短信发送

说明

参数列表的可选属性 M：表示必选。 O：表示任意可选。 C：表示条件可选。

说明

用于提交视频短信进行模板发送

方法

请求方法： POST

Content-Type：application/json; charset=utf-8

请求网址：https://rcs.253.com/rcs/api/v2/msg/submitVideoTemplate

参数

字段	类型	必填	说明
appId	string	M	发送账号
submitNo	string	M	提交号（客户端生成，唯一标识，≤32 位）
templateId	string	M	模板 ID
phones	String[]	C	静态模板发送时必填，手机号列表
dynamicVars	List<Object>	C	动态模板参数；动态模板发送时必填（格式见示例）
timestamp	string	M	10 位 Unix 时间戳（秒），200 秒内有效
signature	string	M	请求签名

返回值

字段	数据类型	描述
code	string	返回码
message	string	错误描述
data	object
--> submitNo	string	提交号
-->batchId	string	批次号，一次提交算一个
--> errphone	string[]	返回提交的号码中的错误号码

示例

请求：

静态模板示例

{
  "appId": "vUgOfi0Ltd",
  "submitNo": "202009221649",
  "phones": [
    "18918416998",
    "13381728253",
    "18551473662",
    "16601722151",
    "187179501591"
  ],
  "templateId": "126701341765533703",
  "timestamp": "1624938115",
  "signature": "5f4b61127355887572afad448e2e64e548b00f3c9f845079cbb931f2fe11a61d"
}

动态模板示例

{
  "appId": "rDOMKNMLaE",
  "submitNo": "202009221649",
  "dynamicVars": [
    {
      "phone": "18551473662",
      "v1": "赵联通",
      "v2": "测试 3",
      "v3": "测试 4",
      "v4": "测试 5",
      "v5": "测试 6"
    },
    {
      "phone": "16601722151",
      "v1": "赵移动",
      "v2": "测试 3",
      "v3": "测试 4",
      "v4": "测试 5",
      "v5": "测试 6"
    }
  ],
  "templateId": "1410869910296330240",
  "timestamp": "1624938115",
  "signature": "fab1434cade0894dc93838b8276b94230bd7ed49ecc1d98ad8d64b3cc097ed7d"
}

响应：

{
  "code": "102000",
  "message": "请求成功",
  "data": {
    "errPhone": [
      "187179501591"
    ],
    "submitNo": "202009221649",
    "batchId": "1445638435275804672"
  }
}

附录

状态报告错误码对照表

返回码	返回信息
CL_0000	成功
CL_1000	失败
CL_1001	黑名单
CL_1002	通道错误
CL_1003	超频
CL_1004	内容存在敏感词或不符合规则
CL_1010	短链获取失败
CL_1012	平台黑名单
CL_1013	平台通道错误
CL_1015	平台地区屏蔽
CL_1016	风险号码屏蔽
CL_1020	禁用签名拦截
CL_1021	反投诉策略拦截
CL_1023	无效变量，变量字符不能大于20且变量中不能包含链接

错误码

错误码	说明
102000	成功
500	系统异常
1002	手机号码格式错误
1003	费用扣除失败
1004	白名单
1005	黑名单
1006	手机号超频
1008	用户没有配置通道包
1010	模板不存在
1013	内部错误，创建模板错误
1015	账户余额不足
1018	账户发送超限
1019	手机号为空
1020	未识别的类型
1301	AppId 不能为空
1303	SubmitNo 不能为空
1306	Phones 不能为空
1311	TemplateID 不能为空
1316	IP 地址限制
1317	账号错误
1318	该模板为动态模板，变量参数不能为空
1319	当前变量模板参数不满足条件：不能重复、最多添加 5 个参数、变量模板参数与提交模板参数个数不一致
1330	模板标题过长，不能超过 20 个字符
1331	短信签名校验失败，请先报备签名
1332	appId 或 appSecret 不正确
1333	/ > < ! ' & script ../ ./ alert 【这些特殊字符不行
1334	视频短信模板内容不能为空
1335	body 中 exType 不能为空，排序不能为空，content 内容不能为空
1336	type 和 exType 不匹配或 type 不支持
1337	body 大小不能超过 2M
1338	通道不存在
1339	当前存在通道不支持变量模板
1340	模板不存在
1341	状态参数错误
1342	必填参数为空
1343	submitNo 长度不能超过 32
1344	超过最大限制条数
1345	签名校验错误
1346	时间戳或签名长度过长
1347	时间戳超时
1348	模板名称不能为空

产品中心

热门搜索

中国站

国际站

短信发送

说明

短信发送

说明

方法

参数

返回值

示例

附录

状态报告错误码对照表

错误码