Dial a new conference participant
Dials a new participant into the specified conference and returns the created participant resource.
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const response = await client.texml.accounts.conferences.participants.participants(
'conference_sid',
{ account_sid: 'account_sid' },
);
console.log(response.account_sid);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
response = client.texml.accounts.conferences.participants.participants(
conference_sid="conference_sid",
account_sid="account_sid",
)
print(response.account_sid)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.Texml.Accounts.Conferences.Participants.Participants(
context.TODO(),
"conference_sid",
telnyx.TexmlAccountConferenceParticipantParticipantsParams{
AccountSid: "account_sid",
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.AccountSid)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.texml.accounts.conferences.participants.ParticipantParticipantsParams;
import com.telnyx.sdk.models.texml.accounts.conferences.participants.ParticipantParticipantsResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
ParticipantParticipantsParams params = ParticipantParticipantsParams.builder()
.accountSid("account_sid")
.conferenceSid("conference_sid")
.build();
ParticipantParticipantsResponse response = client.texml().accounts().conferences().participants().participants(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
response = telnyx.texml.accounts.conferences.participants.participants("conference_sid", account_sid: "account_sid")
puts(response)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$response = $client->texml->accounts->conferences->participants->participants(
'conference_sid',
accountSid: 'account_sid',
amdStatusCallback: 'https://www.example.com/amd_result',
amdStatusCallbackMethod: 'GET',
applicationSid: '1846572522338780702',
beep: 'onExit',
callerID: 'Info',
callSidToCoach: 'v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ',
cancelPlaybackOnDetectMessageEnd: false,
cancelPlaybackOnMachineDetection: false,
coaching: false,
conferenceRecord: 'record-from-start',
conferenceRecordingStatusCallback: 'https://example.com/conference_recording_status_callback',
conferenceRecordingStatusCallbackEvent: 'in-progress completed failed absent',
conferenceRecordingStatusCallbackMethod: 'GET',
conferenceRecordingTimeout: 5,
conferenceStatusCallback: 'https://example.com/conference_status_callback',
conferenceStatusCallbackEvent: 'start end join leave',
conferenceStatusCallbackMethod: 'GET',
conferenceTrim: 'trim-silence',
customHeaders: [['name' => 'X-Custom-Header', 'value' => 'custom-value']],
earlyMedia: true,
endConferenceOnExit: true,
from: '+12065550200',
label: 'customer',
machineDetection: 'Enable',
machineDetectionSilenceTimeout: 2000,
machineDetectionSpeechEndThreshold: 2000,
machineDetectionSpeechThreshold: 2000,
machineDetectionTimeout: 1000,
maxParticipants: 30,
muted: true,
preferredCodecs: 'PCMA,PCMU',
record: false,
recordingChannels: 'dual',
recordingStatusCallback: 'https://example.com/recording_status_callback',
recordingStatusCallbackEvent: 'in-progress completed absent',
recordingStatusCallbackMethod: 'GET',
recordingTrack: 'inbound',
sipAuthPassword: '1234',
sipAuthUsername: 'user',
startConferenceOnEnter: false,
statusCallback: 'https://www.example.com/callback',
statusCallbackEvent: 'answered completed',
statusCallbackMethod: 'GET',
timeLimit: 30,
timeoutSeconds: 30,
to: '+12065550100',
trim: 'trim-silence',
waitURL: 'https://www.example.com/wait_music.mp3',
);
var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx texml:accounts:conferences:participants participants \
--api-key 'My API Key' \
--account-sid account_sid \
--conference-sid conference_sidcurl --request POST \
--url https://api.telnyx.com/v2/texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data 'To=+12065550100' \
--data 'From=+12065550200'{
"account_sid": "4e71926f-8f13-450e-b91c-23c2ef786aa6",
"call_sid": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
"coaching": false,
"conference_sid": "cd5a70f4-759b-4d5e-9c06-88c00f16f3c1",
"end_conference_on_exit": false,
"hold": false,
"muted": false,
"status": "completed",
"uri": "/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants/v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ.json"
}{
"errors": [
{
"detail": "Resource not found"
}
]
}Authorizations
Path Parameters
The UUID of the Telnyx account that owns the resource, for example f5586561-8ff0-4291-a51b-c7dfe4139ff9. The account_sid path segment is kept for Twilio API compatibility, but the value is a Telnyx account UUID, not a Twilio AC... SID. It must match the account that owns the API key used to authenticate the request, otherwise the endpoint returns 404. The same value is sent as AccountSid in TeXML webhooks.
"f5586561-8ff0-4291-a51b-c7dfe4139ff9"
Body
Dial Conference Participant request object
To be used as the caller id name (SIP From Display Name) presented to the destination (To number). The string should have a maximum of 128 characters, containing only letters, numbers, spaces, and -_~!.+ special characters. If ommited, the display name will be the same as the number in the From field.
"Info"
Whether to detect if a human or an answering machine picked up the call. Use Enable if you would like to ne notified as soon as the called party is identified. Use DetectMessageEnd, if you would like to leave a message on an answering machine.
Enable, DetectMessageEnd "Enable"
Selects which detectors must validate a beep. both requires the amplitude and frequency detectors to agree. freq_only uses the frequency detector alone, for beeps whose volume is too unsteady for the default profile. Only used when MachineDetection is enabled.
both, freq_only "freq_only"
Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising it above 480 excludes North American ringback (440 + 480 Hz), which can otherwise be reported as a beep when the freq_only profile is in use. Only used when MachineDetection is enabled.
200 <= x <= 4000550
Whether to record the conference the participant is joining. Defualts to do-not-record. The boolean values true and false are synonymous with record-from-start and do-not-record respectively.
true, false, record-from-start, do-not-record "record-from-start"
The changes to the conference recording's state that should generate a call to RecoridngStatusCallback. Can be: in-progress, completed and absent. Separate multiple values with a space. Defaults to completed. failed and absent are synonymous.
"in-progress completed failed absent"
The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected. The timer only starts when the speech is detected. Please note that the transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite)
5
Applies when ConferenceRecord is record-from-start or true. Silences spoken details of the given kinds in the recording: one or more of pci (card number, expiry date, security code), pii (personal details such as names, phone numbers, addresses and other identifying numbers) and phi (health details such as medications, doses and conditions), separated by commas, for example pci,pii. Redaction works on English speech only. Redacted recordings are charged at the Deepgram speech-to-text rate.
"pci,pii"
Response
New participant resource.
Was this page helpful?
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const response = await client.texml.accounts.conferences.participants.participants(
'conference_sid',
{ account_sid: 'account_sid' },
);
console.log(response.account_sid);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
response = client.texml.accounts.conferences.participants.participants(
conference_sid="conference_sid",
account_sid="account_sid",
)
print(response.account_sid)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.Texml.Accounts.Conferences.Participants.Participants(
context.TODO(),
"conference_sid",
telnyx.TexmlAccountConferenceParticipantParticipantsParams{
AccountSid: "account_sid",
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.AccountSid)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.texml.accounts.conferences.participants.ParticipantParticipantsParams;
import com.telnyx.sdk.models.texml.accounts.conferences.participants.ParticipantParticipantsResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
ParticipantParticipantsParams params = ParticipantParticipantsParams.builder()
.accountSid("account_sid")
.conferenceSid("conference_sid")
.build();
ParticipantParticipantsResponse response = client.texml().accounts().conferences().participants().participants(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
response = telnyx.texml.accounts.conferences.participants.participants("conference_sid", account_sid: "account_sid")
puts(response)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$response = $client->texml->accounts->conferences->participants->participants(
'conference_sid',
accountSid: 'account_sid',
amdStatusCallback: 'https://www.example.com/amd_result',
amdStatusCallbackMethod: 'GET',
applicationSid: '1846572522338780702',
beep: 'onExit',
callerID: 'Info',
callSidToCoach: 'v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ',
cancelPlaybackOnDetectMessageEnd: false,
cancelPlaybackOnMachineDetection: false,
coaching: false,
conferenceRecord: 'record-from-start',
conferenceRecordingStatusCallback: 'https://example.com/conference_recording_status_callback',
conferenceRecordingStatusCallbackEvent: 'in-progress completed failed absent',
conferenceRecordingStatusCallbackMethod: 'GET',
conferenceRecordingTimeout: 5,
conferenceStatusCallback: 'https://example.com/conference_status_callback',
conferenceStatusCallbackEvent: 'start end join leave',
conferenceStatusCallbackMethod: 'GET',
conferenceTrim: 'trim-silence',
customHeaders: [['name' => 'X-Custom-Header', 'value' => 'custom-value']],
earlyMedia: true,
endConferenceOnExit: true,
from: '+12065550200',
label: 'customer',
machineDetection: 'Enable',
machineDetectionSilenceTimeout: 2000,
machineDetectionSpeechEndThreshold: 2000,
machineDetectionSpeechThreshold: 2000,
machineDetectionTimeout: 1000,
maxParticipants: 30,
muted: true,
preferredCodecs: 'PCMA,PCMU',
record: false,
recordingChannels: 'dual',
recordingStatusCallback: 'https://example.com/recording_status_callback',
recordingStatusCallbackEvent: 'in-progress completed absent',
recordingStatusCallbackMethod: 'GET',
recordingTrack: 'inbound',
sipAuthPassword: '1234',
sipAuthUsername: 'user',
startConferenceOnEnter: false,
statusCallback: 'https://www.example.com/callback',
statusCallbackEvent: 'answered completed',
statusCallbackMethod: 'GET',
timeLimit: 30,
timeoutSeconds: 30,
to: '+12065550100',
trim: 'trim-silence',
waitURL: 'https://www.example.com/wait_music.mp3',
);
var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx texml:accounts:conferences:participants participants \
--api-key 'My API Key' \
--account-sid account_sid \
--conference-sid conference_sidcurl --request POST \
--url https://api.telnyx.com/v2/texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data 'To=+12065550100' \
--data 'From=+12065550200'{
"account_sid": "4e71926f-8f13-450e-b91c-23c2ef786aa6",
"call_sid": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
"coaching": false,
"conference_sid": "cd5a70f4-759b-4d5e-9c06-88c00f16f3c1",
"end_conference_on_exit": false,
"hold": false,
"muted": false,
"status": "completed",
"uri": "/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants/v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ.json"
}{
"errors": [
{
"detail": "Resource not found"
}
]
}