📌 WhatsApp API without the hassle and nerves! 🤘
- Channel
- Users
- Messages
- Get messagesGET
- Get messages by chat IDGET
- 💬 Send text messagePOST
- 🖼 Send media-image messagePOST
- 🎥 Send media-video messagePOST
- 📹 Send media-short video message (PTV)POST
- 🎬 Send media-gif messagePOST
- 🎵 Send media-audio messagePOST
- 🎤 Send media-voice messagePOST
- 📑 Send media-document messagePOST
- 📎 Send link preview messagePOST
- 📍 Send location messagePOST
- 🧭 Send live location messagePOST
- 👤 Send contact messagePOST
- 👥 Send contact list messagePOST
- 📊 Send poll messagePOST
- 🎮 Send interactive messagePOST
- 🎭 Send media-sticker messagePOST
- 👁️🗨️ Send story messagePOST
- 🎵️ Send story audio messagePOST
- 🖼 Send story media messagePOST
- 💬 Send story text messagePOST
- 📎 Send media messagePOST
- Get messageGET
- ↪ Forward messagePOST
- ✔✔ Mark message as readPUT
- ❌ Delete messageDELETE
- 😍 React to messagePUT
- ⭐ Star messagePUT
- 📌 Pin messagePOST
- Unpin messageDELETE
- Get messages
- Chats
- Contacts
- Presences
- Groups
- Get groups
- Create group
- Accept group invite
- Get group
- Update group info
- Leave group
- Update group setting
- Get group invite
- Revoke group invite
- Add group participant
- Remove group participant
- Get group icon
- Set group icon
- Delete group icon
- Demote group admin
- Promote to group admin
- Send group invite link
- Get group info by invite code
- Get list of join requests to the group
- Accept group applications for listed users
- Reject group applications for listed users
- Stories
- Statuses
- Newsletters
- Get newsletters
- Create newsletter
- Find newsletters by filters
- Get recommended newsletters by country
- Get newsletter information
- Delete newsletter
- Edit newsletter
- Subscribe to newsletter
- Unsubscribe from newsletter
- Subscribe to newsletter by invite code
- Unsubscribe from newsletter by invite code
- Subscribe to newsletter updates
- Get newsletter messages
- Create Newsletter admin-invite
- Revoke Newsletter admin-invite
- Accept Newsletter admin-request
- Demote Newsletter admin
- Send newsletter invite link
- Get newsletter info by invite code
- Media
- Blacklist
- Business
- Labels
- Communities
- Get communities
- Create community
- Get community
- Deactivate community
- Revoke community invite
- Unlink group from community
- Link group to community
- Join in community group
- Create group in community
- Change community settings
- Add participants to community
- Remove participants from community
- Promote participants to admin in community
- Demote participants to admin in community
- Get community subgroups
- Schemas
- Sample Schemas
- Schemas
- ResponseError
- Webhook payload
- Events
- Request Mobile Login
- UserProfile request body
- Message text send parameters
- Message image send parameters
- Message video send parameters
- Message short video send parameters
- Message gif send parameters
- Message audio send parameters
- Message voice send parameters
- Message document send parameters
- Message link preview send parameters
- Message location send parameters
- Message live location send parameters
- Message contact send parameters
- Message contact list send parameters
- Message poll send parameters
- Message interactive send parameters
- Message sticker send parameters
- Stories post parameters
- Stories audio post parameters
- Stories audio post parameters
- Stories post parameters
- Forward message parameters
- React to message
- Starred Messages
- Starred Messages
- Archive chat request parameters
- Patch chat request parameters
- Check contact request
- Check contact response
- Message contact from phonebook send parameters
- Send me presence request
- Send presence request
- Create group request
- GroupCreate
- Group invite
- New group
- Update group info request
- Update group settings request
- Message group invite link send parameters
- Create newsletter request
- Newsletter
- Edit newsletter request
- Create newsletter admin-invite request
- Message newsletter link send parameters
- Upload media response
- Business Profile
- Product item
- Message product from catalog send parameters
- Product item
- Message catalog send parameters
- Business Collection
- Business Collection Edit
- Create Label Request
- Create community request
- Create group request
- Change community settings request
- MessageID
- ChatID
- ContactID
- CollectionID
- GroupID
- InviteCode
- LabelID
- MediaID
- MediaMessageType
- NewsletterID
- NewsletterInviteCode
- OrderID
- ProductID
- Sender media
- Chat ID List
- List participants request
- Channel Settings
- Media with upload from URL
- Media with upload from base64
- Media without upload
- Media with upload from file
- Webhook unsubscribe request
- Auth code
- Business Collection
- Business Collection Edit Result
- Collections List
- Business Profile
- Chat
- List of chats
- Group
- List of groups
- Community subgroups
- WA Contact
- List of contacts
- List of join requests
- Group applications change list
- Group info by invite code
- Health response
- Label Associations
- Labels
- Trial limits
- List of Media Files
- Message
- List of messages
- Mobile Login status
- List of newsletters
- Paged list of newsletters
- Order items
- Presence
- Product item
- List of products
- Sent message
- List of view statuses
- ResponseSuccess
- Update settings
- QR code
- UserProfile response
- Business Collection
- Iterator parameters
- UserID
- Business Hours
- Label
- Chats
- Check contact
- Contacts
- Participants list
- Event
- Participant
- Group applications change list
- Group Applications
- Group Application
- Groups
- Channel status
- Media Files
- MessageType
- MessageSource
- StatusEnum
- Content text message
- Content image message
- Content video message
- Content audio message
- Content document message
- Content link preview message
- Content sticker message
- Content location message
- Content live location message
- Content contact message
- Content contacts message
- Message content interactive
- Message content poll
- Message content HSM
- Message content interactive
- Message content order
- Content newsletter admin invite message
- Message content product
- Message content product items
- Message action
- Message context
- Message content event
- Message content list
- Message content buttons
- Message reactions
- Message content
- Message content event
- Message content reply
- Media file
- Message voice unique parameters
- View once
- VCard
- Message document unique parameters
- Buttons
- Message text unique parameters
- Button
- Message image or video unique parameters
- Message interactive unique parameters
- Preview link send parameters
- Currency
- Message poll unique parameters
- Poll results
- Buttons reply
- Buttons reply
- Message sticker unique parameters
- Size
- List of messages
- Message advertisement
- Message conversion
- Interactive action
- InteractiveType
- Message audio unique parameters
- Emoji
- Messages
- Mobile Login method
- Newsletters
- Paging
- Product item
- Products
- Error
- Send message parameters
- Message media file parameters for send
- Mentions
- Message gif unique parameters
- Message poll unique parameters
- Media
- Webhooks
- Statuses
- Uploaded media
- Message update
- View status
- Chat update
- Contact update
- Participant event
- Group update
- Call event
- Webhook
- Webhook Event Type
- WebhookParameters
- Button
- List
- List of buttons
- Product fields
- Response
- Health
- Error
- GetSettings
- Success
- UpdateSettings
- UserLogin
- AuthCode
- MobileLogin
- UserProfile
- Messages
- SentMessage
- Message
- Chats
- Chat
- Contacts
- Contact
- Presence
- Groups
- Group
- ResponseListParticipants
- GroupInfoByInviteCode
- GroupApplications
- GroupApplicationsChange
- Statuses
- Newsletters
- NewslettersListPaged
- Newsletter
- MediaFiles
- BusinessProfile
- Products
- Product
- OrderItems
- BusinessCollectionEditResult
- BusinessCollectionList
- BusinessCollection
- Labels
- Label
- Limits
- CommunityList
- Community
- CommunitySubGroups
- RequestBodies
📹 Send media-short video message (PTV)
POST
/messages/short
Maintainer:Not configured
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Body Params multipart/form-data
Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/messages/short' \
--header 'Authorization: Bearer <token>'Responses
🟢201Created
application/json
Body
Example
{
"sent": true,
"message": {
"id": "string",
"type": "text",
"subtype": "string",
"chat_id": "string",
"chat_name": "string",
"from": "string",
"from_me": true,
"from_name": "string",
"source": "text",
"timestamp": 0,
"device_id": 0,
"status": "failed",
"text": {
"body": "string",
"buttons": [
{
"type": "quick_reply",
"title": "string",
"id": "string",
"copy_code": "string",
"phone_number": "string",
"url": "string",
"merchant_url": "string"
}
],
"sections": [
{
"title": "string",
"rows": [
{
"title": "string",
"description": "string",
"id": "string"
}
],
"product_items": [
{
"catalog_id": "string",
"product_id": "string"
}
]
}
],
"button": "string",
"view_once": true
},
"image": {
"id": "string",
"link": "string",
"mime_type": "string",
"file_size": 0,
"file_name": "string",
"sha256": "string",
"timestamp": 0,
"caption": "string",
"preview": "string",
"width": 0,
"height": 0,
"buttons": [
{
"type": "quick_reply",
"title": "string",
"id": "string",
"copy_code": "string",
"phone_number": "string",
"url": "string",
"merchant_url": "string"
}
],
"view_once": true
},
"video": {
"id": "string",
"link": "string",
"mime_type": "string",
"file_size": 0,
"file_name": "string",
"sha256": "string",
"timestamp": 0,
"caption": "string",
"preview": "string",
"width": 0,
"height": 0,
"seconds": 0,
"autoplay": true,
"buttons": [
{
"type": "quick_reply",
"title": "string",
"id": "string",
"copy_code": "string",
"phone_number": "string",
"url": "string",
"merchant_url": "string"
}
],
"view_once": true
},
"short": {
"id": "string",
"link": "string",
"mime_type": "string",
"file_size": 0,
"file_name": "string",
"sha256": "string",
"timestamp": 0,
"caption": "string",
"preview": "string",
"width": 0,
"height": 0,
"seconds": 0,
"autoplay": true,
"buttons": [
{
"type": "quick_reply",
"title": "string",
"id": "string",
"copy_code": "string",
"phone_number": "string",
"url": "string",
"merchant_url": "string"
}
],
"view_once": true
},
"gif": {
"id": "string",
"link": "string",
"mime_type": "string",
"file_size": 0,
"file_name": "string",
"sha256": "string",
"timestamp": 0,
"caption": "string",
"preview": "string",
"width": 0,
"height": 0,
"seconds": 0,
"autoplay": true,
"buttons": [
{
"type": "quick_reply",
"title": "string",
"id": "string",
"copy_code": "string",
"phone_number": "string",
"url": "string",
"merchant_url": "string"
}
],
"view_once": true
},
"audio": {
"id": "string",
"link": "string",
"mime_type": "string",
"file_size": 0,
"file_name": "string",
"sha256": "string",
"timestamp": 0,
"seconds": 0,
"recording_time": 0,
"view_once": true
},
"voice": {
"id": "string",
"link": "string",
"mime_type": "string",
"file_size": 0,
"file_name": "string",
"sha256": "string",
"timestamp": 0,
"seconds": 0,
"recording_time": 0,
"view_once": true
},
"document": {
"id": "string",
"link": "string",
"mime_type": "string",
"file_size": 0,
"file_name": "string",
"sha256": "string",
"timestamp": 0,
"caption": "string",
"filename": "string",
"page_count": 0,
"preview": "string",
"buttons": [
{
"type": "quick_reply",
"title": "string",
"id": "string",
"copy_code": "string",
"phone_number": "string",
"url": "string",
"merchant_url": "string"
}
],
"view_once": true
},
"link_preview": {
"body": "string",
"url": "string",
"id": "string",
"link": "string",
"sha256": "string",
"catalog_id": "string",
"newsletter_id": "string",
"invite_code": "string",
"title": "string",
"description": "string",
"canonical": "string",
"preview": "string",
"view_once": true
},
"sticker": {
"id": "string",
"link": "string",
"mime_type": "string",
"file_size": 0,
"file_name": "string",
"sha256": "string",
"timestamp": 0,
"animated": true,
"width": 0,
"height": 0,
"preview": "string",
"view_once": true
},
"location": {
"latitude": 0,
"longitude": 0,
"address": "string",
"name": "string",
"url": "string",
"preview": "string",
"accuracy": 0,
"speed": 0,
"degrees": 0,
"comment": "string",
"view_once": true
},
"live_location": {
"latitude": 0,
"longitude": 0,
"accuracy": 0,
"speed": 0,
"degrees": 0,
"caption": "string",
"sequence_number": 0,
"time_offset": 0,
"preview": "string",
"view_once": true
},
"contact": {
"name": "string",
"vcard": "string",
"view_once": true
},
"contact_list": {
"list": [
{
"name": "string",
"vcard": "string"
}
],
"view_once": true
},
"interactive": {
"header": {
"text": "string"
},
"body": {
"text": "string"
},
"footer": {
"text": "string"
},
"action": {
"list": {
"sections": [
{
"title": "string",
"rows": [
{
"title": "string",
"description": "string",
"id": "string"
}
]
}
],
"label": "string"
},
"buttons": [
{
"type": "quick_reply",
"title": "string",
"id": "string",
"copy_code": "string",
"phone_number": "string",
"url": "string",
"merchant_url": "string"
}
],
"product": {
"catalog_id": "string",
"product_id": "string"
}
},
"type": "button",
"id": "string",
"link": "string",
"mime_type": "string",
"file_size": 0,
"file_name": "string",
"sha256": "string",
"timestamp": 0,
"view_once": true
},
"poll": {
"title": "string",
"options": [
"string",
"string"
],
"vote_limit": 0,
"total": 0,
"results": [
{
"id": "string",
"name": "string",
"count": 0,
"voters": [
"string"
]
}
],
"view_once": true
},
"hsm": {
"header": {
"type": "text",
"text": {
"body": "string"
},
"image": {
"id": "string",
"link": "string",
"mime_type": "string",
"file_size": 0,
"file_name": "string",
"sha256": "string",
"timestamp": 0
},
"video": {
"id": "string",
"link": "string",
"mime_type": "string",
"file_size": 0,
"file_name": "string",
"sha256": "string",
"timestamp": 0
},
"document": {
"id": "string",
"link": "string",
"mime_type": "string",
"file_size": 0,
"file_name": "string",
"sha256": "string",
"timestamp": 0
},
"location": {
"latitude": 0,
"longitude": 0,
"address": "string",
"name": "string",
"url": "string",
"preview": "string",
"accuracy": 0,
"speed": 0,
"degrees": 0,
"comment": "string",
"view_once": true
}
},
"body": "string",
"footer": "string",
"buttons": [
{
"id": "string",
"type": "simple",
"text": "string",
"url": "string",
"phone_number": "string",
"copy_code": "string"
}
]
},
"system": {
"body": "string"
},
"order": {
"order_id": "string",
"seller": "string",
"title": "string",
"text": "string",
"token": "string",
"item_count": 0,
"currency": "USD",
"total_price": 0,
"status": "new",
"preview": "string"
},
"group_invite": {
"body": "string",
"url": "string",
"id": "string",
"link": "string",
"sha256": "string",
"catalog_id": "string",
"newsletter_id": "string",
"invite_code": "string",
"title": "string",
"description": "string",
"canonical": "string",
"preview": "string",
"view_once": true
},
"newsletter_invite": {
"body": "string",
"url": "string",
"id": "string",
"link": "string",
"sha256": "string",
"catalog_id": "string",
"newsletter_id": "string",
"invite_code": "string",
"title": "string",
"description": "string",
"canonical": "string",
"preview": "string",
"view_once": true
},
"admin_invite": {
"body": "string",
"newsletter_id": "string",
"newsletter_name": "string",
"expiration": 0,
"preview": "string"
},
"product": {
"catalog_id": "string",
"product_id": "string"
},
"catalog": {
"body": "string",
"url": "string",
"id": "string",
"link": "string",
"sha256": "string",
"catalog_id": "string",
"newsletter_id": "string",
"invite_code": "string",
"title": "string",
"description": "string",
"canonical": "string",
"preview": "string",
"view_once": true
},
"product_items": {
"type": "list"
},
"action": {
"target": "string",
"type": "edited",
"emoji": "string",
"ephemeral": 0,
"edited_type": "text",
"edited_content": {
"body": "string",
"buttons": [
{
"type": "quick_reply",
"title": "string",
"id": "string",
"copy_code": "string",
"phone_number": "string",
"url": "string",
"merchant_url": "string"
}
],
"sections": [
{
"title": "string",
"rows": [
{
"title": "string",
"description": "string",
"id": "string"
}
],
"product_items": [
{
"catalog_id": "string",
"product_id": "string"
}
]
}
],
"button": "string",
"view_once": true
},
"votes": [
"string"
],
"comment": "string",
"event_response": {
"participant": "string",
"response": "UNKNOWN",
"timestamp": 1675964377
}
},
"context": {
"forwarded": true,
"forwarding_score": 0,
"mentions": [
"string"
],
"ad": {
"advertiser_name": "string",
"media_type": "image",
"preview": "string",
"preview_url": "string",
"title": "string",
"body": "string",
"media_url": "string",
"source": {
"id": "string",
"type": "string",
"url": "string"
},
"auto_reply": true,
"attrib": true,
"ctwa": "string",
"ref": "string"
},
"conversion": {
"source": "string",
"data": "string",
"delay": 0
},
"quoted_id": "string",
"quoted_type": "text",
"quoted_content": {
"body": "string",
"buttons": [
{
"type": "quick_reply",
"title": "string",
"id": "string",
"copy_code": "string",
"phone_number": "string",
"url": "string",
"merchant_url": "string"
}
],
"sections": [
{
"title": "string",
"rows": [
{
"title": "string",
"description": "string",
"id": "string"
}
],
"product_items": [
{
"catalog_id": "string",
"product_id": "string"
}
]
}
],
"button": "string",
"view_once": true
},
"quoted_author": "string",
"ephemeral": 0
},
"event": {
"is_canceled": false,
"name": "Some name",
"description": "Some description",
"join_link": "https://call.whatsapp.com/voice/K5IFl19olpzTLsh52A0G9R",
"start": 1675964377,
"responses": [
{
"participant": "string",
"response": "UNKNOWN",
"timestamp": 1675964377
}
]
},
"list": {
"header": "string",
"body": "string",
"label": "string",
"footer": "string",
"sections": [
{
"title": "string",
"rows": [
{
"id": "string",
"title": "string",
"description": "string"
}
]
}
]
},
"buttons": {
"text": "string",
"footer": "string",
"buttons": [
{
"id": "string",
"text": "string",
"type": "UNKNOWN"
}
]
},
"reactions": [
{
"id": "string",
"emoji": "string",
"group_key": "string",
"t": 0,
"unread": true,
"count": 0
}
],
"labels": [
{
"id": "string",
"name": "string",
"color": "salmon",
"count": 1
}
]
}
}🟠400Bad Request
🟠401Unauthorized
🟠402402
🟠403Forbidden
🟠404Record Not Found
🟠413413
🟠415415
🟠429429
🔴500Server Error
Modified at 2025-03-19 10:29:02