Skip to content

Commit 201567c

Browse files
gluszczykgluszczyk
authored
feat(docs): add thinking_indicator (#1576)
1 parent f0696d8 commit 201567c

File tree

6 files changed

+169
-4
lines changed

6 files changed

+169
-4
lines changed

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,11 @@ The developer preview version provides a preview of the upcoming changes to the
6060

6161
- Authorizing bots via `X-Author-Id` is removed. Bots can be authorized only via the new Bot Authorization Tokens (see [**Issue Bot Token](/management/configuration-api/v3.6/#issue-bot-token)).
6262

63+
### Other
64+
65+
- There's a new method, **Send Thinking Indicator** ([Web](/messaging/agent-chat-api/v3.6/#send-thinking-indicator) & [RTM](/messaging/agent-chat-api/v3.6/rtm-reference/#send-thinking-indicator)).
66+
- There's a new push, [**incoming_thinking_indicator**](/messaging/agent-chat-api/v3.6/rtm-pushes/#incoming_thinking_indicator).
67+
6368
## [v3.5] - 2022-11-23
6469

6570
### Chats

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

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ curl -X POST \
112112
| **Thread tags** | [`tag_thread`](#tag-thread) [`untag_thread`](#untag-thread) |
113113
| **Customers** | [`get_customer`](#get-customer) [`create_customer`](#create-customer) [`update_customer`](#update-customer) [`ban_customer`](#ban-customer) [`follow_customer`](#follow-customer) [`unfollow_customer`](#unfollow-customer) |
114114
| **Status** | [`set_routing_status`](#set-routing-status) [`list_routing_statuses`](#list-routing-statuses) |
115-
| **Other** | [`mark_events_as_seen`](#mark-events-as-seen) [`send_typing_indicator`](#send-typing-indicator) [`multicast`](#multicast) [`list_agents_for_transfer`](#list-agents-for-transfer) |
115+
| **Other** | [`mark_events_as_seen`](#mark-events-as-seen) [`send_thinking_indicator`](#send-thinking-indicator) [`send_typing_indicator`](#send-typing-indicator) [`multicast`](#multicast) [`list_agents_for_transfer`](#list-agents-for-transfer) |
116116

117117
## Chats
118118

@@ -2357,6 +2357,60 @@ https://api.livechatinc.com/v3.6/agent/action/mark_events_as_seen \
23572357
<Section>
23582358
<Text>
23592359

2360+
### Send Thinking Indicator
2361+
2362+
#### Specifics
2363+
2364+
| | |
2365+
| ---------------------- | -------------------------------------------------------------------------------------------------- |
2366+
| **Method URL** | `https://api.livechatinc.com/v3.6/agent/action/send_thinking_indicator` |
2367+
| **Required scopes** | `chats--all:rw` **\*** or `chats--access:rw` **\*\*** |
2368+
| **RTM API equivalent** | [`send_thinking_indicator`](/messaging/agent-chat-api/v3.6/rtm-reference/#send-thinking-indicator) |
2369+
| **Webhook** | - |
2370+
2371+
**\*)** `chats--all:rw` - to send the thinking indicator to a chat taking place in any group.
2372+
2373+
**\*\*)** `chats--access:rw` - to send the thinking indicator to a chat taking place in groups that the requester (related to the token) is a member of (the agent groups and the chat groups must intersect - at least one group must be common).
2374+
2375+
#### Request
2376+
2377+
| Parameter | Required | Data type | Notes |
2378+
| ------------- | -------- | --------- | ------------------------------------------------------ |
2379+
| `chat_id` | Yes | `string` | Id of the chat that to send the thinking indicator to. |
2380+
| `title` | No | `string` | |
2381+
| `description` | No | `string` | |
2382+
| `visibility` | No | `string` | Default: `all`; `agents` |
2383+
| `custom_id` | No | `string` | |
2384+
2385+
#### Response
2386+
2387+
No response payload (`200 OK`).
2388+
2389+
</Text>
2390+
<Code>
2391+
<CodeSample path={'REQUEST'}>
2392+
2393+
```shell
2394+
curl -X POST \
2395+
https://api.livechatinc.com/v3.6/agent/action/send_thinking_indicator \
2396+
-H 'Authorization: Bearer <your_access_token>' \
2397+
-H 'Content-Type: application/json' \
2398+
-d '{
2399+
"chat_id": "PJ0MRSHTDG",
2400+
"title": "Thinking...",
2401+
"description": "Fetching data from the Billing API...",
2402+
"visibility": "all",
2403+
"custom_id": "31-0C-1C-07-DB-16"
2404+
}'
2405+
```
2406+
2407+
</CodeSample>
2408+
</Code>
2409+
</Section>
2410+
2411+
<Section>
2412+
<Text>
2413+
23602414
### Send Typing Indicator
23612415

23622416
#### Specifics

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

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Here's what you need to know about **pushes**:
3838
| **Customers** | [`incoming_customers`](#incoming_customers) [`incoming_customer`](#incoming_customer) [`customer_updated`](#customer_updated) [`customer_page_updated`](#customer_page_updated) [`customer_banned`](#customer_banned) [`customer_transferred`](#customer_transferred) [`customer_left`](#customer_left) [`subscribed_customers_totals_updated`](#subscribed_customers_totals_updated) [`ticket_created`](#ticket_created) [`ticket_deleted`](#ticket_deleted) |
3939
| **Status** | [`routing_status_set`](#routing_status_set) [`agent_disconnected`](#agent_disconnected) |
4040
| **Configuration** | [`agent_created`](#agent_created) [`agent_approved`](#agent_approved) [`agent_updated`](#agent_updated) [`agent_suspended`](#agent_suspended) [`agent_unsuspended`](#agent_unsuspended) [`agent_deleted`](#agent_deleted) [`auto_accesses_updated`](#auto_accesses_updated) [`bot_created`](#bot_created) [`bot_updated`](#bot_updated) [`bot_deleted`](#bot_deleted) [`group_created`](#group_created) [`group_updated`](#group_updated) [`group_deleted`](#group_deleted) [`tag_created`](#tag_created) [`tag_deleted`](#tag_deleted) [`tag_updated`](#tag_updated) [`groups_status_updated`](#groups_status_updated) [`license_properties_updated`](#license_properties_updated) [`group_properties_updated`](#group_properties_updated) |
41-
| **Other** | [`events_marked_as_seen`](#events_marked_as_seen) [`incoming_sneak_peek`](#incoming_sneak_peek) [`incoming_typing_indicator`](#incoming_typing_indicator) [`incoming_multicast`](#incoming_multicast) [`chat_unfollowed`](#chat_unfollowed) [`queue_positions_updated`](#queue_positions_updated) [`customer_unfollowed`](#customer-unfollowed) |
41+
| **Other** | [`events_marked_as_seen`](#events_marked_as_seen) [`incoming_sneak_peek`](#incoming_sneak_peek) [`incoming_thinking_indicator`](#incoming_thinking_indicator) [`incoming_typing_indicator`](#incoming_typing_indicator) [`incoming_multicast`](#incoming_multicast) [`chat_unfollowed`](#chat_unfollowed) [`queue_positions_updated`](#queue_positions_updated) [`customer_unfollowed`](#customer-unfollowed) |
4242

4343
</Text>
4444

@@ -1257,6 +1257,26 @@ Informs about those group properties that were updated.
12571257

12581258
## Other
12591259

1260+
### `incoming_thinking_indicator`
1261+
1262+
Informs that one of the chat users (an Agent or a Bot Agent) is currently preparing a response. The message hasn't been sent yet.
1263+
1264+
<CodeResponse title={'Sample push payload'}>
1265+
1266+
```json
1267+
{
1268+
"chat_id": "PJ0MRSHTDG",
1269+
"thread_id": "K600PKZON8",
1270+
"author_id": "[email protected]",
1271+
"sent_at": "2025-07-16T12:34:56.909000Z",
1272+
"title": "Thinking...",
1273+
"description": "Fetching data from the Billing API...",
1274+
"custom_id": "31-0C-1C-07-DB-16"
1275+
}
1276+
```
1277+
1278+
</CodeResponse>
1279+
12601280
### `incoming_typing_indicator`
12611281

12621282
Informs that one of the chat users (an Agent or a Bot Agent) is currently typing a message. The message hasn't been sent yet. The push payload contains the typing indicator object.

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

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ When connecting to the Agent Chat RTM API, clients have to send over the require
118118
| **Thread tags** | [`tag_thread`](#tag-thread) [`untag_thread`](#untag-thread) |
119119
| **Customers** | [`get_customer`](#get-customer) [`create_customer`](#create-customer) [`update_customer`](#update-customer) [`ban_customer`](#ban-customer) [`follow_customer`](#follow-customer) [`unfollow_customer`](#unfollow-customer) [`subscribe_customers`](#subscribe_customers) [`unsubscribe_customers`](#unsubscribe_customers) |
120120
| **Status** | [`login`](#login) [`set_routing_status`](#set-routing-status) [`set_away_status`](#set-away-status) [`logout`](#logout) [`list_routing_statuses`](#list-routing-statuses) [`update_session`](#update-session) |
121-
| **Other** | [`mark_events_as_seen`](#mark-events-as-seen) [`send_typing_indicator`](#send-typing-indicator) [`multicast`](#multicast) [`list_agents_for_transfer`](#list-agents-for-transfer) |
121+
| **Other** | [`mark_events_as_seen`](#mark-events-as-seen) [`send_thinking_indicator`](#send-thinking-indicator) [`send_typing_indicator`](#send-typing-indicator) [`multicast`](#multicast) [`list_agents_for_transfer`](#list-agents-for-transfer) |
122122

123123
</Text>
124124
<Code>
@@ -3048,6 +3048,71 @@ Replaces the token used in the login request with a new one. This allows the web
30483048
<Section>
30493049
<Text>
30503050

3051+
### Send Thinking Indicator
3052+
3053+
#### Specifics
3054+
3055+
| | |
3056+
| ---------------------- | ------------------------------------------------------------------------------------------------------- |
3057+
| **Action** | `send_thinking_indicator` |
3058+
| **Required scopes** | `chats--all:rw` **\*** or `chats--access:rw` **\*\*** |
3059+
| **Web API equivalent** | [`send_thinking_indicator`](/messaging/agent-chat-api/v3.6/#send-thinking-indicator) |
3060+
| **Push message** | [`incoming_thinking_indicator`](/messaging/agent-chat-api/v3.6/rtm-pushes/#incoming_thinking_indicator) |
3061+
3062+
**\*)** `chats--all:rw` - to send the thinking indicator to a chat taking place in any group.
3063+
3064+
**\*\*)** `chats--access:rw` - to send the thinking indicator to a chat taking place in groups that the requester (related to the token) is a member of (the agent groups and the chat groups must intersect - at least one group must be common).
3065+
3066+
#### Request
3067+
3068+
| Parameter | Required | Data type | Notes |
3069+
| ------------- | -------- | --------- | ---------------------------------------------------------- |
3070+
| `chat_id` | Yes | `string` | Id of the chat you want to send the thinking indicator to. |
3071+
| `title` | No | `string` | |
3072+
| `description` | No | `string` | |
3073+
| `visibility` | No | `string` | Default: `all`; `agents` |
3074+
| `custom_id` | No | `string` | |
3075+
3076+
</Text>
3077+
<Code>
3078+
<CodeSample path={'REQUEST'}>
3079+
3080+
```json
3081+
{
3082+
"action": "send_thinking_indicator",
3083+
"payload": {
3084+
"chat_id": "PJ0MRSHTDG",
3085+
"title": "Thinking...",
3086+
"description": "Fetching data from the Billing API...",
3087+
"visibility": "all",
3088+
"custom_id": "31-0C-1C-07-DB-16"
3089+
}
3090+
}
3091+
```
3092+
3093+
</CodeSample>
3094+
3095+
<CodeResponse>
3096+
3097+
```json
3098+
{
3099+
"request_id": "<request_id>", // optional
3100+
"action": "send_thinking_indicator",
3101+
"type": "response",
3102+
"success": true,
3103+
"payload": {
3104+
// no response payload
3105+
}
3106+
}
3107+
```
3108+
3109+
</CodeResponse>
3110+
</Code>
3111+
</Section>
3112+
3113+
<Section>
3114+
<Text>
3115+
30513116
### Send Typing Indicator
30523117

30533118
#### Specifics

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ The developer preview version provides a preview of the upcoming changes to the
3939
### Other
4040

4141
- There's a new method, [**Send Greeting Postback**](/messaging/customer-chat-api/v3.6/#send-greeting-postback).
42+
- There's a new push, [**incoming_thinking_indicator**](/messaging/customer-chat-api/v3.6/rtm-pushes/#incoming_thinking_indicator).
4243

4344
## [v3.5] - 2022-11-23
4445

‎src/pages/messaging/customer-chat-api/v3.6/rtm-pushes/index.mdx‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Here's what you need to know about **pushes**:
3636
| **Properties** | [`chat_properties_updated`](#chat_properties_updated) [`chat_properties_deleted`](#chat_properties_deleted) [`thread_properties_updated`](#thread_properties_updated) [`thread_properties_deleted`](#thread_properties_deleted) [`event_properties_updated`](#event_properties_updated) [`event_properties_deleted`](#event_properties_deleted) |
3737
| **Customers** | [`customer_updated`](#customer_updated) [`customer_side_storage_updated`](#customer_side_storage_updated) |
3838
| **Status** | [`customer_disconnected`](#customer_disconnected) [`groups_status_updated`](#groups_status_updated) |
39-
| **Other** | [`incoming_typing_indicator`](#incoming_typing_indicator) [`incoming_multicast`](#incoming_multicast) [`events_marked_as_seen`](#events_marked_as_seen) [`incoming_greeting`](#incoming_greeting) [`greeting_accepted`](#greeting_accepted) [`greeting_canceled`](#greeting_canceled) [`queue_position_updated`](#queue_position_updated) |
39+
| **Other** | [`incoming_thinking_indicator`](#incoming_thinking_indicator) [`incoming_typing_indicator`](#incoming_typing_indicator) [`incoming_multicast`](#incoming_multicast) [`events_marked_as_seen`](#events_marked_as_seen) [`incoming_greeting`](#incoming_greeting) [`greeting_accepted`](#greeting_accepted) [`greeting_canceled`](#greeting_canceled) [`queue_position_updated`](#queue_position_updated) |
4040

4141
</Text>
4242

@@ -566,6 +566,26 @@ Possible statuses: `online`, `online_for_queue`, `offline`.
566566

567567
## Other
568568

569+
### `incoming_thinking_indicator`
570+
571+
Informs that one of the chat users (an Agent or a Bot Agent) is currently preparing a response. The message hasn't been sent yet.
572+
573+
<CodeResponse title={'Sample push payload'}>
574+
575+
```json
576+
{
577+
"chat_id": "PJ0MRSHTDG",
578+
"thread_id": "K600PKZON8",
579+
"author_id": "d17cd570-11a9-45c0-45c0-1b020b7586dc",
580+
"sent_at": "2025-07-16T12:34:56.909000Z",
581+
"title": "Thinking...",
582+
"description": "Fetching data from the Billing API...",
583+
"custom_id": "31-0C-1C-07-DB-16"
584+
}
585+
```
586+
587+
</CodeResponse>
588+
569589
### `incoming_typing_indicator`
570590

571591
Informs that one of the chat users (an Agent or a Bot Agent) is currently typing a message. The message hasn't been sent yet. The push payload contains the typing indicator object.

0 commit comments

Comments
 (0)