Amazon Connect の StartOutboundVoiceContact API における TrafficType ごとの同時通話クォータを整理してみた
はじめに
Amazon Connect の StartOutboundVoiceContact API では、TrafficType に GENERAL または CAMPAIGN を指定できます。
TrafficType=CAMPAIGN が必要になる代表的なケースの 1 つが、Answering Machine Detection（AMD）の利用です。AMD は、アウトバウンド発信時に、発信先が人間なのか留守番電話なのかを Amazon Connect 側で判定するための機能です。
StartOutboundVoiceContact API で AMD を有効化する場合は、AnswerMachineDetectionConfig.EnableAnswerMachineDetection=true に加えて、TrafficType=CAMPAIGN を指定する必要があります。
Use
CAMPAIGNifEnableAnswerMachineDetectionis set totrue.
EnableAnswerMachineDetectionがtrueの場合は、CAMPAIGNを使用します。https://docs.aws.amazon.com/connect/latest/APIReference/API_StartOutboundVoiceContact.html
このとき、Amazon Connect の Service Quotas にある以下 2 つの同時通話クォータのどちらを見積もればよいのかが気になりました。
Concurrent campaign active calls per instance- インスタンスあたりのアクティブな同時キャンペーン通話の数
Concurrent active calls per instance- インスタンスあたりのアクティブな同時呼び出しの数
本記事では、StartOutboundVoiceContact API の TrafficType ごとに、どの同時通話クォータの対象になるのかを整理します。
結論は以下です。
| 通話種別 | 対象クォータ |
|---|---|
TrafficType=CAMPAIGN の通話 |
Concurrent campaign active calls per instance |
TrafficType=GENERAL などの通常通話 |
Concurrent active calls per instance |
TrafficType=CAMPAIGN の通話は、CampaignId を指定していない場合でも Concurrent campaign active calls per instance の対象として考える必要があります。
前提知識
StartOutboundVoiceContact API の TrafficType
StartOutboundVoiceContact API の TrafficType は、アウトバウンド発信のトラフィック種別を指定するパラメータです。
公式ドキュメントでは、TrafficType について以下のように説明されています。
Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is
GENERAL. UseCAMPAIGNifEnableAnswerMachineDetectionis set totrue. For all other cases, useGENERAL.トラフィックの種別を示します。Amazon Connect では、トラフィック種別によって通話の扱いが異なります。デフォルト値は
GENERALです。EnableAnswerMachineDetectionがtrueの場合はCAMPAIGNを使用し、それ以外の場合はGENERALを使用します。https://docs.aws.amazon.com/connect/latest/APIReference/API_StartOutboundVoiceContact.html
指定できる値は以下です。
| 値 | 説明 |
|---|---|
GENERAL |
通常のアウトバウンド通話として扱います。未指定時のデフォルト値です。 |
CAMPAIGN |
キャンペーン通話として扱います。AMD を有効化する場合に指定します。 |
また、TrafficType=CAMPAIGN の通話は、CampaignId を指定していない場合でも Concurrent campaign active calls per instance の対象として考える必要があります。
AMD を使う場合の指定
AMD を有効化する場合は、AnswerMachineDetectionConfig.EnableAnswerMachineDetection=true と TrafficType=CAMPAIGN を指定します。
以下は、ap-northeast-1 で実行する例です。instance-id、contact-flow-id、電話番号は利用環境に合わせて置き換えてください。
aws connect start-outbound-voice-contact \
--instance-id "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" \
--contact-flow-id "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" \
--destination-phone-number "+819012345678" \
--source-phone-number "+815012345678" \
--answer-machine-detection-config "EnableAnswerMachineDetection=true,AwaitAnswerMachinePrompt=false" \
--traffic-type CAMPAIGN \
--ring-timeout-in-seconds 60 \
--region ap-northeast-1
TrafficType ごとに対象となる同時通話クォータ
Amazon Connect の同時通話クォータを見積もる際は、TrafficType=CAMPAIGN の通話と、TrafficType=GENERAL などの通常通話を分けて考える必要があります。
TrafficType=CAMPAIGN の通話
TrafficType=CAMPAIGN の通話は、Concurrent campaign active calls per instance の対象です。
公式ドキュメントでは、Concurrent campaign active calls per instance に相当するクォータについて以下のように説明されています。
現在のリージョンにおいてこのインスタンスで使用できるアクティブな同時キャンペーン通話の最大数。この値を超えると、問い合わせは高速の話し中の音になります。これは、着信番号への転送パスが利用できないことを示します。
そのため、AMD を利用する目的で TrafficType=CAMPAIGN を指定する場合も、キャンペーン通話用の同時通話クォータを確認します。
TrafficType=GENERAL などの通常通話
TrafficType=GENERAL の通話や、TrafficType を未指定にした通常のアウトバウンド通話は、Concurrent active calls per instance の対象として考えます。
公式ドキュメントでは、Concurrent active calls per instance の問い合わせのカウント方法について、以下のように説明されています。
問い合わせのカウント方法
次のコンタクトは、[インスタンスあたりのアクティブな同時呼び出しの数] にカウントされます。
- フローで処理される
- キューで待機中
- エージェントによって処理される
- 発信通話
以下の問い合わせはカウントされません。
- コールバックキューで待機しているコールバックは、利用可能なエージェントにコールバックが提供されるまでカウントされません。
- 外部転送
[インスタンスあたりのアクティブな同時呼び出しの数] のクォータを超えた場合、コンタクトは順序変更音 (高速の話し中の音ともいいます) になり、着信番号への転送パスが使用できないことを示します。
https://docs.aws.amazon.com/ja_jp/connect/latest/adminguide/amazon-connect-service-limits.html
通常通話とキャンペーン通話では、主に確認すべき同時通話クォータが異なる点に注意します。
CampaignId を指定しない場合でも CAMPAIGN 通話として扱われる
StartOutboundVoiceContact API には、CampaignId というパラメータがあります。
公式ドキュメント上、CampaignId は必須パラメータではありません。
CampaignId
Required: No
https://docs.aws.amazon.com/connect/latest/APIReference/API_StartOutboundVoiceContact.html
ここで気になるのが、Amazon Connect Outbound Campaigns の CampaignId を指定せず、TrafficType=CAMPAIGN のみを指定した場合でも、Concurrent campaign active calls per instance の対象になるのかという点です。
今回確認した範囲では、CampaignId を指定していない場合でも、TrafficType=CAMPAIGN の通話は Concurrent campaign active calls per instance の対象になります。
つまり、Amazon Connect Outbound Campaigns のキャンペーン機能自体を利用せず、StartOutboundVoiceContact API から直接発信する構成であっても、TrafficType=CAMPAIGN を指定する場合は、キャンペーン通話用の同時通話クォータを見積もる必要があります。
整理すると以下です。
| API での指定 | CampaignId |
対象クォータ |
|---|---|---|
TrafficType=CAMPAIGN |
指定あり | Concurrent campaign active calls per instance |
TrafficType=CAMPAIGN |
指定なし | Concurrent campaign active calls per instance |
TrafficType=GENERAL または未指定 |
通常は指定なし | Concurrent active calls per instance |
CampaignId の有無ではなく、TrafficType=CAMPAIGN として発信するかどうかを基準に、キャンペーン通話用の同時通話クォータを確認します。
同時に複数の CAMPAIGN 通話が存在する場合の見積もり
例えば、以下のようなケースを考えます。
- 同一 Amazon Connect インスタンスを利用する
- 同一リージョンで発信する
StartOutboundVoiceContactAPI でTrafficType=CAMPAIGNを指定する- 異なる宛先電話番号へ 5 件発信する
- 5 件が同時に呼出中または通話中になる
この場合、Concurrent campaign active calls per instance は 5 以上に引き上げる必要があります。
ここで重要なのは、API レート制限と同時通話クォータは別物という点です。
| 観点 | 説明 |
|---|---|
| API レート制限 | StartOutboundVoiceContact API を呼び出す頻度の制限です。 |
Concurrent campaign active calls per instance |
同時に存在できる TrafficType=CAMPAIGN の通話数の制限です。 |
Amazon Connect Service API のスロットリングクォータについて、公式ドキュメントでは、原則として RateLimit が 1 秒あたり 2 リクエスト、BurstLimit が 1 秒あたり 5 リクエストと説明されています。
本記事で扱う StartOutboundVoiceContact API については、この API レート制限とは別に、同時に存在する通話数のクォータも考慮する必要があります。
Amazon Connect Service API を使用する場合、すべてのオペレーションにおいて、
RateLimitは 1 秒あたり 2 リクエスト、BurstLimitは 1 秒あたり 5 リクエストになります。https://docs.aws.amazon.com/ja_jp/connect/latest/adminguide/amazon-connect-service-limits.html
API レート制限を守って実行していても、通話がすぐに終了しなければ、同時に存在する通話数は増えます。
そのため、TrafficType=CAMPAIGN の通話を短時間に複数発信する場合は、API の呼び出し頻度だけでなく、同時に呼出中または通話中になり得る最大数をもとに Concurrent campaign active calls per instance を見積もる必要があります。
active call の開始タイミングと解放タイミング
Concurrent campaign active calls per instance における active call が、厳密にどの時点からカウントされ、どの時点で解放されるかは、公開ドキュメント上では確認できませんでした。
例えば、以下のどの時点がカウント開始になるかは、公開情報からは判断できません。
StartOutboundVoiceContactAPI が成功してContactIdが返却された時点- 発信先への呼出が開始された時点
- 発信先が応答した時点
- その他の時点
同様に、以下のどの時点でカウントから解放されるかも、公開情報からは判断できません。
- 発信先が応答せず、
RingTimeoutInSecondsにより呼出が終了した時点 - 通話が切断された時点
- コンタクトフローの処理が終了した時点
- その他の時点
そのため、設計時は内部的な厳密なカウントタイミングに依存せず、同時に呼出中または通話中になり得る最大数をもとに、余裕を持ってクォータを見積もるのがよさそうです。
クォータ引き上げ時に確認すること
TrafficType=CAMPAIGN の通話は、デフォルトでは許可されていません。公式ドキュメントにも、TrafficType=CAMPAIGN で通話する前に、Service Quotas の引き上げリクエストが必要である旨が記載されています。
Campaign calls are not allowed by default. Before you can make a call with
TrafficType=CAMPAIGN, you must submit a service quota increase request to the quota Amazon Connect campaigns.キャンペーン通話はデフォルトでは許可されていません。
TrafficType=CAMPAIGNで通話する前に、Amazon Connect campaigns のクォータ引き上げリクエストを送信する必要があります。https://docs.aws.amazon.com/connect/latest/APIReference/API_StartOutboundVoiceContact.html
クォータ引き上げを申請する際は、API の呼び出し頻度ではなく、同時に存在し得る CAMPAIGN 通話数をもとに見積もります。
例えば、以下の観点を整理しておくとよいです。
- 同時に発信する可能性がある最大件数
- 呼出中として残る最大時間
- 平均通話時間と最大通話時間
- リトライや再発信の有無
- ピーク時間帯に同時に存在し得る CAMPAIGN 通話数
最大 5 件の TrafficType=CAMPAIGN 通話が同時に呼出中または通話中になる可能性がある場合、Concurrent campaign active calls per instance は少なくとも 5 以上が必要です。
まとめ
StartOutboundVoiceContact API における TrafficType ごとの同時通話クォータを整理しました。
TrafficType=CAMPAIGN の通話は、CampaignId を指定していない場合でも Concurrent campaign active calls per instance の対象として考える必要があります。一方、TrafficType=GENERAL などの通常通話は、Concurrent active calls per instance の対象として見積もります。
特に、AMD を利用するために TrafficType=CAMPAIGN を指定する場合は、API レート制限だけでなく、同時に呼出中または通話中になり得る CAMPAIGN 通話数をもとに、Concurrent campaign active calls per instance のクォータを確認しましょう。
