Version 2.1.1792967583 · latest Download OpenAPI Markdown

Delivery channels

Configure and test the email (SMTP) and SMS delivery channels.

message-channelsMessagesAuthentication: Admin only3 endpoints

GET/api/v2/message-channels

Authentication: Admin only

Update delivery channels

PUT/api/v2/message-channels

Authentication: Admin only

Field	Type	Required	Description
sms	SmsChannel	Required	SMS channel settings.
smtp	SmtpChannel	Required	SMTP email channel settings.

POST/api/v2/message-channels/test

Authentication: Admin only

Field	Type	Required	Description
channel	string	Required	Channel to test (email or sms). Values `["email","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).
to	string	Required	Recipient address or phone number.

Field	Type	Required	Description
channel	string	Required	Channel to test (email or sms). Values `["email","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).
to	string	Required	Recipient address or phone number.