Send Voice Notification

Last Updated on : 2023-06-15 05:14:26

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

API address

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

Description of body

Parameter name	Type	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.

Parameter name	Type	Description
result	MsgPushRes

Description of result

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

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

{
  "country_code": "86",
  "phone": "151xxxxxxxx",
  "template_id": "VOICE_1616396456",
  "template_param": "{\"code\":\"1234\"}"
}

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

For more information, see error code.