Parameters
| Name | Type | Required | Description |
|---|---|---|---|
brandId | string | Yes | Ocoya brand id from ocoya_list_brands. |
status | string | No | OPEN waiting for the team, RESOLVED done, SPAM junk. One of OPEN, RESOLVED, SPAM. |
type | string | No | DM (email threads too), COMMENT, MENTION or REVIEW. One of DM, MENTION, COMMENT, REVIEW. |
channelIds | string[] | No | Only these channels, from ocoya_list_channels. |
labelIds | string[] | No | Only conversations with any of these labels, from ocoya_list_inbox_labels. |
assigneeId | string | No | Only those assigned to this teammate (from ocoya_list_inbox_teammates), or unassigned. |
archived | boolean | No | true lists the archived conversations instead. |
query | string | No | The customer’s name, or anything written in the conversation. |
page | number | No | Zero-based page number. Defaults to 0. |
perPage | number | No | Conversations per page, up to 100. Defaults to 25. |
Request example
{
"name": "ocoya_list_conversations",
"arguments": {
"brandId": "cmayvq3hk00017apshay5qezu",
"channelIds": ["clh49poxf008x8kov4ncbjty9"],
"query": "launch"
}
}Returns
Returns total, page, perPage and data. This tool only reads: it changes nothing in Ocoya.