如何创建,修改,删除和查询消息模板_Chat App 消息服务(Chat App)-阿里云帮助中心

本文为您介绍消息模板相关的接口说明。

创建模板-CreateChatappTemplate

调用当前接口创建ChatApp模板。

消息模板成功创建后会自动送审，消息模板由Facebook进行审核，审核通过后即可发送用于发送消息。

查询模板审核状态，请参见查询ChatApp模板详情。

说明

消息模板用于向客户发起对话。如果持续收到特定消息模板的负面反馈，该模板可能会被禁用，禁用后将不能再使用此模板发送消息给客户，请确保您的模板不包含违规信息。

接口文档

CreateChatappTemplate - 创建ChatApp模板

示例

正常返回示例（JSON格式）：

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A948664****",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "Data": {
    "TemplateCode": "SMS_232907****",
    "TemplateName": "hello_whatsapp"
  }
}

修改模板-ModifyChatappTemplate

调用当前接口修改ChatApp模板。

说明

只有未审核或审核未通过的模板允许修改。

接口文档

ModifyChatappTemplate - 修改ChatApp模板

示例

正常返回示例（JSON格式）：

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "无",
  "Data": {
    "TemplateCode": "8472929283883",
    "TemplateName": "hello_whatsapp"
  }
}

删除模板-DeleteChatappTemplate

调用当前接口删除ChatApp模板。

接口文档

DeleteChatappTemplate - 删除ChatApp模板

示例

正常返回示例（JSON格式）：

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource."
}

查询模板详情-GetChatappTemplateDetai

调用当前接口查询ChatApp模板详情。

详情信息包括：模板名称、模板审核状态、模板code、模板类型、模板语言等。

接口文档

GetChatappTemplateDetail - 查询ChatApp模板详情

示例

正常返回示例（JSON格式）：

{
  "RequestId": "744c4b5c79c9432497a075bdfca3****",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "Data": {
    "Category": "TRANSACTIONAL",
    "TemplateCode": "744c4b5c79c9432497a075bdfca3****",
    "Name": "hello_whatsapp",
    "Language": "en_US",
    "Example": {
      "key": "{\\\"textVariable\\\":\\\"text\\\",\\\"linkVariable\\\":\\\"https://image.developer.aliy\\\"}"
    },
    "AuditStatus": "pass",
    "Components": [
      {
        "Type": "BODY",
        "Url": "https://image.developer.aliyundoc.com",
        "Text": "你好",
        "Caption": "新文件已上传",
        "FileName": "快递文件",
        "Format": "TEXT",
        "Buttons": [
          {
            "Type": "PHONE_NUMBER",
            "Text": "打电话",
            "PhoneNumber": "861398745****",
            "Url": "https://example.com\n",
            "UrlType": "static"
          }
        ],
        "ThumbUrl": "https://img.png",
        "Duration": 50,
        "FileType": "docx"
      }
    ],
    "TemplateType": "WHATSAPP"
  }
}

查询模板列表-ListChatappTemplate

调用当前接口获取ChatApp模板列表。

用于批量查询消息模板类别模板审核状态、模板名称、模板编码等，单次最大允许查询量为10个。

接口文档

ListChatappTemplate - 查询ChatApp模板列表

示例

正常返回示例（JSON格式）：

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "ListTemplate": [
    {
      "TemplateName": "hello_whatsapp",
      "TemplateCode": "744c4b5c79c9432497a075bdfca3****",
      "AuditStatus": "pass",
      "Language": "en",
      "Category": "TRANSACTIONAL",
      "TemplateType": "WHATSAPP"
    }
  ]
}