API REST - Waboxapp

3y ago
77 Views
2 Downloads
186.83 KB
10 Pages
Last View : 4d ago
Last Download : 4m ago
Upload by : Javier Atchley
Transcription

API RESTBasic om/apiGET / POSTStandard HTTP format (application/x-www-form-urlencoded)JSON formatHTTP 200 code and “success” field when action is successfully doneHTTP 403 code and “error” field on authentication failureHTTP 400 code and “error” field on parameters validation failure

Send text message hatGET / POSTMandatory parameterstokenYour waboxapp API token or Yourenabled APP tokenuidYour account phone number withinternational codetoRecipient account phone number withinternational codecustom uidYour custom unique ID for the newmessage to be sendtextText to be sendResponse: JSON formatsuccessMessage successfully received bywaboxappcustom uidYour custom unique ID for this messageEx. 34666123456Ex. 34666789123Must be uniqueWill be sent back to you onACK eventsHello dude!trueEx. /send/chat?token my token&uid 34666123456&to 34666789123&custom uid msg0001&text Hello dude{"success": true,"custom uid": msg0001}

Send ageGET / POSTMandatory parameterstokenYour waboxapp API token or Yourenabled APP tokenuidYour account phone number withinternational codetoRecipient account phone number withinternational codecustom uidYour custom unique ID for the newmessage to be sendurlURL of image to sendOptional parameterscaptionTitle to show on image previewdescriptionExtended description to show on imagepreviewResponse: JSON formatsuccessMessage successfully received bywaboxappcustom uidYour custom unique ID for this messageEx. 34666123456Ex. 34666789123Must be uniqueWill be sent back to you onACK eventsEx. https://go.gl/image.pngEx. A cute dogEx. This is just a test of imagesendingtrueEx. SJER345FL56

Send link (with /linkGET / POSTMandatory parameterstokenYour waboxapp API token or Yourenabled APP tokenuidYour account phone number withinternational codetoRecipient account phone number withinternational codecustom uidYour custom unique ID for the newmessage to be sendurlURL of link to sendOptional parameterscaptionTitle to show on link previewdescriptionExtended description to show on linkpreviewurl thumbURL of thumb image to show on linkpreviewResponse: JSON formatsuccessMessage successfully received bywaboxappcustom uidYour custom unique ID for this messageEx. 34666123456Ex. 34666789123Must be uniqueWill be sent back to you onACK eventsEx. https://mysite.com/homeEx. My siteEx. The best place to stay overall InternetEx. https://go.gl/image.pngtrueEx. SJER345FL56Note: When a link caption, description or url thumb are not provided, they are taken from linkitself metada.

Send media (any kind of diaGET / POSTMandatory parameterstokenYour waboxapp API token or Yourenabled APP tokenuidYour account phone number withinternational codetoRecipient account phone number withinternational codecustom uidYour custom unique ID for the newmessage to be sendurlURL of file to sendOptional parameterscaptionTitle to show on file previewdescriptionExtended description to show on filepreviewurl thumbURL of thumb image to show on filepreviewResponse: JSON formatsuccessMessage successfully received bywaboxappcustom uidYour custom unique ID for this messageEx. 34666123456Ex. 34666789123Must be uniqueWill be sent back to you onACK eventsEx. https://go.gl/doc.pdfEx. Our documentEx. PDF with detailedarguments about or missionEx. https://go.gl/icon.pngtrueEx. SJER345FL56

Check account (phone number) /[uid]GET / POSTMandatory parameterstokenYour waboxapp API token or Yourenabled APP token[uid]In-URL parameterYour account phone number withinternational codeResponse: JSON formatsuccessMessage successfully received bywaboxappuidYour account phone number withinternational codehook urlAccount URL for web hooksaliasYour account nameplatformYour smartphone platformbatteryYour smartphone battery percentagepluggedIndicates whether your smartphone isplugged and charginglocaleYour web session localeEx. 34666123456trueEx. 34666123456Ex. http://reqb.in/ABCEx. 0/1Ex. en-GBExamplePOST ken my token{"success": true,"uid": "34666123456","hook url": " http://reqb.in/ABC ","alias": "My WA account","platform": "android","battery": "69","plugged": "0","locale": "en-GB"}

Events notification (hooks) in real timeWebhooks are calls made to your custom URL when any event gets fired. You can define yourown hooks URL at client and account levels.Event: New message receivedURLMethodwaboxapp will call your URLPOSTRequest (POST form)eventmessagetokenYour waboxapp API token or Yourenabled APP tokenuidYour account phone number withinternational codecontact[uid]Sender account phone numbercontact[name]Sender account namecontact[type]Sender ir]Message sent timestampIM unique ID for this messageYour custom unique ID for this message,if sent by youMessage directionmessage[type]Message typemessage[body]Message content. It depends conmessage[type]Acknowledge status for this messageackExamplePOST https://requestb.in/xh9tvh{"event": "message","token": "abcd1234","contact[uid]": "34666123456","contact[name]": "Peter","contact[type]": "user","message[dtm]": 1487082303,"message[uid]": "62397B58E3E0B","message[cuid]": "","message[dir]": "i","message[type]": "chat",Ex. 34666123456Ex. 34666123456Ex. PeterEx. userEx. groupEx. 1487082303Ex. 62397B58E3E0BEx: i (input)Ex: o (output)Ex: chat, image, video, audio,document, vcard, locationSee messages types appendixfor detailsSee messages ACK statusappendix for details

"message[body][text]": "Hey! How are you doing?","message[ack]": 3}Event: Message acknowledge (ACK)URLMethodwaboxapp will call your URLPOSTRequest (POST form)eventacktokenYour waboxapp API token or Yourenabled APP tokenuidYour account phone number withinternational codemuidIM unique ID for this messagecuidYour custom unique ID for this message,if sent by youackAcknowledge status for this messageExamplePOST https://requestb.in/xh9tvh{"event": "ack","token": "abcd1234","uid": "74397B58E3ELZ","cuid": "your-cutom-id","ack": 3}Ex. 34666123456Ex. 62397B58E3E0BSee messages ACK statusappendix for details

Appendix: Messages typesTypechatimagevideoaudioptt(recorded audio)documentvcardlocationBody structuretext – Message textcaption – Media captionmimetype – Media mime typesize – Media size in bytesthumb – Media thumb preview in base64url – Media URL (15-day retention)caption – Media captionmimetype – Media mime typesize – Media size in bytesduration – Media duration in secondsthumb – Media thumb preview in base64url – Media URL (15-day retention)caption – Media captionmimetype – Media mime typesize – Media size in bytesduration – Media duration in secondsurl – Media URL (15-day retention)caption – Media captionmimetype – Media mime typesize – Media size in bytesduration – Media duration in secondsurl – Media URL (15-day retention)caption – Media captionmimetype – Media mime typesize – Media size in bytesthumb – Media thumb preview in base64url – Media URL (15-day retention)contact – Contact namevcard – vCard contentname – Place namelng – Longitude coordinatelat – Latitude coordinatethumb – Place map preview in base64url – Place URL

Appendix: Acknowledge (ACK) statusType0123Body structureMessage still not sent to IM serversMessage sent to IM serversMessage delivered to recipientMessage read by recipient(note: it can be masked as status “2” depending on recipient’s privacysettings)

Events notification (hooks) in real time Webhooks are calls made to your custom URL when any event gets fired. You can define your own hooks URL at client and account levels.

Related Documents:

Cisco Nexus 1000V for VMware vSphere REST API Plug-in Configuration Guide, Release 5.x 13 Using the REST API Plug-in Increase max-port via REST. Cisco Nexus 1000V for VMware vSphere REST API Plug-in Configuration Guide, Release 5.x 14 Using the REST API Plug-in Feature History for Using the REST API Plug-in.

api 20 e rapid 20e api 20 ne api campy api nh api staph api 20 strep api coryne api listeriaapi 20 c aux api 20 a rapid id 32 a api 50 ch api 50 chb/e 50 chl reagents to be ordered. strips ref microorganisms suspension inoculum transfer medium i

Latest API exams,latest API-571 dumps,API-571 pdf,API-571 vce,API-571 dumps,API-571 exam questions,API-571 new questions,API-571 actual tests,API-571 practice tests,API-571 real exam questions Created Date

consider using Bulk API, which is based on REST principles and optimized for large sets of data. Using Compression REST API uses the same underlying data model and standard objects as those in SOAP API . See the SOAP API Developer's Guide for details. REST API also follows the same limits as SOAP API . See the Limits section

The Avamar REST API provides an API to develop applications and tools that interact with Avamar systems. The Avamar REST API uses client/server communication which is based on the representational state transfer (REST) API architecture model. Programming interface When using the Avamar REST API, write the code that can manage multiple Avamar

3 API Industry Guide on API Design Apiary - Apiary jump-started the modern API design movement by making API definitions more than just about API documentation, allowing API designers to define APIs in the machine-readable API definition format API blueprint, then mock, share, and publish

Apr 12, 2018 · consider using Bulk API, which is based on REST principles and optimized for large sets of data. Using Compression REST API uses the same underlying data model and standard objects as those in SOAP API. See the SOAP API Developer Guide for details. REST API also follows the same li

May 01, 2014 · API RP 580 API RP 580—Risk-Based Inspection API RP 581 API RP 581—Risk-Based Inspection Technology API RP 941 API RP 941—Steels for Hydrogen Service at Elevated Temperatures and Pressures in Petroleum Refineries and Petrochemical Plants API RP1 API Recommended Practices. API