Комментирование лидов

Читать 7

Запрос

POST: https://api.calltouch.ru/lead-service/v1/api/comment/lead/add

HTTP-заголовки:

Access-Token – API-ключ
SiteId – ID ЛК Calltouch

Тело запроса в формате JSON:

{
    "comments": [

     // Лид 1

        {
            "matching": [
                {
                    "type": "request",
                    "requestParams": {
                        "requestId": 1,
                        "tags": ["тег1", "тег2"],
                        "tagsLogic": "and"
                    }
                },
                {
                    "type": "call",
                    "callParams": {
                        "callId": 2 ,
                        "tags": ["тег"],
                        "tagsLogic": "and"
                    }
                },
                {
                    "type": "requestContact",
                    "requestContactParams": {
                        "emails": ["name@server.com"],
                        "phones": ["79157771122", "+7 (915) 888-11-22"],
                        "date": "01-10-2020 12:00:00",
                        "tags": ["тег"],
                        "tagsLogic": "and",
                        "requestTypeToMatch": "nearestUniq",
                        "searchDepth": 120
                    },
                },
                {
                    "type": "callContact",
                    "callContactParams": {
                        "phones": ["84953338877"],
                        "date": "01-10-2020 12:00:00",
                        "tags": ["тег"],
                        "tagsLogic": "and",
                        "callTypeToMatch": "nearestUniqLead",
                        "searchDepth": 120
                        },
                },
                {
                    "type": "call",
                    "callParams": {
                        "callId": 2,
                        "tags": ["тег"],
                        "tagsLogic": "and"
                    }
                }
            ],
            "addComment": "Комментарий к лиду"
        },

     // Лид N

        ...
    ]
}

Параметры запроса

Параметр	Формат	Обязательный	Описание
comments	array	Да	Массив лидов для комментирования. Можно перечислить до 100 лидов за 1 запрос. Комментирование происходит в режиме онлайн, результат можно получить сразу же. Обязательно.
comments.matching	object	Да	Здесь задается приоритет использования разных типов матчинга, по которым мы будем пытаться найти лид для комментирования. Чем выше находится строка с типом матчинга, тем больший приоритет она имеет. Если матчинга завершится на каком-либо типе, остальные типы ниже будут проигнорированы. Одинаковые типы матчинга могут повторяться, но общее кол-во типов не должно превышать 20 строк.
comments.matching .type	string	Обязательно нужно указать хотя бы 1 тип матчинга в приоритете.	Тип матчинга. Возможные значения: call – поиск звонка по ID request – поиск заявки по ID callContact – поиск звонка по номеру телефона / дате requestContact – поиск заявки по номеру телефона / почте / дате leadContact - поиск лида по номеру телефона / почте / дате. Подробное описание полей в объекте matching в этой статье.
comments.addComment	string	Да	Добавление комментария к лиду. Любые символы, до 1000 символов.

Ответ

Процесс добавления комментария запускается сразу же после отправки запроса, после чего сразу же возвращается и ответ, пример:

{
    "meta": [],
    "data": {
        "comments": [
            {
                "callInfo": {
                    "callId": 12692441,
                    "callReferenceId": "test321",
                    "sipCallId": null
                },
                "requestInfo": null,
                "commented": true,
                "error": null
            }
        ]
    }
}

Параметры ответа

Параметр	Формат	Описание
data.comments[i].commented	boolean	Флаг комментирования лида. Возможные значения: true false
data.comments[i].callInfo	object	Если комментарий привоился звонку, то блок callInfo не пустой.
data.comments[i].callInfo.callId	string	ID звонка в Calltouch
data.comments[i].callInfo.callReferenceId	string	ID звонка из API-метода импорта звонков, может быть null
ldata.comments[i].callInfo.sipCallId	string	ID звонка с АТС
data.comments[i].requestInfo	object	Если комментарий привоился заявке, то блок requestInfo не пустой
data.comments[i].requestInfo.requestId	string	ID заявки в Calltouch
data.comments[i].requestInfo.requestNumber	string	ID заявки, переданный из формы сайта
data.comments[i].error	string	Отображется причина ошибки добавления комментария

Если в запросе обнаруживаются ошибки валидации, то комментирование не выполняется и выводится ошибка:

{
    "meta": [],
    "data": {
        "type": "validationError",
        "apiErrorData": null,
        "validationErrorData": {
            "violations": [{
                "fieldPath": "comments[0].addComment",
                "message": "This value should not be blank."
            }]
        }
    }
}

Если в запросе указаны некорректные авторизационные данные - то выводится ошибка. Список типовых ответов при запросах с некорректными авторизационными данными, или некорректными данными в теле API запроса вы можете посмотреть в этой статье

Система баллов API Calltouch

Система баллов API - механизм, регулирующий нагрузку на сервера Calltouch. Для каждого проекта выдается индивидуальное суточное количество баллов За каждый успешно выполненный запрос списываются баллы. Подробнее читайте в статье: Система баллов API Calltouch

Количество запросов в секунду к API Calltouch ограничено – не более 5 запросов в секунду с одного IP-адреса. Например, если в 1 секунду с одного IP-адреса поступит 11 API-запросов, то 5 выполнятся сразу, а остальные API-запросы завершатся с ошибкой.

Оцените статью