record

The RecordUtterance command has completed and its actionUrl is being invoked.

Request Parameter

Type

Description

requestType

string

The context or reason why this request is being made. Will be record - The RecordUtterance command has completed and its actionUrl is being invoked.

callId

string

Unique identifier for this Call, generated by FreeClimb.

accountId

string

Account ID associated with your account.

from

string

Phone number of the party that initiated the Call (in E.164 format).

to

string

Phone number provisioned to the customer and to which this Call is directed (in E.164 format).

callStatus

string

Descriptive status for the Call. Valid values are:
ringing - Call is currently ringing.
inProgress - Call was answered and is currently in progress (not Queued, not in Conference).
completed - Call ended normally.
busy - Caller received a busy signal.
failed - Call could not be completed as dialed (most likely because the phone number was nonexistent).
noAnswer - Call ended without being answered.
canceled - Call was canceled via the REST API while queued or ringing.

direction

string

String describing the direction of the Call – inbound for inbound calls, outbound for calls initiated via the REST API, outboundDial for Calls initiated by the OutDial PerCL command.

conferenceId

string

This is only populated if request pertains to a Conference. Otherwise, it is set to null.

queueId

string

This is only populated if the request pertains to a Queue. Otherwise, it is set to null.

recordingId

string

ID of the recording.

recordingUrl

string

URL of the recorded audio file. This URL can be used as is in a Play command to play the recording (no authentication needed). It can also be used to download a recording file via the REST API.

recordingSize

string

Size of the recording in bytes

recordingFormat

string

File type of the recording (audio/wav)

recordingDurationSec

integer

Duration of the recorded audio rounded up to the nearest second (in seconds)

termReason

string

Reason for recording termination. Valid values are: finishKey, timeout, hangup, or maxLength.

parentCallId

string

ID of Call that created this leg (child call).

privacyMode

boolean

If true then it indicates the recording will only be available for download for two minutes prior to it being deleted. This is to minimize risk of anyone else getting access to the url and attempting to access it.