版本 2.4.7.20261116085428 · 最新
发信通道 message-channels
邮件(SMTP)与短信发信通道的配置及测试。
点击任一接口,右侧显示对应的调用示例。
消息鉴权: 仅管理员3 个接口
鉴权
请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。
X-API-Key
鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。
约定
分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。
时间一律 RFC 3339(UTC);金额单位为分。
写操作成功回 200/201/204;重复提交按资源唯一键回 409。
GET
/api/v2/message-channels发信通道
鉴权: 仅管理员
PUT
/api/v2/message-channels修改发信通道
鉴权: 仅管理员
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
sms必填 | SmsChannel | 短信通道配置。 |
smtp必填 | SmtpChannel | SMTP 邮件通道配置。 |
POST
/api/v2/message-channels/test测试发信通道
鉴权: 仅管理员
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
channel必填 | string | 要测试的通道(email 邮件、sms 短信)。 |
draft | ChannelTestDraft | 未保存的通道设置草稿;字段形状同保存接口,没给的字段、留空的密钥沿用已存值;SMTP 或代理的地址、端口、用户名改了的,对应密码须重给。 |
template_id | string | 腾讯云短信须给已审核的模板 id(短信宝不需要)。 |
to必填 | string | 收件邮箱或手机号。 |
发信通道对象
| 字段 | 类型 | 说明 |
|---|---|---|
channel必填 | string | 要测试的通道(email 邮件、sms 短信)。 |
draft | ChannelTestDraft | 未保存的通道设置草稿;字段形状同保存接口,没给的字段、留空的密钥沿用已存值;SMTP 或代理的地址、端口、用户名改了的,对应密码须重给。 |
error | string | 失败时的错误信息。 |
ok | boolean | 测试发送是否成功。 |
sms | SmsChannel | 短信通道配置。 |
smtp | SmtpChannel | SMTP 邮件通道配置。 |
template_id | string | 腾讯云短信须给已审核的模板 id(短信宝不需要)。 |
to必填 | string | 收件邮箱或手机号。 |
返回与错误
成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。
成功
{
"id": 1,
"name": "example"
}列表
{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}失败
{
"code": "validation_failed",
"detail": "请求参数不合法",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name 必填"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}