POST | Receive delivery reports for campaign

Delivery reports are making "packs". You can receive delivery reports in this way only once per message. If there is a need to re-receive the delivery report, you must use the method of obtaining message identifiers and request a delivery report for each identifier.

Requested by POST query, all parameters are transmitted in JSON format in the request body.

URL

https://api.quantumtec.eu/v1/sms/report/bulk

Header parameters

Parameter Value
Content-Type application/json
Accept application/json
X-ApiKey API key

Query parameters

Parameters are sent in JSON format

Parameter Format Usage Description
bulkId string Mandatory Specifies the campaign ID received when sending.
Limit integer Optional Limits the number of delivery reports to be sent. In the absence of this parameter, the default value of 50 is used. Maximum value of 500

In response, a data set in JSON format will be sent.

Response parameters

Parameter Description
bulkId Campaign ID
status

Campaign status:

  1. New
  2. Waiting confirmation
  3. Verified
  4. Preparing
  5. Prepared
  6. In process
  7. Sending
  8. Suspended
  9. Sent
  10. Stopped
  11. Rejected
  12. Completed
deliveryResults Data array containing a delivery report for each message
deliveryResults(messageID) Message ID
deliveryResults(partId) ID of the message part if the message is multipart
deliveryResults(state)

Message delivery status:

  1. Delivered
  2. Expired
  3. Deleted
  4. Undelivered
  5. Accepted
  6. Unknown
  7. Rejected
deliveryResults(delivered) The time of receipt of the report delivery message in UTC.
deliveryResults(errorCode) Error code (Not supported by all mobile operators)

Example