Receive delivery reports

Description

If a delivery report URL has been specified when a batch is created, status update reports will be sent to that URL as soon as they are available. The contents of these reports are described below.

Our system sends the report using POST and expects a 200 OK response if the report is delivered correctly. If any other status (i. e. an error status) is received then the report will be sent again at a later time. These retries are repeated each 10 minutes until an 200 OK is received, or for a maximum of 10 tries after which the report is discarded.

Rapport Payload

{
    "id": "5c613848879973045cf39ac4",
    "batchId": "5c613848879973045cf39ac3",
    "recipient": "456189040623",
    "code": 102,
    "duration": 0,
    "created": "2018-10-23T17:43:21Z",
    "segments": 2,
    "price": 0.082,
    "currency": "sek",
    "reference": "A client reference"
}

Fält för Payload

Field name Type Description and Conditions Example
id String The ID of the incoming message. 

"id": "5bcf4324ee47dee41a9dbb13"
batchId String ID of the parent batch of the incoming message (Messages cannot exist without a parent batch). 

"batchId": "5c613848879973045cf39ac3"
batchId String The account ID of the SMS account that owns the message (e.g. you). 

"owner": "ip1-XXXXX"
recipient String The sender ID of the message's originator. 

"sender": "46712345678"
code Integer Den nsenaste statuskoden för meddelandet. För mer information om våra statuskoder, se avsnittet om Status codes 

"code": 102
duration Integer Whether the status is permanent/final. If it is, then this is the last report that will be sent about this message. 

"duration": 0
created String When the status update occured (i. e. when the report was generated). 

"created": "2018-10-23T17:43:21Z"
segments String I de fall meddelandet består av fler tecken än teckengränsen för ett SMS kommer meddelandet att delas upp i flera SMS, även kallat konkatenerade SMS. Den här egenskapen indikerar om hur många SMS som behövs för att kunna skicka meddelandet 

"segments": 2,
price Integer The price for the entire message. In case you want to get the price for a single sms you can divide the number of segments by the price. 

"price": 0.082,
currency String Which currency the given price uses. 

"currency": "sek",
reference String This is a property that allows the user to set a custom ID or credential if storing the default generated IDs is deprecated. 

 "reference": "A client reference"