batch-put-contact
Описание
Примечание
Только служба принципала исходящих кампаний Amazon Connect разрешена на принятие роли в вашей учетной записи и вызов этого API.Позволяет создавать пакет контактов в Amazon Connect. Возможность исходящих кампаний обрабатывает запросы на дозвон через API PutDialRequestBatch. Затем она использует BatchPutContact для создания контактов, соответствующих этим запросам на дозвон. Если агенты доступны, запросы на дозвон совершаются, что приводит к голосовой связи. Результирующий голосовое звонок использует тот же contactId, что и созданный BatchPutContact.
См. также: Документация AWS API
Синтаксис
batch-put-contact
[--client-token <value>]
--instance-id <value>
--contact-data-request-list <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--client-token (строка)
--instance-id (строка)
--contact-data-request-list (список)
Список отдельных запросов на контакт.
(структура)
Объект запроса с информацией для создания контакта.
SystemEndpoint -> (структура)
Точка доступа, связанная с экземпляром Amazon Connect, с которого будет инициирован исходящий контакт для кампании.
Type -> (строка)
Address -> (строка)
CustomerEndpoint -> (структура)
Точка доступа клиента, для которого будет инициирован контакт.
Type -> (строка)
Address -> (строка)
RequestIdentifier -> (строка)
QueueId -> (строка)
Attributes -> (карта)
Список атрибутов, которые необходимо сохранить в контакте.
key -> (строка)
value -> (строка)
Campaign -> (структура)
Структура для хранения информации, связанной с кампанией.
CampaignId -> (строка)
Сокращенный синтаксис:
SystemEndpoint={Type=string,Address=string},CustomerEndpoint={Type=string,Address=string},RequestIdentifier=string,QueueId=string,Attributes={KeyName1=string,KeyName2=string},Campaign={CampaignId=string} ...
Синтаксис JSON:
[
{
"SystemEndpoint": {
"Type": "TELEPHONE_NUMBER"|"VOIP"|"CONTACT_FLOW"|"CONNECT_PHONENUMBER_ARN"|"EMAIL_ADDRESS",
"Address": "string"
},
"CustomerEndpoint": {
"Type": "TELEPHONE_NUMBER"|"VOIP"|"CONTACT_FLOW"|"CONNECT_PHONENUMBER_ARN"|"EMAIL_ADDRESS",
"Address": "string"
},
"RequestIdentifier": "string",
"QueueId": "string",
"Attributes": {"string": "string"
...},
"Campaign": {
"CampaignId": "string"
}
}
...
]
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, указанному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределяют значения, указанные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет интерпретироваться буквально. Это может не быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантии обратной совместимости в сгенерированном JSON-скелете.
Глобальные параметры
--debug (логическое значение)
Включить отладочную запись журнала.
--endpoint-url (строка)
Переопределить URL по умолчанию команды указанным URL.
--no-verify-ssl (логическое значение)
По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение по умолчанию проверки сертификатов SSL.
--no-paginate (логическое значение)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования выходных данных команды.
- json
- текст
- таблица
- yaml
- yaml-потоковый
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование конкретного профиля из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/окружения.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/выключить вывод цвета.
- вкл
- выкл
- авто
--no-sign-request (логическое значение)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Набор сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/окружения.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет зависеть от таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет зависеть от таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная строка base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую, независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (логическое значение)
Отключить вывод пейджера CLI.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры входных данных CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запроса параметров входных данных CLI.
Вывод
SuccessfulRequestList -> (список)
Список запросов, для которых контакт был успешно создан.
(структура)
Запрос, для которого контакт был успешно создан.
RequestIdentifier -> (строка)
ContactId -> (строка)
FailedRequestList -> (список)
Список запросов, для которых создание контакта завершилось ошибкой.
(структура)
Запрос, для которого контакт не был создан.
RequestIdentifier -> (строка)
FailureReasonCode -> (строка)
FailureReasonMessage -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|