Skip to content

Commit f0696d8

Browse files
authored
feat(docs): update bot related APIs
1 parent c3c5246 commit f0696d8

File tree

5 files changed

+7
-16
lines changed

5 files changed

+7
-16
lines changed

src/pages/management/configuration-api/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1515,6 +1515,7 @@ Updates an existing Bot.
15151515
| `groups[].id` | Yes | `uint` | Group ID, required only when `groups`'s present. |
15161516
| `groups[].priority`<sup>**1**</sup> | Yes | `string` | Bot's priority in the group; required only when `groups` is included. |
15171517
| `default_group_priority`<sup>**1**</sup> | No | `string` | The default routing priority for a group without defined priority. |
1518+
| `job_title` | No | `string` | Bot's job title |
15181519
| `work_scheduler` | No | `object` | Work scheduler options to set for the new Bot. See [**Create Agent**](#create-agent) for details. |
15191520
| `work_scheduler.timezone` | Yes | `string` | The time zone in which the Bot's work scheduler should operate. |
15201521

src/pages/management/configuration-api/v3.6/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1499,6 +1499,7 @@ Updates an existing bot.
14991499
| `groups[].id` | Yes | `uint` | Group ID, required only when `groups`'s present. |
15001500
| `groups[].priority`<sup>**1**</sup> | Yes | `string` | Bot's priority in the group; required only when `groups` is included. |
15011501
| `default_group_priority`<sup>**1**</sup> | No | `string` | The default routing priority for a group without defined priority. |
1502+
| `job_title` | No | `string` | Bot's job title |
15021503
| `work_scheduler` | No | `object` | Work scheduler options to set for the new bot. See [**Create Agent**](#create-agent) for details. |
15031504
| `work_scheduler.timezone` | Yes | `string` | The time zone in which the bot's work scheduler should operate. |
15041505

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

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -82,12 +82,9 @@ The `filters`, `limit`, and `sort_order` parameters can't be provided along with
8282

8383
💡 The maximum duration of the `page_id` parameter before it expires is one month.
8484

85-
## Calling the API as a bot
85+
## Calling the RTM API as a bot
8686

87-
It's possible to call the Agent Chat API as a bot. There are two ways to authorize the requests:
88-
89-
- old (v3.5 and lower): a bot shares the access token with the agent who created it. You need to provide the [agent token](/authorization/agent-authorization/) (Bearer or Basic Auth) and the `X-Author-Id: <bot_id>` header in the request.
90-
- new (v3.5 and higher): bots use their own authorization tokens generated with the [Issue Bot Token](/management/configuration-api/v3.5/#issue-bot-token) method.
87+
Establishing a WebSocket connection as a bot is currently unsupported. If you want to call the Agent Chat API as a bot, you should use the [Web API](/messaging/agent-chat-api#calling-the-api-as-a-bot) instead.
9188

9289
# Data structures
9390

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,7 @@ The `filters`, `limit`, and `sort_order` parameters can't be provided along with
8989

9090
## Calling the API as a bot
9191

92-
Sometimes, you want to [send an event as a bot](#send-event). To do it, you need to have a token that allows you to send it. The token can be easily generated for an agent, but you cannot generate a token for a bot. The other time you want to [add a user to your chat](#add-user-to-chat), and this user happens to be a bot in the group with no access to this chat, so you cannot add it.
93-
94-
In both situations, the `Author-Id` header is what you need to include in your request. With it, you can authorize using the agent’s token and send the event as a bot or add a bot to a chat even if the bot belongs to the group that has no access to this chat.
95-
96-
`Author-Id: <bot_id>` header is needed with a [Bearer Token](/authorization/agent-authorization/) that needs to have the same `client_id` as the bot or [PAT](/authorization/agent-authorization#personal-access-tokens) that is from the organization that owns the bot's `client_id`.
92+
Establishing a WebSocket connection as a bot is currently unsupported. If you want to call the Agent Chat API as a bot, you should use the [Web API](/messaging/agent-chat-api#calling-the-api-as-a-bot) instead.
9793

9894
# Data structures
9995

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

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,9 @@ The `filters`, `limit`, and `sort_order` parameters can't be provided along with
8383

8484
💡 The maximum duration of the `page_id` parameter before it expires is one month.
8585

86-
## Calling the API as a bot
86+
## Calling the RTM API as a bot
8787

88-
Sometimes, you want to [send an event as a bot](#send-event). To do it, you need to have a token that allows you to send it. The token can be easily generated for an agent, but you cannot generate a token for a bot. The other time you want to [add a user to your chat](#add-user-to-chat), and this user happens to be a bot in the group with no access to this chat, so you cannot add it.
89-
90-
In both situations, the `Author-Id` header is what you need to include in your request. With it, you can authorize using the agent’s token and send the event as a bot or add a bot to a chat even if the bot belongs to the group that has no access to this chat.
91-
92-
`Author-Id: <bot_id>` header is needed with a [Bearer Token](/authorization/agent-authorization/) that needs to have the same `client_id` as the bot or [PAT](/authorization/agent-authorization#personal-access-tokens) that is from the organization that owns the bot's `client_id`.
88+
Establishing a WebSocket connection as a bot is currently unsupported. If you want to call the Agent Chat API as a bot, you should use the [Web API](/messaging/agent-chat-api#calling-the-api-as-a-bot) instead.
9389

9490
# Data structures
9591

0 commit comments

Comments
 (0)