Callbacks - Statuses

GET https://api.octopush.com/callbacks-statuses

Examples of Callback Payloads for Delivery

SMS Channel

JSON

{
  "channel": "sms",
  "message_id": "sms_0000000000000000000000",
  "list_name": "List Name",
  "number": "[phone]",
  "status": "DELIVERED",
  "unit_price": 0.5,
  "delivery_date": "2025-01-22 11:46:06",
  "meta_data": {}
}

Voice SMS Channel

JSON

{
  "channel": "voice_sms",
  "message_id": "voice_0000000000000000000000",
  "list_name": "List Name",
  "number": "[phone]",
  "status": "DELIVERED",
  "unit_price": 0.5,
  "delivery_date": "2025-01-22 12:28:27",
  "meta_data": {
    "pressed_keys_code": "3545",
    "call_duration": 35,
    "charged_duration": 30
  }
}

RCS Channel

JSON

{
  "channel": "rcs",
  "message_id": "rcs_0000000000000000000000",
  "list_name": "List Name",
  "number": "[phone]",
  "status": "DELIVERED",
  "unit_price": 0.5,
  "delivery_date": "2025-01-22 12:29:14",
  "meta_data": {}
}

Email Channel

JSON

{
  "channel": "email",
  "message_id": "email_0000000000000000000000",
  "list_name": "List Name",
  "meta_data": {
    "template_name": "Template Name"
  },
  "deliveries": [
    {
      "email": "[email protected]",
      "status": "OPENED",
      "unit_price": 0.5,
      "delivery_date": "2025-01-22 12:24:30",
      "status_history": [
        {
          "status": "DELIVERED",
          "delivery_date": "2025-01-22 12:23:30"
        }
      ]
    },
    {
      "email": "[email protected]",
      "status": "SPAM_PRESUMPTION",
      "unit_price": 0.5,
      "delivery_date": "2025-01-22 12:19:30",
      "status_history": []
    }
  ]
}

---

List of Delivery Statuses

Below is a list of possible message delivery statuses along with their descriptions and associated channels:

Status code	Description
DELIVERED	Message successfully delivered
READ	Message read
ACK	Acknowledged by first carrier
OPENED	The recipient has opened your email
CLICKED	The recipient has clicked on your email
TRANSMITTED	Your message was received by Email Gateway
ISP_SEND	Your message was sent to the ISP
UNDEFINED	Undefined status
UNKNOWN_DELIVERY	Unknown delivery status
PROCESSED	Your message is queued for sending or undergoing SPF/DKIM authentication with the ISP
SPAM_PRESUMPTION	Potential spam detection for the email
ABANDONED	No further action taken on this message
NOT_DELIVERED	Message not delivered
NOT_DELIVERABLE	Message not deliverable
BAD_DESTINATION	Invalid destination
BLACKLISTED_NUMBER	Number is blacklisted
NOT_ALLOWED	Delivery not allowed
EXPIRED	Delivery expired
BUSY	Recipient was busy
REFUSED	Call was refused by recipient
ANTI_FLOODING	Message blocked due to anti-flooding rule
UNFOUND_DESTINATION	Destination not found
EMPTY_TEXT	No message content
TIMEOUT	Delivery timed out
SPAM_REPORT	The recipient has blocked your email
UNSUBSCRIBED	The recipient has unregistered from your sendings
FILTERED	Email address has been rejected due to a very high failure potential
HARD_BOUNCE	Your message was refused by the ISP
BLOCKED	Your campaign is blocked due to a too poor quality of email database. Please qualify your addresses or your sendings will be rejected.
SPAM_DETECTED	Your message was detected as spam by ISP
DOMAIN_ERROR	Your message can't be sent, the host doesn't exist or doesn't have MX service
SOFT_BOUNCE	Your message was refused, the account is inactive or over quota
UNKNOWNED_USER	User doesn't exist