模板管理

说明

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

一、创建模板

说明

创建视频短信模板，提交模板是变量模板时，变量模板仅文本可添加变量，且最多包含 5 个变量，顺序依次为：${v1}、${v2}、${v3}、${v4}、${v5}

方法

请求方法： POST

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

请求网址：https://rcs.253.com/rcs/api/v2/template/addVideo

参数

字段	类型	必填	说明
appId	string	M	发送账号
templateName	string	M	模板名称
sign	string	M	平台已创建的签名
body	List<Object>	M	消息内容列表
├─ type	string	M	text / video / audio / image
├─ exType	string	M	txt、mp4、3gp、mp3、jpg、png、gif
├─ content	string	M	文本内容；文件支持 Base64 或 URL
├─ contentType	int	C	1=Base64（默认），2=URL
├─ sort	int	M	内容排序
isDynamic	int	C	动态模板时必填
timestamp	string	M	10 位 Unix 时间戳（200 秒内有效）
signature	string	M	请求签名
templateLink	string	C	模板链接（完整 URL）

返回值

字段	数据类型	描述
code	string	返回码
message	string	错误描述
data	object
--> templateId	string	模板 id

示例

请求：

{
  "appId": "rDOMKNMLaE",
  "body": [
    {
      "exType": "txt",
      "content": "变量一 ${v1},变量二 ${v2},变量三 ${v3},变量四 ${v4},变量五 ${v5}",
      "sort": 1,
      "type": "text"
    }
  ],
  "templateName": "视频短信模板",
  "sign": "【视频短信测试】",
  "isDynamic": 1,
  "timestamp": "1624938115",
  "signature": "1d6cb525296b0e7c50e5dd7e05457135b5b8eed369ce5048e6bde2d6b10a1071"
}

响应：

{
  "code": "102000",
  "message": "请求成功",
  "data": {
    "templateId": "127873750216474624"
  }
}

二、查看模板状态

说明

查询模板状态

方法

请求方法： POST

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

请求网址：https://rcs.253.com/rcs/api/v2/template/findTemplate

参数

字段	数据类型	可选属性	描述
appId	string	M	发送账号
templateId	string	M	templateId
timestamp	string	M	时间戳，1970/1/1 到现在的秒数，10 位 200 秒内请求有效
signature	string	M	签名

返回值

字段	数据类型	描述
code	string	返回码
message	string	错误描述
data	object
--> statusName	string	模板状态说明
--> status		模板状态：1 平台审核中 2 营商审核审核中 3 审核成功 4 审核失败
-->templateId	string	模板 id
-->operator	string[]	模板可发运营商标识：1 移动 2 联通 3 电信
--> rejectReason	string	审核驳回原因
-->expireFlag	string	模板有效性：0 失效 1 有效
-->isDynamic	string	动参或非动参标识：0 非动参 1 动参

示例

请求：

{
  "appId": "rDOMKNMLaE",
  "templateId": "1410869910296330240",
  "timestamp": "1624938115",
  "signature": "8fa6891ab01c4b509870a6e9e6ce25e6074d33beb65aaa4575f9affbb7b0bdaa"
}

响应：

{
  "code": "102000",
  "message": "请求成功",
  "data": {
    "statusName": "审核成功",
    "templateId": "146351173975146503",
    "operator": [
      "2",
      "1",
      "3"
    ],
    "status": 3
  }
}

三、查询模板列表

说明

查询模板状态

方法

请求方法： POST

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

请求网址：https://rcs.253.com/rcs/api/v2/template/listVideoTemplate

参数

字段	数据类型	可选属性	描述
appId	string	M	发送账号
pageNo	string	M	页码
pageSize	string	M	页大小
status	string	M	模板状态: 空字符串表示查询所有状态的模板；1 审核中 2：等待运营商审核，3：审核成功（等价于上架），4：审核失败，
timestamp	string	M	时间戳，1970/1/1 到现在的秒数，10 位 200 秒内请求有效
signature	string	M	签名

返回值

字段	数据类型	描述
code	string	返回码
message	string	错误描述
data	object
--> templateName	string	模板状态说明
--> status		模板状态：0 等待商户送审 1 审核中 2 等待运营商审核 3 审核成功 4 审核失败
-->templateId	string	模板 id
-->sign	string	签名
-->createTime	long	创建时间
-->auditTime	long	审核时间
--> remark	string	备注
--> rejectReason	string	审核驳回原因
--> suffix	string	可以不管
-->expireFlag	string	模板有效性：0 失效 1 有效
-->isDynamic	string	动参或非动参标识：0 非动参 1 动参
-->cmccStatus	int	移动可用标识：0不可用，1 可用
-->cuccStatus	int	联通可用标识：0不可用，1 可用
-->ctccStatus	int	电信可用标识：0不可用，1 可用
pageNo	int	页码
pageSize	int	页大小
totalPages	int	总页数
totalRecords	int	总条数
-->contentList-->sort	int	模板顺序
-->contentList-->contentType	int	资源类型：0 文本 1 图片 2 音频 3 视频
-->contentList-->contentUrl	string	资源链接
-->contentList-->contentText	string	视频短信文本
-->contentList-->fileSuffix	string	文件后缀

示例

请求：

{
  "appId": "rDOMKNMLaE",
  "pageNo": 1,
  "pageSize": 10,
  "status": "2",
  "timestamp": "1624938115",
  "signature": "90eb66134c360cdbd067112189f98fb2263c5099481d60c99b28915cff9267de"
}

响应：

{
  "code": "102000",
  "message": "请求成功",
  "data": [
    {
      "templateName": "测试 123",
      "templateId": "117194636828606469",
      "sign": "【视频短信演示】",
      "status": "2",
      "createTime": 1598405379000,
      "auditTime": 1598405404000,
      "contentList": [
        {
          "sort": 0,
          "contentType": "1",
          "contentUrl": "https://static2.253.com/rcs_sms/stable/images/36ab30a3-c48a-4e45-9ef5-2dec3d303fe7.png",
          "contentText": null,
          "fileSuffix": "video/mp4"
        }
      ],
      "remark": "麻烦 MV",
      "suffix": null
    }
  ],
  "pageNo": 1,
  "totalRecords": 1,
  "totalPages": 1,
  "pageSize": 10
}

四、模板审核结果推送

说明

接收方 http 类型为 post，数据类型为 json，返回 ok

因为移动、电信、联通不会同时成功，所以可以会推多次，用户自行解析就行

推送参数

字段	数据类型	描述
templateId	string	模板编号
status	Integer	审核状态：3：成功 4：失败
remark	string	备注
time	string	时间
cmccStatus	Integer	移动审核状态：0：无状态 3：成功 4：失败
cuccStatus	Integer	联通审核状态：0：无状态 3：成功 4：失败
ctccStatus	Integer	电信审核状态：0：无状态 3：成功 4：失败
expireFlag	string	模板有效性：0 失效 1 有效

对方接收到状态报告后需要返回：”ok”

{
  "templateId": "146xxxxxx23243",
  "status": 3,
  "remark": "审核成功",
  "time": 20201030111523,
  "cmccStatus": 3,
  "cuccStatus": 3,
  "ctccStatus": 3,
  "expireFlag": "1"
}

错误码

错误码	说明
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	模板名称不能为空

产品中心

热门搜索

中国站

国际站

说明

一、创建模板

说明

方法

参数

返回值

示例

二、查看模板状态

说明

方法

参数

返回值

示例

三、查询模板列表

说明

方法

参数

返回值

示例

四、模板审核结果推送

说明

推送参数

错误码