Phiên bản API Đồ thị

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.

Đọc

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"
}

Thông số

Điểm cuối này không có bất kỳ thông số nào.

Trường

Trường thông tin	Mô tả
`id` numeric string	ID
`category` enum	The category type of the message template Mặc định
`components` list<WhatsAppBusinessHSMWhatsAppHSMComponentGet>	An array of JSON objects describing the message template components. Mặc định
`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 Mặc định
`library_template_name` string	Template Library name that this HSM is clone from Mặc định
`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. Mặc định
`name` string	The message template name Mặc định
`previous_category` enum	Previous category of the template. See Template Categories. Mặc định
`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} Mặc định
`sub_category` enum	Sub category of the template Mặc định

Đường viền

Cạnh Mô tả

Cạnh	Mô tả
`compare` Edge<WhatsAppBusinessHSMComparison>	compare

compare

Edge<WhatsAppBusinessHSMComparison>

compare

Mã lỗi

Lỗi	Mô tả
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

Tạo

Bạn có thể tạo yêu cầu POST đến cạnh message_templates từ các đường dẫn sau:

/{whats_app_business_account_id}/message_templates

Khi đăng lên cạnh này, hệ thống sẽ tạo a WhatsAppMessageTemplate.

Thông số

Thông số	Mô tả
`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. Bắt buộc
`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. Bắt buộc
`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. Bắt buộc
`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. Bắt buộc
`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. Bắt buộc
`sub_category` enum {ORDER_DETAILS, ORDER_STATUS}	Sub category of the template

Kiểu trả về

Điểm cuối này hỗ trợ đọc sau khi ghi và sẽ đọc nút mà bạn đã đăng vào đó.

Struct {

id: numeric string,

status: enum,

category: enum,

}

Mã lỗi

Lỗi	Mô tả
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

Cập nhật

Bạn có thể cập nhật a WhatsAppMessageTemplate bằng cách thực hiện yêu cầu POST đến /{whats_app_message_template_id}.

Thông số

Thông số	Mô tả
`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. Bắt buộc
`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. Bắt buộc
`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.

Kiểu trả về

Điểm cuối này hỗ trợ đọc sau khi ghi và sẽ đọc nút mà bạn đã đăng vào đó.

Struct {

success: bool,

}

Mã lỗi

Lỗi	Mô tả
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

Xóa

Bạn có thể hủy liên kết a WhatsAppMessageTemplate khỏi a WhatsAppBusinessAccount bằng cách thực hiện yêu cầu DELETE đến /{whats_app_business_account_id}/message_templates.

Thông số

Thông số Mô tả

Thông số	Mô tả
`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. Bắt buộc

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.

Bắt buộc

Kiểu trả về

Struct {

success: bool,

}

Mã lỗi

Lỗi	Mô tả
100	Invalid parameter
190	Invalid OAuth 2.0 Access Token

Nền tảng WhatsApp Business | API Đám mây | API Tại chỗ | API Quản lý kinh doanh