华为云SMS发送短信API接口文档
所属平台:
华为云SMS
类型:
RESTful
作用:
EXECUTE
接口版本:
1.0
适配器:
\Adapter\Huawei\SMSExecuteAdapter
帮助链接:
https://bbs.qeasy.cloud
描述:
更新日期:
2023-02-19 14:27:38
发送短信
接口地址:/sms/batchSendSms/v1
请求方法: POST
加工厂: {"operation":{"method":"none"}}
接口请求参数
序号 | 字段 | 名称 | 类型 | 默认值 | 描述 | 是否必要 |
---|---|---|---|---|---|---|
1 | from | 短信发送方的号码 | string | 国内短信填写为短信平台为短信签名分配的通道号码,请在申请短信签名时获取签名通道号,如:csms100000001,且通道号码对应的签名类型和模板ID对应的模板类型必须相同。 国际/港澳台短信填写为创建短信应用时分配的通道号,如:isms100000001。 请在短信控制台“国内短信>签名管理”内查看签名的通道号,签名和模板为对应关系,模板所属签名可在“国内短信>模板管理”查看。 | 是 | |
2 | to | 短信接收方的号码 | string | 标准号码格式为:+{国家码}{地区码}{终端号码}。 发送国内短信:接收号码为国内手机号码时,所填号码可以不带+86,系统默认添加86,其他号码需符合标准号码格式:+{国家码}{地区码}{终端号码}。示例:+86131****5678,+86155****6666。 发送国际/港澳台短信:不区分接收号码类型,所填号码都必须符合标准号码格式:。示例:+2412****00(加蓬号码),+3366****212(法国号码)。 如果携带多个接收方号码,则以英文逗号分隔。每个号码最大长度为21位,最多允许携带500个号码。 | 是 | |
3 | templateId | 短信模板ID | string | 用于唯一标识短信模板,请在申请短信模板时获取模板ID。 “templateId”需要与“templateParas”参数配合使用。 国内短信通道号码对应的签名类型和模板ID对应的模板类型必须相同。 请在短信控制台“国内短信>模板管理”内查看模板的模板ID。 | 是 | |
4 | templateParas | 短信模板的变量值 | array | 当使用无变量模板时,可不带templateParas参数。 短信模板的变量值列表,用于依次填充“templateId”参数指定的模板内容中的变量,该参数需填写为JSONArray格式。如模板内容为“您有${1}件快递请到${2}领取”时,该参数可填写为'["3","人民公园正门"]'。 | 否 | |
5 | statusCallback | 回调地址 | string | 用于接收短信状态报告,如:http://my.com/receiveSMSReport。 如果设置了该字段,则该消息的状态报告将通过“接收状态报告”接口直接通知用户。 如果未设置该字段,则短信平台收到运营商短信中心返回的状态报告不会推送给用户,该状态报告将在短信平台中保存1个小时,超时后系统会自动删除。 回调地址推荐使用域名。 | 否 | |
6 | extend | 扩展参数 | string | 在状态报告中会原样返回。 不允许赋空值,不允许携带以下字符:“{”,“}”(即大括号)。 | 否 | |
7 | signature | 签名名称 | string | 必须是已审核通过的,与模板类型一致的签名名称。 仅在templateId指定的模板类型为通用模板时生效且必填,用于指定在通用模板短信内容前面补充的签名。 国际/港澳台短信无需关注此参数。 | 否 |
接口响应参数
序号 | 字段 | 名称 | 类型 | 默认值 | 描述 | 是否必要 |
---|---|---|---|---|---|---|
1 | code | 响应状态 | string | 响应状态 | 否 | |
2 | description | 描述 | string | 响应描述 | 否 |
华为云SMS的接口:发送短信(/sms/batchSendSms/v1),由轻易云数据集成平台API资产管理模块整理收纳,并且根据华为云SMS版本更新同步实时更新。轻易云数据集成平台的API资产管理功能,通过统一的视图和控制台,帮助企业全面掌握API资产的使用情况,实现资源的高效利用和优化配置。