Webhook Request & Response
JSON Method Query String Method
In this method you will get data as JSON , you need to specify to push the data in JSON method while setting up Webhook URL
POST https://yourdomain.com/webhook
The “message-in” variable data is URL encoded so you need to decode the same. Online Tools
{"number": "963587413","message-in": "test","type": "2","application": "1","unique-id": "5642","project-id": "27","media-url": "https://upload.wikimedia.org/wikipedia/commons/5/57/PT05_ubt.jpeg","custom-variable": "test"}
Not Support in Phone Automation
{"number":"963587413","type":"7","application":"8","unique-id":"5642","project-id":"27","contact":[{"city":null,"country":"USA","country_code":"in","state":"Kerala","street":null,"address_type":"Home","zip":null,"email":"[email protected]","first_name":"Test","last_name":"User","phone":"+91 99s999 00111","phone_type":"Mobile","contact_image":""},{"city":null,"country":"India","country_code":"in","state":"Kerala","street":null,"address_type":"Home","zip":null,"email":"[email protected]","first_name":"User","last_name":"Test","phone":"+91 9888d8 00222","phone_type":"Mobile","contact_image":""}]}
Not Supported in Phone Automation
{"number":"96343587413","type":"7","application":"8","unique-id":"5642","project-id":"27","Location":{"lat":81.5094267351303,"long":6.969892978668,"name":"Tourism Maldives","address":"Tourism Maldives Magazine, USA","url":"http://pickyassist.com/"}}
Not Supported in Phone Automation
{"number": "91940055074","message-in": "Not+Sure","message_in_raw": "Not Sure","type": 9,"application": "8","unique-id": "52363299","project-id": "10129","direction": 0,"name": "Picky","context-msg-id": "30486936","payload": "confirmbutton"}
If you wish to give instant reply back then give response in JSON format
{"message-out": "Test Instant Reply Back","delay": "0","type": "1"}
For phone automation sending media file takes longer time and make use of Auto Click method, so please make use of the media sending feature only if needed
{"message-out": "Test Instant Reply Back","delay": "0","media-url": "https://upload.wikimedia.org/wikipedia/commons/5/57/PT05_ubt.jpeg","application": "0","type": "2"}
Not supported in phone automation, multiple contacts must pass as an array.
{"type":"7","application":"8","contact":[{"city":null,"country":"USA","country_code":"us","state":"Deleware","street":null,"address_type":"Home","zip":null,"email":"[email protected]","first_name":"Test","last_name":"User","phone":"+1 129999 00111","phone_type":"Mobile","contact_image":""},{"city":null,"country":"India","country_code":"in","state":"Kerala","street":null,"address_type":"Home","zip":null,"email":"[email protected]","first_name":"User","last_name":"Test","phone":"+91 98888 00222","phone_type":"Mobile","contact_image":""}]}
Not supported in phone automation, locations values need to pass in array
{"type":"5","application":"8","location":{"lat":18.5094267351303,"long":76.969892978668,"name":"Tourism Maldives","address":"Tourism Maldives Magazine, Delaware"}}
The response must be in JSON format else reply will not sent to the user and no need to url encode the message-out variable.
In this method data will be posted as query parameter through URL as shown below, this is the default method
POST -> https://yourdomain.com/webhook?number=963587413&message-in=test&type=1&application=1&unique-id=5672&project-id=27&media-url="https://upload.wikimedia.org/wikipedia/commons/5/57/PT05_ubt.jpeg&custom-variable=test
The “message-in” variable data is URL encoded so you need to decode the same. Online Tools
If you wish to give instant reply back then give response in JSON format
{"message-out": "Test Instant Reply Back;","delay": "0"}
This will use broadcast api and takes 10 seconds to send a message
{"message-out": "Test Instant Reply Back;","delay": 0,"media-url": " https://upload.wikimedia.org/wikipedia/commons/5/57/PT05_ubt.jpeg ","application": "0"}
The response must be in JSON format else reply will not sent to the user and no need to url encode the message-out variable.
