Skip to main content
Infinity links AI Assistant
I am your AI assistant, what is not clear you can ask me oh!
AI助手

创建模板

域名

  • https://api.incsapp.com

请求路由

  • /external/templates/rcs

请求方式

  • POST

请求头

  • Content-Type: application/json
  • certification-code: f484bd42-4a0c-39d....

请求参数

请求参数列表

参数名 类型 必填 描述
name string 是 模板名称。最大长度 25，只能包含字母数字字符和下划线。例如：test_template
type string 是 模板类型，必须是text,richcard,carousel中的一种，详情参考下述 模板类型说明
content object 是 模板内容，详情参考下述 模板请求示例

模板类型说明

  • 支持的模板类型包括：
    • 文本消息 (text) - 文本消息模板支持包含建议回复或操作的简单文本消息。文本消息最多可包含 11 个建议项。
    • 独立富卡片 (richcard) - 独立富卡片模板允许包含一张富卡片：图片、GIF 或视频，并附带建议回复和操作。该模板中的富卡片最多可包含 4 个建议项。
    • 富卡片轮播 (carousel) - 富卡片轮播模板支持包含至少两张富卡片的轮播展示，其中每张卡片均带有建议回复和操作。富卡片轮播模板最多允许展示 10 张卡片，且每张卡片最多可包含 4 个建议项。

  • suggestions 参数内容说明：
    参数 必填 描述 备注
    suggestionType 否 在建议类型中定义的预定义建议类型 例如：reply
    text 否 建议显示文本。如果使用建议则为必填。最大长度 25（包括变量）。
    postbackData 否 建议回传数据。如果使用建议则为必填。最大长度 120（包括变量）。
    phoneNumber 否 国际格式的有效电话号码。 例如：+919702012345
    url 否 有效的公共 URL 例如：https://brand.com

模板请求示例

  1. 文本消息模板（text）
    • content 参数内容说明：
      参数 必填 描述 备注
      textMessage 是 带有自定义变量的模板消息。自定义变量用方括号 [variable_name] 表示。最大长度 2500。 例如：Dear [name], it is time to grab a big deal.
      suggestions 否 包含建议相关数据的对象 参考：suggestions 参数内容说明

响应

成功响应示例

  • 响应说明参见模板资源说明
{
    "status": "success",
    "code": 200,
    "message": "",
    "data": {
        "template_id": "4166201267033543",
        "name": "test_api_2",
        "language": "en_US",
        "category": "MARKETING",
        "status": "REJECTED",
        "quality": "",
        "components": [
            {
                "type": "BODY",
                "text": "A API test template, first variable: {{1}}, second variable: {{2}}",
                "example": {
                    "body_text": [
                        [
                            1,
                            2
                        ]
                    ]
                }
            },
            {
                "type": "FOOTER",
                "text": "Good night"
            }
        ],
        "created_time": 1755076187,
        "updated_time": 1755076201,
        "status_updated_time": 0,
        "quality_updated_time": 0,
        "category_updated_time": 0
    },
    "error": {}
}

失败响应示例

{
    "status": "error",
    "code": 400,
    "message": "category require",
    "data": {},
    "error": {}
}
Back to top