From 94e8d90c5d51b8a64323f3d83a9fcc4a08a8696e Mon Sep 17 00:00:00 2001 From: oliwiapolec Date: Thu, 4 Dec 2025 16:28:40 +0100 Subject: [PATCH 1/6] feat(docs): clean table formatting --- .../data-reporting/reports-api/index.mdx | 252 ++--- .../data-reporting/reports-api/v3.7/index.mdx | 136 +-- .../management/configuration-api/index.mdx | 826 +++++++-------- .../configuration-api/v3.7/index.mdx | 941 +++++++++--------- src/pages/management/webhooks/index.mdx | 56 +- src/pages/management/webhooks/v3.7/index.mdx | 44 +- .../agent-chat-api/data-structures/index.mdx | 2 +- src/pages/messaging/agent-chat-api/index.mdx | 386 +++---- .../agent-chat-api/rtm-reference/index.mdx | 450 ++++----- .../v3.2/data-structures/index.mdx | 26 +- .../messaging/agent-chat-api/v3.2/index.mdx | 28 +- .../v3.2/rtm-reference/index.mdx | 28 +- .../v3.3/data-structures/index.mdx | 2 +- .../messaging/agent-chat-api/v3.3/index.mdx | 28 +- .../v3.3/rtm-reference/index.mdx | 28 +- .../v3.4/data-structures/index.mdx | 2 +- .../messaging/agent-chat-api/v3.4/index.mdx | 28 +- .../v3.4/rtm-reference/index.mdx | 28 +- .../v3.5/data-structures/index.mdx | 2 +- .../messaging/agent-chat-api/v3.5/index.mdx | 28 +- .../v3.5/rtm-reference/index.mdx | 28 +- .../v3.7/data-structures/index.mdx | 2 +- .../messaging/agent-chat-api/v3.7/index.mdx | 440 ++++---- .../v3.7/rtm-reference/index.mdx | 444 ++++----- .../data-structures/index.mdx | 2 +- .../messaging/customer-chat-api/index.mdx | 296 +++--- .../customer-chat-api/rtm-reference/index.mdx | 286 +++--- .../v3.2/data-structures/index.mdx | 12 +- .../customer-chat-api/v3.2/index.mdx | 40 +- .../v3.2/rtm-reference/index.mdx | 66 +- .../v3.3/data-structures/index.mdx | 2 +- .../customer-chat-api/v3.3/index.mdx | 40 +- .../v3.3/rtm-reference/index.mdx | 32 +- .../v3.4/data-structures/index.mdx | 2 +- .../customer-chat-api/v3.4/index.mdx | 40 +- .../v3.4/rtm-reference/index.mdx | 32 +- .../v3.5/data-structures/index.mdx | 2 +- .../customer-chat-api/v3.5/index.mdx | 40 +- .../v3.5/rtm-reference/index.mdx | 32 +- .../v3.7/data-structures/index.mdx | 2 +- .../customer-chat-api/v3.7/index.mdx | 298 +++--- .../v3.7/rtm-reference/index.mdx | 310 +++--- 42 files changed, 2884 insertions(+), 2885 deletions(-) diff --git a/src/pages/data-reporting/reports-api/index.mdx b/src/pages/data-reporting/reports-api/index.mdx index 976ddac67..9ab4425d8 100644 --- a/src/pages/data-reporting/reports-api/index.mdx +++ b/src/pages/data-reporting/reports-api/index.mdx @@ -39,7 +39,7 @@ You can authorize your calls to the Reports API using one of the following metho | Header | Value | Required | Notes | | --------------- | ---------------- | -------- | ---------------------------------------------------- | -| `Authorization` | `Bearer ` | Yes | Your access token | +| `Authorization` | `Bearer ` | Yes | Your access token. | | `X-API-Version` | `3.6` | No | The API version. You can also specify it in the URL. | **Additional headers specifically for the POST methods:** @@ -64,59 +64,59 @@ You can authorize your calls to the Reports API using one of the following metho ### For the Chats reports -| Parameter | Required | Data type | Notes | -| --------------------------------------------------------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `distribution` | No | `string` | Allowed values: `hour`, `day`, `day-hours`, `month` or `year`. Defaults to `day`. | -| `timezone` | No | `string` | IANA [Time Zone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones) (e.g. America/Phoenix). By default, the timezone is taken from the request. If it isn't provided, then it's taken from the agent's timezone. When it's impossible to load the agent's timezone, `filters.from` is parsed to get it. | -| `filters` | No | `object` | If none provided, your report will span the last seven days. | -| `filters.from` | No | `string` | Filters chats within specified time range defined as <`from`,`to`>. Date & time format compatible with RFC3339 with optional resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | -| `filters.to` | No | `string` | Filters chats within specified time range defined as <`from`,`to`>. Date & time format compatible with RFC3339 with optional resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | -| `filters.properties...`**1** | No | `any` | Described below. | -| `filters.agents.`**2** | No | `any` | Described below; `exists` set to `false` will return unassigned chats; `true` will return the assigned ones. | -| `filters.tags.`**2** | No | `any` | Described below. | -| `filters.sales.`**3** | No | `any` | Described below. | -| `filters.goals.`**3** | No | `any` | Described below. | -| `filters.surveys.`**4** | No | `array` | Described below. | -| `filters.event_types.`**5** | No | `any` | Described below. | -| `filters.groups.`**3** | No | `array` | Array of group IDs. | -| `filters.greetings.from` | No | `string` | Filters chats started from a greeting within specified time range defined as <`from`,`to`>. Date & time format compatible with RFC3339 with optional resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | -| `filters.greetings.to` | No | `string` | Filters chats started from a greeting within specified time range defined as <`from`,`to`>. Date & time format compatible with RFC3339 with optional resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | -| `filters.greetings.`**1** | No | `any` | Described below. | -| `filters.greetings.groups.`**3** | No | `any` | Described below. | -| `filters.agent_response.exists` | No | `bool` | | -| `filters.agent_response.first` | No | `bool` | Modifier that makes the other `agent_response` filters operate exclusively on the agents' first response. | -| `filters.agent_response.agents.`**2** | No | `any` | Described below. Works only if the `agent_response.first` filter is set to `true`. | -| `filters.agent_response.groups.`**3** | No | `any` | Described below. Works only if the `agent_response.first` filter is set to `true`. | -| `filters.customer_countries.`**2** | No | `any` | Described below. It supports country codes with the `ISO 3166-1 Alpha-2` format. | +| Parameter | Required | Data type | Notes | +| --------------------------------------------------------------------- | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `distribution` | No | `string` | Possible values: `hour`, `day`, `day-hours`, `month`, `year`. Default: `day`. | +| `timezone` | No | `string` | An IANA [Time Zone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones) (e.g. America/Phoenix). By default, the timezone is taken from the request. If it isn't provided, then it's taken from the agent's timezone. When it's impossible to load the agent's timezone, `filters.from` is parsed to get it. | +| `filters` | No | `object` | If none provided, your report will span the last seven days. | +| `filters.from` | No | `string` | Filters chats within the specified time range defined as <`from`,`to`>. Date & time format compatible with RFC3339 with optional resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | +| `filters.to` | No | `string` | Filters chats within the specified time range defined as <`from`,`to`>. Date & time format compatible with RFC3339 with optional resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | +| `filters.properties...`**1** | No | `any` | Described below. | +| `filters.agents.`**2** | No | `any` | Described below. If `exists` is set to `false`, the API will return unassigned chats. If set to `true`, the API will return assigned chats. | +| `filters.tags.`**2** | No | `any` | Described below. | +| `filters.sales.`**3** | No | `any` | Described below. | +| `filters.goals.`**3** | No | `any` | Described below. | +| `filters.surveys.`**4** | No | `array` | Described below. | +| `filters.event_types.`**5** | No | `any` | Described below. | +| `filters.groups.`**3** | No | `array` | An array of group IDs. | +| `filters.greetings.from` | No | `string` | Filters chats started from a greeting within the specified time range defined as <`from`,`to`>. Date & time format compatible with RFC3339 with optional resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | +| `filters.greetings.to` | No | `string` | Filters chats started from a greeting within the specified time range defined as <`from`,`to`>. Date & time format compatible with RFC3339 with optional resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | +| `filters.greetings.`**1** | No | `any` | Described below. | +| `filters.greetings.groups.`**3** | No | `any` | Described below. | +| `filters.agent_response.exists` | No | `bool` | | +| `filters.agent_response.first` | No | `bool` | A modifier that makes the other `agent_response` filters operate exclusively on the agents' first response. | +| `filters.agent_response.agents.`**2** | No | `any` | Described below. Works only if the `agent_response.first` filter is set to `true`. | +| `filters.agent_response.groups.`**3** | No | `any` | Described below. Works only if the `agent_response.first` filter is set to `true`. | +| `filters.customer_countries.`**2** | No | `any` | Described below. It supports country codes with the `ISO 3166-1 Alpha-2` format. | If filters are provided, they must contain exactly one pair of time-based filters (`filters.from/to`, `filters.greetings.from/to`, or `filters.surveys.from/to`). Additional parameter for the `queued-visitors-left` method: -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | --------------------------------------------------------------- | -| `page` | No | `int` | Non-negative integer allows to paginate products (default: `1`) | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | -------------------------------------------------------------------------- | +| `page` | No | `int` | A non-negative integer that allows you to paginate products. Default: `1`. | ### For the Agents reports -| Parameter | Required | Data type | Notes | -| ----------------------------------------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `distribution` | No | `string` | Allowed values: `hour`, `day`. Defaults to `day`. | -| `timezone` | No | `string` | IANA [Time Zone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones) (e.g. America/Phoenix). By default, the timezone is taken from the request. If it isn't provided, then it's taken from the agent's timezone. When it's impossible to load the agent's timezone, `filters.from` is parsed to get it. | -| `filters` | No | `object` | If none provided, your report will span the last seven days. | -| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with optional resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | -| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with optional resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | -| `filters.agents.`**2** | No | `any` | Described below. | -| `filters.groups.values` | No | `array` | Array of group IDs. | +| Parameter | Required | Data type | Notes | +| ----------------------------------------------------- | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `distribution` | No | `string` | Possible values: `hour`, `day`. Default: `day`. | +| `timezone` | No | `string` | An IANA [Time Zone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones) (e.g. America/Phoenix). By default, the timezone is taken from the request. If it isn't provided, then it's taken from the agent's timezone. When it's impossible to load the agent's timezone, `filters.from` is parsed to get it. | +| `filters` | No | `object` | If none provided, your report will span the last seven days. | +| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with optional resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | +| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with optional resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | +| `filters.agents.`**2** | No | `any` | Described below. | +| `filters.groups.values` | No | `array` | An array of group IDs. | If filters are provided, they must contain exactly one time-based filter (`filters.from/to`). ### For the customer reports -| Parameter | Required | Data type | Notes | -| -------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------ | -| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with optional resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | -| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with optional resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | +| Parameter | Required | Data type | Notes | +| -------------- | -------- | --------- | --------------------------------------------------------------------------------------------------------- | +| `filters.from` | No | `string` | Filters chats within the specified time range. See [format reference](#available-parameters-and-filters). | +| `filters.to` | No | `string` | Filters chats within the specified time range. See [format reference](#available-parameters-and-filters). | If filters are provided, they must contain exactly one time-based filter (`filters.from/to`). @@ -441,8 +441,8 @@ See [available parameters and filters](#available-parameters-and-filters). 💡 | --------------------- | ---------------------------------------------------------------------------------------------------------------------- | | `records` | Contains the `agent` objects. | | `records.agent.total` | The total number of chats an agent had in the specified period. | -| `records.agent.good` | The number of agent's chats rated `good`. | -| `records.agent.bad` | The number of agent's chats rated `bad`. | +| `records.agent.good` | The number of the agent's chats rated `good`. | +| `records.agent.bad` | The number of the agent's chats rated `bad`. | | `records.agent.score` | The agent's score. [Read more about how we calculate agent rankings...](https://www.livechat.com/help/agent-rankings/) | @@ -497,7 +497,7 @@ See [available parameters and filters](#available-parameters-and-filters). | `total` | The total number of chats in the specified date range. | | `records` | Contains the `distribution` objects, for example, `day`. | | `records.day.total` | The total number of chats that `day`. | -| `records.day.started_by_customer_from_greeting` | The number of chats from greetings (also knows as targeted messages) that `day`. | +| `records.day.started_by_customer_from_greeting` | The number of chats from greetings (also known as targeted messages) that `day`. | | `records.day.started_by_customer_without_greeting` | The number of chats started by a customer that `day`. | | `records.day.started_by_agent` | The number of chats started by an agent that `day`. | @@ -558,7 +558,7 @@ See [available parameters and filters](#available-parameters-and-filters). | `records.day.greeting_id.accepted` | The number of chats started as a result of accepting a greeting that `day`. | | `records.day.greeting_id.canceled` | The number of greetings customers dismissed that `day`. | | `records.day.greeting_id.displayed` | The number of greetings displayed that `day`. | -| `records.day.greeting_id.goals` | The number of goals resulted from the greetings that `day`. | +| `records.day.greeting_id.goals` | The number of goals that resulted from greetings that `day`. | @@ -613,22 +613,22 @@ See [available parameters and filters](#available-parameters-and-filters). 💡 #### Response -| Field | Notes | -| ------------------------------------------------------------------------------- | -------------------------------------------------------- | -| `records` | Contains `form` objects. | -| `records[{form_index}]` | Form at a given index. | -| `records[{form_index}].form_id` | Form ID. | -| `records[{form_index}].count` | Number of times this form was filled. | -| `records[{form_index}].group_id` | Group ID in which this `form` is. | -| `records[{form_index}].fields` | Contains `field` objects. | -| `records[{form_index}].fields[{field_index}]` | Field at a given index. | -| `records[{form_index}].fields[{field_index}].field_id` | Field ID. | -| `records[{form_index}].fields[{field_index}].label` | Text label of form field. | -| `records[{form_index}].fields[{field_index}].answers` | List of `answer` objects. | -| `records[{form_index}].fields[{field_index}].answers[{answer_index}]` | Answer at a given index. | -| `records[{form_index}].fields[{field_index}].answers[{answer_index}].answer_id` | Answer ID. | -| `records[{form_index}].fields[{field_index}].answers[{answer_index}].label` | Text label of answer. | -| `records[{form_index}].fields[{field_index}].answers[{answer_index}].count` | Number of times this answer was selected for this field. | +| Field | Notes | +| ------------------------------------------------------------------------------- | ------------------------------------------------------------ | +| `records` | Contains `form` objects. | +| `records[{form_index}]` | A form at a given index. | +| `records[{form_index}].form_id` | The form ID. | +| `records[{form_index}].count` | The number of times this form was filled. | +| `records[{form_index}].group_id` | The group ID in which this `form` is. | +| `records[{form_index}].fields` | Contains `field` objects. | +| `records[{form_index}].fields[{field_index}]` | A field at a given index. | +| `records[{form_index}].fields[{field_index}].field_id` | The field ID. | +| `records[{form_index}].fields[{field_index}].label` | The text label of the form field. | +| `records[{form_index}].fields[{field_index}].answers` | A list of `answer` objects. | +| `records[{form_index}].fields[{field_index}].answers[{answer_index}]` | An answer at a given index. | +| `records[{form_index}].fields[{field_index}].answers[{answer_index}].answer_id` | The answer ID. | +| `records[{form_index}].fields[{field_index}].answers[{answer_index}].label` | The text label of the answer. | +| `records[{form_index}].fields[{field_index}].answers[{answer_index}].count` | The number of times this answer was selected for this field. | @@ -841,12 +841,12 @@ See [available parameters and filters](#available-parameters-and-filters). Depen #### Response -| Field | Notes | -| ----------------- | -------------------------------------------------------------------------------------------------- | -| `total` | Total time the chat was available in the specified date range. | -| `records` | Contains the `distribution` objects, for example, `day`. | -| `records.hours` | The total number of hours the chat was available that `day` (only for the `day` distribution). | -| `records.minutes` | The total number of minutes the chat was available that `hour` (only for the `hour` distribution). | +| Field | Notes | +| ----------------- | ------------------------------------------------------------------------------------------------- | +| `total` | The total time the chat was available in the specified date range. | +| `records` | Contains the `distribution` objects, for example, `day`. | +| `records.hours` | The total number of hours the chat was available that `day`. Only for the `day` distribution. | +| `records.minutes` | The total number of minutes the chat was available that `hour`. Only for the `hour` distribution. | @@ -897,7 +897,7 @@ See [available parameters and filters](#available-parameters-and-filters). | Field | Notes | | ------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `summary` | Summary for all agents. | +| `summary` | A summary for all agents. | | `summary.chats_count` | The total number of chats the agents had in the specified period of time. | | `summary.chats_rated_good` | The number of chats rated `good`. | | `summary.chats_rated_bad` | The number of chats rated `bad`. | @@ -905,8 +905,8 @@ See [available parameters and filters](#available-parameters-and-filters). | `summary.first_response_time` | The average time (in seconds) the agents took to send a first reply to the customers' messages. | | `records` | Contains the `agent` objects. | | `records.chats_count` | The total number of chats the agent had in the specified period of time. | -| `records.chats_rated_good` | The number of agent's chats rated `good`. | -| `records.chats_rated_bad` | The number of agent's chats rated `bad`. | +| `records.chats_rated_good` | The number of the agent's chats rated `good`. | +| `records.chats_rated_bad` | The number of the agent's chats rated `bad`. | | `records.first_response_chats_count` | The number of chats where the agent has replied to the first message sent by the customer. | | `records.first_response_time` | The average time (in seconds) the agent took to send a first reply to the customers' messages. | | `records.accepting_chats_time` | The time (in seconds) during which the agent had the `accepting_chats` status set. | @@ -959,19 +959,19 @@ Returns the total number of page views and unique visitors during the specified #### Request -| Parameter | Required | Data type | Notes | -| -------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------- | -| `filters` | No | `object` | If none provided, your report will span last seven days. | -| `filters.from` | No | `string` | Filters chats within specified time range. See [format reference](#available-parameters-and-filters). | -| `filters.to` | No | `string` | Filters chats within specified time range. See [format reference](#available-parameters-and-filters). | +| Parameter | Required | Data type | Notes | +| -------------- | -------- | --------- | --------------------------------------------------------------------------------------------------------- | +| `filters` | No | `object` | If none provided, your report will span the last seven days. | +| `filters.from` | No | `string` | Filters chats within the specified time range. See [format reference](#available-parameters-and-filters). | +| `filters.to` | No | `string` | Filters chats within the specified time range. See [format reference](#available-parameters-and-filters). | #### Response -| Field | Notes | -| ------------------------- | -------------------------- | -| `summary` | Report summary. | -| `summary.unique_visitors` | Number of unique visitors. | -| `summary.page_views` | Number of page views. | +| Field | Notes | +| ------------------------- | ------------------------------ | +| `summary` | A report summary. | +| `summary.unique_visitors` | The number of unique visitors. | +| `summary.page_views` | The number of page views. | @@ -1022,20 +1022,20 @@ See [available parameters and filters](#available-parameters-and-filters). #### Response -| Field | Notes | -| ------------------------------ | ---------------------------------------------------- | -| `total` | Total number of chats in specified date range. | -| `records` | Contains `distribution` objects, for example, `day`. | -| `records.day.left_queue` | Visitors who left queue without starting chat. | -| `records.day.left_queue.count` | Visitor count. | -| `records.day.left_queue.min` | Minimum time (in seconds) spent in queue. | -| `records.day.left_queue.max` | Maximum time (in seconds) spent in queue. | -| `records.day.left_queue.avg` | Average time (in seconds) spent in queue. | -| `records.day.queued` | Visitors who waited in queue and entered chat. | -| `records.day.queued.count` | Visitor count. | -| `records.day.queued.min` | Minimum time (in seconds) spent in queue. | -| `records.day.queued.max` | Maximum time (in seconds) spent in queue. | -| `records.day.queued.avg` | Average time (in seconds) spent in queue. | +| Field | Notes | +| ------------------------------ | ------------------------------------------------------ | +| `total` | The total number of chats in the specified date range. | +| `records` | Contains `distribution` objects, for example, `day`. | +| `records.day.left_queue` | Visitors who left the queue without starting a chat. | +| `records.day.left_queue.count` | The visitor count. | +| `records.day.left_queue.min` | The minimum time (in seconds) spent in the queue. | +| `records.day.left_queue.max` | The maximum time (in seconds) spent in the queue. | +| `records.day.left_queue.avg` | The average time (in seconds) spent in the queue. | +| `records.day.queued` | Visitors who waited in the queue and entered a chat. | +| `records.day.queued.count` | The visitor count. | +| `records.day.queued.min` | The minimum time (in seconds) spent in the queue. | +| `records.day.queued.max` | The maximum time (in seconds) spent in the queue. | +| `records.day.queued.avg` | The average time (in seconds) spent in the queue. | @@ -1085,31 +1085,31 @@ See [available parameters and filters](#available-parameters-and-filters). #### Response -| Field | Notes | -| ---------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `total` | Total number of chats in specified date range. | -| `summary` | Report summary. | -| `summary.left_without_details` | Number of customers with identifying data. | -| `summary.total_pages` | Total number of returned pages. | -| `records` | Map of records keyed by chat ID. | -| `records.{chat_id}` | Objects including information about visitors who abandoned queue, identified by chat ID. | -| `records.{chat_id}.prechat_survey` | Array of pre-chat survey `fields`. | -| `records.{chat_id}.prechat_survey.key` | Pre-chat survey field `key`. | -| `records.{chat_id}.prechat_survey.value` | Pre-chat survey field `value`. | -| `records.{chat_id}.prechat_survey.id` | Pre-chat survey field `ID`. | -| `records.{chat_id}.prechat_survey.type` | Pre-chat survey field `type`. | -| `records.{chat_id}.visitor` | Customer details. | -| `records.{chat_id}.visitor.id` | Customer `ID`. | -| `records.{chat_id}.visitor.name` | Customer name set in pre-chat survey. | -| `records.{chat_id}.visitor.email` | Customer email set in pre-chat survey. | -| `records.{chat_id}.visitor.ip` | Customer IP. | -| `records.{chat_id}.visitor.visitor_custom_variables` | Array of custom variables in `{key}: {value}` format. | -| `records.{chat_id}.queue` | Queue data. | -| `records.{chat_id}.queue.duration` | Queue duration (in seconds). | -| `records.{chat_id}.queue.url` | URL where queue occurred. | -| `records.{chat_id}.queue.group` | Group to which chat was routed. | -| `records.{chat_id}.queue.start_date` | Queue start date. | -| `records.{chat_id}.integration_variables` | Array of integration variables in `{key}: {value}` format. | +| Field | Notes | +| ---------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `total` | The total number of chats in the specified date range. | +| `summary` | A report summary. | +| `summary.left_without_details` | The number of customers with identifying data. | +| `summary.total_pages` | The total number of returned pages. | +| `records` | A map of records keyed by chat ID. | +| `records.{chat_id}` | Objects including information about visitors who abandoned the queue, identified by chat ID. | +| `records.{chat_id}.prechat_survey` | An array of pre-chat survey `fields`. | +| `records.{chat_id}.prechat_survey.key` | The pre-chat survey field `key`. | +| `records.{chat_id}.prechat_survey.value` | The pre-chat survey field `value`. | +| `records.{chat_id}.prechat_survey.id` | The pre-chat survey field `ID`. | +| `records.{chat_id}.prechat_survey.type` | The pre-chat survey field `type`. | +| `records.{chat_id}.visitor` | Customer details. | +| `records.{chat_id}.visitor.id` | The customer `ID`. | +| `records.{chat_id}.visitor.name` | The customer name set in the pre-chat survey. | +| `records.{chat_id}.visitor.email` | The customer email set in the pre-chat survey. | +| `records.{chat_id}.visitor.ip` | The customer IP. | +| `records.{chat_id}.visitor.visitor_custom_variables` | An array of custom variables in `{key}: {value}` format. | +| `records.{chat_id}.queue` | Queue data. | +| `records.{chat_id}.queue.duration` | The queue duration (in seconds). | +| `records.{chat_id}.queue.url` | The URL where the queue occurred. | +| `records.{chat_id}.queue.group` | The group to which the chat was routed. | +| `records.{chat_id}.queue.start_date` | The queue start date. | +| `records.{chat_id}.integration_variables` | An array of integration variables in `{key}: {value}` format. | @@ -1157,13 +1157,13 @@ Returns the total number of chats marked with each tag listed in the report. #### Request -| Parameter | Required | Data type | Notes | -| ----------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------- | -| `timezone` | No | `string` | Timezone. See [format reference](#available-parameters-and-filters). | -| `filters` | No | `object` | If none provided, your report will span last seven days. | -| `filters.from` | No | `string` | Filters chats within specified time range. See [format reference](#available-parameters-and-filters). | -| `filters.to` | No | `string` | Filters chats within specified time range. See [format reference](#available-parameters-and-filters). | -| `filters.groups.values` | No | `[]int` | Array of group IDs. | +| Parameter | Required | Data type | Notes | +| ----------------------- | -------- | --------- | --------------------------------------------------------------------------------------------------------- | +| `timezone` | No | `string` | The timezone. See [format reference](#available-parameters-and-filters). | +| `filters` | No | `object` | If none provided, your report will span the last seven days. | +| `filters.from` | No | `string` | Filters chats within the specified time range. See [format reference](#available-parameters-and-filters). | +| `filters.to` | No | `string` | Filters chats within the specified time range. See [format reference](#available-parameters-and-filters). | +| `filters.groups.values` | No | `[]int` | An array of group IDs. | #### Response diff --git a/src/pages/data-reporting/reports-api/v3.7/index.mdx b/src/pages/data-reporting/reports-api/v3.7/index.mdx index 4b20412f8..ae846175d 100644 --- a/src/pages/data-reporting/reports-api/v3.7/index.mdx +++ b/src/pages/data-reporting/reports-api/v3.7/index.mdx @@ -39,7 +39,7 @@ You can authorize your calls to the Reports API using one of the following metho | Header | Value | Required | Notes | | --------------- | ---------------- | -------- | ---------------------------------------------------- | -| `Authorization` | `Bearer ` | Yes | Your access token | +| `Authorization` | `Bearer ` | Yes | Your access token. | | `X-API-Version` | `3.7` | No | The API version. You can also specify it in the URL. | **Additional headers specifically for the POST methods:** @@ -67,13 +67,13 @@ You can authorize your calls to the Reports API using one of the following metho | Parameter | Required | Data type | Notes | | --------------------------------------------------------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `distribution` | No | `string` | Allowed values: `hour`, `day`, `day-hours`, `month` or `year`. Defaults to `day`. | +| `distribution` | No | `string` | Possible values: `hour`, `day`, `day-hours`, `month`, `year`. Default: `day`. | | `timezone` | No | `string` | IANA [Time Zone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones) (e.g. America/Phoenix). By default, the timezone is taken from the request. If it isn't provided, then it's taken from the agent's timezone. When it's impossible to load the agent's timezone, `filters.from` is parsed to get it. | | `filters` | No | `object` | If none provided, your report will span the last seven days. | | `filters.from` | No | `string` | Filters chats within specified time range defined as <`from`,`to`>. Date & time format compatible with RFC3339 with optional resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | | `filters.to` | No | `string` | Filters chats within specified time range defined as <`from`,`to`>. Date & time format compatible with RFC3339 with optional resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | | `filters.properties...`**1** | No | `any` | Described below. | -| `filters.agents.`**2** | No | `any` | Described below; `exists` set to `false` will return unassigned chats; `true` will return the assigned ones. | +| `filters.agents.`**2** | No | `any` | Described below. If `exists` is set to `false`, will return unassigned chats. If set to `true`, will return the assigned ones. | | `filters.tags.`**2** | No | `any` | Described below. | | `filters.sales.`**3** | No | `any` | Described below. | | `filters.goals.`**3** | No | `any` | Described below. | @@ -85,7 +85,7 @@ You can authorize your calls to the Reports API using one of the following metho | `filters.greetings.`**1** | No | `any` | Described below. | | `filters.greetings.groups.`**3** | No | `any` | Described below. | | `filters.agent_response.exists` | No | `bool` | | -| `filters.agent_response.first` | No | `bool` | Modifier that makes the other `agent_response` filters operate exclusively on the agents' first response. | +| `filters.agent_response.first` | No | `bool` | A modifier that makes the other `agent_response` filters operate exclusively on the agents' first response. | | `filters.agent_response.agents.`**2** | No | `any` | Described below. Works only if the `agent_response.first` filter is set to `true`. | | `filters.agent_response.groups.`**3** | No | `any` | Described below. Works only if the `agent_response.first` filter is set to `true`. | | `filters.customer_countries.`**2** | No | `any` | Described below. It supports country codes with the `ISO 3166-1 Alpha-2` format. | @@ -94,15 +94,15 @@ If filters are provided, they must contain exactly one pair of time-based filter Additional parameter for the `queued-visitors-left` method: -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | --------------------------------------------------------------- | -| `page` | No | `int` | Non-negative integer allows to paginate products (default: `1`) | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ---------------------------------------------------------------------- | +| `page` | No | `int` | A non-negative integer that allows to paginate products. Default: `1`. | ### For the Agents reports | Parameter | Required | Data type | Notes | | ----------------------------------------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `distribution` | No | `string` | Allowed values: `hour`, `day`. Defaults to `day`. | +| `distribution` | No | `string` | Possible values: `hour`, `day`. Default: `day`. | | `timezone` | No | `string` | IANA [Time Zone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones) (e.g. America/Phoenix). By default, the timezone is taken from the request. If it isn't provided, then it's taken from the agent's timezone. When it's impossible to load the agent's timezone, `filters.from` is parsed to get it. | | `filters` | No | `object` | If none provided, your report will span the last seven days. | | `filters.from` | No | `string` | Date & time format compatible with RFC3339 with optional resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | @@ -614,22 +614,22 @@ See [available parameters and filters](#available-parameters-and-filters). 💡 #### Response -| Field | Notes | -| ------------------------------------------------------------------------------- | -------------------------------------------------------- | -| `records` | Contains `form` objects. | -| `records[{form_index}]` | Form at a given index. | -| `records[{form_index}].form_id` | Form ID. | -| `records[{form_index}].count` | Number of times this form was filled. | -| `records[{form_index}].group_id` | Group ID in which this `form` is. | -| `records[{form_index}].fields` | Contains `field` objects. | -| `records[{form_index}].fields[{field_index}]` | Field at a given index. | -| `records[{form_index}].fields[{field_index}].field_id` | Field ID. | -| `records[{form_index}].fields[{field_index}].label` | Text label of form field. | -| `records[{form_index}].fields[{field_index}].answers` | List of `answer` objects. | -| `records[{form_index}].fields[{field_index}].answers[{answer_index}]` | Answer at a given index. | -| `records[{form_index}].fields[{field_index}].answers[{answer_index}].answer_id` | Answer ID. | -| `records[{form_index}].fields[{field_index}].answers[{answer_index}].label` | Text label of answer. | -| `records[{form_index}].fields[{field_index}].answers[{answer_index}].count` | Number of times this answer was selected for this field. | +| Field | Notes | +| ------------------------------------------------------------------------------- | ------------------------------------------------------------ | +| `records` | Contains `form` objects. | +| `records[{form_index}]` | A form at a given index. | +| `records[{form_index}].form_id` | The form ID. | +| `records[{form_index}].count` | The number of times this form was filled. | +| `records[{form_index}].group_id` | The group ID in which this `form` is. | +| `records[{form_index}].fields` | Contains `field` objects. | +| `records[{form_index}].fields[{field_index}]` | A field at a given index. | +| `records[{form_index}].fields[{field_index}].field_id` | The field ID. | +| `records[{form_index}].fields[{field_index}].label` | The text label of form field. | +| `records[{form_index}].fields[{field_index}].answers` | A list of `answer` objects. | +| `records[{form_index}].fields[{field_index}].answers[{answer_index}]` | An answer at a given index. | +| `records[{form_index}].fields[{field_index}].answers[{answer_index}].answer_id` | The answer ID. | +| `records[{form_index}].fields[{field_index}].answers[{answer_index}].label` | The text label of answer. | +| `records[{form_index}].fields[{field_index}].answers[{answer_index}].count` | The number of times this answer was selected for this field. | @@ -898,7 +898,7 @@ See [available parameters and filters](#available-parameters-and-filters). | Field | Notes | | ------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `summary` | Summary for all agents. | +| `summary` | A summary for all agents. | | `summary.chats_count` | The total number of chats the agents had in the specified period of time. | | `summary.chats_rated_good` | The number of chats rated `good`. | | `summary.chats_rated_bad` | The number of chats rated `bad`. | @@ -968,11 +968,11 @@ Returns the total number of page views and unique visitors during the specified #### Response -| Field | Notes | -| ------------------------- | -------------------------- | -| `summary` | Report summary. | -| `summary.unique_visitors` | Number of unique visitors. | -| `summary.page_views` | Number of page views. | +| Field | Notes | +| ------------------------- | ------------------------------ | +| `summary` | A report summary. | +| `summary.unique_visitors` | The number of unique visitors. | +| `summary.page_views` | The number of page views. | @@ -1025,18 +1025,18 @@ See [available parameters and filters](#available-parameters-and-filters). | Field | Notes | | ------------------------------ | ---------------------------------------------------- | -| `total` | Total number of chats in specified date range. | +| `total` | The total number of chats in specified date range. | | `records` | Contains `distribution` objects, for example, `day`. | | `records.day.left_queue` | Visitors who left queue without starting chat. | -| `records.day.left_queue.count` | Visitor count. | -| `records.day.left_queue.min` | Minimum time (in seconds) spent in queue. | -| `records.day.left_queue.max` | Maximum time (in seconds) spent in queue. | -| `records.day.left_queue.avg` | Average time (in seconds) spent in queue. | +| `records.day.left_queue.count` | The visitor count. | +| `records.day.left_queue.min` | The minimum time (in seconds) spent in queue. | +| `records.day.left_queue.max` | The maximum time (in seconds) spent in queue. | +| `records.day.left_queue.avg` | The average time (in seconds) spent in queue. | | `records.day.queued` | Visitors who waited in queue and entered chat. | -| `records.day.queued.count` | Visitor count. | -| `records.day.queued.min` | Minimum time (in seconds) spent in queue. | -| `records.day.queued.max` | Maximum time (in seconds) spent in queue. | -| `records.day.queued.avg` | Average time (in seconds) spent in queue. | +| `records.day.queued.count` | The visitor count. | +| `records.day.queued.min` | The minimum time (in seconds) spent in queue. | +| `records.day.queued.max` | The maximum time (in seconds) spent in queue. | +| `records.day.queued.avg` | The average time (in seconds) spent in queue. | @@ -1088,29 +1088,29 @@ See [available parameters and filters](#available-parameters-and-filters). | Field | Notes | | ---------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `total` | Total number of chats in specified date range. | -| `summary` | Report summary. | -| `summary.left_without_details` | Number of customers with identifying data. | -| `summary.total_pages` | Total number of returned pages. | -| `records` | Map of records keyed by chat ID. | +| `total` | The total number of chats in specified date range. | +| `summary` | A report summary. | +| `summary.left_without_details` | The number of customers with identifying data. | +| `summary.total_pages` | The total number of returned pages. | +| `records` | A map of records keyed by chat ID. | | `records.{chat_id}` | Objects including information about visitors who abandoned queue, identified by chat ID. | -| `records.{chat_id}.prechat_survey` | Array of pre-chat survey `fields`. | -| `records.{chat_id}.prechat_survey.key` | Pre-chat survey field `key`. | -| `records.{chat_id}.prechat_survey.value` | Pre-chat survey field `value`. | -| `records.{chat_id}.prechat_survey.id` | Pre-chat survey field `ID`. | -| `records.{chat_id}.prechat_survey.type` | Pre-chat survey field `type`. | -| `records.{chat_id}.visitor` | Customer details. | -| `records.{chat_id}.visitor.id` | Customer `ID`. | -| `records.{chat_id}.visitor.name` | Customer name set in pre-chat survey. | -| `records.{chat_id}.visitor.email` | Customer email set in pre-chat survey. | -| `records.{chat_id}.visitor.ip` | Customer IP. | -| `records.{chat_id}.visitor.visitor_custom_variables` | Array of custom variables in `{key}: {value}` format. | -| `records.{chat_id}.queue` | Queue data. | -| `records.{chat_id}.queue.duration` | Queue duration (in seconds). | -| `records.{chat_id}.queue.url` | URL where queue occurred. | -| `records.{chat_id}.queue.group` | Group to which chat was routed. | -| `records.{chat_id}.queue.start_date` | Queue start date. | -| `records.{chat_id}.integration_variables` | Array of integration variables in `{key}: {value}` format. | +| `records.{chat_id}.prechat_survey` | An array of pre-chat survey `fields`. | +| `records.{chat_id}.prechat_survey.key` | The pre-chat survey field `key`. | +| `records.{chat_id}.prechat_survey.value` | The pre-chat survey field `value`. | +| `records.{chat_id}.prechat_survey.id` | The pre-chat survey field `ID`. | +| `records.{chat_id}.prechat_survey.type` | The pre-chat survey field `type`. | +| `records.{chat_id}.visitor` | The customer details. | +| `records.{chat_id}.visitor.id` | The customer `ID`. | +| `records.{chat_id}.visitor.name` | The customer name set in pre-chat survey. | +| `records.{chat_id}.visitor.email` | The customer email set in pre-chat survey. | +| `records.{chat_id}.visitor.ip` | The customer IP. | +| `records.{chat_id}.visitor.visitor_custom_variables` | An array of custom variables in `{key}: {value}` format. | +| `records.{chat_id}.queue` | The queue data. | +| `records.{chat_id}.queue.duration` | The queue duration (in seconds). | +| `records.{chat_id}.queue.url` | The URL where queue occurred. | +| `records.{chat_id}.queue.group` | The group to which chat was routed. | +| `records.{chat_id}.queue.start_date` | The queue start date. | +| `records.{chat_id}.integration_variables` | An array of integration variables in `{key}: {value}` format. | @@ -1160,11 +1160,11 @@ Returns the total number of chats marked with each tag listed in the report. | Parameter | Required | Data type | Notes | | ----------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------- | -| `timezone` | No | `string` | Timezone. See [format reference](#available-parameters-and-filters). | +| `timezone` | No | `string` | The timezone. See [format reference](#available-parameters-and-filters). | | `filters` | No | `object` | If none provided, your report will span last seven days. | | `filters.from` | No | `string` | Filters chats within specified time range. See [format reference](#available-parameters-and-filters). | | `filters.to` | No | `string` | Filters chats within specified time range. See [format reference](#available-parameters-and-filters). | -| `filters.groups.values` | No | `[]int` | Array of group IDs. | +| `filters.groups.values` | No | `[]int` | An array of group IDs. | #### Response @@ -1230,11 +1230,11 @@ Returns up to 100 domains from which visitors access your website, ranked by pag #### Response -| Field | Notes | -| ------------------ | ------------------------------------------------ | -| `name` | Report name: `visitor-domains-report`. | -| `summary` | Map of domain names with their page view counts. | -| `summary.` | Number of page views from the specified domain. | +| Field | Notes | +| ------------------ | --------------------------------------------------- | +| `name` | The report name: `visitor-domains-report`. | +| `summary` | A map of domain names with their page view counts. | +| `summary.` | The number of page views from the specified domain. | diff --git a/src/pages/management/configuration-api/index.mdx b/src/pages/management/configuration-api/index.mdx index c13ab404b..632ebd1fb 100644 --- a/src/pages/management/configuration-api/index.mdx +++ b/src/pages/management/configuration-api/index.mdx @@ -53,9 +53,9 @@ Each request in a batch is executed concurrently – there's no guarantee regard ### Request -| Parameter | Required | Data type | Notes | -| ---------- | -------- | --------- | -------------------------------------------------------------- | -| `requests` | yes | `array` | Array of request objects of the corresponding non-batch method | +| Parameter | Required | Data type | Notes | +| ---------- | -------- | --------- | ------------------------------------------------------------------ | +| `requests` | yes | `array` | An array of request objects of the corresponding non-batch method. | @@ -197,28 +197,28 @@ Creates a new agent with specified parameters within a license. #### Request -| Parameter | Data type | Required | Notes | -| ------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | `string` | Yes | Agent ID | -| `name` | `string` | Yes | Agent name | -| `role` | `string` | No | Agent role, should be one of the following: `viceowner`, `administrator`, `normal` (default). | -| `login_status` | `string` | No | Agent's default status right after the login, should be one of the following: `accepting chats`, `not accepting chats` (default). | -| `job_title` | `string` | No | Agent's job title | -| `mobile` | `string` | No | Agent's mobile number | -| `max_chats_count` | `int` | No | Agent's maximum number of concurrent chats; default: 6. Limited to 20. | -| `awaiting_approval` | `bool` | No | Determines if the agent will be awaiting approval after creation. Only a requester with the `subscription.lc:rw` scope can set this value to `false`. | -| `groups` | `object[]` | No | Groups an agent belongs to. | -| `groups[].id` | `uint` | Yes | Group ID; required only when `group` is included. | -| `groups[].priority`**3** | `string` | Yes | Agent's priority in a group; required only when `group` is included. | -| `notifications`**4** | `string[]` | No | Represents which agent notifications are turned on. | -| `email_subscriptions`**5** | `string[]` | No | Represents which subscriptions will be send to the agent via email. | -| `work_scheduler` | `object` | No | Work scheduler options to set for the new agent | -| `work_scheduler.timezone` | `string` | Yes | Timezone for the work scheduler. Required only when `schedule` is not empty. Falls back to the agent's timezone if empty. | -| `work_scheduler.schedule` | `object[]` | Yes | List of agent's working hours. | -| `work_scheduler.schedule[].day` | `string` | Yes | The day for which the working hours are set. Possible values: sunday, monday, tuesday, wednesday, thursday, friday, and saturday. | -| `work_scheduler.schedule[].enabled` | `bool` | Yes | Whether the given set of working hours is enabled. | -| `work_scheduler.schedule[].start` | `string` | Yes | When working hours start. | -| `work_scheduler.schedule[].end` | `string` | Yes | When working hours end. | +| Parameter | Data type | Required | Notes | +| ------------------------------------- | ---------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | `string` | Yes | The agent ID. | +| `name` | `string` | Yes | The agent name. | +| `role` | `string` | No | The agent role. Possible values: `viceowner`, `administrator`, `normal` (default). | +| `login_status` | `string` | No | The agent's default status right after the login. Possible values: `accepting chats`, `not accepting chats` (default). | +| `job_title` | `string` | No | The agent's job title. | +| `mobile` | `string` | No | The agent's mobile number. | +| `max_chats_count` | `int` | No | The agent's maximum number of concurrent chats. Maximum: 20. Default: 6. | +| `awaiting_approval` | `bool` | No | If set to `true`: the agent will be awaiting approval after creation. Only a requester with the `subscription.lc:rw` scope can set this value to `false`. | +| `groups` | `object[]` | No | The groups an agent belongs to. | +| `groups[].id` | `uint` | Yes | The group ID. Required only when `group` is included. | +| `groups[].priority`**3** | `string` | Yes | The Agent's priority in a group. Required only when `group` is included. | +| `notifications`**4** | `string[]` | No | The agent notifications that are turned on. | +| `email_subscriptions`**5** | `string[]` | No | The subscriptions that will be sent to the agent via email. | +| `work_scheduler` | `object` | No | The work scheduler options to set for the new agent. | +| `work_scheduler.timezone` | `string` | Yes | The timezone for the work scheduler. Falls back to the agent's timezone if empty. Required only when `schedule` is not empty. | +| `work_scheduler.schedule` | `object[]` | Yes | The list of agent's working hours. | +| `work_scheduler.schedule[].day` | `string` | Yes | The day for which the working hours are set. Possible values: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`. | +| `work_scheduler.schedule[].enabled` | `bool` | Yes | If set to `true`: the given set of working hours is enabled. | +| `work_scheduler.schedule[].start` | `string` | Yes | The time when working hours start. | +| `work_scheduler.schedule[].end` | `string` | Yes | The time when working hours end. | **3)** Possible values for the `groups[].priority` parameter: @@ -340,25 +340,25 @@ It returns the info about an agent specified by `id`. #### Request -| Parameter | Type | Required | Notes | -| ------------------------ | ---------- | -------- | ----------------------------- | -| `id` | `string` | Yes | Agent ID | -| `fields`**1** | `string[]` | No | Additional fields to include. | +| Parameter | Type | Required | Notes | +| ------------------------ | ---------- | -------- | --------------------------------- | +| `id` | `string` | Yes | The Agent ID. | +| `fields`**1** | `string[]` | No | The additional fields to include. | **1)** Possible values for the `fields[]` parameter: -| Possible value | Notes | -| --------------------- | -------------------------------------------------------------------------------------- | -| `work_scheduler` | Work scheduler object for an agent. See [**Create Agent**](#create-agent) for details. | -| `groups` | Groups an agent belongs to | -| `email_subscriptions` | A list of an agent's active subscriptions | -| `notifications` | A list of an agent's enabled notifications | -| `job_title` | Agent's job title | -| `mobile` | Agent's mobile number | -| `max_chats_count` | Agent's maximum number of concurrent chats | -| `suspended` | Boolean value indicating if an agent is suspended | -| `awaiting_approval` | Boolean value indicating if an agent is awaiting approval | -| `last_logout` | RFC 3339 date-time of the last logout of an agent (omitted when no logout occurred) | +| Possible value | Notes | +| --------------------- | ------------------------------------------------------------------------------------------ | +| `work_scheduler` | The work scheduler object for an agent. See [**Create Agent**](#create-agent) for details. | +| `groups` | The groups an agent belongs to. | +| `email_subscriptions` | The list of an agent's active subscriptions. | +| `notifications` | The list of an agent's enabled notifications. | +| `job_title` | The agent's job title. | +| `mobile` | The agent's mobile number. | +| `max_chats_count` | The agent's maximum number of concurrent chats. | +| `suspended` | If `true`: the agent is suspended. | +| `awaiting_approval` | If `true`: the agent is awaiting approval. | +| `last_logout` | The RFC 3339 date-time of the last logout of an agent. Omitted when no logout occurred. | @@ -402,27 +402,27 @@ Returns all Agents within a license. #### Request -| Parameter | Required | Type | Notes | -| ------------------------ | -------- | ---------- | ------------------------------------------------------------------------------------------------------------- | -| `filters` | No | `object` | Possible request filters | -| `filters.group_ids` | No | `int[]` | IDs of the groups from which you want to list Agents. You'll only get the Agents from the specified group(s). | -| `filters.suspended` | No | `bool` | If provided, returns only those Agents who have the same `suspended` field value. | -| `fields`**1** | No | `string[]` | Additional agent fields to include. | +| Parameter | Required | Type | Notes | +| ------------------------ | -------- | ---------- | ----------------------------------------------------------------------------------------------------------------- | +| `filters` | No | `object` | The possible request filters | +| `filters.group_ids` | No | `int[]` | The IDs of the groups from which you want to list Agents. You'll only get the Agents from the specified group(s). | +| `filters.suspended` | No | `bool` | If provided: returns only those Agents who have the same `suspended` field value. | +| `fields`**1** | No | `string[]` | The additional agent fields to include. | **1)** Possible values for the `fields[]` parameter: -| Possible value | Notes | -| --------------------- | -------------------------------------------------------------------------------------- | -| `groups` | Groups an agent belongs to | -| `work_scheduler` | Work scheduler object for an agent. See [**Create Agent**](#create-agent) for details. | -| `email_subscriptions` | A list of the agent's active email subscriptions | -| `notifications` | A list of the agent's enabled notifications | -| `job_title` | Agent's job title | -| `mobile` | Agent's mobile number | -| `max_chats_count` | Agent's maximum number of concurrent chats | -| `suspended` | Boolean value indicating if an agent is suspended | -| `awaiting_approval` | Boolean value indicating if an agent is awaiting approval | -| `last_logout` | RFC 3339 date-time of the last logout of an agent (omitted when no logout occurred) | +| Possible value | Notes | +| --------------------- | ------------------------------------------------------------------------------------------ | +| `groups` | The groups an agent belongs to. | +| `work_scheduler` | The work scheduler object for an agent. See [**Create Agent**](#create-agent) for details. | +| `email_subscriptions` | The list of an agent's active email subscriptions. | +| `notifications` | The list of an agent's enabled notifications. | +| `job_title` | The agent's job title. | +| `mobile` | The agent's mobile number. | +| `max_chats_count` | The agent's maximum number of concurrent chats. | +| `suspended` | If `true`: the agent is suspended. | +| `awaiting_approval` | If `true`: the agent is awaiting approval. | +| `last_logout` | The RFC 3339 date-time of the last logout of an agent. Omitted when no logout occurred. | @@ -480,20 +480,20 @@ Updates the properties of an agent specified by `id`. #### Request -| Parameter | Data type | Required | Notes | -| ------------------------------------- | ---------- | -------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `id` | `string` | Yes | Agent ID | -| `role` | `string` | No | Agent role, should be one of the following: `viceowner`, `administrator`, `normal` | -| `login_status` | `string` | No | Agent's default status right after the login, should be one of the following: `accepting chats`, `not accepting chats` (default). | -| `job_title` | `string` | No | Agent's job title | -| `mobile` | `string` | No | Agent's mobile number | -| `max_chats_count` | `int` | No | Agent's maximum number of concurrent. Limited to 20. chats | -| `groups` | `object[]` | No | Groups an agent belongs to. | -| `groups[].id` | `uint` | Yes | Group ID; required only when `group`'s included. | -| `groups[].priority` **1** | `string` | Yes | Agent's priority in a group; required only when `group`'s included. | -| `notifications`**2** | `string[]` | No | Represents which agent notifications are turned on. | -| `email_subscriptions`**3** | `string[]` | No | Represents which subscriptions will be send to an agent via email. | -| `work_scheduler` | `object` | No | Work scheduler options to set for an agent. See [**Create Agent**](#create-agent) for details. | +| Parameter | Data type | Required | Notes | +| ------------------------------------- | ---------- | -------- | ---------------------------------------------------------------------------------------------------------------------- | +| `id` | `string` | Yes | The agent ID. | +| `role` | `string` | No | The agent role. Possible values: `viceowner`, `administrator`, `normal`. | +| `login_status` | `string` | No | The agent's default status right after the login. Possible values: `accepting chats`, `not accepting chats` (default). | +| `job_title` | `string` | No | The agent's job title. | +| `mobile` | `string` | No | The agent's mobile number. | +| `max_chats_count` | `int` | No | The agent's maximum number of concurrent chats. Maximum: 20. | +| `groups` | `object[]` | No | The groups an agent belongs to. | +| `groups[].id` | `uint` | Yes | The Group ID. Required only when `group`'s included. | +| `groups[].priority` **1** | `string` | Yes | The agent's priority in a group. Required only when `group`'s included. | +| `notifications`**2** | `string[]` | No | The agent notifications that are turned on. | +| `email_subscriptions`**3** | `string[]` | No | The subscriptions that will be sent to an agent via email. | +| `work_scheduler` | `object` | No | The work scheduler options to set for an agent. See [**Create Agent**](#create-agent) for details. | **1)** Possible values for the `groups[].priority` parameter: @@ -605,9 +605,9 @@ Deletes an agent specified by `id`. #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | -------- | -| `id` | Yes | `string` | Agent ID | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------- | +| `id` | Yes | `string` | The agent ID. | #### Response @@ -657,9 +657,9 @@ Suspends an agent specified by `id`. #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | -------- | -| `id` | Yes | `string` | Agent ID | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------- | +| `id` | Yes | `string` | The agent ID. | #### Response @@ -709,9 +709,9 @@ Unsuspends an agent specified by `id`. #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | -------- | -| `id` | Yes | `string` | Agent ID | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------- | +| `id` | Yes | `string` | The agent ID. | #### Response @@ -805,9 +805,9 @@ Approves an agent thus allowing the agent to use the application. #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | -------- | -| `id` | Yes | `string` | Agent ID | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------- | +| `id` | Yes | `string` | The agent ID. | #### Response @@ -869,19 +869,19 @@ Creates an `auto access` data structure, which is a set of conditions for the tr | Required scopes | `access_rules:rw` | | [Batch support](#batch-requests) | No | -| Parameter | Required | Data type | Notes | -| ---------------------------------------- | -------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `access` | Yes | `object` | Destination access | -| `access.groups` | Yes | `[]int` | Destination groups | -| `conditions`**1** | Yes | `object` | Conditions to check | -| `conditions.url` | No | `object` | The condition that matches on `customer_page.url` from **Login** or `url` from **Update Customer Page** | -| `conditions.domain` | No | `object` | The condition that matches on the domain of the `customer_url` | -| `conditions.{url,domain}.values` | No | `[]match_object`**2** | Positive match, may not be used together with `exclude_values` | -| `conditions.{url,domain}.exclude_values` | No | `[]match_object` | Negative match | -| `conditions.geolocation` | No | `object` | The condition that matches on the customer's geolocation | -| `conditions.geolocation.values` | Yes | `[]geolocation_object`**3** | An array of objects; matches when at least one subcondition matches. | -| `description` | No | `string` | Description of the auto access | -| `next_id` | No | `string` | ID of an existing auto access. Leave empty if the new auto access should be the last one on the list. | +| Parameter | Required | Data type | Notes | +| ---------------------------------------- | -------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `access` | Yes | `object` | The destination access. | +| `access.groups` | Yes | `[]int` | The destination groups. | +| `conditions`**1** | Yes | `object` | The conditions to check. | +| `conditions.url` | No | `object` | The condition that matches on `customer_page.url` from **Login** or `url` from **Update Customer Page**. | +| `conditions.domain` | No | `object` | The condition that matches on the domain of the `customer_url`. | +| `conditions.{url,domain}.values` | No | `[]match_object`**2** | The positive match. May not be used together with `exclude_values`. | +| `conditions.{url,domain}.exclude_values` | No | `[]match_object` | The negative match. | +| `conditions.geolocation` | No | `object` | The condition that matches on the customer's geolocation. | +| `conditions.geolocation.values` | Yes | `[]geolocation_object`**3** | An array of objects. Matches when at least one subcondition matches. | +| `description` | No | `string` | The description of the auto access. | +| `next_id` | No | `string` | The ID of an existing auto access. Leave empty if the new auto access should be the last one on the list. | **1)** `conditions` must have at least one of `url`, `domain`, `geolocation` set. @@ -889,10 +889,10 @@ Creates an `auto access` data structure, which is a set of conditions for the tr | Parameter | Required | Data type | Notes | | ------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------- | -| `value` | Yes | `string` | A value to match | -| `exact_match` | No | `bool` | If set to `false`, a `match_object.value` will be matched as a substring of the customer URL or domain. | +| `value` | Yes | `string` | A value to match. | +| `exact_match` | No | `bool` | If set to `false`: a `match_object.value` will be matched as a substring of the customer URL or domain. | -**3)** the `geolocation_object` structure. The condition is fulfilled only when all of the specified fields match. At least one field must be specified. +**3)** the `geolocation_object` structure. The condition is fulfilled only when all of the specified fields match. At least one field must be specified. | Parameter | Required | Data type | Example | | -------------- | -------- | --------- | --------------- | @@ -1044,9 +1044,9 @@ Deletes an existing `auto access` data structure specified by its ID. | Required scopes | `access_rules:rw` | | [Batch support](#batch-requests) | No | -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | -------------- | -| `id` | Yes | `string` | Auto access ID | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------------- | +| `id` | Yes | `string` | The auto access ID. | #### Response @@ -1090,31 +1090,31 @@ Updates an existing `auto access`. Only specified fields are updated (overwritt | Required scopes | `access_rules:rw` | | [Batch support](#batch-requests) | No | -| Parameter | Required | Data type | Notes | -| ---------------------------------------- | -------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | ID of the auto access to modify | -| `access` | No | `object` | Destination access | -| `access.groups` | Yes | `[]int` | Destination groups | -| `conditions`**1** | No | `object` | Conditions to check | -| `conditions.url` | No | `object` | The condition that matches on `customer_page.url` from **Login** or `url` from **Update Customer Page** | -| `conditions.domain` | No | `object` | The condition that matches on the domain of the `customer_url` | -| `conditions.{url,domain}.values` | No | `[]match_object`**2** | Positive match, may not be used together with `exclude_values` | -| `conditions.{url,domain}.exclude_values` | No | `[]match_object` | Negative match | -| `conditions.geolocation` | No | `object` | The condition that matches on the customer's geolocation | -| `conditions.geolocation.values` | Yes | `[]geolocation_object`**3** | An array of objects; matches when at least one subcondition matches. | -| `description` | No | `string` | Description of the auto access | -| `next_id`**4** | No | `string` | ID of an existing auto access. If `next_id` is an empty string, auto_access moves to the end of the list. | +| Parameter | Required | Data type | Notes | +| ---------------------------------------- | -------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `id` | Yes | `string` | The ID of the auto access to modify. | +| `access` | No | `object` | The destination access. | +| `access.groups` | Yes | `[]int` | The destination groups. | +| `conditions`**1** | No | `object` | The conditions to check. | +| `conditions.url` | No | `object` | The condition that matches on `customer_page.url` from **Login** or `url` from **Update Customer Page**. | +| `conditions.domain` | No | `object` | The condition that matches on the domain of the `customer_url`. | +| `conditions.{url,domain}.values` | No | `[]match_object`**2** | The positive match. May not be used together with `exclude_values`. | +| `conditions.{url,domain}.exclude_values` | No | `[]match_object` | The negative match. | +| `conditions.geolocation` | No | `object` | The condition that matches on the customer's geolocation. | +| `conditions.geolocation.values` | Yes | `[]geolocation_object`**3** | An array of objects. Matches when at least one subcondition matches. | +| `description` | No | `string` | The description of the auto access. | +| `next_id`**4** | No | `string` | The ID of an existing auto access. If `next_id` is an empty string, auto_access moves to the end of the list. | **1)** `conditions` must have at least one of `url`, `domain`, `geolocation` set. **2)** `` structure: -| Parameter | Required | Data type | Notes | -| ------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------- | -| `value` | Yes | `string` | A value to match | -| `exact_match` | No | `bool` | If set to `false`, a `match_object.value` will be matched as a substring of the customer URL or domain; default: false. | +| Parameter | Required | Data type | Notes | +| ------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------- | +| `value` | Yes | `string` | A value to match. | +| `exact_match` | No | `bool` | If set to `false`: a `match_object.value` will be matched as a substring of the customer URL or domain. Default: `false`. | -**3)** the `geolocation_object` structure. The condition is fulfilled only when all of the specified fields match. At least one field must be specified. +**3)** the `geolocation_object` structure. The condition is fulfilled only when all of the specified fields match. At least one field must be specified. | Parameter | Required | Data type | Example | | -------------- | -------- | --------- | --------------- | @@ -1200,15 +1200,15 @@ Bots based on templates will work in the same way as those created by the [Creat #### Request -| Parameter | Required | Data type | Notes | -| ---------------------------------------- | -------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | Yes | `string` | Display name | -| `avatar` | No | `string` | Avatar URL | -| `max_chats_count` | No | `int` | Max. number of incoming chats that can be routed to the bot; default: 6. Limited to 500. | -| `default_group_priority`**1** | No | `string` | The default routing priority for a group without defined priority. | -| `job_title` | No | `string` | Bot's job title | -| `owner_client_id` | Yes | `string` | **Client Id** that will own the bot template; must be owned by your organization. | -| `affect_existing_installations` | No | `bool` | If set to `true`, a bot based on this template will be created on all licenses that have given application installed. Otherwise only new installations will trigger bot creation. | +| Parameter | Required | Data type | Notes | +| ---------------------------------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `name` | Yes | `string` | The display name. | +| `avatar` | No | `string` | The avatar URL. | +| `max_chats_count` | No | `int` | The maximum number of incoming chats that can be routed to the bot. Maximum: 500. Default: 6. | +| `default_group_priority`**1** | No | `string` | The default routing priority for a group without defined priority. | +| `job_title` | No | `string` | The bot's job title. | +| `owner_client_id` | Yes | `string` | The **Client Id** that will own the bot template. Must be owned by your organization. | +| `affect_existing_installations` | No | `bool` | If set to `true`: a bot based on this template will be created on all licenses that have given application installed. If set to `false`: only new installations will trigger bot creation. | **1)** Possible priority values: @@ -1263,16 +1263,16 @@ Creates a new bot. To make the bot available for receiving chats or webhooks, us | Parameter | Required | Data type | Notes | | ---------------------------------------- | -------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | Yes | `string` | Display name | -| `avatar` | No | `string` | Avatar URL | -| `max_chats_count` | No | `int` | Max. number of incoming chats that can be routed to the bot; default: 6. Limited to 500. | +| `name` | Yes | `string` | The display name. | +| `avatar` | No | `string` | The avatar URL. | +| `max_chats_count` | No | `int` | The maximum number of incoming chats that can be routed to the bot. Maximum: 500. Default: 6. | | `default_group_priority`**1** | No | `string` | The default routing priority for a group without defined priority. | -| `job_title` | No | `string` | Bot's job title | -| `groups` | No | `object[]` | Groups the bot belongs to. | -| `groups[].id` | No | `int` | Group ID; required only when `group`'s included. | -| `groups[].priority`**1** | Yes | `string` | Bot's priority in a group; required only when `group`'s included. | -| `type` | No | `string` | A custom value to categorize or identify the bot. Defaults to `chatbot`. | -| `work_scheduler` | No | `object` | Work scheduler options to set for the new bot. See [**Create Agent**](#create-agent) for details. | +| `job_title` | No | `string` | The bot's job title. | +| `groups` | No | `object[]` | The groups the bot belongs to. | +| `groups[].id` | No | `int` | The group ID. Required only when `group`'s included. | +| `groups[].priority`**1** | Yes | `string` | The bot's priority in a group. Required only when `group`'s included. | +| `type` | No | `string` | A custom value to categorize or identify the bot. Default: `chatbot`. | +| `work_scheduler` | No | `object` | The work scheduler options to set for the new bot. See [**Create Agent**](#create-agent) for details. | | `work_scheduler.timezone` | Yes | `string` | The time zone in which the bot's work scheduler should operate. | | `owner_client_id`**2** | Yes | `string` | Required only when authorizing via [PATs](/authorization/agent-authorization#personal-access-tokens). When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. | @@ -1331,9 +1331,9 @@ Deletes a bot template specified by `id`. The bots associated with the template | Parameter | Required | Type | Notes | | ------------------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | Bot Template ID | -| `owner_client_id` | Yes | `string` | **Client Id** that owns the bot template; must be owned by your organization. | -| `affect_existing_installations` | No | `bool` | If set to `true`, a bot based on this template will be deleted from all licenses that have given application installed. | +| `id` | Yes | `string` | The Bot Template ID. | +| `owner_client_id` | Yes | `string` | The **Client Id** that owns the bot template. Must be owned by your organization. | +| `affect_existing_installations` | No | `bool` | If set to `true`: a bot based on this template will be deleted from all licenses that have given application installed. | #### Response @@ -1379,9 +1379,9 @@ Deletes a bot specified by `id`. #### Request -| Parameter | Required | Type | Notes | -| --------- | -------- | -------- | ------ | -| `id` | Yes | `string` | Bot ID | +| Parameter | Required | Type | Notes | +| --------- | -------- | -------- | ----------- | +| `id` | Yes | `string` | The bot ID. | #### Response @@ -1429,14 +1429,14 @@ Updates an existing bot template. | Parameter | Required | Data type | Notes | | ---------------------------------------- | -------- | --------- | -------------------------------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | Bot Template ID | -| `name` | No | `string` | Display name | -| `avatar` | No | `string` | Avatar URL | -| `max_chats_count` | No | `int` | Maximum incoming chats that can be routed to the bot. Limited to 500. | +| `id` | Yes | `string` | The bot template ID. | +| `name` | No | `string` | The display name. | +| `avatar` | No | `string` | The avatar URL. | +| `max_chats_count` | No | `int` | The maximum incoming chats that can be routed to the bot. Maximum: 500. | | `default_group_priority`**1** | No | `string` | The default routing priority for a group without defined priority. | -| `job_title` | No | `string` | Bot's job title | -| `owner_client_id` | Yes | `string` | **Client Id** that owns the bot template; must be owned by your organization. | -| `affect_existing_installations` | No | `bool` | If set to `true`, bots based on this template will be updated on all licenses that have given application installed. | +| `job_title` | No | `string` | The bot's job title. | +| `owner_client_id` | Yes | `string` | The **Client Id** that owns the bot template. Must be owned by your organization. | +| `affect_existing_installations` | No | `bool` | If set to `true`: bots based on this template will be updated on all licenses that have given application installed. | **1)** Possible priority values: @@ -1492,20 +1492,20 @@ Updates an existing bot. #### Request -| Parameter | Required | Data type | Notes | -| ---------------------------------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | Bot ID | -| `name` | No | `string` | Display name | -| `avatar` | No | `string` | Avatar URL | -| `max_chats_count` | No | `int` | Maximum incoming chats that can be routed to the bot. Limited to 500. | -| `groups` | No | `object[]` | Groups the bot belongs to | -| `groups[].id` | Yes | `uint` | Group ID, required only when `groups`'s present. | -| `groups[].priority`**1** | Yes | `string` | Bot's priority in the group; required only when `groups` is included. | -| `default_group_priority`**1** | No | `string` | The default routing priority for a group without defined priority. | -| `job_title` | No | `string` | Bot's job title | -| `type` | No | `string` | A custom value to categorize or identify the bot. | -| `work_scheduler` | No | `object` | Work scheduler options to set for the new bot. See [**Create Agent**](#create-agent) for details. | -| `work_scheduler.timezone` | Yes | `string` | The time zone in which the bot's work scheduler should operate. | +| Parameter | Required | Data type | Notes | +| ---------------------------------------- | -------- | ---------- | ----------------------------------------------------------------------------------------------------- | +| `id` | Yes | `string` | The bot ID. | +| `name` | No | `string` | The display name. | +| `avatar` | No | `string` | The avatar URL. | +| `max_chats_count` | No | `int` | The maximum incoming chats that can be routed to the bot. Maximum: 500. | +| `groups` | No | `object[]` | The groups the bot belongs to | +| `groups[].id` | Yes | `uint` | The group ID. Required only when `groups`'s present. | +| `groups[].priority`**1** | Yes | `string` | The bot's priority in the group. Required only when `groups` is included. | +| `default_group_priority`**1** | No | `string` | The default routing priority for a group without defined priority. | +| `job_title` | No | `string` | The bot's job title. | +| `type` | No | `string` | A custom value to categorize or identify the bot. | +| `work_scheduler` | No | `object` | The work scheduler options to set for the new bot. See [**Create Agent**](#create-agent) for details. | +| `work_scheduler.timezone` | Yes | `string` | The time zone in which the bot's work scheduler should operate. | **1)** Possible priority values: @@ -1561,9 +1561,9 @@ Returns the list of bot templates created for a Client ID (application). #### Request -| Parameter | Required | Type | Notes | -| ----------------- | -------- | -------- | -------------------------------------------------------------------------------------- | -| `owner_client_id` | Yes | `string` | **Client Id** that owns the bot templates to list; must be owned by your organization. | +| Parameter | Required | Type | Notes | +| ----------------- | -------- | -------- | ------------------------------------------------------------------------------------------ | +| `owner_client_id` | Yes | `string` | The **Client Id** that owns the bot templates to list. Must be owned by your organization. | @@ -1605,10 +1605,10 @@ Returns the list of bots created within a license. The method behavior differs d #### Request -| Parameter | Required | Type | Notes | -| ------------------------ | -------- | ---------- | --------------------------------------------------------------------------------------------------------------------- | -| `all` | No | `bool` | `true` - gets all Bots within a license.  `false` (default)**1** - returns only the requester's Bots. | -| `fields`**2** | No | `string[]` | Additional Bot fields to include | +| Parameter | Required | Type | Notes | +| ------------------------ | -------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------- | +| `all` | No | `bool` | If set to `true`: gets all bots within a license. If set to `false` (default)**1**: returns only the requester's bots. | +| `fields`**2** | No | `string[]` | The additional Bot fields to include. | **1)** Calling List Bots with `all:false` @@ -1617,13 +1617,13 @@ Returns the list of bots created within a license. The method behavior differs d **2)** Possible values for the `fields[]` parameter: -| Possible value | Notes | -| ----------------- | ----------------------------------------------------------------------------------- | -| `groups` | Groups a bot belongs to | -| `work_scheduler` | Work scheduler object for a bot. See [**Create Agent**](#create-agent) for details. | -| `job_title` | Bot's job title | -| `max_chats_count` | Bot's maximum number of concurrent chats | -| `timezone` | The time zone in which the bot's work scheduler operates | +| Possible value | Notes | +| ----------------- | --------------------------------------------------------------------------------------- | +| `groups` | The groups a bot belongs to. | +| `work_scheduler` | The work scheduler object for a bot. See [**Create Agent**](#create-agent) for details. | +| `job_title` | The bot's job title. | +| `max_chats_count` | The bot's maximum number of concurrent chats. | +| `timezone` | The time zone in which the bot's work scheduler operates. | @@ -1667,20 +1667,20 @@ It returns the info about a bot with a given `id`. #### Request -| Parameter | Required | Type | Notes | -| ------------------------ | ---------- | -------- | ----------------------------- | -| `id` | Yes | `string` | Bot ID | -| `fields`**1** | `string[]` | No | Additional fields to include. | +| Parameter | Required | Type | Notes | +| ------------------------ | ---------- | -------- | --------------------------------- | +| `id` | Yes | `string` | The Bot ID. | +| `fields`**1** | `string[]` | No | The additional fields to include. | **1)** Possible values for the `fields[]` parameter: -| Possible value | Notes | -| ----------------- | ----------------------------------------------------------------------------------- | -| `work_scheduler` | Work scheduler object for a bot. See [**Create Agent**](#create-agent) for details. | -| `groups` | Groups a bot belongs to | -| `job_title` | Bot's job title | -| `max_chats_count` | Bot's maximum number of concurrent chats | -| `timezone` | The time zone in which the bot's work scheduler operates | +| Possible value | Notes | +| ----------------- | --------------------------------------------------------------------------------------- | +| `groups` | The groups a bot belongs to. | +| `work_scheduler` | The work scheduler object for a bot. See [**Create Agent**](#create-agent) for details. | +| `job_title` | The bot's job title. | +| `max_chats_count` | The bot's maximum number of concurrent chats. | +| `timezone` | The time zone in which the bot's work scheduler operates. | @@ -1729,12 +1729,12 @@ If you lost the secret, you can reset it using [Reset Bot Template Secret](#rese #### Request -| Parameter | Required | Type | Notes | -| ----------------- | -------- | -------- | --------------- | -| `bot_id` | Yes | `string` | Bot ID | -| `client_id` | Yes | `string` | Client ID | -| `bot_secret` | Yes | `string` | Bot secret | -| `organization_id` | Yes | `string` | Organization ID | +| Parameter | Required | Type | Notes | +| ----------------- | -------- | -------- | -------------------- | +| `bot_id` | Yes | `string` | The bot ID. | +| `client_id` | Yes | `string` | The client ID. | +| `bot_secret` | Yes | `string` | The bot secret. | +| `organization_id` | Yes | `string` | The organization ID. | @@ -1783,9 +1783,9 @@ Resets secret for given bot template. | Parameter | Required | Type | Notes | | ------------------------------- | -------- | -------- | ---------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | Bot template ID | -| `owner_client_id` | Yes | `string` | **Client Id** that owns the bot template; must be owned by your organization. | -| `affect_existing_installations` | No | `bool` | If set to `true`, the new secret is set to for all existing bots based on this template. | +| `id` | Yes | `string` | The bot template ID. | +| `owner_client_id` | Yes | `string` | The **Client Id** that owns the bot template. Must be owned by your organization. | +| `affect_existing_installations` | No | `bool` | If set to `true`: the new secret is set to for all existing bots based on this template. | @@ -1831,7 +1831,7 @@ Resets secret for a given bot. | Parameter | Required | Type | Notes | | ----------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | Bot ID | +| `id` | Yes | `string` | The bot ID. | | `owner_client_id` | Yes | `string` | Required only when authorizing via [PATs](/authorization/agent-authorization#personal-access-tokens). When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. | @@ -1932,10 +1932,10 @@ Lifts a ban from a customer. #### Request -| Parameter | Data type | Required | Notes | -| ------------- | --------- | -------- | ------------------------------- | -| `ip` | `string` | Yes* | Group name (up to 180 chars) | -| `customer_id` | `string` | Yes* | The code of the group languange | +| Parameter | Data type | Required | Notes | +| ------------- | --------- | -------- | ---------------------------------------- | +| `ip` | `string` | Yes* | The group name. Maximum: 180 characters. | +| `customer_id` | `string` | Yes* | The code of the group languange. | **1)** Exactly one of `ip` and `customer_id` is required. @@ -1995,42 +1995,42 @@ Creates a new greeting. #### Request -| Parameter | Required | Data type | Notes | -| ----------------------------------------- | -------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | Yes | `string` | Greeting type, one of: `normal` (standard greeting type) or `announcement` (announcement-style greeting) | -| `active` | Yes | `bool` | Greeting status | -| `active_from` | No | `string` | RFC 3339 date-time format; when the greeting becomes active | -| `active_until` | No | `string` | RFC 3339 date-time format; when the greeting stops being active | -| `name` | Yes | `string` | Greeting name | -| `group` | Yes | `int` | Group ID the greeting belongs to | -| `rules` | Yes | `object[]` | Array of action rules that define when the greeting should be triggered; accepts up to 10 rules | -| `rules[].condition` | Yes | `string` | Logical condition for the rule; `and` (match all conditions), or `or` (match one of the conditions) | -| `rules[].type`**1** | Yes | `string` | Type of the rule condition | -| `rules[].operator`**2** | Yes | `string` | Comparison operator for the rule. Not required for `url_funnel`**1**, `custom_variable`**1**, and `ads_traffic`**1** | -| `rules[].value` | No | `string` | Value to compare against, based on the selected `operator`**2**; required for most rule types | -| `rules[].urls` | No | `object[]` | Array of URLs; required only for the `url_funnel`**1** type; accepts up to 10 objects | -| `rules[].urls[].url` | No | `string` | URL for the `url_funnel`**1** rule; required when `urls` array is used | -| `rules[].urls[].operator`**2** | No | `string` | Operator for the URL comparison; required when `urls` array is used | -| `rules[].session_field` | No | `object` | Key-value pairs; required for `custom_variable`**1** and `ads_traffic`**1** types - exactly one element | -| `properties`**3** | No | `object` | Additional properties for the greeting as key-value pairs | -| `rich_message`**4** | No | `object` | Rich message content of the greeting | +| Parameter | Required | Data type | Notes | +| ----------------------------------------- | -------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | Yes | `string` | The greeting type. Possible values: `normal` (standard greeting type) or `announcement` (announcement-style greeting). | +| `active` | Yes | `bool` | The greeting status. | +| `active_from` | No | `string` | The RFC 3339 date-time format indicating when the greeting becomes active. | +| `active_until` | No | `string` | The RFC 3339 date-time format indicating when the greeting stops being active. | +| `name` | Yes | `string` | The greeting name. | +| `group` | Yes | `int` | The group ID the greeting belongs to. | +| `rules` | Yes | `object[]` | An array of action rules that define when the greeting should be triggered. Maximum: 10 rules. | +| `rules[].condition` | Yes | `string` | The logical condition for the rule. Possible values: `and` (match all conditions), or `or` (match one of the conditions). | +| `rules[].type`**1** | Yes | `string` | The type of the rule condition. | +| `rules[].operator`**2** | Yes | `string` | The comparison operator for the rule. Not required for `url_funnel`**1**, `custom_variable`**1**, and `ads_traffic`**1**. | +| `rules[].value` | No | `string` | The value to compare against, based on the selected `operator`**2**. Required for most rule types. | +| `rules[].urls` | No | `object[]` | An array of URLs. Required only for the `url_funnel`**1** type. Maximum: 10 objects. | +| `rules[].urls[].url` | No | `string` | The URL for the `url_funnel`**1** rule. Required when `urls` array is used. | +| `rules[].urls[].operator`**2** | No | `string` | The operator for the URL comparison. Required when `urls` array is used. | +| `rules[].session_field` | No | `object` | Key-value pairs. Required for `custom_variable`**1** and `ads_traffic`**1** types - exactly one element. | +| `properties`**3** | No | `object` | The additional properties for the greeting as key-value pairs. | +| `rich_message`**4** | No | `object` | The rich message content of the greeting. | **1)** Parameter requirements for each `rules[].type` value: -| Type value | Required Parameters | Parameter Details | -| ------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- | -| `visit_time_site` | `value`, `operator` | `value` must be integer 0-900 (seconds spent on the entire website) | -| `visit_time_page` | `value`, `operator` | `value` must be integer 0-900 (seconds spent on the current page) | -| `url_current` | `value`, `operator` | `value` contains current page URL to match | -| `url_visited` | `value`, `operator` | `value` contains previously visited URL to match | -| `url_funnel` | `urls` | `urls` array with 1-10 URL objects, each with `url` and `operator` | -| `pages_view_number` | `value`, `operator` | `value` contains number of pages viewed to compare | -| `url_referrer` | `value`, `operator` | `value` contains referrer URL to match | -| `geolocation` | `value`, `operator` | `value` contains geographic location to match | -| `visits_number` | `value`, `operator` | `value` contains number of visits to compare | -| `search_keyword` | `value`, `operator` | `value` contains search keyword to match | -| `custom_variable` | `session_field` | `session_field` object with exactly one key-value pair (max 255 characters each) | -| `ads_traffic` | `session_field` | `session_field` with one key from: `microsoft`, `facebook`, `google`, `twitter`, `yahoo` (value max 255 chars) | +| Type value | Required Parameters | Parameter Details | +| ------------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `visit_time_site` | `value`, `operator` | The `value` must be an integer between 0 and 900 (seconds spent on the entire website). | +| `visit_time_page` | `value`, `operator` | The `value` must be an integer between 0 and 900 (seconds spent on the current page). | +| `url_current` | `value`, `operator` | The `value` contains the current page URL to match. | +| `url_visited` | `value`, `operator` | The `value` contains the previously visited URL to match. | +| `url_funnel` | `urls` | The `urls` array with 1-10 URL objects, each with `url` and `operator`. | +| `pages_view_number` | `value`, `operator` | The `value` contains the number of pages viewed to compare. | +| `url_referrer` | `value`, `operator` | The `value` contains the referrer URL to match. | +| `geolocation` | `value`, `operator` | The `value` contains the geographic location to match. | +| `visits_number` | `value`, `operator` | The `value` contains the number of visits to compare. | +| `search_keyword` | `value`, `operator` | The `value` contains the search keyword to match. | +| `custom_variable` | `session_field` | The `session_field` object with exactly one key-value pair. Maximum: 255 characters each. | +| `ads_traffic` | `session_field` | The `session_field` with one key from: `microsoft`, `facebook`, `google`, `twitter`, `yahoo`. Value maximum: 255 characters. | **2)** Possible values for the `rules[].operator` and `rules[].urls[].operator` parameters: @@ -2045,38 +2045,38 @@ Creates a new greeting. **3)** Possible values for the `properties` object keys: -| Possible value | Notes | -| ----------------------------- | ------------------------------ | -| `addon` | Addon-related property | -| `is_exit_intent` | Exit intent detection flag | -| `greeting-message_text` | Plain text message content | -| `greeting-message_json_key` | JSON key for message content | -| `greeting-message_phrase_key` | Phrase key for message content | +| Possible value | Notes | +| ----------------------------- | ----------------------------------- | +| `addon` | The addon-related property. | +| `is_exit_intent` | The exit intent detection flag. | +| `greeting-message_text` | The plain text message content. | +| `greeting-message_json_key` | The JSON key for message content. | +| `greeting-message_phrase_key` | The phrase key for message content. | **4)** The `rich_message` object structure: | Parameter | Required | Data type | Notes | | ----------------------------------- | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `template_id` | yes | `string` | Defines how every rich message will be presented; possible values: `cards`, `sticker`, or `quick_replies` | -| `elements` | no | `array` | Can contain up to 10 `element` objects | -| `elements[].title` | yes | `string` | Displays formatted text on rich messages | -| `elements[].subtitle` | yes | `string` | Displays formatted text on rich messages | -| `elements[].image` | yes | `object` | Displays images on rich messages. Required param: `url`; Optional params: `name`, `content_type`, `size`, `width`, `height`, `alternative_text`. | -| `elements[].image.url` | yes | `string` | Image URL | -| `elements[].image.alternative_text` | no | `string` | Alternative text for the image | -| `elements[].buttons` | no | `array` | Displays up to 13 `button` objects | -| `elements[].buttons[].text` | yes | `string` | Button text | +| `template_id` | yes | `string` | Defines how every rich message will be presented. Possible values: `cards`, `sticker`, or `quick_replies`. | +| `elements` | no | `array` | Can contain up to 10 `element` objects. | +| `elements[].title` | yes | `string` | Displays formatted text on rich messages. | +| `elements[].subtitle` | yes | `string` | Displays formatted text on rich messages. | +| `elements[].image` | yes | `object` | Displays images on rich messages. Required param: `url`. Optional params: `name`, `content_type`, `size`, `width`, `height`, `alternative_text`. | +| `elements[].image.url` | yes | `string` | The image URL. | +| `elements[].image.alternative_text` | no | `string` | The alternative text for the image. | +| `elements[].buttons` | no | `array` | Displays up to 13 `button` objects. | +| `elements[].buttons[].text` | yes | `string` | The button text. | | `elements[].buttons[].type` | yes | `string` | Defines the behavior after a user clicks the button. Should be used together with `elements.buttons.value`. Possible values: `webview`, `message`, `url`, `phone`. [Read more about rich messages.](/extending-chat-widget/rich-messages/#getting-started) | | `elements[].buttons[].value` | yes | `string` | Should be used together with `elements.buttons.type`. You can use this field to give the rich message of a `webview` type (a Moment) a custom title. [Read more about Moments.](/extending-chat-widget/chat-widget-moments/#how-to-start) | | `elements[].buttons[].postback_id` | yes | `string` | A unique identifier for this button, sent in postback events. | | `elements[].buttons[].button_id` | no | `string` | A button identifier, automatically generated if not provided. | -| `elements[].buttons[].role` | no | `string` | Button role, one of: `default`, `primary`, or `danger` | +| `elements[].buttons[].role` | no | `string` | The button role. Possible values: `default`, `primary`, or `danger`. | #### Response -| Field | Data type | Notes | -| ----- | --------- | -------------------------------- | -| `id` | `int` | ID of the newly created greeting | +| Field | Data type | Notes | +| ----- | --------- | ------------------------------------- | +| `id` | `int` | The ID of the newly created greeting. | @@ -2152,18 +2152,18 @@ Updates the properties of a greeting. #### Request -| Parameter | Required | Data type | Notes | -| --------------------------------------------- | -------- | ---------- | ---------------------------------------------------------------------------------------------------- | -| `id` | Yes | `int` | ID of the greeting to update | -| `type` | No | `string` | Greeting type | -| `active` | No | `bool` | Greeting status | -| `active_from` | No | `string` | RFC 3339 date-time format; when the greeting becomes active | -| `active_until` | No | `string` | RFC 3339 date-time format; when the greeting stops being active | -| `name` | No | `string` | Greeting name | -| `rules` | No | `object[]` | Array of action rules; see [Create Greeting](#create-greeting) for detailed structure and validation | -| `properties` | No | `object` | Additional properties; see [Create Greeting](#create-greeting) for allowed keys | -| `rich_message` | No | `object` | Rich message content; see [Create Greeting](#create-greeting) for complete structure | -| `rich_message.elements[].buttons[].button_id` | No | `string` | Pass the existing ID if you want to preserve it | +| Parameter | Required | Data type | Notes | +| --------------------------------------------- | -------- | ---------- | -------------------------------------------------------------------------------------------------------- | +| `id` | Yes | `int` | The ID of the greeting to update. | +| `type` | No | `string` | The greeting type. | +| `active` | No | `bool` | The greeting status. | +| `active_from` | No | `string` | The RFC 3339 date-time format indicating when the greeting becomes active. | +| `active_until` | No | `string` | The RFC 3339 date-time format indicating when the greeting stops being active. | +| `name` | No | `string` | The greeting name. | +| `rules` | No | `object[]` | An array of action rules. See [Create Greeting](#create-greeting) for detailed structure and validation. | +| `properties` | No | `object` | The additional properties. See [Create Greeting](#create-greeting) for allowed keys. | +| `rich_message` | No | `object` | The rich message content. See [Create Greeting](#create-greeting) for complete structure. | +| `rich_message.elements[].buttons[].button_id` | No | `string` | Pass the existing ID if you want to preserve it. | #### Response @@ -2232,9 +2232,9 @@ Deletes a greeting. #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | ---------------------------- | -| `id` | Yes | `int` | ID of the greeting to delete | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | --------------------------------- | +| `id` | Yes | `int` | The ID of the greeting to delete. | #### Response @@ -2280,19 +2280,19 @@ Returns a list of greetings. #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `groups` | No | `array` | Array of group IDs to filter greetings; defaults to all accesible groups. Cannot be used with `page_id`. | -| `page_id` | No | `string` | Page ID for pagination. When provided, `groups` and `limit` parameters are ignored as they're encoded in the page ID. Cannot be used with `groups` or `limit`. | -| `limit` | No | `int` | Number of greetings per page; default: 100. Limited to 100. Cannot be used with `page_id`. | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `groups` | No | `array` | An array of group IDs to filter greetings. Defaults to all accessible groups. Cannot be used with `page_id`. | +| `page_id` | No | `string` | The page ID for pagination. When provided, `groups` and `limit` parameters are ignored as they're encoded in the page ID. Cannot be used with `groups` or `limit`. | +| `limit` | No | `int` | The number of greetings per page. Default: 100. Maximum: 100. Cannot be used with `page_id`. | #### Response -| Field | Data type | Notes | -| ----------------- | --------- | ---------------------------------------------------------------------------------- | -| `greetings` | `array` | Array of greeting objects | -| `found_greetings` | `int` | The total number of greetings. | -| `next_page_id` | `string` | Page ID for the next page of results; returned only if more results are available. | +| Field | Data type | Notes | +| ----------------- | --------- | -------------------------------------------------------------------------------------- | +| `greetings` | `array` | An array of greeting objects. | +| `found_greetings` | `int` | The total number of greetings. | +| `next_page_id` | `string` | The page ID for the next page of results. Returned only if more results are available. | @@ -2337,24 +2337,24 @@ Returns the details of a specific greeting. #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | ------------------------- | -| `id` | Yes | `int` | ID of the greeting to get | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------------------------ | +| `id` | Yes | `int` | The ID of the greeting to get. | #### Response -| Field | Data type | Notes | -| -------------- | --------- | -------------------------------------------------------------------------- | -| `id` | `int` | Greeting ID | -| `type` | `string` | Greeting type | -| `active` | `boolean` | Greeting status | -| `active_from` | `string` | ISO 8601 datetime when the greeting becomes active (if set) | -| `active_until` | `string` | ISO 8601 datetime when the greeting stops being active (if set) | -| `name` | `string` | Greeting name | -| `group` | `int` | ID of the group the greeting is assigned to | -| `rules` | `array` | Array of rule objects, see [Create Greeting](#create-greeting) for details | -| `properties` | `object` | Additional properties, see [Create Greeting](#create-greeting) for details | -| `rich_message` | `object` | Rich message content, see [Create Greeting](#create-greeting) for details | +| Field | Data type | Notes | +| -------------- | --------- | ------------------------------------------------------------------------------- | +| `id` | `int` | The greeting ID. | +| `type` | `string` | The greeting type. | +| `active` | `boolean` | The greeting status. | +| `active_from` | `string` | The ISO 8601 datetime when the greeting becomes active (if set). | +| `active_until` | `string` | The ISO 8601 datetime when the greeting stops being active (if set). | +| `name` | `string` | The greeting name. | +| `group` | `int` | The ID of the group the greeting is assigned to. | +| `rules` | `array` | An array of rule objects. See [Create Greeting](#create-greeting) for details. | +| `properties` | `object` | The additional properties. See [Create Greeting](#create-greeting) for details. | +| `rich_message` | `object` | The rich message content. See [Create Greeting](#create-greeting) for details. | @@ -2412,11 +2412,11 @@ Creates a new group. #### Request -| Parameter | Data type | Required | Notes | -| ---------------------------------- | --------- | -------- | ---------------------------------------------------------------------------- | -| `name` | `string` | Yes | Group name (up to 180 chars) | -| `language_code` | `string` | No | The code of the group languange | -| `agent_priorities`**1** | `object` | Yes | Agents' priorities in a group as a map in the `"": ""` format. | +| Parameter | Data type | Required | Notes | +| ---------------------------------- | --------- | -------- | -------------------------------------------------------------------------------- | +| `name` | `string` | Yes | The group name. Maximum: 180 characters. | +| `language_code` | `string` | No | The code of the group language. | +| `agent_priorities`**1** | `object` | Yes | The agents' priorities in a group as a map in the `"": ""` format. | **1)** The table below presents the possible values for the `agent_priorities` map: @@ -2474,12 +2474,12 @@ Updates an existing group. #### Request -| Parameter | Data type | Required | Notes | -| ---------------------------------- | --------- | -------- | ---------------------------------------------------------------------------- | -| `id` | `int` | Yes | Group ID | -| `name` | `string` | No | Group name (up to 180 chars) | -| `language_code` | `string` | No | The code of the group languange | -| `agent_priorities`**1** | `object` | No | Agents' priorities in a group as a map in the `"": ""` format. | +| Parameter | Data type | Required | Notes | +| ---------------------------------- | --------- | -------- | -------------------------------------------------------------------------------- | +| `id` | `int` | Yes | The group ID. | +| `name` | `string` | No | The group name. Maximum: 180 characters. | +| `language_code` | `string` | No | The code of the group language. | +| `agent_priorities`**1** | `object` | No | The agents' priorities in a group as a map in the `"": ""` format. | **1)** The table below presents the possible values for the `agent_priorities` map: @@ -2540,9 +2540,9 @@ Deletes an existing group. #### Request -| Parameter | Data type | Required | Notes | -| --------- | --------- | -------- | -------- | -| `id` | `int` | Yes | Group ID | +| Parameter | Data type | Required | Notes | +| --------- | --------- | -------- | ------------- | +| `id` | `int` | Yes | The group ID. | #### Response @@ -2576,7 +2576,7 @@ curl -X POST \ ### List Groups -Lists all the exisiting groups. +Lists all the existing groups. #### Specifics @@ -2588,9 +2588,9 @@ Lists all the exisiting groups. #### Request -| Parameter | Data type | Required | Notes | -| ------------------------ | ---------- | -------- | ----------------------------- | -| `fields`**1** | `string[]` | No | Additional fields to include. | +| Parameter | Data type | Required | Notes | +| ------------------------ | ---------- | -------- | --------------------------------- | +| `fields`**1** | `string[]` | No | The additional fields to include. | **1)** Possible values for the `fields[]` parameter: @@ -2639,10 +2639,10 @@ Returns details about a group specified by its `id`. #### Request -| Parameter | Data type | Required | Notes | -| ------------------------ | ---------- | -------- | ----------------------------- | -| `id` | `int` | Yes | Group ID | -| `fields`**1** | `string[]` | No | Additional fields to include. | +| Parameter | Data type | Required | Notes | +| ------------------------ | ---------- | -------- | --------------------------------- | +| `id` | `int` | Yes | The group ID. | +| `fields`**1** | `string[]` | No | The additional fields to include. | **1)** Possible values for the `fields[]` parameter: @@ -2840,20 +2840,20 @@ Registers a new private property for a given **Client Id**. #### Request -| Parameter | Required | Data type | Notes | -| -------------------------------- | ------------------- | ---------- | ------------------------------------------------------------------------------------ | -| `name` | Yes | `string` | Property name | -| `owner_client_id` | Yes | `string` | **Client Id** that will own the property; must be owned by your organization. | -| `type` | Yes | `string` | Possible values: `int`, `string`, `bool`, and `tokenized_string` | -| `access` | Yes | `object` | | -| `access.` | min. one `location` | `object` | Possible values: `chat`, `thread`, `event`, `license`, `group` | -| `access..` | min. one `user` | `[string]` | Possible `` values: `agent`, `customer`; possible values: `read`, `write` | -| `description` | No | `string` | Property description | -| `domain` **1** | No | `[]` | Array of values that properties can be set to | -| `range` **1** | No | `object` | Range of values that properties can be set to | -| `range.from` | No | `int` | Only values **equal** or **greater** than this parameter can be set to this property | -| `range.to` | No | `int` | Only values **equal** or **lower** than this parameter can be set to this property | -| `default_value` **2** | No | `type` | Default value of property; validated by **domain** or **range**, if one exists | +| Parameter | Required | Data type | Notes | +| -------------------------------- | ------------------- | ---------- | ---------------------------------------------------------------------------------------- | +| `name` | Yes | `string` | The property name. | +| `owner_client_id` | Yes | `string` | The **Client Id** that will own the property. Must be owned by your organization. | +| `type` | Yes | `string` | Possible values: `int`, `string`, `bool`, and `tokenized_string`. | +| `access` | Yes | `object` | | +| `access.` | min. one `location` | `object` | Possible values: `chat`, `thread`, `event`, `license`, `group`. | +| `access..` | min. one `user` | `[string]` | Possible `` values: `agent`, `customer`. Possible values: `read`, `write`. | +| `description` | No | `string` | The property description. | +| `domain` **1** | No | `[]` | An array of values that properties can be set to. | +| `range` **1** | No | `object` | A range of values that properties can be set to. | +| `range.from` | No | `int` | Only values **equal to** or **greater than** this parameter can be set to this property. | +| `range.to` | No | `int` | Only values **equal to** or **lower than** this parameter can be set to this property. | +| `default_value` **2** | No | `type` | The default value of property. Validated by **domain** or **range**, if one exists. | **1)** Only one `domain` and one `range` can be set for a single property.
**2)** Registering a property with `default_value` is possible only if `access.` is set to `license` or to `group`. @@ -2915,10 +2915,10 @@ Unregisters a private property. #### Request -| Parameter | Required | Data type | Notes | -| ----------------- | -------- | --------- | ------------------------------------------------------------------------ | -| `name` | Yes | `string` | Property name | -| `owner_client_id` | Yes | `string` | **Client Id** that owns the property; must be owned by your organization | +| Parameter | Required | Data type | Notes | +| ----------------- | -------- | --------- | ----------------------------------------------------------------------------- | +| `name` | Yes | `string` | The property name. | +| `owner_client_id` | Yes | `string` | The **Client Id** that owns the property. Must be owned by your organization. | #### Response @@ -2967,8 +2967,8 @@ Publishes a private property. A published property cannot be unpublished or unre | Parameter | Required | Data type | Notes | | ----------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------------------------------- | -| `name` | Yes | `string` | Property name | -| `owner_client_id` | Yes | `string` | **Client Id** that owns the property; must be owned by your organization. | +| `name` | Yes | `string` | The property name. | +| `owner_client_id` | Yes | `string` | The **Client Id** that owns the property. Must be owned by your organization. | | `access_type` | Yes | `[string]` | Possible values: `read`, `write`. It determines the access level for the **Client Ids** different than `owner_client_id`. | #### Response @@ -3017,9 +3017,9 @@ Lists private and public properties owned by a given **Client Id**. #### Request -| Parameter | Required | Data type | Notes | -| ----------------- | -------- | --------- | --------------------------------------------------------------------------- | -| `owner_client_id` | Yes | `string` | **Client Id** that owns the properties; must be owned by your organization. | +| Parameter | Required | Data type | Notes | +| ----------------- | -------- | --------- | ------------------------------------------------------------------------------- | +| `owner_client_id` | Yes | `string` | The **Client Id** that owns the properties. Must be owned by your organization. | @@ -3133,10 +3133,10 @@ For properties without an explicit value assignment, the method will return the #### Request -| Parameter | Required | Data type | Notes | -| ------------- | -------- | --------- | ---------------------- | -| `namespace` | No | `string` | Properties namespace | -| `name_prefix` | No | `string` | Properties name prefix | +| Parameter | Required | Data type | Notes | +| ------------- | -------- | --------- | --------------------------- | +| `namespace` | No | `string` | The properties namespace. | +| `name_prefix` | No | `string` | The properties name prefix. | @@ -3243,7 +3243,7 @@ set all properties from your namespace and [public properties](#public-propertie | Parameter | Required | Data type | Notes | | ------------ | -------- | ----------------------- | ------------------------------------------------------------------------------------ | -| `group_id` | Yes | `number` | ID of the group you set the properties for. | +| `group_id` | Yes | `number` | The ID of the group you set the properties for. | | `properties` | Yes | [`object`](#properties) | An object with _namespaces_ as keys and _properties_ (grouped in objects) as values. | #### Response @@ -3303,11 +3303,11 @@ Returns the properties set within specified groups. #### Request -| Parameter | Required | Data type | Notes | -| ------------- | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------- | -| `group_ids` | Yes | `[]int` | IDs of the groups you retrieve properties from. Properties from all groups will be returned if an empty array is provided. | -| `namespace` | No | `string` | Properties namespace | -| `name_prefix` | No | `string` | Properties name prefix | +| Parameter | Required | Data type | Notes | +| ------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------ | +| `group_ids` | Yes | `[]int` | The IDs of the groups you retrieve properties from. Properties from all groups will be returned if an empty array is provided. | +| `namespace` | No | `string` | The properties namespace. | +| `name_prefix` | No | `string` | The properties name prefix. | @@ -3360,7 +3360,7 @@ delete all properties from your namespace and [public properties](#public-proper | Parameter | Required | Data type | Notes | | ------------ | -------- | ----------------------- | --------------------------------------------------------------------------------- | -| `id` | Yes | `number` | ID of the group you delete properties from. | +| `id` | Yes | `number` | The ID of the group you delete properties from. | | `properties` | Yes | [`object`](#properties) | An object with _namespaces_ as keys and _property_names_ (in an array) as values. | #### Response @@ -3529,7 +3529,7 @@ curl -X POST \ ### List Tags -Lists the exisiting tags. +Lists the existing tags. #### Specifics @@ -3541,10 +3541,10 @@ Lists the exisiting tags. #### Request -| Parameter | Required | Data type | Notes | -| ------------------- | -------- | --------- | --------------------------------------------------- | -| `filters` | No | `object` | Possible request filters. | -| `filters.group_ids` | Yes | `int[]` | IDs of the groups from which you want to list tags. | +| Parameter | Required | Data type | Notes | +| ------------------- | -------- | --------- | ------------------------------------------------------- | +| `filters` | No | `object` | The possible request filters. | +| `filters.group_ids` | Yes | `int[]` | The IDs of the groups from which you want to list tags. | @@ -3708,24 +3708,24 @@ For `bot` webhooks, you need to [create a bot](#create-bot), [register webhooks] **1)** Token scopes are assigned to an access token, not to an application (Client ID). For this method, we recommend authorizing with a [Personal Access Token (PAT)](/authorization/agent-authorization#personal-access-tokens). Make sure your PAT has the `webhooks.configuration:rw` scope. -| Parameter | Required | Data type | Notes | -| ----------------------------------------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action`**2** | yes | `string` | The [action](#triggering-actions) that triggers sending a webhook. | -| `secret_key` | yes | `string` | The secret key sent in webhooks to verify the source of a webhook. | -| `url` | yes | `string` | Destination URL for the webhook | -| `additional_data` | no | `[]string` | Additional data arriving with the webhook. Value: `chat_properties`, `chat_presence_user_ids` (all actions except for `agent_status_changed`, `agent_deleted`) | -| `description` | no | `string` | Webhook description | -| `filters` | no | `object` | Filters to check if a webhook should be triggered. | -| `filters.author_type` | no | `string` | Possible values: `customer`, `agent`; allowed only for the `incoming_event` and `event_updated` actions. | -| `filters.only_my_chats` | no | `bool` | `true` or `false`; triggers webhooks only for chats with the property `source.client_id` set to my `client_id`. | -| `filters.chat_presence` | no | `object` | Filters to check if a webhook should be triggered based on user's presence in the chat. | -| `filters.chat_presence.user_ids` | no | `object` | Only one filter (`values` or `exclude_values`) is allowed. Supports every user type (agent, customer, ). | -| `filters.chat_presence.user_ids.values` | no | `[]string` | Array of Users' ids; if any specified User is in the chat, the webhook will be triggered. | -| `filters.chat_presence.user_ids.exclude_values` | no | `[]string` | Array of Users' ids; if any specified Users is in the chat, the webhook will not be triggered. | -| `filters.chat_presence.my_bots` | no | `bool` | If any bot owned by `owner_client_id` is in the chat, the webhook will be triggered. | -| `filters.source_type` | no | `[]string` | Array of source types. Possible values: `my_client` (client ID of your app), `other_clients` (client IDs other than your app's), `system` (no client ID); if the source which triggered the webhook matches the filter, the webhook will be sent. | -| `owner_client_id` | yes | `string` | **Client Id** that will own the webhook; must be owned by your organization. | -| `type` | yes | `string` | `bot` or `license` | +| Parameter | Required | Data type | Notes | +| ----------------------------------------------- | -------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `action`**2** | yes | `string` | The [action](#triggering-actions) that triggers sending a webhook. | +| `secret_key` | yes | `string` | The secret key sent in webhooks to verify the source of a webhook. | +| `url` | yes | `string` | The destination URL for the webhook. | +| `additional_data` | no | `[]string` | The additional data arriving with the webhook. Possible values: `chat_properties`, `chat_presence_user_ids` (all actions except for `agent_status_changed`, `agent_deleted`). | +| `description` | no | `string` | The webhook description. | +| `filters` | no | `object` | The filters to check if a webhook should be triggered. | +| `filters.author_type` | no | `string` | Possible values: `customer`, `agent`. Allowed only for the `incoming_event` and `event_updated` actions. | +| `filters.only_my_chats` | no | `bool` | If set to `true`: triggers webhooks only for chats with the property `source.client_id` set to my `client_id`. | +| `filters.chat_presence` | no | `object` | The filters to check if a webhook should be triggered based on user's presence in the chat. | +| `filters.chat_presence.user_ids` | no | `object` | Only one filter (`values` or `exclude_values`) is allowed. Supports every user type (agent, customer). | +| `filters.chat_presence.user_ids.values` | no | `[]string` | An array of Users' ids. If any specified User is in the chat, the webhook will be triggered. | +| `filters.chat_presence.user_ids.exclude_values` | no | `[]string` | An array of Users' ids. If any specified Users is in the chat, the webhook will not be triggered. | +| `filters.chat_presence.my_bots` | no | `bool` | If set to `true`: if any bot owned by `owner_client_id` is in the chat, the webhook will be triggered. | +| `filters.source_type` | no | `[]string` | An array of source types. Possible values: `my_client` (client ID of your app), `other_clients` (client IDs other than your app's), `system` (no client ID). If the source which triggered the webhook matches the filter, the webhook will be sent. | +| `owner_client_id` | yes | `string` | The **Client Id** that will own the webhook. Must be owned by your organization. | +| `type` | yes | `string` | Possible values: `bot` or `license`. | #### Triggering actions @@ -3867,7 +3867,7 @@ Unregisters a webhook previously [registered](#register-webhook) for a Client ID | Parameter | Required | Data type | Notes | | ----------------- | -------- | --------- | ---------------------------------------------------------------------- | -| `id` | Yes | `string` | Webhook ID | +| `id` | Yes | `string` | The webhook ID. | | `owner_client_id` | Yes | `string` | The webhook owner (the Client ID for which the webhook is registered). | #### Response @@ -3915,9 +3915,9 @@ Lists all webhooks that are supported in a given API version. This method requir #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | ------------------------------------------ | -| `version` | No | `string` | Defaults to the current stable API version | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------------------------------------- | +| `version` | No | `string` | Defaults to the current stable API version. | @@ -4114,11 +4114,11 @@ Empty request payload. The response is an array of the channel objects: -| Field | Data type | Notes | -| -------------------------- | --------- | ------------------------------------------------------------------------------------------ | -| `channel_type` | `string` | Possible values: `code`, `direct_link` or `integration` | -| `channel_subtype` | `string` | Possible values: An empty string for `code` and `direct_link`; Client ID for `integration` | -| `first_activity_timestamp` | `string` | RFC 3339 date-time format | +| Field | Data type | Notes | +| -------------------------- | --------- | -------------------------------------------------------------------------- | +| `channel_type` | `string` | Possible values: `code`, `direct_link`, `integration`. | +| `channel_subtype` | `string` | An empty string for `code` and `direct_link`; Client ID for `integration`. | +| `first_activity_timestamp` | `string` | The timestamp in RFC 3339 date-time format. | @@ -4162,9 +4162,9 @@ Resource limits in the LiveChat product are different for each plan. This method #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | ------------------------------------------------------------------ | -| `plan` | yes | `string` | Possible values: `starter`, `team`, `enterprise`, `enterpriseplus` | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------------------------------------------------------------- | +| `plan` | yes | `string` | Possible values: `starter`, `team`, `enterprise`, `enterpriseplus`. | #### Response @@ -4270,9 +4270,9 @@ Reactivates email if it has been bounced. #### Request -| Parameter | Required | Data type | Notes | -| ---------- | -------- | --------- | -------- | -| `agent_id` | Yes | `string` | Agent ID | +| Parameter | Required | Data type | Notes | +| ---------- | -------- | --------- | ------------- | +| `agent_id` | Yes | `string` | The agent ID. | #### Response @@ -4318,24 +4318,24 @@ Updates company details of the license. #### Request -| Parameter | Required | Data type | Notes | -| --------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------- | -| `enrich` | No | `bool` | Whether the system should attempt to automatically fill empty fields by searching for company's domain. | -| `audience` | No | `string` | Audience | -| `chat_purpose` | No | `string` | Chat purpose | -| `city` | No | `string` | City | -| `company` | No | `string` | Company | -| `company_size` | No | `string` | Company size | -| `country` | No | `string` | Country | -| `invoice_email` | No | `string` | Invoice email | -| `invoice_name` | No | `string` | Invoice name | -| `nip` | No | `string` | Employer Identification Number | -| `postal_code` | No | `string` | Postal code | -| `state` | No | `string` | State | -| `street` | No | `string` | Street | -| `phone` | No | `string` | Phone | -| `province` | No | `string` | Province | -| `url` | No | `string` | URL | +| Parameter | Required | Data type | Notes | +| --------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `enrich` | No | `bool` | If set to `true`: the system will attempt to automatically fill empty fields by searching for the company's domain. If set to `false`: no enrichment is performed. | +| `audience` | No | `string` | The audience. | +| `chat_purpose` | No | `string` | The chat purpose. | +| `city` | No | `string` | The city. | +| `company` | No | `string` | The company. | +| `company_size` | No | `string` | The company size. | +| `country` | No | `string` | The country. | +| `invoice_email` | No | `string` | The invoice email. | +| `invoice_name` | No | `string` | The invoice name. | +| `nip` | No | `string` | The Employer Identification Number. | +| `postal_code` | No | `string` | The postal code. | +| `state` | No | `string` | The state. | +| `street` | No | `string` | The street. | +| `phone` | No | `string` | The phone. | +| `province` | No | `string` | The province. | +| `url` | No | `string` | The URL. | #### Response @@ -4389,4 +4389,4 @@ curl -X POST \ # Contact us -If you found a bug or a typo, you can let us know directly on GitHub. In case of any questions or feedback, don't hesitate to contact us at developers@text.com. We'll be happy to hear from you! +If you found a bug or a typo, you can let us know directly on GitHub. In case of any questions or feedback, don't hesitate to contact us at developers@text.com. We'll be happy to hear from you! \ No newline at end of file diff --git a/src/pages/management/configuration-api/v3.7/index.mdx b/src/pages/management/configuration-api/v3.7/index.mdx index 4eb1fb2bd..c9066374b 100644 --- a/src/pages/management/configuration-api/v3.7/index.mdx +++ b/src/pages/management/configuration-api/v3.7/index.mdx @@ -199,28 +199,28 @@ Creates a new agent with specified parameters within a license. #### Request -| Parameter | Data type | Required | Notes | -| ------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | `string` | Yes | Agent ID | -| `name` | `string` | Yes | Agent name | -| `role` | `string` | No | Agent role, should be one of the following: `viceowner`, `administrator`, `normal` (default). | -| `login_status` | `string` | No | Agent's default status right after the login, should be one of the following: `accepting chats`, `not accepting chats` (default). | -| `job_title` | `string` | No | Agent's job title | -| `mobile` | `string` | No | Agent's mobile number | -| `max_chats_count` | `int` | No | Agent's maximum number of concurrent chats; default: 6. Limited to 20. | -| `awaiting_approval` | `bool` | No | Determines if the agent will be awaiting approval after creation. Only a requester with the `subscription.lc:rw` scope can set this value to `false`. | -| `groups` | `object[]` | No | Groups an agent belongs to. | -| `groups[].id` | `uint` | Yes | Group ID; required only when `group` is included. | -| `groups[].priority`**3** | `string` | Yes | Agent's priority in a group; required only when `group` is included. | -| `notifications`**4** | `string[]` | No | Represents which agent notifications are turned on. | -| `email_subscriptions`**5** | `string[]` | No | Represents which subscriptions will be send to the agent via email. | -| `work_scheduler` | `object` | No | Work scheduler options to set for the new agent | -| `work_scheduler.timezone` | `string` | Yes | Timezone for the work scheduler. Required only when `schedule` is not empty. Falls back to the agent's timezone if empty. | -| `work_scheduler.schedule` | `object[]` | Yes | List of agent's working hours. | -| `work_scheduler.schedule[].day` | `string` | Yes | The day for which the working hours are set. Possible values: sunday, monday, tuesday, wednesday, thursday, friday, and saturday. | -| `work_scheduler.schedule[].enabled` | `bool` | Yes | Whether the given set of working hours is enabled. | -| `work_scheduler.schedule[].start` | `string` | Yes | When working hours start. | -| `work_scheduler.schedule[].end` | `string` | Yes | When working hours end. | +| Parameter | Data type | Required | Notes | +| ------------------------------------- | ---------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | `string` | Yes | The agent ID. | +| `name` | `string` | Yes | The agent name. | +| `role` | `string` | No | The agent role. Possible values: `viceowner`, `administrator`, `normal`. Default: `normal`. | +| `login_status` | `string` | No | The agent's default status right after the login. Possible values: `accepting chats`, `not accepting chats`. Default: `not accepting chats`. | +| `job_title` | `string` | No | The agent's job title. | +| `mobile` | `string` | No | The agent's mobile number. | +| `max_chats_count` | `int` | No | The agent's maximum number of concurrent chats. Maximum: 20. Default: 6. | +| `awaiting_approval` | `bool` | No | If set to `true`, the agent will be awaiting approval after creation. Only a requester with the `subscription.lc:rw` scope can set this value to `false`. | +| `groups` | `object[]` | No | Groups the agent belongs to. | +| `groups[].id` | `uint` | Yes | The group ID. Required only when `group` is included. | +| `groups[].priority`**3** | `string` | Yes | The agent's priority in a group. Required only when `group` is included. | +| `notifications`**4** | `string[]` | No | Agent notifications that are enabled. | +| `email_subscriptions`**5** | `string[]` | No | Subscriptions that will be sent to the agent via email. | +| `work_scheduler` | `object` | No | The work scheduler options to set for the new agent. | +| `work_scheduler.timezone` | `string` | Yes | The timezone for the work scheduler. Falls back to the agent's timezone if empty. Required only when `schedule` is not empty. | +| `work_scheduler.schedule` | `object[]` | Yes | A list of the agent's working hours. | +| `work_scheduler.schedule[].day` | `string` | Yes | The day for which the working hours are set. Possible values: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`. | +| `work_scheduler.schedule[].enabled` | `bool` | Yes | If set to `true`, the given set of working hours is enabled. | +| `work_scheduler.schedule[].start` | `string` | Yes | The time when working hours start. | +| `work_scheduler.schedule[].end` | `string` | Yes | The time when working hours end. | **3)** Possible values for the `groups[].priority` parameter: @@ -344,23 +344,23 @@ It returns the info about an agent specified by `id`. | Parameter | Type | Required | Notes | | ------------------------ | ---------- | -------- | ----------------------------- | -| `id` | `string` | Yes | Agent ID | +| `id` | `string` | Yes | The agent ID. | | `fields`**1** | `string[]` | No | Additional fields to include. | **1)** Possible values for the `fields[]` parameter: -| Possible value | Notes | -| --------------------- | -------------------------------------------------------------------------------------- | -| `work_scheduler` | Work scheduler object for an agent. See [**Create Agent**](#create-agent) for details. | -| `groups` | Groups an agent belongs to | -| `email_subscriptions` | A list of an agent's active subscriptions | -| `notifications` | A list of an agent's enabled notifications | -| `job_title` | Agent's job title | -| `mobile` | Agent's mobile number | -| `max_chats_count` | Agent's maximum number of concurrent chats | -| `suspended` | Boolean value indicating if an agent is suspended | -| `awaiting_approval` | Boolean value indicating if an agent is awaiting approval | -| `last_logout` | RFC 3339 date-time of the last logout of an agent (omitted when no logout occurred) | +| Possible value | Notes | +| --------------------- | ------------------------------------------------------------------------------------------ | +| `work_scheduler` | The work scheduler object for an agent. See [**Create Agent**](#create-agent) for details. | +| `groups` | Groups the agent belongs to. | +| `email_subscriptions` | A list of the agent's active subscriptions. | +| `notifications` | A list of the agent's enabled notifications. | +| `job_title` | The agent's job title. | +| `mobile` | The agent's mobile number. | +| `max_chats_count` | The agent's maximum number of concurrent chats. | +| `suspended` | If set to `true`, the agent is suspended. | +| `awaiting_approval` | If set to `true`, the agent is awaiting approval. | +| `last_logout` | The RFC 3339 date-time of the last logout of the agent. Omitted when no logout occurred. | @@ -404,27 +404,27 @@ Returns all Agents within a license. #### Request -| Parameter | Required | Type | Notes | -| ------------------------ | -------- | ---------- | ------------------------------------------------------------------------------------------------------------- | -| `filters` | No | `object` | Possible request filters | -| `filters.group_ids` | No | `int[]` | IDs of the groups from which you want to list Agents. You'll only get the Agents from the specified group(s). | -| `filters.suspended` | No | `bool` | If provided, returns only those Agents who have the same `suspended` field value. | -| `fields`**1** | No | `string[]` | Additional agent fields to include. | +| Parameter | Required | Type | Notes | +| ------------------------ | -------- | ---------- | -------------------------------------------------------------------------------------------------------- | +| `filters` | No | `object` | Possible request filters | +| `filters.group_ids` | No | `int[]` | IDs of the groups from which you want to list agents. Returns only the agents from the specified groups. | +| `filters.suspended` | No | `bool` | If provided, returns only those agents who have the same `suspended` field value. | +| `fields`**1** | No | `string[]` | Additional agent fields to include. | **1)** Possible values for the `fields[]` parameter: -| Possible value | Notes | -| --------------------- | -------------------------------------------------------------------------------------- | -| `groups` | Groups an agent belongs to | -| `work_scheduler` | Work scheduler object for an agent. See [**Create Agent**](#create-agent) for details. | -| `email_subscriptions` | A list of the agent's active email subscriptions | -| `notifications` | A list of the agent's enabled notifications | -| `job_title` | Agent's job title | -| `mobile` | Agent's mobile number | -| `max_chats_count` | Agent's maximum number of concurrent chats | -| `suspended` | Boolean value indicating if an agent is suspended | -| `awaiting_approval` | Boolean value indicating if an agent is awaiting approval | -| `last_logout` | RFC 3339 date-time of the last logout of an agent (omitted when no logout occurred) | +| Possible value | Notes | +| --------------------- | ------------------------------------------------------------------------------------------ | +| `groups` | Groups the agent belongs to. | +| `work_scheduler` | The work scheduler object for an agent. See [**Create Agent**](#create-agent) for details. | +| `email_subscriptions` | A list of the agent's active email subscriptions. | +| `notifications` | A list of the agent's enabled notifications. | +| `job_title` | The agent's job title. | +| `mobile` | The agent's mobile number. | +| `max_chats_count` | The agent's maximum number of concurrent chats. | +| `suspended` | If set to `true`, the agent is suspended. | +| `awaiting_approval` | If set to `true`, the agent is awaiting approval. | +| `last_logout` | The RFC 3339 date-time of the last logout of the agent. Omitted when no logout occurred. | @@ -482,20 +482,20 @@ Updates the properties of an agent specified by `id`. #### Request -| Parameter | Data type | Required | Notes | -| ------------------------------------- | ---------- | -------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `id` | `string` | Yes | Agent ID | -| `role` | `string` | No | Agent role, should be one of the following: `viceowner`, `administrator`, `normal` | -| `login_status` | `string` | No | Agent's default status right after the login, should be one of the following: `accepting chats`, `not accepting chats` (default). | -| `job_title` | `string` | No | Agent's job title | -| `mobile` | `string` | No | Agent's mobile number | -| `max_chats_count` | `int` | No | Agent's maximum number of concurrent. Limited to 20. chats | -| `groups` | `object[]` | No | Groups an agent belongs to. | -| `groups[].id` | `uint` | Yes | Group ID; required only when `group`'s included. | -| `groups[].priority` **1** | `string` | Yes | Agent's priority in a group; required only when `group`'s included. | -| `notifications`**2** | `string[]` | No | Represents which agent notifications are turned on. | -| `email_subscriptions`**3** | `string[]` | No | Represents which subscriptions will be send to an agent via email. | -| `work_scheduler` | `object` | No | Work scheduler options to set for an agent. See [**Create Agent**](#create-agent) for details. | +| Parameter | Data type | Required | Notes | +| ------------------------------------- | ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | `string` | Yes | The agent ID. | +| `role` | `string` | No | The agent role. Possible values: `viceowner`, `administrator`, `normal`. | +| `login_status` | `string` | No | The agent's default status right after the login. Possible values: `accepting chats`, `not accepting chats`. Default: `not accepting chats`. | +| `job_title` | `string` | No | The agent's job title. | +| `mobile` | `string` | No | The agent's mobile number. | +| `max_chats_count` | `int` | No | The agent's maximum number of concurrent chats. Maximum: 20. | +| `groups` | `object[]` | No | Groups the agent belongs to. | +| `groups[].id` | `uint` | Yes | The group ID. Required only when `group`'s included. | +| `groups[].priority` **1** | `string` | Yes | The agent's priority in a group. Required only when `group`'s included. | +| `notifications`**2** | `string[]` | No | Agent notifications that are enabled. | +| `email_subscriptions`**3** | `string[]` | No | Subscriptions that will be sent to an agent via email. | +| `work_scheduler` | `object` | No | The work scheduler options to set for an agent. See [**Create Agent**](#create-agent) for details. | **1)** Possible values for the `groups[].priority` parameter: @@ -607,9 +607,9 @@ Deletes an agent specified by `id`. #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | -------- | -| `id` | Yes | `string` | Agent ID | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------- | +| `id` | Yes | `string` | The agent ID. | #### Response @@ -659,9 +659,9 @@ Suspends an agent specified by `id`. #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | -------- | -| `id` | Yes | `string` | Agent ID | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------- | +| `id` | Yes | `string` | The agent ID. | #### Response @@ -711,9 +711,9 @@ Unsuspends an agent specified by `id`. #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | -------- | -| `id` | Yes | `string` | Agent ID | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------- | +| `id` | Yes | `string` | The agent ID. | #### Response @@ -807,9 +807,9 @@ Approves an agent thus allowing the agent to use the application. #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | -------- | -| `id` | Yes | `string` | Agent ID | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------- | +| `id` | Yes | `string` | The agent ID. | #### Response @@ -859,9 +859,9 @@ Adds a new domain to the allowed domains list. | Required scopes | `domain_manage` | | [Batch support](#batch-requests) | No | -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | -------------------------------- | -| `domain` | Yes | `string` | Domain name (max 255 characters) | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ----------------------------------------- | +| `domain` | Yes | `string` | The domain name. Maximum: 255 characters. | @@ -959,9 +959,9 @@ Removes a domain from the allowed domains list. | Required scopes | `domain_manage` | | [Batch support](#batch-requests) | No | -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | ----------- | -| `domain` | Yes | `string` | Domain name | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ---------------- | +| `domain` | Yes | `string` | The domain name. | #### Response @@ -1023,28 +1023,28 @@ Creates an `auto access` data structure, which is a set of conditions for the tr | Required scopes | `access_rules:rw` | | [Batch support](#batch-requests) | No | -| Parameter | Required | Data type | Notes | -| ---------------------------------------- | -------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `access` | Yes | `object` | Destination access | -| `access.groups` | Yes | `[]int` | Destination groups | -| `conditions`**1** | Yes | `object` | Conditions to check | -| `conditions.url` | No | `object` | The condition that matches on `customer_page.url` from **Login** or `url` from **Update Customer Page** | -| `conditions.domain` | No | `object` | The condition that matches on the domain of the `customer_url` | -| `conditions.{url,domain}.values` | No | `[]match_object`**2** | Positive match, may not be used together with `exclude_values` | -| `conditions.{url,domain}.exclude_values` | No | `[]match_object` | Negative match | -| `conditions.geolocation` | No | `object` | The condition that matches on the customer's geolocation | -| `conditions.geolocation.values` | Yes | `[]geolocation_object`**3** | An array of objects; matches when at least one subcondition matches. | -| `description` | No | `string` | Description of the auto access | -| `next_id` | No | `string` | ID of an existing auto access. Leave empty if the new auto access should be the last one on the list. | +| Parameter | Required | Data type | Notes | +| ---------------------------------------- | -------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `access` | Yes | `object` | The destination access. | +| `access.groups` | Yes | `[]int` | Destination groups. | +| `conditions`**1** | Yes | `object` | Conditions to check. | +| `conditions.url` | No | `object` | The condition that matches on `customer_page.url` from **Login** or `url` from **Update Customer Page**. | +| `conditions.domain` | No | `object` | The condition that matches on the domain of the `customer_url`. | +| `conditions.{url,domain}.values` | No | `[]match_object`**2** | A positive match. Cannot be used together with `exclude_values`. | +| `conditions.{url,domain}.exclude_values` | No | `[]match_object` | A negative match. | +| `conditions.geolocation` | No | `object` | The condition that matches on the customer's geolocation. | +| `conditions.geolocation.values` | Yes | `[]geolocation_object`**3** | An array of objects. Matches when at least one subcondition matches. | +| `description` | No | `string` | A description of the auto access. | +| `next_id` | No | `string` | The ID of an existing auto access. If empty, the new auto access will be the last one on the list. | **1)** `conditions` must have at least one of `url`, `domain`, `geolocation` set. **2)** `` structure: -| Parameter | Required | Data type | Notes | -| ------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------- | -| `value` | Yes | `string` | A value to match | -| `exact_match` | No | `bool` | If set to `false`, a `match_object.value` will be matched as a substring of the customer URL or domain. | +| Parameter | Required | Data type | Notes | +| ------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------- | +| `value` | Yes | `string` | A value to match. | +| `exact_match` | No | `bool` | If set to `false`, `match_object.value` will be matched as a substring of the customer URL or domain. | **3)** the `geolocation_object` structure. The condition is fulfilled only when all of the specified fields match. At least one field must be specified. @@ -1198,9 +1198,9 @@ Deletes an existing `auto access` data structure specified by its ID. | Required scopes | `access_rules:rw` | | [Batch support](#batch-requests) | No | -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | -------------- | -| `id` | Yes | `string` | Auto access ID | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------------- | +| `id` | Yes | `string` | The auto access ID. | #### Response @@ -1244,29 +1244,29 @@ Updates an existing `auto access`. Only specified fields are updated (overwritt | Required scopes | `access_rules:rw` | | [Batch support](#batch-requests) | No | -| Parameter | Required | Data type | Notes | -| ---------------------------------------- | -------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | ID of the auto access to modify | -| `access` | No | `object` | Destination access | -| `access.groups` | Yes | `[]int` | Destination groups | -| `conditions`**1** | No | `object` | Conditions to check | -| `conditions.url` | No | `object` | The condition that matches on `customer_page.url` from **Login** or `url` from **Update Customer Page** | -| `conditions.domain` | No | `object` | The condition that matches on the domain of the `customer_url` | -| `conditions.{url,domain}.values` | No | `[]match_object`**2** | Positive match, may not be used together with `exclude_values` | -| `conditions.{url,domain}.exclude_values` | No | `[]match_object` | Negative match | -| `conditions.geolocation` | No | `object` | The condition that matches on the customer's geolocation | -| `conditions.geolocation.values` | Yes | `[]geolocation_object`**3** | An array of objects; matches when at least one subcondition matches. | -| `description` | No | `string` | Description of the auto access | -| `next_id`**4** | No | `string` | ID of an existing auto access. If `next_id` is an empty string, auto_access moves to the end of the list. | +| Parameter | Required | Data type | Notes | +| ---------------------------------------- | -------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | +| `id` | Yes | `string` | The ID of the auto access to modify. | +| `access` | No | `object` | The destination access. | +| `access.groups` | Yes | `[]int` | Destination groups. | +| `conditions`**1** | No | `object` | Conditions to check. | +| `conditions.url` | No | `object` | The condition that matches on `customer_page.url` from **Login** or `url` from **Update Customer Page**. | +| `conditions.domain` | No | `object` | The condition that matches on the domain of the `customer_url`. | +| `conditions.{url,domain}.values` | No | `[]match_object`**2** | A positive match. Cannot be used together with `exclude_values`. | +| `conditions.{url,domain}.exclude_values` | No | `[]match_object` | A negative match. | +| `conditions.geolocation` | No | `object` | The condition that matches on the customer's geolocation. | +| `conditions.geolocation.values` | Yes | `[]geolocation_object`**3** | An array of objects. Matches when at least one subcondition matches. | +| `description` | No | `string` | A description of the auto access. | +| `next_id`**4** | No | `string` | The ID of an existing auto access. If `next_id` is an empty string, the auto access moves to the end of the list. | **1)** `conditions` must have at least one of `url`, `domain`, `geolocation` set. **2)** `` structure: -| Parameter | Required | Data type | Notes | -| ------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------- | -| `value` | Yes | `string` | A value to match | -| `exact_match` | No | `bool` | If set to `false`, a `match_object.value` will be matched as a substring of the customer URL or domain; default: false. | +| Parameter | Required | Data type | Notes | +| ------------- | -------- | --------- | --------------------------------------------------------------------------------------------------------------------- | +| `value` | Yes | `string` | A value to match. | +| `exact_match` | No | `bool` | If set to `false`, `match_object.value` will be matched as a substring of the customer URL or domain; default: false. | **3)** the `geolocation_object` structure. The condition is fulfilled only when all of the specified fields match. At least one field must be specified. @@ -1354,15 +1354,15 @@ Bots based on templates will work in the same way as those created by the [Creat #### Request -| Parameter | Required | Data type | Notes | -| ---------------------------------------- | -------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | Yes | `string` | Display name | -| `avatar` | No | `string` | Avatar URL | -| `max_chats_count` | No | `int` | Max. number of incoming chats that can be routed to the bot; default: 6. Limited to 500. | -| `default_group_priority`**1** | No | `string` | The default routing priority for a group without defined priority. | -| `job_title` | No | `string` | Bot's job title | -| `owner_client_id` | Yes | `string` | **Client Id** that will own the bot template; must be owned by your organization. | -| `affect_existing_installations` | No | `bool` | If set to `true`, a bot based on this template will be created on all licenses that have given application installed. Otherwise only new installations will trigger bot creation. | +| Parameter | Required | Data type | Notes | +| ---------------------------------------- | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `name` | Yes | `string` | The display name. | +| `avatar` | No | `string` | The avatar URL. | +| `max_chats_count` | No | `int` | The maximum number of incoming chats that can be routed to the bot. Maximum: 500. Default: 6. | +| `default_group_priority`**1** | No | `string` | The default routing priority for a group without defined priority. | +| `job_title` | No | `string` | The bot's job title. | +| `owner_client_id` | Yes | `string` | The Client ID that will own the bot template. Must be owned by your organization. | +| `affect_existing_installations` | No | `bool` | If set to `true`, a bot based on this template will be created on all licenses that have the given application installed. If set to `false`, only new installations will trigger bot creation. | **1)** Possible priority values: @@ -1417,16 +1417,16 @@ Creates a new bot. To make the bot available for receiving chats or webhooks, us | Parameter | Required | Data type | Notes | | ---------------------------------------- | -------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | Yes | `string` | Display name | -| `avatar` | No | `string` | Avatar URL | -| `max_chats_count` | No | `int` | Max. number of incoming chats that can be routed to the bot; default: 6. Limited to 500. | +| `name` | Yes | `string` | The display name. | +| `avatar` | No | `string` | The avatar URL. | +| `max_chats_count` | No | `int` | The maximum number of incoming chats that can be routed to the bot. Maximum: 500. Default: 6. | | `default_group_priority`**1** | No | `string` | The default routing priority for a group without defined priority. | -| `job_title` | No | `string` | Bot's job title | +| `job_title` | No | `string` | The bot's job title. | | `groups` | No | `object[]` | Groups the bot belongs to. | -| `groups[].id` | No | `int` | Group ID; required only when `group`'s included. | -| `groups[].priority`**1** | Yes | `string` | Bot's priority in a group; required only when `group`'s included. | -| `type` | No | `string` | A custom value to categorize or identify the bot. Defaults to `chatbot`. | -| `work_scheduler` | No | `object` | Work scheduler options to set for the new bot. See [**Create Agent**](#create-agent) for details. | +| `groups[].id` | No | `int` | The group ID. Required only when `group`'s included. | +| `groups[].priority`**1** | Yes | `string` | The bot's priority in a group. Required only when `group`'s included. | +| `type` | No | `string` | A custom value to categorize or identify the bot. Default: `chatbot`. | +| `work_scheduler` | No | `object` | The work scheduler options to set for the new bot. See [**Create Agent**](#create-agent) for details. | | `work_scheduler.timezone` | Yes | `string` | The time zone in which the bot's work scheduler should operate. | | `owner_client_id`**2** | Yes | `string` | Required only when authorizing via [PATs](/authorization/agent-authorization#personal-access-tokens). When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. | @@ -1485,8 +1485,8 @@ Deletes a bot template specified by `id`. The bots associated with the template | Parameter | Required | Type | Notes | | ------------------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | Bot Template ID | -| `owner_client_id` | Yes | `string` | **Client Id** that owns the bot template; must be owned by your organization. | +| `id` | Yes | `string` | The bot template ID. | +| `owner_client_id` | Yes | `string` | The Client ID that owns the bot template. Must be owned by your organization. | | `affect_existing_installations` | No | `bool` | If set to `true`, a bot based on this template will be deleted from all licenses that have given application installed. | #### Response @@ -1533,9 +1533,9 @@ Deletes a bot specified by `id`. #### Request -| Parameter | Required | Type | Notes | -| --------- | -------- | -------- | ------ | -| `id` | Yes | `string` | Bot ID | +| Parameter | Required | Type | Notes | +| --------- | -------- | -------- | ----------- | +| `id` | Yes | `string` | The bot ID. | #### Response @@ -1583,13 +1583,13 @@ Updates an existing bot template. | Parameter | Required | Data type | Notes | | ---------------------------------------- | -------- | --------- | -------------------------------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | Bot Template ID | -| `name` | No | `string` | Display name | -| `avatar` | No | `string` | Avatar URL | -| `max_chats_count` | No | `int` | Maximum incoming chats that can be routed to the bot. Limited to 500. | +| `id` | Yes | `string` | The bot template ID. | +| `name` | No | `string` | The display name. | +| `avatar` | No | `string` | The avatar URL. | +| `max_chats_count` | No | `int` | The maximum number of incoming chats that can be routed to the bot. Maximum: 500. | | `default_group_priority`**1** | No | `string` | The default routing priority for a group without defined priority. | -| `job_title` | No | `string` | Bot's job title | -| `owner_client_id` | Yes | `string` | **Client Id** that owns the bot template; must be owned by your organization. | +| `job_title` | No | `string` | The bot's job title. | +| `owner_client_id` | Yes | `string` | The Client ID that owns the bot template. Must be owned by your organization. | | `affect_existing_installations` | No | `bool` | If set to `true`, bots based on this template will be updated on all licenses that have given application installed. | **1)** Possible priority values: @@ -1646,20 +1646,20 @@ Updates an existing bot. #### Request -| Parameter | Required | Data type | Notes | -| ---------------------------------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | Bot ID | -| `name` | No | `string` | Display name | -| `avatar` | No | `string` | Avatar URL | -| `max_chats_count` | No | `int` | Maximum incoming chats that can be routed to the bot. Limited to 500. | -| `groups` | No | `object[]` | Groups the bot belongs to | -| `groups[].id` | Yes | `uint` | Group ID, required only when `groups`'s present. | -| `groups[].priority`**1** | Yes | `string` | Bot's priority in the group; required only when `groups` is included. | -| `default_group_priority`**1** | No | `string` | The default routing priority for a group without defined priority. | -| `job_title` | No | `string` | Bot's job title | -| `type` | No | `string` | A custom value to categorize or identify the bot. | -| `work_scheduler` | No | `object` | Work scheduler options to set for the new bot. See [**Create Agent**](#create-agent) for details. | -| `work_scheduler.timezone` | Yes | `string` | The time zone in which the bot's work scheduler should operate. | +| Parameter | Required | Data type | Notes | +| ---------------------------------------- | -------- | ---------- | ----------------------------------------------------------------------------------------------------- | +| `id` | Yes | `string` | The bot ID. | +| `name` | No | `string` | The display name. | +| `avatar` | No | `string` | The avatar URL. | +| `max_chats_count` | No | `int` | The maximum number of incoming chats that can be routed to the bot. Maximum: 500. | +| `groups` | No | `object[]` | Groups the bot belongs to | +| `groups[].id` | Yes | `uint` | The group ID. Required only when `groups` is present. | +| `groups[].priority`**1** | Yes | `string` | The bot's priority in the group. Required only when `groups` is included. | +| `default_group_priority`**1** | No | `string` | The default routing priority for a group without defined priority. | +| `job_title` | No | `string` | The bot's job title. | +| `type` | No | `string` | A custom value to categorize or identify the bot. | +| `work_scheduler` | No | `object` | The work scheduler options to set for the new bot. See [**Create Agent**](#create-agent) for details. | +| `work_scheduler.timezone` | Yes | `string` | The time zone in which the bot's work scheduler should operate. | **1)** Possible priority values: @@ -1717,7 +1717,7 @@ Returns the list of bot templates created for a Client ID (application). | Parameter | Required | Type | Notes | | ----------------- | -------- | -------- | -------------------------------------------------------------------------------------- | -| `owner_client_id` | Yes | `string` | **Client Id** that owns the bot templates to list; must be owned by your organization. | +| `owner_client_id` | Yes | `string` | The Client ID that owns the bot templates to list. Must be owned by your organization. | @@ -1759,25 +1759,25 @@ Returns the list of bots created within a license. The method behavior differs d #### Request -| Parameter | Required | Type | Notes | -| ------------------------ | -------- | ---------- | --------------------------------------------------------------------------------------------------------------------- | -| `all` | No | `bool` | `true` - gets all Bots within a license.  `false` (default)**1** - returns only the requester's Bots. | -| `fields`**2** | No | `string[]` | Additional bot fields to include | +| Parameter | Required | Type | Notes | +| ------------------------ | -------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| `all` | No | `bool` | If set to `true`, gets all bots within a license. If set to `false`, returns only the requester's bots. Default: `false`.**1** | +| `fields`**2** | No | `string[]` | Additional bot fields to include. | **1)** Calling List Bots with `all:false` -- If a bot was created via an app, all Agents who make the request via this app will get the bot in the response. -- If a bot was created directly by an agent ([PAT authorization](/authorization/agent-authorization#personal-access-tokens)), all Agents who authorize with PATs will get the bot in the response. +- If a bot was created via an app, all agents who make the request via this app will get the bot in the response. +- If a bot was created directly by an agent ([PAT authorization](/authorization/agent-authorization#personal-access-tokens)), all agents who authorize with PATs will get the bot in the response. **2)** Possible values for the `fields[]` parameter: -| Possible value | Notes | -| ----------------- | ----------------------------------------------------------------------------------- | -| `groups` | Groups a bot belongs to | -| `work_scheduler` | Work scheduler object for a bot. See [**Create Agent**](#create-agent) for details. | -| `job_title` | Bot's job title | -| `max_chats_count` | Bot's maximum number of concurrent chats | -| `timezone` | The time zone in which the bot's work scheduler operates | +| Possible value | Notes | +| ----------------- | --------------------------------------------------------------------------------------- | +| `groups` | Groups a bot belongs to. | +| `work_scheduler` | The work scheduler object for a bot. See [**Create Agent**](#create-agent) for details. | +| `job_title` | The bot's job title. | +| `max_chats_count` | The bot's maximum number of concurrent chats. | +| `timezone` | The time zone in which the bot's work scheduler operates. | @@ -1823,18 +1823,18 @@ It returns the info about a bot with a given `id`. | Parameter | Required | Type | Notes | | ------------------------ | ---------- | -------- | ----------------------------- | -| `id` | Yes | `string` | Bot ID | +| `id` | Yes | `string` | The bot ID. | | `fields`**1** | `string[]` | No | Additional fields to include. | **1)** Possible values for the `fields[]` parameter: -| Possible value | Notes | -| ----------------- | ----------------------------------------------------------------------------------- | -| `work_scheduler` | Work scheduler object for a bot. See [**Create Agent**](#create-agent) for details. | -| `groups` | Groups a bot belongs to | -| `job_title` | Bot's job title | -| `max_chats_count` | Bot's maximum number of concurrent chats | -| `timezone` | The time zone in which the bot's work scheduler operates | +| Possible value | Notes | +| ----------------- | --------------------------------------------------------------------------------------- | +| `groups` | Groups a bot belongs to. | +| `work_scheduler` | The work scheduler object for a bot. See [**Create Agent**](#create-agent) for details. | +| `job_title` | The bot's job title. | +| `max_chats_count` | The bot's maximum number of concurrent chats. | +| `timezone` | The time zone in which the bot's work scheduler operates. | @@ -1883,12 +1883,12 @@ If you lost the secret, you can reset it using [Reset Bot Template Secret](#rese #### Request -| Parameter | Required | Type | Notes | -| ----------------- | -------- | -------- | --------------- | -| `bot_id` | Yes | `string` | Bot ID | -| `client_id` | Yes | `string` | Client ID | -| `bot_secret` | Yes | `string` | Bot secret | -| `organization_id` | Yes | `string` | Organization ID | +| Parameter | Required | Type | Notes | +| ----------------- | -------- | -------- | -------------------- | +| `bot_id` | Yes | `string` | The bot ID. | +| `client_id` | Yes | `string` | The client ID. | +| `bot_secret` | Yes | `string` | The bot secret. | +| `organization_id` | Yes | `string` | The organization ID. | @@ -1935,11 +1935,11 @@ Resets secret for given bot template. #### Request -| Parameter | Required | Type | Notes | -| ------------------------------- | -------- | -------- | ---------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | Bot template ID | -| `owner_client_id` | Yes | `string` | **Client Id** that owns the bot template; must be owned by your organization. | -| `affect_existing_installations` | No | `bool` | If set to `true`, the new secret is set to for all existing bots based on this template. | +| Parameter | Required | Type | Notes | +| ------------------------------- | -------- | -------- | ------------------------------------------------------------------------------------- | +| `id` | Yes | `string` | The bot template ID. | +| `owner_client_id` | Yes | `string` | The Client ID that owns the bot template. Must be owned by your organization. | +| `affect_existing_installations` | No | `bool` | If set to `true`, the new secret is set for all existing bots based on this template. | @@ -1985,7 +1985,7 @@ Resets secret for a given bot. | Parameter | Required | Type | Notes | | ----------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | Bot ID | +| `id` | Yes | `string` | The bot ID. | | `owner_client_id` | Yes | `string` | Required only when authorizing via [PATs](/authorization/agent-authorization#personal-access-tokens). When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. | @@ -2086,10 +2086,10 @@ Lifts a ban from a customer. #### Request -| Parameter | Data type | Required | Notes | -| ------------- | --------- | -------- | ------------------------------- | -| `ip` | `string` | Yes* | Group name (up to 180 chars) | -| `customer_id` | `string` | Yes* | The code of the group languange | +| Parameter | Data type | Required | Notes | +| ------------- | --------- | -------- | -------------------------- | +| `ip` | `string` | Yes* | The customer's IP address. | +| `customer_id` | `string` | Yes* | The customer ID. | **1)** Exactly one of `ip` and `customer_id` is required. @@ -2149,42 +2149,42 @@ Creates a new greeting. #### Request -| Parameter | Required | Data type | Notes | -| ----------------------------------------- | -------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | Yes | `string` | Greeting type, one of: `normal` (standard greeting type) or `announcement` (announcement-style greeting) | -| `active` | Yes | `bool` | Greeting status | -| `active_from` | No | `string` | RFC 3339 date-time format; when the greeting becomes active | -| `active_until` | No | `string` | RFC 3339 date-time format; when the greeting stops being active | -| `name` | Yes | `string` | Greeting name | -| `group` | Yes | `int` | Group ID the greeting belongs to | -| `rules` | Yes | `object[]` | Array of action rules that define when the greeting should be triggered; accepts up to 10 rules | -| `rules[].condition` | Yes | `string` | Logical condition for the rule; `and` (match all conditions), or `or` (match one of the conditions) | -| `rules[].type`**1** | Yes | `string` | Type of the rule condition | -| `rules[].operator`**2** | Yes | `string` | Comparison operator for the rule. Not required for `url_funnel`**1**, `custom_variable`**1**, and `ads_traffic`**1** | -| `rules[].value` | No | `string` | Value to compare against, based on the selected `operator`**2**; required for most rule types | -| `rules[].urls` | No | `object[]` | Array of URLs; required only for the `url_funnel`**1** type; accepts up to 10 objects | -| `rules[].urls[].url` | No | `string` | URL for the `url_funnel`**1** rule; required when `urls` array is used | -| `rules[].urls[].operator`**2** | No | `string` | Operator for the URL comparison; required when `urls` array is used | -| `rules[].session_field` | No | `object` | Key-value pairs; required for `custom_variable`**1** and `ads_traffic`**1** types - exactly one element | -| `properties`**3** | No | `object` | Additional properties for the greeting as key-value pairs | -| `rich_message`**4** | No | `object` | Rich message content of the greeting | +| Parameter | Required | Data type | Notes | +| ----------------------------------------- | -------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | Yes | `string` | The greeting type. Possible values: `normal` (standard greeting type), `announcement` (announcement-style greeting). | +| `active` | Yes | `bool` | If set to `true`, the greeting is active. | +| `active_from` | No | `string` | The RFC 3339 date-time when the greeting becomes active. | +| `active_until` | No | `string` | The RFC 3339 date-time when the greeting stops being active. | +| `name` | Yes | `string` | The greeting name. | +| `group` | Yes | `int` | The group ID the greeting belongs to. | +| `rules` | Yes | `object[]` | An array of action rules that define when the greeting should be triggered. Accepts up to 10 rules. | +| `rules[].condition` | Yes | `string` | The logical condition for the rule. Possible values: `and` (match all conditions), `or` (match one of the conditions). | +| `rules[].type`**1** | Yes | `string` | The type of the rule condition. | +| `rules[].operator`**2** | Yes | `string` | The comparison operator for the rule. Not required for `url_funnel`**1**, `custom_variable`**1**, and `ads_traffic`**1**. | +| `rules[].value` | No | `string` | The value to compare against, based on the selected `operator`**2**. Required for most rule types. | +| `rules[].urls` | No | `object[]` | An array of URLs. Required only for the `url_funnel`**1** type. Accepts up to 10 objects. | +| `rules[].urls[].url` | No | `string` | The URL for the `url_funnel`**1** rule. Required when `urls` array is used. | +| `rules[].urls[].operator`**2** | No | `string` | The operator for the URL comparison. Required when `urls` array is used. | +| `rules[].session_field` | No | `object` | Key-value pairs. Required for `custom_variable`**1** and `ads_traffic`**1** types - exactly one element. | +| `properties`**3** | No | `object` | Additional properties for the greeting as key-value pairs. | +| `rich_message`**4** | No | `object` | The rich message content of the greeting. | **1)** Parameter requirements for each `rules[].type` value: -| Type value | Required Parameters | Parameter Details | -| ------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- | -| `visit_time_site` | `value`, `operator` | `value` must be integer 0-900 (seconds spent on the entire website) | -| `visit_time_page` | `value`, `operator` | `value` must be integer 0-900 (seconds spent on the current page) | -| `url_current` | `value`, `operator` | `value` contains current page URL to match | -| `url_visited` | `value`, `operator` | `value` contains previously visited URL to match | -| `url_funnel` | `urls` | `urls` array with 1-10 URL objects, each with `url` and `operator` | -| `pages_view_number` | `value`, `operator` | `value` contains number of pages viewed to compare | -| `url_referrer` | `value`, `operator` | `value` contains referrer URL to match | -| `geolocation` | `value`, `operator` | `value` contains geographic location to match | -| `visits_number` | `value`, `operator` | `value` contains number of visits to compare | -| `search_keyword` | `value`, `operator` | `value` contains search keyword to match | -| `custom_variable` | `session_field` | `session_field` object with exactly one key-value pair (max 255 characters each) | -| `ads_traffic` | `session_field` | `session_field` with one key from: `microsoft`, `facebook`, `google`, `twitter`, `yahoo` (value max 255 chars) | +| Type value | Required Parameters | Parameter Details | +| ------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `visit_time_site` | `value`, `operator` | The `value` must be an integer 0-900 (seconds spent on the entire website). | +| `visit_time_page` | `value`, `operator` | The `value` must be an integer 0-900 (seconds spent on the current page). | +| `url_current` | `value`, `operator` | The `value` contains the current page URL to match. | +| `url_visited` | `value`, `operator` | The `value` contains a previously visited URL to match. | +| `url_funnel` | `urls` | The `urls` array with 1-10 URL objects, each with `url` and `operator`. | +| `pages_view_number` | `value`, `operator` | The `value` contains the number of pages viewed to compare. | +| `url_referrer` | `value`, `operator` | The `value` contains the referrer URL to match. | +| `geolocation` | `value`, `operator` | The `value` contains a geographic location to match. | +| `visits_number` | `value`, `operator` | The `value` contains the number of visits to compare. | +| `search_keyword` | `value`, `operator` | The `value` contains a search keyword to match. | +| `custom_variable` | `session_field` | The `session_field` object with exactly one key-value pair. Maximum: 255 characters each. | +| `ads_traffic` | `session_field` | The `session_field` with one key from: `microsoft`, `facebook`, `google`, `twitter`, `yahoo`. The value maximum: 255 characters. | **2)** Possible values for the `rules[].operator` and `rules[].urls[].operator` parameters: @@ -2199,38 +2199,38 @@ Creates a new greeting. **3)** Possible values for the `properties` object keys: -| Possible value | Notes | -| ----------------------------- | ------------------------------ | -| `addon` | Addon-related property | -| `is_exit_intent` | Exit intent detection flag | -| `greeting-message_text` | Plain text message content | -| `greeting-message_json_key` | JSON key for message content | -| `greeting-message_phrase_key` | Phrase key for message content | +| Possible value | Notes | +| ----------------------------- | --------------------------------------------------- | +| `addon` | An addon-related property. | +| `is_exit_intent` | If set to `true`, exit intent detection is enabled. | +| `greeting-message_text` | The plain text message content. | +| `greeting-message_json_key` | The JSON key for message content. | +| `greeting-message_phrase_key` | The phrase key for message content. | **4)** The `rich_message` object structure: | Parameter | Required | Data type | Notes | | ----------------------------------- | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `template_id` | yes | `string` | Defines how every rich message will be presented; possible values: `cards`, `sticker`, or `quick_replies` | -| `elements` | no | `array` | Can contain up to 10 `element` objects | -| `elements[].title` | yes | `string` | Displays formatted text on rich messages | -| `elements[].subtitle` | yes | `string` | Displays formatted text on rich messages | -| `elements[].image` | yes | `object` | Displays images on rich messages. Required param: `url`; Optional params: `name`, `content_type`, `size`, `width`, `height`, `alternative_text`. | -| `elements[].image.url` | yes | `string` | Image URL | -| `elements[].image.alternative_text` | no | `string` | Alternative text for the image | -| `elements[].buttons` | no | `array` | Displays up to 13 `button` objects | -| `elements[].buttons[].text` | yes | `string` | Button text | +| `template_id` | yes | `string` | Defines how every rich message will be presented. Possible values: `cards`, `sticker`, `quick_replies`. | +| `elements` | no | `array` | Can contain up to 10 `element` objects. | +| `elements[].title` | yes | `string` | Displays formatted text on rich messages. | +| `elements[].subtitle` | yes | `string` | Displays formatted text on rich messages. | +| `elements[].image` | yes | `object` | Displays images on rich messages. Required param: `url`. Optional params: `name`, `content_type`, `size`, `width`, `height`, `alternative_text`. | +| `elements[].image.url` | yes | `string` | The image URL. | +| `elements[].image.alternative_text` | no | `string` | The alternative text for the image. | +| `elements[].buttons` | no | `array` | Displays up to 13 `button` objects. | +| `elements[].buttons[].text` | yes | `string` | The button text. | | `elements[].buttons[].type` | yes | `string` | Defines the behavior after a user clicks the button. Should be used together with `elements.buttons.value`. Possible values: `webview`, `message`, `url`, `phone`. [Read more about rich messages.](/extending-chat-widget/rich-messages/#getting-started) | | `elements[].buttons[].value` | yes | `string` | Should be used together with `elements.buttons.type`. You can use this field to give the rich message of a `webview` type (a Moment) a custom title. [Read more about Moments.](/extending-chat-widget/chat-widget-moments/#how-to-start) | | `elements[].buttons[].postback_id` | yes | `string` | A unique identifier for this button, sent in postback events. | | `elements[].buttons[].button_id` | no | `string` | A button identifier, automatically generated if not provided. | -| `elements[].buttons[].role` | no | `string` | Button role, one of: `default`, `primary`, or `danger` | +| `elements[].buttons[].role` | no | `string` | The button role. Possible values: `default`, `primary`, `danger`. | #### Response -| Field | Data type | Notes | -| ----- | --------- | -------------------------------- | -| `id` | `int` | ID of the newly created greeting | +| Field | Data type | Notes | +| ----- | --------- | ------------------------------------- | +| `id` | `int` | The ID of the newly created greeting. | @@ -2306,19 +2306,18 @@ Updates the properties of a greeting. #### Request -| Parameter | Required | Data type | Notes | -| --------------------------------------------- | -------- | ---------- | ---------------------------------------------------------------------------------------------------- | -| `id` | Yes | `int` | ID of the greeting to update | -| `type` | No | `string` | Greeting type | -| `active` | No | `bool` | Greeting status | -| `active_from` | No | `string` | RFC 3339 date-time format; when the greeting becomes active | -| `active_until` | No | `string` | RFC 3339 date-time format; when the greeting stops being active | -| `name` | No | `string` | Greeting name | -| `rules` | No | `object[]` | Array of action rules; see [Create Greeting](#create-greeting) for detailed structure and validation | -| `properties` | No | `object` | Additional properties; see [Create Greeting](#create-greeting) for allowed keys | -| `rich_message` | No | `object` | Rich message content; see [Create Greeting](#create-greeting) for complete structure | -| `rich_message.elements[].buttons[].button_id` | No | `string` | Pass the existing ID if you want to preserve it | - +| Parameter | Required | Data type | Notes | +| --------------------------------------------- | -------- | ---------- | -------------------------------------------------------------------------------------------------------------------- | +| `id` | Yes | `int` | The ID of the greeting to update. | +| `type` | No | `string` | The greeting type. Possible values: `normal` (standard greeting type), `announcement` (announcement-style greeting). | +| `active` | No | `bool` | If set to `true`, the greeting is active. | +| `active_from` | No | `string` | The RFC 3339 date-time when the greeting becomes active. | +| `active_until` | No | `string` | The RFC 3339 date-time when the greeting stops being active. | +| `name` | No | `string` | The greeting name. | +| `rules` | No | `object[]` | An array of action rules. See [Create Greeting](#create-greeting) for detailed structure and validation. | +| `properties` | No | `object` | Additional properties. See [Create Greeting](#create-greeting) for allowed keys. | +| `rich_message` | No | `object` | The rich message content. See [Create Greeting](#create-greeting) for complete structure | +| `rich_message.elements[].buttons[].button_id` | No | `string` | Pass the existing ID if you want to preserve it | #### Response @@ -2387,9 +2386,9 @@ Deletes a greeting. #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | ---------------------------- | -| `id` | Yes | `int` | ID of the greeting to delete | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | --------------------------------- | +| `id` | Yes | `int` | The ID of the greeting to delete. | #### Response @@ -2435,19 +2434,19 @@ Returns a list of greetings. #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `groups` | No | `array` | Array of group IDs to filter greetings; defaults to all accesible groups. Cannot be used with `page_id`. | -| `page_id` | No | `string` | Page ID for pagination. When provided, `groups` and `limit` parameters are ignored as they're encoded in the page ID. Cannot be used with `groups` or `limit`. | -| `limit` | No | `int` | Number of greetings per page; default: 100. Limited to 100. Cannot be used with `page_id`. | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `groups` | No | `array` | An array of group IDs to filter greetings. Defaults to all accessible groups. Cannot be used with `page_id`. | +| `page_id` | No | `string` | The page ID for pagination. When provided, `groups` and `limit` parameters are ignored as they're encoded in the page ID. Cannot be used with `groups` or `limit`. | +| `limit` | No | `int` | The number of greetings per page. Maximum: 100. Default: 100. Cannot be used with `page_id`. | #### Response -| Field | Data type | Notes | -| ----------------- | --------- | ---------------------------------------------------------------------------------- | -| `greetings` | `array` | Array of greeting objects | -| `found_greetings` | `int` | The total number of greetings. | -| `next_page_id` | `string` | Page ID for the next page of results; returned only if more results are available. | +| Field | Data type | Notes | +| ----------------- | --------- | -------------------------------------------------------------------------------------- | +| `greetings` | `array` | An array of greeting objects. | +| `found_greetings` | `int` | The total number of greetings. | +| `next_page_id` | `string` | The page ID for the next page of results. Returned only if more results are available. | @@ -2492,24 +2491,24 @@ Returns the details of a specific greeting. #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | ------------------------- | -| `id` | Yes | `int` | ID of the greeting to get | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------------------------ | +| `id` | Yes | `int` | The ID of the greeting to get. | #### Response -| Field | Data type | Notes | -| -------------- | --------- | -------------------------------------------------------------------------- | -| `id` | `int` | Greeting ID | -| `type` | `string` | Greeting type | -| `active` | `boolean` | Greeting status | -| `active_from` | `string` | ISO 8601 datetime when the greeting becomes active (if set) | -| `active_until` | `string` | ISO 8601 datetime when the greeting stops being active (if set) | -| `name` | `string` | Greeting name | -| `group` | `int` | ID of the group the greeting is assigned to | -| `rules` | `array` | Array of rule objects, see [Create Greeting](#create-greeting) for details | -| `properties` | `object` | Additional properties, see [Create Greeting](#create-greeting) for details | -| `rich_message` | `object` | Rich message content, see [Create Greeting](#create-greeting) for details | +| Field | Data type | Notes | +| -------------- | --------- | ------------------------------------------------------------------------------ | +| `id` | `int` | The greeting ID. | +| `type` | `string` | The greeting type. | +| `active` | `boolean` | If set to `true`, the greeting is active. | +| `active_from` | `string` | The ISO 8601 datetime when the greeting becomes active (if set). | +| `active_until` | `string` | The ISO 8601 datetime when the greeting stops being active (if set). | +| `name` | `string` | The greeting name. | +| `group` | `int` | The ID of the group the greeting is assigned to | +| `rules` | `array` | An array of rule objects. See [Create Greeting](#create-greeting) for details. | +| `properties` | `object` | Additional properties. See [Create Greeting](#create-greeting) for details. | +| `rich_message` | `object` | The rich message content. See [Create Greeting](#create-greeting) for details. | @@ -2567,19 +2566,19 @@ Creates a new group. #### Request -| Parameter | Data type | Required | Notes | -| ---------------------------------- | --------- | -------- | ---------------------------------------------------------------------------- | -| `name` | `string` | Yes | Group name (up to 180 chars) | -| `language_code` | `string` | No | The code of the group languange | -| `agent_priorities`**1** | `object` | Yes | Agents' priorities in a group as a map in the `"": ""` format. | +| Parameter | Data type | Required | Notes | +| ---------------------------------- | --------- | -------- | -------------------------------------------------------------------------- | +| `name` | `string` | Yes | The name of the group. Maximum: 180 characters. | +| `language_code` | `string` | No | The code of the group language. | +| `agent_priorities`**1** | `object` | Yes | Agent priorities in a group as a map in the `"": ""` format. | **1)** The table below presents the possible values for the `agent_priorities` map: | Possible value | Notes | | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `first` | The highest chat routing priority. Agents with the `first` priority get chats before others from the same group, e.g. Bots can get chats before regular Agents. | -| `normal` | The medium chat routing priority. Agents with the `normal` priority get chats before those with the `last` priority, when there are no Agents with the `first` priority available with free slots in the group. | -| `last` | The lowest chat routing priority. Agents with the `last` priority get chats when there are no Agents with the `first` or `normal` priority available with free slots in the group. | +| `first` | The highest chat routing priority. Agents with the `first` priority get chats before others from the same group, for example, bots can get chats before regular agents. | +| `normal` | The medium chat routing priority. Agents with the `normal` priority get chats before those with the `last` priority, when there are no agents with the `first` priority available with free slots in the group. | +| `last` | The lowest chat routing priority. Agents with the `last` priority get chats when there are no agents with the `first` or `normal` priority available with free slots in the group. | | `supervisor` | Agents with the `supervisor` priority will not get any chats assigned automatically. | @@ -2629,20 +2628,20 @@ Updates an existing group. #### Request -| Parameter | Data type | Required | Notes | -| ---------------------------------- | --------- | -------- | ---------------------------------------------------------------------------- | -| `id` | `int` | Yes | Group ID | -| `name` | `string` | No | Group name (up to 180 chars) | -| `language_code` | `string` | No | The code of the group languange | -| `agent_priorities`**1** | `object` | No | Agents' priorities in a group as a map in the `"": ""` format. | +| Parameter | Data type | Required | Notes | +| ---------------------------------- | --------- | -------- | -------------------------------------------------------------------------- | +| `id` | `int` | Yes | The group ID. | +| `name` | `string` | No | The name of the group. Maximum: 180 characters. | +| `language_code` | `string` | No | The code of the group language. | +| `agent_priorities`**1** | `object` | No | Agent priorities in a group as a map in the `"": ""` format. | **1)** The table below presents the possible values for the `agent_priorities` map: | Possible value | Notes | | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `first` | The highest chat routing priority. Agents with the `first` priority get chats before others from the same group, e.g. Bots can get chats before regular Agents. | -| `normal` | The medium chat routing priority. Agents with the `normal` priority get chats before those with the `last` priority, when there are no Agents with the `first` priority available with free slots in the group. | -| `last` | The lowest chat routing priority. Agents with the `last` priority get chats when there are no Agents with the `first` or `normal` priority available with free slots in the group. | +| `first` | The highest chat routing priority. Agents with the `first` priority get chats before others from the same group, for example, bots can get chats before regular agents. | +| `normal` | The medium chat routing priority. Agents with the `normal` priority get chats before those with the `last` priority, when there are no agents with the `first` priority available with free slots in the group. | +| `last` | The lowest chat routing priority. Agents with the `last` priority get chats when there are no agents with the `first` or `normal` priority available with free slots in the group. | | `supervisor` | Agents with the `supervisor` priority will not get any chats assigned automatically. | #### Response @@ -2695,9 +2694,9 @@ Deletes an existing group. #### Request -| Parameter | Data type | Required | Notes | -| --------- | --------- | -------- | -------- | -| `id` | `int` | Yes | Group ID | +| Parameter | Data type | Required | Notes | +| --------- | --------- | -------- | ------------- | +| `id` | `int` | Yes | The group ID. | #### Response @@ -2751,7 +2750,7 @@ Lists all the exisiting groups. | Possible value | Notes | | ------------------ | ------------------------------------------------------------------------------ | -| `agent_priorities` | An object containing Agents belonging to a group, along with their priorities. | +| `agent_priorities` | An object containing agents belonging to a group, along with their priorities. | | `routing_status` | The routing status of a group. | @@ -2796,14 +2795,14 @@ Returns details about a group specified by its `id`. | Parameter | Data type | Required | Notes | | ------------------------ | ---------- | -------- | ----------------------------- | -| `id` | `int` | Yes | Group ID | +| `id` | `int` | Yes | The group ID. | | `fields`**1** | `string[]` | No | Additional fields to include. | **1)** Possible values for the `fields[]` parameter: | Possible value | Notes | | ------------------ | ------------------------------------------------------------------------------ | -| `agent_priorities` | An object containing Agents belonging to a group, along with their priorities. | +| `agent_priorities` | An object containing agents belonging to a group, along with their priorities. | | `routing_status` | The routing status of a group. | @@ -2995,20 +2994,20 @@ Registers a new private property for a given **Client Id**. #### Request -| Parameter | Required | Data type | Notes | -| -------------------------------- | ------------------- | ---------- | ------------------------------------------------------------------------------------ | -| `name` | Yes | `string` | Property name | -| `owner_client_id` | Yes | `string` | **Client Id** that will own the property; must be owned by your organization. | -| `type` | Yes | `string` | Possible values: `int`, `string`, `bool`, and `tokenized_string` | -| `access` | Yes | `object` | | -| `access.` | min. one `location` | `object` | Possible values: `chat`, `thread`, `event`, `license`, `group` | -| `access..` | min. one `user` | `[string]` | Possible `` values: `agent`, `customer`; possible values: `read`, `write` | -| `description` | No | `string` | Property description | -| `domain` **1** | No | `[]` | Array of values that properties can be set to | -| `range` **1** | No | `object` | Range of values that properties can be set to | -| `range.from` | No | `int` | Only values **equal** or **greater** than this parameter can be set to this property | -| `range.to` | No | `int` | Only values **equal** or **lower** than this parameter can be set to this property | -| `default_value` **2** | No | `type` | Default value of property; validated by **domain** or **range**, if one exists | +| Parameter | Required | Data type | Notes | +| -------------------------------- | ------------------- | ---------- | ----------------------------------------------------------------------------------- | +| `name` | Yes | `string` | The property name. | +| `owner_client_id` | Yes | `string` | The client ID that will own the property; must be owned by your organization. | +| `type` | Yes | `string` | Possible values: `int`, `string`, `bool`, `tokenized_string`. | +| `access` | Yes | `object` | | +| `access.` | min. one `location` | `object` | Possible values: `chat`, `thread`, `event`, `license`, `group`. | +| `access..` | min. one `user` | `[string]` | Possible `` values: `agent`, `customer`; possible values: `read`, `write`. | +| `description` | No | `string` | The property description. | +| `domain` **1** | No | `[]` | An array of values that properties can be set to. | +| `range` **1** | No | `object` | A range of values that properties can be set to. | +| `range.from` | No | `int` | Only values equal to or greater than this parameter can be set to this property. | +| `range.to` | No | `int` | Only values equal to or lower than this parameter can be set to this property. | +| `default_value` **2** | No | `type` | The default value of the property; validated by `domain` or `range`, if one exists. | **1)** Only one `domain` and one `range` can be set for a single property.
**2)** Registering a property with `default_value` is possible only if `access.` is set to `license` or to `group`. @@ -3070,10 +3069,10 @@ Unregisters a private property. #### Request -| Parameter | Required | Data type | Notes | -| ----------------- | -------- | --------- | ------------------------------------------------------------------------ | -| `name` | Yes | `string` | Property name | -| `owner_client_id` | Yes | `string` | **Client Id** that owns the property; must be owned by your organization | +| Parameter | Required | Data type | Notes | +| ----------------- | -------- | --------- | ------------------------------------------------------------------------- | +| `name` | Yes | `string` | The property name. | +| `owner_client_id` | Yes | `string` | The client ID that owns the property; must be owned by your organization. | #### Response @@ -3120,11 +3119,11 @@ Publishes a private property. A published property cannot be unpublished or unre #### Request -| Parameter | Required | Data type | Notes | -| ----------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------------------------------- | -| `name` | Yes | `string` | Property name | -| `owner_client_id` | Yes | `string` | **Client Id** that owns the property; must be owned by your organization. | -| `access_type` | Yes | `[string]` | Possible values: `read`, `write`. It determines the access level for the **Client Ids** different than `owner_client_id`. | +| Parameter | Required | Data type | Notes | +| ----------------- | -------- | ---------- | --------------------------------------------------------------------------------------------------------------------- | +| `name` | Yes | `string` | The property name. | +| `owner_client_id` | Yes | `string` | The client ID that owns the property; must be owned by your organization. | +| `access_type` | Yes | `[string]` | Possible values: `read`, `write`. It determines the access level for the client IDs different than `owner_client_id`. | #### Response @@ -3174,7 +3173,7 @@ Lists private and public properties owned by a given **Client Id**. | Parameter | Required | Data type | Notes | | ----------------- | -------- | --------- | --------------------------------------------------------------------------- | -| `owner_client_id` | Yes | `string` | **Client Id** that owns the properties; must be owned by your organization. | +| `owner_client_id` | Yes | `string` | The client ID that owns the properties; must be owned by your organization. | @@ -3223,9 +3222,9 @@ set all properties from your namespace and [public properties](#public-propertie #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | ----------------------- | ------------------------------------------------------------------------------------ | -| `properties` | Yes | [`object`](#properties) | An object with _namespaces_ as keys and _properties_ (grouped in objects) as values. | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | ----------------------- | -------------------------------------------------------------------------------- | +| `properties` | Yes | [`object`](#properties) | An object with namespaces as keys and properties (grouped in objects) as values. | #### Response @@ -3288,10 +3287,10 @@ For properties without an explicit value assignment, the method will return the #### Request -| Parameter | Required | Data type | Notes | -| ------------- | -------- | --------- | ---------------------- | -| `namespace` | No | `string` | Properties namespace | -| `name_prefix` | No | `string` | Properties name prefix | +| Parameter | Required | Data type | Notes | +| ------------- | -------- | --------- | --------------------------- | +| `namespace` | No | `string` | The properties namespace. | +| `name_prefix` | No | `string` | The properties name prefix. | @@ -3341,9 +3340,9 @@ delete all properties from your namespace and [public properties](#public-proper #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | ----------------------- | --------------------------------------------------------------------------------- | -| `properties` | Yes | [`object`](#properties) | An object with _namespaces_ as keys and _property_names_ (in an array) as values. | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | ----------------------- | ----------------------------------------------------------------------------- | +| `properties` | Yes | [`object`](#properties) | An object with namespaces as keys and property names (in an array) as values. | #### Response @@ -3396,10 +3395,10 @@ set all properties from your namespace and [public properties](#public-propertie #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | ----------------------- | ------------------------------------------------------------------------------------ | -| `group_id` | Yes | `number` | ID of the group you set the properties for. | -| `properties` | Yes | [`object`](#properties) | An object with _namespaces_ as keys and _properties_ (grouped in objects) as values. | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | ----------------------- | -------------------------------------------------------------------------------- | +| `group_id` | Yes | `number` | The ID of the group you set the properties for. | +| `properties` | Yes | [`object`](#properties) | An object with namespaces as keys and properties (grouped in objects) as values. | #### Response @@ -3458,11 +3457,11 @@ Returns the properties set within specified groups. #### Request -| Parameter | Required | Data type | Notes | -| ------------- | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------- | -| `group_ids` | Yes | `[]int` | IDs of the groups you retrieve properties from. Properties from all groups will be returned if an empty array is provided. | -| `namespace` | No | `string` | Properties namespace | -| `name_prefix` | No | `string` | Properties name prefix | +| Parameter | Required | Data type | Notes | +| ------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------ | +| `group_ids` | Yes | `[]int` | The IDs of the groups you retrieve properties from. Properties from all groups will be returned if an empty array is provided. | +| `namespace` | No | `string` | The properties namespace. | +| `name_prefix` | No | `string` | The properties name prefix. | @@ -3513,10 +3512,10 @@ delete all properties from your namespace and [public properties](#public-proper #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | ----------------------- | --------------------------------------------------------------------------------- | -| `id` | Yes | `number` | ID of the group you delete properties from. | -| `properties` | Yes | [`object`](#properties) | An object with _namespaces_ as keys and _property_names_ (in an array) as values. | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | ----------------------- | ----------------------------------------------------------------------------- | +| `id` | Yes | `number` | The ID of the group you delete properties from. | +| `properties` | Yes | [`object`](#properties) | An object with namespaces as keys and property names (in an array) as values. | #### Response @@ -3696,10 +3695,10 @@ Lists the exisiting tags. #### Request -| Parameter | Required | Data type | Notes | -| ------------------- | -------- | --------- | --------------------------------------------------- | -| `filters` | No | `object` | Possible request filters. | -| `filters.group_ids` | Yes | `int[]` | IDs of the groups from which you want to list tags. | +| Parameter | Required | Data type | Notes | +| ------------------- | -------- | --------- | ------------------------------------------------------- | +| `filters` | No | `object` | Possible request filters. | +| `filters.group_ids` | Yes | `int[]` | The IDs of the groups from which you want to list tags. | @@ -3863,24 +3862,24 @@ For `bot` webhooks, you need to [create a bot](#create-bot), [register webhooks] **1)** Token scopes are assigned to an access token, not to an application (Client ID). For this method, we recommend authorizing with a [Personal Access Token (PAT)](/authorization/agent-authorization#personal-access-tokens). Make sure your PAT has the `webhooks.configuration:rw` scope. -| Parameter | Required | Data type | Notes | -| ----------------------------------------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action`**2** | yes | `string` | The [action](#triggering-actions) that triggers sending a webhook. | -| `secret_key` | yes | `string` | The secret key sent in webhooks to verify the source of a webhook. | -| `url` | yes | `string` | Destination URL for the webhook | -| `additional_data` | no | `[]string` | Additional data arriving with the webhook. Value: `chat_properties`, `chat_presence_user_ids` (all actions except for `agent_status_changed`, `agent_deleted`) | -| `description` | no | `string` | Webhook description | -| `filters` | no | `object` | Filters to check if a webhook should be triggered. | -| `filters.author_type` | no | `string` | Possible values: `customer`, `agent`; allowed only for the `incoming_event` and `event_updated` actions. | -| `filters.only_my_chats` | no | `bool` | `true` or `false`; triggers webhooks only for chats with the property `source.client_id` set to my `client_id`. | -| `filters.chat_presence` | no | `object` | Filters to check if a webhook should be triggered based on user's presence in the chat. | -| `filters.chat_presence.user_ids` | no | `object` | Only one filter (`values` or `exclude_values`) is allowed. Supports every user type (agent, customer, bot). | -| `filters.chat_presence.user_ids.values` | no | `[]string` | Array of Users' ids; if any specified User is in the chat, the webhook will be triggered. | -| `filters.chat_presence.user_ids.exclude_values` | no | `[]string` | Array of Users' ids; if any specified Users is in the chat, the webhook will not be triggered. | -| `filters.chat_presence.my_bots` | no | `bool` | If any bot owned by `owner_client_id` is in the chat, the webhook will be triggered. | -| `filters.source_type` | no | `[]string` | Array of source types. Possible values: `my_client` (client ID of your app), `other_clients` (client IDs other than your app's), `system` (no client ID); if the source which triggered the webhook matches the filter, the webhook will be sent. | -| `owner_client_id` | yes | `string` | **Client Id** that will own the webhook; must be owned by your organization. | -| `type` | yes | `string` | `bot` or `license` | +| Parameter | Required | Data type | Notes | +| ----------------------------------------------- | -------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `action`**2** | yes | `string` | The [action](#triggering-actions) that triggers sending a webhook. | +| `secret_key` | yes | `string` | The secret key sent in webhooks to verify the source of a webhook. | +| `url` | yes | `string` | The destination URL for the webhook. | +| `additional_data` | no | `[]string` | Additional data arriving with the webhook. Possible values: `chat_properties`, `chat_presence_user_ids` (all actions except for `agent_status_changed`, `agent_deleted`). | +| `description` | no | `string` | The webhook description. | +| `filters` | no | `object` | Filters to check if a webhook should be triggered. | +| `filters.author_type` | no | `string` | Possible values: `customer`, `agent`; allowed only for the `incoming_event` and `event_updated` actions. | +| `filters.only_my_chats` | no | `bool` | If set to `true`: triggers webhooks only for chats with the property `source.client_id` set to my `client_id`. | +| `filters.chat_presence` | no | `object` | Filters to check if a webhook should be triggered based on user's presence in the chat. | +| `filters.chat_presence.user_ids` | no | `object` | Only one filter (`values` or `exclude_values`) is allowed. Supports every user type (agent, customer, bot). | +| `filters.chat_presence.user_ids.values` | no | `[]string` | An array of user IDs; if any specified user is in the chat, the webhook will be triggered. | +| `filters.chat_presence.user_ids.exclude_values` | no | `[]string` | An array of user IDs; if any specified user is in the chat, the webhook will not be triggered. | +| `filters.chat_presence.my_bots` | no | `bool` | If set to `true`: the webhook will be triggered if any bot owned by `owner_client_id` is in the chat. | +| `filters.source_type` | no | `[]string` | An array of source types. Possible values: `my_client` (client ID of your app), `other_clients` (client IDs other than your app's), `system` (no client ID); if the source which triggered the webhook matches the filter, the webhook will be sent. | +| `owner_client_id` | yes | `string` | The client ID that will own the webhook; must be owned by your organization. | +| `type` | yes | `string` | Possible values: `bot`, `license`. | #### Triggering actions @@ -3976,7 +3975,7 @@ Lists all webhooks registered for the given Client ID. | Parameter | Required | Data type | Notes | | ----------------- | -------- | --------- | ---------------------------------------------------------------------- | -| `owner_client_id` | yes | `string` | The webhook owner (the Client ID for which the webhook is registered). | +| `owner_client_id` | yes | `string` | The webhook owner (the client ID for which the webhook is registered). | @@ -4022,8 +4021,8 @@ Unregisters a webhook previously [registered](#register-webhook) for a Client ID | Parameter | Required | Data type | Notes | | ----------------- | -------- | --------- | ---------------------------------------------------------------------- | -| `id` | Yes | `string` | Webhook ID | -| `owner_client_id` | Yes | `string` | The webhook owner (the Client ID for which the webhook is registered). | +| `id` | Yes | `string` | The webhook ID. | +| `owner_client_id` | Yes | `string` | The webhook owner (the client ID for which the webhook is registered). | #### Response @@ -4070,9 +4069,9 @@ Lists all webhooks that are supported in a given API version. This method requir #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | ------------------------------------------ | -| `version` | No | `string` | Defaults to the current stable API version | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ---------------------------------------- | +| `version` | No | `string` | Default: the current stable API version. | @@ -4118,9 +4117,9 @@ Otherwise, the webhooks will be automatically enabled when the associated applic #### Request -| Parameter | Required | Data type | Notes | -| ----------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `owner_client_id` | Yes | `string` | Required only when authorizing via [PATs](/authorization/agent-authorization#personal-access-tokens). When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. | +| Parameter | Required | Data type | Notes | +| ----------------- | -------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `owner_client_id` | Yes | `string` | Required only when authorizing via [PATs](/authorization/agent-authorization#personal-access-tokens). When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and the provided `owner_client_id` will be used instead. | #### Response @@ -4165,9 +4164,9 @@ To enable the webhooks again (and to rely on automatic webhooks enablement), use #### Request -| Parameter | Required | Data type | Notes | -| ----------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `owner_client_id` | Yes | `string` | Required only when authorizing via [PATs](/authorization/agent-authorization#personal-access-tokens). When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. | +| Parameter | Required | Data type | Notes | +| ----------------- | -------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `owner_client_id` | Yes | `string` | Required only when authorizing via [PATs](/authorization/agent-authorization#personal-access-tokens). When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and the provided `owner_client_id` will be used instead. | #### Response @@ -4211,9 +4210,9 @@ Gets the state of the webhooks registered for a given **Client Id** (application #### Request -| Parameter | Required | Data type | Notes | -| ----------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `owner_client_id` | Yes | `string` | Required only when authorizing via [PATs](/authorization/agent-authorization#personal-access-tokens). When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. | +| Parameter | Required | Data type | Notes | +| ----------------- | -------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `owner_client_id` | Yes | `string` | Required only when authorizing via [PATs](/authorization/agent-authorization#personal-access-tokens). When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and the provided `owner_client_id` will be used instead. | @@ -4259,20 +4258,20 @@ Creates a new canned response. #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------------- | -------------------------------------------------------- | -| `text` | Yes | `string` | Canned response text content **1** | -| `tags` | Yes | `array[string]` | Array of tags | -| `group_id` | Yes | `number` | ID of the group the canned response belongs to | -| `is_private` | No | `bool` | Whether the canned response is private; default: `false` | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------------- | -------------------------------------------------------------------------------------------------------------- | +| `text` | Yes | `string` | The canned response text content. **1** | +| `tags` | Yes | `array[string]` | An array of tags. | +| `group_id` | Yes | `number` | The ID of the group the canned response belongs to. | +| `is_private` | No | `bool` | If set to `true`: the canned response will be private. If set to `false`: it will be public. Default: `false`. | **1)** `text` is sanitized when created. If sanitization removes all content and the input becomes empty, the system rejects the request as invalid. #### Response -| Parameter | Data type | Notes | -| --------- | --------- | --------------------------------- | -| `id` | `number` | ID of the created canned response | +| Parameter | Data type | Notes | +| --------- | --------- | -------------------------------------- | +| `id` | `number` | The ID of the created canned response. | @@ -4319,13 +4318,13 @@ Updates an existing canned response. #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------------- | -------------------------------------- | -| `id` | Yes | `number` | ID of the canned response to update | -| `text` | No | `string` | New canned response text 1 | -| `tags` | No | `array[string]` | Array of tags | -| `group_id` | No | `number` | New group ID for the canned response | -| `is_private` | No | `bool` | Whether the canned response is private | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------------- | -------------------------------------------------------------------------------------------- | +| `id` | Yes | `number` | The ID of the canned response to update. | +| `text` | No | `string` | The new canned response text. 1 | +| `tags` | No | `array[string]` | An array of tags. | +| `group_id` | No | `number` | The new group ID for the canned response. | +| `is_private` | No | `bool` | If set to `true`: the canned response will be private. If set to `false`: it will be public. | **1)** `text` is sanitized when created. If sanitization removes all content and the input becomes empty, the system rejects the request as invalid. @@ -4378,31 +4377,31 @@ Returns a paginated list of canned responses. | Parameter | Required | Data type | Notes | | ----------------- | -------- | --------------- | ----------------------------------------------------------------------------------------- | -| `group_ids` | No | `array[number]` | Filter by specific group IDs (if not provided, defaults to groups the user has access to) | -| `include_private` | No | `bool` | Include private canned responses; default: `false` | -| `limit` | No | `number` | Number of results per page (1-100000, default: 100) | -| `page_id` | No | `string` | Page ID for pagination | +| `group_ids` | No | `array[number]` | Filter by specific group IDs. If not provided, defaults to groups the user has access to. | +| `include_private` | No | `bool` | If set to `true`: private canned responses will be included. Default: `false`. | +| `limit` | No | `number` | The number of results per page. Minimum: 1. Maximum: 100000. Default: 100. | +| `page_id` | No | `string` | The page ID for pagination. | #### Response -| Parameter | Data type | Notes | -| ------------------------ | ----------------------- | -------------------------------------- | -| `canned_responses` | `array[CannedResponse]` | Array of canned response objects | -| `found_canned_responses` | `number` | Total number of canned responses found | -| `next_page_id` | `string` | Page ID for next page (if exists) | +| Parameter | Data type | Notes | +| ------------------------ | ----------------------- | -------------------------------------------- | +| `canned_responses` | `array[CannedResponse]` | An array of canned response objects. | +| `found_canned_responses` | `number` | The total number of canned responses found. | +| `next_page_id` | `string` | The page ID for the next page, if it exists. | ##### Response -| Parameter | Data type | Notes | -| ------------ | --------------- | ---------------------------------------------- | -| `id` | `number` | Canned response ID | -| `text` | `string` | Canned response text content | -| `tags` | `array[string]` | Array of tags | -| `group_id` | `number` | Group ID the canned response belongs to | -| `is_private` | `bool` | Whether the canned response is private | -| `author_id` | `string` | User ID of the last editor | -| `created_at` | `string` | Specifies when the canned response was created | -| `updated_at` | `string` | Specifies when the canned response was updated | +| Parameter | Data type | Notes | +| ------------ | --------------- | ----------------------------------------------- | +| `id` | `number` | The canned response ID. | +| `text` | `string` | The canned response text content. | +| `tags` | `array[string]` | An array of tags. | +| `group_id` | `number` | The group ID the canned response belongs to. | +| `is_private` | `bool` | `true` when the canned response is private. | +| `author_id` | `string` | The user ID of the last editor. | +| `created_at` | `string` | Specifies when the canned response was created. | +| `updated_at` | `string` | Specifies when the canned response was updated. | @@ -4471,9 +4470,9 @@ Deletes an existing canned response. #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | ----------------------------------- | -| `id` | Yes | `number` | ID of the canned response to delete | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ---------------------------------------- | +| `id` | Yes | `number` | The ID of the canned response to delete. | #### Response @@ -4535,11 +4534,11 @@ Empty request payload. The response is an array of the channel objects: -| Field | Data type | Notes | -| -------------------------- | --------- | ------------------------------------------------------------------------------------------ | -| `channel_type` | `string` | Possible values: `code`, `direct_link` or `integration` | -| `channel_subtype` | `string` | Possible values: An empty string for `code` and `direct_link`; Client ID for `integration` | -| `first_activity_timestamp` | `string` | RFC 3339 date-time format | +| Field | Data type | Notes | +| -------------------------- | --------- | ---------------------------------------------------------------------------- | +| `channel_type` | `string` | Possible values: `code`, `direct_link`, `integration`. | +| `channel_subtype` | `string` | An empty string for `code` and `direct_link`. A Client ID for `integration`. | +| `first_activity_timestamp` | `string` | The RFC 3339 date-time format. | @@ -4583,9 +4582,9 @@ Resource limits in the LiveChat product are different for each plan. This method #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | ------------------------------------------------------------------ | -| `plan` | yes | `string` | Possible values: `starter`, `team`, `enterprise`, `enterpriseplus` | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------------------------------------------------------------- | +| `plan` | yes | `string` | Possible values: `starter`, `team`, `enterprise`, `enterpriseplus`. | #### Response @@ -4691,9 +4690,9 @@ Reactivates email if it has been bounced. #### Request -| Parameter | Required | Data type | Notes | -| ---------- | -------- | --------- | -------- | -| `agent_id` | Yes | `string` | Agent ID | +| Parameter | Required | Data type | Notes | +| ---------- | -------- | --------- | ------------- | +| `agent_id` | Yes | `string` | The agent ID. | #### Response @@ -4739,24 +4738,24 @@ Updates company details of the license. #### Request -| Parameter | Required | Data type | Notes | -| --------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------- | -| `enrich` | No | `bool` | Whether the system should attempt to automatically fill empty fields by searching for company's domain. | -| `audience` | No | `string` | Audience | -| `chat_purpose` | No | `string` | Chat purpose | -| `city` | No | `string` | City | -| `company` | No | `string` | Company | -| `company_size` | No | `string` | Company size | -| `country` | No | `string` | Country | -| `invoice_email` | No | `string` | Invoice email | -| `invoice_name` | No | `string` | Invoice name | -| `nip` | No | `string` | Employer Identification Number | -| `postal_code` | No | `string` | Postal code | -| `state` | No | `string` | State | -| `street` | No | `string` | Street | -| `phone` | No | `string` | Phone | -| `province` | No | `string` | Province | -| `url` | No | `string` | URL | +| Parameter | Required | Data type | Notes | +| --------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------- | +| `enrich` | No | `bool` | If set to `true`: the system will attempt to automatically fill empty fields by searching for the company's domain. | +| `audience` | No | `string` | The audience. | +| `chat_purpose` | No | `string` | The chat purpose. | +| `city` | No | `string` | The city. | +| `company` | No | `string` | The company. | +| `company_size` | No | `string` | The company size. | +| `country` | No | `string` | The country. | +| `invoice_email` | No | `string` | The invoice email. | +| `invoice_name` | No | `string` | The invoice name. | +| `nip` | No | `string` | The Employer Identification Number. | +| `postal_code` | No | `string` | The postal code. | +| `state` | No | `string` | The state. | +| `street` | No | `string` | The street. | +| `phone` | No | `string` | The phone. | +| `province` | No | `string` | The province. | +| `url` | No | `string` | The URL. | #### Response diff --git a/src/pages/management/webhooks/index.mdx b/src/pages/management/webhooks/index.mdx index 2a7c718b8..f29eb5900 100644 --- a/src/pages/management/webhooks/index.mdx +++ b/src/pages/management/webhooks/index.mdx @@ -52,9 +52,9 @@ Indicates about a chat coming with a new thread. The webhook payload contains th #### Webhook payload -| Field | Notes | -| ------ | ----------------------------------------------------------------------- | -| `chat` | [Chat data structure](/messaging/agent-chat-api/data-structures/#chats) | +| Field | Notes | +| ------ | ---------------------------------------------------------------------------- | +| `chat` | The [chat data structure](/messaging/agent-chat-api/data-structures/#chats). | @@ -173,10 +173,10 @@ Indicates about the update of a user's access to a particular chat. It contains #### Webhook payload -| Field | Notes | -| -------- | -------------------------------------------------------------------------------------------------- | -| `id` | Chat ID | -| `access` | The updated chat [access](/messaging/agent-chat-api/v3.6/data-structures/#access-1) data structure | +| Field | Notes | +| -------- | --------------------------------------------------------------------------------------------------- | +| `id` | The chat ID. | +| `access` | The updated chat [access](/messaging/agent-chat-api/v3.6/data-structures/#access-1) data structure. | @@ -230,12 +230,12 @@ Indicates that a chat was transferred to a different group or to an agent. #### Webhook payload -| Field | Notes | -| ---------------- | ------------------------------------------------------------------------ | -| `thread_id` | Present if the chat is active. | -| `transferred_to` | IDs of the groups and agents the chat is assigned to after the transfer. | -| `reason` **\*** | Indicates why the chat was transferred. | -| `queue` | Present if the chat is queued after the transfer. | +| Field | Notes | +| ---------------- | ---------------------------------------------------------------------------- | +| `thread_id` | Present if the chat is active. | +| `transferred_to` | The IDs of the groups and agents the chat is assigned to after the transfer. | +| `reason` **\*** | Indicates why the chat was transferred. | +| `queue` | Present if the chat is queued after the transfer. | **\*)** Possible reasons: `manual`, `inactive`, `assigned`, `unassigned`, `other`. @@ -295,9 +295,9 @@ Indicates that a user (customer or agent) was added to a chat. #### Webhook payload -| Field | Notes | -| ----------- | ------------------------------------ | -| `user_type` | Possible values: `agent`, `customer` | +| Field | Notes | +| ----------- | ------------------------------------- | +| `user_type` | Possible values: `agent`, `customer`. | @@ -354,9 +354,9 @@ Indicates that a user (customer or agent) was removed from a chat. #### Webhook payload -| Field | Notes | -| ----------- | ------------------------------------ | -| `user_type` | Possible values: `agent`, `customer` | +| Field | Notes | +| ----------- | ------------------------------------- | +| `user_type` | Possible values: `agent`, `customer`. | @@ -855,9 +855,9 @@ Indicates about those event properties that were updated. #### Webhook payload -| Field | Notes | -| ------------ | --------------------------------------------------------------------------------------------------------------- | -| `properties` | This is not a full `properties` object. This webhook shows only the properties that have been recently updated. | +| Field | Notes | +| ------------ | ------------------------------------------------------------------------------------------------------- | +| `properties` | Not a full `properties` object. This webhook shows only the properties that have been recently updated. | @@ -915,9 +915,9 @@ Indicates about those event properties that were deleted. #### Webhook payload -| Field | Notes | -| ------------ | --------------------------------------------------------------------------------------------------------------- | -| `properties` | This is not a full `properties` object. This webhook shows only the properties that have been recently updated. | +| Field | Notes | +| ------------ | ------------------------------------------------------------------------------------------------------- | +| `properties` | Not a full `properties` object. This webhook shows only the properties that have been recently updated. | @@ -1077,9 +1077,9 @@ Indicates that an agent's or bot's status has changed. #### Webhook payload -| Field | Notes | -| -------- | ------------------------------------------------------------------------------------ | -| `status` | Possible values: `accepting chats`, `not accepting chats`, `offline` (for Bots only) | +| Field | Notes | +| -------- | ------------------------------------------------------------------------------------- | +| `status` | Possible values: `accepting chats`, `not accepting chats`, `offline` (for bots only). | diff --git a/src/pages/management/webhooks/v3.7/index.mdx b/src/pages/management/webhooks/v3.7/index.mdx index ed6f07166..f43066474 100644 --- a/src/pages/management/webhooks/v3.7/index.mdx +++ b/src/pages/management/webhooks/v3.7/index.mdx @@ -52,9 +52,9 @@ Indicates about a chat coming with a new thread. The webhook payload contains th #### Webhook payload -| Field | Notes | -| ------ | ----------------------------------------------------------------------- | -| `chat` | [Chat data structure](/messaging/agent-chat-api/data-structures/#chats) | +| Field | Notes | +| ------ | ---------------------------------------------------------------------------- | +| `chat` | The [chat data structure](/messaging/agent-chat-api/data-structures/#chats). | @@ -173,10 +173,10 @@ Indicates about the update of a user's access to a particular chat. It contains #### Webhook payload -| Field | Notes | -| -------- | -------------------------------------------------------------------------------------------------- | -| `id` | Chat ID | -| `access` | The updated chat [access](/messaging/agent-chat-api/v3.7/data-structures/#access-1) data structure | +| Field | Notes | +| -------- | --------------------------------------------------------------------------------------------------- | +| `id` | The chat ID. | +| `access` | The updated chat [access](/messaging/agent-chat-api/v3.7/data-structures/#access-1) data structure. | @@ -230,12 +230,12 @@ Indicates that a chat was transferred to a different group or to an agent. #### Webhook payload -| Field | Notes | -| ---------------- | ------------------------------------------------------------------------ | -| `thread_id` | Present if the chat is active. | -| `transferred_to` | IDs of the groups and agents the chat is assigned to after the transfer. | -| `reason` **\*** | Indicates why the chat was transferred. | -| `queue` | Present if the chat is queued after the transfer. | +| Field | Notes | +| ---------------- | ---------------------------------------------------------------------------- | +| `thread_id` | Present if the chat is active. | +| `transferred_to` | The IDs of the groups and agents the chat is assigned to after the transfer. | +| `reason` **\*** | Indicates why the chat was transferred. | +| `queue` | Present if the chat is queued after the transfer. | **\*)** Possible reasons: `manual`, `inactive`, `assigned`, `unassigned`, `other`. @@ -295,9 +295,9 @@ Indicates that a user (customer or agent) was added to a chat. #### Webhook payload -| Field | Notes | -| ----------- | ------------------------------------ | -| `user_type` | Possible values: `agent`, `customer` | +| Field | Notes | +| ----------- | ------------------------------------- | +| `user_type` | Possible values: `agent`, `customer`. | @@ -354,9 +354,9 @@ Indicates that a user (customer or agent) was removed from a chat. #### Webhook payload -| Field | Notes | -| ----------- | ------------------------------------ | -| `user_type` | Possible values: `agent`, `customer` | +| Field | Notes | +| ----------- | ------------------------------------- | +| `user_type` | Possible values: `agent`, `customer`. | @@ -1077,9 +1077,9 @@ Indicates that an agent's or bot's status has changed. #### Webhook payload -| Field | Notes | -| -------- | ------------------------------------------------------------------------------------ | -| `status` | Possible values: `accepting chats`, `not accepting chats`, `offline` (for Bots only) | +| Field | Notes | +| -------- | ------------------------------------------------------------------------------------- | +| `status` | Possible values: `accepting chats`, `not accepting chats`, `offline` (for bots only). | diff --git a/src/pages/messaging/agent-chat-api/data-structures/index.mdx b/src/pages/messaging/agent-chat-api/data-structures/index.mdx index cb350ca64..39268b838 100644 --- a/src/pages/messaging/agent-chat-api/data-structures/index.mdx +++ b/src/pages/messaging/agent-chat-api/data-structures/index.mdx @@ -410,7 +410,7 @@ It is not possible to send a System event in API version 3.6. | `created_at` | optional | | | `email` | optional | | | `email_verified` | optional | Specifies if the customer confirmed their email address. See [Request Email Verification](/messaging/customer-chat-api/v3.6/#request-email-verification). | -| `session_fields` | optional | An array of custom object-enclosed `key:value` pairs. Expires along with the session. | +| `session_fields` | optional | An array of custom object-enclosed key-value pairs. Expires along with the session. | | `name` | optional | | | `events_seen_up_to` | optional | RFC 3339 datetime string | | `visit` | optional | | diff --git a/src/pages/messaging/agent-chat-api/index.mdx b/src/pages/messaging/agent-chat-api/index.mdx index f3aef9715..9a26f37e7 100644 --- a/src/pages/messaging/agent-chat-api/index.mdx +++ b/src/pages/messaging/agent-chat-api/index.mdx @@ -136,16 +136,16 @@ It returns [summaries](/messaging/agent-chat-api/v3.6/data-structures/#chat-summ **\*\*)** `chats--access:ro` - to find chats from groups that the requester (related to the token) is a member of. -| Parameter | Required | Type | Notes | -| ----------------------------------------------------- | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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.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) | -| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, maximum: 100. | -| `page_id` | No | `string` | | +| Parameter | Required | Type | Notes | +| ----------------------------------------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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` | If set to `true`: returns active chats only. If set to `false`: returns inactive chats only. If set to `null` or not provided: returns both active and inactive chats. | +| `filters.include_chats_without_threads` | No | `bool` | If set to `true`: includes chats without any threads in the returned chat summary. Default: `true`. | +| `filters.group_ids` | No | `array` | An array of group IDs. Maximum array size: 200. | +| `filters.properties...` | No | `any` | | +| `sort_order` | No | `string` | Possible values: `asc` - oldest chats first, `desc` - newest chats first. Default: `desc`. | +| `limit` | No | `number` | The maximum number of records returned on each [page](#pagination). Default: 10. Maximum: 100. | +| `page_id` | No | `string` | | `filter_type` can take the following values: @@ -157,12 +157,12 @@ There's only one value allowed for a single property. #### Response -| Field | Data type | Notes | -| ------------------ | --------- | ------------------------------------------------------------------------------------------------------------ | -| `chats_summary` | `array` | An array of [Chat summary](/messaging/agent-chat-api/v3.6/data-structures/#chat-summaries) 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. | +| Field | Data type | Notes | +| ------------------ | --------- | ------------------------------------------------------------------------------------------------------------- | +| `chats_summary` | `array` | An array of [chat summary](/messaging/agent-chat-api/v3.6/data-structures/#chat-summaries) 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. | @@ -263,16 +263,16 @@ It returns threads that the current agent has access to in a given chat. #### Request -| Parameter | Required | Data type | Notes | -| ------------------ | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | | -| `sort_order` | No | `string` | Possible values: `asc` - oldest threads first and `desc` - newest threads first (default). | -| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 3, maximum: 100. To limit the total number of returned records, use `filters`. | -| `page_id` | No | `string` | | -| `min_events_count` | No | `number` | Range: 1-100; Specifies the minimum number of events to be returned in the response. It's the **total** number of events, so they can come from more than one thread. You'll get as many latest threads as needed to meet the `min_events_count` condition. | -| `filters` | No | `object` | | -| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` | -| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` | +| Parameter | Required | Data type | Notes | +| ------------------ | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | | +| `sort_order` | No | `string` | Possible values: `asc` - oldest threads first, `desc` - newest threads first. Default: `desc`. | +| `limit` | No | `number` | The maximum number of records returned on each [page](#pagination). To limit the total number of returned records, use `filters`. Default: 3. Maximum: 100. | +| `page_id` | No | `string` | | +| `min_events_count` | No | `number` | Specifies the minimum number of events to be returned in the response. It's the **total** number of events, so they can come from more than one thread. You'll get as many latest threads as needed to meet the `min_events_count` condition. Minimum: 1. Maximum: 100. | +| `filters` | No | `object` | | +| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds: `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | +| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds: `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | You cannot use either `limit` and `min_events_count` or `filters` and `min_events_count` at the same time. @@ -372,10 +372,10 @@ It returns a thread that the current agent has access to in a given chat. #### Request -| Parameter | Required | Data type | Notes | -| ----------- | -------- | --------- | -------------------------------------- | -| `chat_id` | Yes | `string` | | -| `thread_id` | No | `string` | Default: the latest thread (if exists) | +| Parameter | Required | Data type | Notes | +| ----------- | -------- | --------- | --------------------------------------- | +| `chat_id` | Yes | `string` | | +| `thread_id` | No | `string` | Default: the latest thread (if exists). | @@ -503,33 +503,33 @@ The list classification is based on threads; 1 chat per 1 thread. Thus, the same #### Request -| Parameter | Required | Data type | Notes | -| ---------------------------------------------------------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `filters` | No | `object` | | -| `filters.query` | No | `string` | | -| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` | -| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` | -| `filters.chat_ids` | No | `array` | Array of chat IDs. Max array size: 1000. | -| `filters.thread_ids` | No | `array` | Array of thread IDs. Cannot be used with other filters or pagination; max array size: 20. | -| `filters.group_ids` | No | `array` | Array of group IDs. Max array size: 200 | -| `filters.properties...` | No | `any` | **\* described below** | -| `filters.agents.` | No | `any` | **\*\* described below** `exists` set to `false` will return unassigned chats; `true` will return the assigned ones. | -| `filters.tags.` | No | `any` | | -| `filters.sales.` | No | `any` | | -| `filters.goals.` | No | `any` | | -| `filters.surveys.` | No | `array` | **\*\*\*** **described below** | -| `filters.event_types.` | No | `any` | **\*\*\*\*** **described below** | -| `filters.greetings.` | No | `any` | **\*\*\*\*\*\*** **described below** | -| `filters.agent_response.` | No | `any` | **\*\*\*\*\*\*\*** **described below** | -| `filters.customer_countries.` | No | `any` | It supports country codes with the `ISO 3166-1 Alpha-2` format. | -| `filters.customer_id` | No | `string` | | -| `filters.customer_email` | No | `string` | | -| `page_id` | No | `string` | | -| `sort_order` **\*\*\*\*\*** | No | `string` | Default: `desc` | -| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, min: 1, max: 100. To limit the total number of returned records, use `filters`. | -| `highlights` | No | `object` | Use it to highlight the match of `filters.query`. To enable highlights with default parameters, pass an empty object. | -| `highlights.pre_tag` | No | `string` | An HTML tag to use for highlighting the matched text; default: ``. Use it together with `highlights.post_tag`. | -| `highlights.post_tag` | No | `string` | An HTML tag to use for highlighting the matched text; default: ``. Use it together with `highlights.pre_tag`. | +| Parameter | Required | Data type | Notes | +| ---------------------------------------------------------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `filters` | No | `object` | | +| `filters.query` | No | `string` | | +| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds: `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | +| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds: `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | +| `filters.chat_ids` | No | `array` | An array of chat IDs. Maximum array size: 1000. | +| `filters.thread_ids` | No | `array` | An array of thread IDs. Cannot be used with other filters or pagination. Maximum array size: 20. | +| `filters.group_ids` | No | `array` | An array of group IDs. Maximum array size: 200. | +| `filters.properties...` | No | `any` | **\* described below** | +| `filters.agents.` | No | `any` | **\*\* described below** If `exists` is set to `false`: returns unassigned chats. If set to `true`: returns the assigned ones. | +| `filters.tags.` | No | `any` | | +| `filters.sales.` | No | `any` | | +| `filters.goals.` | No | `any` | | +| `filters.surveys.` | No | `array` | **\*\*\* described below** | +| `filters.event_types.` | No | `any` | **\*\*\*\* described below** | +| `filters.greetings.` | No | `any` | **\*\*\*\*\*\* described below** | +| `filters.agent_response.` | No | `any` | **\*\*\*\*\*\*\* described below** | +| `filters.customer_countries.` | No | `any` | Supports country codes with the `ISO 3166-1 Alpha-2` format. | +| `filters.customer_id` | No | `string` | | +| `filters.customer_email` | No | `string` | | +| `page_id` | No | `string` | | +| `sort_order` **\*\*\*\*\*** | No | `string` | Default: `desc`. | +| `limit` | No | `number` | The maximum number of records returned on each [page](#pagination). To limit the total number of returned records, use `filters`. Default: 10. Minimum: 1. Maximum: 100. | +| `highlights` | No | `object` | Use it to highlight the match of `filters.query`. To enable highlights with default parameters, pass an empty object. | +| `highlights.pre_tag` | No | `string` | An HTML tag to use for highlighting the matched text. Use it together with `highlights.post_tag`. Default: ``. | +| `highlights.post_tag` | No | `string` | An HTML tag to use for highlighting the matched text. Use it together with `highlights.pre_tag`. Default: ``. | **\*)** `` can take the following values: @@ -553,8 +553,8 @@ You can pass only one of the following values at a time: `exists`, `values` or ` **\*\*\*)** `` contains the following fields: -- `from` (`string`) - date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` -- `to` (`string`) - date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` +- `from` (`string`) - date & time format compatible with RFC3339 with a resolution of microseconds: `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` +- `to` (`string`) - date & time format compatible with RFC3339 with a resolution of microseconds: `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` - `exists` (`bool`) - if set to `true`, will return only surveys with `survey_id` - `type` (`string`) - allowed values: `pre_chat`, `post_chat` - `values` (`string[]`) - an array of answer_ids @@ -580,8 +580,8 @@ You can pass only one of the following values at a time: `values` or `exclude_va **\*\*\*\*\*\*)** `` can take the following values: -- `from` (`string`) - Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` -- `to` (`string`) - Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` +- `from` (`string`) - Date & time format compatible with RFC3339 with a resolution of microseconds: `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` +- `to` (`string`) - Date & time format compatible with RFC3339 with a resolution of microseconds: `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` - `exists` (`bool`) - `values` (`int[]`) - an array of greeting IDs - `exclude_values` (`int[]`) - an array of greeting IDs @@ -744,14 +744,14 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch | `chat` | No | `object` | | | `chat.properties` | No | `object` | | | `chat.access` | No | `object` | | -| `chat.users` | No | `[]object` | The list of existing users. Up to 4 additional (other than the requester) agents and 1 customer allowed. | -| `chat.users.id` | Yes | `string` | User ID | -| `chat.users.type` | Yes | `string` | `agent` or `customer` | +| `chat.users` | No | `[]object` | The list of existing users. Up to 4 additional agents (other than the requester) and 1 customer allowed. | +| `chat.users.id` | Yes | `string` | The user ID. | +| `chat.users.type` | Yes | `string` | Possible values: `agent`, `customer`. | | `chat.thread` | No | `object` | | | `chat.thread.events` | No | `array` | The list of initial chat [events](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. | | `chat.thread.properties` | No | `object` | | -| `active` | No | `bool` | When set to `false`, creates an inactive thread; default: `true`. | -| `continuous` | No | `bool` | Starts chat as continuous (online group is not required); default: `false`. | +| `active` | No | `bool` | If set to `false`: creates an inactive thread. Default: `true`. | +| `continuous` | No | `bool` | If set to `true`: starts chat as continuous (online group is not required). Default: `false`. | #### Response @@ -815,17 +815,17 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch | Parameter | Required | Data type | Notes | | ------------------------ | -------- | ---------- | -------------------------------------------------------------------------------------------------------- | | `chat` | Yes | `object` | | -| `chat.id` | Yes | `string` | ID of the chat that will be resumed. | -| `chat.access` | No | `object` | Chat access to set, default: all agents. | -| `chat.properties` | No | `object` | Initial chat properties | -| `chat.users` | No | `[]object` | The list of existing users. Up to 4 additional (other than the requester) agents and 1 customer allowed. | -| `chat.users.id` | Yes | `string` | User ID | -| `chat.users.type` | Yes | `string` | `agent` or `customer` | +| `chat.id` | Yes | `string` | The ID of the chat that will be resumed. | +| `chat.access` | No | `object` | Chat access to set. Default: all agents. | +| `chat.properties` | No | `object` | The initial chat properties. | +| `chat.users` | No | `[]object` | The list of existing users. Up to 4 additional agents (other than the requester) and 1 customer allowed. | +| `chat.users.id` | Yes | `string` | The user ID. | +| `chat.users.type` | Yes | `string` | Possible values: `agent`, `customer`. | | `chat.thread` | No | `object` | | -| `chat.thread.events` | No | `array` | Initial chat events array | -| `chat.thread.properties` | No | `object` | Initial thread properties | -| `active` | No | `bool` | When set to `false`, creates an inactive thread; default: `true`. | -| `continuous` | No | `bool` | Sets a chat to the continuous mode. When unset, leaves the mode unchanged. | +| `chat.thread.events` | No | `array` | An array of initial chat events. | +| `chat.thread.properties` | No | `object` | The initial thread properties. | +| `active` | No | `bool` | If set to `false`: creates an inactive thread. Default: `true`. | +| `continuous` | No | `bool` | If set to `true`: sets a chat to the continuous mode. If not set: leaves the mode unchanged. | #### Response @@ -887,10 +887,10 @@ The requester must be present on the list of chat users. You can override it by #### Request -| Parameter | Required | Data type | Notes | -| --------------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | | -| `ignore_requester_presence` | No | `bool` | If `true`, the requester doesn't need to be present on the list of chat users; default `false`. | +| Parameter | Required | Data type | Notes | +| --------------------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------- | +| `id` | Yes | `string` | | +| `ignore_requester_presence` | No | `bool` | If set to `true`: the requester doesn't need to be present on the list of chat users. Default: `false`. | #### Response @@ -1035,14 +1035,14 @@ Transfers a chat to an agent or a group. The following restrictions apply: #### Request -| Parameter | Required | Data type | Notes | -| ---------------------------- | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | Chat ID | -| `target` | No | `object` | If missing, the chat will be transferred within the current group. | -| `target.type` | Yes | `string` | `group` or `agent` | -| `target.ids` | Yes | `array` | `group` or `agent` IDs array | -| `ignore_agents_availability` | No | `bool` | If `true`, allows the chat to be enqueued after the transfer. Otherwise, fails when unable to immediately assign any agent from the requested groups; default `false`. | -| `ignore_requester_presence` | No | `bool` | If `true`, the requester doesn't need to be present on the list of chat users; default `false`. | +| Parameter | Required | Data type | Notes | +| ---------------------------- | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | Yes | `string` | The chat ID. | +| `target` | No | `object` | If missing: the chat will be transferred within the current group. | +| `target.type` | Yes | `string` | Possible values: `group`, `agent`. | +| `target.ids` | Yes | `array` | An array of `group` or `agent` IDs. | +| `ignore_agents_availability` | No | `bool` | If set to `true`: allows the chat to be enqueued after the transfer. If set to `false`: fails when unable to immediately assign any agent from the requested groups. Default: `false`. | +| `ignore_requester_presence` | No | `bool` | If set to `true`: the requester doesn't need to be present on the list of chat users. Default: `false`. | #### Response @@ -1105,13 +1105,13 @@ To learn how to add more than one agent to the chat, reach out to us [on Discord #### Request -| Parameter | Required | Type | Notes | -| --------------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | | -| `user_id` | Yes | `string` | | -| `user_type` | Yes | `string` | Possible values: `agent` or `customer` | -| `visibility` | Yes | `string` | Possible values: `all` or `agents` | -| `ignore_requester_presence` | No | `bool` | If `true`, the requester doesn't need to be present on the list of chat users; default `false`. | +| Parameter | Required | Type | Notes | +| --------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | | +| `user_id` | Yes | `string` | | +| `user_type` | Yes | `string` | Possible values: `agent`, `customer`. | +| `visibility` | Yes | `string` | Possible values: `all`, `agents`. | +| `ignore_requester_presence` | No | `bool` | If set to `true`: the requester doesn't need to be present on the list of chat users. Default: `false`. | #### Response @@ -1165,12 +1165,12 @@ Removes a user from chat. The following restrictions apply: #### Request -| Parameter | Required | Type | Notes | -| --------------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | | -| `user_id` | Yes | `string` | | -| `user_type` | Yes | `string` | Possible value: `agent` | -| `ignore_requester_presence` | No | `bool` | If `true`, the requester doesn't need to be present on the list of chat users; default `false`. | +| Parameter | Required | Type | Notes | +| --------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | | +| `user_id` | Yes | `string` | | +| `user_type` | Yes | `string` | Possible values: `agent`. | +| `ignore_requester_presence` | No | `bool` | If set to `true`: the requester doesn't need to be present on the list of chat users. Default: `false`. | #### Response @@ -1220,10 +1220,10 @@ Sends an [event](/messaging/agent-chat-api/v3.6/data-structures/#events) that is #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | ------------------------------------------------------------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat you want to send a message to. | -| `event` | Yes | `object` | [Event](/messaging/agent-chat-api/data-structures/#events) object. Supports only `message` type. | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to send a message to. | +| `event` | Yes | `object` | An [event](/messaging/agent-chat-api/data-structures/#events) object. Supports only the `message` type. | #### Response @@ -1280,10 +1280,10 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat you want to send a message to. | -| `event` | Yes | `object` | [Event](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | --------------------------------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to send a message to. | +| `event` | Yes | `object` | An [event](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. | #### Response @@ -1344,9 +1344,9 @@ Uploads a file to the server as a temporary file. It returns a URL that expires #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | ------------------ | -| `file` | Yes | `binary` | maximum size: 10MB | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------------- | +| `file` | Yes | `binary` | Maximum size: 10MB. | @@ -1396,14 +1396,14 @@ curl -X POST \ #### Request -| Parameter | Required | Data type | Notes | -| ------------------ | -------- | --------- | --------------------------- | -| `chat_id` | Yes | `string` | | -| `event_id` | Yes | `string` | | -| `postback` | Yes | `object` | | -| `postback.id` | Yes | `string` | Postback name of the button | -| `postback.toggled` | Yes | `bool` | Postback toggled true/false | -| `thread_id` | Yes | `string` | | +| Parameter | Required | Data type | Notes | +| ------------------ | -------- | --------- | -------------------------------- | +| `chat_id` | Yes | `string` | | +| `event_id` | Yes | `string` | | +| `postback` | Yes | `object` | | +| `postback.id` | Yes | `string` | The postback name of the button. | +| `postback.toggled` | Yes | `bool` | Whether the postback is toggled. | +| `thread_id` | Yes | `string` | | #### Response @@ -1457,7 +1457,7 @@ https://api.livechatinc.com/v3.6/agent/action/send_rich_message_postback \ | Parameter | Required | Data type | Notes | | ------------ | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | Id of the chat you to set properties for. | +| `id` | Yes | `string` | The ID of the chat you want to set properties for. | | `properties` | Yes | `object` | Chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | #### Response @@ -1507,10 +1507,10 @@ https://api.livechatinc.com/v3.6/agent/action/update_chat_properties \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ---------------------------------------------- | -| `id` | Yes | `string` | Id of the chat you want to delete property of. | -| `properties` | Yes | `object` | Chat properties to delete. | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | ------------------------------------------------------ | +| `id` | Yes | `string` | The ID of the chat you want to delete properties from. | +| `properties` | Yes | `object` | Chat properties to delete. | #### Response @@ -1561,8 +1561,8 @@ No response payload (`200 OK`). | Parameter | Required | Data type | Notes | | ------------ | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to set properties for. | -| `thread_id` | Yes | `string` | Id of the thread you want to set properties for. | +| `chat_id` | Yes | `string` | The ID of the chat you want to set properties for. | +| `thread_id` | Yes | `string` | The ID of the thread you want to set properties for. | | `properties` | Yes | `object` | Chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | #### Response @@ -1613,11 +1613,11 @@ curl -X POST \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | -------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to delete properties of. | -| `thread_id` | Yes | `string` | Id of the thread you want to delete properties of. | -| `properties` | Yes | `object` | Thread properties to delete. | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | -------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to delete properties from. | +| `thread_id` | Yes | `string` | The ID of the thread you want to delete properties from. | +| `properties` | Yes | `object` | Thread properties to delete. | #### Response @@ -1669,9 +1669,9 @@ https://api.livechatinc.com/v3.6/agent/action/delete_thread_properties \ | Parameter | Required | Data type | Notes | | ------------ | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to set properties for. | -| `thread_id` | Yes | `string` | Id of the thread you want to set properties for. | -| `event_id` | Yes | `string` | Id of the event you want to set properties for. | +| `chat_id` | Yes | `string` | The ID of the chat you want to set properties for. | +| `thread_id` | Yes | `string` | The ID of the thread you want to set properties for. | +| `event_id` | Yes | `string` | The ID of the event you want to set properties for. | | `properties` | Yes | `object` | Chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | #### Response @@ -1723,12 +1723,12 @@ https://api.livechatinc.com/v3.6/agent/action/update_event_properties \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ------------------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat you want to delete the properties of. | -| `thread_id` | Yes | `string` | Id of the thread you want to delete the properties of. | -| `event_id` | Yes | `string` | Id of the event you want to delete the properties of. | -| `properties` | Yes | `object` | Event properties to delete. | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | ------------------------------------------------------------ | +| `chat_id` | Yes | `string` | The ID of the chat you want to delete the properties from. | +| `thread_id` | Yes | `string` | The ID of the thread you want to delete the properties from. | +| `event_id` | Yes | `string` | The ID of the event you want to delete the properties from. | +| `properties` | Yes | `object` | Event properties to delete. | #### Response @@ -1785,11 +1785,11 @@ Read how to [list all available tags](/management/configuration-api/v3.6#list-ta #### Request -| Parameter | Required | Data type | Notes | -| ----------- | -------- | --------- | ------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat you want to add a tag to. | -| `thread_id` | Yes | `string` | Id of the thread you want to add a tag to. | -| `tag` | Yes | `string` | Tag name. It's case sensitive. | +| Parameter | Required | Data type | Notes | +| ----------- | -------- | --------- | ---------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to add a tag to. | +| `thread_id` | Yes | `string` | The ID of the thread you want to add a tag to. | +| `tag` | Yes | `string` | The tag name. It's case sensitive. | #### Response @@ -1837,11 +1837,11 @@ Untags a given **thread**. #### Request -| Parameter | Required | Data type | Notes | -| ----------- | -------- | --------- | ----------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to remove a tag from. | -| `thread_id` | Yes | `string` | Id of the thread you want to remove a tag from. | -| `tag` | Yes | `string` | Tag name. It's case sensitive. | +| Parameter | Required | Data type | Notes | +| ----------- | -------- | --------- | --------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to remove a tag from. | +| `thread_id` | Yes | `string` | The ID of the thread you want to remove a tag from. | +| `tag` | Yes | `string` | The tag name. It's case sensitive. | #### Response @@ -1895,16 +1895,16 @@ Returns the info about the customer with a given `id`. | Field | Data type | Notes | | ---------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `id` | string | [Customer's](/messaging/agent-chat-api/v3.6/data-structures/#customer) ID. | +| `id` | string | The [customer's](/messaging/agent-chat-api/v3.6/data-structures/#customer) ID. | | `type` | string | `customer` | -| `name` | string | Customer's name. Returned only if set. | -| `email` | string | Customer's email. Returned only if set. | -| `avatar` | string | Customer's avatar. Returned only if set. | -| `created_at` | string | Specifies when the customer's identity was created. | -| `session_fields` | []object | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| `name` | string | The customer's name. Returned only if set. | +| `email` | string | The customer's email. Returned only if set. | +| `avatar` | string | The customer's avatar. Returned only if set. | +| `created_at` | string | The date and time when the customer's identity was created. | +| `session_fields` | []object | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | | `statistics` | object | Counters for started threads, opened pages, etc. | | `visit` | object | Geolocation and opened pages from the customer's most recent online visit. Returned only if the customer logged in at least once. | -| `chat_ids` | []string | IDs of a customer's chats. Returned only if the customer had at least one chat. | +| `chat_ids` | []string | The IDs of the customer's chats. Returned only if the customer had at least one chat. | @@ -2008,13 +2008,13 @@ The webhook will be sent only if the customer has active chats. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `id` | Yes | `string` | UUID v4 format is required | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `id` | Yes | `string` | The UUID v4 format is required. | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | The URL of the customer's avatar. | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | Apart from `id`, which is a required parameter, you also need to include **one of the optional** parameters. @@ -2224,10 +2224,10 @@ Changes the status of an agent or a bot agent. #### Request -| Parameter | Required | Data type | Notes | -| ---------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------ | -| `status` | Yes | `string` | For Agents: `accepting_chats` or `not_accepting_chats`; for bot agents: `accepting_chats`, `not_accepting_chats`, or `offline` | -| `agent_id` | No | `string` | If not specified, the requester's status will be updated. | +| Parameter | Required | Data type | Notes | +| ---------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------- | +| `status` | Yes | `string` | For agents: `accepting_chats` or `not_accepting_chats`. For bot agents: `accepting_chats`, `not_accepting_chats`, or `offline`. | +| `agent_id` | No | `string` | If not specified, the requester's status will be updated. | #### Response @@ -2338,10 +2338,10 @@ It marks an agent’s events up to a specific time as read in a customer’s cha #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ------------------------- | -| `chat_id` | Yes | `string` | | -| `seen_up_to` | Yes | `string` | RFC 3339 date-time format | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | ------------------------------ | +| `chat_id` | Yes | `string` | | +| `seen_up_to` | Yes | `string` | The RFC 3339 date-time format. | #### Response @@ -2386,13 +2386,13 @@ https://api.livechatinc.com/v3.6/agent/action/mark_events_as_seen \ #### Request -| Parameter | Required | Data type | Notes | -| ------------- | -------- | --------- | ------------------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat that to send the thinking indicator to. | -| `title` | No | `string` | | -| `description` | No | `string` | | -| `visibility` | No | `string` | Default: `all`; `agents` | -| `custom_id` | No | `string` | | +| Parameter | Required | Data type | Notes | +| ------------- | -------- | --------- | ----------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat to send the thinking indicator to. | +| `title` | No | `string` | | +| `description` | No | `string` | | +| `visibility` | No | `string` | Possible values: `all`, `agents`. Default: `all`. | +| `custom_id` | No | `string` | | #### Response @@ -2440,11 +2440,11 @@ https://api.livechatinc.com/v3.6/agent/action/send_thinking_indicator \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ---------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat that to send the typing indicator to. | -| `visibility` | No | `string` | Default: `all`; `agents` | -| `is_typing` | Yes | `bool` | | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | --------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat to send the typing indicator to. | +| `visibility` | No | `string` | Possible values: `all`, `agents`. Default: `all`. | +| `is_typing` | Yes | `bool` | | #### Response @@ -2489,11 +2489,11 @@ For example, it could be used in an app that sends notifications to Agents or Cu #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ------------------------- | -| `recipients` | Yes | `object` | **\*** | -| `content` | Yes | `any` | A JSON message to be sent | -| `type` | No | `string` | Multicast message type | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | --------------------------- | +| `recipients` | Yes | `object` | **\*** | +| `content` | Yes | `any` | A JSON message to be sent. | +| `type` | No | `string` | The multicast message type. | **\*)** `recipients` can take the following values: @@ -2569,9 +2569,9 @@ It returns the Agents you can transfer a chat to. Agents are sorted ascendingly #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | --------------------------------------- | -| `chat_id` | Yes | `string` | The ID of the chat you want to transfer | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ---------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to transfer. | diff --git a/src/pages/messaging/agent-chat-api/rtm-reference/index.mdx b/src/pages/messaging/agent-chat-api/rtm-reference/index.mdx index 01becc84f..ecfe40a57 100644 --- a/src/pages/messaging/agent-chat-api/rtm-reference/index.mdx +++ b/src/pages/messaging/agent-chat-api/rtm-reference/index.mdx @@ -178,16 +178,16 @@ It returns [summaries](/messaging/agent-chat-api/v3.6/data-structures/#chat-summ #### Request -| Parameter | Required | Type | Notes | -| ----------------------------------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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.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) | -| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, maximum: 100. | -| `page_id` | No | `string` | | +| Parameter | Required | Type | Notes | +| ----------------------------------------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `filters` | No | `object` | When paginating, the `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` | If set to `true`: returns active chats only. If set to `false`: returns inactive chats only. If set to `null` or not provided: returns both active and inactive chats. | +| `filters.include_chats_without_threads` | No | `bool` | If set to `true`: the returned chat summary includes chats without any threads. Default: `true`. | +| `filters.group_ids` | No | `array` | An array of group IDs. Maximum array size: 200. | +| `filters.properties...` | No | `any` | | +| `sort_order` | No | `string` | Possible values: `asc` - oldest chats first, `desc` - newest chats first. Default: `desc`. | +| `limit` | No | `number` | The maximum number of records returned on each [page](#pagination). Default: 10. Maximum: 100. | +| `page_id` | No | `string` | | `filter_type` can take the following values: @@ -199,12 +199,12 @@ There's only one value allowed for a single property. #### Response -| Field | Data type | Notes | -| ------------------ | --------- | ------------------------------------------------------------------------------------------------------------ | -| `chats_summary` | `array` | An array of [Chat summary](/messaging/agent-chat-api/v3.6/data-structures/#chat-summaries) 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. | +| Field | Data type | Notes | +| ------------------ | --------- | ----------------------------------------------------------------------------------------------------------------- | +| `chats_summary` | `array` | An array of [Chat summary](/messaging/agent-chat-api/v3.6/data-structures/#chat-summaries) data structures. | +| `next_page_id` | `string` | In relation to the `page_id` specified in the request. Appears in the response only when there's a next page. | +| `previous_page_id` | `string` | In relation to the `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. | @@ -311,16 +311,16 @@ It returns threads that the current agent has access to in a given chat. #### Request -| Parameter | Required | Data type | Notes | -| ------------------ | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | | -| `sort_order` | No | `string` | Possible values: `asc` - oldest threads first and `desc` - newest threads first (default). | -| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 3, maximum: 100. To limit the total number of returned records, use `filters`. | -| `page_id` | No | `string` | | -| `min_events_count` | No | `number` | Range: 1-100; Specifies the minimum number of events to be returned in the response. It's the **total** number of events, so they can come from more than one thread. You'll get as many latest threads as needed to meet the `min_events_count` condition. | -| `filters` | No | `object` | | -| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` | -| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` | +| Parameter | Required | Data type | Notes | +| ------------------ | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | | +| `sort_order` | No | `string` | Possible values: `asc` - oldest threads first, `desc` - newest threads first. Default: `desc`. | +| `limit` | No | `number` | The maximum number of records returned on each [page](#pagination). To limit the total number of returned records, use `filters`. Default: 3. Maximum: 100. | +| `page_id` | No | `string` | | +| `min_events_count` | No | `number` | The minimum number of events to be returned in the response. It's the **total** number of events, so they can come from more than one thread. You'll get as many latest threads as needed to meet the `min_events_count` condition. Minimum: 1. Maximum: 100. | +| `filters` | No | `object` | | +| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | +| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | You cannot use either `limit` and `min_events_count` or `filters` and `min_events_count` at the same time. @@ -425,10 +425,10 @@ It returns a thread that the current agent has access to in a given chat. #### Request -| Parameter | Required | Data type | Notes | -| ----------- | -------- | --------- | -------------------------------------- | -| `chat_id` | Yes | `string` | | -| `thread_id` | No | `string` | Default: the latest thread (if exists) | +| Parameter | Required | Data type | Notes | +| ----------- | -------- | --------- | --------------------------------------- | +| `chat_id` | Yes | `string` | | +| `thread_id` | No | `string` | Default: the latest thread (if exists). | @@ -560,33 +560,33 @@ The list classification is based on threads; 1 chat per 1 thread. Thus, the same #### Request -| Parameter | Required | Data type | Notes | -| ---------------------------------------------------------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `filters` | No | `object` | | -| `filters.query` | No | `string` | | -| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` | -| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` | -| `filters.chat_ids` | No | `array` | Array of chat IDs. Max array size: 1000. | -| `filters.thread_ids` | No | `array` | Array of thread IDs. Cannot be used with other filters or pagination; max array size: 20. | -| `filters.group_ids` | No | `array` | Array of group IDs. Max array size: 200 | -| `filters.properties...` | No | `any` | **\* described below** | -| `filters.agents.` | No | `any` | **\*\* described below** `exists` see to `false` will return unassigned chats; `true` will return the assigned ones. | -| `filters.tags.` | No | `any` | | -| `filters.sales.` | No | `any` | | -| `filters.goals.` | No | `any` | | -| `filters.surveys.` | No | `array` | **\*\*\*** **described below** | -| `filters.event_types.` | No | `any` | **\*\*\*\*** **described below** | -| `filters.greetings.` | No | `any` | **\*\*\*\*\*\*** **described below** | -| `filters.agent_response.` | No | `any` | **\*\*\*\*\*\*\*** **described below** | -| `filters.customer_countries.` | No | `any` | It supports country codes with the `ISO 3166-1 Alpha-2` format. | -| `filters.customer_id` | No | `string` | | -| `filters.customer_email` | No | `string` | | -| `page_id` | No | `string` | | -| `sort_order` **\*\*\*\*\*** | No | `string` | Default: `desc` | -| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, min: 1, max: 100. To limit the total number of returned records, use `filters`. | -| `highlights` | No | `object` | Use it to highlight the match of `filters.query`. To enable highlights with default parameters, pass an empty object. | -| `highlights.pre_tag` | No | `string` | An HTML tag to use for highlighting the matched text; default: ``. Use it together with `highlights.post_tag`. | -| `highlights.post_tag` | No | `string` | An HTML tag to use for highlighting the matched text; default: ``. Use it together with `highlights.pre_tag`. | +| Parameter | Required | Data type | Notes | +| ---------------------------------------------------------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `filters` | No | `object` | | +| `filters.query` | No | `string` | | +| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | +| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | +| `filters.chat_ids` | No | `array` | An array of chat IDs. Maximum array size: 1000. | +| `filters.thread_ids` | No | `array` | An array of thread IDs. Cannot be used with other filters or pagination. Maximum array size: 20. | +| `filters.group_ids` | No | `array` | An array of group IDs. Maximum array size: 200. | +| `filters.properties...` | No | `any` | **\* described below** | +| `filters.agents.` | No | `any` | **\*\* described below** If `exists` is set to `false`, will return unassigned chats; `true` will return the assigned ones. | +| `filters.tags.` | No | `any` | | +| `filters.sales.` | No | `any` | | +| `filters.goals.` | No | `any` | | +| `filters.surveys.` | No | `array` | **\*\*\*** **described below** | +| `filters.event_types.` | No | `any` | **\*\*\*\*** **described below** | +| `filters.greetings.` | No | `any` | **\*\*\*\*\*\*** **described below** | +| `filters.agent_response.` | No | `any` | **\*\*\*\*\*\*\*** **described below** | +| `filters.customer_countries.` | No | `any` | It supports country codes with the `ISO 3166-1 Alpha-2` format. | +| `filters.customer_id` | No | `string` | | +| `filters.customer_email` | No | `string` | | +| `page_id` | No | `string` | | +| `sort_order` **\*\*\*\*\*** | No | `string` | Default: `desc`. | +| `limit` | No | `number` | The maximum number of records returned on each [page](#pagination). To limit the total number of returned records, use `filters`. Default: 10. Minimum: 1. Maximum: 100. | +| `highlights` | No | `object` | Use it to highlight the match of `filters.query`. To enable highlights with default parameters, pass an empty object. | +| `highlights.pre_tag` | No | `string` | An HTML tag to use for highlighting the matched text. Use it together with `highlights.post_tag`. Default: ``. | +| `highlights.post_tag` | No | `string` | An HTML tag to use for highlighting the matched text. Use it together with `highlights.pre_tag`. Default: ``. | **\*)** `` can take the following values: @@ -803,13 +803,13 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch | `chat.properties` | No | `object` | | | `chat.access` | No | `object` | | | `chat.users` | No | `[]object` | The list of existing users. Up to 4 additional (other than the requester) agents and 1 customer allowed. | -| `chat.users.id` | Yes | `string` | User ID | -| `chat.users.type` | Yes | `string` | `agent` or `customer`. | +| `chat.users.id` | Yes | `string` | The user ID. | +| `chat.users.type` | Yes | `string` | Possible values: `agent`, `customer`. | | `chat.thread` | No | `object` | | | `chat.thread.events` | No | `array` | The list of initial chat [events](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. | | `chat.thread.properties` | No | `object` | | -| `active` | No | `bool` | When set to `false`, creates an inactive thread; default: `true`. | -| `continuous` | No | `bool` | Starts chat as continuous (online group is not required); default: `false`. | +| `active` | No | `bool` | If set to `true`: creates an active thread. Default: `true`. | +| `continuous` | No | `bool` | If set to `true`: starts chat as continuous (online group is not required). Default: `false`. | #### Response @@ -880,16 +880,16 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch | ------------------------ | -------- | ---------- | -------------------------------------------------------------------------------------------------------- | | `chat` | Yes | `object` | | | `chat.id` | Yes | `string` | The ID of the chat that will be resumed. | -| `chat.access` | No | `object` | Chat access to set, default: all agents. | -| `chat.properties` | No | `object` | Initial chat properties | +| `chat.access` | No | `object` | The chat access to set. Default: all agents. | +| `chat.properties` | No | `object` | The initial chat properties. | | `chat.users` | No | `[]object` | The list of existing users. Up to 4 additional (other than the requester) agents and 1 customer allowed. | -| `chat.users.id` | Yes | `string` | User ID | -| `chat.users.type` | Yes | `string` | `agent` or `customer` | +| `chat.users.id` | Yes | `string` | The user ID. | +| `chat.users.type` | Yes | `string` | Possible values: `agent`, `customer`. | | `chat.thread` | No | `object` | | -| `chat.thread.events` | No | `array` | Initial chat events array | -| `chat.thread.properties` | No | `object` | Initial thread properties | -| `active` | No | `bool` | When set to `false`, creates an inactive thread. Default `true`. | -| `continuous` | No | `bool` | Sets a chat to the continuous mode. When unset, leaves the mode unchanged. | +| `chat.thread.events` | No | `array` | The initial chat events array. | +| `chat.thread.properties` | No | `object` | The initial thread properties. | +| `active` | No | `bool` | If set to `false`: creates an inactive thread. Default: `true`. | +| `continuous` | No | `bool` | If set to `true`: sets a chat to the continuous mode. When unset, leaves the mode unchanged. | #### Response @@ -957,10 +957,10 @@ The requester must be present on the list of chat users. You can override it by #### Request -| Parameter | Required | Data type | Notes | -| --------------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | | -| `ignore_requester_presence` | No | `bool` | If `true`, the requester doesn't need to be present on the list of chat users; default `false`. | +| Parameter | Required | Data type | Notes | +| --------------------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------- | +| `id` | Yes | `string` | | +| `ignore_requester_presence` | No | `bool` | If set to `true`: the requester doesn't need to be present on the list of chat users. Default: `false`. | @@ -1140,14 +1140,14 @@ Transfers a chat to an agent or a group. The following restrictions apply: #### Request -| Parameter | Required | Data type | Notes | -| ---------------------------- | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | Chat ID | -| `target` | No | `object` | If missing, the chat will be transferred within the current group. | -| `target.type` | Yes | `string` | `group` or `agent` | -| `target.ids` | Yes | `array` | `group` or `agent` IDs array | -| `ignore_agents_availability` | No | `bool` | If `true`, allows the chat to be enqueued after the transfer. Otherwise, fails when unable to immediately assign any agent from the requested groups; default `false`. | -| `ignore_requester_presence` | No | `bool` | If `true`, the requester doesn't need to be present on the list of chat users; default `false`. | +| Parameter | Required | Data type | Notes | +| ---------------------------- | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | Yes | `string` | The chat ID. | +| `target` | No | `object` | If missing, the chat will be transferred within the current group. | +| `target.type` | Yes | `string` | Possible values: `group`, `agent`. | +| `target.ids` | Yes | `array` | An array of `group` or `agent` IDs. | +| `ignore_agents_availability` | No | `bool` | If set to `true`: allows the chat to be enqueued after the transfer. If set to `false`: fails when unable to immediately assign any agent from the requested groups. Default: `false`. | +| `ignore_requester_presence` | No | `bool` | If set to `true`: the requester doesn't need to be present on the list of chat users. Default: `false`. | @@ -1219,13 +1219,13 @@ To learn how to add more than one agent to the chat, reach out to us [on Discord #### Request -| Parameter | Required | Type | Notes | -| --------------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | | -| `user_id` | Yes | `string` | | -| `user_type` | Yes | `string` | Possible values: `agent` or `customer` | -| `visibility` | Yes | `string` | Possible values: `all` or `agents` | -| `ignore_requester_presence` | No | `bool` | If `true`, the requester doesn't need to be present on the list of chat users; default `false`. | +| Parameter | Required | Type | Notes | +| --------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | | +| `user_id` | Yes | `string` | | +| `user_type` | Yes | `string` | Possible values: `agent`, `customer`. | +| `visibility` | Yes | `string` | Possible values: `all`, `agents`. | +| `ignore_requester_presence` | No | `bool` | If set to `true`: the requester doesn't need to be present on the list of chat users. Default: `false`. | @@ -1289,12 +1289,12 @@ Removes a user from chat. The following restrictions apply: #### Request -| Parameter | Required | Type | Notes | -| --------------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | | -| `user_id` | Yes | `string` | | -| `user_type` | Yes | `string` | Possible value: `agent` | -| `ignore_requester_presence` | No | `bool` | If `true`, the requester doesn't need to be present on the list of chat users; default `false`. | +| Parameter | Required | Type | Notes | +| --------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | | +| `user_id` | Yes | `string` | | +| `user_type` | Yes | `string` | Possible values: `agent`. | +| `ignore_requester_presence` | No | `bool` | If set to `true`: the requester doesn't need to be present on the list of chat users. Default: `false`. | @@ -1355,10 +1355,10 @@ Sends an [event](/messaging/agent-chat-api/v3.6/data-structures/#events) that is #### Request -| Parameters | Required | Data type | Notes | -| ---------- | -------- | --------- | ------------------------------------------------------------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat you want to send the message to. | -| `event` | Yes | `object` | [Event](/messaging/agent-chat-api/data-structures/#events) object. Supports only `message` type. | +| Parameters | Required | Data type | Notes | +| ---------- | -------- | --------- | ------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to send the message to. | +| `event` | Yes | `object` | An [Event](/messaging/agent-chat-api/data-structures/#events) object. Supports only the `message` type. | @@ -1426,10 +1426,10 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch #### Request -| Parameters | Required | Data type | Notes | -| ---------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat you want to send the message to. | -| `event` | Yes | `object` | [Event](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. | +| Parameters | Required | Data type | Notes | +| ---------- | -------- | --------- | --------------------------------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to send the message to. | +| `event` | Yes | `object` | An [Event](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. | @@ -1491,14 +1491,14 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch #### Request -| Parameter | Required | Data type | Notes | -| ------------------ | -------- | --------- | ----------------------------------- | -| `chat_id` | Yes | `string` | | -| `event_id` | Yes | `string` | | -| `postback` | Yes | `object` | | -| `postback.id` | Yes | `string` | Postback name of the button | -| `postback.toggled` | Yes | `bool` | Postback toggled; `true` or `false` | -| `thread_id` | Yes | `string` | | +| Parameter | Required | Data type | Notes | +| ------------------ | -------- | --------- | ------------------------------------------------------------------ | +| `chat_id` | Yes | `string` | | +| `event_id` | Yes | `string` | | +| `postback` | Yes | `object` | | +| `postback.id` | Yes | `string` | The postback name of the button. | +| `postback.toggled` | Yes | `bool` | Whether the postback is toggled. Possible values: `true`, `false`. | +| `thread_id` | Yes | `string` | | @@ -1563,7 +1563,7 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch | Parameter | Required | Data type | Notes | | ------------ | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | Id of the chat you to set a property for. | +| `id` | Yes | `string` | The ID of the chat you want to set a property for. | | `properties` | Yes | `object` | Chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | @@ -1624,10 +1624,10 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ----------------------------------------------- | -| `id` | Yes | `string` | Id of the chat you want to delete property for. | -| `properties` | Yes | `object` | Chat properties to delete. | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | ----------------------------------------------------- | +| `id` | Yes | `string` | The ID of the chat you want to delete a property for. | +| `properties` | Yes | `object` | Chat properties to delete. | @@ -1689,8 +1689,8 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch | Parameter | Required | Data type | Notes | | ------------ | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to set properties for. | -| `thread_id` | Yes | `string` | Id of the thread you want to set properties for. | +| `chat_id` | Yes | `string` | The ID of the chat you want to set properties for. | +| `thread_id` | Yes | `string` | The ID of the thread you want to set properties for. | | `properties` | Yes | `object` | Chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | @@ -1752,11 +1752,11 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to delete property for. | -| `thread_id` | Yes | `string` | Id of the thread you want to delete property for. | -| `properties` | Yes | `object` | Chat properties to delete. | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | ------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to delete a property for. | +| `thread_id` | Yes | `string` | The ID of the thread you want to delete a property for. | +| `properties` | Yes | `object` | Chat properties to delete. | @@ -1817,12 +1817,12 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ------------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat you want to set properties for. | -| `thread_id` | Yes | `string` | Id of the thread you want to set properties for. | -| `event_id` | Yes | `string` | Id of the event you want to set properties for. | -| `properties` | Yes | `object` | Chat properties to set. | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | ---------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to set properties for. | +| `thread_id` | Yes | `string` | The ID of the thread you want to set properties for. | +| `event_id` | Yes | `string` | The ID of the event you want to set properties for. | +| `properties` | Yes | `object` | Chat properties to set. | @@ -1886,9 +1886,9 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch | Parameter | Required | Data type | Notes | | ------------ | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to delete the properties of. | -| `thread_id` | Yes | `string` | Id of the thread you want to delete the properties of. | -| `event_id` | Yes | `string` | Id of the event you want to delete the properties of. | +| `chat_id` | Yes | `string` | The ID of the chat you want to delete the properties of. | +| `thread_id` | Yes | `string` | The ID of the thread you want to delete the properties of. | +| `event_id` | Yes | `string` | The ID of the event you want to delete the properties of. | | `properties` | Yes | `object` | Event properties to delete. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | @@ -1957,11 +1957,11 @@ Read how to [list all available tags](/management/configuration-api/v3.6#list-ta #### Request -| Parameter | Required | Data type | Notes | -| ----------- | -------- | --------- | ------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat you want to add a tag to. | -| `thread_id` | Yes | `string` | Id of the thread you want to add a tag to. | -| `tag` | Yes | `string` | Tag name. It's case sensitive. | +| Parameter | Required | Data type | Notes | +| ----------- | -------- | --------- | ---------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to add a tag to. | +| `thread_id` | Yes | `string` | The ID of the thread you want to add a tag to. | +| `tag` | Yes | `string` | The tag name. It's case sensitive. | @@ -2020,11 +2020,11 @@ Untags a given **thread**. #### Request -| Parameter | Required | Data type | Notes | -| ----------- | -------- | --------- | ----------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to remove a tag from. | -| `thread_id` | Yes | `string` | Id of the thread you want to remove a tag from. | -| `tag` | Yes | `string` | Tag name. It's case sensitive. | +| Parameter | Required | Data type | Notes | +| ----------- | -------- | --------- | --------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to remove a tag from. | +| `thread_id` | Yes | `string` | The ID of the thread you want to remove a tag from. | +| `tag` | Yes | `string` | The tag name. It's case sensitive. | @@ -2089,16 +2089,16 @@ Returns the info about the customer with a given `id`. | Field | Data type | Notes | | ---------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `id` | string | [Customer's](/messaging/agent-chat-api/v3.6/data-structures/#customer) ID. | +| `id` | string | The [customer's](/messaging/agent-chat-api/v3.6/data-structures/#customer) ID. | | `type` | string | `customer` | -| `name` | string | Customer's name. Returned only if set. | -| `email` | string | Customer's email. Returned only if set. | -| `avatar` | string | Customer's avatar. Returned only if set. | +| `name` | string | The customer's name. Returned only if set. | +| `email` | string | The customer's email. Returned only if set. | +| `avatar` | string | The customer's avatar. Returned only if set. | | `created_at` | string | Specifies when the customer's identity was created. | -| `session_fields` | []object | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| `session_fields` | []object | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | | `statistics` | object | Counters for started threads, opened pages, etc. | | `visit` | object | Geolocation and opened pages from the customer's most recent online visit. Returned only if the customer logged in at least once. | -| `chat_ids` | []string | IDs of a customer's chats. Returned only if the customer had at least one chat. | +| `chat_ids` | []string | The IDs of a customer's chats. Returned only if the customer had at least one chat. | @@ -2204,13 +2204,13 @@ Updates customer's properties. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `id` | Yes | `string` | UUID v4 format is required. | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `id` | Yes | `string` | UUID v4 format is required. | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | The URL of the customer's avatar. | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | Apart from `id`, which is a required parameter, you also need to include **one of the optional** parameters. @@ -2272,11 +2272,11 @@ Bans the customer for a specific period of time. It immediately disconnects all #### Request -| Parameter | Required | Data type | | -| ---------- | -------- | --------- | --- | -| `id` | Yes | `string` | | -| `ban` | Yes | `object` | | -| `ban.days` | Yes | `number` | | +| Parameter | Required | Data type | Notes | +| ---------- | -------- | --------- | ----- | +| `id` | Yes | `string` | | +| `ban` | Yes | `object` | | +| `ban.days` | Yes | `number` | | @@ -2339,9 +2339,9 @@ It won't be sent when the requester already follows the customer or is chatting #### Request -| Parameter | Required | Data type | | -| --------- | -------- | --------- | --- | -| `id` | Yes | `string` | | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ----- | +| `id` | Yes | `string` | | @@ -2394,9 +2394,9 @@ Removes the agent from the list of customer's followers. Calling this method on #### Request -| Parameter | Required | Data type | | -| --------- | -------- | --------- | --- | -| `id` | Yes | `string` | | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ----- | +| `id` | Yes | `string` | | @@ -2451,10 +2451,10 @@ If the number of tracked customers exceeds the limit, the `subscribed_customers_ #### Request -| Parameter | Required | Data type | | -| ----------- | -------- | --------- | --- | -| `group_ids` | No | `[]int` | | -| `limit` | No | int | | +| Parameter | Required | Data type | Notes | +| ----------- | -------- | --------- | ----- | +| `group_ids` | No | `[]int` | | +| `limit` | No | int | | @@ -2512,9 +2512,9 @@ Removes a customer subscription. #### Request -| Parameter | Required | Data type | | -| ----------------- | -------- | --------- | --- | -| `subscription_id` | Yes | string | | +| Parameter | Required | Data type | Notes | +| ----------------- | -------- | --------- | ----- | +| `subscription_id` | Yes | string | | @@ -2579,20 +2579,20 @@ It returns the initial state of the current agent. #### Request -| Parameter | Required | Data type | Notes | -| --------------------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `token` | Yes | `string` | OAuth token from the agent's account | -| `timezone` | No | `string` | | -| `reconnect` | No | `bool` | Reconnecting sets the status to the last known state instead of the default one. | -| `application` | No | `object` | | -| `application.name` | No | `string` | Application name | -| `application.version` | No | `string` | Application version | -| `away` __*__ | No | `bool` | When `true`, the connection is set to the `away` state. Defaults to `false`. | -| `customer_monitoring_level` | No | `string` | Possible values: `my`, `chatting`, `invited`, `online`, `highest_available` __**__. Defaults to `my` if [login](#login) creates the first session; otherwise it preserves the current `customer_monitoring_level`. | -| `pushes` | No | `object` | Use case: when you want to receive only specific pushes. By default, it's set to `all` for the version of your currently established RTM connection. | -| `pushes.` | Yes | `[]string` | A list of push subscriptions for a specific version;`` is a version number, without `v` prefix. Possible values: push names. | - -__*__ You can use the `away` param to **prevent assigning chats** to Agents **after random reconnections** when their status was set to `not_accepting_chats` by the auto-away feature. When an agent logs in with `away: true`, the connection is immediately recognized +| Parameter | Required | Data type | Notes | +| --------------------------- | -------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `token` | Yes | `string` | The OAuth token from the agent's account. | +| `timezone` | No | `string` | | +| `reconnect` | No | `bool` | If set to `true`: reconnecting sets the status to the last known state instead of the default one. | +| `application` | No | `object` | | +| `application.name` | No | `string` | The application name. | +| `application.version` | No | `string` | The application version. | +| `away` __*__ | No | `bool` | If set to `true`: the connection is set to the `away` state. Default: `false`. | +| `customer_monitoring_level` | No | `string` | Possible values: `my`, `chatting`, `invited`, `online`, `highest_available` __**__. Default: `my` if [login](#login) creates the first session; otherwise it preserves the current `customer_monitoring_level`. | +| `pushes` | No | `object` | Use case: when you want to receive only specific pushes. Default: `all` for the version of your currently established RTM connection. | +| `pushes.` | Yes | `[]string` | A list of push subscriptions for a specific version; `` is a version number, without `v` prefix. Possible values: push names. | + +__*__ You can use the `away` param to **prevent assigning chats** to agents **after random reconnections** when their status was set to `not_accepting_chats` by the auto-away feature. When an agent logs in with `away: true`, the connection is immediately recognized as `away`. [Read more...](#set-away-status) __**__ These values mean: @@ -2600,7 +2600,7 @@ __**__ These values mean: * `my` - only the customers from chats the agent is assigned to * `chatting` - all customers that are chatting within the groups the agent is assigned to * `invited` - all customers that are invited to chat within the groups the agent is assigned to -* `online` - all customers visiting the website assigned to the agent’s groups +* `online` - all customers visiting the website assigned to the agent's groups * `highest_available` - sets customer monitoring level to the highest available level based on license configuration. More information about the license configuration is available by contacting support #### Response @@ -2715,8 +2715,8 @@ __**__ These values mean: Sets an agent's connection to the `away` state. You can use this method to manipulate the agent's status. The method works per connection - all connections an agent has (desktop, mobile, etc) must be in the `away` state for the agent's status to be changed to `not_accepting_chats`. -You may want to make use of the auto-away feature and set the Agents' statuses to `not_accepting_chats` when they're inactive, for example they're not at their desks. -Remember that checking if Agents are active/inactive should be **implemented on your side**. If you decide they're inactive, set their connections to `away`. The auto-away feature will recognize the `away` connections and change the agent's status to `not_accepting_chats`. +You may want to make use of the auto-away feature and set the agents' statuses to `not_accepting_chats` when they're inactive, for example they're not at their desks. +Remember that checking if agents are active/inactive should be **implemented on your side**. If you decide they're inactive, set their connections to `away`. The auto-away feature will recognize the `away` connections and change the agent's status to `not_accepting_chats`. #### Specifics @@ -2779,7 +2779,7 @@ Unlike [**Set Away Status**](#set-away-status), which is another mechanism of st | | | | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | **Action** | `set_routing_status` | -| **Required scopes** | for Agents: `agents--my:rw` **\*** or `agents--all:rw` **\*\***; for bot agents: `agents-bot--my:rw` **\*\*\*** or `agents-bot--all:rw` **\*\*\*\*** | +| **Required scopes** | for agents: `agents--my:rw` **\*** or `agents--all:rw` **\*\***; for bot agents: `agents-bot--my:rw` **\*\*\*** or `agents-bot--all:rw` **\*\*\*\*** | | **Web API equivalent** | [`set_routing_status`](/messaging/agent-chat-api/v3.6/#set-routing-status) | | **Push message** | [`routing_status_set`](/messaging/agent-chat-api/v3.6/rtm-pushes/#routing_status_set) | @@ -2793,10 +2793,10 @@ Unlike [**Set Away Status**](#set-away-status), which is another mechanism of st #### Request -| Parameter | Required | Data type | Notes | -| ---------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------ | -| `status` | Yes | `string` | For Agents: `accepting_chats` or `not_accepting_chats`; for bot agents: `accepting_chats`, `not_accepting_chats`, or `offline` | -| `agent_id` | No | `string` | If not specified, the requester's status will be updated. | +| Parameter | Required | Data type | Notes | +| ---------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| `status` | Yes | `string` | Possible values: for agents: `accepting_chats` or `not_accepting_chats`; for bot agents: `accepting_chats`, `not_accepting_chats`, or `offline`. | +| `agent_id` | No | `string` | The agent ID. If not specified, the requester's status will be updated. | @@ -2965,9 +2965,9 @@ Replaces the token used in the login request with a new one. This allows the web #### Request -| Parameter | Required | Type | Notes | -| --------- | -------- | -------- | ------------------------------------ | -| `token` | Yes | `string` | OAuth token from the agent's account | +| Parameter | Required | Type | Notes | +| --------- | -------- | -------- | ----------------------------------------- | +| `token` | Yes | `string` | The OAuth token from the agent's account. | @@ -3024,10 +3024,10 @@ Replaces the token used in the login request with a new one. This allows the web #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ------------------------- | -| `chat_id` | Yes | `string` | | -| `seen_up_to` | Yes | `string` | RFC 3339 date-time format | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | ------------------------------ | +| `chat_id` | Yes | `string` | | +| `seen_up_to` | Yes | `string` | The RFC 3339 date-time format. | @@ -3083,13 +3083,13 @@ Replaces the token used in the login request with a new one. This allows the web #### Request -| Parameter | Required | Data type | Notes | -| ------------- | -------- | --------- | ---------------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to send the thinking indicator to. | -| `title` | No | `string` | | -| `description` | No | `string` | | -| `visibility` | No | `string` | Default: `all`; `agents` | -| `custom_id` | No | `string` | | +| Parameter | Required | Data type | Notes | +| ------------- | -------- | --------- | -------------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to send the thinking indicator to. | +| `title` | No | `string` | | +| `description` | No | `string` | | +| `visibility` | No | `string` | Possible values: `all`, `agents`. Default: `all`. | +| `custom_id` | No | `string` | | @@ -3148,11 +3148,11 @@ Replaces the token used in the login request with a new one. This allows the web #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | -------------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to send the typing indicator to. | -| `visibility` | No | `string` | `all` (default), `agents` | -| `is_typing` | Yes | `bool` | | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | ------------------------------------------------------------ | +| `chat_id` | Yes | `string` | The ID of the chat you want to send the typing indicator to. | +| `visibility` | No | `string` | Possible values: `all`, `agents`. Default: `all`. | +| `is_typing` | Yes | `bool` | | @@ -3195,7 +3195,7 @@ Replaces the token used in the login request with a new one. This allows the web This method serves for the **chat-unrelated communication**. Messages sent using `multicast` are not being saved. -For example, it could be used in an app that sends notifications to Agents or Customers, when a certain condition is met (e.g. an important customer started the chat). +For example, it could be used in an app that sends notifications to agents or customers, when a certain condition is met (e.g. an important customer started the chat). #### Specifics @@ -3208,11 +3208,11 @@ For example, it could be used in an app that sends notifications to Agents or Cu #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ------------------------- | -| `recipients` | Yes | `object` | **\*** | -| `content` | Yes | `any` | A JSON message to be sent | -| `type` | No | `string` | Multicast message type | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | --------------------------- | +| `recipients` | Yes | `object` | **\*** | +| `content` | Yes | `any` | A JSON message to be sent. | +| `type` | No | `string` | The multicast message type. | **\*)** `recipients` can take the following values: @@ -3287,10 +3287,10 @@ At least one `recipients` type (`agents.all`, `agents.ids`, `agents.groups`, `cu ### List Agents For Transfer -It returns the Agents you can transfer a chat to. Agents are sorted ascendingly by the total number of active chats they have. Note that: +It returns the agents you can transfer a chat to. Agents are sorted ascendingly by the total number of active chats they have. Note that: -- The method only returns Agents with statuses **online** and **not accepting chats**. Offline Agents aren't returned. -- Only chats **with Customers** are taken into account in `total_active_chats`. +- The method only returns agents with statuses **online** and **not accepting chats**. Offline agents aren't returned. +- Only chats **with customers** are taken into account in `total_active_chats`. #### Specifics @@ -3303,9 +3303,9 @@ It returns the Agents you can transfer a chat to. Agents are sorted ascendingly #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | --------------------------------------- | -| `chat_id` | Yes | `string` | The ID of the chat you want to transfer | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ---------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to transfer. | diff --git a/src/pages/messaging/agent-chat-api/v3.2/data-structures/index.mdx b/src/pages/messaging/agent-chat-api/v3.2/data-structures/index.mdx index 71d65ae7e..79389ced2 100644 --- a/src/pages/messaging/agent-chat-api/v3.2/data-structures/index.mdx +++ b/src/pages/messaging/agent-chat-api/v3.2/data-structures/index.mdx @@ -311,19 +311,19 @@ System message event is native system event sent in specific situations. -| Field | Req./Opt. | Notes | -| -------------------------------- | --------- | ------------------------------------------------------------------------------------- | -| `agent_last_event_created_at` | optional | | -| `avatar` | optional | | -| `customer_last_event_created_at` | optional | | -| `created_at` | optional | | -| `email` | optional | | -| `session_fields` | optional | An array of custom object-enclosed `key:value` pairs. Expires along with the session. | -| `name` | optional | | -| `events_seen_up_to` | optional | RFC 3339 datetime string | -| `last_visit` | optional | | -| `present` | optional | | -| `statistics` | optional | | +| Field | Req./Opt. | Notes | +| -------------------------------- | --------- | ----------------------------------------------------------------------------------- | +| `agent_last_event_created_at` | optional | | +| `avatar` | optional | | +| `customer_last_event_created_at` | optional | | +| `created_at` | optional | | +| `email` | optional | | +| `session_fields` | optional | An array of custom object-enclosed key-value pairs. Expires along with the session. | +| `name` | optional | | +| `events_seen_up_to` | optional | RFC 3339 datetime string | +| `last_visit` | optional | | +| `present` | optional | | +| `statistics` | optional | | # Other common structures diff --git a/src/pages/messaging/agent-chat-api/v3.2/index.mdx b/src/pages/messaging/agent-chat-api/v3.2/index.mdx index b035114ec..6c47fcc69 100644 --- a/src/pages/messaging/agent-chat-api/v3.2/index.mdx +++ b/src/pages/messaging/agent-chat-api/v3.2/index.mdx @@ -1729,7 +1729,7 @@ Returns the info about the customer with a given `customer_id`. | `email` | string | Customer's email. Returned only if set. | | `avatar` | string | Customer's avatar. Returned only if set. | | `created_at` | string | Specifies when the customer's identity was created. | -| `session_fields` | []object | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| `session_fields` | []object | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | | `statistics` | object | Counters for started threads, opened pages, etc. | | `last_visit` | object | Geolocation and opened pages from the customer's most recent online visit. Returned only if the customer logged in at least once. | | `chat_ids` | []string | IDs of a customer's chats. Returned only if the customer had at least one chat. | @@ -1939,12 +1939,12 @@ Creates a new [Customer](/messaging/agent-chat-api/v3.2/data-structures/#custome #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | @@ -1998,13 +1998,13 @@ Updates customer's properties. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `customer_id` | Yes | `string` | UUID v4 format is required | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `customer_id` | Yes | `string` | UUID v4 format is required | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | Apart from `customer_id`, which is a required parameter, you also need to include **one of the optional** parameters. diff --git a/src/pages/messaging/agent-chat-api/v3.2/rtm-reference/index.mdx b/src/pages/messaging/agent-chat-api/v3.2/rtm-reference/index.mdx index db95857ef..c9f349fe8 100644 --- a/src/pages/messaging/agent-chat-api/v3.2/rtm-reference/index.mdx +++ b/src/pages/messaging/agent-chat-api/v3.2/rtm-reference/index.mdx @@ -2015,7 +2015,7 @@ Returns the info about the customer with a given `customer_id`. | `email` | string | Customer's email. Returned only if set. | | `avatar` | string | Customer's avatar. Returned only if set. | | `created_at` | string | Specifies when the customer's identity was created. | -| `session_fields` | []object | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| `session_fields` | []object | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | | `statistics` | object | Counters for started threads, opened pages, etc. | | `last_visit` | object | Geolocation and opened pages from the customer's most recent online visit. Returned only if the customer logged in at least once. | | `chat_ids` | []string | IDs of a customer's chats. Returned only if the customer had at least one chat. | @@ -2236,12 +2236,12 @@ Creates a new [Customer](/messaging/agent-chat-api/v3.2/data-structures/#custome #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | @@ -2301,13 +2301,13 @@ Updates customer's properties. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `customer_id` | Yes | `string` | UUID v4 format is required. | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `customer_id` | Yes | `string` | UUID v4 format is required. | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | Apart from `customer_id`, which is a required parameter, you also need to include **one of the optional** parameters. diff --git a/src/pages/messaging/agent-chat-api/v3.3/data-structures/index.mdx b/src/pages/messaging/agent-chat-api/v3.3/data-structures/index.mdx index 205f2b8f0..6ec4820f9 100644 --- a/src/pages/messaging/agent-chat-api/v3.3/data-structures/index.mdx +++ b/src/pages/messaging/agent-chat-api/v3.3/data-structures/index.mdx @@ -368,7 +368,7 @@ System message event is native system event sent in specific situations. | `created_at` | optional | | | `email` | optional | | | `email_verified` | optional | Specifies if the customer confirmed their email address. See [Request Email Verification](/messaging/customer-chat-api/v3.3/#request-email-verification). | -| `session_fields` | optional | An array of custom object-enclosed `key:value` pairs. Expires along with the session. | +| `session_fields` | optional | An array of custom object-enclosed key-value pairs. Expires along with the session. | | `name` | optional | | | `events_seen_up_to` | optional | RFC 3339 datetime string | | `last_visit` | optional | | diff --git a/src/pages/messaging/agent-chat-api/v3.3/index.mdx b/src/pages/messaging/agent-chat-api/v3.3/index.mdx index 67cdd3169..a04673c9f 100644 --- a/src/pages/messaging/agent-chat-api/v3.3/index.mdx +++ b/src/pages/messaging/agent-chat-api/v3.3/index.mdx @@ -1743,7 +1743,7 @@ Returns the info about the customer with a given `id`. | `email` | string | Customer's email. Returned only if set. | | `avatar` | string | Customer's avatar. Returned only if set. | | `created_at` | string | Specifies when the customer's identity was created. | -| `session_fields` | []object | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| `session_fields` | []object | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | | `statistics` | object | Counters for started threads, opened pages, etc. | | `last_visit` | object | Geolocation and opened pages from the customer's most recent online visit. Returned only if the customer logged in at least once. | | `chat_ids` | []string | IDs of a customer's chats. Returned only if the customer had at least one chat. | @@ -1975,12 +1975,12 @@ Creates a new [Customer](/messaging/agent-chat-api/data-structures/#customer) us #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | @@ -2037,13 +2037,13 @@ The webhook will be sent only if the customer has active chats. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `id` | Yes | `string` | UUID v4 format is required | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `id` | Yes | `string` | UUID v4 format is required | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | Apart from `id`, which is a required parameter, you also need to include **one of the optional** parameters. diff --git a/src/pages/messaging/agent-chat-api/v3.3/rtm-reference/index.mdx b/src/pages/messaging/agent-chat-api/v3.3/rtm-reference/index.mdx index d4b44cb31..bb8c09ff5 100644 --- a/src/pages/messaging/agent-chat-api/v3.3/rtm-reference/index.mdx +++ b/src/pages/messaging/agent-chat-api/v3.3/rtm-reference/index.mdx @@ -1948,7 +1948,7 @@ Returns the info about the customer with a given `id`. | `email` | string | Customer's email. Returned only if set. | | `avatar` | string | Customer's avatar. Returned only if set. | | `created_at` | string | Specifies when the customer's identity was created. | -| `session_fields` | []object | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| `session_fields` | []object | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | | `statistics` | object | Counters for started threads, opened pages, etc. | | `last_visit` | object | Geolocation and opened pages from the customer's most recent online visit. Returned only if the customer logged in at least once. | | `chat_ids` | []string | IDs of a customer's chats. Returned only if the customer had at least one chat. | @@ -2191,12 +2191,12 @@ Creates a new [Customer](/messaging/agent-chat-api/data-structures/#customer) us #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | @@ -2256,13 +2256,13 @@ Updates customer's properties. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `id` | Yes | `string` | UUID v4 format is required. | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `id` | Yes | `string` | UUID v4 format is required. | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | Apart from `id`, which is a required parameter, you also need to include **one of the optional** parameters. diff --git a/src/pages/messaging/agent-chat-api/v3.4/data-structures/index.mdx b/src/pages/messaging/agent-chat-api/v3.4/data-structures/index.mdx index 357197fe8..b61d653e2 100644 --- a/src/pages/messaging/agent-chat-api/v3.4/data-structures/index.mdx +++ b/src/pages/messaging/agent-chat-api/v3.4/data-structures/index.mdx @@ -372,7 +372,7 @@ System message event is native system event sent in specific situations. | `created_at` | optional | | | `email` | optional | | | `email_verified` | optional | Specifies if the customer confirmed their email address. See [Request Email Verification](/messaging/customer-chat-api/v3.4/#request-email-verification). | -| `session_fields` | optional | An array of custom object-enclosed `key:value` pairs. Expires along with the session. | +| `session_fields` | optional | An array of custom object-enclosed key-value pairs. Expires along with the session. | | `name` | optional | | | `events_seen_up_to` | optional | RFC 3339 datetime string | | `last_visit` | optional | | diff --git a/src/pages/messaging/agent-chat-api/v3.4/index.mdx b/src/pages/messaging/agent-chat-api/v3.4/index.mdx index 278d55ada..b9f3803da 100644 --- a/src/pages/messaging/agent-chat-api/v3.4/index.mdx +++ b/src/pages/messaging/agent-chat-api/v3.4/index.mdx @@ -1811,7 +1811,7 @@ Returns the info about the customer with a given `id`. | `email` | string | Customer's email. Returned only if set. | | `avatar` | string | Customer's avatar. Returned only if set. | | `created_at` | string | Specifies when the customer's identity was created. | -| `session_fields` | []object | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| `session_fields` | []object | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | | `statistics` | object | Counters for started threads, opened pages, etc. | | `last_visit` | object | Geolocation and opened pages from the customer's most recent online visit. Returned only if the customer logged in at least once. | | `chat_ids` | []string | IDs of a customer's chats. Returned only if the customer had at least one chat. | @@ -2043,12 +2043,12 @@ Creates a new [Customer](/messaging/agent-chat-api/v3.4/data-structures/#custome #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | @@ -2105,13 +2105,13 @@ The webhook will be sent only if the customer has active chats. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `id` | Yes | `string` | UUID v4 format is required | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `id` | Yes | `string` | UUID v4 format is required | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | Apart from `id`, which is a required parameter, you also need to include **one of the optional** parameters. diff --git a/src/pages/messaging/agent-chat-api/v3.4/rtm-reference/index.mdx b/src/pages/messaging/agent-chat-api/v3.4/rtm-reference/index.mdx index 1891ceb35..8c8320730 100644 --- a/src/pages/messaging/agent-chat-api/v3.4/rtm-reference/index.mdx +++ b/src/pages/messaging/agent-chat-api/v3.4/rtm-reference/index.mdx @@ -1979,7 +1979,7 @@ Returns the info about the customer with a given `id`. | `email` | string | Customer's email. Returned only if set. | | `avatar` | string | Customer's avatar. Returned only if set. | | `created_at` | string | Specifies when the customer's identity was created. | -| `session_fields` | []object | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| `session_fields` | []object | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | | `statistics` | object | Counters for started threads, opened pages, etc. | | `last_visit` | object | Geolocation and opened pages from the customer's most recent online visit. Returned only if the customer logged in at least once. | | `chat_ids` | []string | IDs of a customer's chats. Returned only if the customer had at least one chat. | @@ -2222,12 +2222,12 @@ Creates a new [Customer](/messaging/agent-chat-api/v3.4/data-structures/#custome #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | @@ -2287,13 +2287,13 @@ Updates customer's properties. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `id` | Yes | `string` | UUID v4 format is required. | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `id` | Yes | `string` | UUID v4 format is required. | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | Apart from `id`, which is a required parameter, you also need to include **one of the optional** parameters. diff --git a/src/pages/messaging/agent-chat-api/v3.5/data-structures/index.mdx b/src/pages/messaging/agent-chat-api/v3.5/data-structures/index.mdx index 4dd6c4373..6b8a38844 100644 --- a/src/pages/messaging/agent-chat-api/v3.5/data-structures/index.mdx +++ b/src/pages/messaging/agent-chat-api/v3.5/data-structures/index.mdx @@ -371,7 +371,7 @@ System message event is native system event sent in specific situations. | `created_at` | optional | | | `email` | optional | | | `email_verified` | optional | Specifies if the customer confirmed their email address. See [Request Email Verification](/messaging/customer-chat-api/v3.5/#request-email-verification). | -| `session_fields` | optional | An array of custom object-enclosed `key:value` pairs. Expires along with the session. | +| `session_fields` | optional | An array of custom object-enclosed key-value pairs. Expires along with the session. | | `name` | optional | | | `events_seen_up_to` | optional | RFC 3339 datetime string | | `last_visit` | optional | | diff --git a/src/pages/messaging/agent-chat-api/v3.5/index.mdx b/src/pages/messaging/agent-chat-api/v3.5/index.mdx index a05ade59b..bd65e6aa2 100644 --- a/src/pages/messaging/agent-chat-api/v3.5/index.mdx +++ b/src/pages/messaging/agent-chat-api/v3.5/index.mdx @@ -1863,7 +1863,7 @@ Returns the info about the customer with a given `id`. | `email` | string | Customer's email. Returned only if set. | | `avatar` | string | Customer's avatar. Returned only if set. | | `created_at` | string | Specifies when the customer's identity was created. | -| `session_fields` | []object | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| `session_fields` | []object | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | | `statistics` | object | Counters for started threads, opened pages, etc. | | `last_visit` | object | Geolocation and opened pages from the customer's most recent online visit. Returned only if the customer logged in at least once. | | `chat_ids` | []string | IDs of a customer's chats. Returned only if the customer had at least one chat. | @@ -2095,12 +2095,12 @@ Creates a new [Customer](/messaging/agent-chat-api/v3.5/data-structures/#custome #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | @@ -2157,13 +2157,13 @@ The webhook will be sent only if the customer has active chats. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `id` | Yes | `string` | UUID v4 format is required | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `id` | Yes | `string` | UUID v4 format is required | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | Apart from `id`, which is a required parameter, you also need to include **one of the optional** parameters. diff --git a/src/pages/messaging/agent-chat-api/v3.5/rtm-reference/index.mdx b/src/pages/messaging/agent-chat-api/v3.5/rtm-reference/index.mdx index b14ce9074..11118bf02 100644 --- a/src/pages/messaging/agent-chat-api/v3.5/rtm-reference/index.mdx +++ b/src/pages/messaging/agent-chat-api/v3.5/rtm-reference/index.mdx @@ -1975,7 +1975,7 @@ Returns the info about the customer with a given `id`. | `email` | string | Customer's email. Returned only if set. | | `avatar` | string | Customer's avatar. Returned only if set. | | `created_at` | string | Specifies when the customer's identity was created. | -| `session_fields` | []object | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| `session_fields` | []object | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | | `statistics` | object | Counters for started threads, opened pages, etc. | | `last_visit` | object | Geolocation and opened pages from the customer's most recent online visit. Returned only if the customer logged in at least once. | | `chat_ids` | []string | IDs of a customer's chats. Returned only if the customer had at least one chat. | @@ -2218,12 +2218,12 @@ Creates a new [Customer](/messaging/agent-chat-api/v3.5/data-structures/#custome #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | @@ -2283,13 +2283,13 @@ Updates customer's properties. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `id` | Yes | `string` | UUID v4 format is required. | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `id` | Yes | `string` | UUID v4 format is required. | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | Apart from `id`, which is a required parameter, you also need to include **one of the optional** parameters. 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..8ecae1755 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 @@ -410,7 +410,7 @@ It is not possible to send a System event in API version 3.7. | `created_at` | optional | | | `email` | optional | | | `email_verified` | optional | Specifies if the customer confirmed their email address. See [Request Email Verification](/messaging/customer-chat-api/v3.7/#request-email-verification). | -| `session_fields` | optional | An array of custom object-enclosed `key:value` pairs. Expires along with the session. | +| `session_fields` | optional | An array of custom object-enclosed key-value pairs. Expires along with the session. | | `name` | optional | | | `events_seen_up_to` | optional | RFC 3339 datetime string | | `visit` | optional | | 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..a47f955bb 100644 --- a/src/pages/messaging/agent-chat-api/v3.7/index.mdx +++ b/src/pages/messaging/agent-chat-api/v3.7/index.mdx @@ -136,16 +136,16 @@ It returns [summaries](/messaging/agent-chat-api/v3.7/data-structures/#chat-summ **\*\*)** `chats--access:ro` - to find chats from groups that the requester (related to the token) is a member of. -| Parameter | Required | Type | Notes | -| ----------------------------------------------------- | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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.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) | -| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, maximum: 100. | -| `page_id` | No | `string` | | +| Parameter | Required | Type | Notes | +| ----------------------------------------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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` | If set to `true`: returns active chats only. If set to `false`: returns inactive chats only. If set to `null` or not provided: returns 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.group_ids` | No | `array` | An array of group IDs. Maximum array size: 200. | +| `filters.properties...` | No | `any` | | +| `sort_order` | No | `string` | Possible values: `asc` - oldest chats first, `desc` - newest chats first. Default: `desc`. | +| `limit` | No | `number` | The maximum number of records returned on each [page](#pagination). Default: 10. Maximum: 100. | +| `page_id` | No | `string` | | `filter_type` can take the following values: @@ -157,12 +157,12 @@ There's only one value allowed for a single property. #### Response -| Field | Data type | Notes | -| ------------------ | --------- | ------------------------------------------------------------------------------------------------------------ | -| `chats_summary` | `array` | An array of [Chat summary](/messaging/agent-chat-api/v3.7/data-structures/#chat-summaries) 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. | +| Field | Data type | Notes | +| ------------------ | --------- | ------------------------------------------------------------------------------------------------------------- | +| `chats_summary` | `array` | An array of [chat summary](/messaging/agent-chat-api/v3.7/data-structures/#chat-summaries) 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. | @@ -263,16 +263,16 @@ It returns threads that the current agent has access to in a given chat. #### Request -| Parameter | Required | Data type | Notes | -| ------------------ | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | | -| `sort_order` | No | `string` | Possible values: `asc` - oldest threads first and `desc` - newest threads first (default). | -| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 3, maximum: 100. To limit the total number of returned records, use `filters`. | -| `page_id` | No | `string` | | -| `min_events_count` | No | `number` | Range: 1-100; Specifies the minimum number of events to be returned in the response. It's the **total** number of events, so they can come from more than one thread. You'll get as many latest threads as needed to meet the `min_events_count` condition. | -| `filters` | No | `object` | | -| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` | -| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` | +| Parameter | Required | Data type | Notes | +| ------------------ | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | | +| `sort_order` | No | `string` | Possible values: `asc` - oldest threads first, `desc` - newest threads first. Default: `desc`. | +| `limit` | No | `number` | The maximum number of records returned on each [page](#pagination). Default: 3. Maximum: 100. To limit the total number of returned records, use `filters`. | +| `page_id` | No | `string` | | +| `min_events_count` | No | `number` | Specifies the minimum number of events to be returned in the response. It's the total number of events, so they can come from more than one thread. You'll get as many latest threads as needed to meet the `min_events_count` condition. Minimum: 1. Maximum: 100. | +| `filters` | No | `object` | | +| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | +| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | You cannot use either `limit` and `min_events_count` or `filters` and `min_events_count` at the same time. @@ -372,10 +372,10 @@ It returns a thread that the current agent has access to in a given chat. #### Request -| Parameter | Required | Data type | Notes | -| ----------- | -------- | --------- | -------------------------------------- | -| `chat_id` | Yes | `string` | | -| `thread_id` | No | `string` | Default: the latest thread (if exists) | +| Parameter | Required | Data type | Notes | +| ----------- | -------- | --------- | --------------------------------------- | +| `chat_id` | Yes | `string` | | +| `thread_id` | No | `string` | Default: the latest thread (if exists). | @@ -503,33 +503,33 @@ The list classification is based on threads; 1 chat per 1 thread. Thus, the same #### Request -| Parameter | Required | Data type | Notes | -| ---------------------------------------------------------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `filters` | No | `object` | | -| `filters.query` | No | `string` | | -| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` | -| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` | -| `filters.chat_ids` | No | `array` | Array of chat IDs. Max array size: 1000. | -| `filters.thread_ids` | No | `array` | Array of thread IDs. Cannot be used with other filters or pagination; max array size: 20. | -| `filters.group_ids` | No | `array` | Array of group IDs. Max array size: 200 | -| `filters.properties...` | No | `any` | **\* described below** | -| `filters.agents.` | No | `any` | **\*\* described below** `exists` set to `false` will return unassigned chats; `true` will return the assigned ones. | -| `filters.tags.` | No | `any` | | -| `filters.sales.` | No | `any` | | -| `filters.goals.` | No | `any` | | -| `filters.surveys.` | No | `array` | **\*\*\*** **described below** | -| `filters.event_types.` | No | `any` | **\*\*\*\*** **described below** | -| `filters.greetings.` | No | `any` | **\*\*\*\*\*\*** **described below** | -| `filters.agent_response.` | No | `any` | **\*\*\*\*\*\*\*** **described below** | -| `filters.customer_countries.` | No | `any` | It supports country codes with the `ISO 3166-1 Alpha-2` format. | -| `filters.customer_id` | No | `string` | | -| `filters.customer_email` | No | `string` | | -| `page_id` | No | `string` | | -| `sort_order` **\*\*\*\*\*** | No | `string` | Default: `desc` | -| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, min: 1, max: 100. To limit the total number of returned records, use `filters`. | -| `highlights` | No | `object` | Use it to highlight the match of `filters.query`. To enable highlights with default parameters, pass an empty object. | -| `highlights.pre_tag` | No | `string` | An HTML tag to use for highlighting the matched text; default: ``. Use it together with `highlights.post_tag`. | -| `highlights.post_tag` | No | `string` | An HTML tag to use for highlighting the matched text; default: ``. Use it together with `highlights.pre_tag`. | +| Parameter | Required | Data type | Notes | +| ---------------------------------------------------------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `filters` | No | `object` | | +| `filters.query` | No | `string` | | +| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | +| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | +| `filters.chat_ids` | No | `array` | An array of chat IDs. Maximum array size: 1000. | +| `filters.thread_ids` | No | `array` | An array of thread IDs. Cannot be used with other filters or pagination. Maximum array size: 20. | +| `filters.group_ids` | No | `array` | An array of group IDs. Maximum array size: 200. | +| `filters.properties...` | No | `any` | **\* described below** | +| `filters.agents.` | No | `any` | **\*\* described below** If `exists` is set to `false`: returns unassigned chats. If set to `true`: returns the assigned ones. | +| `filters.tags.` | No | `any` | | +| `filters.sales.` | No | `any` | | +| `filters.goals.` | No | `any` | | +| `filters.surveys.` | No | `array` | **\*\*\*** **described below** | +| `filters.event_types.` | No | `any` | **\*\*\*\*** **described below** | +| `filters.greetings.` | No | `any` | **\*\*\*\*\*\*** **described below** | +| `filters.agent_response.` | No | `any` | **\*\*\*\*\*\*\*** **described below** | +| `filters.customer_countries.` | No | `any` | It supports country codes with the `ISO 3166-1 Alpha-2` format. | +| `filters.customer_id` | No | `string` | | +| `filters.customer_email` | No | `string` | | +| `page_id` | No | `string` | | +| `sort_order` **\*\*\*\*\*** | No | `string` | Default: `desc`. | +| `limit` | No | `number` | The maximum number of records returned on each [page](#pagination). To limit the total number of returned records, use `filters`. Default: 10. Minimum: 1. Maximum: 100. | +| `highlights` | No | `object` | Use it to highlight the match of `filters.query`. To enable highlights with default parameters, pass an empty object. | +| `highlights.pre_tag` | No | `string` | An HTML tag to use for highlighting the matched text. Use it together with `highlights.post_tag`. Default: ``. | +| `highlights.post_tag` | No | `string` | An HTML tag to use for highlighting the matched text. Use it together with `highlights.pre_tag`. Default: ``. | **\*)** `` can take the following values: @@ -745,13 +745,13 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch | `chat.properties` | No | `object` | | | `chat.access` | No | `object` | | | `chat.users` | No | `[]object` | The list of existing users. Up to 4 additional (other than the requester) agents and 1 customer allowed. | -| `chat.users.id` | Yes | `string` | User ID | -| `chat.users.type` | Yes | `string` | `agent` or `customer` | +| `chat.users.id` | Yes | `string` | The user ID. | +| `chat.users.type` | Yes | `string` | Possible values: `agent`, `customer`. | | `chat.thread` | No | `object` | | | `chat.thread.events` | No | `array` | The list of initial chat [events](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. | | `chat.thread.properties` | No | `object` | | -| `active` | No | `bool` | When set to `false`, creates an inactive thread; default: `true`. | -| `continuous` | No | `bool` | Starts chat as continuous (online group is not required); default: `false`. | +| `active` | No | `bool` | If set to `false`: creates an inactive thread. Default: `true`. | +| `continuous` | No | `bool` | If set to `true`: starts chat as continuous (online group is not required). Default: `false`. | #### Response @@ -759,7 +759,7 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch | ----------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `chat_id` | `string` | | | `thread_id` | `string` | | -| `event_ids` | `[]string` | Returned only when the chat was started with initial events. Returns only the IDs of user-generated events; server-side generated events are not included in the array. | +| `event_ids` | `[]string` | Returned only when the chat was started with initial events. Returns only the IDs of user-generated events. Server-side generated events are not included in the array. | @@ -815,24 +815,24 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch | Parameter | Required | Data type | Notes | | ------------------------ | -------- | ---------- | -------------------------------------------------------------------------------------------------------- | | `chat` | Yes | `object` | | -| `chat.id` | Yes | `string` | ID of the chat that will be resumed. | -| `chat.access` | No | `object` | Chat access to set, default: all agents. | -| `chat.properties` | No | `object` | Initial chat properties | +| `chat.id` | Yes | `string` | The ID of the chat that will be resumed. | +| `chat.access` | No | `object` | The chat access to set. Default: all agents. | +| `chat.properties` | No | `object` | The initial chat properties. | | `chat.users` | No | `[]object` | The list of existing users. Up to 4 additional (other than the requester) agents and 1 customer allowed. | -| `chat.users.id` | Yes | `string` | User ID | -| `chat.users.type` | Yes | `string` | `agent` or `customer` | +| `chat.users.id` | Yes | `string` | The user ID. | +| `chat.users.type` | Yes | `string` | Possible values: `agent`, `customer`. | | `chat.thread` | No | `object` | | -| `chat.thread.events` | No | `array` | Initial chat events array | -| `chat.thread.properties` | No | `object` | Initial thread properties | -| `active` | No | `bool` | When set to `false`, creates an inactive thread; default: `true`. | -| `continuous` | No | `bool` | Sets a chat to the continuous mode. When unset, leaves the mode unchanged. | +| `chat.thread.events` | No | `array` | An initial chat events array. | +| `chat.thread.properties` | No | `object` | The initial thread properties. | +| `active` | No | `bool` | If set to `false`: creates an inactive thread. Default: `true`. | +| `continuous` | No | `bool` | If set to `true`: sets a chat to the continuous mode. When unset: leaves the mode unchanged. | #### Response | Field | Data type | Notes | | ----------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `thread_id` | `string` | | -| `event_ids` | `[]string` | Returned only when the chat was resumed with initial events. Returns only the IDs of user-generated events; server-side generated events are not included in the array. | +| `event_ids` | `[]string` | Returned only when the chat was resumed with initial events. Returns only the IDs of user-generated events. Server-side generated events are not included in the array. | @@ -887,10 +887,10 @@ The requester must be present on the list of chat users. You can override it by #### Request -| Parameter | Required | Data type | Notes | -| --------------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | | -| `ignore_requester_presence` | No | `bool` | If `true`, the requester doesn't need to be present on the list of chat users; default `false`. | +| Parameter | Required | Data type | Notes | +| --------------------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------- | +| `id` | Yes | `string` | | +| `ignore_requester_presence` | No | `bool` | If set to `true`: the requester doesn't need to be present on the list of chat users. Default: `false`. | #### Response @@ -1035,14 +1035,14 @@ Transfers a chat to an agent or a group. The following restrictions apply: #### Request -| Parameter | Required | Data type | Notes | -| ---------------------------- | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | Chat ID | -| `target` | No | `object` | If missing, the chat will be transferred within the current group. | -| `target.type` | Yes | `string` | `group` or `agent` | -| `target.ids` | Yes | `array` | `group` or `agent` IDs array | -| `ignore_agents_availability` | No | `bool` | If `true`, allows the chat to be enqueued after the transfer. Otherwise, fails when unable to immediately assign any agent from the requested groups; default `false`. | -| `ignore_requester_presence` | No | `bool` | If `true`, the requester doesn't need to be present on the list of chat users; default `false`. | +| Parameter | Required | Data type | Notes | +| ---------------------------- | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | Yes | `string` | The chat ID. | +| `target` | No | `object` | If missing: the chat will be transferred within the current group. | +| `target.type` | Yes | `string` | Possible values: `group`, `agent`. | +| `target.ids` | Yes | `array` | An array of `group` or `agent` IDs. | +| `ignore_agents_availability` | No | `bool` | If set to `true`: allows the chat to be enqueued after the transfer. If set to `false`: fails when unable to immediately assign any agent from the requested groups. Default: `false`. | +| `ignore_requester_presence` | No | `bool` | If set to `true`: the requester doesn't need to be present on the list of chat users. Default: `false`. | #### Response @@ -1105,13 +1105,13 @@ To learn how to add more than one agent to the chat, reach out to us [on Discord #### Request -| Parameter | Required | Type | Notes | -| --------------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | | -| `user_id` | Yes | `string` | | -| `user_type` | Yes | `string` | Possible values: `agent` or `customer` | -| `visibility` | Yes | `string` | Possible values: `all` or `agents` | -| `ignore_requester_presence` | No | `bool` | If `true`, the requester doesn't need to be present on the list of chat users; default `false`. | +| Parameter | Required | Type | Notes | +| --------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | | +| `user_id` | Yes | `string` | | +| `user_type` | Yes | `string` | Possible values: `agent`, `customer`. | +| `visibility` | Yes | `string` | Possible values: `all`, `agents`. | +| `ignore_requester_presence` | No | `bool` | If set to `true`: the requester doesn't need to be present on the list of chat users. Default: `false`. | #### Response @@ -1165,12 +1165,12 @@ Removes a user from chat. The following restrictions apply: #### Request -| Parameter | Required | Type | Notes | -| --------------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | | -| `user_id` | Yes | `string` | | -| `user_type` | Yes | `string` | Possible value: `agent` | -| `ignore_requester_presence` | No | `bool` | If `true`, the requester doesn't need to be present on the list of chat users; default `false`. | +| Parameter | Required | Type | Notes | +| --------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | | +| `user_id` | Yes | `string` | | +| `user_type` | Yes | `string` | Possible value: `agent`. | +| `ignore_requester_presence` | No | `bool` | If set to `true`: the requester doesn't need to be present on the list of chat users. Default: `false`. | #### Response @@ -1220,10 +1220,10 @@ Sends an [event](/messaging/agent-chat-api/v3.7/data-structures/#events) that is #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | ------------------------------------------------------------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat you want to send a message to. | -| `event` | Yes | `object` | [Event](/messaging/agent-chat-api/data-structures/#events) object. Supports only `message` type. | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to send a message to. | +| `event` | Yes | `object` | An [event](/messaging/agent-chat-api/data-structures/#events) object. Supports only the `message` type. | #### Response @@ -1280,10 +1280,10 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat you want to send a message to. | -| `event` | Yes | `object` | [Event](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | --------------------------------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to send a message to. | +| `event` | Yes | `object` | An [event](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. | #### Response @@ -1344,9 +1344,9 @@ Uploads a file to the server as a temporary file. It returns a URL that expires #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | ------------------ | -| `file` | Yes | `binary` | maximum size: 10MB | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------------- | +| `file` | Yes | `binary` | Maximum size: 10MB. | @@ -1396,14 +1396,14 @@ curl -X POST \ #### Request -| Parameter | Required | Data type | Notes | -| ------------------ | -------- | --------- | --------------------------- | -| `chat_id` | Yes | `string` | | -| `event_id` | Yes | `string` | | -| `postback` | Yes | `object` | | -| `postback.id` | Yes | `string` | Postback name of the button | -| `postback.toggled` | Yes | `bool` | Postback toggled true/false | -| `thread_id` | Yes | `string` | | +| Parameter | Required | Data type | Notes | +| ------------------ | -------- | --------- | -------------------------------- | +| `chat_id` | Yes | `string` | | +| `event_id` | Yes | `string` | | +| `postback` | Yes | `object` | | +| `postback.id` | Yes | `string` | The postback name of the button. | +| `postback.toggled` | Yes | `bool` | Whether the postback is toggled. | +| `thread_id` | Yes | `string` | | #### Response @@ -1455,10 +1455,10 @@ https://api.livechatinc.com/v3.7/agent/action/send_rich_message_postback \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | Id of the chat you to set properties for. | -| `properties` | Yes | `object` | Chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | Yes | `string` | The ID of the chat you to set properties for. | +| `properties` | Yes | `object` | The chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | #### Response @@ -1507,10 +1507,10 @@ https://api.livechatinc.com/v3.7/agent/action/update_chat_properties \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ---------------------------------------------- | -| `id` | Yes | `string` | Id of the chat you want to delete property of. | -| `properties` | Yes | `object` | Chat properties to delete. | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | -------------------------------------------------- | +| `id` | Yes | `string` | The ID of the chat you want to delete property of. | +| `properties` | Yes | `object` | The chat properties to delete. | #### Response @@ -1559,11 +1559,11 @@ No response payload (`200 OK`). #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to set properties for. | -| `thread_id` | Yes | `string` | Id of the thread you want to set properties for. | -| `properties` | Yes | `object` | Chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to set properties for. | +| `thread_id` | Yes | `string` | The ID of the thread you want to set properties for. | +| `properties` | Yes | `object` | The chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | #### Response @@ -1613,11 +1613,11 @@ curl -X POST \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | -------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to delete properties of. | -| `thread_id` | Yes | `string` | Id of the thread you want to delete properties of. | -| `properties` | Yes | `object` | Thread properties to delete. | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | ------------------------------------------------------ | +| `chat_id` | Yes | `string` | The ID of the chat you want to delete properties of. | +| `thread_id` | Yes | `string` | The ID of the thread you want to delete properties of. | +| `properties` | Yes | `object` | The thread properties to delete. | #### Response @@ -1667,12 +1667,12 @@ https://api.livechatinc.com/v3.7/agent/action/delete_thread_properties \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to set properties for. | -| `thread_id` | Yes | `string` | Id of the thread you want to set properties for. | -| `event_id` | Yes | `string` | Id of the event you want to set properties for. | -| `properties` | Yes | `object` | Chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to set properties for. | +| `thread_id` | Yes | `string` | The ID of the thread you want to set properties for. | +| `event_id` | Yes | `string` | The ID of the event you want to set properties for. | +| `properties` | Yes | `object` | The chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | #### Response @@ -1723,12 +1723,12 @@ https://api.livechatinc.com/v3.7/agent/action/update_event_properties \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ------------------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat you want to delete the properties of. | -| `thread_id` | Yes | `string` | Id of the thread you want to delete the properties of. | -| `event_id` | Yes | `string` | Id of the event you want to delete the properties of. | -| `properties` | Yes | `object` | Event properties to delete. | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | ---------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to delete the properties of. | +| `thread_id` | Yes | `string` | The ID of the thread you want to delete the properties of. | +| `event_id` | Yes | `string` | The ID of the event you want to delete the properties of. | +| `properties` | Yes | `object` | The event properties to delete. | #### Response @@ -1785,11 +1785,11 @@ Read how to [list all available tags](/management/configuration-api/v3.7#list-ta #### Request -| Parameter | Required | Data type | Notes | -| ----------- | -------- | --------- | ------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat you want to add a tag to. | -| `thread_id` | Yes | `string` | Id of the thread you want to add a tag to. | -| `tag` | Yes | `string` | Tag name. It's case sensitive. | +| Parameter | Required | Data type | Notes | +| ----------- | -------- | --------- | ---------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to add a tag to. | +| `thread_id` | Yes | `string` | The ID of the thread you want to add a tag to. | +| `tag` | Yes | `string` | The tag name. It's case sensitive. | #### Response @@ -1837,11 +1837,11 @@ Untags a given **thread**. #### Request -| Parameter | Required | Data type | Notes | -| ----------- | -------- | --------- | ----------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to remove a tag from. | -| `thread_id` | Yes | `string` | Id of the thread you want to remove a tag from. | -| `tag` | Yes | `string` | Tag name. It's case sensitive. | +| Parameter | Required | Data type | Notes | +| ----------- | -------- | --------- | --------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to remove a tag from. | +| `thread_id` | Yes | `string` | The ID of the thread you want to remove a tag from. | +| `tag` | Yes | `string` | The tag name. It's case sensitive. | #### Response @@ -1887,24 +1887,24 @@ Returns the info about the customer with a given `id`. #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | ----- | -| `id` | Yes | string | | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------------ | +| `id` | Yes | string | The customer's ID. | #### Response | Field | Data type | Notes | | ---------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `id` | string | [Customer's](/messaging/agent-chat-api/v3.7/data-structures/#customer) ID. | +| `id` | string | The [customer's](/messaging/agent-chat-api/v3.7/data-structures/#customer) ID. | | `type` | string | `customer` | -| `name` | string | Customer's name. Returned only if set. | -| `email` | string | Customer's email. Returned only if set. | -| `avatar` | string | Customer's avatar. Returned only if set. | +| `name` | string | The customer's name. Returned only if set. | +| `email` | string | The customer's email. Returned only if set. | +| `avatar` | string | The customer's avatar. Returned only if set. | | `created_at` | string | Specifies when the customer's identity was created. | -| `session_fields` | []object | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| `session_fields` | []object | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | | `statistics` | object | Counters for started threads, opened pages, etc. | | `visit` | object | Geolocation and opened pages from the customer's most recent online visit. Returned only if the customer logged in at least once. | -| `chat_ids` | []string | IDs of a customer's chats. Returned only if the customer had at least one chat. | +| `chat_ids` | []string | The IDs of a customer's chats. Returned only if the customer had at least one chat. | @@ -2008,13 +2008,13 @@ The webhook will be sent only if the customer has active chats. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `id` | Yes | `string` | UUID v4 format is required | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `id` | Yes | `string` | UUID v4 format is required. | +| `name` | No | `string` | The customer's name. | +| `email` | No | `string` | The customer's email. | +| `avatar` | No | `string` | The URL of the customer's avatar. | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | Apart from `id`, which is a required parameter, you also need to include **one of the optional** parameters. @@ -2073,11 +2073,11 @@ Bans the customer for a specific period of time. It immediately disconnects all #### Request -| Parameter | Required | Data type | | -| ---------- | -------- | --------- | --- | -| `id` | Yes | `string` | | -| `ban` | Yes | `object` | | -| `ban.days` | Yes | `number` | | +| Parameter | Required | Data type | Notes | +| ---------- | -------- | --------- | -------------------------- | +| `id` | Yes | `string` | The customer's ID. | +| `ban` | Yes | `object` | The ban object. | +| `ban.days` | Yes | `number` | The number of days to ban. | #### Response @@ -2126,9 +2126,9 @@ Agents don't need to follow the customers they're chatting with in order to rece #### Request -| Parameter | Required | Data type | | -| --------- | -------- | --------- | --- | -| `id` | Yes | `string` | | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------------ | +| `id` | Yes | `string` | The customer's ID. | #### Response @@ -2170,9 +2170,9 @@ Removes the agent from the list of customer's followers. Calling this method on #### Request -| Parameter | Required | Data type | | -| --------- | -------- | --------- | --- | -| `id` | Yes | `string` | | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ------------------ | +| `id` | Yes | `string` | The customer's ID. | #### Response @@ -2224,10 +2224,10 @@ Changes the status of an agent or a bot agent. #### Request -| Parameter | Required | Data type | Notes | -| ---------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------ | -| `status` | Yes | `string` | For Agents: `accepting_chats` or `not_accepting_chats`; for bot agents: `accepting_chats`, `not_accepting_chats`, or `offline` | -| `agent_id` | No | `string` | If not specified, the requester's status will be updated. | +| Parameter | Required | Data type | Notes | +| ---------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `status` | Yes | `string` | For agents: Possible values: `accepting_chats`, `not_accepting_chats`. For bot agents: Possible values: `accepting_chats`, `not_accepting_chats`, `offline`. | +| `agent_id` | No | `string` | The ID of the agent. If not specified, the requester's status will be updated. | #### Response @@ -2274,10 +2274,10 @@ Returns the current routing status of each agent selected by the provided filter #### Request -| Parameter | Required | Type | Notes | -| ------------------- | -------- | -------- | ----- | -| `filters` | No | `object` | | -| `filters.group_ids` | No | `array` | | +| Parameter | Required | Type | Notes | +| ------------------- | -------- | -------- | ------------------- | +| `filters` | No | `object` | The filters object. | +| `filters.group_ids` | No | `array` | The group IDs. | @@ -2321,7 +2321,7 @@ https://api.livechatinc.com/v3.7/agent/action/list_routing_statuses \ ### Mark Events as Seen -It marks an agent’s events up to a specific time as read in a customer’s chat window. +It marks an agent's events up to a specific time as read in a customer's chat window. #### Specifics @@ -2338,10 +2338,10 @@ It marks an agent’s events up to a specific time as read in a customer’s cha #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ------------------------- | -| `chat_id` | Yes | `string` | | -| `seen_up_to` | Yes | `string` | RFC 3339 date-time format | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | -------------------------- | +| `chat_id` | Yes | `string` | The chat ID. | +| `seen_up_to` | Yes | `string` | RFC 3339 date-time format. | #### Response @@ -2386,13 +2386,13 @@ https://api.livechatinc.com/v3.7/agent/action/mark_events_as_seen \ #### Request -| Parameter | Required | Data type | Notes | -| ------------- | -------- | --------- | ------------------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat that to send the thinking indicator to. | -| `title` | No | `string` | | -| `description` | No | `string` | | -| `visibility` | No | `string` | Default: `all`; `agents` | -| `custom_id` | No | `string` | | +| Parameter | Required | Data type | Notes | +| ------------- | -------- | --------- | ----------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat to send the thinking indicator to. | +| `title` | No | `string` | The title of the thinking indicator. | +| `description` | No | `string` | The description of the thinking indicator. | +| `visibility` | No | `string` | Possible values: `all`, `agents`. Default: `all`. | +| `custom_id` | No | `string` | A custom ID for the thinking indicator. | #### Response @@ -2440,11 +2440,11 @@ https://api.livechatinc.com/v3.7/agent/action/send_thinking_indicator \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ---------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat that to send the typing indicator to. | -| `visibility` | No | `string` | Default: `all`; `agents` | -| `is_typing` | Yes | `bool` | | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | --------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat to send the typing indicator to. | +| `visibility` | No | `string` | Possible values: `all`, `agents`. Default: `all`. | +| `is_typing` | Yes | `bool` | If set to `true`: the typing indicator is shown. | #### Response @@ -2489,11 +2489,11 @@ For example, it could be used in an app that sends notifications to Agents or Cu #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ------------------------- | -| `recipients` | Yes | `object` | **\*** | -| `content` | Yes | `any` | A JSON message to be sent | -| `type` | No | `string` | Multicast message type | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | ----------------------------- | +| `recipients` | Yes | `object` | The recipients object. **\*** | +| `content` | Yes | `any` | A JSON message to be sent. | +| `type` | No | `string` | The multicast message type. | **\*)** `recipients` can take the following values: @@ -2569,9 +2569,9 @@ It returns the Agents you can transfer a chat to. Agents are sorted ascendingly #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | --------------------------------------- | -| `chat_id` | Yes | `string` | The ID of the chat you want to transfer | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ---------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to transfer. | @@ -2626,10 +2626,10 @@ Requests an AI-generated summary of a specific thread. A thread can be summarize #### Request -| Parameter | Required | Data type | Notes | -| ----------- | -------- | --------- | ----- | -| `chat_id` | Yes | `string` | | -| `thread_id` | Yes | `string` | | +| Parameter | Required | Data type | Notes | +| ----------- | -------- | --------- | --------------------- | +| `chat_id` | Yes | `string` | The ID of the chat. | +| `thread_id` | Yes | `string` | The ID of the thread. | #### Response 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..b90d8048e 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 @@ -181,12 +181,12 @@ It returns [summaries](/messaging/agent-chat-api/v3.7/data-structures/#chat-summ | Parameter | Required | Type | Notes | | ----------------------------------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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.group_ids` | No | `array` | Array of group IDs. Max array size: 200 | +| `filters.active` | No | `bool` | If set to `true`: returns active chats only. If set to `false`: returns inactive chats only. If set to `null` or not provided: returns 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.group_ids` | No | `array` | An array of group IDs. Maximum array size: 200. | | `filters.properties...` | No | `any` | | -| `sort_order` | No | `string` | Possible values: `asc` - oldest chats first, `desc` - newest chats first (default) | -| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, maximum: 100. | +| `sort_order` | No | `string` | Possible values: `asc` - oldest chats first, `desc` - newest chats first. Default: `desc`. | +| `limit` | No | `number` | The maximum number of records returned on each [page](#pagination). Default: 10. Maximum: 100. | | `page_id` | No | `string` | | `filter_type` can take the following values: @@ -199,12 +199,12 @@ There's only one value allowed for a single property. #### Response -| Field | Data type | Notes | -| ------------------ | --------- | ------------------------------------------------------------------------------------------------------------ | -| `chats_summary` | `array` | An array of [Chat summary](/messaging/agent-chat-api/v3.7/data-structures/#chat-summaries) 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. | +| Field | Data type | Notes | +| ------------------ | --------- | ------------------------------------------------------------------------------------------------------------- | +| `chats_summary` | `array` | An array of [Chat summary](/messaging/agent-chat-api/v3.7/data-structures/#chat-summaries) 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. | @@ -311,16 +311,16 @@ It returns threads that the current agent has access to in a given chat. #### Request -| Parameter | Required | Data type | Notes | -| ------------------ | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | | -| `sort_order` | No | `string` | Possible values: `asc` - oldest threads first and `desc` - newest threads first (default). | -| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 3, maximum: 100. To limit the total number of returned records, use `filters`. | -| `page_id` | No | `string` | | -| `min_events_count` | No | `number` | Range: 1-100; Specifies the minimum number of events to be returned in the response. It's the **total** number of events, so they can come from more than one thread. You'll get as many latest threads as needed to meet the `min_events_count` condition. | -| `filters` | No | `object` | | -| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` | -| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` | +| Parameter | Required | Data type | Notes | +| ------------------ | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | | +| `sort_order` | No | `string` | Possible values: `asc` - oldest threads first, `desc` - newest threads first. Default: `desc`. | +| `limit` | No | `number` | The maximum number of records returned on each [page](#pagination). To limit the total number of returned records, use `filters`. Default: 3. Maximum: 100. | +| `page_id` | No | `string` | | +| `min_events_count` | No | `number` | Specifies the minimum number of events to be returned in the response. It's the **total** number of events, so they can come from more than one thread. You'll get as many latest threads as needed to meet the `min_events_count` condition. Minimum: 1. Maximum: 100. | +| `filters` | No | `object` | | +| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | +| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | You cannot use either `limit` and `min_events_count` or `filters` and `min_events_count` at the same time. @@ -425,10 +425,10 @@ It returns a thread that the current agent has access to in a given chat. #### Request -| Parameter | Required | Data type | Notes | -| ----------- | -------- | --------- | -------------------------------------- | -| `chat_id` | Yes | `string` | | -| `thread_id` | No | `string` | Default: the latest thread (if exists) | +| Parameter | Required | Data type | Notes | +| ----------- | -------- | --------- | --------------------------------------- | +| `chat_id` | Yes | `string` | | +| `thread_id` | No | `string` | Default: the latest thread (if exists). | @@ -560,33 +560,33 @@ The list classification is based on threads; 1 chat per 1 thread. Thus, the same #### Request -| Parameter | Required | Data type | Notes | -| ---------------------------------------------------------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `filters` | No | `object` | | -| `filters.query` | No | `string` | | -| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` | -| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` | -| `filters.chat_ids` | No | `array` | Array of chat IDs. Max array size: 1000. | -| `filters.thread_ids` | No | `array` | Array of thread IDs. Cannot be used with other filters or pagination; max array size: 20. | -| `filters.group_ids` | No | `array` | Array of group IDs. Max array size: 200 | -| `filters.properties...` | No | `any` | **\* described below** | -| `filters.agents.` | No | `any` | **\*\* described below** `exists` see to `false` will return unassigned chats; `true` will return the assigned ones. | -| `filters.tags.` | No | `any` | | -| `filters.sales.` | No | `any` | | -| `filters.goals.` | No | `any` | | -| `filters.surveys.` | No | `array` | **\*\*\*** **described below** | -| `filters.event_types.` | No | `any` | **\*\*\*\*** **described below** | -| `filters.greetings.` | No | `any` | **\*\*\*\*\*\*** **described below** | -| `filters.agent_response.` | No | `any` | **\*\*\*\*\*\*\*** **described below** | -| `filters.customer_countries.` | No | `any` | It supports country codes with the `ISO 3166-1 Alpha-2` format. | -| `filters.customer_id` | No | `string` | | -| `filters.customer_email` | No | `string` | | -| `page_id` | No | `string` | | -| `sort_order` **\*\*\*\*\*** | No | `string` | Default: `desc` | -| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, min: 1, max: 100. To limit the total number of returned records, use `filters`. | -| `highlights` | No | `object` | Use it to highlight the match of `filters.query`. To enable highlights with default parameters, pass an empty object. | -| `highlights.pre_tag` | No | `string` | An HTML tag to use for highlighting the matched text; default: ``. Use it together with `highlights.post_tag`. | -| `highlights.post_tag` | No | `string` | An HTML tag to use for highlighting the matched text; default: ``. Use it together with `highlights.pre_tag`. | +| Parameter | Required | Data type | Notes | +| ---------------------------------------------------------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `filters` | No | `object` | | +| `filters.query` | No | `string` | | +| `filters.from` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | +| `filters.to` | No | `string` | Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. | +| `filters.chat_ids` | No | `array` | An array of chat IDs. Maximum array size: 1000. | +| `filters.thread_ids` | No | `array` | An array of thread IDs. Cannot be used with other filters or pagination. Maximum array size: 20. | +| `filters.group_ids` | No | `array` | An array of group IDs. Maximum array size: 200. | +| `filters.properties...` | No | `any` | **\* described below** | +| `filters.agents.` | No | `any` | **\*\* described below** If `exists` is set to `false`: returns unassigned chats. If set to `true`: returns assigned chats. | +| `filters.tags.` | No | `any` | | +| `filters.sales.` | No | `any` | | +| `filters.goals.` | No | `any` | | +| `filters.surveys.` | No | `array` | **\*\*\*** **described below** | +| `filters.event_types.` | No | `any` | **\*\*\*\*** **described below** | +| `filters.greetings.` | No | `any` | **\*\*\*\*\*\*** **described below** | +| `filters.agent_response.` | No | `any` | **\*\*\*\*\*\*\*** **described below** | +| `filters.customer_countries.` | No | `any` | Supports country codes with the `ISO 3166-1 Alpha-2` format. | +| `filters.customer_id` | No | `string` | | +| `filters.customer_email` | No | `string` | | +| `page_id` | No | `string` | | +| `sort_order` **\*\*\*\*\*** | No | `string` | Default: `desc`. | +| `limit` | No | `number` | The maximum number of records returned on each [page](#pagination). To limit the total number of returned records, use `filters`. Default: 10. Minimum: 1. Maximum: 100. | +| `highlights` | No | `object` | Use it to highlight the match of `filters.query`. To enable highlights with default parameters, pass an empty object. | +| `highlights.pre_tag` | No | `string` | An HTML tag to use for highlighting the matched text. Use it together with `highlights.post_tag`. Default: ``. | +| `highlights.post_tag` | No | `string` | An HTML tag to use for highlighting the matched text. Use it together with `highlights.pre_tag`. Default: ``. | **\*)** `` can take the following values: @@ -633,8 +633,8 @@ You can pass only one of the following values at a time: `values` or `exclude_va **\*\*\*\*\*\*)** `` can take the following values: -- `from` (`string`) - Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` -- `to` (`string`) - Date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` +- `from` (`string`) - A date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` +- `to` (`string`) - A date & time format compatible with RFC3339 with a resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM` - `exists` (`bool`) - `values` (`int[]`) - an array of greeting IDs - `exclude_values` (`int[]`) - an array of greeting IDs @@ -797,19 +797,19 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch #### Request -| Parameter | Required | Data type | Notes | -| ------------------------ | -------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat` | No | `object` | | -| `chat.properties` | No | `object` | | -| `chat.access` | No | `object` | | -| `chat.users` | No | `[]object` | The list of existing users. Up to 4 additional (other than the requester) agents and 1 customer allowed. | -| `chat.users.id` | Yes | `string` | User ID | -| `chat.users.type` | Yes | `string` | `agent` or `customer`. | -| `chat.thread` | No | `object` | | -| `chat.thread.events` | No | `array` | The list of initial chat [events](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. | -| `chat.thread.properties` | No | `object` | | -| `active` | No | `bool` | When set to `false`, creates an inactive thread; default: `true`. | -| `continuous` | No | `bool` | Starts chat as continuous (online group is not required); default: `false`. | +| Parameter | Required | Data type | Notes | +| ------------------------ | -------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `chat` | No | `object` | | +| `chat.properties` | No | `object` | | +| `chat.access` | No | `object` | | +| `chat.users` | No | `[]object` | The list of existing users. Up to 4 additional agents (other than the requester) and 1 customer allowed. | +| `chat.users.id` | Yes | `string` | The user ID. | +| `chat.users.type` | Yes | `string` | Possible values: `agent`, `customer`. | +| `chat.thread` | No | `object` | | +| `chat.thread.events` | No | `array` | The list of initial chat [events](/messaging/agent-chat-api/data-structures/#events) objects. Does not support the `form` type event in the LiveChat app. | +| `chat.thread.properties` | No | `object` | | +| `active` | No | `bool` | If set to `false`: creates an inactive thread. Default: `true`. | +| `continuous` | No | `bool` | If set to `true`: starts chat as continuous (online group is not required). Default: `false`. | #### Response @@ -876,20 +876,20 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch #### Request -| Parameter | Required | Type | Notes | +| Parameter | Required | Data type | Notes | | ------------------------ | -------- | ---------- | -------------------------------------------------------------------------------------------------------- | -| `chat` | Yes | `object` | | +| `chat` | No | `object` | | | `chat.id` | Yes | `string` | The ID of the chat that will be resumed. | -| `chat.access` | No | `object` | Chat access to set, default: all agents. | -| `chat.properties` | No | `object` | Initial chat properties | -| `chat.users` | No | `[]object` | The list of existing users. Up to 4 additional (other than the requester) agents and 1 customer allowed. | -| `chat.users.id` | Yes | `string` | User ID | -| `chat.users.type` | Yes | `string` | `agent` or `customer` | +| `chat.access` | No | `object` | The chat access to set. Default: all agents. | +| `chat.properties` | No | `object` | Initial chat properties. | +| `chat.users` | No | `[]object` | The list of existing users. Up to 4 additional agents (other than the requester) and 1 customer allowed. | +| `chat.users.id` | Yes | `string` | The user ID. | +| `chat.users.type` | Yes | `string` | Possible values: `agent`, `customer`. | | `chat.thread` | No | `object` | | -| `chat.thread.events` | No | `array` | Initial chat events array | -| `chat.thread.properties` | No | `object` | Initial thread properties | -| `active` | No | `bool` | When set to `false`, creates an inactive thread. Default `true`. | -| `continuous` | No | `bool` | Sets a chat to the continuous mode. When unset, leaves the mode unchanged. | +| `chat.thread.events` | No | `array` | An initial chat events array. | +| `chat.thread.properties` | No | `object` | Initial thread properties. | +| `active` | No | `bool` | If set to `false`: creates an inactive thread. Default: `true`. | +| `continuous` | No | `bool` | If set to `true`: sets a chat to the continuous mode. If not set: leaves the mode unchanged. | #### Response @@ -957,10 +957,10 @@ The requester must be present on the list of chat users. You can override it by #### Request -| Parameter | Required | Data type | Notes | -| --------------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | | -| `ignore_requester_presence` | No | `bool` | If `true`, the requester doesn't need to be present on the list of chat users; default `false`. | +| Parameter | Required | Data type | Notes | +| --------------------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------- | +| `id` | Yes | `string` | | +| `ignore_requester_presence` | No | `bool` | If set to `true`: the requester doesn't need to be present on the list of chat users. Default: `false`. | @@ -1140,14 +1140,14 @@ Transfers a chat to an agent or a group. The following restrictions apply: #### Request -| Parameter | Required | Data type | Notes | -| ---------------------------- | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | Chat ID | -| `target` | No | `object` | If missing, the chat will be transferred within the current group. | -| `target.type` | Yes | `string` | `group` or `agent` | -| `target.ids` | Yes | `array` | `group` or `agent` IDs array | -| `ignore_agents_availability` | No | `bool` | If `true`, allows the chat to be enqueued after the transfer. Otherwise, fails when unable to immediately assign any agent from the requested groups; default `false`. | -| `ignore_requester_presence` | No | `bool` | If `true`, the requester doesn't need to be present on the list of chat users; default `false`. | +| Parameter | Required | Data type | Notes | +| ---------------------------- | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | Yes | `string` | The chat ID. | +| `target` | No | `object` | If missing: the chat will be transferred within the current group. | +| `target.type` | Yes | `string` | Possible values: `group`, `agent`. | +| `target.ids` | Yes | `array` | An array of `group` or `agent` IDs. | +| `ignore_agents_availability` | No | `bool` | If set to `true`: allows the chat to be enqueued after the transfer. If set to `false`: fails when unable to immediately assign any agent from the requested groups. Default: `false`. | +| `ignore_requester_presence` | No | `bool` | If set to `true`: the requester doesn't need to be present on the list of chat users. Default: `false`. | @@ -1219,13 +1219,13 @@ To learn how to add more than one agent to the chat, reach out to us [on Discord #### Request -| Parameter | Required | Type | Notes | -| --------------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | | -| `user_id` | Yes | `string` | | -| `user_type` | Yes | `string` | Possible values: `agent` or `customer` | -| `visibility` | Yes | `string` | Possible values: `all` or `agents` | -| `ignore_requester_presence` | No | `bool` | If `true`, the requester doesn't need to be present on the list of chat users; default `false`. | +| Parameter | Required | Type | Notes | +| --------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | | +| `user_id` | Yes | `string` | | +| `user_type` | Yes | `string` | Possible values: `agent`, `customer`. | +| `visibility` | Yes | `string` | Possible values: `all`, `agents`. | +| `ignore_requester_presence` | No | `bool` | If set to `true`: the requester doesn't need to be present on the list of chat users. Default: `false`. | @@ -1289,12 +1289,12 @@ Removes a user from chat. The following restrictions apply: #### Request -| Parameter | Required | Type | Notes | -| --------------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | | -| `user_id` | Yes | `string` | | -| `user_type` | Yes | `string` | Possible value: `agent` | -| `ignore_requester_presence` | No | `bool` | If `true`, the requester doesn't need to be present on the list of chat users; default `false`. | +| Parameter | Required | Type | Notes | +| --------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | | +| `user_id` | Yes | `string` | | +| `user_type` | Yes | `string` | Possible values: `agent`. | +| `ignore_requester_presence` | No | `bool` | If set to `true`: the requester doesn't need to be present on the list of chat users. Default: `false`. | @@ -1355,10 +1355,10 @@ Sends an [event](/messaging/agent-chat-api/v3.7/data-structures/#events) that is #### Request -| Parameters | Required | Data type | Notes | -| ---------- | -------- | --------- | ------------------------------------------------------------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat you want to send the message to. | -| `event` | Yes | `object` | [Event](/messaging/agent-chat-api/data-structures/#events) object. Supports only `message` type. | +| Parameters | Required | Data type | Notes | +| ---------- | -------- | --------- | ------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to send the message to. | +| `event` | Yes | `object` | An [Event](/messaging/agent-chat-api/data-structures/#events) object. Supports only the `message` type. | @@ -1426,10 +1426,10 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch #### Request -| Parameters | Required | Data type | Notes | -| ---------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat you want to send the message to. | -| `event` | Yes | `object` | [Event](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. | +| Parameters | Required | Data type | Notes | +| ---------- | -------- | --------- | --------------------------------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to send the message to. | +| `event` | Yes | `object` | An [Event](/messaging/agent-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. | @@ -1491,14 +1491,14 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch #### Request -| Parameter | Required | Data type | Notes | -| ------------------ | -------- | --------- | ----------------------------------- | -| `chat_id` | Yes | `string` | | -| `event_id` | Yes | `string` | | -| `postback` | Yes | `object` | | -| `postback.id` | Yes | `string` | Postback name of the button | -| `postback.toggled` | Yes | `bool` | Postback toggled; `true` or `false` | -| `thread_id` | Yes | `string` | | +| Parameter | Required | Data type | Notes | +| ------------------ | -------- | --------- | -------------------------------- | +| `chat_id` | Yes | `string` | | +| `event_id` | Yes | `string` | | +| `postback` | Yes | `object` | | +| `postback.id` | Yes | `string` | The postback name of the button. | +| `postback.toggled` | Yes | `bool` | Whether the postback is toggled. | +| `thread_id` | Yes | `string` | | @@ -1563,7 +1563,7 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch | Parameter | Required | Data type | Notes | | ------------ | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | Id of the chat you to set a property for. | +| `id` | Yes | `string` | The chat ID. | | `properties` | Yes | `object` | Chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | @@ -1624,10 +1624,10 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ----------------------------------------------- | -| `id` | Yes | `string` | Id of the chat you want to delete property for. | -| `properties` | Yes | `object` | Chat properties to delete. | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | -------------------------- | +| `id` | Yes | `string` | The chat ID. | +| `properties` | Yes | `object` | Chat properties to delete. | @@ -1689,8 +1689,8 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch | Parameter | Required | Data type | Notes | | ------------ | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to set properties for. | -| `thread_id` | Yes | `string` | Id of the thread you want to set properties for. | +| `chat_id` | Yes | `string` | The chat ID. | +| `thread_id` | Yes | `string` | A thread ID. | | `properties` | Yes | `object` | Chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | @@ -1752,11 +1752,11 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to delete property for. | -| `thread_id` | Yes | `string` | Id of the thread you want to delete property for. | -| `properties` | Yes | `object` | Chat properties to delete. | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | ----------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to delete property for. | +| `thread_id` | Yes | `string` | The ID of the thread you want to delete property for. | +| `properties` | Yes | `object` | Chat properties to delete. | @@ -1817,12 +1817,12 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ------------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat you want to set properties for. | -| `thread_id` | Yes | `string` | Id of the thread you want to set properties for. | -| `event_id` | Yes | `string` | Id of the event you want to set properties for. | -| `properties` | Yes | `object` | Chat properties to set. | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | ---------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to set properties for. | +| `thread_id` | Yes | `string` | The ID of the thread you want to set properties for. | +| `event_id` | Yes | `string` | The ID of the event you want to set properties for. | +| `properties` | Yes | `object` | Chat properties to set. | @@ -1886,9 +1886,9 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch | Parameter | Required | Data type | Notes | | ------------ | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to delete the properties of. | -| `thread_id` | Yes | `string` | Id of the thread you want to delete the properties of. | -| `event_id` | Yes | `string` | Id of the event you want to delete the properties of. | +| `chat_id` | Yes | `string` | The ID of the chat you want to delete the properties of. | +| `thread_id` | Yes | `string` | The ID of the thread you want to delete the properties of. | +| `event_id` | Yes | `string` | The ID of the event you want to delete the properties of. | | `properties` | Yes | `object` | Event properties to delete. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | @@ -1957,11 +1957,11 @@ Read how to [list all available tags](/management/configuration-api/v3.7#list-ta #### Request -| Parameter | Required | Data type | Notes | -| ----------- | -------- | --------- | ------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat you want to add a tag to. | -| `thread_id` | Yes | `string` | Id of the thread you want to add a tag to. | -| `tag` | Yes | `string` | Tag name. It's case sensitive. | +| Parameter | Required | Data type | Notes | +| ----------- | -------- | --------- | ---------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to add a tag to. | +| `thread_id` | Yes | `string` | The ID of the thread you want to add a tag to. | +| `tag` | Yes | `string` | The tag name. It's case sensitive. | @@ -2020,11 +2020,11 @@ Untags a given **thread**. #### Request -| Parameter | Required | Data type | Notes | -| ----------- | -------- | --------- | ----------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to remove a tag from. | -| `thread_id` | Yes | `string` | Id of the thread you want to remove a tag from. | -| `tag` | Yes | `string` | Tag name. It's case sensitive. | +| Parameter | Required | Data type | Notes | +| ----------- | -------- | --------- | --------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to remove a tag from. | +| `thread_id` | Yes | `string` | The ID of the thread you want to remove a tag from. | +| `tag` | Yes | `string` | The tag name. It's case sensitive. | @@ -2089,13 +2089,13 @@ Returns the info about the customer with a given `id`. | Field | Data type | Notes | | ---------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `id` | string | [Customer's](/messaging/agent-chat-api/v3.7/data-structures/#customer) ID. | +| `id` | string | The [customer's](/messaging/agent-chat-api/v3.7/data-structures/#customer) ID. | | `type` | string | `customer` | -| `name` | string | Customer's name. Returned only if set. | -| `email` | string | Customer's email. Returned only if set. | -| `avatar` | string | Customer's avatar. Returned only if set. | +| `name` | string | The customer's name. Returned only if set. | +| `email` | string | The customer's email. Returned only if set. | +| `avatar` | string | The customer's avatar. Returned only if set. | | `created_at` | string | Specifies when the customer's identity was created. | -| `session_fields` | []object | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| `session_fields` | []object | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | | `statistics` | object | Counters for started threads, opened pages, etc. | | `visit` | object | Geolocation and opened pages from the customer's most recent online visit. Returned only if the customer logged in at least once. | | `chat_ids` | []string | IDs of a customer's chats. Returned only if the customer had at least one chat. | @@ -2204,13 +2204,13 @@ Updates customer's properties. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `id` | Yes | `string` | UUID v4 format is required. | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `id` | Yes | `string` | The UUID v4 format is required. | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | The URL of the customer's avatar. | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | Apart from `id`, which is a required parameter, you also need to include **one of the optional** parameters. @@ -2339,9 +2339,9 @@ It won't be sent when the requester already follows the customer or is chatting #### Request -| Parameter | Required | Data type | | -| --------- | -------- | --------- | --- | -| `id` | Yes | `string` | | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ----- | +| `id` | Yes | `string` | | @@ -2394,9 +2394,9 @@ Removes the agent from the list of customer's followers. Calling this method on #### Request -| Parameter | Required | Data type | | -| --------- | -------- | --------- | --- | -| `id` | Yes | `string` | | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ----- | +| `id` | Yes | `string` | | @@ -2451,10 +2451,10 @@ If the number of tracked customers exceeds the limit, the `subscribed_customers_ #### Request -| Parameter | Required | Data type | | -| ----------- | -------- | --------- | --- | -| `group_ids` | No | `[]int` | | -| `limit` | No | int | | +| Parameter | Required | Data type | Notes | +| ----------- | -------- | --------- | ----- | +| `group_ids` | No | `[]int` | | +| `limit` | No | int | | @@ -2512,9 +2512,9 @@ Removes a customer subscription. #### Request -| Parameter | Required | Data type | | -| ----------------- | -------- | --------- | --- | -| `subscription_id` | Yes | string | | +| Parameter | Required | Data type | Notes | +| ----------------- | -------- | --------- | ----- | +| `subscription_id` | Yes | string | | @@ -2581,18 +2581,18 @@ It returns the initial state of the current agent. | Parameter | Required | Data type | Notes | | --------------------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `token` | Yes | `string` | OAuth token from the agent's account | +| `token` | Yes | `string` | The OAuth token from the agent's account. | | `timezone` | No | `string` | | -| `reconnect` | No | `bool` | Reconnecting sets the status to the last known state instead of the default one. | +| `reconnect` | No | `bool` | If set to `true`: reconnecting sets the status to the last known state instead of the default one. | | `application` | No | `object` | | -| `application.name` | No | `string` | Application name | -| `application.version` | No | `string` | Application version | -| `away` __*__ | No | `bool` | When `true`, the connection is set to the `away` state. Defaults to `false`. | +| `application.name` | No | `string` | The application name. | +| `application.version` | No | `string` | The application version. | +| `away` __*__ | No | `bool` | If set to `true`: the connection is set to the `away` state. Default: `false`. | | `customer_monitoring_level` | No | `string` | Possible values: `my`, `chatting`, `invited`, `online`, `highest_available` __**__. Defaults to `my` if [login](#login) creates the first session; otherwise it preserves the current `customer_monitoring_level`. | | `pushes` | No | `object` | Use case: when you want to receive only specific pushes. By default, it's set to `all` for the version of your currently established RTM connection. | -| `pushes.` | Yes | `[]string` | A list of push subscriptions for a specific version;`` is a version number, without `v` prefix. Possible values: push names. | +| `pushes.` | Yes | `[]string` | A list of push subscriptions for a specific version; `` is a version number, without `v` prefix. Possible values: push names. | -__*__ You can use the `away` param to **prevent assigning chats** to Agents **after random reconnections** when their status was set to `not_accepting_chats` by the auto-away feature. When an agent logs in with `away: true`, the connection is immediately recognized +__*__ You can use the `away` param to **prevent assigning chats** to agents **after random reconnections** when their status was set to `not_accepting_chats` by the auto-away feature. When an agent logs in with `away: true`, the connection is immediately recognized as `away`. [Read more...](#set-away-status) __**__ These values mean: @@ -2729,9 +2729,9 @@ Remember that checking if Agents are active/inactive should be **implemented on #### Request -| Parameter | Required | Data type | -| --------- | -------- | --------- | -| `away` | Yes | `bool` | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ----- | +| `away` | Yes | `bool` | | @@ -2793,10 +2793,10 @@ Unlike [**Set Away Status**](#set-away-status), which is another mechanism of st #### Request -| Parameter | Required | Data type | Notes | -| ---------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------ | -| `status` | Yes | `string` | For Agents: `accepting_chats` or `not_accepting_chats`; for bot agents: `accepting_chats`, `not_accepting_chats`, or `offline` | -| `agent_id` | No | `string` | If not specified, the requester's status will be updated. | +| Parameter | Required | Data type | Notes | +| ---------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------- | +| `status` | Yes | `string` | For agents: `accepting_chats` or `not_accepting_chats`. For bot agents: `accepting_chats`, `not_accepting_chats`, or `offline`. | +| `agent_id` | No | `string` | If not specified, the requester's status will be updated. | @@ -2965,9 +2965,9 @@ Replaces the token used in the login request with a new one. This allows the web #### Request -| Parameter | Required | Type | Notes | -| --------- | -------- | -------- | ------------------------------------ | -| `token` | Yes | `string` | OAuth token from the agent's account | +| Parameter | Required | Type | Notes | +| --------- | -------- | -------- | ----------------------------------------- | +| `token` | Yes | `string` | The OAuth token from the agent's account. | @@ -3024,10 +3024,10 @@ Replaces the token used in the login request with a new one. This allows the web #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ------------------------- | -| `chat_id` | Yes | `string` | | -| `seen_up_to` | Yes | `string` | RFC 3339 date-time format | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | ------------------------------ | +| `chat_id` | Yes | `string` | | +| `seen_up_to` | Yes | `string` | The RFC 3339 date-time format. | @@ -3079,17 +3079,17 @@ Replaces the token used in the login request with a new one. This allows the web **\*)** `chats--all:rw` - to send the thinking indicator to a chat taking place in any group. -**\*\*)** `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). +**\*\*)** `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 in common). #### Request -| Parameter | Required | Data type | Notes | -| ------------- | -------- | --------- | ---------------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to send the thinking indicator to. | -| `title` | No | `string` | | -| `description` | No | `string` | | -| `visibility` | No | `string` | Default: `all`; `agents` | -| `custom_id` | No | `string` | | +| Parameter | Required | Data type | Notes | +| ------------- | -------- | --------- | -------------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to send the thinking indicator to. | +| `title` | No | `string` | | +| `description` | No | `string` | | +| `visibility` | No | `string` | Possible values: `all`, `agents`. Default: `all`. | +| `custom_id` | No | `string` | | @@ -3144,15 +3144,15 @@ Replaces the token used in the login request with a new one. This allows the web **\*)** `chats--all:rw` - to send the typing indicator to a chat taking place in any group. -**\*\*)** `chats--access:rw` - to send the typing 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). +**\*\*)** `chats--access:rw` - to send the typing 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 in common). #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | -------------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to send the typing indicator to. | -| `visibility` | No | `string` | `all` (default), `agents` | -| `is_typing` | Yes | `bool` | | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | ------------------------------------------------------------ | +| `chat_id` | Yes | `string` | The ID of the chat you want to send the typing indicator to. | +| `visibility` | No | `string` | Possible values: `all`, `agents`. Default: `all`. | +| `is_typing` | Yes | `bool` | | @@ -3195,7 +3195,7 @@ Replaces the token used in the login request with a new one. This allows the web This method serves for the **chat-unrelated communication**. Messages sent using `multicast` are not being saved. -For example, it could be used in an app that sends notifications to Agents or Customers, when a certain condition is met (e.g. an important customer started the chat). +For example, it could be used in an app that sends notifications to agents or customers, when a certain condition is met (e.g. an important customer started the chat). #### Specifics @@ -3208,11 +3208,11 @@ For example, it could be used in an app that sends notifications to Agents or Cu #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ------------------------- | -| `recipients` | Yes | `object` | **\*** | -| `content` | Yes | `any` | A JSON message to be sent | -| `type` | No | `string` | Multicast message type | +| Parameter | Required | Data type | Notes | +| ------------ | -------- | --------- | --------------------------- | +| `recipients` | Yes | `object` | **\*** | +| `content` | Yes | `any` | A JSON message to be sent. | +| `type` | No | `string` | The multicast message type. | **\*)** `recipients` can take the following values: @@ -3287,10 +3287,10 @@ At least one `recipients` type (`agents.all`, `agents.ids`, `agents.groups`, `cu ### List Agents For Transfer -It returns the Agents you can transfer a chat to. Agents are sorted ascendingly by the total number of active chats they have. Note that: +It returns the agents you can transfer a chat to. Agents are sorted ascendingly by the total number of active chats they have. Note that: -- The method only returns Agents with statuses **online** and **not accepting chats**. Offline Agents aren't returned. -- Only chats **with Customers** are taken into account in `total_active_chats`. +- The method only returns agents with statuses **online** and **not accepting chats**. Offline agents aren't returned. +- Only chats **with customers** are taken into account in `total_active_chats`. #### Specifics @@ -3303,9 +3303,9 @@ It returns the Agents you can transfer a chat to. Agents are sorted ascendingly #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | --------------------------------------- | -| `chat_id` | Yes | `string` | The ID of the chat you want to transfer | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ---------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to transfer. | diff --git a/src/pages/messaging/customer-chat-api/data-structures/index.mdx b/src/pages/messaging/customer-chat-api/data-structures/index.mdx index 1193a0aee..bc0cb7efe 100644 --- a/src/pages/messaging/customer-chat-api/data-structures/index.mdx +++ b/src/pages/messaging/customer-chat-api/data-structures/index.mdx @@ -382,7 +382,7 @@ It is not possible to send a System event in API version 3.6. | `email` | optional | | | `email_verified` | optional | Specifies if the customer confirmed their email address. See [Request Email Verification](#request-email-verification). | | `name` | optional | | -| `session_fields` | optional | An array of custom object-enclosed `key:value` pairs. Available for the session duration. | +| `session_fields` | optional | An array of custom object-enclosed key-value pairs. Available for the session duration. | ## Agent diff --git a/src/pages/messaging/customer-chat-api/index.mdx b/src/pages/messaging/customer-chat-api/index.mdx index e353d4f01..d28db865d 100644 --- a/src/pages/messaging/customer-chat-api/index.mdx +++ b/src/pages/messaging/customer-chat-api/index.mdx @@ -130,7 +130,7 @@ It returns [summaries](/messaging/customer-chat-api/v3.6/data-structures/#chat-s | Parameter | Required | Type | Notes | | ------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------ | -| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, maximum: 25. | +| `limit` | No | `number` | The 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` | | @@ -231,10 +231,10 @@ It returns threads that the current customer has access to in a given chat. | Parameter | Required | Data type | Notes | | ------------------ | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `chat_id` | Yes | `string` | | -| `sort_order` | No | `string` | Possible values: `asc` - oldest threads first and `desc` - newest threads first (default). | -| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 3, maximum: 100. | +| `sort_order` | No | `string` | Possible values: `asc` – oldest threads first and `desc` – newest threads first (default). | +| `limit` | No | `number` | The maximum number of records returned on each [page](#pagination). Default: 3, maximum: 100. | | `page_id` | No | `string` | | -| `min_events_count` | No | `number` | Range: 1-100; Specifies the minimum number of events to be returned in the response. It's the **total** number of events, so they can come from more than one thread. You'll get as many latest threads as needed to meet the `min_events_count` condition. | +| `min_events_count` | No | `number` | Range: 1-100. Specifies the minimum number of events to be returned in the response. It's the **total** number of events, so they can come from more than one thread. You'll get as many latest threads as needed to meet the `min_events_count` condition. | You cannot use both `limit` and `min_events_count` at the same time. @@ -414,16 +414,16 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch #### Request -| Parameter | Required | Data type | Notes | -| ------------------------ | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat` | No | `object` | | -| `chat.properties` | No | `object` | Initial chat properties | -| `chat.access` | No | `object` | Chat access to set; default: all agents. | -| `chat.thread` | No | `object` | | -| `chat.thread.events` | No | `array` | Initial chat [events](/messaging/customer-chat-api/data-structures/#events) array. Does not support the `form` type event in the LiveChat app. | -| `chat.thread.properties` | No | `object` | Initial thread properties | -| `active` | No | `bool` | When set to `false`, creates an inactive thread; default: `true`. | -| `continuous` | No | `bool` | Starts chat as continuous (online group is not required); default: `false`. | +| Parameter | Required | Data type | Notes | +| ------------------------ | -------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | +| `chat` | No | `object` | | +| `chat.properties` | No | `object` | The initial chat properties. | +| `chat.access` | No | `object` | The chat access to set. Default: all agents. | +| `chat.thread` | No | `object` | | +| `chat.thread.events` | No | `array` | The initial chat [events](/messaging/customer-chat-api/data-structures/#events) array. Does not support the `form` type event in the LiveChat app. | +| `chat.thread.properties` | No | `object` | The initial thread properties. | +| `active` | No | `bool` | When set to `false`, creates an inactive thread. When set to `true`, creates an active thread. Default: `true`. | +| `continuous` | No | `bool` | When set to `true`, starts chat as continuous (online group is not required). When set to `false`, starts chat as non-continuous. Default: `false`. | #### Response @@ -484,17 +484,17 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch #### Request -| Parameter | Required | Data type | Notes | -| ------------------------ | -------- | --------- | -------------------------------------------------------------------------- | -| `chat` | Yes | `object` | | -| `chat.id` | Yes | `string` | ID of the chat that will be resumed. | -| `chat.access` | No | `object` | Chat access to set; default: all agents. | -| `chat.properties` | No | `object` | Initial chat properties | -| `chat.thread` | No | `object` | | -| `chat.thread.events` | No | `array` | Initial chat events array | -| `chat.thread.properties` | No | `object` | Initial thread properties | -| `active` | No | `bool` | When set to `false`, creates an inactive thread; default: `true`. | -| `continuous` | No | `bool` | Sets a chat to the continuous mode. When unset, leaves the mode unchanged. | +| Parameter | Required | Data type | Notes | +| ------------------------ | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `chat` | Yes | `object` | | +| `chat.id` | Yes | `string` | The ID of the chat that will be resumed. | +| `chat.access` | No | `object` | The chat access to set. Default: all agents. | +| `chat.properties` | No | `object` | The initial chat properties. | +| `chat.thread` | No | `object` | | +| `chat.thread.events` | No | `array` | The initial chat events array. | +| `chat.thread.properties` | No | `object` | The initial thread properties. | +| `active` | No | `bool` | When set to `false`, creates an inactive thread. When set to `true`, creates an active thread. Default: `true`. | +| `continuous` | No | `bool` | When set to `true`, sets a chat to the continuous mode. When set to `false`, sets a chat to non-continuous mode. When unset, leaves the mode unchanged. | #### Response @@ -606,12 +606,12 @@ Returns the dynamic configuration of a given group. It provides data to call [** #### Request -| Parameter | Required | Data type | Notes | -| -------------- | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------- | -| `group_id` | No | `number` | The ID of the group that you want to get a dynamic configuration for. ID of the default group is used if not provided. | -| `url` | No | `string` | The URL that you want to get a dynamic configuration for. | -| `channel_type` | No | `string` | The channel type that you want to get a dynamic configuration for. | -| `test` | No | `bool` | Treats a dynamic configuration request as a test. | +| Parameter | Required | Data type | Notes | +| -------------- | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------- | +| `group_id` | No | `number` | The ID of the group that you want to get a dynamic configuration for. The ID of the default group is used if not provided. | +| `url` | No | `string` | The URL that you want to get a dynamic configuration for. | +| `channel_type` | No | `string` | The channel type that you want to get a dynamic configuration for. | +| `test` | No | `bool` | When set to `true`, treats a dynamic configuration request as a test. | #### Response @@ -772,11 +772,11 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch #### Request -| Parameter | Required | Data type | Notes | -| ----------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat that you to send a message to. | -| `event` | Yes | `object` | [Event](/messaging/customer-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. | -| `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`. | +| Parameter | Required | Data type | Notes | +| ----------------------- | -------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat that you want to send a message to. | +| `event` | Yes | `object` | The [Event](/messaging/customer-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. | +| `attach_to_last_thread` | No | `bool` | When set to `true`, the event will be added to the last thread for inactive chats. When set to `false`, the request will fail for inactive chats. The flag is ignored for active chats. Default: `false`. | @@ -835,11 +835,11 @@ In the Agent Chat API, the [Delete Event](#delete-event) method replaces the ori #### Request -| Parameter | Required | Data type | Notes | -| ----------- | -------- | --------- | ------------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat that you want to delete an event from. | -| `thread_id` | Yes | `string` | Id of the thread that you want to delete an event from. | -| `event_id` | Yes | `string` | Id of the event that you want to delete. | +| Parameter | Required | Data type | Notes | +| ----------- | -------- | --------- | ----------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat that you want to delete an event from. | +| `thread_id` | Yes | `string` | The ID of the thread that you want to delete an event from. | +| `event_id` | Yes | `string` | The ID of the event that you want to delete. | @@ -889,9 +889,9 @@ Uploads a file to the server as a temporary file. It returns a URL that expires #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | ------------------ | -| `file` | Yes | `binary` | Maximum size: 10MB | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ----------------------- | +| `file` | Yes | `binary` | The maximum size: 10MB. | @@ -937,14 +937,14 @@ curl -X POST \ #### Request -| Parameter | Required | Data type | Notes | -| ------------------ | -------- | --------- | ----------------------------------- | -| `chat_id` | Yes | `string` | | -| `event_id` | Yes | `string` | | -| `postback` | Yes | `object` | | -| `postback.id` | Yes | `string` | Postback name of the button | -| `postback.toggled` | Yes | `bool` | Postback toggled; `true` or `false` | -| `thread_id` | Yes | `string` | | +| Parameter | Required | Data type | Notes | +| ------------------ | -------- | --------- | -------------------------------- | +| `chat_id` | Yes | `string` | | +| `event_id` | Yes | `string` | | +| `postback` | Yes | `object` | | +| `postback.id` | Yes | `string` | The postback name of the button. | +| `postback.toggled` | Yes | `bool` | The toggle state of the button. | +| `thread_id` | Yes | `string` | | #### Response @@ -996,10 +996,10 @@ Sends a sneak peek to a chat. #### Request -| Parameter | Required | Data type | Notes | -| ----------------- | -------- | --------- | --------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat to send a sneak peek to. | -| `sneak_peek_text` | Yes | `string` | Sneak peek text | +| Parameter | Required | Data type | Notes | +| ----------------- | -------- | --------- | ------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat to send a sneak peek to. | +| `sneak_peek_text` | Yes | `string` | The sneak peek text. | #### Response @@ -1105,10 +1105,10 @@ curl -X GET \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | Id of the chat you to set a property for. | -| `properties` | Yes | `object` | Chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | +| Parameter | Required | Type | Notes | +| ------------ | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | Yes | `string` | The ID of the chat you want to set a property for. | +| `properties` | Yes | `object` | The chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | #### Response @@ -1157,10 +1157,10 @@ curl -X POST \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ------------------------------------------------ | -| `id` | Yes | `string` | Id of the chat you want to delete properties of. | -| `properties` | Yes | `object` | Chat properties to delete. | +| Parameter | Required | Type | Notes | +| ------------ | -------- | -------- | ---------------------------------------------------- | +| `id` | Yes | `string` | The ID of the chat you want to delete properties of. | +| `properties` | Yes | `object` | The chat properties to delete. | #### Response @@ -1209,11 +1209,11 @@ curl -X POST \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ------------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat you want to set properties for. | -| `thread_id` | Yes | `string` | Id of the thread you want to set properties for. | -| `properties` | Yes | `object` | Chat properties to set. | +| Parameter | Required | Type | Notes | +| ------------ | -------- | -------- | ---------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to set properties for. | +| `thread_id` | Yes | `string` | The ID of the thread you want to set properties for. | +| `properties` | Yes | `object` | The chat properties to set. | #### Response @@ -1263,11 +1263,11 @@ curl -X POST \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ------------------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat you want to delete the properties of. | -| `thread_id` | Yes | `string` | Id of the thread you want to delete the properties of. | -| `properties` | Yes | `object` | Thread properties to delete. | +| Parameter | Required | Type | Notes | +| ------------ | -------- | -------- | ---------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to delete the properties of. | +| `thread_id` | Yes | `string` | The ID of the thread you want to delete the properties of. | +| `properties` | Yes | `object` | The thread properties to delete. | #### Response @@ -1317,12 +1317,12 @@ curl -X POST \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to set properties for. | -| `thread_id` | Yes | `string` | Id of the thread you want to set properties for. | -| `event_id` | Yes | `string` | Id of the event you want to set properties for. | -| `properties` | Yes | `object` | Chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | +| Parameter | Required | Type | Notes | +| ------------ | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to set properties for. | +| `thread_id` | Yes | `string` | The ID of the thread you want to set properties for. | +| `event_id` | Yes | `string` | The ID of the event you want to set properties for. | +| `properties` | Yes | `object` | The chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | #### Response @@ -1373,12 +1373,12 @@ curl -X POST \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to delete the properties of. | -| `thread_id` | Yes | `string` | Id of the thread you want to delete the properties of. | -| `event_id` | Yes | `string` | Id of the event you want to delete the properties of. | -| `properties` | Yes | `object` | Event properties to delete. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | +| Parameter | Required | Type | Notes | +| ------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `chat_id` | Yes | `string` | The ID of the chat you want to delete the properties of. | +| `thread_id` | Yes | `string` | The ID of the thread you want to delete the properties of. | +| `event_id` | Yes | `string` | The ID of the event you want to delete the properties of. | +| `properties` | Yes | `object` | The event properties to delete. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | #### Response @@ -1432,10 +1432,10 @@ Returns the properties of a given license. It only returns the properties a cust #### Request -| Query string parameter | Required | Data type | Notes | -| ---------------------- | -------- | --------- | ------------------------------ | -| `namespace` | No | `string` | Property namespace to retrieve | -| `name` | No | `string` | Property name | +| Query string parameter | Required | Data type | Notes | +| ---------------------- | -------- | --------- | ----------------------------------- | +| `namespace` | No | `string` | The property namespace to retrieve. | +| `name` | No | `string` | The property name. | @@ -1486,11 +1486,11 @@ Returns the properties of a given group. It only returns the properties a custom #### Request -| Query string parameter | Required | Data type | Notes | -| ---------------------- | -------- | --------- | ----------------------------------------------------- | -| `id` | Yes | `number` | Id of the group you want to return the properties of. | -| `namespace` | No | `string` | Property namespace to retrieve | -| `name` | No | `string` | Property name | +| Query string parameter | Required | Data type | Notes | +| ---------------------- | -------- | --------- | --------------------------------------------------------- | +| `id` | Yes | `number` | The ID of the group you want to return the properties of. | +| `namespace` | No | `string` | The property namespace to retrieve | +| `name` | No | `string` | The property name | @@ -1543,12 +1543,12 @@ The webhook will be sent only if the customer has active chats. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | The URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | The URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | At least one optional parameter needs to be included in the request. @@ -1604,9 +1604,9 @@ The webhook will be sent only if the customer has active chats. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------ | -| `session_fields` | Yes | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. Max keys: 100 | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | ----------------------------------------------------------------------------------------------------------------- | +| `session_fields` | Yes | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. The maximum number of keys: 100. | Users agent and referrer are updated by default using the browser’s headers. @@ -1658,12 +1658,12 @@ Returns the info about the customer requesting it. #### Response -| | | -| ---------------- | --------------------------------------------------------------------------------------------------------------- | -| `name` | [Customer's](/messaging/customer-chat-api/v3.6/data-structures/#customer) name. Returned only if set. | -| `email` | [Customer's](/messaging/customer-chat-api/v3.6/data-structures/#customer) email. Returned only if set. | -| `avatar` | [Customer's](/messaging/customer-chat-api/v3.6/data-structures/#customer) avatar. Returned only if set. | -| `session_fields` | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| | | +| ---------------- | ------------------------------------------------------------------------------------------------------------- | +| `name` | [Customer's](/messaging/customer-chat-api/v3.6/data-structures/#customer) name. Returned only if set. | +| `email` | [Customer's](/messaging/customer-chat-api/v3.6/data-structures/#customer) email. Returned only if set. | +| `avatar` | [Customer's](/messaging/customer-chat-api/v3.6/data-structures/#customer) avatar. Returned only if set. | +| `session_fields` | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | @@ -1722,10 +1722,10 @@ curl -X POST \ #### Request -| Parameter | Required | Data type | Notes | -| ----------- | -------- | --------- | ---------------------------------------------------------- | -| `all` | No | `bool` | If set to `true`, you will get statuses of all the groups. | -| `group_ids` | No | `array` | A table of groups' IDs | +| Parameter | Required | Data type | Notes | +| ----------- | -------- | --------- | ------------------------------------------------------------ | +| `all` | No | `bool` | When set to `true`, you will get statuses of all the groups. | +| `group_ids` | No | `array` | A table of groups' IDs | One of the optional parameters needs to be included in the request. @@ -1797,11 +1797,11 @@ Customer can use this method to trigger checking if [goals](https://www.livechat #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------- | -| `session_fields` | Yes | `[]object` | An array of custom object-enclosed `key:value` pairs | -| `group_id` | Yes | `number` | | -| `page_url` | Yes | `string` | | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | --------------------------------------------------- | +| `session_fields` | Yes | `[]object` | An array of custom object-enclosed key-value pairs. | +| `group_id` | Yes | `number` | | +| `page_url` | Yes | `string` | | #### Response @@ -1853,17 +1853,17 @@ Returns an empty ticket form of a ` | Yes | `[]string` | A list of push subscriptions for a specific version;`` is a version number, without `v` prefix. Possible values: push names. | +| Parameter | Required | Data type | Notes | +| ----------------------------- | -------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `token` | Yes | `string` | The OAuth token from the customer's account. | +| `customer` | No | `object` | | +| `customer.avatar` | No | `string` | The URL of the customer's avatar. | +| `customer.email` | No | `string` | | +| `customer.name` | No | `string` | | +| `customer.session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | +| `customer_page.title` | No | `string` | | +| `customer_page.url` | No | `string` | | +| `customer_side_storage`**\*** | No | `object` | A map in the `"key": "value"` format. | +| `is_mobile` | No | `bool` | If set to `true`, indicates that logging in is performed from a mobile device. | +| `group_id` | No | `number` | | +| `referrer` | No | `string` | | +| `application` | No | `object` | The application info. | +| `application.name` | No | `string` | The application name. | +| `application.version` | No | `string` | The application version. | +| `application.channel_type` | No | `string` | The application channel type. | +| `pushes` | No | `object` | Use case: when you want to receive only specific pushes. Default: `all` for the version of your currently established RTM connection. | +| `pushes.` | Yes | `[]string` | A list of push subscriptions for a specific version. `` is a version number, without `v` prefix. Possible values: push names. | **\*)** We use `customer_side_storage` to keep some data on the client side. You should pass a map from the `customer_side_storage_updated` push payload to this field. @@ -1764,7 +1764,7 @@ It returns the initial state of the current customer. | Parameter | Required | Data type | Notes | | ----------- | -------- | --------- | ---------------------------------------------------------- | | `all` | No | `bool` | If set to `true`, you will get statuses of all the groups. | -| `group_ids` | No | `array` | A table of a groups' IDs | +| `group_ids` | No | `array` | A table of groups' IDs. | One of the optional parameters needs to be included in the request payload. @@ -1837,17 +1837,17 @@ Returns an empty ticket form of a -| Field | Req./Opt. | Notes | -| ---------------- | --------- | ----------------------------------------------------------------------------------------- | -| `avatar` | optional | | -| `email` | optional | | -| `name` | optional | | -| `session_fields` | optional | An array of custom object-enclosed `key:value` pairs. Available for the session duration. | +| Field | Req./Opt. | Notes | +| ---------------- | --------- | --------------------------------------------------------------------------------------- | +| `avatar` | optional | | +| `email` | optional | | +| `name` | optional | | +| `session_fields` | optional | An array of custom object-enclosed key-value pairs. Available for the session duration. | ## Agent diff --git a/src/pages/messaging/customer-chat-api/v3.2/index.mdx b/src/pages/messaging/customer-chat-api/v3.2/index.mdx index cec59d695..cd314d0e5 100644 --- a/src/pages/messaging/customer-chat-api/v3.2/index.mdx +++ b/src/pages/messaging/customer-chat-api/v3.2/index.mdx @@ -1274,12 +1274,12 @@ curl -X GET \ #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | The URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | The URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | At least one optional parameter needs to be included in the request. @@ -1332,9 +1332,9 @@ curl -X POST \ #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------ | -| `session_fields` | Yes | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. Max keys: 100 | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------------------- | +| `session_fields` | Yes | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. Max keys: 100 | Users agent and referrer are updated by default using the browser’s headers. @@ -1386,12 +1386,12 @@ Returns the info about the customer requesting it. #### Response -| | | -| ---------------- | --------------------------------------------------------------------------------------------------------------- | -| `name` | [Customer's](/messaging/customer-chat-api/v3.2/data-structures/#customer) name. Returned only if set. | -| `email` | [Customer's](/messaging/customer-chat-api/v3.2/data-structures/#customer) email. Returned only if set. | -| `avatar` | [Customer's](/messaging/customer-chat-api/v3.2/data-structures/#customer) avatar. Returned only if set. | -| `session_fields` | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| | | +| ---------------- | ------------------------------------------------------------------------------------------------------------- | +| `name` | [Customer's](/messaging/customer-chat-api/v3.2/data-structures/#customer) name. Returned only if set. | +| `email` | [Customer's](/messaging/customer-chat-api/v3.2/data-structures/#customer) email. Returned only if set. | +| `avatar` | [Customer's](/messaging/customer-chat-api/v3.2/data-structures/#customer) avatar. Returned only if set. | +| `session_fields` | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | @@ -1525,11 +1525,11 @@ Customer can use this method to trigger checking if [goals](https://www.livechat #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------- | -| `session_fields` | Yes | `[]object` | An array of custom object-enclosed `key:value` pairs | -| `group_id` | Yes | `number` | | -| `page_url` | Yes | `string` | | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------- | +| `session_fields` | Yes | `[]object` | An array of custom object-enclosed key-value pairs | +| `group_id` | Yes | `number` | | +| `page_url` | Yes | `string` | | #### Response diff --git a/src/pages/messaging/customer-chat-api/v3.2/rtm-reference/index.mdx b/src/pages/messaging/customer-chat-api/v3.2/rtm-reference/index.mdx index 8f1cdc7ed..a6bf3f24d 100644 --- a/src/pages/messaging/customer-chat-api/v3.2/rtm-reference/index.mdx +++ b/src/pages/messaging/customer-chat-api/v3.2/rtm-reference/index.mdx @@ -1367,12 +1367,12 @@ Sends a sneak peek to a chat. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar. | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | URL of the customer's avatar. | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | At least one optional parameter needs to be included in the request payload. @@ -1496,9 +1496,9 @@ Agent and referrer are updated by default using the browser’s headers. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------ | -| `session_fields` | Yes | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. Max keys: 100 | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------------------- | +| `session_fields` | Yes | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. Max keys: 100 | Agent and referrer are updated by default using the browser’s headers. @@ -1561,12 +1561,12 @@ Returns the info about the customer requesting it. #### Response -| | | -| ---------------- | --------------------------------------------------------------------------------------------------------------- | -| `name` | [Customer's](/messaging/customer-chat-api/v3.2/data-structures/#customer) name. Returned only if set. | -| `email` | [Customer's](/messaging/customer-chat-api/v3.2/data-structures/#customer) email. Returned only if set. | -| `avatar` | [Customer's](/messaging/customer-chat-api/v3.2/data-structures/#customer) avatar. Returned only if set. | -| `session_fields` | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| | | +| ---------------- | ------------------------------------------------------------------------------------------------------------- | +| `name` | [Customer's](/messaging/customer-chat-api/v3.2/data-structures/#customer) name. Returned only if set. | +| `email` | [Customer's](/messaging/customer-chat-api/v3.2/data-structures/#customer) email. Returned only if set. | +| `avatar` | [Customer's](/messaging/customer-chat-api/v3.2/data-structures/#customer) avatar. Returned only if set. | +| `session_fields` | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | @@ -1638,24 +1638,24 @@ It returns the initial state of the current customer. #### Request -| Parameter | Required | Data type | Notes | -| ----------------------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `token` | Yes | `string` | OAuth token from the customer's account | -| `customer` | No | `object` | | -| `customer.avatar` | No | `string` | The URL of the customer's avatar | -| `customer.email` | No | `string` | | -| `customer.name` | No | `string` | | -| `customer.session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | -| `customer_page.title` | No | `string` | | -| `customer_page.url` | No | `string` | | -| `customer_side_storage`**\*** | No | `object` | A map in the `"key": "value"` format | -| `is_mobile` | No | `bool` | Indicates if logging in is performed from a mobile device. | -| `group_id` | No | `number` | | -| `referrer` | No | `string` | | -| `application` | No | `object` | Application info | -| `application.name` | No | `string` | Application name | -| `application.version` | No | `string` | Application version | -| `application.channel_type` | No | `string` | Application channel type | +| Parameter | Required | Data type | Notes | +| ----------------------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `token` | Yes | `string` | OAuth token from the customer's account | +| `customer` | No | `object` | | +| `customer.avatar` | No | `string` | The URL of the customer's avatar | +| `customer.email` | No | `string` | | +| `customer.name` | No | `string` | | +| `customer.session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | +| `customer_page.title` | No | `string` | | +| `customer_page.url` | No | `string` | | +| `customer_side_storage`**\*** | No | `object` | A map in the `"key": "value"` format | +| `is_mobile` | No | `bool` | Indicates if logging in is performed from a mobile device. | +| `group_id` | No | `number` | | +| `referrer` | No | `string` | | +| `application` | No | `object` | Application info | +| `application.name` | No | `string` | Application name | +| `application.version` | No | `string` | Application version | +| `application.channel_type` | No | `string` | Application channel type | **\*)** We use `customer_side_storage` to keep some data on the client side. You should pass a map from the `customer_side_storage_updated` push payload to this field. diff --git a/src/pages/messaging/customer-chat-api/v3.3/data-structures/index.mdx b/src/pages/messaging/customer-chat-api/v3.3/data-structures/index.mdx index c0ec00587..0433d20e2 100644 --- a/src/pages/messaging/customer-chat-api/v3.3/data-structures/index.mdx +++ b/src/pages/messaging/customer-chat-api/v3.3/data-structures/index.mdx @@ -348,7 +348,7 @@ System message event is a native system event sent in specific situations. | `email` | optional | | | `email_verified` | optional | Specifies if the customer confirmed their email address. See [Request Email Verification](#request-email-verification). | | `name` | optional | | -| `session_fields` | optional | An array of custom object-enclosed `key:value` pairs. Available for the session duration. | +| `session_fields` | optional | An array of custom object-enclosed key-value pairs. Available for the session duration. | ## Agent diff --git a/src/pages/messaging/customer-chat-api/v3.3/index.mdx b/src/pages/messaging/customer-chat-api/v3.3/index.mdx index 3fb2e4431..88592c548 100644 --- a/src/pages/messaging/customer-chat-api/v3.3/index.mdx +++ b/src/pages/messaging/customer-chat-api/v3.3/index.mdx @@ -1488,12 +1488,12 @@ The webhook will be sent only if the customer has active chats. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | The URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | The URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | At least one optional parameter needs to be included in the request. @@ -1549,9 +1549,9 @@ The webhook will be sent only if the customer has active chats. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------ | -| `session_fields` | Yes | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. Max keys: 100 | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------------------- | +| `session_fields` | Yes | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. Max keys: 100 | Users agent and referrer are updated by default using the browser’s headers. @@ -1603,12 +1603,12 @@ Returns the info about the customer requesting it. #### Response -| | | -| ---------------- | --------------------------------------------------------------------------------------------------------------- | -| `name` | [Customer's](/messaging/customer-chat-api/data-structures/#customer) name. Returned only if set. | -| `email` | [Customer's](/messaging/customer-chat-api/data-structures/#customer) email. Returned only if set. | -| `avatar` | [Customer's](/messaging/customer-chat-api/data-structures/#customer) avatar. Returned only if set. | -| `session_fields` | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| | | +| ---------------- | ------------------------------------------------------------------------------------------------------------- | +| `name` | [Customer's](/messaging/customer-chat-api/data-structures/#customer) name. Returned only if set. | +| `email` | [Customer's](/messaging/customer-chat-api/data-structures/#customer) email. Returned only if set. | +| `avatar` | [Customer's](/messaging/customer-chat-api/data-structures/#customer) avatar. Returned only if set. | +| `session_fields` | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | @@ -1742,11 +1742,11 @@ Customer can use this method to trigger checking if [goals](https://www.livechat #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------- | -| `session_fields` | Yes | `[]object` | An array of custom object-enclosed `key:value` pairs | -| `group_id` | Yes | `number` | | -| `page_url` | Yes | `string` | | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------- | +| `session_fields` | Yes | `[]object` | An array of custom object-enclosed key-value pairs | +| `group_id` | Yes | `number` | | +| `page_url` | Yes | `string` | | #### Response diff --git a/src/pages/messaging/customer-chat-api/v3.3/rtm-reference/index.mdx b/src/pages/messaging/customer-chat-api/v3.3/rtm-reference/index.mdx index 989e69139..61fd991a9 100644 --- a/src/pages/messaging/customer-chat-api/v3.3/rtm-reference/index.mdx +++ b/src/pages/messaging/customer-chat-api/v3.3/rtm-reference/index.mdx @@ -1309,12 +1309,12 @@ Sends a sneak peek to a chat. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar. | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | URL of the customer's avatar. | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | At least one optional parameter needs to be included in the request payload. @@ -1438,9 +1438,9 @@ Agent and referrer are updated by default using the browser’s headers. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------ | -| `session_fields` | Yes | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. Max keys: 100 | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------------------- | +| `session_fields` | Yes | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. Max keys: 100 | Agent and referrer are updated by default using the browser’s headers. @@ -1503,12 +1503,12 @@ Returns the info about the customer requesting it. #### Response -| | | -| ---------------- | --------------------------------------------------------------------------------------------------------------- | -| `name` | [Customer's](/messaging/customer-chat-api/data-structures/#customer) name. Returned only if set. | -| `email` | [Customer's](/messaging/customer-chat-api/data-structures/#customer) email. Returned only if set. | -| `avatar` | [Customer's](/messaging/customer-chat-api/data-structures/#customer) avatar. Returned only if set. | -| `session_fields` | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| | | +| ---------------- | ------------------------------------------------------------------------------------------------------------- | +| `name` | [Customer's](/messaging/customer-chat-api/data-structures/#customer) name. Returned only if set. | +| `email` | [Customer's](/messaging/customer-chat-api/data-structures/#customer) email. Returned only if set. | +| `avatar` | [Customer's](/messaging/customer-chat-api/data-structures/#customer) avatar. Returned only if set. | +| `session_fields` | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | @@ -1587,7 +1587,7 @@ It returns the initial state of the current customer. | `customer.avatar` | No | `string` | The URL of the customer's avatar | | `customer.email` | No | `string` | | | `customer.name` | No | `string` | | -| `customer.session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| `customer.session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | | `customer_page.title` | No | `string` | | | `customer_page.url` | No | `string` | | | `customer_side_storage`**\*** | No | `object` | A map in the `"key": "value"` format | diff --git a/src/pages/messaging/customer-chat-api/v3.4/data-structures/index.mdx b/src/pages/messaging/customer-chat-api/v3.4/data-structures/index.mdx index abe4cc6b5..2155e22ea 100644 --- a/src/pages/messaging/customer-chat-api/v3.4/data-structures/index.mdx +++ b/src/pages/messaging/customer-chat-api/v3.4/data-structures/index.mdx @@ -350,7 +350,7 @@ System message event is a native system event sent in specific situations. | `email` | optional | | | `email_verified` | optional | Specifies if the customer confirmed their email address. See [Request Email Verification](#request-email-verification). | | `name` | optional | | -| `session_fields` | optional | An array of custom object-enclosed `key:value` pairs. Available for the session duration. | +| `session_fields` | optional | An array of custom object-enclosed key-value pairs. Available for the session duration. | ## Agent diff --git a/src/pages/messaging/customer-chat-api/v3.4/index.mdx b/src/pages/messaging/customer-chat-api/v3.4/index.mdx index f39a947be..586fed057 100644 --- a/src/pages/messaging/customer-chat-api/v3.4/index.mdx +++ b/src/pages/messaging/customer-chat-api/v3.4/index.mdx @@ -1491,12 +1491,12 @@ The webhook will be sent only if the customer has active chats. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | The URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | The URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | At least one optional parameter needs to be included in the request. @@ -1552,9 +1552,9 @@ The webhook will be sent only if the customer has active chats. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------ | -| `session_fields` | Yes | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. Max keys: 100 | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------------------- | +| `session_fields` | Yes | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. Max keys: 100 | Users agent and referrer are updated by default using the browser’s headers. @@ -1606,12 +1606,12 @@ Returns the info about the customer requesting it. #### Response -| | | -| ---------------- | --------------------------------------------------------------------------------------------------------------- | -| `name` | [Customer's](/messaging/customer-chat-api/v3.4/data-structures/#customer) name. Returned only if set. | -| `email` | [Customer's](/messaging/customer-chat-api/v3.4/data-structures/#customer) email. Returned only if set. | -| `avatar` | [Customer's](/messaging/customer-chat-api/v3.4/data-structures/#customer) avatar. Returned only if set. | -| `session_fields` | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| | | +| ---------------- | ------------------------------------------------------------------------------------------------------------- | +| `name` | [Customer's](/messaging/customer-chat-api/v3.4/data-structures/#customer) name. Returned only if set. | +| `email` | [Customer's](/messaging/customer-chat-api/v3.4/data-structures/#customer) email. Returned only if set. | +| `avatar` | [Customer's](/messaging/customer-chat-api/v3.4/data-structures/#customer) avatar. Returned only if set. | +| `session_fields` | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | @@ -1745,11 +1745,11 @@ Customer can use this method to trigger checking if [goals](https://www.livechat #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------- | -| `session_fields` | Yes | `[]object` | An array of custom object-enclosed `key:value` pairs | -| `group_id` | Yes | `number` | | -| `page_url` | Yes | `string` | | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------- | +| `session_fields` | Yes | `[]object` | An array of custom object-enclosed key-value pairs | +| `group_id` | Yes | `number` | | +| `page_url` | Yes | `string` | | #### Response diff --git a/src/pages/messaging/customer-chat-api/v3.4/rtm-reference/index.mdx b/src/pages/messaging/customer-chat-api/v3.4/rtm-reference/index.mdx index b23e6d2e4..5bc4dd343 100644 --- a/src/pages/messaging/customer-chat-api/v3.4/rtm-reference/index.mdx +++ b/src/pages/messaging/customer-chat-api/v3.4/rtm-reference/index.mdx @@ -1311,12 +1311,12 @@ Sends a sneak peek to a chat. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar. | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | URL of the customer's avatar. | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | At least one optional parameter needs to be included in the request payload. @@ -1440,9 +1440,9 @@ Agent and referrer are updated by default using the browser’s headers. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------ | -| `session_fields` | Yes | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. Max keys: 100 | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------------------- | +| `session_fields` | Yes | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. Max keys: 100 | Agent and referrer are updated by default using the browser’s headers. @@ -1505,12 +1505,12 @@ Returns the info about the customer requesting it. #### Response -| | | -| ---------------- | --------------------------------------------------------------------------------------------------------------- | -| `name` | [Customer's](/messaging/customer-chat-api/v3.4/data-structures/#customer) name. Returned only if set. | -| `email` | [Customer's](/messaging/customer-chat-api/v3.4/data-structures/#customer) email. Returned only if set. | -| `avatar` | [Customer's](/messaging/customer-chat-api/v3.4/data-structures/#customer) avatar. Returned only if set. | -| `session_fields` | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| | | +| ---------------- | ------------------------------------------------------------------------------------------------------------- | +| `name` | [Customer's](/messaging/customer-chat-api/v3.4/data-structures/#customer) name. Returned only if set. | +| `email` | [Customer's](/messaging/customer-chat-api/v3.4/data-structures/#customer) email. Returned only if set. | +| `avatar` | [Customer's](/messaging/customer-chat-api/v3.4/data-structures/#customer) avatar. Returned only if set. | +| `session_fields` | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | @@ -1589,7 +1589,7 @@ It returns the initial state of the current customer. | `customer.avatar` | No | `string` | The URL of the customer's avatar | | `customer.email` | No | `string` | | | `customer.name` | No | `string` | | -| `customer.session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| `customer.session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | | `customer_page.title` | No | `string` | | | `customer_page.url` | No | `string` | | | `customer_side_storage`**\*** | No | `object` | A map in the `"key": "value"` format | diff --git a/src/pages/messaging/customer-chat-api/v3.5/data-structures/index.mdx b/src/pages/messaging/customer-chat-api/v3.5/data-structures/index.mdx index b977382d8..37ec433cd 100644 --- a/src/pages/messaging/customer-chat-api/v3.5/data-structures/index.mdx +++ b/src/pages/messaging/customer-chat-api/v3.5/data-structures/index.mdx @@ -349,7 +349,7 @@ System message event is a native system event sent in specific situations. | `email` | optional | | | `email_verified` | optional | Specifies if the customer confirmed their email address. See [Request Email Verification](#request-email-verification). | | `name` | optional | | -| `session_fields` | optional | An array of custom object-enclosed `key:value` pairs. Available for the session duration. | +| `session_fields` | optional | An array of custom object-enclosed key-value pairs. Available for the session duration. | ## Agent diff --git a/src/pages/messaging/customer-chat-api/v3.5/index.mdx b/src/pages/messaging/customer-chat-api/v3.5/index.mdx index ffa150122..741ca9430 100644 --- a/src/pages/messaging/customer-chat-api/v3.5/index.mdx +++ b/src/pages/messaging/customer-chat-api/v3.5/index.mdx @@ -1486,12 +1486,12 @@ The webhook will be sent only if the customer has active chats. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | The URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | The URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | At least one optional parameter needs to be included in the request. @@ -1547,9 +1547,9 @@ The webhook will be sent only if the customer has active chats. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------ | -| `session_fields` | Yes | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. Max keys: 100 | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------------------- | +| `session_fields` | Yes | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. Max keys: 100 | Users agent and referrer are updated by default using the browser’s headers. @@ -1601,12 +1601,12 @@ Returns the info about the customer requesting it. #### Response -| | | -| ---------------- | --------------------------------------------------------------------------------------------------------------- | -| `name` | [Customer's](/messaging/customer-chat-api/v3.5/data-structures/#customer) name. Returned only if set. | -| `email` | [Customer's](/messaging/customer-chat-api/v3.5/data-structures/#customer) email. Returned only if set. | -| `avatar` | [Customer's](/messaging/customer-chat-api/v3.5/data-structures/#customer) avatar. Returned only if set. | -| `session_fields` | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| | | +| ---------------- | ------------------------------------------------------------------------------------------------------------- | +| `name` | [Customer's](/messaging/customer-chat-api/v3.5/data-structures/#customer) name. Returned only if set. | +| `email` | [Customer's](/messaging/customer-chat-api/v3.5/data-structures/#customer) email. Returned only if set. | +| `avatar` | [Customer's](/messaging/customer-chat-api/v3.5/data-structures/#customer) avatar. Returned only if set. | +| `session_fields` | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | @@ -1740,11 +1740,11 @@ Customer can use this method to trigger checking if [goals](https://www.livechat #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------- | -| `session_fields` | Yes | `[]object` | An array of custom object-enclosed `key:value` pairs | -| `group_id` | Yes | `number` | | -| `page_url` | Yes | `string` | | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------- | +| `session_fields` | Yes | `[]object` | An array of custom object-enclosed key-value pairs | +| `group_id` | Yes | `number` | | +| `page_url` | Yes | `string` | | #### Response diff --git a/src/pages/messaging/customer-chat-api/v3.5/rtm-reference/index.mdx b/src/pages/messaging/customer-chat-api/v3.5/rtm-reference/index.mdx index 9e87cfe45..9c3928131 100644 --- a/src/pages/messaging/customer-chat-api/v3.5/rtm-reference/index.mdx +++ b/src/pages/messaging/customer-chat-api/v3.5/rtm-reference/index.mdx @@ -1288,12 +1288,12 @@ Sends a sneak peek to a chat. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | URL of the customer's avatar. | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | URL of the customer's avatar. | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | At least one optional parameter needs to be included in the request payload. @@ -1417,9 +1417,9 @@ Agent and referrer are updated by default using the browser’s headers. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------ | -| `session_fields` | Yes | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. Max keys: 100 | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------------------- | +| `session_fields` | Yes | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. Max keys: 100 | Agent and referrer are updated by default using the browser’s headers. @@ -1482,12 +1482,12 @@ Returns the info about the customer requesting it. #### Response -| | | -| ---------------- | --------------------------------------------------------------------------------------------------------------- | -| `name` | [Customer's](/messaging/customer-chat-api/v3.5/data-structures/#customer) name. Returned only if set. | -| `email` | [Customer's](/messaging/customer-chat-api/v3.5/data-structures/#customer) email. Returned only if set. | -| `avatar` | [Customer's](/messaging/customer-chat-api/v3.5/data-structures/#customer) avatar. Returned only if set. | -| `session_fields` | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| | | +| ---------------- | ------------------------------------------------------------------------------------------------------------- | +| `name` | [Customer's](/messaging/customer-chat-api/v3.5/data-structures/#customer) name. Returned only if set. | +| `email` | [Customer's](/messaging/customer-chat-api/v3.5/data-structures/#customer) email. Returned only if set. | +| `avatar` | [Customer's](/messaging/customer-chat-api/v3.5/data-structures/#customer) avatar. Returned only if set. | +| `session_fields` | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | @@ -1566,7 +1566,7 @@ It returns the initial state of the current customer. | `customer.avatar` | No | `string` | The URL of the customer's avatar | | `customer.email` | No | `string` | | | `customer.name` | No | `string` | | -| `customer.session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| `customer.session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | | `customer_page.title` | No | `string` | | | `customer_page.url` | No | `string` | | | `customer_side_storage`**\*** | No | `object` | A map in the `"key": "value"` format | 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..61d46ee88 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 @@ -382,7 +382,7 @@ It is not possible to send a System event in API version 3.7. | `email` | optional | | | `email_verified` | optional | Specifies if the customer confirmed their email address. See [Request Email Verification](#request-email-verification). | | `name` | optional | | -| `session_fields` | optional | An array of custom object-enclosed `key:value` pairs. Available for the session duration. | +| `session_fields` | optional | An array of custom object-enclosed key-value pairs. Available for the session duration. | ## Agent 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..93ba090b8 100644 --- a/src/pages/messaging/customer-chat-api/v3.7/index.mdx +++ b/src/pages/messaging/customer-chat-api/v3.7/index.mdx @@ -130,7 +130,7 @@ It returns [summaries](/messaging/customer-chat-api/v3.7/data-structures/#chat-s | Parameter | Required | Type | Notes | | ------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------ | -| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, maximum: 25. | +| `limit` | No | `number` | The 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` | | @@ -231,10 +231,10 @@ It returns threads that the current customer has access to in a given chat. | Parameter | Required | Data type | Notes | | ------------------ | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `chat_id` | Yes | `string` | | -| `sort_order` | No | `string` | Possible values: `asc` - oldest threads first and `desc` - newest threads first (default). | -| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 3, maximum: 100. | +| `sort_order` | No | `string` | Possible values: `asc` – oldest threads first and `desc` – newest threads first (default). | +| `limit` | No | `number` | The maximum number of records returned on each [page](#pagination). Default: 3, maximum: 100. | | `page_id` | No | `string` | | -| `min_events_count` | No | `number` | Range: 1-100; Specifies the minimum number of events to be returned in the response. It's the **total** number of events, so they can come from more than one thread. You'll get as many latest threads as needed to meet the `min_events_count` condition. | +| `min_events_count` | No | `number` | Range: 1-100. Specifies the minimum number of events to be returned in the response. It's the **total** number of events, so they can come from more than one thread. You'll get as many latest threads as needed to meet the `min_events_count` condition. | You cannot use both `limit` and `min_events_count` at the same time. @@ -310,10 +310,10 @@ curl -X POST \ #### Request -| Parameter | Required | Data type | Notes | -| ----------- | -------- | --------- | -------------------------------------- | -| `chat_id` | Yes | `string` | | -| `thread_id` | No | `string` | Default: the latest thread (if exists) | +| Parameter | Required | Data type | Notes | +| ----------- | -------- | --------- | --------------------------------------- | +| `chat_id` | Yes | `string` | | +| `thread_id` | No | `string` | Default: the latest thread (if exists). | @@ -414,16 +414,16 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch #### Request -| Parameter | Required | Data type | Notes | -| ------------------------ | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat` | No | `object` | | -| `chat.properties` | No | `object` | Initial chat properties | -| `chat.access` | No | `object` | Chat access to set; default: all agents. | -| `chat.thread` | No | `object` | | -| `chat.thread.events` | No | `array` | Initial chat [events](/messaging/customer-chat-api/data-structures/#events) array. Does not support the `form` type event in the LiveChat app. | -| `chat.thread.properties` | No | `object` | Initial thread properties | -| `active` | No | `bool` | When set to `false`, creates an inactive thread; default: `true`. | -| `continuous` | No | `bool` | Starts chat as continuous (online group is not required); default: `false`. | +| Parameter | Required | Data type | Notes | +| ------------------------ | -------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | +| `chat` | No | `object` | | +| `chat.properties` | No | `object` | The initial chat properties. | +| `chat.access` | No | `object` | The chat access to set. Default: all agents. | +| `chat.thread` | No | `object` | | +| `chat.thread.events` | No | `array` | The initial chat [events](/messaging/customer-chat-api/data-structures/#events) array. Does not support the `form` type event in the LiveChat app. | +| `chat.thread.properties` | No | `object` | The initial thread properties. | +| `active` | No | `bool` | When set to `false`, creates an inactive thread. When set to `true`, creates an active thread. Default: `true`. | +| `continuous` | No | `bool` | When set to `true`, starts chat as continuous (online group is not required). When set to `false`, starts chat as non-continuous. Default: `false`. | #### Response @@ -484,17 +484,17 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch #### Request -| Parameter | Required | Data type | Notes | -| ------------------------ | -------- | --------- | -------------------------------------------------------------------------- | -| `chat` | Yes | `object` | | -| `chat.id` | Yes | `string` | ID of the chat that will be resumed. | -| `chat.access` | No | `object` | Chat access to set; default: all agents. | -| `chat.properties` | No | `object` | Initial chat properties | -| `chat.thread` | No | `object` | | -| `chat.thread.events` | No | `array` | Initial chat events array | -| `chat.thread.properties` | No | `object` | Initial thread properties | -| `active` | No | `bool` | When set to `false`, creates an inactive thread; default: `true`. | -| `continuous` | No | `bool` | Sets a chat to the continuous mode. When unset, leaves the mode unchanged. | +| Parameter | Required | Data type | Notes | +| ------------------------ | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `chat` | Yes | `object` | | +| `chat.id` | Yes | `string` | The ID of the chat that will be resumed. | +| `chat.access` | No | `object` | The chat access to set. Default: all agents. | +| `chat.properties` | No | `object` | The initial chat properties. | +| `chat.thread` | No | `object` | | +| `chat.thread.events` | No | `array` | The initial chat events array. | +| `chat.thread.properties` | No | `object` | The initial thread properties. | +| `active` | No | `bool` | When set to `false`, creates an inactive thread. When set to `true`, creates an active thread. Default: `true`. | +| `continuous` | No | `bool` | When set to `true`, sets a chat to the continuous mode. When set to `false`, sets a chat to non-continuous mode. When unset, leaves the mode unchanged. | #### Response @@ -606,12 +606,12 @@ Returns the dynamic configuration of a given group. It provides data to call [** #### Request -| Parameter | Required | Data type | Notes | -| -------------- | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------- | -| `group_id` | No | `number` | The ID of the group that you want to get a dynamic configuration for. ID of the default group is used if not provided. | -| `url` | No | `string` | The URL that you want to get a dynamic configuration for. | -| `channel_type` | No | `string` | The channel type that you want to get a dynamic configuration for. | -| `test` | No | `bool` | Treats a dynamic configuration request as a test. | +| Parameter | Required | Data type | Notes | +| -------------- | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------- | +| `group_id` | No | `number` | The ID of the group that you want to get a dynamic configuration for. The ID of the default group is used if not provided. | +| `url` | No | `string` | The URL that you want to get a dynamic configuration for. | +| `channel_type` | No | `string` | The channel type that you want to get a dynamic configuration for. | +| `test` | No | `bool` | When set to `true`, treats a dynamic configuration request as a test. | #### Response @@ -772,11 +772,11 @@ The method updates the requester's `events_seen_up_to` as if they've seen all ch #### Request -| Parameter | Required | Data type | Notes | -| ----------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat that you to send a message to. | -| `event` | Yes | `object` | [Event](/messaging/customer-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. | -| `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`. | +| Parameter | Required | Data type | Notes | +| ----------------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat that you want to send a message to. | +| `event` | Yes | `object` | The [Event](/messaging/customer-chat-api/data-structures/#events) object. Does not support the `form` type event in the LiveChat app. | +| `attach_to_last_thread` | No | `bool` | When set to `true`, the event will be added to the last thread for inactive chats. When set to `false`, the request will fail for inactive chats. Default: `false`. | @@ -835,11 +835,11 @@ In the Agent Chat API, the [Delete Event](#delete-event) method replaces the ori #### Request -| Parameter | Required | Data type | Notes | -| ----------- | -------- | --------- | ------------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat that you want to delete an event from. | -| `thread_id` | Yes | `string` | Id of the thread that you want to delete an event from. | -| `event_id` | Yes | `string` | Id of the event that you want to delete. | +| Parameter | Required | Data type | Notes | +| ----------- | -------- | --------- | ----------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat that you want to delete an event from. | +| `thread_id` | Yes | `string` | The ID of the thread that you want to delete an event from. | +| `event_id` | Yes | `string` | The ID of the event that you want to delete. | @@ -889,9 +889,9 @@ Uploads a file to the server as a temporary file. It returns a URL that expires #### Request -| Parameter | Required | Data type | Notes | -| --------- | -------- | --------- | ------------------ | -| `file` | Yes | `binary` | Maximum size: 10MB | +| Parameter | Required | Data type | Notes | +| --------- | -------- | --------- | ----------------------- | +| `file` | Yes | `binary` | The maximum size: 10MB. | @@ -937,14 +937,14 @@ curl -X POST \ #### Request -| Parameter | Required | Data type | Notes | -| ------------------ | -------- | --------- | ----------------------------------- | -| `chat_id` | Yes | `string` | | -| `event_id` | Yes | `string` | | -| `postback` | Yes | `object` | | -| `postback.id` | Yes | `string` | Postback name of the button | -| `postback.toggled` | Yes | `bool` | Postback toggled; `true` or `false` | -| `thread_id` | Yes | `string` | | +| Parameter | Required | Data type | Notes | +| ------------------ | -------- | --------- | -------------------------------- | +| `chat_id` | Yes | `string` | | +| `event_id` | Yes | `string` | | +| `postback` | Yes | `object` | | +| `postback.id` | Yes | `string` | The postback name of the button. | +| `postback.toggled` | Yes | `bool` | The toggle state of the button. | +| `thread_id` | Yes | `string` | | #### Response @@ -996,10 +996,10 @@ Sends a sneak peek to a chat. #### Request -| Parameter | Required | Data type | Notes | -| ----------------- | -------- | --------- | --------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat to send a sneak peek to. | -| `sneak_peek_text` | Yes | `string` | Sneak peek text | +| Parameter | Required | Data type | Notes | +| ----------------- | -------- | --------- | ------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat to send a sneak peek to. | +| `sneak_peek_text` | Yes | `string` | The sneak peek text. | #### Response @@ -1105,10 +1105,10 @@ curl -X GET \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | Yes | `string` | Id of the chat you to set a property for. | -| `properties` | Yes | `object` | Chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | +| Parameter | Required | Type | Notes | +| ------------ | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | Yes | `string` | The ID of the chat you want to set a property for. | +| `properties` | Yes | `object` | The chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | #### Response @@ -1157,10 +1157,10 @@ curl -X POST \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ------------------------------------------------ | -| `id` | Yes | `string` | Id of the chat you want to delete properties of. | -| `properties` | Yes | `object` | Chat properties to delete. | +| Parameter | Required | Type | Notes | +| ------------ | -------- | -------- | ---------------------------------------------------- | +| `id` | Yes | `string` | The ID of the chat you want to delete properties of. | +| `properties` | Yes | `object` | The chat properties to delete. | #### Response @@ -1209,11 +1209,11 @@ curl -X POST \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ------------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat you want to set properties for. | -| `thread_id` | Yes | `string` | Id of the thread you want to set properties for. | -| `properties` | Yes | `object` | Chat properties to set. | +| Parameter | Required | Type | Notes | +| ------------ | -------- | -------- | ---------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to set properties for. | +| `thread_id` | Yes | `string` | The ID of the thread you want to set properties for. | +| `properties` | Yes | `object` | The chat properties to set. | #### Response @@ -1263,11 +1263,11 @@ curl -X POST \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ------------------------------------------------------ | -| `chat_id` | Yes | `string` | Id of the chat you want to delete the properties of. | -| `thread_id` | Yes | `string` | Id of the thread you want to delete the properties of. | -| `properties` | Yes | `object` | Thread properties to delete. | +| Parameter | Required | Type | Notes | +| ------------ | -------- | -------- | ---------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to delete the properties of. | +| `thread_id` | Yes | `string` | The ID of the thread you want to delete the properties of. | +| `properties` | Yes | `object` | The thread properties to delete. | #### Response @@ -1317,12 +1317,12 @@ curl -X POST \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to set properties for. | -| `thread_id` | Yes | `string` | Id of the thread you want to set properties for. | -| `event_id` | Yes | `string` | Id of the event you want to set properties for. | -| `properties` | Yes | `object` | Chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | +| Parameter | Required | Type | Notes | +| ------------ | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `chat_id` | Yes | `string` | The ID of the chat you want to set properties for. | +| `thread_id` | Yes | `string` | The ID of the thread you want to set properties for. | +| `event_id` | Yes | `string` | The ID of the event you want to set properties for. | +| `properties` | Yes | `object` | The chat properties to set. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | #### Response @@ -1373,12 +1373,12 @@ curl -X POST \ #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chat_id` | Yes | `string` | Id of the chat you want to delete the properties of. | -| `thread_id` | Yes | `string` | Id of the thread you want to delete the properties of. | -| `event_id` | Yes | `string` | Id of the event you want to delete the properties of. | -| `properties` | Yes | `object` | Event properties to delete. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | +| Parameter | Required | Type | Notes | +| ------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `chat_id` | Yes | `string` | The ID of the chat you want to delete the properties of. | +| `thread_id` | Yes | `string` | The ID of the thread you want to delete the properties of. | +| `event_id` | Yes | `string` | The ID of the event you want to delete the properties of. | +| `properties` | Yes | `object` | The event properties to delete. You should stick to the [general properties format](/management/configuration-api/#properties) and include _namespace_, _property name_ and _value_. | #### Response @@ -1432,10 +1432,10 @@ Returns the properties of a given license. It only returns the properties a cust #### Request -| Query string parameter | Required | Data type | Notes | -| ---------------------- | -------- | --------- | ------------------------------ | -| `namespace` | No | `string` | Property namespace to retrieve | -| `name` | No | `string` | Property name | +| Query string parameter | Required | Data type | Notes | +| ---------------------- | -------- | --------- | ----------------------------------- | +| `namespace` | No | `string` | The property namespace to retrieve. | +| `name` | No | `string` | The property name. | @@ -1486,11 +1486,11 @@ Returns the properties of a given group. It only returns the properties a custom #### Request -| Query string parameter | Required | Data type | Notes | -| ---------------------- | -------- | --------- | ----------------------------------------------------- | -| `id` | Yes | `number` | Id of the group you want to return the properties of. | -| `namespace` | No | `string` | Property namespace to retrieve | -| `name` | No | `string` | Property name | +| Query string parameter | Required | Data type | Notes | +| ---------------------- | -------- | --------- | --------------------------------------------------------- | +| `id` | Yes | `number` | The ID of the group you want to return the properties of. | +| `namespace` | No | `string` | The property namespace to retrieve. | +| `name` | No | `string` | The property name. | @@ -1543,12 +1543,12 @@ The webhook will be sent only if the customer has active chats. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- | -| `name` | No | `string` | | -| `email` | No | `string` | | -| `avatar` | No | `string` | The URL of the customer's avatar | -| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | -------------------------------------------------------------------------------- | +| `name` | No | `string` | | +| `email` | No | `string` | | +| `avatar` | No | `string` | The URL of the customer's avatar | +| `session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | At least one optional parameter needs to be included in the request. @@ -1604,9 +1604,9 @@ The webhook will be sent only if the customer has active chats. #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ------------------------------------------------------------------------------------------------ | -| `session_fields` | Yes | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. Max keys: 100 | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | ----------------------------------------------------------------------------------------------------------------- | +| `session_fields` | Yes | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. The maximum number of keys: 100. | Users agent and referrer are updated by default using the browser’s headers. @@ -1658,12 +1658,12 @@ Returns the info about the customer requesting it. #### Response -| | | -| ---------------- | --------------------------------------------------------------------------------------------------------------- | -| `name` | [Customer's](/messaging/customer-chat-api/v3.7/data-structures/#customer) name. Returned only if set. | -| `email` | [Customer's](/messaging/customer-chat-api/v3.7/data-structures/#customer) email. Returned only if set. | -| `avatar` | [Customer's](/messaging/customer-chat-api/v3.7/data-structures/#customer) avatar. Returned only if set. | -| `session_fields` | An array of custom object-enclosed `key:value` pairs. Returned only if set. Available for the session duration. | +| | | +| ---------------- | ------------------------------------------------------------------------------------------------------------- | +| `name` | [Customer's](/messaging/customer-chat-api/v3.7/data-structures/#customer) name. Returned only if set. | +| `email` | [Customer's](/messaging/customer-chat-api/v3.7/data-structures/#customer) email. Returned only if set. | +| `avatar` | [Customer's](/messaging/customer-chat-api/v3.7/data-structures/#customer) avatar. Returned only if set. | +| `session_fields` | An array of custom object-enclosed key-value pairs. Returned only if set. Available for the session duration. | @@ -1722,10 +1722,10 @@ curl -X POST \ #### Request -| Parameter | Required | Data type | Notes | -| ----------- | -------- | --------- | ---------------------------------------------------------- | -| `all` | No | `bool` | If set to `true`, you will get statuses of all the groups. | -| `group_ids` | No | `array` | A table of groups' IDs | +| Parameter | Required | Data type | Notes | +| ----------- | -------- | --------- | ------------------------------------------------------------ | +| `all` | No | `bool` | When set to `true`, you will get statuses of all the groups. | +| `group_ids` | No | `array` | A table of groups' IDs. | One of the optional parameters needs to be included in the request. @@ -1797,11 +1797,11 @@ Customer can use this method to trigger checking if [goals](https://www.livechat #### Request -| Parameter | Required | Data type | Notes | -| ---------------- | -------- | ---------- | ---------------------------------------------------- | -| `session_fields` | Yes | `[]object` | An array of custom object-enclosed `key:value` pairs | -| `group_id` | Yes | `number` | | -| `page_url` | Yes | `string` | | +| Parameter | Required | Data type | Notes | +| ---------------- | -------- | ---------- | --------------------------------------------------- | +| `session_fields` | Yes | `[]object` | An array of custom object-enclosed key-value pairs. | +| `group_id` | Yes | `number` | | +| `page_url` | Yes | `string` | | #### Response @@ -1853,10 +1853,10 @@ Returns an empty ticket form of a ` | Yes | `[]string` | A list of push subscriptions for a specific version;`` is a version number, without `v` prefix. Possible values: push names. | +| Parameter | Required | Data type | Notes | +| ----------------------------- | -------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `token` | Yes | `string` | The OAuth token from the customer's account. | +| `customer` | No | `object` | | +| `customer.avatar` | No | `string` | The URL of the customer's avatar. | +| `customer.email` | No | `string` | | +| `customer.name` | No | `string` | | +| `customer.session_fields` | No | `[]object` | An array of custom object-enclosed key-value pairs. Respects the order of items. | +| `customer_page.title` | No | `string` | | +| `customer_page.url` | No | `string` | | +| `customer_side_storage`**\*** | No | `object` | A map in the `"key": "value"` format. | +| `is_mobile` | No | `bool` | If set to `true`: indicates logging in is performed from a mobile device. | +| `group_id` | No | `number` | | +| `referrer` | No | `string` | | +| `application` | No | `object` | The application info. | +| `application.name` | No | `string` | The application name. | +| `application.version` | No | `string` | The application version. | +| `application.channel_type` | No | `string` | The application channel type. | +| `pushes` | No | `object` | Use case: when you want to receive only specific pushes. Default: `all` for the version of your currently established RTM connection. | +| `pushes.` | Yes | `[]string` | A list of push subscriptions for a specific version; `` is a version number, without `v` prefix. Possible values: push names. | **\*)** We use `customer_side_storage` to keep some data on the client side. You should pass a map from the `customer_side_storage_updated` push payload to this field. @@ -1763,16 +1763,16 @@ It returns the initial state of the current customer. | Parameter | Required | Data type | Notes | | ----------- | -------- | --------- | ---------------------------------------------------------- | -| `all` | No | `bool` | If set to `true`, you will get statuses of all the groups. | -| `group_ids` | No | `array` | A table of a groups' IDs | +| `all` | No | `bool` | If set to `true`: you will get statuses of all the groups. | +| `group_ids` | No | `array` | An array of groups' IDs. | One of the optional parameters needs to be included in the request payload. #### Response -| | | | -| ----------------- | -------------------------------------------------------------------------------------------------------- | --- | -| `Group Not Found` | If you send `group_id` of a group that doesn't exists, the id won't be included in the resposne payload. | | +| | | | +| ----------------- | ------------------------------------------------------------------------------------------------------- | --- | +| `Group Not Found` | If you send `group_id` of a group that doesn't exist, the ID won't be included in the response payload. | | @@ -1837,17 +1837,17 @@ Returns an empty ticket form of a