Delivery reports

Delivery reports let you check whether a message was delivered, is still pending, or could not be delivered.

Check delivery status at least 5 minutes after sending an SMS. Mobile network operators need time to return delivery updates to Beem.

How it works

Send an SMS using Send SMS.
Note the request_id returned for each recipient in the response.
After at least 5 minutes, call Get delivery reports with dest_addr and request_id.

API reference

Use the interactive API reference to try the request: Get delivery reports — GET https://dlrapi.beem.africa/public/v1/delivery-reports

Query parameters

Parameter	Description
`dest_addr`	Destination mobile number (same format as when sending).
`request_id`	Request ID from the Send SMS response for that recipient.

Status values

Status	Meaning
`PENDING`	Delivery is still in progress.
`DELIVERED`	Message was delivered to the handset.
`UNDELIVERED`	Message could not be delivered.

Authentication

Authenticate with Basic Auth (API Key and Secret) or an access token. See Authentication. Set Content-Type to application/json for JSON requests or application/xml for XML requests.

Sample response

[
  {
    "dest_addr": "255700000002",
    "status": "PENDING",
    "request_id": "31951"
  }
]

Error responses

HTTP status	When
`404`	Invalid `request_id` or `dest_addr` — no matching delivery report.
`401`	Invalid API credentials — see API responses.
`400`	Missing authorization header or invalid request.

Sending flow — end-to-end SMS lifecycle
Send SMS — submit messages and obtain request_id values

Getting Started

APIs

How it works

API reference

Query parameters

Status values

Authentication

Sample response

Error responses

​How it works

​API reference

​Query parameters

​Status values

​Authentication

​Sample response

​Error responses

​Related

How it works

API reference

Query parameters

Status values

Authentication

Sample response

Error responses

Related