图谱 API 版

Whats App Business Account Message Templates

Represents a collection of templates on a WhatsApp Business Account. See Templates.

读取

Get a list of templates on a WhatsApp Business Account.

Requirements

Type	Description
Access Tokens	User or System User
Permissions	whatsapp_business_management

Request Syntax

GET /<WHATSAPP_BUSINESS_ACCOUNT_ID>/message_templates
  ?category=<CATEGORY>,
  &content=<CONTENT>,
  &language=<LANGUAGE>,
  &name=<NAME>,
  &name_or_content=<NAME_OR_CONTENT>,
  &quality_score=<QUALITY_SCORE>,
  &status=<STATUS>

Path Parameters

Placeholder	Value
`<WHATSAPP_BUSINESS_ACCOUNT_ID>`	WhatsApp Business Account ID.

Response

A list of WhatsApp Message Template nodes.

Sample Request

curl 'https://graph.facebook.com/v16.0/102290129340398/message_templates?category=utility' \
-H 'Authorization: Bearer EAAJB...'

Sample Response

{
  "data": [
    {
      "name": "order_delivery_update",
      "components": [
        {
          "type": "HEADER",
          "format": "LOCATION"
        },
        {
          "type": "BODY",
          "text": "Good news {{1}}! Your order #{{2}} is on its way to the location above. Thank you for your order!",
          "example": {
            "body_text": [
              [
                "Mark",
                "566701"
              ]
            ]
          }
        },
        {
          "type": "FOOTER",
          "text": "To stop receiving delivery updates, tap the button below."
        },
        {
          "type": "BUTTONS",
          "buttons": [
            {
              "type": "QUICK_REPLY",
              "text": "Stop Delivery Updates"
            }
          ]
        }
      ],
      "language": "en_US",
      "status": "APPROVED",
      "category": "UTILITY",
      "id": "1667192013751005"
    },
    ...
  ],
  "paging": {
    "cursors": {
      "before": "MAZDZD",
      "after": "MjQZD"
    }
  }
}

参数

参数	描述
`category` array<enum {ACCOUNT_UPDATE, PAYMENT_UPDATE, PERSONAL_FINANCE_UPDATE, SHIPPING_UPDATE, RESERVATION_UPDATE, ISSUE_RESOLUTION, APPOINTMENT_UPDATE, TRANSPORTATION_UPDATE, TICKET_UPDATE, ALERT_UPDATE, AUTO_REPLY, TRANSACTIONAL, OTP, UTILITY, MARKETING, AUTHENTICATION}>	The category for a template
`content` string	The content for a template
`language` array<string>	A list of supported languages that are available for each template
`name` string	The name for a message template
`name_or_content` string	Returns a list of message templates where the value for `name` or `content` match this value
`quality_score` array<enum {GREEN, YELLOW, RED, UNKNOWN}>	The quality score for a template
`status` array<enum {APPROVED, IN_APPEAL, PENDING, REJECTED, PENDING_DELETION, DELETED, DISABLED, PAUSED, LIMIT_EXCEEDED}>	The review status for a template

字段

从这条连线读取将返回一个 JSON 格式的结果：

{
    "data": [],
    "paging": {},
    "summary": {}
}

`data`

WhatsAppBusinessHSM 节点列表。

`paging`

详细了解分页功能，请见图谱 API 指南。

`summary`

关于连线的汇总信息（例如次数总计）。请指定字段来调取概要中的参数（例如：概要=total_count）。

字段	说明
`total_count` unsigned int32	The total number of message templates that belong to a WhatsApp Business Account
`message_template_count` int32	The current number of message templates that belong to the WhatsApp Business Account
`message_template_limit` int32	The maximum number of message templates that can belong to a WhatsApp Business Account
`are_translations_complete` bool	The status for template translations

错误代码

错误	描述
80008	There have been too many calls to this WhatsApp Business account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.
100	Invalid parameter
200	Permissions error
190	Invalid OAuth 2.0 Access Token
368	The action attempted has been deemed abusive or is otherwise disallowed
2500	Error parsing graph query

创建

你可以通过下列路径向 message_templates 连线发出 POST 请求：

/{whats_app_business_account_id}/message_templates

发布到这个连线会创建 a WhatsAppMessageTemplate 。

Requirements

Type	Description
Access Tokens	User or System User
Permissions	whatsapp_business_management

Request Syntax

POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>/message_templates

Path Parameters

Placeholder	Value
`<WHATSAPP_BUSINESS_ACCOUNT_ID>`	ID of the WhatsApp Business Account to create the template on.

Post Body

See Parameters for property descriptions.

{
  "allow_category_change": <ALLOW_CATEGORY_CHANGE>,
  "name": "<NAME>",
  "language": "<LANGUAGE>",
  "category": "<CATEGORY>",
  "components": [<COMPONENTS>]
}

Response

See Return Type.

Sample Request

curl 'https://graph.facebook.com/v19.0/102290129340398/message_templates' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "name": "seasonal_promotion",
  "language": "en",
  "category": "MARKETING",
  "components": [
    {
      "type": "HEADER",
      "format": "TEXT",
      "text": "Our {{1}} is on!",
      "example": {
        "header_text": [
          "Summer Sale"
        ]
      }
    },
    {
      "type": "BODY",
      "text": "Shop now through {{1}} and use code {{2}} to get {{3}} off of all merchandise.",
      "example": {
        "body_text": [
          [
            "the end of August","25OFF","25%"
          ]
        ]
      }
    },
    {
      "type": "FOOTER",
      "text": "Use the buttons below to manage your marketing subscriptions"
    },
    {
      "type":"BUTTONS",
      "buttons": [
        {
          "type": "QUICK_REPLY",
          "text": "Unsubcribe from Promos"
        },
        {
          "type":"QUICK_REPLY",
          "text": "Unsubscribe from All"
        }
      ]
    }
  ]
}'

Sample Response

{
    "id": "594425479261596",
    "status": "PENDING",
    "category": "MARKETING"
}

参数

参数	描述
`allow_category_change` boolean	Set to `true` to allow us to assign a category based on our template guidelines and the template's contents. This can prevent the template `status` from immediately being set to `REJECTED` upon creation due to miscategorization. If omitted, template will not be auto-assigned a category and its status may be set to `REJECTED` if determined to be miscategorized. See Template Categories.
`category` enum {UTILITY, MARKETING, AUTHENTICATION}	Template category. See Template Categories. 必填
`components` array<JSON object>	Array of components that make up the template. See Template Components. For types `HEADER`, `BODY`, `FOOTER`, `text` is required.
`type` enum {GREETING, HEADER, BODY, FOOTER, BUTTONS, CAROUSEL, LIMITED_TIME_OFFER}	Component type. 必填
`format` enum {TEXT, IMAGE, DOCUMENT, VIDEO, LOCATION}	Component format.
`text` string	Required for components with type `HEADER`,`BODY`, or `FOOTER`. Component text.
`buttons` array<JSON object>	Button components to be used in the template.
`type` enum {QUICK_REPLY, URL, PHONE_NUMBER, OTP, MPM, CATALOG, FLOW, VOICE_CALL}	Button type. 必填
`text` string	Button text.
`url` URI	url
`phone_number` phone number string	phone_number
`example` array<string>	example
`flow_id` int64	flow_id
`zero_tap_terms_accepted` boolean	zero_tap_terms_accepted
`example` JSON object	Placeholder examples. Templates will not be approved without examples.
`header_text` array<string>	header_text
`body_text` array<array<string>>	body_text
`header_handle` array<string>	header_handle
`language` string	Template location and locale code. 必填
`message_send_ttl_seconds` int64	Time to live for message template sent. If users are offline for more than TTL duration after message template is sent, message will be dropped from message queue and will not be delivered. Only allowed for authentication message templates.
`name` string	Template name. 必填
`sub_category` enum {ORDER_DETAILS, ORDER_STATUS}	Sub category of the template

返回类型

这个端点支持先写后读，并会读取接收你的 POST 请求的节点。

Struct {

id: numeric string,

status: enum,

category: enum,

}

错误代码

错误	描述
80008	There have been too many calls to this WhatsApp Business account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.
100	Invalid parameter
192	Invalid phone number
200002	HSM Template creation failed
131009	Parameter value is not valid
368	The action attempted has been deemed abusive or is otherwise disallowed
200	Permissions error

更新

你无法在此端点执行该操作。

删除

你可以向 /{whats_app_business_account_id}/message_templates 发出 DELETE 请求，将 a WhatsAppMessageTemplate 与 a WhatsAppBusinessAccount 取消关联。

Requirements

Type	Description
Access Tokens	User or System User
Permissions	whatsapp_business_management

Request Syntax

DELETE /<WHATSAPP_BUSINESS_ACCOUNT_ID>/message_templates

Path Parameters

Placeholder	Value
`<WHATSAPP_BUSINESS_ACCOUNT_ID>`	ID of the WhatsApp Business Account that owns the template.

Response

See Return Type.

Sample Request

curl -X DELETE 'https://graph.facebook.com/v19.0/102290129340398/message_templates?name=order_confirmation' \
-H 'Authorization: Bearer EAAJB...'

Sample Response

{
  "success": true
}

参数

参数描述

参数	描述
`hsm_id` whatsapp business hsm ID	ID of template to be deleted. Required if deleting a template by ID.
`name` string	Name of template to be deleted. 必填

hsm_id

whatsapp business hsm ID

ID of template to be deleted. Required if deleting a template by ID.

name

string

Name of template to be deleted.

必填

返回类型

Struct {

success: bool,

}

错误代码

错误	描述
100	Invalid parameter
80008	There have been too many calls to this WhatsApp Business account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.
190	Invalid OAuth 2.0 Access Token

WhatsApp Business 开放平台 | 云端 API | 本地 API | Business 管理 API