Skip to content

Commit 8874d41

Browse files
ale-kacperczykale-kacperczyk
authored
Remove attach_to_last_thread flag from Agent Chat API (#1514)
1 parent efca792 commit 8874d41

File tree

9 files changed

+13
-19
lines changed

9 files changed

+13
-19
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ The developer preview version provides a preview of the upcoming changes to the
7575
- has new filters: `event_types` (which replaces the `events` filter), `greetings`, and `agent_response`.
7676
- has new filter modifiers: `filters.agents.require_every_value`, `filters.tags.require_every_value`, `filters.sales.require_every_value`, `filters.goals.require_every_value`, and `filters.event_types.require_every_value`.
7777
- Multiple methods no longer require the `chats--my:ro`, `chats--my:rw`, `chats.conversation--my:rw`, and `chats.conversation--my:rw` scopes.
78-
- The **Start Chat** ([Web](/messaging/agent-chat-api/v3.4/#start-chat) & [RTM](/messaging/agent-chat-api/v3.4/rtm-reference/#start-chat)) and **Resume Chat** ([Web](/messaging/agent-chat-api/v3.4/#resume-chat) & [RTM](/messaging/agent-chat-api/v3.4/rtm-reference/#resume-chat)) methods now require that authors (except the requester) of all initial events are listed in the `users` field. Both the events and users have a fixed `visibility` set to `all`.
78+
- The **Send Event** ([Web](/messaging/agent-chat-api/v3.4/#send-event) & [RTM](/messaging/agent-chat-api/v3.4/rtm-reference/#send-event)) method now requires the requester to be added as a chat user.
7979
- The **Start Chat**, **Resume Chat**, **Send Event**, **Send Typing Indicator**, and **Send Rich Message Postback** methods now require either the `chats--all:rw` or `chats--access:rw` scope instead of the `chats.conversation--all:rw` or `chats.conversation--access:rw`.
8080
- The **Deactivate Chat** ([Web](/messaging/agent-chat-api/v3.4/#deactivate-chat) & [RTM](/messaging/agent-chat-api/v3.4/rtm-reference/#deactivate-chat)) method now requires the requester to be present on the list of chat users. You can override it with a new param, `ignore_requester_presence`.
8181
- 🛠️ (2022-12-7): The **Get Chat** ([Web](/messaging/agent-chat-api/v3.4/#get-chat) & [RTM](/messaging/agent-chat-api/v3.4/rtm-reference/#get-chat)) method now validates access to the requested thread.

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1113,7 +1113,7 @@ Removes a user from chat. The following restrictions apply:
11131113

11141114
- You can't remove the `customer`.
11151115
- The requester must be present on the list of chat users.
1116-
- You can override it by setting the `ignore_requester_presence` parameter.
1116+
- You can override it by setting the `ignore_requester_presence` parameter.
11171117

11181118
#### Specifics
11191119

@@ -1211,7 +1211,7 @@ https://api.livechatinc.com/v3.5/agent/action/get_license_info \
12111211
```json
12121212
{
12131213
"license_id": "104130623",
1214-
"expires_at": "2024-12-09T12:01:18.909000Z"
1214+
"expires_at": "2024-12-09T12:01:18.909000Z",
12151215
"created_at": "2019-12-09T12:01:18.909000Z",
12161216
"in_trial": false
12171217
}
@@ -1257,7 +1257,6 @@ To call the API as a bot, use the `X-Author-Id` header set to the bot's id. [Rea
12571257
| ----------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
12581258
| `chat_id` | Yes | `string` | Id of the chat you want to send a message to. |
12591259
| `event` | Yes | `object` | [Event](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. |
1260-
| `attach_to_last_thread` | No | `bool` | The flag is ignored for active chats. Default: `false`. For inactive chats: `true` – the event will be added to the last thread; `false` – the request will fail. The only event type that can be sent to inactive chats is a system message.|
12611260

12621261
#### Response
12631262

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1318,7 +1318,6 @@ To call the API as a bot, use the `author_id` property set to the bot's id in th
13181318
| ----------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13191319
| `chat_id` | Yes | `string` | Id of the chat you want to send the message to. |
13201320
| `event` | Yes | `object` | [Event](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. |
1321-
| `attach_to_last_thread` | No | `bool` | The flag is ignored for active chats. Default: `false`. For inactive chats: `true` – the event will be added to the last thread; `false` – the request will fail. The only event type that can be sent to inactive chats is a system message. |
13221321

13231322
</Text>
13241323
<Code>

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1168,11 +1168,11 @@ To call the API as a bot, use the `X-Author-Id` header set to the bot's id.
11681168

11691169
#### Request
11701170

1171-
| Parameter | Required | Data type | Notes |
1172-
| ----------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1173-
| `chat_id` | Yes | `string` | Id of the chat you want to send a message to. |
1174-
| `event` | Yes | `object` | [Event](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. |
1175-
| `attach_to_last_thread` | No | `bool` | The flag is ignored for active chats. Default: `false`. For inactive chats: `true` – the event will be added to the last thread; `false` – the request will fail. The only event type that can be sent to inactive chats is a system message. |
1171+
| Parameter | Required | Data type | Notes |
1172+
| ----------------------- | -------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1173+
| `chat_id` | Yes | `string` | Id of the chat you want to send a message to. |
1174+
| `event` | Yes | `object` | [Event](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. |
1175+
| `attach_to_last_thread` | No | `bool` | The flag is ignored for active chats. For inactive chats: `true` – the event will be added to the last thread; `false` – the request will fail. Default: `false`. The only event type that can be sent to inactive chats is a system message. |
11761176

11771177
#### Response
11781178

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1319,11 +1319,11 @@ To call the API as a bot, use the `author_id` property set to the bot's id in th
13191319

13201320
#### Request
13211321

1322-
| Parameters | Required | Data type | Notes |
1323-
| ----------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1324-
| `chat_id` | Yes | `string` | Id of the chat you want to send the message to. |
1325-
| `event` | Yes | `object` | [Event](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. |
1326-
| `attach_to_last_thread` | No | `bool` | The flag is ignored for active chats. Default: `false`. For inactive chats: `true` – the event will be added to the last thread; `false` – the request will fail. The only event type that can be sent to inactive chats is a system message. |
1322+
| Parameters | Required | Data type | Notes |
1323+
| ----------------------- | -------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1324+
| `chat_id` | Yes | `string` | Id of the chat you want to send the message to. |
1325+
| `event` | Yes | `object` | [Event](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. |
1326+
| `attach_to_last_thread` | No | `bool` | The flag is ignored for active chats. For inactive chats: `true` – the event will be added to the last thread; `false` – the request will fail. Default: `false`. The only event type that can be sent to inactive chats is a system message. |
13271327

13281328
</Text>
13291329
<Code>

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1204,7 +1204,6 @@ To call the API as a bot, use the `X-Author-Id` header set to the bot's id. [Rea
12041204
| ----------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
12051205
| `chat_id` | Yes | `string` | Id of the chat you want to send a message to. |
12061206
| `event` | Yes | `object` | [Event](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. |
1207-
| `attach_to_last_thread` | No | `bool` | The flag is ignored for active chats. Default: `false`. For inactive chats: `true` – the event will be added to the last thread; `false` – the request will fail. The only event type that can be sent to inactive chats is a system message. |
12081207

12091208
#### Response
12101209

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1323,7 +1323,6 @@ To call the API as a bot, use the `author_id` property set to the bot's id in th
13231323
| ----------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13241324
| `chat_id` | Yes | `string` | Id of the chat you want to send the message to. |
13251325
| `event` | Yes | `object` | [Event](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. |
1326-
| `attach_to_last_thread` | No | `bool` | The flag is ignored for active chats. Default: `false`. For inactive chats: `true` – the event will be added to the last thread; `false` – the request will fail. The only event type that can be sent to inactive chats is a system message. |
13271326

13281327
</Text>
13291328
<Code>

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1221,7 +1221,6 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch
12211221
| ----------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
12221222
| `chat_id` | Yes | `string` | Id of the chat you want to send a message to. |
12231223
| `event` | Yes | `object` | [Event](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. |
1224-
| `attach_to_last_thread` | No | `bool` | The flag is ignored for active chats. Default: `false`. For inactive chats: `true` – the event will be added to the last thread; `false` – the request will fail. The only event type that can be sent to inactive chats is a system message. |
12251224

12261225
#### Response
12271226

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1354,7 +1354,6 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch
13541354
| ----------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13551355
| `chat_id` | Yes | `string` | Id of the chat you want to send the message to. |
13561356
| `event` | Yes | `object` | [Event](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. |
1357-
| `attach_to_last_thread` | No | `bool` | The flag is ignored for active chats. Default: `false`. For inactive chats: `true` – the event will be added to the last thread; `false` – the request will fail. The only event type that can be sent to inactive chats is a system message. |
13581357

13591358
</Text>
13601359
<Code>

0 commit comments

Comments
 (0)