Sign inGet Started
Commencer
Guides
Référence API
SDK
CLI
Base de connaissances
Changelog

Get a conversation

GET
/v1/amb/conversations/{conversation_id}
const result = await bird.amb.conversations.get(
  "acv_01krdgeqcxet5s7t44vh8rt9mg",
);
console.log(result);
Réponse200
{
  "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"
}

Returns one conversation, including closed conversations. Conversation records have no age limit.

Paramètres

conversation_idstring

Conversation identifier. Starts with acv_.

Contenu de la réponse

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

recipient
object
obligatoire

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

Afficher les attributs enfants
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
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
last_message
nullable object
obligatoire

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

Afficher les attributs enfants
id
string
obligatoire

Conversation ID.

business_account_id
string
obligatoire

Business this conversation belongs to.

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

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

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.

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.

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.

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.

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.

labels
array of string
obligatoire

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

closed_at
nullable string
obligatoire

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

closed_reason
nullable string
obligatoire

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

created_at
string
obligatoire

When this conversation was created.

updated_at
string
obligatoire

When this conversation last changed.

Ressources associées

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

Obtenir un guide d'implémentation