{"info":{"_postman_id":"431d12ec-2756-4d09-8583-2b9db1129deb","name":"Whatsapp API","description":"

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

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
api_key	required	Your Api Key
mobile	required	Phone with international format e.g. 923001234567
message	required	Text Message
priority	optional	This 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
type	required	0=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
url	optional	image / 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
file	optional	Use 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
schedule	optional	schedule=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
personalized	optional	Send 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

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"9576087","collectionId":"431d12ec-2756-4d09-8583-2b9db1129deb","publishedId":"2s9Ykraevk","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-12-22T08:10:33.000Z"},"item":[{"name":"Send Text Message","id":"5cc2a928-0769-45ab-98f1-18557b90a128","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"api_key","value":"YOUR_API_KEY","description":"

Your API-Key (Login Your Account Get It From Your Profile Or API Menu)

\n","type":"text"},{"key":"mobile","value":"92XXXX","description":"

Recipient Mobile Number (International Format) i.e 234xxx,234xxx,234xxx

\n","type":"text"},{"key":"message","value":"Hello World","description":"

Text Message

\n","type":"text"},{"key":"priority","value":"0","description":"

Message Queue (0 = Instant Delivery)

\n","type":"text"},{"key":"type","value":"0","description":"

Message Type (0=Text, 1=Image, 2=Documents)

\n","type":"text"}]},"url":"https://server-address.com/api/send.php","urlObject":{"protocol":"https","path":["api","send.php"],"host":["server-address","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5cc2a928-0769-45ab-98f1-18557b90a128"},{"name":"Send Image Message","id":"b2ec1d84-5c57-4b15-b00c-54278d6b07d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"api_key","value":"YOUR_API_KEY","description":"

Your API-Key (Login Your Account Get It From Your Profile Or API Menu)

\n","type":"text"},{"key":"mobile","value":"923XXXX","description":"

Recipient Mobile Number (International Format) i.e 234xxx,234xxx,234xxx

\n","type":"text"},{"key":"priority","value":"0","description":"

Message Queue (0 = Instant Delivery)

\n","type":"text"},{"key":"type","value":"1","description":"

Message Type (0=Text, 1=Image, 2=Documents)

\n","type":"text"},{"key":"url","value":"https://sample-videos.com/img/Sample-jpg-image-50kb.jpg","description":"

image Link (HTTP URL Address)

\n","type":"text"},{"key":"file","description":"

Use This Method If You Want To Send Direct Images From Your System

\n","type":"file","value":null,"disabled":true},{"key":"caption","value":"Type Image Caption Here","description":"

Image Caption

\n","type":"text"}]},"url":"https://server-address.com/api/send.php","urlObject":{"protocol":"https","path":["api","send.php"],"host":["server-address","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b2ec1d84-5c57-4b15-b00c-54278d6b07d8"},{"name":"Send Document Message","id":"01a4a697-5820-4f13-af21-b6001f5231af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"api_key","value":"YOUR_API_KEY","description":"

Your API-Key (Login Your Account Get It From Your Profile Or API Menu)

\n","type":"text"},{"key":"mobile","value":"923XXXX","description":"

Recipient Mobile Number (International Format) i.e 234xxx,234xxx,234xxx

\n","type":"text"},{"key":"priority","value":"0","description":"

Message Queue (0 = Instant Delivery)

\n","type":"text"},{"key":"type","value":"2","description":"

Message Type (0=Text, 1=Image, 2=Documents)

\n","type":"text"},{"key":"url","value":"https://www.africau.edu/images/default/sample.pdf","description":"

Document Link (HTTP URL Address)

\n","type":"text"},{"key":"file","description":"

Use This Method If You Want To Send Direct Images From Your System

\n","type":"file","value":null,"disabled":true},{"key":"caption","value":"Type Your Document Caption Here","description":"

Document Caption

\n","type":"text"}]},"url":"https://server-address.com/api/send.php","urlObject":{"protocol":"https","path":["api","send.php"],"host":["server-address","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"01a4a697-5820-4f13-af21-b6001f5231af"},{"name":"Send Dynamic Message","id":"56914425-0005-4528-9c64-4a251d10ef4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"api_key","value":"YOUR_API_KEY","description":"

Your API-Key (Login Your Account Get It From Your Profile Or API Menu)

\n","type":"text"},{"key":"personalized","value":"1","type":"text"},{"key":"type","value":"0","description":"

Message Type (0=Text, 1=Image)

\n","type":"text"},{"key":"priority","value":"30","description":"

Message Queue (0 = Instant Delivery)

\n","type":"text"},{"key":"message","value":"[{\"mobile\":923101234567,\"message\":\"Hello Ahmad Shahzad\"},{\"mobile\":923011234567,\"message\":\"Hello Ali Ahmad\"},{\"mobile\":923331234567,\"message\":\"Hello Mustafa Kamal\"}]","description":"

specificed format in json

\n","type":"text"},{"key":"url","value":"https://sample-videos.com/img/Sample-jpg-image-50kb.jpg","description":"

if want to send image with with dynamic text caption then type=1

\n","type":"text","disabled":true}]},"url":"https://server-address.com/api/send.php","description":"

You can personalize your messages by adding the recipients first name, surname, account number etc, to the text or image messages that you send out. Personalizing your messages allows you to send messages with unique information for each contact in your database.

\n","urlObject":{"protocol":"https","path":["api","send.php"],"host":["server-address","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"56914425-0005-4528-9c64-4a251d10ef4f"},{"name":"Send Schedule Message","id":"e89fe445-0716-4efa-b080-85235840639f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"api_key","value":"YOUR_API_KEY","description":"

Your API-Key (Login Your Account Get It From Your Profile Or API Menu)

\n","type":"text"},{"key":"mobile","value":"923XXX","description":"

Recipient Mobile Number (International Format) i.e 234xxx,234xxx,234xxx

\n","type":"text"},{"key":"message","value":"Hello World","description":"

Text Message

\n","type":"text"},{"key":"priority","value":"0","description":"

Message Queue (0 = Instant Delivery)

\n","type":"text"},{"key":"type","value":"0","description":"

Message Type (0=Text, 1=Image, 2=Documents)

\n","type":"text"},{"key":"schedule","value":"1","description":"

Schedule SMS Parameter

\n","type":"text"},{"key":"schedule_time","value":"2024-12-22 07:18:43","description":"

Schdeule Date Time

\n","type":"text"}]},"url":"https://server-address.com/api/send.php","urlObject":{"protocol":"https","path":["api","send.php"],"host":["server-address","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e89fe445-0716-4efa-b080-85235840639f"},{"name":"Receive Incoming Message","id":"90ee3bfb-a73e-4c6b-9671-baf1f746fd84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"instance_id","value":"1XXX","description":"

Your Instance ID

\n","type":"text"},{"key":"from","value":"92XXXX","description":"

SMS Received From e.g. 923001234567

\n","type":"text"},{"key":"to","value":"92XXXX","description":"

Connected Whatsapp Number In Which New SMS Received

\n","type":"text"},{"key":"notify_name","value":"Contact_Name","description":"

If Name Saved In Your Contact List, Then It Will Send Name As Well

\n","type":"text"},{"key":"message","value":"Text_Message","description":"

Message Content

\n","type":"text"},{"key":"dlr_id","value":"ABCXXXX","description":"

SMS Unique ID

\n","type":"text"},{"key":"datetime","value":"XXX","description":"

Date Time

\n","type":"text"}]},"url":"https://your-server-address.com/incoming_sms_url.php","description":"

To Set Call Back URL For New Incoming Messages Login Your Account & Click On Accounts Menu & Click The Control Button of a Ready Instance, Then Click On Inbox URL Button & Add Your Server URL Address To Receive New Incoming Messages

All New Messages Will Be Delivered On Your Specified URL Address

A POST REQUEST With The Following Paramaters Will Be Receive On Your Defined URL Address

\n","urlObject":{"protocol":"https","path":["incoming_sms_url.php"],"host":["your-server-address","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"90ee3bfb-a73e-4c6b-9671-baf1f746fd84"},{"name":"Check WhatsApp Availability","id":"1e7c045d-125c-4f24-bf47-b1c2e803eacc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"api_key","value":"{{API_KEY}}","type":"text"},{"key":"mobile","value":"{{923xxxx}}","type":"text"},{"key":"type","value":"2","description":"

type=1 for Bulk Check\ntype=2 for LIVE Check

Bulk Check Results Find Here

https://your-server-address.com/dashboard/filter-numbers.php

\n","type":"text"}]},"url":"https://your-server-address.com/api/whatsapp_numbers.php","urlObject":{"protocol":"https","path":["api","whatsapp_numbers.php"],"host":["your-server-address","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1e7c045d-125c-4f24-bf47-b1c2e803eacc"},{"name":"getGroups","id":"828525c6-cdd5-4a98-8d98-296cdbdb494f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-server-address.com/apps/check_group.php?api_key={{API_KEY}}","urlObject":{"protocol":"https","path":["apps","check_group.php"],"host":["your-server-address","com"],"query":[{"key":"api_key","value":"{{API_KEY}}"}],"variable":[]}},"response":[],"_postman_id":"828525c6-cdd5-4a98-8d98-296cdbdb494f"},{"name":"Send Group Message","id":"24c356f1-4ea4-4f4e-881e-1c010b61b508","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"api_key","value":"{{API_KEY}}","description":"

Your API-Key (Login Your Account Get It From Your Profile Or API Menu)

\n","type":"text"},{"key":"group","value":"1","type":"text"},{"key":"mobile","value":"{{GROUP_ID}}","description":"

Provide Your Group ID\nFrom This API\n https://your-server-address.com/apps/check_group.php?api_key=XXXXX

\n","type":"text"},{"key":"message","value":"Hello World","description":"

Text Message

\n","type":"text"},{"key":"priority","value":"0","description":"

Message Queue (0 = Instant Delivery)

\n","type":"text"},{"key":"type","value":"0","description":"

Message Type (0=Text, 1=Image, 2=Documents)

\n","type":"text"}]},"url":"https://your-server-address.com/api/send.php","urlObject":{"protocol":"https","path":["api","send.php"],"host":["your-server-address","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"24c356f1-4ea4-4f4e-881e-1c010b61b508"}]}