The Documentation Hub

Welcome to Kaleyra Documentation Hub. You can find comprehensive API docs, integration guides and docs to getting you started. In case you're stuck, refer to the docs here and you're good to go

Get Started    

Delivery URL for SMS API

What is Delivery URL?

DLRURL is the URL from which you can get the delivery reports if requested through an API. To request such delivery reports, you need to pass "DLRURL" parameter in the API URL.

Custom Flags in DLRURL

We have few custom flags supported in DLR URL to get the additional values. In case one wants to build the URL in above format, the following flags can be used:

Field Name
Description

{status}

SMS status code

{sid}

MessageID generated by us

{custom}

ReferenceID provided for the sms

{custom1}

Custom Flag 1 associated with the message

{custom2}

Custom Flag 2 associated with the message

{credits}

Credits charged for the Sms

{senttime}

Sent to Operator time in YYYY-MM-DD HH:mm:SS format

{submittime}

Request receive time in YYYY-MM-DD HH:mm:SS format

{delivered}

Delivered time in YYYY-MM-DD HH:mm:SS format

{sentat}

Sent to Operator in unixtime format

{delivat}

Delivered time in unixtime format

{submitat}

Request Receive time in unixtime format

{mobile}

Mobile Number

{units}

No of Message Units

Sample DLRURL


http%3A%2F%2Fdomain.net%2Freceive%3Fsent%3D%7Bsent%7D%26delivered%3D%7Bdelivered%7D%26custom%3D%7Bcustom%7D%26sid%3D%7Bsid%7D%26status%3D%7Bstatus%7D%26reference%3D%7Breference%7D%26custom1%3D%7Bcustom1%7D%26custom2%3D%7Bcustom2%7D%26credits%3D%7Bcredits%7D%0A

Sample DLRURL without encode


http://domain.net/receive?sent={sent}&delivered={delivered}&custom={custom}&sid={sid}&status={status}&reference={reference}&custom1={custom1}&custom2={custom2}&credits={credits}

What's Next

API Responses

Delivery URL for SMS API


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.