Skip to content

Commit df4c0ef

Browse files
mdojwamdojwa
authored
feat(docs): extend list_archives with 'chat_ids' filter for v3.6, v3.7 (#1594)
1 parent 8d03af3 commit df4c0ef

File tree

5 files changed

+14
-2
lines changed

5 files changed

+14
-2
lines changed

‎src/pages/messaging/agent-chat-api/changelog/index.mdx‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,19 @@ The developer preview version provides a preview of the upcoming changes to the
1919

2020
</Warning>
2121

22-
## [v3.6] - 2025-08-07
22+
## [v3.7]
23+
24+
### Chats
25+
26+
- The **List Archives** ([Web](/messaging/agent-chat-api/v3.7/#list-archives) & [RTM](/messaging/agent-chat-api/rtm-reference/#list-archives)) method has a new filter, `chat_ids`.
27+
28+
## [v3.6]
2329

2430
### Chats
2531

2632
- The **Get Chat** ([Web](/messaging/agent-chat-api/#get-chat) & [RTM](/messaging/agent-chat-api/rtm-reference/#get-chat)) method now validates access to the requested thread.
2733
- The **List Chats** ([Web](/messaging/agent-chat-api/#list-chats) & [RTM](/messaging/agent-chat-api/rtm-reference/#list-chats)) method filter `include_active` is replaced with `active` and now allows filtering only active, only inactive or both types of chats.
28-
- The **List Archives** ([Web](/messaging/agent-chat-api/#list-archives) & [RTM](/messaging/agent-chat-api/rtm-reference/#list-archives)) method has new filters, `customer_id` and `customer_email`.
34+
- The **List Archives** ([Web](/messaging/agent-chat-api/#list-archives) & [RTM](/messaging/agent-chat-api/rtm-reference/#list-archives)) method has new filters, `customer_id`, `customer_email`, and `chat_ids`.
2935
- The [**Thread**](/messaging/agent-chat-api/data-structures/#threads) data structure has a new `customer_visit` field.
3036
- The [**agent_disconnected**](/messaging/agent-chat-api/rtm-pushes#agent_disconnected) push has a reason for disconnection, `role_permissions_changed`.
3137

‎src/pages/messaging/agent-chat-api/index.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -499,6 +499,7 @@ The list classification is based on threads; 1 chat per 1 thread. Thus, the same
499499
| `filters.query` | No | `string` | |
500500
| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` |
501501
| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` |
502+
| `filters.chat_ids` | No | `array` | Array of chat IDs. Max array size: 1000. |
502503
| `filters.thread_ids` | No | `array` | Array of thread IDs. Cannot be used with other filters or pagination; max array size: 20. |
503504
| `filters.group_ids` | No | `array` | Array of group IDs. Max array size: 200 |
504505
| `filters.properties.<namespace>.<name>.<properties_filter_type>` | No | `any` | **\* described below** |

‎src/pages/messaging/agent-chat-api/rtm-reference/index.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -556,6 +556,8 @@ The list classification is based on threads; 1 chat per 1 thread. Thus, the same
556556
| `filters.query` | No | `string` | |
557557
| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` |
558558
| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` |
559+
| `filters.chat_ids` | No | `array` | Array of chat IDs. Max array size: 1000. |
560+
| `filters.thread_ids` | No | `array` | Array of thread IDs. Cannot be used with other filters or pagination; max array size: 20. |
559561
| `filters.group_ids` | No | `array` | Array of group IDs. Max array size: 200 |
560562
| `filters.properties.<namespace>.<name>.<properties_filter_type>` | No | `any` | **\* described below** |
561563
| `filters.agents.<filter_type>` | No | `any` | **\*\* described below** `exists` see to `false` will return unassigned chats; `true` will return the assigned ones. |

‎src/pages/messaging/agent-chat-api/v3.7/index.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -499,6 +499,7 @@ The list classification is based on threads; 1 chat per 1 thread. Thus, the same
499499
| `filters.query` | No | `string` | |
500500
| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` |
501501
| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` |
502+
| `filters.chat_ids` | No | `array` | Array of chat IDs. Max array size: 1000. |
502503
| `filters.thread_ids` | No | `array` | Array of thread IDs. Cannot be used with other filters or pagination; max array size: 20. |
503504
| `filters.group_ids` | No | `array` | Array of group IDs. Max array size: 200 |
504505
| `filters.properties.<namespace>.<name>.<properties_filter_type>` | No | `any` | **\* described below** |

‎src/pages/messaging/agent-chat-api/v3.7/rtm-reference/index.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -556,6 +556,8 @@ The list classification is based on threads; 1 chat per 1 thread. Thus, the same
556556
| `filters.query` | No | `string` | |
557557
| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` |
558558
| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` |
559+
| `filters.chat_ids` | No | `array` | Array of chat IDs. Max array size: 1000. |
560+
| `filters.thread_ids` | No | `array` | Array of thread IDs. Cannot be used with other filters or pagination; max array size: 20. |
559561
| `filters.group_ids` | No | `array` | Array of group IDs. Max array size: 200 |
560562
| `filters.properties.<namespace>.<name>.<properties_filter_type>` | No | `any` | **\* described below** |
561563
| `filters.agents.<filter_type>` | No | `any` | **\*\* described below** `exists` see to `false` will return unassigned chats; `true` will return the assigned ones. |

0 commit comments

Comments
 (0)