record

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

Request ParameterTypeDescription
requestTypestringThe context or reason why this request is being made. Will be record - The RecordUtterance command has completed and its actionUrl is being invoked.
callIdstringUnique identifier for this Call, generated by FreeClimb.
accountIdstringAccount ID associated with your account.
fromstringPhone number of the party that initiated the Call (in E.164 format).
tostringPhone number provisioned to the customer and to which this Call is directed (in E.164 format).
callStatusstringDescriptive 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.
directionstringString 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.
conferenceIdstringThis is only populated if request pertains to a Conference. Otherwise, it is set to null.
queueIdstringThis is only populated if the request pertains to a Queue. Otherwise, it is set to null.
recordingIdstringID of the recording.
recordingUrlstringURL 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.
recordingSizestringSize of the recording in bytes
recordingFormatstringFile type of the recording (audio/wav)
recordingDurationSecintegerDuration of the recorded audio rounded up to the nearest second (in seconds)
termReasonstringReason for recording termination. Valid values are: finishKey, timeout, hangup, or maxLength.
parentCallIdstringID of Call that created this leg (child call).
privacyModebooleanIf 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.