Контакты

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

GET https://app.jetbot24.ru/api/v1/getContacts

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

Path Parameters

Name	Type	Description
api_token*	string	api токен вашего аккаунта
bot_id*	integer	ID бота (находится в URL конструктора между bots и schema)
date_from	integer	Фильтр по дате создания контакта в формате Unix Time
date_to	integer	Фильтр по дате создания контакта в формате Unix Time
count	integer	Количество контактов для получения. Максимальное значение: 500
page	integer	Порядковый номер страницы

Response

200 Запрос успешно обработан

{
"data": [
    {
      "id": 1,
      "bot_id": 1,
      "phone": "79991234567",
      "email": "[e-mail]",
      "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": "« Назад",
    "active": false
    },
      {
        "url": "https://app.jetbot24.ru/api/v1/getContacts?page=1",
        "label": 1,
        "active": true
      },
      {
        "url": null,
        "label": "Вперёд »",
        "active": false
      }
    ],
    "path": "https://app.jetbot24.ru/api/v1/getContacts",
    "perpage": 20,
    "to": 3,
    "total": 3
  }
}

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

POST https://app.jetbot24.ru/api/v1/createOrUpdateContact

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

Request Body

Name	Type	Description
api_token*	string	api токен вашего аккаунта
bot_id*	integer	ID бота (находится в URL конструктора между bots и schema)
messenger*	string	Тип мессенджера. Возможные значения: whatsapp, telegram, viber, vk
name*	string	Имя контакта
email	string	Email контакта
address	string	Адрес контакта
phone	string	Номер телефона контакта в международном формате ([phone]). Обязателен когда messenger == "whatsapp"
telegram_id	int	ID пользователя в Телеграм. Обязателен когда messenger == "telegram"
telegram_username	string	Username пользователя Телеграм
viber_id	string	ID пользователя в Viber. Обязателен когда messenger == "viber"
vk_id	int	ID пользователя в ВКонтакте. Обязателен когда messenger == "vk"
tags	array	Массив тегов контакта. Пример: ["Тег 1", "Тег 2"]

Response

200

{
"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": []
  }
}

400

{
  "error": "Invalid request"
}