PhoneCall
Represents information about a phone call.
new PhoneCall(param)
| Field | Type | Description | Required |
|---|---|---|---|
| param | object | Parameters associated with a phone call. | |
| param.agentStatus | string | Optional. Status of the rep on the call. | |
| param.agentARN | string | Optional. Amazon Resource Name (ARN) identifying the rep in the telephony system. | No |
| param.callAttributes | PhoneCallAttributes | Attributes associated with the call. The values in this object are immutable and can’t be updated by the partner. See example below. | |
| param.callId | string | The unique identifier for the phone call. This ID is used to track and manage the call within the system. | Yes |
| param.callInfo | CallInfo | Optional. Call info using key value pairs in a JSON object. | |
| param.callType | string | Optional. The type of call. One of these values: Inbound, Outbound, Callback, AddParticipant, Consult. | |
| param.closeCallOnError | boolean | Optional. Whether the call was closed for an error. | |
| param.connectionId | string | Optional. An identifier for a call leg. By default, the connectionId value is the same as callId. Telephony providers other than Amazon Connect don’t need to set the connectionId. | |
| param.contact | Contact | Optional. The call target or contact. | |
| param.phoneNumber | string | Optional. The phone number associated with this call; usually an external number. | |
| param.reason | string | Optional. Reason for phone call. | |
| param.state | string | Optional. The state of the call. For example: ringing, connected, declined, failed. |