{"info":{"_postman_id":"a24cd265-3681-4ae2-a6e6-1c7758aa9556","name":"Developer API","description":"

This page will help you get started with API.

\n

This document will provide instructions on how to quickly integrate SMS messaging services into various solutions by using HTTP application programming interface (HTTP API). The HTTP API can be used for sending SMS messages, making Number Context (number validation) requests and receiving inbound SMS messages sent from mobile phones.

\n

API is based on REST standards, enabling you to use your browser for accessing URLs. In order to interact with our API, any HTTP client in any programming language can be used.

\n

Base URL

\n

Submit all requests to the base URL. All the requests are submitted thorough HTTP POST method.

\n
https://messaging-service.co.tz\n\n

Content-Type & Accept header

\n

API supports JSON and XML Content-Types and Accept criteria that should be specified in the header. If the Content-Type is not specified you will receive a General error. Depending which Accept type is chosen in the deader for the request, the same one will be applied in the response.

\n\n

Authorization

\n

We support basic authorization using a username and password with Base64 encoding variation RFC2045-MIME.

\n
    \n

  1. Username and password are combined into a string username:password.

    \n
    2. \n

  2. The resulting string is encoded using the RFC2045-MIME variant of Base64.

    \n
    3. \n

  3. The authorization method and a space, like this: \"Basic \", are put before the encoded string.

    \n
    4. \n
\n

EXAMPLE

\n

Username: Aladdin

\n

Password: open sesame

\n

Base64 encoded string: QWxhZGRpbjpvcGVuIHNlc2FtZQ==

\n

Authorization header: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

\n

Gerenate your Base64 encoded string here

\n

Response status and error codes

\n

While using our API you may encounter certain status and error codes that you need to understand or troubleshoot. This page contains a list of all codes with thorough descriptions and action steps you need to take in case you are looking for a resolution of the problem.

\n

HTTP status codes

\n

Every HTTP transaction has a status code sent back by the server to define how the server handled the transaction. Most common statuses you may have encountered are 200 OK and 404 Not Found

\n

Learn more about HTTP status codes here

\n

API Status codes

\n

Besides standard HTTP status code, status object may be returned as part of the API response message, delivery report or message log.

\n

Status json object example:

\n
{  \n   \"groupId\":3,\n   \"groupName\":\"DELIVERED\",\n   \"id\":5,\n   \"name\":\"DELIVERED_TO_HANDSET\",\n   \"description\":\"Message delivered to handset\"\n}\n\n

General status codes

\n

PENDING (group id: 18) - general status codes

\n

Message has been processed and sent to the next instance i.e. mobile operator.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
IdStatus
50PENDING_WAITING_DELIVERY - Message has been processed and sent to the next instance i.e. mobile operator with request acknowledgment from their platform. Delivery report has not yet been received, and is awaited thus the status is still pending.
51ENROUTE (SENT) - Message has been processed and sent to the next instance i.e. mobile operator.
52PENDING_ACCEPTED - Message has been accepted and processed, and is ready to be sent to the next instance i.e. operator.
\n

DELIVERY (group id: 20) - general status codes

\n

Delivery report received from mobile operators.

\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
IdStatus
73DELIVERED - The message was successfully delivered.
74EXPIRED - The SMSC was unable to deliver the message in a specified amount of time.For instance when the phone was turned off.
75DELETED - The message was deleted.
76UNDELIVERABLE - The SMS was unable to deliver the message.For instance, when the number does not exist. This status is also returned when SMSC does not send accurate status.
77ACCEPTED - The SMS was accepted and will be send.
78UNKNOWN - Unknown error occured.
79REJECTED - The message was rejected.The provider could have blocked phonenumbers in this range.
80SKIPPED - The message was skipped.
\n

REJECTED (group id: 19) - general status codes

\n

Message has been received, but has either been rejected by our system, or the operator has reverted Rejected as final status.

\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\n\n\n\n\n\n\n\n\n\n\n\n
IdStatus
53REJECTED_NETWORK - Message has been received, but the network is either out of our coverage or not setup on your account. Your account manager can inform you on the coverage status or setup the network in question.
54REJECTED_PREFIX_MISSING - Message has been received, but has been rejected as the number is not recognized due to either incorrect number prefix or number length. This information is different for each network and is regularly updated.
55REJECTED_DND - Message has been received, and rejected due to the user being subscribed to DND (Do Not Disturb) services, disabling any service traffic to their number.
56REJECTED_SOURCE - Your account is set to accept only registered sender ID-s while the sender ID defined in the request has not been registered on your account.
57REJECTED_NOT_ENOUGH_CREDITS - Your account is out of credits for further submission - please top up your account. For further assistance in topping up or applying for online account topup service you may contact your account manager.
58REJECTED_SENDER - The sender ID has been blacklisted on your account - please remove the blacklist on your account or contact Support for further assistance.
59REJECTED_DESTINATION - The destination number has been blacklisted either at the operator request or on your account - please contact Support for more information.
60REJECTED_PREPAID_PACKAGE_EXPIRED - Account credits have been expired past their validity period - please topup your subaccount with credits to extend the validity period.
61REJECTED_DESTINATION_NOT_REGISTERED - Your account has been setup for submission only to a single number for testing purposes - kindly contact your manager to remove the limitation.
62REJECTED_ROUTE_NOT_AVAILABLE - Mesage has been received on the system, however your account has not been setup to send messages i.e. no routes on your account are available for further submission. Your account manager will be able to setup your account based on your preference.
63REJECTED_FLOODING_FILTER - Message has been rejected due to a anti-flooding mechanism. By default, a single number can only receive 20 varied messages and 6 identical messages per hour. If there is a requirement, the limitation can be extended per account on request to your account manager.
64REJECTED_SYSTEM_ERROR - The request has been rejected due to an expected system system error, please retry submission or contact our technical support team for more details.
65REJECTED_DUPLICATE_MESSAGE_ID -The request has been rejected due to a duplicate message ID specified in the submit request, while message ID-s should be a unique value
66REJECTED_INVALID_UDH - Message has been received, while our system detected the message was formatted incorrectly because of either an invalid ESM class parameter (fully featured binary message API method) or an inaccurate amount of characters when using esmclass:64 (UDH). For more information feel free to visit the below articles or contact our Support team for clarification. https://en.wikipedia.org/wiki/User_Data_Header, https://en.wikipedia.org/wiki/Concatenated_SMS
67REJECTED_MESSAGE_TOO_LONG - Message has been received, but the total message length is more than 25 parts or message text which exceeds 4000 bytes as per our system limitation.
68MISSING_TO - The request has been received, however the \"to\" parameter has not been set or it is empty, i.e. there must be valid recipients to send the message.
69REJECTED_INVALID_DESTINATION - The request has been received, however the destination is invalid - the number prefix is not correct as it does not match a valid number prefix by any mobile operator. Number length is also taken into consideration in verifying number number validity.
\n

Test Mode

\n

You can make a request just to test our API for your development environment, and get responses and understanding them. This feature will send you only dummy data generate from your request. No charges are involved in testing mode, it is free and your current sms balance will not be reducted for the requests you send to the test APIs.

\n

TEST APIs url

\n

For single message text request:

\n

POST https://messaging-service.co.tz/api/sms/v1/test/text/single

\n

For multiple messages text request:

\n

POST https://messaging-service.co.tz/api/sms/v1/test/text/multi

\n

Further instructions are on Send SMS Section

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Base URL","slug":"base-url"},{"content":"Content-Type & Accept header","slug":"content-type-accept-header"},{"content":"Authorization","slug":"authorization"},{"content":"Response status and error codes","slug":"response-status-and-error-codes"},{"content":"HTTP status codes","slug":"http-status-codes"},{"content":"API Status codes","slug":"api-status-codes"},{"content":"Test Mode","slug":"test-mode"}],"owner":"4680389","collectionId":"a24cd265-3681-4ae2-a6e6-1c7758aa9556","publishedId":"SW7dX7JL","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-09-16T09:05:48.000Z"},"item":[{"name":"Send Sms","item":[{"name":"Single destination","event":[{"listen":"prerequest","script":{"id":"5942409e-07ef-4848-95fd-f569e92959df","exec":[""],"type":"text/javascript"}}],"id":"35b6ab20-b684-41ae-9911-2013ad927078","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic dGVzdDE6MTIzNDU2","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"from\": \"N-SMS\", \"to\": \"255716718040\", \"text\": \"Your message\", \"reference\":\"xaefcgt\"}"},"url":"https://messaging-service.co.tz/api/sms/v1/text/single","description":"

Now, you are ready to send your first SMS message using:

\n

POST https://messaging-service.co.tz/api/sms/v1/text/single

\n

For testing your request use the url below:

\n

POST https://messaging-service.co.tz/api/sms/v1/test/text/single

\n

Request body contains the message you wish to send with from, to and message parameters.

\n","urlObject":{"protocol":"https","path":["api","sms","v1","text","single"],"host":["messaging-service","co","tz"],"query":[],"variable":[]}},"response":[{"id":"766ce207-036d-4213-89a2-f91fdbdbd1cf","name":"Single destination","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic aW0yM246MjNuMjNu","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"from\":\"N-SMS\", \"to\":\"255716718040\", \"text\": \"Your message\", \"reference\": \"aswqetgcv\"}","options":{"raw":{"language":"json"}}},"url":"https://messaging-service.co.tz/api/sms/v1/test/text/single"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.1.31"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 13 Jan 2020 11:30:19 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"56"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n {\n \"to\": \"255716718040\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"smsCount\": 1\n }\n ]\n}"}],"_postman_id":"35b6ab20-b684-41ae-9911-2013ad927078"},{"name":"Multiple destinations","event":[{"listen":"prerequest","script":{"id":"5942409e-07ef-4848-95fd-f569e92959df","exec":[""],"type":"text/javascript"}}],"id":"2936eed4-6027-45e7-92c9-fe1cd7df140b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic dGVzdDE6MTIzNDU2","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"from\":\"N-SMS\", \"to\":[\"255655912841\", \"255716718040\"], \"text\": \"Your message\", \"reference\": \"aswqetgcv\"}"},"url":"https://messaging-service.co.tz/api/sms/v1/text/single","description":"

For sending the single messages to multiple phone numbers, you need to perform:

\n

POST https://messaging-service.co.tz/api/sms/v1/text/single

\n

For testing your request use the url below:

\n

POST https://messaging-service.co.tz/api/sms/v1/test/text/single

\n

Request body contains the message you wish to send with from, to and message parameters.

\n","urlObject":{"protocol":"https","path":["api","sms","v1","text","single"],"host":["messaging-service","co","tz"],"query":[],"variable":[]}},"response":[{"id":"dffe33a5-8b42-4c37-987f-d68b59d371ea","name":"Multiple destinations","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic dGVzdDE6MTIzNDU2","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"from\":\"N-SMS\", \"to\":[\"255655912841\", \"255716718040\"], \"text\": \"Your message\", \"reference\": \"aswqetgcv\"}","options":{"raw":{"language":"json"}}},"url":"https://messaging-service.co.tz/api/sms/v1/test/text/single"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Jan 2020 11:52:30 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) PHP/7.2.24 mod_wsgi/3.4 Python/2.7.5"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"57"},{"key":"Content-Length","value":"330"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n {\n \"to\": \"255655912841\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"smsCount\": 1\n },\n {\n \"to\": \"255716718040\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"smsCount\": 1\n }\n ]\n}"}],"_postman_id":"2936eed4-6027-45e7-92c9-fe1cd7df140b"},{"name":"Multiple messages to Multiple destinations (Example 1)","event":[{"listen":"prerequest","script":{"id":"5942409e-07ef-4848-95fd-f569e92959df","exec":[""],"type":"text/javascript"}}],"id":"b13825ab-8b49-45f5-a4cd-fb7d21aa975a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic dGVzdDE6MTIzNDU2","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"messages\": [{\"from\":\"N-SMS\", \"to\":\"255716718040\", \"text\": \"Your message\"}, { \"from\":\"N-SMS\", \"to\":\"255655912841\", \"text\":\"Your other message\"}], \"reference\": \"aswqetgcv\"}"},"url":"https://messaging-service.co.tz/api/sms/v1/text/multi","description":"

For sending the multiple messages to multiple phone numbers, you need to perform:

\n

POST https://messaging-service.co.tz/api/sms/v1/text/multi

\n

For testing your request use the url below:

\n

POST https://messaging-service.co.tz/api/sms/v1/test/text/multi

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n","urlObject":{"protocol":"https","path":["api","sms","v1","text","multi"],"host":["messaging-service","co","tz"],"query":[],"variable":[]}},"response":[{"id":"91eab8f2-1689-401f-9e40-1f739b86b456","name":"Multiple messages to Multiple destinations","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic dGVzdDE6MTIzNDU2","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"messages\": [{\"from\":\"N-SMS\", \"to\":\"255716718040\", \"text\": \"Your message\"}, { \"from\":\"N-SMS\", \"to\":\"255655912841\", \"text\":\"Your other message\"}], \"reference\": \"aswqetgcv\"}","options":{"raw":{"language":"json"}}},"url":"https://messaging-service.co.tz/api/sms/v1/text/multi"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Jan 2020 11:27:15 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) PHP/7.2.24 mod_wsgi/3.4 Python/2.7.5"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Content-Length","value":"330"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n {\n \"to\": \"255716718040\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"smsCount\": 1\n },\n {\n \"to\": \"255655912841\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"smsCount\": 1\n }\n ]\n}"}],"_postman_id":"b13825ab-8b49-45f5-a4cd-fb7d21aa975a"},{"name":"Multiple messages to Multiple destinations (Example 2)","event":[{"listen":"prerequest","script":{"id":"5942409e-07ef-4848-95fd-f569e92959df","exec":[""],"type":"text/javascript"}}],"id":"6916415a-4645-460d-bb3f-a6d6fbd60e4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic dGVzdDE6MTIzNDU2","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"messages\": [{\"from\": \"N-SMS\",\"to\": [\"255716718040\",\"255758483019\"],\"text\": \"Your message\"},{\"from\": \"N-SMS\",\"to\": [\"255758483019\", \"255655912841\",\"255716718040\"],\"text\": \"Your other message\"}], \"reference\": \"aswqetgcv\"}","options":{"raw":{"language":"json"}}},"url":"https://messaging-service.co.tz/api/sms/v1/text/multi","description":"

For sending the multiple messages to multiple phone numbers, you need to perform:

\n

POST https://messaging-service.co.tz/api/sms/v1/text/multi

\n

For testing your request use the url below:

\n

POST https://messaging-service.co.tz/api/sms/v1/test/text/multi

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n","urlObject":{"protocol":"https","path":["api","sms","v1","text","multi"],"host":["messaging-service","co","tz"],"query":[],"variable":[]}},"response":[{"id":"c2e67045-15a8-4e84-993d-a99d71def30b","name":"Multiple messages to Multiple destinations 2","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic dGVzdDE6MTIzNDU2","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"messages\": [{\"from\": \"N-SMS\",\"to\": [\"255716718040\",\"255758483019\"],\"text\": \"Your message\"},{\"from\": \"N-SMS\",\"to\": [\"255758483019\", \"255655912841\",\"255716718040\"],\"text\": \"Your other message\"}], \"reference\": \"aswqetgcv\"}","options":{"raw":{"language":"json"}}},"url":"https://messaging-service.co.tz/api/sms/v1/text/multi"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Jan 2020 11:04:15 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) PHP/7.2.24 mod_wsgi/3.4 Python/2.7.5"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Content-Length","value":"853"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n {\n \"to\": \"255716718040\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"smsCount\": 1\n },\n {\n \"to\": \"255758483019\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"smsCount\": 1\n },\n {\n \"to\": \"255758483019\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"smsCount\": 1\n },\n {\n \"to\": \"255655912841\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"smsCount\": 1\n },\n {\n \"to\": \"255716718040\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"smsCount\": 1\n }\n ]\n}"}],"_postman_id":"6916415a-4645-460d-bb3f-a6d6fbd60e4a"},{"name":"Schedule SMS","event":[{"listen":"prerequest","script":{"id":"5942409e-07ef-4848-95fd-f569e92959df","exec":[""],"type":"text/javascript"}}],"id":"59cc2941-482b-45ab-9721-a7abffc83bba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic dGVzdDE6MTIzNDU2","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"from\": \"N-SMS\", \"to\": \"255716718040\", \"text\": \"Your message\", \"date\": \"2020-10-01\" , \"time\": \"12:00\"}"},"url":"https://messaging-service.co.tz/api/sms/v1/text/single","description":"

To send schedule sms you required to have the following parameters:

\n

from - your Sender ID

\n

to - recipient phone number with the format begin with 255

\n

text - your text message

\n

date - date of the day to which you want to send your sms, format of Year-month-date exapmle:2020-10-01

\n

time - time of the day to which you want to send your sms, 24 hours format exapmle:12:00

\n

Optional parameters to the schedule sms

\n

repeat - you can add this parameter when you want your sms to be repeated. This must be with these values in order to work: hourly, daily, weekly or monthly

\n

start_date - this parameter defines the date from this your sms can start sending, format of Year-month-date exapmle:2020-10-01.

\n

end_date - this parameter defines the date from this your sms can end sending, format of Year-month-date exapmle:2021-01-01.

\n","urlObject":{"protocol":"https","path":["api","sms","v1","text","single"],"host":["messaging-service","co","tz"],"query":[],"variable":[]}},"response":[{"id":"d1c657a2-0ded-453b-a409-3f9fde42ffcb","name":"Schedule SMS","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic dGVzdDE6MTIzNDU2","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"from\": \"N-SMS\", \"to\": \"255716718040\", \"text\": \"Your message\", \"date\": \"2020-10-01\" , \"time\": \"12:00\"}"},"url":"https://messaging-service.co.tz/api/sms/v1/text/single"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.2.33"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 05 Aug 2020 05:59:49 GMT"},{"key":"X-RateLimit-Limit","value":"50000"},{"key":"X-RateLimit-Remaining","value":"49999"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n {\n \"to\": \"255716718040\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\",\n \"description\": \"Pending accepted , will be sent on scheduled time.\"\n },\n \"smsCount\": 1\n }\n ]\n}"}],"_postman_id":"59cc2941-482b-45ab-9721-a7abffc83bba"},{"name":"Send Sms Via Link","id":"fed9c327-34dc-4625-b628-d37ef6bdcca4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://messaging-service.co.tz/link/sms/v1/text/single?username=myuser&password=mypass&from=N-SMS&to=255655000000&text=TestMessage","urlObject":{"protocol":"https","path":["link","sms","v1","text","single"],"host":["messaging-service","co","tz"],"query":[{"key":"username","value":"myuser"},{"key":"password","value":"mypass"},{"key":"from","value":"N-SMS"},{"key":"to","value":"255655000000"},{"key":"text","value":"TestMessage"}],"variable":[]}},"response":[],"_postman_id":"fed9c327-34dc-4625-b628-d37ef6bdcca4"}],"id":"5e466440-829b-4b56-be32-b681e4f81227","description":"

In a few simple steps, we will explain how to send an SMS using Nextbyte HTTPS API.

\n

Firstly, you'll need a valid Nextbyte account. When you sign up for the account, you will set a username and password. Next, your username and password has to be encoded in base64 like described in the Authorization Section:

\n

The message will be sent only to a valid phone number (numbers), written in international format e.g.255738234345. We strongly recommend using the E.164 number formatting. E.164 numbers are internationally standardized to a fifteen digit maximum length. Phone numbers are usually prefixed with + (plus sign), followed by a country code, network code and the subscriber number. Phone numbers that are not E.164 formatted may work, depending on the handset or network.

\n

When sending a message you can specify reference value which associates the API request payload with your data. This is very useful when fetching delivery reports and logs. This is also useful when at any circumstance the requester does not receive a response from the API endpoint and wants to synchronise information at some point later.

\n","event":[{"listen":"prerequest","script":{"id":"69bdea10-8b42-4d2b-bbde-e21e08b149b9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f8306796-dc73-4bba-a164-504fd8dd61e5","type":"text/javascript","exec":[""]}}],"_postman_id":"5e466440-829b-4b56-be32-b681e4f81227"},{"name":"Sms Delivery Reports","item":[{"name":"Get all delivery reports","event":[{"listen":"prerequest","script":{"id":"5942409e-07ef-4848-95fd-f569e92959df","exec":[""],"type":"text/javascript"}}],"id":"5fc5b186-c4dc-4de0-9d0f-baee93d53c7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Basic aW0yM246MTIzN44DU2"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://messaging-service.co.tz/api/sms/v1/reports","urlObject":{"protocol":"https","path":["api","sms","v1","reports"],"host":["messaging-service","co","tz"],"query":[],"variable":[]}},"response":[{"id":"11e55745-cb18-41a8-bb56-95fd79c2d2d9","name":"Getting all delivery reports","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Basic aW0yM246MTIzNDU2"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json","disabled":true},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://messaging-service.co.tz/api/sms/v1/reports"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Apr 2020 08:57:14 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) PHP/7.2.27"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.27"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Content-Length","value":"1494"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n \t\n {\n \"messageId\": \"2808579298410163167\",\n \"sentAt\": \"2020-02-08 12:28:51\",\n \"doneAt\": \"2020-04-21 18:23:07\",\n \"to\": \"255716718040\",\n \"smsCount\": 1,\n \"status\": {\n \"groupId\": 3,\n \"groupName\": \"DELIVERED\",\n \"id\": 5,\n \"name\": \"DELIVERED_TO_HANDSET\",\n \"description\": \"Message delivered to handset\"\n },\n \"error\": {\n \"groupId\": 0,\n \"groupName\": \"OK\",\n \"id\": 0,\n \"name\": \"NO_ERROR\",\n \"description\": \"No Error\",\n \"permanent\": false\n }\n },\n {\n \"messageId\": \"28227686813403535606\",\n \"sentAt\": \"2020-02-21 12:21:00\",\n \"doneAt\": \"2020-04-18 18:23:07\",\n \"to\": \"255716718040\",\n \"smsCount\": 1,\n \"status\": null,\n \"error\": null\n },\n {\n \"messageId\": \"28089492984101631440\",\n \"sentAt\": \"2020-02-05 12:28:51\",\n \"doneAt\": \"2020-04-18 18:23:07\",\n \"to\": \"255716718040\",\n \"smsCount\": 1,\n \"status\": {\n \"groupId\": 3,\n \"groupName\": \"DELIVERED\",\n \"id\": 5,\n \"name\": \"DELIVERED_TO_HANDSET\",\n \"description\": \"Message delivered to handset\"\n },\n \"error\": {\n \"groupId\": 0,\n \"groupName\": \"OK\",\n \"id\": 0,\n \"name\": \"NO_ERROR\",\n \"description\": \"No Error\",\n \"permanent\": false\n }\n }\n ]\n}"},{"id":"34133222-b478-40d2-a57a-d37a6c00cafa","name":"Getting all delivery reports with size limit","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Basic aW0yM246MTIzNDU2"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json","disabled":true},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://messaging-service.co.tz/api/sms/v1/reports?size=3","protocol":"https","host":["messaging-service","co","tz"],"path":["api","sms","v1","reports"],"query":[{"key":"size","value":"3","description":"Limit the size of delivery reports. The maximum allowed is 500"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Apr 2020 08:57:14 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) PHP/7.2.27"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.27"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Content-Length","value":"1494"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n \t\n {\n \"messageId\": \"2808579298410163167\",\n \"sentAt\": \"2020-02-08 12:28:51\",\n \"doneAt\": \"2020-04-21 18:23:07\",\n \"to\": \"255716718040\",\n \"smsCount\": 1,\n \"status\": {\n \"groupId\": 3,\n \"groupName\": \"DELIVERED\",\n \"id\": 5,\n \"name\": \"DELIVERED_TO_HANDSET\",\n \"description\": \"Message delivered to handset\"\n },\n \"error\": {\n \"groupId\": 0,\n \"groupName\": \"OK\",\n \"id\": 0,\n \"name\": \"NO_ERROR\",\n \"description\": \"No Error\",\n \"permanent\": false\n }\n },\n {\n \"messageId\": \"28227686813403535606\",\n \"sentAt\": \"2020-02-21 12:21:00\",\n \"doneAt\": \"2020-04-18 18:23:07\",\n \"to\": \"255716718040\",\n \"smsCount\": 1,\n \"status\": null,\n \"error\": null\n },\n {\n \"messageId\": \"28089492984101631440\",\n \"sentAt\": \"2020-02-05 12:28:51\",\n \"doneAt\": \"2020-04-18 18:23:07\",\n \"to\": \"255716718040\",\n \"smsCount\": 1,\n \"status\": {\n \"groupId\": 3,\n \"groupName\": \"DELIVERED\",\n \"id\": 5,\n \"name\": \"DELIVERED_TO_HANDSET\",\n \"description\": \"Message delivered to handset\"\n },\n \"error\": {\n \"groupId\": 0,\n \"groupName\": \"OK\",\n \"id\": 0,\n \"name\": \"NO_ERROR\",\n \"description\": \"No Error\",\n \"permanent\": false\n }\n }\n ]\n}"}],"_postman_id":"5fc5b186-c4dc-4de0-9d0f-baee93d53c7d"},{"name":"Get delivery reports with messageId","event":[{"listen":"prerequest","script":{"id":"5942409e-07ef-4848-95fd-f569e92959df","exec":[""],"type":"text/javascript"}}],"id":"6402ce4e-d0d4-44ac-8606-a9d12a900974","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Basic aW0yM246MTIzNDU2"},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://messaging-service.co.tz/api/sms/v1/reports?messageId=28089492984101631440","urlObject":{"protocol":"https","path":["api","sms","v1","reports"],"host":["messaging-service","co","tz"],"query":[{"key":"messageId","value":"28089492984101631440"}],"variable":[]}},"response":[{"id":"2ddc9bc3-b31b-48b3-8f50-8c4d6beb44a9","name":"Getting all delivery reports with messageId","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Basic aW0yM246MTIzNDU2"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json","disabled":true},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://messaging-service.co.tz/api/sms/v1/reports?messageId=28089492984101631440","protocol":"https","host":["messaging-service","co","tz"],"path":["api","sms","v1","reports"],"query":[{"key":"messageId","value":"28089492984101631440"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Apr 2020 09:04:22 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) PHP/7.2.27"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.27"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"56"},{"key":"Content-Length","value":"381"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"messageId\": \"28089492984101631440\",\n \"sentAt\": \"2020-02-05 12:28:51\",\n \"doneAt\": \"2020-04-18 18:23:07\",\n \"to\": \"255716718040\",\n \"smsCount\": 1,\n \"status\": {\n \"groupId\": 3,\n \"groupName\": \"DELIVERED\",\n \"id\": 5,\n \"name\": \"DELIVERED_TO_HANDSET\",\n \"description\": \"Message delivered to handset\"\n },\n \"error\": {\n \"groupId\": 0,\n \"groupName\": \"OK\",\n \"id\": 0,\n \"name\": \"NO_ERROR\",\n \"description\": \"No Error\",\n \"permanent\": false\n }\n }\n ]\n}"}],"_postman_id":"6402ce4e-d0d4-44ac-8606-a9d12a900974"},{"name":"Get delivery reports with specific date range (To be deprecated)","event":[{"listen":"prerequest","script":{"id":"5942409e-07ef-4848-95fd-f569e92959df","exec":[""],"type":"text/javascript"}}],"id":"46fc5c9c-0cd4-4356-8cab-1e326e54940a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Basic aW0yM246MTIzNDU2"},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://messaging-service.co.tz/api/sms/v1/reports?sentSince=2020-02-01&sentUntil=2020-02-20","urlObject":{"protocol":"https","path":["api","sms","v1","reports"],"host":["messaging-service","co","tz"],"query":[{"key":"sentSince","value":"2020-02-01"},{"key":"sentUntil","value":"2020-02-20"}],"variable":[]}},"response":[{"id":"5562634b-55fa-4ed6-b5e8-b0fb5f6bc8db","name":"Get delivery reports with specific date range","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Basic aW0yM246MTIzNDU2"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json","disabled":true},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://messaging-service.co.tz/api/sms/v1/reports?sentSince=2020-02-01&sentUntil=2020-02-20","protocol":"https","host":["messaging-service","co","tz"],"path":["api","sms","v1","reports"],"query":[{"key":"sentSince","value":"2020-02-01"},{"key":"sentUntil","value":"2020-02-20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Apr 2020 10:05:33 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) PHP/7.2.27"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.27"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Content-Length","value":"381"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"messageId\": \"28089492984101631440\",\n \"sentAt\": \"2020-02-05 12:28:51\",\n \"doneAt\": \"2020-04-18 18:23:07\",\n \"to\": \"255716718040\",\n \"smsCount\": 1,\n \"status\": {\n \"groupId\": 3,\n \"groupName\": \"DELIVERED\",\n \"id\": 5,\n \"name\": \"DELIVERED_TO_HANDSET\",\n \"description\": \"Message delivered to handset\"\n },\n \"error\": {\n \"groupId\": 0,\n \"groupName\": \"OK\",\n \"id\": 0,\n \"name\": \"NO_ERROR\",\n \"description\": \"No Error\",\n \"permanent\": false\n }\n }\n ]\n}"}],"_postman_id":"46fc5c9c-0cd4-4356-8cab-1e326e54940a"}],"id":"0221a7eb-262d-4089-9d1e-9fa6b018fed6","description":"

GET https://messaging-service.co.tz/api/sms/v1/reports

\n

Delivery report per recipient can only be retrieved/queried once, hence make sure to store them for your reference once retrieved. Available query parameters are:

\n

size:

\n

Specify the number of reports to be retrieved per request. The default and maximum size is 500.

\n

https://messaging-service.co.tz/api/sms/v1/reports?size=200

\n

sender:
Get delivery reports for a specific sender.

\n

https://messaging-service.co.tz/api/sms/v1/reports?sender=N-SMS

\n

messageId:
The ID uniquely identifies the message sent. You will receive a messageId in the response after sending a message.

\n

https://messaging-service.co.tz/api/sms/v1/reports?messageId=348833233

\n

The following additional parameters are still used but will be deprecated in the next minor upgrade.

\n

sentSince and sentUntil:
These are dates within the delivery reports you request to see. These are required both in order to get your requested reports.

\n

reference:

\n

This is the special value which was used during sending a message to associate the sent message with specific API request values.

\n

Using these parameters is optional you can just use the provided API url to get all of the delivery reports status which you have never retrieved before.

\n

Examples on how requests can be made is shown as follows in API url:

\n

https://messaging-service.co.tz/api/sms/v1/reports?sentFrom=2020-01-01&sentUntil=2020-12-31

\n

if no data is found the results will be returned as follows:

\n
{\n    \"results\":[]\n}\n\n
","event":[{"listen":"prerequest","script":{"id":"0ca30927-fb16-4813-8ad4-5b66f01e5628","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c68a38b8-ca23-4d13-a9dc-b9746cfd239d","type":"text/javascript","exec":[""]}}],"_postman_id":"0221a7eb-262d-4089-9d1e-9fa6b018fed6"},{"name":"Sent Sms Logs","item":[{"name":"Get all sent SMS logs","event":[{"listen":"prerequest","script":{"id":"5942409e-07ef-4848-95fd-f569e92959df","exec":[""],"type":"text/javascript"}}],"id":"ab7c4fbe-6378-4a2e-bb67-63c7bb440e8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic aW0yM246MTIzNDU2","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"http://messaging-service.co.tz/api/sms/v1/logs?from=NEXTSMS&limit=5&offset=20","description":"

Let's see what happens when you request all of your logs, without any query parameter:

\n","urlObject":{"protocol":"http","path":["api","sms","v1","logs"],"host":["messaging-service","co","tz"],"query":[{"key":"from","value":"NEXTSMS"},{"key":"limit","value":"5"},{"key":"offset","value":"20"}],"variable":[]}},"response":[{"id":"b1ad04eb-38a8-4323-a36d-d4b39c911cae","name":"Getting Sent SMS logs","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic aW0yM246MTIzNDU2","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://messaging-service.co.tz/api/sms/v1/logs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Apr 2020 09:24:37 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) PHP/7.2.27"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.27"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Content-Length","value":"2909"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"messageId\": \"28695733526003536021\",\n \"sentAt\": \"2020-04-15 16:09:00\",\n \"doneAt\": \"2020-04-18 18:23:07\",\n \"to\": \"255716718040\",\n \"from\": \"NEXTSMS\",\n \"text\": \"test\",\n \"smsCount\": 1,\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"error\": null\n },\n {\n \"messageId\": \"28255409354101630625\",\n \"sentAt\": \"2020-02-24 17:21:00\",\n \"doneAt\": \"2020-04-18 18:23:07\",\n \"to\": \"255716718040\",\n \"from\": \"NEXTSMS\",\n \"text\": \"test\",\n \"smsCount\": 1,\n \"status\": {\n \"groupId\": 5,\n \"groupName\": \"REJECTED\",\n \"id\": 12,\n \"name\": \"REJECTED_NOT_ENOUGH_CREDITS\",\n \"description\": \"Not enough credits\"\n },\n \"error\": null\n },\n {\n \"messageId\": \"28089492984101631440\",\n \"sentAt\": \"2020-02-05 12:28:51\",\n \"doneAt\": \"2020-04-18 18:23:07\",\n \"to\": \"255716718040\",\n \"from\": \"NEXTSMS\",\n \"text\": \"Your message\",\n \"smsCount\": 1,\n \"status\": {\n \"groupId\": 3,\n \"groupName\": \"DELIVERED\",\n \"id\": 5,\n \"name\": \"DELIVERED_TO_HANDSET\",\n \"description\": \"Message delivered to handset\"\n },\n \"error\": {\n \"groupId\": 0,\n \"groupName\": \"OK\",\n \"id\": 0,\n \"name\": \"NO_ERROR\",\n \"description\": \"No Error\",\n \"permanent\": false\n }\n }\n ]\n}"}],"_postman_id":"ab7c4fbe-6378-4a2e-bb67-63c7bb440e8c"},{"name":"Get all sent SMS logs with optional parameter","event":[{"listen":"prerequest","script":{"id":"5942409e-07ef-4848-95fd-f569e92959df","exec":[""],"type":"text/javascript"}}],"id":"493fa3f2-c96d-44cc-892d-b6e166dd0683","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic aW0yM246MTIzNDU2","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://messaging-service.co.tz/api/sms/v1/logs?from=SENDER&to=255716718040&sentSince=2020-02-01&sentUntil=2020-02-20","description":"

you might need some filters to search through them. The filters you can use are:

\n

from:
Sender ID name.

\n

to:
Destination (Phone number starting with 255).

\n

sentSince: Date.
Lower limit on date and time of sending SMS.

\n

sentUntil: Date.
Upper limit on date and time of sending SMS.

\n

offset: To skip a given number of results in the report. This must be an integer.

\n

limit: To limit the number of results returned use limit, this must be an integer (Maximum allowed is 500).

\n

Using parameters is optional you can just use the provided API url to get all of your sent sms logs.

\n

reference:

\n

This is the special value which was used during sending a message to associate the sent message with specific API request values.

\n","urlObject":{"protocol":"https","path":["api","sms","v1","logs"],"host":["messaging-service","co","tz"],"query":[{"key":"from","value":"SENDER"},{"key":"to","value":"255716718040"},{"key":"sentSince","value":"2020-02-01"},{"key":"sentUntil","value":"2020-02-20"}],"variable":[]}},"response":[{"id":"9e4c0e91-db7a-4fad-8726-8ab89c7e3f0d","name":"Get all sent SMS logs with optional parameter","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic aW0yM246MTIzNDU2","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://messaging-service.co.tz/api/sms/v1/logs?from=NEXTSMS&to=255716718040&sentSince=2020-02-01&sentUntil=2020-02-20","protocol":"https","host":["messaging-service","co","tz"],"path":["api","sms","v1","logs"],"query":[{"key":"from","value":"NEXTSMS"},{"key":"to","value":"255716718040"},{"key":"sentSince","value":"2020-02-01"},{"key":"sentUntil","value":"2020-02-20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Apr 2020 09:47:24 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) PHP/7.2.27"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.27"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Content-Length","value":"420"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"messageId\": \"28089492984101631440\",\n \"sentAt\": \"2020-02-05 12:28:51\",\n \"doneAt\": \"2020-04-18 18:23:07\",\n \"to\": \"255716718040\",\n \"from\": \"NEXTSMS\",\n \"text\": \"Your message\",\n \"smsCount\": 1,\n \"status\": {\n \"groupId\": 3,\n \"groupName\": \"DELIVERED\",\n \"id\": 5,\n \"name\": \"DELIVERED_TO_HANDSET\",\n \"description\": \"Message delivered to handset\"\n },\n \"error\": {\n \"groupId\": 0,\n \"groupName\": \"OK\",\n \"id\": 0,\n \"name\": \"NO_ERROR\",\n \"description\": \"No Error\",\n \"permanent\": false\n }\n }\n ]\n}"}],"_postman_id":"493fa3f2-c96d-44cc-892d-b6e166dd0683"}],"id":"3b5528c5-211c-46b2-b2f3-26a7d677b988","description":"

Logs with sent SMS message history can be requested for all messages by using a single request:

\n

GET https://messaging-service.co.tz/api/sms/v1/logs

\n","event":[{"listen":"prerequest","script":{"id":"e23a0abb-57ee-4463-9f7a-af4425c23a55","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"590ab632-34e2-4fc7-ae64-2583b92341a6","type":"text/javascript","exec":[""]}}],"_postman_id":"3b5528c5-211c-46b2-b2f3-26a7d677b988"},{"name":"Sub Customer","item":[{"name":"Register Sub Customer","id":"4d5c6a0a-9d16-45e2-ab8e-74211258ca00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic bmV3MjNuOjEyMzQ1Ng","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Api\",\n \"last_name\": \"Customer\",\n \"username\": \"apicust\",\n \"email\": \"apicust@customer.com\",\n \"phone_number\" : \"0738234339\",\n \"account_type\" : \"Sub Customer (Reseller)\", \n \"sms_price\": 20\n}"},"url":"https://messaging-service.co.tz/api/reseller/v1/sub_customer/create","description":"

This api is enabled for customers in reseller program where they can register their customers.

\n

Complete all the fields required :

\n

first_name

\n

last_name

\n

username

\n

email

\n

phone_number

\n

account_type:\nSub Customer or Sub Customer (Reseller)

\n

sms_price

\n","urlObject":{"protocol":"https","path":["api","reseller","v1","sub_customer","create"],"host":["messaging-service","co","tz"],"query":[],"variable":[]}},"response":[{"id":"3291fa91-13af-4cd4-b959-49ce6d4c99cf","name":"Register Sub Customer","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic bmV3MjNuOjEyMzQ1Ng==","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Api\",\n \"last_name\": \"Customer\",\n \"username\": \"apicust\",\n \"email\": \"apicust@customer.com\",\n \"phone_number\" : \"0738234339\",\n \"account_type\" : \"Sub Customer (Reseller)\", \n \"sms_price\": 20\n}"},"url":"https://messaging-service.co.tz/api/reseller/v1/sub_customer/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.2.27"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 16 Jun 2020 13:37:49 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"57"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"status\": 200,\n \"message\": \"Customer created successfully. Email is sent to your customer email address for confirmation.\",\n \"result\": {\n \"name\": \"Api Customer\",\n \"username\": \"apicust\",\n \"phone_number\": \"+255738234339\",\n \"email\": \"apicust@customer.com\",\n \"account_type\": \"Sub Customer (Reseller)\",\n \"sms_price\": \"20.00 TSH\"\n }\n}"}],"_postman_id":"4d5c6a0a-9d16-45e2-ab8e-74211258ca00"},{"name":"Recharge customer","id":"d3bd992c-08a8-400d-9b52-41fe6afecf44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic aW0yM246MTIzNDU2","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"email\": \"example@email.com\", \"smscount\":5000}"},"url":"https://messaging-service.co.tz/api/reseller/v1/sub_customer/recharge","description":"

To recharge your customer you are required to specify

\n

your customer email account which has been registered with the customer

\n

and smscount number of sms you want to recharge a customer.

\n","urlObject":{"protocol":"https","path":["api","reseller","v1","sub_customer","recharge"],"host":["messaging-service","co","tz"],"query":[],"variable":[]}},"response":[{"id":"1c38604e-a1c1-406a-8dda-98df25044254","name":"Recharge customer","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic aW0yM246MTIzNDU2","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"email\": \"example@email.com\", \"smscount\":5000}"},"url":"https://messaging-service.co.tz/api/reseller/v1/sub_customer/recharge"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.2.33"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 05 Aug 2020 07:21:07 GMT"},{"key":"X-RateLimit-Limit","value":"50000"},{"key":"X-RateLimit-Remaining","value":"49999"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"status\": 200,\n \"message\": \"Transaction completed successfully\",\n \"result\": {\n \"Customer\": \"example@email.com\",\n \"Sms transferred\": 5000,\n \"Your sms balance\": 450000\n }\n}"}],"_postman_id":"d3bd992c-08a8-400d-9b52-41fe6afecf44"},{"name":"Deduct customer","id":"6bd9edb4-540f-489b-b11c-d421123c6651","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic aW0yM246MTIzNDU2","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"email\": \"example@email.com\", \"smscount\":2000}"},"url":"https://messaging-service.co.tz/api/reseller/v1/sub_customer/deduct","description":"

To deduct your customer you are required to specify

\n

your customer email account which has been registered with the customer

\n

and smscount number of sms you want to deduct from a customer account.

\n","urlObject":{"protocol":"https","path":["api","reseller","v1","sub_customer","deduct"],"host":["messaging-service","co","tz"],"query":[],"variable":[]}},"response":[{"id":"c9f0c529-c8aa-471e-be7f-af173729060f","name":"Deduct customer","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic aW0yM246MTIzNDU2","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"email\": \"example@email.com\", \"smscount\":2000}"},"url":"https://messaging-service.co.tz/api/reseller/v1/sub_customer/deduct"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.2.33"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 05 Aug 2020 07:35:02 GMT"},{"key":"X-RateLimit-Limit","value":"50000"},{"key":"X-RateLimit-Remaining","value":"49999"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"status\": 200,\n \"message\": \"Transaction completed successfully\",\n \"result\": {\n \"Customer\": \"example@email.com\",\n \"Sms deducted\": 2000,\n \"Your sms balance\": 470000,\n \"Customer sms balance\": 3000\n }\n}"}],"_postman_id":"6bd9edb4-540f-489b-b11c-d421123c6651"}],"id":"55e93842-e8bb-42b8-8a2d-383025e7c706","event":[{"listen":"prerequest","script":{"id":"01ef4c39-18a9-46fd-b5c1-e1e3c2b4427d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f9445367-d165-4bb8-88fb-e0bfa6a2d11e","type":"text/javascript","exec":[""]}}],"_postman_id":"55e93842-e8bb-42b8-8a2d-383025e7c706","description":""},{"name":"Get sms balance","event":[{"listen":"prerequest","script":{"id":"5942409e-07ef-4848-95fd-f569e92959df","exec":[""],"type":"text/javascript"}}],"id":"570c9c63-4dc5-4ef5-aba5-1e4ba6d6d288","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Basic c3ViY3VzdG9tZXI6MTIzNDU2"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://messaging-service.co.tz/api/sms/v1/balance","urlObject":{"protocol":"https","path":["api","sms","v1","balance"],"host":["messaging-service","co","tz"],"query":[],"variable":[]}},"response":[{"id":"e526ae1c-61c4-475a-bdbd-c1a749ee4529","name":"Get sms balance","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Basic c3ViY3VzdG9tZXI6MTIzNDU2"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://messaging-service.co.tz/api/sms/v1/balance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 May 2020 17:55:06 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) PHP/7.2.27"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.27"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Content-Length","value":"17"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"sms_balance\": 5\n}"}],"_postman_id":"570c9c63-4dc5-4ef5-aba5-1e4ba6d6d288"}],"event":[{"listen":"prerequest","script":{"id":"6c412bd6-8182-4b63-9db4-849abb53549a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"af365973-4801-4e71-9df6-6b3be93a04a7","type":"text/javascript","exec":[""]}}]}