Skip to content
Revox
Get started
API Reference
Call

Pause a call

client.call.pause(stringid, RequestOptionsoptions?): CallPauseResponse { success }
POST/call/{id}/pause

Pause a call's retry loop. The current in-progress attempt (if any) will finish, but no new attempts will be started until the call is resumed.

ParametersExpand Collapse
id: string
ReturnsExpand Collapse
CallPauseResponse { success }
success: boolean

Pause a call

import Revox from '@revoxai/sdk';

const client = new Revox({
  apiKey: process.env['REVOX_API_KEY'], // This is the default and can be omitted
});

const response = await client.call.pause('id');

console.log(response.success);
{
  "success": true
}
Returns Examples
{
  "success": true
}