发送短信

更新时间:2023-06-20 12:39:04下载pdf

本文介绍发送短信的 API。

接口描述

为用户发短信验证码、通知类短信或营销短信。

接口地址

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

请求参数

body 说明

参数名类型参数位置是否必填说明
country_codeString true国家码
phoneString true接收短信的手机号码
template_idString true短信模板 ID,必须填写已审核通过的模板 ID
template_paramString false短信模板变量对应的实际值,JSON 格式
sign_nameString false短信签名

返回参数

参数名类型说明
resultMsgPushRes

result 说明

参数名类型说明
send_statusBoolean发送状态

请求示例

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

返回示例

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

错误码

参考 错误码