Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

URL: https://cis.twin24.ai/api/v1/telephony/autoCall



curl --location 'https://cis.twin24.ai/cis/api/v1/telephony/autoCall' \

--header 'accept: application/json' \

...

ПараметрПринимаемые значенияОписание
offset Целое число от 0

«Отступ» от начала записей. То есть с какой записи начинать вывод.

Смещение по позиции полученной информации.
Например, в заданное временное окно было 4 050 звонков. Сделав запрос, вы получили доступный максимум в виде 1 000 записей. Тогда вам нужно повторить запрос, с указанием последней полученной позиции. После получения 1 000 записей, «1 000» и есть наша последняя позиция. Получив еще раз максимальное количество, повторяем запрос, указав смещение уже на 2 000 позиций. 
Делаем смещение до тех пор, пока количество возвращенных данных не будет меньше запрошенного лимита.

page 

Целое число от 0

Номер «страницы» с записями. 
Например, если у вас есть 4 050 звонков и лимит вывода на одной странице составляет 1 000 записей, то на первой странице будут записи с номерами с 0 по 1000, на второй — с 1 001 по 2000 и так далее.

limit 

Целое число от 1 до 1 000

Количество записей на одной странице. Максимум 1000 объектов. 

from 

url encoded дата в формате - ГГГГ-ММ-ДДTчч:мм:сс+чч:мм 

Например:

Начало периода в формате decoded: 2023-06-13T00:00:00+00:00 
В encoded будет выглядеть: 2023-06-13T00%3A00%3A00%2B00%3A00

Дата и время, от которой требуется провести поиск статистики в формате encoded.

to 

url encoded дата в формате - ГГГГ-ММ-ДДTчч:мм:сс+чч:мм 

Например:

Начало периода в формате decoded: 2023-06-13T00:00:00+00:00 
В encoded будет выглядеть: 2023-06-13T00%3A00%3A00%2B00%3A00

В запросе требуется использовать дату и время в формате encoded.

Дата и время, до которой требуется провести поиск статистики в формате encoded.

status

(Перечень статусов указан ниже)

Параметр, отвечающий за то, задания в каких статусах обработки будут отображены в ответе. Статусы указываются через запятую БЕЗ пробела


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

...

statusОписание
BLANKЗадание создано, но кандидаты на обзвон в него не загружались. Задание пустое. Звонить некому.
READYСоздано, кандидаты загружены. Готово к обзону.
PROCESSПрямо сейчас находится в процессе обзвона.
PAUSED Задание находится на паузе. Было остановлено.
DONE Обработка задания полностью завершена.
PAUSED_NO_MONEY Задание было остановлено из-за отрицательного баланса.
TIMEOUT 

Аварийная остановка задания (техническая ошибка)

PAUSED_NOBODY PREPARING 

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

ERROR_PREPARING 

Ошибка подготовки. (техническая ошибка)

DELETING Задание находится в очереди на удаление, ждет отработки процедуры.
PAUSED_SCHEDULE PAUSED_NO_ROUTE 

приостановлено по расписанию

HALTED MAX_CPS 

Задание остановлено навсегда. Попыток и звонков больше предприниматься не будет.

PAUSED_NO_CID 

Приостановлено, не выбран callerId.

NO_NEXT_CALL 

Не удалось расчитать время следующего звонка (фактически аварийное завершение, техническая ошибка)