{"info":{"_postman_id":"4c18ef09-8b60-4f88-9392-40e7e141fc68","name":"API documentation","description":"

Get started here

Mango is about making our APIs accessible and making sending messaging easy. Below the documentation will help guide you through how to implement our APIs seamlessly into your application

Our APIs are built on a RESTful endpoint structure and served using HTTPs to ensure data privacy. We use JSON-encoded responses and conventional HTTP response codes.

Base URL - QA

http://qa-api.mangocommunication.com/api/external

Authentication

The API uses API key and Secret access to authenticate requests. This wil be shared once the accounts has been setup.

Errors

API will use conventional HTTP response codes to indicate the success or failure of an API request.

Codes in the 2xx range indicate success
\n
Codes in the 4xx range indicate an error that failed given the information provided (e.g. a required parameter was omitted, duplicate reference, insufficient balance, no routes etc.)
\n
Codes in the 5xx range indicate server errors
\n

Response

{
\"Code\": \"OK\",
\"Status\": \"Success\",
\"Message\": \"Success\"
}

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Get started here","slug":"get-started-here"}],"owner":"32966714","collectionId":"4c18ef09-8b60-4f88-9392-40e7e141fc68","publishedId":"2sA2r6WPJB","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-02-14T23:45:49.000Z"},"item":[{"name":"SMS API","item":[{"name":"Send Message","id":"3969ba39-0c2c-4250-9bd7-36ebce64449e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"From\": \"447903690474\",\r\n \"To\": \"947903690111\",\r\n \"Text\": \"this is test\",\r\n \"ExternalRef\": \"AG-001\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://qa-api.mangocommunication.com/api/external/1000254/api-secret@@","description":"

The send a message API endpoint allows you to send a message to a single msisdn in one request.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


From	Required
To	Required, The telephone number of the message recipient must be in E.164 format
Text	Required
ExternalRef	Required, max 40 characters, Unique

","urlObject":{"path":["1000254","api-secret@@"],"host":["http://qa-api.mangocommunication.com/api/external"],"query":[],"variable":[]}},"response":[],"_postman_id":"3969ba39-0c2c-4250-9bd7-36ebce64449e"},{"name":"Update Callback URL","id":"0c1c88f5-187b-44ae-af61-b66dbcecdcb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Endpoint\": \"http://test.com/callback?\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://qa-api.mangocommunication.com/api/external/UpdateCallBack/1000254/api-secret@@","description":"

The update calll back API endpoint allows you to update the callback endpoint.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n


Endpoint	Required

","urlObject":{"path":["UpdateCallBack","1000254","api-secret@@"],"host":["http://qa-api.mangocommunication.com/api/external"],"query":[],"variable":[]}},"response":[],"_postman_id":"0c1c88f5-187b-44ae-af61-b66dbcecdcb3"},{"name":"Status Query","id":"30c70be9-d56b-4945-84a7-f8388b1154ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://qa-api.mangocommunication.com/api/external/1000254/api-secret@@/3CAB57C1FC3BAD","description":"

The check message status endpoint allows you to be able to understand for a single message the status of delivery; eg. Sent, delivered, undelivered, processing etc.

\n","urlObject":{"path":["1000254","api-secret@@","3CAB57C1FC3BAD"],"host":["http://qa-api.mangocommunication.com/api/external"],"query":[],"variable":[]}},"response":[],"_postman_id":"30c70be9-d56b-4945-84a7-f8388b1154ee"},{"name":"Check balance","id":"57e7a227-5a96-4436-9e47-0772c8669fbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://qa-api.mangocommunication.com/api/external/balane/1000254/api-secret@@/","description":"

The balance API endpoint allows you to be able to retrieve your balance.

\n","urlObject":{"path":["balane","1000254","api-secret@@",""],"host":["http://qa-api.mangocommunication.com/api/external"],"query":[],"variable":[]}},"response":[],"_postman_id":"57e7a227-5a96-4436-9e47-0772c8669fbc"}],"id":"273d2aac-7f61-4955-a8b4-1797122ad3c7","description":"

Mango API v 1.0.0

\n","_postman_id":"273d2aac-7f61-4955-a8b4-1797122ad3c7"}],"event":[{"listen":"prerequest","script":{"id":"646ba619-d928-44c3-bf86-4732848e858f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b96b76b5-503b-40e5-b64a-6ef86787e456","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"http://qa-api.mangocommunication.com/api/"},{"key":"api-key","value":"1000254","type":"string"},{"key":"api-secret","value":"api-secret@@","type":"string"}]}