Dysmsapiclass="icms-help-docs-content">批量发送卡片短信

批量发送卡片短信。

接口说明

发送卡片短信为计费接口，卡片短信发送失败或渲染失败时不计费，详情请参见多媒体短信定价。
目前卡片短信在内部邀约阶段，请联系您的阿里云商务经理申请开通或联系阿里云售前咨询。
卡片短信超时时间建议设置为≥3S；发生超时失败的情况时，建议查看回执状态后再判断是否重试。同时建议您在调用此接口时，不要开启 SDK 重试逻辑，否则可能会造成多次发送的情况。超时和重试的相关设置，请参见超时机制、重试机制。
国内短信、国际短信及多媒体短信目前均不支持幂等的能力，请您做好幂等控制，防止因多次重试而导致的重复操作问题。
发送卡片短信前需添加卡片短信模板且模板审核通过。本接口在发送短信时，会校验号码是否支持卡片短信。如果该手机号不支持发送卡片短信，可在接口中设置是否接受数字短信和文本短信的回落，提升发送的触达率。
批量发送卡片短信，每个号码可以使用不同的签名，不同的回落。在一次请求中，最多可以向 100 个手机号码分别发送卡片短信。

QPS 限制

本接口的单用户 QPS 限制为 1000 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作

操作	访问级别	资源类型	条件关键字	关联操作
dysms:SendBatchCardSms	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值

名称	类型	必填	描述	示例值
CardTemplateCode	string	是	卡片短信模板 Code。请在控制台卡片短信模板管理页面选择已通过审核的卡片短信模板 Code。	CARD_SMS_3**5
SmsTemplateCode	string	是	回落文本短信的模板 Code。FallbackType 选择 SMS 回落文本短信时，此参数必填。您可以通过 QuerySmsTemplateList 接口查询当前账号已申请的模板或在短信服务控制台查看模板列表。说明必须是已添加、并通过审核的短信模板。	SMS_23425****
FallbackType	string	是	回落类型。取值： SMS：不支持卡片短信的号码，回落文本短信。 DIGITALSMS：不支持卡片短信的号码，回落数字短信。 NONE：不需要回落。	SMS
DigitalTemplateCode	string	否	回落数字短信的模板 Code。FallbackType 选择 DIGITALSMS 回落数字短信时，此参数必填。您可在控制台国内数字短信模板管理页面查看数字短信模板列表。说明必须是已添加、并通过审核的数字短信模板。	DIGITAL_SMS_23408****
OutId	string	否	预留给调用方使用的 ID。	16545681783595370
PhoneNumberJson	string	是	接收短信的手机号码。	["1390000**","1370000**"]
SignNameJson	string	是	短信签名名称。您可以通过 QuerySmsSignList 接口查询当前账号已申请的签名或在短信服务控制台查看签名列表。说明必须是已添加、并通过审核的短信签名；且短信签名的个数必须与手机号码的个数相同、内容一一对应。	["阿里云","阿里巴巴"]
CardTemplateParamJson	string	否	卡片短信模板参数对应的实际值。CardTemplateCode 卡片短信模板内含有变量时，此参数必填。说明如果 JSON 中需要带换行符，请参照标准的 JSON 协议处理。	[{"customurl":"http://www.alibaba.com","dyncParams":"{"a":"hello","b":"world"}"}]
SmsTemplateParamJson	string	否	文本短信模板参数对应的实际值。SmsTemplateCode 回落的文本短信模板内含有变量时，此参数必填。说明如果 JSON 中需要带换行符，请参照标准的 JSON 协议处理。	[{"a":1,"b":2},{"a":9,"b":8}]
DigitalTemplateParamJson	string	否	数字短信模板参数对应的实际值。DigitalTemplateCode 回落的数字短信模板内含有变量时，此参数必填。说明如果 JSON 中需要带换行符，请参照标准的 JSON 协议处理。	[{"a":1,"b":2},{"a":9,"b":8}]
SmsUpExtendCodeJson	string	否	上行短信扩展码。	[\"6\",\"6\"]
TemplateCode	string	否	自定义发送内容模板 CODE。自定义内容会按照选定的文本短信模板+卡片解析链接的形式下发到终端，您可以登录短信服务控制台，选择国内消息或国际/港澳台短信，在模板管理页面查看模板 CODE。说明必须是已添加、并通过审核的短信模板；且发送国际/港澳台消息时，请使用国际/港澳台短信模板。例如：选择的文本短信模板内容为：您有一条消息待查收；卡片解析链接为：`1.cn/2d`。最终下发内容：`您有一条消息待查收 1.cn/2**d`。请在下发前做好测试和字数控制。	SMS_20375****
TemplateParamJson	string	否	自定义发送内容模板变量对应的实际值。TemplateCode 填入包含变量的短信模板时，此参数必填。说明如果 JSON 中需要带换行符，请参照标准的 JSON 协议处理；模板变量值的个数必须与手机号码、签名的个数相同、内容一一对应，表示向指定手机号码中发对应签名的短信，且短信模板中的变量参数替换为对应的值。	[{"name":"TemplateParamJson"},{"name":"TemplateParamJson"}]

返回参数

名称	类型	描述	示例值

名称	类型	描述	示例值
	object	返回数据。
Code	string	请求状态码。返回 OK 代表请求成功。其他错误码，请参见 API 错误码。	OK
RequestId	string	请求 ID。	A90E4451-FED7-49D2-87C8-00700A8C4D0D
Success	boolean	调用接口是否成功。取值： true：调用成功。 false：调用失败。	true
Data	object	返回数据。
MediaMobiles	string	接收卡片短信的手机号。	1390000****
BizCardId	string	卡片短信发送 ID。	123
BizDigitalId	string	数字短信发送 ID。	3214
CardTmpState	integer	卡片短信模板审核状态。取值： 0：审核中。 1：审核通过。 2：审核不通过。说明审核不通过的短信可通过 FallbackType 字段设置回落流程。	0
NotMediaMobiles	string	回落的手机号。	1390000****
BizSmsId	string	文本短信发送 ID。	3256

示例

正常返回示例

JSON格式

        

          
      
        
{
  "Code": "OK",
  "RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
  "Success": true,
  "Data": {
    "MediaMobiles": "1390000****",
    "BizCardId": "123",
    "BizDigitalId": "3214",
    "CardTmpState": 0,
    "NotMediaMobiles": "1390000****",
    "BizSmsId": "3256"
  }
}

错误码

HTTP status code	错误码	错误信息	描述

HTTP status code	错误码	错误信息	描述
200	ForbiddenAction	Access to the account is denied. Please contact the administrator.	没有访问权限，请联系管理员

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

变更时间	变更内容概要	操作
2024-09-09	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情