amb-conversations

List conversations

Returns the conversations your business has with customers on Apple Messages for Business, newest first by last message. To page through older conversations, use starting_after. A closed conversation stays in this list; filter on status for the Apple channel state, or inbox_status for open and resolved inbox work.

Use assigned_to=me for your own conversations or unassigned for conversations without an assignee. Repeat label to require every supplied label.

get/v1/amb/conversations

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/amb/conversations
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Query parameters

inbox_status'open' | 'resolved'

Whether the conversation needs attention in the workspace inbox. Set it to resolved when the work is finished. A new inbound message reopens the same conversation. Changing inbox status preserves message history and does not change the channel's permission to send messages or mark messages read.

Filter by workspace inbox status. Omit to include open and resolved conversations.

business_account_idstring
Example:abz_01krdgeqcxet5s7t44vh8rt9mg

Filter to conversations belonging to this business.

status'open' | 'closed'

Apple's native conversation state, which determines whether replies can be sent. A customer close or an Apple 410 response closes it; a newer inbound message reopens it. This API has no native close operation. Use inbox_status to resolve workspace inbox work independently.

Filter to conversations with this status. Omit to return both open and closed conversations.

intent_idstring

Filter to conversations with this entry point intent, as sent in Apple's intentID. Conversations whose entry point carried no intent match only when this filter is omitted.

group_idstring

Filter to conversations with this entry point group, as sent in Apple's groupID. Conversations whose entry point carried no group match only when this filter is omitted.

queuestring

Filter to conversations in this queue. Pass an empty string to match unrouted conversations, the ones no routing rule has claimed.

assigned_tostring

Return conversations assigned to this workspace member. Pass me for the signed-in user or unassigned for conversations without an assignee. An API key cannot use me and receives a 422 response.

labelstring[]

Return conversations carrying this label. Repeat the parameter to require every supplied label.

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.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

Paginated list of conversations.

next_cursorstring nullable required

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

prev_cursorstring nullable required

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

refresh_cursorstring nullable required

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.

Example response

{
  "data": [
    {
      "routing": {
        "entry_point": "support",
        "queue": "support"
      },
      "routing_change": {
        "entry_point": "billing",
        "queue": "billing",
        "message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg"
      },
      "last_message": {
        "id": "amb_01krdgeqcxet5s7t44vh8rt9mg"
      },
      "id": "acv_01krdgeqcxet5s7t44vh8rt9mg",
      "business_account_id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
      "device_capabilities": [
        "QUICK",
        "LIST",
        "TIME"
      ],
      "locale": "en-US",
      "assigned_to": "usr_01krdgeqcxet5s7t44vh8rt9mg",
      "labels": [
        "billing",
        "vip"
      ]
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.