Amazon Connectの新しいAPIでクイック接続を操作する

概要

Amazon Connectに新しいAPIが追加され、クイック接続の設定を行うことができるようになりました
ユーザー（Amacon Connectではエージェントと呼ばれます）を追加／削除した場合、多くの場合は転送するためのクイック接続設定を行うと思います
下記ブログで紹介されているように、APIを使ってクイック接続設定を自動化することが可能になります

https://aws.amazon.com/jp/blogs/contact-center/managing-quick-connects-with-a-new-api-in-amazon-connect/

試す環境

手元の環境(Ubuntu20.04 on WSL2)にて、AWSCLIを利用して試してみました

新しいAPIなのでAWS CLIもアップデートしました
バージョン2.1.19でした

$ aws --version
aws-cli/2.1.19 Python/3.7.3 Linux/4.19.128-microsoft-standard exe/x86_64.ubuntu.20 prompt/off

実行結果

各種機能を実行して動作を確認します

create-quick-connect

クイック接続を作成します
ここでは、エージェントタイプを作成してみようと思いますので、パラメータとして下記が必要になります

• ユーザーID
• 問い合わせフローID（エージェント転送タイプ）

ユーザーIDを確認

list-users APIを使用して確認します

$ aws connect list-users \ 
  --instance-id zzzzzzzzzz
{
    "UserSummaryList": [
        {
            "Id": "xxxxxxxxxx",
            "Arn": "arn:aws:connect:ap-northeast-1:999999999999:instance/zzzzzzzzzz/agent/xxxxxxxxxx",
            "Username": "member_x"
        },
...(snip)

問い合わせフローIDを確認

$ aws connect list-contact-flows \
  --instance-id zzzzzzzzzz \
  --contact-flow-types AGENT_TRANSFER
{
    "ContactFlowSummaryList": [
        {
            "Id": "yyyyyyyyyy",
            "Arn": "arn:aws:connect:ap-northeast-1:999999999999:instance/zzzzzzzzzz/contact-flow/yyyyyyyyyy",
            "Name": "Default agent transfer",
            "ContactFlowType": "AGENT_TRANSFER"
        }
    ]
}

エージェント転送クイック接続作成

正常に受け付けられると作成されたクイック接続IDがレスポンスされます

$ aws connect create-quick-connect \
  --instance-id zzzzzzzzzz \
  --name createtest-quick-connet \
  --quick-connect-config 'QuickConnectType=USER,UserConfig={UserId=xxxxxxxxxx,ContactFlowId=yyyyyyyyyy}'
{
    "QuickConnectARN": "arn:aws:connect:ap-northeast-1:999999999999:instance/zzzzzzzzzz/transfer-destination/aaaaaaaaaa",
    "QuickConnectId": "aaaaaaaaaa"
}

クイック接続作成 確認

管理画面で確認できます

list-quick-connects

クイック接続一覧を取得します

$ aws connect list-quick-connects \
  --instance-id zzzzzzzzzz
{
    "QuickConnectSummaryList": [
        {
            "Id": "aaaaaaaaaa",
            "Arn": "arn:aws:connect:ap-northeast-1:999999999999:instance/zzzzzzzzzz/transfer-destination/aaaaaaaaaa",
            "Name": "createtest-quick-connet",
            "QuickConnectType": "USER"
        },
...(snip)...

describe-quick-connect

クイック接続の詳細情報を取得します

$ aws connect describe-quick-connect \
  --instance-id zzzzzzzzzz \
  --quick-connect-id aaaaaaaaaa
{
    "QuickConnect": {
        "QuickConnectARN": "arn:aws:connect:ap-northeast-1:9999999999:instance/zzzzzzzzzz/transfer-destination/aaaaaaaaaa",
        "QuickConnectId": "aaaaaaaaaa",
        "Name": "createtest-quick-connet",
        "QuickConnectConfig": {
            "QuickConnectType": "USER",
            "UserConfig": {
                "UserId": "xxxxxxxxxx",
                "ContactFlowId": "yyyyyyyyyy"
            }
        },
        "Tags": {}
    }
}

update-quick-connect-name

クイック接続の名前と説明を更新します
レスポンスは表示されませんが更新されています

$ aws connect update-quick-connect-name \
  --instance-id zzzzzzzzzz \
  --quick-connect-id aaaaaaaaaa \
  --name createtest-quick-connet-rename \
  --description 更新しました

update-quick-connect-config

クイック接続の設定内容を更新します 下記ではユーザーIDを変更しています
レスポンスは表示されませんが更新されています

$ aws connect update-quick-connect-config \
  --instance-id zzzzzzzzzz \
  --quick-connect-id aaaaaaaaaa \
  --quick-connect-config 'QuickConnectType=USER,UserConfig={UserId=cccccccccc,ContactFlowId=yyyyyyyyyy}'

delete-quick-connect

クイック接続の設定を削除します
Amazon Connectの管理画面ではクイック接続の削除操作ができないのですが、API操作では削除できるようです
いずれ管理画面上もアップデートされるのかもしれませんね

$ aws connect delete-quick-connect \
  --instance-id zzzzzzzzzz \
  --quick-connect-id aaaaaaaaaa

管理画面では変更履歴を確認することができます

Amazon Connect管理画面で確認

クイック接続設定を操作した履歴が確認できます
[リソース名] 部分のリンクをクリックするとさらに詳細な変更履歴を確認できます
監査も安心ですね

まとめ

Amazon ConnectのAPI、続々と追加されて管理面の自動化が進むようになりますね