Jump to Content
API Reference
v2
中文版
Help Center
Log In
API Reference
Help Center
Log In
v2
API Reference
Learn about Business-scoped user IDs(BSUID)
All
Pages
Start typing to search…
JUMP TO
INTRODUCTION
Introduction
Authentication
Errors
WhatsApp Errors
Rate Limits
Pagination
Request IDs
Versioning
Changelog
WhatsApp Message Pricing Updates
BSUID Webhook Payload Changes
Developer Tools
OpenAPI
SDKs
GUIDE
📖
WhatsApp Message Sending Guide
📖
Webhook Integration Guide
📖
WhatsApp Flow Endpoint Implementation Guide
📖
WhatsApp Calling Guide
📖
Learn about Business-scoped user IDs(BSUID)
YCloud API
Balance
Retrieve balance
get
Contacts
Create a contact
post
List contacts
get
Retrieve a contact
get
Update a contact
patch
Delete a contact
del
List contact attributes
get
Custom Events
Create an event definition
post
Retrieve an event definition
get
Update an event definition
patch
Create an event property definition
post
Update an event property definition
patch
Delete an event property definition
del
Send an event
post
Emails
Send an email
post
SMS
Send an SMS
post
List SMS records
get
Unsubscribers
Create an unsubscriber
post
List unsubscribers
get
List all unsubscribers by customer
get
Retrieve an unsubscriber
get
Delete an unsubscriber
del
Verify
Start a verification
post
Check a verification
post
Voices
Send a voice code
post
List voice records
get
Webhook Endpoints
Create a webhook endpoint
post
List webhook endpoints
get
Retrieve a webhook endpoint
get
Update a webhook endpoint
patch
Delete a webhook endpoint
del
Rotate a webhook endpoint secret
post
WhatsApp Business Accounts
List WABAs
get
Retrieve a WABA
get
WhatsApp Inbound Messages
Mark message as read
post
Mark message as read and display a typing indicator
post
WhatsApp Media
Upload media
post
WhatsApp Messages
Send a message directly
post
Enqueue a message
post
Retrieve a message
get
WhatsApp Phone Numbers
List phone numbers
get
Retrieve a phone number
get
Retrieve a phone number profile
get
Update a phone number profile
patch
Retrieve commerce settings
get
Update commerce settings
patch
Register a phone number
post
Retrieve phone number settings
get
Save phone number settings
post
Update a phone number display name
patch
WhatsApp Templates
Create a template
post
List templates
get
Delete templates by name
del
Delete a template
del
Edit a template
patch
Retrieve a template
get
WhatsApp Flows
Create a flow
post
List flows
get
Update flow metadata
patch
Update flow structure
patch
Delete a flow
del
Retrieve a flow
get
Publish a flow
post
Deprecate a flow
post
generate a web preview URL with this flow.
get
WhatsApp Calling
Connect a call
post
Pre-accept a call
post
Accept a call
post
Terminate a call
post
Reject a call
post
Webhooks
Configure Webhooks
Webhook Events & Payloads
Webhook Payload Object
Test webhooks
post
Examples
API & Webhook Examples
API Request Examples
WhatsApp Template Creation Examples
WhatsApp Messaging Examples
Webhook Payload Examples
WhatsApp Template Reviewed Webhook Examples
WhatsApp Message Updated Webhook Examples
WhatsApp Inbound Message Webhook Examples
WhatsApp Business Account Updated Webhook Examples
WhatsApp Payment Updated Webhook Examples
Contact Created Webhook Examples
Contact Deleted Webhook Examples
Contact Unsubscribe Created Webhook Examples
Contact Unsubscribe Deleted Webhook Examples
Contact Attributes Changed Webhook Examples
WhatsApp Business App History Message Webhook Examples
WhatsApp Business App Sent Message Sync Webhook Examples
WhatsApp Calling Connect Webhook Examples
WhatsApp Calling Status Update Webhook Examples
WhatsApp Calling Terminate Webhook Examples
WhatsApp Flow Webhook Examples
Powered by
Learn about Business-scoped user IDs(BSUID)
Ask AI
