Spec-Zone.ru › AWS CLI v2

[ aws . chime ]

получение-номера-телефона

Описание

Возвращает данные для указанного идентификатора номера телефона, такие как ассоциации, возможности и тип продукта.

См. также: Документация API AWS

Синтаксис

  get-phone-number
--phone-number-id <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]

Параметры

--phone-number-id (строка)

Идентификатор номера телефона.

--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.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования для Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной среды. Подробнее см. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для получения данных номера телефона

Следующий get-phone-number пример отображает данные указанного номера телефона.

aws chime get-phone-number \
    --phone-number-id +12065550100

Вывод:

{
    "PhoneNumber": {
        "PhoneNumberId": "%2B12065550100",
        "E164PhoneNumber": "+12065550100",
        "Type": "Local",
        "ProductType": "VoiceConnector",
        "Status": "Unassigned",
        "Capabilities": {
            "InboundCall": true,
            "OutboundCall": true,
            "InboundSMS": true,
            "OutboundSMS": true,
            "InboundMMS": true,
            "OutboundMMS": true
        },
       "Associations": [
            {
                "Value": "abcdef1ghij2klmno3pqr4",
                "Name": "VoiceConnectorId",
                "AssociatedTimestamp": "2019-10-28T18:40:37.453Z"
            }
        ],
        "CallingNameStatus": "UpdateInProgress",
        "CreatedTimestamp": "2019-08-09T21:35:21.445Z",
        "UpdatedTimestamp": "2019-08-09T21:35:31.745Z"
    }
}

Дополнительную информацию см. в разделе Работа с номерами телефонов в Руководстве администратора Amazon Chime.

Вывод

Номер телефона -> (структура)

Данные номера телефона.

Номер телефона -> (строка)

Идентификатор номера телефона.

E164Номер телефона -> (строка)

Номер телефона в формате E.164.

Страна -> (строка)

Страна номера телефона. Формат: ISO 3166-1 alpha-2.

Тип -> (строка)

Тип номера телефона.

Тип продукта -> (строка)

Тип продукта номера телефона.

Статус -> (строка)

Статус номера телефона.

Возможности -> (структура)

Возможности номера телефона.

Входящий звонок -> (логическое)

Разрешает или запрещает входящие звонки для указанного номера телефона.

Исходящий звонок -> (логическое)

Разрешает или запрещает исходящие звонки для указанного номера телефона.

Входящие SMS -> (логическое)

Разрешает или запрещает входящие SMS-сообщения для указанного номера телефона.

Исходящие SMS -> (логическое)

Разрешает или запрещает исходящие SMS-сообщения для указанного номера телефона.

Входящие MMS -> (логическое)

Разрешает или запрещает входящие MMS-сообщения для указанного номера телефона.

Исходящие MMS -> (логическое)

Разрешает или запрещает исходящие MMS-сообщения для указанного номера телефона.

Ассоциации -> (список)

Ассоциации номера телефона.

(структура)

Ассоциации номера телефона, такие как идентификатор учетной записи Amazon Chime, идентификатор пользователя Amazon Chime, идентификатор Amazon Chime Voice Connector или идентификатор группы Amazon Chime Voice Connector.

Значение -> (строка)

Содержит идентификатор сущности, указанный в поле Название.

Название -> (строка)

Определяет ассоциацию с идентификатором учетной записи Amazon Chime, идентификатором пользователя, идентификатором Amazon Chime Voice Connector или идентификатором группы Amazon Chime Voice Connector.

Дата ассоциации -> (временная метка)

Временная метка ассоциации номера телефона в формате ISO 8601.

Имя для вызовов -> (строка)

Имя для исходящих вызовов, связанное с номером телефона.

Статус имени для вызовов -> (строка)

Статус имени для исходящих вызовов.

Дата создания -> (временная метка)

Временная метка создания номера телефона в формате ISO 8601.

Дата обновления -> (временная метка)

Временная метка обновления номера телефона в формате ISO 8601.

Дата удаления -> (временная метка)

Временная метка удаления номера телефона в формате ISO 8601.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API