Whatsapp business api documentation template. object: Required when type=document.

Whatsapp business api documentation template If you are a developer who wants direct access to the Cloud API to build on the behalf of a client’s business, fill out this form and we will reach out Note that there are restrictions and limitations on business phone numbers and their uses, which are described in detail in our Business Phone Numbers document. For reference, check out how to create WhatsApp templates in AiSensy . You can send the following message types using the platform: Text messages This document explains how conversation-based pricing works on the WhatsApp Business Platform. Documentation Contents Get Started In Scopes field, you should have whatsapp_business_management, whatsapp_business_messaging. You get a webhooks notification: 1- When a customer performs an action. If you need more than 250 templates, write to us at hello@tellephant. Use the WhatsApp Business Phone Number > Messages endpoint to send a catalog template message using a catalog template with an APPROVED status. During the session, there are no additional charges for any additional messages from the business or the end-user. This document explains how conversation-based pricing works on the WhatsApp Business Platform. In WhatsApp Manager > Account tools: Click on create template; Select Utility category to expand Order details message option; Enter the desired template name and supported locale Analytics. Prior message threads in the WhatsApp app or WhatsApp Business app between the user and your business are not muted. Aug 29, 2022 · I'm using WhatsApp Business API and can't find a way to put links with labels in messages. WhatsApp On-Premises API is deprecated. com. business_capability_update. WhatsApp¶. document. Templates can be created using the Business Management API or the WhatsApp Business Manager. The API, on the other hand, supports unlimited users and high volumes of broadcasts. io, your guide to seamless integration and messaging. Catalog templates and how to use them. This document describes single-product message (MPM) templates, their uses, and how to create them. This purpose-built API intelligently orchestrates OTP delivery between WhatsApp, SMS, RCS and other channels to maximize conversion and reduce cost. The components you choose for each of your templates should be based on your business needs. Regardless of which API you end up using, you must also use the Business Management API, which is used to manage WhatsApp Business Account and message templates. SPM templates are marketing templates that allow you to present a single product from your ecommerce catalog, accompanied by a product image, product title, and product price (all pulled from your product within your catalog), along with customizable body text This document explains how conversation-based pricing works on the WhatsApp Business Platform. Currently, there are two ways to send media messages with the WhatsApp Business API: May 19, 2022 · If the thought of utilizing “dev resources to deploy a cloud API solution,” caused some anxiety about how your team would use WhatsApp Business Platform, there’s good news: Managing your messages, templates, and accessing your analytics is handled inside the Facebook Business Manager. Authentication. If a parent business is unverified, each of its WhatsApp Business Accounts is limited to 250 templates. You can send the following message types using the platform: Create, Retrieve, and Delete Message Templates. To use product card carousel templates, you must have an ecommerce product catalog, with inventory, connected to your WhatsApp Business Account. Request Syntax POST /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/messages This document explains how conversation-based pricing works on the WhatsApp Business Platform. Unlike using WhatsApp via API, it has limited scalability, and only up to 5 employees can manage the account through one phone. Text; Media (image, video, audio, document, sticker) Business Assets. Sep 25, 2023 · WhatsApp Business API documentation is a powerful tool that can transform your business’s customer communication. The Business Management API allows you to create and manage WhatsApp-related business assets, such as WhatsApp Business Accounts and message templates. Text; Media (image, video, audio, document, sticker) Business Help Center. Full instructions for getting started with WhatsApp Business Cloud API so you can send your first test message is located at Get Started With the WhatsApp Business Cloud API. Migrate Phone Number to a Different WABA Parameter Description; object. The supported date and time formats include: Component Time — The time is assembled from components (i. Optional. Documentation Contents Get Started Limitations. Create a new template (via the API or WhatsApp Manager) and select a category based on the guidelines above, since a template's category cannot be changed once the template is approved. Requirements. 39 of the On-Premises API. To know how you can opt-in users, read frequently a This document explains how conversation-based pricing works on the WhatsApp Business Platform. e. Businesses can use WhatsApp Business to communicate with their customers by text, send documents and provide support. Templates must have been sent at least 1,000 times in the queries specified timeframe. Users who view a limited-time offer template message using that WhatsApp web app or desktop app will not see the offer, but will instead see a message indicating that they have received a message but that it's not supported in the client they are using. Couldn't find any reference about it in the docs: https://developers. Once the message template is approved, you can use the API to send a message. Use the Cloud API to send approved coupon code Oct 29, 2024 · Need WABA (WhatsApp Business Account) ID to create template ; Get Started. WhatsApp users can use the Offers and announcements setting to stop or resume delivery of marketing template messages from your business. This option was deprecated with v2. Ensure your test business phone number is selected in the From field. 1: In the sidebar of WAM, under Message Templates, select Create Template. The number of templates a WhatsApp Business Account can have is determined by its parent business. This is the object that was subscribed to. Template messages are used to start a conversation with a customer or reply to a customer's message outside the 24-hour window. Timeframes are limited to 7, 30, 60 and 90 day lookbacks from the time of the request. You can read more in the WhatsApp Template Management API guide. Use the POST /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/messages endpoint to send an approved product card carousel template to a WhatsApp user. WABA. When a WhatsApp user taps the button, a location sharing screen appears which the user can then use to share their location. Using the API, businesses can connect thousands of agents and bots to interact with customers programmatically and manually. This document describes how to get messaging, conversation, and template analytics, such as the number of messages sent from a business phone number, the number of conversations and their costs for a WhatsApp Business Account (WABA), or the number of times a given template has been read. Send a WhatsApp Media Message Template. object: Contains an hsm object. Make sure it contains no newlines, tabs, or more than 4 consecutive spaces and meets the length restrictions as called out in the Business Manager or WhatsApp Business Management API. Creating Coupon Code Templates. js used in this blog post. The custom object takes a partial section of the original WhatsApp API request and sends it directly through to WhatsApp. Once your WhatsApp Business API is Live, you can create template messages and submit them to WhatsApp for approval. Each media card has card body text without variables, a quick reply button, and a URL button that uses a variable. It provides a reliable way to interact with customers over WhatsApp, while maintaining data protection and compliance through end-to-end Indicates the number of template messages you can send with each of your WhatsApp Business Account's business phone numbers that have an approved display name. Documentation to help you set up your environment, test, build and integrate the WhatsApp Business Platform into your stack. They are opened and charged when messages you send to customers are delivered. To know how you can opt-in users, read frequently asked questions. Step 3: Send a Test Message. The WhatsApp Template Management API allows you to programmatically list existing WhatsApp templates, create new templates, delete templates, and upload media for use in templates. Tellephant can request that WhatsApp reconsider the rejected template. Introduction . A media object containing an image. For example, to migrate 5000 templates, send one request with this value set to 0 and another request with this value set to 1, in parallel. You can create MPM templates using the WhatsApp Business Account > Message Templates endpoint or the WhatsApp Manager > Account tools > Message templates panel. On-Premises API only. You can either add a call-to-action button or a quick reply button. Use the template object instead. The capabilities of Cloud API will be reflected soon. Get started with WhatsApp Flows API documentation from WhatsApp Business Platform exclusively on the Postman API Network. For call-to-action templates, you can add 2 buttons, up to one button of each type (call phone number and visit website). 0 Components of the message template — Fill in the template with the text and/or media components, including parameter placeholders, as required. object: Required when type=document. It is not possible to have the phone number registered in the WhatsApp Business API to use anywhere, and do not use it for anything else. WhatsApp is now a more cost effective channel than SMS to send One-Time-Passcodes (OTPs) in many parts of the world. CRM. See our Cloud API vs. Creating an order details template on Whatsapp Manager. You can view a template's status by going to WhatsApp Manager > Overview, mousing over the suitcase icon (Account tools) and clicking Message templates. Source WhatsApp Business Account ID. Custom objects; Interactive Messages: Overview October 4, 2023. See Migrate Phone Number to a Different WABA. WhatsApp Business API Template Components. Business Management API, Cloud API, On-Premises API. A media object containing a document. Constraints. com and create an account. Note: This package is WIP. Catalog templates display a product thumbnail header image of your choice and custom body text, along with a fixed text header and fixed text sub-header. ENVIRONMENT WhatsApp Business API Documentation. Have created an interactive message template on Business Manager. Use the WhatsApp Business Management API to create new message templates, media message templates, or interactive message templates. message_template_components_update You can view a template's status by going to WhatsApp Manager > Overview, mousing over the suitcase icon (Account tools) and clicking Message templates. . WhatsApp Business API Channel Guide. We are making changes to the WhatsApp Business Platform pricing model. Option 1: Customer can source a number directly from Syniverse to use as a WhatsApp Business API number. Show notifications is enabled (Settings > Notifications) in the WhatsApp app or WhatsApp Business app. To use this collection you must have a Meta business portfolio, a WhatsApp Business Account (WABA), and a business phone number. The WhatsApp dashboard is an intuitive way to manage WhatsApp Business App is a free-to-download mobile application for small business owners that allows them to communicate with customers over WhatsApp on behalf of the business. This document provides an overview of how messages work on the WhatsApp Business Platform. Step 2: Integrating AiSensy with your CRM WhatsApp will charge once per 24-hour session of messaging between a business and a customer. Example template: Request: This public collection contains common queries, sample responses, and links to supporting documentation for the Business Management API. To send the Media Message Template you need to use the Messages custom object. WhatsApp Message Templates (template) are customizable templates that you can construct via the API using various template components. This repository contains Infra-as-Code templates that create cloud services hosting WhatsApp Business API (On-Premises) with desired throughput on various public cloud platforms, including AWS, Azure & GCP. interactive Template Components. The Whatsapp Business API client attempts to format the date/time based on the specified localization. You can send Template messages to users that you have opted-in. Use the API to get and filter phone numbers associated with your WhatsApp Business Account. See Pricing Updates on the WhatsApp Business Platform. Zero-indexed. See an example here. They use one of your pre-approved WhatsApp Templates (alerts, appointment reminders, shipping notifications, etc) and need to be submitted and approved by WhatsApp before they can be WhatsApp Business Phone Number > Verify Code. You can update your template's contents or its category via the API or WhatsApp Manager. Components of the message template: Fill in the template with the text and/or media components, including parameter placeholders, as required. If you have multiple WhatsApp Business Accounts, select the account whose template statuses you want to view from the list of accounts in the dropdown menu in the top-right corner. Unlike all other message types, template messages do not require a 24-hour customer service window to be open between you and the message recipient before the message can be sent. Dec 12, 2024 · In order to protect WhatsApp users from unsolicited messages, WhatsApp Business has strict requirements around how businesses can use WhatsApp to send messages, especially when the business initiates the conversation. 2: Under Browse the WhatsApp Template Library, select Browse Templates. Although WhatsApp templates can be managed manually via the WhatsApp Business Manager UI, the Vonage WhatsApp Template Management API now lets you manage your templates The Business Management API allows you to create and manage WhatsApp-related business assets, such as WhatsApp Business Accounts and message templates. The Cloud API, hosted by Meta, allows you to implement WhatsApp Business APIs without the cost of hosting of your own servers and also allows you to more easily scale your business messaging. Dec 1, 2024 · Comparing the two WhatsApp Business products. Discover the comprehensive documentation for Whatsapp Business API on 1msg. Media Cards. On-Premises API document to learn more about the differences between Components of the message template — Fill in the template with the text and/or media components, including parameter placeholders, as required. This example request creates a media card carousel template with a message that uses 3 variables and 3 media cards. You can directly use v1/login endpoint in order to create/obtain an API token. The Postman Documenter generates and maintains beautiful, live documentation for your collections. In the WhatsApp > API Setup panel:. Objects, Fields, and Values Parameter Description; object. See the Cloud API Commerce guide to learn more about connecting a catalog to your account. After you verify access token, please try to make basic request with the the token, like GET /waba-id or GET /flow-id. WhatsApp is an instant messaging and voice-over-IP app that allows users to send messages, make calls, and share content. Comienza a configurarlo en minutos y envía hoy mismo mensajes atractivos, oportunos y de alta calidad. With this option, Syniverse can currently only provide US, UK and Canadian numbers and will help you with registration, activation of the number and creation of a Syniverse WhatsApp Business API Sender ID This repository is a hub for examples of how developers can use Cloud API, hosted by Meta, on the WhatsApp Business Platform. Set up and Configure Glitch. Device level notification is enabled for the WhatsApp app or WhatsApp Business app. Make it clear to your user that the password or code will be delivered to their WhatsApp phone number, especially if you offer multiple ways for the user to receive password or code delivery. Request Syntax. Only templates categorized as MARKETING are supported. ‍ WhatsApp supports up to 250 templates per account by default. Obtain your token with a request. media-messages-js - Demo of how to use WhatsApp Business Platform with media The WhatsApp Business API allows medium and large businesses to communicate with their customers at scale. See our On-Premises API Sunset document for a complete deprecation timeline and links to documents that can help you migrate from On-Premises API to Cloud API, if you are already using On-Premises API. Request. WhatsApp Business Platform > Cloud API Endpoint References. Header with a document variable. This collection contains common queries, sample responses, and links to supporting documentation that can help you quickly get started with the API. WhatsApp Message Templates. Manage Phone Numbers. First, you need to know App ID and Qiscus Secret Key to do authentication in Qiscus Omnichannel Chat. See Messaging Limits . WhatsApp Business Phone Number > WhatsApp Commerce Settings. Note that there are restrictions and limitations on business phone numbers and their uses, which are described in detail in our Business Phone Numbers document. Public . Aprovecha la Plataforma de WhatsApp Business Con sus 2000 millones de usuarios en todo el mundo, es muy probable que tus clientes ya se encuentren en WhatsApp. Best for: Businesses working with Solution Partners, or non-technical stakeholders using the WhatsApp Business API. Location Request Messages. Via the API Postman Collection For Official WhatsApp Business API. Further information. Template Components. A simple step for send message via WhatsApp Business API that you can follow i. Template status is REJECTED. Cloud API reviews templates and variable parameters using machine learning to protect the security and integrity of Cloud API services. max_phone_numbers_per_waba Show notifications is enabled (Settings > Notifications) in the WhatsApp app or WhatsApp Business app. Required. This can include changes to the maximum number of business phone numbers your WhatsApp Business Account can have, or a change to the messaging limit for all of your WhatsApp Business Account's business phone numbers. ) The WhatsApp Business Management API allows you to programmatically manage your WhatsApp Business Account assets, such as message templates and phone numberss. When paired with the right WhatsApp API software, businesses can manage conversations with advanced AI and automation and ensure smooth contact synchronization with e-commerce platforms and CRMs, among other advanced capabilities. interactive Creating Templates via WhatsApp Manager (WAM) Follow the instructions below to create templates using the Template Library in WhatsApp Manager. Sends a text message to the business; Sends an image, video, audio, document, or sticker to the business October 4, 2023. Use the WhatsApp Business Phone Number > Messages endpoint to send an authentication template message with a one-time password button. Using the SDK (Beta) The WhatsApp Business Management API allows you to programmatically manage your WhatsApp Business Account assets, such as message templates and phone numberss. Use the WhatsApp Business Account > Message Templates Sending Coupon Templates. Check out our Verify WhatsApp API to send OTPs. Example Request. Send the pre-approved hello_world template message to your chosen recipient number. Best Practices. These allows you to: manage your WhatsApp Business Account assets, such as message templates and phone numbers; send messages to your contacts, such as simple text messages, messages with buttons Cloud API only. Catalog templates are marketing templates that allow you to showcase your product catalog entirely within WhatsApp. Useful if you have previously requested a list, but since then the user has created new templates and you only need to get new templates NOTE: A Facebook API phone number can only be registered in one service at a time; if your number is registered in the WhatsApp Business Cloud API, it cannot be registered in the WhatsApp app. WhatsApp Cloud API, hosted by Meta, is the official WhatsApp Business Platform API used for business messaging. WhatsApp business assets are any WhatsApp assets owned by a business on the WhatsApp Business Platform, such as WhatsApp Business Accounts (WABAs), business phone numbers, message templates, product catalogs, etc. Once your template is approved, you can use Cloud API or On-Premises API to send it in a template message. The benefits of using WhatsApp Business templates are multifold, from being more efficient and personalized, to improve response time and offer easy access to information - Your business can ace customer interaction and provide stellar support while increasing bottom line revenue with the help of live agents or chatbots for WhatsApp. POST /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/messages Name: Type: Description: limit: number: Records returned limit. The API is built on the Marketing API and leverages some of its endpoints, so this documentation may contain links to the Marketing API documentation where appropriate. Mar 29, 2024 · Get started with EnableX WhatsApp Business API. WhatsApp over API. Like Click here, in HTML. Use this edge to confirm a phone number's ownership after migration. When a business initiates a conversation with a customer, it must use a template that has undergone WhatsApp’s review and Best Practices. Whatsapp business api SDK, written in java. Use the WhatsApp Business Account > Message Templates endpoint to create a catalog template. The only required component is the body component. hsm. 3: You will now see all currently available templates. , day of the week, month, hour, etc. Both templates must be in the same WhatsApp Business Account. These components help structure the content of the message and provide a better user experience. Documentation Settings. co You must also specify the type of media that you are sending: audio, document, image, sticker, or video. And under Granular Scopes section you should see your WABA Id under both whatsapp_business_management and whatsapp_business_messaging. We recommend starting with a handful to get started faster. Using the SDK (Beta) Oct 7, 2024 · Note: Make sure your WhatsApp template message is created & approved before creating the API Campaign. facebook. Feel free to contribute! Sending Messages. Cloud API only. Default: 100: offset: number: From which template to send the list. If you attempt to send a marketing template to a WhatsApp user who has stopped marketing template messages from your business, the API will process the request but not send the message. WhatsApp Template Management API. SPM templates are marketing templates that allow you to present a single product from your ecommerce catalog, accompanied by a product image, product title, and product price (all pulled from your product within your catalog), along with customizable body text The Business Management API allows you to create and manage WhatsApp-related business assets, such as WhatsApp Business Accounts and message templates. All Desk360 API endpoints (except login) need this token in order to respond to your request. Nov 25, 2024 · WhatsApp Business API is designed with powerful messaging experiences to meet your business needs. The preferred solution is Cloud API, due to its ease of implementation and low maintenance. Once your template is approved, you can use Cloud API to send it in a template message. basic-webhook-js - basic WhatsApp webhook app written using Node. Never worry about maintaining API documentation again. Charges are applied per conversation, not per individual message sent or received. entry. WhatsApp reviews requests for higher template limits within 2-4 weeks and WhatsApp Business Account ID. 102290129340398 <PAGE_NUMBER> Integer. On-Premises API document to learn more about the differences between Best Practices. Templates are made up of four primary components which you define when you create a template: header, body, footer, and buttons. Templates are used when sending template messages with either the Cloud API, hosted by Meta, or the On-Premises API. Each card in the template has an image or video header asset, card body text, and up to two buttons. Main Root Nodes. Messages. Learn how to use the WhatsApp Manager and the Facebook Business Manager, as they related to the WhatsApp Business API: Learn more about the WhatsApp Business Platform solutions based on your business goal Supported languages for Cloud API message templates. The charge will vary, depending on who initiated the conversation (the business or the end-user). This SDK implements the Official Whatsapp Cloud API and WhatsApp Business Management API. Single-Product Message Templates. image. To send and receive messages using the API, you will need a business portfolio, a WABA, and a business phone number. Carousel templates are composed of message body text and up to 10 media cards. Notifies you of changes to a business's capabilities. e login, set up webhooks, post a text message, and get webhooks. Location request messages display body text and a send location button. Template messages are Highly Structured(HSM)/ Notification messages. When the request is received, the media is uploaded to the WhatsApp server and sent to the user indicated in the to field. To create an order details template, business needs a business portfolio with a WhatsApp Business Account. Route Mobile WhatsApp Business Messaging API Jan 15, 2023 · WhatsApp Business API; WhatsApp Flows; Click To WhatsApp Ads; The example below shows the payload to be used for a template having: • A document header The preferred solution is Cloud API, due to its ease of implementation and low maintenance. Indicates amount of templates to migrate as sets of 2500. By following the guidelines and best practices outlined in this guide, you can harness its potential to boost customer engagement, drive growth, and elevate your brand’s presence on WhatsApp. In this code snippet you learn how to send a WhatsApp Media Message Template using the Messages API. Please use WhatsApp Cloud API, hosted by Meta, instead. object: Required when type=image. This allows you to use all the features that we discuss in this guide and ensures that the UI Analytics. Authentication templates using the code expiration warning now use the code_expiration_minutes value (instead of a default of 10 minutes) to determine if the delivered template message should display an autofill button or copy code button. The WhatsApp Template Management API allows you to list existing WhatsApp templates, create new templates, delete templates, and upload media for use in templates. The WhatsApp Business API allows medium and large businesses to communicate with their customers at scale. Infobip WhatsApp API (opens in a new tab) is a scalable solution that enables businesses to programmatically send and receive messages by integrating WhatsApp as their communication channel. This object contains the details of the change that triggered the webhooks call. Template Messages for WhatsApp. This document provides an overview of Webhooks and they apply to the WhatsApp Business Management API, WhatsApp Business Platform Cloud API, and WhatsApp Business Platform On-Premises API. A WhatsApp Business APIMessage Template consists of several components including a header, body, footer, and buttons. Node Get or update a WhatsApp business phone number's India-based business compliance Template messages allow you to send marketing, utility, and authentication templates to WhatsApp users. Enable or disable the business phone number's shopping cart and product catalog. Head over to glitch. Conversations are 24-hour message threads between you and your customers. Make sure it contains no newlines, tabs, or more than 4 consecutive spaces and meets the length restrictions as called out in the Business Manager or WhatsApp Business Management API. For embedded signup, this is always whatsapp_business_account. Confirm the user's WhatsApp phone number before sending the one-time password or code to that number. ; Footer components are not supported. ehvx zadleds hwpx zfjrmy ksdty lmnc cczsqv gtm uvwa zhxkfn