Text Platform

https://platform.text.com/docs
Admin
Text Platform provides APIs, SDKs, and developer tools for building flexible software solutions,...
Tokens:1,043,143
Snippets:3,603
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Run Simple Agent Example

Source: https://platform.text.com/docs/messaging/node-sdk

Instructions to install dependencies and start the Simple Agent application. This example showcases the LiveChat Node.js SDK's functionality for sending messages and interacting with chats.

```bash
npm install
npm start
```

--------------------------------

### Run Simple Agent Example

Source: https://platform.text.com/docs/messaging/chat-sdk

Instructions to install dependencies and start the Simple Agent application. This example showcases the LiveChat Node.js SDK's functionality for sending messages and interacting with chats.

```bash
npm install
npm start
```

--------------------------------

### Setup Completion Endpoint API

Source: https://platform.text.com/docs/getting-started/app-guides/onboarding

API endpoints for managing user setup completion status. Use PUT to mark a user for reminders and DELETE to remove them once setup is complete. Requires App Authorization.

```APIDOC
Endpoint: /v2/applications/{application_id}/instance/setup

Methods:
  PUT: Add a user to receive setup completion reminders.
    - Description: Informs the platform that a user has not completed app setup.
    - Parameters:
      - Authorization: Bearer <access_token> (Required)
    - Example:
      curl -X PUT 'https://dev-platform.livechatinc.com/v2/applications/15jS39tMg/instance/setup' \
      -H 'Authorization: Bearer <access_token>'

  DELETE: Remove a user from setup completion reminders.
    - Description: Informs the platform that a user has completed app setup and no longer needs reminders.
    - Parameters:
      - Authorization: Bearer <access_token> (Required)
    - Example:
      curl -X DELETE 'https://dev-platform.livechatinc.com/v2/applications/15jS39tMg/instance/setup' \
      -H 'Authorization: Bearer <access_token>'

Dependencies:
  - App Authorization block

Notes:
  - The access token must belong to the user who granted permission to your app.
```

--------------------------------

### AccountsSDK Initialization Example (JavaScript)

Source: https://platform.text.com/docs/getting-started/authorization/sign-in-with-livechat

Demonstrates how to create an instance of the AccountsSDK with essential client ID configuration. This is the primary step to begin authorizing users.

```javascript
const instance = new AccountsSDK({
  client_id: '<your_app_client_id>'
});
```

--------------------------------

### Start Chat Response Example

Source: https://platform.text.com/docs/messaging/customer-chat-api/v3.5/rtm-reference

An example JSON response upon successfully starting a chat. It returns the `chat_id` and `thread_id` of the newly created session.

```json
{
  "request_id": "<request_id>",
  "action": "start_chat",
  "type": "response",
  "success": true,
  "payload": {
    "chat_id": "PJ0MRSHTDG",
    "thread_id": "PGDGHT5G"
  }
}
```

--------------------------------

### AccountsSDK Initialization Example (JavaScript)

Source: https://platform.text.com/docs/authorization/sign-in-with-livechat

Demonstrates how to create an instance of the AccountsSDK with essential client ID configuration. This is the primary step to begin authorizing users.

```javascript
const instance = new AccountsSDK({
  client_id: '<your_app_client_id>'
});
```

--------------------------------

### Start Chat Response Example

Source: https://platform.text.com/docs/messaging/customer-chat-api/v3.1/rtm-reference

An example JSON response upon successfully starting a chat. It returns the `chat_id` and `thread_id` of the newly created session.

```json
{
  "request_id": "<request_id>",
  "action": "start_chat",
  "type": "response",
  "success": true,
  "payload": {
    "chat_id": "PJ0MRSHTDG",
    "thread_id": "PGDGHT5G"
  }
}
```

--------------------------------

### Start Chat Response Example

Source: https://platform.text.com/docs/messaging/customer-chat-api/rtm-reference

An example JSON response upon successfully starting a chat. It returns the `chat_id` and `thread_id` of the newly created session.

```json
{
  "request_id": "<request_id>",
  "action": "start_chat",
  "type": "response",
  "success": true,
  "payload": {
    "chat_id": "PJ0MRSHTDG",
    "thread_id": "PGDGHT5G"
  }
}
```

--------------------------------

### AccountsSDK popup Method Example (JavaScript)

Source: https://platform.text.com/docs/getting-started/authorization/sign-in-with-livechat

Shows how to obtain a Popup object instance, built on top of the SDK, for handling authorization flows via popups.

```javascript
const popup = instance.popup({
  client_id: '<your_app_client_id>'
});
```

--------------------------------

### Start Chat Response Example

Source: https://platform.text.com/docs/customer-chat-api/rtm-reference

An example JSON response upon successfully starting a chat. It returns the `chat_id` and `thread_id` of the newly created session.

```json
{
  "request_id": "<request_id>",
  "action": "start_chat",
  "type": "response",
  "success": true,
  "payload": {
    "chat_id": "PJ0MRSHTDG",
    "thread_id": "PGDGHT5G"
  }
}
```

--------------------------------

### Create Tag Example

Source: https://platform.text.com/docs/management/configuration-api/v3

Example using curl to create a new tag named 'docs_feedback' and assign it to groups with IDs 0 and 42.

```bash
curl -X POST \
  https://api.livechatinc.com/v3.5/configuration/action/create_tag \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <your_access_token>' \
  -d '{
    "name": "docs_feedback",
    "group_ids": [
      0,
      42
    ]
  }'
```

--------------------------------

### Get Predicted Agent API

Source: https://platform.text.com/docs/messaging/customer-chat-api/v3.3/rtm-reference

Gets the predicted Agent that a Customer will chat with when the chat starts. Returns agent details and queue status.

```APIDOC
get_predicted_agent
  Description: Gets the predicted Agent - the one the Customer will chat with when the chat starts.
  Web API equivalent: /docs/messaging/customer-chat-api/v3.3#get-predicted-agent
  Parameters:
    (No specific payload parameters required for this action)
  Response:
    queue (boolean): If `true`, the chat will be queued.
    agent (object): Details of the predicted agent.
      id (string): Agent's unique identifier.
      name (string): Agent's display name.
      avatar (string): URL to the agent's avatar.
      is_bot (boolean): Indicates if the agent is a bot.
      job_title (string): Agent's job title.
      type (string): Type of the entity (e.g., 'agent').
  Request Example:
    {
      "action": "get_predicted_agent",
      "payload": {}
    }
  Response Example:
    {
      "request_id": "<request_id>",
      "action": "get_predicted_agent",
      "type": "response",
      "success": true,
      "payload": {
        "agent": {
          "id": "b5657aff34dd32e198160d54666df9d8",
          "name": "Agent Smith",
          "avatar": "https://example.avatar/example.com",
          "is_bot": false,
          "job_title": "support hero",
          "type": "agent"
        },
        "queue": false
      }
```

--------------------------------

### Start Chat Request Example

Source: https://platform.text.com/docs/messaging/customer-chat-api/v3.5/rtm-reference

A sample JSON request to start a new chat. The payload can be empty for a basic chat initiation.

```json
{
  "action": "start_chat",
  "payload": {}
}
```

--------------------------------

### Install HelpDesk SDK via NPM

Source: https://platform.text.com/docs/extending-agent-app/products-sdk/helpdesk-sdk

Instructions for installing the HelpDesk SDK package using npm, the Node Package Manager. This is the primary method for integrating the SDK into your JavaScript projects.

```bash
npm install @livechat/helpdesk-sdk
```

--------------------------------

### Create Tag Example

Source: https://platform.text.com/docs/management/configuration-api

Example using curl to create a new tag named 'docs_feedback' and assign it to groups with IDs 0 and 42.

```bash
curl -X POST \
  https://api.livechatinc.com/v3.5/configuration/action/create_tag \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <your_access_token>' \
  -d '{
    "name": "docs_feedback",
    "group_ids": [
      0,
      42
    ]
  }'
```

--------------------------------

### Start Chat Request Example

Source: https://platform.text.com/docs/messaging/customer-chat-api/v3.1/rtm-reference

A sample JSON request to start a new chat. The payload can be empty for a basic chat initiation.

```json
{
  "action": "start_chat",
  "payload": {}
}
```

--------------------------------

### Create Fullscreen Widget Instance

Source: https://platform.text.com/docs/extending-agent-app/products-sdk/helpdesk-sdk

Initializes a Fullscreen widget by calling `createFullscreenWidget`. This function returns a promise that resolves with a Fullscreen widget instance, enabling interaction with the HelpDesk App.

```javascript
import { createFullscreenWidget } from "@livechat/helpdesk-sdk";

createFullscreenWidget().then(widget => {
  // build your logic around the widget
});
```

--------------------------------

### Start Chat Request Example

Source: https://platform.text.com/docs/messaging/customer-chat-api/rtm-reference

A sample JSON request to start a new chat. The payload can be empty for a basic chat initiation.

```json
{
  "action": "start_chat",
  "payload": {}
}
```

--------------------------------

### Start Chat Request Example

Source: https://platform.text.com/docs/customer-chat-api/rtm-reference

A sample JSON request to start a new chat. The payload can be empty for a basic chat initiation.

```json
{
  "action": "start_chat",
  "payload": {}
}
```

--------------------------------

### AccountsSDK popup Method Example (JavaScript)

Source: https://platform.text.com/docs/authorization/sign-in-with-livechat

Shows how to obtain a Popup object instance, built on top of the SDK, for handling authorization flows via popups.

```javascript
const popup = instance.popup({
  client_id: '<your_app_client_id>'
});
```

--------------------------------

### Get Chat Response Example

Source: https://platform.text.com/docs/messaging/agent-chat-api

Example JSON response from the 'get_chat' API endpoint, detailing the chat thread, participants, and events.

```json
{
  "id": "PJ0MRSHTDG",
  "thread": {
    "id": "K600PKZON8",
    "created_at": "2020-05-07T07:11:28.288340Z",
    "active": true,
    "user_ids": [
      "b7eff798-f8df-4364-8059-649c35c9ed0c",
      "smith@example.com"
    ],
    "events": [
      {
        "id": "Q20N9CKRX2_1",
        "created_at": "2019-12-17T07:57:41.512000Z",
        "visibility": "all",
        "type": "message",
        "text": "Hello",
        "author_id": "smith@example.com"
      }
    ],
    "properties": {
      "0805e283233042b37f460ed8fbf22160": {
        "string_property": "string_value"
      }
    },
    "access": {
      "group_ids": [0]
    },
    "previous_thread_id": "K600PKZOM8",
    "next_thread_id": "K600PKZOO8"
  },
  "users": [
    {
      "id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
      "type": "customer",
      "present": true,
      "created_at": "2019-12-17T08:53:20.693553+01:00",
      "statistics": {
        "chats_count": 1
      },
      "agent_last_event_created_at": "2019-12-17T09:04:05.239000+01:00"
    },
    {
      "id": "smith@example.com",
      "name": "Agent Smith",
      "email": "smith@example.com",
      "type": "agent",
      "present": true,
      "avatar": "https://example.com/avatar.jpg",
      "visibility": "all"
    }
  ],
  "properties": {
    "0805e283233042b37f460ed8fbf22160": {
      "string_property": "string_value"
    }
  },
  "access": {
    "group_ids": [0]
  },
  "is_followed": true
}
```

--------------------------------

### AccountsSDK redirect Method Example (JavaScript)

Source: https://platform.text.com/docs/getting-started/authorization/sign-in-with-livechat

Illustrates obtaining a Redirect object instance, built on top of the SDK, for managing authorization flows that use browser redirects.

```javascript
const redirect = instance.redirect({
  client_id: '<your_app_client_id>'
});
```

--------------------------------

### Get Chat Response Example

Source: https://platform.text.com/docs/agent-chat-api

Example JSON response from the 'get_chat' API endpoint, detailing the chat thread, participants, and events.

```json
{
  "id": "PJ0MRSHTDG",
  "thread": {
    "id": "K600PKZON8",
    "created_at": "2020-05-07T07:11:28.288340Z",
    "active": true,
    "user_ids": [
      "b7eff798-f8df-4364-8059-649c35c9ed0c",
      "smith@example.com"
    ],
    "events": [
      {
        "id": "Q20N9CKRX2_1",
        "created_at": "2019-12-17T07:57:41.512000Z",
        "visibility": "all",
        "type": "message",
        "text": "Hello",
        "author_id": "smith@example.com"
      }
    ],
    "properties": {
      "0805e283233042b37f460ed8fbf22160": {
        "string_property": "string_value"
      }
    },
    "access": {
      "group_ids": [0]
    },
    "previous_thread_id": "K600PKZOM8",
    "next_thread_id": "K600PKZOO8"
  },
  "users": [
    {
      "id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
      "type": "customer",
      "present": true,
      "created_at": "2019-12-17T08:53:20.693553+01:00",
      "statistics": {
        "chats_count": 1
      },
      "agent_last_event_created_at": "2019-12-17T09:04:05.239000+01:00"
    },
    {
      "id": "smith@example.com",
      "name": "Agent Smith",
      "email": "smith@example.com",
      "type": "agent",
      "present": true,
      "avatar": "https://example.com/avatar.jpg",
      "visibility": "all"
    }
  ],
  "properties": {
    "0805e283233042b37f460ed8fbf22160": {
      "string_property": "string_value"
    }
  },
  "access": {
    "group_ids": [0]
  },
  "is_followed": true
}
```

--------------------------------

### Create Bot Template Request Example

Source: https://platform.text.com/docs/management/configuration-api/v3

Example using curl to create a new bot template with a specified name.

```curl
curl -X POST \
  https://api.livechatinc.com/v3.5/configuration/action/create_bot_template \
  -H 'Authorization: Bearer <your_access_token>' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "Bot Name"
      }'
```

--------------------------------

### Get Chat Request Example

Source: https://platform.text.com/docs/messaging/agent-chat-api

Example cURL command to call the 'get_chat' API endpoint, specifying the chat ID and thread ID.

```curl
curl -X POST \
  https://api.livechatinc.com/v3.5/agent/action/get_chat \
  -H 'Authorization: Bearer <your_access_token>' \
  -H 'Content-Type: application/json' \
  -d '{ \
      "chat_id": "PWJ8Y4THAV", \
      "thread_id": "K600PKZON8" \
    }'
```

--------------------------------

### Example Request using cURL

Source: https://platform.text.com/docs/management/configuration-api

Demonstrates how to call the agent creation API endpoint using cURL. It includes setting the HTTP method, endpoint URL, authorization header, content type, and the JSON payload for creating an agent with specific configurations.

```shell
curl -X POST \
  https://api.livechatinc.com/v3.5/configuration/action/create_agent \
  -H 'Authorization: Bearer <your_access_token>' \
  -H 'Content-Type: application/json' \
  -d '{ \
        "id": "smith@example.com", \
        "name": "Agent Smith", \
        "role": "viceowner", \
        "groups": [ \
          { \
            "id": 5, \
            "priority": "first" \
          }, \
          { \
            "id": 2, \
            "priority": "last" \
          }, \
          { \
            "id": 1, \
            "priority": "normal" \
          } \
        ], \
        "work_scheduler": { \
        "schedule": [ \
            { \
                "day": "monday", \
                "start": "08:00", \
                "end": "12:30", \
                "enabled": true \
            }, \
            { \
                "day": "monday", \
                "start": "13:30", \
                "end": "16:00", \
                "enabled": true \
            }, \
            { \
                "day": "friday", \
                "start": "08:00", \
                "end": "16:00", \
                "enabled": true \
            } \
        ], \
        "timezone": "Europe/Warsaw" \
    }, \
        "notifications": [ \
          "new_visitor", \
          "new_goal", \
          "visitor_is_typing" \
        ], \
        "email_subscriptions": [ \
          "weekly_summary" \
        ] \
    }'
```

--------------------------------

### Create Bot Template Request Example

Source: https://platform.text.com/docs/management/configuration-api

Example using curl to create a new bot template with a specified name.

```curl
curl -X POST \
  https://api.livechatinc.com/v3.5/configuration/action/create_bot_template \
  -H 'Authorization: Bearer <your_access_token>' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "Bot Name"
      }'
```

--------------------------------

### Get Chat Request Example

Source: https://platform.text.com/docs/agent-chat-api

Example cURL command to call the 'get_chat' API endpoint, specifying the chat ID and thread ID.

```curl
curl -X POST \
  https://api.livechatinc.com/v3.5/agent/action/get_chat \
  -H 'Authorization: Bearer <your_access_token>' \
  -H 'Content-Type: application/json' \
  -d '{ \
      "chat_id": "PWJ8Y4THAV", \
      "thread_id": "K600PKZON8" \
    }'
```

--------------------------------

### Enable PKCE Extension

Source: https://platform.text.com/docs/getting-started/authorization/sign-in-with-livechat

Initializes the AccountsSDK instance with PKCE options enabled. This is the first step to secure authorization flows by preventing redirect hijacking.

```javascript
const instance = new AccountsSDK({
    client_id: '<your_app_client_id>',
    redirect_uri: '<your_app_redirect_uri>',
    response_type: "code",
    pkce: {
      enabled: true
    }
  });
```

--------------------------------

### Example GET Request for Paid Licenses

Source: https://platform.text.com/docs/partner-program/partner-api

An example cURL request to fetch paid affiliate licenses within a specified date range with a limit of one result.

```curl
curl --request GET \
    --url https://api.livechatinc.com/v2/partners/affiliates/licenses/paid?date_from=2025-02-15T00:00:00Z&date_to=2025-06-14T23:59:59Z&limit=1 \
    --header 'Authorization: Bearer <YOUR_API_TOKEN>'
```

--------------------------------

### Get Predicted Agent API Action

Source: https://platform.text.com/docs/messaging/customer-chat-api/v3.5/rtm-reference

Gets the predicted Agent who the Customer will chat with when the chat starts. The response includes agent details and a queue status.

```APIDOC
get_predicted_agent
  Description: Gets the predicted Agent - the one the Customer will chat with when the chat starts.
  Response Fields:
    queue (bool): If `true`, the chat will be queued.
    agent (object): Details of the predicted agent, including id, name, avatar, job_title, and type.
```

```JSON
{
  "action": "get_predicted_agent",
  "payload": {}
}
```

```JSON
{
  "request_id": "<request_id>",
  "action": "get_predicted_agent",
  "type": "response",
  "success": true,
  "payload": {
    "agent": {
      "id": "b5657aff34dd32e198160d54666df9d8",
      "name": "Agent Smith",
      "avatar": "https://example.avatar/example.com",
      "is_bot": false,
      "job_title": "support hero",
      "type": "agent"
    },
    "queue": false
  }
}
```

--------------------------------

### Example Request using cURL

Source: https://platform.text.com/docs/management/configuration-api/v3

Demonstrates how to call the agent creation API endpoint using cURL. It includes setting the HTTP method, endpoint URL, authorization header, content type, and the JSON payload for creating an agent with specific configurations.

```shell
curl -X POST \
  https://api.livechatinc.com/v3.5/configuration/action/create_agent \
  -H 'Authorization: Bearer <your_access_token>' \
  -H 'Content-Type: application/json' \
  -d '{ \
        "id": "smith@example.com", \
        "name": "Agent Smith", \
        "role": "viceowner", \
        "groups": [ \
          { \
            "id": 5, \
            "priority": "first" \
          }, \
          { \
            "id": 2, \
            "priority": "last" \
          }, \
          { \
            "id": 1, \
            "priority": "normal" \
          } \
        ], \
        "work_scheduler": { \
        "schedule": [ \
            { \
                "day": "monday", \
                "start": "08:00", \
                "end": "12:30", \
                "enabled": true \
            }, \
            { \
                "day": "monday", \
                "start": "13:30", \
                "end": "16:00", \
                "enabled": true \
            }, \
            { \
                "day": "friday", \
                "start": "08:00", \
                "end": "16:00", \
                "enabled": true \
            } \
        ], \
        "timezone": "Europe/Warsaw" \
    }, \
        "notifications": [ \
          "new_visitor", \
          "new_goal", \
          "visitor_is_typing" \
        ], \
        "email_subscriptions": [ \
          "weekly_summary" \
        ] \
    }'
```

--------------------------------

### Configuration API

Source: https://platform.text.com/docs/getting-started

The Configuration API is designed for managing license configurations and building complex integrations. It allows for setting up properties, managing webhooks to connect with external services, and configuring bot agents for AI solutions.

```APIDOC
Configuration API:
  Functionality:
    - Properties setup: Store information about chats or events.
    - Webhook management: Connect LiveChat with different services and react to chat events.
    - Bot agent configuration: Connect LiveChat with AI solutions.
  Purpose:
    - To store license configurations.
    - To build complex integrations.
    - To configure resources directly via the API.
```

--------------------------------

### Get Predicted Agent API Action

Source: https://platform.text.com/docs/messaging/customer-chat-api/v3.1/rtm-reference

Gets the predicted Agent who the Customer will chat with when the chat starts. The response includes agent details and a queue status.

```APIDOC
get_predicted_agent
  Description: Gets the predicted Agent - the one the Customer will chat with when the chat starts.
  Response Fields:
    queue (bool): If `true`, the chat will be queued.
    agent (object): Details of the predicted agent, including id, name, avatar, job_title, and type.
```

```JSON
{
  "action": "get_predicted_agent",
  "payload": {}
}
```

```JSON
{
  "request_id": "<request_id>",
  "action": "get_predicted_agent",
  "type": "response",
  "success": true,
  "payload": {
    "agent": {
      "id": "b5657aff34dd32e198160d54666df9d8",
      "name": "Agent Smith",
      "avatar": "https://example.avatar/example.com",
      "is_bot": false,
      "job_title": "support hero",
      "type": "agent"
    },
    "queue": false
  }
}
```

--------------------------------

### Get Predicted Agent API Action

Source: https://platform.text.com/docs/messaging/customer-chat-api/rtm-reference

Gets the predicted Agent who the Customer will chat with when the chat starts. The response includes agent details and a queue status.

```APIDOC
get_predicted_agent
  Description: Gets the predicted Agent - the one the Customer will chat with when the chat starts.
  Response Fields:
    queue (bool): If `true`, the chat will be queued.
    agent (object): Details of the predicted agent, including id, name, avatar, job_title, and type.
```

```JSON
{
  "action": "get_predicted_agent",
  "payload": {}
}
```

```JSON
{
  "request_id": "<request_id>",
  "action": "get_predicted_agent",
  "type": "response",
  "success": true,
  "payload": {
    "agent": {
      "id": "b5657aff34dd32e198160d54666df9d8",
      "name": "Agent Smith",
      "avatar": "https://example.avatar/example.com",
      "is_bot": false,
      "job_title": "support hero",
      "type": "agent"
    },
    "queue": false
  }
}
```

--------------------------------

### Smart Actions Greeting Configuration Example

Source: https://platform.text.com/docs/messaging/references/default-properties

Example JSON structure for configuring smart actions related to greetings.

```JSON
{
  "properties": {
    "smart_actions": {
      "greeting.hide_when_offline": false,
      "greeting.enabled": true,
      "greeting.max_invites": 5
    }
  }
}
```

--------------------------------

### Get Predicted Agent API Action

Source: https://platform.text.com/docs/customer-chat-api/rtm-reference

Gets the predicted Agent who the Customer will chat with when the chat starts. The response includes agent details and a queue status.

```APIDOC
get_predicted_agent
  Description: Gets the predicted Agent - the one the Customer will chat with when the chat starts.
  Response Fields:
    queue (bool): If `true`, the chat will be queued.
    agent (object): Details of the predicted agent, including id, name, avatar, job_title, and type.
```

```JSON
{
  "action": "get_predicted_agent",
  "payload": {}
}
```

```JSON
{
  "request_id": "<request_id>",
  "action": "get_predicted_agent",
  "type": "response",
  "success": true,
  "payload": {
    "agent": {
      "id": "b5657aff34dd32e198160d54666df9d8",
      "name": "Agent Smith",
      "avatar": "https://example.avatar/example.com",
      "is_bot": false,
      "job_title": "support hero",
      "type": "agent"
    },
    "queue": false
  }
}
```

--------------------------------

### Property Access Configuration Example

Source: https://platform.text.com/docs/getting-started/app-guides/properties

An example JSON structure illustrating how property access is defined for different locations (chat, thread) and user types (agent, customer).

```json
{
  "name": "sample_property",
  "access": {
    "chat": {
      "agent": ["read", "write"],
      "customer": ["read"]
    },
    "thread": {
      "agent": ["read", "write"],
      "customer": ["read"]
    }
  }
}
```

--------------------------------

### Enable PKCE Extension

Source: https://platform.text.com/docs/authorization/sign-in-with-livechat

Initializes the AccountsSDK instance with PKCE options enabled. This is the first step to secure authorization flows by preventing redirect hijacking.

```javascript
const instance = new AccountsSDK({
    client_id: '<your_app_client_id>',
    redirect_uri: '<your_app_redirect_uri>',
    response_type: "code",
    pkce: {
      enabled: true
    }
  });
```

--------------------------------

### Get Chat Response Example

Source: https://platform.text.com/docs/messaging/customer-chat-api/v3.5/rtm-reference

An example of a successful JSON response when retrieving chat details. It includes request metadata and the chat payload with thread information and user details.

```json
{
  "request_id": "<request_id>",
  "action": "get_chat",
  "type": "response",
  "success": true,
  "payload": {
    "id": "PJ0MRSHTDG",
    "thread": {
      "id": "K600PKZON8",
      "created_at": "2020-05-07T07:11:28.288340Z",
      "active": true,
      "user_ids": [
        "b7eff798-f8df-4364-8059-649c35c9ed0c",
        "b5657aff34dd32e198160d54666df9d8"
      ],
      "events": [
        {
          "id": "Q20N9CKRX2_1",
          "created_at": "2019-12-17T07:57:41.512000Z",
          "type": "message",
          "text": "Hello",
          "author_id": "b5657aff34dd32e198160d54666df9d8"
        }
      ],
      "properties": {
        "0805e283233042b37f460ed8fbf22160": {
          "string_property": "string_value"
        }
      },
      "access": {
        "group_ids": [0]
      },
      "previous_thread_id": "K600PKZOM8",
      "next_thread_id": "K600PKZOO8"
    },
    "users": [
      {
        "id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
        "type": "customer",
        "present": true
      },
      {
        "id": "b5657aff34dd32e198160d54666df9d8",
        "name": "Agent Smith",
        "type": "agent",
        "present": true,
        "avatar": "https://example.com/avatar.jpg",
        "job_title": "Support Agent"
      }
    ],
    "access": {
      "group_ids": [0]
    },
    "properties": {
      "0805e283233042b37f460ed8fbf22160": {
        "string_property": "string_value"
      }
    }
  }
}
```

--------------------------------

### Get Chat Response Example

Source: https://platform.text.com/docs/messaging/customer-chat-api/v3.1/rtm-reference

An example of a successful JSON response when retrieving chat details. It includes request metadata and the chat payload with thread information and user details.

```json
{
  "request_id": "<request_id>",
  "action": "get_chat",
  "type": "response",
  "success": true,
  "payload": {
    "id": "PJ0MRSHTDG",
    "thread": {
      "id": "K600PKZON8",
      "created_at": "2020-05-07T07:11:28.288340Z",
      "active": true,
      "user_ids": [
        "b7eff798-f8df-4364-8059-649c35c9ed0c",
        "b5657aff34dd32e198160d54666df9d8"
      ],
      "events": [
        {
          "id": "Q20N9CKRX2_1",
          "created_at": "2019-12-17T07:57:41.512000Z",
          "type": "message",
          "text": "Hello",
          "author_id": "b5657aff34dd32e198160d54666df9d8"
        }
      ],
      "properties": {
        "0805e283233042b37f460ed8fbf22160": {
          "string_property": "string_value"
        }
      },
      "access": {
        "group_ids": [0]
      },
      "previous_thread_id": "K600PKZOM8",
      "next_thread_id": "K600PKZOO8"
    },
    "users": [
      {
        "id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
        "type": "customer",
        "present": true
      },
      {
        "id": "b5657aff34dd32e198160d54666df9d8",
        "name": "Agent Smith",
        "type": "agent",
        "present": true,
        "avatar": "https://example.com/avatar.jpg",
        "job_title": "Support Agent"
      }
    ],
    "access": {
      "group_ids": [0]
    },
    "properties": {
      "0805e283233042b37f460ed8fbf22160": {
        "string_property": "string_value"
      }
    }
  }
}
```

--------------------------------

### Authorization and SDKs

Source: https://platform.text.com/docs/getting-started

Details on authentication and authorization protocols used by LiveChat and HelpDesk, including OAuth 2.1 flows for agents and customers. It also mentions the Accounts SDK for simplified authentication and the Global Accounts service for cross-product configuration.

```APIDOC
Authorization and SDKs:
  Protocol: OAuth 2.1
  Flows:
    - Agent authorization: For agent-specific operations.
    - Customer authorization: For customer-specific operations.
  Scopes: Required permissions configured in the Developer Console.
  SDKs:
    - Accounts SDK (Sign in with LiveChat): Simplifies access to basic account information.
    - HelpDesk SDK: For developing custom widgets for the HelpDesk agent app.
  Global Accounts service: Manages standard options across ChatBot, HelpDesk, and KnowledgeBase.
```

--------------------------------

### AccountsSDK authorizeURL Method Example (JavaScript)

Source: https://platform.text.com/docs/getting-started/authorization/sign-in-with-livechat

Demonstrates generating an authorization URL for either the 'code' or 'token' flow, essential for initiating the OAuth 2.0 authorization process.

```javascript
const authURL = instance.authorizeURL({
  client_id: '<your_app_client_id>'
}, "token");
```

--------------------------------

### Get Chat Response Example

Source: https://platform.text.com/docs/messaging/customer-chat-api/rtm-reference

An example of a successful JSON response when retrieving chat details. It includes request metadata and the chat payload with thread information and user details.

```json
{
  "request_id": "<request_id>",
  "action": "get_chat",
  "type": "response",
  "success": true,
  "payload": {
    "id": "PJ0MRSHTDG",
    "thread": {
      "id": "K600PKZON8",
      "created_at": "2020-05-07T07:11:28.288340Z",
      "active": true,
      "user_ids": [
        "b7eff798-f8df-4364-8059-649c35c9ed0c",
        "b5657aff34dd32e198160d54666df9d8"
      ],
      "events": [
        {
          "id": "Q20N9CKRX2_1",
          "created_at": "2019-12-17T07:57:41.512000Z",
          "type": "message",
          "text": "Hello",
          "author_id": "b5657aff34dd32e198160d54666df9d8"
        }
      ],
      "properties": {
        "0805e283233042b37f460ed8fbf22160": {
          "string_property": "string_value"
        }
      },
      "access": {
        "group_ids": [0]
      },
      "previous_thread_id": "K600PKZOM8",
      "next_thread_id": "K600PKZOO8"
    },
    "users": [
      {
        "id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
        "type": "customer",
        "present": true
      },
      {
        "id": "b5657aff34dd32e198160d54666df9d8",
        "name": "Agent Smith",
        "type": "agent",
        "present": true,
        "avatar": "https://example.com/avatar.jpg",
        "job_title": "Support Agent"
      }
    ],
    "access": {
      "group_ids": [0]
    },
    "properties": {
      "0805e283233042b37f460ed8fbf22160": {
        "string_property": "string_value"
      }
    }
  }
}
```

--------------------------------

### Get Chat Response Example

Source: https://platform.text.com/docs/customer-chat-api/rtm-reference

An example of a successful JSON response when retrieving chat details. It includes request metadata and the chat payload with thread information and user details.

```json
{
  "request_id": "<request_id>",
  "action": "get_chat",
  "type": "response",
  "success": true,
  "payload": {
    "id": "PJ0MRSHTDG",
    "thread": {
      "id": "K600PKZON8",
      "created_at": "2020-05-07T07:11:28.288340Z",
      "active": true,
      "user_ids": [
        "b7eff798-f8df-4364-8059-649c35c9ed0c",
        "b5657aff34dd32e198160d54666df9d8"
      ],
      "events": [
        {
          "id": "Q20N9CKRX2_1",
          "created_at": "2019-12-17T07:57:41.512000Z",
          "type": "message",
          "text": "Hello",
          "author_id": "b5657aff34dd32e198160d54666df9d8"
        }
      ],
      "properties": {
        "0805e283233042b37f460ed8fbf22160": {
          "string_property": "string_value"
        }
      },
      "access": {
        "group_ids": [0]
      },
      "previous_thread_id": "K600PKZOM8",
      "next_thread_id": "K600PKZOO8"
    },
    "users": [
      {
        "id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
        "type": "customer",
        "present": true
      },
      {
        "id": "b5657aff34dd32e198160d54666df9d8",
        "name": "Agent Smith",
        "type": "agent",
        "present": true,
        "avatar": "https://example.com/avatar.jpg",
        "job_title": "Support Agent"
      }
    ],
    "access": {
      "group_ids": [0]
    },
    "properties": {
      "0805e283233042b37f460ed8fbf22160": {
        "string_property": "string_value"
      }
    }
  }
}
```

--------------------------------

### Use HelpDesk SDK UMD Build in Browser

Source: https://platform.text.com/docs/extending-agent-app/products-sdk/helpdesk-sdk

Provides an example of how to include the HelpDesk SDK directly in an HTML file using its Universal Module Definition (UMD) build via a CDN. This is useful for quick integration without a build process.

```javascript
<script src="https://unpkg.com/@livechat/helpdesk-sdk@1.0.3/dist/helpdesk-sdk.umd.min.js"></script>
<script>
  HelpDesk.createDetailsWidget().then(function(widget) {
    // do something with widget
  });
</script>
```

--------------------------------

### Create Bot API

Source: https://platform.text.com/docs/management/configuration-api

Defines the parameters and provides an example for creating a new bot. It includes details on required fields like name and optional fields for avatar, chat routing, job title, groups, work scheduler, and owner client ID.

```APIDOC
Create Bot:
  Method URL: https://api.livechatinc.com/v3.5/configuration/action/create_bot
  Required scopes: bots:rw
  Batch support: No

  Request Body Parameters:
    name (string, required): Display name for the bot.
    avatar (string, optional): URL for the bot's avatar.
    max_chats_count (int, optional): Maximum incoming chats routed to the Bot. Defaults to 6, max 500.
    default_group_priority (string, optional): Default routing priority for a group without defined priority.
      Possible values: 'first', 'normal', 'last', 'supervisor'.
    job_title (string, optional): The bot's job title.
    groups (object[], optional): Array of groups the Bot belongs to.
      groups[].id (int, optional): Group ID (required if group is included).
      groups[].priority (string, required): Bot's priority within a group (required if group is included).
        Possible values: 'first', 'normal', 'last', 'supervisor'.
    work_scheduler (object, optional): Options for the bot's work scheduler.
      work_scheduler.timezone (string, required): The timezone for the bot's work scheduler.
    owner_client_id (string, required): Client ID for authorization via PATs. Overrides Bearer Token's client_id.

  Response:
    200 OK: Returns bot ID and secret.
      {
        "id": "5c9871d5372c824cbf22d860a707a578",
        "secret": "641e2ae6d997d2009a3ac92a05f37fc3"
      }

  Priority Values:
    first: Highest priority, gets chats before others in the same group.
    normal: Medium priority, gets chats before 'last' priority agents when no 'first' priority agents are available.
    last: Lowest priority, gets chats when no 'first' or 'normal' priority agents are available.
    supervisor: Bots do not receive automatic chat assignments.
```

```bash
curl -X POST \
  https://api.livechatinc.com/v3.5/configuration/action/create_bot \
  -H 'Authorization: Bearer <your_access_token>' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Bot Name" }'
```

--------------------------------

### Get Group API Response Example

Source: https://platform.text.com/docs/management/configuration-api

An example response for the get_group API endpoint, detailing a specific group including its ID, name, language code, agent priorities, and routing status.

```json
{
	"id": 19,
	"name": "Sports shoes",
	"language_code": "en",
	"agent_priorities": {
		"agent1@example.com": "normal",
		"agent2@example.com": "normal",
		"agent3@example.com": "last"
	},
	"routing_status": "offline"
}
```
Tokens:
Raw