Удаление пользовательских полей из звонков, заявок и сделок

Читать 4

Описание

С помощью данного API метода можно удалять добавленные ранее пользовательские поля, у звонков, заявок и сделок.

Подробное про функционал пользовательских полей в API можно прочитать в статье: Пользовательские поля звонков, заявок и сделок в API.

Запрос

POST: 

https://api.calltouch.ru/lead-service/v1/api/customfield/delete

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

  • Access-Token — API-ключ;
  • SiteId — ID ЛК Calltouch.

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

Пример тела запроса

{
    callId: 123456,
    customFields: ["field1","field2"]
}

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

Параметр   Тип   Обязательный   Описание  
callId
callReferenceId
sipCallId
requestId
requestNumber
orderId
orderNumber  		string или number  Да, должен быть указан один из параметров  Идентификатор звонка, заявки или сделки, у которой необходимо удалить пользовательские поля. Доступные варианты:
  • callId - ID звонка в Calltouch;
  • callReferenceId- ID звонка из внешней системы;
  • sipCallId - ID звонка из sip;
  • requestId - ID заявки в Calltouch;
  • requestNumber - ID заявки из внешней системы;
  • orderId - ID сделки в Calltouch;
  • orderNumber - ID сделки из внешней системы.

Должен быть указан хотя бы один из параметров. Нельзя указывать сразу несколько параметров. 

customFields  array Да  Указания названий пользовательских полей в API, по которым необходимо удалить значение пользовательского поля у искомого звонка, заявки или сделки.

Можно указать несколько названий полей в массиве. Значения будут удалены у всех указанных полей. Максимум 20 полей.

Можно указывать только те пользовательские поля, которые были ранее настроены в ЛК (добавлены в настройках API). 

Ответ

Удаление пользовательских полей происходит сразу. В ответе API метода будет указан статус удаления.

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

{
  "callId":12345,"status":"success","message":""
}

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

Параметр   Формат   Описание  
callId
callReferenceId
sipCallId
requestId
requestNumber
orderId
orderNumber  		string или number Идентификатор звонка, заявки или сделки, по которому произвели удаление пользовательских полей. 
status  string 

Статус удаления. Возможные значения:

  • success - удаление прошло успешно;
  • failed - удаление прошло неуспешно.

Типовые ошибки

Если в искомом сайте указанное в запросе пользовательское поле не настроено в ЛК (не добавлено в настройках API), то в ответе будет содержимое вида:

{
  "customFields":['field1','field2'],"status":"failed","message":"Указанное пользовательское поле не используется в проекте"
}

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

{
  "callId":12345,"status":"failed","message":"Указанный звонок, заявка или сделка не найдена"
}

Ошибки валидации

Если один из входных параметров запроса некорректен и не прошел валидацию, то в ответе будет ошибка, указывающую на проблемное поле, с пояснением (с кодом 500). Пример: 

{
  "errorCode": "500",
  "message": "Поле callId должно быть числом."
}

Список типовых ответов при запросах с некорректными данными в теле API запроса вы можете посмотреть в этой статье.

Ошибки авторизации

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

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

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

За успешный вызов данного API метода списывается 2 балла. 

Количество запросов в секунду к API Calltouch ограничено — не более 5 запросов в секунду с одного IP-адреса. Например, если в 1 секунду с одного IP-адреса поступит 11 API-запросов, то 5 выполнятся сразу, а остальные API-запросы завершатся с ошибкой c кодом 429 (Too Many Requests).


Не нашли решение проблемы?
Заполните форму, и мы вам поможем.
Похожие статьи
Недавно просмoтренные