Send Voice Notification

Last Updated on : 2023-09-11 09:55:07download

Send verification codes, notifications, or marketing voice messages to users.

API address

POST: /v1.0/iot-03/messages/voices/actions/push

Request parameter

Description of body

Parameter name Type IN Required Description
country_code String true The country code.
phone String true The phone number that receives the voice notification.
template_id String true The approved voice template ID.
template_param String false The actual value corresponding to the voice template variable, in the JSON format.

Return parameter

Parameter name Type Description
result MsgPushRes

Description of result

Parameter name Type Description
send_status Boolean The status of sending a specified notification.

Request example

POST: /v1.0/iot-03/messages/voices/actions/push
{ "country_code": "86", "phone": "151xxxxxxxx", "template_id": "VOICE_1616396456", "template_param": "{\"code\":\"1234\"}" }

Return example

{ "result": { "send_status": true }, "t": 1586153261345, "success": true }

Error code

For more information, see error code.