Public
Documentation Settings
No Environment
Double Column
cURL - cURL
Whatsapp API
Introduction
POST
Send Text Message
POST
Send Image Message
POST
Send Document Message
POST
Send Dynamic Message
POST
Send Schedule Message
POST
Receive Incoming Message
POST
Check WhatsApp Availability
GET
getGroups
POST
Send Group Message

Whatsapp API

This documentation will provide instructions on how to quickly integrate whatsapp messaging services into various solutions by using HTTP API.

  • Change server-address.com To Our Main Web Address

Parameters For API

ParameterTypeDescription
api_keyrequiredYour Api Key
mobilerequiredPhone with international format e.g. 923001234567
messagerequiredText Message
priorityoptionalThis parameter is optional, You can use it to create a professional queue for messages
The Messages with less priority value are sent first.

example of usage :
priority = 0: for High priority like OTP messages.
priority = 10: used with general messages.
priority =20: Non-urgent notifications to your customers.
priority =30: Non-urgent promotional offers to your customers.
Default value : 10
typerequired0=Text, 1= Images, 2= Documents
Default Value: 0=Text

type=1, send images
Supported extensions ( jpg , jpeg , gif , png , svg , webp , bmp ) .
Max file size : 3 MB .

type=2, send documents
Supported most extensions like ( zip , xlsx , csv , pptx , docx ....etc )
Max file size : 3 MB
urloptionalimage / documents HTTP Link (if type = 1 or 2)

Sample: https://sample-videos.com/img/Sample-jpg-image-50kb.jpg

Example: https://server-address.com/api/send.php?api_key=???&mobile=923???&type=1&url=https://sample-videos.com/img/Sample-jpg-image-50kb.jpg&caption=ImageCaption&priority=0
fileoptionalUse the following parameter file to send a direct file instead of any URL (POST Method using form-data )
Example:

file=C:/Users/Downloads/sample.jpg
scheduleoptionalschedule=1
schedule_time=2023-12-22 05:38:06
Example:
https://server-address.com/api/send.php?api_key=???&mobile=923???&message=HelloWorld&schedule=1&schedule_time=2023-12-22%2005:38:06&priority=0
personalizedoptionalSend Customized SMS (Text Data Will Be Change In Each & Every Messages)
personalized=1
**message=**[{"mobile":923101234567,"message":"Hello Ahmad Shahzad"},{"mobile":923011234567,"message":"Hello Ali Ahmad"},{"mobile":923331234567,"message":"Hello Mustafa Kamal"}]

Example:
https://server-address.com/api/send.php?api_key=???&mobile=923???&personalized=1&message=[{"mobile":923101234567,"message":"Hello%20%20Ahmad%20Shahzad"},{"mobile":923011234567,"message":"Hello%20%20Ali%20Ahmad"},{"mobile":923331234567,"message":"Hello%20%20Mustafa%20Kamal"}]&priority=0