发信通道
邮件(SMTP)与短信发信通道的配置及测试。
message-channels消息鉴权: 仅管理员3 个接口发信通道
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 | — | 未保存的通道设置草稿;字段形状同保存接口,没给的字段、留空的密钥沿用已存值。 |
| template_id | string | — | 腾讯云短信须给已审核的模板 id(短信宝不需要)。 |
| to | string | 必填 | 收件邮箱或手机号。 |
发信通道对象
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| channel | string | 必填 | 要测试的通道(email 邮件、sms 短信)。 |
| draft | ChannelTestDraft | — | 未保存的通道设置草稿;字段形状同保存接口,没给的字段、留空的密钥沿用已存值。 |
| error | string | — | 失败时的错误信息。 |
| ok | boolean | — | 测试发送是否成功。 |
| sms | SmsChannel | — | 短信通道配置。 |
| smtp | SmtpChannel | — | SMTP 邮件通道配置。 |
| template_id | string | — | 腾讯云短信须给已审核的模板 id(短信宝不需要)。 |
| to | string | 必填 | 收件邮箱或手机号。 |