What can I do with bounce?

Bounces can be useful for finding out why a task failed to deliver to a subscriber.

  • See a list of bounces for a subscriber you've sent to by filtering by subscriber_id.
  • Filtering bounces by task_id will show you how many bounces a task received.
  • Use subscriber_id and task_id to diagnose why a particular subscriber hasn't received a particular message.
  • Bounces are classified by type and can be "hard" or "soft". Please see our knowledge guide for an explanation of these terms.

Bounce is a read-only endpoint. POST, PUT and DELETE methods are not supported.

GET /bounce or /bounce/:id

AttributeTypeFilterSortDescription
id
intRequired*YesUnique ID of the bounce event.
channel
enumRequiredNoSend channel: "email" or "sms".
error
stringNoNoError returned by the peer server after delivery was attempted.
subscriber_id
intRequired*YesUnique ID of the subscriber to whom the bounced message was sent.
email
string/nullNoNoIf channel = "email", the email address of the subscriber to whom the bounced message was sent; null otherwise.
msisdn
string/nullNoNoIf channel = "sms", the MSISDN (see definition) of the subscriber to whom the bounced message was sent; null otherwise.
task_id
intRequired*YesUnique ID of the task from which the bounce occurred.
type
enumNoNoThe type of bounce: "hard" or "soft".
cdate
decimalNoYesTimestamp at which the bounce occurred.

*At least one of: id, task_id, subscriber_id must always be present.

error can help you determine the cause of a bounce. See our knowledge guide for an explanantion of bounce error codes.

HEAD /bounce or /bounce/:id

AttributeTypePresenceDescription
id
intRequired*Unique ID of the bounce event.
channel
enumRequiredSend channel: "email" or "sms".
subscriber_id
intRequired*Unique ID of the subscriber to whom the bounced message was sent.
task_id
intRequired*Unique ID of the task from which the bounce occurred.

*At least one of: id, task_id, subscriber_id must always be present.

POST /bounce

This method is not supported.

PUT /bounce or /bounce/:id

This method is not supported.

DELETE /bounce or /bounce/:id

This method is not supported.

Error codes

There are no error codes for this endpoint.

Examples

Have you seen our example of this endpoint being used with other endpoints?

JSON response

{
    "id":                 12345678,
    "channel":            "email",
    "error":              "4.2.1",
    "subscriber_id":      87654321,
    "email":              "someone@example.com",
    "msisdn":             null,
    "task_id":            456789,
    "type":               "hard",
    "cdate":              1317259641   
}