Agent Chat Web API

https://platform.text.com/docs/messaging/agent-chat-api
Admin
A Web API reference for integrating agent chat functionalities, allowing clients to send messages,...
Tokens:461,969
Snippets:1,840
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Start Chat Response Example

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

An example of a successful response after starting a chat. It provides the unique IDs for the newly created chat and thread.

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

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

### Get License Info Response Example

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

An example of the JSON response when retrieving license information, showing license_id, expires_at, created_at, and in_trial status.

```json
{
    "license_id": "104130623",
    "expires_at": "2024-12-09T12:01:18.909000Z",
    "created_at": "2019-12-09T12:01:18.909000Z",
    "in_trial": false
}
```

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

### Start Chat Request Example

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

This JSON object demonstrates the structure for initiating a new chat. It includes the action type and an empty payload, ready to be populated with chat details.

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

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

### Start a Chat (cURL)

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

This example shows how to start a new chat using the LiveChat API. It uses a cURL command to make a POST request to the start_chat endpoint with an empty JSON payload, initiating a basic chat session.

```cURL
curl -X POST \
  https://api.livechatinc.com/v3.5/agent/action/start_chat \
  -H 'Authorization: Bearer <your_access_token>' \
  -H 'Content-Type: application/json' \
  -d '{}'
```

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

### Start Chat API

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

Starts a new chat session. Allows specifying initial users, events, and properties for the chat.

```APIDOC
## POST /api/users

### Description
Starts a new chat session. Allows specifying initial users, events, and properties for the chat. Authors of all initial events (except the requester) must be listed in the `users` field. The default `visibility` of both the events and users is set to `all` and cannot be changed. This method updates the requester's `events_seen_up_to` as if they've seen all chat events.

### Method
POST

### Endpoint
https://api.livechatinc.com/v3.6/agent/action/start_chat

### Parameters
#### Request Body
- **chat** (object) - Optional - Configuration for the new chat.
  - **properties** (object) - Optional - Properties for the chat.
  - **access** (object) - Optional - Access settings for the chat.
  - **users** (array of objects) - Optional - The list of existing users to include in the chat. Up to 4 additional agents (other than the requester) and 1 customer are allowed.
    - **id** (string) - Required - User ID.
    - **type** (string) - Required - Type of user (`agent` or `customer`).
  - **thread** (object) - Optional - Configuration for the chat thread.
    - **events** (array) - Optional - The list of initial chat events. Does not support the `form` type event.
    - **properties** (object) - Optional - Properties for the thread.
    - **active** (bool) - Optional - Set to `false` to create an inactive thread; default: `true`.
    - **continuous** (bool) - Optional - Starts chat as continuous (online group is not required); default: `false`.

### Request Example
```json
{
  "chat": {
    "users": [
      {
        "id": "agent_id_1",
        "type": "agent"
      },
      {
        "id": "customer_id_1",
        "type": "customer"
      }
    ],
    "thread": {
      "events": [
        {
          "text": "Hello, how can I help you?",
          "author_id": "agent_id_1"
        }
      ]
    }
  }
}
```

### Response
#### Success Response (200)
- **chat** (object) - Details of the started chat.
  - **id** (string) - The unique identifier for the chat.
  - **users** (array) - An array of user objects participating in the chat.
  - **thread** (object) - The thread object associated with the chat.
  - **properties** (object) - Chat-specific properties.
  - **access** (object) - Access settings for the chat.
  - **is_followed** (bool) - Indicates if the chat is being followed.

#### Response Example
```json
{
  "chat": {
    "id": "NEWCHATID123",
    "users": [
      {
        "id": "agent_id_1",
        "name": "Agent One",
        "email": "agent1@example.com",
        "type": "agent",
        "present": true,
        "avatar": "https://cdn.livechat-files.com/api/file/avatar.png",
        "visibility": "all"
      },
      {
        "id": "customer_id_1",
        "name": "Customer One",
        "type": "customer",
        "present": true,
        "avatar": null,
        "visibility": "all"
      }
    ],
    "thread": {
      "id": "THREADID456",
      "active": true,
      "user_ids": [
        "agent_id_1",
        "customer_id_1"
      ],
      "events": [
        {
          "id": "EVENTID789",
          "created_at": "2023-10-27T10:00:00Z",
          "visibility": "all",
          "type": "message",
          "properties": {},
          "text": "Hello, how can I help you?",
          "author_id": "agent_id_1"
        }
      ],
      "properties": {},
      "access": {
        "group_ids": []
      },
      "created_at": "2023-10-27T10:00:00Z",
      "is_followed": false
    },
    "properties": {},
    "access": {
      "group_ids": []
    },
    "is_followed": false
  }
}
```
```

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

### Start Chat Response Example

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

This JSON object represents a successful response after starting a chat. It confirms the action, indicates success, and provides the new chat and thread IDs.

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

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

### Start Chat API

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

Initiates a new chat session. This endpoint can be used to start a conversation with a customer.

```APIDOC
## POST /websites/platform_text_messaging_agent-chat-api/start_chat

### Description
Initiates a new chat session. This endpoint can be used to start a conversation with a customer.

### Method
POST

### Endpoint
https://api.livechatinc.com/v3.6/agent/action/start_chat

### Parameters
#### Request Body
- **(object)** - Optional - Request body can be empty.

### Request Example
{
  "example": "{}"
}

### Response
#### Success Response (200)
- **chat_id** (string) - The unique identifier for the newly started chat.
- **thread_id** (string) - The unique identifier for the thread associated with the chat.
- **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.

#### Response Example
{
  "example": "{\"chat_id\": \"PJ0MRSHTDG\", \"thread_id\": \"PGDGHT5G\"}"
}
```

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

### Login Request Example (JSON)

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

This is an example of a JSON request to log in to the Agent Chat API. It includes an authentication token and specifies push subscriptions for different API versions.

```json
{
  "action": "login",
  "payload": {
    "token": "Bearer dal:test_1fgTbfXmgthj4cZSA",
    "pushes": {
      "3.6": ["incoming_chat", "incoming_multicast"],
      "3.7": ["all"]
    }
  }
}

```

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

### Start Chat

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

Starts a new chat. Allows setting an 'active' parameter and automatically marks all events as seen.

```APIDOC
## POST /api/chats/start

### Description
Starts a new chat.

### Method
POST

### Endpoint
/api/chats/start

### Request Body
{
  "user_ids": [
    "string"
  ],
  "active": "boolean"
}

### Response
#### Success Response (200)
- **chat_id** (string) - The ID of the newly created chat.

#### Response Example
{
  "chat_id": "chat_456"
}
```

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

### Start Chat API

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

Starts a new chat session. You can specify initial events, users, and properties for the chat. The method updates the requester's events seen status.

```APIDOC
## POST /api/v3.5/agent/action/start_chat

### Description
Starts a new chat session. You can specify initial events, users, and properties for the chat. The method updates the requester's events seen status.

### Method
POST

### Endpoint
https://api.livechatinc.com/v3.5/agent/action/start_chat

### Parameters
#### Request Body
- **chat** (object) - Optional - Configuration for the new chat.
  - **properties** (object) - Optional - Custom properties for the chat.
  - **access** (object) - Optional - Access settings for the chat.
  - **users** (array) - Optional - A list of users to include in the chat. Up to 4 agents and 1 customer are allowed besides the requester.
    - **id** (string) - Required - The user's unique identifier.
    - **type** (string) - Required - The type of user (`agent` or `customer`).
  - **thread** (object) - Optional - Configuration for the chat's thread.
    - **events** (array) - Optional - A list of initial events for the thread. Does not support the `form` event type.
    - **properties** (object) - Optional - Custom properties for the thread.
    - **active** (boolean) - Optional - Set to `false` to create an inactive thread; defaults to `true`.
    - **continuous** (boolean) - Optional - Starts the chat as continuous, bypassing the need for an online group; defaults to `false`.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **chat_id** (string) - The unique identifier of the newly started chat.
- **thread_id** (string) - The unique identifier of the chat's thread.
- **event_ids** (array) - An array of strings, containing the IDs of user-generated initial events. Server-generated events are not included.

#### Response Example
```json
{
  "chat_id": "PJ0MRSHTDG",
  "thread_id": "PGDGHT5G"
}
```
```

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

### Start Chat

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

Starts a new chat session. You can optionally include initial users, events, and thread properties. The API handles setting the requester as the author of any initial events and marks them as seen.

```APIDOC
## POST /api/chats

### Description
Starts a chat. Authors (except the requester) of all initial events must be listed in the `users` field. The default `visibility` of both the events and users is set to `all` and cannot be changed. The method updates the requester's `events_seen_up_to` as if they've seen all chat events.

### Method
POST

### Endpoint
/api/chats

### Parameters
#### Request Body
- **action** (string) - Required - Should be set to `start_chat`.
- **payload** (object) - Required - Contains parameters for starting the chat.
  - **chat** (object) - Optional - Defines the properties of the chat to be started.
    - **properties** (object) - Optional - Custom properties for the chat.
    - **access** (object) - Optional - Access control settings for the chat.
    - **users** (array of objects) - Optional - The list of existing users to include in the chat. Up to 4 additional agents and 1 customer are allowed.
      - **id** (string) - Required - User ID.
      - **type** (string) - Required - User type: `agent` or `customer`.
    - **thread** (object) - Optional - Defines the initial thread properties.
      - **events** (array of objects) - Optional - The list of initial chat events. The `form` type event is not supported.
      - **properties** (object) - Optional - Custom properties for the thread.
      - **active** (boolean) - Optional - If set to `false`, creates an inactive thread; default is `true`.
      - **continuous** (boolean) - Optional - Starts the chat as continuous (online group is not required); default is `false`.

### Request Example
```json
{
  "action": "start_chat",
  "payload": {
    "chat": {
      "users": [
        {
          "id": "agent@example.com",
          "type": "agent"
        },
        {
          "id": "customer@example.com",
          "type": "customer"
        }
      ],
      "thread": {
        "events": [
          {
            "type": "message",
            "text": "Hello!"
          }
        ]
      }
    }
  }
}
```

### Response
#### Success Response (200)
- **request_id** (string) - Optional - Unique identifier for the request.
- **action** (string) - The action performed, e.g., `start_chat`.
- **type** (string) - Type of the response, e.g., `response`.
- **success** (boolean) - Indicates if the action was successful.
- **payload** (object) - Contains the results of the action.
  - **chat_id** (string) - The unique identifier for the newly created chat.
  - **thread_id** (string) - The unique identifier for the newly created thread.
  - **event_ids** (array of strings) - Optional - IDs of the user-generated initial events, if any were provided.

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

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

### Start Chat

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

Initiates a new chat conversation. Requires specific scopes for authorization.

```APIDOC
## POST /chats/start

### Description
Starts a new chat conversation. Requires either `chats--all:rw` or `chats.conversation--all:rw` scope.

### Method
POST

### Endpoint
/chats/start

### Request Body
- **customer_id** (string) - Required - The identifier of the customer initiating the chat.
- **agent_id** (string) - Optional - The identifier of the agent assigned to the chat.

### Request Example
```json
{
  "customer_id": "cust_456",
  "agent_id": "agent_2"
}
```

### Response
#### Success Response (200)
- **chat_id** (string) - The unique identifier of the newly created chat.

#### Response Example
```json
{
  "chat_id": "chat_abc789"
}
```
```

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

### Get Chat Response Example

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

Provides a sample JSON response for the 'get_chat' action, detailing the structure of chat and thread information, including events, users, and customer 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",
        "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",
      "customer_visit": {
        "ip": "<customer_ip>",
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2785.116 Safari/537.36",
        "geolocation": {
          "latitude": "-14.6973803",
          "longitude": "-75.1266898",
          "country": "Poland",
          "country_code": "PL",
          "region": "Dolnoslaskie",
          "city": "Wroclaw",
          "timezone": "Europe/Warsaw"
        }
      } 
    },
    "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
  }
}
```

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

### Start Chat API

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

Starts a new chat conversation. You can include initial messages, user information, and thread properties.

```APIDOC
## POST /api/chats

### Description
Starts a chat. Authors (except the requester) of all initial events must be listed in the `users` field. The default `visibility` of both the events and users is set to `all` and cannot be changed. The method updates the requester's `events_seen_up_to` as if they've seen all chat events.

### Method
POST

### Endpoint
/api/chats

### Parameters
#### Request Body
- **action** (string) - Required - Must be `start_chat`.
- **payload** (object) - Required - Contains chat details.
  - **payload.chat** (object) - Optional - Chat configuration.
    - **payload.chat.properties** (object) - Optional - Custom properties for the chat.
    - **payload.chat.access** (object) - Optional - Access control for the chat.
    - **payload.chat.users** (array of objects) - Optional - List of existing users in the chat. Up to 4 additional agents and 1 customer are allowed.
      - **payload.chat.users.id** (string) - Required - User ID.
      - **payload.chat.users.type** (string) - Required - Type of user (`agent` or `customer`).
    - **payload.chat.thread** (object) - Optional - Thread configuration.
      - **payload.chat.thread.events** (array of objects) - Optional - List of initial chat events. Does not support `form` type events.
      - **payload.chat.thread.properties** (object) - Optional - Custom properties for the thread.
      - **payload.chat.thread.active** (boolean) - Optional - Set to `false` to create an inactive thread; default: `true`.
      - **payload.chat.thread.continuous** (boolean) - Optional - Starts chat as continuous; default: `false`.

### Request Example
```json
{
  "action": "start_chat",
  "payload": {}
}
```

### Response
#### Success Response (200)
- **request_id** (string) - Optional - Unique identifier for the request.
- **action** (string) - The action performed, e.g., `start_chat`.
- **type** (string) - Type of the response, e.g., `response`.
- **success** (boolean) - Indicates if the action was successful.
- **payload** (object) - Contains the results of the action.
  - **payload.chat_id** (string) - The ID of the newly created chat.
  - **payload.thread_id** (string) - The ID of the newly created thread.
  - **payload.event_ids** (array of strings) - Optional - IDs of user-generated initial events.

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

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

### Login Request Example

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

An example of a login request to the Agent Chat API. It includes the authentication token and specifies push subscriptions for different API versions.

```json
{
  "action": "login",
  "payload": {
    "token": "Bearer dal:test_1fgTbfXmgthj4cZSA",
    "pushes": {
      "3.5": ["incoming_chat", "incoming_multicast"],
      "3.6": ["all"]
    }
  }
}
```

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

### List Threads Response Example (JSON)

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

Example JSON response for the 'list_threads' action, detailing thread, event, user, and pagination information.

```json
{
  "request_id": "<request_id>",
  "action": "list_threads",
  "type": "response",
  "success": true,
  "payload": {
    "threads": [{
      "id": "K600PKZON8",
      "created_at": "2019-12-17T07:57:41.512000Z",
      "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": {
      },
      "access": {
        "group_ids": [0]
      },
      "previous_thread_id": "K600PKZOM8",
      "next_thread_id": "K600PKZOO8",
      "customer_visit": {
        "ip": "<customer_ip>",
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2785.116 Safari/537.36",
        "geolocation": {
          "latitude": "-14.6973803",
          "longitude": "-75.1266898",
          "country": "Poland",
          "country_code": "PL",
          "region": "Dolnoslaskie",
          "city": "Wroclaw",
          "timezone": "Europe/Warsaw"
        }
      }
    }],
    "found_threads": 42,
    "next_page_id": "MTUxNzM5ODEzMTQ5Ng==",
    "previous_page_id": "MTUxNzM5ODEzMTQ5Nw=="
  }
}

```

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

### List Chats Request Example

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

Example request for the `list_chats` method, which returns summaries of chats an Agent has access to. It includes optional filters, sort order, limit, and pagination parameters.

```json
{
  "action": "list_chats",
  "payload": {
    "filters": {
      "active": true,
      "include_chats_without_threads": false,
      "group_ids": ["group1", "group2"],
      "properties.custom_namespace.status.values": ["active"]
    },
    "sort_order": "asc",
    "limit": 50,
    "page_id": "some_page_id"
  }
}

```

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

### Start Chat

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

Starts a new chat session. This method allows initiating a conversation with specified users and initial events. The requester's read status is updated to reflect viewing all initial events.

```APIDOC
## POST /api/chats/start

### Description
Starts a chat. Authors (except the requester) of all initial events must be listed in the `users` field. The default `visibility` of both the events and users is set to `all` and cannot be changed. The method updates the requester's `events_seen_up_to` as if they've seen all chat events.

### Method
POST

### Endpoint
/api/chats/start

### Parameters
#### Request Body
- **action** (string) - Required - The action to perform, should be `start_chat`.
- **payload** (object) - Optional - Contains the chat details.
  - **payload.chat** (object) - Optional - Details of the chat to start.
    - **payload.chat.properties** (object) - Optional - Custom properties for the chat.
    - **payload.chat.access** (object) - Optional - Access settings for the chat.
      - **payload.chat.access.group_ids** (array[integer]) - Optional - List of group IDs for access.
    - **payload.chat.users** (array[object]) - Optional - The list of existing users. Up to 4 additional (other than the requester) agents and 1 customer allowed.
      - **payload.chat.users.id** (string) - Required - User ID.
      - **payload.chat.users.type** (string) - Required - User type (`agent` or `customer`).
    - **payload.chat.thread** (object) - Optional - Initial thread details.
      - **payload.chat.thread.events** (array[object]) - Optional - The list of initial chat events. Does not support the `form` type event.
      - **payload.chat.thread.properties** (object) - Optional - Custom properties for the thread.
    - **payload.active** (boolean) - Optional - Creates an inactive thread if `false`; default: `true`.
    - **payload.continuous** (boolean) - Optional - Starts chat as continuous (online group not required); default: `false`.

### Request Example
```json
{
  "action": "start_chat",
  "payload": {}
}
```

### Response
#### Success Response (200)
- **request_id** (string) - Optional - Unique identifier for the request.
- **action** (string) - The action performed, `start_chat`.
- **type** (string) - The type of the response, `response`.
- **success** (boolean) - Indicates if the action was successful.
- **payload** (object) - Contains the result of the action.
  - **payload.chat_id** (string) - The ID of the newly started chat.
  - **payload.thread_id** (string) - The ID of the thread associated with the chat.
  - **payload.event_ids** (array[string]) - Returned only when the chat was started with initial events. Returns only the IDs of user-generated events.

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

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

### List Chats Response Example

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

An example of a successful response from the 'list_chats' API call. It includes details about pagination, a summary of chats, and the estimated number of chats found.

```JSON
{
  "request_id": "<request_id>",
  "action": "list_chats",
  "type": "response",
  "success": true,
  "payload": {
    "next_page_id": "MTUxNzM5ODEzMTQ5Ng==",
    "chats_summary": [
      {
        "id": "PJ0MRSHTDG",
        "last_event_per_type": {
          "message": {
            "thread_id": "K600PKZON8",
            "thread_created_at": "2020-05-07T07:11:28.288340Z",
            "event": {
              "id": "Q298LUVPRH_1",
              "created_at": "2019-12-09T12:01:18.909000Z",
              "visibility": "all",
              "type": "message",
              "text": "hello world",
              "author_id": "b7eff798-f8df-4364-8059-649c35c9ed0c"
            }
          },
          "system_message": {
            "thread_id": "K600PKZON8",
            "thread_created_at": "2020-05-07T07:11:28.288340Z",
            "event": {
              "System message" event
            }
          }
        },
        "users": [
          {
            "Customer" user object
          },
          {
            "Agent" user object
          }
        ],
        "last_thread_summary": {
          "id": "K600PKZON8",
          "created_at": "2020-05-07T07:11:28.288340Z",
          "user_ids": [
            "b7eff798-f8df-4364-8059-649c35c9ed0c",
            "smith@example.com"
          ],
          "properties": {
            "Properties" object
          },
          "active": true,
          "access": {
            "group_ids": [0]
          }
        },
        "properties": {
          "Properties" object
        },
        "access": {
          "group_ids": [0]
        },
        "is_followed": true
      }
    ],
    "found_chats": 4
  }
}
```

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

### Get Chat Response Example

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

This JSON payload illustrates a successful response from the get_chat action, containing detailed information about a chat thread, associated users, and properties.

```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",
        "smith@example.com"
      ],
      "events": [{
        "id": "Q20N9CKRX2_1",
        "created_at": "2019-12-17T07:57:41.512000Z",
        "recipients": "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"
    }],
    "properties": {
      "0805e283233042b37f460ed8fbf22160": {
        "string_property": "string_value"
      }
    },
    "access": {
      "group_ids": [0]
    },
    "is_followed": true
  }
}
```

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

### Start Chat

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

Starts a new chat conversation. This action also updates the requester's 'events_seen_up_to' timestamp.

```APIDOC
## POST /api/chats/start_chat

### Description
Starts a new chat conversation. This action also updates the requester's 'events_seen_up_to' timestamp.

### Method
POST

### Endpoint
/api/chats/start_chat

### Parameters
#### Required scopes
- `chats.conversation--all:rw`
- `chats.conversation--access:rw`
- `chats.conversation--my:rw`
*(If `chat.users` is defined, one of the following scopes is also required: `chats--all:rw`, `chats--access:rw`, or `chats--my:rw`)*

### Request Example
```json
{
  "action": "start_chat"
}
```

### Response
*(Response details for starting a chat are not provided in the input text. Typically, it would include the newly created chat object or its ID.)*

#### Success Response (200)
*(Example structure, actual response may vary)*
```json
{
  "request_id": "<request_id>",
  "action": "start_chat",
  "type": "response",
  "success": true,
  "payload": {
    "chat_id": "NEW_CHAT_ID"
  }
}
```
```

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

### Add User to Chat Response Example

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

Provides an example of a successful response after adding a user to a chat. Indicates the 'action', 'type', and 'success' status of the operation.

```json
{
  "request_id": "<request_id>", 
  "action": "add_user_to_chat",
  "type": "response",
  "success": true,
  "payload": {
  // no response payload
  }
}
```

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

### List Agents for Transfer Response Example

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

Example of the JSON response when listing agents available for chat transfer. Each agent is listed with their ID and the total number of active chats they are currently handling.

```JSON
[
  {
  "agent_id": "smith@example.com",
  "total_active_chats": 2
  }, {
  "agent_id": "agent@example.com",
  "total_active_chats": 5
  }
]

```

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

### Start Chat Action

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

Defines the 'start_chat' action, its purpose of initiating a chat, and the necessary scopes for its execution.

```text
Action: `start_chat`
Required scopes ***: `chats.conversation--all:rw` `chats.conversation--access:rw` `chats.conversation--my:rw`
Web API equivalent: `start_chat`
Push message: `incoming_chat`
```

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

### Start Chat API

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

Starts a new chat conversation. You can include initial events, users, and thread properties. The method updates the requester's 'events_seen_up_to' as if they've seen all chat events.

```APIDOC
## POST /websites/platform_text_messaging_agent-chat-api

### Description
Starts a chat. Authors (except the requester) of all initial events must be listed in the `users` field. The default `visibility` of both the events and users is set to `all` and cannot be changed. The method updates the requester's `events_seen_up_to` as if they've seen all chat events.

### Method
POST

### Endpoint
/websites/platform_text_messaging_agent-chat-api

### Parameters
#### Request Body
- **action** (string) - Required - The action to perform, should be `start_chat`.
- **payload** (object) - Required - Contains the data for starting the chat.
  - **payload.chat** (object) - Optional - Represents the chat object.
    - **payload.chat.properties** (object) - Optional - Custom properties for the chat.
    - **payload.chat.access** (object) - Optional - Access control settings for the chat.
    - **payload.chat.users** (array of objects) - Optional - The list of existing users. Up to 4 additional agents and 1 customer are allowed.
      - **payload.chat.users.id** (string) - Required - User ID.
      - **payload.chat.users.type** (string) - Required - User type: `agent` or `customer`.
    - **payload.chat.thread** (object) - Optional - Represents the thread object.
      - **payload.chat.thread.events** (array of objects) - Optional - The list of initial chat events. Does not support the `form` type event.
      - **payload.chat.thread.properties** (object) - Optional - Custom properties for the thread.
      - **payload.chat.thread.active** (boolean) - Optional - Set to `false` to create an inactive thread; defaults to `true`.
      - **payload.chat.thread.continuous** (boolean) - Optional - Starts the chat as continuous (online group is not required); defaults to `false`.

### Request Example
```json
{
  "action": "start_chat",
  "payload": {}
}
```

### Response
#### Success Response (200)
- **request_id** (string) - Optional - Unique identifier for the request.
- **action** (string) - The action performed, will be `start_chat`.
- **type** (string) - Indicates the type of response, will be `response`.
- **success** (boolean) - Indicates if the action was successful.
- **payload** (object) - Contains the result of the action.
  - **payload.chat_id** (string) - The unique identifier for the started chat.
  - **payload.thread_id** (string) - The unique identifier for the thread within the chat.
  - **payload.event_ids** (array of strings) - Optional - IDs of user-generated events, returned only if initial events were provided.

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

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

### List Chats Request Example

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

An example of a request to list chats, demonstrating the use of various filter parameters such as active status, inclusion of chats without threads, group IDs, property filters, sort order, limit, and pagination.

```json
{
  "action": "list_chats",
  "payload": {
    "filters": {
      "active": true,
      "include_chats_without_threads": false,
      "group_ids": ["group1", "group2"],
      "properties.custom_namespace.custom_name.exists": true
    },
    "sort_order": "asc",
    "limit": 50,
    "page_id": "page123"
  }
}

```

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

### Start Chat

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

Starts a new chat session. This endpoint allows initiating a conversation with specified users and initial events. The method updates the requester's events seen status.

```APIDOC
## POST /api/chats

### Description
Starts a new chat session. This endpoint allows initiating a conversation with specified users and initial events. The method updates the requester's events seen status.

### Method
POST

### Endpoint
/api/chats

### Parameters
#### Request Body
- **action** (string) - Required - The action to perform, must be `start_chat`.
- **payload** (object) - Optional - Payload containing chat details.
  - **payload.properties** (object) - Optional - Custom properties for the chat.
  - **payload.access** (object) - Optional - Access control settings for the chat.
  - **payload.users** (array of objects) - Optional - List of existing users in the chat. Up to 4 additional agents and 1 customer are allowed.
    - **payload.users.id** (string) - Required - User ID.
    - **payload.users.type** (string) - Required - Type of user, either `agent` or `customer`.
  - **payload.thread** (object) - Optional - Thread details for the chat.
    - **payload.thread.events** (array of objects) - Optional - Initial events for the chat. Does not support `form` type events.
    - **payload.thread.properties** (object) - Optional - Custom properties for the thread.
    - **payload.thread.active** (boolean) - Optional - Set to `false` to create an inactive thread. Defaults to `true`.
    - **payload.thread.continuous** (boolean) - Optional - Starts chat as continuous. Defaults to `false`.

### Request Example
```json
{
  "action": "start_chat",
  "payload": {}
}
```

### Response
#### Success Response (200)
- **request_id** (string) - Optional - Unique identifier for the request.
- **action** (string) - The action performed, `start_chat`.
- **type** (string) - Type of the response, `response`.
- **success** (boolean) - Indicates if the action was successful.
- **payload** (object) - Contains the result of the action.
  - **payload.chat_id** (string) - The ID of the newly started chat.
  - **payload.thread_id** (string) - The ID of the thread associated with the chat.

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

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

### List Chats Request Example

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

Demonstrates how to request a list of chats an Agent has access to. This example includes optional filters for including active chats and chats without threads, as well as sorting and pagination parameters.

```json
{
  "action": "list_chats",
  "filters": {
    "include_active": true,
    "include_chats_without_threads": true,
    "group_ids": ["group_id_1", "group_id_2"],
    "properties.custom_namespace.custom_name.exists": true
  },
  "sort_order": "desc",
  "limit": 50,
  "page_id": "page_123"
}
```

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

### Start Chat

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

Initiates a new chat conversation. Requires specific scopes for managing conversations.

```APIDOC
## POST /api/chats/start_chat

### Description
Starts a new chat conversation.

### Method
POST

### Endpoint
/api/chats/start_chat

### Parameters
#### Request Body
- **action** (string) - Required - Must be `start_chat`.
- **payload** (object) - Required - Contains parameters for starting a chat.
  - **chat** (object) - Optional - Details of the chat to start.
    - **users** (array) - Optional - Array of users to include in the chat.

### Scopes
- `chats.conversation--all:rw`
- `chats.conversation--access:rw`
- `chats.conversation--my:rw`
- If `chat.users` is defined, one of the following is also required: `chats--all:rw`, `chats--access:rw`, `chats--my:rw`

### Response
(Response structure not provided in the input text)
```
Tokens:
Raw