Ejemplos de Amazon Chime que utilizan la AWS CLI
En los siguientes ejemplos de código se muestra cómo realizar acciones e implementar situaciones comunes usando la AWS Command Line Interface con 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.
En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.
Temas
Acciones
En el siguiente ejemplo de código, se muestra cómo utilizar associate-phone-number-with-user
.
- AWS CLI
-
Asociación de un número de teléfono a un usuario
En el siguiente ejemplo de
associate-phone-number-with-user
, se 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-id1ab2345c-67de-8901-f23g-45h678901j2k
\ --e164-phone-number"+12065550100"
Este comando no genera ninguna salida.
Para obtener más información, consulte Managing User Phone Numbers en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte AssociatePhoneNumberWithUser
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar associate-phone-numbers-with-voice-connector-group
.
- AWS CLI
-
Asociación de números de teléfono a un grupo de Amazon Chime Voice Connector
En el siguiente ejemplo de
associate-phone-numbers-with-voice-connector-group
, se asocian los números de teléfono especificados a un grupo de Amazon Chime Voice Connector.aws chime associate-phone-numbers-with-voice-connector-group \ --voice-connector-group-id
123a456b-c7d8-90e1-fg23-4h567jkl8901
\ --e164-phone-numbers"+12065550100"
"+12065550101"
\ --force-associateSalida:
{ "PhoneNumberErrors": [] }
Para obtener más información, consulte Working with Amazon Chime Voice Connector groups en la Guía de administración de Amazon Chime.
-
Para obtener más información sobre la API, consulte AssociatePhoneNumbersWithVoiceConnectorGroup
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar associate-phone-numbers-with-voice-connector
.
- AWS CLI
-
Asociación de números de teléfono a un Amazon Chime Voice Connector
En el siguiente ejemplo de
associate-phone-numbers-with-voice-connector
, se asocian los números de teléfono especificados a un Amazon Chime Voice Connector.aws chime associate-phone-numbers-with-voice-connector \ --voice-connector-id
abcdef1ghij2klmno3pqr4
\ --e164-phone-numbers"+12065550100"
"+12065550101"
--force-associateSalida:
{ "PhoneNumberErrors": [] }
Para obtener más información, consulte Working with Amazon Chime Voice Connectors en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte AssociatePhoneNumbersWithVoiceConnector
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar associate-signin-delegate-groups-with-account
.
- AWS CLI
-
Para asociar grupos de delegados que inicien sesión
En el siguiente ejemplo de
associate-signin-delegate-groups-with-account
, se asocia el grupo de delegados de inicio de sesión especificado a la cuenta de Amazon Chime especificada.aws chime associate-signin-delegate-groups-with-account \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --signin-delegate-groupsGroupName=my_users
Este comando no genera ninguna salida.
Para obtener más información, consulte Managing User Access and Permissions en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte AssociateSigninDelegateGroupsWithAccount
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar batch-create-room-membership
.
- AWS CLI
-
Creación de suscripciones a varias salas
En el siguiente ejemplo de
batch-create-room-membership
, se agregan varios usuarios a una sala de chat como miembros de dicha sala de chat. También se asignan roles de administrador y miembro a los usuarios.aws chime batch-create-room-membership \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --room-idabcd1e2d-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 Creating a Chat Room en la Guía del usuario de Amazon Chime.
-
Para obtener información sobre la API, consulte BatchCreateRoomMembership
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar batch-delete-phone-number
.
- AWS CLI
-
Eliminación de varios números de teléfono
En el siguiente ejemplo de
batch-delete-phone-number
, 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 Working with Phone Numbers en la Guía de administración de Amazon Chime.
-
Para obtener más información sobre la API, consulte BatchDeletePhoneNumber
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar batch-suspend-user
.
- AWS CLI
-
Suspensión de varios usuarios
En el siguiente ejemplo de
batch-suspend-user
, se suspende a los usuarios indicados 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 obtener información sobre de la API, consulte BatchSuspendUser
en la Referencia de comandos de la AWS CLI
-
En el siguiente ejemplo de código, se muestra cómo utilizar batch-unsuspend-user
.
- AWS CLI
-
Anulación de la suspensión de varios usuarios
En el siguiente ejemplo de
batch-unsuspend-user
, se anula la suspensión anterior de los usuarios indicados en 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 obtener información sobre la API, consulte BatchUnsuspendUser
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar batch-update-phone-number
.
- AWS CLI
-
Actualización de varios tipos de productos de números de teléfono al mismo tiempo
En el siguiente ejemplo de
batch-update-phone-number
, 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": [] }
Actualización de varios nombres de llamadas de números de teléfono al mismo tiempo
En el siguiente ejemplo de
batch-update-phone-number
, se actualizan los nombres de llamadas 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 Working with Phone Numbers en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte BatchUpdatePhoneNumber
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar batch-update-user
.
- AWS CLI
-
Actualización de varios usuarios con un solo comando
En el siguiente ejemplo de
batch-update-user
, se actualiza elLicenseType
de cada uno de los usuarios indicados en la cuenta de Amazon Chime especificada.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 obtener detalles sobre la API, consulte BatchUpdateUser
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar create-account
.
- AWS CLI
-
Creación de una cuenta
En el siguiente ejemplo de
create-account
, se crea una cuenta de Amazon Chime en la cuenta de AWS del 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 Getting Started en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte CreateAccount
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar create-bot
.
- AWS CLI
-
Creación de un bot de Amazon Chime
En el siguiente ejemplo de
create-bot
, se crea un bot para la cuenta de Amazon Chime Enterprise 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 Integrate a Chat Bot with Amazon Chime en la Guía para desarrolladores de Amazon Chime.
-
Para obtener información sobre la API, consulte CreateBot
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar create-phone-number-order
.
- AWS CLI
-
Creación de un pedido de números de teléfono
En el siguiente ejemplo de
create-phone-number-order
, se crea un pedido 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 Working with Phone Numbers en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte CreatePhoneNumberOrder
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar create-proxy-session
.
- AWS CLI
-
Creación de una sesión de proxy
En el siguiente ejemplo de
create-proxy-session
, se crea una sesión de proxy con funciones de voz y SMS.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 obtener información sobre la API, consulte CreateProxySession
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar create-room-membership
.
- AWS CLI
-
Creación de una suscripción de sala
El siguiente ejemplo de
create-room-membership
, se agrega el usuario especificado a la sala de chat como miembro de dicha sala de chat.aws chime create-room-membership \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --room-idabcd1e2d-3e45-6789-01f2-3g45h67i890j
\ --member-id1ab2345c-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 Creating a Chat Room en la Guía del usuario de Amazon Chime.
-
Para obtener información sobre la API, consulte CreateRoomMembership
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar create-room
.
- AWS CLI
-
Creación de una sala de chat
En el siguiente ejemplo de
create-room
, se crea una sala de chat para la cuenta de Amazon Chime especificada.aws chime create-room \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --namechatRoom
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 Creating a Chat Room en la Guía del usuario de Amazon Chime.
-
Para obtener información sobre la API, consulte CreateRoom
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar create-user
.
- AWS CLI
-
Para crear un perfil de usuario para un dispositivo compartido
En el siguiente ejemplo de
create-user
, se 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
\ --emailroomdevice@example.com
\ --user-typeSharedDevice
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 Preparing for Setup en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte CreateUser
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar create-voice-connector-group
.
- AWS CLI
-
Para crear un grupo de Amazon Chime Voice Connectors
En el siguiente ejemplo de
create-voice-connector-group
, se crea un grupo de Amazon Chime Voice Connector que incluye el Amazon Chime Voice Connector especificado.aws chime create-voice-connector-group \ --name
myGroup
\ --voice-connector-itemsVoiceConnectorId=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 Working with Amazon Chime Voice Connector Groups en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte CreateVoiceConnectorGroup
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar create-voice-connector
.
- AWS CLI
-
Creación de un Amazon Chime Voice Connector
En el siguiente ejemplo de
create-voice-connector
, se crea un Amazon Chime Voice Connector en la región de AWS especificada con el cifrado activado.aws chime create-voice-connector \ --name
newVoiceConnector
\ --aws-regionus-west-2
\ --require-encryptionSalida:
{ "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 Working with Amazon Chime Voice Connectors en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte CreateVoiceConnector
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar delete-account
.
- AWS CLI
-
Eliminación de una cuenta
En el siguiente ejemplo de
delete-account
, 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 Deleting Your Account en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte DeleteAccount
en la Referencia de comandos de AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar delete-phone-number
.
- AWS CLI
-
Eliminación de un número de teléfono
En el siguiente ejemplo de
delete-phone-number
, se pasa 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 Working with Phone Numbers en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte DeletePhoneNumber
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar delete-proxy-session
.
- AWS CLI
-
Eliminación de una sesión de proxy
En el siguiente ejemplo de
delete-proxy-session
, se elimina la sesión de proxy especificada.aws chime delete-proxy-session \ --voice-connector-id
abcdef1ghij2klmno3pqr4
\ --proxy-session-id123a4bc5-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 obtener información sobre la API, consulte DeleteProxySession
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar delete-room-membership
.
- AWS CLI
-
Eliminación de la suscripción de un usuario a una sala de chat
En el siguiente ejemplo de
delete-room-membership
, se elimina al miembro especificado de la sala de chat indicada.aws chime delete-room-membership \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --room-idabcd1e2d-3e45-6789-01f2-3g45h67i890j
\ --member-id1ab2345c-67de-8901-f23g-45h678901j2k
Este comando no genera ninguna salida.
Para obtener más información, consulte Creating a Chat Room en la Guía del usuario de Amazon Chime.
-
Para obtener información sobre la API, consulte DeleteRoomMembership
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar delete-room
.
- AWS CLI
-
Eliminación de una sala de chat
En el siguiente ejemplo de
delete-room
, se borra la sala de chat especificada y se eliminan las suscripciones a dicha sala de chat.aws chime delete-room \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --room-idabcd1e2d-3e45-6789-01f2-3g45h67i890j
Este comando no genera ninguna salida.
Para obtener más información, consulte Creating a Chat Room en la Guía del usuario de Amazon Chime.
-
Para obtener información sobre la API, consulte DeleteRoom
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar delete-voice-connector-group
.
- AWS CLI
-
title
En el siguiente ejemplo de
delete-voice-connector-group
, se elimina el grupo de Amazon Chime Voice Connector 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 Working with Amazon Chime Voice Connector Groups en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte DeleteVoiceConnectorGroup
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar delete-voice-connector-origination
.
- AWS CLI
-
Eliminación de la configuración de origen
En el siguiente ejemplo de
delete-voice-connector-origination
, se eliminan el host, el puerto, el protocolo, la prioridad y el peso de origen del Amazon Chime Voice Connector especificado.aws chime delete-voice-connector-origination \ --voice-connector-id
abcdef1ghij2klmno3pqr4
Este comando no genera ninguna salida.
Para obtener más información, consulte Working with Amazon Chime Voice Connectors en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte DeleteVoiceConnectorOrigination
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar delete-voice-connector-proxy
.
- AWS CLI
-
Eliminación de una configuración de proxy
En el siguiente ejemplo de
delete-voice-connector-proxy
, se elimina la configuración de proxy del Amazon Chime Voice Connector.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.
-
Para obtener información sobre la API, consulte DeleteVoiceConnectorProxy
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar delete-voice-connector-streaming-configuration
.
- AWS CLI
-
Eliminación de una configuración de streaming
En el siguiente ejemplo de
delete-voice-connector-streaming-configuration
, se elimina la configuración de streaming del Amazon Chime Voice Connector 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 Streaming Amazon Chime Voice Connector Data to Kinesis en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte DeleteVoiceConnectorStreamingConfiguration
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar delete-voice-connector-termination-credentials
.
- AWS CLI
-
Eliminación de las credenciales de terminación
En el siguiente ejemplo de
delete-voice-connector-termination-credentials
, se eliminan las credenciales de terminación del nombre de usuario especificado y del Amazon Chime Voice Connector.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 Working with Amazon Chime Voice Connectors en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte DeleteVoiceConnectorTerminationCredentials
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar delete-voice-connector-termination
.
- AWS CLI
-
Eliminación de la configuración de terminación
En el siguiente ejemplo de
delete-voice-connector-termination
, se elimina la configuración de terminación del Amazon Chime Voice Connector especificado.aws chime delete-voice-connector-termination \ --voice-connector-id
abcdef1ghij2klmno3pqr4
Este comando no genera ninguna salida.
Para obtener más información, consulte Working with Amazon Chime Voice Connectors en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte DeleteVoiceConnectorTermination
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar delete-voice-connector
.
- AWS CLI
-
Eliminación de un Amazon Chime Voice Connector
En el siguiente ejemplo de
delete-voice-connector
se realiza.aws chime delete-voice-connector \ --voice-connector-id
abcdef1ghij2klmno3pqr4
Este comando no genera ninguna salida.
Para obtener más información, consulte Working with Amazon Chime Voice Connectors en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte DeleteVoiceConnector
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar disassociate-phone-number-from-user
.
- AWS CLI
-
Desasociación de un número de teléfono de un usuario
En el siguiente ejemplo de
disassociate-phone-number-from-user
, se 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-id1ab2345c-67de-8901-f23g-45h678901j2k
Este comando no genera ninguna salida.
Para obtener más información, consulte Managing User Phone Numbers en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte DisassociatePhoneNumberFromUser
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar disassociate-phone-numbers-from-voice-connector-group
.
- AWS CLI
-
Desasociación de números de teléfono de un grupo de Amazon Chime Voice Connector
En el siguiente ejemplo de
disassociate-phone-numbers-from-voice-connector-group
, se desasocian los números de teléfono especificados de un grupo de Amazon Chime Voice Connector.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 Working with Amazon Chime Voice Connector Groups en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte DisassociatePhoneNumbersFromVoiceConnectorGroup
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar disassociate-phone-numbers-from-voice-connector
.
- AWS CLI
-
Desasociación de los números de teléfono de un Amazon Chime Voice Connector
En el siguiente ejemplo de
disassociate-phone-numbers-from-voice-connector
, se desasocian los números de teléfono especificados de un Amazon Chime Voice Connector.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 Working with Amazon Chime Voice Connectors en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte DisassociatePhoneNumbersFromVoiceConnector
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar disassociate-signin-delegate-groups-from-account
.
- AWS CLI
-
Desasociación de grupos de delegados de inicio de sesión
En el siguiente ejemplo de
disassociate-signin-delegate-groups-from-account
, se 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 Managing User Access and Permissions en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte DisassociateSigninDelegateGroupsFromAccount
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar get-account-settings
.
- AWS CLI
-
Para obtener la configuración de una cuenta
En el siguiente ejemplo de
get-account-settings
, se obtiene 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 Managing Your Amazon Chime Accounts en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte GetAccountSettings
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar get-account
.
- AWS CLI
-
Para obtener los detalles de una cuenta
En siguiente ejemplo de
get-account
, se obtienen 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 Managing Your Amazon Chime Accounts en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte GetAccount
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar get-bot
.
- AWS CLI
-
Para obtener los detalles de un bot
En el siguiente ejemplo de
get-bot
, se muestran los detalles del bot especificado.aws chime get-bot \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --bot-id123abcd4-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 Update Chat Bots en la Guía para desarrolladores de Amazon Chime.
-
Para obtener información sobre la API, consulte GetBot
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar get-global-settings
.
- AWS CLI
-
Para obtener la configuración global
En el siguiente ejemplo de
get-global-settings
, se obtienen los nombres de los buckets de S3 que se utilizan para almacenar los registros de detalles de llamadas de los Amazon Chime Business Calling y Amazon Chime Voice Connector asociados a la cuenta de AWS del administrador.aws chime get-global-settings
Salida:
{ "BusinessCalling": { "CdrBucket": "s3bucket" }, "VoiceConnector": { "CdrBucket": "s3bucket" } }
Para obtener más información, consulte Managing Global Settings en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte GetGlobalSettings
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar get-phone-number-order
.
- AWS CLI
-
Para obtener los detalles de un pedido de números de teléfono
En el siguiente ejemplo de
get-phone-number-order
, 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 Working with Phone Numbers en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte GetPhoneNumberOrder
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar get-phone-number-settings
.
- AWS CLI
-
Para obtener el nombre de una llamada saliente
En el siguiente ejemplo de
get-phone-number-settings
, se obtiene el nombre de llamada saliente predeterminada de la cuenta de AWS del usuario iniciador.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 Working with Phone Numbers en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte GetPhoneNumberSettings
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar get-phone-number
.
- AWS CLI
-
Para obtener detalles del número de teléfono
En el siguiente ejemplo de
get-phone-number
, 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 Working with Phone Numbers en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte GetPhoneNumber
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar get-proxy-session
.
- AWS CLI
-
Para obtener detalles de la sesión de proxy
En el siguiente ejemplo de
get-proxy-session
, se genera una lista de los detalles de la sesión de proxy especificada.aws chime get-proxy-session \ --voice-connector-id
abcdef1ghij2klmno3pqr4
\ --proxy-session-id123a4bc5-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 obtener información sobre la API, consulte GetProxySession
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar get-room
.
- AWS CLI
-
Para obtener los detalles sobre una sala de chat
En el siguiente ejemplo de
get-room
, se muestran los detalles de la sala de chat especificada.aws chime get-room \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --room-idabcd1e2d-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 Creating a Chat Room en la Guía del usuario de Amazon Chime.
-
Para obtener información sobre la API, consulte GetRoom
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar get-user-settings
.
- AWS CLI
-
Para obtener la configuración del usuario
En el siguiente ejemplo de
get-user-settings
, se muestra la configuración de usuario especificada.aws chime get-user-settings \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --user-id1ab2345c-67de-8901-f23g-45h678901j2k
Salida:
{ "UserSettings": { "Telephony": { "InboundCalling": true, "OutboundCalling": true, "SMS": true } } }
Para obtener más información, consulte Managing User Phone Numbers en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte GetUserSettings
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar get-user
.
- AWS CLI
-
Para obtener los detalles de un usuario
En el siguiente ejemplo de
get-user
, se obtienen los detalles del usuario especificado.aws chime get-user \ --account-id
a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
\ --user-ida1b2c3d4-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 Managing Users en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte GetUser
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar get-voice-connector-group
.
- AWS CLI
-
Para obtener los detalles de un grupo de Amazon Chime Voice Connector
En el siguiente ejemplo de
get-voice-connector-group
, se muestran los detalles del grupo de Amazon Chime Voice Connector 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 Working with Amazon Chime Voice Connector Groups en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte GetVoiceConnectorGroup
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar get-voice-connector-logging-configuration
.
- AWS CLI
-
Para obtener los detalles de la configuración del registro
En el siguiente ejemplo de
get-voice-connector-logging-configuration
, se obtienen los detalles de la configuración de registro del Amazon Chime Voice Connector especificado.aws chime get-voice-connector-logging-configuration \ --voice-connector-id
abcdef1ghij2klmno3pqr4
Salida:
{ "LoggingConfiguration": { "EnableSIPLogs": true } }
Para obtener más información, consulte Streaming Amazon Chime Voice Connector Media to Kinesis en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte GetVoiceConnectorLoggingConfiguration
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar get-voice-connector-origination
.
- AWS CLI
-
Para obtener la configuración de origen
En el siguiente ejemplo de
get-voice-connector-origination
, se obtiene el host, el puerto, el protocolo, la prioridad y el peso de origen del Amazon Chime Voice Connector 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 Working with Amazon Chime Voice Connectors en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte GetVoiceConnectorOrigination
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar get-voice-connector-proxy
.
- AWS CLI
-
Para obtener detalles de la configuración del proxy
En el siguiente ejemplo de
get-voice-connector-proxy
, se obtienen los detalles de la configuración de proxy del Amazon Chime Voice Connector.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.
-
Para obtener información sobre la APl, consulte GetVoiceConnectorProxy
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar get-voice-connector-streaming-configuration
.
- AWS CLI
-
Para obtener detalles de la configuración de streaming
En el siguiente ejemplo de
get-voice-connector-streaming-configuration
, se obtienen los detalles de la configuración de streaming del Amazon Chime Voice Connector 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 Streaming Amazon Chime Voice Connector Data to Kinesis en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte GetVoiceConnectorStreamingConfiguration
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar get-voice-connector-termination-health
.
- AWS CLI
-
Para obtener detalles del estado de terminación
En el siguiente ejemplo de
get-voice-connector-termination-health
, se obtienen los detalles del estado de terminación del Amazon Chime Voice Connector 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 Working with Amazon Chime Voice Connectors en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte GetVoiceConnectorTerminationHealth
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar get-voice-connector-termination
.
- AWS CLI
-
Para obtener la configuración de terminación
En el siguiente ejemplo de
get-voice-connector-termination
, se obtiene la configuración de terminación del Amazon Chime Voice Connector 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 Working with Amazon Chime Voice Connectors en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte GetVoiceConnectorTermination
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar get-voice-connector
.
- AWS CLI
-
Para obtener detalles de un Amazon Chime Voice Connector
En el siguiente ejemplo de
get-voice-connector
, se muestran los detalles del Amazon Chime Voice Connector 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 Working with Amazon Chime Voice Connectors en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte GetVoiceConnector
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar invite-users
.
- AWS CLI
-
Invitación a los usuarios a unirse a Amazon Chime
En el siguiente ejemplo de
invite-users
, se 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 Inviting and Suspending Users en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte InviteUsers
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar list-accounts
.
- AWS CLI
-
Generación de una lista de cuentas
En el siguiente ejemplo de
list-accounts
, se genera una lista de las cuentas de Amazon Chime en la cuenta de AWS del administrador.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 Managing Your Amazon Chime Accounts en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte ListAccounts
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar list-bots
.
- AWS CLI
-
Para obtener una lista de bots
En el siguiente ejemplo de
list-bots
, se obtiene una lista de bots asociada 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 Use Chat Bots with Amazon Chime en la Guía para desarrolladores de Amazon Chime.
-
Para obtener información sobre la API, consulte ListBots
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar list-phone-number-orders
.
- AWS CLI
-
Generación de una lista de pedidos de números de teléfono
En el siguiente ejemplo de
list-phone-number-orders
, se genera una lista de los pedidos de números de teléfono asociados a la cuenta de Amazon Chime del administrador.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 Working with Phone Numbers en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte ListPhoneNumberOrders
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar list-phone-numbers
.
- AWS CLI
-
Generación de una lista de números de teléfono de una cuenta de Amazon Chime
En el siguiente ejemplo de
list-phone-numbers
, se genera una lista de los números de teléfono asociados a la cuenta de 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 Working with Phone Numbers en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte ListPhoneNumbers
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar list-proxy-sessions
.
- AWS CLI
-
Generación de una lista de sesiones de proxy
En el siguiente ejemplo de
list-proxy-sessions
, se genera una lista de sesiones de proxy del Amazon Chime Voice Connector.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 obtener información sobre la API, consulte ListProxySessions
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar list-room-memberships
.
- AWS CLI
-
Generación de una lista de suscripciones a la sala
En el siguiente ejemplo de
list-room-memberships
, se muestra una lista de los detalles de suscripción de la sala de chat especificada.aws chime list-room-memberships \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --room-idabcd1e2d-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 Creating a Chat Room en la Guía del usuario de Amazon Chime.
-
Para obtener información sobre la API, consulte ListRoomMemberships
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar list-rooms
.
- AWS CLI
-
Generación de una lista de salas de chat
En el siguiente ejemplo de
list-rooms
, se muestra una lista de salas de chat en la cuenta especificada. La lista se filtra para incluir solo las salas de chat a las que pertenece el miembro especificado.aws chime list-rooms \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --member-id1ab2345c-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 Creating a Chat Room en la Guía del usuario de Amazon Chime.
-
Para obtener información sobre la API, consulte ListRooms
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar list-users
.
- AWS CLI
-
Generación de una lista de los usuarios de una cuenta
En el siguiente ejemplo de
list-users
, se genera una lista de 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 Managing Users en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte ListUsers
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar list-voice-connector-groups
.
- AWS CLI
-
Generación de una lista de grupos de Amazon Chime Voice Connector para una cuenta de Amazon Chime
En el siguiente ejemplo de
list-voice-connector-groups
, se genera una lista de grupos de Amazon Chime Voice Connector asociada 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 Working with Amazon Chime Voice Connector groups en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte ListVoiceConnectorGroups
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar list-voice-connector-termination-credentials
.
- AWS CLI
-
Para obtener una lista de credenciales de terminación
En el siguiente ejemplo de
list-voice-connector-termination-credentials
, se obtiene una lista de las credenciales de terminación del Amazon Chime Voice Connector 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 Working with Amazon Chime Voice Connectors en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte ListVoiceConnectorTerminationCredentials
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar list-voice-connectors
.
- AWS CLI
-
Para generar una lista de Amazon Chime Voice Connector de una cuenta
En el siguiente ejemplo de
list-voice-connectors
, se genera una lista de los Amazon Chime Voice Connector asociados a la cuenta del iniciador.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 Working with Amazon Chime Voice Connectors en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte ListVoiceConnectors
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar logout-user
.
- AWS CLI
-
Cierre de sesión de un usuario
En el siguiente ejemplo de
logout-user
, se cierra la sesión del usuario especificado.aws chime logout-user \ --account-id
a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
\ --user-ida1b2c3d4-5678-90ab-cdef-22222EXAMPLE
Este comando no genera ninguna salida.
-
Para obtener información sobre la API, consulte LogoutUser
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar put-voice-connector-logging-configuration
.
- AWS CLI
-
Adición de una configuración de registro para un Amazon Chime Voice Connector
En el siguiente ejemplo de
put-voice-connector-logging-configuration
, se activa la configuración de registro SIP del Amazon Chime Voice Connector especificado.aws chime put-voice-connector-logging-configuration \ --voice-connector-id
abcdef1ghij2klmno3pqr4
\ --logging-configurationEnableSIPLogs=true
Salida:
{ "LoggingConfiguration": { "EnableSIPLogs": true } }
Para obtener más información, consulte Streaming Amazon Chime Voice Connector Media to Kinesis en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte PutVoiceConnectorLoggingConfiguration
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar put-voice-connector-origination
.
- AWS CLI
-
Ajuste de la configuración de origen
En el siguiente ejemplo de
put-voice-connector-origination
, se configura el host, el puerto, el protocolo, la prioridad y el peso de origen del Amazon Chime Voice Connector 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=falseSalida:
{ "Origination": { "Routes": [ { "Host": "10.24.34.0", "Port": 1234, "Protocol": "TCP", "Priority": 1, "Weight": 5 } ], "Disabled": false } }
Para obtener más información, consulte Working with Amazon Chime Voice Connectors en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte PutVoiceConnectorOrigination
en la Referencia de Cmdlet de AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar put-voice-connector-proxy
.
- AWS CLI
-
Establecimiento de una configuración de proxy
En el siguiente ejemplo de
put-voice-connector-proxy
, se establece una configuración de proxy para el Amazon Chime Voice Connector.aws chime put-voice-connector-proxy \ --voice-connector-id
abcdef1ghij2klmno3pqr4
\ --default-session-expiry-minutes60
\ --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.
-
Para obtener información sobre la API, consulte PutVoiceConnectorProxy
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar put-voice-connector-streaming-configuration
.
- AWS CLI
-
Creación de una configuración de streaming
En el siguiente ejemplo de
put-voice-connector-streaming-configuration
, se crea una configuración de streaming para el Amazon Chime Voice Connector especificado. Permite el streaming de contenido multimedia desde el Amazon Chime Voice Connector hasta 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-configurationDataRetentionInHours=24,Disabled=false
Salida:
{ "StreamingConfiguration": { "DataRetentionInHours": 24, "Disabled": false } }
Para obtener más información, consulte Streaming Amazon Chime Voice Connector Data to Kinesis en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte PutVoiceConnectorStreamingConfiguration
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar put-voice-connector-termination-credentials
.
- AWS CLI
-
Configuración de credenciales de terminación
En el siguiente ejemplo de
put-voice-connector-termination-credentials
, se establecen las credenciales de terminación del Amazon Chime Voice Connector 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 Working with Amazon Chime Voice Connectors en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte PutVoiceConnectorTerminationCredentials
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar put-voice-connector-termination
.
- AWS CLI
-
Establecimiento de la configuración de terminación
En el siguiente ejemplo de
put-voice-connector-termination
, se establece la configuración de terminación del host de IP permitido y las regiones iniciadoras en el Amazon Chime Voice Connector especificado.aws chime put-voice-connector-termination \ --voice-connector-id
abcdef1ghij2klmno3pqr4
\ --termination CallingRegions="US",CidrAllowedList="10.24.34.0/23",Disabled=falseSalida:
{ "Termination": { "CpsLimit": 0, "CallingRegions": [ "US" ], "CidrAllowedList": [ "10.24.34.0/23" ], "Disabled": false } }
Para obtener más información, consulte Working with Amazon Chime Voice Connectors en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte PutVoiceConnectorTermination
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar regenerate-security-token
.
- AWS CLI
-
Regeneración de un token de seguridad
En el siguiente ejemplo de
regenerate-security-token
, se regenera el token de seguridad del bot especificado.aws chime regenerate-security-token \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --bot-id123abcd4-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 Authenticate Chat Bot Requests en la Guía para desarrolladores de Amazon Chime.
-
Para obtener información sobre la API, consulte RegenerateSecurityToken
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar reset-personal-pin
.
- AWS CLI
-
Restablecimiento del PIN personal para reuniones de un usuario
En el siguiente ejemplo de
reset-personal-pin
, se restablece el PIN personal para reuniones de un usuario especificado.aws chime reset-personal-pin \ --account-id
a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
--user-ida1b2c3d4-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 Changing Personal Meeting PINs en la Guía para desarrolladores de Amazon Chime.
-
Para obtener información sobre la API, consulte ResetPersonalPin
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar restore-phone-number
.
- AWS CLI
-
Restauración de un número de teléfono
En el siguiente ejemplo de
restore-phone-number
, se restaura el número de teléfono especificado desde 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 Working with Phone Numbers en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte RestorePhoneNumber
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar search-available-phone-numbers
.
- AWS CLI
-
Búsqueda de números de teléfono disponibles
En el siguiente ejemplo de
search-available-phone-numbers
, 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 Working with Phone Numbers en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte SearchAvailablePhoneNumbers
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar update-account-settings
.
- AWS CLI
-
Actualización de la configuración de la cuenta
En el siguiente ejemplo de
update-account-settings
, se desactiva el control remoto de las pantallas compartidas en la cuenta de Amazon Chime especificada.aws chime update-account-settings \ --account-id
a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
\ --account-settingsDisableRemoteControl=true
Este comando no genera ninguna salida.
-
Para obtener información sobre la API, consulte UpdateAccountSettings
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar update-account
.
- AWS CLI
-
Actualización de una cuenta
En el siguiente ejemplo de
update-account
, se actualiza el nombre de la cuenta especificada.aws chime update-account \ --account-id
a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
\ --nameMyAccountName
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 Renaming Your Account en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte UpdateAccount
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar update-bot
.
- AWS CLI
-
Actualización de un bot
En el siguiente ejemplo de
update-bot
, se actualiza el estado del bot especificado para detener su ejecución.aws chime update-bot \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --bot-id123abcd4-5ef6-789g-0h12-34j56789012k
\ --disabledSalida:
{ "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 Update Chat Bots en la Guía para desarrolladores de Amazon Chime.
-
Para obtener información sobre la API, consulte UpdateBot
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar update-global-settings
.
- AWS CLI
-
Actualización de la configuración global
En el siguiente ejemplo de
update-global-settings
, se actualizan los buckets de S3 que se utilizan para almacenar los registros de detalles de llamadas de los Amazon Chime Business Calling y Amazon Chime Voice Connector asociados a la cuenta de AWS del administrador.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 Managing Global Settings en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte UpdateGlobalSettings
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar update-phone-number-settings
.
- AWS CLI
-
Actualización del nombre de llamada saliente
En el siguiente ejemplo de
update-phone-number-settings
, se actualiza el nombre de llamada saliente predeterminado de la cuenta de AWS del administrador.aws chime update-phone-number-settings \ --calling-name
"myName"
Este comando no genera ninguna salida.
Para obtener más información, consulte Working with Phone Numbers en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte UpdatePhoneNumberSettings
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar update-phone-number
.
- AWS CLI
-
Ejemplo 1: actualizar el tipo de producto de un número de teléfono
En el siguiente ejemplo de
update-phone-number
, 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: cómo actualizar el nombre de la llamada saliente de un número de teléfono
En el siguiente ejemplo de
update-phone-number
, se actualiza el nombre de la llamada saliente del número de teléfono especificado.aws chime update-phone-number --phone-number-id "+12065550100" --calling-name "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 Working with Phone Numbers en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte UpdatePhoneNumber
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar update-proxy-session
.
- AWS CLI
-
Actualización de una sesión de proxy
En el siguiente ejemplo de
update-proxy-session
, se actualizan las capacidades de la sesión de proxy.aws chime update-proxy-session \ --voice-connector-id
abcdef1ghij2klmno3pqr4
\ --proxy-session-id123a4bc5-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 obtener información acerca de la API, consulte UpdateProxySession
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar update-room-membership
.
- AWS CLI
-
Creación de una suscripción de sala
En el siguiente ejemplo de
update-room-membership
, se cambia el rol del miembro de la sala de chat especificado aAdministrator
.aws chime update-room-membership \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --room-idabcd1e2d-3e45-6789-01f2-3g45h67i890j
\ --member-id1ab2345c-67de-8901-f23g-45h678901j2k
\ --roleAdministrator
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 Creating a Chat Room en la Guía del usuario de Amazon Chime.
-
Para obtener información sobre la API, consulte UpdateRoomMembership
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar update-room
.
- AWS CLI
-
Actualización de una sala de chat
En el siguiente ejemplo de
update-room
, se cambia el nombre de la sala de chat especificada.aws chime update-room \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --room-idabcd1e2d-3e45-6789-01f2-3g45h67i890j
\ --nameteamRoom
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 Creating a Chat Room en la Guía del usuario de Amazon Chime.
-
Para obtener información sobre la API, consulte UpdateRoom
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar update-user-settings
.
- AWS CLI
-
Actualización de la configuración del usuario
En el siguiente ejemplo de
update-user-settings
, se permite al usuario especificado realizar llamadas entrantes y salientes, así como enviar y recibir mensajes SMS.aws chime update-user-settings \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --user-id1ab2345c-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 Managing User Phone Numbers en la Guía de administración de Amazon Chime.
-
Para obtener información acerca de la API, consulte UpdateUserSettings
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar update-user
.
- AWS CLI
-
Actualización de detalles del usuario
En este ejemplo se actualizan los detalles especificados del usuario especificado.
Comando:
aws chime update-user \ --account-id
a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
\ --user-ida1b2c3d4-5678-90ab-cdef-22222EXAMPLE
\ --license-type"Basic"
Salida:
{ "User": { "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" } }
-
Para obtener información sobre la API, consulte UpdateUser
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar update-voice-connector-group
.
- AWS CLI
-
Actualización de los detalles de un grupo de Amazon Chime Voice Connector
En el siguiente ejemplo de
update-voice-connector-group
, se actualizan los detalles del grupo de Amazon Chime Voice Connector especificado.aws chime update-voice-connector-group \ --voice-connector-group-id
123a456b-c7d8-90e1-fg23-4h567jkl8901
\ --name"newGroupName"
\ --voice-connector-itemsVoiceConnectorId=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 Working with Amazon Chime Voice Connector Groups en la Guía de administración de Amazon Chime.
-
Para obtener información sobre la API, consulte UpdateVoiceConnectorGroup
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar update-voice-connector
.
- AWS CLI
-
Actualización de los detalles de un Amazon Chime Voice Connector
En el siguiente ejemplo de
update-voice-connector
, se actualizan los detalles del Amazon Chime Voice Connector especificado.aws chime update-voice-connector \ --voice-connector-id
abcdef1ghij2klmno3pqr4
\ --namenewName
\ --require-encryptionSalida:
{ "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 Working with Amazon Chime Voice Connectors en la Guía de administración de Amazon Chime.
-
Para ver los detalles de la API, consulte UpdateVoiceConnector
en la Referencia de comandos de la AWS CLI.
-