Delivery channels message-channels
Configure and test the email (SMTP) and SMS delivery channels.
Pick an endpoint to see its example call on the right.
Authentication
Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.
X-API-Key
Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).
Conventions
Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.
Times are RFC 3339 (UTC); amounts are in cents.
Writes return 200/201/204 on success; duplicates of a unique key return 409.
/api/v2/message-channelsDelivery channels
Authentication: Admin only
/api/v2/message-channelsUpdate delivery channels
Authentication: Admin only
Request body application/json
| Field | Type | Description |
|---|---|---|
smsRequired | SmsChannel | SMS channel settings. |
smtpRequired | SmtpChannel | SMTP email channel settings. |
/api/v2/message-channels/testTest delivery channel
Authentication: Admin only
Request body application/json
| Field | Type | Description |
|---|---|---|
channelRequired | string | Channel to test (email or sms). |
draft | ChannelTestDraft | Unsaved channel settings; same shape as the save endpoint, omitted fields and blank secrets fall back to the stored values. |
template_id | string | An approved template id is required for the Tencent Cloud SMS channel (not needed for SMSBao). |
toRequired | string | Recipient address or phone number. |
Delivery channels object
| Field | Type | Description |
|---|---|---|
channelRequired | string | Channel to test (email or sms). |
draft | ChannelTestDraft | Unsaved channel settings; same shape as the save endpoint, omitted fields and blank secrets fall back to the stored values. |
error | string | Error message when the test failed. |
ok | boolean | Whether the test send succeeded. |
sms | SmsChannel | SMS channel settings. |
smtp | SmtpChannel | SMTP email channel settings. |
template_id | string | An approved template id is required for the Tencent Cloud SMS channel (not needed for SMSBao). |
toRequired | string | Recipient address or phone number. |
Responses and errors
Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.
{
"id": 1,
"name": "example"
}{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}{
"code": "validation_failed",
"detail": "Invalid request parameters",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name is required"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}