Sign inGet Started

List messages in a conversation

GET
/v1/amb/conversations/{conversation_id}/messages
const result = await bird.amb.conversations.listMessages(
  "acv_01krdgeqcxet5s7t44vh8rt9mg",
  { limit: 2 },
);
console.log(result);
响应200
{
  "data": [
    {
      "id": "amb_01krdgeqcxet5s7t44vh8rt9mg",
      "conversation_id": "acv_01krdgeqcxet5s7t44vh8rt9mg",
      "business_account_id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
      "direction": "outbound",
      "status": "accepted",
      "kind": "text",
      "source": "operator",
      "in_reply_to_message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg",
      "reply_message_id": "amb_01krdgh7m2zq8w4x6y9b3c5d7e",
      "replied_at": "2026-10-13T10:09:00Z",
      "locale": "en_US",
      "category": "order_update",
      "tags": [
        {
          "name": "category",
          "value": "welcome"
        }
      ],
      "cost": {
        "amount": "0.00990",
        "currency_code": "USD",
        "transaction_amount": "0.00790",
        "passthrough_amount": "0.00200"
      },
      "last_error": {
        "code": "bird:business_not_registered",
        "description": "Apple refused the message with HTTP status 404."
      },
      "requested_language": "pt-BR",
      "resolved_language": "pt-BR",
      "template_id": "amt_01krdgeqcxet5s7t44vh8rt9mg",
      "template_version_id": "amv_01krdgeqcxet5s7t44vh8rt9mg",
      "template_content_hash": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns the messages in a conversation, newest first, both received and sent. To page through older messages, use starting_after. The sort order is fixed, so to render the messages in conversation order, reverse the page yourself. Messages do not expire based on age.

参数

conversation_idstring

Conversation identifier. Starts with acv_.

查询参数

directionstring

Filter to received (inbound) or sent (outbound) messages.

Possible values: outbound, inbound

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

响应载荷

data
array of object
必填

Page of Apple Messages for Business messages, newest first.

显示子属性
next_cursor
nullable string
必填

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursor
nullable string
必填

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursor
nullable string
必填

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.