{"info":{"_postman_id":"0a17d3ce-5fc3-4822-a909-447067fbc2ff","name":"SMS API DOCUMENTATION","description":"

What is an SMS API?

\n

An API (Application Programming Interface) acts as an interface between the code you write and our SMS Gateway.

\n

This document provides a reference for all features available to you via the HTTP interface for sending SMS.
It is quick to get started (copy and paste a URL directly in your web browser to send a message!) and there is no need to understand the additional or advanced features unless you want to use them.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"7705958","collectionId":"0a17d3ce-5fc3-4822-a909-447067fbc2ff","publishedId":"Uyr7Hydn","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-04-19T21:16:22.000Z"},"item":[{"name":"Request Parameters","item":[{"name":"Send SMS Using Username & Password","id":"10af5574-30bd-435d-ac05-461a917f47c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sms.nalosolutions.com/smsbackend/clientapi/Resl_Nalo/send-message/?username=johndoe&password=some_password&type=0&destination=233XXXXXXXXX&dlr=1&source=NALO&message=This+is+a+test+from+Mars","urlObject":{"path":["clientapi","Resl_Nalo","send-message",""],"host":["https://sms.nalosolutions.com/smsbackend"],"query":[{"key":"username","value":"johndoe"},{"key":"password","value":"some_password"},{"key":"type","value":"0"},{"key":"destination","value":"233XXXXXXXXX"},{"key":"dlr","value":"1"},{"key":"source","value":"NALO"},{"key":"message","value":"This+is+a+test+from+Mars"}],"variable":[]}},"response":[{"id":"ad609dad-c03d-414f-b89b-472c5cf1209a","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sms.nalosolutions.com/smsbackend/clientapi/Resl_Nalo/send-message/?username=johndoe&password=some_password&type=0&destination=233XXXXXXXXX&dlr=1&source=NALO&message=This+is+a+test+from+Mars","host":["https://sms.nalosolutions.com/smsbackend"],"path":["clientapi","Resl_Nalo","send-message",""],"query":[{"key":"username","value":"johndoe"},{"key":"password","value":"some_password"},{"key":"type","value":"0"},{"key":"destination","value":"233XXXXXXXXX"},{"key":"dlr","value":"1"},{"key":"source","value":"NALO"},{"key":"message","value":"This+is+a+test+from+Mars"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 18 Apr 2022 04:25:58 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.3"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Vary","value":"Accept, Cookie"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"46"}],"cookie":[],"responseTime":null,"body":"1701|233501371674|api.0000011.20220418.0000001"}],"_postman_id":"10af5574-30bd-435d-ac05-461a917f47c3"},{"name":"Send SMS Using Authentication Key","id":"908cef86-51c4-42a8-b2b2-1aa6f3667587","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sms.nalosolutions.com/smsbackend/clientapi/Resl_Nalo/send-message/?key={{AUTH_KEY}}&type=0&destination=233XXXXXXXXX&dlr=1&source=NALO&message=This+is+a+test+from+Mars","description":"
\n

We recommend you url encode the auth key or url before request

\n
\n","urlObject":{"path":["clientapi","Resl_Nalo","send-message",""],"host":["https://sms.nalosolutions.com/smsbackend"],"query":[{"key":"key","value":"{{AUTH_KEY}}"},{"key":"type","value":"0"},{"key":"destination","value":"233XXXXXXXXX"},{"key":"dlr","value":"1"},{"key":"source","value":"NALO"},{"key":"message","value":"This+is+a+test+from+Mars"}],"variable":[]}},"response":[{"id":"5aafa753-2cef-490a-83bf-c57982b09d06","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sms.nalosolutions.com/smsbackend/clientapi/Resl_Nalo/send-message/?username=johndoe&password=some_password&type=0&destination=233XXXXXXXXX&dlr=1&source=NALO&message=This+is+a+test+from+Mars","host":["https://sms.nalosolutions.com/smsbackend"],"path":["clientapi","Resl_Nalo","send-message",""],"query":[{"key":"username","value":"johndoe"},{"key":"password","value":"some_password"},{"key":"type","value":"0"},{"key":"destination","value":"233XXXXXXXXX"},{"key":"dlr","value":"1"},{"key":"source","value":"NALO"},{"key":"message","value":"This+is+a+test+from+Mars"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 18 Apr 2022 04:25:58 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.3"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Vary","value":"Accept, Cookie"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"46"}],"cookie":[],"responseTime":null,"body":"1701|233501371674|api.0000011.20220418.0000001"}],"_postman_id":"908cef86-51c4-42a8-b2b2-1aa6f3667587"},{"name":"Send sms api with auth_key -Json","id":"c55b03da-a595-4fb2-958f-d40bdd5dd8dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"key\": \")wcav5guzevjl)0)1w3gh(ehg2d4x0(#ih7jkmk2gpi987)6530xadkyjxlgzi\",\n \"msisdn\": \"233244071872, 233XXXXXXXX\",\n \"message\": \"Here are two, of many\",\n \"sender_id\": \"NALO\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sms.nalosolutions.com/smsbackend/Resl_Nalo/send-message/","urlObject":{"path":["Resl_Nalo","send-message",""],"host":["https://sms.nalosolutions.com/smsbackend"],"query":[],"variable":[]}},"response":[{"id":"f3de5c10-899d-4282-96d8-584633d5a6a1","name":"success","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"some_auth_key","disabled":true}],"body":{"mode":"raw","raw":"{\n \"key\": \")wcav5guzevjl)0)1w3gh(ehg2d4x0(#ih7jkmk2gpik48)912hg0xadkyjxlgzi\",\n \"msisdn\": \"233244071872, 233XXXXXXXX\",\n \"message\": \"Here are two, of many\",\n \"sender_id\": \"SenderID\"\n}","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8000/Resl_Nalo/send-message/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Dec 2022 07:01:20 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Content-Length","value":"81"},{"key":"Vary","value":"Accept,Cookie,Origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=1, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"1701\",\n \"job_id\": \"api.0000011.20221222.0000003\",\n \"msisdn\": \"233244071872\"\n}"}],"_postman_id":"c55b03da-a595-4fb2-958f-d40bdd5dd8dd"},{"name":"Send sms api - Json","id":"bd73d572-5877-4b25-87a3-21747f585ddf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\": \"johndoe\",\n \"password\": \"password\",\n \"msisdn\": \"233XXXXXXXX\",\n \"message\": \"Here are two, of many\",\n \"sender_id\": \"Test\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sms.nalosolutions.com/smsbackend/Resl_Nalo/send-message/","urlObject":{"path":["Resl_Nalo","send-message",""],"host":["https://sms.nalosolutions.com/smsbackend"],"query":[],"variable":[]}},"response":[{"id":"3c6ff19c-527e-4227-9a25-5399bee35649","name":"success","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"some_auth_key","disabled":true}],"body":{"mode":"raw","raw":"\n{\n \"username\": \"johndoe\",\n \"password\": \"password\",\n \"msisdn\": \"233244071872\",\n \"message\": \"Here are two, of many\",\n \"sender_id\": \"Test\"\n}","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8000/Resl_Nalo/send-message/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 21 Dec 2022 18:47:20 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Content-Length","value":"81"},{"key":"Vary","value":"Accept,Cookie,Origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=1, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"1701\",\n \"job_id\": \"api.0000011.20221221.0000099\",\n \"msisdn\": \"233244071872\"\n}"}],"_postman_id":"bd73d572-5877-4b25-87a3-21747f585ddf"},{"name":"Send sms api - xml","id":"55d2a23d-80b5-4444-8705-9d470f6c75dd","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\n\n johndoe\n 233XXXXXXXX\n MySender\n Here are two, of many\n password\n"},"url":"https://sms.nalosolutions.com/smsbackend/Resl_Nalo/send-sms/","urlObject":{"path":["Resl_Nalo","send-sms",""],"host":["https://sms.nalosolutions.com/smsbackend"],"query":[],"variable":[]}},"response":[{"id":"825c6829-3871-40e4-af34-e018630dc329","name":"Invalid Sender","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"some_auth_key","disabled":true},{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\n johndoe\n 233XXXXXXXX\n MySender\n Here are two, of many\n password\n"},"url":"http://127.0.0.1:8000/Resl_Nalo/send-sms/"},"status":"Precondition Failed","code":412,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 21 Dec 2022 18:49:40 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Content-Length","value":"110"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Vary","value":"Cookie,Origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=1, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"\n\n 1707\n Invalid Source(Sender)\n"},{"id":"5a1ddb80-7566-4d78-950e-25ce5c0a4efe","name":"success","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"some_auth_key","disabled":true},{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\n\n johndoe\n 233XXXXXXXX\n MySender\n Here are two, of many\n password\n"},"url":"https://sms.nalosolutions.com/smsbackend/Resl_Nalo/send-sms/"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 21 Dec 2022 18:50:24 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Content-Length","value":"147"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Vary","value":"Cookie,Origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Keep-Alive","value":"timeout=1, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/xml; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"\n\n 1701\n api.0000011.20221221.0000102\n 233540105690\n"}],"_postman_id":"55d2a23d-80b5-4444-8705-9d470f6c75dd"}],"id":"a3f86bae-c378-409b-a38f-f527fe44beb0","description":"

SMS messages are sent by making HTTPS calls to the API. You can loop through your list of mobile numbers and make HTTPS requests to send SMS messages to them.

\n

HTTPS POST API:

\n
    \n
  1. JSON & XML REQUEST PARAMETERS
    2. \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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterRequiredDescription
usernameYesSpecifies the username. It is a unique identification chosen by client during account creation
passwordYesAlpha-numeric special characters combination with minimum length of eight(8) characters
msisdnYesPhone number of the recipient
sender_idYesMessage sender Identification
messageYesContent to be sent out
\n

2. XML T24 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\n\n\n\n\n\n\n\n\n\n\n
ParameterRequiredDescription
userYesSpecifies the username. It is a unique identification chosen by client during account creation
passwordYesuser's password
fromYessender ID
toYesRecipient phone number
textYesMessage content
\n

Please Note:

\n

A key can be used in place of username (user) and password to make api calls.

\n

This key is manually generated from the client portal.

\n

HTTPS GET API:

\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\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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterRequiredDescripton
Username_prefixYesSpecifies the reseller’s name. eg. Resl_Nalo
usernameYesSpecifies the username. It is a unique identification chosen by the client at the time of registration or sign-up. Each account detail is uniquely linked to a username and the username cannot be changed after successful creation. The user is authenticated by the username and password parameters. When you send a message, it will be sent in the name of the authenticated user. The value must be URL.
passwordYesSpecifies the password. The password is obtained after sign up and It should be at least 8 characters with alphanumeric text and at least a special character (e.g. @). The user is authenticated by the username and password parameters. When you send a message, it will be sent in the name of the authenticated user. The value must be URL.
typeYesSpecifies the message type. It indicates whether it is a text message or a fash. The value of the type parameter is always 0 is for simple text messages, 1 is for flash messages
dlrYesSpecifies delivery report request. It has a constant value of 1 for a DLR request. It is recommended that this parameter is not modified.
sourceYesSpecifies the sender’s address. When the message arrives on the phone, this information will be displayed. This can be alpha text (e.g. Nalo), numeric (e.g. 123), alphanumeric (e.g. nalo123) The maximum character length is eleven (11). Sender address with spaces in between (e.g. NALO NOC) should be URL encoded.
destinationYesSpecifies the recipient’s phone number. The message will be sent to this telephone number. The telephone number can be specified in local number format (e.g. 024113234), or in international number format (e.g. 23324113234).
messageYesSpecifies the text or the data of the SMS message. The value must be encoded in UTF8 and must be URL encoded.
callback_urlNoSpecifies the client’s URL to send a delivery report on the status of messages sent out. The response is JSON formated.
keyNospecifies client’s unique key for API calls. When implemented the username and password parameter will be ignored.We recommend you url encode the auth key or url before request.
validity_periodNoSpecifies how long the message will be valid, i.e., how long the Operator/Telco will try to send the message to the recipient. Defined in minutes. E.g a validity set to 5 means the SMS will expire within 5 minutes. This is beneficial for OTP type messages.
\n
","_postman_id":"a3f86bae-c378-409b-a38f-f527fe44beb0"},{"name":"Response Codes","item":[],"id":"399e738a-06fe-4946-9f96-ce67785f0dfb","description":"

1701: Success, Message Submitted Successfully, in this case you will receive the response

\n

1701|<phone_number>|<message_ID>

\n
\n

The message Id can then be used later to map the delivery reports to this message.

\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\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\n\n\n\n\n
Error CodeDescription
1702Invalid URL Error, This means that one of the parameters was not
provided or left blank
1703Invalid value in username or password field
1704Invalid value in “type” field
1705Invalid Message
1706Invalid Destination
1707Invalid Source (Sender)
1708Invalid value for “dlr” field
1709User validation failed
1710Internal Error
1025Insufficient Credit User
1026Insufficient Credit Reseller
\n
","_postman_id":"399e738a-06fe-4946-9f96-ce67785f0dfb"}]}