Skip to main content

Recording Available

The Recording Available event is sent after a recording has been processed. It indicates that the recording is available for download.

Request Parameters#

PropertyDescription
eventTypeThe event type, value is recordingAvailable.
eventTimeThe approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution.
accountIdThe user account associated with the call.
applicationIdThe id of the application associated with the call.
toThe phone number that received the call, in E.164 format (e.g. +15555555555).
fromThe provided identifier string of the caller used in the from field of the original call.
directionThe direction of the call. Either inbound or outbound. The direction of a call never changes.
callIdThe call id associated with the event.
parentCallId(optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present.
recordingIdThe unique id for this recording.
channelsNumber of channels in the recording (1 or 2).
enqueuedTime(optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.
startTimeThe time that the recording started (in ISO8601 format).
endTimeThe time that the recording ended (in ISO8601 format).
durationThe duration of the recording (in ISO8601 format).
fileFormatThe audio format that the recording was saved as (wav or mp3).
callUrlThe URL of the call associated with the event.
mediaUrlThe URL of the recording media.
tag(optional) The tag specified earlier in the call. If no tag was specified or it was previously cleared, this field will not be present.
statusThe state of the recording. Can be complete, partial, or error. A partial status indicates that, although the recording is available to be downloaded, parts of the recording are missing.
transferCallerId(optional) If the event is related to the B leg of a <Transfer>, the phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). Otherwise, this field will not be present.
transferTo(optional) If the event is related to the B leg of a <Transfer>, the phone number used as the to field of the B-leg call in E.164 format (e.g. +15555555555). Otherwise, this field will not be present.

Expected Response#

HTTP/1.1 204

Examples#

Recording Available#

POST http://yourUrl.example/recordingAvailable
Content-Type: application/json
{
"eventType" : "recordingAvailable",
"eventTime" : "2019-09-13T16:49:40.500",
"accountId" : "55555555",
"applicationId" : "7fc9698a-b04a-468b-9e8f-91238c0d0086",
"to" : "+15553334444",
"from" : "+15551112222",
"direction" : "outbound",
"callId" : "c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d",
"recordingId" : "r-115da407-e3d9-4ea7-889f-5f4ad7386a80",
"channels" : 1,
"startTime" : "2019-09-13T16:48:29.235Z",
"endTime" : "2019-09-13T16:48:48.890Z",
"duration" : "PT20.056S",
"fileFormat" : "wav",
"callUrl" : "https://../{accountId}/calls/{callId-1}",
"mediaUrl" : "https://../{accountId}/calls/{callId-1}/recordings/{recordingId}/media",
"status" : "complete"
}

Recording Available with Enqueued Time#

POST http://yourUrl.example/recordingAvailable
Content-Type: application/json
{
"eventType" : "recordingAvailable",
"eventTime" : "2019-09-13T16:49:40.500",
"accountId" : "55555555",
"applicationId" : "7fc9698a-b04a-468b-9e8f-91238c0d0086",
"to" : "+15553334444",
"from" : "+15551112222",
"direction" : "outbound",
"callId" : "c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d",
"recordingId" : "r-115da407-e3d9-4ea7-889f-5f4ad7386a80",
"channels" : 1,
"enqueuedTime" : "2019-09-13-16:48:27.198Z",
"startTime" : "2019-09-13T16:48:29.235Z",
"endTime" : "2019-09-13T16:48:48.890Z",
"duration" : "PT20.056S",
"fileFormat" : "wav",
"callUrl" : "https://../{accountId}/calls/{callId-1}",
"mediaUrl" : "https://../{accountId}/calls/{callId-1}/recordings/{recordingId}/media",
"status" : "complete"
}