{ "componentChunkName": "component---src-templates-doc-page-js", "path": "/docs/ru/telephony/calls_api/add_phones/", "result": {"data":{"site":{"siteMetadata":{"title":"Gatsby-doc-engine"}},"markdownRemark":{"id":"c691d280-28d7-5f04-b9ae-37100ef924c8","excerpt":"Добавление номеров в обзвон Следующий метод Calls API служит для добавления в обзвон номеров с параметрами: Тело запроса В теле запроса к данному методу…","html":"

Добавление номеров в обзвон

\n
\n

Следующий метод Calls 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ПараметрОписаниеПример
phoneНомер телефона абонента. Обязательное поле.\"79110000000\"
payloadПроизвольные дополнительные данные, которые необходимо передать в сценарий.{\"promo\": \"Скидка 20% на все тарифы JAICP!\"}
startDateTimeНачальное время звонка. Звонок будет совершен в интервале от startDateTime до finishDateTime.\"2020-03-23T00:00:00Z\"
finishDateTimeКонечное время звонка. После finishDateTime звонки совершаться не будут.\"2020-03-23T00:00:00Z\"
allowedDaysДни недели, в которые звонок может быть совершен.[\"mon\", \"wed\", \"fri\"]
allowedTimeВременные интервалы для каждого дня недели, в которые может быть совершен звонок.{\"default\": [{\"localTimeFrom\": \"10:00\", \"localTimeTo\": \"18:00\"}]}
retryIntervalInMinutesПауза между попытками дозвониться в минутах.120
maxAttemptsКоличество попыток дозвониться.1
gmtZoneЧасовой пояс абонента.\"+03:00\"
dialerPriorityПриоритет номера телефона.2
\n

Допустимое время звонка

\n

allowedDays

\n

Поле allowedDays задает дни недели, в которые может быть совершен звонок. Значение поля — массив, в котором могут содержаться следующие строки: \"mon\", \"tue\", \"wed\", \"thu\", \"fri\", \"sat\", \"sun\".

\n

При явном указании поля allowedDays звонок возможен только в разрешенные в нем дни недели. Настройки allowedTime для других дней недели при этом игнорируются.

\n

allowedTime

\n

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

\n

Значение поля — это объект с ключами, соответствующими допустимым названиям дней недели из поля allowedDays, а также ключом default. В значении по каждому ключу содержится массив объектов с вложенными полями localTimeFrom и localTimeTo — самым ранним и поздним временем для звонка.

\n

Время указывается в формате HH:mm. Указанное время является относительным — при звонке учитывается местное время абонента.

\n

Звонки в дни недели, не указанные в теле запроса, будут совершаться в рамках интервалов, переданных по ключу default.

\n

localTimeFrom и localTimeTo

\n

При указании localTimeFrom и localTimeTo следует учитывать следующие особенности:

\n\n
[\n  {\n    \"localTimeFrom\": \"10:00\"\n  }\n] // Ошибка: не указана верхняя граница\n\n[\n  {\n    \"localTimeFrom\": \"10:00\",\n    \"localTimeTo\": \"13:30\"\n  },\n  {\n    \"localTimeFrom\": \"13:00\",\n    \"localTimeTo\": \"14:30\"\n  }\n] // Ошибка: пересекающиеся интервалы\n\n[\n  {\n    \"localTimeFrom\": \"20:00\",\n    \"localTimeTo\": \"03:00\"\n  }\n] // Корректный интервал с 8 вечера до 3 ночи
\n

Часовой пояс абонента

\n

Значение gmtZone должно удовлетворять любому из следующих форматов:

\n\n

Приоритет номера телефона

\n

Поле dialerPriority позволяет установить приоритет номера телефона от 1 до 5, где 1 — наивысший приоритет, а 5 — наименьший.

\n

В зависимости от установленного значения звонки в обзвоне будут выполняться последовательно, начиная с более приоритетных номеров телефона и заканчивая менее приоритетными.

\n

У dialerPriority есть ряд особенностей.

\n\n

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

\n
curl --request POST 'https://app.jaicp.com/api/calls/campaign/8231.7056.1b131df1/addPhones' \\\n--header 'Content-Type: application/json' \\\n--data-raw '[\n  {\n    \"phone\": 79110000000,\n    \"payload\": {\n      \"name\": \"Alex\",\n      \"age\": 34\n    },\n    \"allowedTime\": {\n      \"mon\": [\n        {\n          \"localTimeFrom\": \"10:00\",\n          \"localTimeTo\": \"11:30\"\n        },\n        {\n          \"localTimeFrom\": \"13:00\",\n          \"localTimeTo\": \"14:30\"\n        }\n      ],\n      \"default\": [\n        {\n          \"localTimeFrom\": \"10:00\",\n          \"localTimeTo\": \"18:00\"\n        }\n      ]\n    },\n    \"retryIntervalInMinutes\": 120,\n    \"maxAttempts\": 0,\n    \"gmtZone\": \"+03:30\"\n  }\n]'
\n

Ответ на запрос — массив идентификаторов всех созданных заданий на обзвон.

","frontmatter":{"title":"","description":null},"headings":[{"value":"Добавление номеров в обзвон"}]}},"pageContext":{"slug":"/docs/ru/telephony/calls_api/add_phones/","previous":{"fields":{"slug":"/docs/ru/telephony/calls_api/calls_api/"},"frontmatter":{"title":"","description":null}},"next":{"fields":{"slug":"/docs/ru/telephony/calls_api/add_phone/"},"frontmatter":{"title":"","description":null}}}}, "staticQueryHashes": ["1209419333"]}