Contoh Amazon Connect menggunakan AWS CLI - AWS Command Line Interface
Tindakan

Dokumentasi ini AWS CLI hanya untuk Versi 1. Untuk dokumentasi yang terkait dengan Versi 2 AWS CLI, lihat Panduan Pengguna Versi 2.

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Contoh Amazon Connect menggunakan AWS CLI

Contoh kode berikut menunjukkan cara melakukan tindakan dan mengimplementasikan skenario umum dengan menggunakan AWS Command Line Interface with Amazon Connect.

Tindakan adalah kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Sementara tindakan menunjukkan cara memanggil fungsi layanan individual, Anda dapat melihat tindakan dalam konteks dalam skenario terkait.

Setiap contoh menyertakan tautan ke kode sumber lengkap, di mana Anda dapat menemukan instruksi tentang cara mengatur dan menjalankan kode dalam konteks.

Tindakan

Contoh kode berikut menunjukkan cara menggunakancreate-user.

AWS CLI

Untuk membuat pengguna

create-userContoh berikut menambahkan pengguna dengan atribut yang ditentukan ke instance Amazon Connect yang ditentukan.

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

Untuk informasi selengkapnya, lihat Menambahkan Pengguna di Panduan Administrator Amazon Connect.

  • Untuk API detailnya, lihat CreateUserdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandelete-user.

AWS CLI

Untuk menghapus pengguna

delete-userContoh berikut menghapus pengguna yang ditentukan dari instance Amazon Connect yang ditentukan.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mengelola Pengguna di Panduan Administrator Amazon Connect.

  • Untuk API detailnya, lihat DeleteUserdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandescribe-user-hierarchy-group.

AWS CLI

Untuk menampilkan detail untuk grup hierarki

describe-user-hierarchy-groupContoh berikut menampilkan detail untuk grup hierarki Amazon Connect yang ditentukan.

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

Untuk informasi selengkapnya, lihat Mengatur Hierarki Agen di Panduan Administrator Amazon Connect.

Contoh kode berikut menunjukkan cara menggunakandescribe-user-hierarchy-structure.

AWS CLI

Untuk menampilkan detail untuk struktur hierarki

describe-user-hierarchy-structureContoh berikut menampilkan detail untuk struktur hierarki untuk instance Amazon Connect yang ditentukan.

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

Untuk informasi selengkapnya, lihat Mengatur Hierarki Agen di Panduan Administrator Amazon Connect.

Contoh kode berikut menunjukkan cara menggunakandescribe-user.

AWS CLI

Untuk menampilkan detail untuk pengguna

describe-userContoh berikut menampilkan detail untuk pengguna Amazon Connect yang ditentukan.

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

Untuk informasi selengkapnya, lihat Mengelola Pengguna di Panduan Administrator Amazon Connect.

  • Untuk API detailnya, lihat DescribeUserdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanget-contact-attributes.

AWS CLI

Untuk mengambil atribut untuk kontak

get-contact-attributesContoh berikut mengambil atribut yang ditetapkan untuk kontak Amazon Connect yang ditentukan.

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

Output:

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

Untuk informasi selengkapnya, lihat Menggunakan Atribut Kontak Amazon Connect di Panduan Administrator Amazon Connect.

Contoh kode berikut menunjukkan cara menggunakanlist-contact-flows.

AWS CLI

Untuk membuat daftar alur kontak dalam sebuah instance

list-contact-flowsContoh berikut mencantumkan alur kontak dalam instance Amazon Connect yang ditentukan.

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

Untuk informasi selengkapnya, lihat Membuat Alur Kontak Amazon Connect di Panduan Administrator Amazon Connect.

Contoh kode berikut menunjukkan cara menggunakanlist-hours-of-operations.

AWS CLI

Untuk membuat daftar jam operasi dalam sebuah instance

list-hours-of-operationsContoh berikut mencantumkan jam operasi untuk instans Amazon Connect yang ditentukan.

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

Untuk informasi selengkapnya, lihat Mengatur Jam Operasi untuk Antrian di Panduan Administrator Amazon Connect.

Contoh kode berikut menunjukkan cara menggunakanlist-phone-numbers.

AWS CLI

Untuk mencantumkan nomor telepon dalam sebuah contoh

list-phone-numbersContoh berikut mencantumkan nomor telepon dalam instans Amazon Connect yang ditentukan.

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

Untuk informasi selengkapnya, lihat Mengatur Nomor Telepon untuk Pusat Kontak Anda di Panduan Administrator Amazon Connect.

Contoh kode berikut menunjukkan cara menggunakanlist-queues.

AWS CLI

Untuk membuat daftar antrian dalam sebuah instance

list-queuesContoh berikut mencantumkan antrian dalam instance Amazon Connect yang ditentukan.

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

Untuk informasi selengkapnya, lihat Membuat Antrian di Panduan Administrator Amazon Connect.

  • Untuk API detailnya, lihat ListQueuesdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanlist-routing-profiles.

AWS CLI

Untuk membuat daftar profil perutean dalam sebuah instance

list-routing-profilesContoh berikut mencantumkan profil perutean dalam instance Amazon Connect yang ditentukan.

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

Untuk informasi selengkapnya, lihat Membuat Profil Perutean di Panduan Administrator Amazon Connect.

Contoh kode berikut menunjukkan cara menggunakanlist-security-profiles.

AWS CLI

Untuk membuat daftar profil keamanan dalam sebuah instance

list-security-profilesContoh berikut mencantumkan profil keamanan dalam instans Amazon Connect yang ditentukan.

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

Untuk informasi selengkapnya, lihat Menetapkan Izin: Profil Keamanan di Panduan Administrator Amazon Connect.

Contoh kode berikut menunjukkan cara menggunakanlist-user-hierarchy-groups.

AWS CLI

Untuk mencantumkan grup hierarki pengguna dalam sebuah instance

list-user-hierarchy-groupsContoh berikut mencantumkan grup hierarki pengguna dalam instance Amazon Connect yang ditentukan.

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

Untuk informasi selengkapnya, lihat Mengatur Hierarki Agen di Panduan Administrator Amazon Connect.

Contoh kode berikut menunjukkan cara menggunakanlist-users.

AWS CLI

Untuk mencantumkan grup hierarki pengguna dalam sebuah instance

list-usersContoh berikut mencantumkan pengguna dalam instans Amazon Connect yang ditentukan.

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

Untuk informasi selengkapnya, lihat Menambahkan Pengguna di Panduan Administrator Amazon Connect.

  • Untuk API detailnya, lihat ListUsersdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanupdate-contact-attributes.

AWS CLI

Untuk memperbarui atribut kontak

update-contact-attributesContoh berikut memperbarui greetingPlayed atribut untuk pengguna Amazon Connect yang ditentukan.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Menggunakan Atribut Kontak Amazon Connect di Panduan Administrator Amazon Connect.

Contoh kode berikut menunjukkan cara menggunakanupdate-user-hierarchy.

AWS CLI

Untuk memperbarui hierarki pengguna

update-user-hierarchyContoh berikut memperbarui hierarki agen untuk pengguna Amazon Connect yang ditentukan.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mengkonfigurasi Pengaturan Agen di Panduan Administrator Amazon Connect.

Contoh kode berikut menunjukkan cara menggunakanupdate-user-identity-info.

AWS CLI

Untuk memperbarui informasi identitas pengguna

update-user-identity-infoContoh berikut memperbarui informasi identitas untuk pengguna Amazon Connect yang ditentukan.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mengkonfigurasi Pengaturan Agen di Panduan Administrator Amazon Connect.

Contoh kode berikut menunjukkan cara menggunakanupdate-user-phone-config.

AWS CLI

Untuk memperbarui konfigurasi telepon pengguna

update-user-phone-configContoh berikut memperbarui konfigurasi telepon untuk pengguna yang ditentukan.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mengkonfigurasi Pengaturan Agen di Panduan Administrator Amazon Connect.

Contoh kode berikut menunjukkan cara menggunakanupdate-user-routing-profile.

AWS CLI

Untuk memperbarui profil perutean pengguna

update-user-routing-profileContoh berikut memperbarui profil perutean untuk pengguna Amazon Connect yang ditentukan.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mengkonfigurasi Pengaturan Agen di Panduan Administrator Amazon Connect.

Contoh kode berikut menunjukkan cara menggunakanupdate-user-security-profiles.

AWS CLI

Untuk memperbarui profil keamanan pengguna

update-user-security-profilesContoh berikut memperbarui profil keamanan untuk pengguna Amazon Connect yang ditentukan.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Menetapkan Izin: Profil Keamanan di Panduan Administrator Amazon Connect.