本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
使用 的 Amazon Connect 範例 AWS CLI
下列程式碼範例示範如何 AWS Command Line Interface 搭配 Amazon Connect 使用 來執行動作和實作常見案例。
Actions 是大型程式的程式碼摘錄,必須在內容中執行。雖然動作會示範如何呼叫個別服務函數,但您可以在其相關案例中查看內容中的動作。
每個範例都包含完整原始程式碼的連結,您可以在其中找到如何在內容中設定和執行程式碼的指示。
主題
動作
下列程式碼範例示範如何使用 create-user
。
- AWS CLI
-
建立使用者
下列
create-user
範例會將具有指定屬性的使用者新增至指定的 Amazon Connect 執行個體。aws connect create-user \ --username
Mary
\ --passwordPass@Word1
\ --identity-infoFirstName=Mary,LastName=Major
\ --phone-configPhoneType=DESK_PHONE,AutoAccept=true,AfterContactWorkTimeLimit=60,DeskPhoneNumber=+15555551212
\ --security-profile-id12345678-1111-2222-aaaa-a1b2c3d4f5g7
\ --routing-profile-id87654321-9999-3434-abcd-x1y2z3a1b2c3
\ --instance-ida1b2c3d4-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詳細資訊,請參閱 命令參考 CreateUser
中的 。 AWS CLI
-
下列程式碼範例示範如何使用 delete-user
。
- AWS CLI
-
若要刪除使用者
下列
delete-user
範例會從指定的 Amazon Connect 執行個體刪除指定的使用者。aws connect delete-user \ --instance-id
a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
\ --user-id87654321-2222-1234-1234-111234567891
此命令不會產生輸出。
如需詳細資訊,請參閱 Amazon Connect 管理員指南 中的管理使用者。
-
如需API詳細資訊,請參閱 命令參考 DeleteUser
中的 。 AWS CLI
-
下列程式碼範例示範如何使用 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-ida1b2c3d4-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 管理員指南 中的設定客服人員階層。
-
如需API詳細資訊,請參閱 命令參考 DescribeUserHierarchyGroup
中的 。 AWS CLI
-
下列程式碼範例示範如何使用 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 管理員指南 中的設定客服人員階層。
-
如需API詳細資訊,請參閱 命令參考 DescribeUserHierarchyStructure
中的 。 AWS CLI
-
下列程式碼範例示範如何使用 describe-user
。
- AWS CLI
-
若要顯示使用者的詳細資訊
下列
describe-user
範例顯示指定 Amazon Connect 使用者的詳細資訊。aws connect describe-user \ --user-id
0c245dc0-0cf5-4e37-800e-2a7481cc8a60
--instance-id40c83b68-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詳細資訊,請參閱 命令參考 DescribeUser
中的 。 AWS CLI
-
下列程式碼範例示範如何使用 get-contact-attributes
。
- AWS CLI
-
擷取聯絡人的屬性
下列
get-contact-attributes
範例會擷取為指定 Amazon Connect 聯絡人設定的屬性。aws connect get-contact-attributes \ --instance-id
a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
\ --initial-contact-id12345678-1111-2222-800e-a2b3c4d5f6g7
輸出:
{ "Attributes": { "greetingPlayed": "true" } }
如需詳細資訊,請參閱 Amazon Connect 管理員指南 中的使用 Amazon Connect 聯絡人屬性。 Amazon Connect
-
如需API詳細資訊,請參閱 命令參考 GetContactAttributes
中的 。 AWS CLI
-
下列程式碼範例示範如何使用 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 聯絡流程。 Amazon Connect
-
如需API詳細資訊,請參閱 命令參考 ListContactFlows
中的 。 AWS CLI
-
下列程式碼範例示範如何使用 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 管理員指南 中的設定佇列的操作時間。
-
如需API詳細資訊,請參閱 命令參考 ListHoursOfOperations
中的 。 AWS CLI
-
下列程式碼範例示範如何使用 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詳細資訊,請參閱 命令參考 ListPhoneNumbers
中的 。 AWS CLI
-
下列程式碼範例示範如何使用 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詳細資訊,請參閱 命令參考 ListQueues
中的 。 AWS CLI
-
下列程式碼範例示範如何使用 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 管理員指南 中的建立路由設定檔。
-
如需API詳細資訊,請參閱 命令參考 ListRoutingProfiles
中的 。 AWS CLI
-
下列程式碼範例示範如何使用 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 管理員指南 中的指派許可:安全設定檔。
-
如需API詳細資訊,請參閱 命令參考 ListSecurityProfiles
中的 。 AWS CLI
-
下列程式碼範例示範如何使用 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 管理員指南 中的設定客服人員階層。
-
如需API詳細資訊,請參閱 命令參考 ListUserHierarchyGroups
中的 。 AWS CLI
-
下列程式碼範例示範如何使用 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詳細資訊,請參閱 命令參考 ListUsers
中的 。 AWS CLI
-
下列程式碼範例示範如何使用 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-ida1b2c3d4-5678-90ab-cdef-EXAMPLE11111
\ --attributesgreetingPlayed=false
此命令不會產生輸出。
如需詳細資訊,請參閱 Amazon Connect 管理員指南 中的使用 Amazon Connect 聯絡人屬性。 Amazon Connect
-
如需API詳細資訊,請參閱 命令參考 UpdateContactAttributes
中的 。 AWS CLI
-
下列程式碼範例示範如何使用 update-user-hierarchy
。
- AWS CLI
-
更新使用者的階層
下列
update-user-hierarchy
範例會更新指定 Amazon Connect 使用者的代理程式階層。aws connect update-user-hierarchy \ --hierarchy-group-id
12345678-a1b2-c3d4-e5f6-123456789abc
\ --user-id87654321-2222-1234-1234-111234567891
\ --instance-ida1b2c3d4-5678-90ab-cdef-EXAMPLE11111
此命令不會產生輸出。
如需詳細資訊,請參閱 Amazon Connect 管理員指南 中的設定客服人員設定。
-
如需API詳細資訊,請參閱 命令參考 UpdateUserHierarchy
中的 。 AWS CLI
-
下列程式碼範例示範如何使用 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-id87654321-2222-1234-1234-111234567891
\ --instance-ida1b2c3d4-5678-90ab-cdef-EXAMPLE11111
此命令不會產生輸出。
如需詳細資訊,請參閱 Amazon Connect 管理員指南 中的設定客服人員設定。
-
如需API詳細資訊,請參閱 命令參考 UpdateUserIdentityInfo
中的 。 AWS CLI
-
下列程式碼範例示範如何使用 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-id12345678-4444-3333-2222-111122223333
\ --instance-ida1b2c3d4-5678-90ab-cdef-EXAMPLE11111
此命令不會產生輸出。
如需詳細資訊,請參閱 Amazon Connect 管理員指南 中的設定客服人員設定。
-
如需API詳細資訊,請參閱 命令參考 UpdateUserPhoneConfig
中的 。 AWS CLI
-
下列程式碼範例示範如何使用 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-id87654321-2222-1234-1234-111234567891
\ --instance-ida1b2c3d4-5678-90ab-cdef-EXAMPLE11111
此命令不會產生輸出。
如需詳細資訊,請參閱 Amazon Connect 管理員指南 中的設定客服人員設定。
-
如需API詳細資訊,請參閱 命令參考 UpdateUserRoutingProfile
中的 。 AWS CLI
-
下列程式碼範例示範如何使用 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-id87654321-2222-1234-1234-111234567891
\ --instance-ida1b2c3d4-5678-90ab-cdef-EXAMPLE11111
此命令不會產生輸出。
如需詳細資訊,請參閱 Amazon Connect 管理員指南 中的指派許可:安全設定檔。
-
如需API詳細資訊,請參閱 命令參考 UpdateUserSecurityProfiles
中的 。 AWS CLI
-