SMS Reports

Africans best sms delivery
SMS TODAY: processing sms made simple
Release 1.2.

You may sometimes want to know delivery reports of your sms's at later time, you can archive this by calling reports system as bellow


End point

https://api.smstoday.net/report

Below is a list of all required arguments that needs to be sent in the POST request:
NOTE: You can query reports by submitting either message id or the bulk id

Request Type: POST
Parameter Required Description
message_id YES Represent a message id which was returned by the SMS TODAY system on time of sending sms
Query a single message against it's message id
bulk_id NO Represent a bulk messages id which was returned by the SMS TODAY system on time of sending messages
This queries all messages sent on the particular session.
api_key YES The value of api_key identifies the user within the system when interacting with the api. You obtain this by registering on https://doc.smstoday.net.
Register here
password YES Your SMS TODAY account password

When specified message_id or bulk_id does not exists the system may return status 700 which means Undefined required field message id or bulk id

The sample code below is all that is required to integrate Sms today into your application/websites when calling single message report curl -X POST -F message_id=6074a0fa77686&api_key=0000&password=000 The sample code below is all that is required to integrate Sms today into your application/websites when calling bulk message report curl -X POST -F bulk_id=6074a0fa7768a&api_key=0000&password=000

REQUEST RESPONSE

Response is always on json format where you're required to decode into your workspace language

json string which the server reply to your call

Response Type: JSON { "feedback":[ { "id":"glhhvg2e29ht", "row":"iyiaqtrah14t", "state":"4" } ], "status":200, "type":"success", "msg":"Delivery report tracked" }

json string explained

Parameter Description Example
type Their are number of request type response

success indicated that the request was made successful
info indicated that the request wasn't made successful If you may encounter response "info" it means the request is not POST or the requested resource is not available within the api

success,
info,
danger,
warning
msg This contains the response message in a human readable request was successful, request wasn't successful
code Depending on the que status the api can replay with number of request codes, these codes indicates that the request succeed or not

200 request was successful
400 Invalid api key
700 Undefined required field

Note: Status 200 is generated once a single message satisfied the gateway for delivery.
state Depending on the que status the api can replay with number of delivery state, these states indicates that the sms delivered or not

1 SMS not paid
2 SMS paid
3 Pending
4 Delivered
5 Rejected by the delivery terminal
6 Failed (Either expired or network)
7 Unknown, the state is not known and it can recover

feedback Contains detailed description of the delivery state

id message id by the time of sending
row the bulk id of the que assigned
state current state of the sms within delivery system

state 4
id glhhvg2e29ht
row iyiaqtrah14t