5G消息模板新增

1、概述

5G消息模板：消息的展示样式，可以创建文本、文件、单卡片、多卡片、地理位置5种样式。消息模板需要给平台进行审核，审核通过后才能发送给手机终端。消息模板可以设置变量，在消息发送时需要填写实际值来替换变量，带有变量的模板称为变量模板。

5G消息模板是专为支持5G的手机所提供的一种富媒体消息展示形式，对于不支持5G的手机，可以设置回落消息，回落消息将以“漏斗”选择机制匹配手机终端支持的消息格式，给手机终端发送消息。

通过接口，用户可以新增自己定义的模板。该接口数据输入输出均采用json格式封装的字符串，编码（对整个请求的字符串编码）统一为UTF-8，采用POST方式提交请求。

	素材	模板
需要审核	是	是
需要报备	是	否

2、接口地址

POST https://rcsapi.hanwg.com/rcs/template/addTemplate/{{chatbotId}}

3、请求参数

3.1、请求路径参数

见全局参数

3.2、请求头参数

见接口权限校验

3.3、请求体参数

模板中的素材必须审核通过才能成功上传模板

名称	数据类型	是否必有	描述
templateName	string	是	模板名称文字个数[1, 17]
label	string	否	模板标签多个以“,”分隔
storeSupported	bool	否	是否离线存储 true（默认）终端手机关机时，消息会存储在网关，手机开机后，网关会发送消息 false
smsSupported	int	否	回落类型 0：不回落（默认） 1：短信回落 2：5G视信回落 3：CH5仿真回落 4：智能消息回落
smsContent	string	条件	回落的内容当：smsSupported = 1时，填写短信内容，无需手动添加签名，平台会在短信开头自动添加签名，如果有签名就会当作内容下发。文字个数[1, 200] 2时，填写5G视信的模板编号，模板编号请在平台获取，或者通过【上传超级短信模板（5G视信模板）】获取 3时，填写CH5回落的短信提示内容，【例：给您发了一条 5G 消息，请访问${xx_rcs_h5_url}查看】。${xx_rcs_h5_url}代表回落为CH5消息的链接变量，由平台自动替换，请勿编辑。平台会自动给消息添加签名。 4时，填写智能消息模板编号，模板编号请在平台获取，或者通过【智能消息API文档】获取。注意：请勿在该字段中添加签名，因为系统将会自动添加Chatbot签名。计费时，总字符数将包括自动添加的签名字符及该字段的字符数，请务必注意计费细节。
message	object	是	消息内容对象有5种类型：文本，文件，单卡片，多卡片，地理位置信息

为模板添加变量，变量会在模板发送时替换：

变量规则

4、请求示例

4.1、文本模板

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

POST /rcs/template/addTemplate/a92e43085a0049ba8928b61fa04eeee HTTP/1.1
Authorization: ZGgxODUyODphODFlMDdhYzEzMGEyNzc5YjU0NjI3YTk3OTEwNzhkOA==
Date: 2023-02-16 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

{
  "templateName": "文本模板",
  "label": "海洋,森林",
  "storeSupported": true,
  "smsSupported": 0,
  "smsContent": "",
  "message": {
    "contentType": "text/plain",
    "contentEncoding": "utf8",
    "contentText": "回复Y确认订阅",
    "suggestion": [
      {
        "reply": {
          "displayText": "Y",
          "postback": {
            "data": "回执操作"
          }
        }
      }
    ]
  }
}

4.2、文件模板

文件+悬浮菜单(上行回复+拨打电话+打开链接)

POST /rcs/template/addTemplate/a92e43085a0049ba8928b61fa04eeee HTTP/1.1
Authorization: ZGgxODUyODoxMzlkYjdmYTI0MjhiODZiM2MxNzVjZDUwZWFlNDdkMQ==
Date: 2023-02-16 14:38:43
Content-Type: application/json
User-Agent: PostmanRuntime/7.31.0
Accept: */*
Postman-Token: 95e8f176-b998-4536-b228-c5abe69e044c
Host: 172.18.1.104:31205
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 1463

{
  "templateName": "文件模板",
  "label": "海洋,森林",
  "storeSupported": false,
  "smsSupported": 0,
  "smsContent": "",
  "message": {
    "contentType": "application/vnd.gsma.rcs-ft-http",
    "contentEncoding": "utf8",
    "contentText": {
      "fileId": "material_001"
    },
    "suggestion": [
      {
        "reply": {
          "displayText": "Y",
          "postback": {
            "data": "回执操作"
          }
        }
      },
      {
        "action": {
          "displayText": "普通拨号",
          "postback": {
            "data": "回执操作"
          },
          "dialerAction": {
            "dialPhoneNumber": {
              "phoneNumber": "15766666666"
            }
          }
        }
      },
      {
        "action": {
          "displayText": "打开链接",
          "postback": {
            "data": "回执操作"
          },
          "urlAction": {
            "openUrl": {
              "url": "https://www.baidu.com",
              "application": “browser”
            }
          }
        }
      }
    ]
  }
}

4.3、单卡片模板+智能消息回落

单卡片+建议菜单(撰写消息)+悬浮菜单(打开链接+地理位置)+智能消息回落

POST /rcs/template/addTemplate/a92e43085a0049ba8928b61fa04eeee HTTP/1.1
Authorization: ZGgxODUyODo0N2RmYzM5N2RjMjMzNTI3NWM0ZjU2M2Q2OTA4NTMxOQ==
Date: 2023-02-16 15:23:48
Content-Type: application/json
User-Agent: PostmanRuntime/7.31.0
Accept: */*
Postman-Token: f3677217-64c0-48e9-8a54-774a29e84bf0
Host: 172.18.1.104:31205
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 2782

{
    "templateName": "单卡片模板",
    "label": "海洋,森林",
    "storeSupported": false,
    "smsSupported": 4,
    "smsContent": "499fdde984ac47b1bbf70582f82458fe",
    "message": {
        "contentType": "application/vnd.gsma.botmessage.v1.0+json",
        "contentEncoding": "utf8",
        "contentText": {
            "generalPurposeCard": {
                "layout": {
                    "cardOrientation": "VERTICAL",
                    "titleFontStyle": [
                        "bold"
                    ],
                    "descriptionFontStyle": [
                        "italics"
                    ]
                },
                "content": {
                    "media": {
                        "mediaId": "material_001",
                        "height": "TALL_HEIGHT"
                    },
                    "title": "卡片标题",
                    "description": "卡片描述",
                    "suggestions": [
                        {
                            "action": {
                                "displayText": "短信草稿",
                                "postback": {
                                    "data": "回执操作"
                                },
                                "composeAction": {
                                    "composeTextMessage": {
                                        "phoneNumber": "15766666666",
                                        "text": "消息内容"
                                    }
                                }
                            }
                        }
                    ]
                }
            }
        },
        "suggestion": [
            {
                "action": {
                    "displayText": "打开链接",
                    "postback": {
                        "data": "回执操作"
                    },
                    "urlAction": {
                        "openUrl": {
                            "url": "https://www.baidu.com",
                            "application": “browser”
                        }
                    }
                }
            },
            {
                "action": {
                    "displayText": "地理位置/展示位置",
                    "postback": {
                        "data": "回执操作"
                    },
                    "mapAction": {
                        "showLocation": {
                            "location": {
                                "longitude": "116.403978",
                                "latitude": "39.915031",
                                "label": "标签"
                            }
                        }
                    }
                }
            }
        ]
    }
}

4.4、多卡片模板+ch5回落

多卡片+建议菜单(撰写消息+设置日历)+悬浮菜单(打开链接)+ch5回落

POST /rcs/template/addTemplate/a92e43085a0049ba8928b61fa04eeee HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: ZGgxODUyODpmNjg5Y2Y1Y2NiMmYzODAzMWMyYTlhNTBmYjExMzRhNA==
Date: 2023-02-16 15:51:59
User-Agent: PostmanRuntime/7.31.0
Postman-Token: 52f2fd6c-e671-444c-bf52-3be686069d78
Host: 172.18.1.104:31205
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 3579

{
  "templateName": "多卡片模板",
  "label": "海洋,森林",
  "storeSupported": false,
  "smsSupported": 3,
  "smsContent": "给您发了一条5G消息，请点击链接访问：${dh_rcs_h5_url}",
  "message": {
    "contentType": "application/vnd.gsma.botmessage.v1.0+json",
    "contentEncoding": "utf8",
    "contentText": {
      "generalPurposeCardCarousel": {
        "layout": {
          "cardWidth": "MEDIUM_WIDTH",
          "titleFontStyle": [
            "bold"
          ],
          "descriptionFontStyle": [
            "italics"
          ]
        },
        "content": [
          {
            "media": {
              "mediaId": "material_001",
              "height": "TALL_HEIGHT"
            },
            "title": "卡片1标题",
            "description": "卡片1描述",
            "suggestions": [
              {
                "action": {
                  "displayText": "短信草稿",
                  "postback": {
                    "data": "回执操作"
                  },
                  "composeAction": {
                    "composeTextMessage": {
                      "phoneNumber": "15766666666",
                      "text": "消息内容"
                    }
                  }
                }
              }
            ]
          },
          {
            "media": {
              "mediaId": "material_002",
              "height": "SHORT_HEIGHT"
            },
            "title": "卡片2标题",
            "description": "卡片2描述",
            "suggestions": [
              {
                "action": {
                  "displayText": "设置日历",
                  "postback": {
                    "data": "回执操作"
                  },
                  "calendarAction": {
                    "createCalendarEvent": {
                      "startTime": "2022-12-08",
                      "endTime": "2022-12-09",
                      "title": "结婚纪念日",
                      "description": "5201314"
                    }
                  }
                }
              }
            ]
          }
        ]
      }
    },
    "suggestion": [
      {
        "action": {
          "displayText": "打开链接",
          "postback": {
            "data": "回执操作"
          },
          "urlAction": {
            "openUrl": {
              "url": "https://www.baidu.com",
              "application": “browser”
            }
          }
        }
      }
    ]
  }
}

4.5、地理位置模板+视信回落

地理位置+悬浮菜单(获取设备信息)+视信回落

POST /rcs/template/addTemplate/a92e43085a0049ba8928b61fa04eeee HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: ZGgxODUyODo4YWE4Y2NiODkzOTM2MmFlNzEyY2E1OWQ3N2Y0ZTExMQ==
Date: 2023-02-16 15:55:18
User-Agent: PostmanRuntime/7.31.0
Postman-Token: 13d2ebeb-f0de-4228-9d0d-2afccf3dab23
Host: 172.18.1.104:31205
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 741

{
  "templateName": "地理位置模板",
  "label": "海洋,森林",
  "storeSupported": false,
  "smsSupported": 2,
  "smsContent": "228addd350f5456d8d9df1d0f028c537",
  "message": {
    "contentType": "text/plain",
    "contentEncoding": "utf8",
    "contentText": "geo:39.915031,116.403978;crs=gcj02;u=10;rcs-l=天安门",
    "suggestion": [
      {
        "action": {
          "displayText": "获取设备信息",
          "postback": {
            "data": "回执操作"
          },
          "deviceAction": {
            "requestDeviceSpecifics": {}
          }
        }
      }
    ]
  }
}

4.6、单卡片(动态参数)+智能消息(动态参数)

单卡片(动态参数)+智能消息(动态参数)

POST /rcs/template/addTemplate/a92e43085a0049ba8928b61fa04eeee HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: ZGgxODUyODpiYTQxYzY4Njg1ODJmOGMxMjJhZGM3ZjRmYWMwMWNjNA==
Date: 2023-02-16 16:01:55
User-Agent: PostmanRuntime/7.31.0
Postman-Token: b0adafd3-323d-40cd-a729-c1a971fd2edf
Host: 172.18.1.104:31205
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 2763

{
  "templateName": "单卡片模板",
  "label": "海洋,森林",
  "storeSupported": false,
  "smsSupported": 0,
  "smsContent": "",
  "message": {
    "contentType": "application/vnd.gsma.botmessage.v1.0+json",
    "contentEncoding": "utf8",
    "contentText": {
      "generalPurposeCard": {
        "layout": {
          "cardOrientation": "VERTICAL",
          "titleFontStyle": [
            "bold"
          ],
          "descriptionFontStyle": [
            "italics"
          ]
        },
        "content": {
          "media": {
            "mediaId": "material_000001",
            "height": "TALL_HEIGHT"
          },
          "title": "卡片${title}",
          "description": "卡片${description}",
          "suggestions": [
            {
              "action": {
                "displayText": "短信草稿",
                "postback": {
                  "data": "回执操作"
                },
                "composeAction": {
                  "composeTextMessage": {
                    "phoneNumber": "15766666666",
                    "text": "消息内容"
                  }
                }
              }
            }
          ]
        }
      }
    },
    "suggestion": [
      {
        "action": {
          "displayText": "打开链接",
          "postback": {
            "data": "回执操作"
          },
          "urlAction": {
            "openUrl": {
              "url": "https://www.baidu.com",
              "application": “browser”
            }
          }
        }
      },
      {
        "action": {
          "displayText": "地理位置/展示位置",
          "postback": {
            "data": "回执操作"
          },
          "mapAction": {
            "showLocation": {
              "location": {
                "longitude": "116.403978",
                "latitude": "39.915031",
                "label": "标签"
              }
            }
          }
        }
      }
    ]
  }
}

5、响应参数

名称		数据类型	是否必有	描述
code		int	是	响应状态码
desc		string	是	请求响应描述
result		object	条件	请求响应内容必需：code = 0（请求成功）
	templateId	string	条件	上传成功后返回的模板编号

6、响应示例

HTTP/1.1 200 OK
Content-Type: application/json
Transfer-Encoding: chunked
Date: Thu, 16 Feb 2023 06:32:50 GMT
Connection: close

{
  "code": 0,
  "desc": "请求成功",
  "result": {
    "templateId": "b3aed3e2a241437dab082a19c2905531"
  }
}

文档更新时间: 2026-05-15 14:36 作者：王超

5G消息新增模板