图谱 API 版

WhatsApp Message Template

Represents a specific message template. Make the API call to the message template ID.

To find a message template ID, call https://graph.facebook.com/v19.0/{whatsapp-business-account-ID}/message_templates.

For more information on how to use the API, see WhatsApp Business Management API.

读取

Retrieves information about the message template

Example

Requirements

whatsapp_business_management permission
whatsapp_business_messaging permission
public_profile permission
WHATSAPP MESSAGE TEMPLATE ID
USER ACCESS TOKEN

Request

curl -i -X GET \
 "https://graph.facebook.com/LATEST-VERSION/WHATS-APP-MESSAGE-TEMPLATE-ID?access_token=USER-ACCESS-TOKEN"

GraphRequest request = GraphRequest.newGraphPathRequest(
  accessToken,
  "/WHATS-APP-MESSAGE-TEMPLATE-ID",
  new GraphRequest.Callback() {
    @Override
    public void onCompleted(GraphResponse response) {
      // Insert your code here
    }
});

request.executeAsync();

FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
    initWithGraphPath:@"/WHATS-APP-MESSAGE-TEMPLATE-ID"
           parameters:nil
           HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection, id result, NSError *error) {
    // Insert your code here
}];

Response

{
  "name": "shiptest",
  "components": [
    {
      "type": "BODY",
      "text": "testing"
    }
  ],
  "language": "en_US",
  "status": "REJECTED",
  "category": "TRANSACTIONAL",
  "id": "WHATS-APP-MESSAGE-TEMPLATE-ID"
}

参数

这个端点不包含任何参数。

字段

字段	描述
`id` numeric string	ID
`category` enum	The category type of the message template 默认
`components` list<WhatsAppBusinessHSMWhatsAppHSMComponentGet>	An array of JSON objects describing the message template components. 默认
`cta_url_link_tracking_opted_out` bool	Optional boolean field for opting out/in of link tracking at template level
`language` string	The language (and locale) of the element translation 默认
`library_template_name` string	Template Library name that this HSM is clone from 默认
`message_send_ttl_seconds` integer	Template message delivery retry time-to-live (TTL) override value. If unable to deliver the template message to the WhatsApp user, we will periodically retry for this period of time. If we are unable to deliver the message for this period of time, the message will be dropped. Only allowed for authentication message templates. See Time-To-Live. 默认
`name` string	The message template name 默认
`previous_category` enum	Previous category of the template. See Template Categories. 默认
`quality_score` WhatsAppBusinessHSMWhatsAppBusinessHSMQualityScoreShape	Quality score of the HSM
`rejected_reason` enum	The reason the message template was rejected enum {ABUSIVE_CONTENT, INVALID_FORMAT, NONE, PROMOTIONAL, TAG_CONTENT_MISMATCH, SCAM}
`status` enum	The status of the message template enum {APPROVED, IN_APPEAL, PENDING, REJECTED, PENDING_DELETION, DELETED, DISABLED, PAUSED, LIMIT_EXCEEDED} 默认
`sub_category` enum	Sub category of the template 默认

连线

连线描述

连线	描述
`compare` Edge<WhatsAppBusinessHSMComparison>	compare

compare

Edge<WhatsAppBusinessHSMComparison>

compare

错误代码

错误	描述
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.
104	Incorrect signature

创建

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

/{whats_app_business_account_id}/message_templates

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

参数

参数	描述
`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
200	Permissions error
368	The action attempted has been deemed abusive or is otherwise disallowed
190	Invalid OAuth 2.0 Access Token
139000	Blocked by Integrity

更新

你可以向 /{whats_app_message_template_id} 发出 POST 请求，以更新 a WhatsAppMessageTemplate 。

参数

参数	描述
`category` enum {UTILITY, MARKETING, AUTHENTICATION}	category
`components` array<JSON object>	The array containing all the content of the message template
`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
`flow_id` int64	flow_id
`zero_tap_terms_accepted` boolean	zero_tap_terms_accepted
`message_send_ttl_seconds` int64	Template message delivery retry time-to-live (TTL) override value. If unable to deliver the template message to the WhatsApp user, we will periodically retry for this period of time. If we are unable to deliver the message for this period of time, the message will be dropped. Only allowed for authentication message templates. See Time-To-Live.

返回类型

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

Struct {

success: bool,

}

错误代码

错误	描述
100	Invalid parameter
192	Invalid phone number
368	The action attempted has been deemed abusive or is otherwise disallowed
131009	Parameter value is not valid

删除

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

参数

参数描述

参数	描述
`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
190	Invalid OAuth 2.0 Access Token

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