Ejemplos de Amazon Chime con AWS CLI - AWS Command Line Interface

Esta documentación es AWS CLI únicamente para la versión 1 de la versión. Para ver la documentación relacionada con la versión 2 de AWS CLI, consulte la Guía del usuario de la versión 2.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Ejemplos de Amazon Chime con AWS CLI

Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes AWS Command Line Interface mediante Amazon Chime.

Las acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las funciones de servicio individuales, es posible ver las acciones en contexto en los escenarios relacionados.

Cada ejemplo incluye un enlace al código fuente completo, donde puede encontrar instrucciones sobre cómo configurar y ejecutar el código en su contexto.

Acciones

El siguiente ejemplo de código muestra cómo usarloassociate-phone-number-with-user.

AWS CLI

Para asociar un número de teléfono a un usuario

El siguiente associate-phone-number-with-user ejemplo asocia el número de teléfono especificado a un usuario.

aws chime associate-phone-number-with-user \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --user-id 1ab2345c-67de-8901-f23g-45h678901j2k \ --e164-phone-number "+12065550100"

Este comando no genera ninguna salida.

Para obtener más información, consulte Administrar los números de teléfono de los usuarios en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloassociate-phone-numbers-with-voice-connector-group.

AWS CLI

Para asociar números de teléfono a un grupo de conectores de voz de Amazon Chime

El siguiente associate-phone-numbers-with-voice-connector-group ejemplo asocia los números de teléfono especificados a un grupo de conectores de voz de Amazon Chime.

aws chime associate-phone-numbers-with-voice-connector-group \ --voice-connector-group-id 123a456b-c7d8-90e1-fg23-4h567jkl8901 \ --e164-phone-numbers "+12065550100" "+12065550101" \ --force-associate

Salida:

{ "PhoneNumberErrors": [] }

Para obtener más información, consulte Uso de grupos de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloassociate-phone-numbers-with-voice-connector.

AWS CLI

Para asociar números de teléfono a un conector de voz de Amazon Chime

En el siguiente associate-phone-numbers-with-voice-connector ejemplo, se asocian los números de teléfono especificados a un conector de voz de Amazon Chime.

aws chime associate-phone-numbers-with-voice-connector \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --e164-phone-numbers "+12065550100" "+12065550101" --force-associate

Salida:

{ "PhoneNumberErrors": [] }

Para obtener más información, consulte Uso de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloassociate-signin-delegate-groups-with-account.

AWS CLI

Para asociar grupos de delegados que inicien sesión

El siguiente associate-signin-delegate-groups-with-account ejemplo asocia el grupo de delegados de inicio de sesión especificado con la cuenta de Amazon Chime especificada.

aws chime associate-signin-delegate-groups-with-account \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --signin-delegate-groups GroupName=my_users

Este comando no genera ninguna salida.

Para obtener más información, consulte Administrar el acceso y los permisos de los usuarios en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarlobatch-create-room-membership.

AWS CLI

Para crear membresías a varias salas

El siguiente batch-create-room-membership ejemplo agrega varios usuarios a una sala de chat como miembros de la sala de chat. También asigna funciones de administrador y miembro a los usuarios.

aws chime batch-create-room-membership \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ --membership-item-list "MemberId=1ab2345c-67de-8901-f23g-45h678901j2k,Role=Administrator" "MemberId=2ab2345c-67de-8901-f23g-45h678901j2k,Role=Member"

Salida:

{ "ResponseMetadata": { "RequestId": "169ba401-d886-475f-8b3f-e01eac6fadfb", "HTTPStatusCode": 201, "HTTPHeaders": { "x-amzn-requestid": "169ba401-d886-475f-8b3f-e01eac6fadfb", "content-type": "application/json", "content-length": "13", "date": "Mon, 02 Dec 2019 22:46:58 GMT", "connection": "keep-alive" }, "RetryAttempts": 0 }, "Errors": [] }

Para obtener más información, consulte Creación de una sala de chat en la Guía del usuario de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarlobatch-delete-phone-number.

AWS CLI

Para eliminar varios números de teléfono

En el siguiente batch-delete-phone-number ejemplo, se eliminan todos los números de teléfono especificados.

aws chime batch-delete-phone-number \ --phone-number-ids "%2B12065550100" "%2B12065550101"

Este comando no genera ninguna salida. Salida:

{ "PhoneNumberErrors": [] }

Para obtener más información, consulte Uso de números de teléfono en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarlobatch-suspend-user.

AWS CLI

Para suspender a varios usuarios

El siguiente batch-suspend-user ejemplo suspende a los usuarios de la lista de la cuenta de Amazon Chime especificada.

aws chime batch-suspend-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-id-list "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE" "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE"

Salida:

{ "UserErrors": [] }
  • Para API obtener más información, consulte la Referencia BatchSuspendUserde AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlobatch-unsuspend-user.

AWS CLI

Para anular la suspensión de varios usuarios

En el siguiente batch-unsuspend-user ejemplo, se elimina cualquier suspensión anterior de los usuarios incluidos en la lista de la cuenta de Amazon Chime especificada.

aws chime batch-unsuspend-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-id-list "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE" "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE"

Salida:

{ "UserErrors": [] }
  • Para API obtener más información, consulte BatchUnsuspendUserla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlobatch-update-phone-number.

AWS CLI

Para actualizar varios tipos de productos de números de teléfono al mismo tiempo

En el siguiente batch-update-phone-number ejemplo, se actualizan los tipos de producto de todos los números de teléfono especificados.

aws chime batch-update-phone-number \ --update-phone-number-request-items PhoneNumberId=%2B12065550100,ProductType=BusinessCalling PhoneNumberId=%2B12065550101,ProductType=BusinessCalling

Salida:

{ "PhoneNumberErrors": [] }

Para actualizar varios nombres de llamadas a números de teléfono al mismo tiempo

En el siguiente batch-update-phone-number ejemplo, se actualizan los nombres de llamada de todos los números de teléfono especificados.

aws chime batch-update-phone-number \ --update-phone-number-request-items PhoneNumberId=%2B14013143874,CallingName=phonenumber1 PhoneNumberId=%2B14013144061,CallingName=phonenumber2

Salida:

{ "PhoneNumberErrors": [] }

Para obtener más información, consulte Uso de números de teléfono en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarlobatch-update-user.

AWS CLI

Para actualizar varios usuarios en un solo comando

En el siguiente batch-update-user ejemplo, se actualiza la cuenta de Amazon Chime especificada LicenseType para cada uno de los usuarios de la lista.

aws chime batch-update-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE --update-user-request-items "UserId=a1b2c3d4-5678-90ab-cdef-22222EXAMPLE,LicenseType=Basic" "UserId=a1b2c3d4-5678-90ab-cdef-33333EXAMPLE,LicenseType=Basic"

Salida:

{ "UserErrors": [] }
  • Para API obtener más información, consulte BatchUpdateUserla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlocreate-account.

AWS CLI

Para crear una cuenta

En el siguiente create-account ejemplo, se crea una cuenta de Amazon Chime en la cuenta del AWS administrador.

aws chime create-account \ --name MyChimeAccount

Salida:

{ "Account": { "AwsAccountId": "111122223333", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "Name": "MyChimeAccount", "AccountType": "Team", "CreatedTimestamp": "2019-01-04T17:11:22.003Z", "DefaultLicense": "Pro", "SupportedLicenses": [ "Basic", "Pro" ], "SigninDelegateGroups": [ { "GroupName": "myGroup" }, ] } }

Para obtener más información, consulte Introducción en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte CreateAccountla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlocreate-bot.

AWS CLI

Para crear un bot de Amazon Chime

En el siguiente create-bot ejemplo, se crea un bot para la cuenta empresarial de Amazon Chime especificada.

aws chime create-bot \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --display-name "myBot" \ --domain "example.com"

Salida:

{ "Bot": { "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", "DisplayName": "myBot (Bot)", "BotType": "ChatBot", "Disabled": false, "CreatedTimestamp": "2019-09-09T18:05:56.749Z", "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", "BotEmail": "myBot-chimebot@example.com", "SecurityToken": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" } }

Para obtener más información, consulte Integrar un bot de chat con Amazon Chime en la Guía para desarrolladores de Amazon Chime.

  • Para API obtener más información, consulte la Referencia CreateBotde AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlocreate-phone-number-order.

AWS CLI

Para crear un pedido de números de teléfono

En el siguiente create-phone-number-order ejemplo, se crea un orden de números de teléfono para los números de teléfono especificados.

aws chime create-phone-number-order \ --product-type VoiceConnector \ --e164-phone-numbers "+12065550100" "+12065550101" "+12065550102"

Salida:

{ "PhoneNumberOrder": { "PhoneNumberOrderId": "abc12345-de67-89f0-123g-h45i678j9012", "ProductType": "VoiceConnector", "Status": "Processing", "OrderedPhoneNumbers": [ { "E164PhoneNumber": "+12065550100", "Status": "Processing" }, { "E164PhoneNumber": "+12065550101", "Status": "Processing" }, { "E164PhoneNumber": "+12065550102", "Status": "Processing" } ], "CreatedTimestamp": "2019-08-09T21:35:21.427Z", "UpdatedTimestamp": "2019-08-09T21:35:22.408Z" } }

Para obtener más información, consulte Uso de números de teléfono en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarlocreate-proxy-session.

AWS CLI

Para crear una sesión de proxy

En el siguiente create-proxy-session ejemplo, se crea una sesión de proxy con voz y SMS funciones.

aws chime create-proxy-session \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --participant-phone-numbers "+14015550101" "+12065550100" \ --capabilities "Voice" "SMS"

Salida:

{ "ProxySession": { "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "ProxySessionId": "123a4bc5-67d8-901e-2f3g-h4ghjk56789l", "Status": "Open", "ExpiryMinutes": 60, "Capabilities": [ "SMS", "Voice" ], "CreatedTimestamp": "2020-04-15T16:10:10.288Z", "UpdatedTimestamp": "2020-04-15T16:10:10.288Z", "Participants": [ { "PhoneNumber": "+12065550100", "ProxyPhoneNumber": "+19135550199" }, { "PhoneNumber": "+14015550101", "ProxyPhoneNumber": "+19135550199" } ] } }

Para obtener más información, consulte Proxy Phone Sessions en la Guía para desarrolladores de Amazon Chime.

  • Para API obtener más información, consulte CreateProxySessionla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlocreate-room-membership.

AWS CLI

Para crear una membresía de sala

En el siguiente create-room-membership ejemplo, se agrega el usuario especificado a la sala de chat como miembro de la sala de chat.

aws chime create-room-membership \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ --member-id 1ab2345c-67de-8901-f23g-45h678901j2k

Salida:

{ "RoomMembership": { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Member": { "MemberId": "1ab2345c-67de-8901-f23g-45h678901j2k", "MemberType": "User", "Email": "janed@example.com", "FullName": "Jane Doe", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45" }, "Role": "Member", "InvitedBy": "arn:aws:iam::111122223333:user/alejandro", "UpdatedTimestamp": "2019-12-02T22:36:41.969Z" } }

Para obtener más información, consulte Creación de una sala de chat en la Guía del usuario de Amazon Chime.

  • Para API obtener más información, consulte CreateRoomMembershipla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlocreate-room.

AWS CLI

Para crear una sala de chat

En el siguiente create-room ejemplo, se crea una sala de chat para la cuenta de Amazon Chime especificada.

aws chime create-room \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --name chatRoom

Salida:

{ "Room": { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Name": "chatRoom", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", "CreatedBy": "arn:aws:iam::111122223333:user/alejandro", "CreatedTimestamp": "2019-12-02T22:29:31.549Z", "UpdatedTimestamp": "2019-12-02T22:29:31.549Z" } }

Para obtener más información, consulte Creación de una sala de chat en la Guía del usuario de Amazon Chime.

  • Para API obtener más información, consulte CreateRoomla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlocreate-user.

AWS CLI

Para crear un perfil de usuario para un dispositivo compartido

El siguiente create-user ejemplo crea un perfil de dispositivo compartido para la dirección de correo electrónico especificada.

aws chime create-user \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --email roomdevice@example.com \ --user-type SharedDevice

Salida:

{ "User": { "UserId": "1ab2345c-67de-8901-f23g-45h678901j2k", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", "PrimaryEmail": "roomdevice@example.com", "DisplayName": "Room Device", "LicenseType": "Pro", "UserType": "SharedDevice", "UserRegistrationStatus": "Registered", "RegisteredOn": "2020-01-15T22:38:09.806Z", "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": false } } }

Para obtener más información, consulte Preparación de la configuración en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte CreateUserla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlocreate-voice-connector-group.

AWS CLI

Para crear un grupo de conectores de voz de Amazon Chime

En el siguiente create-voice-connector-group ejemplo, se crea un grupo de conectores de voz de Amazon Chime que incluye el conector de voz de Amazon Chime especificado.

aws chime create-voice-connector-group \ --name myGroup \ --voice-connector-items VoiceConnectorId=abcdef1ghij2klmno3pqr4,Priority=2

Salida:

{ "VoiceConnectorGroup": { "VoiceConnectorGroupId": "123a456b-c7d8-90e1-fg23-4h567jkl8901", "Name": "myGroup", "VoiceConnectorItems": [], "CreatedTimestamp": "2019-09-18T16:38:34.734Z", "UpdatedTimestamp": "2019-09-18T16:38:34.734Z" } }

Para obtener más información, consulte Uso de grupos de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarlocreate-voice-connector.

AWS CLI

Para crear un conector de voz de Amazon Chime

En el siguiente create-voice-connector ejemplo, se crea un conector de voz de Amazon Chime en la AWS región especificada, con el cifrado activado.

aws chime create-voice-connector \ --name newVoiceConnector \ --aws-region us-west-2 \ --require-encryption

Salida:

{ "VoiceConnector": { "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "AwsRegion": "us-west-2", "Name": "newVoiceConnector", "OutboundHostName": "abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws", "RequireEncryption": true, "CreatedTimestamp": "2019-09-18T20:34:01.352Z", "UpdatedTimestamp": "2019-09-18T20:34:01.352Z" } }

Para obtener más información, consulte Uso de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte la Referencia CreateVoiceConnectorde AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodelete-account.

AWS CLI

Para eliminar una cuenta

En el siguiente delete-account ejemplo, se elimina la cuenta especificada.

aws chime delete-account --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

Este comando no genera ninguna salida.

Para obtener más información, consulte Eliminar su cuenta en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte DeleteAccountla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodelete-phone-number.

AWS CLI

Para eliminar un número de teléfono

En el siguiente delete-phone-number ejemplo, se mueve el número de teléfono especificado a la cola de eliminación.

aws chime delete-phone-number \ --phone-number-id "+12065550100"

Este comando no genera ninguna salida.

Para obtener más información, consulte Uso de números de teléfono en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte DeletePhoneNumberla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodelete-proxy-session.

AWS CLI

Para eliminar una sesión de proxy

En el siguiente delete-proxy-session ejemplo, se elimina la sesión de proxy especificada.

aws chime delete-proxy-session \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --proxy-session-id 123a4bc5-67d8-901e-2f3g-h4ghjk56789l

Este comando no genera ninguna salida.

Para obtener más información, consulte Proxy Phone Sessions en la Guía para desarrolladores de Amazon Chime.

  • Para API obtener más información, consulte DeleteProxySessionla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodelete-room-membership.

AWS CLI

Para eliminar a un usuario como miembro de una sala de chat

El siguiente delete-room-membership ejemplo elimina al miembro especificado de la sala de chat especificada.

aws chime delete-room-membership \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ --member-id 1ab2345c-67de-8901-f23g-45h678901j2k

Este comando no genera ninguna salida.

Para obtener más información, consulte Creación de una sala de chat en la Guía del usuario de Amazon Chime.

  • Para API obtener más información, consulte DeleteRoomMembershipla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodelete-room.

AWS CLI

Para eliminar una sala de chat

En el siguiente delete-room ejemplo, se elimina la sala de chat especificada y se quitan las pertenencias a la sala de chat.

aws chime delete-room \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j

Este comando no genera ninguna salida.

Para obtener más información, consulte Creación de una sala de chat en la Guía del usuario de Amazon Chime.

  • Para API obtener más información, consulte DeleteRoomla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodelete-voice-connector-group.

AWS CLI

title

En el siguiente delete-voice-connector-group ejemplo, se elimina el grupo de conectores de voz de Amazon Chime especificado.

aws chime delete-voice-connector-group \ --voice-connector-group-id 123a456b-c7d8-90e1-fg23-4h567jkl8901

Este comando no genera ninguna salida.

Para obtener más información, consulte Uso de grupos de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarlodelete-voice-connector-origination.

AWS CLI

Para eliminar la configuración de origen

En el siguiente delete-voice-connector-origination ejemplo, se eliminan el host, el puerto, el protocolo, la prioridad y el peso de origen del conector de voz Amazon Chime especificado.

aws chime delete-voice-connector-origination \ --voice-connector-id abcdef1ghij2klmno3pqr4

Este comando no genera ninguna salida.

Para obtener más información, consulte Uso de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarlodelete-voice-connector-proxy.

AWS CLI

Para eliminar una configuración de proxy

En el siguiente delete-voice-connector-proxy ejemplo, se elimina la configuración de proxy del conector de voz de Amazon Chime.

aws chime delete-voice-connector-proxy \ --voice-connector-id abcdef1ghij2klmno3pqr4

Este comando no genera ninguna salida.

Para obtener más información, consulte Proxy Phone Sessions en la Guía para desarrolladores de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarlodelete-voice-connector-streaming-configuration.

AWS CLI

Para eliminar una configuración de streaming

En el siguiente delete-voice-connector-streaming-configuration ejemplo, se elimina la configuración de streaming del conector de voz Amazon Chime especificado.

aws chime delete-voice-connector-streaming-configuration \ --voice-connector-id abcdef1ghij2klmno3pqr4

Este comando no genera ninguna salida.

Para obtener más información, consulte Transmisión de datos del conector de voz de Amazon Chime a Kinesis en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarlodelete-voice-connector-termination-credentials.

AWS CLI

Para eliminar las credenciales de terminación

En el siguiente delete-voice-connector-termination-credentials ejemplo, se eliminan las credenciales de terminación del nombre de usuario especificado y del conector de voz Amazon Chime.

aws chime delete-voice-connector-termination-credentials \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --usernames "jdoe"

Este comando no genera ninguna salida.

Para obtener más información, consulte Uso de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarlodelete-voice-connector-termination.

AWS CLI

Para eliminar la configuración de terminación

El siguiente delete-voice-connector-termination ejemplo elimina la configuración de terminación del conector de voz Amazon Chime especificado.

aws chime delete-voice-connector-termination \ --voice-connector-id abcdef1ghij2klmno3pqr4

Este comando no genera ninguna salida.

Para obtener más información, consulte Uso de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarlodelete-voice-connector.

AWS CLI

Para eliminar un conector de voz de Amazon Chime

En el siguiente delete-voice-connector ejemplo se hace lo siguiente

aws chime delete-voice-connector \ --voice-connector-id abcdef1ghij2klmno3pqr4

Este comando no genera ninguna salida.

Para obtener más información, consulte Uso de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte la Referencia DeleteVoiceConnectorde AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodisassociate-phone-number-from-user.

AWS CLI

Para desasociar un número de teléfono de un usuario

El siguiente disassociate-phone-number-from-user ejemplo desasocia un número de teléfono del usuario especificado.

aws chime disassociate-phone-number-from-user \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --user-id 1ab2345c-67de-8901-f23g-45h678901j2k

Este comando no genera ninguna salida.

Para obtener más información, consulte Administrar los números de teléfono de los usuarios en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarlodisassociate-phone-numbers-from-voice-connector-group.

AWS CLI

Para desasociar números de teléfono de un grupo de conectores de voz de Amazon Chime

El siguiente disassociate-phone-numbers-from-voice-connector-group ejemplo desasocia los números de teléfono especificados de un grupo de conectores de voz de Amazon Chime.

aws chime disassociate-phone-numbers-from-voice-connector-group \ --voice-connector-group-id 123a456b-c7d8-90e1-fg23-4h567jkl8901 \ --e164-phone-numbers "+12065550100" "+12065550101"

Salida:

{ "PhoneNumberErrors": [] }

Para obtener más información, consulte Uso de grupos de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarlodisassociate-phone-numbers-from-voice-connector.

AWS CLI

Para desasociar números de teléfono de un conector de voz de Amazon Chime

El siguiente disassociate-phone-numbers-from-voice-connector ejemplo desasocia los números de teléfono especificados de un conector de voz de Amazon Chime.

aws chime disassociate-phone-numbers-from-voice-connector \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --e164-phone-numbers "+12065550100" "+12065550101"

Salida:

{ "PhoneNumberErrors": [] }

Para obtener más información, consulte Uso de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarlodisassociate-signin-delegate-groups-from-account.

AWS CLI

Para desasociar los grupos de delegados que inician sesión

El siguiente disassociate-signin-delegate-groups-from-account ejemplo desasocia el grupo de delegados de inicio de sesión especificado de la cuenta de Amazon Chime especificada.

aws chime disassociate-signin-delegate-groups-from-account \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --group-names "my_users"

Este comando no genera ninguna salida.

Para obtener más información, consulte Administrar el acceso y los permisos de los usuarios en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloget-account-settings.

AWS CLI

Para recuperar la configuración de una cuenta

En el siguiente get-account-settings ejemplo, se recupera la configuración de la cuenta especificada.

aws chime get-account-settings --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

Salida:

{ "AccountSettings": { "DisableRemoteControl": false, "EnableDialOut": false } }

Para obtener más información, consulte Gestión de sus cuentas de Amazon Chime en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte la Referencia GetAccountSettingsde AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-account.

AWS CLI

Para recuperar los detalles de una cuenta

En el siguiente get-account ejemplo, se recuperan los detalles de la cuenta de Amazon Chime especificada.

aws chime get-account \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

Salida:

{ "Account": { "AwsAccountId": "111122223333", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "Name": "EnterpriseDirectory", "AccountType": "EnterpriseDirectory", "CreatedTimestamp": "2018-12-20T18:38:02.181Z", "DefaultLicense": "Pro", "SupportedLicenses": [ "Basic", "Pro" ], "SigninDelegateGroups": [ { "GroupName": "myGroup" }, ] } }

Para obtener más información, consulte Gestión de sus cuentas de Amazon Chime en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte la Referencia GetAccountde AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-bot.

AWS CLI

Para recuperar detalles sobre un bot

En el siguiente get-bot ejemplo, se muestran los detalles del bot especificado.

aws chime get-bot \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k

Salida:

{ "Bot": { "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", "DisplayName": "myBot (Bot)", "BotType": "ChatBot", "Disabled": false, "CreatedTimestamp": "2019-09-09T18:05:56.749Z", "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", "BotEmail": "myBot-chimebot@example.com", "SecurityToken": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" } }

Para obtener más información, consulte Actualizar los bots de chat en la Guía para desarrolladores de Amazon Chime.

  • Para API obtener más información, consulte GetBotla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-global-settings.

AWS CLI

Para obtener la configuración global

En el siguiente get-global-settings ejemplo, se recuperan los nombres de los buckets de S3 que se utilizan para almacenar los registros de detalles de llamadas de los conectores Amazon Chime Business Calling y Amazon Chime Voice asociados a la cuenta del administrador. AWS

aws chime get-global-settings

Salida:

{ "BusinessCalling": { "CdrBucket": "s3bucket" }, "VoiceConnector": { "CdrBucket": "s3bucket" } }

Para obtener más información, consulte Gestión de la configuración global en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte GetGlobalSettingsla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-phone-number-order.

AWS CLI

Para obtener los detalles de un pedido con un número de teléfono

En el siguiente get-phone-number-order ejemplo, se muestran los detalles del pedido de números de teléfono especificado.

aws chime get-phone-number-order \ --phone-number-order-id abc12345-de67-89f0-123g-h45i678j9012

Salida:

{ "PhoneNumberOrder": { "PhoneNumberOrderId": "abc12345-de67-89f0-123g-h45i678j9012", "ProductType": "VoiceConnector", "Status": "Partial", "OrderedPhoneNumbers": [ { "E164PhoneNumber": "+12065550100", "Status": "Acquired" }, { "E164PhoneNumber": "+12065550101", "Status": "Acquired" }, { "E164PhoneNumber": "+12065550102", "Status": "Failed" } ], "CreatedTimestamp": "2019-08-09T21:35:21.427Z", "UpdatedTimestamp": "2019-08-09T21:35:31.926Z" } }

Para obtener más información, consulte Uso de números de teléfono en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte GetPhoneNumberOrderla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-phone-number-settings.

AWS CLI

Para recuperar el nombre de una llamada saliente

En el siguiente get-phone-number-settings ejemplo, se recupera el nombre de llamada saliente predeterminado de la cuenta del usuario que realiza la llamada. AWS

aws chime get-phone-number-settings

Este comando no genera ninguna salida. Salida:

{ "CallingName": "myName", "CallingNameUpdatedTimestamp": "2019-10-28T18:56:42.911Z" }

Para obtener más información, consulte Uso de números de teléfono en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloget-phone-number.

AWS CLI

Para obtener los detalles del número de teléfono

En el siguiente get-phone-number ejemplo, se muestran los detalles del número de teléfono especificado.

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

Salida:

{ "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" } }

Para obtener más información, consulte Uso de números de teléfono en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte GetPhoneNumberla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-proxy-session.

AWS CLI

Para obtener los detalles de la sesión de proxy

En el siguiente get-proxy-session ejemplo, se muestran los detalles de la sesión de proxy especificada.

aws chime get-proxy-session \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --proxy-session-id 123a4bc5-67d8-901e-2f3g-h4ghjk56789l

Salida:

{ "ProxySession": { "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "ProxySessionId": "123a4bc5-67d8-901e-2f3g-h4ghjk56789l", "Status": "Open", "ExpiryMinutes": 60, "Capabilities": [ "SMS", "Voice" ], "CreatedTimestamp": "2020-04-15T16:10:10.288Z", "UpdatedTimestamp": "2020-04-15T16:10:10.288Z", "Participants": [ { "PhoneNumber": "+12065550100", "ProxyPhoneNumber": "+19135550199" }, { "PhoneNumber": "+14015550101", "ProxyPhoneNumber": "+19135550199" } ] } }

Para obtener más información, consulte Proxy Phone Sessions en la Guía para desarrolladores de Amazon Chime.

  • Para API obtener más información, consulte GetProxySessionla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-room.

AWS CLI

Para obtener los detalles sobre una sala de chat

En el siguiente get-room ejemplo, se muestran detalles sobre la sala de chat especificada.

aws chime get-room \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j

Salida:

{ "Room": { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Name": "chatRoom", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", "CreatedBy": "arn:aws:iam::111122223333:user/alejandro", "CreatedTimestamp": "2019-12-02T22:29:31.549Z", "UpdatedTimestamp": "2019-12-02T22:29:31.549Z" } }

Para obtener más información, consulte Creación de una sala de chat en la Guía del usuario de Amazon Chime.

  • Para API obtener más información, consulte GetRoomla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-user-settings.

AWS CLI

Para recuperar la configuración del usuario

En el siguiente get-user-settings ejemplo, se muestra la configuración de usuario especificada.

aws chime get-user-settings \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --user-id 1ab2345c-67de-8901-f23g-45h678901j2k

Salida:

{ "UserSettings": { "Telephony": { "InboundCalling": true, "OutboundCalling": true, "SMS": true } } }

Para obtener más información, consulte Administrar los números de teléfono de los usuarios en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte GetUserSettingsla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-user.

AWS CLI

Para obtener detalles sobre un usuario

En el siguiente get-user ejemplo, se recuperan los detalles del usuario especificado.

aws chime get-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE

Salida:

{ "User": { "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "PrimaryEmail": "marthar@example.com", "DisplayName": "Martha Rivera", "LicenseType": "Pro", "UserRegistrationStatus": "Registered", "RegisteredOn": "2018-12-20T18:45:25.231Z", "InvitedOn": "2018-12-20T18:45:25.231Z", "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": False, "AlexaForBusinessRoomArn": "null" }, "PersonalPIN": "XXXXXXXXXX" } }

Para obtener más información, consulte Administración de usuarios en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte GetUserla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-voice-connector-group.

AWS CLI

Para obtener información sobre un grupo de conectores de voz de Amazon Chime

En el siguiente get-voice-connector-group ejemplo, se muestran los detalles del grupo de conectores de voz de Amazon Chime especificado.

aws chime get-voice-connector-group \ --voice-connector-group-id 123a456b-c7d8-90e1-fg23-4h567jkl8901

Salida:

{ "VoiceConnectorGroup": { "VoiceConnectorGroupId": "123a456b-c7d8-90e1-fg23-4h567jkl8901", "Name": "myGroup", "VoiceConnectorItems": [], "CreatedTimestamp": "2019-09-18T16:38:34.734Z", "UpdatedTimestamp": "2019-09-18T16:38:34.734Z" } }

Para obtener más información, consulte Uso de grupos de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloget-voice-connector-logging-configuration.

AWS CLI

Para obtener los detalles de la configuración del registro

En el siguiente get-voice-connector-logging-configuration ejemplo, se recuperan los detalles de la configuración de registro del conector de voz Amazon Chime especificado.

aws chime get-voice-connector-logging-configuration \ --voice-connector-id abcdef1ghij2klmno3pqr4

Salida:

{ "LoggingConfiguration": { "EnableSIPLogs": true } }

Para obtener más información, consulte Transmisión de contenido multimedia de Amazon Chime Voice Connector a Kinesis en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloget-voice-connector-origination.

AWS CLI

Para recuperar la configuración de origen

El siguiente get-voice-connector-origination ejemplo recupera el host de origen, el puerto, el protocolo, la prioridad y el peso del conector de voz Amazon Chime especificado.

aws chime get-voice-connector-origination \ --voice-connector-id abcdef1ghij2klmno3pqr4

Salida:

{ "Origination": { "Routes": [ { "Host": "10.24.34.0", "Port": 1234, "Protocol": "TCP", "Priority": 1, "Weight": 5 } ], "Disabled": false } }

Para obtener más información, consulte Uso de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloget-voice-connector-proxy.

AWS CLI

Para obtener los detalles de la configuración del proxy

En el siguiente get-voice-connector-proxy ejemplo, se obtienen los detalles de configuración del proxy de su conector de voz Amazon Chime.

aws chime get-voice-connector-proxy \ --voice-connector-id abcdef1ghij2klmno3pqr4

Salida:

{ "Proxy": { "DefaultSessionExpiryMinutes": 60, "Disabled": false, "PhoneNumberCountries": [ "US" ] } }

Para obtener más información, consulte Proxy Phone Sessions en la Guía para desarrolladores de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloget-voice-connector-streaming-configuration.

AWS CLI

Para obtener los detalles de la configuración de streaming

En el siguiente get-voice-connector-streaming-configuration ejemplo, se obtienen los detalles de configuración de streaming del conector de voz Amazon Chime especificado.

aws chime get-voice-connector-streaming-configuration \ --voice-connector-id abcdef1ghij2klmno3pqr4

Salida:

{ "StreamingConfiguration": { "DataRetentionInHours": 24, "Disabled": false } }

Para obtener más información, consulte Transmisión de datos del conector de voz de Amazon Chime a Kinesis en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloget-voice-connector-termination-health.

AWS CLI

Para recuperar los detalles del estado de la rescisión

En el siguiente get-voice-connector-termination-health ejemplo, se recuperan los detalles del estado de terminación del conector de voz Amazon Chime especificado.

aws chime get-voice-connector-termination-health \ --voice-connector-id abcdef1ghij2klmno3pqr4

Salida:

{ "TerminationHealth": { "Timestamp": "Fri Aug 23 16:45:55 UTC 2019", "Source": "10.24.34.0" } }

Para obtener más información, consulte Uso de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloget-voice-connector-termination.

AWS CLI

Para recuperar la configuración de terminación

En el siguiente get-voice-connector-termination ejemplo, se recupera la configuración de terminación del conector de voz Amazon Chime especificado.

aws chime get-voice-connector-termination \ --voice-connector-id abcdef1ghij2klmno3pqr4

Este comando no genera ninguna salida. Salida:

{ "Termination": { "CpsLimit": 1, "DefaultPhoneNumber": "+12065550100", "CallingRegions": [ "US" ], "CidrAllowedList": [ "10.24.34.0/23" ], "Disabled": false } }

Para obtener más información, consulte Uso de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloget-voice-connector.

AWS CLI

Para obtener detalles de un conector de voz de Amazon Chime

En el siguiente get-voice-connector ejemplo, se muestran los detalles del conector de voz Amazon Chime especificado.

aws chime get-voice-connector \ --voice-connector-id abcdef1ghij2klmno3pqr4

Salida:

{ "VoiceConnector": { "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "AwsRegion": "us-west-2", "Name": "newVoiceConnector", "OutboundHostName": "abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws", "RequireEncryption": true, "CreatedTimestamp": "2019-09-18T20:34:01.352Z", "UpdatedTimestamp": "2019-09-18T20:34:01.352Z" } }

Para obtener más información, consulte Uso de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte la Referencia GetVoiceConnectorde AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloinvite-users.

AWS CLI

Para invitar a los usuarios a unirse a Amazon Chime

El siguiente invite-users ejemplo envía un correo electrónico para invitar a un usuario a la cuenta de Amazon Chime especificada.

aws chime invite-users \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-email-list "alejandror@example.com" "janed@example.com"

Salida:

{ "Invites": [ { "InviteId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "Status": "Pending", "EmailAddress": "alejandror@example.com", "EmailStatus": "Sent" } { "InviteId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", "Status": "Pending", "EmailAddress": "janed@example.com", "EmailStatus": "Sent" } ] }

Para obtener más información, consulte Invitación y suspensión de usuarios en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte la Referencia InviteUsersde AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlolist-accounts.

AWS CLI

Para obtener una lista de cuentas

En el siguiente list-accounts ejemplo, se recupera una lista de las cuentas de Amazon Chime de la cuenta del administrador AWS .

aws chime list-accounts

Salida:

{ "Accounts": [ { "AwsAccountId": "111122223333", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "Name": "First Chime Account", "AccountType": "EnterpriseDirectory", "CreatedTimestamp": "2018-12-20T18:38:02.181Z", "DefaultLicense": "Pro", "SupportedLicenses": [ "Basic", "Pro" ], "SigninDelegateGroups": [ { "GroupName": "myGroup" }, ] }, { "AwsAccountId": "111122223333", "AccountId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "Name": "Second Chime Account", "AccountType": "Team", "CreatedTimestamp": "2018-09-04T21:44:22.292Z", "DefaultLicense": "Pro", "SupportedLicenses": [ "Basic", "Pro" ], "SigninDelegateGroups": [ { "GroupName": "myGroup" }, ] } ] }

Para obtener más información, consulte Gestión de sus cuentas de Amazon Chime en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte la Referencia ListAccountsde AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlolist-bots.

AWS CLI

Para recuperar una lista de bots

En el siguiente list-bots ejemplo, se enumeran los bots asociados a la cuenta de Amazon Chime Enterprise especificada.

aws chime list-bots \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45

Salida:

{ "Bot": { "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", "DisplayName": "myBot (Bot)", "BotType": "ChatBot", "Disabled": false, "CreatedTimestamp": "2019-09-09T18:05:56.749Z", "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", "BotEmail": "myBot-chimebot@example.com", "SecurityToken": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" } }

Para obtener más información, consulte Uso de bots de chat con Amazon Chime en la Guía para desarrolladores de Amazon Chime.

  • Para API obtener más información, consulte la Referencia ListBotsde AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlolist-phone-number-orders.

AWS CLI

Para enumerar los pedidos de números de teléfono

El siguiente list-phone-number-orders ejemplo muestra los pedidos con números de teléfono asociados a la cuenta del administrador de Amazon Chime.

aws chime list-phone-number-orders

Salida:

{ "PhoneNumberOrders": [ { "PhoneNumberOrderId": "abc12345-de67-89f0-123g-h45i678j9012", "ProductType": "VoiceConnector", "Status": "Partial", "OrderedPhoneNumbers": [ { "E164PhoneNumber": "+12065550100", "Status": "Acquired" }, { "E164PhoneNumber": "+12065550101", "Status": "Acquired" }, { "E164PhoneNumber": "+12065550102", "Status": "Failed" } ], "CreatedTimestamp": "2019-08-09T21:35:21.427Z", "UpdatedTimestamp": "2019-08-09T21:35:31.926Z" } { "PhoneNumberOrderId": "cba54321-ed76-09f5-321g-h54i876j2109", "ProductType": "BusinessCalling", "Status": "Partial", "OrderedPhoneNumbers": [ { "E164PhoneNumber": "+12065550103", "Status": "Acquired" }, { "E164PhoneNumber": "+12065550104", "Status": "Acquired" }, { "E164PhoneNumber": "+12065550105", "Status": "Failed" } ], "CreatedTimestamp": "2019-08-09T21:35:21.427Z", "UpdatedTimestamp": "2019-08-09T21:35:31.926Z" } ] }

Para obtener más información, consulte Uso de números de teléfono en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarlolist-phone-numbers.

AWS CLI

Para enumerar los números de teléfono de una cuenta de Amazon Chime

El siguiente list-phone-numbers ejemplo muestra los números de teléfono asociados a la cuenta Amazon Chime del administrador.

aws chime list-phone-numbers

Este comando no genera ninguna salida. Salida:

{ "PhoneNumbers": [ { "PhoneNumberId": "%2B12065550100", "E164PhoneNumber": "+12065550100", "Type": "Local", "ProductType": "VoiceConnector", "Status": "Assigned", "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-12T22:10:20.521Z", "UpdatedTimestamp": "2019-10-28T18:42:07.964Z" }, { "PhoneNumberId": "%2B12065550101", "E164PhoneNumber": "+12065550101", "Type": "Local", "ProductType": "VoiceConnector", "Status": "Assigned", "Capabilities": { "InboundCall": true, "OutboundCall": true, "InboundSMS": true, "OutboundSMS": true, "InboundMMS": true, "OutboundMMS": true }, "Associations": [ { "Value": "abcdef1ghij2klmno3pqr4", "Name": "VoiceConnectorId", "AssociatedTimestamp": "2019-10-28T18:40:37.511Z" } ], "CallingNameStatus": "UpdateInProgress", "CreatedTimestamp": "2019-08-12T22:10:20.521Z", "UpdatedTimestamp": "2019-10-28T18:42:07.960Z" } ] }

Para obtener más información, consulte Uso de números de teléfono en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte ListPhoneNumbersla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlolist-proxy-sessions.

AWS CLI

Para mostrar una lista de las sesiones de proxy

En el siguiente list-proxy-sessions ejemplo, se enumeran las sesiones de proxy de su conector de voz Amazon Chime.

aws chime list-proxy-sessions \ --voice-connector-id abcdef1ghij2klmno3pqr4

Salida:

{ "ProxySession": { "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "ProxySessionId": "123a4bc5-67d8-901e-2f3g-h4ghjk56789l", "Status": "Open", "ExpiryMinutes": 60, "Capabilities": [ "SMS", "Voice" ], "CreatedTimestamp": "2020-04-15T16:10:10.288Z", "UpdatedTimestamp": "2020-04-15T16:10:10.288Z", "Participants": [ { "PhoneNumber": "+12065550100", "ProxyPhoneNumber": "+19135550199" }, { "PhoneNumber": "+14015550101", "ProxyPhoneNumber": "+19135550199" } ] } }

Para obtener más información, consulte Proxy Phone Sessions en la Guía para desarrolladores de Amazon Chime.

  • Para API obtener más información, consulte ListProxySessionsla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlolist-room-memberships.

AWS CLI

Para enumerar las membresías de las salas

En el siguiente list-room-memberships ejemplo, se muestra una lista de los detalles de pertenencia a la sala de chat especificada.

aws chime list-room-memberships \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j

Salida:

{ "RoomMemberships": [ { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Member": { "MemberId": "2ab2345c-67de-8901-f23g-45h678901j2k", "MemberType": "User", "Email": "zhangw@example.com", "FullName": "Zhang Wei", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45" }, "Role": "Member", "InvitedBy": "arn:aws:iam::111122223333:user/alejandro", "UpdatedTimestamp": "2019-12-02T22:46:58.532Z" }, { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Member": { "MemberId": "1ab2345c-67de-8901-f23g-45h678901j2k", "MemberType": "User", "Email": "janed@example.com", "FullName": "Jane Doe", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45" }, "Role": "Administrator", "InvitedBy": "arn:aws:iam::111122223333:user/alejandro", "UpdatedTimestamp": "2019-12-02T22:46:58.532Z" } ] }

Para obtener más información, consulte Creación de una sala de chat en la Guía del usuario de Amazon Chime.

  • Para API obtener más información, consulte ListRoomMembershipsla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlolist-rooms.

AWS CLI

Para mostrar una lista de salas de chat

En el siguiente list-rooms ejemplo, se muestra una lista de salas de chat de la cuenta especificada. La lista se filtra solo para incluir las salas de chat a las que pertenece el miembro especificado.

aws chime list-rooms \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --member-id 1ab2345c-67de-8901-f23g-45h678901j2k

Salida:

{ "Room": { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Name": "teamRoom", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", "CreatedBy": "arn:aws:iam::111122223333:user/alejandro", "CreatedTimestamp": "2019-12-02T22:29:31.549Z", "UpdatedTimestamp": "2019-12-02T22:33:19.310Z" } }

Para obtener más información, consulte Creación de una sala de chat en la Guía del usuario de Amazon Chime.

  • Para API obtener más información, consulte ListRoomsla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlolist-users.

AWS CLI

Para enumerar los usuarios de una cuenta

En el siguiente list-users ejemplo, se enumeran los usuarios de la cuenta de Amazon Chime especificada.

aws chime list-users --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

Salida:

{ "Users": [ { "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "PrimaryEmail": "mariag@example.com", "DisplayName": "Maria Garcia", "LicenseType": "Pro", "UserType": "PrivateUser", "UserRegistrationStatus": "Registered", "RegisteredOn": "2018-12-20T18:45:25.231Z" "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": false } }, { "UserId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "PrimaryEmail": "richardr@example.com", "DisplayName": "Richard Roe", "LicenseType": "Pro", "UserType": "PrivateUser", "UserRegistrationStatus": "Registered", "RegisteredOn": "2018-12-20T18:45:45.415Z" "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": false } }, { "UserId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "PrimaryEmail": "saanvis@example.com", "DisplayName": "Saanvi Sarkar", "LicenseType": "Basic", "UserType": "PrivateUser", "UserRegistrationStatus": "Registered", "RegisteredOn": "2018-12-20T18:46:57.747Z" "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": false } }, { "UserId": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "PrimaryEmail": "wxiulan@example.com", "DisplayName": "Wang Xiulan", "LicenseType": "Basic", "UserType": "PrivateUser", "UserRegistrationStatus": "Registered", "RegisteredOn": "2018-12-20T18:47:15.390Z" "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": false } } ] }

Para obtener más información, consulte Administración de usuarios en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte ListUsersla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlolist-voice-connector-groups.

AWS CLI

Para enumerar los grupos de conectores de voz de Amazon Chime para una cuenta de Amazon Chime

En el siguiente list-voice-connector-groups ejemplo, se enumeran los grupos de conectores de voz de Amazon Chime asociados a la cuenta de Amazon Chime del administrador.

aws chime list-voice-connector-groups

Salida:

{ "VoiceConnectorGroups": [ { "VoiceConnectorGroupId": "123a456b-c7d8-90e1-fg23-4h567jkl8901", "Name": "myGroup", "VoiceConnectorItems": [], "CreatedTimestamp": "2019-09-18T16:38:34.734Z", "UpdatedTimestamp": "2019-09-18T16:38:34.734Z" } ] }

Para obtener más información, consulte Uso de grupos de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarlolist-voice-connector-termination-credentials.

AWS CLI

Para recuperar una lista de credenciales de terminación

En el siguiente list-voice-connector-termination-credentials ejemplo, se recupera una lista de las credenciales de terminación del conector de voz Amazon Chime especificado.

aws chime list-voice-connector-termination-credentials \ --voice-connector-id abcdef1ghij2klmno3pqr4

Este comando no genera ninguna salida. Salida:

{ "Usernames": [ "jdoe" ] }

Para obtener más información, consulte Uso de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarlolist-voice-connectors.

AWS CLI

Para enumerar los conectores de voz de Amazon Chime para una cuenta

En el siguiente list-voice-connectors ejemplo, se enumeran los conectores de voz de Amazon Chime asociados a la cuenta de la persona que llama.

aws chime list-voice-connectors

Salida:

{ "VoiceConnectors": [ { "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "AwsRegion": "us-east-1", "Name": "MyVoiceConnector", "OutboundHostName": "abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws", "RequireEncryption": true, "CreatedTimestamp": "2019-06-04T18:46:56.508Z", "UpdatedTimestamp": "2019-09-18T16:33:00.806Z" }, { "VoiceConnectorId": "cbadef1ghij2klmno3pqr5", "AwsRegion": "us-west-2", "Name": "newVoiceConnector", "OutboundHostName": "cbadef1ghij2klmno3pqr5.voiceconnector.chime.aws", "RequireEncryption": true, "CreatedTimestamp": "2019-09-18T20:34:01.352Z", "UpdatedTimestamp": "2019-09-18T20:34:01.352Z" } ] }

Para obtener más información, consulte Uso de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte la Referencia ListVoiceConnectorsde AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlologout-user.

AWS CLI

Para cerrar la sesión de un usuario

En el siguiente logout-user ejemplo, se cierra la sesión del usuario especificado.

aws chime logout-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE

Este comando no genera ninguna salida.

  • Para API obtener más información, consulte LogoutUserla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloput-voice-connector-logging-configuration.

AWS CLI

Para añadir una configuración de registro para un conector de voz de Amazon Chime

El siguiente put-voice-connector-logging-configuration ejemplo activa la configuración de SIP registro para el conector de voz Amazon Chime especificado.

aws chime put-voice-connector-logging-configuration \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --logging-configuration EnableSIPLogs=true

Salida:

{ "LoggingConfiguration": { "EnableSIPLogs": true } }

Para obtener más información, consulte Transmisión de contenido multimedia de Amazon Chime Voice Connector a Kinesis en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloput-voice-connector-origination.

AWS CLI

Para configurar los ajustes de origen

El siguiente put-voice-connector-origination ejemplo configura el host de origen, el puerto, el protocolo, la prioridad y el peso del conector de voz Amazon Chime especificado.

aws chime put-voice-connector-origination \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --origination Routes=[{Host="10.24.34.0",Port=1234,Protocol="TCP",Priority=1,Weight=5}],Disabled=false

Salida:

{ "Origination": { "Routes": [ { "Host": "10.24.34.0", "Port": 1234, "Protocol": "TCP", "Priority": 1, "Weight": 5 } ], "Disabled": false } }

Para obtener más información, consulte Uso de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloput-voice-connector-proxy.

AWS CLI

Para poner una configuración de proxy

El siguiente put-voice-connector-proxy ejemplo establece una configuración de proxy para su conector de voz Amazon Chime.

aws chime put-voice-connector-proxy \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --default-session-expiry-minutes 60 \ --phone-number-pool-countries "US"

Salida:

{ "Proxy": { "DefaultSessionExpiryMinutes": 60, "Disabled": false, "PhoneNumberCountries": [ "US" ] } }

Para obtener más información, consulte Proxy Phone Sessions en la Guía para desarrolladores de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloput-voice-connector-streaming-configuration.

AWS CLI

Para crear una configuración de streaming

En el siguiente put-voice-connector-streaming-configuration ejemplo, se crea una configuración de streaming para el conector de voz Amazon Chime especificado. Permite la transmisión de contenido multimedia desde el conector de voz de Amazon Chime a Amazon Kinesis y establece el período de retención de datos en 24 horas.

aws chime put-voice-connector-streaming-configuration \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --streaming-configuration DataRetentionInHours=24,Disabled=false

Salida:

{ "StreamingConfiguration": { "DataRetentionInHours": 24, "Disabled": false } }

Para obtener más información, consulte Transmisión de datos del conector de voz de Amazon Chime a Kinesis en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloput-voice-connector-termination-credentials.

AWS CLI

Para configurar las credenciales de terminación

El siguiente put-voice-connector-termination-credentials ejemplo establece las credenciales de terminación para el conector de voz Amazon Chime especificado.

aws chime put-voice-connector-termination-credentials \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --credentials Username="jdoe",Password="XXXXXXXX"

Este comando no genera ninguna salida.

Para obtener más información, consulte Uso de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloput-voice-connector-termination.

AWS CLI

Para configurar los ajustes de terminación

El siguiente put-voice-connector-termination ejemplo establece las regiones de llamada y la configuración de terminación del host IP permitido para el conector de voz Amazon Chime especificado.

aws chime put-voice-connector-termination \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --termination CallingRegions="US",CidrAllowedList="10.24.34.0/23",Disabled=false

Salida:

{ "Termination": { "CpsLimit": 0, "CallingRegions": [ "US" ], "CidrAllowedList": [ "10.24.34.0/23" ], "Disabled": false } }

Para obtener más información, consulte Uso de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloregenerate-security-token.

AWS CLI

Para regenerar un token de seguridad

En el siguiente regenerate-security-token ejemplo, se regenera el token de seguridad del bot especificado.

aws chime regenerate-security-token \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k

Salida:

{ "Bot": { "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", "DisplayName": "myBot (Bot)", "BotType": "ChatBot", "Disabled": false, "CreatedTimestamp": "2019-09-09T18:05:56.749Z", "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", "BotEmail": "myBot-chimebot@example.com", "SecurityToken": "je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY" } }

Para obtener más información, consulte Autenticación de solicitudes de bots de chat en la Guía para desarrolladores de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloreset-personal-pin.

AWS CLI

Para restablecer la reunión personal de un usuario PIN

El siguiente reset-personal-pin ejemplo restablece la reunión PIN personal del usuario especificado.

aws chime reset-personal-pin \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE

Salida:

{ "User": { "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "PrimaryEmail": "mateo@example.com", "DisplayName": "Mateo Jackson", "LicenseType": "Pro", "UserType": "PrivateUser", "UserRegistrationStatus": "Registered", "RegisteredOn": "2018-12-20T18:45:25.231Z", "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": False, "AlexaForBusinessRoomArn": "null" }, "PersonalPIN": "XXXXXXXXXX" } }

Para obtener más información, consulte Cambiar una reunión personal PINs en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte ResetPersonalPinla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlorestore-phone-number.

AWS CLI

Para restaurar un número de teléfono

El siguiente restore-phone-number ejemplo restaura el número de teléfono especificado de la cola de eliminación.

aws chime restore-phone-number \ --phone-number-id "+12065550100"

Salida:

{ "PhoneNumber": { "PhoneNumberId": "%2B12065550100", "E164PhoneNumber": "+12065550100", "Type": "Local", "ProductType": "BusinessCalling", "Status": "Unassigned", "Capabilities": { "InboundCall": true, "OutboundCall": true, "InboundSMS": true, "OutboundSMS": true, "InboundMMS": true, "OutboundMMS": true }, "Associations": [], "CreatedTimestamp": "2019-08-09T21:35:21.445Z", "UpdatedTimestamp": "2019-08-12T22:06:36.355Z" } }

Para obtener más información, consulte Uso de números de teléfono en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte RestorePhoneNumberla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlosearch-available-phone-numbers.

AWS CLI

Para buscar números de teléfono disponibles

En el siguiente search-available-phone-numbers ejemplo, se buscan los números de teléfono disponibles por código de área.

aws chime search-available-phone-numbers \ --area-code "206"

Salida:

{ "E164PhoneNumbers": [ "+12065550100", "+12065550101", "+12065550102", "+12065550103", "+12065550104", "+12065550105", "+12065550106", "+12065550107", "+12065550108", "+12065550109", ] }

Para obtener más información, consulte Uso de números de teléfono en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloupdate-account-settings.

AWS CLI

Para actualizar la configuración de tu cuenta

El siguiente update-account-settings ejemplo deshabilita el control remoto de las pantallas compartidas para la cuenta de Amazon Chime especificada.

aws chime update-account-settings \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --account-settings DisableRemoteControl=true

Este comando no genera ninguna salida.

El siguiente ejemplo de código muestra cómo usarloupdate-account.

AWS CLI

Para actualizar una cuenta

En el siguiente update-account ejemplo, se actualiza el nombre de la cuenta especificada.

aws chime update-account \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --name MyAccountName

Salida:

{ "Account": { "AwsAccountId": "111122223333", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "Name": "MyAccountName", "AccountType": "Team", "CreatedTimestamp": "2018-09-04T21:44:22.292Z", "DefaultLicense": "Pro", "SupportedLicenses": [ "Basic", "Pro" ], "SigninDelegateGroups": [ { "GroupName": "myGroup" }, ] } }

Para obtener más información, consulte Cambiar el nombre de su cuenta en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte la Referencia UpdateAccountde AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloupdate-bot.

AWS CLI

Para actualizar un bot

En el siguiente update-bot ejemplo, se actualiza el estado del bot especificado para impedir su ejecución.

aws chime update-bot \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k \ --disabled

Salida:

{ "Bot": { "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", "DisplayName": "myBot (Bot)", "BotType": "ChatBot", "Disabled": true, "CreatedTimestamp": "2019-09-09T18:05:56.749Z", "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", "BotEmail": "myBot-chimebot@example.com", "SecurityToken": "je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY" } }

Para obtener más información, consulte Actualizar los bots de chat en la Guía para desarrolladores de Amazon Chime.

  • Para API obtener más información, consulte UpdateBotla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloupdate-global-settings.

AWS CLI

Para actualizar la configuración global

En el siguiente update-global-settings ejemplo, se actualiza el bucket de S3 que se utiliza para almacenar los registros de detalles de llamadas de Amazon Chime Business Calling y Amazon Chime Voice Connectors asociados a la cuenta del administrador. AWS

aws chime update-global-settings \ --business-calling CdrBucket="s3bucket" \ --voice-connector CdrBucket="s3bucket"

Este comando no genera ninguna salida.

Para obtener más información, consulte Gestión de la configuración global en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte UpdateGlobalSettingsla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloupdate-phone-number-settings.

AWS CLI

Para actualizar el nombre de una llamada saliente

En el siguiente update-phone-number-settings ejemplo, se actualiza el nombre de llamada saliente predeterminado de la cuenta del AWS administrador.

aws chime update-phone-number-settings \ --calling-name "myName"

Este comando no genera ninguna salida.

Para obtener más información, consulte Uso de números de teléfono en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloupdate-phone-number.

AWS CLI

Ejemplo 1: Para actualizar el tipo de producto de un número de teléfono

En el siguiente update-phone-number ejemplo, se actualiza el tipo de producto del número de teléfono especificado.

aws chime update-phone-number \ --phone-number-id "+12065550100" \ --product-type "BusinessCalling"

Salida:

{ "PhoneNumber": { "PhoneNumberId": "%2B12065550100", "E164PhoneNumber": "+12065550100", "Type": "Local", "ProductType": "BusinessCalling", "Status": "Unassigned", "Capabilities": { "InboundCall": true, "OutboundCall": true, "InboundSMS": true, "OutboundSMS": true, "InboundMMS": true, "OutboundMMS": true }, "Associations": [], "CallingName": "phonenumber1", "CreatedTimestamp": "2019-08-09T21:35:21.445Z", "UpdatedTimestamp": "2019-08-12T21:44:07.591Z" } }

Ejemplo 2: Para actualizar el nombre de la llamada saliente de un número de teléfono

En el siguiente update-phone-number ejemplo, se actualiza el nombre de la llamada saliente del número de teléfono especificado.

as chime update-phone-number: phone-number-id «+12065550100" --nombre de llamada «phonenumber2"

Salida:

{ "PhoneNumber": { "PhoneNumberId": "%2B12065550100", "E164PhoneNumber": "+12065550100", "Type": "Local", "ProductType": "BusinessCalling", "Status": "Unassigned", "Capabilities": { "InboundCall": true, "OutboundCall": true, "InboundSMS": true, "OutboundSMS": true, "InboundMMS": true, "OutboundMMS": true }, "Associations": [], "CallingName": "phonenumber2", "CreatedTimestamp": "2019-08-09T21:35:21.445Z", "UpdatedTimestamp": "2019-08-12T21:44:07.591Z" } }

Para obtener más información, consulte Uso de números de teléfono en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte UpdatePhoneNumberla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloupdate-proxy-session.

AWS CLI

Para actualizar una sesión de proxy

En el siguiente update-proxy-session ejemplo, se actualizan las capacidades de la sesión de proxy.

aws chime update-proxy-session \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --proxy-session-id 123a4bc5-67d8-901e-2f3g-h4ghjk56789l \ --capabilities "Voice"

Salida:

{ "ProxySession": { "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "ProxySessionId": "123a4bc5-67d8-901e-2f3g-h4ghjk56789l", "Status": "Open", "ExpiryMinutes": 60, "Capabilities": [ "Voice" ], "CreatedTimestamp": "2020-04-15T16:10:10.288Z", "UpdatedTimestamp": "2020-04-15T16:10:10.288Z", "Participants": [ { "PhoneNumber": "+12065550100", "ProxyPhoneNumber": "+19135550199" }, { "PhoneNumber": "+14015550101", "ProxyPhoneNumber": "+19135550199" } ] } }

Para obtener más información, consulte Proxy Phone Sessions en la Guía para desarrolladores de Amazon Chime.

  • Para API obtener más información, consulte UpdateProxySessionla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloupdate-room-membership.

AWS CLI

Para actualizar la membresía de una sala

En el siguiente update-room-membership ejemplo, se modifica el rol del miembro de la sala de chat especificado aAdministrator.

aws chime update-room-membership \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ --member-id 1ab2345c-67de-8901-f23g-45h678901j2k \ --role Administrator

Salida:

{ "RoomMembership": { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Member": { "MemberId": "1ab2345c-67de-8901-f23g-45h678901j2k", "MemberType": "User", "Email": "sofiamartinez@example.com", "FullName": "Sofia Martinez", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45" }, "Role": "Administrator", "InvitedBy": "arn:aws:iam::111122223333:user/admin", "UpdatedTimestamp": "2019-12-02T22:40:22.931Z" } }

Para obtener más información, consulte Creación de una sala de chat en la Guía del usuario de Amazon Chime.

  • Para API obtener más información, consulte UpdateRoomMembershipla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloupdate-room.

AWS CLI

Para actualizar una sala de chat

En el siguiente update-room ejemplo, se modifica el nombre de la sala de chat especificada.

aws chime update-room \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ --name teamRoom

Salida:

{ "Room": { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Name": "teamRoom", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", "CreatedBy": "arn:aws:iam::111122223333:user/alejandro", "CreatedTimestamp": "2019-12-02T22:29:31.549Z", "UpdatedTimestamp": "2019-12-02T22:33:19.310Z" } }

Para obtener más información, consulte Creación de una sala de chat en la Guía del usuario de Amazon Chime.

  • Para API obtener más información, consulte UpdateRoomla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloupdate-user-settings.

AWS CLI

Para actualizar la configuración de usuario

El siguiente update-user-settings ejemplo permite al usuario especificado realizar llamadas entrantes y salientes y enviar y recibir SMS mensajes.

aws chime update-user-settings \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --user-id 1ab2345c-67de-8901-f23g-45h678901j2k \ --user-settings "Telephony={InboundCalling=true,OutboundCalling=true,SMS=true}"

Este comando no genera ninguna salida.

Para obtener más información, consulte Administrar los números de teléfono de los usuarios en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte UpdateUserSettingsla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloupdate-user.

AWS CLI

Para actualizar los detalles del usuario

En este ejemplo, se actualizan los detalles especificados para el usuario especificado.

Comando:

aws chime update-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE \ --license-type "Basic"

Salida:

{ "User": { "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" } }
  • Para API obtener más información, consulte UpdateUserla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloupdate-voice-connector-group.

AWS CLI

Para actualizar los detalles de un grupo de conectores de voz de Amazon Chime

En el siguiente update-voice-connector-group ejemplo, se actualizan los detalles del grupo de conectores de voz de Amazon Chime especificado.

aws chime update-voice-connector-group \ --voice-connector-group-id 123a456b-c7d8-90e1-fg23-4h567jkl8901 \ --name "newGroupName" \ --voice-connector-items VoiceConnectorId=abcdef1ghij2klmno3pqr4,Priority=1

Salida:

{ "VoiceConnectorGroup": { "VoiceConnectorGroupId": "123a456b-c7d8-90e1-fg23-4h567jkl8901", "Name": "newGroupName", "VoiceConnectorItems": [ { "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "Priority": 1 } ], "CreatedTimestamp": "2019-09-18T16:38:34.734Z", "UpdatedTimestamp": "2019-10-28T19:00:57.081Z" } }

Para obtener más información, consulte Uso de grupos de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

El siguiente ejemplo de código muestra cómo usarloupdate-voice-connector.

AWS CLI

Para actualizar los detalles de un conector de voz de Amazon Chime

En el siguiente update-voice-connector ejemplo, se actualiza el nombre del conector de voz Amazon Chime especificado.

aws chime update-voice-connector \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --name newName \ --require-encryption

Salida:

{ "VoiceConnector": { "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "AwsRegion": "us-west-2", "Name": "newName", "OutboundHostName": "abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws", "RequireEncryption": true, "CreatedTimestamp": "2019-09-18T20:34:01.352Z", "UpdatedTimestamp": "2019-09-18T20:40:52.895Z" } }

Para obtener más información, consulte Uso de conectores de voz de Amazon Chime en la Guía de administración de Amazon Chime.

  • Para API obtener más información, consulte la Referencia UpdateVoiceConnectorde AWS CLI comandos.