API Graph
Version API du graphe

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/v21.0/{whatsapp-business-account-ID}/message_templates.

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

Lecture

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

Paramètres

Ce point de terminaison n’a aucun paramètre.

Champs

ChampDescription
id
numeric string

ID

category
enum

The category type of the message template

Par défaut
components
list<WhatsAppBusinessHSMWhatsAppHSMComponentGet>

An array of JSON objects describing the message template components.

Par défaut
correct_category
enum

The correct category for the template.

Par défaut
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

Par défaut
library_template_name
string

Template Library name that this HSM is clone from

Par défaut
message_send_ttl_seconds
integer

Template message delivery retry time-to-live (TTL) override value. If we are unable to deliver a message to a WhatsApp user, we will retry the delivery for a period of time known as a time-to-live, TTL, or the message validity period.

TTL can be configured for certain message types. See Time-To-Live.

Par défaut
name
string

The message template name

Par défaut
parameter_format
enum

parameter_format

Par défaut
previous_category
enum

Previous category of the template. See Template Categories.

Par défaut
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}

Par défaut
sub_category
enum

Sub category of the template

Par défaut

Arêtes

ArêteDescription
compare
Edge<WhatsAppBusinessHSMComparison>

compare

Error Codes

ErreurDescription
80008There 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.
100Invalid parameter
104Incorrect signature
190Invalid OAuth 2.0 Access Token

Création

You can make a POST request to message_templates edge from the following paths:
When posting to this edge, a WhatsAppMessageTemplate will be created.

Paramètres

ParamètreDescription
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.

Obligatoire
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.

Obligatoire
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, APP, POSTBACK}

Button type.

Obligatoire
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

flow_action
enum {NAVIGATE, DATA_EXCHANGE}

flow_action

navigate_screen
string

navigate_screen

supported_apps
array<JSON object>

supported_apps

package_name
string

package_name

Obligatoire
signature_hash
string

signature_hash

Obligatoire
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

Obligatoire
library_template_body_inputs
JSON object

Optional data during creation of a template from a library template. These are optional fields for the body component.

add_contact_number
boolean

add_contact_number

add_learn_more_link
boolean

add_learn_more_link

add_security_recommendation
boolean

add_security_recommendation

add_track_package_link
boolean

add_track_package_link

code_expiration_minutes
int64

code_expiration_minutes

library_template_button_inputs
array<JSON object>

Optional data during creation of a template from a library template. These are optional fields for the button component.

type
enum {QUICK_REPLY, URL, PHONE_NUMBER, OTP, MPM, CATALOG, FLOW, VOICE_CALL, APP, POSTBACK}

type

Obligatoire
phone_number
string

phone_number

url
JSON object

url

base_url
string

base_url

Obligatoire
url_suffix_example
string

url_suffix_example

otp_type
enum {COPY_CODE, ONE_TAP, ZERO_TAP}

otp_type

zero_tap_terms_accepted
boolean

zero_tap_terms_accepted

supported_apps
array<JSON object>

supported_apps

package_name
string

package_name

Obligatoire
signature_hash
string

signature_hash

Obligatoire
library_template_name
string

library_template_name

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, we will retry the delivery for a period of time known as a time-to-live, TTL, or the message validity period.

TTL can be configured for certain message types. See Time-To-Live.

name
string

Template name.

Obligatoire
parameter_format
enum {NAMED, POSITIONAL}

The parameter format of the template

sub_category
enum {ORDER_DETAILS, ORDER_STATUS}

Sub category of the template

Type de retour

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
id: numeric string,
status: enum,
category: enum,
}

Error Codes

ErreurDescription
100Invalid parameter
192Invalid phone number
131009Parameter value is not valid
368The action attempted has been deemed abusive or is otherwise disallowed
80008There 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.
200Permissions error
139002Publishing attempt failed
190Invalid OAuth 2.0 Access Token

Mise à jour

You can update a WhatsAppMessageTemplate by making a POST request to /{whats_app_message_template_id}.

Paramètres

ParamètreDescription
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.

Obligatoire
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, APP, POSTBACK}

Button type.

Obligatoire
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

flow_action
enum {NAVIGATE, DATA_EXCHANGE}

flow_action

navigate_screen
string

navigate_screen

supported_apps
array<JSON object>

supported_apps

package_name
string

package_name

Obligatoire
signature_hash
string

signature_hash

Obligatoire
message_send_ttl_seconds
int64

Template message delivery retry time-to-live (TTL) override value.If we are unable to deliver a message to a WhatsApp user, we will retry the delivery for a period of time known as a time-to-live, TTL, or the message validity period. If we are unable to deliver the message for this period of time, the message will be dropped.

TTL can be configured for certain message types. See Time-To-Live.

parameter_format
enum {NAMED, POSITIONAL}

The parameter format of the template

Type de retour

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}

Error Codes

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

Suppression

You can dissociate a WhatsAppMessageTemplate from a WhatsAppBusinessAccount by making a DELETE request to /{whats_app_business_account_id}/message_templates.

Paramètres

ParamètreDescription
hsm_id
numeric string

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

name
string

Name of template to be deleted.

Obligatoire

Type de retour

Struct {
success: bool,
}

Error Codes

ErreurDescription
100Invalid parameter
80008There 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.
190Invalid OAuth 2.0 Access Token