> For the complete documentation index, see [llms.txt](https://jetbot.gitbook.io/api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://jetbot.gitbook.io/api/rabota-s-api/kontakty.md).

# Контакты

## Получить список контактов (пользователей) бота

<mark style="color:blue;">`GET`</mark> `https://app.jetbot24.ru/api/v1/getContacts`

Этот метод позволяет получить список контактов указанного бота.

**Path Parameters**

<table><thead><tr><th width="240">Name</th><th width="155">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>api_token</code><mark style="color:red;">*</mark></td><td>string</td><td>api токен вашего аккаунта</td></tr><tr><td><code>bot_id</code><mark style="color:red;">*</mark></td><td>integer</td><td>ID бота (находится в URL конструктора между bots и schema)</td></tr><tr><td><code>date_from</code></td><td>integer</td><td>Фильтр по дате создания контакта в формате Unix Time</td></tr><tr><td><code>date_to</code></td><td>integer</td><td>Фильтр по дате создания контакта в формате Unix Time</td></tr><tr><td><code>count</code></td><td>integer</td><td>Количество контактов для получения. Максимальное значение: 500</td></tr><tr><td><code>page</code></td><td>integer</td><td>Порядковый номер страницы</td></tr></tbody></table>

**Response**

{% tabs %}
{% tab title="200 Запрос успешно обработан" %}

```json
{
"data": [
    {
      "id": 1,
      "bot_id": 1,
      "phone": "79991234567",
      "email": "info@example.com",
      "name": "Иван Иванов",
      "messenger": "whatsapp",
      "address": "г. Москва, ул. Пушкина, д. 5",
      "utm": {
        "utm_source": "landing",
        "utm_medium": "...",
        "utm_campaign": "...",
        "utm_term": "...",
        "utm_content": "..."
      },
      "created_at": "2024-05-10T10:38:28+00:00"
    },
    {
      "id": 2,
      "bot_id": 1,
      "phone": "792712312321",
      "email": null,
      "name": "Петр Петров",
      "messenger": "telegram",
      "telegram_id": "123456",
      "telegram_username": "superman",
      "address": null,
      "utm": null,
      "created_at": "2024-04-02T12:16:16+00:00"
    },
    {
      "id": 3,
      "bot_id": 2,
      "phone": null,
      "email": null,
      "name": "Василий Васильев",
      "messenger": "viber",
      "viber_id": "1123456789dD20=",
      "address": null,
      "utm": null,
      "created_at": "2024-05-11T15:31:34+00:00"
    },
  ],
  "links": {
    "first": "https:\/\/app.jetbot24.ru\/api\/v1\/getContacts?page=1",
    "last": "https:\/\/app.jetbot24.ru\/api\/v1\/getContacts?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
    {
    "url":null,
    "label": "&laquo; Назад",
    "active": false
    },
      {
        "url": "https://app.jetbot24.ru/api/v1/getContacts?page=1",
        "label": 1,
        "active": true
      },
      {
        "url": null,
        "label": "Вперёд &raquo;",
        "active": false
      }
    ],
    "path": "https://app.jetbot24.ru/api/v1/getContacts",
    "perpage": 20,
    "to": 3,
    "total": 3
  }
}
```

{% endtab %}
{% endtabs %}

## Создать или обновить контакт пользователя

<mark style="color:green;">`POST`</mark> `https://app.jetbot24.ru/api/v1/createOrUpdateContact`

Этот метод позволяет создать или обновить контакт указанного бота.

**Request Body**

<table><thead><tr><th width="238">Name</th><th width="136">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>api_token</code><mark style="color:red;">*</mark></td><td>string</td><td>api токен вашего аккаунта</td></tr><tr><td><code>bot_id</code><mark style="color:red;">*</mark></td><td>integer</td><td>ID бота (находится в URL конструктора между bots и schema)</td></tr><tr><td><code>messenger</code><mark style="color:red;">*</mark></td><td>string</td><td>Тип мессенджера. Возможные значения: <code>whatsapp</code>, <code>telegram</code>, <code>viber</code>, <code>vk</code></td></tr><tr><td><code>name</code><mark style="color:red;">*</mark></td><td>string</td><td>Имя контакта</td></tr><tr><td><code>email</code></td><td>string</td><td>Email контакта</td></tr><tr><td><code>address</code></td><td>string</td><td>Адрес контакта</td></tr><tr><td><code>phone</code></td><td>string</td><td>Номер телефона контакта в международном формате (+79991234567). Обязателен когда <code>messenger == "whatsapp"</code></td></tr><tr><td><code>telegram_id</code></td><td>int</td><td>ID пользователя в Телеграм. Обязателен когда <code>messenger == "telegram"</code></td></tr><tr><td><code>telegram_username</code></td><td>string</td><td>Username пользователя Телеграм</td></tr><tr><td><code>viber_id</code></td><td>string</td><td>ID пользователя в Viber. Обязателен когда <code>messenger == "viber"</code></td></tr><tr><td><code>vk_id</code></td><td>int</td><td>ID пользователя в ВКонтакте. Обязателен когда <code>messenger == "vk"</code></td></tr><tr><td><code>tags</code></td><td>array</td><td>Массив тегов контакта. Пример: ["Тег 1", "Тег 2"]</td></tr></tbody></table>

**Response**

{% tabs %}
{% tab title="200" %}

```json
{
"data": {
    "id": 1,
    "botid": 1,
    "phone": null,
    "email": null,
    "name": "Вася",
    "address": null,
    "messenger": "telegram",
    "utm": [],
    "avatar": null,
    "telegram_id": "123456",
    "telegram_username": null,
    "vk_user_id": null,
    "created_at": "2024-11-07T15:35:51+00:00",
    "unsubscribedat": null,
    "tags": [
      "Тег 1",
      "Тег 2"
    ],
    "variables": []
  }
}
```

{% endtab %}

{% tab title="400" %}

```json
{
  "error": "Invalid request"
}
```

{% endtab %}
{% endtabs %}