Standard HTTP format (application/x-www-form-urlencoded)

Transcription

1 API REST Basic concepts Requests Responses GET / Standard HTTP format (application/x-www-form-urlencoded) JSON format HTTP 200 code and success field when action is successfully done HTTP 403 code and error field on authentication failure HTTP 400 code and error field on parameters validation failure

2 Send WhatsApp text (chat) GET / Mandatory parameters Your waboxapp API or Your enabled APP to Recipient WhatsApp account phone Ex custom_ Your custom unique ID for the new to be send Will be sent b to you on ACK events text Text to be send Hello dude! Response: JSON format success Message successfully received by waboxapp custom_ Your custom unique ID for this true Ex. SJER345FL &custom_=msg0001&text=Hello+dude "success": true, "custom_": msg0001 Events notification (hooks) in real time Webhooks are calls made to your custom when any event gets fired. You can define your own hooks at client and account levels.

3 Event: New received waboxapp will call your Request ( form) event Your waboxapp API or Your enabled APP contact[] Sender WhatsApp account phone Ex number contact[name] Sender WhatsApp account name Ex. Peter contact[type] Sender type Ex. user Ex. group [dtm] Message sent timestamp Ex [] WhatsApp unique ID for this Ex B58E3E0B [c] Your custom unique ID for this, if sent by you [dir] Message direction Ex: i (input) Ex: o (output) [type] Message type Ex: chat, image, video, audio, document, vcard, location [body] Message content. It depends con [type] WhatsApp nowledge status for this See s types appendix for details See s ACK status appendix for details "event": "", "": "abcd1234", "contact[]": " ", "contact[name]": "Peter", "contact[type]": "user", "[dtm]": , "[]": "62397B58E3E0B", "[c]": "", "[dir]": "i", "[type]": "chat", "[body][text]": "Hey! How are you doing?", "[]": 3

4 Event: Message nowledge (ACK) waboxapp will call your Request ( form) event Your waboxapp API or Your enabled APP m WhatsApp unique ID for this Ex B58E3E0B c Your custom unique ID for this, if sent by you WhatsApp nowledge status for this See s ACK status appendix for details "event": "", "": "abcd1234", "": "74397B58E3ELZ", "c": "your-cutom-id", "": 3

5 Appendix: Messages types Type chat image video audio document vcard location Body structure text Message text duration Media duration in seconds duration Media duration in seconds contact Contact name vcard vcard content name Place name lng Longitude coordinate lat Latitude coordinate thumb Place map preview in base64 url Place Appendix: Acknowledge (ACK) status Type Body structure 0 Message still not sent to WhatsApp servers 1 Message sent to WhatsApp servers 2 Message delivered to recipient 3 Message read by recipient (note: it can be masked as status 2 depending on recipient s privacy settings)