Интерфейс API

GET /v1/zcrm/customers/<c_id>

Возвращает клиента по его ID.

Параметры адреса

• c_id — идентификатор клиента

Ответ

{
  "id": 65,
  "name": "Good company",
  "status": "company",
  "type": "client",
  "responsible_user_id": 20,
  "employees_count": "50",
  "comment": "",
  "country": "GB",
  "city": "London",
  "address": "",
  "zip": "",
  "website": "",
  "created_at": "2020-04-28 05:47:47",
  "created_by": 20,
  "lead_source": "manual",
  "lead_created_at": null,
  "lead_created_by": null,
  "phones": [
    {
      "type": "work",
      "phone": "+44123456789"
    }
  ],
  "contacts": [
    {
      "type": "email_work",
      "value": "good_company@example.com"
    }
  ],
  "labels": [
    {
      "id": 12,
      "label": "Best clients"
    }
  ],
  "custom_properties": [
    {
      "id": 18,
      "key": "loyalty",
      "title": "Loyalty",
      "value": "high"
    }
  ]
}

где:

• id — идентификатор клиента
• name — имя клиента
• status — статус клиента. Возможные значения:
  • individual — физ. лицо
  • company — компания
• type — тип клиента. Возможные значения:
  • potential — потенциальный клиент
  • client — клиент
  • reseller — реселлер
  • partner — партнёр
• responsible_user_id — ответственный (идентификатор пользователя)
• employees_count — кол-во сотрудников. Возможные значения:
  • 50 — меньше 50
  • 50_250 — 50 – 250
  • 250_500 — 250 – 500
• comment — описание клиента
• country — страна клиента. Двухбуквенный код (RU, US и т.д.)
• city — город клиента
• address — адрес клиента
• zip — почтовый индекс
• website — веб-сайт клиента
• created_at — дата и время создания клиента (в формате `YYYY-MM-DD HH:mm:ss`)
• created_by — кем был создан (идентификатор пользователя)
• lead_source — источник. Возможные значения:
  • manual — вручную
  • call_incoming — входящий звонок
  • call_outgoing — исходящий звонок
  • form — форма
• lead_created_at — дата и время создания лида, если клиент был создан из лида (в формате `YYYY-MM-DD HH:mm:ss`)
• lead_created_by — кем был создан лид, если клиент был создан из лида (идентификатор пользователя)
• phones — массив телефонных номеров клиента. Каждый номер содержит следующие поля:
  • type — тип номера. Возможные значения:
    • work — рабочий
    • personal — личный
  • phone — значение номера
• contacts — массив контактов клиента. Каждый контакт содержит следующие поля:
  • type — тип контакта. Возможные значения:
    • email_work — рабочий e-mail
    • email_personal — личный e-mail
    • skype
    • telegram
    • viber
    • whatsapp
  • value — значение контакта
• labels — массив тегов, назначенных клиенту. Каждый тег содержит следующие поля:
  • id — идентификатор тега
  • label — значение тега
• custom_properties — массив дополнительных свойств. Каждое дополнительное свойство содержит следующие поля:
  • id — идентификатор дополнительного свойства
  • key — уникальное имя дополнительного свойства
  • title — отображаемое название дополнительного свойства
  • value — значение дополнительного свойства

POST /v1/zcrm/customers

Создаёт нового клиента с указанными данными.

• customer — данные нового клиента. Структура клиента:

Параметры

{
    "name": "Good company",
    "status": "company",
    "type": "client",
    "responsible_user_id": 20,
    "employees_count": "50",
    "comment": "",
    "country": "GB",
    "city": "London",
    "address": "",
    "zip": "",
    "website": "",
    "lead_source": "manual",
    "phones": [
      {
        "type": "work",
        "phone": "+44123456789"
      }
    ],
    "contacts": [
      {
        "type": "email_work",
        "value": "good_company@example.com"
      }
    ],
    "labels": [
      { "id": 12 },
      { "id": 13 }
  ],
    "custom_properties": [
    {
        "id": 18,
        "value": "high"
      }
    ]
}

где:

• name — имя клиента
• status — статус клиента. Допустимые значения:
  • individual — физ. лицо
  • company — компания
• type — тип клиента. Допустимые значения:
  • potential — потенциальный клиент
  • client — клиент
  • reseller — реселлер
  • partner — партнёр
• responsible_user_id — ответственный (идентификатор пользователя)
• employees_count — кол-во сотрудников. Допустимые значения:
  • 50 — меньше 50
  • 50_250 — 50 – 250
  • 250_500 — 250 – 500
• comment — описание клиента
• country — страна клиента. Двухбуквенный код (RU, US и т.д.)
• city — город клиента
• address — адрес клиента
• zip — почтовый индекс
• website — веб-сайт клиента
• lead_source — источник. Допустимые значения:
  • manual — вручную
  • call_incoming — входящий звонок
  • call_outgoing — исходящий звонок
  • form — форма
• phones — массив телефонных номеров. Каждый номер должен содержать следующие поля:
  • type — тип номера. Возможные значения:
    • work — рабочий
    • personal — личный
  • phone — значение номера
• contacts — массив контактов клиента. Каждый контакт должен содержать следующие поля:
  • type — тип контакта. Возможные значения:
    • email_work — рабочий e-mail
    • email_personal — личный e-mail
    • skype
    • telegram
    • viber
    • whatsapp
  • value — значение контакта
• labels — массив тегов, добавляемых к клиенту. Каждый элемент должен содержать:
  • id — идентификатор существующего тега
• custom_properties — массив дополнительных свойств. Каждый элемент должен содержать:
  • id — идентификатор дополнительного свойства либо:
  • key — уникальное имя дополнительного свойства
  • value — значение дополнительного свойства

Ответ:

{
"id": 65
}

где:

• id — идентификатор созданного клиента

PUT /v1/zcrm/customers/<c_id>

Обновляет существующего клиента с указанным ID.

Параметры адреса

• c_id — идентификатор клиента

Параметры

• customer — новые данные клиента. Структура клиента:

{
    "name": "Good company",
    "status": "company",
    "type": "client",
    "responsible_user_id": 20,
    "employees_count": "50",
    "comment": "",
    "country": "GB",
    "city": "London",
    "address": "",
    "zip": "",
    "website": "",
    "lead_source": "manual",
    "phones": [
      {
        "type": "work",
        "phone": "+44123456789"
      }
    ],
    "contacts": [
      {
        "type": "email_work",
        "value": "good_company@example.com"
      }
    ],
    "labels": [
      { "id": 12 },
      { "id": 13 }
  ],
    "custom_properties": [
    {
        "id": 18,
        "value": "high"
      }
    ]
}

где:

• name — имя клиента
• status — статус клиента. Допустимые значения:
  • individual — физ. лицо
  • company — компания
• type — тип клиента. Допустимые значения:
  • potential — потенциальный клиент
  • client — клиент
  • reseller — реселлер
  • partner — партнёр
• responsible_user_id — ответственный (идентификатор пользователя)
• employees_count — кол-во сотрудников. Допустимые значения:
  • 50 — меньше 50
  • 50_250 — 50 – 250
  • 250_500 — 250 – 500
• comment — описание клиента
• country — страна клиента. Двухбуквенный код (RU, US и т.д.)
• city — город клиента
• address — адрес клиента
• zip — почтовый индекс
• website — веб-сайт клиента
• lead_source — источник. Допустимые значения:
  • manual — вручную
  • call_incoming — входящий звонок
  • call_outgoing — исходящий звонок
  • form — форма
• phones — массив телефонных номеров. Каждый номер должен содержать следующие поля:
  • type — тип номера. Возможные значения:
    • work — рабочий
    • personal — личный
  • phone — значение номера
• contacts — массив контактов клиента. Каждый контакт должен содержать следующие поля:
  • type — тип контакта. Возможные значения:
    • email_work — рабочий e-mail
    • email_personal — личный e-mail
    • skype
    • telegram
    • viber
    • whatsapp
  • value — значение контакта
• labels — массив тегов, добавляемых к клиенту. Каждый элемент должен содержать:
  • id — идентификатор существующего тега
• custom_properties — массив дополнительных свойств. Каждый элемент должен содержать:
  • id — идентификатор дополнительного свойства либо:
  • key — уникальное имя дополнительного свойства
  • value — значение дополнительного свойства

DELETE /v1/zcrm/customers/<c_id>

Удаляет клиента по его ID.

Параметры адреса

• c_id — идентификатор клиента

GET /v1/zcrm/customers/labels

Возвращает список всех тегов и статистику по ним.

Ответ

{
  "totalCount": 5,
  "labels": [
    {
      "id": 12,
      "label": "Best clients",
      "count": 14
    }
  ]
}

где:

• totalCount — общее кол-во тегов в системе
• labels — массив тегов. Каждый тег имеет следующие поля:
  • id — идентификатор тега
  • label — имя тега
  • count — кол-во клиентов и лидов, использующих данный тег

POST /v1/zcrm/customers/labels

Создаёт новый тег.

Параметры

• name — имя нового тега

Ответ

{
  "id": 13,
  "label": "Best clients",
  "count": 0
}

где:

• id — идентификатор созданного тега
• label — имя тега
• count — кол-во клиентов и лидов, использующих данный тег (здесь всегда равен 0)

DELETE /v1/zcrm/customers/labels/<l_id>

Удаляет тег из системы по его ID.

Параметры адреса

• l_id — идентификатор тега

GET /v1/zcrm/customers/custom-properties

Возвращает все дополнительные свойства.

Ответ

{
  "totalCount": 8,
  "customProperties": [
    {
      "id": 18,
      "key": "loyalty",
      "title": "Loyalty"
    }
  ]
}

где:

• totalCount — общее количество дополнительных свойств.
• customProperties — массив дополнительных свойств. Каждое дополнительное свойство содержит следующие поля:
  • id — идентификатор дополнительного свойства
  • key — уникальное имя дополнительного свойства
  • title — отображаемое название дополнительного свойства

GET /v1/zcrm/customers/<c_id>/feed

Возвращает записи в ленте клиента.

Параметры адреса

• c_id — идентификатор клиента

Ответ

{
  "totalCount": 17,
  "items": [
    {
      "id": 37825,
      "type": "note",
      "content": "Call to client",
      "time": "2020-06-08 06:55:02",
      "user_id": 20,
      "user_name": "John Smith",
      "call_id": null,
      "call_type": null,
      "call_status": null,
      "call_phone": null,
      "call_duration": null,
      "call_record": null,
      "call_contact_name": null,
      "attached_files": [
        {
          "file_id": 576,
          "original_filename": "filename.doc"
        }
      ]
    }
  ]
}

где:

• totalCount — общее количество записей
• items — массив записей. Каждая запись содержит следующие атрибуты:
  • id — идентификатор записи
  • type — тип записи. Возможные значения:
    • event — событие
    • note — текстовая заметка
    • call — звонок
  • content — содержимое записи. Если тип записи — заметка, этот атрибут содержит текстовое содержание заметки. Если тип записи — событие, этот атрибут содержит идентификатор события, например:
    • CUSTOMER_CREATED — событие создания клиента
    • LEAD_CREATED — событие создания лида
  • time — время записи в формате `YYYY-MM-DD hh:mm:ss`
  • user_id — идентификатор пользователя, создавшего запись
  • user_name — имя пользователя, создавшего запись
  • call_id — идентификатор звонка (если тип записи — звонок)
  • call_type — тип звонка. Возможные значения:
    • incoming — входящий звонок
    • outgoing — исходящий звонок
  • call_status — статус звонка. Возможные значения:
    • answer — успешный звонок
    • noanswer — без ответа
    • cancel — отменён
    • busy — занято
    • failed — не удался
  • call_phone — телефонный номер звонка
  • call_duration — длительность звонка в секундах
  • call_record — включена ли запись звонка
  • call_contact_name — имя контакта звонка
  • attached_files — массив прикреплённых к заметке файлов (если тип записи — заметка). Каждый элемент массива содержит следующие атрибуты:
    • file_id — идентификатор файла
    • original_filename — оригинальное имя файла

POST /v1/zcrm/customers/<c_id>/feed

Добавляет текстовую заметку в ленту клиента с возможностью прикрепления файлов.

Параметры адреса

• c_id — идентификатор клиента

Параметры

• content — текстовое содержание заметки
• files — массив прикрепляемых файлов

Ответ

{
  "id": 37825,
  "type": "note",
  "content": "Call to client",
  "time": "2020-06-08 06:55:02",
  "user_id": 20,
  "user_name": "John Smith",
  "attached_files": [
    {
      "file_id": 576,
      "original_filename": "filename.doc"
    }
  ]
}

где:

• id — идентификатор записи
• type — тип записи. В данном случае равен:
  • note — текстовая заметка
• content — текстовое содержание заметки
• time — время записи в формате `YYYY-MM-DD hh:mm:ss`
• user_id — идентификатор пользователя, создавшего запись
• user_name — имя пользователя, создавшего запись
• attached_files — массив прикреплённых к заметке файлов (если тип записи — заметка). Каждый элемент массива содержит следующие атрибуты:
  • file_id — идентификатор файла
  • original_filename — оригинальное имя файла

PUT /v1/zcrm/customers/<c_id>/feed/<i_id>

>Обновляет содержимое существующей текстовой заметки по её ID.

Параметры адреса

• c_id — идентификатор клиента
• i_id — идетификатор текстовой заметки

Параметры

• content — новый текст заметки

DELETE /v1/zcrm/customers/<c_id>/feed/<i_id>

Удаляет заметку в ленте клиента по её ID.

Параметры адреса

• c_id — идентификатор клиента
• i_id — идетификатор текстовой заметки

GET /v1/zcrm/customers/<c_id>/employees

Возвращает список сотрудников клиента по его ID.

Параметры адреса

• c_id — идентификатор клиента

Ответ

{
  "totalCount": 5,
  "employees": [
    {
      "id": 23,
      "customer_id": 11,
      "name": "John Smith",
      "position": "manager",
      "position_title": "",
      "comment": "",
      "phones": [
        {
          "type": "work",
          "phone": "+44123456789"
        }
      ],
      "contacts": [
        {
          "type": "email_work",
          "value": "john@example.com"
        }
      ]
    }
  ]
}

где:

• totalCount — кол-во сотрудников клиента
• employees — массив сотрудников клиента. Каждый элемент массива содержит следующие атрибуты:
  • id — идентификатор сотрудника
  • customer_id — идентификатор клиента, к которому привязан сотрудник
  • name — имя сотрудника
  • position — должность сотрудника. Возможные значения:
    • ceo — ген. директор
    • director — директор
    • manager — менеджер
    • sales_manager — менеджер по продажам
    • hr — HR
    • support — поддержка
    • custom — произвольная
  • position_title — наименование произвольной должности (для position = custom)
  • comment — описание сотрудника
  • phones — массив телефонных номеров сотрудника. Каждый номер содержит следующие поля:
    • type — тип номера. Возможные значения:
      • work — рабочий
      • personal — личный
    • phone — значение номера
  • contacts — массив контактов сотрудника. Каждый контакт содержит следующие поля:
    • type — тип контакта. Возможные значения:
      • email_work — рабочий e-mail
      • email_personal — личный e-mail
      • skype
      • telegram
      • viber
      • whatsapp
    • value — значение контакта

GET /v1/zcrm/customers/<c_id>/employees/<e_id>

Возвращает сотрудника клиента по его ID.

Параметры адреса

• c_id — идентификатор клиента
• e_id — идентификатор сотрудника

Ответ

{
  "id": 23,
  "customer_id": 11,
  "name": "John Smith",
  "position": "manager",
  "position_title": "",
  "comment": "",
  "phones": [
    {
      "type": "work",
      "phone": "+44123456789"
    }
  ],
  "contacts": [
    {
      "type": "email_work",
      "value": "john@example.com"
    }
  ]
}

где:

• id — идентификатор сотрудника
• customer_id — идентификатор клиента, к которому привязан сотрудник
• name — имя сотрудника
• position — должность сотрудника. Возможные значения:
  • ceo — ген. директор
  • director — директор
  • manager — менеджер
  • sales_manager — менеджер по продажам
  • hr — HR
  • support — поддержка
  • custom — произвольная
• position_title — наименование произвольной должности (для position = custom)
• comment — описание сотрудника
• phones — массив телефонных номеров сотрудника. Каждый номер содержит следующие поля:
  • type — тип номера. Возможные значения:
    • work — рабочий
    • personal — личный
  • phone — значение номера
• contacts — массив контактов сотрудника. Каждый контакт содержит следующие поля:
  • type — тип контакта. Возможные значения:
    • email_work — рабочий e-mail
    • email_personal — личный e-mail
    • skype
    • telegram
    • viber
    • whatsapp
  • value — значение контакта

POST /v1/zcrm/customers/<c_id>/employees

Создаёт и сохраняет нового сотрудника для заданного клиента.

Параметры адреса

• c_id — идентификатор клиента

Параметры

• employee — данные нового сотрудника. Структура сотрудника:

{
    "name": "John Smith",
    "position": "manager",
    "position_title": "",
    "comment": "",
    "phones": [
      {
        "type": "work",
        "phone": "+44123456789"
      }
    ],
    "contacts": [
      {
        "type": "email_work",
        "value": "john@example.com"
      }
    ]
  }

где:

• name — имя сотрудника
• position — должность сотрудника. Допустимые значения:
  • ceo — ген. директор
  • director — директор
  • manager — менеджер
  • sales_manager — менеджер по продажам
  • hr — HR
  • support — поддержка
  • custom — произвольная
• position_title — наименование произвольной должности (для position = custom)
• comment — описание сотрудника
• phones — массив телефонных номеров сотрудника. Каждый номер содержит следующие поля:
  • type — тип номера. Возможные значения:
    • work — рабочий
    • personal — личный
  • phone — значение номера
• contacts — массив контактов сотрудника. Каждый контакт содержит следующие поля:
  • type — тип контакта. Возможные значения:
    • email_work — рабочий e-mail
    • email_personal — личный e-mail
    • skype
    • telegram
    • viber
    • whatsapp
  • value — значение контакта

Ответ

{
  "id": 23
}

где:

• id — идентификатор нового сотрудника

PUT /v1/zcrm/customers/<c_id>/employees/<e_id>

Обновляет существующего сотрудника с указанным ID.

Параметры адреса

• c_id — идентификатор клиента
• e_id — идентификатор сотрудника

Параметры

• employee — новые данные сотрудника. Структура:

{
    "name": "John Smith",
    "position": "manager",
    "position_title": "",
    "comment": "",
    "phones": [
      {
        "type": "work",
        "phone": "+44123456789"
      }
    ],
    "contacts": [
      {
        "type": "email_work",
        "value": "john@example.com"
      }
    ]
}

где:

• name — имя сотрудника
• position — должность сотрудника. Допустимые значения:
  • ceo — ген. директор
  • director — директор
  • manager — менеджер
  • sales_manager — менеджер по продажам
  • hr — HR
  • support — поддержка
  • custom — произвольная
• position_title — наименование произвольной должности (для position = custom)
• comment — описание сотрудника
• phones — массив телефонных номеров сотрудника. Каждый номер содержит следующие поля:
  • type — тип номера. Возможные значения:
    • work — рабочий
    • personal — личный
  • phone — значение номера
• contacts — массив контактов сотрудника. Каждый контакт содержит следующие поля:
  • type — тип контакта. Возможные значения:
    • email_work — рабочий e-mail
    • email_personal — личный e-mail
    • skype
    • telegram
    • viber
    • whatsapp
  • value — значение контакта

DELETE /v1/zcrm/customers/<c_id>/employees/<e_id>

Удаляет сотрудника по его ID.

Параметры адреса

• c_id — идентификатор клиента
• e_id — идентификатор сотрудника

GET /v1/zcrm/events

Возвращает список задач.

Параметры

• search (необязательный) — строка поиска. Поиск осуществляется комбинированно по:
  
  • названию задач
  • описанию задач
  • комментарию к завершённым задачам
• filter (необязательный) — фильтр задач. Структура фильтра:
  

  {
      "responsible": 456,
      "createdBy": 456,
      "start": "2020-06-03 02:56:00",
      "end": "2020-06-12 02:56:00",
      "completed": 1
  }

  где:

  • responsible — ответственный (идентификатор пользователя)
  • createdBy — создал (идентификатор пользователя)
  • start — показать задачи, начинающиеся после указанного времени (в формате `YYYY-MM-DD hh:mm:ss`)
  • end — показать задачи, заканчивающиеся до указанного времени (в формате `YYYY-MM-DD hh:mm:ss`)
  • completed — установите в 1, чтобы показать в том числе завершённые задачи
• sort (необязательный) — сортировка задач. Структура параметра:
  

  {
      "attr": "start",
      "desc": 0
  }

  где:

  • attr — поле сортировки. Допустимые значения:
    • responsible — ответственный пользователь
    • title — название задачи
    • start — время начала задачи
    • end — время окончания задачи
  • desc — направление сортировки. Допустимые значения:
    • 0 — по возрастанию
    • 1 — по убыванию

Ответ

{
  "totalCount": 4,
  "events": [
    {
      "id": 40,
      "type": "task",
      "title": "Call to GoodCompany",
      "description": "",
      "start": "2020-05-26 09:00:00",
      "end": "2020-05-26 12:30:00",
      "allDay": false,
      "created_by": 234,
      "responsible_user": 234,
      "phone": "",
      "call_done": 0,
      "completed": 0,
      "completed_comment": "",
      "members": [234, 235],
      "customers": [
        {
          "id": 3486,
          "name": "GoodCompany",
          "status": "company",
          "type": "client",
          "lead_source": "manual",
          "lead_status": "not_processed",
          "contact_type": "customer"
        }
      ]
    }
  ]
}

где

• totalCount — общее кол-во задач
• events — массив задач. Каждая задача содержит следующие атрибуты:
  • id — идентификатор задачи
  • type — тип задачи. Возможные значения:
    • task — задача
    • call — звонок
  • title — название задачи
  • description — описание задачи (в формате Quill Delta: https://quilljs.com/docs/delta/)
  • start — дата и время начала задачи (в формате `YYYY-MM-DD hh:mm:ss`)
  • end — дата и время окончания задачи (в формате `YYYY-MM-DD hh:mm:ss`)
  • allDay — задача на весь день (`true` или `false`) — дата определяется параметром start
  • created_by — идентификатор пользователя, создавшего задачу
  • responsible_user — идентификатор пользователя, ответственного за задачу
  • phone — номер телефона для звонка (если тип задачи — звонок)
  • call_done — указывает, был ли осуществлён звонок
  • completed — указывает, что задача помечена как завершённая
  • completed_comment — комментарий к завершённой задаче
  • members — массив участников задачи (только идентификаторы пользователей)
  • customers — массив клиентов и лидов, прикреплённых к задаче. Каждый элемент массива содержит следующие поля:
    • id — идентификатор клиента / лида
    • name — имя клиента / лида
    • status — статус клиента. Возможные значения:
      • individual — физ. лицо
      • company — компания
    • type — тип клиента. Возможные значения:
      • potential — потенциальный клиент
      • client — клиент
      • reseller — реселлер
      • partner — партнёр
    • lead_source — источник лида. Возможные значения:
      • manual — вручную
      • call_incoming — входящий звонок
      • call_outgoing — исходящий звонок
      • form — форма
    • lead_status — статус лида. Возможные значения:
      • not_processed — не обработан
      • in_progress — в обработке
      • finished — завершён
    • contact_type — тип контакта. Возможные значения:
      • customer — клиент
      • lead — лид

GET /v1/zcrm/events/<event_id>

Возвращает задачу по её ID.

Ответ

{
  "id": 40,
  "type": "task",
  "title": "Call to GoodCompany",
  "description": "",
  "start": "2020-05-26 09:00:00",
  "end": "2020-05-26 12:30:00",
  "allDay": false,
  "created_by": 234,
  "responsible_user": 234,
  "phone": "",
  "call_done": 0,
  "completed": 0,
  "completed_comment": "",
  "members": [234, 235],
  "customers": [
    {
      "id": 3486,
      "name": "GoodCompany",
      "status": "company",
      "type": "client",
      "lead_source": "manual",
      "lead_status": "not_processed",
      "contact_type": "customer"
    }
  ]
}

где

• id — идентификатор задачи
• type — тип задачи. Возможные значения:
  • task — задача
  • call — звонок
• title — название задачи
• description — описание задачи (в формате Quill Delta: https://quilljs.com/docs/delta/)
• start — дата и время начала задачи (в формате `YYYY-MM-DD hh:mm:ss`)
• end — дата и время окончания задачи (в формате `YYYY-MM-DD hh:mm:ss`)
• allDay — задача на весь день (`true` или `false`)
• created_by — идентификатор пользователя, создавшего задачу
• responsible_user — идентификатор пользователя, ответственного за задачу
• phone — номер телефона для звонка (если тип задачи — звонок)
• call_done — указывает, был ли осуществлён звонок
• completed — указывает, что задача помечена как завершённая
• completed_comment — комментарий к завершённой задаче
• members — массив участников задачи (только идентификаторы пользователей)
• customers — массив клиентов и лидов, прикреплённых к задаче. Каждый элемент массива содержит следующие поля:
  • id — идентификатор клиента / лида
  • name — имя клиента / лида
  • status — статус клиента. Возможные значения:
    • individual — физ. лицо
    • company — компания
  • type — тип клиента. Возможные значения:
    • potential — потенциальный клиент
    • client — клиент
    • reseller — реселлер
    • partner — партнёр
  • lead_source — источник лида. Возможные значения:
    • manual — вручную
    • call_incoming — входящий звонок
    • call_outgoing — исходящий звонок
    • form — форма
  • lead_status — статус лида. Возможные значения:
    • not_processed — не обработан
    • in_progress — в обработке
    • finished — завершён
  • contact_type — тип контакта. Возможные значения:
    • customer — клиент
    • lead — лид

POST /v1/zcrm/events

Создаёт новую задачу с указанными данными.

Параметры

• event — данные новой задачи. Структура:

{
    "type": "task",
    "title": "Call to GoodCompany",
    "description": "",
    "start": "2020-05-26 09:00:00",
    "end": "2020-05-26 12:30:00",
    "allDay": false,
    "responsible_user": 234,
    "phone": "",
    "members": [234, 235],
    "customers": [3486, 3487]
}

где

• type — тип задачи. Допустимые значения:
  • task — задача
  • call — звонок
• title — название задачи
• description — описание задачи (в формате Quill Delta: https://quilljs.com/docs/delta/)
• start — дата и время начала задачи (в формате `YYYY-MM-DD hh:mm:ss`)
• end — дата и время окончания задачи (в формате `YYYY-MM-DD hh:mm:ss`)
• allDay — задача на весь день (`true` или `false`)
• responsible_user — идентификатор пользователя, ответственного за задачу
• phone — номер телефона для звонка (если тип задачи — звонок)
• members — массив участников задачи (только идентификаторы пользователей)
• customers — массив прикреплённых клиентов и лидов (только идентификаторы клиентов и лидов)

Ответ

{
  "id": 7216
}

где

• id — идентификатор созданной задачи

PUT /v1/zcrm/events/<event_id>

Обновляет существующую задачу с указанным ID.

Параметры

• event — новые данные задачи. Структура:

{
    "title": "Call to GoodCompany",
    "description": "",
    "start": "2020-05-26 09:00:00",
    "end": "2020-05-26 12:30:00",
    "allDay": false,
    "created_by": 234,
    "responsible_user": 234,
    "phone": "",
    "members": [234, 235],
    "customers": [3486, 3487]
}

где

• title — название задачи
• description — описание задачи (в формате Quill Delta: https://quilljs.com/docs/delta/)
• start — дата и время начала задачи (в формате `YYYY-MM-DD hh:mm:ss`)
• end — дата и время окончания задачи (в формате `YYYY-MM-DD hh:mm:ss`)
• allDay — задача на весь день (`true` или `false`)
• responsible_user — идентификатор пользователя, ответственного за задачу
• phone — номер телефона для звонка (если тип задачи — звонок)
• members — массив участников задачи (только идентификаторы пользователей)
• customers — массив прикреплённых клиентов и лидов (только идентификаторы клиентов и лидов)

POST /v1/zcrm/events/<event_id>/close

Завершает (закрывает) задачу.

Параметры

• comment (необязательный) — комментарий

DELETE /v1/zcrm/events/<event_id>

Удаляет задачу по её ID.

Нет параметров

GET /v1/zcrm/leads

Возвращает список лидов.

Параметры

• search (необязательный) — строка поиска. Поиск осуществляется комбинированно по:
  
  • имени лида
  • номерам телефонов лида
  • описанию лида
  • адресу и почтовому индексу
  • веб-сайту
  • адресам e-mail
  • мессенджерам
• filter (необязательный) — фильтр лидов. Структура фильтра:
  

  {
      "source": "call_incoming",
      "responsible": 32,
      "label": 12,
      "createdAfter": "2020-06-11 12:24:00",
      "createdBefore": "2020-06-26 12:24:00"
  }

где

• source — источник лида. Допустимые значения:
  • manual — добавлен вручную
  • call_incoming — входящий звонок
  • call_outgoing — исходящий звонок
  • form — форма обратной связи
• responsible — ответственный (идентификатор пользователя). Параметр также допускает специальные значения:
  • null — вернёт все назначенные кому-либо лиды
  • –1 — вернёт неразобранные лиды
  • –2 — вернёт все лиды (и назначенные, и неразобранные)
• label — тег (идентификатор)
• createdAfter — показать только лиды, созданные после указанного времени (формат: `YYYY-MM-DD hh:mm:ss`)
• createdBefore — показать только лиды, созданные до указанного времени (формат: `YYYY-MM-DD hh:mm:ss`)

• sort (необязательный) — сортировка лидов. Структура параметра:
  

  {
      "attr": "name",
      "desc": 0
  }

  где

  • attr — поле сортировки. Допустимые значения:
    • name — имя лида
    • lead_source — источник лида
    • lead_status — статус лида
    • responsible_user_id — ответственный пользователь
    • lead_created_at — время создания лида
  • desc — направление сортировки. Допустимые значения:
    • 0 — по возрастанию
    • 1 — по убыванию
• take (для постраничного вывода) — сколько лидов вернуть (по умолчанию 20)
• skip (для постраничного вывода) — сколько лидов пропустить (по умолчанию 0)

Ответ

{
  "totalCount": 100,
  "uncategorizedCount": 10,
  "leads": [
    {
      "id": 3486,
      "name": "GoodCompany",
      "responsible_user_id": 234,
      "employees_count": "50",
      "comment": "",
      "country": "GB",
      "city": "London",
      "address": "",
      "zip": "",
      "website": "",
      "lead_status": "not_processed",
      "lead_source": "manual",
      "lead_created_at": "2020-04-28 05:47:47",
      "lead_created_by": 234,
      "phones": [
        {
          "type": "work",
          "phone": "+44123456789"
        }
      ],
      "contacts": [
        {
          "type": "email_work",
          "value": "good_company@example.com"
        }
      ],
      "labels": [
        {
          "id": 22,
          "label": "Best clients"
        }
      ]
    }
  ]
}

где

• totalCount — общее кол-во найденных лидов (с учётом строки поиска и фильтра)
• uncategorizedCount — общее кол-во неразобранных лидов (с учётом поиска и фильтра)
• leads — массив лидов (с учётом постраничного вывода). Каждый элемент массива содержит следующие параметры:
  • id — идентификатор лида
  • name — имя лида
  • responsible_user_id — ответственный (идентификатор пользователя)
  • employees_count — кол-во сотрудников. Возможные значения:
    • 50 — меньше 50
    • 50_250 — 50 – 250
    • 250_500 — 250 – 500
  • comment — описание лида
  • country — страна лида. Двухбуквенный код (RU, US и т.д.)
  • city — город лида
  • address — адрес лида
  • zip — почтовый индекс
  • website — веб-сайт лида
  • lead_status — статус лида. Возможные значения:
    • not_processed — не обработан
    • in_progress — в обработке
    • finished — завершён
  • lead_source — источник лида. Возможные значения:
    • manual — вручную
    • call_incoming — входящий звонок
    • call_outgoing — исходящий звонок
    • form — форма
  • lead_created_at — дата и время создания лида (в формате `YYYY-MM-DD HH:mm:ss`)
  • lead_created_by — кем был создан лид (идентификатор пользователя)
  • phones — массив телефонных номеров лида. Каждый номер содержит следующие поля:
    • type — тип номера. Возможные значения:
      • work — рабочий
      • personal — личный
    • phone — значение номера
  • contacts — массив контактов лида. Каждый контакт содержит следующие поля:
    • type — тип контакта. Возможные значения:
      • email_work — рабочий e-mail
      • email_personal — личный e-mail
      • skype
      • telegram
      • viber
      • whatsapp
    • value — значение контакта
  • labels — массив тегов, назначенных лиду. Каждый тег содержит следующие поля:
    • id — идентификатор тега
    • label — значение тега

GET /v1/zcrm/leads/<lead_id>

Возвращает лид по его ID.

Ответ

{
  "id": 3486,
  "name": "GoodCompany",
  "responsible_user_id": 234,
  "employees_count": "50",
  "comment": "",
  "country": "GB",
  "city": "London",
  "address": "",
  "zip": "",
  "website": "",
  "lead_status": "not_processed",
  "lead_source": "manual",
  "lead_created_at": "2020-04-28 05:47:47",
  "lead_created_by": 234,
  "phones": [
    {
      "type": "work",
      "phone": "+44123456789"
    }
  ],
  "contacts": [
    {
      "type": "email_work",
      "value": "good_company@example.com"
    }
  ],
  "labels": [
    {
      "id": 22,
      "label": "Best clients"
    }
  ],
  "custom_properties": [
    {
      "id": 12,
      "key": "loyalty",
      "title": "Loyalty",
      "value": "high"
    }
  ]
}

где

• id — идентификатор лида
• name — имя лида
• responsible_user_id — ответственный (идентификатор пользователя)
• employees_count — кол-во сотрудников. Возможные значения:
  • 50 — меньше 50
  • 50_250 — 50 – 250
  • 250_500 — 250 – 500
• comment — описание лида
• country — страна лида. Двухбуквенный код (RU, US и т.д.)
• city — город лида
• address — адрес лида
• zip — почтовый индекс
• website — веб-сайт лида
• lead_status — статус лида. Возможные значения:
  • not_processed — не обработан
  • in_progress — в обработке
  • finished — завершён
• lead_source — источник лида. Возможные значения:
  • manual — вручную
  • call_incoming — входящий звонок
  • call_outgoing — исходящий звонок
  • form — форма
• lead_created_at — дата и время создания лида (в формате `YYYY-MM-DD HH:mm:ss`)
• lead_created_by — кем был создан лид (идентификатор пользователя)
• phones — массив телефонных номеров лида. Каждый номер содержит следующие поля:
  • type — тип номера. Возможные значения:
    • work — рабочий
    • personal — личный
  • phone — значение номера
• contacts — массив контактов лида. Каждый контакт содержит следующие поля:
  • type — тип контакта. Возможные значения:
    • email_work — рабочий e-mail
    • email_personal — личный e-mail
    • skype
    • telegram
    • viber
    • whatsapp
  • value — значение контакта
• labels — массив тегов, назначенных лиду. Каждый тег содержит следующие поля:
  • id — идентификатор тега
  • label — значение тега

POST /v1/zcrm/leads

Создаёт новый лид с указанными данными.

Параметры

• convert — сконвертировать лид в клиента. Допустимые значения:
  
  • 0 — не конвертировать, создать лид
  • 1 — создать клиента
  • 2 — некачественный (операция будет отменена — ни лид, ни клиент не будут созданы)
• lead — данные нового лида. Структура лида:
  

  {
      "name": "GoodCompany",
      "responsible_user_id": 234,
      "employees_count": "50",
      "comment": "",
      "country": "RU",
      "city": "Москва",
      "address": "",
      "zip": "",
      "website": "",
      "lead_source": "manual",
      "lead_status": "in_progress",
      "phones": [
        {
          "type": "work",
          "phone": "+44123456789"
        }
      ],
      "contacts": [
        {
          "type": "email_work",
          "value": "good_company@example.com"
        }
      ],
      "labels": [
        { "id": 22 },
        { "id": 23 }
    ],
      "custom_properties": [
      {
          "id": 12,
          "value": "high"
        }
      ]
  }

  где

  • name — имя лида
  • responsible_user_id — ответственный (идентификатор пользователя)
  • employees_count — кол-во сотрудников. Допустимые значения:
    • 50 — меньше 50
    • 50_250 — 50 – 250
    • 250_500 — 250 – 500
  • comment — описание лида
  • country — страна лида. Двухбуквенный код (RU, US и т.д.)
  • city — город лида
  • address — адрес лида
  • zip — почтовый лида
  • website — веб-сайт лида
  • lead_source — источник лида. Допустимые значения:
    • manual — вручную
    • call_incoming — входящий звонок
    • call_outgoing — исходящий звонок
    • form — форма
  • lead_status — статус лида. Допустимые значения:
    • not_processed — не обработан
    • in_progress — в обработке
    • finished — завершён
  • phones — массив телефонных номеров. Каждый номер должен содержать следующие поля:
    • type — тип номера. Возможные значения:
      • work — рабочий
      • personal — личный
    • phone — значение номера
  • contacts — массив контактов лида. Каждый контакт должен содержать следующие поля:
    • type — тип контакта. Возможные значения:
      • email_work — рабочий e-mail
      • email_personal — личный e-mail
      • skype
      • telegram
      • viber
      • whatsapp
    • value — значение контакта
  • labels — массив тегов, добавляемых к лиду. Каждый элемент должен содержать:
    • id — идентификатор существующего тега
    • custom_properties — массив дополнительных свойств. Каждый элемент должен содержать:
      • id — идентификатор дополнительного свойства либо:
      • key — уникальное имя дополнительного свойства
      • value — значение дополнительного свойства

Ответ

{
  "id": 123
}

где

• id — идентификатор созданного лида

PUT /v1/zcrm/leads/<lead_id>

Обновляет существующий лид с указанным ID.

Параметры

• convert — сконвертировать лид в клиента. Допустимые значения:
  
  • 0 — не конвертировать
  • 1 — создать клиента
  • 2 — некачественный (удалить лид)
• lead — новые данные лида. Структура лида:

{
    "name": "GoodCompany",
    "responsible_user_id": 234,
    "employees_count": "50",
    "comment": "",
    "country": "GB",
    "city": "London",
    "address": "",
    "zip": "",
    "website": "",
    "lead_source": "manual",
    "lead_status": "in_progress",
    "phones": [
      {
        "type": "work",
        "phone": "+44123456789"
      }
    ],
    "contacts": [
      {
        "type": "email_work",
        "value": "good_company@example.com"
      }
    ],
    "labels": [
      { "id": 22 },
      { "id": 23 }
  ],
    "custom_properties": [
    {
        "id": 12,
        "value": "high"
      }
    ]
}

где

• name — имя лида
• responsible_user_id — ответственный (идентификатор пользователя)
• employees_count — кол-во сотрудников. Допустимые значения:
  • 50 — меньше 50
  • 50_250 — 50 – 250
  • 250_500 — 250 – 500
• comment — описание лида
• country — страна лида. Двухбуквенный код (RU, US и т.д.)
• city — город лида
• address — адрес лида
• zip — почтовый лида
• website — веб-сайт лида
• lead_source — источник лида. Допустимые значения:
  • manual — вручную
  • call_incoming — входящий звонок
  • call_outgoing — исходящий звонок
  • form — форма
• lead_status — статус лида. Допустимые значения:
  • not_processed — не обработан
  • in_progress — в обработке
  • finished — завершён
• phones — массив телефонных номеров. Каждый номер должен содержать следующие поля:
  • type — тип номера. Возможные значения:
    • work — рабочий
    • personal — личный
  • phone — значение номера
• contacts — массив контактов лида. Каждый контакт должен содержать следующие поля:
  • type — тип контакта. Возможные значения:
    • email_work — рабочий e-mail
    • email_personal — личный e-mail
    • skype
    • telegram
    • viber
    • whatsapp
  • value — значение контакта
• labels — массив тегов, добавляемых к лиду. Каждый элемент должен содержать:
  • id — идентификатор существующего тега
• custom_properties — массив дополнительных свойств. Каждый элемент должен содержать:
  • id — идентификатор дополнительного свойства либо:
  • key — уникальное имя дополнительного свойства
  • value — значение дополнительного свойства

DELETE /v1/zcrm/leads/<lead_id>

Удаляет лид по его ID.

Нет параметров

GET /v1/zcrm/users

Возвращает список пользователей.

Ответ

{
  "totalCount": 2,
  "users": [
    {
      "id": 234,
      "email": "john_smith@example.com",
      "name": "John Smith",
      "group_id": 653,
      "is_superadmin": 1,
      "enabled": 1,
      "created_at": "2020-04-27 01:01:31",
      "avatar": 2457,
      "role": "",
      "status": "",
      "language": "en",
      "color": "220",
      "color_hex": "5678BD",
      "internal_number": "100",
      "timezone": "Europe/London",
      "first_day": 1,
      "device": "webphone",
      "phone_widget_location": "right",
      "phones": [
        {
          "phone": "+44123456789",
          "type": "work"
        }
      ],
      "contacts": [
        {
          "type": "email_work",
          "value": "smith@example.com"
        }
      ]
    }
  ]
}

где

• totalCount — общее кол-во пользователей
• users — массив пользователей. Каждый элемент массива содержит следующие атрибуты:
  • id — идентификатор пользователя
  • email — e-mail аккаунта пользователя
  • name — имя пользователя
  • group_id — идентификатор группы пользователя
  • is_superadmin — указывает, является ли пользователь суперадминистратором (1 либо 0)
  • enabled — разблокирован ли пользователь (1 либо 0)
  • created_at — дата и время создания пользователя (в формате `YYYY-MM-DD hh:mm:ss`)
  • avatar — аватар пользователя (идентификатор файла)
  • role — должность пользователя
  • status — статус пользователя
  • language — язык интерфейса пользователя. Возможные варианты:
    • de — немецкий
    • en — английский
    • es — испанский
    • pl — польский
    • ru — русский
    • ua — украинский
  • color — цвет пользователя в интерфейсе ZCRM (только значение hue — от 0 до 359)
  • color_hex — цвет пользователя в интерфейсе ZCRM (hex-представление)
  • internal_number — внутренний номер АТС пользователя
  • timezone — временная зона пользователя
  • first_day — определяет, какой день недели является началом недели:
    • 0 — воскресенье
    • 1 — понедельник
  • device — что используется для звонков. Возможные значения:
    • webphone — веб-телефон
    • softphone — сторонний софтфон
  • phone_widget_location — расположение виджета веб-телефона. Возможные значения:
    • left — располагать виджет телефона слева
    • right — располагать виджет телефона справа
  • phones — массив телефонных номеров пользователя. Каждый номер содержит следующие поля:
    • phone — значение номера
    • type — тип номера. Возможные значения:
      • work — рабочий
      • personal — личный
  • contacts — массив контактов пользователя. Каждый контакт содержит следующие поля:
    • type — тип контакта. Возможные значения:
      • email_work — рабочий контактный e-mail
      • email_personal — личный контактный e-mail
      • skype
      • telegram
      • viber
      • whatsapp
    • value — значение контакта

GET /v1/zcrm/users/<user_id>

Возвращает пользователя по его ID.

Ответ

{
  "id": 234,
  "email": "john_smith@example.com",
  "name": "John Smith",
  "group_id": 653,
  "is_superadmin": 1,
  "enabled": 1,
  "created_at": "2020-04-27 01:01:31",
  "avatar": 2457,
  "role": "",
  "status": "",
  "language": "ru",
  "color": "220",
  "color_hex": "5678BD",
  "internal_number": "100",
  "timezone": "Europe/London",
  "first_day": 1,
  "device": "webphone",
  "phone_widget_location": "right",
  "phones": [
    {
      "phone": "+44123456789",
      "type": "work"
    }
  ],
  "contacts": [
    {
      "type": "email_work",
      "value": "smith@example.com"
    }
  ],
  "pending_email_change_request": false
}

где

• id — идентификатор пользователя
• email — e-mail аккаунта пользователя
• name — имя пользователя
• group_id — идентификатор группы пользователя
• is_superadmin — указывает, является ли пользователь суперадминистратором (1 либо 0)
• enabled — разблокирован ли пользователь (1 либо 0)
• created_at — дата и время создания пользователя (в формате `YYYY-MM-DD hh:mm:ss`)
• avatar — аватар пользователя (идентификатор файла)
• role — должность пользователя
• status — статус пользователя
• language — язык интерфейса пользователя. Возможные варианты:
  • de — немецкий
  • en — английский
  • es — испанский
  • pl — польский
  • ru — русский
  • ua — украинский
• color — цвет пользователя в интерфейсе ZCRM (только значение hue — от 0 до 359)
• color_hex — цвет пользователя в интерфейсе ZCRM (hex-представление)
• internal_number — внутренний номер АТС пользователя
• timezone — временная зона пользователя
• first_day — определяет, какой день недели является началом недели:
  • 0 — воскресенье
  • 1 — понедельник
• device — что используется для звонков. Возможные значения:
  • webphone — веб-телефон
  • softphone — сторонний софтфон
• phone_widget_location — расположение виджета веб-телефона. Возможные значения:
  • left — располагать виджет телефона слева
  • right — располагать виджет телефона справа
• phones — массив телефонных номеров пользователя. Каждый номер содержит следующие поля:
  • phone — значение номера
  • type — тип номера. Возможные значения:
    • work — рабочий
    • personal — личный
• contacts — массив контактов пользователя. Каждый контакт содержит следующие поля:
  • type — тип контакта. Возможные значения:
    • email_work — рабочий контактный e-mail
    • email_personal — личный контактный e-mail
    • skype
    • telegram
    • viber
    • whatsapp
  • value — значение контакта
• pending_email_change_request — если был отправлен запрос на изменение e-mail аккаунта, но запрос пока не подтверждён, этот параметр будет установлен в true

GET /v1/zcrm/users/<user_id>/working-hours

Возвращает рабочие часы пользователя.

Ответ

{
  "schedulePeriod": 7,
  "scheduleWorkingHours": [
    {
      "time_start": "2020-06-15 09:00:00",
      "time_end": "2020-06-15 18:00:00"
    }
  ],
  "scheduleFixes": [
    {
      "index": 2,
      "repeat_index": 1,
      "time_start": "2020-06-24 09:00:00",
      "time_end": "2020-06-24 13:00:00",
      "deleted": 0
    }
  ],
  "customWorkingHours": [
    {
      "time_start": "2020-06-27 11:00:00",
      "time_end": "2020-06-27 15:00:00"
    }
  ]
}

где

• schedulePeriod — периодичность расписания, как оно повторяется. Для обычной рабочей недели это 7 дней, для графика «день через день» это 2 дня и т.д.
• scheduleWorkingHours — массив рабочих периодов. Каждый рабочий период содержит соедующие атрибуты:
  • time_start — начало рабочего времени в формате `YYYY-MM-DD hh:mm:ss`
  • time_end — конец рабочего времени в формате `YYYY-MM-DD hh:mm:ss`
• scheduleFixes — массив изменений, внесённых в рабочие периоды, определённые в параметре scheduleWorkingHours. Каждый элемент массива содержит следующие атрибуты:
  • index — индекс элемента в scheduleWorkingHours, т.е. какой рабочий период изменён
  • repeat_index — индекс повтора расписания, в котором происходит изменение рабочего периода
  • time_start — новое начало рабочего времени в формате `YYYY-MM-DD hh:mm:ss`
  • time_end — новый конец рабочего времени в формате `YYYY-MM-DD hh:mm:ss`
  • deleted — если равен 1, рабочий период полностью удалён
• customWorkingHours — массив пользовательских, единичных рабочих периодов. Каждый рабочий период содержит соедующие атрибуты:
  • time_start — начало рабочего времени в формате `YYYY-MM-DD hh:mm:ss`
  • time_end — конец рабочего времени в формате `YYYY-MM-DD hh:mm:ss`

GET /v1/zcrm/users/groups

Возвращает группы и права пользователей каждой из них.

Ответ

{
  "totalCount": 4,
  "groups": [
    {
      "id": 45,
      "type": "manager",
      "title": "",
      "permissions": {
        "customers_create": true,
        "customers_edit": true,
        "customers_delete": true,
        "customers_import_export": true,
        "customers_view_all": false,
        "calendar_other_users_access": false,
        "calls_other_users_access": false,
        "leads_view": false,
        "leads_edit": false,
        "leads_delete": false,
        "leads_import_export": false,
        "team_add": false,
        "team_edit": false
      }
    }
  ]
}

где

• totalCount — общее количество групп
• groups — массив групп. Каждая группа содержит следующие атрибуты:
  
  • id — идентификатор группы
  • type — тип группы. Возможные значения:
    • admin — администраторы
    • manager — менеджеры
    • chat_operator — операторы
    • trainee — стажёры
    • custom — пользовательская
  • title — имя пользовательской группы (для type = custom)
  • permissions — права пользователей группы. Администраторы имеют полный доступ, поэтому для администраторов данный объект будет пустым. Остальные группы содержат следующие атрибуты (каждый из которых может быть равен `true` или `false`):
    • customers_create — разрешено создание клиентов
    • customers_edit — разрешено редактирование клиентов
    • customers_delete — разрешено удаление клиентов
    • customers_import_export — разрешены импорт и экспорт клиентов
    • customers_view_all — разрешён просмотр всех клиентов, в том числе назначенных другим пользователям
    • calendar_other_users_access — разрешён просмотр задач других пользователей
    • calls_other_users_access — разрешён доступ к звонкам других пользователей
    • leads_view — разрешён просмотр лидов других пользователей
    • leads_edit — разрешено редактирование лидов других пользователей
    • leads_delete — разрешено удаление лидов других пользователей
    • leads_import_export — разрешены импорт и экспорт лидов
    • team_add — разрешено добавление и приглашение пользователей в команду
    • team_edit — разрешено редактирование пользователей

GET /v1/zcrm/calls

Возвращает список звонков.

Параметры

• search (необязательный) — строка поиска. Поиск осуществляется комбинированно по:
  
  • номерам телефонов
  • именам контактов (клиентов, сотрудников, лидов или пользователей)
• filter (необязательный) — фильтр звонков. Структура фильтра:
  

  {
      "user": 23,
      "type": "incoming",
      "status": "answer",
      "dateFrom": "2020-06-03 14:56:00",
      "dateTo": "2020-06-26 14:56:00"
  }

  где

  • user — пользователь (идентификатор)
  • type — тип звонка. Допустимые значения:
    • incoming — входящий звонок
    • outgoing — исходящий звонок
  • status — статус звонка. Допустимые значения:
    • answer — успешный звонок
    • noanswer — без ответа
    • cancel — отменён
    • busy — занято
    • failed — не удался
  • dateFrom — показать только звонки, совершённые после указанного времени (формат: `YYYY-MM-DD hh:mm:ss`)
  • dateTo — показать только звонки, совершённые до указанного времени (формат: `YYYY-MM-DD hh:mm:ss`)

• sort (необязательный) — сортировка звонков. Структура параметра:
  

    {
      "attr": "time",
      "desc": 0
    }

  где

  • attr — поле сортировки. Допустимые значения:
    • phone — номер телефона
    • status — статус звонка
    • duration — длительность звонка
    • time — время звонка
  • desc — направление сортировки. Допустимые значения:
    • 0 — по возрастанию
    • 1 — по убыванию
• take (для постраничного вывода) — сколько звонков вернуть (по умолчанию 20)
• skip (для постраничного вывода) — сколько звонков пропустить (по умолчанию 0)

Ответ

{
  "totalCount": 233,
  "calls": [
    {
      "id": 127,
      "type": "outgoing",
      "status": "answer",
      "phone": "+44123456789",
      "user_id": 179,
      "time": "2019-07-31 17:58:40",
      "duration": 9,
      "pbx_call_id": "out_807ghh1h7f09fa7a188dbf8a6998b1c9ghg4ij06",
      "record": 1,
      "record_url_till": "2020-07-24 20:08:10",
      "contact_type": "customer",
      "contact_name": "GoodCompany",
      "contact_customer_id": 3486,
      "contact_employee_id": null,
      "employee_customer_id": null,
      "contact_user_id": null,
      "is_lead": 1,
      "record_urls": [
        {
          "url": "https://api.zadarma.com/v1/pbx/record/download/[...]/[...]/[...].mp3"
        }
      ]
    }
  ]
}

где

• totalCount — общее количество звонков (с учётом строки поиска и фильтра)
• calls — массив звонков (с учётом постраничного вывода). Каждый элемент массива содержит следующие параметры:
  
  • id — идентификатор звонка
  • type — тип звонка. Возможные значения:
    • incoming — входящий звонок
    • outgoing — исходящий звонок
  • status — статус звонка. Возможные значения:
    • answer — успешный звонок
    • noanswer — без ответа
    • cancel — отменён
    • busy — занято
    • failed — не удался
  • phone — телефонный номер
  • user_id — пользователь, инициировавший или принявший звонок
  • time — время звонка в формате `YYYY-MM-DD hh:mm:ss`
  • duration — длительность звонка в секундах
  • pbx_call_id — идентификатор звонка в АТС Zadarma
  • record — включена ли запись звонка
  • record_url_till — время, до которого ссылка на запись разговора будет работать
  • contact_type — тип контакта. Возможные значения:
    • customer — клиент или лид (см. параметр is_lead)
    • employee — сотрудник клиента
    • user — пользователь
  • contact_name — имя контакта
  • contact_customer_id — идентификатор клиента или лида (если звонок связан с клиентом)
  • contact_employee_id — идентификатор сотрудника (если звонок связан с сотрудником)
  • employee_customer_id — идентификатор родительской сущности (если звонок связан с сотрудником)
  • contact_user_id — идентификатор пользователя (если звонок связан с пользователем)
  • is_lead — показывает, связан ли звонок с лидом
  • record_urls — массив записей разговора (может отсутствовать, т.к. должен быть специально запрошен). Каждый элемент массива — объект, содержащий след. поле:
    • url — ссылка на запись разговора

GET /v1/zcrm/contacts

Возвращает список всех контактов (клиенты, сотрудники, лиды, пользователи) с номерами телефонов.

Параметры

• search (необязательный) — строка поиска. Поиск осуществляется комбинированно по:
  
  • именам и телефонам клиентов, лидов, сотрудников и пользователей
  • внутренним номерам АТС пользователей
• take (для постраничного вывода) — сколько контактов вернуть (по умолчанию 20)
• skip (для постраничного вывода) — сколько контактов пропустить (по умолчанию 0)

Ответ

{
  "totalCount": 128,
  "contacts": [
    {
      "contact_type": "customer",
      // clients attributes...
    },
    {
      "contact_type": "employee",
      // employee attributes...
    },
    {
      "contact_type": "lead",
      // leads attributes...
    },
    {
      "contact_type": "user",
      // users attributes...
    }
  ]
}

где

• totalCount — общее кол-во контактов (с учётом строки поиска)
• contacts — массив контактов. Каждый из контактов в зависимости от его типа (клиент, сотрудник, лид, пользователь) будет иметь собственный набор атрибутов.
  

  Клиент

  {
      "contact_type": "customer",
      "id": 3486,
      "name": "GoodCompany",
      "status": "company",
      "type": "client",
      "phone": {
        "phone": "+44123456789",
        "type": "work"
      },
      "responsible": {
        "id": 234,
        "name": "John Smith",
        "ext_num": "100"
      }
  }

  где

  • contact_type — тип контакта:
    • customer — клиент
  • id — идентификатор клиента
  • name — имя клиента
  • status — статус клиента. Возможные значения:
    • individual — физ. лицо
    • company — компания
  • type — тип клиента. Возможные значения:
    • potential — потенциальный клиент
    • client — клиент
    • reseller — реселлер
    • partner — партнёр
  • phone — телефонный номер. Содержит следующие поля:
    • phone — непосредственно номер
    • type — тип номера. Возможные значения:
      • work — рабочий
      • personal — личный
  • responsible — ответственный пользователь. Содержит следующие поля:
    • id — идентификатор пользователя
    • name — имя пользователя
    • ext_num — внутренний номер АТС пользователя

  Сотрудник клиента

  {
          "contact_type": "employee",
          "id": 8,
          "name": "John Smith",
          "phone": {
            "phone": "+44123456789",
            "type": "work"
          },
          "position": {
            "position": "manager",
            "title": ""
          },
          "customer": {
            "id": 3486,
            "name": "GoodCompany"
          },
          "responsible": {
            "id": 234,
            "name": "John Smith",
            "ext_num": "100"
          }
  }

  где

  • contact_type — тип контакта:
    • employee — сотрудник
  • id — идентификатор сотрудника
  • name — имя сотрудника
  • phone — телефонный номер. Содержит следующие поля:
    • phone — непосредственно номер
    • type — тип номера. Возможные значения:
      • work — рабочий
      • personal — личный
  • position — должность сотрудника. Содержит следующие поля:
    • position — значение должности. Возможные значения:
      • ceo — ген. директор
      • director — директор
      • manager — менеджер
      • sales_manager — менеджер по продажам
      • hr — HR
      • support — поддержка
      • custom — произвольная
    title — наименование произвольной должности (для position = custom)
  • customer — клиент, к которому прикреплён сотрудник. Содержит следующие поля:
    • id — идентификатор клиента
    • name — имя клиента
    • responsible — пользователь, ответственный за родительского клиента. Содержит следующие поля:
      • id — идентификатор пользователя
      • name — имя пользователя
      • ext_num — внутренний номер АТС пользователя

  Лид

  {
  "contact_type": "lead",
  "id": 3486,
  "name": "GoodCompany",
  "phone": {
    "phone": "+44123456789",
    "type": "work"
  },
  "responsible": {
    "id": 234,
    "name": "John Smith",
    "ext_num": "100"
  }
  }

  где

  • contact_type — тип контакта:
    • lead — лид
  • id — идентификатор лида
  • name — имя лида
  • phone — телефонный номер. Содержит следующие поля:
    • phone — непосредственно номер
    • type — тип номера. Возможные значения:
      • work — рабочий
      • personal — личный
  • responsible — ответственный пользователь. Содержит следующие поля:
    • id — идентификатор пользователя
    • name — имя пользователя
    • ext_num — внутренний номер АТС пользователя

  Пользователь

  {
      "contact_type": "user",
      "id": 234,
      "name": "John Smith",
      "avatar": 2457,
      "role": "",
      "status": "",
      "phone": {
        "phone": "100",
        "type": "internal"
      },
      "group": {
        "type": "admin",
        "title": ""
      }
    }

  где

  • contact_type — тип контакта:
    • user — пользователь
  • id — идентификатор пользователя
  • name — имя пользователя
  • avatar — аватар пользователя (идентификатор файла)
  • role — роль пользователя
  • status — статус пользователя
  • phone — телефонный номер. Содержит следующие поля:
    • phone — непосредственно номер
    • type — тип номера. Возможные значения:
      • work — рабочий
      • personal — личный
      • internal — внутренний номер АТС
  • group — группа пользователя. Содержит следующие поля:
    • type — тип группы. Возможные значения:
      • admin — администраторы
      • manager — менеджеры
      • chat_operator — операторы
      • trainee — стажёры
      • custom — пользовательская
    • title — имя пользовательской группы (для type = custom)

GET /v1/zcrm/contacts/identify

Идентифицирует контакт (клиента, сотрудника, лида, пользователя) по номеру телефона.

Параметры

• phone — телефонный номер

Ответ

Клиент

{
  "contact_type": "customer",
  "id": 3486,
  "name": "GoodCompany",
  "status": "company",
  "type": "client",
  "phone": {
    "phone": "+44123456789",
    "type": "work"
  },
  "responsible": {
    "id": 234,
    "name": "Jim Beam",
    "ext_num": "100"
  }
}

где

• contact_type — тип контакта:
  • customer — клиент
• id — идентификатор клиента
• name — имя клиента
• status — статус клиента. Возможные значения:
  • individual — физ. лицо
  • company — компания
• type — тип клиента. Возможные значения:
  • potential — потенциальный клиент
  • client — клиент
  • reseller — реселлер
  • partner — партнёр
• phone — телефонный номер. Содержит следующие поля:
  • phone — непосредственно номер
  • type — тип номера. Возможные значения:
    • work — рабочий
    • personal — личный
• responsible — ответственный пользователь. Содержит следующие поля:
  • id — идентификатор пользователя
  • name — имя пользователя
  • ext_num — внутренний номер АТС пользователя

Сотрудник клиента

{
  "contact_type": "employee",
  "id": 8,
  "name": "John Smith",
  "phone": {
    "phone": "+44123456789",
    "type": "work"
  },
  "position": {
    "position": "manager",
    "title": ""
  },
  "customer": {
    "id": 3486,
    "name": "GoodCompany"
  },
  "responsible": {
    "id": 234,
    "name": "Jim Beam",
    "ext_num": "100"
  }
}

где

• contact_type — тип контакта:
  • employee — сотрудник
• id — идентификатор сотрудника
• name — имя сотрудника
• phone — телефонный номер. Содержит следующие поля:
  • phone — непосредственно номер
  • type — тип номера. Возможные значения:
    • work — рабочий
    • personal — личный
• position — должность сотрудника. Содержит следующие поля:
  • position — значение должности. Возможные значения:
    • ceo — ген. директор
    • director — директор
    • manager — менеджер
    • sales_manager — менеджер по продажам
    • hr — HR
    • support — поддержка
    • custom — произвольная
  • title — наименование произвольной должности (для position = custom)
• customer — клиент, к которому прикреплён сотрудник. Содержит следующие поля:
  • id — идентификатор клиента
  • name — имя клиента
• responsible — пользователь, ответственный за родительского клиента. Содержит следующие поля:
  • id — идентификатор пользователя
  • name — имя пользователя
  • ext_num — внутренний номер АТС пользователя

Лид

{
  "contact_type": "lead",
  "id": 3486,
  "name": "GoodCompany",
  "phone": {
    "phone": "+44123456789",
    "type": "work"
  },
  "responsible": {
    "id": 234,
    "name": "Jim Beam",
    "ext_num": "100"
  }
}

где

• contact_type — тип контакта:
  • lead — лид
• id — идентификатор лида
• name — имя лида
• phone — телефонный номер. Содержит следующие поля:
  • phone — непосредственно номер
  • type — тип номера. Возможные значения:
    • work — рабочий
    • personal — личный
• responsible — ответственный пользователь. Содержит следующие поля:
  • id — идентификатор пользователя
  • name — имя пользователя
  • ext_num — внутренний номер АТС пользователя

Пользователь

{
  "contact_type": "user",
  "id": 234,
  "name": "John Smith",
  "avatar": 2457,
  "role": "",
  "status": "",
  "phone": {
    "phone": "100",
    "type": "internal"
  },
  "group": {
    "type": "admin",
    "title": ""
  }
}

где

• contact_type — тип контакта:
  • user — пользователь
• id — идентификатор пользователя
• name — имя пользователя
• avatar — аватар пользователя (идентификатор файла)
• role — роль пользователя
• status — статус пользователя
• phone — телефонный номер. Содержит следующие поля:
  • phone — непосредственно номер
  • type — тип номера. Возможные значения:
    • work — рабочий
    • personal — личный
    • internal — внутренний номер АТС
• group — группа пользователя. Содержит следующие поля:
  • type — тип группы. Возможные значения:
    • admin — администраторы
    • manager — менеджеры
    • chat_operator — операторы
    • trainee — стажёры
    • custom — пользовательская
  • title — имя пользовательской группы (для type = custom)

GET /v1/zcrm/files/<file_id>

Отдаёт файл по его ID.

Нет параметров