Amazon Chime SDK PSTN オーディオサービスのテレフォニーイベントについて - Amazon Chime SDK
イベントタイプ

Amazon Chime SDK PSTN オーディオサービスのテレフォニーイベントについて

Audio Service は、通話中に特定のイベントが発生すると、AWS AWS Lambda 関数を呼び出します。次の例はイベントを示しています。それぞれのイベントについては、この例の後のテキストで説明しています。

{ 
    "SchemaVersion": "1.0", 
    "Sequence": 3, 
    "InvocationEventType": "event-type", 
    "CallDetails": { 
        "TransactionId": "transaction-id-1", 
        "AwsAccountId": "aws-acct-id-1", 
        "AwsRegion": "us-east-1", 
        "SipMediaApplicationId": "sip-media-app-id-1", 
        "Participants": [ 
            { 
                "CallId": "call-id-1", 
                "ParticipantTag": "LEG-A", 
                "To": "e164PhoneNumber", 
                "From": "e164PhoneNumber", 
                "Direction": "Inbound/Outbound", 
                "StartTimeInMilliseconds": "1641998241509", 
                "Status": "Connected/Disconnected" 
            } 
        ] 
    } 
}
SchemaVersion

このイベントオブジェクトの作成に使用されたスキーマのバージョン。

Sequence

AWS Lambda 関数を呼び出すイベントのシーケンス。通話中に関数が呼び出されるたびに、シーケンスがインクリメントされます。

InvocationEventType

AWS Lambda 呼び出しをトリガーするイベントのタイプ。詳細については、このトピックで後述する「イベントタイプ」を参照してください。

CallDetails

AWS Lambda 呼び出しに関連付けられた通話に関する情報。

TransactionId

AWS Lambda 呼び出しに関連付けられた通話の ID。

AwsAccountId

通話ルーティングを招いた SIP メディアアプリケーションに関連付けられた AWS アカウント ID。

SipMediaApplicationId

通話に関連付けられた SIP メディアアプリケーションの ID。

Participants

AWS AWS Lambda 関数を呼び出す通話の参加者に関する情報。

CallId

各参加者に割り当たられた一意の ID。

ParticipantTag

各通話参加者にはタグ (LEG-A または LEG-B) が付けられます。

To

参加者の「受信者」電話番号 (E.164 形式)。

From

参加者の「発信者」電話番号 (E.164 形式)。

Direction

通話レッグの発信元の方向。Inbound は Audio Service への通話を表します。Outbound は Audio Service からの通話を表します。

StartTimeInMilliseconds

参加者が通話に参加したときから始まるエポック時間 (ミリ秒単位)。

Status

参加者が Connected か Disconnected か。

イベントタイプ

Audio Service は、以下のイベントタイプを使用して Lambda 関数を呼び出します。

NEW_INBOUND_CALL

SIP メディアアプリケーションに関連付けられている電話番号から新しい通話が開始されました。

NEW_OUTBOUND_CALL

CreateSipMediaApplicationCall API を介して新しい発信通話が行われました。

ACTION_SUCCESSFUL

AWS Lambda 関数から返されたアクションが成功しました。成功したアクションには、成功したアクションと一致する ActionData が含まれます。


    "ActionData": {
        // The previous successful action 
    },
ACTION_FAILED

AWS Lambda 関数から返されたアクションは成功しませんでした。失敗したアクションには、失敗したアクションと一致する ActionData、エラータイプ、失敗について説明するエラーメッセージが含まれます。


    "ActionData": {
        // The previous unsuccessful action
        "ErrorType": "error-type",
        "ErrorMessage": "error message"
    },
ACTION_INTERRUPTED

UpdateSipMediaApplicationCall API 通話によって、実行中のアクションが中断されました。ActionData には中断されたアクションが含まれます。

"ActionData": {
        // The action that was interrupted
    },
HANGUP

ユーザーまたはアプリケーションが通話レッグをハングアップしました。ActionData にはイベントに関する以下の詳細が含まれます。


   "ActionData": {
        "Type": "Hangup",
        "Parameters": {
            "SipResponseCode": 486,
            "CallId": "c70f341a-adde-4406-9dea-1e01d34d033d",
            "ParticipantTag": "LEG-A"
        }
    },
Type

Hangup

Parameters

HANGUP イベントに関する情報:

  • SipResponseCode - イベントに関連付けられたレスポンスコード。最も一般的なコードは次のとおりです。

    • 0 - 通常のクリア

    • 480 - 応答なし

    • 486 - ユーザービジー

  • CallId ハングアップした参加者の ID。

  • ParticipantTag ハングアップした参加者のタグ。

CALL_ANSWERED

Audio Service が応答し、着信通話が応答されました。このイベントは、通話がブリッジされない限り、ダイヤルアウト通話時に返されます。

INVALID_LAMBDA_RESPONSE

最後の AWS Lambda 呼び出しに提供されたレスポンスが問題を引き起こしました。ActionData には以下の追加フィールドが含まれます。


    "ErrorType": "error-type-1", 
    "ErrorMessage": "error-msg-1"
DIGITS_RECEIVED

アプリケーションは、ReceiveDigits アクションの完了後に DTMF ディジットを受け取りました。ActionData には受け取ったディジットが含まれます。


    "ActionData": {
        "ReceivedDigits": ###
        // The ReceiveDigits action data
    },
CALL_UPDATE_REQUESTED

UpdateSipMediaApplicationCall API が呼び出されました。ActionData には更新リクエストに関する情報が含まれます。


    "ActionData": {
        "Type": "CallUpdateRequest", 
        "Parameters": {
            "Arguments": {
                "leg": "LEG-A"
                }
            }
        },
    }
RINGING

通話レッグの呼び出し音が鳴っています。