5G视信模板新增

1、概述

使用当前接口可以创建视频短信模板。

2、接口地址

POST https://rcsapi.hanwg.com/v1/mms/template/upload

3、请求参数

3.1、请求路径参数

全局参数

3.2、请求头参数

接口权限校验

3.2、请求体参数

字段 数据类型 是否必有 描述
title string 模板标题
文字个数[0,15]
sign string 签名
文字个数[1, 20]
签名的格式:“【”开头,“】”结尾(签名必须带【】)
content array[object] 条件 模板内容
1.支持文件类型:文本、图片、音频、视频
2.文本支持格式:txt
3.图片支持格式:jpeg、jpg、gif、bmp(不要使用png格式,大部分运营商都不支持)
4.音频支持的格式:amr、mpeg、mp3、aac
5.视频支持的格式:mp4、3gp
6.模板支持带变量,目前只支持图片变量、文字变量
7.图片变量模板上传,支持直接文件和素材编号,暂不支持url
name string 内容每帧的名称
1.文本类型一定不要有名称
2.多媒体类型一定要有名称,即图片、音频、视频时一定要有名称,且名称必须需有文件格式后缀, 如:xx.jpg
index string 标识是第几帧,第几个素材
1.格式为: 帧数_素材数,如:3_3
2.同一帧内不能有相同的文件类型,即每帧最多有4个素材,且文本、图片、音频、视频素材每种最多一个
3.同一个模板,帧不能重名
4.index的帧数最大15
content string 素材内容
1.素材内容支持带变量,目前只支持图片变量
2.使用图片变量,图片变量值唯一:${media_variable},content只能有图片变量,且不能有其它字符。如:“content”: “${media_variable}”
不用图片变量,content不能带图片变量,否则校验不通过,且content必须为base64编码的字串
4. 文本内容支持变量,变量格式:${a,b},最少匹配a个最多匹配b个字,其中a>=0(等于0表示支持空字符串),b>=a且b>0(b的最大值建议在10以内),变量总数建议控制在10个以内。(变量值超过b的长度会导致发送失败)
5.如果sign为空,第一个文本内容前需要写签名,按照sign的格式。sign不为空,content中的签名会当作一般文字处理
6.模板末尾要写回TD退订
7.模板总大小不能超过2M

4、请求示例

4.1、带图片变量

文本+悬浮菜单(上行回复)

POST  /mms/template/upload    HTTP/1.1
Authorization: ZGgxODUyODphODFlMDdhYzEzMGEyNzc5YjU0NjI3YTk3OTEwNzhkOA==
Date: 2023-08-03 14:32:49
Content-Type: application/json
User-Agent: PostmanRuntime/7.31.0
Accept: */*
Postman-Token: a08557cb-7a9d-4a78-b988-32b6ad8a44db
Host: 172.18.1.104:31205
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 536
{
    "title": "mms模板带图片变量",
    "sign": "【签名】",
    "content": [
         {
            "content": "${2,10}特产有:${1,10}${1,10}${1,10}等。",
            "index":"1_1"
        } ,
        {
            "name": "img.jpg",
            "content": "${media_variable}",
            "index": "1_2"
        },
        {
            "name": "音频.mp3",
            "content": "ebfhejuj1ZcuZXHiXXHGVCyREV0vNrteK3Y2Rbkjdfjkgd78978er",
            "index": "1_3"
        },
        {
            "name": "视频.mp4",
            "content": "5+Y8s5+XPzMzGmWMPyrv5vRKzxvFQ3QDRU3VzUPNxiG6lX9/",
            "index": "1_4"
        },
        {   
            "content": "重庆是一座美丽的城市,我爱重庆!回复TD退订,${2,10},${1,10}",
            "index": "2_1"
        }
    ]
}

4.2、不带图片变量

文本+悬浮菜单(上行回复)

POST  /mms/template/upload    HTTP/1.1
Authorization: ZGgxODUyODphODFlMDdhYzEzMGEyNzc5YjU0NjI3YTk3OTEwNzhkOA==
Date: 2023-08-03 14:32:49
Content-Type: application/json
User-Agent: PostmanRuntime/7.31.0
Accept: */*
Postman-Token: a08557cb-7a9d-4a78-b988-32b6ad8a44db
Host: 172.18.1.104:31205
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 536
{
    "title": "mms模板带图片变量",
    "sign": "【签名】",
    "content": [
         {
            "content": "${2,10}特产有:${1,10}${1,10}${1,10}等。",
            "index":"1_1"
        },
        {
            "name": "img.jpg",
            "content": "nz75Piud98JVw3InTYfzK9e/hn99ph25kzHjsdgjdfjgdfhv2OqlsMesX",
            "index": "1_2"
        },
        {
            "name": "音频.mp3",
            "content": "ebfhejuj1ZcuZXHiXXHGVCyREV0vNrteK3Y2Rbkjdfjkgd78978er",
            "index": "1_3"
        },
        {
            "name": "视频.mp4",
            "content": "5+Y8s5+XPzMzGmWMPyrv5vRKzxvFQ3QDRU3VzUPNxiG6lX9/",
            "index": "1_4"
        },
        {   
            "content": "重庆是一座美丽的城市,我爱重庆!回复TD退订,${2,10},${1,10}",
            "index": "2_1"
        }
    ]
}

5、响应参数

名称 数据类型 是否必有 描述
result int 响应状态码
msg string 响应描述
templateNo string 响应内容
模板编号
需要:code = 0(请求成功)

6、响应示例

HTTP/1.1 200 OK
Content-Type: application/json
Transfer-Encoding: chunked
Date: Thu, 16 Feb 2023 07:03:43 GMT
Connection: close

{
  "result" : 0,
  "desc" : "请求成功",
  "templateNo" : "499fdde984ac47b1bbf70582f82458fe",
}
文档更新时间: 2025-12-17 13:17   作者:王超