This document provides API references for all platforms running on VendApp.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15261322","collectionId":"a2306ca8-dfe7-47ca-87ff-df7b5a8a9ac7","publishedId":"UVXjKwNi","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-01-15T17:41:15.000Z"},"item":[{"name":"SMS","item":[{"name":"Send SMS","id":"7952e051-89b2-4687-9c32-5e525b8c6050","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"action","value":"sms","description":"Required. This is define the action the API is to perform
\n","type":"text"},{"key":"token","value":"api-token","description":"Required. The API token. This can be accessed at Developer Tool -> API Token
\n","type":"text"},{"key":"sender","value":"sender_id","description":"Required. The Sender ID of the message to be sent
\n","type":"text"},{"key":"message","value":"message","description":"Required. The Message to be sent
\n","type":"text"},{"key":"to","value":"phone_numbers","description":"Required. The phone numbers, separated by commas
\n","type":"text"},{"key":"type","value":"type","description":"Required. The message type\n0: Plain Message\n1: Flash plain message\n2: Unicode message\n6: Flash unicode message
\n","type":"text"},{"key":"routing","value":"routing","description":"Required. The routing protocol for the message\n2: Send to non-dnd only. DND is not billed\n3: Send to all phone number including DND, provided a transactional bind is configured
\n","type":"text"},{"key":"ref_id","value":"ref_id","description":"Optional. The ref_id to identify the message group
\n","type":"text"},{"key":"schedule","value":"","description":"Optioinal. Set a future date if the message is to scheduled for a future delivery
\n","type":"text"}]},"url":"BASE_URL/io/api/","description":"The endpoints allows you to send SMS directly from your application.
\n","urlObject":{"path":["io","api",""],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[{"id":"e96e4600-b764-48b9-b859-89395e6e56e4","name":"Send SMS","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"action","value":"sms","description":"Required. This is define the action the API is to perform","type":"text"},{"key":"token","value":"api-token","description":"Required. The API token. This can be accessed at **Developer Tool -> API Token**","type":"text"},{"key":"sender","value":"sender_id","description":"Required. The Sender ID of the message to be sent","type":"text"},{"key":"message","value":"message","description":"Required. The Message to be sent","type":"text"},{"key":"to","value":"phone_numbers","description":"Required. The phone numbers, separated by commas","type":"text"},{"key":"type","value":"type","description":"Required. The message type\n0: Plain Message\n1: Flash plain message\n2: Unicode message\n6: Flash unicode message","type":"text"},{"key":"routing","value":"routing","description":"Required. The routing protocol for the message\n2: Send to non-dnd only. DND is not billed\n3: Send to all phone number including DND, provided a transactional bind is configured","type":"text"},{"key":"ref_id","value":"ref_id","description":"Optional. The ref_id to identify the message group","type":"text"},{"key":"schedule","value":"","description":"Optioinal. Set a future date if the message is to scheduled for a future delivery","type":"text"}]},"url":"BASE_URL/io/api/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 15 Jan 2022 17:35:32 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 1000,\n \"successful\": \"2348000000000\",\n \"basic_successful\": \"\",\n \"corp_successful\": \"\",\n \"simserver_successful\": \"\",\n \"simserver_shared\": \"\",\n \"simserver_failed\": \"\",\n \"simserver_distribution\": [],\n \"failed\": \"\",\n \"flooding\": \"\",\n \"insufficient_unit\": \"\",\n \"invalid\": \"\",\n \"all_numbers\": \"2348000000000\",\n \"nondnd_numbers\": \"2348000000000\",\n \"dnd_numbers\": \"\",\n \"units_used\": \"4.00\",\n \"units_calculated\": \"4.00\",\n \"units_before\": \"3075.0000\",\n \"units_after\": \"3071.0000\",\n \"sms_pages\": 1,\n \"simhost\": \"\",\n \"message_id\": \"vendsms-20220115-Ee6xAB56F7jceZCve0gJK83098GC3MJynfGBZzx\",\n \"ref_id\": \"00010020020\",\n \"comment\": \"Completed Successfully\"\n}"}],"_postman_id":"7952e051-89b2-4687-9c32-5e525b8c6050"}],"id":"63aac694-defa-4afd-807a-a276b8819083","description":"Find the collection of all endpoints relating to SMS below.
\n","_postman_id":"63aac694-defa-4afd-807a-a276b8819083"},{"name":"Account","item":[{"name":"Wallet Balance","id":"073bb270-b151-4db7-8520-16013d967204","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"BASE_URL/io/api/?token=api-token&action=bal","description":"This endpoint provides the opportunity to retrieve the account balance
\n","urlObject":{"path":["io","api",""],"host":["BASE_URL"],"query":[{"description":{"content":"Required. The API token.
\n","type":"text/plain"},"key":"token","value":"api-token"},{"description":{"content":"Required. This must be set to bal.
\n","type":"text/plain"},"key":"action","value":"bal"}],"variable":[]}},"response":[{"id":"cda006f0-73b8-4953-a70f-e01879d63404","name":"Wallet Balance","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"BASE_URL/io/api/?token=api-token&action=bal","host":["BASE_URL"],"path":["io","api",""],"query":[{"key":"token","value":"api-token","description":"Required. The API token."},{"key":"action","value":"bal","description":"Required. This must be set to **bal**."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 15 Jan 2022 17:53:02 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"comment\": \"Balance fetched successfully\",\n \"data\": {\n \"balance\": \"3071.00\"\n }\n}"}],"_postman_id":"073bb270-b151-4db7-8520-16013d967204"}],"id":"1726a668-ada1-4f1e-82d3-1e6f70c3ea5c","description":"The collection provides the endpoints to manage the account.
\n","_postman_id":"1726a668-ada1-4f1e-82d3-1e6f70c3ea5c"}],"event":[{"listen":"prerequest","script":{"id":"1f741e35-90b0-4b72-ab65-f4c59f210c93","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"69d8d4b0-5458-4d66-9007-5ed32bd198a2","type":"text/javascript","exec":[""]}}],"variable":[{"key":"base_url","value":"BASE_URL"},{"key":"token","value":"api-token"},{"key":"sms_sender","value":"sender_id"},{"key":"sms_to","value":"phone_numbers"},{"key":"sms_message","value":"message"},{"key":"sms_type","value":"type"},{"key":"sms_routing","value":"routing"},{"key":"sms_ref_id","value":"ref_id"}]}