Esempi per utilizzo di Amazon Connect con AWS CLI - Esempi di codice per SDK AWS
Azioni

Sono disponibili altri esempi per SDK AWS nel repository GitHub della documentazione degli esempi per SDK AWS.

Esempi per utilizzo di Amazon Connect con AWS CLI

Gli esempi di codice seguenti mostrano come eseguire operazioni e implementare scenari comuni utilizzando AWS Command Line Interface con Amazon Connect.

Le azioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le operazioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.

Ogni esempio include un link al codice sorgente completo, in cui vengono fornite le istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Azioni

L’esempio di codice seguente mostra come utilizzare create-user.

AWS CLI

Come creare un utente

L’esempio create-user seguente aggiunge un utente con gli attributi specificati all’istanza Amazon Connect specificata.

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

Output:

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

Per ulteriori informazioni, consulta Aggiungere utenti nella Guida per l’amministratore di Amazon Connect.

  • Per informazioni dettagliate sull’API, consulta CreateUser nella documentazione di riferimento dei comandi della AWS CLI.

L’esempio di codice seguente mostra come utilizzare delete-user.

AWS CLI

Come eliminare un utente

L’esempio delete-user seguente elimina l’utente specificato dall’istanza Amazon Connect specificata.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Gestione degli utenti nella Guida per l’amministratore di Amazon Connect.

  • Per informazioni dettagliate sull’API, consulta DeleteUser nella documentazione di riferimento dei comandi della AWS CLI.

L’esempio di codice seguente mostra come utilizzare describe-user-hierarchy-group.

AWS CLI

Come visualizzare i dettagli di un gruppo gerarchico

L’esempio describe-user-hierarchy-group seguente mostra i dettagli del gruppo di gerarchia Amazon Connect specificato.

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

Output:

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

Per ulteriori informazioni, consulta Configurare le gerarchie di agenti nella Guida per l’amministratore di Amazon Connect.

L’esempio di codice seguente mostra come utilizzare describe-user-hierarchy-structure.

AWS CLI

Come visualizzare i dettagli di una struttura gerarchica

L’esempio describe-user-hierarchy-structure seguente mostra i dettagli della struttura gerarchica per l’istanza Amazon Connect specificata.

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

Output:

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

Per ulteriori informazioni, consulta Configurare le gerarchie di agenti nella Guida per l’amministratore di Amazon Connect.

L’esempio di codice seguente mostra come utilizzare describe-user.

AWS CLI

Come visualizzare i dettagli di un utente

L’esempio describe-user seguente mostra i dettagli dell’utente Amazon Connect specificato.

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

Output:

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

Per ulteriori informazioni, consulta Gestione degli utenti nella Guida per l’amministratore di Amazon Connect.

  • Per informazioni dettagliate sull’API, consulta DescribeUser in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare get-contact-attributes.

AWS CLI

Come recuperare gli attributi di un contatto

L’esempio get-contact-attributes seguente recupera gli attributi che sono stati impostati per il contatto Amazon Connect specificato.

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

Output:

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

Per ulteriori informazioni, consulta la pagina Uso degli attributi di contatto di Amazon Connect nella Guida per l’amministratore di Amazon Connect.

  • Per informazioni dettagliate sull’API, consulta GetContactAttributes in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-contact-flows.

AWS CLI

Come elencare i flussi di contatti in un’istanza

L’esempio list-contact-flows seguente mostra i flussi di contatto nell’istanza Amazon Connect specificata.

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

Output:

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

Per ulteriori informazioni, consulta Creare flussi di contatti Amazon Connect nella Guida per l’amministratore di Amazon Connect.

  • Per informazioni dettagliate sull’API, consulta ListContactFlows in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-hours-of-operations.

AWS CLI

Come elencare gli orari di funzionamento di un’istanza

L’esempio list-hours-of-operations seguente elenca gli orari di operatività per l’istanza Amazon Connect specificata.

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

Output:

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

Per ulteriori informazioni, consulta Impostazione degli orari di attività di una coda nella Guida per l’amministratore di Amazon Connect.

L’esempio di codice seguente mostra come utilizzare list-phone-numbers.

AWS CLI

Come elencare i numeri di telefono di un’istanza

L’esempio list-phone-numbers seguente elenca i numeri di telefono nell’istanza Amazon Connect specificata.

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

Output:

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

Per ulteriori informazioni, consulta Configurare i numeri di telefono per il contact center nella Guida per l’amministratore di Amazon Connect.

  • Per informazioni dettagliate sull’API, consulta ListPhoneNumbers in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-queues.

AWS CLI

Come elencare le code in un’istanza

L’esempio list-queues seguente elenca le code nell’istanza Amazon Connect specificata.

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

Output:

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

Per ulteriori informazioni, consulta Creare una coda nella Guida per l’amministratore di Amazon Connect.

  • Per informazioni dettagliate sull’API, consulta ListQueues nella documentazione di riferimento dei comandi della AWS CLI.

L’esempio di codice seguente mostra come utilizzare list-routing-profiles.

AWS CLI

Come elencare i profili di routing in un’istanza

L’esempio list-routing-profiles seguente elenca i profili di routing nell’istanza Amazon Connect specificata.

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

Output:

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

Per ulteriori informazioni, consulta Creazione di un profilo di instradamento nella Guida per l’amministratore di Amazon Connect.

  • Per informazioni dettagliate sull’API, consulta ListRoutingProfiles in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-security-profiles.

AWS CLI

Come elencare i profili di sicurezza in un’istanza

L’esempio list-security-profiles seguente elenca i profili di sicurezza nell’istanza Amazon Connect specificata.

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

Output:

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

Per ulteriori informazioni, consulta Assegnare le autorizzazioni: profili di sicurezza nella Guida per l’amministratore di Amazon Connect.

  • Per informazioni dettagliate sull’API, consulta ListSecurityProfiles nella documentazione di riferimento dei comandi della AWS CLI.

L’esempio di codice seguente mostra come utilizzare list-user-hierarchy-groups.

AWS CLI

Come elencare i gruppi gerarchici di utenti in un’istanza

L’esempio list-user-hierarchy-groups seguente elenca i gruppi di gerarchie di utenti nell’istanza Amazon Connect specificata.

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

Output:

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

Per ulteriori informazioni, consulta Configurare le gerarchie di agenti nella Guida per l’amministratore di Amazon Connect.

L’esempio di codice seguente mostra come utilizzare list-users.

AWS CLI

Come elencare i gruppi gerarchici di utenti in un’istanza

L’esempio list-users seguente elenca gli utenti nell’istanza Amazon Connect specificata.

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

Output:

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

Per ulteriori informazioni, consulta Aggiungere utenti nella Guida per l’amministratore di Amazon Connect.

  • Per informazioni dettagliate sull’API, consulta ListUser nella AWS CLI documentazione di riferimento del comando.

L’esempio di codice seguente mostra come utilizzare update-contact-attributes.

AWS CLI

Come aggiornare l’attributo di un contatto

L’esempio update-contact-attributes seguente aggiorna l’attributo greetingPlayed per l’utente Amazon Connect specificato.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta la pagina Uso degli attributi di contatto di Amazon Connect nella Guida per l’amministratore di Amazon Connect.

L’esempio di codice seguente mostra come utilizzare update-user-hierarchy.

AWS CLI

Come aggiornare la gerarchia degli utenti

L’esempio update-user-hierarchy seguente aggiorna la gerarchia degli agenti per l’utente Amazon Connect specificato.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Configurare le impostazioni dell’agente nella Guida per l’amministratore di Amazon Connect.

  • Per informazioni dettagliate sull’API, consulta UpdateUserHierarchy in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare update-user-identity-info.

AWS CLI

Come aggiornare le informazioni sull’identità di un utente

L’esempio update-user-identity-info seguente aggiorna le informazioni sull’identità per l’utente Amazon Connect specificato.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Configurare le impostazioni dell’agente nella Guida per l’amministratore di Amazon Connect.

L’esempio di codice seguente mostra come utilizzare update-user-phone-config.

AWS CLI

Come aggiornare la configurazione del telefono di un utente

L’esempio update-user-phone-config seguente aggiorna la configurazione del telefono per l’utente specificato.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Configurare le impostazioni dell’agente nella Guida per l’amministratore di Amazon Connect.

L’esempio di codice seguente mostra come utilizzare update-user-routing-profile.

AWS CLI

Come aggiornare il profilo di routing di un utente

L’esempio update-user-routing-profile seguente aggiorna il profilo di routing per l’utente Amazon Connect specificato.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Configurare le impostazioni dell’agente nella Guida per l’amministratore di Amazon Connect.

L’esempio di codice seguente mostra come utilizzare update-user-security-profiles.

AWS CLI

Come aggiornare i profili di sicurezza di un utente

L’esempio update-user-security-profiles seguente aggiorna il profilo di sicurezza per l’utente Amazon Connect specificato.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Assegnare le autorizzazioni: profili di sicurezza nella Guida per l’amministratore di Amazon Connect.