Telnyx

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx();

const response = await client.rooms.sessions.actions.kick('0ccc7b54-4df3-4bca-a65a-3da1ecc777f0');

console.log(response.data);

{
  "data": {
    "result": "ok"
  }
}

POST

room_sessions

{room_session_id}

actions

kick

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx();

const response = await client.rooms.sessions.actions.kick('0ccc7b54-4df3-4bca-a65a-3da1ecc777f0');

console.log(response.data);

{
  "data": {
    "result": "ok"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

room_session_id

string<uuid>

required

The unique identifier of a room session.

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"

Body

application/json

Parameters that can be defined during Kick action.

participants

Either a list of participant id to perform the action on, or the keyword "all" to perform the action on all participant.

Available options:

all

Example:

"all"

exclude

string<uuid>[]

List of participant id to exclude from the action.

Response

200 - application/json

Success Action Response

data

object

Show child attributes

data.result

string

Example:

"ok"

End a room session.Mute participants in room session.

⌘I

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup