Exemplos do Amazon Chime usando AWS CLI - AWS Command Line Interface
Ações

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Exemplos do Amazon Chime usando AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Amazon Chime.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar funções de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, onde você pode encontrar instruções sobre como configurar e executar o código no contexto.

Tópicos

Ações

O código de exemplo a seguir mostra como usar associate-phone-number-with-user.

AWS CLI

Para associar um número de telefone a um usuário

O associate-phone-number-with-user exemplo a seguir associa o número de telefone especificado a um usuário.

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 não produz saída.

Para obter mais informações, consulte Gerenciamento de números de telefone de usuários no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar associate-phone-numbers-with-voice-connector-group.

AWS CLI

Para associar números de telefone a um grupo do Amazon Chime Voice Connector

O associate-phone-numbers-with-voice-connector-group exemplo a seguir associa os números de telefone especificados a um grupo 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-associate

Saída:

{
    "PhoneNumberErrors": []
}

Para obter mais informações, consulte Como trabalhar com grupos do Amazon Chime Voice Connector no Guia de Administração do Amazon Chime.

O código de exemplo a seguir mostra como usar associate-phone-numbers-with-voice-connector.

AWS CLI

Para associar números de telefone a um Amazon Chime Voice Connector

O associate-phone-numbers-with-voice-connector exemplo a seguir associa os números de telefone especificados a um Amazon Chime Voice Connector.

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

Saída:

{
    "PhoneNumberErrors": []
}

Para obter mais informações, consulte Como trabalhar com conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar associate-signin-delegate-groups-with-account.

AWS CLI

Para associar grupos de delegados de login

O associate-signin-delegate-groups-with-account exemplo a seguir associa o grupo de delegados de login especificado à conta especificada do Amazon Chime.

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

Este comando não produz saída.

Para obter mais informações, consulte Gerenciamento de acesso e permissões de usuários no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar batch-create-room-membership.

AWS CLI

Para criar várias associações de salas

O batch-create-room-membership exemplo a seguir adiciona vários usuários a uma sala de bate-papo como membros da sala de bate-papo. Ele também atribui funções de administrador e membro aos usuários.

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"

Saída:

{
    "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 obter mais informações, consulte Criação de uma sala de bate-papo no Guia do usuário do Amazon Chime.

O código de exemplo a seguir mostra como usar batch-delete-phone-number.

AWS CLI

Para excluir vários números de telefone

O batch-delete-phone-number exemplo a seguir exclui todos os números de telefone especificados.

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

Este comando não produz saída. Saída:

{
    "PhoneNumberErrors": []
}

Para obter mais informações, consulte Como trabalhar com números de telefone no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar batch-suspend-user.

AWS CLI

Para suspender vários usuários

O batch-suspend-user exemplo a seguir suspende os usuários listados da conta especificada do Amazon Chime.

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"

Saída:

{
    "UserErrors": []
}

  • Para API obter detalhes, consulte BatchSuspendUserna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar batch-unsuspend-user.

AWS CLI

Para cancelar a suspensão de vários usuários

O batch-unsuspend-user exemplo a seguir remove qualquer suspensão anterior para os usuários listados na conta especificada do Amazon Chime.

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"

Saída:

{
    "UserErrors": []
}

O código de exemplo a seguir mostra como usar batch-update-phone-number.

AWS CLI

Para atualizar vários tipos de produtos com números de telefone ao mesmo tempo

O batch-update-phone-number exemplo a seguir atualiza os tipos de produtos para todos os números de telefone especificados.

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

Saída:

{
    "PhoneNumberErrors": []
}

Para atualizar vários números de telefone chamando nomes ao mesmo tempo

O batch-update-phone-number exemplo a seguir atualiza os nomes de chamada de todos os números de telefone especificados.

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

Saída:

{
    "PhoneNumberErrors": []
}

Para obter mais informações, consulte Como trabalhar com números de telefone no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar batch-update-user.

AWS CLI

Para atualizar vários usuários em um único comando

O batch-update-user exemplo a seguir atualiza o LicenseType para cada um dos usuários listados na conta especificada do Amazon Chime.

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"

Saída:

{
    "UserErrors": []
}

  • Para API obter detalhes, consulte BatchUpdateUserna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-account.

AWS CLI

Para criar uma conta

O create-account exemplo a seguir cria uma conta do Amazon Chime na conta do AWS administrador.

aws chime create-account \
    --name MyChimeAccount

Saída:

{
    "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 obter mais informações, consulte Conceitos básicos no Guia de administração do Amazon Chime.

  • Para API obter detalhes, consulte CreateAccountna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-bot.

AWS CLI

Para criar um bot do Amazon Chime

O create-bot exemplo a seguir cria um bot para a conta específica do Amazon Chime Enterprise.

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

Saída:

{
    "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 obter mais informações, consulte Integrar um bot de bate-papo com o Amazon Chime no Guia do desenvolvedor do Amazon Chime.

  • Para API obter detalhes, consulte CreateBotna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-phone-number-order.

AWS CLI

Para criar um pedido de número de telefone

O create-phone-number-order exemplo a seguir cria uma ordem de número de telefone para os números de telefone especificados.

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

Saída:

{
    "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 obter mais informações, consulte Como trabalhar com números de telefone no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar create-proxy-session.

AWS CLI

Para criar uma sessão de proxy

O create-proxy-session exemplo a seguir cria uma sessão de proxy com voz e SMS recursos.

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

Saída:

{
    "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 obter mais informações, consulte Proxy Phone Sessions no Amazon Chime Developer Guide.

O código de exemplo a seguir mostra como usar create-room-membership.

AWS CLI

Para criar uma associação de sala

O create-room-membership exemplo a seguir adiciona o usuário especificado à sala de bate-papo como membro da sala de bate-papo.

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

Saída:

{
    "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 obter mais informações, consulte Criação de uma sala de bate-papo no Guia do usuário do Amazon Chime.

O código de exemplo a seguir mostra como usar create-room.

AWS CLI

Para criar uma sala de bate-papo

O create-room exemplo a seguir cria uma sala de bate-papo para a conta especificada do Amazon Chime.

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

Saída:

{
    "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 obter mais informações, consulte Criação de uma sala de bate-papo no Guia do usuário do Amazon Chime.

  • Para API obter detalhes, consulte CreateRoomna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-user.

AWS CLI

Para criar um perfil de usuário para um dispositivo compartilhado

O create-user exemplo a seguir cria um perfil de dispositivo compartilhado para o endereço de e-mail especificado.

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

Saída:

{
    "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 obter mais informações, consulte Preparação para configuração no Guia de administração do Amazon Chime.

  • Para API obter detalhes, consulte CreateUserna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-voice-connector-group.

AWS CLI

Para criar um grupo do Amazon Chime Voice Connector

O create-voice-connector-group exemplo a seguir cria um grupo de Amazon Chime Voice Connector que inclui o Amazon Chime Voice Connector especificado.

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

Saída:

{
    "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 obter mais informações, consulte Como trabalhar com grupos de conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar create-voice-connector.

AWS CLI

Para criar um Amazon Chime Voice Connector

O create-voice-connector exemplo a seguir cria um Amazon Chime Voice Connector na AWS região especificada, com a criptografia ativada.

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

Saída:

{
    "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 obter mais informações, consulte Como trabalhar com conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar delete-account.

AWS CLI

Para excluir uma conta

O delete-account exemplo a seguir exclui a conta especificada.

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

Este comando não produz saída.

Para obter mais informações, consulte Excluindo sua conta no Guia de administração do Amazon Chime.

  • Para API obter detalhes, consulte DeleteAccountna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-phone-number.

AWS CLI

Para excluir um número de telefone

O delete-phone-number exemplo a seguir move o número de telefone especificado para a fila de exclusão.

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

Este comando não produz saída.

Para obter mais informações, consulte Como trabalhar com números de telefone no Guia de administração do Amazon Chime.

  • Para API obter detalhes, consulte DeletePhoneNumberna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-proxy-session.

AWS CLI

Para excluir uma sessão de proxy

O delete-proxy-session exemplo a seguir exclui a sessão de proxy especificada.

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

Este comando não produz saída.

Para obter mais informações, consulte Proxy Phone Sessions no Amazon Chime Developer Guide.

O código de exemplo a seguir mostra como usar delete-room-membership.

AWS CLI

Para remover um usuário como membro de uma sala de bate-papo

O delete-room-membership exemplo a seguir remove o membro especificado da sala de bate-papo 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 não produz saída.

Para obter mais informações, consulte Criação de uma sala de bate-papo no Guia do usuário do Amazon Chime.

O código de exemplo a seguir mostra como usar delete-room.

AWS CLI

Para excluir uma sala de bate-papo

O delete-room exemplo a seguir exclui a sala de bate-papo especificada e remove as associações da sala de bate-papo.

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

Este comando não produz saída.

Para obter mais informações, consulte Criação de uma sala de bate-papo no Guia do usuário do Amazon Chime.

  • Para API obter detalhes, consulte DeleteRoomna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-voice-connector-group.

AWS CLI

title

O delete-voice-connector-group exemplo a seguir exclui o grupo especificado do Amazon Chime Voice Connector.

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

Este comando não produz saída.

Para obter mais informações, consulte Como trabalhar com grupos de conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar delete-voice-connector-origination.

AWS CLI

Para excluir as configurações de originação

O delete-voice-connector-origination exemplo a seguir exclui o host de origem, a porta, o protocolo, a prioridade e o peso do Amazon Chime Voice Connector especificado.

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

Este comando não produz saída.

Para obter mais informações, consulte Como trabalhar com conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar delete-voice-connector-proxy.

AWS CLI

Para excluir uma configuração de proxy

O delete-voice-connector-proxy exemplo a seguir exclui a configuração de proxy do seu Amazon Chime Voice Connector.

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

Este comando não produz saída.

Para obter mais informações, consulte Proxy Phone Sessions no Amazon Chime Developer Guide.

O código de exemplo a seguir mostra como usar delete-voice-connector-streaming-configuration.

AWS CLI

Para excluir uma configuração de streaming

O delete-voice-connector-streaming-configuration exemplo a seguir exclui a configuração de streaming para o Amazon Chime Voice Connector especificado.

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

Este comando não produz saída.

Para obter mais informações, consulte Streaming de dados do Amazon Chime Voice Connector para o Kinesis no Guia de Administração do Amazon Chime.

O código de exemplo a seguir mostra como usar delete-voice-connector-termination-credentials.

AWS CLI

Para excluir as credenciais de rescisão

O delete-voice-connector-termination-credentials exemplo a seguir exclui as credenciais de rescisão do nome de usuário especificado e do Amazon Chime Voice Connector.

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

Este comando não produz saída.

Para obter mais informações, consulte Como trabalhar com conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar delete-voice-connector-termination.

AWS CLI

Para excluir as configurações de rescisão

O delete-voice-connector-termination exemplo a seguir exclui as configurações de terminação do Amazon Chime Voice Connector especificado.

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

Este comando não produz saída.

Para obter mais informações, consulte Como trabalhar com conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar delete-voice-connector.

AWS CLI

Para excluir um conector de voz do Amazon Chime

O delete-voice-connector exemplo a seguir faz isso

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

Este comando não produz saída.

Para obter mais informações, consulte Como trabalhar com conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar disassociate-phone-number-from-user.

AWS CLI

Para desassociar um número de telefone de um usuário

O disassociate-phone-number-from-user exemplo a seguir dissocia um número de telefone do usuário especificado.

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

Este comando não produz saída.

Para obter mais informações, consulte Gerenciamento de números de telefone de usuários no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar disassociate-phone-numbers-from-voice-connector-group.

AWS CLI

Para desassociar números de telefone de um grupo do Amazon Chime Voice Connector

O disassociate-phone-numbers-from-voice-connector-group exemplo a seguir desassocia os números de telefone especificados de um grupo do 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"

Saída:

{
    "PhoneNumberErrors": []
}

Para obter mais informações, consulte Como trabalhar com grupos de conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar disassociate-phone-numbers-from-voice-connector.

AWS CLI

Para desassociar números de telefone de um Amazon Chime Voice Connector

O disassociate-phone-numbers-from-voice-connector exemplo a seguir desassocia os números de telefone especificados de um Amazon Chime Voice Connector.

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

Saída:

{
    "PhoneNumberErrors": []
}

Para obter mais informações, consulte Como trabalhar com conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar disassociate-signin-delegate-groups-from-account.

AWS CLI

Para desassociar grupos de delegados de login

O disassociate-signin-delegate-groups-from-account exemplo a seguir desassocia o grupo de delegados de login especificado da conta especificada do Amazon Chime.

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

Este comando não produz saída.

Para obter mais informações, consulte Gerenciamento de acesso e permissões de usuários no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar get-account-settings.

AWS CLI

Para recuperar as configurações de uma conta

O get-account-settings exemplo a seguir recupera as configurações da conta especificada.

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

Saída:

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

Para obter mais informações, consulte Gerenciando suas contas do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar get-account.

AWS CLI

Para recuperar os detalhes de uma conta

O get-account exemplo a seguir recupera os detalhes da conta especificada do Amazon Chime.

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

Saída:

{
    "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 obter mais informações, consulte Gerenciando suas contas do Amazon Chime no Guia de administração do Amazon Chime.

  • Para API obter detalhes, consulte GetAccountna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-bot.

AWS CLI

Para recuperar detalhes sobre um bot

O get-bot exemplo a seguir exibe os detalhes do bot especificado.

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

Saída:

{
    "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 obter mais informações, consulte Atualizar bots de bate-papo no Guia do desenvolvedor do Amazon Chime.

  • Para API obter detalhes, consulte GetBotna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-global-settings.

AWS CLI

Para obter configurações globais

O get-global-settings exemplo a seguir recupera os nomes de bucket do S3 usados para armazenar registros de detalhes de chamadas para Amazon Chime Business Calling e Amazon Chime Voice Connectors associados à conta do administrador. AWS 

aws chime get-global-settings

Saída:

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

Para obter mais informações, consulte Gerenciamento de configurações globais no Guia de administração do Amazon Chime.

  • Para API obter detalhes, consulte GetGlobalSettingsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-phone-number-order.

AWS CLI

Para obter detalhes de um pedido de número de telefone

O get-phone-number-order exemplo a seguir exibe os detalhes do pedido de número de telefone especificado.

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

Saída:

{
    "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 obter mais informações, consulte Como trabalhar com números de telefone no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar get-phone-number-settings.

AWS CLI

Para recuperar um nome de chamada de saída

O get-phone-number-settings exemplo a seguir recupera o nome padrão da chamada de saída para a conta do AWS usuário chamador.

aws chime get-phone-number-settings

Este comando não produz saída. Saída:

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

Para obter mais informações, consulte Como trabalhar com números de telefone no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar get-phone-number.

AWS CLI

Para obter detalhes do número de telefone

O get-phone-number exemplo a seguir exibe os detalhes do número de telefone especificado.

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

Saída:

{
    "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 obter mais informações, consulte Como trabalhar com números de telefone no Guia de administração do Amazon Chime.

  • Para API obter detalhes, consulte GetPhoneNumberna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-proxy-session.

AWS CLI

Para obter detalhes da sessão de proxy

O get-proxy-session exemplo a seguir lista os detalhes da sessão de proxy especificada.

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

Saída:

{
    "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 obter mais informações, consulte Proxy Phone Sessions no Amazon Chime Developer Guide.

  • Para API obter detalhes, consulte GetProxySessionna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-room.

AWS CLI

Para obter os detalhes sobre uma sala de bate-papo

O get-room exemplo a seguir exibe detalhes sobre a sala de bate-papo especificada.

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

Saída:

{
    "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 obter mais informações, consulte Criação de uma sala de bate-papo no Guia do usuário do Amazon Chime.

  • Para API obter detalhes, consulte GetRoomna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-user-settings.

AWS CLI

Para recuperar as configurações do usuário

O get-user-settings exemplo a seguir exibe as configurações de usuário especificadas.

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

Saída:

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

Para obter mais informações, consulte Gerenciamento de números de telefone de usuários no Guia de administração do Amazon Chime.

  • Para API obter detalhes, consulte GetUserSettingsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-user.

AWS CLI

Para obter detalhes sobre um usuário

O get-user exemplo a seguir recupera os detalhes do usuário especificado.

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

Saída:

{
    "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 obter mais informações, consulte Gerenciamento de usuários no Guia de administração do Amazon Chime.

  • Para API obter detalhes, consulte GetUserna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-voice-connector-group.

AWS CLI

Para obter detalhes de um grupo do Amazon Chime Voice Connector

O get-voice-connector-group exemplo a seguir exibe detalhes do grupo especificado do Amazon Chime Voice Connector.

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

Saída:

{
    "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 obter mais informações, consulte Como trabalhar com grupos de conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar get-voice-connector-logging-configuration.

AWS CLI

Para obter detalhes da configuração de registro

O get-voice-connector-logging-configuration exemplo a seguir recupera os detalhes da configuração de registro para o Amazon Chime Voice Connector especificado.

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

Saída:

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

Para obter mais informações, consulte Streaming de mídia do Amazon Chime Voice Connector para o Kinesis no Guia de Administração do Amazon Chime.

O código de exemplo a seguir mostra como usar get-voice-connector-origination.

AWS CLI

Para recuperar as configurações de originação

O get-voice-connector-origination exemplo a seguir recupera o host de origem, a porta, o protocolo, a prioridade e o peso do Amazon Chime Voice Connector especificado.

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

Saída:

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

Para obter mais informações, consulte Como trabalhar com conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar get-voice-connector-proxy.

AWS CLI

Para obter detalhes da configuração do proxy

O get-voice-connector-proxy exemplo a seguir obtém os detalhes da configuração de proxy do seu Amazon Chime Voice Connector.

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

Saída:

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

Para obter mais informações, consulte Proxy Phone Sessions no Amazon Chime Developer Guide.

O código de exemplo a seguir mostra como usar get-voice-connector-streaming-configuration.

AWS CLI

Para obter detalhes da configuração de streaming

O get-voice-connector-streaming-configuration exemplo a seguir obtém os detalhes da configuração de streaming para o Amazon Chime Voice Connector especificado.

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

Saída:

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

Para obter mais informações, consulte Streaming de dados do Amazon Chime Voice Connector para o Kinesis no Guia de Administração do Amazon Chime.

O código de exemplo a seguir mostra como usar get-voice-connector-termination-health.

AWS CLI

Para recuperar detalhes de integridade da rescisão

O get-voice-connector-termination-health exemplo a seguir recupera os detalhes de saúde da terminação do Amazon Chime Voice Connector especificado.

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

Saída:

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

Para obter mais informações, consulte Como trabalhar com conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar get-voice-connector-termination.

AWS CLI

Para recuperar as configurações de rescisão

O get-voice-connector-termination exemplo a seguir recupera as configurações de terminação do Amazon Chime Voice Connector especificado.

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

Este comando não produz saída. Saída:

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

Para obter mais informações, consulte Como trabalhar com conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar get-voice-connector.

AWS CLI

Para obter detalhes de um Amazon Chime Voice Connector

O get-voice-connector exemplo a seguir exibe os detalhes do Amazon Chime Voice Connector especificado.

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

Saída:

{
    "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 obter mais informações, consulte Como trabalhar com conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

  • Para API obter detalhes, consulte GetVoiceConnectorna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar invite-users.

AWS CLI

Para convidar usuários a participarem do Amazon Chime

O invite-users exemplo a seguir envia um e-mail para convidar um usuário para a conta especificada do Amazon Chime.

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

Saída:

{
    "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 obter mais informações, consulte Convidar e suspender usuários no Guia de administração do Amazon Chime.

  • Para API obter detalhes, consulte InviteUsersna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-accounts.

AWS CLI

Para obter uma lista de contas

O list-accounts exemplo a seguir recupera uma lista das contas do Amazon Chime na conta do administrador AWS .

aws chime list-accounts

Saída:

{
    "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 obter mais informações, consulte Gerenciando suas contas do Amazon Chime no Guia de administração do Amazon Chime.

  • Para API obter detalhes, consulte ListAccountsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-bots.

AWS CLI

Para recuperar uma lista de bots

O list-bots exemplo a seguir lista os bots associados à conta especificada do Amazon Chime Enterprise.

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

Saída:

{
    "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 obter mais informações, consulte Usar bots de bate-papo com o Amazon Chime no Guia do desenvolvedor do Amazon Chime.

  • Para API obter detalhes, consulte ListBotsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-phone-number-orders.

AWS CLI

Para listar pedidos de números de telefone

O list-phone-number-orders exemplo a seguir lista os pedidos com números de telefone associados à conta do administrador do Amazon Chime.

aws chime list-phone-number-orders

Saída:

{
    "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 obter mais informações, consulte Como trabalhar com números de telefone no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar list-phone-numbers.

AWS CLI

Para listar números de telefone para uma conta do Amazon Chime

O list-phone-numbers exemplo a seguir lista os números de telefone associados à conta Amazon Chime do administrador.

aws chime list-phone-numbers

Este comando não produz saída. Saída:

{
    "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 obter mais informações, consulte Como trabalhar com números de telefone no Guia de administração do Amazon Chime.

  • Para API obter detalhes, consulte ListPhoneNumbersna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-proxy-sessions.

AWS CLI

Para listar sessões de proxy

O list-proxy-sessions exemplo a seguir lista as sessões de proxy do seu Amazon Chime Voice Connector.

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

Saída:

{
    "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 obter mais informações, consulte Proxy Phone Sessions no Amazon Chime Developer Guide.

  • Para API obter detalhes, consulte ListProxySessionsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-room-memberships.

AWS CLI

Para listar associações de salas

O list-room-memberships exemplo a seguir exibe uma lista dos detalhes da associação para a sala de bate-papo especificada.

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

Saída:

{
    "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 obter mais informações, consulte Criação de uma sala de bate-papo no Guia do usuário do Amazon Chime.

O código de exemplo a seguir mostra como usar list-rooms.

AWS CLI

Para listar salas de bate-papo

O list-rooms exemplo a seguir exibe uma lista de salas de bate-papo na conta especificada. A lista é filtrada somente para as salas de bate-papo às quais o membro especificado pertence.

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

Saída:

{
    "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 obter mais informações, consulte Criação de uma sala de bate-papo no Guia do usuário do Amazon Chime.

  • Para API obter detalhes, consulte ListRoomsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-users.

AWS CLI

Para listar os usuários em uma conta

O list-users exemplo a seguir lista os usuários da conta especificada do Amazon Chime.

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

Saída:

{
    "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 obter mais informações, consulte Gerenciamento de usuários no Guia de administração do Amazon Chime.

  • Para API obter detalhes, consulte ListUsersna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-voice-connector-groups.

AWS CLI

Para listar grupos do Amazon Chime Voice Connector para uma conta do Amazon Chime

O list-voice-connector-groups exemplo a seguir lista os grupos do Amazon Chime Voice Connector associados à conta Amazon Chime do administrador.

aws chime list-voice-connector-groups

Saída:

{
    "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 obter mais informações, consulte Como trabalhar com grupos do Amazon Chime Voice Connector no Guia de Administração do Amazon Chime.

O código de exemplo a seguir mostra como usar list-voice-connector-termination-credentials.

AWS CLI

Para recuperar uma lista de credenciais de rescisão

O list-voice-connector-termination-credentials exemplo a seguir recupera uma lista das credenciais de rescisão do Amazon Chime Voice Connector especificado.

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

Este comando não produz saída. Saída:

{
    "Usernames": [
        "jdoe"
    ]
}

Para obter mais informações, consulte Como trabalhar com conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar list-voice-connectors.

AWS CLI

Para listar Amazon Chime Voice Connectors para uma conta

O list-voice-connectors exemplo a seguir lista os Amazon Chime Voice Connectors associados à conta do chamador.

aws chime list-voice-connectors

Saída:

{
    "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 obter mais informações, consulte Como trabalhar com conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar logout-user.

AWS CLI

Para desconectar um usuário

O logout-user exemplo a seguir desconecta o usuário especificado.

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

Este comando não produz saída.

  • Para API obter detalhes, consulte LogoutUserna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar put-voice-connector-logging-configuration.

AWS CLI

Para adicionar uma configuração de registro para um Amazon Chime Voice Connector

O put-voice-connector-logging-configuration exemplo a seguir ativa a configuração de SIP registro para o Amazon Chime Voice Connector especificado.

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

Saída:

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

Para obter mais informações, consulte Streaming de mídia do Amazon Chime Voice Connector para o Kinesis no Guia de Administração do Amazon Chime.

O código de exemplo a seguir mostra como usar put-voice-connector-origination.

AWS CLI

Para definir as configurações de originação

O put-voice-connector-origination exemplo a seguir configura o host de origem, a porta, o protocolo, a prioridade e o peso do 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=false

Saída:

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

Para obter mais informações, consulte Como trabalhar com conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar put-voice-connector-proxy.

AWS CLI

Para colocar uma configuração de proxy

O put-voice-connector-proxy exemplo a seguir define uma configuração de proxy para seu Amazon Chime Voice Connector.

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

Saída:

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

Para obter mais informações, consulte Proxy Phone Sessions no Amazon Chime Developer Guide.

O código de exemplo a seguir mostra como usar put-voice-connector-streaming-configuration.

AWS CLI

Para criar uma configuração de streaming

O put-voice-connector-streaming-configuration exemplo a seguir cria uma configuração de streaming para o Amazon Chime Voice Connector especificado. Ele permite o streaming de mídia do Amazon Chime Voice Connector para o Amazon Kinesis e define o período de retenção de dados para 24 horas.

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

Saída:

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

Para obter mais informações, consulte Streaming de dados do Amazon Chime Voice Connector para o Kinesis no Guia de Administração do Amazon Chime.

O código de exemplo a seguir mostra como usar put-voice-connector-termination-credentials.

AWS CLI

Para configurar as credenciais de rescisão

O put-voice-connector-termination-credentials exemplo a seguir define as credenciais de rescisão para o Amazon Chime Voice Connector especificado.

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

Este comando não produz saída.

Para obter mais informações, consulte Como trabalhar com conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar put-voice-connector-termination.

AWS CLI

Para definir as configurações de rescisão

O put-voice-connector-termination exemplo a seguir define as regiões de chamada e as configurações de terminação de host IP permitidas para o 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=false

Saída:

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

Para obter mais informações, consulte Como trabalhar com conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar regenerate-security-token.

AWS CLI

Para regenerar um token de segurança

O regenerate-security-token exemplo a seguir regenera o token de segurança do bot especificado.

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

Saída:

{
    "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 obter mais informações, consulte Authenticate Chat Bot Requests no Amazon Chime Developer Guide.

O código de exemplo a seguir mostra como usar reset-personal-pin.

AWS CLI

Para redefinir a reunião pessoal de um usuário PIN

O reset-personal-pin exemplo a seguir redefine a reunião PIN pessoal do usuário especificado.

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

Saída:

{
    "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 obter mais informações, consulte Changing Personal Meeting PINs no Guia de Administração do Amazon Chime.

  • Para API obter detalhes, consulte ResetPersonalPinna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar restore-phone-number.

AWS CLI

Para restaurar um número de telefone

O restore-phone-number exemplo a seguir restaura o número de telefone especificado da fila de exclusão.

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

Saída:

{
    "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 obter mais informações, consulte Como trabalhar com números de telefone no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar search-available-phone-numbers.

AWS CLI

Para pesquisar números de telefone disponíveis

O search-available-phone-numbers exemplo a seguir pesquisa os números de telefone disponíveis por código de área.

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

Saída:

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

Para obter mais informações, consulte Como trabalhar com números de telefone no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar update-account-settings.

AWS CLI

Para atualizar as configurações da sua conta

O update-account-settings exemplo a seguir desativa o controle remoto de telas compartilhadas para a conta especificada do Amazon Chime.

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

Este comando não produz saída.

O código de exemplo a seguir mostra como usar update-account.

AWS CLI

Para atualizar uma conta

O update-account exemplo a seguir atualiza o nome da conta especificada.

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

Saída:

{
    "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 obter mais informações, consulte Renomear sua conta no Guia de administração do Amazon Chime.

  • Para API obter detalhes, consulte UpdateAccountna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-bot.

AWS CLI

Para atualizar um bot

O update-bot exemplo a seguir atualiza o status do bot especificado para impedir sua execução.

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

Saída:

{
    "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 obter mais informações, consulte Atualizar bots de bate-papo no Guia do desenvolvedor do Amazon Chime.

  • Para API obter detalhes, consulte UpdateBotna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-global-settings.

AWS CLI

Para atualizar as configurações globais

O update-global-settings exemplo a seguir atualiza o bucket do S3 usado para armazenar registros de detalhes de chamadas para Amazon Chime Business Calling e Amazon Chime Voice Connectors associados à conta do administrador. AWS 

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

Este comando não produz saída.

Para obter mais informações, consulte Gerenciamento de configurações globais no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar update-phone-number-settings.

AWS CLI

Para atualizar o nome de uma chamada de saída

O update-phone-number-settings exemplo a seguir atualiza o nome padrão da chamada de saída para a AWS conta do administrador.

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

Este comando não produz saída.

Para obter mais informações, consulte Como trabalhar com números de telefone no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar update-phone-number.

AWS CLI

Exemplo 1: Para atualizar o tipo de produto de um número de telefone

O update-phone-number exemplo a seguir atualiza o tipo de produto do número de telefone especificado.

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

Saída:

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

Exemplo 2: Para atualizar o nome da chamada de saída para um número de telefone

O update-phone-number exemplo a seguir atualiza o nome da chamada de saída para o número de telefone especificado.

as chime update-phone-number - phone-number-id “+12065550100" --nome de chamada “número de telefone 2"

Saída:

{
    "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 obter mais informações, consulte Como trabalhar com números de telefone no Guia de administração do Amazon Chime.

  • Para API obter detalhes, consulte UpdatePhoneNumberna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-proxy-session.

AWS CLI

Para atualizar uma sessão de proxy

O update-proxy-session exemplo a seguir atualiza os recursos da sessão de proxy.

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

Saída:

{
    "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 obter mais informações, consulte Proxy Phone Sessions no Amazon Chime Developer Guide.

O código de exemplo a seguir mostra como usar update-room-membership.

AWS CLI

Para atualizar a associação de uma sala

O update-room-membership exemplo a seguir modifica a função do membro da sala de bate-papo especificado paraAdministrator.

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

Saída:

{
    "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 obter mais informações, consulte Criação de uma sala de bate-papo no Guia do usuário do Amazon Chime.

O código de exemplo a seguir mostra como usar update-room.

AWS CLI

Para atualizar uma sala de bate-papo

O update-room exemplo a seguir modifica o nome da sala de bate-papo especificada.

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

Saída:

{
    "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 obter mais informações, consulte Criação de uma sala de bate-papo no Guia do usuário do Amazon Chime.

  • Para API obter detalhes, consulte UpdateRoomna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-user-settings.

AWS CLI

Para atualizar as configurações do usuário

O update-user-settings exemplo a seguir permite que o usuário especificado faça chamadas de entrada e saída e envie e receba SMS mensagens.

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 não produz saída.

Para obter mais informações, consulte Gerenciamento de números de telefone de usuários no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar update-user.

AWS CLI

Para atualizar os detalhes do usuário

Este exemplo atualiza os detalhes especificados para o usuário especificado.

Comando:

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

Saída:

{
    "User": {
        "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE"
    }
}

  • Para API obter detalhes, consulte UpdateUserna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-voice-connector-group.

AWS CLI

Para atualizar os detalhes de um grupo do Amazon Chime Voice Connector

O update-voice-connector-group exemplo a seguir atualiza os detalhes do grupo especificado do Amazon Chime Voice Connector.

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

Saída:

{
    "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 obter mais informações, consulte Como trabalhar com grupos de conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.

O código de exemplo a seguir mostra como usar update-voice-connector.

AWS CLI

Para atualizar os detalhes de um Amazon Chime Voice Connector

O update-voice-connector exemplo a seguir atualiza o nome do Amazon Chime Voice Connector especificado.

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

Saída:

{
    "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 obter mais informações, consulte Como trabalhar com conectores de voz do Amazon Chime no Guia de administração do Amazon Chime.