ConferenceCommandsApi

All URIs are relative to https://api.telnyx.com/v2

Method	HTTP request	Description
callControlRecordConferenceStart	POST /conferences/{id}/actions/record_start	Conference recording start
callControlRecordConferenceStop	POST /conferences/{id}/actions/record_stop	Conference recording stop
createConference	POST /conferences	Create conference
getConference	GET /conferences/{id}	Retrieve a conference
getConferenceParticipants	GET /conferences/{id}/participants	List conference participants
getConferences	GET /conferences	List conferences
holdConference	POST /conferences/{id}/actions/hold	Hold conference participants
joinConference	POST /conferences/{id}/actions/join	Join a conference
muteConference	POST /conferences/{id}/actions/mute	Mute conference participants
unholdConference	POST /conferences/{id}/actions/unhold	Unhold conference participants
unmuteConference	POST /conferences/{id}/actions/unmute	Unmute conference participants

callControlRecordConferenceStart

ConferenceCommandResponse callControlRecordConferenceStart(body, id)

Conference recording start

Start recording the conference. Recording will stop on conference end, or via the Stop Recording command. Expected Webhooks: - `conference.recording.saved`

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ConferenceCommandsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


ConferenceCommandsApi apiInstance = new ConferenceCommandsApi();
StartRecordingRequest body = new StartRecordingRequest(); // StartRecordingRequest | 
String id = "id_example"; // String | Specifies the conference to record
try {
    ConferenceCommandResponse result = apiInstance.callControlRecordConferenceStart(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConferenceCommandsApi#callControlRecordConferenceStart");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	StartRecordingRequest
id	String	Specifies the conference to record

Return type

ConferenceCommandResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

callControlRecordConferenceStop

ConferenceCommandResponse callControlRecordConferenceStop(body, id)

Conference recording stop

Stop recording the conference. Expected Webhooks: - `conference.recording.saved`

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ConferenceCommandsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


ConferenceCommandsApi apiInstance = new ConferenceCommandsApi();
StopRecordingRequest body = new StopRecordingRequest(); // StopRecordingRequest | Stop recording conference request
String id = "id_example"; // String | Specifies the conference to stop the recording for
try {
    ConferenceCommandResponse result = apiInstance.callControlRecordConferenceStop(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConferenceCommandsApi#callControlRecordConferenceStop");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	StopRecordingRequest	Stop recording conference request
id	String	Specifies the conference to stop the recording for

Return type

ConferenceCommandResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

createConference

CreateConferenceResponse createConference(body)

Create conference

Create a conference from an existing call leg using a `call_control_id` and a conference name. Upon creating the conference, the call will be automatically bridged to the conference. Conferences will expire after all participants have left the conference or after 4 hours regardless of the number of active participants. Expected Webhooks: - `conference.created` - `conference.participant.joined` - `conference.participant.left` - `conference.ended` - `conference.recording.saved`

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ConferenceCommandsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


ConferenceCommandsApi apiInstance = new ConferenceCommandsApi();
CreateConferenceRequest body = new CreateConferenceRequest(); // CreateConferenceRequest | Create a conference
try {
    CreateConferenceResponse result = apiInstance.createConference(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConferenceCommandsApi#createConference");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	CreateConferenceRequest	Create a conference

Return type

CreateConferenceResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

getConference

GetConferenceResponse getConference(id)

Retrieve a conference

Retrieve an existing conference

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ConferenceCommandsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


ConferenceCommandsApi apiInstance = new ConferenceCommandsApi();
String id = "id_example"; // String | Uniquely identifies the conference
try {
    GetConferenceResponse result = apiInstance.getConference(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConferenceCommandsApi#getConference");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	Uniquely identifies the conference

Return type

GetConferenceResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

getConferenceParticipants

ListParticipantsResponse getConferenceParticipants(id, filterMuted, filterOnHold, filterWhispering, pageNumber, pageSize)

List conference participants

Lists conference participants

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ConferenceCommandsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


ConferenceCommandsApi apiInstance = new ConferenceCommandsApi();
String id = "id_example"; // String | Uniquely identifies the conference
Boolean filterMuted = true; // Boolean | If present, participants will be filtered to those who are/are not muted
Boolean filterOnHold = true; // Boolean | If present, participants will be filtered to those who are/are not put on hold
Boolean filterWhispering = true; // Boolean | If present, participants will be filtered to those who are whispering or are not
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
try {
    ListParticipantsResponse result = apiInstance.getConferenceParticipants(id, filterMuted, filterOnHold, filterWhispering, pageNumber, pageSize);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConferenceCommandsApi#getConferenceParticipants");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	Uniquely identifies the conference
filterMuted	Boolean	If present, participants will be filtered to those who are/are not muted	[optional]
filterOnHold	Boolean	If present, participants will be filtered to those who are/are not put on hold	[optional]
filterWhispering	Boolean	If present, participants will be filtered to those who are whispering or are not	[optional]
pageNumber	Integer	The page number to load	[optional] [default to 1] [enum: ]
pageSize	Integer	The size of the page	[optional] [default to 20] [enum: ]

Return type

ListParticipantsResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

getConferences

ListConferenceResponse getConferences(filterName, pageNumber, pageSize)

List conferences

Lists conferences. Conferences are created on demand, and will expire after all participants have left the conference or after 4 hours regardless of the number of active participants. Conferences are listed in descending order by `expires_at`.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ConferenceCommandsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


ConferenceCommandsApi apiInstance = new ConferenceCommandsApi();
String filterName = "filterName_example"; // String | If present, conferences will be filtered to those with a matching `name` attribute. Matching is case-sensitive
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
try {
    ListConferenceResponse result = apiInstance.getConferences(filterName, pageNumber, pageSize);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConferenceCommandsApi#getConferences");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
filterName	String	If present, conferences will be filtered to those with a matching `name` attribute. Matching is case-sensitive	[optional]
pageNumber	Integer	The page number to load	[optional] [default to 1] [enum: ]
pageSize	Integer	The size of the page	[optional] [default to 20] [enum: ]

Return type

ListConferenceResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

holdConference

ConferenceCommandResponse holdConference(body, id)

Hold conference participants

Hold a list of participants in a conference call

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ConferenceCommandsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


ConferenceCommandsApi apiInstance = new ConferenceCommandsApi();
ConferenceHoldRequest body = new ConferenceHoldRequest(); // ConferenceHoldRequest | 
String id = "id_example"; // String | Uniquely identifies the conference
try {
    ConferenceCommandResponse result = apiInstance.holdConference(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConferenceCommandsApi#holdConference");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	ConferenceHoldRequest
id	String	Uniquely identifies the conference

Return type

ConferenceCommandResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

joinConference

ConferenceCommandResponse joinConference(body, id)

Join a conference

Join an existing call leg to a conference. Issue the Join Conference command with the conference ID in the path and the `call_control_id` of the leg you wish to join to the conference as an attribute. Expected Webhooks: - `conference.participant.joined` - `conference.participant.left`

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ConferenceCommandsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


ConferenceCommandsApi apiInstance = new ConferenceCommandsApi();
JoinConferenceRequest body = new JoinConferenceRequest(); // JoinConferenceRequest | New Messaging Profile object
String id = "id_example"; // String | Uniquely identifies the conference
try {
    ConferenceCommandResponse result = apiInstance.joinConference(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConferenceCommandsApi#joinConference");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	JoinConferenceRequest	New Messaging Profile object
id	String	Uniquely identifies the conference

Return type

ConferenceCommandResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

muteConference

ConferenceCommandResponse muteConference(body, id)

Mute conference participants

Mute a list of participants in a conference call

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ConferenceCommandsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


ConferenceCommandsApi apiInstance = new ConferenceCommandsApi();
ConferenceMuteRequest body = new ConferenceMuteRequest(); // ConferenceMuteRequest | 
String id = "id_example"; // String | Uniquely identifies the conference
try {
    ConferenceCommandResponse result = apiInstance.muteConference(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConferenceCommandsApi#muteConference");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	ConferenceMuteRequest
id	String	Uniquely identifies the conference

Return type

ConferenceCommandResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

unholdConference

ConferenceCommandResponse unholdConference(body, id)

Unhold conference participants

Unhold a list of participants in a conference call

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ConferenceCommandsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


ConferenceCommandsApi apiInstance = new ConferenceCommandsApi();
ConferenceUnholdRequest body = new ConferenceUnholdRequest(); // ConferenceUnholdRequest | 
String id = "id_example"; // String | Uniquely identifies the conference
try {
    ConferenceCommandResponse result = apiInstance.unholdConference(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConferenceCommandsApi#unholdConference");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	ConferenceUnholdRequest
id	String	Uniquely identifies the conference

Return type

ConferenceCommandResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

unmuteConference

ConferenceCommandResponse unmuteConference(body, id)

Unmute conference participants

Unmute a list of participants in a conference call

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ConferenceCommandsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


ConferenceCommandsApi apiInstance = new ConferenceCommandsApi();
ConferenceUnmuteRequest body = new ConferenceUnmuteRequest(); // ConferenceUnmuteRequest | 
String id = "id_example"; // String | Uniquely identifies the conference
try {
    ConferenceCommandResponse result = apiInstance.unmuteConference(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConferenceCommandsApi#unmuteConference");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	ConferenceUnmuteRequest
id	String	Uniquely identifies the conference

Return type

ConferenceCommandResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

Files

ConferenceCommandsApi.md

Latest commit

History

ConferenceCommandsApi.md

File metadata and controls

ConferenceCommandsApi

callControlRecordConferenceStart

Example

Parameters

Return type

Authorization

HTTP request headers

callControlRecordConferenceStop

Example

Parameters

Return type

Authorization

HTTP request headers

createConference

Example

Parameters

Return type

Authorization

HTTP request headers

getConference

Example

Parameters

Return type

Authorization

HTTP request headers

getConferenceParticipants

Example

Parameters

Return type

Authorization

HTTP request headers

getConferences

Example

Parameters

Return type

Authorization

HTTP request headers

holdConference

Example

Parameters

Return type

Authorization

HTTP request headers

joinConference

Example

Parameters

Return type

Authorization

HTTP request headers

muteConference

Example

Parameters

Return type

Authorization

HTTP request headers

unholdConference

Example

Parameters

Return type

Authorization

HTTP request headers

unmuteConference

Example

Parameters

Return type

Authorization

HTTP request headers