0

Stop audio playback

by
Published Apr 8, 2025

Stop audio being played on the call. **Expected Webhooks (see [callback schema](https://developers.telnyx.com/api/call-control/stop-call-playback#callbacks) below):** - `call.playback.ended` or `call.speak.ended`

Script telnyx Verified

The script

Submitted by hugo697 Bun
Verified 428 days ago
1
//native
2
type Telnyx = {
3
	apiKey: string
4
}
5
/**
6
 * Stop audio playback
7
 * Stop audio being played on the call.
8

9
**Expected Webhooks (see [callback schema](https://developers.telnyx.com/api/call-control/stop-call-playback#callbacks) below):**
10

11
- `call.playback.ended` or `call.speak.ended`
12

13
 */
14
export async function main(
15
	auth: Telnyx,
16
	call_control_id: string,
17
	body: {
18
		overlay?: false | true
19
		stop?: string
20
		client_state?: string
21
		command_id?: string
22
	}
23
) {
24
	const url = new URL(`https://api.telnyx.com/v2/calls/${call_control_id}/actions/playback_stop`)
25

26
	const response = await fetch(url, {
27
		method: 'POST',
28
		headers: {
29
			'Content-Type': 'application/json',
30
			Authorization: 'Bearer ' + auth.apiKey
31
		},
32
		body: JSON.stringify(body)
33
	})
34
	if (!response.ok) {
35
		const text = await response.text()
36
		throw new Error(`${response.status} ${text}`)
37
	}
38
	return await response.json()
39
}
40