List events for a message

GET

/v1/amb/messages/{message_id}/events

const result = await bird.amb.listEvents("amb_01krdgeqcxet5s7t44vh8rt9mg");
console.log(result);

result = client.amb.list_events('amb_01krdgeqcxet5s7t44vh8rt9mg')
print(result)

result, err := client.Amb.ListEvents(ctx, "amb_01krdgeqcxet5s7t44vh8rt9mg", bird.AmbListEventsParams{})
if err != nil {
	log.Fatal(err)
}
fmt.Println(result)

$bird->amb->listEvents('amb_01krdgeqcxet5s7t44vh8rt9mg');

bird amb list-events <message-id>

curl -X GET "https://us1.platform.bird.com/v1/amb/messages/{message_id}/events" \
  -H "Authorization: Bearer $TOKEN"

响应200

{
  "data": [
    {
      "id": "aev_01krdgeqcxet5s7t44vh8rt9mg",
      "type": "amb.sent",
      "error": {
        "code": "bird:business_not_registered",
        "description": "Apple refused the message with HTTP status 404."
      }
    }
  ]
}

Returns a message's lifecycle events in chronological order, one entry per status transition (amb.accepted, amb.sent, amb.send_failed, amb.received). The timeline is bounded and returned in full, so this list is not paginated. Event history does not expire based on age.

参数

message_id

string

Message identifier. Starts with amb_.

查询参数

type

string

Keep only events of this exact type (for example amb.sent or amb.send_failed). Omit for the full timeline.

Possible values (may grow over time): amb.accepted, amb.sent, amb.send_failed, amb.rejected, amb.received

响应载荷

data

array of object

必填

The message's events, oldest first. Not paginated: a message's timeline is bounded and returned in full.

显示子属性

data.id

string

必填

ID of the event, unique within the message's timeline.

data.type

string

必填

Message timeline event type:

amb.accepted: The API accepted the request.
amb.sent: The message was handed to Apple.
amb.send_failed: Apple refused the message, or its send attempts were exhausted.
amb.rejected: Bird refused the message before any send attempt.
amb.received: An inbound message arrived from the customer.

This is an open enum. Accept unrecognized values.

Possible values (may grow over time): amb.accepted, amb.sent, amb.send_failed, amb.rejected, amb.received

data.occurred_at

string

必填

When this event occurred.

data.error

nullable object

Failure detail, on an amb.send_failed or amb.rejected event. Null on every other event type.

显示子属性

data.error.code

string

必填

Machine-readable reason a send failed, in one of two namespaces: bird: for a reason Bird's own pipeline assigned (for example bird:business_not_registered), or apple: followed by the HTTP status Apple's API returned for the send attempt (for example apple:404). This is an open, growing set in both namespaces; accept unrecognized values.

data.error.description

string

必填

The failure in words. Free-form, so branch on code and show this to a human.

data.error.occurred_at

string

必填

When the failure occurred.

相关资源

继续查阅此主题的文档、指南和示例。资源为英文。

理解概念Should I use a Bird SDK or call the API directly?跟随学习路径Build your first integration 实施指南Send your first email

获取实施简报

const result = await bird.amb.listEvents("amb_01krdgeqcxet5s7t44vh8rt9mg");
console.log(result);

result = client.amb.list_events('amb_01krdgeqcxet5s7t44vh8rt9mg')
print(result)

result, err := client.Amb.ListEvents(ctx, "amb_01krdgeqcxet5s7t44vh8rt9mg", bird.AmbListEventsParams{})
if err != nil {
	log.Fatal(err)
}
fmt.Println(result)

$bird->amb->listEvents('amb_01krdgeqcxet5s7t44vh8rt9mg');

bird amb list-events <message-id>

curl -X GET "https://us1.platform.bird.com/v1/amb/messages/{message_id}/events" \
  -H "Authorization: Bearer $TOKEN"

响应200

{
  "data": [
    {
      "id": "aev_01krdgeqcxet5s7t44vh8rt9mg",
      "type": "amb.sent",
      "error": {
        "code": "bird:business_not_registered",
        "description": "Apple refused the message with HTTP status 404."
      }
    }
  ]
}