{ "componentChunkName": "component---src-templates-doc-page-js", "path": "/docs/ru/telephony/calls_api/", "result": {"data":{"site":{"siteMetadata":{"title":"Gatsby-doc-engine"}},"markdownRemark":{"id":"8f413d79-ce86-522b-a1c6-3c5079508603","excerpt":"Calls API Платформа JAICP предоставляет Calls API для работы с телефонией. API предоставляет возможность: Добавить телефонные номера с параметрами в рассылку…","html":"

Calls API

\n
\n

Платформа JAICP предоставляет Calls API для работы с телефонией.

\n

API предоставляет возможность:

\n\n

Перед началом работы с Calls API необходимо:

\n
    \n
  1. Настроить телефонию.
    2. \n
  2. Подключить телефонный канал.
    3. \n
  3. Создать голосовую рассылку.
    4. \n
\n
\n

Методы API

\n

Подробное описание Calls API: методы, параметры запроса, форматы ответа, примеры, возвращаемые ошибки >

\n

Контроль доступа проверяется только по токену рассылки.

\n

API предоставляет следующие методы:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
МетодОписание
POST https://<host_name>/api/calls/campaign/{token}/addPhonesДобавление телефонных номеров с параметрами в рассылку.
POST https://<host_name>/api/calls/campaign/{token}/callJob/getReportПолучение отчета json по номерам.
POST https://<host_name>/api/calls/campaign/{token}/callAttempt/getReportПолучение отчета json по попыткам дозвониться.
POST https://<host_name>/api/calls/campaign/{token}/callJob/cancelОтмена новых звонков по номеру телефона или ID задания на обзвон.

Обратите внимание, что отменить можно только звонки для номеров, которые добавлены при помощи Calls API.
POST https://<host_name>/api/calls/campaign/{token}/control/startЗапуск созданной голосовой рассылки.
POST https://<host_name>/api/calls/campaign/{token}/control/pauseПриостановление голосовой рассылки.
POST https://<host_name>/api/calls/campaign/{token}/control/resumeВозобновление приостановленной голосовой рассылки.
POST https://<host_name>/api/calls/campaign/{token}/control/stopОстановка голосовой рассылки.
\n
\n\n

Например, для https://zb04.just-ai.com/ метод добавления телефонных номеров будет выглядеть следующим образом:

\n
https://zb04.just-ai.com/api/calls/campaign/123456.789.mBoMyfZLZqKHIPKjFjWYfRw9hgfIV9InFC4bHGVw5ND/addPhones
\n
\n\n
\n

При добавлении телефонного номера в очередь определенной рассылки создается задание на обзвон с уникальным ID. При этом, если телефонный номер повторно добавлен в эту же рассылку будет создано новое задание на обзвон с другим ID.

\n
\n

Обратите внимание, что отчет о совершенных звонках будет содержать информацию о дате, длительности, результате звонка, а также все сведения, зафиксированные в сценарии методом $dialer.reportData($header, $value, $order).

\n
\n

Определение политики звонка через Calls API

\n

При добавлении номера в рассылку при помощи API вы можете также задать индивидуальные параметры звонка.

\n

Для этого при вызове метода addPhones в теле запроса передайте параметры CallJobParameters.

\n

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

\n

Подробнее о политике звонков

\n
\n

Статусы звонков

\n

В ответе API поле jobStatus описывает состояние номера для каждого звонка в момент формирования отчета.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Значение поляОписание
longСallWithResultЗвонок завершен с результатом.
longCallWithNoResultЗвонок завершен без результата.
noAnswerВсе попытки звонков закончились без ответа абонента.
plannedЗвонок находится в очереди, например, ждет доступных линий.
notDoneСтатус будет проставлен, если рассылка завершена, но при этом не было совершено ни одного звонка. Например, рассылку завершили вручную.
inProcessИдет дозвон или разговор с абонентом.
onRetryПовторная попытка.
canceledСтатус проставляется, если звонки были отменены по Calls API.
nonexistentNumberСтатус проставляется, если звонок был совершен на несуществующий номер.
","frontmatter":{"title":"","description":null},"headings":[{"value":"Calls API"}]}},"pageContext":{"slug":"/docs/ru/telephony/calls_api/","previous":{"fields":{"slug":"/docs/ru/telephony/lists_of_numbers/"},"frontmatter":{"title":"","description":null}},"next":{"fields":{"slug":"/docs/ru/telephony/call_tasks/"},"frontmatter":{"title":"","description":null}}}}, "staticQueryHashes": ["1209419333"]}