Loading...
Loading...
Compare original and translation side by side
gem install telnyxgem install telnyxrequire "telnyx"
client = Telnyx::Client.new(
api_key: ENV["TELNYX_API_KEY"], # This is the default and can be omitted
)clientrequire "telnyx"
client = Telnyx::Client.new(
api_key: ENV["TELNYX_API_KEY"], # 这是默认配置,可以省略
)clientresponse = client.calls.dial(
connection_id: "7267xxxxxxxxxxxxxx",
from: "+18005550101",
to: "+18005550100"
)
puts(response)401403404422429response = client.calls.dial(
connection_id: "7267xxxxxxxxxxxxxx",
from: "+18005550101",
to: "+18005550100"
)
puts(response)401403404422429+13125550001+.auto_paging_eachpage.auto_paging_each { |item| puts item.id }+13125550001+.auto_paging_eachpage.auto_paging_each { |item| puts item.id }dial()call_control_iddial()dial()call_control_iddial()## Additional Operations## 其他操作client.calls.dial()POST /calls| Parameter | Type | Required | Description |
|---|---|---|---|
| string (E.164) | Yes | The DID or SIP URI to dial out to. |
| string (E.164) | Yes | The |
| string (UUID) | Yes | The ID of the Call Control App (formerly ID of the connectio... |
| integer | No | The number of seconds that Telnyx will wait for the call to ... |
| string (UUID) | No | Use this field to set the Billing Group ID for the call. |
| string | No | Use this field to add state to every subsequent webhook. |
| ... | +48 optional params in references/api-details.md |
response = client.calls.dial(
connection_id: "7267xxxxxxxxxxxxxx",
from: "+18005550101",
to: "+18005550100"
)
puts(response)response.data.call_control_idresponse.data.call_leg_idresponse.data.call_session_idresponse.data.is_aliveresponse.data.recording_idresponse.data.call_durationclient.calls.dial()POST /calls| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| string (E.164) | 是 | 要拨打的DID或SIP URI |
| string (E.164) | 是 | 展示给被叫方的主叫ID号码 |
| string (UUID) | 是 | 呼叫控制应用的ID(之前也叫连接ID) |
| integer | 否 | Telnyx等待呼叫接通的秒数 |
| string (UUID) | 否 | 用于指定该通话所属的账单组ID |
| string | 否 | 用于给后续所有webhook添加自定义状态 |
| ... | 还有48个可选参数,请查看references/api-details.md |
response = client.calls.dial(
connection_id: "7267xxxxxxxxxxxxxx",
from: "+18005550101",
to: "+18005550100"
)
puts(response)response.data.call_control_idresponse.data.call_leg_idresponse.data.call_session_idresponse.data.is_aliveresponse.data.recording_idresponse.data.call_durationclient.calls.actions.answer()POST /calls/{call_control_id}/actions/answer| Parameter | Type | Required | Description |
|---|---|---|---|
| string (UUID) | Yes | Unique identifier and token for controlling the call |
| string (UUID) | No | Use this field to set the Billing Group ID for the call. |
| string | No | Use this field to add state to every subsequent webhook. |
| string (URL) | No | Use this field to override the URL for which Telnyx will sen... |
| ... | +26 optional params in references/api-details.md |
response = client.calls.actions.answer("v3:550e8400-e29b-41d4-a716-446655440000_gRU1OGRkYQ")
puts(response)response.data.resultresponse.data.recording_idclient.calls.actions.answer()POST /calls/{call_control_id}/actions/answer| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| string (UUID) | 是 | 用于控制通话的唯一标识符和令牌 |
| string (UUID) | 否 | 用于指定该通话所属的账单组ID |
| string | 否 | 用于给后续所有webhook添加自定义状态 |
| string (URL) | 否 | 用于覆盖Telnyx发送事件的默认URL |
| ... | 还有26个可选参数,请查看references/api-details.md |
response = client.calls.actions.answer("v3:550e8400-e29b-41d4-a716-446655440000_gRU1OGRkYQ")
puts(response)response.data.resultresponse.data.recording_idclient.calls.actions.transfer()POST /calls/{call_control_id}/actions/transfer| Parameter | Type | Required | Description |
|---|---|---|---|
| string (E.164) | Yes | The DID or SIP URI to dial out to. |
| string (UUID) | Yes | Unique identifier and token for controlling the call |
| integer | No | The number of seconds that Telnyx will wait for the call to ... |
| string | No | Use this field to add state to every subsequent webhook. |
| string (URL) | No | Use this field to override the URL for which Telnyx will sen... |
| ... | +33 optional params in references/api-details.md |
response = client.calls.actions.transfer("call_control_id", to: "+18005550100")
puts(response)response.data.resultclient.calls.actions.transfer()POST /calls/{call_control_id}/actions/transfer| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| string (E.164) | 是 | 要转接的目标DID或SIP URI |
| string (UUID) | 是 | 用于控制通话的唯一标识符和令牌 |
| integer | 否 | Telnyx等待转接接通的秒数 |
| string | 否 | 用于给后续所有webhook添加自定义状态 |
| string (URL) | 否 | 用于覆盖Telnyx发送事件的默认URL |
| ... | 还有33个可选参数,请查看references/api-details.md |
response = client.calls.actions.transfer("call_control_id", to: "+18005550100")
puts(response)response.data.resulttelnyx-signature-ed25519telnyx-timestampundefinedtelnyx-signature-ed25519telnyx-timestampundefinedundefinedundefined| Field | Type | Description |
|---|---|---|
| enum: event | Identifies the type of the resource. |
| enum: call.answered | The type of event being delivered. |
| uuid | Identifies the type of resource. |
| date-time | ISO 8601 datetime of when the event occurred. |
| string | Call ID used to issue commands via Call Control API. |
| string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
| string | ID that is unique to the call and can be used to correlate webhook events. |
| string | ID that is unique to the call session and can be used to correlate webhook ev... |
| 字段 | 类型 | 描述 |
|---|---|---|
| enum: event | 标识资源类型 |
| enum: call.answered | 触发的事件类型 |
| uuid | 资源ID |
| date-time | 事件发生的ISO 8601格式时间 |
| string | 用于通过呼叫控制API发送指令的通话ID |
| string | 通话使用的呼叫控制应用ID(之前叫Telnyx连接ID) |
| string | 通话的唯一ID,可用于关联webhook事件 |
| string | 通话会话的唯一ID,可用于关联webhook事件 |
| Field | Type | Description |
|---|---|---|
| enum: event | Identifies the type of the resource. |
| enum: call.hangup | The type of event being delivered. |
| uuid | Identifies the type of resource. |
| date-time | ISO 8601 datetime of when the event occurred. |
| string | Call ID used to issue commands via Call Control API. |
| string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
| string | ID that is unique to the call and can be used to correlate webhook events. |
| string | ID that is unique to the call session and can be used to correlate webhook ev... |
| 字段 | 类型 | 描述 |
|---|---|---|
| enum: event | 标识资源类型 |
| enum: call.hangup | 触发的事件类型 |
| uuid | 资源ID |
| date-time | 事件发生的ISO 8601格式时间 |
| string | 用于通过呼叫控制API发送指令的通话ID |
| string | 通话使用的呼叫控制应用ID(之前叫Telnyx连接ID) |
| string | 通话的唯一ID,可用于关联webhook事件 |
| string | 通话会话的唯一ID,可用于关联webhook事件 |
| Field | Type | Description |
|---|---|---|
| enum: event | Identifies the type of the resource. |
| enum: call.initiated | The type of event being delivered. |
| uuid | Identifies the type of resource. |
| date-time | ISO 8601 datetime of when the event occurred. |
| string | Call ID used to issue commands via Call Control API. |
| string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
| string | The list of comma-separated codecs enabled for the connection. |
| string | The list of comma-separated codecs offered by caller. |
| 字段 | 类型 | 描述 |
|---|---|---|
| enum: event | 标识资源类型 |
| enum: call.initiated | 触发的事件类型 |
| uuid | 资源ID |
| date-time | 事件发生的ISO 8601格式时间 |
| string | 用于通过呼叫控制API发送指令的通话ID |
| string | 通话使用的呼叫控制应用ID(之前叫Telnyx连接ID) |
| string | 连接启用的编解码器列表,用逗号分隔 |
| string | 主叫方提供的编解码器列表,用逗号分隔 |
client.calls.actions.hangup()POST /calls/{call_control_id}/actions/hangup| Parameter | Type | Required | Description |
|---|---|---|---|
| string (UUID) | Yes | Unique identifier and token for controlling the call |
| string | No | Use this field to add state to every subsequent webhook. |
| string (UUID) | No | Use this field to avoid duplicate commands. |
| array[object] | No | Custom headers to be added to the SIP BYE message. |
response = client.calls.actions.hangup("v3:550e8400-e29b-41d4-a716-446655440000_gRU1OGRkYQ")
puts(response)response.data.resultclient.calls.actions.hangup()POST /calls/{call_control_id}/actions/hangup| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| string (UUID) | 是 | 用于控制通话的唯一标识符和令牌 |
| string | 否 | 用于给后续所有webhook添加自定义状态 |
| string (UUID) | 否 | 用于避免重复执行指令 |
| array[object] | 否 | 添加到SIP BYE消息中的自定义请求头 |
response = client.calls.actions.hangup("v3:550e8400-e29b-41d4-a716-446655440000_gRU1OGRkYQ")
puts(response)response.data.resultclient.calls.actions.bridge()POST /calls/{call_control_id}/actions/bridge| Parameter | Type | Required | Description |
|---|---|---|---|
| string (UUID) | Yes | The Call Control ID of the call you want to bridge with, can... |
| string (UUID) | Yes | Unique identifier and token for controlling the call |
| string | No | Use this field to add state to every subsequent webhook. |
| string (UUID) | No | Use this field to avoid duplicate commands. |
| string (UUID) | No | The ID of the video room you want to bridge with, can't be u... |
| ... | +16 optional params in references/api-details.md |
response = client.calls.actions.bridge(
"call_control_id",
call_control_id_to_bridge_with: "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg"
)
puts(response)response.data.resultclient.calls.actions.bridge()POST /calls/{call_control_id}/actions/bridge| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| string (UUID) | 是 | 要桥接的目标通话的呼叫控制ID |
| string (UUID) | 是 | 用于控制当前通话的唯一标识符和令牌 |
| string | 否 | 用于给后续所有webhook添加自定义状态 |
| string (UUID) | 否 | 用于避免重复执行指令 |
| string (UUID) | 否 | 要桥接的视频房间ID,不能和其他桥接目标同时使用 |
| ... | 还有16个可选参数,请查看references/api-details.md |
response = client.calls.actions.bridge(
"call_control_id",
call_control_id_to_bridge_with: "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg"
)
puts(response)response.data.resultclient.calls.actions.reject()POST /calls/{call_control_id}/actions/reject| Parameter | Type | Required | Description |
|---|---|---|---|
| enum (CALL_REJECTED, USER_BUSY) | Yes | Cause for call rejection. |
| string (UUID) | Yes | Unique identifier and token for controlling the call |
| string | No | Use this field to add state to every subsequent webhook. |
| string (UUID) | No | Use this field to avoid duplicate commands. |
response = client.calls.actions.reject("call_control_id", cause: :USER_BUSY)
puts(response)response.data.resultclient.calls.actions.reject()POST /calls/{call_control_id}/actions/reject| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| enum (CALL_REJECTED, USER_BUSY) | 是 | 拒接通话的原因 |
| string (UUID) | 是 | 用于控制通话的唯一标识符和令牌 |
| string | 否 | 用于给后续所有webhook添加自定义状态 |
| string (UUID) | 否 | 用于避免重复执行指令 |
response = client.calls.actions.reject("call_control_id", cause: :USER_BUSY)
puts(response)response.data.resultclient.calls.retrieve_status()GET /calls/{call_control_id}| Parameter | Type | Required | Description |
|---|---|---|---|
| string (UUID) | Yes | Unique identifier and token for controlling the call |
response = client.calls.retrieve_status("v3:550e8400-e29b-41d4-a716-446655440000_gRU1OGRkYQ")
puts(response)response.data.call_control_idresponse.data.call_durationresponse.data.call_leg_idresponse.data.call_session_idresponse.data.client_stateresponse.data.end_timeclient.calls.retrieve_status()GET /calls/{call_control_id}| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| string (UUID) | 是 | 用于控制通话的唯一标识符和令牌 |
response = client.calls.retrieve_status("v3:550e8400-e29b-41d4-a716-446655440000_gRU1OGRkYQ")
puts(response)response.data.call_control_idresponse.data.call_durationresponse.data.call_leg_idresponse.data.call_session_idresponse.data.client_stateresponse.data.end_timeclient.connections.list_active_calls()GET /connections/{connection_id}/active_calls| Parameter | Type | Required | Description |
|---|---|---|---|
| string (UUID) | Yes | Telnyx connection id |
| object | No | Consolidated page parameter (deepObject style). |
page = client.connections.list_active_calls("1293384261075731461")
puts(page)page.datapage.metacall_control_idcall_durationcall_leg_idcall_session_idclient_staterecord_typeclient.connections.list_active_calls()GET /connections/{connection_id}/active_calls| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| string (UUID) | 是 | Telnyx连接ID |
| object | 否 | 统一分页参数(deepObject格式) |
page = client.connections.list_active_calls("1293384261075731461")
puts(page)page.datapage.metacall_control_idcall_durationcall_leg_idcall_session_idclient_staterecord_typeclient.call_control_applications.list()GET /call_control_applications| Parameter | Type | Required | Description |
|---|---|---|---|
| enum (created_at, connection_name, active) | No | Specifies the sort order for results. |
| object | No | Consolidated filter parameter (deepObject style). |
| object | No | Consolidated page parameter (deepObject style). |
page = client.call_control_applications.list
puts(page)page.datapage.metaidcreated_atupdated_atactiveanchorsite_overrideapplication_nameclient.call_control_applications.list()GET /call_control_applications| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| enum (created_at, connection_name, active) | 否 | 指定结果的排序顺序 |
| object | 否 | 统一过滤参数(deepObject格式) |
| object | 否 | 统一分页参数(deepObject格式) |
page = client.call_control_applications.list
puts(page)page.datapage.metaidcreated_atupdated_atactiveanchorsite_overrideapplication_name| Operation | SDK method | Endpoint | Use when | Required params |
|---|---|---|---|---|
| Create a call control application | | | Create or provision an additional resource when the core tasks do not cover this flow. | |
| Retrieve a call control application | | | Fetch the current state before updating, deleting, or making control-flow decisions. | |
| Update a call control application | | | Modify an existing resource without recreating it. | |
| Delete a call control application | | | Remove, detach, or clean up an existing resource. | |
| SIP Refer a call | | | Trigger a follow-up action in an existing workflow rather than creating a new top-level resource. | |
| Send SIP info | | | Trigger a follow-up action in an existing workflow rather than creating a new top-level resource. | |
| 操作 | SDK方法 | 接口地址 | 使用场景 | 必填参数 |
|---|---|---|---|---|
| 创建呼叫控制应用 | | | 当核心任务无法覆盖需求时,创建或provision额外资源 | |
| 获取呼叫控制应用 | | | 在更新、删除应用或做出控制流程决策前获取当前状态 | |
| 更新呼叫控制应用 | | | 修改现有资源而无需重新创建 | |
| 删除呼叫控制应用 | | | 移除、解绑或清理现有资源 | |
| SIP转接通话 | | | 在现有工作流中触发后续操作,而无需创建新的顶层资源 | |
| 发送SIP信息 | | | 在现有工作流中触发后续操作,而无需创建新的顶层资源 | |
| Event | | Description |
|---|---|---|
| | Call Bridged |
| 事件 | | 描述 |
|---|---|---|
| | 通话已桥接 |