获取 WhatsApp 消息模板

获取已同步到 PBX 的指定 WhatsApp 渠道的 WhatsApp 消息模板的信息和内容。

请求 URL

GET {base_url}/{api_path}/message_channel/whatsapp_template?access_token={access_token}

请求参数

表 1.
参数 是否必填 类型 说明
omnichannel_id 是 Integer WhatsApp 消息渠道的 ID。
注： 可使用 查询特定消息渠道 接口查询渠道 ID。
category 否 String 模板类别。

取值范围：

  • MARKETING：营销。
  • UTILITY：交易相关。
  • AUTHENTICATION：身份验证。
注： 使用半角逗号 , 分隔多个类别。
language 否 String 模板语言。
注：
  • 此参数的可用取值取决于 PBX 中渠道关联的 WhatsApp 账号下已有模板的语言。要获取有效的语言代码，请先通过此接口查询模板列表，然后使用返回结果中的 language 值。
  • 使用半角逗号 , 分隔多种语言。
search_value 否 String 搜索关键字。
page 否 Integer 定义显示第几个页面。
page_size 否 Integer 定义每页显示几项查询结果。

响应参数

表 2.
参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer WhatsApp 消息模板的总数。
data Array <MSGTemplate_Info> WhatsApp 消息模板的详情。
MSGTemplate_Info
参数 类型 说明
id Integer 消息模板在 PBX 中的 ID。
template_id String 来自 WhatsApp 平台的原始模板 ID。
name String 模板名称。
parameter_format String 模板中占位符 (变量) 的引用方式。
  • POSITIONAL：占位符按位置引用。例如，{{1}}、{{2}}。
  • NAMED：占位符按变量名引用。例如，{{name}}、{{code}}。
language String 模板语言。
category String 模板类别。
sub_category String 模板子类别。
components_data String 模板组件内容 (JSON 字符串格式)。
omnichannel_id Integer 消息渠道 ID。

示例

请求示例

GET /openapi/v1.0/message_channel/whatsapp_template?omnichannel_id=1&access_token=FOgrNFKY6xVQcUxw3pfMTFqCAG6lBulV&search_value=store HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 1,
    "data": [
        {
            "id": 1774,
            "template_id": "2011532696320970",
            "name": "store_offer_notification",
            "parameter_format": "NAMED",
            "language": "en",
            "category": "MARKETING",
            "sub_category": "CUSTOM",
            "components_data": "[{\"type\":\"HEADER\",\"format\":\"LOCATION\"},{\"type\":\"BODY\",\"text\":\"Special offer: {{Offer_Details}}\\n\\nPlease visit our store within {{Time_Limit}} to enjoy this offer.\\n\\nIf you have any questions, feel free to contact us.\"},{\"type\":\"FOOTER\",\"text\":\"We look forward to serving you!\"}]",
            "omnichannel_id": 1
        }
    ]
}