SendSms接口是短信发送接口,支持在一次请求中向多个不同的手机号码发送同样内容的短信。
调用该接口发送短信时,请注意:发送短信会根据发送量计费,价格请参见产品定价。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
action | String | 是 | SendSms | 系统规定参数。取值:SendSms。 |
phoneNumber | String | 是 | 1381111***** | 接收短信的手机号码。格式:国内短信:无任何前缀的11位手机号码,例如1381111****。多个手机号码使用英文","隔开,最多支持一次提交200个手机号码。 |
signName | String | 是 | 天翼云 | 短信签名名称。请在控制台的签名管理页签下签名名称一列查看。说明:必须是已添加、并通过审核的短信签名。 |
templateCode | String | 是 | SMS73419576145 | 短信模板ID。请在控制台的模板管理页签下模板Code一列查看。说明:必须是已添加、并通过审核的短信模板。 |
templateParam | String | 否 | {"code":"1111"} | 短信模板变量对应的实际值,JSON字符串格式。说明:如果JSON中需要带换行符,请参照标准的JSON协议处理。 |
extendCode | String | 否 | 90999 | 上行短信扩展码,长度不可超过6。上行短信,指发送给通信服务提供商的短信,用于定制某种服务、完成查询,或是办理某种业务等,需要收费的,按运营商普通短信资费进行扣费。说明:无特殊需要此字段的用户请忽略此字段。 |
sessionId | String | 否 | 123456 | 客户自带短信标识,在状态报告中会原样返回。说明:无特殊需要此字段的用户请忽略此字段。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | String | OK | 请求状态码。 返回OK代表请求被成功接收。 实际短信发送状态,通过配置短信状态报告回调地址异步返回,错误码详见错误码列表。 |
message | String | success | 状态码描述。 |
requestId | String | cknkbmqflsojbf48h8ng | 请求ID。多个手机号码的请求ID使用","隔开。 |
示例
请求示例
{
"action": "SendSms",
"signName": "天翼云",
"phoneNumber": "13301110000",
"templateCode": "SMS73419576145",
"templateParam": "{\"code\":\"123456\",\"time\":\"1\"}",
"extendCode": "123"
}
正常返回示例
{
"code": "OK",
"message": "success",
"requestId": "cknkbmqflsojbf48h8ng"
}