List conversations

GET

/v1/amb/conversations

const result = await bird.amb.conversations.list({
  business_account_id: "abz_01krdgeqcxet5s7t44vh8rt9mg",
  limit: 2,
});
console.log(result);

result = client.amb.conversations.list(business_account_id='abz_01krdgeqcxet5s7t44vh8rt9mg', limit=2)
print(result)

for item, err := range client.Amb.Conversations.List(ctx, bird.AmbConversationsListParams{BusinessAccountID: "abz_01krdgeqcxet5s7t44vh8rt9mg", Limit: 2}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(item)
}

foreach ($bird->amb->conversations->list(['business_account_id' => 'abz_01krdgeqcxet5s7t44vh8rt9mg', 'limit' => '2']) as $item) {
    var_dump($item);
}

bird amb conversations list

curl -X GET "https://us1.platform.bird.com/v1/amb/conversations" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "intent_id=order_status" \
  --url-query "group_id=support" \
  --url-query "queue=support" \
  --url-query "assigned_to=me" \
  --url-query "label=billing" \
  --url-query "limit=25"

Réponse200

{
  "data": [
    {
      "inbox_status": "open",
      "routing": {
        "entry_point": "support",
        "queue": "support"
      },
      "routing_change": {
        "entry_point": "billing",
        "queue": "billing",
        "message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg"
      },
      "last_message": {
        "id": "amb_01krdgeqcxet5s7t44vh8rt9mg",
        "direction": "outbound"
      },
      "id": "acv_01krdgeqcxet5s7t44vh8rt9mg",
      "business_account_id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
      "status": "open",
      "origin": "entry_point",
      "device_capabilities": [
        "QUICK",
        "LIST",
        "TIME"
      ],
      "supported_content_kinds": [
        "text"
      ],
      "locale": "en-US",
      "assigned_to": "usr_01krdgeqcxet5s7t44vh8rt9mg",
      "labels": [
        "billing",
        "vip"
      ],
      "closed_reason": "user_close"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

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.

Paramètres de requête

inbox_statusstring

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

Possible values: open, resolved

business_account_idstring

Filter to conversations belonging to this business.

statusstring

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

Possible values: open, closed

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.

labelarray

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.

Contenu de la réponse

data

array of object

obligatoire

Page of conversations, newest first by last message.

Afficher les attributs enfants

data.inbox_status

string

obligatoire

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.

Possible values: open, resolved

data.recipient

object

obligatoire

The customer on the other side of this Apple Messages for Business conversation.

Afficher les attributs enfants

data.routing

object

obligatoire

Routing context the conversation is filed under. Routing rules set it when the conversation opens or reopens, or when the customer writes after it was resolved. A teammate can move the queue or apply a pending routing_change.

Afficher les attributs enfants

data.routing_change

nullable object

obligatoire

Routing from a later customer message that differs from routing, waiting for a teammate to apply or dismiss it. Null when there is none. Only recorded while the inbox status is open; resolving the conversation or moving its queue clears it.

Afficher les attributs enfants

data.last_message

nullable object

obligatoire

Most recent message, or null when its identity has not been recorded.

Afficher les attributs enfants

data.id

string

obligatoire

Conversation ID.

data.business_account_id

string

obligatoire

Business this conversation belongs to.

data.status

string

obligatoire

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.

Possible values: open, closed

data.origin

string

obligatoire

How the conversation started. entry_point means the customer opened it from one of your configured Apple Messages for Business entry points. invitation means the customer accepted an invitation and sent a message. This is set once when the conversation is created and never changes.

Possible values: entry_point, invitation

data.device_capabilities

array of string

obligatoire

The capability tokens the customer's device advertised on its most recent message, replaced by each inbound rather than accumulated, so this describes the device in use now. An empty list means the device's capabilities are unknown. Implemented message types may still be sent, but device rendering support has not been confirmed. Authentication requires an explicitly advertised AUTH2 capability.

data.supported_content_kinds

array of string

obligatoire

Implemented baseline types plus interactive types confirmed by device_capabilities. An empty capability list yields text, attachments and rich links; it does not establish support for other types. Unadvertised quick replies, list pickers, time pickers and forms are refused when capabilities are known. Custom apps and opaque interactive references are not included because their device support cannot be inferred from these tokens. Unsupported roadmap types cannot be sent.

data.locale

string

obligatoire

The customer's locale from the most recent inbound message, or your business's default locale before any inbound arrives. Preserved in Apple's locale format, for example en_US@rg=nlzzzz.

data.unread_count

integer

obligatoire

Number of inbound messages the workspace has not acknowledged. Shared across the workspace. Pass read with a date-time to acknowledge received inbound messages through that timestamp. Sending a reply does not change this count.

data.assigned_to

nullable string

obligatoire

The user this conversation is assigned to, or null when unassigned. Assignment is not rechecked against workspace membership on read, so it can still name a user whose access was removed.

data.labels

array of string

obligatoire

Workspace labels on this conversation. Labels do not change read state or inbox status.

data.closed_at

nullable string

obligatoire

When the native Apple conversation was closed. Null while its native status is open; independent of inbox status.

data.closed_reason

nullable string

obligatoire

Why the native Apple conversation was closed. Null while its native status is open; independent of inbox status.

data.created_at

string

obligatoire

When this conversation was created.

data.updated_at

string

obligatoire

When this conversation last changed.

next_cursor

nullable string

obligatoire

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

prev_cursor

nullable string

obligatoire

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

refresh_cursor

nullable string

obligatoire

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.

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.

Obtenir un guide d'implémentation

const result = await bird.amb.conversations.list({
  business_account_id: "abz_01krdgeqcxet5s7t44vh8rt9mg",
  limit: 2,
});
console.log(result);

result = client.amb.conversations.list(business_account_id='abz_01krdgeqcxet5s7t44vh8rt9mg', limit=2)
print(result)

for item, err := range client.Amb.Conversations.List(ctx, bird.AmbConversationsListParams{BusinessAccountID: "abz_01krdgeqcxet5s7t44vh8rt9mg", Limit: 2}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(item)
}

foreach ($bird->amb->conversations->list(['business_account_id' => 'abz_01krdgeqcxet5s7t44vh8rt9mg', 'limit' => '2']) as $item) {
    var_dump($item);
}

bird amb conversations list

curl -X GET "https://us1.platform.bird.com/v1/amb/conversations" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "intent_id=order_status" \
  --url-query "group_id=support" \
  --url-query "queue=support" \
  --url-query "assigned_to=me" \
  --url-query "label=billing" \
  --url-query "limit=25"

Réponse200

{
  "data": [
    {
      "inbox_status": "open",
      "routing": {
        "entry_point": "support",
        "queue": "support"
      },
      "routing_change": {
        "entry_point": "billing",
        "queue": "billing",
        "message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg"
      },
      "last_message": {
        "id": "amb_01krdgeqcxet5s7t44vh8rt9mg",
        "direction": "outbound"
      },
      "id": "acv_01krdgeqcxet5s7t44vh8rt9mg",
      "business_account_id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
      "status": "open",
      "origin": "entry_point",
      "device_capabilities": [
        "QUICK",
        "LIST",
        "TIME"
      ],
      "supported_content_kinds": [
        "text"
      ],
      "locale": "en-US",
      "assigned_to": "usr_01krdgeqcxet5s7t44vh8rt9mg",
      "labels": [
        "billing",
        "vip"
      ],
      "closed_reason": "user_close"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

List conversations

Paramètres de requête

Contenu de la réponse

Ressources associées