Sending Delivery Reports


    You can also send Delivery Reports for previously Received SMS. To use this feature, Delivery Reports must be activated in the SMS link. Additionally, you must specify a transaction_id in the 200 OK response of the received SMS. You will send an HTTP PUT request using the base url and append the voxbone E164, /report/ and the transaction_id you assined to the received sms. For example if you received an SMS on the voxbone did +3228080000 and assigned a transaction_id of “5idUwgDTbcSb”. He can send a delivery report to the number for this SMS by sending an HTTP PUT message to the following URL:



    Path Method Description
    /{orig_destination}/report/{transaction_id} PUT The delivery report is sent to the specified number via a PUT request with the phone number and transaction ID appended

    Request Body Parameters

    The Voxbone Delivery Report request includes the following parameters:

    Field Type Description
    orig_from String Telephone number of the original SMS sender in +E164 format
    delivery_status(mandatory) Enumeration Possible values: message_waiting, delivered_to_network, delivered_to_terminal, delivery_expired, delivery_failed, delivery_rejected, delivery_impossible, delivery_unknown
    status_code(mandatory) Enumeration Possible values: ok, accepted, bad_request, message_too_long, not_found, forbidden, limit_exceeded, overload, temporarily_unavailable, internal_error, unknown_error, timeout
    submit_date String UTC date corresponding to time voxbone originally received the message
    done_date String UTC date corresponding to time final delivery occurred

    Sample Request

    curl -X PUT --digest -u username:password -H "Content-type: application/json" -H "Accept: application/json" "" --data-binary $'{"orig_from" : "+3245546750","delivery_status" : "delivered_to_network", "status_code" : "ok", "submit_date" : "2015-03-27 15:36:16", "done_date" : "2015-03-27 15:36:16"}'

    Sample Request Body

    “orig_from” : “+3245546750”,
    “delivery_status” : “delivered_to_network”,
    “status_code” : “ok”,
    “submit_date” : “2015-03-27 15:36:16”,
    “done_date” : “2015-03-27 15:36:16”


    200 OK if transaction specified in transaction_id is found. 4xx error if transaction is not found, delivery reports not enabled, or delivery report was not requested