请根据购买的邮箱版本选择对应的API访问地址来使用。
版本 | 标准版、AI尊享版 | 国产化版本 |
Host地址 | alimail-cn.aliyuncs.com | mail-open.xc.aliyun.com |
获取Token | https://alimail-cn.aliyuncs.com/oauth2/v2.0/token | https://mail-open.xc.aliyun.com/oauth2/v2.0/token |
创建账号 | https://alimail-cn.aliyuncs.com /v2/users | https://mail-open.xc.aliyun.com /v2/users |
更多示例请参考
授权Token获取
调用邮箱API之前，需要先在邮箱域管中的API开放平台创建应用、分配权限，之后可以使用应用的appId/secret调用授权接口，换取授权token。授权接口请求方法如下：
POST /oauth2/v2.0/token HTTP/1.1 Host: alimail-cn.aliyuncs.com Content-Type: application/x-www-form-urlencoded grant_type=client_credentials&client_id=应用appId&client_secret=应用secret
请求参数说明：
参数名 必填 说明
| grant_type | Y | 固定取值：client_credentials |
| client_id | Y | 请求授权 token 的应用 id，由邮箱企业管理员在后台注册应用后获取 |
| client_secret | Y | 请求授权 token 的应用 secret，由邮箱企业管理员在后台注册应用后获取。注意不要对外泄漏，任何人拥有应用 id/secret 后都能够以该应用的身份调用API |
返回参数说明：
参数名 说明
| token_type | token类型，目前统一为：bearer |
| access_token | 授权token |
| expires_in | 授权token有效时间，单位：秒。建议使用方对授权token进行缓存，超过过期时间之后再重新获取。 |
请求示例：
命令行 curl 工具：
curl -X POST \ https://alimail-cn.aliyuncs.com/oauth2/v2.0/token \ -H 'content-type: application/x-www-form-urlencoded' \ -d 'grant_type=client_credentials&client_id=...&client_secret=...'
Java（依赖OkHttpClient）：
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = RequestBody.create(mediaType, "grant_type=client_credentials&client_id=...&client_secret=...");
Request request = new Request.Builder()
.url("https://alimail-cn.aliyuncs.com/oauth2/v2.0/token")
.post(body)
.addHeader("content-type", "application/x-www-form-urlencoded")
.build();
Response response = client.newCall(request).execute();返回示例：
{
"token_type": "bearer",
"access_token": "...",
"expires_in": 172799
}API调用授权Token传递
所有的开放 API 调用都需要通过 HTTP 请求头 “Authorization” 带上有效的授权 token，注意请求头的值在 token 前面需要加上 “bearer” 前缀：
请求示例：
curl -X POST \ https://alimail-cn.aliyuncs.com/... \ -H 'content-type: application/json' \ -H 'authorization: bearer 获取的授权token' ...
API访问流量限制
单个域内所有应用的API访问流量，总计不能超过40次/秒。访问流量超出限制后接口会返回 HTTP status 429。