Exemplos do Amazon Connect usando AWS CLI - AWS Exemplos de código do SDK
Ações

Há mais exemplos de AWS SDK disponíveis no repositório AWS Doc SDK Examples GitHub .

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

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis 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, em que você pode encontrar instruções sobre como configurar e executar o código.

Tópicos

Ações

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

AWS CLI

Para criar um usuário

O exemplo create-user a seguir adiciona um usuário com os atributos especificados à instância especificada do Amazon Connect.

aws connect create-user \
    --username Mary \
    --password Pass@Word1 \
    --identity-info FirstName=Mary,LastName=Major \
    --phone-config PhoneType=DESK_PHONE,AutoAccept=true,AfterContactWorkTimeLimit=60,DeskPhoneNumber=+15555551212 \
    --security-profile-id 12345678-1111-2222-aaaa-a1b2c3d4f5g7 \
    --routing-profile-id 87654321-9999-3434-abcd-x1y2z3a1b2c3 \
    --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Saída:

{
    "UserId": "87654321-2222-1234-1234-111234567891",
    "UserArn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent/87654321-2222-1234-1234-111234567891"
}

Para obter mais informações, consulte Adicionar usuários no Guia do administrador do Amazon Connect.

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

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

AWS CLI

Como excluir um usuário

O exemplo delete-user a seguir exclui o usuário especificado da instância especificada do Amazon Connect.

aws connect delete-user \
    --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
    --user-id 87654321-2222-1234-1234-111234567891

Este comando não produz saída.

Para obter mais informações, consulte Gerenciar usuários no Guia do administrador do Amazon Connect.

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

O código de exemplo a seguir mostra como usar describe-user-hierarchy-group.

AWS CLI

Para exibir os detalhes de um grupo de hierarquias

O exemplo describe-user-hierarchy-group a seguir exibe os detalhes do grupo de hierarquias especificado do Amazon Connect.

aws connect describe-user-hierarchy-group \
    --hierarchy-group-id 12345678-1111-2222-800e-aaabbb555gg \
    --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Saída:

{
     "HierarchyGroup": {
         "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7",
         "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group/12345678-1111-2222-800e-a2b3c4d5f6g7",
         "Name": "Example Corporation",
         "LevelId": "1",
         "HierarchyPath": {
             "LevelOne": {
                 "Id": "abcdefgh-3333-4444-8af3-201123456789",
                 "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group/abcdefgh-3333-4444-8af3-201123456789",
                 "Name": "Example Corporation"
             }
         }
     }
 }

Para obter mais informações, consulte Configurar hierarquias dos agentes no Guia do administrador do Amazon Connect.

O código de exemplo a seguir mostra como usar describe-user-hierarchy-structure.

AWS CLI

Para exibir os detalhes de uma estrutura de hierarquias

O exemplo describe-user-hierarchy-structure a seguir exibe os detalhes da estrutura de hierarquias da instância especificada do Amazon Connect.

aws connect describe-user-hierarchy-group \
    --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Saída:

{
     "HierarchyStructure": {
         "LevelOne": {
             "Id": "12345678-1111-2222-800e-aaabbb555gg",
             "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group-level/1",
             "Name": "Corporation"
         },
         "LevelTwo": {
             "Id": "87654321-2222-3333-ac99-123456789102",
             "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group-level/2",
             "Name": "Services Division"
         },
         "LevelThree": {
             "Id": "abcdefgh-3333-4444-8af3-201123456789",
             "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group-level/3",
             "Name": "EU Site"
         }
     }
 }

Para obter mais informações, consulte Configurar hierarquias dos agentes no Guia do administrador do Amazon Connect.

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

AWS CLI

Para exibir os detalhes de um usuário

O exemplo describe-user a seguir exibe os detalhes do usuário especificado do Amazon Connect.

aws connect describe-user \
    --user-id 0c245dc0-0cf5-4e37-800e-2a7481cc8a60
    --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e

Saída:

{
    "User": {
        "Id": "0c245dc0-0cf5-4e37-800e-2a7481cc8a60",
        "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/0c245dc0-0cf5-4e37-800e-2a7481cc8a60",
        "Username": "Jane",
        "IdentityInfo": {
            "FirstName": "Jane",
            "LastName": "Doe",
            "Email": "example.com"
        },
        "PhoneConfig": {
            "PhoneType": "SOFT_PHONE",
            "AutoAccept": false,
            "AfterContactWorkTimeLimit": 0,
            "DeskPhoneNumber": ""
        },
        "DirectoryUserId": "8b444cf6-b368-4f29-ba18-07af27405658",
        "SecurityProfileIds": [
            "b6f85a42-1dc5-443b-b621-de0abf70c9cf"
        ],
        "RoutingProfileId": "0be36ee9-2b5f-4ef4-bcf7-87738e5be0e5",
        "Tags": {}
    }
}

Para obter mais informações, consulte Gerenciar usuários no Guia do administrador do Amazon Connect.

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

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

AWS CLI

Para recuperar os atributos de um contato

O exemplo get-contact-attributes a seguir recupera os atributos que foram definidos para o contato especificado do Amazon Connect.

aws connect get-contact-attributes \
    --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
    --initial-contact-id 12345678-1111-2222-800e-a2b3c4d5f6g7

Saída:

{
    "Attributes": {
        "greetingPlayed": "true"
    }
}

Para obter mais informações, consulte Usar atributos de contato do Amazon Connect no Guia do administrador do Amazon Connect.

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

AWS CLI

Para listar os fluxos de contato em uma instância

O exemplo list-contact-flows a seguir lista os fluxos de contato na instância especificada do Amazon Connect.

aws connect list-contact-flows \
    --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Saída:

{
     "ContactFlowSummaryList": [
         {
             "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7",
             "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/contact-flow/12345678-1111-2222-800e-a2b3c4d5f6g7",
             "Name": "Default queue transfer",
             "ContactFlowType": "QUEUE_TRANSFER"
         },
         {
             "Id": "87654321-2222-3333-ac99-123456789102",
             "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/contact-flow/87654321-2222-3333-ac99-123456789102",
             "Name": "Default agent hold",
             "ContactFlowType": "AGENT_HOLD"
         },
         {
             "Id": "abcdefgh-3333-4444-8af3-201123456789",
                 "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/contact-flow/abcdefgh-3333-4444-8af3-201123456789",
             "Name": "Default customer hold",
             "ContactFlowType": "CUSTOMER_HOLD"
         },
     ]
 }

Para obter mais informações, consulte Criar fluxos de contato do Amazon Connect no Guia do administrador do Amazon Connect.

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

O código de exemplo a seguir mostra como usar list-hours-of-operations.

AWS CLI

Para listar as horas de operação em uma instância

O exemplo list-hours-of-operations a seguir lista as horas de operação da instância especificada do Amazon Connect.

aws connect list-hours-of-operations \
    --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e

Saída:

{
    "HoursOfOperationSummaryList": [
        {
            "Id": "d69f1f84-7457-4924-8fbe-e64875546259",
            "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/operating-hours/d69f1f84-7457-4924-8fbe-e64875546259",
            "Name": "Basic Hours"
        }
    ]
}

Para obter mais informações, consulte Definir as horas de operação de uma fila no Guia do administrador do Amazon Connect.

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

AWS CLI

Para listar os números de telefone em uma instância

O exemplo list-phone-numbers a seguir lista os números de telefone na instância especificada do Amazon Connect.

aws connect list-phone-numbers \
    --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Saída:

{
    "PhoneNumberSummaryList": [
        {
            "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/phone-number/xyz80zxy-xyz1-80zx-zx80-11111EXAMPLE",
            "PhoneNumber": "+17065551212",
            "PhoneNumberType": "DID",
            "PhoneNumberCountryCode": "US"
        },
        {
            "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/phone-number/ccc0ccc-xyz1-80zx-zx80-22222EXAMPLE",
            "PhoneNumber": "+18555551212",
            "PhoneNumberType": "TOLL_FREE",
            "PhoneNumberCountryCode": "US"
        }
    ]
}

Para obter mais informações, consulte Configurar números de telefone para a central de atendimento no Guia do administrador do Amazon Connect.

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

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

AWS CLI

Para listar as filas em uma instância

O exemplo list-queues a seguir lista as filas na instância especificada do Amazon Connect.

aws connect list-queues \
    --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Saída:

{
    "QueueSummaryList": [
        {
            "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7",
            "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/queue/agent/12345678-1111-2222-800e-a2b3c4d5f6g7",
            "QueueType": "AGENT"
        },
        {
            "Id": "87654321-2222-3333-ac99-123456789102",
            "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/queue/agent/87654321-2222-3333-ac99-123456789102",
            "QueueType": "AGENT"
        },
        {
            "Id": "abcdefgh-3333-4444-8af3-201123456789",
            "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/queue/agent/abcdefgh-3333-4444-8af3-201123456789",
            "QueueType": "AGENT"
        },
        {
            "Id": "hgfedcba-4444-5555-a31f-123456789102",
            "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/queue/hgfedcba-4444-5555-a31f-123456789102",
            "Name": "BasicQueue",
            "QueueType": "STANDARD"
        },
    ]
}

Para obter mais informações, consulte Criar uma fila no Guia do administrador do Amazon Connect.

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

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

AWS CLI

Para listar os perfis de roteamento em uma instância

O exemplo list-routing-profiles a seguir lista os perfis de roteamento na instância especificada do Amazon Connect.

aws connect list-routing-profiles \
    --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Saída:

{
    "RoutingProfileSummaryList": [
        {
            "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7",
            "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/routing-profile/12345678-1111-2222-800e-a2b3c4d5f6g7",
            "Name": "Basic Routing Profile"
        },
    ]
}

Para obter mais informações, consulte Criar um perfil de roteamento no Guia do administrador do Amazon Connect.

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

AWS CLI

Para listar os perfis de segurança em uma instância

O exemplo list-security-profiles a seguir lista os perfis de segurança na instância especificada do Amazon Connect.

aws connect list-security-profiles \
    --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Saída:

{
    "SecurityProfileSummaryList": [
        {
            "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7",
            "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/security-profile/12345678-1111-2222-800e-a2b3c4d5f6g7",
            "Name": "CallCenterManager"
        },
        {
            "Id": "87654321-2222-3333-ac99-123456789102",
            "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/security-profile/87654321-2222-3333-ac99-123456789102",
            "Name": "QualityAnalyst"
        },
        {
            "Id": "abcdefgh-3333-4444-8af3-201123456789",
            "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/security-profile/abcdefgh-3333-4444-8af3-201123456789",
            "Name": "Agent"
        },
        {
            "Id": "12345678-1111-2222-800e-x2y3c4d5fzzzz",
            "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/security-profile/12345678-1111-2222-800e-x2y3c4d5fzzzz",
            "Name": "Admin"
        }
    ]
}

Para obter mais informações, consulte Atribuir permissões: perfis de segurança no Guia do administrador do Amazon Connect.

O código de exemplo a seguir mostra como usar list-user-hierarchy-groups.

AWS CLI

Para listar os grupos de hierarquia de usuários em uma instância

O exemplo list-user-hierarchy-groups a seguir lista os grupos de hierarquias de usuários na instância especificada do Amazon Connect.

aws connect list-user-hierarchy-groups \
    --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e

Saída:

{
    "UserHierarchyGroupSummaryList": [
        {
            "Id": "0e2f6d1d-b3ca-494b-8dbc-ba81d9f8182a",
            "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent-group/0e2f6d1d-b3ca-494b-8dbc-ba81d9f8182a",
            "Name": "Example Corporation"
        },
    ]
}

Para obter mais informações, consulte Configurar hierarquias dos agentes no Guia do administrador do Amazon Connect.

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

AWS CLI

Para listar os grupos de hierarquia de usuários em uma instância

O exemplo list-users a seguir lista os usuários na instância especificada do Amazon Connect.

aws connect list-users \
    --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e

Saída:

{
    "UserSummaryList": [
        {
            "Id": "0c245dc0-0cf5-4e37-800e-2a7481cc8a60",
            "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/0c245dc0-0cf5-4e37-800e-2a7481cc8a60",
            "Username": "Jane"
        },
        {
            "Id": "46f0c67c-3fc7-4806-ac99-403798788c14",
            "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/46f0c67c-3fc7-4806-ac99-403798788c14",
            "Username": "Paulo"
        },
        {
            "Id": "55a83578-95e1-4710-8af3-2b7afe310e48",
            "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/55a83578-95e1-4710-8af3-2b7afe310e48",
            "Username": "JohnD"
        },
        {
            "Id": "703e27b5-c9f0-4f1f-a239-64ccbb160125",
            "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/703e27b5-c9f0-4f1f-a239-64ccbb160125",
            "Username": "JohnS"
        }
    ]
}

Para obter mais informações, consulte Adicionar usuários no Guia do administrador do Amazon Connect.

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

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

AWS CLI

Para atualizar o atributo de um contato

O exemplo update-contact-attributes a seguir atualiza o atributo greetingPlayed do usuário especificado do Amazon Connect.

aws connect update-contact-attributes \
    --initial-contact-id 11111111-2222-3333-4444-12345678910 \
    --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
    --attributes greetingPlayed=false

Este comando não produz saída.

Para obter mais informações, consulte Usar atributos de contato do Amazon Connect no Guia do administrador do Amazon Connect.

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

AWS CLI

Para atualizar a hierarquia de um usuário

O exemplo update-user-hierarchy a seguir atualiza a hierarquia de agentes do usuário especificado do Amazon Connect.

aws connect update-user-hierarchy \
    --hierarchy-group-id 12345678-a1b2-c3d4-e5f6-123456789abc \
    --user-id 87654321-2222-1234-1234-111234567891 \
    --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Este comando não produz saída.

Para obter mais informações, consulte Definir configurações do agente no Guia do administrador do Amazon Connect.

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

AWS CLI

Para atualizar as informações de identidade de um usuário

O exemplo update-user-identity-info a seguir atualiza as informações de identidade do usuário especificado do Amazon Connect.

aws connect update-user-identity-info \
    --identity-info FirstName=Mary,LastName=Major,Email=marym@example.com \
    --user-id 87654321-2222-1234-1234-111234567891 \
    --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Este comando não produz saída.

Para obter mais informações, consulte Definir configurações do agente no Guia do administrador do Amazon Connect.

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

AWS CLI

Para atualizar a configuração do telefone de um usuário

O exemplo update-user-phone-config a seguir atualiza a configuração do telefone do usuário especificado.

aws connect update-user-phone-config \
    --phone-config PhoneType=SOFT_PHONE,AutoAccept=false,AfterContactWorkTimeLimit=60,DeskPhoneNumber=+18005551212 \
    --user-id 12345678-4444-3333-2222-111122223333 \
    --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Este comando não produz saída.

Para obter mais informações, consulte Definir configurações do agente no Guia do administrador do Amazon Connect.

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

AWS CLI

Para atualizar o perfil de roteamento de um usuário

O exemplo update-user-routing-profile a seguir atualiza o perfil de roteamento do usuário especificado do Amazon Connect.

aws connect update-user-routing-profile \
    --routing-profile-id 12345678-1111-3333-2222-4444EXAMPLE \
    --user-id 87654321-2222-1234-1234-111234567891 \
    --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Este comando não produz saída.

Para obter mais informações, consulte Definir configurações do agente no Guia do administrador do Amazon Connect.

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

AWS CLI

Para atualizar os perfis de segurança de um usuário

O exemplo update-user-security-profiles a seguir atualiza o perfil de segurança do usuário especificado do Amazon Connect.

aws connect update-user-security-profiles \
    --security-profile-ids 12345678-1234-1234-1234-1234567892111 \
    --user-id 87654321-2222-1234-1234-111234567891 \
    --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Este comando não produz saída.

Para obter mais informações, consulte Atribuir permissões: perfis de segurança no Guia do administrador do Amazon Connect.