模板管理
更新时间:2026-07-31 10:01:40
一、创建模板
-
Content-Type: application/json
-
请求方式: json 格式封装的字符串,采用 post 方式提交请求
-
编码格式: utf-8
完整公共请求头、CheckSum 验签算法统一参考:API调用说明
说明
创建视频短信模板,提交模板是变量模板时,变量模板仅文本可添加变量,且最多包含 5 个变量,顺序依次为:${v1}、${v2}、${v3}、${v4}、${v5}
请求体 body
| 参数名称 | 参数类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| templateName | String | 是 | 模板名称 | 视频短信模板 |
| sign | String | 是 | 已经在平台创建的签名 | 【视频短信测试】 |
| body | List | 是 | 模板内容列表 | 见下方嵌套参数 |
| → type | String | 是 | 媒体类型:text / video / audio / image | text |
| → exType | String | 是 | 后缀格式,和 type 配合使用 text:txt video:mp4/3gp audio:mp3 image:jpg/gif/png | txt |
| → content | String | 是 | 文本素材直接传内容,文件素材时(图片、视频、音频等等),可传 base64 和文件 url,根据 contentType 指定 | 变量一 ${v1} |
| → contentType | Int | 条件 | content 类型(文本不考虑该值)。如果是文件时,1:base64,2:文件素材 url。不传默认是:1 | 1 |
| → sort | Int | 是 | 内容排序 | 1 |
| isDynamic | Int | 条件 | 动态模板标记,当创建动态模板时此字段为必须 | 1 |
| templateLink | String | 条件 | 模板链接完整示例 |
接口响应
响应体 body
| 参数名称 | 参数类型 | 描述 | 示例 |
|---|---|---|---|
| code | String | 返回码 | "102000" |
| msg | String | 错误描述 | "请求成功" |
| requestId | String | 请求id | 32位uuid |
| data | Object | ||
| → templateId | String | 模板 id | 127873750216474624 |
请求示例
{
"body": [
{
"exType": "txt",
"content": "变量一 ${v1},变量二 ${v2},变量三 ${v3},变量四 ${v4},变量五 ${v5},拒收请回复R",
"sort": 1,
"type": "text"
}
],
"templateName": "视频短信模板",
"sign": "【视频短信测试】",
"isDynamic": 1
}响应示例
{
"code": "102000",
"msg": "请求成功",
"requestId": "32位uuid",
"data": {
"templateId": "127873750216474624"
}
}二、查看模板状态
-
接口url: https://rcs.253.com/videosms/api/v2/template/getSingleTemplateInfo
-
Content-Type: application/json
-
请求方式: json 格式封装的字符串,采用 post 方式提交请求
-
编码格式: utf-8
完整公共请求头、CheckSum 验签算法统一参考:API调用说明
说明
查询模板状态。
请求体 body
| 参数名称 | 参数类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| templateId | String | 是 | 模板 id | 1410869910296330240 |
接口响应
响应体 body
| 参数名称 | 参数类型 | 描述 | 示例 |
|---|---|---|---|
| code | String | 返回码 | "102000" |
| msg | String | 错误描述 | "请求成功" |
| requestId | String | 请求id | 32位uuid |
| data | Object | ||
| → statusName | String | 模板状态说明 | "审核成功" |
| → status | Int | 模板状态:1 平台审核中 2 运营商审核中 3 审核成功 4 审核失败 | 3 |
| → templateId | String | 模板 id | 146351173975146503 |
| → operator | String[] | 模板可发运营商标识:1 移动 2 联通 3 电信 | ["2", "1", "3"] |
| → rejectReason | String | 审核驳回原因 | |
| → expireFlag | String | 模板有效性:0 失效 1 有效 | |
| → isDynamic | String | 动参或非动参标识:0 非动参 1 动参 |
请求示例
{
"templateId": "1410869910296330240"
}响应示例
{
"code": "102000",
"msg": "请求成功",
"requestId": "32位uuid",
"data": {
"statusName": "审核成功",
"templateId": "146351173975146503",
"operator": ["2", "1", "3"],
"status": 3
}
}三、模板审核结果推送
-
推送方式: POST,创蓝服务器主动推送至用户配置的回调地址
-
Content-Type: application/json
-
编码格式: utf-8
说明
模板审核结果推送,对方接收到状态报告后需要返回:"ok"(直接返回字符串 ok)。
推送参数
| 参数名称 | 参数类型 | 描述 | 示例 |
|---|---|---|---|
| templateId | String | 模板 id | 146xxxxxx23243 |
| status | Int | 模板状态:1 平台审核中 2 运营商审核中 3 审核成功 4 审核失败 | 3 |
| remark | String | 审核备注/说明 | 审核成功 |
| time | String | 推送时间,格式 yyyyMMddHHmmss | 20201030111523 |
| cmccStatus | Int | 移动审核状态:1 审核中 3 审核成功 4 审核失败 | 3 |
| cuccStatus | Int | 联通审核状态:1 审核中 3 审核成功 4 审核失败 | 3 |
| ctccStatus | Int | 电信审核状态:1 审核中 3 审核成功 4 审核失败 | 3 |
| expireFlag | String | 模板有效性:0 失效 1 有效 | 1 |
推送示例
{
"templateId": "146xxxxxx23243",
"status": 3,
"remark": "审核成功",
"time": "20201030111523",
"cmccStatus": 3,
"cuccStatus": 3,
"ctccStatus": 3,
"expireFlag": "1"
}⚠️ 对方接收到推送后需要返回字符串 "ok"
这篇文档对您有帮助吗?




