Skip to main content
Node.js
import { PeriskopeApi } from '@periskope/periskope-client';

const client = new PeriskopeApi({
  authToken: 'YOUR_API_KEY',
});

const result = await client.message.cancelBroadcast({
  broadcast_id: 'b25192d5-2370-4a69-b844-aae5e2bfae92',
});

// result.status is 'deleted' (was scheduled) or 'stopped' (was in-progress)
console.log(result.broadcast_id, result.status);
{
  "broadcast_id": "b25192d5-2370-4a69-b844-aae5e2bfae92",
  "status": "deleted"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

broadcast_id
string
required

The broadcast_id returned when the broadcast was created. You have to provide the broadcast_id here in order to delete or stop it.

Example:

"b25192d5-2370-4a69-b844-aae5e2bfae92"

Response

Broadcast was deleted or stopped successfully.

broadcast_id
string
Example:

"b25192d5-2370-4a69-b844-aae5e2bfae92"

status
enum<string>
Available options:
deleted,
stopped
Example:

"deleted"