Understanding telephony events for Amazon Chime SDK PSTN audio service

The version of schema used to create this event object.

The sequence of events that invoke your AWS Lambda function. Each time your function is invoked during a call, the sequence is incremented.

The type of event that triggers an AWS Lambda invocation. For more information, see Event types later in this topic.

Information about the call associated with the AWS Lambda invocation.

The ID of a call associated with an AWS Lambda invocation.

The AWS account ID associated with the SIP media application that resulted in the call routing.

The ID of the SIP media application associated with the call.

Information about the participants on the call that invokes an AWS AWS Lambda function.

A unique ID assigned to each participant.

Each call participant gets a tag, LEG-A or LEG-B.

The participant "to" phone number, in E.164 format.

The participant “from” phone number, in E.164 format.

The direction that a call leg comes from. Inbound represents a call made to the Audio Service. Outbound represents a call made from the Audio Service.

The epoch time in milliseconds, starting when a participant joins a call.

Whether a participant is Connected or Disconnected

A new call has been initiated by a phone number associated with your SIP media application.

A new outbound call has been made via the CreateSipMediaApplicationCall API.

An action returned from your AWS Lambda function has succeeded. Successful actions include ActionData that matches the successful action.

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

An action returned from your AWS Lambda function did not succeed. Unsuccessful actions include ActionData that matches the failed action, an error type, and an error message that describes the failure:

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

An action in the process of running was interrupted by an UpdateSipMediaApplicationCall API invocation. The ActionData includes the interrupted actions:

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

A user or the application hung up a call leg. The ActionData includes these details about the event:

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

The Audio Service answered an incoming call was answered. This event is returned on a dial-out call unless the call is bridged.

The response provided to the last AWS Lambda invocation caused a problem. The ActionData includes these additional fields:

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

The application received DTMF digits after completion of a ReceiveDigits action. The ActionData includes the received digits.

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

The UpdateSipMediaApplicationCall API was invoked. The ActionData includes information about the update request:

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

A call leg is ringing