WhatsApp Cloud API: Difference between revisions

From Planfix
Jump to: navigation, search
(Created page with "{{#seo: |title=WhatsApp Cloud API |titlemode=append |keywords=Planfix, WhatsApp Cloud API, API, WhatsApp |description=WhatsApp Cloud API }} In Planfix, you can use the official integration with WhatsApp. Content: *Create an application *Set up a webhook and subscribe to all events *#Создание системного пользователя |Создание системного по...")
 
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 7: Line 7:
In Planfix, you can use the official integration with WhatsApp.
In Planfix, you can use the official integration with WhatsApp.


Content:
Content:
*[[#Create an application |Create an application]]
*[[#Create an application |Create an application]]
*[[#Set up a webhook and subscribe to all events |Set up a webhook and subscribe to all events]]
*[[#Set up a webhook and subscribe to all events |Set up a webhook and subscribe to all events]]
*[[#Создание системного пользователя |Создание системного пользователя]]
*[[#Creating a system user |Creating a system user]]
*[[#Creating a system user that grants the system user access to the phone number |Creating a system user that grants the system user access to the phone number]]
*[[#Creating a system user that grants the system user access to the phone number |Creating a system user that grants the system user access to the phone number]]
*[[#Work in test mode  |Work in test mode]]
*[[#Work in test mode  |Work in test mode]]
*[[#Work in live mode |Work in live mode]]
*[[#Work in live mode |Work in live mode]]


== Go to the [[https://developers.facebook.com/ Meta for Developers page]] and create an application ==
== Create an application ==
Go to the [https://developers.facebook.com/ Meta for Developers page] and create an application
<!-- <video>
<!-- <video>
Watch the video on YouTube.-->
Watch the video on YouTube.-->
== Set up a webhook and subscribe to all events ==
== Set up a webhook and subscribe to all events ==
*Log in to your created app and add WhatsApp by clicking the '''"Configure"''' button.
*Log in to your created app and add WhatsApp by clicking the '''"Configure"''' button.
Line 43: Line 42:
A system user is needed to generate an Access Token. It is used when connecting the integration in Planfix.
A system user is needed to generate an Access Token. It is used when connecting the integration in Planfix.
To create a system user, follow these steps:
To create a system user, follow these steps:
*Log in to the [[https://business.facebook.com/latest/home?nav_ref=bm_home_redirect&business_id=199447378088400&asset_id=101919384926463 Meta Business Suite]].  
*Log in to the [https://business.facebook.com/latest/home?nav_ref=bm_home_redirect&business_id=199447378088400&asset_id=101919384926463 Meta Business Suite].  
*Find your business account, and in the dropdown menu in the top left corner, click the gear icon "Settings."  
*Find your business account, and in the dropdown menu in the top left corner, click the gear icon "Settings."  
*Choose '''"Company Settings."'''  
*Choose '''"Company Settings."'''  
Line 64: Line 63:
   
   
== Granting the system user access to the phone number ==
== Granting the system user access to the phone number ==
*Log in to [[https://business.facebook.com/latest/home?nav_ref=bm_home_redirect&business_id=199447378088400&asset_id=101919384926463 Meta Business Suite]].  
*Log in to [https://business.facebook.com/latest/home?nav_ref=bm_home_redirect&business_id=199447378088400&asset_id=101919384926463 Meta Business Suite].  
*Select the business account to which the application was added (1).  
*Select the business account to which the application was added (1).  
*Then on the left in the "Accounts" section, choose "WhatsApp Accounts" (2) and select your WhatsApp business account (3).  
*Then on the left in the "Accounts" section, choose "WhatsApp Accounts" (2) and select your WhatsApp business account (3).  
Line 74: Line 73:


== Work in test mode ==
== Work in test mode ==
*Open your application in [[https://developers.facebook.com/ Meta for Developers]].
*Open your application in [https://developers.facebook.com/ Meta for Developers].
*Copy the WhatsApp Business Account ID (1) and the temporary token (2), then in the Planfix integration, add them to the corresponding fields.  
*Copy the WhatsApp Business Account ID (1) and the temporary token (2), then in the Planfix integration, add them to the corresponding fields.  
*Click the "Update" link to add a test number automatically:
*Click the "Update" link to add a test number automatically:
Line 81: Line 80:


== Work in live mode ==
== Work in live mode ==
*Open your application in [[https://developers.facebook.com/ Meta for Developers]].
*Open your application in [https://developers.facebook.com/ Meta for Developers].
*Copy the WhatsApp Business Account ID.  
*Copy the WhatsApp Business Account ID.  
*Add the "Add Phone Number" button if the number is not there. It is located below on the same page.
*Add the "Add Phone Number" button if the number is not there. It is located below on the same page.
*After completing the integration setup, click the '''"Update"''' link. The corresponding numbers should be automatically added with the correct WhatsApp Business Account ID and Access Token.
 
== Important ==
== Important ==
After completing the integration setup, click the '''"Update"''' link. The corresponding numbers should be automatically added with the correct WhatsApp Business Account ID and Access Token.
*Contacting someone through the official WhatsApp Cloud API is not allowed. This is a rule set by WhatsApp itself.
*With Planfix, you can use buttons or scripts to send pre-written messages approved by [[WhatsApp |WhatsApp]].





Latest revision as of 07:36, 31 July 2023

In Planfix, you can use the official integration with WhatsApp.

Content:

Create an application

Go to the Meta for Developers page and create an application

Set up a webhook and subscribe to all events

  • Log in to your created app and add WhatsApp by clicking the "Configure" button.
  • On the left panel, select "WhatsApp""Quick Start." Choose your Meta business account and click "Next":

9rGqtl.png

  • In the window that appears, click "Start using API":

7xeknZ.png

  • Go to the menu on the left and select "WhatsApp""Settings." Add a Callback URL and Verify the token, copying them from the Planfix integration:

yFCU5l.png

  • Then set up "Webhook Fields," subscribing to all fields:

3dLUhf.png

VGHeXC.png

Creating a system user

A system user is needed to generate an Access Token. It is used when connecting the integration in Planfix. To create a system user, follow these steps:

  • Log in to the Meta Business Suite.
  • Find your business account, and in the dropdown menu in the top left corner, click the gear icon "Settings."
  • Choose "Company Settings."
  • Go to the "Users""System Users" section.
  • Click "Add" and create a system user:
  • Add the system user's name.
  • Specify the role as "Administrator" and save.
  • You need to provide access to your application that was created at the beginning. To do this, click the *"Add Objects" button:

20tvlR.png

hqmePH.png

  • Now click the "Create new token" (Access Token) button:

XoYSaj.png

  • Specify your application. Choose permissions: whatsapp_business_messaging and whatsapp_business_management.
  • Generate the token (Access Token), copy it, and save it.

Granting the system user access to the phone number

  • Log in to Meta Business Suite.
  • Select the business account to which the application was added (1).
  • Then on the left in the "Accounts" section, choose "WhatsApp Accounts" (2) and select your WhatsApp business account (3).
  • Click the "Add People" button (4):

gpbd6E.png

Choose the system user created earlier, give them full access rights, and save the settings.

Work in test mode

  • Open your application in Meta for Developers.
  • Copy the WhatsApp Business Account ID (1) and the temporary token (2), then in the Planfix integration, add them to the corresponding fields.
  • Click the "Update" link to add a test number automatically:

PTvgvh.png

Work in live mode

  • Open your application in Meta for Developers.
  • Copy the WhatsApp Business Account ID.
  • Add the "Add Phone Number" button if the number is not there. It is located below on the same page.
  • After completing the integration setup, click the "Update" link. The corresponding numbers should be automatically added with the correct WhatsApp Business Account ID and Access Token.

Important

  • Contacting someone through the official WhatsApp Cloud API is not allowed. This is a rule set by WhatsApp itself.
  • With Planfix, you can use buttons or scripts to send pre-written messages approved by WhatsApp.


Go To