Qeasy Cloud
Get Started

华为云SMS 发送短信 API

Platform
华为云SMS
Type
RESTful
Effect
EXECUTE
API Version
1.0
Adapter
\Adapter\Huawei\SMSExecuteAdapter
Auth Mode
SIGN
Updated At
2023-02-19

发送短信

POST/sms/batchSendSms/v1
Factory
{
  "operation": {
    "method": "none"
  }
}

Request Parameters

No.FieldNameTypeDefaultRequiredDescription
1from短信发送方的号码stringRequired国内短信填写为短信平台为短信签名分配的通道号码,请在申请短信签名时获取签名通道号,如:csms100000001,且通道号码对应的签名类型和模板ID对应的模板类型必须相同。 国际/港澳台短信填写为创建短信应用时分配的通道号,如:isms100000001。 请在短信控制台“国内短信>签名管理”内查看签名的通道号,签名和模板为对应关系,模板所属签名可在“国内短信>模板管理”查看。
2to短信接收方的号码stringRequired标准号码格式为:+{国家码}{地区码}{终端号码}。 发送国内短信:接收号码为国内手机号码时,所填号码可以不带+86,系统默认添加86,其他号码需符合标准号码格式:+{国家码}{地区码}{终端号码}。示例:+86131****5678,+86155****6666。 发送国际/港澳台短信:不区分接收号码类型,所填号码都必须符合标准号码格式:。示例:+2412****00(加蓬号码),+3366****212(法国号码)。 如果携带多个接收方号码,则以英文逗号分隔。每个号码最大长度为21位,最多允许携带500个号码。
3templateId短信模板IDstringRequired用于唯一标识短信模板,请在申请短信模板时获取模板ID。 “templateId”需要与“templateParas”参数配合使用。 国内短信通道号码对应的签名类型和模板ID对应的模板类型必须相同。 请在短信控制台“国内短信>模板管理”内查看模板的模板ID。
4templateParas短信模板的变量值arrayOptional当使用无变量模板时,可不带templateParas参数。 短信模板的变量值列表,用于依次填充“templateId”参数指定的模板内容中的变量,该参数需填写为JSONArray格式。如模板内容为“您有${1}件快递请到${2}领取”时,该参数可填写为'["3","人民公园正门"]'。
5statusCallback回调地址stringOptional用于接收短信状态报告,如:http://my.com/receiveSMSReport。 如果设置了该字段,则该消息的状态报告将通过“接收状态报告”接口直接通知用户。 如果未设置该字段,则短信平台收到运营商短信中心返回的状态报告不会推送给用户,该状态报告将在短信平台中保存1个小时,超时后系统会自动删除。 回调地址推荐使用域名。
6extend扩展参数stringOptional在状态报告中会原样返回。 不允许赋空值,不允许携带以下字符:“{”,“}”(即大括号)。
7signature签名名称stringOptional必须是已审核通过的,与模板类型一致的签名名称。 仅在templateId指定的模板类型为通用模板时生效且必填,用于指定在通用模板短信内容前面补充的签名。 国际/港澳台短信无需关注此参数。

Response Parameters

No.FieldNameTypeDefaultRequiredDescription
1code响应状态stringOptional响应状态
2description描述stringOptional响应描述

The 发送短信 API (/sms/batchSendSms/v1) of 华为云SMS is curated by the API asset management module of the Qeasy Cloud data integration platform and kept in sync with 华为云SMS version updates.

Need to integrate this API?

Qeasy ships with prebuilt adaptation for this API — contact us to start configuring data integration.