Version 2.4.7.20261116085428 · latest

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.

MessagesAuthentication: Admin only3 endpoints

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.

PUT/api/v2/message-channelsUpdate delivery channels

Authentication: Admin only

Request body application/json

FieldTypeDescription
smsRequiredSmsChannel SMS channel settings.
smtpRequiredSmtpChannel SMTP email channel settings.
POST/api/v2/message-channels/testTest delivery channel

Authentication: Admin only

Request body application/json

FieldTypeDescription
channelRequiredstring Channel to test (email or sms).
Values ["email","sms"]
draftChannelTestDraft Unsaved channel settings; same shape as the save endpoint, omitted fields and blank secrets fall back to the stored values.
template_idstring An approved template id is required for the Tencent Cloud SMS channel (not needed for SMSBao).
toRequiredstring Recipient address or phone number.

Delivery channels object

FieldTypeDescription
channelRequiredstring Channel to test (email or sms).
Values ["email","sms"]
draftChannelTestDraft Unsaved channel settings; same shape as the save endpoint, omitted fields and blank secrets fall back to the stored values.
errorstring Error message when the test failed.
okboolean Whether the test send succeeded.
smsSmsChannel SMS channel settings.
smtpSmtpChannel SMTP email channel settings.
template_idstring An approved template id is required for the Tencent Cloud SMS channel (not needed for SMSBao).
toRequiredstring 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.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "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"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command