Objective

Setting up call recording parameters to record an entire call or part of a call with the Voice API.

Applies To

• Voice API
• Call Recordings

Procedure

When using Voice API to record calls, different parameters in the Record action can change how the call is handled. When using the record action in Voice API, the recording will record the entire call from the time the action is started, unless there is a timeout or end parameter set. When a timeout or end parameter is set, the recording enters a blocking state. When a timeout or end parameter is not set, the recording is not in a blocking state.

Timeout and end parameters are endOnSilence, timeOutI, or endOnKey and when these are set in the record action, the call enters a blocking state and the recording will not end and proceed onto the next action until the parameter has been met. If "endOnKey": "#" is set, then the call will be recorded from the point the record action starts until the # key is pressed. Once the recording has entered, the call will proceed to the next action.

If you need to record the entire call, the record action should be the first action in the NCCO, and there should be no timeout set. If you want to record everything at the last action and have the recording terminate on disconnect, then the record action should be the last action in the NCCO without a timeout set.

After your recording is complete, it is stored by Vonage for 30 days.

Additional Information

You can find examples in our developer documentation on Voice API > NCCO Reference > Record

and Voice API > Recordings.