{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"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.\n\n- Change **server-address.com** To Our **Main Web Address**\n    \n\n<u><b>Parameters For API<br></b></u>\n\n| Parameter | **Type** | Description |\n| --- | --- | --- |\n| api_key | required | Your Api Key |\n| mobile | required | Phone with international format e.g. 923001234567 |\n| message | required | Text Message |\n| priority | optional | This parameter is optional, You can use it to create a professional queue for messages  <br>The Messages with less priority value are sent first.  <br>  <br>example of usage :  <br>**priority = 0**: for High priority like OTP messages.  <br>**priority = 10**: used with general messages.  <br>**priority =20**: Non-urgent notifications to your customers.  <br>**priority =30**: Non-urgent promotional offers to your customers.  <br>Default value : 10 |\n| type | required | **0**\\=Text, **1**\\= Images, **2**\\= Documents  <br>Default Value: 0=Text  <br>  <br>**type=1**, send images  <br>Supported extensions ( jpg , jpeg , gif , png , svg , webp , bmp ) .  <br>Max file size : 3 MB .  <br>  <br>**type=2,** send documents  <br>Supported most extensions like ( zip , xlsx , csv , pptx , docx ....etc )  <br>Max file size : 3 MB |\n| url | optional | image / documents HTTP Link (if type = 1 or 2)  <br>  <br>**Sample**: [https://sample-videos.com/img/Sample-jpg-image-50kb.jpg](https://sample-videos.com/img/Sample-jpg-image-50kb.jpg)  <br>  <br>**Example**: [https://server-address.com/api/send.php?api_key=???&amp;mobile=923???&amp;type=1&amp;url=https://sample-videos.com/img/Sample-jpg-image-50kb.jpg&amp;caption=ImageCaption&amp;priority=0](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) |\n| file | optional | Use the following parameter file to send a direct file instead of any URL (POST Method using form-data )  <br>**Example**:  <br>  <br>**file**\\=C:/Users/Downloads/sample.jpg |\n| schedule | optional | **schedule=1**  <br>**schedule_time**\\=2023-12-22 05:38:06  <br>Example:  <br>[https://server-address.com/api/send.php?api_key=???&amp;mobile=923???&amp;message=HelloWorld&amp;schedule=1&amp;schedule_time=2023-12-22%2005:38:06&amp;priority=0](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) |\n| personalized | optional | Send Customized SMS (Text Data Will Be Change In Each & Every Messages)  <br>**personalized=1**  <br>**message=**\\[{\"mobile\":923101234567,\"message\":\"Hello Ahmad Shahzad\"},{\"mobile\":923011234567,\"message\":\"Hello Ali Ahmad\"},{\"mobile\":923331234567,\"message\":\"Hello Mustafa Kamal\"}\\]  <br>  <br>**Example**:  <br>[https://server-address.com/api/send.php?api_key=???&amp;mobile=923???&amp;personalized=1&amp;message=[{\"mobile\":923101234567,\"message\":\"Hello%20%20Ahmad%20Shahzad\"},{\"mobile\":923011234567,\"message\":\"Hello%20%20Ali%20Ahmad\"},{\"mobile\":923331234567,\"message\":\"Hello%20%20Mustafa%20Kamal\"}]&amp;priority=0](https://server-address.com/api/send.php?api_key=???&mobile=923???&personalized=1&message=%5B%7B%22mobile%22:923101234567,%22message%22:%22Hello%20%20Ahmad%20Shahzad%22%7D,%7B%22mobile%22:923011234567,%22message%22:%22Hello%20%20Ali%20Ahmad%22%7D,%7B%22mobile%22:923331234567,%22message%22:%22Hello%20%20Mustafa%20Kamal%22%7D%5D&priority=0) |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"9576087","collectionId":"431d12ec-2756-4d09-8583-2b9db1129deb","publishedId":"2s9Ykraevk","public":true,"publicUrl":"https://documenter-api.postman.tech/view/9576087/2s9Ykraevk","privateUrl":"https://go.postman.co/documentation/9576087-431d12ec-2756-4d09-8583-2b9db1129deb","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"WhatsApp API gateway for chatbot and sending WhatsApp messages, media, transactional campaigns for PHP, nodejs , JavaScript, and Python"},{"name":"title","value":"WHATSAPP API"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2023-12-22T08:10:33.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"WHATSAPP API","description":"WhatsApp API gateway for chatbot and sending WhatsApp messages, media, transactional campaigns for PHP, nodejs , JavaScript, and Python"},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s9Ykraevk"}