Вы просматриваете старую версию данной страницы. Смотрите текущую версию.

Сравнить с текущим просмотр истории страницы

« Предыдущий Версия 5 Следующий »

Добавление кандидата

Метод: POST

Authorization: Bearer Token

URL https://cis.twin24.ai/api/v1/telephony/autoCallCandidate/single/batch

cURL 
curl ----location 'https://cis.twin24.ai/api/v1/telephony/autoCallCandidate/single/batch' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \ 
     --header 'authorization: Bearer TOKEN' \
     --data '{

  "callbackData": {
    "id_client": "123456"
  },
  "phone": [
    "79876543210",
    "79876543211"
  ],
  "botSettingsId": "a8c57dfe-...850d2e",
  "variables": [
    "Имя": "Тест",
    "Фамилия": "Тестов",
    "Отчество": "Тестович"
  ],
  "clientExternalId": "123",
  "autoCallTemplateId": "bb973460-....9d2d12196",
  "timezone": 25200,
  "checkPhone": true
}
'
Тело запроса в формате JSON 
{
  "callbackData": {
    "id_client": "123456"
  },
  "phone": [
    "79876543210",
    "79876543211"
  ],
  "botSettingsId": "a8c57dfe-...850d2e",
  "variables": [
    "Имя : Тест",
    "Фамилия: Тестов",
    "Отчество: Тестович"
  ],
  "clientExternalId": "123",
  "autoCallTemplateId": "bb973460-....9d2d12196",
  "timezone": 25200,
  "checkPhone": true
}

Описание параметров метода:

ПараметрТипОбязательностьОписание

phone

array of strings

Обязательно

Номера телефонов кандидата для обзвона.

variables

array of strings

Необязательно

Объект с переменными по кандидату.
Ограничений на количество нет, для примера указаны 3.

clientExternalId

string

Необязательно

Внешний идентификатор клиента

botSettingsId

string

Необязательно

Идентификатор сценария для создаваемого обзвона.

Если не указать, то используется сценарий указанный в шаблоне.

autoCallTemplateId

string

Необязательно

Идентификатор шаблона для создаваемого обзвона.

Если не указать, то выбирается из выставленного в ЛК шаблона "по умолчанию"

timezone

integer

Необязательно

Часовой пояс для обзвона. Указывается в секундах от -43200 до 43200

Если не указать, то часовой пояс выбирается автоматически по номеру кандидата.

callbackData

object

Необязательно

Объект с полями информации по кандидату, которую нужно вернуть в неизменном виде в хуке о результате звонка и результате обработки кандидата. Например: ID клиента или ID сделки.

checkPhone

boolean

Необязательно

Осуществление проверки номеров на корректность.


Ответ в формате JSON
{
    "id": {
        "identity": "bf1fee...70dc544"
    }
}

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

Поле

Тип

Обязательно

Описание

id

Object

Да

-

 identity

 string

 Да

Идентификатор задания на обзвон


  • Нет меток