Amazon Connect 示例使用 AWS CLI - AWS Command Line Interface

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

Amazon Connect 示例使用 AWS CLI

下列程式碼範例說明如何透過 AWS Command Line Interface 搭配 Amazon Connect 使用來執行動作和實作常見案例。

Actions 是大型程式的程式碼摘錄,必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數,但您可以在其相關情境和跨服務範例中查看內容中的動作。

Scenarios (案例) 是向您展示如何呼叫相同服務中的多個函數來完成特定任務的程式碼範例。

每個範例都包含一個連結 GitHub,您可以在其中找到如何在內容中設定和執行程式碼的指示。

主題

動作

下列程式碼範例會示範如何使用create-user

AWS CLI

若要建立使用者

下列create-user範例會將具有指定屬性的使用者新增至指定的 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

輸出:

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

如需詳細資訊,請參閱 Amazon Connect 管理員指南中的新增使用者

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考CreateUser中的。

下列程式碼範例會示範如何使用delete-user

AWS CLI

若要刪除使用者

下列delete-user範例會從指定的 Amazon Connect 執行個體中刪除指定的使用者。

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

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon Connect 管理員指南中的管理使用者

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考DeleteUser中的。

下列程式碼範例會示範如何使用describe-user-hierarchy-group

AWS CLI

若要顯示階層群組的詳細資訊

下列describe-user-hierarchy-group範例顯示指定之 Amazon Connect 階層群組的詳細資料。

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

輸出:

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

如需詳細資訊,請參閱 Amazon Connect 管理員指南中的設定代理程式階層

下列程式碼範例會示範如何使用describe-user-hierarchy-structure

AWS CLI

若要顯示階層結構的詳細資訊

下列describe-user-hierarchy-structure範例顯示指定 Amazon Connect 執行個體的階層結構詳細資訊。

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

輸出:

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

如需詳細資訊,請參閱 Amazon Connect 管理員指南中的設定代理程式階層

下列程式碼範例會示範如何使用describe-user

AWS CLI

若要顯示使用者的詳細資訊

下列describe-user範例顯示指定 Amazon Connect 使用者的詳細資訊。

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

輸出:

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

如需詳細資訊,請參閱 Amazon Connect 管理員指南中的管理使用者

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考DescribeUser中的。

下列程式碼範例會示範如何使用get-contact-attributes

AWS CLI

若要擷取連絡人的屬性

下列get-contact-attributes範例會擷取為指定之 Amazon Connect 聯絡人設定的屬性。

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

輸出:

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

如需詳細資訊,請參閱 Amazon Connect 管理員指南中的使用 Amazon Connect 聯絡屬性

下列程式碼範例會示範如何使用list-contact-flows

AWS CLI

若要列出執行個體中的聯絡流程

下列list-contact-flows範例會列出指定 Amazon Connect 執行個體中的聯絡流程。

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

輸出:

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

如需詳細資訊,請參閱 Amazon Connect 管理員指南中的建立 Amazon Connect 聯絡流程

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考ListContactFlows中的。

下列程式碼範例會示範如何使用list-hours-of-operations

AWS CLI

若要列出執行處理中的作業時數

下列list-hours-of-operations範例會列出指定 Amazon Connect 執行個體的操作時數。

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

輸出:

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

如需詳細資訊,請參閱 Amazon Connect 管理員指南中的設定佇列的操作時數

下列程式碼範例會示範如何使用list-phone-numbers

AWS CLI

列出執行個體中的電話號碼

下列list-phone-numbers範例會列出指定 Amazon Connect 執行個體中的電話號碼。

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

輸出:

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

如需詳細資訊,請參閱 Amazon Connect 管理員指南中的為您的聯絡中心設定電話號碼

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考ListPhoneNumbers中的。

下列程式碼範例會示範如何使用list-queues

AWS CLI

若要列出執行個體中的佇列

下列list-queues範例會列出指定 Amazon Connect 執行個體中的佇列。

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

輸出:

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

如需詳細資訊,請參閱 Amazon Connect 管理員指南中的建立佇列

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考ListQueues中的。

下列程式碼範例會示範如何使用list-routing-profiles

AWS CLI

列出執行個體中的路由設定檔

下列list-routing-profiles範例列出指定 Amazon Connect 執行個體中的路由設定檔。

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

輸出:

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

如需詳細資訊,請參閱 Amazon Connect 管理員指南中的建立路由設定檔

下列程式碼範例會示範如何使用list-security-profiles

AWS CLI

列出執行個體中的安全性設定檔

下列list-security-profiles範例列出指定 Amazon Connect 執行個體中的安全設定檔。

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

輸出:

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

如需詳細資訊,請參閱 Amazon Connect 管理員指南中的指派許可:安全設定檔

下列程式碼範例會示範如何使用list-user-hierarchy-groups

AWS CLI

若要列出執行個體中的使用者階層群組

下列list-user-hierarchy-groups範例會列出指定 Amazon Connect 執行個體中的使用者階層群組。

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

輸出:

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

如需詳細資訊,請參閱 Amazon Connect 管理員指南中的設定代理程式階層

下列程式碼範例會示範如何使用list-users

AWS CLI

若要列出執行個體中的使用者階層群組

下列list-users範例會列出指定之 Amazon Connect 執行個體中的使用者。

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

輸出:

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

如需詳細資訊,請參閱 Amazon Connect 管理員指南中的新增使用者

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考ListUsers中的。

下列程式碼範例會示範如何使用update-contact-attributes

AWS CLI

若要更新連絡人的屬性

下列update-contact-attributes範例會更新指定之 Amazon Connect 使用者的greetingPlayed屬性。

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

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon Connect 管理員指南中的使用 Amazon Connect 聯絡屬性

下列程式碼範例會示範如何使用update-user-hierarchy

AWS CLI

若要更新使用者的階層

下列update-user-hierarchy範例會更新指定 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

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon Connect 管理員指南中的設定代理程式設定。

下列程式碼範例會示範如何使用update-user-identity-info

AWS CLI

若要更新使用者的身分資訊

下列update-user-identity-info範例會更新指定 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

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon Connect 管理員指南中的設定代理程式設定。

下列程式碼範例會示範如何使用update-user-phone-config

AWS CLI

更新使用者的電話設定

下列update-user-phone-config範例會更新指定使用者的電話組態。

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

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon Connect 管理員指南中的設定代理程式設定。

下列程式碼範例會示範如何使用update-user-routing-profile

AWS CLI

若要更新使用者的路由設定檔

下列update-user-routing-profile範例會更新指定 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

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon Connect 管理員指南中的設定代理程式設定。

下列程式碼範例會示範如何使用update-user-security-profiles

AWS CLI

更新使用者的安全性設定檔

下列update-user-security-profiles範例會更新指定 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

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon Connect 管理員指南中的指派許可:安全設定檔