SMS Status Check

This helps to check for the status of an SMS by providing an identifier.

Status Check with MessageID

A query to this endpoint returns the status of a single message.

Request Parameters

Parameter	Type	Requirement	Description
messageID	String	Mandatory	An ID of one of the sent messages.

Sample Request

GET /v1/messages/batch/ eadbfcd0-94d1-438f-ad32-0013f34042c2 HTTP/1.1
Host: sms.hubtel.com

curl --location 'https://sms.hubtel.com/v1/messages/c0658679-c685-45c7-b38b-555c322c4c16' \
--header 'Authorization: Basic ZGJyZXRWc6bm5oY3B6cnc='

Response Parameters

Parameter	Type	Description
rate	Number	Cost per sms
batchId	String	Unique identifier of batch message
messageId	String	Unique identifier of individual message
content	String	Content of the message.
status	String	Current status of message based on DeliveryReceipt (DLR) by Telco.
updateTime	String	DLR update time.
time	String	SMS was sent.
to	String	MSISDN to receive message
from	String	SenderId or name recipient will see.

Sample Response

{
    "rate": 0.0309,
    "batchId": null,
    "messageId": "eadbfcd0-94d1-438f-ad32-0013f34042c2",
    "content": "The Job is the JOB",
    "status": "Delivered",
    "updateTime": "2023-05-30T16:43:15",
    "time": "2023-05-30T16:43:13.7208383Z",
    "to": "233546335113",
    "from": "AbrantieCo"
}

Status Check with BatchID

A query to this endpoint returns the status of a batch of messages.

Request Parameters

Parameter	Type	Requirement	Description
batchID	String	Mandatory	An ID from a batch of messages sent.

Sample Request

GET /v1/messages/batch/18ee6a2a-29ac-41c6-b70f-de809b040584 HTTP/1.1
Host: sms.hubtel.com

curl --location 'https://sms.hubtel.com/v1/messages/batch/1855d322-1e14-46f8-acc6-53b9d04d9d8c' \
--header 'Authorization: Basic ZGJyZXRibWbm5oY3B6cnc='

Response Parameters

Parameter	Type	Description
rate	Number	Cost per sms
data	Array	This contains other objects.
batchId	String	Unique identifier of batch message
messageId	String	Unique identifier of individual message
content	String	Content of the message.
status	String	Current status of message based on DeliveryReceipt (DLR) by Telco.
updateTime	String	DLR update time.
time	String	SMS was sent.
to	String	MSISDN to receive message
from	String	SenderId or name recipient will see.

Sample Response

{
    "batchId": "18ee6a2a-29ac-41c6-b70f-de809b040584",
    "data": [
        {
            "rate": 0.0309,
            "messageId": "f58e7f2a-203a-4079-a518-7f6647099b5e",
            "content": "Hi Joe, thank you for all you do for this business",
            "status": "Delivered",
            "updateTime": "2023-03-21T12:54:43",
            "time": "2023-03-21T12:50:27.893495Z",
            "to": "233546335113",
            "from": "AbrantieCo"
        },
        {
            "rate": 0.0309,
            "messageId": "350fd34d-dce1-4694-a4c9-d9b97d1f4593",
            "content": "Hi Pheezy, thank you for all you do for this business",
            "status": "Delivered",
            "updateTime": "2023-03-21T12:50:34",
            "time": "2023-03-21T12:50:27.893495Z",
            "to": "233501431586",
            "from": "AbrantieCo"
        }
    ]
}

SMS Status

Find below SMS Status based on DeliveryReceipts (DLR)s by Telco:

Delivered
These messages have been reliably and successfully dispatched to the recipient's phone.
This constitutes the ultimate Delivery Receipt (DLR) status provided by a telco.
Sent
Sent messages encompass messages that have been forwarded by Hubtel to the recipient's network operator for eventual delivery.
These messages are currently in a state of pending delivery by the telcos.
To ascertain their ultimate status, you can utilize the status check API at a later time.
Pending
Pending messages are those in a queue, awaiting discharge by Hubtel to the recipient's network operator for the purpose of delivery.
Blacklisted
Blacklisted numbers correspond to individuals who have explicitly communicated with telcos to abstain from receiving unsolicited bulk messages on their mobile devices.
As a result, the telco designates these numbers for blacklist inclusion.
It's important to emphasize that the network operator is responsible for delivering
messages to the handset.
Hubtel solely receives the ultimate message status from the mobile network operator.
Undeliverable/Failed, Unrouteable/Error, Rejected
Occurrences of messages like these could arise from various factors, such as the customer's phone being powered off, inaccessible, or experiencing network unavailability.
Additionally, issues could stem from the recipient being situated outside network coverage during the moment the message was dispatched to their device.
These various statuses are dependent on the various Telcos.
NACK/0x0000000b/Invalid Destination Address
These statuses mean that the recipient number may be inaccurate or inadequately formatted.