Метод: POST

Authorization: Bearer Token (Метод для получения токена по логину и паролю)

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

cURL 
curl ----location 'https://twin24.ai/cis/api/v1/telephony/autoCallCandidate/single/batch' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \ 
     --header 'authorization: Bearer TOKEN' \
     --data '{
	"batch": [
		{
			"callbackData": {
				"id_client": "123456"
			},
			"phone": [
				"79876543210",
				"79876543211"
			],
			"botSettingsId": "a8c57dfe-...850d2e",
			"variables": {
				"Имя": "Тест",
				"Фамилия": "Тестов",
				"Отчество": "Тестович"
			},
			"clientExternalId": "123",
			"autoCallTemplateId": "bb973460-....9d2d12196",
			"timezone": 25200,
			"checkPhone": true
		},
		{
			"callbackData": {
				"id_client": "78910"
			},
			"phone": [
				"79876543222",
				"79876543233"
			],
			"botSettingsId": "b3c33ffe-...012d25",
			"variables": {
				"Имя": "Тест2",
				"Фамилия": "Тестов2",
				"Отчество": "Тестович2"
			},
			"clientExternalId": "321",
			"autoCallTemplateId": "aa973370-....1c2d321312",
			"timezone": 25200,
			"checkPhone": false
		}
	]
}
'
Тело запроса в формате JSON 
{
	"batch": [
		{
			"callbackData": {
				"id_client": "123456"
			},
			"phone": [
				"79876543210",
				"79876543211"
			],
			"botSettingsId": "a8c57dfe-...850d2e",
			"variables": {
				"Имя": "Тест",
				"Фамилия": "Тестов",
				"Отчество": "Тестович"
			},
			"clientExternalId": "123",
			"autoCallTemplateId": "bb973460-....9d2d12196",
			"timezone": 25200,
			"checkPhone": true
		},
		{
			"callbackData": {
				"id_client": "78910"
			},
			"phone": [
				"79876543222",
				"79876543233"
			],
			"botSettingsId": "b3c33ffe-...012d25",
			"variables": {
				"Имя": "Тест2",
				"Фамилия": "Тестов2",
				"Отчество": "Тестович2"
			},
			"clientExternalId": "321",
			"autoCallTemplateId": "aa973370-....1c2d321312",
			"timezone": 25200,
			"checkPhone": false
		}
	]
}

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

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

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
[    
       [        
            {            
               "autoCallId": {                
                      "identity": "6c1b8040-aa75-.........-а741ad34d69d"
               },            
               "autoCallCandidateId": {                
                      "identity": "019c8e5e-1ааа-.........-5аf94939f9f0"           
               }        
             }    
       ]
]

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

Поле

Тип

Описание

autoCallCandidateId

Object

-

 identity

 string

Идентификатор кандидата

autoCallId

Object

-

identity

string

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


  • Нет меток