telnyx-voice-conferencing-java

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->
<!-- 由Telnyx OpenAPI规范自动生成,请勿编辑。 -->

Telnyx Voice Conferencing - Java

Telnyx语音会议 - Java版

Installation

安装

text
// See https://github.com/team-telnyx/telnyx-java for Maven/Gradle setup
text
// 有关Maven/Gradle配置,请查看https://github.com/team-telnyx/telnyx-java

Setup

初始化

java
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

TelnyxClient client = TelnyxOkHttpClient.fromEnv();
All examples below assume
client
is already initialized as shown above.
java
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

TelnyxClient client = TelnyxOkHttpClient.fromEnv();
以下所有示例均假设
client
已按上述方式初始化。

Enqueue call

将呼叫加入队列

Put the call in a queue.
POST /calls/{call_control_id}/actions/enqueue
— Required:
queue_name
Optional:
client_state
(string),
command_id
(string),
keep_after_hangup
(boolean),
max_size
(integer),
max_wait_time_secs
(integer)
java
import com.telnyx.sdk.models.calls.actions.ActionEnqueueParams;
import com.telnyx.sdk.models.calls.actions.ActionEnqueueResponse;

ActionEnqueueParams params = ActionEnqueueParams.builder()
    .callControlId("call_control_id")
    .queueName("support")
    .build();
ActionEnqueueResponse response = client.calls().actions().enqueue(params);
将呼叫添加到指定队列中。
POST /calls/{call_control_id}/actions/enqueue
— 必填参数:
queue_name
可选参数:
client_state
(字符串)、
command_id
(字符串)、
keep_after_hangup
(布尔值)、
max_size
(整数)、
max_wait_time_secs
(整数)
java
import com.telnyx.sdk.models.calls.actions.ActionEnqueueParams;
import com.telnyx.sdk.models.calls.actions.ActionEnqueueResponse;

ActionEnqueueParams params = ActionEnqueueParams.builder()
    .callControlId("call_control_id")
    .queueName("support")
    .build();
ActionEnqueueResponse response = client.calls().actions().enqueue(params);

Remove call from a queue

将呼叫移出队列

Removes the call from a queue.
POST /calls/{call_control_id}/actions/leave_queue
Optional:
client_state
(string),
command_id
(string)
java
import com.telnyx.sdk.models.calls.actions.ActionLeaveQueueParams;
import com.telnyx.sdk.models.calls.actions.ActionLeaveQueueResponse;

ActionLeaveQueueResponse response = client.calls().actions().leaveQueue("call_control_id");
将呼叫从队列中移除。
POST /calls/{call_control_id}/actions/leave_queue
可选参数:
client_state
(字符串)、
command_id
(字符串)
java
import com.telnyx.sdk.models.calls.actions.ActionLeaveQueueParams;
import com.telnyx.sdk.models.calls.actions.ActionLeaveQueueResponse;

ActionLeaveQueueResponse response = client.calls().actions().leaveQueue("call_control_id");

List conferences

列出所有会议

Lists conferences.
GET /conferences
java
import com.telnyx.sdk.models.conferences.ConferenceListPage;
import com.telnyx.sdk.models.conferences.ConferenceListParams;

ConferenceListPage page = client.conferences().list();
查询会议列表。
GET /conferences
java
import com.telnyx.sdk.models.conferences.ConferenceListPage;
import com.telnyx.sdk.models.conferences.ConferenceListParams;

ConferenceListPage page = client.conferences().list();

Create conference

创建会议

Create a conference from an existing call leg using a
call_control_id
and a conference name.
POST /conferences
— Required:
call_control_id
,
name
Optional:
beep_enabled
(enum),
client_state
(string),
comfort_noise
(boolean),
command_id
(string),
duration_minutes
(integer),
hold_audio_url
(string),
hold_media_name
(string),
max_participants
(integer),
region
(enum),
start_conference_on_create
(boolean)
java
import com.telnyx.sdk.models.conferences.ConferenceCreateParams;
import com.telnyx.sdk.models.conferences.ConferenceCreateResponse;

ConferenceCreateParams params = ConferenceCreateParams.builder()
    .callControlId("v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg")
    .name("Business")
    .build();
ConferenceCreateResponse conference = client.conferences().create(params);
通过现有通话的
call_control_id
和会议名称创建新会议。
POST /conferences
— 必填参数:
call_control_id
name
可选参数:
beep_enabled
(枚举值)、
client_state
(字符串)、
comfort_noise
(布尔值)、
command_id
(字符串)、
duration_minutes
(整数)、
hold_audio_url
(字符串)、
hold_media_name
(字符串)、
max_participants
(整数)、
region
(枚举值)、
start_conference_on_create
(布尔值)
java
import com.telnyx.sdk.models.conferences.ConferenceCreateParams;
import com.telnyx.sdk.models.conferences.ConferenceCreateResponse;

ConferenceCreateParams params = ConferenceCreateParams.builder()
    .callControlId("v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg")
    .name("Business")
    .build();
ConferenceCreateResponse conference = client.conferences().create(params);

Retrieve a conference

获取会议详情

Retrieve an existing conference
GET /conferences/{id}
java
import com.telnyx.sdk.models.conferences.ConferenceRetrieveParams;
import com.telnyx.sdk.models.conferences.ConferenceRetrieveResponse;

ConferenceRetrieveResponse conference = client.conferences().retrieve("id");
查询指定会议的详细信息。
GET /conferences/{id}
java
import com.telnyx.sdk.models.conferences.ConferenceRetrieveParams;
import com.telnyx.sdk.models.conferences.ConferenceRetrieveResponse;

ConferenceRetrieveResponse conference = client.conferences().retrieve("id");

Hold conference participants

暂停会议参与者通话

Hold a list of participants in a conference call
POST /conferences/{id}/actions/hold
Optional:
audio_url
(string),
call_control_ids
(array[string]),
media_name
(string),
region
(enum)
java
import com.telnyx.sdk.models.conferences.actions.ActionHoldParams;
import com.telnyx.sdk.models.conferences.actions.ActionHoldResponse;

ActionHoldResponse response = client.conferences().actions().hold("id");
将会议中的指定参与者置于通话暂停状态。
POST /conferences/{id}/actions/hold
可选参数:
audio_url
(字符串)、
call_control_ids
(字符串数组)、
media_name
(字符串)、
region
(枚举值)
java
import com.telnyx.sdk.models.conferences.actions.ActionHoldParams;
import com.telnyx.sdk.models.conferences.actions.ActionHoldResponse;

ActionHoldResponse response = client.conferences().actions().hold("id");

Join a conference

加入会议

Join an existing call leg to a conference.
POST /conferences/{id}/actions/join
— Required:
call_control_id
Optional:
beep_enabled
(enum),
client_state
(string),
command_id
(string),
end_conference_on_exit
(boolean),
hold
(boolean),
hold_audio_url
(string),
hold_media_name
(string),
mute
(boolean),
region
(enum),
soft_end_conference_on_exit
(boolean),
start_conference_on_enter
(boolean),
supervisor_role
(enum),
whisper_call_control_ids
(array[string])
java
import com.telnyx.sdk.models.conferences.actions.ActionJoinParams;
import com.telnyx.sdk.models.conferences.actions.ActionJoinResponse;

ActionJoinParams params = ActionJoinParams.builder()
    .id("id")
    .callControlId("v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg")
    .build();
ActionJoinResponse response = client.conferences().actions().join(params);
将现有通话加入指定会议。
POST /conferences/{id}/actions/join
— 必填参数:
call_control_id
可选参数:
beep_enabled
(枚举值)、
client_state
(字符串)、
command_id
(字符串)、
end_conference_on_exit
(布尔值)、
hold
(布尔值)、
hold_audio_url
(字符串)、
hold_media_name
(字符串)、
mute
(布尔值)、
region
(枚举值)、
soft_end_conference_on_exit
(布尔值)、
start_conference_on_enter
(布尔值)、
supervisor_role
(枚举值)、
whisper_call_control_ids
(字符串数组)
java
import com.telnyx.sdk.models.conferences.actions.ActionJoinParams;
import com.telnyx.sdk.models.conferences.actions.ActionJoinResponse;

ActionJoinParams params = ActionJoinParams.builder()
    .id("id")
    .callControlId("v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg")
    .build();
ActionJoinResponse response = client.conferences().actions().join(params);

Leave a conference

退出会议

Removes a call leg from a conference and moves it back to parked state.
POST /conferences/{id}/actions/leave
— Required:
call_control_id
Optional:
beep_enabled
(enum),
command_id
(string),
region
(enum)
java
import com.telnyx.sdk.models.conferences.actions.ActionLeaveParams;
import com.telnyx.sdk.models.conferences.actions.ActionLeaveResponse;

ActionLeaveParams params = ActionLeaveParams.builder()
    .id("id")
    .callControlId("c46e06d7-b78f-4b13-96b6-c576af9640ff")
    .build();
ActionLeaveResponse response = client.conferences().actions().leave(params);
将通话从会议中移除并恢复到驻留状态。
POST /conferences/{id}/actions/leave
— 必填参数:
call_control_id
可选参数:
beep_enabled
(枚举值)、
command_id
(字符串)、
region
(枚举值)
java
import com.telnyx.sdk.models.conferences.actions.ActionLeaveParams;
import com.telnyx.sdk.models.conferences.actions.ActionLeaveResponse;

ActionLeaveParams params = ActionLeaveParams.builder()
    .id("id")
    .callControlId("c46e06d7-b78f-4b13-96b6-c576af9640ff")
    .build();
ActionLeaveResponse response = client.conferences().actions().leave(params);

Mute conference participants

静音会议参与者

Mute a list of participants in a conference call
POST /conferences/{id}/actions/mute
Optional:
call_control_ids
(array[string]),
region
(enum)
java
import com.telnyx.sdk.models.conferences.actions.ActionMuteParams;
import com.telnyx.sdk.models.conferences.actions.ActionMuteResponse;

ActionMuteResponse response = client.conferences().actions().mute("id");
将会议中的指定参与者静音。
POST /conferences/{id}/actions/mute
可选参数:
call_control_ids
(字符串数组)、
region
(枚举值)
java
import com.telnyx.sdk.models.conferences.actions.ActionMuteParams;
import com.telnyx.sdk.models.conferences.actions.ActionMuteResponse;

ActionMuteResponse response = client.conferences().actions().mute("id");

Play audio to conference participants

向会议参与者播放音频

Play audio to all or some participants on a conference call.
POST /conferences/{id}/actions/play
Optional:
audio_url
(string),
call_control_ids
(array[string]),
loop
(object),
media_name
(string),
region
(enum)
java
import com.telnyx.sdk.models.conferences.actions.ActionPlayParams;
import com.telnyx.sdk.models.conferences.actions.ActionPlayResponse;

ActionPlayResponse response = client.conferences().actions().play("id");
向会议中全部或指定参与者播放音频。
POST /conferences/{id}/actions/play
可选参数:
audio_url
(字符串)、
call_control_ids
(字符串数组)、
loop
(对象)、
media_name
(字符串)、
region
(枚举值)
java
import com.telnyx.sdk.models.conferences.actions.ActionPlayParams;
import com.telnyx.sdk.models.conferences.actions.ActionPlayResponse;

ActionPlayResponse response = client.conferences().actions().play("id");

Conference recording pause

暂停会议录制

Pause conference recording.
POST /conferences/{id}/actions/record_pause
Optional:
command_id
(string),
recording_id
(string),
region
(enum)
java
import com.telnyx.sdk.models.conferences.actions.ActionRecordPauseParams;
import com.telnyx.sdk.models.conferences.actions.ActionRecordPauseResponse;

ActionRecordPauseResponse response = client.conferences().actions().recordPause("id");
暂停正在进行的会议录制。
POST /conferences/{id}/actions/record_pause
可选参数:
command_id
(字符串)、
recording_id
(字符串)、
region
(枚举值)
java
import com.telnyx.sdk.models.conferences.actions.ActionRecordPauseParams;
import com.telnyx.sdk.models.conferences.actions.ActionRecordPauseResponse;

ActionRecordPauseResponse response = client.conferences().actions().recordPause("id");

Conference recording resume

恢复会议录制

Resume conference recording.
POST /conferences/{id}/actions/record_resume
Optional:
command_id
(string),
recording_id
(string),
region
(enum)
java
import com.telnyx.sdk.models.conferences.actions.ActionRecordResumeParams;
import com.telnyx.sdk.models.conferences.actions.ActionRecordResumeResponse;

ActionRecordResumeResponse response = client.conferences().actions().recordResume("id");
恢复已暂停的会议录制。
POST /conferences/{id}/actions/record_resume
可选参数:
command_id
(字符串)、
recording_id
(字符串)、
region
(枚举值)
java
import com.telnyx.sdk.models.conferences.actions.ActionRecordResumeParams;
import com.telnyx.sdk.models.conferences.actions.ActionRecordResumeResponse;

ActionRecordResumeResponse response = client.conferences().actions().recordResume("id");

Conference recording start

开始会议录制

Start recording the conference.
POST /conferences/{id}/actions/record_start
— Required:
format
Optional:
command_id
(string),
custom_file_name
(string),
play_beep
(boolean),
region
(enum),
trim
(enum)
java
import com.telnyx.sdk.models.conferences.actions.ActionRecordStartParams;
import com.telnyx.sdk.models.conferences.actions.ActionRecordStartResponse;

ActionRecordStartParams params = ActionRecordStartParams.builder()
    .id("id")
    .format(ActionRecordStartParams.Format.WAV)
    .build();
ActionRecordStartResponse response = client.conferences().actions().recordStart(params);
启动会议录制功能。
POST /conferences/{id}/actions/record_start
— 必填参数:
format
可选参数:
command_id
(字符串)、
custom_file_name
(字符串)、
play_beep
(布尔值)、
region
(枚举值)、
trim
(枚举值)
java
import com.telnyx.sdk.models.conferences.actions.ActionRecordStartParams;
import com.telnyx.sdk.models.conferences.actions.ActionRecordStartResponse;

ActionRecordStartParams params = ActionRecordStartParams.builder()
    .id("id")
    .format(ActionRecordStartParams.Format.WAV)
    .build();
ActionRecordStartResponse response = client.conferences().actions().recordStart(params);

Conference recording stop

停止会议录制

Stop recording the conference.
POST /conferences/{id}/actions/record_stop
Optional:
client_state
(string),
command_id
(string),
recording_id
(uuid),
region
(enum)
java
import com.telnyx.sdk.models.conferences.actions.ActionRecordStopParams;
import com.telnyx.sdk.models.conferences.actions.ActionRecordStopResponse;

ActionRecordStopResponse response = client.conferences().actions().recordStop("id");
停止正在进行的会议录制。
POST /conferences/{id}/actions/record_stop
可选参数:
client_state
(字符串)、
command_id
(字符串)、
recording_id
(uuid)、
region
(枚举值)
java
import com.telnyx.sdk.models.conferences.actions.ActionRecordStopParams;
import com.telnyx.sdk.models.conferences.actions.ActionRecordStopResponse;

ActionRecordStopResponse response = client.conferences().actions().recordStop("id");

Speak text to conference participants

向会议参与者播报文本

Convert text to speech and play it to all or some participants.
POST /conferences/{id}/actions/speak
— Required:
payload
,
voice
Optional:
call_control_ids
(array[string]),
command_id
(string),
language
(enum),
payload_type
(enum),
region
(enum),
voice_settings
(object)
java
import com.telnyx.sdk.models.conferences.actions.ActionSpeakParams;
import com.telnyx.sdk.models.conferences.actions.ActionSpeakResponse;

ActionSpeakParams params = ActionSpeakParams.builder()
    .id("id")
    .payload("Say this to participants")
    .voice("female")
    .build();
ActionSpeakResponse response = client.conferences().actions().speak(params);
将文本转换为语音并播放给全部或指定参与者。
POST /conferences/{id}/actions/speak
— 必填参数:
payload
voice
可选参数:
call_control_ids
(字符串数组)、
command_id
(字符串)、
language
(枚举值)、
payload_type
(枚举值)、
region
(枚举值)、
voice_settings
(对象)
java
import com.telnyx.sdk.models.conferences.actions.ActionSpeakParams;
import com.telnyx.sdk.models.conferences.actions.ActionSpeakResponse;

ActionSpeakParams params = ActionSpeakParams.builder()
    .id("id")
    .payload("Say this to participants")
    .voice("female")
    .build();
ActionSpeakResponse response = client.conferences().actions().speak(params);

Stop audio being played on the conference

停止会议中的音频播放

Stop audio being played to all or some participants on a conference call.
POST /conferences/{id}/actions/stop
Optional:
call_control_ids
(array[string]),
region
(enum)
java
import com.telnyx.sdk.models.conferences.actions.ActionStopParams;
import com.telnyx.sdk.models.conferences.actions.ActionStopResponse;

ActionStopResponse response = client.conferences().actions().stop("id");
停止向全部或指定参与者播放的音频。
POST /conferences/{id}/actions/stop
可选参数:
call_control_ids
(字符串数组)、
region
(枚举值)
java
import com.telnyx.sdk.models.conferences.actions.ActionStopParams;
import com.telnyx.sdk.models.conferences.actions.ActionStopResponse;

ActionStopResponse response = client.conferences().actions().stop("id");

Unhold conference participants

恢复会议参与者通话

Unhold a list of participants in a conference call
POST /conferences/{id}/actions/unhold
— Required:
call_control_ids
Optional:
region
(enum)
java
import com.telnyx.sdk.models.conferences.actions.ActionUnholdParams;
import com.telnyx.sdk.models.conferences.actions.ActionUnholdResponse;

ActionUnholdParams params = ActionUnholdParams.builder()
    .id("id")
    .addCallControlId("v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg")
    .build();
ActionUnholdResponse response = client.conferences().actions().unhold(params);
恢复会议中指定参与者的通话。
POST /conferences/{id}/actions/unhold
— 必填参数:
call_control_ids
可选参数:
region
(枚举值)
java
import com.telnyx.sdk.models.conferences.actions.ActionUnholdParams;
import com.telnyx.sdk.models.conferences.actions.ActionUnholdResponse;

ActionUnholdParams params = ActionUnholdParams.builder()
    .id("id")
    .addCallControlId("v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg")
    .build();
ActionUnholdResponse response = client.conferences().actions().unhold(params);

Unmute conference participants

取消会议参与者静音

Unmute a list of participants in a conference call
POST /conferences/{id}/actions/unmute
Optional:
call_control_ids
(array[string]),
region
(enum)
java
import com.telnyx.sdk.models.conferences.actions.ActionUnmuteParams;
import com.telnyx.sdk.models.conferences.actions.ActionUnmuteResponse;

ActionUnmuteResponse response = client.conferences().actions().unmute("id");
取消会议中指定参与者的静音状态。
POST /conferences/{id}/actions/unmute
可选参数:
call_control_ids
(字符串数组)、
region
(枚举值)
java
import com.telnyx.sdk.models.conferences.actions.ActionUnmuteParams;
import com.telnyx.sdk.models.conferences.actions.ActionUnmuteResponse;

ActionUnmuteResponse response = client.conferences().actions().unmute("id");

Update conference participant

更新会议参与者角色

Update conference participant supervisor_role
POST /conferences/{id}/actions/update
— Required:
call_control_id
,
supervisor_role
Optional:
command_id
(string),
region
(enum),
whisper_call_control_ids
(array[string])
java
import com.telnyx.sdk.models.conferences.actions.ActionUpdateParams;
import com.telnyx.sdk.models.conferences.actions.ActionUpdateResponse;
import com.telnyx.sdk.models.conferences.actions.UpdateConference;

ActionUpdateParams params = ActionUpdateParams.builder()
    .id("id")
    .updateConference(UpdateConference.builder()
        .callControlId("v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg")
        .supervisorRole(UpdateConference.SupervisorRole.WHISPER)
        .build())
    .build();
ActionUpdateResponse action = client.conferences().actions().update(params);
更新会议参与者的
supervisor_role
(监督者角色)。
POST /conferences/{id}/actions/update
— 必填参数:
call_control_id
supervisor_role
可选参数:
command_id
(字符串)、
region
(枚举值)、
whisper_call_control_ids
(字符串数组)
java
import com.telnyx.sdk.models.conferences.actions.ActionUpdateParams;
import com.telnyx.sdk.models.conferences.actions.ActionUpdateResponse;
import com.telnyx.sdk.models.conferences.actions.UpdateConference;

ActionUpdateParams params = ActionUpdateParams.builder()
    .id("id")
    .updateConference(UpdateConference.builder()
        .callControlId("v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg")
        .supervisorRole(UpdateConference.SupervisorRole.WHISPER)
        .build())
    .build();
ActionUpdateResponse action = client.conferences().actions().update(params);

End a conference

结束会议

End a conference and terminate all active participants.
POST /conferences/{id}/actions/end
Optional:
command_id
(string)
java
import com.telnyx.sdk.models.conferences.actions.ActionEndConferenceParams;
import com.telnyx.sdk.models.conferences.actions.ActionEndConferenceResponse;

ActionEndConferenceResponse response = client.conferences().actions().endConference("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
结束会议并终止所有参与者的通话。
POST /conferences/{id}/actions/end
可选参数:
command_id
(字符串)
java
import com.telnyx.sdk.models.conferences.actions.ActionEndConferenceParams;
import com.telnyx.sdk.models.conferences.actions.ActionEndConferenceResponse;

ActionEndConferenceResponse response = client.conferences().actions().endConference("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");

Gather DTMF using audio prompt in a conference

在会议中通过音频提示收集DTMF信号

Play an audio file to a specific conference participant and gather DTMF input.
POST /conferences/{id}/actions/gather_using_audio
— Required:
call_control_id
Optional:
audio_url
(string),
client_state
(string),
gather_id
(string),
initial_timeout_millis
(integer),
inter_digit_timeout_millis
(integer),
invalid_audio_url
(string),
invalid_media_name
(string),
maximum_digits
(integer),
maximum_tries
(integer),
media_name
(string),
minimum_digits
(integer),
stop_playback_on_dtmf
(boolean),
terminating_digit
(string),
timeout_millis
(integer),
valid_digits
(string)
java
import com.telnyx.sdk.models.conferences.actions.ActionGatherDtmfAudioParams;
import com.telnyx.sdk.models.conferences.actions.ActionGatherDtmfAudioResponse;

ActionGatherDtmfAudioParams params = ActionGatherDtmfAudioParams.builder()
    .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    .callControlId("v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg")
    .build();
ActionGatherDtmfAudioResponse response = client.conferences().actions().gatherDtmfAudio(params);
向指定会议参与者播放音频文件并收集DTMF输入。
POST /conferences/{id}/actions/gather_using_audio
— 必填参数:
call_control_id
可选参数:
audio_url
(字符串)、
client_state
(字符串)、
gather_id
(字符串)、
initial_timeout_millis
(整数)、
inter_digit_timeout_millis
(整数)、
invalid_audio_url
(字符串)、
invalid_media_name
(字符串)、
maximum_digits
(整数)、
maximum_tries
(整数)、
media_name
(字符串)、
minimum_digits
(整数)、
stop_playback_on_dtmf
(布尔值)、
terminating_digit
(字符串)、
timeout_millis
(整数)、
valid_digits
(字符串)
java
import com.telnyx.sdk.models.conferences.actions.ActionGatherDtmfAudioParams;
import com.telnyx.sdk.models.conferences.actions.ActionGatherDtmfAudioResponse;

ActionGatherDtmfAudioParams params = ActionGatherDtmfAudioParams.builder()
    .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    .callControlId("v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg")
    .build();
ActionGatherDtmfAudioResponse response = client.conferences().actions().gatherDtmfAudio(params);

Send DTMF to conference participants

向会议参与者发送DTMF信号

Send DTMF tones to one or more conference participants.
POST /conferences/{id}/actions/send_dtmf
— Required:
digits
Optional:
call_control_ids
(array[string]),
client_state
(string),
duration_millis
(integer)
java
import com.telnyx.sdk.models.conferences.actions.ActionSendDtmfParams;
import com.telnyx.sdk.models.conferences.actions.ActionSendDtmfResponse;

ActionSendDtmfParams params = ActionSendDtmfParams.builder()
    .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    .digits("1234#")
    .build();
ActionSendDtmfResponse response = client.conferences().actions().sendDtmf(params);
向一位或多位会议参与者发送DTMF音。
POST /conferences/{id}/actions/send_dtmf
— 必填参数:
digits
可选参数:
call_control_ids
(字符串数组)、
client_state
(字符串)、
duration_millis
(整数)
java
import com.telnyx.sdk.models.conferences.actions.ActionSendDtmfParams;
import com.telnyx.sdk.models.conferences.actions.ActionSendDtmfResponse;

ActionSendDtmfParams params = ActionSendDtmfParams.builder()
    .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    .digits("1234#")
    .build();
ActionSendDtmfResponse response = client.conferences().actions().sendDtmf(params);

List conference participants

列出会议参与者

Lists conference participants
GET /conferences/{conference_id}/participants
java
import com.telnyx.sdk.models.conferences.ConferenceListParticipantsPage;
import com.telnyx.sdk.models.conferences.ConferenceListParticipantsParams;

ConferenceListParticipantsPage page = client.conferences().listParticipants("conference_id");

查询指定会议的参与者列表。
GET /conferences/{conference_id}/participants
java
import com.telnyx.sdk.models.conferences.ConferenceListParticipantsPage;
import com.telnyx.sdk.models.conferences.ConferenceListParticipantsParams;

ConferenceListParticipantsPage page = client.conferences().listParticipants("conference_id");

Webhooks

Webhook事件

The following webhook events are sent to your configured webhook URL. All webhooks include
telnyx-timestamp
and
telnyx-signature-ed25519
headers for verification (Standard Webhooks compatible).
EventDescription
callEnqueued
Call Enqueued
callLeftQueue
Call Left Queue
conferenceCreated
Conference Created
conferenceEnded
Conference Ended
conferenceFloorChanged
Conference Floor Changed
conferenceParticipantJoined
Conference Participant Joined
conferenceParticipantLeft
Conference Participant Left
conferenceParticipantPlaybackEnded
Conference Participant Playback Ended
conferenceParticipantPlaybackStarted
Conference Participant Playback Started
conferenceParticipantSpeakEnded
Conference Participant Speak Ended
conferenceParticipantSpeakStarted
Conference Participant Speak Started
conferencePlaybackEnded
Conference Playback Ended
conferencePlaybackStarted
Conference Playback Started
conferenceRecordingSaved
Conference Recording Saved
conferenceSpeakEnded
Conference Speak Ended
conferenceSpeakStarted
Conference Speak Started
以下Webhook事件将发送到您配置的Webhook URL。所有Webhook均包含
telnyx-timestamp
telnyx-signature-ed25519
头信息用于验证(兼容标准Webhook)。
事件描述
callEnqueued
呼叫已加入队列
callLeftQueue
呼叫已离开队列
conferenceCreated
会议已创建
conferenceEnded
会议已结束
conferenceFloorChanged
会议发言者已变更
conferenceParticipantJoined
参与者已加入会议
conferenceParticipantLeft
参与者已离开会议
conferenceParticipantPlaybackEnded
向参与者播放的音频已结束
conferenceParticipantPlaybackStarted
已开始向参与者播放音频
conferenceParticipantSpeakEnded
向参与者播报的语音已结束
conferenceParticipantSpeakStarted
已开始向参与者播报语音
conferencePlaybackEnded
会议音频播放已结束
conferencePlaybackStarted
已开始会议音频播放
conferenceRecordingSaved
会议录制文件已保存
conferenceSpeakEnded
会议语音播报已结束
conferenceSpeakStarted
已开始会议语音播报

Webhook payload fields

Webhook负载字段说明

callEnqueued
FieldTypeDescription
data.record_type
enumIdentifies the type of the resource.
data.event_type
enumThe type of event being delivered.
data.id
uuidIdentifies the type of resource.
data.occurred_at
date-timeISO 8601 datetime of when the event occurred.
data.payload.call_control_id
stringCall ID used to issue commands via Call Control API.
data.payload.connection_id
stringCall Control App ID (formerly Telnyx connection ID) used in the call.
data.payload.call_leg_id
stringID that is unique to the call and can be used to correlate webhook events.
data.payload.call_session_id
stringID that is unique to the call session and can be used to correlate webhook events.
data.payload.client_state
stringState received from a command.
data.payload.queue
stringThe name of the queue
data.payload.current_position
integerCurrent position of the call in the queue.
data.payload.queue_avg_wait_time_secs
integerAverage time call spends in the queue in seconds.
callLeftQueue
FieldTypeDescription
data.record_type
enumIdentifies the type of the resource.
data.event_type
enumThe type of event being delivered.
data.id
uuidIdentifies the type of resource.
data.occurred_at
date-timeISO 8601 datetime of when the event occurred.
data.payload.call_control_id
stringCall ID used to issue commands via Call Control API.
data.payload.connection_id
stringCall Control App ID (formerly Telnyx connection ID) used in the call.
data.payload.call_leg_id
stringID that is unique to the call and can be used to correlate webhook events.
data.payload.call_session_id
stringID that is unique to the call session and can be used to correlate webhook events.
data.payload.client_state
stringState received from a command.
data.payload.queue
stringThe name of the queue
data.payload.queue_position
integerLast position of the call in the queue.
data.payload.reason
enumThe reason for leaving the queue
data.payload.wait_time_secs
integerTime call spent in the queue in seconds.
conferenceCreated
FieldTypeDescription
data.record_type
enumIdentifies the type of the resource.
data.event_type
enumThe type of event being delivered.
data.id
uuidIdentifies the type of resource.
data.payload.call_control_id
stringCall ID used to issue commands via Call Control API.
data.payload.connection_id
stringCall Control App ID (formerly Telnyx connection ID) used in the call.
data.payload.call_leg_id
stringID that is unique to the call and can be used to correlate webhook events.
data.payload.call_session_id
stringID that is unique to the call session and can be used to correlate webhook events.
data.payload.client_state
stringState received from a command.
data.payload.conference_id
stringConference ID that the participant joined.
data.payload.occurred_at
date-timeISO 8601 datetime of when the event occurred.
conferenceEnded
FieldTypeDescription
data.record_type
enumIdentifies the type of the resource.
data.event_type
enumThe type of event being delivered.
data.id
uuidIdentifies the type of resource.
data.payload.call_control_id
stringCall ID used to issue commands via Call Control API.
data.payload.connection_id
stringCall Control App ID (formerly Telnyx connection ID) used in the call.
data.payload.call_leg_id
stringID that is unique to the call and can be used to correlate webhook events.
data.payload.call_session_id
stringID that is unique to the call session and can be used to correlate webhook events.
data.payload.client_state
stringState received from a command.
data.payload.conference_id
stringConference ID that the participant joined.
data.payload.occurred_at
date-timeISO 8601 datetime of when the event occurred.
data.payload.reason
enumReason the conference ended.
conferenceFloorChanged
FieldTypeDescription
record_type
enumIdentifies the type of the resource.
event_type
enumThe type of event being delivered.
id
uuidIdentifies the type of resource.
payload.call_control_id
stringCall Control ID of the new speaker.
payload.connection_id
stringCall Control App ID (formerly Telnyx connection ID) used in the call.
payload.call_leg_id
stringCall Leg ID of the new speaker.
payload.call_session_id
stringCall Session ID of the new speaker.
payload.client_state
stringState received from a command.
payload.conference_id
stringConference ID that had a speaker change event.
payload.occurred_at
date-timeISO 8601 datetime of when the event occurred.
conferenceParticipantJoined
FieldTypeDescription
data.record_type
enumIdentifies the type of the resource.
data.event_type
enumThe type of event being delivered.
data.id
uuidIdentifies the type of resource.
data.occurred_at
date-timeISO 8601 datetime of when the event occurred.
data.payload.call_control_id
stringCall ID used to issue commands via Call Control API.
data.payload.connection_id
stringCall Control App ID (formerly Telnyx connection ID) used in the call.
data.payload.call_leg_id
stringID that is unique to the call and can be used to correlate webhook events.
data.payload.call_session_id
stringID that is unique to the call session and can be used to correlate webhook events.
data.payload.client_state
stringState received from a command.
data.payload.conference_id
stringConference ID that the participant joined.
conferenceParticipantLeft
FieldTypeDescription
data.record_type
enumIdentifies the type of the resource.
data.event_type
enumThe type of event being delivered.
data.id
uuidIdentifies the type of resource.
data.occurred_at
date-timeISO 8601 datetime of when the event occurred.
data.payload.call_control_id
stringCall ID used to issue commands via Call Control API.
data.payload.connection_id
stringCall Control App ID (formerly Telnyx connection ID) used in the call.
data.payload.call_leg_id
stringID that is unique to the call and can be used to correlate webhook events.
data.payload.call_session_id
stringID that is unique to the call session and can be used to correlate webhook events.
data.payload.client_state
stringState received from a command.
data.payload.conference_id
stringConference ID that the participant joined.
conferenceParticipantPlaybackEnded
FieldTypeDescription
data.record_type
enumIdentifies the type of the resource.
data.event_type
enumThe type of event being delivered.
data.id
uuidIdentifies the type of resource.
data.payload.call_control_id
stringParticipant's call ID used to issue commands via Call Control API.
data.payload.call_leg_id
stringID that is unique to the call and can be used to correlate webhook events.
data.payload.call_session_id
stringID that is unique to the call session and can be used to correlate webhook events.
data.payload.client_state
stringState received from a command.
data.payload.connection_id
stringCall Control App ID (formerly Telnyx connection ID) used in the call.
data.payload.creator_call_session_id
stringID that is unique to the call session that started the conference.
data.payload.conference_id
stringID of the conference the text was spoken in.
data.payload.media_url
stringThe audio URL being played back, if audio_url has been used to start.
data.payload.media_name
stringThe name of the audio media file being played back, if media_name has been used to start.
data.payload.occurred_at
date-timeISO 8601 datetime of when the event occurred.
conferenceParticipantPlaybackStarted
FieldTypeDescription
data.record_type
enumIdentifies the type of the resource.
data.event_type
enumThe type of event being delivered.
data.id
uuidIdentifies the type of resource.
data.payload.call_control_id
stringParticipant's call ID used to issue commands via Call Control API.
data.payload.call_leg_id
stringID that is unique to the call and can be used to correlate webhook events.
data.payload.call_session_id
stringID that is unique to the call session and can be used to correlate webhook events.
data.payload.client_state
stringState received from a command.
data.payload.connection_id
stringCall Control App ID (formerly Telnyx connection ID) used in the call.
data.payload.creator_call_session_id
stringID that is unique to the call session that started the conference.
data.payload.conference_id
stringID of the conference the text was spoken in.
data.payload.media_url
stringThe audio URL being played back, if audio_url has been used to start.
data.payload.media_name
stringThe name of the audio media file being played back, if media_name has been used to start.
data.payload.occurred_at
date-timeISO 8601 datetime of when the event occurred.
conferenceParticipantSpeakEnded
FieldTypeDescription
data.record_type
enumIdentifies the type of the resource.
data.event_type
enumThe type of event being delivered.
data.id
uuidIdentifies the type of resource.
data.payload.call_control_id
stringParticipant's call ID used to issue commands via Call Control API.
data.payload.call_leg_id
stringID that is unique to the call and can be used to correlate webhook events.
data.payload.call_session_id
stringID that is unique to the call session and can be used to correlate webhook events.
data.payload.client_state
stringState received from a command.
data.payload.connection_id
stringCall Control App ID (formerly Telnyx connection ID) used in the call.
data.payload.creator_call_session_id
stringID that is unique to the call session that started the conference.
data.payload.conference_id
stringID of the conference the text was spoken in.
data.payload.occurred_at
date-timeISO 8601 datetime of when the event occurred.
conferenceParticipantSpeakStarted
FieldTypeDescription
data.record_type
enumIdentifies the type of the resource.
data.event_type
enumThe type of event being delivered.
data.id
uuidIdentifies the type of resource.
data.payload.call_control_id
stringParticipant's call ID used to issue commands via Call Control API.
data.payload.call_leg_id
stringID that is unique to the call and can be used to correlate webhook events.
data.payload.call_session_id
stringID that is unique to the call session and can be used to correlate webhook events.
data.payload.client_state
stringState received from a command.
data.payload.connection_id
stringCall Control App ID (formerly Telnyx connection ID) used in the call.
data.payload.creator_call_session_id
stringID that is unique to the call session that started the conference.
data.payload.conference_id
stringID of the conference the text was spoken in.
data.payload.occurred_at
date-timeISO 8601 datetime of when the event occurred.
conferencePlaybackEnded
FieldTypeDescription
data.record_type
enumIdentifies the type of the resource.
data.event_type
enumThe type of event being delivered.
data.id
uuidIdentifies the type of resource.
data.payload.connection_id
stringCall Control App ID (formerly Telnyx connection ID) used in the call.
data.payload.creator_call_session_id
stringID that is unique to the call session that started the conference.
data.payload.conference_id
stringID of the conference the text was spoken in.
data.payload.media_url
stringThe audio URL being played back, if audio_url has been used to start.
data.payload.media_name
stringThe name of the audio media file being played back, if media_name has been used to start.
data.payload.occurred_at
date-timeISO 8601 datetime of when the event occurred.
conferencePlaybackStarted
FieldTypeDescription
data.record_type
enumIdentifies the type of the resource.
data.event_type
enumThe type of event being delivered.
data.id
uuidIdentifies the type of resource.
data.payload.connection_id
stringCall Control App ID (formerly Telnyx connection ID) used in the call.
data.payload.creator_call_session_id
stringID that is unique to the call session that started the conference.
data.payload.conference_id
stringID of the conference the text was spoken in.
data.payload.media_url
stringThe audio URL being played back, if audio_url has been used to start.
data.payload.media_name
stringThe name of the audio media file being played back, if media_name has been used to start.
data.payload.occurred_at
date-timeISO 8601 datetime of when the event occurred.
conferenceRecordingSaved
FieldTypeDescription
data.record_type
enumIdentifies the type of the resource.
data.event_type
enumThe type of event being delivered.
data.id
uuidIdentifies the type of resource.
data.payload.call_control_id
stringParticipant's call ID used to issue commands via Call Control API.
data.payload.call_session_id
stringID that is unique to the call session and can be used to correlate webhook events.
data.payload.client_state
stringState received from a command.
data.payload.channels
enumWhether recording was recorded in
single
or
dual
channel.
data.payload.conference_id
uuidID of the conference that is being recorded.
data.payload.connection_id
stringCall Control App ID (formerly Telnyx connection ID) used in the call.
data.payload.format
enumThe audio file format used when storing the call recording.
data.payload.recording_ended_at
date-timeISO 8601 datetime of when recording ended.
data.payload.recording_id
uuidID of the conference recording.
data.payload.recording_started_at
date-timeISO 8601 datetime of when recording started.
conferenceSpeakEnded
FieldTypeDescription
data.record_type
enumIdentifies the type of the resource.
data.event_type
enumThe type of event being delivered.
data.id
uuidIdentifies the type of resource.
data.payload.connection_id
stringCall Control App ID (formerly Telnyx connection ID) used in the call.
data.payload.creator_call_session_id
stringID that is unique to the call session that started the conference.
data.payload.conference_id
stringID of the conference the text was spoken in.
data.payload.occurred_at
date-timeISO 8601 datetime of when the event occurred.
conferenceSpeakStarted
FieldTypeDescription
data.record_type
enumIdentifies the type of the resource.
data.event_type
enumThe type of event being delivered.
data.id
uuidIdentifies the type of resource.
data.payload.connection_id
stringCall Control App ID (formerly Telnyx connection ID) used in the call.
data.payload.creator_call_session_id
stringID that is unique to the call session that started the conference.
data.payload.conference_id
stringID of the conference the text was spoken in.
data.payload.occurred_at
date-timeISO 8601 datetime of when the event occurred.
callEnqueued
字段类型描述
data.record_type
枚举值标识资源类型
data.event_type
枚举值交付的事件类型
data.id
uuid标识资源ID
data.occurred_at
date-time事件发生的ISO 8601格式时间
data.payload.call_control_id
字符串用于通过呼叫控制API发送指令的呼叫ID
data.payload.connection_id
字符串通话中使用的呼叫控制应用ID(原Telnyx连接ID)
data.payload.call_leg_id
字符串通话的唯一ID,可用于关联Webhook事件
data.payload.call_session_id
字符串通话会话的唯一ID,可用于关联Webhook事件
data.payload.client_state
字符串从指令中接收的状态
data.payload.queue
字符串队列名称
data.payload.current_position
整数呼叫在队列中的当前位置
data.payload.queue_avg_wait_time_secs
整数呼叫在队列中的平均等待时间(秒)
callLeftQueue
字段类型描述
data.record_type
枚举值标识资源类型
data.event_type
枚举值交付的事件类型
data.id
uuid标识资源ID
data.occurred_at
date-time事件发生的ISO 8601格式时间
data.payload.call_control_id
字符串用于通过呼叫控制API发送指令的呼叫ID
data.payload.connection_id
字符串通话中使用的呼叫控制应用ID(原Telnyx连接ID)
data.payload.call_leg_id
字符串通话的唯一ID,可用于关联Webhook事件
data.payload.call_session_id
字符串通话会话的唯一ID,可用于关联Webhook事件
data.payload.client_state
字符串从指令中接收的状态
data.payload.queue
字符串队列名称
data.payload.queue_position
整数呼叫在队列中的最后位置
data.payload.reason
枚举值呼叫离开队列的原因
data.payload.wait_time_secs
整数呼叫在队列中的等待时间(秒)
conferenceCreated
字段类型描述
data.record_type
枚举值标识资源类型
data.event_type
枚举值交付的事件类型
data.id
uuid标识资源ID
data.payload.call_control_id
字符串用于通过呼叫控制API发送指令的呼叫ID
data.payload.connection_id
字符串通话中使用的呼叫控制应用ID(原Telnyx连接ID)
data.payload.call_leg_id
字符串通话的唯一ID,可用于关联Webhook事件
data.payload.call_session_id
字符串通话会话的唯一ID,可用于关联Webhook事件
data.payload.client_state
字符串从指令中接收的状态
data.payload.conference_id
字符串参与者加入的会议ID
data.payload.occurred_at
date-time事件发生的ISO 8601格式时间
conferenceEnded
字段类型描述
data.record_type
枚举值标识资源类型
data.event_type
枚举值交付的事件类型
data.id
uuid标识资源ID
data.payload.call_control_id
字符串用于通过呼叫控制API发送指令的呼叫ID
data.payload.connection_id
字符串通话中使用的呼叫控制应用ID(原Telnyx连接ID)
data.payload.call_leg_id
字符串通话的唯一ID,可用于关联Webhook事件
data.payload.call_session_id
字符串通话会话的唯一ID,可用于关联Webhook事件
data.payload.client_state
字符串从指令中接收的状态
data.payload.conference_id
字符串参与者加入的会议ID
data.payload.occurred_at
date-time事件发生的ISO 8601格式时间
data.payload.reason
枚举值会议结束的原因
conferenceFloorChanged
字段类型描述
record_type
枚举值标识资源类型
event_type
枚举值交付的事件类型
id
uuid标识资源ID
payload.call_control_id
字符串新发言者的呼叫控制ID
payload.connection_id
字符串通话中使用的呼叫控制应用ID(原Telnyx连接ID)
payload.call_leg_id
字符串新发言者的通话ID
payload.call_session_id
字符串新发言者的通话会话ID
payload.client_state
字符串从指令中接收的状态
payload.conference_id
字符串发生发言者变更的会议ID
payload.occurred_at
date-time事件发生的ISO 8601格式时间
conferenceParticipantJoined
字段类型描述
data.record_type
枚举值标识资源类型
data.event_type
枚举值交付的事件类型
data.id
uuid标识资源ID
data.occurred_at
date-time事件发生的ISO 8601格式时间
data.payload.call_control_id
字符串用于通过呼叫控制API发送指令的呼叫ID
data.payload.connection_id
字符串通话中使用的呼叫控制应用ID(原Telnyx连接ID)
data.payload.call_leg_id
字符串通话的唯一ID,可用于关联Webhook事件
data.payload.call_session_id
字符串通话会话的唯一ID,可用于关联Webhook事件
data.payload.client_state
字符串从指令中接收的状态
data.payload.conference_id
字符串参与者加入的会议ID
conferenceParticipantLeft
字段类型描述
data.record_type
枚举值标识资源类型
data.event_type
枚举值交付的事件类型
data.id
uuid标识资源ID
data.occurred_at
date-time事件发生的ISO 8601格式时间
data.payload.call_control_id
字符串用于通过呼叫控制API发送指令的呼叫ID
data.payload.connection_id
字符串通话中使用的呼叫控制应用ID(原Telnyx连接ID)
data.payload.call_leg_id
字符串通话的唯一ID,可用于关联Webhook事件
data.payload.call_session_id
字符串通话会话的唯一ID,可用于关联Webhook事件
data.payload.client_state
字符串从指令中接收的状态
data.payload.conference_id
字符串参与者加入的会议ID
conferenceParticipantPlaybackEnded
字段类型描述
data.record_type
枚举值标识资源类型
data.event_type
枚举值交付的事件类型
data.id
uuid标识资源ID
data.payload.call_control_id
字符串参与者的呼叫ID,用于通过呼叫控制API发送指令
data.payload.call_leg_id
字符串通话的唯一ID,可用于关联Webhook事件
data.payload.call_session_id
字符串通话会话的唯一ID,可用于关联Webhook事件
data.payload.client_state
字符串从指令中接收的状态
data.payload.connection_id
字符串通话中使用的呼叫控制应用ID(原Telnyx连接ID)
data.payload.creator_call_session_id
字符串启动会议的通话会话唯一ID
data.payload.conference_id
字符串语音播报所在的会议ID
data.payload.media_url
字符串正在播放的音频URL(若通过audio_url启动播放)
data.payload.media_name
字符串正在播放的音频媒体文件名(若通过media_name启动播放)
data.payload.occurred_at
date-time事件发生的ISO 8601格式时间
conferenceParticipantPlaybackStarted
字段类型描述
data.record_type
枚举值标识资源类型
data.event_type
枚举值交付的事件类型
data.id
uuid标识资源ID
data.payload.call_control_id
字符串参与者的呼叫ID,用于通过呼叫控制API发送指令
data.payload.call_leg_id
字符串通话的唯一ID,可用于关联Webhook事件
data.payload.call_session_id
字符串通话会话的唯一ID,可用于关联Webhook事件
data.payload.client_state
字符串从指令中接收的状态
data.payload.connection_id
字符串通话中使用的呼叫控制应用ID(原Telnyx连接ID)
data.payload.creator_call_session_id
字符串启动会议的通话会话唯一ID
data.payload.conference_id
字符串语音播报所在的会议ID
data.payload.media_url
字符串正在播放的音频URL(若通过audio_url启动播放)
data.payload.media_name
字符串正在播放的音频媒体文件名(若通过media_name启动播放)
data.payload.occurred_at
date-time事件发生的ISO 8601格式时间
conferenceParticipantSpeakEnded
字段类型描述
data.record_type
枚举值标识资源类型
data.event_type
枚举值交付的事件类型
data.id
uuid标识资源ID
data.payload.call_control_id
字符串参与者的呼叫ID,用于通过呼叫控制API发送指令
data.payload.call_leg_id
字符串通话的唯一ID,可用于关联Webhook事件
data.payload.call_session_id
字符串通话会话的唯一ID,可用于关联Webhook事件
data.payload.client_state
字符串从指令中接收的状态
data.payload.connection_id
字符串通话中使用的呼叫控制应用ID(原Telnyx连接ID)
data.payload.creator_call_session_id
字符串启动会议的通话会话唯一ID
data.payload.conference_id
字符串语音播报所在的会议ID
data.payload.occurred_at
date-time事件发生的ISO 8601格式时间
conferenceParticipantSpeakStarted
字段类型描述
data.record_type
枚举值标识资源类型
data.event_type
枚举值交付的事件类型
data.id
uuid标识资源ID
data.payload.call_control_id
字符串参与者的呼叫ID,用于通过呼叫控制API发送指令
data.payload.call_leg_id
字符串通话的唯一ID,可用于关联Webhook事件
data.payload.call_session_id
字符串通话会话的唯一ID,可用于关联Webhook事件
data.payload.client_state
字符串从指令中接收的状态
data.payload.connection_id
字符串通话中使用的呼叫控制应用ID(原Telnyx连接ID)
data.payload.creator_call_session_id
字符串启动会议的通话会话唯一ID
data.payload.conference_id
字符串语音播报所在的会议ID
data.payload.occurred_at
date-time事件发生的ISO 8601格式时间
conferencePlaybackEnded
字段类型描述
data.record_type
枚举值标识资源类型
data.event_type
枚举值交付的事件类型
data.id
uuid标识资源ID
data.payload.connection_id
字符串通话中使用的呼叫控制应用ID(原Telnyx连接ID)
data.payload.creator_call_session_id
字符串启动会议的通话会话唯一ID
data.payload.conference_id
字符串语音播报所在的会议ID
data.payload.media_url
字符串正在播放的音频URL(若通过audio_url启动播放)
data.payload.media_name
字符串正在播放的音频媒体文件名(若通过media_name启动播放)
data.payload.occurred_at
date-time事件发生的ISO 8601格式时间
conferencePlaybackStarted
字段类型描述
data.record_type
枚举值标识资源类型
data.event_type
枚举值交付的事件类型
data.id
uuid标识资源ID
data.payload.connection_id
字符串通话中使用的呼叫控制应用ID(原Telnyx连接ID)
data.payload.creator_call_session_id
字符串启动会议的通话会话唯一ID
data.payload.conference_id
字符串语音播报所在的会议ID
data.payload.media_url
字符串正在播放的音频URL(若通过audio_url启动播放)
data.payload.media_name
字符串正在播放的音频媒体文件名(若通过media_name启动播放)
data.payload.occurred_at
date-time事件发生的ISO 8601格式时间
conferenceRecordingSaved
字段类型描述
data.record_type
枚举值标识资源类型
data.event_type
枚举值交付的事件类型
data.id
uuid标识资源ID
data.payload.call_control_id
字符串参与者的呼叫ID,用于通过呼叫控制API发送指令
data.payload.call_session_id
字符串通话会话的唯一ID,可用于关联Webhook事件
data.payload.client_state
字符串从指令中接收的状态
data.payload.channels
枚举值录制的声道类型,
single
(单声道)或
dual
(双声道)
data.payload.conference_id
uuid正在录制的会议ID
data.payload.connection_id
字符串通话中使用的呼叫控制应用ID(原Telnyx连接ID)
data.payload.format
枚举值存储通话录制文件时使用的音频格式
data.payload.recording_ended_at
date-time录制结束的ISO 8601格式时间
data.payload.recording_id
uuid会议录制文件的ID
data.payload.recording_started_at
date-time录制开始的ISO 8601格式时间
conferenceSpeakEnded
字段类型描述
data.record_type
枚举值标识资源类型
data.event_type
枚举值交付的事件类型
data.id
uuid标识资源ID
data.payload.connection_id
字符串通话中使用的呼叫控制应用ID(原Telnyx连接ID)
data.payload.creator_call_session_id
字符串启动会议的通话会话唯一ID
data.payload.conference_id
字符串语音播报所在的会议ID
data.payload.occurred_at
date-time事件发生的ISO 8601格式时间
conferenceSpeakStarted
字段类型描述
data.record_type
枚举值标识资源类型
data.event_type
枚举值交付的事件类型
data.id
uuid标识资源ID
data.payload.connection_id
字符串通话中使用的呼叫控制应用ID(原Telnyx连接ID)
data.payload.creator_call_session_id
字符串启动会议的通话会话唯一ID
data.payload.conference_id
字符串语音播报所在的会议ID
data.payload.occurred_at
date-time事件发生的ISO 8601格式时间