{ "info": { "_postman_id": "ff2c210f-2e31-4649-aea8-0a183b438203", "name": "WhatsApp Cloud API", "description": "[WhatsApp Cloud API](https://developers.facebook.com/docs/whatsapp/cloud-api), hosted by Meta, is the official WhatsApp Business Platform API used for business messaging. This collection contains common queries, sample responses, and links to supporting documentation that can help you quickly get started with the API.\n\n## **Cloud API Overview**\n\nCloud API allows medium and large businesses to communicate with customers at scale. Using the API, businesses can build systems that connect thousands of customers with agents or bots, enabling both programmatic and manual communication. Additionally, businesses can integrate the API with numerous backend systems, such as CRM and marketing platforms.\n\n[https://developers.facebook.com/docs/whatsapp/cloud-api/overview](https://developers.facebook.com/docs/whatsapp/cloud-api/overview)\n\n## Getting Started with Cloud API\n\nTo use the API and this collection you must have a Meta business portfolio, a WhatsApp Business Account, and a business phone number. If you complete the steps in the Cloud API [Get Started](https://developers.facebook.com/docs/whatsapp/cloud-api/get-started) guide, these assets will be created for you.\n\n## Get Started as a Solution Partner\n\n[This guide](https://developers.facebook.com/docs/whatsapp/solution-providers/get-started-for-solution-partners) goes over the steps Solution Partners need to take in order to offer the Cloud API to their customers.\n\n## Migrating from On-Premises API to Cloud API\n\n[This guide explains how to migrate](https://developers.facebook.com/docs/whatsapp/cloud-api/guides/migrating-from-onprem-to-cloud) business phone numbers from On-Premises API to Cloud API.\n\n## Environment\n\nThis collection has a corresponding WhatsApp Cloud API Postman [environment](https://learning.postman.com/docs/sending-requests/managing-environments/) which you must select when using the collection. Set **current values** for the variables defined in this environment if you wish to use the collection to perform queries.\n\nYou can find most of these values in the [WhatsApp Manager](https://business.facebook.com/wa/manage/home/) or the **WhatsApp** > **Getting Started** panel in the [app dashboard](https://developers.facebook.com/apps). However, if you have an access token and your business portfolio ID, you can use queries in the collection to get the remaining values.\n\n## Access tokens\n\nThe API supports both user and system user access tokens. You can get a user access token by loading your app in the [app dashboard](https://developers.facebook.com/apps) and navigating to the WhatsApp > Getting Started panel. Alternatively you can use the [Graph API Explorer](https://developers.facebook.com/tools/explorer/) to generate one.\n\nSince user access tokens expire after 24 hours, you'll likely want to generate a system user access token, which lasts up to 60 days (or permanently, if you wish). See [Access Tokens](https://developers.facebook.com/docs/whatsapp/business-management-api/get-started#access-tokens) to learn how to create a system user and system user access token.\n\nOnce you have your token, save it as a **current value** in the environment.\n\n## Business portfolio ID\n\nYou can get your business portfolio ID by signing into the [Meta Business Suite](https://business.facebook.com). The ID appears in the URL as the `business_id` query string parameter value. Once you save this as a **current value** in the environment, go to the WhatsApp Business Account (WABA) folder and run the **Get all owned WABAs** query. This will return your WABA ID, which you can save to your environment and then use to determine your business phone number ID.\n\n## Permissions\n\nThe API only relies on two permissions:\n\n- whatsapp_business_management\n \n- whatsapp_business_messaging\n \n\nNote that if you get a user access token from the app dashboard, your app will automatically be granted these permissions (by you, on your behalf), so you can use the token to test right away.\n\nQueries that target your business portfolio require the business_management permission, which you may also need based on your business use case. Most developers do not need this permission, however, as accessing your business portfolio is uncommon, and the Meta Business Suite provides nearly all of this functionality anyway.\n\n## Access token debugger\n\nYou can paste any token you generate into the [access token debugger](https://developers.facebook.com/tools/debug/accesstoken/) to see what type of token it is and what permission you have granted to your app.\n\n## Pagination\n\nEndpoints that return lists/collections may [paginate results](https://developers.facebook.com/docs/graph-api/results) (you'll see previous and next properties in the response). Use the URLs from these properties to get the previous or next set of results. Note that if you click one of these links in Postman, it will open a new query in a new tab which you must save before running (otherwise it can't read your environment variables), so you may wish to cut and paste the URL and run the query in the same tab in which it was returned.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "23406602", "_collection_link": "https://hakach-team.postman.co/workspace/f6071ca8-7717-4ed0-8c8e-c2cbd4a100ea/collection/23406602-ff2c210f-2e31-4649-aea8-0a183b438203?action=share&source=collection_link&creator=23406602" }, "item": [ { "name": "Get Started", "item": [ { "name": "Subscribe to your WABA", "request": { "method": "POST", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/subscribed_apps", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "subscribed_apps" ] }, "description": "To make sure you receive notifications for your account you need to subscribe your app to your WABA.\n\n#### Response\n\nIf your request is successful, all Webhook events for the phone numbers under this account are sent to your configured Webhooks endpoint." }, "response": [ { "name": "Subscribe to your WABA", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/subscribed_apps", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "subscribed_apps" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"success\": \"true\"\n}" } ] }, { "name": "Get Phone Number ID", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/phone_numbers", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "phone_numbers" ] }, "description": "To send messages, you need to register the phone number you want to use. This is the business phone number we mentioned in [Set up Assets](https://developers.facebook.com/docs/whatsapp/cloud-api/get-started#set-up-assets).\n\nBefore you can proceed to registration, you need to find that phone number’s ID.\n\n#### Response\n\nIf the request is successful, the response includes all phone numbers connected to your WABA.\n\nSave the ID for the phone number you want to register. For more information about this endpoint, see [Read Phone Numbers](https://developers.facebook.com/docs/whatsapp/business-management-api/phone-numbers).\n\n#### Migration Exception\n\nIf you are migrating a phone number from the On-Premises API to the Cloud API, there are extra steps you need to perform before registering a phone number with the Cloud API. For more information regarding the full process, see [Migrate Between On-Premises and Cloud API](#79b8156b-8c83-4db9-94ac-dd9aaaa67390).\n\nTo get your phone number’s ID, make the following API call:" }, "response": [ { "name": "Get Phone Number ID", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/phone_numbers", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "phone_numbers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"verified_name\": \"Jasper's Market\",\n \"display_phone_number\": \"+1 631-555-5555\",\n \"id\": \"1906385232743451\",\n \"quality_rating\": \"GREEN\"\n },\n {\n \"verified_name\": \"Jasper's Ice Cream\",\n \"display_phone_number\": \"+1 631-555-5556\",\n \"id\": \"1913623884432103\",\n \"quality_rating\": \"NA\"\n }\n ]\n}" } ] }, { "name": "Register Phone Number", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"pin\": \"6-digit-pin\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/register", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "register" ] }, "description": "With your phone number’s ID in hand, you can register it. In the registration API call, you perform two actions at the same time:\n\n1. Register the phone.\n2. Enable [two-step verification](https://faq.whatsapp.com/general/verification/about-two-step-verification) by setting a 6-digit registration code — you must set this code on your end. Save and memorize this code as it can be requested later. **Setting up two-factor authentication is a requirement to use the Cloud API.**\n \n\n**Embedded Signup Users**\n\nA phone number **must** be registered within 14 days after going through the Embedded Signup flow. If the phone number is not registered during that window, the phone number must go through the Embedded Signup flow again prior to registration." }, "response": [ { "name": "Register Phone Number", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"pin\": \"6-digit-pin\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/register", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "register" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"success\": \"true\"\n}" } ] }, { "name": "Send Test Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"template\",\n \"template\": {\n \"name\": \"hello_world\",\n \"language\": {\n \"code\": \"en_US\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "response": [ { "name": "Send Test Message", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"template\",\n \"template\": {\n \"name\": \"hello_world\",\n \"language\": {\n \"code\": \"en_US\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Debug Access Token", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/debug_token?input_token={{User-Access-Token}}", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "debug_token" ], "query": [ { "key": "input_token", "value": "{{User-Access-Token}}" } ] } }, "response": [] } ] }, { "name": "WhatsApp Business Accounts (WABAs)", "item": [ { "name": "Get WABA", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}" ] }, "description": "- Endpoint reference: [WhatsApp Business Account](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "\"c39946d41277419f1b3eb1f9761f2068612715ed\"" }, { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "AuECIG8CyNuAbaHekReCMDU" }, { "key": "x-fb-trace-id", "value": "Au3qI883HZc" }, { "key": "x-fb-rev", "value": "1007269544" }, { "key": "X-FB-Debug", "value": "Ja/wv3Ohd34TUOD8zF8ba70aUikGGCX1SwPAPuFErmXs69aTDV0YPXaxA2Xdj+bpGHniTzMRpaJYaOyGZYEtLA==" }, { "key": "Date", "value": "Sat, 08 Apr 2023 01:05:37 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "150" } ], "cookie": [], "body": "{\n \"id\": \"104996122399160\",\n \"name\": \"Lucky Shrub\",\n \"timezone_id\": \"1\",\n \"message_template_namespace\": \"58e6d318_b627_4112_b9c7_2961197553ea\"\n}" } ] }, { "name": "Get owned WABAs", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Business-ID}}/owned_whatsapp_business_accounts", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Business-ID}}", "owned_whatsapp_business_accounts" ] }, "description": "Endpoint reference: [Business > Extended Credits](https://developers.facebook.com/docs/marketing-api/reference/business/extendedcredits/)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Business-ID}}/owned_whatsapp_business_accounts", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Business-ID}}", "owned_whatsapp_business_accounts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Encoding", "value": "br" }, { "key": "ETag", "value": "\"366ab827015bbd04e3737a8e0e33b755ebdb1190\"" }, { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}],\"104996122399160\":[{\"type\":\"whatsapp_business_management\",\"call_count\":0,\"total_cputime\":0,\"total_time\":0,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "Ah4MqTo1ZUzj81zkb2XbBje" }, { "key": "x-fb-trace-id", "value": "EjCBhZpFH17" }, { "key": "x-fb-rev", "value": "1007269544" }, { "key": "X-FB-Debug", "value": "VZi3ZGTNb0Rd+lKKWI0HEaur9OTNIBff6mO7rsXN/IeCzQa8AcsdK0ef8XPzSYrHjrpTulugwFludywozAfNOQ==" }, { "key": "Date", "value": "Sat, 08 Apr 2023 01:06:45 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "422" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"104996122399160\",\n \"name\": \"Lucky Shrub\",\n \"timezone_id\": \"1\",\n \"message_template_namespace\": \"58e6d318_b627_4112_b9c7_2961197553ea\"\n },\n {\n \"id\": \"102290129340398\",\n \"name\": \"Test WhatsApp Business Account\",\n \"timezone_id\": \"1\",\n \"message_template_namespace\": \"ba30dd89_2ebd_41e4_b805_f2c05ae04cc9\"\n }\n ],\n \"paging\": {\n \"cursors\": {\n \"before\": \"QVFIUnpPVXRnY3BPN19rTVItOG51T291YURjV3BaeXRXU29adDVreS04ekhSNl9YWTlfdmN3SHlyTEk1a2FRdnlWanBqM1FuQm1uZAHhfYl9UMTNCYjM3MWV3\",\n \"after\": \"QVFIUjBrRUs5QVJuUDhDSmZARMlc2dXRYNXBmMjMtRUt3SmFlbk9PRk43azdiN1VQaW1HcnRkejFzZATNoNDdTdGVWMDhjamVvY25HWnI4WjIzX0hYSk40NHhB\"\n }\n }\n}" } ] }, { "name": "Get shared WABAs", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Business-ID}}/client_whatsapp_business_accounts", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Business-ID}}", "client_whatsapp_business_accounts" ] } }, "response": [ { "name": "Get List of Shared WABAs", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Business-ID}}/client_whatsapp_business_accounts", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Business-ID}}", "client_whatsapp_business_accounts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{ \n \"data\": [\n {\n \"id\": 1906385232743451, \n \"name\": \"My WhatsApp Business Account\", \n \"currency\": \"USD\", \n \"timezone_id\": \"1\", \n \"message_template_namespace\": \"abcdefghijk_12lmnop\" \n },\n {\n \"id\": 1972385232742141, \n \"name\": \"My Regional Account\", \n \"currency\": \"INR\", \n \"timezone_id\": \"5\", \n \"message_template_namespace\": \"12abcdefghijk_34lmnop\" \n }\n\n ],\n \"paging\": {\n\t\"cursors\": {\n\t\t\"before\": \"abcdefghij\",\n\t\t\"after\": \"klmnopqr\"\n\t}\n }\n}" } ] } ], "description": "Some API calls listed in this document require you to know your WhatsApp Business Account (WABA) ID. You have the following methods of getting a WABA ID:\n\n1. **Business Manager**: This is the most simple way. Just open the [Business Manager](https://business.facebook.com/), select your business, go to Settings and find your WhatsApp Business Account. When you click on the account, you see `\"owned by\"` and `\"id\"`. Save that ID number.\n2. **During Embedded Signup Onboarding**: See [Get Shared WABA ID with accessToken](https://developers.facebook.com/docs/whatsapp/embedded-signup/manage-accounts#get-shared-waba-id-with-accesstoken) for information.\n3. **Getting all WABAs shared with your business**: See [Get List of Shared WABAs](https://developers.facebook.com/docs/whatsapp/embedded-signup/manage-accounts#get-list-of-shared-wabas) for information.", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Registration", "item": [ { "name": "Register Phone", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"pin\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/register", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "register" ] }, "description": "To register your phone, make a **POST** call to **`/{{Phone-Number-ID}}/register`**. You need to include the following parameters.\n\n## Request Parameters\n\n| Name | Description |\n|-------------------------|--------------------------|\n| **`messaging_product`** | **Required**.
The messaging service used. This value always needs to be set to `\"whatsapp\"`. |\n| **`pin`** | **Required**.
A 6-digit pin you previously set up. For more information, see [Set Two-Step Verification](#08c441cc-8837-4ce5-8e0d-73fb0125c323). |" }, "response": [ { "name": "Register Phone", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"pin\": \"123456\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/register", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "register" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"success\": true\n}" } ] }, { "name": "Deregister Phone", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/deregister", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "deregister" ] }, "description": "To deregister your phone, make a **POST** call to **`{{Phone-Number-ID}}/deregister`**. **Deregister Phone** removes a previously registered phone. You can always re-register your phone using by repeating the registration process.\n\n#### Response\n\nA successful response returns:\n\n``` json\n{\n \"success\": true\n}\n\n```" }, "response": [ { "name": "Deregister Phone", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/deregister", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "deregister" ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"success\": true\n}" } ] } ], "description": "You need to register your phone number in the following scenarios:\n\n* Account Creation: When you implement this API, you need to register the phone number you want to use to send messages. We enforce [setting two-step verification](#fc57a30c-97e0-4e06-b74b-89fd7fc5f783) during account creation to add an extra layer of security of your accounts.\n* Name Change: In this case, your phone is already registered and you want to change your display name. To do that, you must first [file for a name change on WhatsApp Manager](https://www.facebook.com/business/help/378834799515077). Once the name is approved, you need to register your phone again under the new name.\n \n\nBefore registering your phone, you need to verify that you own that phone number with a SMS or voice code. For details, see [Verify Phone Ownership](https://developers.facebook.com/docs/whatsapp/business-management-api/guides/migrate-phone-to-different-waba#step-2--verify-phone-ownership).\n\nIn case you would like to remove your phone from the Cloud API, you can deregister a phone. This can be used in cases where you want to move to the On-Premises API or you want to use your phone number in the regular WhatsApp customer app. You can always reregister your phone with Cloud API later by repeating the registration process.\n\n**You set up** [**two-factor verification**](#fc57a30c-97e0-4e06-b74b-89fd7fc5f783) **and** [**register a phone number**](#b22af3db-9d13-4467-a7a6-4026f71984cb) **in the same API call.**\n\n#### Reminders\n\n* To use these endpoints, you need to authenticate yourself with a system user access token with the **`whatsapp_business_messaging`** permission.\n* If you need to find your phone number ID, see [Get Phone Number ID](#c72d9c17-554d-4ae1-8f9e-b28a94010b28)." }, { "name": "Phone Numbers", "item": [ { "name": "Get Phone Numbers", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/phone_numbers", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "phone_numbers" ] }, "description": "This API returns all phone numbers in a WhatsApp Business Account specified by the **`{{WABA-ID}}`** value. Get the **`id`** value for the phone number you want to use to send messages with WhatsApp Business Cloud API.\n\n#### Response Parameters\n\n| Name | Description |\n|-----------------------|-----------------------------|\n| **`verified_name`** | The verified name associated with the phone number. |\n| **`display_phone_number`** | The string representation of the phone number. |\n| **`id`** | The ID associated with the phone number. |\n| **`quality_rating`** | The quality rating of the phone number based on how messages have been received by recipients in recent days. Valid values are:

For more information relating to quality rating, see [About WhatsApp Business Account Message Quality Rating](https://www.facebook.com/business/help/896873687365001). |" }, "response": [ { "name": "Get Phone Numbers", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/phone_numbers", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "phone_numbers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"verified_name\": \"Jasper's Market\",\n \"display_phone_number\": \"+1 631-555-5555\",\n \"id\": \"1906385232743451\",\n \"quality_rating\": \"GREEN\"\n },\n {\n \"verified_name\": \"Jasper's Ice Cream\",\n \"display_phone_number\": \"+1 631-555-5556\",\n \"id\": \"1913623884432103\",\n \"quality_rating\": \"NA\"\n }\n ]\n}" } ] }, { "name": "Get Phone Number By ID", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}" ] }, "description": "When you query all the phone numbers for a WhatsApp Business Account, each phone number has an **`id`**. You can directly query for a phone number using this **`id`**.\n\n#### Response Parameters\n\n| Name | Description |\n|-----------------------|-----------------------------|\n| **`verified_name`** | The verified name associated with the phone number. |\n| **`display_phone_number`** | The string representation of the phone number. |\n| **`id`** | The ID associated with the phone number. |\n| **`quality_rating`** | The quality rating of the phone number based on how messages have been received by recipients in recent days. Valid values are:

For more information relating to quality rating, see [About WhatsApp Business Account Message Quality Rating](https://www.facebook.com/business/help/896873687365001). |" }, "response": [ { "name": "Get Phone Number By ID", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"verified_name\": \"Jasper's Market\",\n \"display_phone_number\": \"+1 631-555-5555\",\n \"id\": \"1906385232743451\",\n \"quality_rating\": \"GREEN\"\n}" } ] }, { "name": "Get Display Name Status (Beta)", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}?fields=name_status", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}" ], "query": [ { "key": "fields", "value": "name_status", "description": "The status of a display name associated with a specific phone number. The **`name_status`** value can be one of the following:\n\n* `APPROVED`: The name has been approved. You can download your certificate now.\n* `AVAILABLE_WITHOUT_REVIEW`: The certificate for the phone is available and display name is ready to use without review.\n* `DECLINED`: The name has not been approved. You cannot download your certificate.\n* `EXPIRED`: Your certificate has expired and can no longer be downloaded.\n* `PENDING_REVIEW`: Your name request is under review. You cannot download your certificate.\nNONE: No certificate is available." } ] }, "description": "Include **`fields=name_status`** as a query string parameter to get the status of a display name associated with a specific phone number. This field is currently in beta and not available to all developers." }, "response": [ { "name": "Get Display Name Status (Beta)", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}?fields=name_status", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}" ], "query": [ { "key": "fields", "value": "name_status", "description": "The status of a display name associated with a specific phone number. The **`name_status`** value can be one of the following:\n\n* `APPROVED`: The name has been approved. You can download your certificate now.\n* `AVAILABLE_WITHOUT_REVIEW`: The certificate for the phone is available and display name is ready to use without review.\n* `DECLINED`: The name has not been approved. You cannot download your certificate.\n* `EXPIRED`: Your certificate has expired and can no longer be downloaded.\n* `PENDING_REVIEW`: Your name request is under review. You cannot download your certificate.\nNONE: No certificate is available." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"id\" : \"105954558954427\",\n \"name_status\" : \"AVAILABLE_WITHOUT_REVIEW\"\n}" } ] }, { "name": "Get Phone Numbers with Filtering (beta)", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/phone_numbers?fields=id,is_official_business_account,display_phone_number,verified_name&filtering=[{'field':'account_mode','operator':'EQUAL','value':'SANDBOX'}]", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "phone_numbers" ], "query": [ { "key": "fields", "value": "id,is_official_business_account,display_phone_number,verified_name" }, { "key": "filtering", "value": "[{'field':'account_mode','operator':'EQUAL','value':'SANDBOX'}]" } ] }, "description": "- Guide: [Filter Phone Numbers](https://developers.facebook.com/docs/whatsapp/business-management-api/manage-phone-numbers#filter-phone-numbers)\n- Endpoint reference: [WhatsApp Business Account > Phone Numbers](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/phone_numbers/)" }, "response": [] }, { "name": "Request Verification Code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"code_method\": \"SMS\",\n \"locale\": \"en_US\"\n}" }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/request_code", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "request_code" ] }, "description": "You need to verify the phone number you want to use to send messages to your customers. Phone numbers must be verified through SMS/voice call. The verification process can be done through the Graph API calls specified below.\n \n\nTo verify a phone number using Graph API, make a **POST** request to **`{{PHONE_NUMBER_ID}}/request_code`**. In your call, include your chosen verification method and locale. You need to authenticate yourself using **{{User-Access-Token}}** (This is automatically done for you in the **`Request Verification Code`** request).\n\n#### Request Parameters\n\n| Name | Description |\n|-----------------------|-----------------------------|\n| **`code_method`** | **Required**.
Specifies the method for verification. Supported options are: `SMS` or `VOICE`. |\n| **`locale`** | **Required**.
Specifies your locale. For instance: `\"en_US\"`. |\n\n#### Response\n\nAfter a successful call to **`Request Verification Code`**, you will receive your verification code via the method you selected in **`code_method`**. To finish the verification process, you need to use the [**`Verify Code`**](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/phone-numbers#verify) request." }, "response": [ { "name": "Request Verification Code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"code_method\": \"SMS\",\n \"locale\": \"en_US\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/request_code", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "request_code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"success\": true\n}" } ] }, { "name": "Verify Code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\"\n}" }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/verify_code", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "verify_code" ] }, "description": "After you received a SMS or Voice request code from [**`Request Verification Code`**](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/phone-numbers#verify), you need to verify the code that was sent to you. To verify this code, make a **POST** request to **`{{PHONE_NUMBER_ID}}/verify_code`** that includes the code as a parameter.\n\n#### Request Parameters\n\n| Name | Description |\n|-----------------------|-----------------------------|\n| **`code`**
type: Numeric String | **Required**.
The code you received after calling [**`Request Verification Code`**](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/phone-numbers#verify)(**`{{PHONE_NUMBER_ID}}/request_code`**). |" }, "response": [ { "name": "Verify Code", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/verify_code", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "verify_code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"success\": true\n}" } ] }, { "name": "Set Two-Step Verification Code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"pin\": \"<6-digit-pin>\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}" ] }, "description": "You can use this endpoint to change two-step verification code associated with your account. \nAfter you change the verification code, future requests like changing the name, must use the new code. \n\n**You set up two-factor verification and [register a phone number](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/registration#register-phone) in the same API call.**\n\nYou must use the parameters listed below to change two-step verification \n\n\n## Parameters\n\n| Name | Description |\n|-------------- |--------------- |\n| **`pin`** | **Required**.
A 6-digit PIN you want to use for two-step verification. |" }, "response": [ { "name": "Set Two-Step Verification Code", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"pin\": \"123456\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"success\": true\n}" } ] } ], "description": "Some API calls listed in this document require you to know your phone number’s ID. For more information on how to get a list of phone numbers associated with your WhatsApp Business Account, see [Get All Phone Numbers](https://developers.facebook.com/docs/whatsapp/business-management-api/phone-numbers#all-phone-numbers). The API call response includes IDs for each of the phone numbers connected to your WhatsApp Business Account. Save the ID for the phone you want to use with any **`/{phone-number-ID}`** calls.", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Webhook Subscriptions", "item": [ { "name": "Webhook Payload Reference", "item": [ { "name": "Components", "item": [ { "name": "Entry Object", "item": [], "description": "| Field | Description |\n|--------------------|----------------------------------|\n| **`id`** | The ID of Whatsapp Business Accounts this Webhook belongs to. |\n| **`changes`** | Changes that triggered the Webhooks call. This field contains an array of change objects. |", "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Change Object", "item": [], "description": "| Field | Description |\n|--------------------|----------------------------------|\n| **`value`** | A [value object](#54a8a703-18c8-47af-9aaf-a560afd9aa7b). Contains details of the changes related to the specified field. |\n| **`field`** | Contains the type of notification you are getting on that Webhook. Currently, the only option for this API is `“messages”`. |", "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Metadata Object", "item": [], "description": "| Name | Description |\n|-------------------------|----------------------------------|\n| **`display_phone_number`** | The phone number of the business account that is receiving the Webhooks. |\n| **`phone_number_id`** | The ID of the phone number receiving the Webhooks. You can use this **`phone_number_id`** to send messages back to customers. |" }, { "name": "Value Object", "item": [], "description": "| Field | Description |\n|-------------------------|----------------------------------|\n| **`messaging_product`** | The messaging service used for Webhooks. For WhatsApp messages, this value needs to be set to `“whatsapp”`. |\n| **`metadata`** | The metadata about your phone number. |\n| **`messages`** | An array of [message objects](#9ad6ff8c-72d6-4b04-b4d5-45fe093976ad). **Added to Webhooks for incoming message notifications**.|\n| **`statuses`** | An array of [message status objects](#15305365-753b-400a-90ce-de069ee7f909). **Added to Webhooks for message status update**. |\n| **`errors`** | An array of [message error objects](#a89ecf92-9b51-409a-af27-2c3b9bc0fd7e). |", "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Contact Object", "item": [], "description": "| Field | Description |\n|-------------------------|----------------------------------|\n| **`profile`** | The [profile object](#bedd6ec6-be2f-42ca-9b0e-a6c3f6f4cd70). |\n| **`wa_id`** | The WhatsApp ID of the customer. You can send messages using this **`wa_id`**. |", "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Profile Object", "item": [], "description": "| Field | Description |\n| --- | --- |\n| **`name`** | **Optional.**
Specifies the sender's profile name. |", "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Messages Object", "item": [], "description": "The messages array of objects is nested within the **`Value`** object and is triggered when a customer updates their profile information or a customer sends a message to the business that is subscribed to the Webhook.\n\n| Field | Description |\n|-------------------------|----------------------------------|\n| **`from`** | The customer's phone number. |\n| **`id`** | The unique identifier of incoming message, you can use messages endpoint to mark it as read. |\n| **`timestamp`** | The timestamp when a customer sends a message. |\n| **`type`** | The type of message being received.

Supported values are:
  • `text`: for text messages.
  • `image`: for image (media) messages.
  • `interactive`: for interactive messages.
  • `document`: for document (media) messages.
  • `audio`: for audio and voice (media) messages.
  • `sticker`: for sticker messages.
  • `order`: for when a customer has placed an order.
  • `video`: for video (media) messages.
  • `button`: for responses to [interactive message templates](#b00c9f92-be3e-4511-af38-be72827a7f3a).
  • `contacts`: for contact messages.
  • `location`: for location messages.
  • `unknown`: for unknown messages.
  • `system`: for user number change messages.
|\n| **`context`** | **Added to Webhook if message is forwarded or an inbound reply.**
A [context object](#57287ed9-e640-44db-b991-9f03749cb645).|\n| **`identity`** | **Added to Webhook if show_security_notifications is enabled in application settings.**
An [identity object](#a1b69494-a0f5-405c-9dd5-968362c4a30f). |\n| **`text`** | **Added to Webhook if type is `text`**.
A [text object](#e2e1d9df-0886-4e29-a8c8-ff93223178bd). |\n| **`audio`** | **Added to Webhook if type is `audio` (including voice messages)**.
A [media object](#058689bd-e754-4efc-938d-bec7bec3b1c4) with the audio information. |\n| **`image`** | **Added to Webhook if type is `image`**.
A [media object](#058689bd-e754-4efc-938d-bec7bec3b1c4) with the image information. |\n| **`sticker`** | **Added to Webhook if type is `sticker`**.
A [media object](#058689bd-e754-4efc-938d-bec7bec3b1c4) with the sticker information. |\n| **`video`** | **Added to Webhook if type is `video`**.
A [media object](#058689bd-e754-4efc-938d-bec7bec3b1c4) with the video information. |\n| **`interactive`** | **Added to Webhook if type is `interactive`**.
When a customer has interacted with your message, an [interactive object](https://documenter.getpostman.com/view/13382743/UVC5FTHT?fbclid=IwAR083mCseNzJm-JgxlIQbdF30hkAbEOHkbBaw9bA7-isGKU6uwtq1RJKc0o#68fe0550-aba5-4ee3-b79d-0846f3dddef1) is included in the **``Messages`** object. |\n| **`order`** | Included in the **`Messages`** object when a customer has placed an order. The order object can contain the following fields:
  • **`catalog_id`**: ID for the catalog the ordered item belongs to.
  • **`text`**: Text message from the user sent along with the order.
  • **`product_items`**: Array of product item objects.


The **`product_items`** object contains the following fields:
  • **`product_retailer_id`**: The unique identifier of the product in a catalog.
  • **`quanitity`**: The number of items.
  • **`item_price`**: The price of each item.
  • **`currency`**: The price currency.
\n| **`document`** | **Added to Webhook if type is `document`**.
A [media object](#058689bd-e754-4efc-938d-bec7bec3b1c4) with the document information. |\n| **`errors`** | **Added to Webhook if type is `unknown`**.
If displayed, this field contains the following error message:

```[{\"code\":131051,\"details\":\"Message type is not currently supported\",\"title\":\"Unsupported message type\"]```|\n| **`system`** | **Added to Webhook if type is `system`**.
A [system message object](#15b395a9-15eb-4610-ba12-3c9f8a5e0528). |\n| **`button`** | **Added to Webhook if type is `button`**.
A [button message object](#cffcb0b3-f6c8-45d6-b4a1-5deaa8955a7d).
This field is used when the Webhook notifies you that a user clicked on a quick reply button.|\n| **`referral`** | **Added to Webhook if the message is coming from a user that clicked an ad that is `Click To WhatsApp`**.
A [referral object](). This is how the referral object works:
  1. A user clicks on an ad with the Click to WhatsApp call-to-action.
  2. User is redirected to WhatsApp and sends a message to the advertising business.
  3. User sends a message to the business. Be aware that users may elect to remove their referral data.
  4. The advertising business gets an inbound message notification including the **`referral`** object, which provides additional context on the ad that triggered the message. Knowing all this information, the business can appropriately reply to the user message.
\n|", "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Text Object", "item": [], "description": "| Field | Description |\n|-------------------------|----------------------------------|\n| **`body`** | The text of the text message. |", "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Context Object", "item": [], "description": "| Field | Description |\n|----------------------------|----------------------------------|\n| **`forwarded`** | **Added to Webhooks if message was forwarded.**
Set to **`true`** if the received message has been forwarded. |\n| **`frequently_forwarded`** | **Added to Webhooks if message has been frequently forwarded.**
Set to **`true`** if the received message has been forwarded more than five times. |\n| **`from`** | **Added to Webhooks if message is an inbound reply to a sent message.**
The WhatsApp ID of the sender of the sent message. |\n| **`id`** | **Optional**
The message ID for the sent message for an inbound reply. |\n| **`referred_product`** | **Required for Product Enquiry Messages**.

Specifies the product the user is requesting information about. For more information, see [Receive Response From Customers](https://developers.facebook.com/docs/whatsapp/on-premises/guides/commerce-guides/receive-responses-from-customers).

The **`referred_product`** object contains the following fields:
  • **`catalog_id`**: Unique identifier of the Meta catalog linked to the WhatsApp Business Account.
  • **`product_retailer_id`**: Unique identifier of the product in a catalog.
|", "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Identity Object", "item": [], "description": "| Field | Description |\n|----------------------------|----------------------------------|\n| **`acknowledged`** | State of acknowledgment for latest **`user_identity_changed`** system notification. |\n| **`created_timestamp`** | The timestamp of when the WhatsApp Business API detected the user potentially changed. |\n| **`hash`** | Identifier for the latest **`user_identity_changed`** system notification. |" }, { "name": "Media Object", "item": [], "description": "**`Media Object`** is used for audio, images, documents, videos and stickers.\n\n| Field | Description |\n|----------------------------|----------------------------------|\n| **`caption`** | **Added to Webhooks if it has been previously specified.**
The caption that describes the media. |\n| **`filename`** | **Added to Webhooks for document messages.**
The media's filename on the sender's device. |\n| **`id`** | The ID of the media. |\n| **`mime_type`** | The mime type of the media. |\n| **`sha256`** | The checksum of the media. |" }, { "name": "Reaction Object", "item": [], "description": "The `Reaction` object contains information about messages that contain a reaction and corresponding emojis. This object contains the following fields:\n\n| Field | Description |\n|-----------------------|----------------------------------|\n| **`message_id`** | Specifies the **`wamid`** of the message received that contained the reaction. |\n| **`emoji`** | The emoji used for the reaction.|" }, { "name": "Interactive Object", "item": [ { "name": "Button Reply Object", "item": [], "description": "| Field | Description |\n| --- | --- |\n| **`id`** | The unique identifier of the button. |\n| **`title`** | The title of the button. |" }, { "name": "List Reply Object", "item": [], "description": "| Field | Description |\n| --- | --- |\n| **`id`** | The unique identifier (ID) of the selected row. |\n| **`title`** | The title of the selected row. |\n| **`description`** | The description of the selected row. |" } ], "description": "| Field | Description |\n| --- | --- |\n| **`type`** | Contains the type of interactive object. Supported options are:
  • `button_reply`: for responses of Reply Buttons.
  • `list_reply`: for responses to List Messages and other interactive objects.
|\n| **`button_reply`** | **Used on Webhooks related to Reply Buttons.**
Contains a [button reply object](#3530f9ca-704b-4811-a1bc-04472a72e00f). |\n| **`list_reply`** | **Used on Webhooks related to List Messages**
Contains a [list reply object](#374bd5d7-e6c5-48e6-80f9-5821ad5da7ff). |" }, { "name": "System Message Object", "item": [], "description": "This object is added to Webhooks if a user has changed their phone number and if a user’s identity has potentially changed on WhatsApp.\n\n| Field | Description |\n|-----------------------|----------------------------------|\n| **`body`** | Describes the system message event. Supported use cases are:
  • **Phone number update:** for when a user changes from an old number to a new number.
  • **Identity update:** for when a user identity has changed.
|\n| **`new_wa_id`** | **Added to Webhooks for phone number updates.**
New WhatsApp ID of the customer.|\n| **`identity`** | **Added to Webhooks for identity updates.**
New WhatsApp ID of the customer.|\n|**`type`** | Supported types are:
  • **user_changed_number**: for a user changed number notification.
  • **user_identity_changed**: for user identity changed notification.
|\n| **`user`** | **Added to Webhooks for identity updates.**
The new WhatsApp user ID of the customer.|", "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Statuses Object", "item": [ { "name": "Conversation Object", "item": [], "description": "The **`conversation`** object tracks the attributes of your current conversation. The following fields are specified within the conversation object:\n\n| Field | Description |\n|------------------------------|----------------------------------|\n| **`id`**
type: string | The ID of the conversation the given status notification belongs to. |\n| **`origin`**
type: object | Describes where the conversation originated from. See [origin object](#efa78bee-682f-4620-9d97-14ecb3cee0ef) for more information.|\n| **`expiration_timestamp`**
type: [UNIX timestamp](https://en.wikipedia.org/wiki/Unix_time?fbclid=IwAR3joUPmHY6qMICZD4EeLhuRgSR7F28eKavnrVnru3QFMhtgOcCJ3V-QjbQ) | The timestamp when the current ongoing conversation expires. This field is not present in all Webhook types. |", "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Payment Object", "item": [], "description": "The **`payment`** object tracks the attributes of the user-initiated transaction changes. The following fields are specified within the payment object:\n\n| Field | Description |\n| --- | --- |\n| **`id`**
type: string | Webhook ID for the notification. |\n| **`from`**
type: string | WhatsApp ID of the customer. |\n| **`type`**
type: string | For payment status update webhooks, type is `payment`. |\n| **`status`**
type: string | Latest status of the payment. Can be one of `captured`, `failed` or `pending`. |\n| **`payment`**
type: object | Contains the following field:

`reference_id` string
\\- Unique reference ID for the order sent in order_details message. |\n| **`timestamp`**
type: string | Timestamp for the webhook. |", "auth": { "type": "noauth" } }, { "name": "Origin Object", "item": [], "description": "**This object will become available when [Conversation-Based Pricing](https://developers.facebook.com/docs/whatsapp/pricing/conversationpricing) launches in a future update.**\nThe **`origin`** object describes where a conversation has originated from. The following fields are specified within the origin object:\n\n| Field | Description |\n|------------------------------|----------------------------------|\n| **`type`**
type: string | Indicates where a conversation has started. This can also be referred to as a conversation entry point. Currently, the available options are:
  • **`business_initiated`**: indicates that the conversation started by a business sending the first message to a user. This applies any time it has been more than 24 hours since the last user message.
  • **`user_initiated`**: indicates that the conversation started by a business replying to a user message. This applies only when the business reply is within 24 hours of the last user message.
  • **`referral_conversion`**: indicates that the conversation originated from a [free entry point](https://developers.facebook.com/docs/whatsapp/pricing/conversationpricing#free-entry-points). These conversations are always user-initiated.
|", "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Pricing Object", "item": [], "description": "The **`pricing`** object includes your billing attributes. The following fields are specified within the pricing object:\n\n| Field | Description |\n|----------------------------------------|----------------------------------|\n| **`pricing_model`**
type: string | Type of pricing model being used. Current supported values are:
  • `\"CBP\"` (conversation-based pricing): See [Conversation-Based Pricing](https://developers.facebook.com/docs/whatsapp/pricing/conversationpricing) for rates based on recipient country.
  • `\"NBP\"` (notification-based pricing): Notifications are also known as Template Messages ([click here for details on pricing](https://developers.facebook.com/docs/whatsapp/pricing)). This pricing model will be deprecated in a future release early 2022.
|\n| **`billable`**
type: boolean | Indicates if the given message or conversation is billable. Value varies according to **`pricing_model`**.

If you are using CBP (conversation-based pricing):
  • This flag is set to **`false`** if the conversation was initiated from [free entry points](https://developers.facebook.com/docs/whatsapp/pricing/conversationpricing#free-entry-points). Conversations initiated from free entry points are not billable.
  • For all other conversations, it’s set to **`true`**.
  • This is also set to **`true`** for conversations inside your free tier limit. You are not charged for these conversations, but they are considered billable and are reflected on your invoice.

If you are using NBP (notification-based pricing):
  • This flag is **`false`** for user-initiated conversations.
  • This flag is set to **`true`** for notification messages (template messages)
|\n| **`category`**
type: string | Indicates the conversation pricing category. Currently, available options are:
  • **`business_initiated`**: indicates that the conversation was started by a business sending the first message to a user. This applies any time it has been more than 24 hours since the last user message.
  • **`user_initiated`**: indicates that the conversation was initiated by a business replying to a user message. This applies only when the business reply is within 24 hours of the last user message.
  • **`referral_conversion`**: indicates that the conversation originated from a [free entry point](https://developers.facebook.com/docs/whatsapp/pricing/conversationpricing#free-entry-points). These conversations are always user-initiated.
|", "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] } ], "description": "The **`statuses`** object informs you of the status of messages between you, users, and/or groups.\n\n| Field | Description |\n|------------------------------|----------------------------------|\n| **`id`**
type: string | The message ID. |\n| **`recipient_id`**
type: string | The WhatsApp ID of the recipient.|\n| **`status`**
type: string | The status of the message. Valid values are: **`read`**, **`delivered`**, **`sent`**, **`failed`**, or **`deleted`**.

For more information, see [All Possible Message Statuses](#9a302c08-c8d7-42da-8800-1b24bed8adaf).|\n| **`timestamp`**
type: string | The timestamp of the status message.|\n| **`type`**
type: string | The type of entity this status object is about. Currently, the only available option is `\"message\"`.
_This object is only available for the On-Premises implementation of the API. Cloud API developers will not receive this field._ |\n| **`conversation`**
type: object | **This object will be provided by default when [Conversation-Based Pricing](https://developers.facebook.com/docs/whatsapp/pricing/conversationpricing) launches in a future update.**
Object containing conversation attributes, including **`id`**. See [conversation object](#7f5a70d6-7302-44d3-a473-74b92c21365b) for more information.

WhatsApp defines a conversation as a 24-hour session of messaging between a person and a business. There is no limit on the number of messages that can be exchanged in the fixed 24-hour window. The 24-hour conversation session begins when:
  • A business-initiated message is delivered to a user
  • A business’ reply to a user message is delivered

The 24-hour conversation session is different from the 24-hour customer support window. The customer support window is a rolling window that is refreshed when a user-initiated message is delivered to a business. Within the customer support window businesses can send free-form messages. Any business-initiated message sent more than 24 hours after the last customer message must be a template message. |\n| **`pricing`**
type: object | **This object will be provided by default when [Conversation-Based Pricing](https://developers.facebook.com/docs/whatsapp/pricing/conversationpricing) launches in a future update.**
| Object containing billing attributes, including **`pricing_model`**, **`billable`** flag, and **`category`**. See [pricing object](https://documenter.getpostman.com/view/13382743/UVC5FTHT#f72385a4-9ab5-40ec-bd1b-fd0adf0d37e3) for more information.\n| **`errors`** | **Added to Webhook if status is set to `failed`**.
An array of [error objects](#a89ecf92-9b51-409a-af27-2c3b9bc0fd7e) with information about a message’s delivery failure.|", "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Error Object", "item": [], "description": "| Field | Description |\n|-----------------------|----------------------------------|\n| **`code`** | The error code. |\n| **`title`** | The error title.|", "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Button Object", "item": [], "description": "| Field | Description |\n|-----------------------|----------------------------------|\n| **`payload`** | The developer-defined payload for the button when a business account sends interactive messages. |\n| **`text`** | The button text.|", "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Referral Object", "item": [], "description": "| Field | Description |\n| --- | --- | \n| **`source_url`** | Specifies the URL that leads to the ad or post clicked by the user. Opening this URL takes you to the ad viewed by your user. |\n| **`source_type`** | Specifies the type of the ad's source. Supported values are `\"ad\"` or `\"post\"`. |\n| **`source_id`** | Specifies the Meta ID for an ad or post. |\n| **`headline`** | Specifies the headline used in the ad or post that generated the message. |\n| **`body`** | The description, or body, from the ad or post that generated the message. |\n| **`media_type`** | Media present in the ad or post the user clicked. Supported values are `\"image\"` or `\"video\"`. |\n| **`image_url`** | **Added if media_type is `“image”`**.
Contains a URL to the raw image. |\n| **`video_url`** | **Added if media_type is `“video”`**.
Contains a URL to the video. |\n| **`thumbnail_url`** | **Added if media_type is `“video”`**.
Contains a URL to the thumbnail image of the clicked video. |" } ], "description": "The top level Webhooks array contains the following two fields:\n\n| Field | Description |\n|--------------------|----------------------------------|\n| **`object`** | All Webhook events for WhatsApp Cloud API belong under the **`whatsapp_business_account`** object. |\n| **`entry`** | An array of [entry objects](#818e8a3e-37b1-4bb6-8441-3291c02c0258). |" }, { "name": "Received Text Message", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"8856996819413533\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"16505553333\",\n \"phone_number_id\": \"27681414235104944\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"Kerry Fisher\"\n },\n \"wa_id\": \"16315551234\"\n }\n ],\n \"messages\": [\n {\n \"from\": \"16315551234\",\n \"id\": \"wamid.ABGGFlCGg0cvAgo-sJQh43L5Pe4W\",\n \"timestamp\": \"1603059201\",\n \"text\": {\n \"body\": \"Hello this is an answer\"\n },\n \"type\": \"text\"\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" }, "description": "The following is an example of a text message you received from a customer:" }, "response": [] }, { "name": "Received Text Message with Show Security Notifications", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"8856996819413533\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"\",\n \"phone_number_id\": \"27681414235104944\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"\"\n },\n \"wa_id\": \"\"\n }\n ],\n \"messages\": [\n {\n \"from\": \"\",\n \"id\": \"ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh\",\n \"identity\": {\n \"acknowledged\": true,\n \"created_timestamp\": 1602532300000,\n \"hash\": \"Sjvjlx8G6Z0=\"\n },\n \"text\": {\n \"body\": \"Hi from new number 3601\"\n },\n \"timestamp\": \"1602532300\",\n \"type\": \"text\"\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" }, "description": "The following is an example of a text message you receive from a customer, when you have the **`show_security_notifications`** parameter set to **`true`** in the **application settings**." }, "response": [] }, { "name": "Received Message with Reaction", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"8856996819413533\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"\",\n \"phone_number_id\": \"27681414235104944\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"\"\n },\n \"wa_id\": \"\"\n }\n ],\n \"messages\": [\n {\n \"from\": \"sender_wa_id\",\n \"id\": \"message_id\",\n \"timestamp\": \"message_timestamp\",\n \"type\": \"reaction\",\n \"reaction\": {\n \"emoji\": \"\",\n \"messsage_id\": \"\"\n }\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" }, "description": "If the message being reacted to is more than 30 days old the reaction message webhook will not be delivered. Note that for reactions, the **`timestamp`** value indicates when the customer sent the reaction, not when the Webhook was generated." }, "response": [] }, { "name": "Received Media Message with Image", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"8856996819413533\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"16505553333\",\n \"phone_number_id\": \"\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"\"\n },\n \"wa_id\": \"\"\n }\n ],\n \"messages\": [\n {\n \"from\": \"\",\n \"id\": \"wamid.id\",\n \"timestamp\": \"\",\n \"type\": \"image\",\n \"image\": {\n \"caption\": \"This is a caption\",\n \"mime_type\": \"image/jpeg\",\n \"sha256\": \"81d3bd8a8db4868c9520ed47186e8b7c5789e61ff79f7f834be6950b808a90d3\",\n \"id\": \"2754859441498128\"\n }\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" }, "description": "When a message with media is received, the WhatsApp Business API downloads the media. A notification is sent to your Webhook once the media is downloaded. \n\nThe Webhook notification contains information that identifies the media object and enables you to find and retrieve the object. [Use the media endpoints to retrieve the media](#39a02bc0-ede1-4848-b24e-4ac3d501aaea)." }, "response": [] }, { "name": "Received Media Message with Sticker", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"8856996819413533\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"\",\n \"phone_number_id\": \"\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"\"\n },\n \"wa_id\": \"\"\n }\n ],\n \"messages\": [\n {\n \"from\": \"\",\n \"id\": \"\",\n \"timestamp\": \"\",\n \"type\": \"sticker\",\n \"sticker\": {\n \"id\": \"\",\n \"animated\": false,\n \"mime_type\": \"image/webp\",\n \"sha256\": \"\"\n }\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" }, "description": "When you receive a media message containing a sticker, WhatsApp Business API downloads the sticker and a notification is sent to your Webhook once the sticker is downloaded.\n\nThe Webhook notification contains information that identifies the media object and allows you to find and retrieve the object. [Use the media endpoints to retrieve the media](https://desktop.postman.com/?desktopVersion=9.16.0&userId=14291747&teamId=1367031)." }, "response": [] }, { "name": "Received Contact Messages", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"\",\n \"phone_number_id\": \"\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"\"\n },\n \"wa_id\": \"\"\n }\n ],\n \"messages\": [\n {\n \"from\": \"\",\n \"id\": \"\",\n \"timestamp\": \"\",\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"type\": \"\",\n \"zip\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"emails\": [\n {\n \"email\": \"\",\n \"type\": \"\"\n }\n ],\n \"name\": {\n \"formatted_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\",\n \"suffix\": \"\",\n \"prefix\": \"\"\n },\n \"org\": {\n \"company\": \"\",\n \"department\": \"\",\n \"title\": \"\"\n },\n \"phones\": [\n {\n \"phone\": \"\",\n \"wa_id\": \"\",\n \"type\": \"\"\n }\n ],\n \"urls\": [\n {\n \"url\": \"\",\n \"type\": \"\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" }, "description": "The following is an example of a contact message you received from a customer:" }, "response": [] }, { "name": "Received Static Location Messages", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"\",\n \"phone_number_id\": \"\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"\"\n },\n \"wa_id\": \"\"\n }\n ],\n \"messages\": [\n {\n \"from\": \"PHONE_NUMBER\",\n \"id\": \"wamid.ID\",\n \"timestamp\": \"TIMESTAMP\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\",\n }\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" }, "description": "The following is an example of a static location message you received from a customer." }, "response": [] }, { "name": "Received Message Triggered by Click to WhatsApp Ads", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"ID\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"\",\n \"phone_number_id\": \"\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"\"\n },\n \"wa_id\": \"\"\n }\n ],\n \"messages\": [\n {\n \"referral\": {\n \"source_url\": \"\",\n \"source_id\": \"\",\n \"source_type\": \"\",\n \"headline\": \"\",\n \"body\": \"\",\n \"media_type\": \"\",\n \"image_url\": \"\",\n \"video_url\": \"\",\n \"thumbnail_url\": \"\"\n },\n \"from\": \"\",\n \"id\": \"wamid.ID\",\n \"timestamp\": \"\",\n \"type\": \"text\",\n \"text\": {\n \"body\": \"\"\n }\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" } }, "response": [] }, { "name": "Received Unknown Messages", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"1900820329959633\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"16315551234\",\n \"phone_number_id\": \"16315551234\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"Kerry Fisher\"\n },\n \"wa_id\": \"16315555555\"\n }\n ],\n \"messages\": [\n {\n \"from\": \"16315555555\",\n \"id\": \"wamid.ABGGFlA5FpafAgo6tHcNmNjXmuSf\",\n \"timestamp\": \"1602139392\",\n \"errors\": [\n {\n \"code\": 130501,\n \"details\": \"Message type is not currently supported\",\n \"title\": \"Unsupported message type\"\n }\n ],\n \"type\": \"unknown\"\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" }, "description": "It’s possible to receive an unknown message callback notification. The following is an example of a message you received from a customer that is not supported." }, "response": [] }, { "name": "Message Status Update Notifications", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"8856996819413533\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"16505553333\",\n \"phone_number_id\": \"27681414235104944\"\n },\n \"statuses\": [\n {\n \"id\": \"wamid.gBGGFlCGg0cvAglAxydbAoy-gwNo\",\n \"status\": \"sent\",\n \"timestamp\": \"1603086313\",\n \"recipient_id\": \"16315551234\"\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" }, "description": "The WhatsApp Business API sends notifications to inform you of the status of the messages between you and users. When a message is sent successfully, you receive a notification when the message is sent, delivered, and read. The order of these notifications in your app may not reflect the actual timing of the message status. You can view the timestamp to determine the timing.\n\nThe following is an example of successful message status update Webhooks:" }, "response": [] }, { "name": "Received Callback from a Quick Reply Button Click", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"8856996819413533\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"16505553333\",\n \"phone_number_id\": \"27681414235104944\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"Kerry Fisher\"\n },\n \"wa_id\": \"16315551234\"\n }\n ],\n \"messages\": [\n {\n \"context\": {\n \"from\": \"16505553333\",\n \"id\": \"wamid.gBGGFlCGg0cvAgkLFm4e9tICiTI\"\n },\n \"from\": \"16315551234\",\n \"id\": \"wamid.ABGGFlCGg0cvAgo-sHWxBA2VFD_S\",\n \"timestamp\": \"1603087229\",\n \"type\": \"button\",\n \"button\": {\n \"text\": \"No\",\n \"payload\": \"No-Button-Payload\"\n }\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" }, "description": "When your customer clicks on a quick reply button in an [interactive message template](#eed16be1-5e49-4a48-8710-398820b4b5dd), a response is sent. Below is an example of the callback format." }, "response": [] }, { "name": "Status: Message Sent - User Initiated", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"WHATSAPP_BUSINESS_ACCOUNT_ID\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"PHONE_NUMBER\",\n \"phone_number_id\": \"PHONE_NUMBER_ID\"\n },\n \"statuses\": [\n {\n \"id\": \"wamid.ID\",\n \"recipient_id\": \"PHONE_NUMBER\",\n \"status\": \"sent\",\n \"timestamp\": \"TIMESTAMP\",\n \"conversation\": {\n \"id\": \"CONVERSATION_ID\",\n \"expiration_timestamp\": TIMESTAMP,\n \"origin\": {\n \"type\": \"user_initiated\"\n }\n },\n \"pricing\": {\n \"pricing_model\": \"CBP\",\n \"billable\": true,\n \"category\": \"user_initiated\"\n }\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" }, "description": "The following notification is received when a business sends a message as part of a [user-initiated conversation](https://developers.facebook.com/docs/whatsapp/pricing/conversationpricing#how-it-works) (if that conversation did not originate in a free entry point):" }, "response": [] }, { "name": "Status: Message Sent - Business-Initiated", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"WHATSAPP_BUSINESS_ACCOUNT_ID\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"PHONE_NUMBER\",\n \"phone_number_id\": \"PHONE_NUMBER_ID\"\n },\n \"statuses\": [\n {\n \"id\": \"wamid.ID\",\n \"recipient_id\": \"PHONE_NUMBER\",\n \"status\": \"sent\",\n \"timestamp\": \"TIMESTAMP\",\n \"conversation\": {\n \"id\": \"CONVERSATION_ID\",\n \"expiration_timestamp\": TIMESTAMP,\n \"origin\": {\n \"type\": \"business_initated\"\n }\n },\n \"pricing\": {\n \"pricing_model\": \"CBP\",\n \"billable\": true,\n \"category\": \"business_initated\"\n }\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" }, "description": "The following notification is received when a business sends a message as part of a [business-initiated conversation](https://developers.facebook.com/docs/whatsapp/pricing/conversationpricing#how-it-works):" }, "response": [] }, { "name": "Status: Message Sent - Business Reply to User", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"WHATSAPP_BUSINESS_ACCOUNT_ID\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"PHONE_NUMBER\",\n \"phone_number_id\": \"PHONE_NUMBER_ID\"\n },\n \"statuses\": [\n {\n \"id\": \"wamid.ID\",\n \"status\": \"sent\",\n \"timestamp\": TIMESTAMP,\n \"recipient_id\": PHONE_NUMBER,\n \"conversation\": {\n \"id\": \"CONVERSATION_ID\",\n \"expiration_timestamp\": TIMESTAMP,\n \"origin\": {\n \"type\": \"referral_conversion\"\n }\n },\n \"pricing\": {\n \"billable\": false,\n \"pricing_model\": \"CBP\",\n \"category\": \"referral_conversion\"\n }\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" } }, "response": [] }, { "name": "Status: Message Delivered - User Initiated", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"WHATSAPP_BUSINESS_ACCOUNT_ID\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"PHONE_NUMBER\",\n \"phone_number_id\": \"PHONE_NUMBER_ID\"\n },\n \"statuses\": [\n {\n \"id\": \"wamid.ID\",\n \"recipient_id\": \"PHONE_NUMBER\",\n \"status\": \"delivered\",\n \"timestamp\": \"TIMESTAMP\",\n \"conversation\": {\n \"id\": \"CONVERSATION_ID\",\n \"expiration_timestamp\": TIMESTAMP,\n \"origin\": {\n \"type\": \"business_initiated\"\n }\n },\n \"pricing\": {\n \"pricing_model\": \"CBP\",\n \"billable\": true\n }\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" }, "description": "The following notification is received when a business’ message is delivered and that message is part of a [user-initiated conversation](https://developers.facebook.com/docs/whatsapp/pricing/conversationpricing#how-it-works) (if that conversation did not originate in a [free entry point](https://developers.facebook.com/docs/whatsapp/pricing/conversationpricing#free-entry-points)):" }, "response": [] }, { "name": "Status: Message Delivered - Business from User-Initiated", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"WHATSAPP_BUSINESS_ACCOUNT_ID\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"PHONE_NUMBER\",\n \"phone_number_id\": \"PHONE_NUMBER_ID\"\n },\n \"statuses\": [\n {\n \"id\": \"wamid.ID\",\n \"status\": \"sent\",\n \"timestamp\": \"TIMESTAMP\",\n \"recipient_id\": \"PHONE_NUMBER\",\n \"conversation\": {\n \"id\": \"CONVERSATION_ID\",\n \"expiration_timestamp\": TIMESTAMP,\n \"type\": \"referral_conversion\"\n },\n \"pricing\": {\n \"billable\": false,\n \"pricing_model\": \"CBP\",\n \"category\": \"referral_conversion\"\n }\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" }, "description": "The following notification is received when a business’ message is delivered and that message is part of a [user-initiated conversation](https://developers.facebook.com/docs/whatsapp/pricing/conversationpricing#how-it-works) (if that conversation did not originate in a [free entry point](https://developers.facebook.com/docs/whatsapp/pricing/conversationpricing#free-entry-points)):" }, "response": [] }, { "name": "Status: Message Delivered - Business Delivered from User", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"WHATSAPP_BUSINESS_ACCOUNT_ID\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"PHONE_NUMBER\",\n \"phone_number_id\": \"PHONE_NUMBER_ID\"\n },\n \"statuses\": [\n {\n \"id\": \"wamid.ID\",\n \"recipient_id\": \"PHONE_NUMBER\",\n \"status\": \"delivered\",\n \"timestamp\": \"TIMESTAMP\",\n \"conversation\": {\n \"id\": \"CONVERSATION_ID\",\n \"expiration_timestamp\": TIMESTAMP,\n \"origin\": {\n \"type\": \"user_initiated\"\n }\n },\n \"pricing\": {\n \"pricing_model\": \"CBP\",\n \"billable\": true,\n \"category\": \"user_initiated\"\n }\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" }, "description": "The following notification is received when a business’ message is delivered and that message is part of a [user-initiated conversation](https://developers.facebook.com/docs/whatsapp/pricing/conversationpricing#how-it-works) originating from a [free entry point](https://developers.facebook.com/docs/whatsapp/pricing/conversationpricing#free-entry-points):" }, "response": [] }, { "name": "Status: Message Deleted", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"WHATSAPP_BUSINESS_ACCOUNT_ID\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": PHONE_NUMBER,\n \"phone_number_id\": PHONE_NUMBER\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"NAME\"\n },\n \"wa_id\": PHONE_NUMBER\n }\n ],\n \"messages\": [\n {\n \"from\": PHONE_NUMBER,\n \"id\": \"wamid.ID\",\n \"timestamp\": TIMESTAMP,\n \"errors\": [\n {\n \"code\": 131051,\n \"details\": \"Message type is not currently supported\",\n \"title\": \"Unsupported message type\"\n }\n ],\n \"type\": \"unsupported\"\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" }, "description": "Currently, the Cloud API does not support webhook status updates for deleted messages. If a user deletes a message, you will receive a webhook with an error code for an unsupported message type:" }, "response": [] }, { "name": "Status: Message Failed", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"WHATSAPP_BUSINESS_ACCOUNT_ID\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": PHONE_NUMBER,\n \"phone_number_id\": PHONE_NUMBER_ID\n },\n \"statuses\": [\n {\n \"id\": \"wamid.ID\",\n \"status\": \"failed\",\n \"timestamp\": TIMESTAMP,\n \"recipient_id\": PHONE_NUMBER,\n \"errors\": [\n {\n \"code\": 131014,\n \"title\": \"Request for url https://URL.jpg failed with error: 404 (Not Found)\"\n }\n ]\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" }, "description": "The following notification shows a Webhook with failed status:" }, "response": [] }, { "name": "Received Product Enquiry Message", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"ID\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"PHONE_NUMBER\",\n \"phone_number_id\": \"PHONE_NUMBER_ID\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"NAME\"\n },\n \"wa_id\": \"PHONE_NUMBER_ID\"\n }\n ],\n \"messages\": [\n {\n \"from\": \"PHONE_NUMBER\",\n \"id\": \"wamid.ID\",\n \"text\": {\n \"body\": \"MESSAGE_TEXT\"\n },\n \"context\": {\n \"from\": \"PHONE_NUMBER\",\n \"id\": \"wamid.ID\",\n \"referred_product\": {\n \"catalog_id\": \"CATALOG_ID\",\n \"product_retailer_id\": \"PRODUCT_ID\"\n }\n },\n \"timestamp\": \"TIMESTAMP\",\n \"type\": \"text\"\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" }, "description": "A Product Enquiry Message is received when a user is asking for more information about a specific product. These can be received as in two scenarios:
  1. When a customer replies to Single or Multi-Product Messages
  2. When a customer accesses a business’ catalog through another entry point, navigates to a **Product Details Page**, and clicks **Message Business about this Product**.
" }, "response": [] }, { "name": "Received Order Messages", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"8856996819413533\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"16505553333\",\n \"phone_number_id\": \"phone-number-id\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"Kerry Fisher\"\n },\n \"wa_id\": \"16315551234\"\n }\n ],\n \"messages\": [\n {\n \"from\": \"16315551234\",\n \"id\": \"wamid.ABGGFlCGg0cvAgo6cHbBhfK5760V\",\n \"order\": {\n \"catalog_id\": \"the-catalog_id\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"the-product-SKU-identifier\",\n \"quantity\": \"number-of-item\",\n \"item_price\": \"unitary-price-of-item\",\n \"currency\": \"price-currency\"\n }\n ],\n \"text\": \"text-message-sent-along-with-the-order\"\n },\n \"context\": {\n \"from\": \"16315551234\",\n \"id\": \"wamid.gBGGFlaCGg0xcvAdgmZ9plHrf2Mh-o\"\n },\n \"timestamp\": \"1603069091\",\n \"type\": \"order\"\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" } }, "response": [] }, { "name": "Status: Transaction Status - Order Details Message", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"WHATSAPP_BUSINESS_ACCOUNT_ID\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"PHONE_NUMBER\",\n \"phone_number_id\": \"PHONE_NUMBER_ID\"\n },\n \"statuses\": [\n {\n \"id\": \"wamid.ID\",\n \"from\": \"PHONE_NUMBER\",\n \"type\": \"payment\",\n \"status\": \"\",\n \"payment\": {\n \"reference_id\": \"reference-id-from-order-details-msg\"\n },\n \"timestamp\": \"notification_timestamp\"\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" }, "description": "The following notification is received when a business sends a message which opens a service [conversation](https://developers.facebook.com/docs/whatsapp/pricing#conversations):" }, "response": [] } ], "description": "Webhooks are user-defined HTTP callbacks that are triggered by specific events. Whenever that trigger event occurs, the WhatsApp Business API client captures the event, collects the data, and immediately sends a notification (HTTPs request) to the Webhook URL configured in the Webhooks setup step.\n\nFor the purposes of this use case, your Webhooks server must be reachable from facebook and have HTTPs support and a valid SSL certificate. See [Webhooks, Getting Started](https://developers.facebook.com/docs/graph-api/webhooks/getting-started) for requirements on creating a Webhooks endpoint and configuring the Webhooks product.\n\nTo get Webhooks notifications, your application must subscribe to the WABA you want to receive alerts for. For a full guide, see [Webhooks for WhatsApp Business Accounts](https://developers.facebook.com/docs/graph-api/webhooks/getting-started/webhooks-for-whatsapp).\n\n \nThe structure of the webhook payload is explained in the [Webhooks Notification Payload Reference. ](https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/components/) All Webhooks have the following generic JSON format:\n\n``` json\n{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"WHATSAPP_BUSINESS_ACCOUNT_ID\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"PHONE_NUMBER\",\n \"phone_number_id\": \"PHONE_NUMBER_ID\"\n },\n # specific Webhooks payload \n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}\n\n ```\n\n \nIf you receive a message that is not supported for the Cloud API beta release, you will get an [unknown message Webhook](https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks#received-unknown-messages).\n\n**This table lists all possible options for the status of a message.**\n\n| Status | Description | WhatsApp Mobile Equivalent |\n| --- | --- | --- |\n| **`sent`** | Message received by WhatsApp server. | One checkmark |\n| **`delivered`** | Message delivered to the recipient. | Two checkmarks |\n| **`read`** | Message read by recipient. | Two blue checkmarks |\n| **`failed`** | Message failed to send. | Red error triangle |\n| **`deleted`** | Message deleted by the user. | Message is replaced in WhatsApp mobile with the note `\"This message was deleted\"`. |", "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Subscribe to a WABA", "request": { "method": "POST", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/subscribed_apps", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "subscribed_apps" ] }, "description": "Subscribe an app to a WhatsApp Business Account. For more information about subscribing to a WhatsApp Business Account, see [Subscribe to a WhatsApp Business Account](https://developers.facebook.com/docs/whatsapp/embedded-signup/webhooks#subscribe-to-a-whatsapp-business-account)." }, "response": [ { "name": "Subscribe to a WABA", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/subscribed_apps", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "subscribed_apps" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"success\": true\n}" } ] }, { "name": "Get All Subscriptions for a WABA", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/subscribed_apps", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "subscribed_apps" ] }, "description": "To get a list of apps subscribed to Webhooks for a WABA, send a **GET** request to the **`subscribed_apps`** endpoint on the WABA:" }, "response": [ { "name": "Get All Subscriptions for a WABA", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/subscribed_apps", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "subscribed_apps" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"whatsapp_business_api_data\": {\n \"link\": \"\",\n \"name\": \"\",\n \"id\": \"7234002551525653\"\n }\n },\n {\n \"whatsapp_business_api_data\": {\n \"link\": \"\",\n \"name\": \"\",\n \"id\": \"3736565603394103\"\n }\n }\n ]\n}\n" } ] }, { "name": "Unsubscribe from a WABA", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/subscribed_apps", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "subscribed_apps" ] }, "description": "To unsubscribe your app from webhooks for a WhatsApp Business Account, send a **DELETE** request to the `/subscribed_apps/` endpoint on the WABA." }, "response": [ { "name": "Unsubscribe from a WABA", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/subscribed_apps", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "subscribed_apps" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"success\": true\n}" } ] }, { "name": "Override Callback URL", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"override_callback_uri\": \"\",\n \"verify_token\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/subscribed_apps", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "subscribed_apps" ] }, "description": "If you want to subscribe to Webhooks for multiple WhatsApp Business Accounts but want messages field Webhooks notifications to be sent to different callback URLs for each WABA, you can override the callback URL when subscribing to Webhooks for each WABA.\n\nTo do this, first verify that the alternate Webhook endpoint can receive and process Webhooks notifications. Then, subscribe to Webhooks for the WABA as your normally would, but include the alternate endpoint's callback URL along with its verification token as a JSON payload:\n\n\nFor more information, see [Overriding the Callback URL](https://developers.facebook.com/docs/whatsapp/embedded-signup/webhooks#overriding-the-callback-url)." }, "response": [ { "name": "Override Callback URL", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"override_callback_uri\": \"https://alternate-endpoint-callback.com/webhook\",\n \"verify_token\": \"myvoiceismypassport?\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/v15.0/{{WABA-ID}}/subscribed_apps", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "v15.0", "{{WABA-ID}}", "subscribed_apps" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"data\" : [\n {\n \"override_callback_uri\" : \"https://alternate-endpoint-callback.com/webhook\",\n \"whatsapp_business_api_data\" : {\n \"id\" : \"670843887433847\",\n \"link\" : \"https://www.facebook.com/games/?app_id=67084...\",\n \"name\" : \"Jaspers Market\"\n }\n }\n ]\n}" } ] } ], "description": "To get Webhook events for a specific WABA, you need to explicitly subscribe to that WABA. You only need to subscribe to a WABA once and then you receive all Webhook events for phone numbers under that WABA. You don’t need to subscribe for every phone number. \n

\n\n## Reminders\n- To use these endpoints, you need to authenticate yourself with a [System User Access Token](https://developers.facebook.com/docs/facebook-login/access-tokens#usertokens) with the **`whatsapp_business_management`** permission.\n- WhatsApp Business Account ID (WABA ID). If you need to find your WABA ID see [Get WABA ID](#b7f6e513-f4e4-4b62-b4a2-d18dc5e6249c).\n- You need to set up Webhooks server in your application to receive Webhooks events. To learn how to set up Webhooks, see [Webhooks](https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/components)." }, { "name": "Messages", "item": [ { "name": "Messages Object", "item": [ { "name": "Text Object", "item": [], "description": "A **`Text Object`** consists of the following fields and formatting options:\n\n#### Fields\n\n| Name | Description |\n|----------------|--------------|\n| **`body`** | **Required for text messages**.
The text of the text message that can contain URLs and supports formatting. To view available formatting options, see [Text Object Formatting Options](https://developers.facebook.com/docs/whatsapp/api/messages#formatting).

If you include URLs in your text **and** want to include a preview box in text messages (`\"preview_url\": true`), ensure it starts with `http://` or `https://`. You must include a hostname, since IP addresses are not matched.

Maximum length: 4096 characters. |\n|**`preview_url`**
type: `Boolean`| **Optional**.
By default, WhatsApp recognizes URLs and makes them clickable, but you can also include a preview box with more information about the link. Set this field to `true` if you want to include a URL preview box.

The majority of the time when you send a URL, whether with a preview or not, the receiver of the message will see a URL that they can click on.

URL previews are only rendered after one of the following has occurred:
  • The business has sent a message template to the user.
  • The user initiates a conversation with a \"click to chat\" link.
  • The user adds the business phone number to their address book and initiates a conversation.

**Default**: `false`|" }, { "name": "Reaction Object", "item": [], "description": "The `Reaction Object` consists of a message ID and a emoji.\n\n#### Fields\n\n| Name | Description |\n|-----------------|---------------------|\n| **`message_id`** | **Required**.

Specifies the WhatsApp message ID (WAMID) that this reaction is being sent to.

You cannot send a reaction to a **`message_id`** that previously sent or received reaction messages. |\n| **`emoji`** | **Required**.

The emoji used for the reaction.

All emojis are supported, however only one emoji can be sent in a reaction message. Set this value to \"\" (empty string) to remove the reaction.
Unicode is not supported. However, unicode values can be Java or JavaScript-escape encoded. |" }, { "name": "Media Object", "item": [], "description": "The `Media Object` consists of audio, document, image, sticker, and video objects.\n\n#### Fields\n\n| Name | Description |\n|-----------------|---------------------|\n| **`id`** | **Required when type is an image, audio, document, sticker, or video and you are not using a link**.
The media object ID. For more information, see [Get Media ID](#39a02bc0-ede1-4848-b24e-4ac3d501aaea). |\n| **`link`** | **Required when type is audio, document, image, sticker, or video and you are not using an uploaded media ID.**
The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. |\n| **`caption`** | **Optional**.
Describes the specified image, document, or video. Do not use it with audio or sticker media.|\n|**`filename`** | **Optional**.
Describes the filename for the specific document. Use only with document media.|" }, { "name": "Template Object", "item": [], "description": "The `Template Object` contains the following fields:\n\n#### Fields\n\n| Name | Description |\n|------------------|--------------------------|\n| **`name`** |**Required**.
The name of the template. |\n| **`language`** |**Required**.
Specifies a [language object](https://documenter.getpostman.com/view/13382743/UVC5FTHT?fbclid=IwAR083mCseNzJm-JgxlIQbdF30hkAbEOHkbBaw9bA7-isGKU6uwtq1RJKc0o#d9272e38-c3db-458c-a23b-07953abc73a4). Specifies the language the template may be rendered in.

Only the **`deterministic`** language policy works with media template messages.|\n| **`components`** |**Optional**.
An array of [components objects](https://documenter.getpostman.com/view/13382743/UVC5FTHT?fbclid=IwAR0V3m0B47q6rsaPsrwcWzb5FbNtQD7K8I1RulisTB4Mj-rB0AYiSkdc9lY#8225365a-acb8-48c7-8e57-079dfc532865) that contain the parameters of the message. |" }, { "name": "Language Object", "item": [], "description": "The `Language Object` contains the following fields:\n\n#### Fields\n\n| Name | Description |\n|------------------|--------------------------|\n| **`policy`** |**Optional**.
For more information, see [Language Policy Options](https://developers.facebook.com/docs/whatsapp/api/messages/message-templates#language-policy-options).

**Default** (and only supported value): `deterministic`|\n| **`code`** |**Required**.
The code of the language or locale to use. This field accepts both language (for example, `‘en’`) and language_locale (for example, `‘en_US’`) formats.
For more information regarding all codes, see [Supported Languages](https://developers.facebook.com/docs/whatsapp/api/messages/message-templates#supported-languages). |" }, { "name": "Components Object", "item": [], "description": "The `Components Object` contains the following fields:\n\n#### Fields\n\n| Name | Description |\n|------------------|--------------------------|\n| **`type`** |**Required**.
Describes the component type.

**Values**: `header`, `body`, `button`
For text-based templates, only `body` is supported. |\n| **`parameters`** |**Required when type is `button`**.
The namespace of the template. |\n| **`sub_type`** |**Required when type is `button`. Not used for the other types.**
The type of button to create.

**Values**: `quick_reply`, `url`|\n| **`index`** |**Required when type is `button`. Not used for the other types.**
The position index of the button. You can have up to 3 buttons using index values of 0 to 2. |" }, { "name": "Parameter Object", "item": [], "description": "The **`Parameter Object`** contains the following fields:\n\n#### Fields\n\n| Name | Description |\n|------------------|--------------------------|\n| **`type`** |**Required**.
Describes the parameter type.


**Values**: `text`, `currency`, `date_time`, `image`, `document`

For text-based templates, the only supported parameter types are `text`, `currency`, and `date_time` |\n| **`text`** |**Required when type=`text`**.
The message of the text.
For the `header component`, the character limit is 60 characters.
For the `body component`, the character limit is 1024.

The exception to these character limits applies to template messages in the following conditions:
  • When sending a **`template`** message with a **`body`** component only, the character limit for the `text` parameter and the full template text is 32768 characters.
  • When sending a **`template`** message with **`body`** and other components, The character limit for the `text` parameter and the full template text is 1024 characters.
      • |\n| **`currency`** |**Required when type is `currency`**.
      A [currency object](#424b70af-ced8-456d-b1e1-1360c5afb9e9).|\n| **`date_time`** |**Required when type is `date_time`**.
      A [date_time object](#ec955b05-7bd4-4273-ad87-ae755b580f6e).|\n| **`image`** |**Required when type is `image`**.
      A [media object](#77f64012-481d-45d8-855f-e1620c6b2a5e) of type image.|\n| **`document`** |**Required when type is `document`**.
      A [media object](#77f64012-481d-45d8-855f-e1620c6b2a5e) of type document.
      Only PDF documents are supported for media-based message templates.|" }, { "name": "Currency Object", "item": [], "description": "The `Currency Object` contains the following fields:\n\n#### Fields\n\n| Name | Description |\n|----------------------|--------------------------|\n| **`fallback_value`** |**Required**.
      The default text if localization fails.
      |\n| **`code`** |**Required**.
      The currency code as defined in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).
      |\n| **`amount_1000`** |**Required**.
      The amount multiplied by 1000.
      |" }, { "name": "Date_Time Object", "item": [], "description": "The `Date_Time Object` contains the following fields:\n\n#### Fields\n\n| Name | Description |\n|----------------------|--------------------------|\n| **`fallback_value`** | **Required**.
      The default text if localization fails. |\n| **`day_of_week`** | **Optional**.
      If it is different from the value derived from the date (if specified), use the derived value. Both strings and numbers are accepted.
      Supported values:
      • `\"MONDAY\"` or 1
      • `\"TUESDAY\"` or 2
      • `\"WEDNESDAY\"` or 3
      • `\"THURSDAY\"` or 4
      • `\"FRIDAY\"` or 5
      • `\"SATURDAY\"` or 6
      • `\"SUNDAY\"` or 7
      |\n| **`year`** | **Optional**.
      Specifies the year. |\n| **`month`** | **Optional**.
      Specifies the month. |\n| **`day_of_month`** | **Optional**.
      Specifies the day of the month. |\n| **`hour`** | **Optional**.
      Specifies the hour. |\n| **`minute`** | **Optional**.
      Specifies the minute. |\n| **`calendar`** | **Optional**.
      The type of calendar.

      **Values**: `\"GREGORIAN\"` or `\"SOLAR_HIJRI\"`. |" }, { "name": "Button Parameter Object", "item": [], "description": "The `Button Parameter Object` contains the following fields:\n\n#### Fields\n\n| Name | Description |\n|----------------------|--------------------------|\n| **`type`** | **Required**.
      Specifies the type of parameter for the button.

      **Values**: `payload`,`text`|\n| **`payload`** | **Required for `quick_reply` buttons**.
      Developer-defined payload that is returned when the button is clicked in addition to the display text on the button.

      For more information on usage, see [Callback from a Quick Reply Button Click](#eb99d8fb-170a-4284-b7da-454484a0333a).|\n| **`text`** | **Required for url buttons**.
      Developer-provided suffix that is appended to the predefined prefix URL in the template.|" }, { "name": "Contacts Object", "item": [ { "name": "addresses Object", "item": [], "description": "| Name | Description |\n| --- | --- |\n| **`street`** | **Optional**.
      Steet number and name. |\n| **`city`** | **Optional**.
      The name of the city. |\n| **`state`** | **Optional**.
      The abbreviation name of the state. |\n| **`zip`** | **Optional**.
      The ZIP code. |\n| **`country`** | **Optional**.
      The full name of the country. |\n| **`country_code`** | **Optional**.
      The two-letter country abbreviation. |\n| **`type`** | **Optional**.
      Standard values: `HOME`, `WORK`. |" }, { "name": "emails Object", "item": [], "description": "| Name | Description |\n| --- | --- |\n| **`email`** | **Optional**.
      Email address. |\n| **`type`** | **Optional**.
      Standard Values: `HOME`, `WORK` |" }, { "name": "name Object", "item": [], "description": "| Name | Description |\n|---|---|\n| **`formatted_name`** | **Required.**
      Full name, as it normally appears. |\n| **`first_name`** | **Optional**.
      First name.|\n| **`last_name`** | **Optional**.
      Last name. |\n| **`middle_name`** | **Optional**.
      Middle name. |\n| **`suffix`** | **Optional**.
      Name suffix.|\n| **`prefix`**| **Optional**.
      Name prefix. |\n\n* At least one of the optional parameters needs to be included along with the **`formatted_name`** parameter." }, { "name": "org Object", "item": [], "description": "| Name | Description |\n| --- | --- |\n| **`company`** | **Optional.**
      Name of the contact's company. |\n| **`department`** | **Optional.**
      Name of the contact's department. |\n| **`title`** | **Optional.**
      The contact's business title. |" }, { "name": "phone Object", "item": [], "description": "| Name | Description |\n| --- | --- |\n| **`phone`** | **Optional.**
      Automatically populated with the **`wa_id`** value as a formatted phone number. |\n| **`type`** | **Optional.**
      Standard Values: `CELL`, `MAIN`, `IPHONE`, `HOME`, `WORK` |\n| **`wa_id`** | **Optional.**
      WhatsApp ID. |" }, { "name": "urls Object", "item": [], "description": "| Name | Description |\n| --- | --- |\n| **`url`** | **Optional.**
      The URL. |\n| **`type`** | **Optional.**
      Standard Values: `HOME`, `WORK` |" } ], "description": "The `Contacts Object` contains the following fields:\n\n#### Fields\n\n| Name | Description |\n|----------------------|--------------------------|\n| **`addresses`** | **Optional**.
      Specifies an array of address objects. For more information, see [address object](https://developers.facebook.com/docs/whatsapp/api/messages#addresses-object).|\n| **`birthday`** | **Optional**.
      A **YYYY-MM-DD** formatted string.|\n| **`emails`** | **Optional**.
      Specifies an array of email objects. For more information, see [emails object](https://developers.facebook.com/docs/whatsapp/api/messages#emails-object).|\n| **`name`** | **Required**.
      Specifies the name object. For more information, see [name object](https://developers.facebook.com/docs/whatsapp/api/messages#name-object).|\n| **`org`** | **Optional**.
      Specifies the org object. For more information, see [org object](https://developers.facebook.com/docs/whatsapp/api/messages#org-object).|\n| **`phones`** | **Optional**.
      Specifies an array of phone objects. For more information, see [phone object](https://developers.facebook.com/docs/whatsapp/api/messages#phone-object).|\n| **`urls`** | **Optional**.
      Specifies an array of url objects. For more information, see [url object](https://developers.facebook.com/docs/whatsapp/api/messages#urls-object).|" }, { "name": "Location Object", "item": [], "description": "The `Location Object` contains the following fields:\n\n
      Fields
      \n\n| Name | Description |\n|----------------------|--------------------------|\n| **`longitude`** | **Required**.
      The longitude of the location.|\n| **`latitude`** | **Required**.
      The latitude of the location.|\n| **`name`** | **Optional**.
      The name of the location.|\n| **`address`** | **Optional**.
      The address of the location. This field is only displayed if **`name`** is present.|" }, { "name": "Interactive Object", "item": [ { "name": "Header Object", "item": [], "description": "##### Fields\n\n| Name | Description |\n|----------------------|--------------------------|\n| **`type`** | **Required**.
      The header type you would like to use. Supported values are:
      • `text`: Used for List Messages, Reply Buttons, and Multi-Product Messages.
      • `video`: Used for Reply Buttons.
      • `image`: Used for Reply Buttons.
      • `document`: Used for Reply Buttons.
      |\n| **`text`** | **Required if `type` is set to `text`**.
      The text for the header. Formatting allows emojis, but not markdown.

      Maximum length: 60 characters.|\n| **`video`** | **Required if `type` is set to `video`**.
      Contains the **`media`** object for this video.|\n| **`image`** | **Required if `type` is set to `image`**.
      Contains the **`media`** object for this image.|\n| **`document`** | **Required if `type` is set to `document`**.
      Contains the **`media`** object for this document.|" }, { "name": "Body Object", "item": [], "description": "##### Fields\n\n| Name | Description |\n|----------------------|--------------------------|\n| **`text`** | **Required**.
      The body content of the message. Emojis and markdown are supported. Links are supported.

      Maximum length: 1024 characters.|" }, { "name": "Footer Object", "item": [], "description": "##### Fields\n\n| Name | Description |\n|----------------------|--------------------------|\n| **`text`** | **Required if the `footer` object is present**.
      The footer content of the message. Emojis and markdown are supported. Links are supported.

      Maximum length: 60 characters.|" }, { "name": "Action Object", "item": [], "description": "##### Fields\n\n| Name | Description |\n|----------------------|--------------------------|\n| **`button`** | **Required for all List Messages**.
      The Button content. It cannot be an empty string and must be unique within the message. Does not allow emojis or markdown.

      Maximum length: 20 characters.|\n| **`buttons`** | **Required for Reply Button**.
      A button can contain the following parameters:
      • **`type`**: only supported if **`type`**=**`reply`**(for Reply Button)
      • **`title`**: The Button title. It cannot be an empty string and must be unique within the message. Does not allow emojis or markdown. Maximum length: 20 characters.
      • **`id`**: Unique identifier for your button. This ID is returned in the Webhook when the button is clicked by the user. Maximum length: 256 characters.

      You can have a maximum of 3 buttons.|\n| **`sections`** | **Required for List Messages and Multi-Product Messages**.
      The array of **`section`** objects. There is a minimum of 1 and maximum of 10. For more information, see [section object](#).|\n| **`catalog_id`** | **Required for Single Product and Multi-Product messages.**

      Unique identifier of the Facebook catalog linked to your WhatsApp Business Account. **`catalog_id`** can be retrieved through [Commerce Manager](https://business.facebook.com/commerce/). |\n| **`product_retailer_id`** | **Required for Single Product and Multi-Product messages.**

      The unique identifier of the product in the catalog.

      To get the **`product_retailer_id`**, go to [Commerce Manager](https://business.facebook.com/commerce/), select your Facebook Business account, and you will see a list of shops connected to your account. Click the shop you want to use. On the left-side panel, click **Catalog** > **Items**, and find the item you want to mention. The ID for that item is displayed under the item's name. |" }, { "name": "Section Object", "item": [], "description": "##### Fields\n\n| Name | Description |\n| --- | --- |\n| **`title`** | **Required if the message has more than one** **`section`**.
      The title of the section.

      Maximum length: 24 characters. |\n| **`rows`** | **Required for List Messages**.

      Each row must have a **`title`** (Maximum length: 24 characters) and an **`ID`** (Maximum length: 200 characters). You can add a **`description`** (Maximum length: 72 characters), but it is optional. |\n| **`product_items`** | **Required for Multi-Product Messages**.

      Specifies an array of `product` objects.
      There is a minimum of 1 product per section and a maximum of 30 products across all sections.

      Each `product` object contains the following field:
      **`product_retailer_id`** – **Required for Multi-Product Messages**. Specifies the unique identifier of the product in a catalog. To get this ID, go to [Commerce Manager](https://business.facebook.com/commerce/), select your account and the shop you want to use. Then, click **Catalog** > **Items**, and find the item you want to mention. The ID for that item is displayed under the item's name.\n\n\n##### **`Rows`** Example\n\n``` json\n\"rows\": [\n {\n \"id\":\"unique-row-identifier-here\",\n \"title\": \"row-title-content-here\",\n \"description\": \"row-description-content-here\",\n }\n]\n\n```" } ], "description": "The **`Interactive Object`** contains four main components: **`header`**, **`body`**, **`footer`**, and **`action`**. Additionally, some of those components can contain one or more different objects:\n\n* Inside **`header`**, you can nest **`media`** objects.\n* Inside **`action`**, you can nest **`section`** and **`button`** objects.\n\n#### Fields\n\n| Name | Description |\n|----------------------|--------------------------|\n| **`type`** | **Required**.
      The type of interactive message you want to send. Supported values:
      • `list`: Use it for List Messages.
      • `button`: Use it for Reply Buttons.
      • `product`: Use this for Single Product Messages
      • `product_list`: Use this for Multi-Product Messages
      |\n| **`header`** | **Required for type `product_list`**. **Optional for other types**.
      This contains the header content displayed on top of a message. You cannot set a **`header`** if your **`interactive`** object is type `product`.

      The **`header`** object contains the following fields:
      • `document`: **Required** if **`type`** is set to `document`. Contains the **`media`** object with the document.
      • `image`: **Required** if **`type`** is set to `image`. Contains the **`media`** object with the image.
      • `video`: **Required** if **`type`** is set to `video`. Contains the **`media`** object with the video.
      • `text`: **Required** if **`type`** is set to `text`. The text for the header. Formatting allows emojis, but not markdown. Maximum length: 60 characters.


      Supported interactive message type by header type:
      • `text` - for List Messages, Reply Buttons, and Multi-Product Messages
      • `video` - for Reply Buttons.
      • `image`: for Reply Buttons.
      • `document` - For Reply Buttons.
      |\n| **`body`** | **Optional** for type `product`. **Required** for all other message types.
      The body of the message. The **`text`** field for the **`body`** object supports Emojis and markdown.

      Maximum length: 1024 characters.|\n| **`footer`** | **Optional**.
      An object with the footer of the message.Emojis and markdown are supported.

      Maximum length: 60 characters.|\n| **`action`** | **Required**.
      The action you want the user to perform after reading the message.|" } ], "description": "To send a message, you must first assemble a message object with the content you want to send. The **`Message Object`** contains the following fields used to create a message object:\n\n#### Fields\n\n| Name | Description |\n|------|----------|\n|**`messaging_product`** | **Required**.
      Messaging service used for the request. Always use `\"whatsapp\"`.|\n|**`recipient_type`** | **Optional**.
      Currently, you can only send messages to individuals. Set this value to `\"individual\"`.

      **Default**: `individual` |\n|**`to`** | **Required**.
      WhatsApp ID or phone number for the person you want to send a message to.

      See [Phone Numbers, Formatting](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/phone-numbers#formatting) for more information. |\n|**`context`** | **Optional**. Only used for Cloud API.
      Used to mention a specific message you are replying to. The reply can be any message type currently supported by the Cloud API. |\n|**`type`** | **Optional**.
      The type of message you want to send.

      The supported options for beta users are:
      • **text**: for text messages.
      • **template**: for template messages. Only text-based templates are supported.
      • **document**: for document messages.
      • **image**: for image messages.
      • **interactive**: for list and reply button messages.
      • **audio**: for audio messages.
      • **contacts**: for contacts messages.
      • **location**: for location messages.
      • **sticker**: for sticker messages.
      • **video**: for video messages.

      **Default**: `text`|\n|**`text`** | **Required for text messages**.
      A [text object](#fa59d67b-dc6f-446a-a0fd-f97537afbd2e). |\n|**`audio`** | **Required when `type` is set to `audio`**.
      A [media object](#77f64012-481d-45d8-855f-e1620c6b2a5e) containing audio. |\n|**`contact`** | **Required when `type` is set to `contacts`**.
      A [contacts object](#5bb1e554-402c-4278-bce4-657a9c4dc12f).|\n|**`document`** | **Required when `type` is set to `document`**.
      A [media object](#77f64012-481d-45d8-855f-e1620c6b2a5e) containing a document. |\n|**`image`** | **Required when `type` is set to `image`**.
      A [media object](#77f64012-481d-45d8-855f-e1620c6b2a5e) containing an image. |\n|**`interactive`** | **Required when `type` is set to `interactive`**.
      An [interactive object](#68fe0550-aba5-4ee3-b79d-0846f3dddef1). This option is used to send List Messages and Reply Buttons.

      The components of each interactive object generally follow a consistent pattern: **`header`**, **`body`**, **`footer`**, and **`action`**. |\n|**`location`** | **Required when type `type` is set to `location`**.
      A [location object](#2ad90ff7-6fef-40a8-96cf-83f1144763c1). |\n|**`reaction`** | **Required when type `type` is set to `reaction`**.
      A [reaction object](). |\n|**`sticker`** | **Required when `type` is set to `sticker`**.
      A [media object](#77f64012-481d-45d8-855f-e1620c6b2a5e) containing a sticker. Currently, we only support third-party static stickers. Static stickers must be 512x512 pixels and cannot exceed 100 KB. Animated stickers must be 512x512 pixels and cannot exceed 500 KB.|\n|**`video`** | **Required when `type` is set to `video`**.
      A [media object](#77f64012-481d-45d8-855f-e1620c6b2a5e) containing a video. |\n|**`template`** | **Required when type is set to `template`**.
      A [template object](#fb5ad9b7-7991-443a-a1b5-97fdc5731673). |", "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Send Text Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\", \n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"text\",\n \"text\": {\n \"preview_url\": false,\n \"body\": \"text-message-content\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a text message, make a **POST** call to **`/{{{Phone-Number-ID}}/messages`** and attach a message object with `type = \"text\"`. Then, add a `text object`.\n\nFor more information about the `Text Object` structure, see [Text object](#fa59d67b-dc6f-446a-a0fd-f97537afbd2e).\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Text Message", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\", \n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"text\",\n \"text\": {\n \"preview_url\": false,\n \"body\": \"text-message-content\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Reply to Text Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"text\",\n \"text\": {\n \"preview_url\": false,\n \"body\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a reply-to text message, make a **POST** call to **`/{{{Phone-Number-ID}}/messages`** and use the **`context.message_id`** field. \n\nContext field is used for specifying to which previous message (**`context.message_id`**) you are replying to.\n\n## Request Parameters\n\n| Parameter | Description |\n|---|---|\n| **`messaging_product`** | **Required**
      Messaging service used for the request. Use `\"whatsapp\"`.\n| **`context.message_id`** | **Required for context object**
      Specifies the ID of the message being replied to. |\n\nFor more information about the `Text Object` structure, see [Text object](#fa59d67b-dc6f-446a-a0fd-f97537afbd2e).\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Reply to Text Message", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"text\",\n \"text\": {\n \"preview_url\": false,\n \"body\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/v13.0/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "v13.0", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Text Message with Preview URL", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"text\": {\n \"preview_url\": true,\n \"body\": \"Please visit https://youtu.be/hpltvTEiRrY to inspire your day!\"\n }\n}" }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "response": [ { "name": "Send Text Message with Preview URL", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"text\": {\n \"preview_url\": true,\n \"body\": \"Please visit https://youtu.be/hpltvTEiRrY.\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [{\n \"input\": \"15555551234\",\n \"wa_id\": \"\"\n }],\n \"messages\": [{\n \"id\": \"wamid.ID\"\n }]\n}" } ] }, { "name": "Send Reply with Reaction Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"reaction\",\n \"reaction\": {\n \"message_id\": \"\",\n \"emoji\": \"\"\n }\n}" }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send reaction messages, make a **POST** call to `/PHONE_NUMBER_ID/messages` and attach a message object with `type = reaction`. Then, add a **`reaction`** object.\n\n\n### Parameters\n\n| Name | Description |\n| --- | --- |\n| **`messaging_product`** | **Required**.
      Always set this value to `\"whatsapp\"`. |\n| **`recipient_type`** | **Optional**.
      Currently, you can only send messages to individuals. Set this value to `\"individual\"`.

      **Default**: `individual` |\n| **`to`** | **Required**.
      WhatsApp ID or phone number for the person you want to send a message to.

      See [Phone Numbers, Formatting](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/phone-numbers#formatting) for more information. |\n| **`type`** | **Required**.
      To send a reply with a reaction, set this string value to `\"reaction\"`. |\n| **`reaction`** | **Required**.
      The [reaction object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#reaction-object) you are using for your reply. |\n\nIf the previous message is more than 30 days old or doesn't correspond to any message in the conversation, the reaction message will not be delivered and you will receive a Webhook with the code `131009`." }, "response": [ { "name": "Send Reply with Reaction Message", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"reaction\",\n \"reaction\": {\n \"message_id\": \"wamid.HBgLM...\",\n \"emoji\": \"\\uD83D\\uDE00\"\n }\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/v14.0/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "v14.0", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"\",\n \"wa_id\": \"\"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.HBgLM...\"\n }\n ]\n}" } ] }, { "name": "Send Image Message by ID", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"image\",\n \"image\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a reply to an image message, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a message object with type = `image`. Then add a corresponding `image object`.\n\nSend an image message to your customers using link or media ID uploaded from media endpoint.\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Image Message by ID", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"image\",\n \"image\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}\n" } ] }, { "name": "Send Reply to Image Message by ID", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"image\",\n \"image\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a reply-to image message, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a message object with type = `image`. Add the `image.id` of the image. \n\nAssign **`context.message_id`** the message id of the message you want to reply to.\n\n## Request Parameters\n\n| Parameter | Description |\n|---|---|\n| **`messaging_product`** | **Required**
      Messaging service used for the request. Use `\"whatsapp\"`.\n| **`context.message_id`** | **Required for context object**
      Specifies the ID of the message being replied to. |\n| **`type`** | **Required**
      Specifies the media type. Use \"image\".|\n| **`image.id`** | Specifies the ID of the image you are replying to. |\n\nFor more information about the `Media Object` structure, see [Media Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#media-object).\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Reply to Image Message by ID", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "url": { "raw": "" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Image Message by URL", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"image\",\n \"image\": {\n \"link\": \"http(s)://image-url\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a media message, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a message object with type = `image`. Then, be sure to include the link to the image.\n\nSend an audio message to your customers using a link to an image file.\n\nFor more information about the `Media Object` structure, see [Media Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#media-object)." }, "response": [ { "name": "Send Image Message by URL", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"image\",\n \"image\": {\n \"link\": \"http(s)://image-url\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Reply to Image Message by URL", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"image\",\n \"image\": {\n \"link\": \"http(s)://image-url\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send an image link as a reply to message, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a media object with type = `image`. Then, be sure to include the link to the image.\n\nAssign **`context.message_id`** the message ID of the message you want to reply to.\n\n## Request Parameters\n\n| Parameter | Description |\n|---|---|\n| **`messaging_product`** | **Required**
      Messaging service used for the request. Use `\"whatsapp\"`.\n| **`context.message_id`** | **Required for context object**
      Specifies the ID of the message being replied to. |\n| **`type`** | **Required**
      Specifies the media type. Use \"image\".|\n| **`image.link`** | Specifies the link of the image you are using for your reply. |\n\nFor more information about the `Media Object` structure, see [Media Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#media-object).\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Reply to Image Message by URL", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Audio Message by ID", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"audio\",\n \"audio\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a media message, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a media object with type = `audio`. Then, add the corresponding `audio object` ID.\n\n## Request Parameters\n\n| Parameter | Description |\n| --- | --- |\n| **`messaging_product`** | **Required**
      Messaging service used for the request. Use `\"whatsapp\"`. |\n| **`type`** | **Required**
      Specifies the media type. Use \"audio\". |\n| **`audio.id`** | Specifies the ID of the media object you are replying to. |\n| **`audio.voice`** | boolean. If true, send this as a [voice](https://faq.whatsapp.com/657157755756612/) message instead of a normal [audio](https://developers.facebook.com/docs/whatsapp/cloud-api/messages/audio-messages) message. Ensure your audio file is an .ogg codec=opus file if using this |\n\nFor more information about the `Media Object` structure, see [Media Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#media-object).\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Audio Message by ID", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"audio\",\n \"audio\": {\n \"id\": \"\",\n \"voice\": true\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Reply to Audio Message by ID", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"audio\",\n \"audio\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a media message, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a media object with type = `audio`. Then, add the corresponding `audio object` ID.\n\nAssign **`context.message_id`** the message id of the message you want to reply to.\n\n## Request Parameters\n\n| Parameter | Description |\n| --- | --- |\n| **`messaging_product`** | **Required**
      Messaging service used for the request. Use `\"whatsapp\"`. |\n| **`context.message_id`** | **Required for context object**
      Specifies the ID of the message being replied to. |\n| **`type`** | **Required**
      Specifies the media type. Use \"audio\". |\n| **`audio.id`** | Specifies the ID of the media object you are replying to. |\n| **`audio.voice`** | boolean. If true, send this as a [voice](https://faq.whatsapp.com/657157755756612/) message instead of a normal [audio](https://developers.facebook.com/docs/whatsapp/cloud-api/messages/audio-messages) message. Ensure your audio file is an .ogg codec=opus file if using this |\n\nFor more information about the `Media Object` structure, see [Media Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#media-object).\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Reply to Audio Message by ID", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"audio\",\n \"audio\": {\n \"id\": \"\",\n \"voice\": true\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Audio Message by URL", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"audio\",\n \"audio\": {\n \"link\": \"http(s)://audio-url\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send an audio link as a reply to message, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a media object with type = `audio`. Then, be sure to include the link to the audio.\n\n## Request Parameters\n\n| Parameter | Description |\n| --- | --- |\n| **`messaging_product`** | **Required**
      Messaging service used for the request. Use `\"whatsapp\"`. |\n| **`type`** | **Required**
      Specifies the media type. Use \"audio\". |\n| **`audio.link`** | Specifies the link of the image you are using for your reply. |\n| **`audio.voice`** | boolean. If true, send this as a [voice](https://faq.whatsapp.com/657157755756612/) message instead of a normal [audio](https://developers.facebook.com/docs/whatsapp/cloud-api/messages/audio-messages) message. Ensure your audio file is an .ogg codec=opus file if using this |\n\nFor more information about the `Media Object` structure, see [Media Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#media-object).\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Audio Message By URL", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"audio\",\n \"audio\": {\n \"link\": \"\",\n \"voice\": true\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Reply to Audio Message by URL", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"audio\",\n \"audio\": {\n \"link\": \"http(s)://audio-url\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send an audio link as a reply to message, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a media object with type = `audio`. Then, be sure to include the link to the audio.\n\nAssign **`context.message_id`** the message ID of the message you want to reply to.\n\n## Request Parameters\n\n| Parameter | Description |\n| --- | --- |\n| **`messaging_product`** | **Required**
      Messaging service used for the request. Use `\"whatsapp\"`. |\n| **`context.message_id`** | **Required for context object**
      Specifies the ID of the message you are replying to. |\n| **`type`** | **Required**
      Specifies the media type. Use \"audio\". |\n| **`audio.link`** | Specifies the link of the image you are using for your reply. |\n| **`audio.voice`** | boolean. If true, send this as a [voice](https://faq.whatsapp.com/657157755756612/) message instead of a normal [audio](https://developers.facebook.com/docs/whatsapp/cloud-api/messages/audio-messages) message. Ensure your audio file is an .ogg codec=opus file if using this |\n\nFor more information about the `Media Object` structure, see [Media Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#media-object).\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Reply to Audio Message by URL", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"audio\",\n \"audio\": {\n \"link\": \"http(s)://audio-url\",\n \"voice\": true\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Document Message by ID", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"document\",\n \"document\": {\n \"id\": \"\",\n \"caption\": \"\",\n \"filename\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a media message, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a message object with type = `document`. Then, add the corresponding `document object` ID.\n\nFor more information about the `Media Object` structure, see [Media Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#media-object).\n\nSend a document message to your customers using media ID uploaded from media endpoint.\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Document Message by ID", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"document\",\n \"document\": {\n \"id\": \"\",\n \"caption\": \"\",\n \"filename\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Reply to Document Message by ID", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"document\",\n \"document\": {\n \"id\": \"\",\n \"caption\": \"\",\n \"filename\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a reply to document message, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a media object with type = `document`. Then, add the corresponding `document object` ID.\n\nAssign **`context.message_id`** the message id of the message you want to reply to.\n\n## Request Parameters\n\n| Parameter | Description |\n|---|---|\n| **`messaging_product`** | **Required**
      Messaging service used for the request. Use `\"whatsapp\"`.\n| **`context.message_id`** | **Required for context object**
      Specifies the ID of the message being replied to. |\n| **`type`** | **Required**
      Specifies the media type. Use \"document\".|\n| **`document.id`** | Specifies the ID of the document object you are replying to. |\n\nFor more information about the `Media Object` structure, see [Media Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#media-object).\n\nSend a document message to your customers using media ID uploaded from media endpoint.\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Reply to Document Message by ID", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"document\",\n \"document\": {\n \"id\": \"\",\n \"caption\": \"\",\n \"filename\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Document Message by URL", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"document\",\n \"document\": {\n \"link\": \"\",\n \"caption\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a media message, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a message object with type = `document`. Then, include the link to the document.\n\nFor more information about the `Media Object` structure, see [Media Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#media-object).\n\nSend a document message to your customers using link.\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Document Message by URL", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"document\",\n \"document\": {\n \"link\": \"\",\n \"caption\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Reply to Document Message by URL", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"document\",\n \"document\": {\n \"link\": \"\",\n \"caption\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a document link as a reply to message, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a media object with type = `document`. Then, be sure to include the link to the document.\n\nAssign **`context.message_id`** the message ID of the message you want to reply to.\n\n## Request Parameters\n\n| Parameter | Description |\n|---|---|\n| **`messaging_product`** | **Required**
      Messaging service used for the request. Use `\"whatsapp\"`.\n| **`context.message_id`** | **Required for context object**
      Specifies the ID of the message you are replying to. |\n| **`type`** | **Required**
      Specifies the media type. Use \"document\".|\n| **`document.link`** | Specifies the link of the document you are sending for your reply. |\n\nFor more information about the `Media Object` structure, see [Media Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#media-object).\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Reply to Document Message by URL", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"document\",\n \"document\": {\n \"link\": \"\",\n \"caption\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Sticker Message by ID", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"sticker\",\n \"sticker\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a media message, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a message object with type = `sticker`. Then, add the corresponding **`sticker`** object ID.\n\nFor more information about the `Media Object` structure, see [Media Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#media-object).\n\nSend a sticker message to your customers using the media ID uploaded from media endpoint.\n\n## Request Parameters\n\n| Parameter | Description |\n|---|---|\n| **`messaging_product`** | **Required**
      Messaging service used for the request. Always use `\"whatsapp\"`.\n| **`type`** | **Required**
      Specifies the media type. Use `\"sticker\"`.|\n| **`sticker.id`** | Specifies the ID of the sticker object you are sending. |\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Sticker Message By ID", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"sticker\",\n \"sticker\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Reply to Sticker Message by ID", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"sticker\",\n \"sticker\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a reply to sticker message, make a **POST** call to **/{{Phone-Number-ID}}/messages** and attach a media object with type = sticker. Then, add the corresponding sticker object ID.\n\nAssign **`context.message_id`** the message id of the message you want to reply to.\n\n## Request Parameters\n\n| Parameter | Description |\n|---|---|\n| **`messaging_product`** | **Required**
      Messaging service used for the request. Use `\"whatsapp\"`.\n| **`context.message_id`** | **Required for context object**
      Specifies the ID of the message you are replying to. |\n| **`type`** | **Required**
      Specifies the media type. Use `\"sticker\"`.|\n| **`sticker.id`** | Specifies the ID of the sticker object you are sending. |\n\nFor more information about the `Media Object` structure, see [Media Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#media-object).\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Reply to Sticker Message by ID", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"sticker\",\n \"sticker\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Sticker Message by URL", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"sticker\",\n \"sticker\": {\n \"link\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a media message, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a message object with type = `sticker`. Then, add a link to the corresponding `sticker` file.\n\nFor more information about the `Media Object` structure, see [Media Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#media-object).\n\nSend a sticker message to your customers using link.\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Sticker Message By URL", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"sticker\",\n \"sticker\": {\n \"link\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Reply to Sticker Message by URL", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"sticker\",\n \"sticker\": {\n \"link\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a sticker link as a reply to message, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a media object with type = `sticker`. Then, be sure to include the link to the sticker.\n\nAssign **`context.message_id`** the message ID of the message you want to reply to.\n\n## Request Parameters\n\n| Parameter | Description |\n|---|---|\n| **`messaging_product`** | **Required**
      Messaging service used for the request. Use `\"whatsapp\"`.\n| **`context.message_id`** | **Required for context object**
      Specifies the ID of the message you are replying to. |\n| **`type`** | **Required**
      Specifies the media type. Use \"sticker\".|\n| **`sticker.link`** | Specifies the link of the sticker you are sending for your reply. |\n\nFor more information about the `Media Object` structure, see [Media Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#media-object).\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Reply to Sticker Message by URL", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"sticker\",\n \"sticker\": {\n \"link\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Video Message by ID", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"video\",\n \"video\": {\n \"caption\": \"\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a media message, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a message object with type = `video`. Then, add a corresponding `video object` ID.\n\nFor more information about the `Media Object` structure, see [Media Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#media-object).\n\nSend a video message to your customers using the media ID uploaded from media endpoint.\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Video Message By ID", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" }, { "key": "Authorization", "value": "Bearer {{AdminAuthToken}}" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"video\",\n \"video\": {\n \"caption\": \"\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Reply to Video Message by ID", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"video\",\n \"video\": {\n \"caption\": \"\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a reply to video message, make a **POST** call to **/{{Phone-Number-ID}}/messages** and attach a media object with type = \"video\". Then, add the corresponding video object ID.\n\nAssign **`context.message_id`** the message id of the message you want to reply to.\n\n## Request Parameters\n\n| Parameter | Description |\n|---|---|\n| **`messaging_product`** | **Required**
      Messaging service used for the request. Use `\"whatsapp\"`.\n| **`context.message_id`** | **Required for context object**
      Specifies the ID of the message you are replying to. |\n| **`type`** | **Required**
      Specifies the media type. Use \"video\".|\n| **`video.id`** | Specifies the ID of the video object you are sending. |\n\nFor more information about the `Media Object` structure, see [Media Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#media-object).\n\nSends a video message as a reply to using the media ID uploaded from the /media endpoint.\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Reply to Video Message by ID", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"video\",\n \"video\": {\n \"caption\": \"\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Video Message by URL", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"video\",\n \"video\": {\n \"link\": \"\",\n \"caption\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a media message, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a message object with type = `video`. Then, add a link to the video.\n\nFor more information about the `Media Object` structure, see [Media Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#media-object).\n\nSend a video message to your customers using a link.\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Video Message By URL", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" }, { "key": "Authorization", "value": "Bearer {{AdminAuthToken}}" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"video\",\n \"video\": {\n \"link\": \"\",\n \"caption\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Reply to Video Message by URL", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"video\",\n \"video\": {\n \"link\": \"\",\n \"caption\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a video link as a reply to message, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a media object with type = `video`. Then, be sure to include the link to the video.\n\nAssign **`context.message_id`** the message ID of the message you want to reply to.\n\n## Request Parameters\n\n| Parameter | Description |\n|---|---|\n| **`messaging_product`** | **Required**
      Messaging service used for the request. Use `\"whatsapp\"`.\n| **`context.message_id`** | **Required for context object**
      Specifies the ID of the message you are replying to. |\n| **`type`** | **Required**
      Specifies the media type. Use \"video\".|\n| **`video.link`** | Specifies the link to the video you are sending for your reply. |\n\nFor more information about the `Media Object` structure, see [Media Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#media-object).\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**. Use the ID listed after **`wamid`** to track your message status." }, "response": [ { "name": "Send Reply to Video Message by URL", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"video\",\n \"video\": {\n \"link\": \"\",\n \"caption\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Contact Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"contacts\",\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"type\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"emails\": [\n {\n \"email\": \"\",\n \"type\": \"\"\n }\n ],\n \"name\": {\n \"formatted_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\",\n \"suffix\": \"\",\n \"prefix\": \"\"\n },\n \"org\": {\n \"company\": \"\",\n \"department\": \"\",\n \"title\": \"\"\n },\n \"phones\": [\n {\n \"phone\": \"\",\n \"wa_id\": \"\",\n \"type\": \"\"\n }\n ],\n \"urls\": [\n {\n \"url\": \"\",\n \"type\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send contact messages, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a message object with type: **`contact`**. Then, add a [contacts object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#contacts-object).\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**." }, "response": [ { "name": "Send Contact Message", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"contacts\",\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"street\": \"1 Hacker Way\",\n \"city\": \"Menlo Park\",\n \"state\": \"CA\",\n \"zip\": \"94025\",\n \"country\": \"United States\",\n \"country_code\": \"us\",\n \"type\": \"HOME\"\n },\n {\n \"street\": \"200 Jefferson Dr\",\n \"city\": \"Menlo Park\",\n \"state\": \"CA\",\n \"zip\": \"94025\",\n \"country\": \"United States\",\n \"country_code\": \"us\",\n \"type\": \"WORK\"\n }\n ],\n \"birthday\": \"2012-08-18\",\n \"emails\": [\n {\n \"email\": \"test@fb.com\",\n \"type\": \"WORK\"\n },\n {\n \"email\": \"test@whatsapp.com\",\n \"type\": \"HOME\"\n }\n ],\n \"name\": {\n \"formatted_name\": \"John Smith\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"D.\",\n \"suffix\": \"Jr\",\n \"prefix\": \"Dr\"\n },\n \"org\": {\n \"company\": \"WhatsApp\",\n \"department\": \"Design\",\n \"title\": \"Manager\"\n },\n \"phones\": [\n {\n \"phone\": \"+1 (940) 555-1234\",\n \"type\": \"HOME\"\n },\n {\n \"phone\": \"+1 (650) 555-1234\",\n \"type\": \"WORK\",\n \"wa_id\": \"16505551234\"\n }\n ],\n \"urls\": [\n {\n \"url\": \"https://www.facebook.com\",\n \"type\": \"WORK\"\n },\n {\n \"url\": \"https://www.whatsapp.com\",\n \"type\": \"HOME\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/v13.0/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "v13.0", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Reply to Contact Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"contacts\",\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"type\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"emails\": [\n {\n \"email\": \"\",\n \"type\": \"\"\n }\n ],\n \"name\": {\n \"formatted_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\",\n \"suffix\": \"\",\n \"prefix\": \"\"\n },\n \"org\": {\n \"company\": \"\",\n \"department\": \"\",\n \"title\": \"\"\n },\n \"phones\": [\n {\n \"phone\": \"\",\n \"wa_id\": \"\",\n \"type\": \"\"\n }\n ],\n \"urls\": [\n {\n \"url\": \"\",\n \"type\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send contact messages, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a message object with type: **`contact`**. Then, add a [contacts object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#contacts-object).\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**." }, "response": [ { "name": "Send Reply to Contact Message", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"contacts\",\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"street\": \"1 Hacker Way\",\n \"city\": \"Menlo Park\",\n \"state\": \"CA\",\n \"zip\": \"94025\",\n \"country\": \"United States\",\n \"country_code\": \"us\",\n \"type\": \"HOME\"\n },\n {\n \"street\": \"200 Jefferson Dr\",\n \"city\": \"Menlo Park\",\n \"state\": \"CA\",\n \"zip\": \"94025\",\n \"country\": \"United States\",\n \"country_code\": \"us\",\n \"type\": \"WORK\"\n }\n ],\n \"birthday\": \"2012-08-18\",\n \"emails\": [\n {\n \"email\": \"test@fb.com\",\n \"type\": \"WORK\"\n },\n {\n \"email\": \"test@whatsapp.com\",\n \"type\": \"HOME\"\n }\n ],\n \"name\": {\n \"formatted_name\": \"John Smith\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"D.\",\n \"suffix\": \"Jr\",\n \"prefix\": \"Dr\"\n },\n \"org\": {\n \"company\": \"WhatsApp\",\n \"department\": \"Design\",\n \"title\": \"Manager\"\n },\n \"phones\": [\n {\n \"phone\": \"+1 (940) 555-1234\",\n \"type\": \"HOME\"\n },\n {\n \"phone\": \"+1 (650) 555-1234\",\n \"type\": \"WORK\",\n \"wa_id\": \"16505551234\"\n }\n ],\n \"urls\": [\n {\n \"url\": \"https://www.facebook.com\",\n \"type\": \"WORK\"\n },\n {\n \"url\": \"https://www.whatsapp.com\",\n \"type\": \"HOME\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/v13.0/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "v13.0", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Location Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"location\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send location messages, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a message object with type = `location`. Then, add a location object.\n\nFor more information on the structure of `Location Object`, see [Location Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#location-object).\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**." }, "response": [ { "name": "Send Location Messages", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"location\",\n \"location\": {\n \"latitude\": 37.758056,\n \"longitude\": -122.425332,\n \"name\": \"META HQ\",\n \"address\": \"1 Hacker Way, Menlo Park, CA 94025\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/v13.0/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "v13.0", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Reply to Location Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"location\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send location messages, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a message object with type = `location`. Then, add a location object.\n\nFor more information on the structure of `Location Object`, see [Location Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#location-object).\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**." }, "response": [ { "name": "Send Reply to Location Message", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"location\",\n \"location\": {\n \"latitude\": 37.758056,\n \"longitude\": -122.425332,\n \"name\": \"META HQ\",\n \"address\": \"1 Hacker Way, Menlo Park, CA 94025\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/v13.0/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "v13.0", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Message Template Text", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"template\",\n \"template\": {\n \"name\": \"template-name\",\n \"language\": {\n \"code\": \"language-and-locale-code\"\n },\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"text-string\"\n },\n {\n \"type\": \"currency\",\n \"currency\": {\n \"fallback_value\": \"$100.99\",\n \"code\": \"USD\",\n \"amount_1000\": 100990\n }\n },\n {\n \"type\": \"date_time\",\n \"date_time\": {\n \"fallback_value\": \"February 25, 1977\",\n \"day_of_week\": 5,\n \"year\": 1977,\n \"month\": 2,\n \"day_of_month\": 25,\n \"hour\": 15,\n \"minute\": 33,\n \"calendar\": \"GREGORIAN\"\n }\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "You need to create a message template before you can send one. See [Create Template Using the WhatsApp Manager](https://developers.facebook.com/docs/whatsapp/message-templates/creation#step-1--create-template-using-the-whatsapp-manager) for more information. If your account is not verified yet, you can use one of our pre-approved templates.\n\nTo send a text-based message template, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a message object with type = `template`. Then, add a template object.\n\n## Prerequisites\n- You need to create a message template through [WhatsApp Manager](https://developers.facebook.com/docs/whatsapp/message-templates/creation) or [BM API](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates#creating-message-templates)\n- For an unverified account, we have already [pre-created message templates](https://www.facebook.com/business/help/722393685250070) for you to use.\n\n## Message Objects\n\nMessage templates can contain the following `Message Objects`:\n\n* [Template Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#template-object)\n* [Component Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#components-object)\n* [Parameter Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#parameter-object)\n* [Currency Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#currency-object)\n* [Date_Time Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#date-time-object)\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**." }, "response": [ { "name": "Send Message Template Text", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"template\",\n \"template\": {\n \"name\": \"template-name\",\n \"language\": {\n \"code\": \"language-and-locale-code\"\n },\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"text-string\"\n },\n {\n \"type\": \"currency\",\n \"currency\": {\n \"fallback_value\": \"$100.99\",\n \"code\": \"USD\",\n \"amount_1000\": 100990\n }\n },\n {\n \"type\": \"date_time\",\n \"date_time\": {\n \"fallback_value\": \"February 25, 1977\",\n \"day_of_week\": 5,\n \"year\": 1977,\n \"month\": 2,\n \"day_of_month\": 25,\n \"hour\": 15,\n \"minute\": 33,\n \"calendar\": \"GREGORIAN\"\n }\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/v13.0/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "v13.0", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Message Template Media", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"template\",\n \"template\": {\n \"name\": \"template-name\",\n \"language\": {\n \"code\": \"language-and-locale-code\"\n },\n \"components\": [\n {\n \"type\": \"header\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"http(s)://the-image-url\"\n }\n }\n ]\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"text-string\"\n },\n {\n \"type\": \"currency\",\n \"currency\": {\n \"fallback_value\": \"$100.99\",\n \"code\": \"USD\",\n \"amount_1000\": 100990\n }\n },\n {\n \"type\": \"date_time\",\n \"date_time\": {\n \"fallback_value\": \"February 25, 1977\",\n \"day_of_week\": 5,\n \"year\": 1977,\n \"month\": 2,\n \"day_of_month\": 25,\n \"hour\": 15,\n \"minute\": 33,\n \"calendar\": \"GREGORIAN\"\n }\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "Media message templates allow you to send media content as a header component beyond text template with parameters in the body component. Before sending a message template, you need to create one. See [Create Template Using the WhatsApp Manager](https://developers.facebook.com/docs/whatsapp/message-templates/creation) for more information. If your account is not verified yet, you can use one of our pre-approved templates.\n\nTo send a media-based message template, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a message object with type = `template`. Then, add a template object.\n\n## Prerequisites\n\n- You need to create a message template through [WhatsApp Manager](https://developers.facebook.com/docs/whatsapp/message-templates/creation) or [BM API](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates#creating-message-templates)\n- For an unverified account, we have already [pre-created message templates](https://www.facebook.com/business/help/722393685250070) for you to use.\n\n## Message Objects\n\nMedia-Based message templates can contain the following `Message Objects`:\n\n* [Template Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#template-object)\n* [Component Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#components-object)\n* [Parameter Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#parameter-object)\n* [Currency Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#currency-object)\n* [Date_Time Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#date-time-object)\n\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**." }, "response": [ { "name": "Send Message Template Media", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"template\",\n \"template\": {\n \"name\": \"template-name\",\n \"language\": {\n \"code\": \"language-and-locale-code\"\n },\n \"components\": [\n {\n \"type\": \"header\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"http(s)://the-image-url\"\n }\n }\n ]\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"text-string\"\n },\n {\n \"type\": \"currency\",\n \"currency\": {\n \"fallback_value\": \"$100.99\",\n \"code\": \"USD\",\n \"amount_1000\": 100990\n }\n },\n {\n \"type\": \"date_time\",\n \"date_time\": {\n \"fallback_value\": \"February 25, 1977\",\n \"day_of_week\": 5,\n \"year\": 1977,\n \"month\": 2,\n \"day_of_month\": 25,\n \"hour\": 15,\n \"minute\": 33,\n \"calendar\": \"GREGORIAN\"\n }\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/v13.0/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "v13.0", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Message Template Interactive", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"template\",\n \"template\": {\n \"name\": \"template-name\",\n \"language\": {\n \"code\": \"language-and-locale-code\"\n },\n \"components\": [\n {\n \"type\": \"header\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"http(s)://the-image-url\"\n }\n }\n ]\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"text-string\"\n },\n {\n \"type\": \"currency\",\n \"currency\": {\n \"fallback_value\": \"$100.99\",\n \"code\": \"USD\",\n \"amount_1000\": 100990\n }\n },\n {\n \"type\": \"date_time\",\n \"date_time\": {\n \"fallback_value\": \"February 25, 1977\",\n \"day_of_week\": 5,\n \"year\": 1977,\n \"month\": 2,\n \"day_of_month\": 25,\n \"hour\": 15,\n \"minute\": 33,\n \"calendar\": \"GREGORIAN\"\n }\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"payload\": \"aGlzIHRoaXMgaXMgY29v\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": \"1\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"payload\": \"9rwnB8RbYmPF5t2Mn09x4h\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "Before sending a message template, you need to create one. See [Create Template Using the WhatsApp Manager](https://developers.facebook.com/docs/whatsapp/message-templates/creation) for more information. If your account is not verified yet, you can use one of our [pre-approved templates](https://www.facebook.com/business/help/722393685250070).\n\nTo send an interactive message template, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a message object with `type=template`. Then, add a template object with your chosen button.\n\nInteractive message templates expand the content you can send recipients beyond the standard message template and media messages template types to include interactive buttons using the components object. There are two types of predefined buttons offered:\n\n* Call-to-Action — Allows your customer to call a phone number and visit a website.\n* Quick Reply — Allows your customer to return a simple text message.\n\nThese buttons can be attached to text messages or media messages. Once your interactive message templates have been created and approved, you can use them in notification messages as well as customer service/care messages.\n\n## Message Objects\n\nInteractive message templates can contain the following `Message Objects`:\n\n* [Template Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#template-object)\n* [Component Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#components-object)\n* [Parameter Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#parameter-object)\n* [Currency Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#currency-object)\n* [Date_Time Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#date-time-object)\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**." }, "response": [ { "name": "Send Interactive Message Template", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"template\",\n \"template\": {\n \"name\": \"template-name\",\n \"language\": {\n \"code\": \"language-and-locale-code\"\n },\n \"components\": [\n {\n \"type\": \"header\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"http(s)://the-image-url\"\n }\n }\n ]\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"text-string\"\n },\n {\n \"type\": \"currency\",\n \"currency\": {\n \"fallback_value\": \"$100.99\",\n \"code\": \"USD\",\n \"amount_1000\": 100990\n }\n },\n {\n \"type\": \"date_time\",\n \"date_time\": {\n \"fallback_value\": \"February 25, 1977\",\n \"day_of_week\": 5,\n \"year\": 1977,\n \"month\": 2,\n \"day_of_month\": 25,\n \"hour\": 15,\n \"minute\": 33,\n \"calendar\": \"GREGORIAN\"\n }\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"payload\": \"aGlzIHRoaXMgaXMgY29v\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": \"1\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"payload\": \"9rwnB8RbYmPF5t2Mn09x4h\"\n }\n ]\n }\n ]\n }\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/v13.0/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "v13.0", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send List Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"list\",\n \"header\": {\n \"type\": \"text\",\n \"text\": \"\"\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n },\n \"action\": {\n \"button\": \"\",\n \"sections\": [\n {\n \"title\": \"\",\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"title\": \"\",\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ]\n }\n ]\n }\n }\n}" }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a list message, make a **POST** call to `/messages` and attach a message object with **`type`** = `interactive`. Then, set the **`type`** of the `interactive` object = **`list`**. Finally, include the corresponding **`interactive`** object.\n\nFor more reference information about **`interactive`** objects, see [Interactive Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#interactive-object)." }, "response": [ { "name": "Send List Message", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"list\",\n \"header\": {\n \"type\": \"text\",\n \"text\": \"\"\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n },\n \"action\": {\n \"button\": \"\",\n \"sections\": [\n {\n \"title\": \"\",\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"title\": \"\",\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ]\n }\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/v13.0/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "v13.0", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [{\n \"input\": \"15555551234\",\n \"wa_id\": \"\"\n }],\n \"messages\": [{\n \"id\": \"wamid.ID\"\n }]\n}" } ] }, { "name": "Send Reply to List Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"list\",\n \"header\": {\n \"type\": \"text\",\n \"text\": \"\"\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n },\n \"action\": {\n \"button\": \"\",\n \"sections\": [\n {\n \"title\": \"\",\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"title\": \"\",\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ]\n }\n ]\n }\n }\n}" }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a list message, make a **POST** call to `/messages` and attach a message object with **`type`** = `interactive`. Then, set the **`type`** of the `interactive` object = **`list`**. Finally, include the corresponding **`interactive`** object.\n\nFor more reference information about **`interactive`** objects, see [Interactive Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#interactive-object)." }, "response": [ { "name": "Send Reply to List Message", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"context\": {\n \"message_id\": \"\"\n },\n \"interactive\": {\n \"type\": \"list\",\n \"header\": {\n \"type\": \"text\",\n \"text\": \"\"\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n },\n \"action\": {\n \"button\": \"\",\n \"sections\": [\n {\n \"title\": \"\",\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"title\": \"\",\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ]\n }\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/v13.0/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "v13.0", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [{\n \"input\": \"15555551234\",\n \"wa_id\": \"\"\n }],\n \"messages\": [{\n \"id\": \"wamid.ID\"\n }]\n}" } ] }, { "name": "Send Reply Button", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"button\",\n \"body\": {\n \"text\": \"\"\n },\n \"action\": {\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n },\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ]\n }\n }\n}" }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send interactive messages, make a **POST** call to `/PHONE_NUMBER_ID/messages`(see [Get Phone Number](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/phone-numbers)) and attach a message object with **`type`**\\=`interactive`. Then, add an **`interactive object`**.\n\nFor more reference information about **`interactive`** objects, see [Interactive Object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#interactive-object).\n\n## Response\nA successful response includes an object with an identifier prefixed with wamid. Use the ID listed after wamid to track your message status." }, "response": [ { "name": "Send Reply Button", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"button\",\n \"body\": {\n \"text\": \"\"\n },\n \"action\": {\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n },\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/v13.0/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "v13.0", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [{\n \"input\": \"PHONE_NUMBER\",\n \"wa_id\": \"WHATSAPP_ID\"\n }],\n \"messages\": [{\n \"id\": \"wamid.ID\"\n }]\n}" } ] }, { "name": "Mark Message As Read", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"status\": \"read\",\n \"message_id\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "When you receive an incoming message from Webhooks, you could use messages endpoint to change the status of it to read. \nWe recommend marking incoming messages as read within 30 days of receipt. \n**Note**: you cannot mark outgoing messages you sent as read.\n\nYou need to obtain the **`message_id`** of the incoming message from Webhooks.\n\nFor a more in depth guide for marking messages as read, see [Guide: Mark Messages as Read](https://developers.facebook.com/docs/whatsapp/cloud-api/guides/mark-message-as-read)." }, "response": [ { "name": "Mark Message As Read", "originalRequest": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"status\": \"read\",\n \"message_id\": \"wamid.234123\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/v13.0/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "v13.0", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"success\": true\n}" } ] }, { "name": "Send Single Product Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"product\",\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n },\n \"action\": {\n \"catalog_id\": \"367025965434465\",\n \"product_retailer_id\": \"\"\n }\n }\n}" }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a single product message, make a **POST** call to the **`/{{Version}}/phone_number/messages`** endpoint.\n\nThis request uses an **`interactive`** object and parameter **`type`** should be set to `interactive`. The **`interactive`** parameter must also be set to the **`interactive`** object associated with the single product message. \n\n### Parameters\n\n| Name | Description |\n| --- | --- |\n| **`messaging_product`** | **Required**.
      Always set this value to `\"whatsapp\"`. |\n| **`recipient_type`** | **Optional**.
      Currently, you can only send messages to individuals. Set this value to `\"individual\"`.

      **Default**: `individual` |\n| **`to`** | **Required**.
      WhatsApp ID or phone number for the person you want to send a message to.

      See [Phone Numbers, Formatting](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/phone-numbers#formatting) for more information. |\n| **`type`** | **Required**.
      To send single product messages, set this string value to `\"interactive\"`. |\n| **`interactive`** | **Required**.
      The [interactive object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#interactive-object) associated with the single product message. |\n\n### Interactive Object Parameters specific to Single Product Messages\n| Name | Description |\n| --- | --- |\n| **`type`** | **Required**.
      Specifies the type of interactive object. For single product messages set this value to `\"product\"`.|\n| **`action`** | **Required**.
      |" }, "response": [ { "name": "Send Single Product Message", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"product\",\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n },\n \"action\": {\n \"catalog_id\": \"367025965434465\",\n \"product_retailer_id\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"+1-631-555-5555\",\n \"wa_id\": \"16315555555\"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGFlaCGg0xcvAdgmZ9plHrf2Mh-o\"\n }\n ]\n}\n" } ] }, { "name": "Send Multi-Product Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"product_list\",\n \"header\": {\n \"type\": \"\",\n \"text\": \"\"\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n },\n \"action\": {\n \"catalog_id\": \"146265584024623\",\n \"sections\": [\n {\n \"title\": \"\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"\"\n },\n {\n \"product_retailer_id\": \"\"\n }\n ]\n },\n {\n \"title\": \"\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"\"\n },\n {\n \"product_retailer_id\": \"\"\n }\n ]\n }\n ]\n }\n }\n}" }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a multi-product message, make a **POST** call to the **`/{{Version}}/phone_number/messages`** endpoint.\n\nThis request uses an **`interactive`** object and parameter **`type`** should be set to `interactive`. The **`interactive`** parameter must also be set to the **`interactive`** object associated with the single product message. \n\n### Parameters\n\n| Name | Description |\n| --- | --- |\n| **`messaging_product`** | **Required**.
      Always set this value to `\"whatsapp\"`. |\n| **`recipient_type`** | **Optional**.
      Currently, you can only send messages to individuals. Set this value to `\"individual\"`.

      **Default**: `individual` |\n| **`to`** | **Required**.
      WhatsApp ID or phone number for the person you want to send a message to.

      See [Phone Numbers, Formatting](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/phone-numbers#formatting) for more information. |\n| **`type`** | **Required**.
      To send single product messages, set this string value to `\"interactive\"`. |\n| **`interactive`** | **Required**.
      The [interactive object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#interactive-object) associated with the single product message. |\n\n### Interactive Object Parameters specific to Multi-Product Messages\n| Name | Description |\n| --- | --- |\n| **`type`** | **Required**.
      Specifies the type of interactive object. For multi-product messages set this value to `\"product_list\"` |" }, "response": [ { "name": "Send Multi-Product Message", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"product_list\",\n \"header\": {\n \"type\": \"\",\n \"text\": \"\"\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n },\n \"action\": {\n \"catalog_id\": \"146265584024623\",\n \"sections\": [\n {\n \"title\": \"\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"\"\n },\n {\n \"product_retailer_id\": \"\"\n }\n ]\n },\n {\n \"title\": \"\",\n \"product_items\": [\n {\n \"product_retailer_id\": \"\"\n },\n {\n \"product_retailer_id\": \"\"\n }\n ]\n }\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"+1-631-555-5555\",\n \"wa_id\": \"16315555555\"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGFlaCGg0xcvAdgmZ9plHrf2Mh-o\"\n }\n ]\n}" } ] }, { "name": "Send Catalog Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"catalog_message\",\n \"body\": {\n \"text\": \"Hello! Thanks for your interest. Ordering is easy. Just visit our catalog and add items to purchase.\"\n },\n \"action\": {\n \"name\": \"catalog_message\",\n \"parameters\": {\n \"thumbnail_product_retailer_id\": \"2lc20305pt\"\n }\n },\n \"footer\": {\n \"text\": \"Best grocery deals on WhatsApp!\"\n }\n }\n}" }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a single product message, make a **POST** call to the **`/{{Version}}/phone_number/messages`** endpoint.\n\nThis request uses an **`interactive`** object and parameter **`type`** should be set to `interactive`. The **`interactive`** parameter must also be set to the **`interactive`** object associated with the single product message. \n\n### Parameters\n\n| Name | Description |\n| --- | --- |\n| **`messaging_product`** | **Required**.
      Always set this value to `\"whatsapp\"`. |\n| **`recipient_type`** | **Optional**.
      Currently, you can only send messages to individuals. Set this value to `\"individual\"`.

      **Default**: `individual` |\n| **`to`** | **Required**.
      WhatsApp ID or phone number for the person you want to send a message to.

      See [Phone Numbers, Formatting](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/phone-numbers#formatting) for more information. |\n| **`type`** | **Required**.
      To send single product messages, set this string value to `\"interactive\"`. |\n| **`interactive`** | **Required**.
      The [interactive object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#interactive-object) associated with the single product message. |\n\n### Interactive Object Parameters specific to Single Product Messages\n| Name | Description |\n| --- | --- |\n| **`type`** | **Required**.
      Specifies the type of interactive object. For single product messages set this value to `\"product\"`.|\n| **`action`** | **Required**.
      |" }, "response": [ { "name": "Example response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"+16505551234\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"catalog_message\",\n \"body\": {\n \"text\": \"Hello! Thanks for your interest. Ordering is easy. Just visit our catalog and add items to purchase.\"\n },\n \"action\": {\n \"name\": \"catalog_message\",\n \"parameters\": {\n \"thumbnail_product_retailer_id\": \"2lc20305pt\"\n }\n },\n \"footer\": {\n \"text\": \"Best grocery deals on WhatsApp!\"\n }\n }\n}" }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "x-business-use-case-usage", "value": "{\"104996122399160\":[{\"type\":\"whatsapp\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v17.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "Aw3rl09JmaSC43LvqSra8Wo" }, { "key": "x-fb-trace-id", "value": "BINWLl+juwM" }, { "key": "x-fb-rev", "value": "1007674581" }, { "key": "X-FB-Debug", "value": "QHCq1sCilMV6uusUBKtpCSiVKmcPAD85rWpN+a7A+lQLKJH1N5h2VAdbTiE+8Gmdreo04CEQ503ETjOQ+n0lCA==" }, { "key": "Date", "value": "Tue, 13 Jun 2023 22:45:17 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "173" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"+16505551234\",\n \"wa_id\": \"16505551234\"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.HBgLMTY1MDM4Nzk0MzkVAgARGBI3NDMzMjc2N0VDNUVFNURBQzQA\"\n }\n ]\n}" } ] }, { "name": "Send Catalog Template Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"template\",\n \"template\": {\n \"name\": \"intro_catalog_offer\",\n \"language\": {\n \"code\": \"en_US\"\n },\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"100\"\n },\n {\n \"type\": \"text\",\n \"text\": \"400\"\n },\n {\n \"type\": \"text\",\n \"text\": \"3\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"CATALOG\",\n \"index\": 0,\n \"parameters\": [\n {\n \"type\": \"action\",\n \"action\": {\n \"thumbnail_product_retailer_id\": \"2lc20305pt\"\n }\n }\n ]\n }\n ]\n }\n}" }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "To send a single product message, make a **POST** call to the **`/{{Version}}/phone_number/messages`** endpoint.\n\nThis request uses an **`interactive`** object and parameter **`type`** should be set to `interactive`. The **`interactive`** parameter must also be set to the **`interactive`** object associated with the single product message. \n\n### Parameters\n\n| Name | Description |\n| --- | --- |\n| **`messaging_product`** | **Required**.
      Always set this value to `\"whatsapp\"`. |\n| **`recipient_type`** | **Optional**.
      Currently, you can only send messages to individuals. Set this value to `\"individual\"`.

      **Default**: `individual` |\n| **`to`** | **Required**.
      WhatsApp ID or phone number for the person you want to send a message to.

      See [Phone Numbers, Formatting](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/phone-numbers#formatting) for more information. |\n| **`type`** | **Required**.
      To send single product messages, set this string value to `\"interactive\"`. |\n| **`interactive`** | **Required**.
      The [interactive object](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#interactive-object) associated with the single product message. |\n\n### Interactive Object Parameters specific to Single Product Messages\n| Name | Description |\n| --- | --- |\n| **`type`** | **Required**.
      Specifies the type of interactive object. For single product messages set this value to `\"product\"`.|\n| **`action`** | **Required**.
      |" }, "response": [ { "name": "Example response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"+16505551234\",\n \"type\": \"template\",\n \"template\": {\n \"name\": \"intro_catalog_offer\",\n \"language\": {\n \"code\": \"en_US\"\n },\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"100\"\n },\n {\n \"type\": \"text\",\n \"text\": \"400\"\n },\n {\n \"type\": \"text\",\n \"text\": \"3\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"CATALOG\",\n \"index\": 0,\n \"parameters\": [\n {\n \"type\": \"action\",\n \"action\": {\n \"thumbnail_product_retailer_id\": \"2lc20305pt\"\n }\n }\n ]\n }\n ]\n }\n}" }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "x-business-use-case-usage", "value": "{\"104996122399160\":[{\"type\":\"whatsapp\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v17.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "A3CkdIX7I5A8FzGdWU0rfJi" }, { "key": "x-fb-trace-id", "value": "DgGcg9xZbk0" }, { "key": "x-fb-rev", "value": "1007674581" }, { "key": "X-FB-Debug", "value": "O3koAQxJZ+bZ4K9w6unVQGBeDcPXeW3HgWwaUO7LCflmc6N7B+JHk1n0uJJGsTGEjzIxcQ1TuNkA/wWdP9Ulkg==" }, { "key": "Date", "value": "Tue, 13 Jun 2023 22:35:12 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "173" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"+16505551234\",\n \"wa_id\": \"16505551234\"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.HBgLMTY1MDM4Nzk0MzkVAgARGBJCOTY3NDc0NDFDRUI3NTA0Q0UA\"\n }\n ]\n}" } ] } ], "description": "\n\nUse the **`/{{Phone-Number-ID}}/messages`** endpoint to send text messages, media (audio, documents, images, and video), and message templates to your customers. For more information relating to the messages you can send, see [Messages](#1f4f7644-cc97-40b5-b8e4-c19da268fff1).\n\nMessages are identified by a unique ID. You can track message status in the Webhooks through its ID. You could also mark an incoming message as read through the **`/{{Phone-Number-ID}}/messages`** endpoint.\n\n## Prerequisites\n\n* [User Access Token](https://developers.facebook.com/docs/facebook-login/access-tokens#usertokens) with **`whatsapp_business_messaging`** permission\n* `phone-number-id` for your registered WhatsApp account. See [Get Phone Number](#c72d9c17-554d-4ae1-8f9e-b28a94010b28).", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Templates", "item": [ { "name": "Get template by ID (default fields)", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "" ] }, "description": "- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates)\n- Guide: [How To Monitor Quality Signals](https://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals)\n- Endpoint reference: [WhatsApp Message Template](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-hsm/)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/920070352646140", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "920070352646140" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Encoding", "value": "br" }, { "key": "ETag", "value": "\"e5d8c11dc8393ffe82fb32bea775f609f0efcc87\"" }, { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "AQShOun0F8Erf0hMbGBGLmQ" }, { "key": "x-fb-trace-id", "value": "Hvd7hnyFd49" }, { "key": "x-fb-rev", "value": "1007251231" }, { "key": "X-FB-Debug", "value": "svLARzFgDoUSQya1fv6vGYZoY4BkzPQToXrpR3W6k/OOk8NYFcZVvLhceUdli74kBn9gG8AobKUZdAljEF4NFw==" }, { "key": "Date", "value": "Wed, 05 Apr 2023 18:49:23 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "362" } ], "cookie": [], "body": "{\n \"name\": \"2023_april_promo\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"TEXT\",\n \"text\": \"Fall Sale\"\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Hi {{1}}, our Fall Sale is on! Use promo code {{2}} Get an extra 25% off every order above $350!\",\n \"example\": {\n \"body_text\": [\n [\n \"Mark\",\n \"FALL25\"\n ]\n ]\n }\n },\n {\n \"type\": \"FOOTER\",\n \"text\": \"Not interested in any of our sales? Tap Stop Promotions\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Stop promotions\"\n }\n ]\n }\n ],\n \"language\": \"en_US\",\n \"status\": \"APPROVED\",\n \"category\": \"MARKETING\",\n \"id\": \"920070352646140\"\n}" } ] }, { "name": "Get template by name (default fields)", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates?name=", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ], "query": [ { "key": "name", "value": "" } ] }, "description": "- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates)\n- Guide: [How To Monitor Quality Signals](https://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals)\n- Endpoint reference: [WhatsApp Business Account > Message Templates](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates?name=2023_april_promo", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ], "query": [ { "key": "name", "value": "2023_april_promo" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Encoding", "value": "br" }, { "key": "ETag", "value": "\"27f9cd56fe671f038711cbf7136ec7f84da8987a\"" }, { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "AGWR1WfFKKo0s0TxB5GfuQn" }, { "key": "x-fb-trace-id", "value": "HerPIJHngh2" }, { "key": "x-fb-rev", "value": "1007276590" }, { "key": "X-FB-Debug", "value": "kDgYHRc3KXNszZd5J3o81ZZMUb/PWKShZbVlzINomeH3BtWE158Y+4fswKDUtStciJVunTEwVGX3YgTpkmbGNA==" }, { "key": "Date", "value": "Mon, 10 Apr 2023 23:27:16 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "391" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"name\": \"2023_april_promo\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"TEXT\",\n \"text\": \"Fall Sale\"\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Hi {{1}}, our Fall Sale is on! Use promo code {{2}} Get an extra 25% off every order above $350!\",\n \"example\": {\n \"body_text\": [\n [\n \"Mark\",\n \"FALL25\"\n ]\n ]\n }\n },\n {\n \"type\": \"FOOTER\",\n \"text\": \"Not interested in any of our sales? Tap Stop Promotions\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Stop promotions\"\n }\n ]\n }\n ],\n \"language\": \"en_US\",\n \"status\": \"REJECTED\",\n \"category\": \"MARKETING\",\n \"id\": \"920070352646140\"\n }\n ],\n \"paging\": {\n \"cursors\": {\n \"before\": \"MAZDZD\",\n \"after\": \"MjQZD\"\n }\n }\n}" } ] }, { "name": "Get all templates (default fields)", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] }, "description": "- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates)\n- Guide: [How To Monitor Quality Signals](https://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals)\n- Endpoint reference: [WhatsApp Business Account > Message Templates](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Encoding", "value": "br" }, { "key": "ETag", "value": "\"51f958583abc438d2081f013d228356c7be9b9cb\"" }, { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "A3JwLvL_TNitEV6B9e0RloV" }, { "key": "x-fb-trace-id", "value": "DdaerLa+9CB" }, { "key": "x-fb-rev", "value": "1007251231" }, { "key": "X-FB-Debug", "value": "OMiFsmGF5A90+heFzqwF4JZ9/+d7uakMs29gu7fKBCEB31ThsTmzfX8ft/X3dBTHZNk8kYjTep2hwfep+aZ2Xw==" }, { "key": "Date", "value": "Wed, 05 Apr 2023 18:46:29 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "590" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"name\": \"hello_world\",\n \"previous_category\": \"ACCOUNT_UPDATE\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"TEXT\",\n \"text\": \"Hello World\"\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Welcome and congratulations!! This message demonstrates your ability to send a message notification from WhatsApp Business Platform’s Cloud API. Thank you for taking the time to test with us.\"\n },\n {\n \"type\": \"FOOTER\",\n \"text\": \"WhatsApp Business API Team\"\n }\n ],\n \"language\": \"en_US\",\n \"status\": \"APPROVED\",\n \"category\": \"MARKETING\",\n \"id\": \"1192339204654487\"\n },\n {\n \"name\": \"2023_april_promo\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"TEXT\",\n \"text\": \"Fall Sale\"\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Hi {{1}}, our Fall Sale is on! Use promo code {{2}} Get an extra 25% off every order above $350!\",\n \"example\": {\n \"body_text\": [\n [\n \"Mark\",\n \"FALL25\"\n ]\n ]\n }\n },\n {\n \"type\": \"FOOTER\",\n \"text\": \"Not interested in any of our sales? Tap Stop Promotions\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Stop promotions\"\n }\n ]\n }\n ],\n \"language\": \"en_US\",\n \"status\": \"APPROVED\",\n \"category\": \"MARKETING\",\n \"id\": \"920070352646140\"\n }\n ],\n \"paging\": {\n \"cursors\": {\n \"before\": \"MAZDZD\",\n \"after\": \"MjQZD\"\n }\n }\n}" } ] }, { "name": "Get namespace", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}?fields=message_template_namespace", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}" ], "query": [ { "key": "fields", "value": "message_template_namespace" } ] }, "description": "- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates)\n- Guide: [How To Monitor Quality Signals](https://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals)\n- Endpoint reference: [WhatsApp Business Account > Message Templates](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}?fields=message_template_namespace", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}" ], "query": [ { "key": "fields", "value": "message_template_namespace" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "\"f3fe70e1e3b22c5aa9edd9d4430b0c5a9e78f68c\"" }, { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "Amez7b9yCp8MnTQlGbo0AnF" }, { "key": "x-fb-trace-id", "value": "EB5kGHWA89K" }, { "key": "x-fb-rev", "value": "1007251231" }, { "key": "X-FB-Debug", "value": "jI6jeoezzMoKeb+HWbNzMiESQpSP/ZBpT0HLUdLgsaWMYrL0xDcINSox0i7lpqsiyoEsaQFngro4GtpMv+hpSw==" }, { "key": "Date", "value": "Wed, 05 Apr 2023 18:51:08 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "92" } ], "cookie": [], "body": "{\n \"message_template_namespace\": \"58e6d318_b627_4112_b9c7_2961197553ea\",\n \"id\": \"104996122399160\"\n}" } ] }, { "name": "Create authentication template w/ OTP copy code button", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"authentication_code_copy_code_button\",\n \"language\": \"en_US\",\n \"category\": \"AUTHENTICATION\",\n \"components\": [\n {\n \"type\": \"BODY\",\n \"add_security_recommendation\": true\n },\n {\n \"type\": \"FOOTER\",\n \"code_expiration_minutes\": 10\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"OTP\",\n \"otp_type\": \"COPY_CODE\",\n \"text\": \"Copy Code\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] }, "description": "- Guide: [Authentication Templates with OTP Buttons](https://developers.facebook.com/docs/whatsapp/business-management-api/authentication-templates)\n- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates)\n- Guide: [How To Monitor Quality Signals](https://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals)\n- Endpoint reference: [WhatsApp Business Account > Message Templates](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"authentication_code_copy_code_button\",\n \"language\": \"en_US\",\n \"category\": \"AUTHENTICATION\",\n \"components\": [\n {\n \"type\": \"BODY\",\n \"add_security_recommendation\": true\n },\n {\n \"type\": \"FOOTER\",\n \"code_expiration_minutes\": 10\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"OTP\",\n \"otp_type\": \"COPY_CODE\",\n \"text\": \"Copy Code\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "x-business-use-case-usage", "value": "{\"104996122399160\":[{\"type\":\"whatsapp_business_management\",\"call_count\":0,\"total_cputime\":0,\"total_time\":0,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "AKDIp932lVvZuHIQyIS952l" }, { "key": "x-fb-trace-id", "value": "G95hQDucvX9" }, { "key": "x-fb-rev", "value": "1007468797" }, { "key": "X-FB-Debug", "value": "5laZch8UZd8gq/YUm4wPBo3Xo64o7SnELEqsMjdcW7ZIwi75buqMYyvxZXGOaCWur1/zh2hAQakRlkFkeJ7FKQ==" }, { "key": "Date", "value": "Wed, 10 May 2023 20:33:46 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "73" } ], "cookie": [], "body": "{\n \"id\": \"1473688840035974\",\n \"status\": \"APPROVED\",\n \"category\": \"AUTHENTICATION\"\n}" } ] }, { "name": "Create authentication template w/ OTP one-tap autofill button", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"authentication_code_autofill_button\",\n \"language\": \"en_US\",\n \"category\": \"AUTHENTICATION\",\n \"components\": [\n {\n \"type\": \"BODY\",\n \"add_security_recommendation\": true\n },\n {\n \"type\": \"FOOTER\",\n \"code_expiration_minutes\": 10\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"OTP\",\n \"otp_type\": \"ONE_TAP\",\n \"text\": \"Copy Code\",\n \"autofill_text\": \"Autofill\",\n \"package_name\": \"com.example.luckyshrub\",\n \"signature_hash\": \"K8a%2FAINcGX7\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] }, "description": "- Guide: [Authentication Templates with OTP Buttons](https://developers.facebook.com/docs/whatsapp/business-management-api/authentication-templates)\n- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates)\n- Guide: [How To Monitor Quality Signals](https://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals)\n- Endpoint reference: [WhatsApp Business Account > Message Templates](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"authentication_code_autofill_button\",\n \"language\": \"en_US\",\n \"category\": \"AUTHENTICATION\",\n \"components\": [\n {\n \"type\": \"BODY\",\n \"add_security_recommendation\": true\n },\n {\n \"type\": \"FOOTER\",\n \"code_expiration_minutes\": 10\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"OTP\",\n \"otp_type\": \"ONE_TAP\",\n \"text\": \"Copy Code\",\n \"autofill_text\": \"Autofill\",\n \"package_name\": \"com.example.luckyshrub\",\n \"signature_hash\": \"K8a%2FAINcGX7\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "x-business-use-case-usage", "value": "{\"104996122399160\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "ADlZKG2UmdFA85rJ2B8_Ozi" }, { "key": "x-fb-trace-id", "value": "D+M6cMp+D1L" }, { "key": "x-fb-rev", "value": "1007468797" }, { "key": "X-FB-Debug", "value": "//U2RB2hd4nk+GqaJM9kjVybDBP6Xw6k2lvMIpqAMJDKK8USOjNWRKbG5vpJNjp6y9N2a9zM1ZOhlE+4/5GB6w==" }, { "key": "Date", "value": "Wed, 10 May 2023 21:04:23 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "72" } ], "cookie": [], "body": "{\n \"id\": \"771761447905391\",\n \"status\": \"APPROVED\",\n \"category\": \"AUTHENTICATION\"\n}" } ] }, { "name": "Create catalog template", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"intro_catalog_offer\",\n \"language\": \"en_US\",\n \"category\": \"MARKETING\",\n \"components\": [\n {\n \"type\": \"BODY\",\n \"text\": \"Now shop for your favourite products right here on WhatsApp! Get Rs {{1}} off on all orders above {{2}}Rs! Valid for your first {{3}} orders placed on WhatsApp!\",\n \"example\": {\n \"body_text\": [\n [\n \"100\",\n \"400\",\n \"3\"\n ]\n ]\n }\n },\n {\n \"type\": \"FOOTER\",\n \"text\": \"Best grocery deals on WhatsApp!\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"CATALOG\",\n \"text\": \"View catalog\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] }, "description": "- Guide: [Catalog Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/catalog-templates)\n- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates)\n- Endpoint reference: [WhatsApp Business Account > Message Templates](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"authentication_code_autofill_button\",\n \"language\": \"en_US\",\n \"category\": \"AUTHENTICATION\",\n \"components\": [\n {\n \"type\": \"BODY\",\n \"add_security_recommendation\": true\n },\n {\n \"type\": \"FOOTER\",\n \"code_expiration_minutes\": 10\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"OTP\",\n \"otp_type\": \"ONE_TAP\",\n \"text\": \"Copy Code\",\n \"autofill_text\": \"Autofill\",\n \"package_name\": \"com.example.luckyshrub\",\n \"signature_hash\": \"K8a%2FAINcGX7\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "x-business-use-case-usage", "value": "{\"104996122399160\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "ADlZKG2UmdFA85rJ2B8_Ozi" }, { "key": "x-fb-trace-id", "value": "D+M6cMp+D1L" }, { "key": "x-fb-rev", "value": "1007468797" }, { "key": "X-FB-Debug", "value": "//U2RB2hd4nk+GqaJM9kjVybDBP6Xw6k2lvMIpqAMJDKK8USOjNWRKbG5vpJNjp6y9N2a9zM1ZOhlE+4/5GB6w==" }, { "key": "Date", "value": "Wed, 10 May 2023 21:04:23 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "72" } ], "cookie": [], "body": "{\n \"category\" : \"MARKETING\",\n \"id\" : \"188720130491317\",\n \"status\" : \"PENDING\"\n}" } ] }, { "name": "Create multi-product message template", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"abandoned_cart\",\n \"language\": \"en_US\",\n \"category\": \"MARKETING\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"TEXT\",\n \"text\": \"Forget something {{1}}?\",\n \"example\": {\n \"header_text\": [\n \"Pablo\"\n ]\n }\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Looks like you left some items in your cart! Use code {{1}} and you can get 10% off of all of them!\",\n \"example\": {\n \"body_text\": [\n [\n \"10OFF\"\n ]\n ]\n }\n },\n {\n \"type\":\"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"MPM\",\n \"text\": \"View items\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] }, "description": "- Guide: [Multi-Product Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/mpm-templates)\n- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates)\n- Guide: [How To Monitor Quality Signals](https://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals)\n- Endpoint reference: [WhatsApp Business Account > Message Templates](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"abandoned_cart\",\n \"language\": \"en_US\",\n \"category\": \"MARKETING\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"TEXT\",\n \"text\": \"Forget something {{1}}?\",\n \"example\": {\n \"header_text\": [\n \"Pablo\"\n ]\n }\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Looks like you left some items in your cart! Use code {{1}} and you can get 10% off of all of them!\",\n \"example\": {\n \"body_text\": [\n [\n \"10OFF\"\n ]\n ]\n }\n },\n {\n \"type\":\"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"MPM\",\n \"text\": \"View items\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "x-business-use-case-usage", "value": "{\"104996122399160\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "A3RpRCRYq_2lAy6Wxi8LHKA" }, { "key": "x-fb-trace-id", "value": "Bw/YMwRpjl4" }, { "key": "x-fb-rev", "value": "1007468797" }, { "key": "X-FB-Debug", "value": "PUCQeqJ37UQ+sft7EingcX61vzlQ66E+YYidBn/TRmvZr4c+cmh/1L1Vi0IwsGuBeB1rTgXk4LrOevOiTagYMg==" }, { "key": "Date", "value": "Wed, 10 May 2023 21:28:52 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "67" } ], "cookie": [], "body": "{\n \"id\": \"1986030731777856\",\n \"status\": \"PENDING\",\n \"category\": \"MARKETING\"\n}" } ] }, { "name": "Create template w/ text header, text body, text footer, and 2 quick reply buttons", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"seasonal_promotion_text_only\",\n \"language\": \"en\",\n \"category\": \"MARKETING\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"TEXT\",\n \"text\": \"Our {{1}} is on!\",\n \"example\": {\n \"header_text\": [\n \"Summer Sale\"\n ]\n }\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Shop now through {{1}} and use code {{2}} to get {{3}} off of all merchandise.\",\n \"example\": {\n \"body_text\": [\n [\n \"the end of August\",\"25OFF\",\"25%\"\n ]\n ]\n }\n },\n {\n \"type\": \"FOOTER\",\n \"text\": \"Use the buttons below to manage your marketing subscriptions\"\n },\n {\n \"type\":\"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Unsubcribe from Promos\"\n },\n {\n \"type\":\"QUICK_REPLY\",\n \"text\": \"Unsubscribe from All\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] }, "description": "- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates)\n- Guide: [How To Monitor Quality Signals](https://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals)\n- Endpoint reference: [WhatsApp Business Account > Message Templates](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"seasonal_promotion_text_only\",\n \"language\": \"en\",\n \"category\": \"MARKETING\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"TEXT\",\n \"text\": \"Our {{1}} is on!\",\n \"example\": {\n \"header_text\": [\n \"Summer Sale\"\n ]\n }\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Shop now through {{1}} and use code {{2}} to get {{3}} off of all merchandise.\",\n \"example\": {\n \"body_text\": [\n [\n \"the end of August\",\"25OFF\",\"25%\"\n ]\n ]\n }\n },\n {\n \"type\": \"FOOTER\",\n \"text\": \"Use the buttons below to manage your marketing subscriptions\"\n },\n {\n \"type\":\"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Unsubcribe from Promos\"\n },\n {\n \"type\":\"QUICK_REPLY\",\n \"text\": \"Unsubscribe from All\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "AI_3T_tgo703qWCRyjGFo0Z" }, { "key": "x-fb-trace-id", "value": "GsPSVe222Tl" }, { "key": "x-fb-rev", "value": "1007262384" }, { "key": "X-FB-Debug", "value": "d9B0xsLYPaAGN0boQNCL6IKBUg7Y0ylgMRd9JiRdwb9d+wBe0TcvtpOvZ1RQ1s64QLIjemknt9ipTvNM5k7HVw==" }, { "key": "Date", "value": "Thu, 06 Apr 2023 21:34:33 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "67" } ], "cookie": [], "body": "{\n \"id\": \"1627019861106475\",\n \"status\": \"PENDING\",\n \"category\": \"MARKETING\"\n}" } ] }, { "name": "Create template w/ image header, text body, text footer, and 2 call-to-action buttons", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"limited_time_offer_tuscan_getaway_2023\",\n \"language\": \"en_US\",\n \"category\": \"MARKETING\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"IMAGE\",\n \"example\": {\n \"header_handle\": [\n \"4::aW...\"\n ]\n }\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Hi {{1}}! For a limited time only you can get our {{2}} for as low as {{3}}. Tap the Offer Details button for more information.\",\n \"example\": {\n \"body_text\": [\n [\n \"Mark\",\"Tuscan Getaway package\",\"800\"\n ]\n ]\n }\n },\n {\n \"type\": \"FOOTER\",\n \"text\": \"Offer valid until May 31, 2023\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"Call\",\n \"phone_number\": \"15550051310\"\n },\n {\n \"type\": \"URL\",\n \"text\": \"Shop Now\",\n \"url\": \"https://www.examplesite.com/shop?promo={{1}}\",\n \"example\": [\n \"summer2023\"\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] }, "description": "- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates)\n- Guide: [How To Monitor Quality Signals](https://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals)\n- Endpoint reference: [WhatsApp Business Account > Message Templates](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"limited_time_offer_tuscan_getaway_2023\",\n \"language\": \"en_US\",\n \"category\": \"MARKETING\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"IMAGE\",\n \"example\": {\n \"header_handle\": [\n \"4::aW1hZ2UvanBn:ARYytyb0kLp5htbBB8vWlclG5M9gMBxiEyt4FNCvrueWBOmFmRAztEuNtPGUnEC22Etc_SAAVU0YJOk3B7A-JuR1241_nq7gfITFxXKdDGnfvw:e:1681000441:634974688087057:100089620928913:ARbB4l0IPRncfMF-1sE\\n4::aW1hZ2UvanBn:ARZewDmbZuoq3rGUO1WgXjJEYcI1Tt7jr_Z6o2-oD5rg4--AQarBV_S1BYEcR8INJkctK0lNJmQ5v7PsBo-vqB-N0DSTe2-G6jHOlxKc12KSSg:e:1681000441:634974688087057:100089620928913:ARZQmT7tfO0sW--3oLo\\n4::aW1hZ2UvanBn:ARZkcJXFoEMa0YMMd2WQT8aVMJFaUPlSYW9xXshyh1bP-Pd6JP4t2VbrZezqGOEfC-acYkRZA5Q31FX7dEE_hQ9a-0i-b-RaueQrWO6vWk-7bQ:e:1681000441:634974688087057:100089620928913:ARYlgv7ErOQGsZYClfs\"\n ]\n }\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Hi {{1}}! For a limited time only you can get our {{2}} for as low as {{3}}. Tap the Offer Details button for more information.\",\n \"example\": {\n \"body_text\": [\n [\n \"Mark\",\"Tuscan Getaway package\",\"800\"\n ]\n ]\n }\n },\n {\n \"type\": \"FOOTER\",\n \"text\": \"Offer valid until May 31, 2023\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"Call\",\n \"phone_number\": \"16467043595\"\n },\n {\n \"type\": \"URL\",\n \"text\": \"Shop Now\",\n \"url\": \"https://damp-sea-63235.herokuapp.com/shop?promo={{1}}\",\n \"example\": [\n \"summer2023\"\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "A8B59xsqDRPZs4cmEVzDXyW" }, { "key": "x-fb-trace-id", "value": "EIhIwSCVG3y" }, { "key": "x-fb-rev", "value": "1007263228" }, { "key": "X-FB-Debug", "value": "MCgT301EhTnmJPNQ3EvAkMyMb/+PcRdwjElfb/Ag/RkFLf37QJ2dZq6KZ/PKeWyksWL2JblPXyKF3uBeIMSyLQ==" }, { "key": "Date", "value": "Fri, 07 Apr 2023 00:27:06 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "66" } ], "cookie": [], "body": "{\n \"id\": \"558456123149285\",\n \"status\": \"PENDING\",\n \"category\": \"MARKETING\"\n}" } ] }, { "name": "Create template w/ location header, text body, text footer, and a website buttons", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"order_delivery_update\",\n \"language\": \"en_US\",\n \"category\": \"UTILITY\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"LOCATION\"\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Good news {{1}}! Your order #{{2}} is on its way to the location above. Thank you for your order!\",\n \"example\": {\n \"body_text\": [\n [\n \"Mark\",\n \"566701\"\n ]\n ]\n }\n },\n {\n \"type\": \"FOOTER\",\n \"text\": \"To stop receiving delivery updates, tap the button below.\"\n },\n {\n \"type\":\"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Stop Delivery Updates\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] }, "description": "- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates)\n- Guide: [How To Monitor Quality Signals](https://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals)\n- Endpoint reference: [WhatsApp Business Account > Message Templates](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"order_delivery_update\",\n \"language\": \"en_US\",\n \"category\": \"UTILITY\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"LOCATION\"\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Good news {{1}}! Your order #{{2}} is on its way to the location above. Thank you for your order!\",\n \"example\": {\n \"body_text\": [\n [\n \"Mark\",\n \"566701\"\n ]\n ]\n }\n },\n {\n \"type\": \"FOOTER\",\n \"text\": \"To stop receiving delivery updates, tap the button below.\"\n },\n {\n \"type\":\"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Stop Delivery Updates\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "AubwVT4uq_U6uQOGumC32Hn" }, { "key": "x-fb-trace-id", "value": "Hcn1fh7XKeE" }, { "key": "x-fb-rev", "value": "1007266633" }, { "key": "X-FB-Debug", "value": "I5PZsVqJRarPN8lrGXwSOUDp5VtgobB98YBrVVqgAK6qIYAmci7WaCoXSKIxZ8ggtXH/6/pE413yIo3Gl4+DVw==" }, { "key": "Date", "value": "Fri, 07 Apr 2023 05:36:15 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "65" } ], "cookie": [], "body": "{\n \"id\": \"1667192013751005\",\n \"status\": \"PENDING\",\n \"category\": \"UTILITY\"\n}" } ] }, { "name": "Create template w/ document header, text body, a phone number button, and a URL button", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"order_confirmation\",\n \"language\": \"en_US\",\n \"category\": \"UTILITY\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"DOCUMENT\",\n \"example\": {\n \"header_handle\": [\n \"4::YXBwbGljYXRpb24vcGRm:ARZVv4zuogJMxmAdS3_6T4o_K4ll2806avA7rWpikisTzYPsXXUeKk0REjS-hIM1rYrizHD7rQXj951TKgUFblgd_BDWVROCwRkg9Vhjj-cHNQ:e:1681237341:634974688087057:100089620928913:ARa1ZDhwbLZM3EENeeg\"\n ]\n }\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Thank you for your order, {{1}}! Your order number is {{2}}. Tap the PDF linked above to view your receipt. If you have any questions, please use the buttons below to contact support. Thanks again!\",\n \"example\": {\n \"body_text\": [\n [\n \"Mark\",\"860198-230332\"\n ]\n ]\n }\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"Call\",\n \"phone_number\": \"16467043595\"\n },\n {\n \"type\": \"URL\",\n \"text\": \"Contact Support\",\n \"url\": \"https://www.examplesite.com/support\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] }, "description": "- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates)\n- Guide: [How To Monitor Quality Signals](https://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals)\n- Endpoint reference: [WhatsApp Business Account > Message Templates](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"order_confirmation\",\n \"language\": \"en_US\",\n \"category\": \"UTILITY\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"DOCUMENT\",\n \"example\": {\n \"header_handle\": [\n \"4::YXBwbGljYXRpb24vcGRm:ARZVv4zuogJMxmAdS3_6T4o_K4ll2806avA7rWpikisTzYPsXXUeKk0REjS-hIM1rYrizHD7rQXj951TKgUFblgd_BDWVROCwRkg9Vhjj-cHNQ:e:1681237341:634974688087057:100089620928913:ARa1ZDhwbLZM3EENeeg\"\n ]\n }\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Thank you for your order, {{1}}! Your order number is {{2}}. Tap the PDF linked above to view your receipt. If you have any questions, please use the buttons below to contact support. Thanks again!\",\n \"example\": {\n \"body_text\": [\n [\n \"Mark\",\"860198-230332\"\n ]\n ]\n }\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"Call\",\n \"phone_number\": \"16467043595\"\n },\n {\n \"type\": \"URL\",\n \"text\": \"Contact Support\",\n \"url\": \"https://www.examplesite.com/support\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "A4STUhm0XiMwJTlYq_PrDV9" }, { "key": "x-fb-trace-id", "value": "GLyPiVKuWzq" }, { "key": "x-fb-rev", "value": "1007268877" }, { "key": "X-FB-Debug", "value": "r8Ry/p8JFtsdtanUNO3CVXgTd2XQz+r+8BFIk0zjFPXXxOoaHwNiCyGZcPpsLDpBdP/XyP64DugpEKm/YOqaDw==" }, { "key": "Date", "value": "Fri, 07 Apr 2023 18:52:24 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "65" } ], "cookie": [], "body": "{\n \"id\": \"1689556908129832\",\n \"status\": \"PENDING\",\n \"category\": \"UTILITY\"\n}" } ] }, { "name": "Edit template", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"2023_april_promo\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"TEXT\",\n \"text\": \"Fall Sale\"\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Hi {{1}}, our Fall Sale is on! Use promo code {{2}} Get an extra 25% off every order above $350!\",\n \"example\": {\n \"body_text\": [\n [\n \"Mark\",\n \"FALL25\"\n ]\n ]\n }\n },\n {\n \"type\": \"FOOTER\",\n \"text\": \"Not interested in any of our sales? Tap Stop Promotions\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Stop promotions\"\n }\n ]\n }\n ],\n \"language\": \"en_US\",\n \"category\": \"MARKETING\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "" ] }, "description": "- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates)\n- Guide: [How To Monitor Quality Signals](https://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals)\n- Endpoint reference: [WhatsApp Message Template](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-hsm/)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"2023_april_promo\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"TEXT\",\n \"text\": \"Fall Sale\"\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Hi {{1}}, our Fall Sale is on! Use promo code {{2}} Get an extra 25% off every order above $350!\",\n \"example\": {\n \"body_text\": [\n [\n \"Mark\",\n \"FALL25\"\n ]\n ]\n }\n },\n {\n \"type\": \"FOOTER\",\n \"text\": \"Not interested in any of our sales? Tap Stop Promotions\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Stop promotions\"\n }\n ]\n }\n ],\n \"language\": \"en_US\",\n \"category\": \"MARKETING\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/920070352646140", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "920070352646140" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "x-business-use-case-usage", "value": "{\"634974688087057\":[{\"type\":\"whatsapp_business_management\",\"call_count\":0,\"total_cputime\":0,\"total_time\":0,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "AxL3yVE-rzEh1hPOKywIZDW" }, { "key": "x-fb-trace-id", "value": "BfPPcrAeZzp" }, { "key": "x-fb-rev", "value": "1007268877" }, { "key": "X-FB-Debug", "value": "zbNYNbDIkRVjsYZD3iU+7DGcNYKDv3s4901qpUuDTKGBq20h5dU5YjKCRIlIc2+Mzs/ZqnnGk0U68tK3eYVjvA==" }, { "key": "Date", "value": "Fri, 07 Apr 2023 19:32:22 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "16" } ], "cookie": [], "body": "{\n \"success\": true\n}" } ] }, { "name": "Delete template by name", "request": { "method": "DELETE", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates?name=", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ], "query": [ { "key": "name", "value": "" } ] }, "description": "- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates)\n- Guide: [How To Monitor Quality Signals](https://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals)\n- Endpoint reference: [WhatsApp Business Account > Message Templates](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates?name=seasonal_promotion_text_only", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ], "query": [ { "key": "name", "value": "seasonal_promotion_text_only" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "AQ2o2PPr2PzuzjL5VZnyNRs" }, { "key": "x-fb-trace-id", "value": "GJFtrOLrU++" }, { "key": "x-fb-rev", "value": "1007262384" }, { "key": "X-FB-Debug", "value": "4JujrkREfj7kXJ4hfIYNWM5BsnPHtocabFGJw3lBKCBCBKxPEdf1g4UCOFBVskGCoG28U17u3ysbIQxbvlhIOg==" }, { "key": "Date", "value": "Thu, 06 Apr 2023 21:00:35 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "16" } ], "cookie": [], "body": "{\n \"success\": true\n}" } ] }, { "name": "Delete template by ID", "request": { "method": "DELETE", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates?hsm_id=&name=", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ], "query": [ { "key": "hsm_id", "value": "", "description": "Template ID" }, { "key": "name", "value": "", "description": "Template name" } ] }, "description": "- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates)\n- Guide: [How To Monitor Quality Signals](https://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals)\n- Endpoint reference: [WhatsApp Business Account > Message Templates](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates?hsm_id=1407680676729941&name=order_confirmation", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ], "query": [ { "key": "hsm_id", "value": "1407680676729941" }, { "key": "name", "value": "order_confirmation" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "AdYqACouwJuFZWuJ6z-Zb-6" }, { "key": "x-fb-trace-id", "value": "ADp6tYI5dOX" }, { "key": "x-fb-rev", "value": "1007383760" }, { "key": "X-FB-Debug", "value": "bZ8hhZfdE97MVE74znlGSPtmnavHwev8Zkxa0dKIYEozk4+GVC1MXXCGbrfC25WV0ku5G1VmB3u7M9uq9ye/2w==" }, { "key": "Date", "value": "Wed, 26 Apr 2023 22:10:27 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "16" } ], "cookie": [], "body": "{\n \"success\": true\n}" } ] } ], "description": "- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates)\n- Guide: [How To Monitor Quality Signals](https://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals)" }, { "name": "Flows", "item": [ { "name": "Create Flow", "item": [ { "name": "Create Flow", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text" }, { "key": "categories", "value": "[\"OTHER\"]", "description": "A list of Flow categories. Multiple values are possible, but at least one is required. Choose the values which represent your business use case. \n\nPossible values: \"SIGN_UP\", \"SIGN_IN\", \"APPOINTMENT_BOOKING\", \"LEAD_GENERATION\", \"CONTACT_US\", \"CUSTOMER_SUPPORT\", \"SURVEY\", \"OTHER\"", "type": "text" }, { "key": "clone_flow_id", "value": "", "description": "Creates a copy of the existing flow specified", "type": "text", "disabled": true }, { "key": "endpoint_uri", "value": "https://example.com", "description": "Endpoint URI for the Flow", "type": "text", "disabled": true } ], "options": { "formdata": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/flows", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "flows" ] }, "description": "Creates a new flow. To clone an existing flow you can add the parameter\n\n`\"clone_flow_id\": \"original-flow-id\"`" }, "response": [ { "name": "Create Flow", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text" }, { "key": "categories", "value": "[\"OTHER\"]", "type": "text" }, { "key": "clone_flow_id", "value": "", "type": "text", "disabled": true }, { "key": "endpoint_uri", "value": "https://example.com", "type": "text", "disabled": true } ], "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/flows", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "flows" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"id\": \"flow-1\"\n}" } ] }, { "name": "Migrate Flows", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "source_waba_id", "value": "", "description": "The ID of the source WABA from which the flows will be copied", "type": "text" }, { "key": "source_flow_names", "value": "[\"appointment\", \"leadgen\"]", "description": "[Optional] The names of the flows that will be copied from the source WABA. If not specified, all flows in the source WABA will be copied", "type": "text" } ], "options": { "formdata": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/migrate_flows", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "migrate_flows" ] }, "description": "Creates a copy of existing flows from source WABA to destination WABA with the same names." }, "response": [ { "name": "Migrate Flows", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "source_waba_id", "value": "", "description": "The ID of the source WABA from which the flows will be copied", "type": "text" }, { "key": "source_flow_names", "value": "[\"appointment\", \"leadgen\"]", "description": "[Optional] The names of the flows that will be copied from the source WABA. If not specified, all flows in the source WABA will be copied", "type": "text" } ], "options": { "formdata": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/migrate_flows", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "migrate_flows" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"migrated_flows\": [\n {\n \"source_id\": \"source-flow-1\",\n \"source_name\": \"appointment\",\n \"migrated_id\": \"dest-flow-1\"\n }\n ],\n \"failed_flows\": [\n {\n \"source_name\": \"leadgen\",\n \"error_code\": \"4233041\",\n \"error_message\": \"Flows Migration Error: Flow name not found in source WABA.\"\n }\n ]\n}" } ] }, { "name": "Get Flow", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}?fields=id,name,categories,preview,status,validation_errors,json_version,data_api_version,data_channel_uri,health_status,whatsapp_business_account,application", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}" ], "query": [ { "key": "fields", "value": "id,name,categories,preview,status,validation_errors,json_version,data_api_version,data_channel_uri,health_status,whatsapp_business_account,application", "description": "Return specific fields in the response" } ] }, "description": "Can request specific fields by enabling the \\`fields\\` query param" }, "response": [ { "name": "Get Flow", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}?fields=id,name,categories,preview,status,validation_errors,json_version,data_api_version,data_channel_uri,whatsapp_business_account,application", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}" ], "query": [ { "key": "fields", "value": "id,name,categories,preview,status,validation_errors,json_version,data_api_version,data_channel_uri,whatsapp_business_account,application", "description": "Return specific fields in the response" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"id\": \"flow-1\",\n \"name\": \"my first flow\",\n \"categories\": [\n \"OTHER\"\n ],\n \"preview\": {\n \"preview_url\": \"https://business.facebook.com/wa/manage/flows/55000..../preview/?token=b9d6.....\",\n \"expires_at\": \"2023-05-21T11:18:09+0000\"\n },\n \"status\": \"DRAFT\",\n \"validation_errors\": [],\n \"json_version\": \"2.1\",\n \"data_api_version\": \"3.0\",\n \"data_channel_uri\": \"https://example.com\",\n \"health_status\": {\n \"can_send_message\": \"BLOCKED\",\n \"entities\": [\n {\n \"entity_type\": \"FLOW\",\n \"id\": \"flow-1\",\n \"can_send_message\": \"AVAILABLE\"\n },\n {\n \"entity_type\": \"WABA\",\n \"id\": \"waba-1\",\n \"can_send_message\": \"BLOCKED\",\n \"errors\": [\n {\n \"error_code\": 141006,\n \"error_description\": \"There is an error with the payment method. This will block business initiated conversations.\",\n \"possible_solution\": \"There was an error with your payment method. Please add a new payment method to the account.\"\n },\n {\n \"error_code\": 141014,\n \"error_description\": \"The WABA is banned.\",\n \"possible_solution\": \"Please visit Business Support Home for more details (https://business.facebook.com/accountquality) on how to appeal the ban.\"\n }\n ]\n },\n {\n \"entity_type\": \"BUSINESS\",\n \"id\": \"business-1\",\n \"can_send_message\": \"LIMITED\",\n \"errors\": [\n {\n \"error_code\": 141010,\n \"error_description\": \"The Business has not passed business verification.\",\n \"possible_solution\": \"Visit business settings and start or resolve the business verification request.\"\n }\n ]\n },\n {\n \"entity_type\": \"APP\",\n \"id\": \"app-1\",\n \"can_send_message\": \"AVAILABLE\"\n }\n ]\n },\n \"whatsapp_business_account\": {\n \"id\": \"waba-1\",\n \"name\": \"My Awesome WABA\",\n \"timezone_id\": \"54\",\n \"business_type\": \"ent\",\n \"message_template_namespace\": \"namespace-1\"\n },\n \"application\": {\n \"link\": \"https://www.facebook.com/games/?app_id=app-1\",\n \"name\": \"My Awesome App\",\n \"id\": \"app-1\"\n }\n}" } ] }, { "name": "Get Preview URL", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}?fields=preview.invalidate(false)", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}" ], "query": [ { "key": "fields", "value": "preview.invalidate(false)", "description": "Set to true to generate a new preview link and expire old link" }, { "key": "date_format", "value": "U", "description": "Returns date as unix timestamp in seconds", "disabled": true } ] }, "description": "Returns link to web page with preview of the flow. The link has an expiry time which is returned in the response. The same link will be returned as long as it's still valid, a new link will be generated when it expires.\n\nTo generate a new link and invalidate the existing link, set\n\n`fields=preview.invalidate(true)`" }, "response": [ { "name": "Get Preview URL", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}?fields=preview.invalidate(false)", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}" ], "query": [ { "key": "fields", "value": "preview.invalidate(false)", "description": "Set to true to generate a new preview link and expire old link" }, { "key": "date_format", "value": "U", "description": "Returns date as unix timestamp in seconds", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"preview\": {\n \"preview_url\": \"https://business.facebook.com/wa/manage/flows/550.../preview/?token=b9d6....\",\n \"expires_at\": \"2023-05-21T11:18:09+0000\"\n },\n \"id\": \"flow-1\"\n\n}" } ] }, { "name": "List Flows", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/flows", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "flows" ] } }, "response": [ { "name": "List Flows", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/flows", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "flows" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"data\": [\n {\n \"name\": \"my first flow\",\n \"status\": \"DRAFT\",\n \"categories\": [\n \"SIGN_UP\"\n ],\n \"validation_errors\": [],\n \"id\": \"flow-1\"\n },\n {\n \"name\": \"my second flow\",\n \"status\": \"DRAFT\",\n \"categories\": [\n \"SIGN_UP\",\n \"SIGN_IN\"\n ],\n \"validation_errors\": [\n {\n \"error\": \"INVALID_PROPERTY\",\n \"error_type\": \"JSON_SCHEMA_ERROR\",\n \"message\": \"The property \\\"initial-text\\\" cannot be specified at \\\"$root/screens/0/layout/children/2/children/0\\\".\",\n \"line_start\": 46,\n \"line_end\": 46,\n \"column_start\": 17,\n \"column_end\": 30\n }\n ],\n \"id\": \"flow-2\"\n },\n {\n \"name\": \"another flow\",\n \"status\": \"PUBLISHED\",\n \"categories\": [\n \"CONTACT_US\"\n ],\n \"validation_errors\": [],\n \"id\": \"flow-3\"\n }\n ],\n \"paging\": {\n \"cursors\": {\n \"before\": \"QVFIUnpKT...\",\n \"after\": \"QVFIUnZAWV...\"\n }\n }\n}" } ] } ] }, { "name": "Update Flow", "item": [ { "name": "Update Flow JSON", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [] }, { "key": "name", "value": "flow.json", "type": "text" }, { "key": "asset_type", "value": "FLOW_JSON", "type": "text" } ] }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}/assets", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}", "assets" ] }, "description": "Used to upload a flow JSON file with the flow content. Refer to flow JSON documentation here [https://developers.facebook.com/docs/whatsapp/flows/reference/flowjson](https://developers.facebook.com/docs/whatsapp/flows/reference/flowjson)\n\nThe file must be attached as from data. The response will include any validation errors in the JSON file" }, "response": [ { "name": "Upload Flow JSON Asset", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [] }, { "key": "name", "value": "flow.json", "type": "text" }, { "key": "asset_type", "value": "FLOW_JSON", "type": "text" } ] }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}/assets", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}", "assets" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"success\": true,\n \"validation_errors\": [\n {\n \"error\": \"INVALID_PROPERTY\",\n \"error_type\": \"JSON_SCHEMA_ERROR\",\n \"message\": \"The property \\\"initial-text\\\" cannot be specified at \\\"$root/screens/0/layout/children/2/children/0\\\".\",\n \"line_start\": 46,\n \"line_end\": 46,\n \"column_start\": 17,\n \"column_end\": 30\n }\n ]\n}" } ] }, { "name": "Publish Flow", "request": { "method": "POST", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}/publish", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}", "publish" ] }, "description": "Updates the status of the flow as \"PUBLISHED\". This action is not reversible. The flow and its assets become immutable once published. To update the flow, you must create a new flow and specify the previous flow id as the \\`clone_flow_id\\` parameter" }, "response": [ { "name": "Publish Flow", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}/publish", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}", "publish" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"success\": true\n}" } ] }, { "name": "Update Flow Metadata", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text" }, { "key": "categories", "value": "[\"OTHER\"]", "description": "A list of Flow categories. Multiple values are possible, but at least one is required. Choose the values which represent your business use case. \n\nAllowed values: \"SIGN_UP\", \"SIGN_IN\", \"APPOINTMENT_BOOKING\", \"LEAD_GENERATION\", \"CONTACT_US\", \"CUSTOMER_SUPPORT\", \"SURVEY\", \"OTHER\"", "type": "text" }, { "key": "endpoint_uri", "value": "https://example.com", "description": "Endpoint URI for the Flow", "type": "text" } ], "options": { "formdata": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}" ] } }, "response": [ { "name": "Update Flow Metadata", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text" }, { "key": "categories", "value": "[\"OTHER\"]", "type": "text" }, { "key": "endpoint_uri", "value": "https://example.com", "type": "text" } ], "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"success\": true\n}" } ] }, { "name": "List Assets (Get Flow JSON URL)", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}/assets", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}", "assets" ] }, "description": "Returns all assets attached to the flow. Currently only FLOW_JSON asset is supported" }, "response": [ { "name": "List Assets", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}/assets", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}", "assets" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"data\": [\n {\n \"name\": \"flow.json\",\n \"asset_type\": \"FLOW_JSON\",\n \"download_url\": \"https://scontent.xx.fbcdn.net/m1/v/t0.57323-24/An_Hq0jnfJ...\"\n }\n ],\n \"paging\": {\n \"cursors\": {\n \"before\": \"QVFIU...\",\n \"after\": \"QVFIU...\"\n }\n }\n}" } ] }, { "name": "Deprecate Flow", "request": { "method": "POST", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}/deprecate", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}", "deprecate" ] }, "description": "Updates the status of the flow as \"DEPRECATED\". This action is not reversible. Only a published flow can be deprecated to prevent sending or opening it." }, "response": [ { "name": "Deprecate Flow", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}/publish", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}", "publish" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"success\": true\n}" } ] }, { "name": "Delete Flow", "request": { "method": "DELETE", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}" ] }, "description": "Deletes the flow entirely. This action is not reversible. Only a DRAFT flow can be deleted." }, "response": [ { "name": "Delete Flow", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"success\": true\n}" } ] } ] }, { "name": "Setup Endpoint Encryption", "item": [ { "name": "Set Encryption Public Key", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "business_public_key", "value": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKC\n...\n8QIDAQAB\n-----END PUBLIC KEY-----", "type": "text" } ] }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/whatsapp_business_encryption", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "whatsapp_business_encryption" ] }, "description": "Sets the public key that is used for encrypting the data channel requests" }, "response": [ { "name": "Set Encryption Public Key", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "business_public_key", "value": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKC\n...\n8QIDAQAB\n-----END PUBLIC KEY-----", "type": "text" } ] }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/whatsapp_business_encryption", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "whatsapp_business_encryption" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"success\": true\n}" } ] }, { "name": "Get Encryption Public Key", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/whatsapp_business_encryption", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "whatsapp_business_encryption" ] } }, "response": [ { "name": "Get Encryption Public Key", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/whatsapp_business_encryption", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "whatsapp_business_encryption" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"data\": [\n {\n \"business_public_key\": \"-----BEGIN PUBLIC KEY-----\\nMIIBIjANBgkqh...AQAB\\n-----END PUBLIC KEY-----\",\n \"business_public_key_signature_status\": \"VALID\"\n }\n ]\n}" } ] } ] }, { "name": "Send Flow", "item": [ { "name": "Send Draft Flow by Name", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"recipient_type\": \"individual\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"flow\",\n \"header\": {\n \"type\": \"text\",\n \"text\": \"Not shown in draft mode\"\n },\n \"body\": {\n \"text\": \"Not shown in draft mode\"\n },\n \"footer\": {\n \"text\": \"Not shown in draft mode\"\n },\n \"action\": {\n \"name\": \"flow\",\n \"parameters\": {\n \"flow_message_version\": \"3\",\n \"flow_action\": \"navigate\",\n \"flow_token\": \"\",\n \"flow_name\": \"{{Flow-Name}}\",\n \"flow_cta\": \"Not shown in draft mode\",\n \"mode\": \"draft\",\n \"flow_action_payload\": {\n \"screen\": \"\",\n \"data\": {\n \"\": \"\"\n }\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "Flow messages won't be delivered to unsupported WhatsApp versions" }, "response": [ { "name": "Send Draft Flow by Name", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"recipient_type\": \"individual\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"flow\",\n \"header\": {\n \"type\": \"text\",\n \"text\": \"Not shown in draft mode\"\n },\n \"body\": {\n \"text\": \"Not shown in draft mode\"\n },\n \"footer\": {\n \"text\": \"Not shown in draft mode\"\n },\n \"action\": {\n \"name\": \"flow\",\n \"parameters\": {\n \"flow_message_version\": \"3\",\n \"flow_action\": \"navigate\",\n \"flow_token\": \"\",\n \"flow_name\": \"{{Flow-Name}}\",\n \"flow_cta\": \"Not shown in draft mode\",\n \"mode\": \"draft\",\n \"flow_action_payload\": {\n \"screen\": \"\",\n \"data\": {\n \"\": \"\"\n }\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"18055555555\",\n \"wa_id\": \"18055555555\"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.HBgL...\"\n }\n ]\n}" } ] }, { "name": "Send Draft Flow by ID", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"recipient_type\": \"individual\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"flow\",\n \"header\": {\n \"type\": \"text\",\n \"text\": \"Not shown in draft mode\"\n },\n \"body\": {\n \"text\": \"Not shown in draft mode\"\n },\n \"footer\": {\n \"text\": \"Not shown in draft mode\"\n },\n \"action\": {\n \"name\": \"flow\",\n \"parameters\": {\n \"flow_message_version\": \"3\",\n \"flow_action\": \"navigate\",\n \"flow_token\": \"\",\n \"flow_id\": \"{{Flow-ID}}\",\n \"flow_cta\": \"Not shown in draft mode\",\n \"mode\": \"draft\",\n \"flow_action_payload\": {\n \"screen\": \"\",\n \"data\": {\n \"\": \"\"\n }\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "Flow messages won't be delivered to unsupported WhatsApp versions" }, "response": [ { "name": "Send Draft Flow by ID", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"recipient_type\": \"individual\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"flow\",\n \"header\": {\n \"type\": \"text\",\n \"text\": \"Not shown in draft mode\"\n },\n \"body\": {\n \"text\": \"Not shown in draft mode\"\n },\n \"footer\": {\n \"text\": \"Not shown in draft mode\"\n },\n \"action\": {\n \"name\": \"flow\",\n \"parameters\": {\n \"flow_message_version\": \"3\",\n \"flow_action\": \"navigate\",\n \"flow_token\": \"\",\n \"flow_id\": \"{{Flow-ID}}\",\n \"flow_cta\": \"Not shown in draft mode\",\n \"mode\": \"draft\",\n \"flow_action_payload\": {\n \"screen\": \"\",\n \"data\": {\n \"\": \"\"\n }\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"18055555555\",\n \"wa_id\": \"18055555555\"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.HBgL...\"\n }\n ]\n}" } ] }, { "name": "Send Published Flow by Name", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"recipient_type\": \"individual\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"flow\",\n \"header\": {\n \"type\": \"text\",\n \"text\": \"\"\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n },\n \"action\": {\n \"name\": \"flow\",\n \"parameters\": {\n \"flow_message_version\": \"3\",\n \"flow_action\": \"navigate\",\n \"flow_token\": \"\",\n \"flow_name\": \"{{Flow-Name}}\",\n \"flow_cta\": \"Open Flow!\",\n \"flow_action_payload\": {\n \"screen\": \"\",\n \"data\": {\n \"\": \"\"\n }\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "Flow messages won't be delivered to unsupported WhatsApp versions" }, "response": [ { "name": "Send Published Flow by Name", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"recipient_type\": \"individual\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"flow\",\n \"header\": {\n \"type\": \"text\",\n \"text\": \"\"\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n },\n \"action\": {\n \"name\": \"flow\",\n \"parameters\": {\n \"flow_message_version\": \"3\",\n \"flow_action\": \"navigate\",\n \"flow_token\": \"\",\n \"flow_name\": \"{{Flow-Name}}\",\n \"flow_cta\": \"Open Flow!\",\n \"flow_action_payload\": {\n \"screen\": \"\",\n \"data\": {\n \"\": \"\"\n }\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"18055555555\",\n \"wa_id\": \"18055555555\"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.HBgL...\"\n }\n ]\n}" } ] }, { "name": "Send Published Flow by ID", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"recipient_type\": \"individual\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"flow\",\n \"header\": {\n \"type\": \"text\",\n \"text\": \"\"\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n },\n \"action\": {\n \"name\": \"flow\",\n \"parameters\": {\n \"flow_message_version\": \"3\",\n \"flow_action\": \"navigate\",\n \"flow_token\": \"\",\n \"flow_id\": \"{{Flow-ID}}\",\n \"flow_cta\": \"Open Flow!\",\n \"flow_action_payload\": {\n \"screen\": \"\",\n \"data\": {\n \"\": \"\"\n }\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "Flow messages won't be delivered to unsupported WhatsApp versions" }, "response": [ { "name": "Send Published Flow by ID", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"recipient_type\": \"individual\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"flow\",\n \"header\": {\n \"type\": \"text\",\n \"text\": \"\"\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n },\n \"action\": {\n \"name\": \"flow\",\n \"parameters\": {\n \"flow_message_version\": \"3\",\n \"flow_action\": \"navigate\",\n \"flow_token\": \"\",\n \"flow_id\": \"{{Flow-ID}}\",\n \"flow_cta\": \"Open Flow!\",\n \"flow_action_payload\": {\n \"screen\": \"\",\n \"data\": {\n \"\": \"\"\n }\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"18055555555\",\n \"wa_id\": \"18055555555\"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.HBgL...\"\n }\n ]\n}" } ] }, { "name": "Create Flow Template Message by Name", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"language\": \"en_US\",\n \"category\": \"MARKETING\",\n \"components\": [\n {\n \"type\": \"body\",\n \"text\": \"Check out this new offer\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"FLOW\",\n \"text\": \"Check out this offer!\",\n \"flow_name\": \"{{Flow-Name}}\",\n \"navigate_screen\": \"\",\n \"flow_action\": \"navigate\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] } }, "response": [ { "name": "Create Flow Template Message by Name", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"language\": \"en_US\",\n \"category\": \"MARKETING\",\n \"components\": [\n {\n \"type\": \"body\",\n \"text\": \"Check out this new offer\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"FLOW\",\n \"text\": \"Check out this offer!\",\n \"flow_name\": \"{{Flow-Name}}\",\n \"navigate_screen\": \"\",\n \"flow_action\": \"navigate\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"id\": \"template-1\",\n \"status\": \"PENDING\",\n \"category\": \"MARKETING\"\n}" } ] }, { "name": "Create Flow Template Message by Flow JSON", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"language\": \"en_US\",\n \"category\": \"MARKETING\",\n \"components\": [\n {\n \"type\": \"body\",\n \"text\": \"Check out this new offer\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"FLOW\",\n \"text\": \"Check out this offer!\",\n \"flow_json\": \"{\\\"version\\\":\\\"5.0\\\",\\\"screens\\\":[{\\\"id\\\":\\\"WELCOME_SCREEN\\\",\\\"layout\\\":{\\\"type\\\":\\\"SingleColumnLayout\\\",\\\"children\\\":[{\\\"type\\\":\\\"TextHeading\\\",\\\"text\\\":\\\"Hello World\\\"},{\\\"type\\\":\\\"Footer\\\",\\\"label\\\":\\\"Complete\\\",\\\"on-click-action\\\":{\\\"name\\\":\\\"complete\\\",\\\"payload\\\":{}}}]},\\\"title\\\":\\\"Welcome\\\",\\\"terminal\\\":true,\\\"success\\\":true,\\\"data\\\":{}}]}\",\n \"navigate_screen\": \"WELCOME_SCREEN\",\n \"flow_action\": \"navigate\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] } }, "response": [ { "name": "Create Flow Template Message by Flow JSON", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"language\": \"en_US\",\n \"category\": \"MARKETING\",\n \"components\": [\n {\n \"type\": \"body\",\n \"text\": \"Check out this new offer\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"FLOW\",\n \"text\": \"Check out this offer!\",\n \"flow_json\": \"{\\\"version\\\":\\\"5.0\\\",\\\"screens\\\":[{\\\"id\\\":\\\"WELCOME_SCREEN\\\",\\\"layout\\\":{\\\"type\\\":\\\"SingleColumnLayout\\\",\\\"children\\\":[{\\\"type\\\":\\\"TextHeading\\\",\\\"text\\\":\\\"Hello World\\\"},{\\\"type\\\":\\\"Footer\\\",\\\"label\\\":\\\"Complete\\\",\\\"on-click-action\\\":{\\\"name\\\":\\\"complete\\\",\\\"payload\\\":{}}}]},\\\"title\\\":\\\"Welcome\\\",\\\"terminal\\\":true,\\\"success\\\":true,\\\"data\\\":{}}]}\",\n \"navigate_screen\": \"WELCOME_SCREEN\",\n \"flow_action\": \"navigate\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"id\": \"template-1\",\n \"status\": \"PENDING\",\n \"category\": \"MARKETING\"\n}" } ] }, { "name": "Create Flow Template Message by ID", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"language\": \"en_US\",\n \"category\": \"MARKETING\",\n \"components\": [\n {\n \"type\": \"body\",\n \"text\": \"Check out this new offer\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"FLOW\",\n \"text\": \"Check out this offer!\",\n \"flow_id\": \"{{Flow-ID}}\",\n \"navigate_screen\": \"\",\n \"flow_action\": \"navigate\"\n }\n ]\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] } }, "response": [ { "name": "Create Flow Template Message by ID", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"language\": \"en_US\",\n \"category\": \"MARKETING\",\n \"components\": [\n {\n \"type\": \"body\",\n \"text\": \"Check out this new offer\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"FLOW\",\n \"text\": \"Check out this offer!\",\n \"flow_id\": \"{{Flow-ID}}\",\n \"navigate_screen\": \"\",\n \"flow_action\": \"navigate\"\n }\n ]\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}/message_templates", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}", "message_templates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"id\": \"template-1\",\n \"status\": \"PENDING\",\n \"category\": \"MARKETING\"\n}" } ] }, { "name": "Send Flow Template Message", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"template\",\n \"template\": {\n \"name\": \"\",\n \"language\": {\n \"code\": \"en_US\"\n },\n \"components\": [\n {\n \"type\": \"button\",\n \"sub_type\": \"flow\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"action\",\n \"action\": {\n \"flow_token\": \"\",\n \"flow_action_data\": {\n \"\": \"\"\n }\n }\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "response": [ { "name": "Send Flow Template Message", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"template\",\n \"template\": {\n \"name\": \"\",\n \"language\": {\n \"code\": \"en_US\"\n },\n \"components\": [\n {\n \"type\": \"button\",\n \"sub_type\": \"flow\",\n \"index\": \"0\",\n \"parameters\": [\n {\n \"type\": \"action\",\n \"action\": {\n \"flow_token\": \"\",\n \"flow_action_data\": {\n \"\": \"\"\n }\n }\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"18055555555\",\n \"wa_id\": \"18055555555\"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.HBgL...\"\n }\n ]\n}" } ] } ] }, { "name": "Get Endpoint Metrics", "item": [ { "name": "Get Endpoint Request Count Metric", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}?fields=metric.name(ENDPOINT_REQUEST_COUNT).granularity(DAY).since(2024-01-28).until(2024-01-30)", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}" ], "query": [ { "key": "fields", "value": "metric.name(ENDPOINT_REQUEST_COUNT).granularity(DAY).since(2024-01-28).until(2024-01-30)" } ] }, "description": "Can request specific fields by enabling the \\`fields\\` query param" }, "response": [ { "name": "Get Endpoint Request Count Metric", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}?fields=metric.name(ENDPOINT_REQUEST_COUNT).granularity(DAY).since(2024-01-28).until(2024-01-30)", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}" ], "query": [ { "key": "fields", "value": "metric.name(ENDPOINT_REQUEST_COUNT).granularity(DAY).since(2024-01-28).until(2024-01-30)", "description": "Return specific fields in the response" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"id\": \"flow-1\",\n \"metric\": {\n \"granularity\": \"DAY\",\n \"name\": \"ENDPOINT_REQUEST_COUNT\",\n \"data_points\": [\n {\n \"timestamp\": \"2024-01-28T08:00:00+0000\",\n \"data\": [\n {\n \"key\": \"value\",\n \"value\": 138\n }\n ]\n },\n {\n \"timestamp\": \"2024-01-29T08:00:00+0000\",\n \"data\": [\n {\n \"key\": \"value\",\n \"value\": 361\n }\n ]\n }\n ]\n }\n}" } ] }, { "name": "Get Endpoint Request Error Metric", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}?fields=metric.name(ENDPOINT_REQUEST_ERROR).granularity(DAY).since(2024-01-28).until(2024-01-30)", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}" ], "query": [ { "key": "fields", "value": "metric.name(ENDPOINT_REQUEST_ERROR).granularity(DAY).since(2024-01-28).until(2024-01-30)" } ] }, "description": "Can request specific fields by enabling the \\`fields\\` query param" }, "response": [ { "name": "Get Endpoint Request Error Metric", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}?fields=metric.name(ENDPOINT_REQUEST_ERROR).granularity(DAY).since(2024-01-28).until(2024-01-30)", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}" ], "query": [ { "key": "fields", "value": "metric.name(ENDPOINT_REQUEST_ERROR).granularity(DAY).since(2024-01-28).until(2024-01-30)", "description": "Return specific fields in the response" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"id\": \"flow-1\",\n \"metric\": {\n \"granularity\": \"DAY\",\n \"name\": \"ENDPOINT_REQUEST_ERROR\",\n \"data_points\": [\n {\n \"timestamp\": \"2024-01-28T08:00:00+0000\",\n \"data\": [\n {\n \"key\": \"timeout_error\",\n \"value\": 25\n }\n ]\n },\n {\n \"timestamp\": \"2024-01-29T08:00:00+0000\",\n \"data\": [\n {\n \"key\": \"timeout_error\",\n \"value\": 64\n }\n ]\n }\n ]\n }\n}" } ] }, { "name": "Get Endpoint Request Error Rate Metric", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}?fields=metric.name(ENDPOINT_REQUEST_ERROR_RATE).granularity(LIFETIME).since(2024-01-28).until(2024-01-30)", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}" ], "query": [ { "key": "fields", "value": "metric.name(ENDPOINT_REQUEST_ERROR_RATE).granularity(LIFETIME).since(2024-01-28).until(2024-01-30)" } ] }, "description": "Can request specific fields by enabling the \\`fields\\` query param" }, "response": [ { "name": "Get Endpoint Request Error Rate Metric", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}?fields=metric.name(ENDPOINT_REQUEST_ERROR_RATE).granularity(LIFETIME).since(2024-01-28).until(2024-01-30)", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}" ], "query": [ { "key": "fields", "value": "metric.name(ENDPOINT_REQUEST_ERROR_RATE).granularity(LIFETIME).since(2024-01-28).until(2024-01-30)", "description": "Return specific fields in the response" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"id\": \"flow-1\",\n \"metric\": {\n \"granularity\": \"LIFETIME\",\n \"name\": \"ENDPOINT_REQUEST_ERROR_RATE\",\n \"data_points\": [\n {\n \"timestamp\": \"2024-01-28T08:00:00+0000\",\n \"data\": [\n {\n \"key\": \"value\",\n \"value\": 0.12625250501002\n }\n ]\n }\n ]\n }\n}" } ] }, { "name": "Get Endpoint Request Latencies Metric", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}?fields=metric.name(ENDPOINT_REQUEST_LATENCY_SECONDS_CEIL).granularity(DAY).since(2024-01-28).until(2024-01-30)", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}" ], "query": [ { "key": "fields", "value": "metric.name(ENDPOINT_REQUEST_LATENCY_SECONDS_CEIL).granularity(DAY).since(2024-01-28).until(2024-01-30)" } ] }, "description": "Can request specific fields by enabling the \\`fields\\` query param" }, "response": [ { "name": "Get Endpoint Request Latencies Metric", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}?fields=metric.name(ENDPOINT_REQUEST_LATENCY_SECONDS_CEIL).granularity(DAY).since(2024-01-28).until(2024-01-30)", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}" ], "query": [ { "key": "fields", "value": "metric.name(ENDPOINT_REQUEST_LATENCY_SECONDS_CEIL).granularity(DAY).since(2024-01-28).until(2024-01-30)", "description": "Return specific fields in the response" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"id\": \"flow-1\",\n \"metric\": {\n \"granularity\": \"DAY\",\n \"name\": \"ENDPOINT_REQUEST_LATENCY_SECONDS_CEIL\",\n \"data_points\": [\n {\n \"timestamp\": \"2024-01-28T08:00:00+0000\",\n \"data\": [\n {\n \"key\": \"1\",\n \"value\": 106\n }\n ]\n },\n {\n \"timestamp\": \"2024-01-29T08:00:00+0000\",\n \"data\": [\n {\n \"key\": \"1\",\n \"value\": 328\n },\n {\n \"key\": \"2\",\n \"value\": 2\n }\n ]\n }\n ]\n }\n}" } ] }, { "name": "Get Endpoint Availability Metric", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}?fields=metric.name(ENDPOINT_AVAILABILITY).granularity(DAY).since(2024-01-28).until(2024-01-30)", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}" ], "query": [ { "key": "fields", "value": "metric.name(ENDPOINT_AVAILABILITY).granularity(DAY).since(2024-01-28).until(2024-01-30)" } ] }, "description": "Can request specific fields by enabling the \\`fields\\` query param" }, "response": [ { "name": "Get Endpoint Availability Metric", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Flow-ID}}?fields=metric.name(ENDPOINT_AVAILABILITY).granularity(DAY).since(2024-01-28).until(2024-01-30)", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Flow-ID}}" ], "query": [ { "key": "fields", "value": "metric.name(ENDPOINT_AVAILABILITY).granularity(DAY).since(2024-01-28).until(2024-01-30)", "description": "Return specific fields in the response" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"id\": \"flow-1\",\n \"metric\": {\n \"granularity\": \"DAY\",\n \"name\": \"ENDPOINT_AVAILABILITY\",\n \"data_points\": [\n {\n \"timestamp\": \"2024-01-28T08:00:00+0000\",\n \"data\": [\n {\n \"key\": \"succeeded\",\n \"value\": 713\n },\n {\n \"key\": \"failed\",\n \"value\": 335\n }\n ]\n },\n {\n \"timestamp\": \"2024-01-29T08:00:00+0000\",\n \"data\": [\n {\n \"key\": \"succeeded\",\n \"value\": 623\n },\n {\n \"key\": \"failed\",\n \"value\": 2\n }\n ]\n }\n ]\n }\n}" } ] } ] } ] }, { "name": "Media", "item": [ { "name": "Upload Image", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "messaging_product", "value": "whatsapp", "type": "text" }, { "key": "file", "type": "file", "src": "/Users/Sample.jpg" } ] }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/media", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "media" ] }, "description": "This request uploads an image as .jpeg. The parameters are specified as **form-data** in the request **body**." }, "response": [ { "name": "Upload Image (form-data)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "messaging_product", "value": "whatsapp", "type": "text" }, { "key": "file", "type": "file", "src": "/Users/Sample.jpg" } ] }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/media", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "media" ] } }, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"id\": \"\"\n}" }, { "name": "Upload Image JSON", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \n \"file\": \"@/local/path/file.jpg;type=image/jpeg\",\n \"messaging_product\": \"whatsapp\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/media", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "media" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"id\": \"4490709327384033\"\n}" } ] }, { "name": "Upload Sticker", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "messaging_product", "value": "whatsapp", "type": "text" }, { "key": "file", "type": "file", "src": "/Users/sticker.webp" } ] }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/media", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "media" ] }, "description": "This request uploads a sticker as .webp. The parameters are specified as **form-data** in the request **body**." }, "response": [ { "name": "Upload Sticker File (form-data)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "messaging_product", "value": "whatsapp", "type": "text" }, { "key": "file", "type": "file", "src": "/Users/sticker.webp" } ] }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/media", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "media" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"id\": \"\"\n}" }, { "name": "Upload Sticker File JSON", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \n \"file\": \"@/local/path/file.webp;type=webp\",\n \"messaging_product\": \"whatsapp\" \n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/media", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "media" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"id\": \"4490709327384033\"\n}" } ] }, { "name": "Upload Audio", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"file\": \"@/local/path/file.ogg;type=audio/ogg\",\n \"messaging_product\": \"whatsapp\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/media", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "media" ] }, "description": "This request uploads an audio as .ogg. The parameters are specified as **form-data** in the request **body**." }, "response": [ { "name": "Upload Audio (form-data)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "messaging_product", "value": "whatsapp", "type": "text" }, { "key": "file", "type": "file", "src": "VTU9ki3ZH/sample-ogg.ogg" } ] }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/media", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "media" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"id\": \"\"\n}" }, { "name": "Upload Audio JSON", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \n \"file\": \"@/local/path/file.ogg;type=ogg\",\n \"messaging_product\": \"whatsapp\" \n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/media", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "media" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"4490709327384033\"\n}" } ] }, { "name": "Retrieve Media URL", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Media-ID}}?phone_number_id=", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Media-ID}}" ], "query": [ { "key": "phone_number_id", "value": "", "description": "Specifies that this action only be performed if the media belongs to the provided phone number." } ] }, "description": "To retrieve your media’s URL, make a **GET** call to **`/{{Media-ID}}`**. Use the returned URL to download the media file. Note that clicking this URL (i.e. performing a generic GET) will not return the media; you must include an access token. For more information, see [Download Media](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#download-media).\n\nYou can also use the optional query **`?phone_number_id`** for **`Retrieve Media URL`** and **`Delete Media`**. This parameter checks to make sure the media belongs to the phone number before retrieval or deletion.\n\n#### Response\n\nA successful response includes an object with a media URL. The URL is only valid for 5 minutes. To use this URL, see [Download Media](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#download-media)." }, "response": [ { "name": "Retrieve Media URL", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Media-ID}}?phone_number_id=", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Media-ID}}" ], "query": [ { "key": "phone_number_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"url\": \"\",\n \"mime_type\": \"image/jpeg\",\n \"sha256\": \"\",\n \"file_size\": \"303833\",\n \"id\": \"2621233374848975\"\n}" } ] }, { "name": "Delete Media", "request": { "method": "DELETE", "header": [], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Media-ID}}/?phone_number_id=", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Media-ID}}", "" ], "query": [ { "key": "phone_number_id", "value": "", "description": "Specifies that deletion of the media only be performed if the media belongs to the provided phone number." } ] }, "description": "To delete media, make a **DELETE** call to the ID of the media you want to delete.\n\n## Prerequisites\n- [User Access Token](https://developers.facebook.com/docs/facebook-login/access-tokens#usertokens) with **`whatsapp_business_messaging`** permission\n- Media object ID from either uploading media endpoint or media message Webhooks\n\n## Request\n[Perform requests in Graph API Explorer](https://developers.facebook.com/tools/explorer/?method=DELETE&path=media_id&version=v8.0)" }, "response": [ { "name": "Delete Media", "originalRequest": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}" } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Media-ID}}?phone_number_id=", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Media-ID}}" ], "query": [ { "key": "phone_number_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"success\": true\n}" } ] }, { "name": "Download Media", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Media-URL}}", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Media-URL}}" ] }, "description": "When you retrieve a media URL through the **GET** Media endpoint, you must use a User Access Token to download media content from the URL. If you click the URL from a browser, you will get an access error.
      \n> **Note**: all media URLs will expire after 5 minutes, you need to retrieve the media URL again if it expires.\n\n## Prerequisites\n- [User Access Token](https://developers.facebook.com/docs/facebook-login/access-tokens#usertokens) with **`whatsapp_business_messaging`** permission\n- A media URL obtained from retrieving media url endpoint \n\n## Response:\nIf successful, you receive the binary data of media saved in **`media_file`**, response headers contain a `content-type` header to indicate the mime type of returned data. For more information, see [Supported Media Types](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types).\n\nIf media fails to download, you receive a **404 Not Found** response code. In that case, we recommend that you try to [Retrieve Media URL](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#retrieve-media-url) and download again. If doing so doesn't resolve the issue, please try to renew the **`USER_ACCESS_TOKEN`** then retry downloading the media." }, "response": [ { "name": "Download Media", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Media-URL}}", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Media-URL}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "image/jpeg", "description": "", "type": "text" }, { "key": "media_file", "value": "", "description": "", "type": "text" } ], "cookie": [], "body": "" } ] } ], "description": "You can use the following endpoints to upload, retrieve, or delete media:\n\n| Endpoint | Uses |\n| ----------- | ---------- |\n| [POST /{phone-number-ID}/media]() | Upload media. |\n| [GET /{media-ID}]() | Retrieve the URL for a specific media item. |\n| [DELETE /{media-ID}]() | Delete a specific media item. |\n| [GET /{media-URL}]() | Download media from a media URL. |\n\n#### Reminders\n\n* To use these endpoints, you need to authenticate yourself with a system user access token with the **`whatsapp_business_messaging`** permission.\n* If you need to find your phone number ID, see [Get Phone Number ID](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/phone-numbers).\n* If you need to find your media URL, see [Retrieve Media URL](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#download-media).\n\n#### Support Media Types\n| Media | Supported File Type(s) | Size Limit |\n| ----------- | ----------------------- | ---------- |\n| `audio` |
      • `audio/aac`
      • `audio/mp4`
      • `audio/mpeg`
      • `audio/amr`
      • `audio/ogg`

      **Note**: only opus codecs, base audio/ogg is not supported | 16MB |\n| `document` |
      • `text/plain`
      • `application/pdf`
      • `application/vnd.ms-powerpoint`
      • `application/msword`
      • `application/vnd.ms-excel`
      • `application/vnd.openxmlformats-officedocument.wordprocessingml.document`
      • `application/vnd.openxmlformats-officedocument.presentationml.presentation`
      • `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`
      | 100MB |\n| `image` |
      • `image/jpeg`
      • `image/png`
      | 5MB |\n| `sticker` |
      • `image/webp`
      | 100KB |\n| `video` |
      • `video/mp4`
      • `video/3sp`

      **Notes**:
      • Only H.264 video codec and AAC audio codec is supported.
      • We support videos with a single audio stream or no audio stream.
          • | 16MB |\n\n\n#### Get Media ID\nTo complete some of the following API calls, you need to have a media ID. There are two ways to get this ID:\n\n* **From the API call**: Once you have successfully uploaded media files to the API, the media ID is included in the response to your call.\n* **From Webhooks**: When a business account receives a media message, it downloads the media and uploads it to the Cloud API automatically. That event triggers the Webhooks and sends you a notification that includes the media ID." }, { "name": "Typing indicators", "item": [ { "name": "Send typing indicator and read receipt", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"status\": \"read\",\n \"message_id\": \"\",\n \"typing_indicator\": {\n \"type\": \"text\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "- Guide: [Typing indicators](https://developers.facebook.com/docs/whatsapp/cloud-api/typing-indicators)\n \n- Endpoint reference: [WhatsApp Business Phone Number > Messages](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/messages/#Creating)" }, "response": [ { "name": "Send typing indicator and read receipt", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"status\": \"read\",\n \"message_id\": \"wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQUYzMjEzNDM2RTZGQ0MzMDJBRgA=\",\n \"typing_indicator\": {\n \"type\": \"text\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp\",\"call_count\":0,\"total_cputime\":0,\"total_time\":0,\"estimated_time_to_regain_access\":0}]}" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v22.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "A_xHw226CwK1JmTNs0vg6H7" }, { "key": "x-fb-trace-id", "value": "HI+8wJKxeVw" }, { "key": "x-fb-rev", "value": "1023054691" }, { "key": "X-FB-Debug", "value": "lv4tuvFRJpqMrYs/DgGn3j5JDX8U1npjw9IK3Wq4ZK9SBhiBtL99ztZj5d/YLhsgoaBRNR0/FKJ1swL3oLYvMg==" }, { "key": "Date", "value": "Wed, 21 May 2025 17:38:00 GMT" }, { "key": "X-FB-Connection-Quality", "value": "EXCELLENT; q=0.9, rtt=7, rtx=0, c=10, mss=1380, tbw=3403, tp=-1, tpl=-1, uplat=552, ullat=0" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "16" } ], "cookie": [], "body": "{\n \"success\": true\n}" } ] } ], "description": "Guide: [Typing indicators](https://developers.facebook.com/docs/whatsapp/cloud-api/typing-indicators)" }, { "name": "Business Profiles", "item": [ { "name": "Resumable Upload - Create an Upload Session", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "OAuth {{User-Access-Token}}", "type": "text" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/app/uploads/?file_length=&file_type=image/jpeg&file_name=myprofile.jpg", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "app", "uploads", "" ], "query": [ { "key": "file_length", "value": "", "description": "**Required**
          Specifies the size of your file in bytes." }, { "key": "file_type", "value": "image/jpeg", "description": "**Required**
          Specifies the MIME type. Values are
          • `image/jpeg`
          • `image/png`
          • `video/mp4`
          " }, { "key": "file_name", "value": "myprofile.jpg", "description": "**Optional**
          Specifies the file name you are using to create the session." } ] }, "description": "The Resumable Upload series of requests allow you to upload Profile Pictures to Meta so you can receive a handle to update these pictures in the Business Profile API. The Resumable Upload requests consist of the following:\n\n* **Resumable Upload - Create an Upload Session**\n* **Resumable Upload - Upload File Data**\n* **Resumable Upload - Query File Upload Status**\n\nTo create a new upload session, make a **POST** call using the `/app/uploads` endpoint.\n\nFor more information, see [Create an Upload Session](https://developers.facebook.com/docs/graph-api/guides/upload#step-1--create-a-session).\n\n**Response** \nThe call returns a server-generated value that includes the session ID that you can use in later calls. \n\n>Copy this value and Open the **Environment quick look** in Postman and paste it in the **CURRENT VALUE** for `Upload-ID`." }, "response": [ { "name": "Resumable Upload - Create an Upload Session", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "OAuth {{User-Access-Token}}", "type": "text" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/app/uploads/?file_length=14502&file_type=image/jpeg&file_name=myprofile.jpg", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "app", "uploads", "" ], "query": [ { "key": "file_length", "value": "14502", "description": "**Required**
          Specifies the size of your file in bytes." }, { "key": "file_type", "value": "image/jpeg", "description": "**Required**
          Specifies the MIME type. Values are
          • `image/jpeg`
          • `video/mp4`
          " }, { "key": "file_name", "value": "myprofile.jpg", "description": "**Optional**
          Specifies the file name you are using to create the session." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"id\": \"upload:MTphdHRhY2htZW50Ojlk2mJiZxUwLWV6MDUtNDIwMy05yTA3LWQ4ZDPmZGFkNTM0NT8=?sig=ARZqkGCA_uQMxC8nHKI\"\n}" } ] }, { "name": "Resumable Upload - Upload File Data", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "image/jpeg", "type": "text" }, { "key": "file_offset", "value": "0", "description": "Specifies the offset to start the upload. The offset value should always be `0`.", "type": "text" }, { "key": "Authorization", "value": "OAuth {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "file", "file": { "src": "/Users/Sample.jpg" } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Upload-ID}}", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Upload-ID}}" ] }, "description": "To upload a profile picture to your business profile, make a **POST** call to the named endpoint {{Version}}/{{Upload-ID}}, where **Upload-ID** is the value you received from **Resumable Upload - Create an Upload Session**. This value should look like the following:\n\n``` json\n\"upload:MTphdHRhY2htZW50Ojlk2mJiZxUwLWV6MDUtNDIwMy05yTA3LWQ4ZDPmZGFkNTM0NT8=?sig=ARZqkGCA_uQMxC8nHKI\"\n\n```\n\nThe **`file_offset`** parameter **must** be included as an HTTP header. It will not work as a query parameter.\n\nThe access token must be included in an Authorization HTTP header. It cannot work as a query parameter.\n\nFor more information, see [Initiate Data Upload](https://developers.facebook.com/docs/graph-api/guides/upload#step-2--initiate-upload).\n\n**Response** \nThe call returns a handle that includes the session ID that you can use to update your profile picture using **Update Business Profile**." }, "response": [ { "name": "Resumable Upload - Upload File Data", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "image/jpeg", "type": "text" }, { "key": "file_offset", "value": "0", "description": "Specifies the offset to start the upload. The offset value should always be `0`.", "type": "text" }, { "key": "Authorization", "value": "OAuth {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "file", "file": { "src": "/Users/Sample.jpg" } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Upload-ID}}", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Upload-ID}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"h\":\"2:c2FtcGxlLm1wNA==:image/jpeg:GKAj0gAUCZmJ1voFADip2iIAAAAAbugbAAAA:e:1472075513:ARZ_3ybzrQqEaluMUdI\"\n}" } ] }, { "name": "Resumable Upload - Query File Upload Status", "request": { "method": "GET", "header": [ { "key": "Cache-Control", "value": "no-cache", "type": "text" }, { "key": "Authorization", "value": "OAuth {{User-Access-Token}}", "type": "text" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Upload-ID}}", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Upload-ID}}" ] }, "description": "You can query the status of an upload session by making a **GET** call to an endpoint that is named based on the **`Upload-ID`** that was returned through the **Resumable Upload - Create an Upload Session** request.\n\nWhen uploading data, you **must include the access token as an HTTP header.**\n\n**Example**\n``` bash\nGET https://graph.facebook.com/v14.0/upload:MTphdHRhY2htZW50Ojlk2mJiZxUwLWV6MDUtNDIwMy05yTA3LWQ4ZDPmZGFkNTM0NT8=?sig=ARZqkGCA_uQMxC8nHKI HTTP/1.1\nAuthorization: OAuth {{USER_ACCESS_TOKEN}}\n\n```\n\nFor more information, see [Query File Upload Status after an Interruption](https://developers.facebook.com/docs/graph-api/guides/upload#interruptions).\n\n**Response**\nThe result will be a JSON-encoded ID and offset that looks like the following:\n\n``` json\n{ \"id\": \"upload:MTphdHRhY2htZW50Ojlk2mJiZxUwLWV6MDUtNDIwMy05yTA3LWQ4ZDPmZGFkNTM0NT8=?sig=ARZqkGCA_uQMxC8nHKI\", \"file_offset\": 0 }\n```" }, "response": [ { "name": "Resumable Upload - Query File Upload Status", "originalRequest": { "method": "GET", "header": [ { "key": "Cache-Control", "value": "no-cache", "type": "text" }, { "key": "Authorization", "value": "OAuth {{User-Access-Token}}", "type": "text" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Upload-ID}}", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Upload-ID}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{ \n \"id\": \"upload:MTphdHRhY2htZW50Ojlk2mJiZxUwLWV6MDUtNDIwMy05yTA3LWQ4ZDPmZGFkNTM0NT8=?sig=ARZqkGCA_uQMxC8nHKI\", \n \"file_offset\": 0 \n}" } ] }, { "name": "Get Business Profile", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/whatsapp_business_profile", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "whatsapp_business_profile" ] }, "description": "To get information about a business profile, make a **GET** call to the **`/{{Phone-Number-ID}}/whatsapp_business_profile`** endpoint. Within the **`whatsapp_business_profile`** request, you can specify what you want to know from the business. \n\n## Fields\n\n| Name | Description |\n|-------------------------|--------------------------------------|\n| **`messaging_product`** | **Required**.
          The messaging service used for the request. Always set the value to `\"whatsapp\"` if you are using WhatsApp for Business API.|\n| **`address`** | The address of the business. The maximum character limit for the string is 256. |\n| **`description`** |Description of the business. The maximum character limit for the string is 256. |\n| **`vertical`** | **Optional**.
          The industry type of the business. This can be either an empty string or one of the accepted values

          **Values**: `UNDEFINED`, `OTHER`, `AUTO`, `BEAUTY`, `APPAREL`, `EDU`, `ENTERTAIN`, `EVENT_PLAN`, `FINANCE`, `GROCERY`, `GOVT`, `HOTEL`, `HEALTH`, `NONPROFIT`, `PROF_SERVICES`, `RETAIL`, `TRAVEL`, `RESTAURANT`, or `NOT_A_BIZ`.|\n| **`about`** | **Optional**.
          The text to display in business profile's About section The max length for the string is 139 characters. The minimum length for the string is 1 character.

          Rendered emojis are supported however their unicode values are not. Emoji unicode values must be Java- or JavaScript-escape encoded.|\n| **`email`** | **Optional**.
          The contact email address (in valid email format) of the business. The maximum character limit for the string is 128 characters.|\n| **`websites`** | **Optional**.
          The URLs associated with the business. For instance, a website, Facebook Page, or Instagram. You must include the http:// or https:// portion of the URL. There is a maximum of 2 websites with a maximum of 256 characters each. |\n| **`profile_picture_handle`** | **Optional**.
          The handle of the profile picture generated from a call to the [Resumable Upload API](https://developers.facebook.com/docs/graph-api/guides/upload).|\n\n" }, "response": [ { "name": "Get Business Profile ID", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/whatsapp_business_profile?fields=about,address,description,email,profile_picture_url,websites,vertical", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "whatsapp_business_profile" ], "query": [ { "key": "fields", "value": "about,address,description,email,profile_picture_url,websites,vertical" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"business_profile\": {\n \"messaging_product\": \"whatsapp\",\n \"address\": \"business-address\",\n \"description\": \"business-description\",\n \"vertical\": \"business-industry\",\n \"about\": \"profile-about-text\",\n \"email\": \"business-email\",\n \"websites\": [\n \"https://website-1\",\n \"https://website-2\"\n ],\n \"profile_picture_url\": \"\" \n }\n }\n ]\n}" } ] }, { "name": "Update Business Profile", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"address\": \"\",\n \"description\": \"\",\n \"vertical\": \"\",\n \"about\": \"\",\n \"email\": \"\",\n \"websites\": [\n \"\",\n \"\"\n ],\n \"profile_picture_handle\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/whatsapp_business_profile", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "whatsapp_business_profile" ] }, "description": "Update the business profile information such as the business description, email or address. To update your profile, make a **POST** call to **`/{{Phone-Number-ID}}/whatsapp_business_profile`**. In your request, you can include the parameters listed below.\n\nIt is recommended that you use **Resumable Upload - Create an Upload Session** to obtain an upload ID. Then use this upload ID in a call to **Resumable Upload - Upload File Data** to obtain the picture handle. This handle can be used for the **`profile_picture_handle`**.\n\n## Request Parameters\n\n| Name | Description |\n|-------------------------|--------------------------------------|\n| **`messaging_product`** | **Required**.
          The messaging service used for the request. Always set the value to `\"whatsapp\"` if you are using WhatsApp for Business API.|\n| **`address`** | **Optional**.
          The address of the business. The maximum character limit for the string is 256. |\n| **`description`** | **Optional**.
          The description of the business. The maximum character limit for the string is 256. |\n| **`vertical`** | **Optional**.
          The industry type of the business. This can be either an empty string or one of the accepted values.

          **Values**: `UNDEFINED`, `OTHER`, `AUTO`, `BEAUTY`, `APPAREL`, `EDU`, `ENTERTAIN`, `EVENT_PLAN`, `FINANCE`, `GROCERY`, `GOVT`, `HOTEL`, `HEALTH`, `NONPROFIT`, `PROF_SERVICES`, `RETAIL`, `TRAVEL`, `RESTAURANT`, or `NOT_A_BIZ`.|\n| **`about`** | **Optional**.
          The text to display in business profile's About section. The max length for the string is 139 characters. The minimum length for the string is 1 character.

          Rendered emojis are supported however their unicode values are not. Emoji unicode values must be Java- or JavaScript-escape encoded.|\n| **`email`** | **Optional**.
          The contact email address (in valid email format) of the business. The maximum character limit for the string is 128 characters.|\n| **`websites`** | **Optional**.
          The URLs associated with the business. For instance, a website, Facebook Page, or Instagram. You must include the http:// or https:// portion of the URL. There is a maximum of 2 websites with a maximum of 256 characters each. |\n| **`profile_picture_handle`** | **Optional**.
          The handle of the profile picture generated from a call to **Resumable Upload - Upload File Data**. For more information, see [Resumable Upload API](https://developers.facebook.com/docs/graph-api/guides/upload).|\n\n## Delete Business Profile\n\nTo delete your business profile, you must [delete your phone number](https://developers.facebook.com/docs/whatsapp/phone-numbers#delete-phone-number-from-a-business-account)." }, "response": [ { "name": "Update Business Profile", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"address\": \"\",\n \"description\": \"\",\n \"vertical\": \"\",\n \"about\": \"\",\n \"email\": \"\",\n \"websites\": [\n \"\",\n \"\"\n ],\n \"profile_picture_handle\": \"4:VGVzdC5wbmc=:aW1hZ2UvanBlZw==:ARat4Mt-L09JON3f30SmDkdyPSuyBkDDYiB4TFXuXISjdgHoNp2b7j882_9Jzr2tPrdKxi92UygyVzTivJiOvmebMpZ6MIjTik3gTyI3ZCQAgQ:e:1659995302:2022308451254161:636685196:ARZf1ftR5N6-qSLtklU\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/whatsapp_business_profile", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "whatsapp_business_profile" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"business_profile\": {\n \"messaging_product\": \"whatsapp\",\n \"address\": \"\",\n \"description\": \"\",\n \"vertical\": \"\",\n \"about\": \"\",\n \"email\": \"\",\n \"websites\": [\n \"https://website-1\",\n \"https://website-2\"\n ],\n \"profile_picture_url\": \"https://pps.whatsapp.net/...\",\n \"id\": \"\"\n },\n \"id\": \"\"\n }\n ]\n}" } ] } ], "description": "To complete the following API calls, you need to get a business profile ID. To do that, make a **GET** call to the **`/{{Phone-Number-ID}}`** endpoint and add `business_profile` as a URL field. Within the **`business_profile`** request, you can specify what you want to know from your business.\n\n#### Reminders\n\n* To use this endpoint, you need to authenticate yourself with a system user access token with the **`whatsapp_business_management`** permission." }, { "name": "Commerce Settings", "item": [ { "name": "Get commerce settings", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/whatsapp_commerce_settings", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "whatsapp_commerce_settings" ] }, "description": "- Guide: [Sell Products & Services](https://developers.facebook.com/docs/whatsapp/cloud-api/guides/sell-products-and-services) (Cloud API)\n- Guide: [Sell Products & Services](https://developers.facebook.com/docs/whatsapp/on-premises/guides/commerce-guides) (On-Premises API)\n- Endpoint reference: [WhatsApp Business Phone Number > WhatsApp Commerce Settings](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/whatsapp_commerce_settings)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/whatsapp_commerce_settings", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "whatsapp_commerce_settings" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "\"be665e167cf848b6b62159f1d6828c494dc47008\"" }, { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "ATqienUCgZnGDTAHjSt_s1u" }, { "key": "x-fb-trace-id", "value": "BZ2vk4sqqeh" }, { "key": "x-fb-rev", "value": "1007268877" }, { "key": "X-FB-Debug", "value": "N/Bc7wjn7wzoGQzxpah+q29b3kn3Cu3Q5Vexydxna3Nq00SaWCkxw7wXuyFyLggvngmTAGNe60aQ2TTFzvT2hQ==" }, { "key": "Date", "value": "Fri, 07 Apr 2023 20:02:54 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "84" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"is_cart_enabled\": true,\n \"is_catalog_visible\": true,\n \"id\": \"527759822865714\"\n }\n ]\n}" } ] }, { "name": "Set or update commerce settings", "request": { "method": "POST", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/whatsapp_commerce_settings?is_cart_enabled=true&is_catalog_visible=true", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "whatsapp_commerce_settings" ], "query": [ { "key": "is_cart_enabled", "value": "true" }, { "key": "is_catalog_visible", "value": "true" } ] }, "description": "- Guide: [Sell Products & Services](https://developers.facebook.com/docs/whatsapp/cloud-api/guides/sell-products-and-services) (Cloud API)\n- Guide: [Sell Products & Services](https://developers.facebook.com/docs/whatsapp/on-premises/guides/commerce-guides) (On-Premises API)\n- Endpoint reference: [WhatsApp Business Phone Number > WhatsApp Commerce Settings](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/whatsapp_commerce_settings)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/whatsapp_commerce_settings?is_cart_enabled=false&is_catalog_visible=false", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "whatsapp_commerce_settings" ], "query": [ { "key": "is_cart_enabled", "value": "false" }, { "key": "is_catalog_visible", "value": "false" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "cross-origin-resource-policy", "value": "cross-origin" }, { "key": "x-app-usage", "value": "{\"call_count\":0,\"total_cputime\":0,\"total_time\":0}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "AB0EvD-U5WkosUqnPBMwXhB" }, { "key": "x-fb-trace-id", "value": "A5pEgwxfemZ" }, { "key": "x-fb-rev", "value": "1007268877" }, { "key": "X-FB-Debug", "value": "03bVIwTYJnh6qJe3sqWWNGapvvRoU/yKE+3nC45djcuaeV41y+6Z4SgWhK/SRB+WUUBEKWInR4hxFzHnKZ1+7Q==" }, { "key": "Date", "value": "Fri, 07 Apr 2023 20:01:14 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "16" } ], "cookie": [], "body": "{\n \"success\": true\n}" } ] } ], "description": "- Guide: [Sell Products & Services](https://developers.facebook.com/docs/whatsapp/cloud-api/guides/sell-products-and-services) (Cloud API)\n- Guide: [Sell Products & Services](https://developers.facebook.com/docs/whatsapp/on-premises/guides/commerce-guides) (On-Premises API)" }, { "name": "Payments API - SG", "item": [ { "name": "Send Order Details Message", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-WA-ID}}\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"order_details\",\n \"order_details\": {\n \"header\": {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"http(s)://the-url\",\n \"provider\": {\n \"name\": \"provider-name\"\n }\n }\n },\n \"body\": {\n \"text\": \"your-text-body-content\"\n },\n \"footer\": {\n \"text\": \"your-text-footer-content\"\n },\n \"action\": {\n \"reference_id\": \"unique-reference-id\",\n \"type\": \"digital-goods\",\n \"payment_type\": \"p2m-lite:stripe\",\n \"payment_configuration\": \"my-payment-config-name\",\n \"currency\": \"SGD\",\n \"total_amount\": {\n \"value\": 1000,\n \"offset\": 100\n },\n \"order\": {\n \"status\": \"pending\",\n \"items\": [\n {\n \"retailer_id\": \"1234567\",\n \"name\": \"bread\",\n \"amount\": {\n \"value\": 10000,\n \"offset\": 100\n },\n \"sale_amount\": {\n \"value\": 100,\n \"offset\": 100\n },\n \"quantity\": 1\n }\n ],\n \"subtotal\": {\n \"value\": 20000,\n \"offset\": 100\n },\n \"tax\": {\n \"value\": 1000,\n \"offset\": 100,\n \"description\": \"optional_text\"\n }, \n \"shipping\": {\n \"value\": 1000,\n \"offset\": 100,\n \"description\": \"optional_text\"\n },\n \"discount\": {\n \"value\": 1000,\n \"offset\": 100,\n \"description\": \"optional_text\",\n \"discount_program_name\": \"optional_text\"\n },\n \"catalog_id\": \"optional-catalog_id\",\n \"expiration\": {\n \"timestamp\": \"utc_timestamp_in_seconds\",\n \"description\": \"cancellation-explanation\"\n }\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "Guide: [Payments API - SG](https://developers.facebook.com/docs/whatsapp/cloud-api/payments-api/payments-sg)" }, "response": [ { "name": "Send Order Details Message", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-WA-ID}}\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"order_details\",\n \"order_details\": {\n \"header\": {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"http(s)://the-url\",\n \"provider\": {\n \"name\": \"provider-name\"\n }\n }\n },\n \"body\": {\n \"text\": \"your-text-body-content\"\n },\n \"footer\": {\n \"text\": \"your-text-footer-content\"\n },\n \"action\": {\n \"reference_id\": \"unique-reference-id\",\n \"type\": \"digital-goods\",\n \"payment_type\": \"p2m-lite:stripe\",\n \"payment_configuration\": \"my-payment-config-name\",\n \"currency\": \"SGD\",\n \"total_amount\": {\n \"value\": 1000,\n \"offset\": 100\n },\n \"order\": {\n \"status\": \"pending\",\n \"items\": [\n {\n \"retailer_id\": \"1234567\",\n \"name\": \"bread\",\n \"amount\": {\n \"value\": 10000,\n \"offset\": 100\n },\n \"sale_amount\": {\n \"value\": 100,\n \"offset\": 100\n },\n \"quantity\": 1\n }\n ],\n \"subtotal\": {\n \"value\": 20000,\n \"offset\": 100\n },\n \"tax\": {\n \"value\": 1000,\n \"offset\": 100,\n \"description\": \"optional_text\"\n }, \n \"shipping\": {\n \"value\": 1000,\n \"offset\": 100,\n \"description\": \"optional_text\"\n },\n \"discount\": {\n \"value\": 1000,\n \"offset\": 100,\n \"description\": \"optional_text\",\n \"discount_program_name\": \"optional_text\"\n },\n \"catalog_id\": \"optional-catalog_id\",\n \"expiration\": {\n \"timestamp\": \"utc_timestamp_in_seconds\",\n \"description\": \"cancellation-explanation\"\n }\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"+1-631-555-5555\",\n \"wa_id\": \"16315555555\"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGFlaCGg0xcvAdgmZ9plHrf2Mh-o\"\n }\n ]\n}" } ] }, { "name": "Send Order Status Message", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-WA-ID}}\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"order_status\",\n \"body\": {\n \"text\": \"your-text-body-content\"\n },\n \"action\": {\n \"name\": \"review_order\",\n \"parameters\": {\n \"reference_id\": \"unique-reference-id-from-order-details-msg\",\n \"order\": {\n \"status\": \"processing\",\n \"description\": \"optional-text\"\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "Guide: [Payments API - SG](https://developers.facebook.com/docs/whatsapp/cloud-api/payments-api/payments-sg)" }, "response": [ { "name": "Send Order Status Message", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" }, { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-WA-ID}}\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"order_status\",\n \"body\": {\n \"text\": \"your-text-body-content\"\n },\n \"action\": {\n \"name\": \"review_order\",\n \"parameters\": {\n \"reference_id\": \"same-reference-id-from-order-details-msg\",\n \"order\": {\n \"status\": \"processing\",\n \"description\": \"optional-text\"\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"+1-631-555-5555\",\n \"wa_id\": \"16315555555\"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGFlaCGg0xcvAdgmZ9plHrf2Mh-o\"\n }\n ]\n}" } ] } ], "description": "Guide: [Payments API - SG](https://developers.facebook.com/docs/whatsapp/cloud-api/payments-api/payments-sg)" }, { "name": "Payments API - IN", "item": [ { "name": "Send Order Details Message", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-WA-Phone-Number}}\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"order_details\",\n \"header\": {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/3/3b/Home_made_sour_dough_bread.jpg/640px-Home_made_sour_dough_bread.jpg\"\n }\n },\n \"body\": {\n \"text\": \"your-text-body-content\"\n },\n \"footer\": {\n \"text\": \"your-text-footer-content\"\n },\n \"action\": {\n \"name\": \"review_and_pay\",\n \"parameters\": {\n \"reference_id\": \"unique-reference-id\",\n \"type\": \"digital-goods\",\n \"payment_type\": \"upi\",\n \"payment_configuration\": \"my-payment-config-name\",\n \"currency\": \"INR\",\n \"total_amount\": {\n \"value\": 1100,\n \"offset\": 100\n },\n \"order\": {\n \"status\": \"pending\",\n \"items\": [\n {\n \"retailer_id\": \"1234567\",\n \"name\": \"bread\",\n \"amount\": {\n \"value\": 1500,\n \"offset\": 100\n },\n \"sale_amount\": {\n \"value\": 1000,\n \"offset\": 100\n },\n \"quantity\": 1\n }\n ],\n \"subtotal\": {\n \"value\": 1000,\n \"offset\": 100\n },\n \"tax\": {\n \"value\": 100,\n \"offset\": 100,\n \"description\": \"optional_text\"\n },\n \"shipping\": {\n \"value\": 100,\n \"offset\": 100,\n \"description\": \"optional_text\"\n },\n \"discount\": {\n \"value\": 100,\n \"offset\": 100,\n \"description\": \"optional_text\",\n \"discount_program_name\": \"optional_text\"\n }\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "**These APIs are in beta. Please reach out to Meta Business Engineering teams with your WABA ID to gain access.**\n\nGuide: [Payments API - IN](https://developers.facebook.com/docs/whatsapp/cloud-api/payments-api/payments-in)" }, "response": [ { "name": "Send Order Details Message", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-WA-Phone-Number}}\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"order_details\",\n \"header\": {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/3/3b/Home_made_sour_dough_bread.jpg/640px-Home_made_sour_dough_bread.jpg\"\n }\n },\n \"body\": {\n \"text\": \"your-text-body-content\"\n },\n \"footer\": {\n \"text\": \"your-text-footer-content\"\n },\n \"action\": {\n \"name\": \"review_and_pay\",\n \"parameters\": {\n \"reference_id\": \"unique-reference-id\",\n \"type\": \"digital-goods\",\n \"payment_type\": \"upi\",\n \"payment_configuration\": \"my-payment-config-name\",\n \"currency\": \"INR\",\n \"total_amount\": {\n \"value\": 1100,\n \"offset\": 100\n },\n \"order\": {\n \"status\": \"pending\",\n \"items\": [\n {\n \"retailer_id\": \"1234567\",\n \"name\": \"bread\",\n \"amount\": {\n \"value\": 1500,\n \"offset\": 100\n },\n \"sale_amount\": {\n \"value\": 1000,\n \"offset\": 100\n },\n \"quantity\": 1\n }\n ],\n \"subtotal\": {\n \"value\": 1000,\n \"offset\": 100\n },\n \"tax\": {\n \"value\": 100,\n \"offset\": 100,\n \"description\": \"optional_text\"\n },\n \"shipping\": {\n \"value\": 100,\n \"offset\": 100,\n \"description\": \"optional_text\"\n },\n \"discount\": {\n \"value\": 100,\n \"offset\": 100,\n \"description\": \"optional_text\",\n \"discount_program_name\": \"optional_text\"\n }\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"+1-631-555-5555\",\n \"wa_id\": \"16315555555\"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGFlaCGg0xcvAdgmZ9plHrf2Mh-o\"\n }\n ]\n}" } ] }, { "name": "Send Order Status Message", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-WA-Phone-Number}}\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"order_status\",\n \"body\": {\n \"text\": \"your-text-body-content\"\n },\n \"action\": {\n \"name\": \"review_order\",\n \"parameters\": {\n \"reference_id\": \"unique-reference-id\",\n \"order\": {\n \"status\": \"processing\",\n \"description\": \"optional-text\"\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "**These APIs are in beta. Please reach out to Meta Business Engineering teams with your WABA ID to gain access.**\n\nGuide: [Payments API - IN](https://developers.facebook.com/docs/whatsapp/cloud-api/payments-api/payments-in)" }, "response": [ { "name": "Send Order Status Message", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"{{Recipient-WA-Phone-Number}}\",\n \"type\": \"interactive\",\n \"interactive\": {\n \"type\": \"order_status\",\n \"body\": {\n \"text\": \"your-text-body-content\"\n },\n \"action\": {\n \"name\": \"review_order\",\n \"parameters\": {\n \"reference_id\": \"unique-reference-id-from-order-details-msg\",\n \"order\": {\n \"status\": \"processing\",\n \"description\": \"optional-text\"\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"+1-631-555-5555\",\n \"wa_id\": \"16315555555\"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGFlaCGg0xcvAdgmZ9plHrf2Mh-o\"\n }\n ]\n}" } ] } ], "description": "**These APIs are in beta. Please reach out to Meta Business Engineering teams with your WABA ID to gain access.**\n\nGuide: [Payments API - IN](https://developers.facebook.com/docs/whatsapp/cloud-api/payments-api/payments-in)" }, { "name": "QR codes", "item": [ { "name": "Get QR code", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/message_qrdls/", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "message_qrdls", "" ] }, "description": "- Guide: [QR Codes](https://developers.facebook.com/docs/whatsapp/business-management-api/qr-codes)\n- Endpoint reference: [WhatsApp Business Phone Number > Message Qrdls](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/message_qrdls/)" }, "response": [ { "name": "Example Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/message_qrdls/ANED2T5QRU7HG1", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "message_qrdls", "ANED2T5QRU7HG1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "\"eb11a43a8f1e633acc57540de90158ed9ede1eb6\"" }, { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v17.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "AI30jPlFHq76adVh0j6NI6M" }, { "key": "x-fb-trace-id", "value": "Ckwb7R007I8" }, { "key": "x-fb-rev", "value": "1007849776" }, { "key": "X-FB-Debug", "value": "xwYqFVM/CgvMFBdr72b1SoodwzNgzEfQ9SDpiIPeb3wE0n/sie2xgK6jFXjwpEQROxdgbLqDvJdWTH20Xbwu4Q==" }, { "key": "Date", "value": "Mon, 17 Jul 2023 17:31:52 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "145" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"code\": \"ANED2T5QRU7HG1\",\n \"prefilled_message\": \"Show me Cyber Monday deals!\",\n \"deep_link_url\": \"https://wa.me/message/ANED2T5QRU7HG1\"\n }\n ]\n}" } ] }, { "name": "Get all QR codes (default fields)", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/message_qrdls", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "message_qrdls" ] }, "description": "- Guide: [QR Codes](https://developers.facebook.com/docs/whatsapp/business-management-api/qr-codes)\n- Endpoint reference: [WhatsApp Business Phone Number > Message Qrdls](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/message_qrdls/)" }, "response": [ { "name": "Example Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/message_qrdls", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "message_qrdls" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Encoding", "value": "br" }, { "key": "ETag", "value": "\"87b838b487862bbd93840a39909a27424a1e8f31\"" }, { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v17.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "ApTtyoBD0N_UK-CnCHdfKhC" }, { "key": "x-fb-trace-id", "value": "C6BI7RgADgF" }, { "key": "x-fb-rev", "value": "1007849776" }, { "key": "X-FB-Debug", "value": "jYPjPwQxjEjunci3gPMbyYk1E92KQBB4ySVOiXjgqbAwghc5jpY5g9DOQT5WN5JkztCQc9zv2Orxf+WZJHyEJw==" }, { "key": "Date", "value": "Mon, 17 Jul 2023 17:30:25 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "247" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"code\": \"5QBPAD2DC6L5A1\",\n \"prefilled_message\": \"Show me Cyber Tuesday deals!\",\n \"deep_link_url\": \"https://wa.me/message/5QBPAD2DC6L5A1\"\n },\n {\n \"code\": \"ANED2T5QRU7HG1\",\n \"prefilled_message\": \"Show me Cyber Monday deals!\",\n \"deep_link_url\": \"https://wa.me/message/ANED2T5QRU7HG1\"\n },\n {\n \"code\": \"WOMVT6TJ2BP7A1\",\n \"prefilled_message\": \"Tell me more about your production workshop\",\n \"deep_link_url\": \"https://wa.me/message/WOMVT6TJ2BP7A1\"\n }\n ]\n}" } ] }, { "name": "Get all QR codes (specific fields)", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/message_qrdls?fields=code,prefilled_message,qr_image_url.format(SVG)", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "message_qrdls" ], "query": [ { "key": "fields", "value": "code,prefilled_message,qr_image_url.format(SVG)", "description": ".format can be SVG or PNG" } ] }, "description": "- Guide: [QR Codes](https://developers.facebook.com/docs/whatsapp/business-management-api/qr-codes)\n- Endpoint reference: [WhatsApp Business Phone Number > Message Qrdls](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/message_qrdls/)" }, "response": [ { "name": "Example Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/message_qrdls?fields=code,prefilled_message,qr_image_url.format(SVG)", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "message_qrdls" ], "query": [ { "key": "fields", "value": "code,prefilled_message,qr_image_url.format(SVG)", "description": ".format can be SVG or PNG" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Encoding", "value": "br" }, { "key": "ETag", "value": "\"84d2588d672322f90621f50c9cd8a3b23e089a14\"" }, { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v17.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "AJKapmjTPh6pdfa788IJdi0" }, { "key": "x-fb-trace-id", "value": "Es9NJJI/zlf" }, { "key": "x-fb-rev", "value": "1007848995" }, { "key": "X-FB-Debug", "value": "9AMjB0CoJKzCX5kSQf4RODPU2InGnibVJeqo4go1GBn6JToViVnC1f8+dpozejxHbzXcaO1Mx1r/tW7GWNAKAg==" }, { "key": "Date", "value": "Mon, 17 Jul 2023 17:32:57 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "1062" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"code\": \"5QBPAD2DC6L5A1\",\n \"prefilled_message\": \"Show me Cyber Tuesday deals!\",\n \"qr_image_url\": \"https://scontent-iad3-2.xx.fbcdn.net/m1/v/t6/An_CaBAHoMypun-kUZsZ88eIZjmnyD0deR9jzkE0BAIjUN_irRtfWqrwFo1fj6uZCbVss_DmlCPf121K_Ik8k-r-Mc9tEaWnD2nNX4YcrVPXW97-EtSR4ISGmaYNjNg0s5n08DtkYwh5?ccb=10-5&oh=00_AfCr-w29t9Qfe66xM5H9dJu2SKKBVJmXfC2WatMB_m1FNQ&oe=64DCF088&_nc_sid=5a413f\"\n },\n {\n \"code\": \"ANED2T5QRU7HG1\",\n \"prefilled_message\": \"Show me Cyber Monday deals!\",\n \"qr_image_url\": \"https://scontent-iad3-2.xx.fbcdn.net/m1/v/t6/An-psFmLBls2NFXnhhkSVqwIHEqCTQoNKTLxxlOeci0Wbsukd2RLiwZalHrXwqT5RTFSzOhyw6OLvJJO0itaQtJI1BS2WkNcV67wR3GNx7ZX1tFSNCbpo1e6KPptKF1GbVGzmUfkgSPX?ccb=10-5&oh=00_AfD8UP3gI1a7r0swztpJJ9zcIoVDwX1m888-f-9MPMVTFA&oe=64DD0736&_nc_sid=5a413f\"\n },\n {\n \"code\": \"WOMVT6TJ2BP7A1\",\n \"prefilled_message\": \"Tell me more about your production workshop\",\n \"qr_image_url\": \"https://scontent-iad3-2.xx.fbcdn.net/m1/v/t6/An9kdIj-mOc6-m33Q103wyA8zeTsGizIhQ1Xg-rVaKzSIUUnz2azOlTNj2bjqhzomkdvN92Hz2yp4kgWrWhgUBFlT5aHLpc7mB9fu8MlD1QIxnQNE0Oby2L1yBO2TGmQy7i-wjhk_NwC?ccb=10-5&oh=00_AfAyxB3EVjmtOmnuizSVDTmr78SNAxxCJqn7MVEgkZ5dUQ&oe=64DCF966&_nc_sid=5a413f\"\n }\n ]\n}" } ] }, { "name": "Get QR code SVG image URL", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/message_qrdls?fields=prefilled_message,deep_link_url,qr_image_url.format(SVG)&code=", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "message_qrdls" ], "query": [ { "key": "fields", "value": "prefilled_message,deep_link_url,qr_image_url.format(SVG)" }, { "key": "code", "value": "" } ] }, "description": "- Guide: [QR Codes](https://developers.facebook.com/docs/whatsapp/business-management-api/qr-codes)\n- Endpoint reference: [WhatsApp Business Phone Number > Message Qrdls](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/message_qrdls/)" }, "response": [ { "name": "Example Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/message_qrdls?fields=prefilled_message,deep_link_url,qr_image_url.format(SVG)&code=FO7JXE4BG3RFG1", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "message_qrdls" ], "query": [ { "key": "fields", "value": "prefilled_message,deep_link_url,qr_image_url.format(SVG)" }, { "key": "code", "value": "FO7JXE4BG3RFG1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Encoding", "value": "br" }, { "key": "ETag", "value": "\"6bb9bb199ae09827badab937f0098a769c5300a5\"" }, { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "AhEUORFmwVBVr8wWHAPEvJ_" }, { "key": "x-fb-trace-id", "value": "GpMs++NzaER" }, { "key": "x-fb-rev", "value": "1007250199" }, { "key": "X-FB-Debug", "value": "MGgEGMCHCz1WPNrThsZE/2TgpMdMzkbtnKHBbAKLcZdmCdcxFdIbYzoy3PBZ84G9cGCfAML2vBfDArqzT1dRzw==" }, { "key": "Date", "value": "Wed, 05 Apr 2023 17:13:43 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "354" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"prefilled_message\": \"Tell me more about your event planning packages\",\n \"deep_link_url\": \"https://wa.me/message/FO7JXE4BG3RFG1\",\n \"qr_image_url\": \"https://scontent-iad3-1.xx.fbcdn.net/m1/v/t6/An_tlxnbh51qOQehAUw8o0lv9rIJm0PwPYsk4HCQkovoSsA_FT8WA56FVpe-lzURBxjngRUxWsHyMzvFb35K6DVrJGNqTsuWvjgL7G8K2SmHDsnnBiWqqm3GPmXlLWs9Ct_ok4tQM3YR?ccb=10-5&oh=00_AfBNcOAJ7gT1uXGqBfZFOv-wppQjBZFJAOJU59Ybe-V4sQ&oe=6455097A&_nc_sid=f36290\"\n }\n ]\n}" } ] }, { "name": "Get QR code PNG image URL", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/message_qrdls?fields=prefilled_message,deep_link_url,qr_image_url.format(PNG)&code=", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "message_qrdls" ], "query": [ { "key": "fields", "value": "prefilled_message,deep_link_url,qr_image_url.format(PNG)" }, { "key": "code", "value": "" } ] }, "description": "- Guide: [QR Codes](https://developers.facebook.com/docs/whatsapp/business-management-api/qr-codes)\n- Endpoint reference: [WhatsApp Business Phone Number > Message Qrdls](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/message_qrdls/)" }, "response": [ { "name": "Example Response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/message_qrdls?fields=prefilled_message,deep_link_url,qr_image_url.format(PNG)&code=FO7JXE4BG3RFG1", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "message_qrdls" ], "query": [ { "key": "fields", "value": "prefilled_message,deep_link_url,qr_image_url.format(PNG)" }, { "key": "code", "value": "FO7JXE4BG3RFG1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Encoding", "value": "br" }, { "key": "ETag", "value": "\"9f26cc417d27b958c462b202a8d4aa4f1e6d9f20\"" }, { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "ARQVLBnydt3HxForUiKGvlR" }, { "key": "x-fb-trace-id", "value": "E2gR87OM4ab" }, { "key": "x-fb-rev", "value": "1007250199" }, { "key": "X-FB-Debug", "value": "Zey14boRCKNY0lC6Q0kFbQP8pdJgrQl4cwbJpCkJx29aYh0OZO1+ieLkNzbKRMDOQr4dbrCXufjpV1fYe8w+fA==" }, { "key": "Date", "value": "Wed, 05 Apr 2023 17:19:14 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "354" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"prefilled_message\": \"Tell me more about your event planning packages\",\n \"deep_link_url\": \"https://wa.me/message/FO7JXE4BG3RFG1\",\n \"qr_image_url\": \"https://scontent-iad3-1.xx.fbcdn.net/m1/v/t6/An-H7T8OyTqO07lcRGHlKteuPMKDnx07nua3dGb4i560bVxDscweOV4KoKD_4wCDFoHR_C5LyVjxQISKPxwora1bbFhUEo2nA19ZPLBUVoQSmV12l1x-nuu312jKty-5rmojmde_a0g?ccb=10-5&oh=00_AfASq_vjojFza_9A-HDeRgHM3wZ8yjNprpYBjNKOn8RkSg&oe=64550A9E&_nc_sid=f36290\"\n }\n ]\n}" } ] }, { "name": "Create QR code", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"prefilled_message\": \"\",\n \"generate_qr_image\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/message_qrdls", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "message_qrdls" ] }, "description": "- Guide: [QR Codes](https://developers.facebook.com/docs/whatsapp/business-management-api/qr-codes)\n- Endpoint reference: [WhatsApp Business Phone Number > Message Qrdls](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/message_qrdls/)" }, "response": [ { "name": "Example Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"prefilled_message\": \"Show me Cyber Monday deals!\",\n \"generate_qr_image\": \"SVG\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/message_qrdls", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "message_qrdls" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Encoding", "value": "br" }, { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "cross-origin-resource-policy", "value": "cross-origin" }, { "key": "x-app-usage", "value": "{\"call_count\":2,\"total_cputime\":0,\"total_time\":4}" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v17.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "AmoOQGTJFcmUuZO8YUS3OKd" }, { "key": "x-fb-trace-id", "value": "EItwrXJiz+3" }, { "key": "x-fb-rev", "value": "1007848995" }, { "key": "X-FB-Debug", "value": "Ksgfum34ZCdBYgGDNUidde6xFR+1D4pD7Vr6IQji0TjOJT5QejgxGt7iyBbo0fEdKNZXB0QdimJ3Qv4mkvKyLw==" }, { "key": "Date", "value": "Mon, 17 Jul 2023 17:27:29 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "347" } ], "cookie": [], "body": "{\n \"code\": \"ANED2T5QRU7HG1\",\n \"prefilled_message\": \"Show me Cyber Monday deals!\",\n \"deep_link_url\": \"https://wa.me/message/ANED2T5QRU7HG1\",\n \"qr_image_url\": \"https://scontent-iad3-2.xx.fbcdn.net/m1/v/t6/An-psFmLBls2NFXnhhkSVqwIHEqCTQoNKTLxxlOeci0Wbsukd2RLiwZalHrXwqT5RTFSzOhyw6OLvJJO0itaQtJI1BS2WkNcV67wR3GNx7ZX1tFSNCbpo1e6KPptKF1GbVGzmUfkgSPX?ccb=10-5&oh=00_AfAOAr6oRA2OKV_Ur3GUh4em57sACxUkfhXHsObiFrxOsA&oe=64DCCEF6&_nc_sid=5a413f\"\n}" } ] }, { "name": "Update Message QR Code.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"prefilled_message\": \"\",\n \"code\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/message_qrdls", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "message_qrdls" ] }, "description": "- Guide: [QR Codes](https://developers.facebook.com/docs/whatsapp/business-management-api/qr-codes)\n- Endpoint reference: [WhatsApp Business Phone Number > Message Qrdls](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/message_qrdls/)" }, "response": [ { "name": "Example Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"prefilled_message\": \"Tell me about your new workshops\",\n \"code\": \"WOMVT6TJ2BP7A1\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/message_qrdls", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "message_qrdls" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "cross-origin-resource-policy", "value": "cross-origin" }, { "key": "x-app-usage", "value": "{\"call_count\":2,\"total_cputime\":0,\"total_time\":7}" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v17.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "ANM3JhD_nX6mId4j7RIjBgX" }, { "key": "x-fb-trace-id", "value": "HFFijzWIcMZ" }, { "key": "x-fb-rev", "value": "1007849776" }, { "key": "X-FB-Debug", "value": "zLJyZblKlLxBMqXnKHoVQeJglRBHI6oY7Pk8haMG9WkE3IVZVe5bv1wlXzAulmmkiwgzz3RFT/ds12C/i6y8Gg==" }, { "key": "Date", "value": "Mon, 17 Jul 2023 17:36:41 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "139" } ], "cookie": [], "body": "{\n \"code\": \"WOMVT6TJ2BP7A1\",\n \"prefilled_message\": \"Tell me about your new workshops\",\n \"deep_link_url\": \"https://wa.me/message/WOMVT6TJ2BP7A1\"\n}" } ] }, { "name": "Delete QR code", "request": { "method": "DELETE", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/message_qrdls/", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "message_qrdls", "" ] }, "description": "- Guide: [QR Codes](https://developers.facebook.com/docs/whatsapp/business-management-api/qr-codes)\n- Endpoint reference: [WhatsApp Business Phone Number > Message Qrdls](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/message_qrdls/)" }, "response": [ { "name": "Example Response", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/message_qrdls/AWHPX5O6XYVUM1", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "message_qrdls", "AWHPX5O6XYVUM1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "cross-origin-resource-policy", "value": "cross-origin" }, { "key": "x-app-usage", "value": "{\"call_count\":0,\"total_cputime\":0,\"total_time\":0}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "AhAUBojpK310cV-2jph-xzV" }, { "key": "x-fb-trace-id", "value": "AUimp6F3rsO" }, { "key": "x-fb-rev", "value": "1007250199" }, { "key": "X-FB-Debug", "value": "7f+8MRyeBctLPWkPXoiwsf5fFghwJJ+g6XLnjpZpiF68Srv60WTH2pbvbeuJPhLWMqlzCWulba1OhzJPls4pUA==" }, { "key": "Date", "value": "Wed, 05 Apr 2023 18:18:08 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "16" } ], "cookie": [], "body": "{\n \"success\": true\n}" } ] } ], "description": "- Guide: [QR Codes](https://developers.facebook.com/docs/whatsapp/business-management-api/qr-codes)", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Business Portfolio", "item": [ { "name": "Get Business Portfolio (Specific Fields)", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Business-ID}}?fields=id,name,timezone_id", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Business-ID}}" ], "query": [ { "key": "fields", "value": "id,name,timezone_id" } ] }, "description": "Endpoint reference: [Business](https://developers.facebook.com/docs/marketing-api/reference/business/)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Business-ID}}?fields=id,name,timezone_id", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Business-ID}}" ], "query": [ { "key": "fields", "value": "id,name,timezone_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "\"e9b6e9b51bf22b6dc50325d79593daee64a9438e\"" }, { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "cross-origin-resource-policy", "value": "cross-origin" }, { "key": "x-app-usage", "value": "{\"call_count\":0,\"total_cputime\":0,\"total_time\":0}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "ASXeY7n8KxE4s2WPsejsx5T" }, { "key": "x-fb-trace-id", "value": "BpUU8ro+Qyc" }, { "key": "x-fb-rev", "value": "1007266633" }, { "key": "X-FB-Debug", "value": "sXZ8RdzMc/GncoPer8191i4EFUEuQglfsee5vTMgumeA8DW0ab23QsdikhTpEoo+1UXoQXkvr7fOAv5/EC6nIA==" }, { "key": "Date", "value": "Fri, 07 Apr 2023 04:40:39 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "65" } ], "cookie": [], "body": "{\n \"id\": \"506914307656634\",\n \"name\": \"Lucky Shrub\",\n \"timezone_id\": 0\n}" } ] } ] }, { "name": "Analytics", "item": [ { "name": "Get analytics", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}?fields=analytics.start(1680503760).end(1680564980).granularity(DAY).phone_numbers([]).country_codes([\"US\", \"BR\"])", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}" ], "query": [ { "key": "fields", "value": "analytics.start(1680503760).end(1680564980).granularity(DAY).phone_numbers([]).country_codes([\"US\", \"BR\"])" } ] }, "description": "- Guide: [Analytics](https://developers.facebook.com/docs/whatsapp/business-management-api/analytics)\n- Endpoint reference: [WhatsApp Business Account > Analytics](https://developers.facebook.com/docs/graph-api/reference/waba-analytics/)" }, "response": [ { "name": "Example reponse", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}?fields=analytics.start(1543543200).end(1544148000).granularity(DAY).phone_numbers([]).country_codes([\"US\", \"BR\"])", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}" ], "query": [ { "key": "fields", "value": "analytics.start(1543543200).end(1544148000).granularity(DAY).phone_numbers([]).country_codes([\"US\", \"BR\"])" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"analytics\": {\n \"phone_numbers\": [\n \"16505550111\",\n \"16505550112\",\n \"16505550113\"\n ],\n \"country_codes\": [\n \"US\",\n \"BR\"\n ],\n \"granularity\": \"DAY\",\n \"data_points\": [\n {\n \"start\": 1543543200,\n \"end\": 1543629600,\n \"sent\": 196093,\n \"delivered\": 179715\n },\n {\n \"start\": 1543629600,\n \"end\": 1543716000,\n \"sent\": 147649,\n \"delivered\": 139032\n },\n {\n \"start\": 1543716000,\n \"end\": 1543802400,\n \"sent\": 61988,\n \"delivered\": 58830\n },\n {\n \"start\": 1543802400,\n \"end\": 1543888800,\n \"sent\": 132465,\n \"delivered\": 124392\n },\n {\n \"start\": 1543888800,\n \"end\": 1543975200,\n \"sent\": 181002,\n \"delivered\": 167335\n },\n {\n \"start\": 1543975200,\n \"end\": 1544061600,\n \"sent\": 168687,\n \"delivered\": 157838\n },\n {\n \"start\": 1544061600,\n \"end\": 1544148000,\n \"sent\": 161832,\n \"delivered\": 152383\n }\n ]\n },\n \"id\": \"952305634918047\"\n}" } ] }, { "name": "Get conversation analytics", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}?fields=conversation_analytics.start(1656661480).end(1674859480).granularity(MONTHLY).conversation_directions([\"business_initiated\"]).dimensions([\"conversation_type\", \"conversation_direction\"])", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}" ], "query": [ { "key": "fields", "value": "conversation_analytics.start(1656661480).end(1674859480).granularity(MONTHLY).conversation_directions([\"business_initiated\"]).dimensions([\"conversation_type\", \"conversation_direction\"])" } ] }, "description": "- Guide: [Analytics](https://developers.facebook.com/docs/whatsapp/business-management-api/analytics)\n- Endpoint reference: [WhatsApp Business Account > Analytics](https://developers.facebook.com/docs/graph-api/reference/waba-analytics/)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{WABA-ID}}?fields=analytics.start(1543543200).end(1544148000).granularity(DAY).phone_numbers([]).country_codes([\"US\", \"BR\"])", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{WABA-ID}}" ], "query": [ { "key": "fields", "value": "analytics.start(1543543200).end(1544148000).granularity(DAY).phone_numbers([]).country_codes([\"US\", \"BR\"])" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"analytics\": {\n \"phone_numbers\": [\n \"16505550111\",\n \"16505550112\",\n \"16505550113\"\n ],\n \"country_codes\": [\n \"US\",\n \"BR\"\n ],\n \"granularity\": \"DAY\",\n \"data_points\": [\n {\n \"start\": 1543543200,\n \"end\": 1543629600,\n \"sent\": 196093,\n \"delivered\": 179715\n },\n {\n \"start\": 1543629600,\n \"end\": 1543716000,\n \"sent\": 147649,\n \"delivered\": 139032\n },\n {\n \"start\": 1543716000,\n \"end\": 1543802400,\n \"sent\": 61988,\n \"delivered\": 58830\n },\n {\n \"start\": 1543802400,\n \"end\": 1543888800,\n \"sent\": 132465,\n \"delivered\": 124392\n },\n {\n \"start\": 1543888800,\n \"end\": 1543975200,\n \"sent\": 181002,\n \"delivered\": 167335\n },\n {\n \"start\": 1543975200,\n \"end\": 1544061600,\n \"sent\": 168687,\n \"delivered\": 157838\n },\n {\n \"start\": 1544061600,\n \"end\": 1544148000,\n \"sent\": 161832,\n \"delivered\": 152383\n }\n ]\n },\n \"id\": \"952305634918047\"\n}" } ] } ], "description": "- Guide: [Analytics](https://developers.facebook.com/docs/whatsapp/business-management-api/analytics)", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Billing", "item": [ { "name": "Get credit lines", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Business-ID}}/extendedcredits", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Business-ID}}", "extendedcredits" ] }, "description": "- Endpoint reference: [Business > Extendedcredits](https://developers.facebook.com/docs/marketing-api/reference/extended-credit/)" }, "response": [ { "name": "Example response", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}" } ], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Business-ID}}/extendedcredits?fields=id,legal_entity_name", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Business-ID}}", "extendedcredits" ], "query": [ { "key": "fields", "value": "id,legal_entity_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "Text", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"1972385232742146\", \n \"legal_entity_name\": \"Lucky Shrub\"\n }\n ]\n}\n" } ] } ], "description": "- Help Center Article: [About billing for your WhatsApp Business Account](https://www.facebook.com/business/help/2225184664363779)" }, { "name": "OnPrem Account Migration", "item": [ { "name": "Migrate Account", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"pin\": \"6-digit-pin\",\n \"backup\": {\n \"data\": \"backup_data\",\n \"password\": \"password\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/register", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "register" ] }, "description": "To migrate your account, make a **POST** call to the **`/{{Phone-Number-ID}}/register`** endpoint and include the parameters listed below. \n\nYour request may take as long as 15 seconds to finish. During this period, your on-premise deployment is automatically disconnected from WhatsApp server and shutdown; the business account will start up in the cloud-hosted service at the same time. After the request finishes successfully, you can send messages immediately.\n\n## Request Parameters\n| Name | Description |\n|-----------------------|---------------------------|\n|**`messaging_product`**| **Required**.
          Messaging service used for the request. For account migration, always use `\"whatsapp\"`. \n| **`pin`** |**Required**.
          A 6-digit pin you have previously set up — See [Set Two-Step Verification](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/two-step-verification) If you use the wrong pin, your on-premise deployment will be down and will be disconnected from the WhatsApp servers.
          If you haven't set up or you have disabled two-step verification, provide a random 6-digit pin in the request, and this will be used to enable two-step verification in the WhatsApp Business Cloud-Based API. |\n|**`backup.data`** | **Required**.
          The data value you get when you backup your on-premise deployment. This contains the account registration info and application settings.
          For more information, see [Backup and Restore](https://developers.facebook.com/docs/whatsapp/api/settings/backup-and-restore) to backup your on-premise implementation. |\n|**`backup.password`** | **Required**.
          The password you used in the backup API of your On-Premise deployment.|" }, "response": [ { "name": "Migrate Account", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"pin\": \"123678\",\n \"backup\": {\n \"data\": \"BACKUP_DATA\",\n \"password\": \"P455w0rd##\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/register", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "register" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"success\": \"true\"\n}" } ] } ], "description": "Use the **`/{{Phone-Number-ID}}/register`** endpoint to migrate your WhatsApp Business Accounts from your current on-premise deployment to the new Cloud-Based API. \n\n#### Reminders\n\n* To use this endpoint, you need to authenticate yourself with a system user access token with the **`whatsapp_business_management`** permission.\n\n* If you need to find your phone number ID, see [Get Phone Number ID](#c72d9c17-554d-4ae1-8f9e-b28a94010b28)." }, { "name": "Block Users", "item": [ { "name": "Get blocked users", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/block_users", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "block_users" ] }, "description": "- Guide: [Block Users](https://developers.facebook.com/docs/whatsapp/cloud-api/block-users)\n \n- Endpoint reference: [GET WhatsApp Buiness Phone Number > block_users](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/block_users/#Reading)" }, "response": [ { "name": "Get blocked users", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/block_users", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "block_users" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Encoding", "value": "br" }, { "key": "ETag", "value": "\"479d4d6b1605dd222ded4e7fb450229b1d19dbc6\"" }, { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0},{\"type\":\"whatsapp\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v22.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "AGaOBl2yM-g8gdON-dhzl5y" }, { "key": "x-fb-trace-id", "value": "E7riEe9OW2e" }, { "key": "x-fb-rev", "value": "1019544279" }, { "key": "X-FB-Debug", "value": "52zkUgodnaVRhbBE+3RiGz6TnmjmDEGunwYd+vKSc4synE+Xii//dy6twB/7yKgOJiMUuV0OF248UAZ1qL3v0A==" }, { "key": "Date", "value": "Fri, 24 Jan 2025 00:48:41 GMT" }, { "key": "X-FB-Connection-Quality", "value": "EXCELLENT; q=0.9, rtt=7, rtx=0, c=10, mss=1380, tbw=372, tp=-1, tpl=-1, uplat=527, ullat=0" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "155" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"messaging_product\": \"whatsapp\",\n \"wa_id\": \"16505551234\"\n }\n ],\n \"paging\": {\n \"cursors\": {\n \"before\": \"eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3Mzc2Nzk2ODgzODM1ODQifQZDZD\",\n \"after\": \"eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3Mzc2Nzk2ODgzODM1ODQifQZDZD\"\n }\n }\n}" } ] }, { "name": "Block user(s)", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"block_users\": [\n {\n \"user\": \"{{Recipient-Phone-Number}}\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/block_users", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "block_users" ] }, "description": "- Guide: [Block Users](https://developers.facebook.com/docs/whatsapp/cloud-api/block-users)\n \n- Endpoint reference: [POST WhatsApp Buiness Phone Number > block_users](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/block_users/#Creating)" }, "response": [ { "name": "Block user(s)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"block_users\": [\n {\n \"user\": \"+16505551234\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/block_users", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "block_users" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v22.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "Amfmei-TxXlu3XDYNpXGNul" }, { "key": "x-fb-trace-id", "value": "EvIR2I6Qlba" }, { "key": "x-fb-rev", "value": "1019544279" }, { "key": "X-FB-Debug", "value": "obpzTBElj3EHsUSYaQnKGL+48PTbhnEUlBcWCbxZ975gqdmNtykW75syW2urtWZFXbUVgznzAYrP1e9bJNxGZQ==" }, { "key": "Date", "value": "Fri, 24 Jan 2025 00:48:08 GMT" }, { "key": "X-FB-Connection-Quality", "value": "EXCELLENT; q=0.9, rtt=8, rtx=0, c=10, mss=1380, tbw=3404, tp=-1, tpl=-1, uplat=1235, ullat=0" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "111" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"block_users\": {\n \"added_users\": [\n {\n \"input\": \"+16505551234\",\n \"wa_id\": \"16505551234\"\n }\n ]\n }\n}" } ] }, { "name": "Unblock user(s)", "request": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"block_users\": [\n {\n \"user\": \"{{Recipient-Phone-Number}}\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/block_users", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "block_users" ] }, "description": "- Guide: [Block Users](https://developers.facebook.com/docs/whatsapp/cloud-api/block-users)\n \n- Endpoint reference: [DELETE WhatsApp Buiness Phone Number > block_users](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/block_users/#Deleting)" }, "response": [ { "name": "Unblock user(s)", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"block_users\": [\n {\n \"user\": \"+16505551234\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/block_users", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "block_users" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v22.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "A_gHjMbqGboJZKOEcxLKzhy" }, { "key": "x-fb-trace-id", "value": "GXXfwd3p1hC" }, { "key": "x-fb-rev", "value": "1019544279" }, { "key": "X-FB-Debug", "value": "1vpcJ11cxYPapINmC6TBtRjtZ+e1xnlB9Ow5TaPw95PWVWzWpN1c96zrZX2glrzyzf/qIQBWkvUx53Xm/qTOBw==" }, { "key": "Date", "value": "Fri, 24 Jan 2025 00:54:14 GMT" }, { "key": "X-FB-Connection-Quality", "value": "EXCELLENT; q=0.9, rtt=7, rtx=0, c=10, mss=1380, tbw=372, tp=-1, tpl=-1, uplat=2019, ullat=0" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "113" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"block_users\": {\n \"removed_users\": [\n {\n \"input\": \"+16505551234\",\n \"wa_id\": \"16505551234\"\n }\n ]\n }\n}" } ] } ], "description": "Guide: [Block Users](https://developers.facebook.com/docs/whatsapp/cloud-api/block-users)" }, { "name": "Business Compliance", "item": [ { "name": "Get India-based business compliance info", "request": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/business_compliance_info", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "business_compliance_info" ] } }, "response": [ { "name": "Sample response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/business_compliance_info", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "business_compliance_info" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Encoding", "value": "br" }, { "key": "ETag", "value": "\"5d9b0d60e85289ecf991fc9d1374a2dea2bb1933\"" }, { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "x-business-use-case-usage", "value": "{\"102290129340398\":[{\"type\":\"whatsapp_business_management\",\"call_count\":1,\"total_cputime\":1,\"total_time\":1,\"estimated_time_to_regain_access\":0}]}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "Adxmksg34KENIcsc9IhuPOx" }, { "key": "x-fb-trace-id", "value": "CWbAtEYpDno" }, { "key": "x-fb-rev", "value": "1007307139" }, { "key": "X-FB-Debug", "value": "KnAizExvSQwkzX5kWoW0eWjbmGFhM7YuFXw9Bvo1fYDJJDurr0s+57kYrB1rNo7DRBOExt0rYt+uc2cFp3YB5w==" }, { "key": "Date", "value": "Thu, 13 Apr 2023 21:46:15 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "224" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"entity_name\": \"Lucky Shrub\",\n \"entity_type\": \"Partnership\",\n \"is_registered\": true,\n \"grievance_officer_details\": {\n \"name\": \"Chandravati P.\",\n \"email\": \"chandravati@luckyshrub.com\",\n \"landline_number\": \"+913857614343\",\n \"mobile_number\": \"+913854559033\"\n },\n \"customer_care_details\": {\n \"email\": \"support@luckyshrub.com\",\n \"landline_number\": \"+913857614343\",\n \"mobile_number\": \"+913854559033\"\n },\n \"messaging_product\": \"whatsapp\"\n }\n ]\n}" } ] }, { "name": "Add India-based business compliance info", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"entity_name\": \"\",\n \"entity_type\": \"\",\n \"is_registered\": ,\n \"grievance_officer_details\": {\n \"name\": \"\",\n \"email\": \"\",\n \"landline_number\": \"\",\n \"mobile_number\": \"\"\n },\n \"customer_care_details\": {\n \"email\": \"\",\n \"landline_number\": \"\",\n \"mobile_number\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/business_compliance_info", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "business_compliance_info" ] } }, "response": [ { "name": "Sample response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"entity_name\": \"Lucky Shrub\",\n \"entity_type\": \"PARTNERSHIP\",\n \"is_registered\": true,\n \"grievance_officer_details\": {\n \"name\": \"Chandravati P.\",\n \"email\": \"chandravati@luckyshrub.com\",\n \"landline_number\": \"+913857614343\",\n \"mobile_number\": \"+913854559033\"\n },\n \"customer_care_details\": {\n \"email\": \"support@luckyshrub.com\",\n \"landline_number\": \"+913857614343\",\n \"mobile_number\": \"+913854559033\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/business_compliance_info", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "business_compliance_info" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=UTF-8" }, { "key": "Vary", "value": "Origin" }, { "key": "cross-origin-resource-policy", "value": "cross-origin" }, { "key": "x-app-usage", "value": "{\"call_count\":0,\"total_cputime\":0,\"total_time\":0}" }, { "key": "x-fb-rlafr", "value": "0" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "facebook-api-version", "value": "v16.0" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; preload" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Cache-Control", "value": "private, no-cache, no-store, must-revalidate" }, { "key": "Expires", "value": "Sat, 01 Jan 2000 00:00:00 GMT" }, { "key": "x-fb-request-id", "value": "AYkiln3WLsn7Xbi5rwRXGDE" }, { "key": "x-fb-trace-id", "value": "EBj3JL+cwpH" }, { "key": "x-fb-rev", "value": "1007307139" }, { "key": "X-FB-Debug", "value": "CXQbL4sps9oXN95xat+eZEsU9mvmrIEgU3NZPA9BNaecLZ1NLgIUO+lVMHfjT2mVIr4dA6IKONfIbhIp3SBQDw==" }, { "key": "Date", "value": "Thu, 13 Apr 2023 21:35:02 GMT" }, { "key": "Alt-Svc", "value": "h3=\":443\"; ma=86400" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Content-Length", "value": "16" } ], "cookie": [], "body": "{\n \"success\": true\n}" } ] } ] }, { "name": "Examples", "item": [ { "name": "Send Sample Text Message", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-WA-ID}}\",\n \"type\": \"template\",\n \"template\": {\n \"name\": \"hello_world\",\n \"language\": {\n \"code\": \"en_US\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] }, "description": "You need to create a message template before you can send one. See [Create Template Using the WhatsApp Manager](https://developers.facebook.com/docs/whatsapp/message-templates/creation#step-1--create-template-using-the-whatsapp-manager) for more information. If your account is not verified yet, you can use one of our pre-approved templates.\n\nTo send a text-based message template, make a **POST** call to **`/{{Phone-Number-ID}}/messages`** and attach a message object with type = `template`. Then, add a template object.\n\n## Prerequisites\n- You need to create a message template through [WhatsApp Manager](https://developers.facebook.com/docs/whatsapp/message-templates/creation) or [BM API](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates#creating-message-templates)\n- For an unverified account, we have already [pre-created message templates](https://www.facebook.com/business/help/722393685250070) for you to use.\n\n## Message Objects\n\nMessage templates can contain the following `Message Objects`:\n\n* [Template Object](#fb5ad9b7-7991-443a-a1b5-97fdc5731673)\n* [Language Object](#d9272e38-c3db-458c-a23b-07953abc73a40)\n* [Component Object](#8225365a-acb8-48c7-8e57-079dfc532865)\n* [Parameter Object](#fe8db07c-27ad-49f3-bf33-472ee302c136)\n* [Currency Object](#424b70af-ced8-456d-b1e1-1360c5afb9e9)\n* [Date_Time Object](#ec955b05-7bd4-4273-ad87-ae755b580f6e)\n\n## Response\n\nA successful response includes an object with an identifier prefixed with **`wamid`**." }, "response": [ { "name": "Send Sample Text message", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"16315555555\",\n \"type\": \"template\",\n \"template\": {\n \"name\": \"template-name\",\n \"language\": {\n \"code\": \"language-and-locale-code\"\n },\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"text-string\"\n },\n {\n \"type\": \"currency\",\n \"currency\": {\n \"fallback_value\": \"$100.99\",\n \"code\": \"USD\",\n \"amount_1000\": 100990\n }\n },\n {\n \"type\": \"date_time\",\n \"date_time\": {\n \"fallback_value\": \"February 25, 1977\",\n \"day_of_week\": 5,\n \"year\": 1977,\n \"month\": 2,\n \"day_of_month\": 25,\n \"hour\": 15,\n \"minute\": 33,\n \"calendar\": \"GREGORIAN\"\n }\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Sample Shipping Confirmation Template", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"template\",\n \"template\": {\n \"name\": \"sample_shipping_confirmation\",\n \"language\": {\n \"code\": \"en_US\",\n \"policy\": \"deterministic\"\n },\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"2\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "response": [ { "name": "Send Sample Shipping Confirmation Template", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{User-Access-Token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"16315555555\",\n \"type\": \"template\",\n \"template\": {\n \"name\": \"template-name\",\n \"language\": {\n \"code\": \"language-and-locale-code\"\n },\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"text-string\"\n },\n {\n \"type\": \"currency\",\n \"currency\": {\n \"fallback_value\": \"$100.99\",\n \"code\": \"USD\",\n \"amount_1000\": 100990\n }\n },\n {\n \"type\": \"date_time\",\n \"date_time\": {\n \"fallback_value\": \"February 25, 1977\",\n \"day_of_week\": 5,\n \"year\": 1977,\n \"month\": 2,\n \"day_of_month\": 25,\n \"hour\": 15,\n \"minute\": 33,\n \"calendar\": \"GREGORIAN\"\n }\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"48XXXXXXXXX\",\n \"wa_id\": \"48XXXXXXXXX \"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.gBGGSFcCNEOPAgkO_KJ55r4w_ww\"\n }\n ]\n}" } ] }, { "name": "Send Sample Issue Resolution Template", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"template\",\n \"template\": {\n \"name\": \"sample_issue_resolution\",\n \"language\": {\n \"code\": \"en_US\",\n \"policy\": \"deterministic\"\n },\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"*Mr. Jones*\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": 0,\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"Yes\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": 1,\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"No\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "response": [ { "name": "Send Sample Issue Resolution Template", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"messaging_product\": \"whatsapp\",\n \"to\": \"{{Recipient-Phone-Number}}\",\n \"type\": \"template\",\n \"template\": {\n \"name\": \"sample_issue_resolution\",\n \"language\": {\n \"code\": \"en_US\",\n \"policy\": \"deterministic\"\n },\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"*Mr. Jones*\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": 0,\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"Yes\"\n }\n ]\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": 1,\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"No\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/messages", "protocol": "https", "host": [ "graph", "facebook", "com" ], "path": [ "{{Version}}", "{{Phone-Number-ID}}", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "Text", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "password", "value": "{{User-Access-Token}}", "type": "string" }, { "key": "token", "value": "{{User-Access-Token}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "pm.request.headers.add({", " key: 'User-Agent',", " value: 'Postman/WhatsAppCloudAPICollection'", "});" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "Version", "value": "", "type": "default" }, { "key": "WABA-ID", "value": "", "type": "default" }, { "key": "User-Access-Token", "value": "", "type": "default" } ] }