Модель контакта

Вид модели:

{
  "id": "contact_id",
  "project_id": 123,
  "details": [
    {
      "id": "contact_detail_id",
      "type": "email/phone",
      "data": "email@example.com/+71234567890"
    }
  ],
  "fields": [
    {
      "id": "12",
      "type": "string",
      "name": "fieldName",
      "value": "exampleText"
    }
  ],
  "created_at": "DD.MM.YY HH:MM:SS",
  "name": "user_name",
  "site": "example.com"
}

Описание полей:

  • id: ID контакта
  • project_id - ID проекта, к которому был создан пользователь.
  • details - массив контактных данных:
    • id - ID контактных данных
    • type - Тип контактных данных
    • data - Контактные данные
  • fields - массив полей контакта:
    • id - ID поля контакта
    • type - Тип поля. Может быть: string, text, number, date
    • name - Имя поля контакта
    • value - Значение поля для конкретного контакта.

      При отсутствии значения - поле value передаваться не будет

  • created_at - дата создания (формат: DD.MM.YY HH.MM.SS)
  • name - Имя контакта
  • site - Личный сайт контакта

Используется при:

Модель проекта

Вид модели:

{
    "id": 123,
    "name": "project_name",
    "page": "project_url",
    "domain": "domain_name"
}

Описание полей:

  • id- Уникальный номер проекта
  • name - Название проекта
  • page - Полное доменное имя (FQDN)
  • domain - Доменное имя в чистом виде

Используется при:

Модель лида

В случае корректного токена и успешного выполнения запроса Вы получите следующий результат:

{
  "id": 2087883,
  "contact_id": 1981409,
  "name": "Mak",
  "view": {
    "id": 43,
    "source": "Api",
    "campaign": "CampaignName",
    "keyword": "keywordName"
  },
  "custom": [
    {
      "id": 344623,
      "name": "Владелец заявки",
      "type": "conv_owner",
      "value": {
        "id": 17873,
        "type": "main"
      }
    },
    {
      "id": 344624,
      "name": "Дата заявки",
      "type": "conv_date",
      "value": "09.05.17 16:54:40"
    }
  ],
  "payments": [
    {
      "category": "categoryName",
      "purpose": "purposeName",
      "sum": 41
    }
  ],
  "contact": {
    "id": "contact_id",
    "project_id": 123,
    "details": [
      {
        "id": "contact_detail_id",
        "type": "email/phone",
        "data": "email@example.com/+71234567890"
      }
    ],
    "fields": [
      {
        "id": "12",
        "type": "string",
        "name": "fieldName",
        "value": "exampleText"
      }
    ],
    "created_at": "DD.MM.YY HH:MM:SS",
    "name": "user_name",
    "site": "example.com"
  }
}

Описание полей:

  • id - ID лида
  • contact_id - ID контакта (вернее, person_id), к которому привязан лид
  • name - Имя лида
  • view - Просмотр, с которого был создан лид
    • id - ID просмотра
    • source - Источник
    • campaign - Кампания
    • keyword - Ключевое слово
  • custom - Блок работы с кастомными полями
    • id - ID поля
    • name - Название поля
    • type - Тип поля
    • value - Значение, либо массив значений
  • payments - Платежи лида
    • category - Категория платежа
    • purpose - Назначение платежа
    • sum - Сумма платежа

Используется при:

Модель задачи

В случае корректного токена и успешного выполнения запроса Вы получите следующий результат:

{
    "status": "success",
    "result": {
        "id": 3893,
        "title": "Новвая задача",
        "text": "описание",
        "owner_id": 19010,
        "project_id": 649,
        "date_start": 1688896800,
        "date_end": 16999948798,
        "remind_type": 1,
        "remind_method": "sms,email,popup",
        "lead_id": 393989,
        "visibility": 2,
        "status": 1,
        "observers": [
            {
                "id": 9,
                "phone": "79161676999",
                "name": "Иванов Иван",
                "last_project_id": 649
            },
            {
                "id": 19010,
                "email": "polyanskiy@mail.ru",
                "phone": "79161234567",
                "name": "Петр Петров",
                "job": "Менеджер",
                "avatar": "/img/icon/contacts-person.png"
            },
            {
                "id": 19011,
                "email": "polyanskiy@mail.ru",
                "phone": "79161234567",
                "name": "Мария Васильева",
                "job": "Менеджер",
                "avatar": "/img/icon/contacts-person.png"
            }
        ],
        "labels": [
            {
                "id": 158,
                "name": "Тестирование",
                "color": "F7F0C5"
            },
            {
                "id": 159,
                "name": "Работает",
                "color": "F7F0C5"
            }
        ]
    }
}

Описание полей:

  • task_title - Название задачи - обязательное текстовое поле;
  • task_text - Информация о задаче - необязательное текстовое поле;
  • owner_id - Ответственный - обязательное поле. Id сотрудника, к которому нужно привязать задачу;
  • project_id - Проект - обязательное поле. Id проекта, в котором нужно создать задачу.
  • date_start - Дата начала задачи. Формат unix timestamp
  • date_end - Дата завершения задачи. Формат unix timestamp
  • remind_type - Время напоминания - необязательное поле.

    Может передаваться один из вариантов (числовое значение):

    без напоминания - 0 ,вовремя - 1 ,за час - 2 ,за неделю - 3 Если ничего не передано, сохранится вариант “без напоминания”

  • remind_method - Способ напоминания - необязательное поле. Но если “Время напоминания” не равно “без напоминания”, то способ напоминания должен быть обязательным.

    Может передаваться один или несколько из вариантов (массив строк):

    sms ,email ,call - звонок ,popup - всплывающее окно

  • lead_id - ID связанного лида - необязательное поле. ID лида, к которому нужно привязать задачу (как если бы она была создана из карточки лида)

  • observers - массив полей наблюдателей
    • id - id сотрудника,
    • email - электронный адрес,
    • phone - телефон,
    • name - имя сотрудника,
    • job - должность сотрудника,
    • avatar - аватар
  • labels массив полей меток:
    • id - ID метки
    • name - Наименование метки.
    • color - Цветовая маркировка метки.
  • visibility - Кто может видеть задачу: 0 - только я, 1 - все, 2 - только указанные в observers сотрудники.
  • status - Статус задачи: 0 - начата, 1 - выполнена.

Используется при:

Модель метки

В случае корректного токена и успешного выполнения запроса Вы получите следующий результат:

{
    "status": "success",
    "result": {
        "id": 1216,
        "name": "Очень важно",
        "color": "DCEBD8"
    }
}

Описание полей:

  • id - идентификатор метки;
  • name - название метки - обязательное текстовое поле;
  • color - цвет (HEX) метки - обязательное текстовое поле;

    для этого поля допустимо одно из значений:

DCEBD8

D2E4EB

F7D1D0

DDDDDD

FFD5C2

D1F3EC

E1D8ED

F7F0C5

Используется при: