List conversations
/v1/amb/conversationsconst 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 listcurl -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"{
"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_statusstringFilter by workspace inbox status. Omit to include open and resolved conversations.
Possible values: open, resolved
business_account_idstringFilter to conversations belonging to this business.
statusstringFilter to conversations with this status. Omit to return both open and closed conversations.
Possible values: open, closed
intent_idstringFilter 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_idstringFilter 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.
queuestringFilter to conversations in this queue. Pass an empty string to match unrouted conversations, the ones no routing rule has claimed.
assigned_tostringReturn 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.
labelarrayReturn conversations carrying this label. Repeat the parameter to require every supplied label.
limitintegerMaximum number of items to return per page.
starting_afterstringCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_beforestringCursor 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
dataPage of conversations, newest first by last message.
next_cursorCursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.
prev_cursorCursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.
refresh_cursorRefresh 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.
Ressources associées
Poursuivez avec la documentation, les guides et les exemples sur ce sujet.