Получить список всех доступных групп

Описание: метод позволяет получить список всех доступных групп в системе КЦ

Method: GET

URL: /api/v1/groups/all.json

Описание полей: * - обязательные параметры

Поле тип значения описание

Возможные ответы:
При успешном запросе, сервер ответит HTTP статусом 200, и данными:

{
    "groups": [
        {
            "id": 839,
            "name": "Обзвон",
            "taskSelectionMode": "BY_PRIORITY"
        },
        {
            "id": 853,
            "name": "Обзвон - 2",
            "taskSelectionMode": "BY_ROUND"
        },
        {
            "id": 856,
            "name": "Неликвид",
            "taskSelectionMode": "BY_ROUND"
        },
        {
            "id": 943,
            "name": "Входящая",
            "taskSelectionMode": "BY_ROUND"
        }
    ]
}

Примеры неуспешного ответа (ошибок):

 

 


Создание веб рекола

Описание: метод позволяет создать веб рекол, с желаемой датой и временем перезвона

Method: POST

URL: /api/v1/webrecalls/exec.do

Данные запроса:

Поиск карточек клиента происходит по внешнему идентификатору клиента (если данный функционал был разрешен в recall задаче) или по номеру телефона. В случае, если система не нашла карточки клиента по внешнему идентификатору, поиск будет происходить по номеру телефона. Система создаст новую карточку клиента, если в базе данных КЦ отсутствует клиент с таким номером телефона. Структура JSON запроса при этом:

Описание полей: * - обязательные параметры

Поле тип значения описание
recalls* array() Массив с параметрами Web recall.
phone* string() Номер телефона на который создается Веб перезвон
accountId* integer() id аккаунта веб рекола. Как узнать этот параметр
callDate* string() желаемые дата и время звонка в ISO формате (2016-07-22T15:48:32+03:00). Может быть менше текущей даты, для немедленного звонка.
fullUrl string(25) Название поля, которое внесено в конфигурацию полей, разрешенных для передачи по тем или иным recall задачам. (даное название это пример) Узнать как формировать список доступных полей в запросе

Возможные ответы:
При успешном запросе, сервер ответит HTTP статусом 201, и данными с идентификатором id созданого пользователя: Created

Примеры неуспешного ответа (ошибок):

 

 


Отмена веб рекола

Описание: метод позволяет отменить предварительно созданный/заказанный веб реколл (например, если новый веб реколл имеет статус NEW и по нему должен произойти прозвон, то после выполнения запроса его статус изменится на EXPIRED и прозвон не произойдет)

Method: DELETE

URL: /api/v1/webrecalls/{webRecallId}/phones/{phoneNumber}.do

Описание полей: * - обязательные параметры

Поле тип значения описание
{accountId}* integer() id аккаунта веб рекола. Как узнать этот параметр
{phoneNumber}* string() Номер телефона для отмены перезвона

Возможные ответы:
При успешном запросе, сервер ответит HTTP статусом 200, и данными OK

Примеры неуспешного ответа (ошибок):

 

 


Авторизация на использование токенов

Описание: метод позволяет создать авторизационный токен на запросы к АРІ. При этом его нужно передавать http хедером x-auth-token с каждым запросом. Для получения token используется Basic авторизация (https://en.wikipedia.org/wiki/Basic_access_authentication#Client_side)

Method: POST

URL: /api/v1/tokens.do

Описание полей: * - обязательные параметры

Поле тип значения описание

Возможные ответы:
При успешном запросе, сервер ответит HTTP статусом 201,
Если авторизация прошла успешно, статус ответа должен быть 201 (Created), а хедер x-auth-token будет содержать уникальный токен вида 51f9a273-bf96-4fa5-b034-250567944e91, по которому пользователь будет авторизироваться для дальнейших запросов в систему. Время жизни token ограничено 30 минутами с момента последнего обращения к API.

Примеры неуспешного ответа (ошибок):