Контакты

Получить список контактов

GET https://app.onebot.tech/api/v1/getContacts

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

Path Parameters

Name
Type
Description

date_from

Integer

Фильтр по дате создания контакта в формате Unix Time

date_to

Integer

Фильтр по дате создания контакта в формате Unix Time

count

Integer

Количество контактов для получения. Максимальное значение: 500

with

String

Список дополнительных сущностей для контакта, передается в виде перечисления через запятую. Пример: tags,variables

bot_id

Integer

ID бота

{
  "data": [
    {
      "id": 1,
      "bot_id": 1,
      "phone": "380500505555",
      "email": "info@example.com",
      "name": "Иван Иванов",
      "messenger": "whatsapp",
      "address": "г. Киев, Степана Бандеры, д. 5",
      "utm": {
        "utm_source": "landing",
        "utm_medium": "...",
        "utm_campaign": "...",
        "utm_term": "...",
        "utm_content": "..."
      },
      "created_at": "2022-11-11T10:38:28+00:00"
    },
    {
      "id": 2,
      "bot_id": 1,
      "phone": "380660888007",
      "email": null,
      "name": "Петр Петров",
      "messenger": "telegram",
      "telegram_id": "123456",
      "telegram_username": "superman",
      "address": null,
      "utm": null,
      "created_at": "2022-11-11T12: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": "2022-11-11T15:31:34+00:00"
    },
  ],
  "links": {
    "first": "http:\/\/onebot.tech\/api\/v1\/getContacts?page=1",
    "last": "http:\/\/onebot.tech\/api\/v1\/getContacts?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "http:\/\/onebot.tech\/api\/v1\/getContacts",
    "per_page": 500,
    "to": 3,
    "total": 3
  }
}

PreviousРассылкаNextСчета

Last updated