全部文档

发送邮件

开始使用前，请先创建应用，申请邮件发送 scope,并成功完成审批，同时完成模板创建

请求

POST http://colibri.hsifue.cn/api/email

说明

::: tip 注意
发送频率限制：每天最多 10000 封邮件
:::

header 参数

参数名 必选 类型 描述
Authorization 是 String Bearer app_access_token. 注：该 access_token 是应用级别
Content-Type 是 String application/json

body 参数

参数名 必选 类型 描述
to 是 String 数组 邮件接收邮箱列表
params 是 Map*<String,String*> 模板中的参数列表,params 中的 key 值要和邮件模板中的保持一致，比如参数 count 和模板中的${count}保持一致
templateId 是 String 已创建的模板 id，每个应用只能发送属于自己的模板邮件

响应

HTTP 代码 说明 类型
200 ok 请求成功，根据业务 code 解析实际结果
401 invalid_token 请求头里面的 accessToken 无效
600 业务异常 业务异常

HTTP 请求示例

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"to\":[\"XXX@hsifue.cn\"],\"params\":{\"count\":\"123\"},\"templateId\":\"XXXXX\"}");
Request request = new Request.Builder()
  .url("http://colibri.hsifue.cn/api/email")
  .post(body)
  .addHeader("authorization", "Bearer XXXXXXXX")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

curl -X POST \
  http://colibri.hsifue.cn/api/email \
  -H 'authorization: Bearer XXXXXXXX' \
  -H 'content-type: application/json' \
  -d '{"to":["xxx@hsifue.cn"],"params":{"count":"123"},"templateId":"xxxxx_zh_CN"}'

成功返回结果

{
  "code": 40000,
  "error": "OK",
  "description": "OK"
}

异常返回结果

{"code":40100,"error":"colibri.unauthorized","description":"认证失败"}
{"code":40200,"error":"colibri.oauth.scope.error","description":"没有分配权限"}
{"code":40202,"error":"colibri.invalid.template.id","description":"无效的模板ID"}
{ "error": "invalid_token", "error_description": "cn-24b92d2f-66cc-45d2-8e8b-e08916bca2d62"}