WhatsApp Cloud API
Overview
Readme
Cloud API Overview
Message Throughput
Rate Limits
Available Metrics
Scaling
Data Privacy & Security
Readme
Message Flows
Stored and Collected Data
Encryption
Get Started
Readme
Step 1: Set up Developer Assets and Platform Access
Step 2: Send a Test Message
Readme
Send Test Message
POST
Step 3: Configure a Webhook
Step 4: Receive a Test Message
Next Steps
Get Started for BSPs
Prepare and Plan
Set up Assets
Sign Contracts
Build Integration
Step 1: Get System User Access Token
Step 2: Set up Webhooks
Step 3: Subscribe to your WABA
POST
Step 4: Get Phone Number ID
GET
Step 5: Register Phone Number
POST
Step 6: Receive a Message from Consumer App
VIEW
Step 7: Send a Test Message
POST
Guides
Readme
Mark Messages as Read
Sell Products and Services
API Reference
Readme
Account Migration
Readme
Migrate Account
POST
Block Users
Readme
Get blocked users
GET
Block user(s)
POST
Unblock user(s)
DELETE
Business Compliance
Get India-based business compliance info
GET
Add India-based business compliance info
POST
Business Profiles
Readme
Resumable Upload - Create an Upload Session
POST
Resumable Upload - Upload File Data
POST
Resumable Upload - Query File Upload Status
GET
Get Business Profile
GET
Update Business Profile
POST
Registration
Readme
Register Phone
POST
Deregister Phone
POST
Media
Readme
Upload Audio
POST
Retrieve Media URL
GET
Delete Media
DELETE
Download Media
GET
Messages
Readme
Messages Object
Readme
Text Object
Reaction Object
Media Object
Template Object
Language Object
Components Object
Parameter Object
Currency Object
Date_Time Object
Button Parameter Object
Contacts Object
Readme
addresses Object
emails Object
name Object
org Object
phone Object
urls Object
Location Object
Interactive Object
Readme
Header Object
Body Object
Footer Object
Action Object
Section Object
Mark Message As Read
PUT
Send Catalog Template Message
POST
Phone Numbers
Readme
Get Phone Numbers
GET
Get Phone Number By ID
GET
Get Display Name Status (Beta)
GET
Request Verification Code
POST
Verify Code
POST
Two-Step Verification
Readme
Set Two-Step Verification Code
POST
WhatsApp Business Accounts (WABAs)
Readme
Get Shared WABA ID
GET
Get List of Shared WABAs
GET
WABA Subscriptions
Readme
Get All Subscriptions for a WABA
GET
Unsubscribe from a WABA
DELETE
Override Callback URL
POST
Payments API - SG
Send Order Status Message
POST
Payments API - IN
Send Order Status Message
POST
Typing indicators
Send typing indicator and read receipt
POST
Examples
Send Sample Issue Resolution Template
POST
Webhooks
Readme
Understanding Webhooks
Generate Endpoint for Webhook Testing
Components
Readme
Entry Object
Change Object
Metadata Object
Value Object
Contact Object
Profile Object
Messages Object
Text Object
Context Object
Identity Object
Media Object
Reaction Object
Interactive Object
System Message Object
Statuses Object
Error Object
Button Object
Referral Object
Message Status Types
Status: Transaction Status - Order Details Message
VIEW
Support and Troubleshooting
Support
Errors
Readme
Sample Error Response
VIEW
Technical Implementation FAQs
Data Privacy & Security FAQs
Regulatory Compliance FAQs
Set up Assets
创建时间: 2025-05-28 16:39
To use the Cloud API, BSPs need to have the following assets:
Asset | Specific Instructions |
---|---|
Business Manager | You can use an existing, or set up a new one. Save the Business Manager ID. |
WhatsApp Business Account (WABA) | See Create a WhatsApp Business Account for the WhatsApp Business API for help. |
Meta App | If you don’t have an app, you need to create one with the “Business” type. Remember to add a display name and a contact email to your app. As a BSP (Business Solution Provider), your app must go through App Review and request Advanced Access to the following permissions: * whatsapp_business_management — Used to manage phone numbers, message templates, registration, business profile under a WhatsApp Business Account. To get this permission, your app must go through App Review. * whatsapp_business_messaging — Used to send/receive messages from WhatsApp users, upload/download media under a WhatsApp Business Account. To get this permission, your app must go through App Review. * business_management See a sample App Review submission here. As a BSP, you can also feel free to use the same Meta app across different clients and WABAs. But be aware that each app can only have one webhook endpoint and each app needs to go through App Review. |
System User | See Add System Users to Your Business Manager for help. Currently, a Meta App with whatsapp_business_messaging , whatsapp_business_management , and business_messaging permissions has access to up to: * 1 admin system user, and * 1 employee system user We recommend using the admin system user for your production deployment. See About Business Manager Roles and Permissions for more information. |
Business Phone Number | This is the phone number the business will use to send messages. Phone numbers need to be verified through SMS/voice call. For BSPs and Direct Businesses: If you wish to use your own number, then you should add a phone number in WhatsApp Manager and verify it with the verify endpoint via Graph API. For Businesses using BSPs: If you wish to use your own number, then you should add and verify their numbers using the BSP’s Embedded Signup flow. The verification status of a phone number doesn't impact the migration between On-Premises and Cloud API. If you don't have access to Embedded Signup to verify phone numbers, we recommend verifying the phone numbers using the On-Premises solution, and then migrating those numbers to the Cloud API. There is no limit to the amount of business phone numbers that can be onboarded to the Cloud API. Only one phone number can be used on a platform at a time: One for Cloud API and another for On-Premises. This means that you cannot use a production phone number with both the On-Premises and Cloud APIs. We recommend doing any testing with a test number (either an existing test number or a new one) and then moving your own phone number to the Cloud API when you’re confident you’re ready for production use. |
Consumer Phone Number | This is a phone number that is currently using the consumer WhatsApp app. This number will be receiving the messages sent by your business phone number. |
最后更新: -