Delivery reports - Beem API

When you send a message, set DLR=1 to request a delivery report. The Messaging Platform (MP) issues an HTTP POST to your callback URL when the final delivery status is reached.

Per-message callback URL

Provide a fully qualified HTTPS URL in the DLRADDRESS parameter on each send request. You do not need a separate portal configuration step for DLR callbacks.

DLR=1
DLRADDRESS=https://www.example.com/dlr-callback

DLR parameters

Parameters sent from MP to your DLRADDRESS:

Parameter	Description
`ID`	Original message ID
`DLRID`	Message ID the DLR refers to
`SOURCEADDR`	Sender address
`DESTADDR`	Recipient address
`STATUS`	Delivery status code
`MSGTYPE`	Message type
`MESSAGE`	Status message text
`VP`	Validity period

DLR status values

Status	Meaning
`1`	Delivered
`2`	In process
`3`	Failed
`4`	Deleted
`5`	Expired
`6`	Rejected
`7`	Canceled
`8`	Queued
`9`	Orphaned
`10`	Relayed
`11`	Unknown

Your server must respond with HTTP 200 OK. The response body should be empty and will be ignored.

Sample handler (PHP)

<?php
header('Content-Type: application/json');

$status = $_POST['STATUS'] ?? null;
$messageId = $_POST['DLRID'] ?? $_POST['ID'] ?? null;

// Process the DLR here

http_response_code(200);
?>

Sample implementations: beem-sms-txn-api-sample — callback

Inbound two-way SMS — mobile-originated messages
Parameters reference — send and receive parameter lists