diff --git a/payloads/messaging/v3.7/agent-chat-api/index.js b/payloads/messaging/v3.7/agent-chat-api/index.js index 09387c5b0..70cc05bbb 100644 --- a/payloads/messaging/v3.7/agent-chat-api/index.js +++ b/payloads/messaging/v3.7/agent-chat-api/index.js @@ -14,7 +14,7 @@ export { default as customer } from "./users/customer.json"; export { default as access } from "./other-structures/access.json"; export { default as chat } from "./other-structures/chat.json"; -export { default as chatSummary } from "./other-structures/chatSummary.json"; +export { default as chatInfo } from "./other-structures/chatInfo.json"; export { default as formFields } from "./other-structures/formFields.json"; export { default as filledFormFields } from "./other-structures/filledFormFields.json"; export { default as properties } from "./other-structures/properties.json"; diff --git a/payloads/messaging/v3.7/agent-chat-api/other-structures/chatSummary.json b/payloads/messaging/v3.7/agent-chat-api/other-structures/chatInfo.json similarity index 99% rename from payloads/messaging/v3.7/agent-chat-api/other-structures/chatSummary.json rename to payloads/messaging/v3.7/agent-chat-api/other-structures/chatInfo.json index ad252c71e..d0785facc 100644 --- a/payloads/messaging/v3.7/agent-chat-api/other-structures/chatSummary.json +++ b/payloads/messaging/v3.7/agent-chat-api/other-structures/chatInfo.json @@ -1,6 +1,6 @@ { "id": "PJ0MRSHTDG", - "last_thread_summary": { + "last_thread_info": { "id": "QA37PVJ75B", "created_at": "2020-05-12T11:42:47.383000Z", "user_ids": [ diff --git a/payloads/messaging/v3.7/customer-chat-api/index.js b/payloads/messaging/v3.7/customer-chat-api/index.js index 11bf5ed4f..c7f65502f 100644 --- a/payloads/messaging/v3.7/customer-chat-api/index.js +++ b/payloads/messaging/v3.7/customer-chat-api/index.js @@ -11,7 +11,7 @@ export { default as customer } from "./users/customer.json" export { default as access } from "./other-structures/access.json" export { default as chat } from "./other-structures/chat.json" -export { default as chatSummary } from "./other-structures/chatSummary.json" +export { default as chatInfo } from "./other-structures/chatInfo.json" export { default as form } from "./other-structures/form.json" export { default as formFields } from "./other-structures/formFields.json" export { default as filledFormFields } from "./other-structures/filledFormFields.json" diff --git a/payloads/messaging/v3.7/customer-chat-api/other-structures/chatSummary.json b/payloads/messaging/v3.7/customer-chat-api/other-structures/chatInfo.json similarity index 99% rename from payloads/messaging/v3.7/customer-chat-api/other-structures/chatSummary.json rename to payloads/messaging/v3.7/customer-chat-api/other-structures/chatInfo.json index e4c1d272d..2a118e2d5 100644 --- a/payloads/messaging/v3.7/customer-chat-api/other-structures/chatSummary.json +++ b/payloads/messaging/v3.7/customer-chat-api/other-structures/chatInfo.json @@ -64,4 +64,4 @@ ] }, "active": false -} \ No newline at end of file +} diff --git a/src/pages/messaging/agent-chat-api/changelog/index.mdx b/src/pages/messaging/agent-chat-api/changelog/index.mdx index 311de7159..d8d8f2df4 100644 --- a/src/pages/messaging/agent-chat-api/changelog/index.mdx +++ b/src/pages/messaging/agent-chat-api/changelog/index.mdx @@ -31,6 +31,9 @@ The developer preview version provides a preview of the upcoming changes to the ### Chats - 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`. +- The **List Chats** ([Web](/messaging/agent-chat-api/v3.7/#list-chats) & [RTM](/messaging/agent-chat-api/v3.7/rtm-reference/#list-chats)) method's response body field `chats_summary` was renamed to `chats_info`. +- The **Login** ([RTM](/messaging/agent-chat-api/v3.7/rtm-reference/#login)) method's response body field `chats_summary` was renamed to `chats_info`. +- The **Chat summary** data structure is renamed to [**Chat info**](/messaging/agent-chat-api/v3.7/data-structures#chat-info) and its field `last_thread_summary` is renamed to `last_thread_info`. ## [v3.6] - 2025-08-07 diff --git a/src/pages/messaging/agent-chat-api/v3.7/data-structures/index.mdx b/src/pages/messaging/agent-chat-api/v3.7/data-structures/index.mdx index 51e9c87be..172123ddc 100644 --- a/src/pages/messaging/agent-chat-api/v3.7/data-structures/index.mdx +++ b/src/pages/messaging/agent-chat-api/v3.7/data-structures/index.mdx @@ -423,7 +423,7 @@ Apart from [Events](#events) and [Users](#users), there are also other common da - [Access](#access) - [Chats](#chats) -- [Chat summaries](#chat-summaries) +- [Chat info](#chat-info) - [Form fields](#form-fields) - [Filled form fields](#filled-form-fields) - [Properties](#properties) @@ -447,11 +447,11 @@ Apart from [Events](#events) and [Users](#users), there are also other common da | `properties` | optional | | | `access` | optional | | -## Chat summaries +## Chat info -**Chat summary** is similar to the **Chat** data structure. The difference is that **Chat** contains a `thread` object, while **Chat summary** includes `last_thread_summary` and `last_event_per_type`. +**Chat info** is similar to the **Chat** data structure. The difference is that **Chat** contains a `thread` object, while **Chat info** includes `last_thread_info` and `last_event_per_type`. - + ## Form fields diff --git a/src/pages/messaging/agent-chat-api/v3.7/index.mdx b/src/pages/messaging/agent-chat-api/v3.7/index.mdx index 37757a342..9d9980b88 100644 --- a/src/pages/messaging/agent-chat-api/v3.7/index.mdx +++ b/src/pages/messaging/agent-chat-api/v3.7/index.mdx @@ -121,7 +121,7 @@ curl -X POST \ ### List Chats -It returns [summaries](/messaging/agent-chat-api/v3.7/data-structures/#chat-summaries) of the chats an agent has access to. +It returns the [info](/messaging/agent-chat-api/v3.7/data-structures/#chat-info) about the chats an agent has access to. #### Specifics @@ -140,7 +140,7 @@ It returns [summaries](/messaging/agent-chat-api/v3.7/data-structures/#chat-summ | ----------------------------------------------------- | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `filters` | No | `object` | When paginating, `filters` provided in the first request are remembered and automatically used for the subsequent requests. Providing a new `filters` object will result in a `validation` error. To reset the filters, start paginating with a new set of filters. | | `filters.active` | No | `bool` | Possible values: `true` - active chats only, `false` - inactive chats only, `null` or not provided - both active and inactive chats. | -| `filters.include_chats_without_threads` | No | `bool` | Defines if the returned chat summary includes chats without any threads; default: `true`. | +| `filters.include_chats_without_threads` | No | `bool` | Defines if the returned chat info includes chats without any threads; default: `true`. | | `filters.group_ids` | No | `array` | Array of group IDs. Max array size: 200 | | `filters.properties...` | No | `any` | | | `sort_order` | No | `string` | Possible values: `asc` - oldest chats first, `desc` - newest chats first (default) | @@ -159,7 +159,7 @@ There's only one value allowed for a single property. | Field | Data type | Notes | | ------------------ | --------- | ------------------------------------------------------------------------------------------------------------ | -| `chats_summary` | `array` | An array of [Chat summary](/messaging/agent-chat-api/v3.7/data-structures/#chat-summaries) data structures | +| `chats_info` | `array` | An array of [Chat info](/messaging/agent-chat-api/v3.7/data-structures/#chat-info) data structures. | | `next_page_id` | `string` | In relation to `page_id` specified in the request. Appears in the response only when there's a next page. | | `previous_page_id` | `string` | In relation to `page_id` specified in the request Appears in the response only when there's a previous page. | | `found_chats` | `number` | An estimated number. The real number of found chats can slightly differ. | @@ -182,7 +182,7 @@ curl -X POST \ ```json { "next_page_id": "MTUxNzM5ODEzMTQ5Ng==", // optional - "chats_summary": [{ + "chats_info": [{ "id": "PJ0MRSHTDG", "last_event_per_type": { "message": { @@ -210,7 +210,7 @@ curl -X POST \ }, { // "Agent" user object }], - "last_thread_summary": { + "last_thread_info": { "id": "K600PKZON8", "created_at": "2020-05-07T07:11:28.288340Z", "user_ids": [ @@ -486,7 +486,7 @@ curl -X POST \ It returns a list of the chats an agent has access to. Together with a **chat**, the **events** of **one thread** from this chat are returned. -The list classification is based on threads; 1 chat per 1 thread. Thus, the same **chat** object may appear on the list several times, but each time with a different **thread**. The returned **chat** is a complete object, not only a **chat summary**. +The list classification is based on threads; 1 chat per 1 thread. Thus, the same **chat** object may appear on the list several times, but each time with a different **thread**. The returned **chat** is a complete object, not only a **chat info**. #### Specifics diff --git a/src/pages/messaging/agent-chat-api/v3.7/rtm-reference/index.mdx b/src/pages/messaging/agent-chat-api/v3.7/rtm-reference/index.mdx index 56e3d8b6c..32e8203b8 100644 --- a/src/pages/messaging/agent-chat-api/v3.7/rtm-reference/index.mdx +++ b/src/pages/messaging/agent-chat-api/v3.7/rtm-reference/index.mdx @@ -161,7 +161,7 @@ When connecting to the Agent Chat RTM API, clients have to send over the require ### List Chats -It returns [summaries](/messaging/agent-chat-api/v3.7/data-structures/#chat-summaries) of the chats an agent has access to. +It returns [info](/messaging/agent-chat-api/v3.7/data-structures/#chat-info) of the chats an agent has access to. #### Specifics @@ -182,7 +182,7 @@ It returns [summaries](/messaging/agent-chat-api/v3.7/data-structures/#chat-summ | ----------------------------------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `filters` | No | `object` | When paginating, `filters` provided in the first request are remembered and automatically used for the subsequent requests. Providing a new `filters` object will result in a `validation` error. To reset the filters, start paginating with a new set of filters. | | `filters.active` | No | `bool` | Possible values: `true` - active chats only, `false` - inactive chats only, `null` or not provided - both active and inactive chats. | -| `filters.include_chats_without_threads` | No | `bool` | Defines if the returned chat summary includes chats without any threads; default: `true`. | +| `filters.include_chats_without_threads` | No | `bool` | Defines if the returned chat info includes chats without any threads; default: `true`. | | `filters.group_ids` | No | `array` | Array of group IDs. Max array size: 200 | | `filters.properties...` | No | `any` | | | `sort_order` | No | `string` | Possible values: `asc` - oldest chats first, `desc` - newest chats first (default) | @@ -201,7 +201,7 @@ There's only one value allowed for a single property. | Field | Data type | Notes | | ------------------ | --------- | ------------------------------------------------------------------------------------------------------------ | -| `chats_summary` | `array` | An array of [Chat summary](/messaging/agent-chat-api/v3.7/data-structures/#chat-summaries) data structures | +| `chats_info` | `array` | An array of [Chat info](/messaging/agent-chat-api/v3.7/data-structures/#chat-info) data structures. | | `next_page_id` | `string` | In relation to `page_id` specified in the request. Appears in the response only when there's a next page. | | `previous_page_id` | `string` | In relation to `page_id` specified in the request Appears in the response only when there's a previous page. | | `found_chats` | `number` | An estimated number. The real number of found chats can slightly differ. | @@ -229,7 +229,7 @@ There's only one value allowed for a single property. "success": true, "payload": { "next_page_id": "MTUxNzM5ODEzMTQ5Ng==", // optional - "chats_summary": [{ + "chats_info": [{ "id": "PJ0MRSHTDG", "last_event_per_type": { "message": { @@ -257,7 +257,7 @@ There's only one value allowed for a single property. }, { // "Agent" user object }], - "last_thread_summary": { + "last_thread_info": { "id": "K600PKZON8", "created_at": "2020-05-07T07:11:28.288340Z", "user_ids": [ @@ -543,7 +543,7 @@ It returns a thread that the current agent has access to in a given chat. It returns a list of the chats an agent has access to. Together with a **chat**, the **events** of **one thread** from this chat are returned. -The list classification is based on threads; 1 chat per 1 thread. Thus, the same **chat** object may appear on the list several times, but each time with a different **thread**. The returned **chat** is a complete object, not only a **chat summary**. +The list classification is based on threads; 1 chat per 1 thread. Thus, the same **chat** object may appear on the list several times, but each time with a different **thread**. The returned **chat** is a complete object, not only the **chat info**. #### Specifics @@ -2650,7 +2650,7 @@ __**__ These values mean: "my_profile": { // "User > My profile" object }, - "chats_summary": [{ + "chats_info": [{ "id": "PJ0MRSHTDG", "users": [ // array of "User" objects @@ -2677,7 +2677,7 @@ __**__ These values mean: } // ... }, - "last_thread_summary": { + "last_thread_info": { "id": "K600PKZON8", "user_ids": ["smith@example.com"], "properties": { diff --git a/src/pages/messaging/customer-chat-api/changelog/index.mdx b/src/pages/messaging/customer-chat-api/changelog/index.mdx index 4b3f82b8f..d2038aa9e 100644 --- a/src/pages/messaging/customer-chat-api/changelog/index.mdx +++ b/src/pages/messaging/customer-chat-api/changelog/index.mdx @@ -19,6 +19,12 @@ The developer preview version provides a preview of the upcoming changes to the +## [v3.7] - Developer preview + +### Chats + +- The **List Chats** ([Web](/messaging/customer-chat-api/v3.7/#list-chats) & [RTM](/messaging/customer-chat-api/v3.7/rtm-reference/#list-chats)) method's response body field `chats_summary` was renamed to `chats_info`. + ## [v3.6] - 2025-08-07 ### Config diff --git a/src/pages/messaging/customer-chat-api/v3.7/data-structures/index.mdx b/src/pages/messaging/customer-chat-api/v3.7/data-structures/index.mdx index 2862dd4f5..22bcf9f37 100644 --- a/src/pages/messaging/customer-chat-api/v3.7/data-structures/index.mdx +++ b/src/pages/messaging/customer-chat-api/v3.7/data-structures/index.mdx @@ -394,7 +394,7 @@ Apart from [Events](#events) and [Users](#users), there are also other common da - [Access](#access) - [Chats](#chats) -- [Chat summaries](#chat-summaries) +- [Chat info](#chat-info) - [Forms](#forms) - [Form fields](#form-fields) - [Filled form fields](#filled-form-fields) @@ -418,11 +418,11 @@ Apart from [Events](#events) and [Users](#users), there are also other common da | `properties` | optional | | | `access` | optional | | -## Chat summaries +## Chat info -**Chat summary** is similar to the **Chat** data structure. The difference is that **Chat** contains a `thread` object, while **Chat summary** includes `last_event_per_type`. +**Chat info** is similar to the **Chat** data structure. The difference is that **Chat** contains a `thread` object, while **Chat info** includes `last_event_per_type`. - + ## Forms diff --git a/src/pages/messaging/customer-chat-api/v3.7/index.mdx b/src/pages/messaging/customer-chat-api/v3.7/index.mdx index 589415198..a029ee616 100644 --- a/src/pages/messaging/customer-chat-api/v3.7/index.mdx +++ b/src/pages/messaging/customer-chat-api/v3.7/index.mdx @@ -116,7 +116,7 @@ curl -X POST \ ### List Chats -It returns [summaries](/messaging/customer-chat-api/v3.7/data-structures/#chat-summaries) of the chats a customer participated in. +It returns [info](/messaging/customer-chat-api/v3.7/data-structures/#chat-info) about the chats a customer participated in. #### Specifics @@ -128,11 +128,11 @@ It returns [summaries](/messaging/customer-chat-api/v3.7/data-structures/#chat-s #### Request -| Parameter | Required | Type | Notes | -| ------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------ | -| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, maximum: 25. | -| `sort_order` | No | `string` | Possible values: `asc`, `desc` (default). Chat summaries are sorted by the creation date of its last thread. | -| `page_id` | No | `string` | | +| Parameter | Required | Type | Notes | +| ------------ | -------- | -------- | -------------------------------------------------------------------------------------------------------------------- | +| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, maximum: 25. | +| `sort_order` | No | `string` | Possible values: `asc`, `desc` (default). The chat info entries are sorted by the creation date of their last thread.| +| `page_id` | No | `string` | | #### Response @@ -141,7 +141,7 @@ It returns [summaries](/messaging/customer-chat-api/v3.7/data-structures/#chat-s | `total_chats` | `number` | An estimated number. The real number of found chats can slightly differ. | | `next_page_id` | `string` | In relation to `page_id` specified in the request. Appears in the response only when there's the next page. | | `previous_page_id` | `string` | In relation to `page_id` specified in the request. Appears in the response only when there's the previous page. | -| `chats_summary` | `array` | Array of [Chat summary](/messaging/customer-chat-api/v3.7/data-structures/#chat-summaries) data structures. | +| `chats_info` | `array` | Array of [Chat info](/messaging/customer-chat-api/v3.7/data-structures/#chat-info) data structures. | @@ -164,7 +164,7 @@ curl -X POST \ ```json { "next_page_id": "MTUxNzM5ODEzMTQ5Ng==", - "chats_summary": [{ + "chats_info": [{ "id": "PJ0MRSHTDG", "last_thread_id": "K600PKZON8", "last_thread_created_at": "2020-05-08T08:22:21.128420Z", diff --git a/src/pages/messaging/customer-chat-api/v3.7/rtm-reference/index.mdx b/src/pages/messaging/customer-chat-api/v3.7/rtm-reference/index.mdx index 6af74a520..04aba63c1 100644 --- a/src/pages/messaging/customer-chat-api/v3.7/rtm-reference/index.mdx +++ b/src/pages/messaging/customer-chat-api/v3.7/rtm-reference/index.mdx @@ -154,7 +154,7 @@ When connecting to the Customer Chat RTM API, clients have to send over the requ ### List Chats -It returns [summaries](/messaging/customer-chat-api/v3.7/data-structures/#chat-summaries) of the chats a customer participated in. +It returns [info](/messaging/customer-chat-api/v3.7/data-structures/#chat-info) about the chats a customer participated in. #### Specifics @@ -166,11 +166,11 @@ It returns [summaries](/messaging/customer-chat-api/v3.7/data-structures/#chat-s #### Request -| Parameter | Required | Type | Notes | -| ------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------ | -| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, maximum: 25. | -| `sort_order` | No | `string` | Possible values: `asc`, `desc` (default). Chat summaries are sorted by the creation date of its last thread. | -| `page_id` | No | `string` | | +| Parameter | Required | Type | Notes | +| ------------ | -------- | -------- | --------------------------------------------------------------------------------------------------------------------- | +| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, maximum: 25. | +| `sort_order` | No | `string` | Possible values: `asc`, `desc` (default). The chat info entries are sorted by the creation date of their last thread. | +| `page_id` | No | `string` | | #### Response @@ -179,7 +179,7 @@ It returns [summaries](/messaging/customer-chat-api/v3.7/data-structures/#chat-s | `total_chats` | `number` | An estimated number. The real number of found chats can slightly differ. | | `next_page_id` | `string` | In relation to `page_id` specified in the request. Appears in the response only when there's the next page. | | `previous_page_id` | `string` | In relation to `page_id` specified in the request. Appears in the response only when there's the previous page. | -| `chats_summary` | `array` | Array of [Chat summary](/messaging/customer-chat-api/v3.7/data-structures/#chat-summaries) data structures. | +| `chats_info` | `array` | Array of [Chat info](/messaging/customer-chat-api/v3.7/data-structures/#chat-info) data structures. | @@ -206,7 +206,7 @@ It returns [summaries](/messaging/customer-chat-api/v3.7/data-structures/#chat-s "success": true, "payload": { "next_page_id": "MTUxNzM5ODEzMTQ5Ng==", - "chats_summary": [{ + "chats_info": [{ "id": "PJ0MRSHTDG", "last_thread_id": "K600PKZON8", "last_thread_created_at": "2020-05-08T08:22:21.128420Z",