该接口用于客户请求短信业务平台向指定用户发送短信。
请求方法
POST
访问URI
/sms/batchSendSms/v1
通信协议
HTTPS/HTTP
参数名称
是否必选
参数类型
默认值
说明
Content-Type
是
String
无
固定填application/x-www-form-urlencoded。
Authorization
SDK-HMAC-SHA256Access=app_key的值,SignedHeaders=参与签名的头域(小写),Signature=经过签名算法计算得到的值
X-WSSE
否(X-WSSE认证必选)
X-Sdk-Date
否(特殊AK/SK认证必选)
格式为:yyyyMMdd'T'HHmmss'Z'
Host
否
API调用目的地址,用于特殊AK/SK认证:如smsapi.cn-north-4.myhuaweicloud.com:443
编程语言
Java
yyyy-MM-dd'T'HH:mm:ss'Z'
PHP
Y-m-d\TH:i:s\Z
Python
%Y-%m-%dT%H:%M:%SZ
C#
yyyy-MM-ddTHH:mm:ssZ
Node.js
toISOString().replace(/.[0-9]+\Z/,'Z')
Go
2006-01-02T15:04:05Z
from
String(1-21)
短信发送方的号码。
to
String(1-21999)
短信接收方的号码,标准号码格式为:+{国家码}{地区码}{终端号码}。
如果携带多个接收方号码,则以英文逗号分隔。每个号码最大长度为21位,最多允许携带500个号码。
templateId
String(1-32)
“templateId”需要与“templateParas”参数配合使用。
中国大陆短信通道号码对应的签名类型和模板ID对应的模板类型必须相同。
templateParas
String[]
注:当使用无变量模板时,可不带templateParas参数。
列表中变量值的个数及长度必须和“templateId”对应模板内容中定义的变量个数及长度保持一致,例如“templateId”对应的模板内容有2个变量且变量长度分别为5和6,则此处需要设置2个变量值且内容长度分别小于等于5和6。
如模板内容为“您有${NUM_5}件快递请到${TXT_6}领取”时,该参数可填写为'["3","人民公园正门"]'。
statusCallback
String(1-1024)
extend
String(1-128)
扩展参数,在状态报告中会原样返回。
不允许赋空值,不允许携带以下字符:“{”,“}”(即大括号)。
signature
String(0-32)
仅中国大陆短信可携带此参数。
签名名称,必须是已审核通过的,与模板类型一致的签名名称。
仅在templateId指定的模板类型为通用模板时生效且必填,用于指定在通用模板短信内容前面补充的签名。
code
String(1-7)
请求返回的结果码。
description
String(1-512)
请求返回的结果码描述。
result
短信ID列表,当目的号码存在多个时,每个号码都会返回一个SmsID。
当返回异常响应时不携带此字段。
smsMsgId
String(1-50)
短信的唯一标识。
originTo
短信接收方的号码。
status
createTime
String(1-20)
格式为:yyyy-MM-dd'T'HH:mm:ss'Z'。
countryId
String(1-3)
短信接收方号码的国家码。
total
int
短信拆分条数。
响应码
结果码
英文描述
中文描述
处理方法
200
000000
Success.
发送请求成功。
无需处理。
400
E000000
Systemerror.
系统异常。
请先对照代码样例检查templateParas参数设置是否正确。若排查代码后仍未解决问题,请联系管理员处理。
E000001
AuthorizationnotcontainedintheHTTPheader.
HTTP消息头未找到Authorization字段。
请检查HTTP消息头中是否携带了Authorization字段。
E000002
realmnotcontainedinAuthorization.
Authorization字段中未找到realm属性。
请检查Authorization字段中的是否携带了realm属性。
E000003
profilenotcontainedinAuthorization.
Authorization字段中未找到profile属性。
请检查Authorization字段中的是否携带了profile属性。
E000004
ThevalueofrealminAuthorizationmustbeSDP.
Authorization中realm属性值应该为“SDP”。
请检查Authorization字段中的realm属性值是否为“SDP”。
E000005
ThevalueofprofileinAuthorizationmustbeUsernameToken.
Authorization中profile属性值应该为“UsernameToken”。
请检查Authorization字段中的profile属性值是否为“UsernameToken”。
E000006
ThevalueoftypeinAuthorizationmustbeapp_key.
Authorization中type属性值应该为“Appkey”。
请检查Authorization字段中的type属性值是否为“Appkey”。
E000007
typenotcontainedinAuthorization.
Authorization字段中未找到type属性。
请检查Authorization字段中是否携带了type属性。
E000008
WSSEnotcontainedinAuthorization.
Authorization中没有携带WSSE。
请检查Authorization字段中是否携带了WSSE。
E000020
X-WSSEnotcontainedintheHTTPheader.
HTTP头未找到X-WSSE字段。
请检查HTTP消息头中是否携带了X-WSSE字段。
E000021
UserNamenotcontainedinX-WSSE.
X-WSSE字段中未找到UserName属性。
请检查X-WSSE字段中的是否携带了UserName属性。
E000022
NoncenotcontainedinX-WSSE.
X-WSSE字段中未找到Nonce属性。
请检查X-WSSE字段中的是否携带了Nonce属性。
E000023
CreatednotcontainedinX-WSSE.
X-WSSE字段中未找到Created属性。
请检查X-WSSE字段中的是否携带了Created属性。
E000024
PasswordDigestnotcontainedinX-WSSE.
X-WSSE字段中未找到PasswordDigest属性。
请检查X-WSSE字段中的是否携带了PasswordDigest属性。
E000025
TheformatofCreatedisincorrect.
Created属性格式错误。
请检查X-WSSE字段中的Created属性格式是否正确。
E000026
UsernameTokennotcontainedinX-WSSE.
X-WSSE字段中未找到UsernameToken属性。
请检查X-WSSE字段中的是否携带了UsernameToken属性。
E000027
Invalidrequest.
非法请求。
根据API接口文档的参数描述和要求,检查请求携带的参数是否都合法。
E000040
ThevalueofContentTypemustbeapplication/x-www-form-urlencoded.
ContentType值应该为application/x-www-form-urlencoded。
请检查ContentType头域的取值是否为“application/x-www-form-urlencoded”。
E000041
X-Sdk-Dateheaderisempty.
X-Sdk-Date为空
特殊AK/SK认证时,请检查HTTP消息头X-Sdk-Date的值。
E000042
TheformatofX-Sdk-Dateheaderisinvalid.
X-Sdk-Date格式错误
特殊AK/SK认证时,请检查HTTP消息头X-Sdk-Date的格式,格式为:yyyyMMdd'T'HHmmss'Z'
E000043
TheformatofAuthorizationheaderisincorrect.
Authorization格式错误
特殊AK/SK认证时,请检查HTTP消息头Authorization格式。
E000044
X-Sdk-Dateisexpired.
X-Sdk-Date过期
E000045
Authorizationverifyfailed.
Authorization校验失败
特殊AK/SK认证时,请检查HTTP消息头Authorization中的Signature字段。
E000503
Theparameterformatisincorrect.
参数格式错误。
请检查参数格式是否正确。
E000510
短信发送失败,描述见参数status。
查看响应参数中的status确认发送失败的原因,修改后重新发送。
401
E000101
Authenticationfailed.
鉴权失败。
请检查Authorization和X-WSSE参数的填写是否正确。
E000102
Invalidapp_key.
app_key无效。
请检查请求携带的app_key填写是否正确。
如app_key填写正确,建议检查app接入地址是否正确(从控制台“应用管理”获取)。
E000103
Thestatusoftheapp_keyisunavailable.
app_key不可用。
请联系管理员确认该app_key状态是否正常。
E000104
Invalidapp_secret.
app_secret无效。
请检查请求携带的app_secret填写是否正确。
E000105
Invaliddigest.
PasswordDigest无效。
请检查请求携带的PasswordDigest填写是否正确。
E000106
Theapp_keyisnotallowedtoinvokethisAPI.
app_key没有调用本API的权限。
请联系管理员确认该app_key是否具有“短信能力开放”能力。
E000109
Theuserstatusisdeactivated.
用户状态未激活。
请联系管理员激活用户。
E000110
Timeoutlimit.
E000111
Incorrectusernameorpassword.
用户名或密码错误。
系统找不到app_key对应的用户信息,请联系管理员处理。
E000112
Thesubscriberstatusisfrozen.
用户状态已冻结。
若是因业务违规冻结,请整改业务后联系运营经理申请解冻。
403
E000620
Theappclientipisnotinipwhitelist.
对端appIP不在白名单列表中。
E000623
NumberofSMSssentbytheSPreachedthelimit.
SP短信发送量达到限额。
请联系运营经理协商调整SP短信发送量最大限额。
E000630
NumberofSMSssentbytheSPreachedthecountry/regionlimit.
SP发送量达到国家/地区级限额
设置流量阈值时,为该号码所属国家/地区设置了限额值。租户发往该国家/地区的短信数量累计
超过限额值导致短信发送失败。
下载Demo,快速开发应用:
在使用文档中是否遇到以下问题
意见反馈(选填)
请至少选择一项反馈信息并填写问题反馈
字符长度不能超过500
关于华为云
支持与服务
账号与支付
2024,华为云计算技术有限公司及其关联公司。保留一切权利。