Back to Details

telnyx-sip-javascript

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

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

Telnyx Sip - JavaScript

Telnyx Sip - JavaScript

Installation

安装

bash
npm install telnyx
bash
npm install telnyx

Setup

初始化

javascript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
All examples below assume 
client
is already initialized as shown above.
javascript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // 这是默认值，可省略
});
以下所有示例均假设
client
已按上述方式完成初始化。

Error Handling

错误处理

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:
javascript
try {
  const result = await client.messages.send({ to: '+13125550001', from: '+13125550002', text: 'Hello' });
} catch (err) {
  if (err instanceof Telnyx.APIConnectionError) {
    console.error('Network error — check connectivity and retry');
  } else if (err instanceof Telnyx.RateLimitError) {
    // 429: rate limited — wait and retry with exponential backoff
    const retryAfter = err.headers?.['retry-after'] || 1;
    await new Promise(r => setTimeout(r, retryAfter * 1000));
  } else if (err instanceof Telnyx.APIError) {
    console.error(`API error ${err.status}: ${err.message}`);
    if (err.status === 422) {
      console.error('Validation error — check required fields and formats');
    }
  }
}
Common error codes: 
401
invalid API key, 
403
insufficient permissions, 
404
resource not found, 
422
validation error (check field formats), 
429
rate limited (retry with exponential backoff).
所有API调用都可能因网络错误、速率限制（429）、验证错误（422）或认证错误（401）而失败。生产环境代码中务必处理错误：
javascript
try {
  const result = await client.messages.send({ to: '+13125550001', from: '+13125550002', text: 'Hello' });
} catch (err) {
  if (err instanceof Telnyx.APIConnectionError) {
    console.error('网络错误 — 检查连接并重试');
  } else if (err instanceof Telnyx.RateLimitError) {
    // 429：请求受限 — 等待后使用指数退避策略重试
    const retryAfter = err.headers?.['retry-after'] || 1;
    await new Promise(r => setTimeout(r, retryAfter * 1000));
  } else if (err instanceof Telnyx.APIError) {
    console.error(`API错误 ${err.status}: ${err.message}`);
    if (err.status === 422) {
      console.error('验证错误 — 检查必填字段和格式');
    }
  }
}
常见错误码：
401
无效API密钥，
403
权限不足，
404
资源未找到，
422
验证错误（检查字段格式），
429
请求受限（使用指数退避策略重试）。

Important Notes

重要说明

  • Pagination: List methods return an auto-paginating iterator. Use 
    for await (const item of result) { ... }
    to iterate through all pages automatically.
  • 分页： 列表方法会返回一个自动分页的迭代器。使用
    for await (const item of result) { ... }
    可自动遍历所有页面。

List all Access IP Ranges

列出所有访问IP范围

GET /access_ip_ranges
javascript
// Automatically fetches more pages as needed.
for await (const accessIPRange of client.accessIPRanges.list()) {
  console.log(accessIPRange.id);
}
Returns: 
cidr_block
(string), 
created_at
(date-time), 
description
(string), 
id
(string), 
status
(enum: pending, added), 
updated_at
(date-time), 
user_id
(string)
GET /access_ip_ranges
javascript
// 按需自动获取更多页面。
for await (const accessIPRange of client.accessIPRanges.list()) {
  console.log(accessIPRange.id);
}
返回值：
cidr_block
（字符串）、
created_at
（日期时间）、
description
（字符串）、
id
（字符串）、
status
（枚举值：pending、added）、
updated_at
（日期时间）、
user_id
（字符串）

Create new Access IP Range

创建新的访问IP范围

POST /access_ip_ranges
— Required: 
cidr_block
Optional: 
description
(string)
javascript
const accessIPRange = await client.accessIPRanges.create({ cidr_block: 'cidr_block' });

console.log(accessIPRange.id);
Returns: 
cidr_block
(string), 
created_at
(date-time), 
description
(string), 
id
(string), 
status
(enum: pending, added), 
updated_at
(date-time), 
user_id
(string)
POST /access_ip_ranges
— 必填项：
cidr_block
可选项：
description
（字符串）
javascript
const accessIPRange = await client.accessIPRanges.create({ cidr_block: 'cidr_block' });

console.log(accessIPRange.id);
返回值：
cidr_block
（字符串）、
created_at
（日期时间）、
description
（字符串）、
id
（字符串）、
status
（枚举值：pending、added）、
updated_at
（日期时间）、
user_id
（字符串）

Delete access IP ranges

删除访问IP范围

DELETE /access_ip_ranges/{access_ip_range_id}
javascript
const accessIPRange = await client.accessIPRanges.delete('550e8400-e29b-41d4-a716-446655440000');

console.log(accessIPRange.id);
Returns: 
cidr_block
(string), 
created_at
(date-time), 
description
(string), 
id
(string), 
status
(enum: pending, added), 
updated_at
(date-time), 
user_id
(string)
DELETE /access_ip_ranges/{access_ip_range_id}
javascript
const accessIPRange = await client.accessIPRanges.delete('550e8400-e29b-41d4-a716-446655440000');

console.log(accessIPRange.id);
返回值：
cidr_block
（字符串）、
created_at
（日期时间）、
description
（字符串）、
id
（字符串）、
status
（枚举值：pending、added）、
updated_at
（日期时间）、
user_id
（字符串）

List connections

列出所有连接

Returns a list of your connections irrespective of type.
GET /connections
javascript
// Automatically fetches more pages as needed.
for await (const connectionListResponse of client.connections.list()) {
  console.log(connectionListResponse.id);
}
Returns: 
active
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
connection_name
(string), 
created_at
(string), 
id
(string), 
outbound_voice_profile_id
(string), 
record_type
(string), 
tags
(array[string]), 
updated_at
(string), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri)
返回所有类型的连接列表。
GET /connections
javascript
// 按需自动获取更多页面。
for await (const connectionListResponse of client.connections.list()) {
  console.log(connectionListResponse.id);
}
返回值：
active
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
connection_name
（字符串）、
created_at
（字符串）、
id
（字符串）、
outbound_voice_profile_id
（字符串）、
record_type
（字符串）、
tags
（字符串数组）、
updated_at
（字符串）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）

Retrieve a connection

获取单个连接详情

Retrieves the high-level details of an existing connection. To retrieve specific authentication information, use the endpoint for the specific connection type.
GET /connections/{id}
javascript
const connection = await client.connections.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(connection.data);
Returns: 
active
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
connection_name
(string), 
created_at
(string), 
id
(string), 
outbound_voice_profile_id
(string), 
record_type
(string), 
tags
(array[string]), 
updated_at
(string), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri)
获取现有连接的核心详情。如需获取特定认证信息，请使用对应连接类型的端点。
GET /connections/{id}
javascript
const connection = await client.connections.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(connection.data);
返回值：
active
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
connection_name
（字符串）、
created_at
（字符串）、
id
（字符串）、
outbound_voice_profile_id
（字符串）、
record_type
（字符串）、
tags
（字符串数组）、
updated_at
（字符串）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）

List credential connections

列出凭证连接

Returns a list of your credential connections.
GET /credential_connections
javascript
// Automatically fetches more pages as needed.
for await (const credentialConnection of client.credentialConnections.list()) {
  console.log(credentialConnection.id);
}
Returns: 
active
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_in_webhooks
(boolean), 
connection_name
(string), 
created_at
(string), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
id
(string), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
password
(string), 
record_type
(string), 
rtcp_settings
(object), 
sip_uri_calling_preference
(enum: disabled, unrestricted, internal), 
tags
(array[string]), 
updated_at
(string), 
user_name
(string), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
返回所有凭证连接列表。
GET /credential_connections
javascript
// 按需自动获取更多页面。
for await (const credentialConnection of client.credentialConnections.list()) {
  console.log(credentialConnection.id);
}
返回值：
active
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_in_webhooks
（布尔值）、
connection_name
（字符串）、
created_at
（字符串）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
id
（字符串）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
password
（字符串）、
record_type
（字符串）、
rtcp_settings
（对象）、
sip_uri_calling_preference
（枚举值：disabled、unrestricted、internal）、
tags
（字符串数组）、
updated_at
（字符串）、
user_name
（字符串）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）

Create a credential connection

创建凭证连接

Creates a credential connection.
POST /credential_connections
— Required: 
user_name
, 
password
, 
connection_name
Optional: 
active
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_in_webhooks
(boolean), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
rtcp_settings
(object), 
sip_uri_calling_preference
(enum: disabled, unrestricted, internal), 
tags
(array[string]), 
webhook_api_version
(enum: 1, 2, texml), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
javascript
const credentialConnection = await client.credentialConnections.create({
  connection_name: 'my name',
  password: 'my123secure456password789',
  user_name: 'myusername123',
});

console.log(credentialConnection.data);
Returns: 
active
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_in_webhooks
(boolean), 
connection_name
(string), 
created_at
(string), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
id
(string), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
password
(string), 
record_type
(string), 
rtcp_settings
(object), 
sip_uri_calling_preference
(enum: disabled, unrestricted, internal), 
tags
(array[string]), 
updated_at
(string), 
user_name
(string), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
创建一个凭证连接。
POST /credential_connections
— 必填项：
user_name
、
password
、
connection_name
可选项：
active
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_in_webhooks
（布尔值）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
rtcp_settings
（对象）、
sip_uri_calling_preference
（枚举值：disabled、unrestricted、internal）、
tags
（字符串数组）、
webhook_api_version
（枚举值：1、2、texml）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）
javascript
const credentialConnection = await client.credentialConnections.create({
  connection_name: 'my name',
  password: 'my123secure456password789',
  user_name: 'myusername123',
});

console.log(credentialConnection.data);
返回值：
active
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_in_webhooks
（布尔值）、
connection_name
（字符串）、
created_at
（字符串）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
id
（字符串）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
password
（字符串）、
record_type
（字符串）、
rtcp_settings
（对象）、
sip_uri_calling_preference
（枚举值：disabled、unrestricted、internal）、
tags
（字符串数组）、
updated_at
（字符串）、
user_name
（字符串）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）

Retrieve a credential connection

获取凭证连接详情

Retrieves the details of an existing credential connection.
GET /credential_connections/{id}
javascript
const credentialConnection = await client.credentialConnections.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(credentialConnection.data);
Returns: 
active
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_in_webhooks
(boolean), 
connection_name
(string), 
created_at
(string), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
id
(string), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
password
(string), 
record_type
(string), 
rtcp_settings
(object), 
sip_uri_calling_preference
(enum: disabled, unrestricted, internal), 
tags
(array[string]), 
updated_at
(string), 
user_name
(string), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
获取现有凭证连接的详情。
GET /credential_connections/{id}
javascript
const credentialConnection = await client.credentialConnections.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(credentialConnection.data);
返回值：
active
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_in_webhooks
（布尔值）、
connection_name
（字符串）、
created_at
（字符串）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
id
（字符串）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
password
（字符串）、
record_type
（字符串）、
rtcp_settings
（对象）、
sip_uri_calling_preference
（枚举值：disabled、unrestricted、internal）、
tags
（字符串数组）、
updated_at
（字符串）、
user_name
（字符串）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）

Update a credential connection

更新凭证连接

Updates settings of an existing credential connection.
PATCH /credential_connections/{id}
Optional: 
active
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_in_webhooks
(boolean), 
connection_name
(string), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
password
(string), 
rtcp_settings
(object), 
sip_uri_calling_preference
(enum: disabled, unrestricted, internal), 
tags
(array[string]), 
user_name
(string), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
javascript
const credentialConnection = await client.credentialConnections.update('550e8400-e29b-41d4-a716-446655440000');

console.log(credentialConnection.data);
Returns: 
active
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_in_webhooks
(boolean), 
connection_name
(string), 
created_at
(string), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
id
(string), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
password
(string), 
record_type
(string), 
rtcp_settings
(object), 
sip_uri_calling_preference
(enum: disabled, unrestricted, internal), 
tags
(array[string]), 
updated_at
(string), 
user_name
(string), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
更新现有凭证连接的设置。
PATCH /credential_connections/{id}
可选项：
active
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_in_webhooks
（布尔值）、
connection_name
（字符串）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
password
（字符串）、
rtcp_settings
（对象）、
sip_uri_calling_preference
（枚举值：disabled、unrestricted、internal）、
tags
（字符串数组）、
user_name
（字符串）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）
javascript
const credentialConnection = await client.credentialConnections.update('550e8400-e29b-41d4-a716-446655440000');

console.log(credentialConnection.data);
返回值：
active
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_in_webhooks
（布尔值）、
connection_name
（字符串）、
created_at
（字符串）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
id
（字符串）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
password
（字符串）、
record_type
（字符串）、
rtcp_settings
（对象）、
sip_uri_calling_preference
（枚举值：disabled、unrestricted、internal）、
tags
（字符串数组）、
updated_at
（字符串）、
user_name
（字符串）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）

Delete a credential connection

删除凭证连接

Deletes an existing credential connection.
DELETE /credential_connections/{id}
javascript
const credentialConnection = await client.credentialConnections.delete('550e8400-e29b-41d4-a716-446655440000');

console.log(credentialConnection.data);
Returns: 
active
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_in_webhooks
(boolean), 
connection_name
(string), 
created_at
(string), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
id
(string), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
password
(string), 
record_type
(string), 
rtcp_settings
(object), 
sip_uri_calling_preference
(enum: disabled, unrestricted, internal), 
tags
(array[string]), 
updated_at
(string), 
user_name
(string), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
删除现有凭证连接。
DELETE /credential_connections/{id}
javascript
const credentialConnection = await client.credentialConnections.delete('550e8400-e29b-41d4-a716-446655440000');

console.log(credentialConnection.data);
返回值：
active
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_in_webhooks
（布尔值）、
connection_name
（字符串）、
created_at
（字符串）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
id
（字符串）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
password
（字符串）、
record_type
（字符串）、
rtcp_settings
（对象）、
sip_uri_calling_preference
（枚举值：disabled、unrestricted、internal）、
tags
（字符串数组）、
updated_at
（字符串）、
user_name
（字符串）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）

Check a Credential Connection Registration Status

检查凭证连接注册状态

Checks the registration_status for a credential connection, (
registration_status
) as well as the timestamp for the last SIP registration event (
registration_status_updated_at
)
POST /credential_connections/{id}/actions/check_registration_status
javascript
const response = await client.credentialConnections.actions.checkRegistrationStatus('550e8400-e29b-41d4-a716-446655440000');

console.log(response.data);
Returns: 
ip_address
(string), 
last_registration
(string), 
port
(integer), 
record_type
(string), 
sip_username
(string), 
status
(enum: Not Applicable, Not Registered, Failed, Expired, Registered, Unregistered), 
transport
(string), 
user_agent
(string)
检查凭证连接的注册状态（
registration_status
）以及最后一次SIP注册事件的时间戳（
registration_status_updated_at
）
POST /credential_connections/{id}/actions/check_registration_status
javascript
const response = await client.credentialConnections.actions.checkRegistrationStatus('550e8400-e29b-41d4-a716-446655440000');

console.log(response.data);
返回值：
ip_address
（字符串）、
last_registration
（字符串）、
port
（整数）、
record_type
（字符串）、
sip_username
（字符串）、
status
（枚举值：Not Applicable、Not Registered、Failed、Expired、Registered、Unregistered）、
transport
（字符串）、
user_agent
（字符串）

List FQDN connections

列出FQDN连接

Returns a list of your FQDN connections.
GET /fqdn_connections
javascript
// Automatically fetches more pages as needed.
for await (const fqdnConnection of client.fqdnConnections.list()) {
  console.log(fqdnConnection.id);
}
Returns: 
active
(boolean), 
adjust_dtmf_timestamp
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_enabled
(boolean), 
call_cost_in_webhooks
(boolean), 
connection_name
(string), 
created_at
(string), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
id
(string), 
ignore_dtmf_duration
(boolean), 
ignore_mark_bit
(boolean), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
microsoft_teams_sbc
(boolean), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
password
(string), 
record_type
(string), 
rtcp_settings
(object), 
rtp_pass_codecs_on_stream_change
(boolean), 
send_normalized_timestamps
(boolean), 
tags
(array[string]), 
third_party_control_enabled
(boolean), 
transport_protocol
(enum: UDP, TCP, TLS), 
txt_name
(string), 
txt_ttl
(integer), 
txt_value
(string), 
updated_at
(string), 
user_name
(string), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
返回所有FQDN连接列表。
GET /fqdn_connections
javascript
// 按需自动获取更多页面。
for await (const fqdnConnection of client.fqdnConnections.list()) {
  console.log(fqdnConnection.id);
}
返回值：
active
（布尔值）、
adjust_dtmf_timestamp
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_enabled
（布尔值）、
call_cost_in_webhooks
（布尔值）、
connection_name
（字符串）、
created_at
（字符串）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
id
（字符串）、
ignore_dtmf_duration
（布尔值）、
ignore_mark_bit
（布尔值）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
microsoft_teams_sbc
（布尔值）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
password
（字符串）、
record_type
（字符串）、
rtcp_settings
（对象）、
rtp_pass_codecs_on_stream_change
（布尔值）、
send_normalized_timestamps
（布尔值）、
tags
（字符串数组）、
third_party_control_enabled
（布尔值）、
transport_protocol
（枚举值：UDP、TCP、TLS）、
txt_name
（字符串）、
txt_ttl
（整数）、
txt_value
（字符串）、
updated_at
（字符串）、
user_name
（字符串）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）

Create an FQDN connection

创建FQDN连接

Creates a FQDN connection.
POST /fqdn_connections
— Required: 
connection_name
Optional: 
active
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_in_webhooks
(boolean), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
microsoft_teams_sbc
(boolean), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
rtcp_settings
(object), 
tags
(array[string]), 
transport_protocol
(enum: UDP, TCP, TLS), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
javascript
const fqdnConnection = await client.fqdnConnections.create({ connection_name: 'my-resource' });

console.log(fqdnConnection.data);
Returns: 
active
(boolean), 
adjust_dtmf_timestamp
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_enabled
(boolean), 
call_cost_in_webhooks
(boolean), 
connection_name
(string), 
created_at
(string), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
id
(string), 
ignore_dtmf_duration
(boolean), 
ignore_mark_bit
(boolean), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
microsoft_teams_sbc
(boolean), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
password
(string), 
record_type
(string), 
rtcp_settings
(object), 
rtp_pass_codecs_on_stream_change
(boolean), 
send_normalized_timestamps
(boolean), 
tags
(array[string]), 
third_party_control_enabled
(boolean), 
transport_protocol
(enum: UDP, TCP, TLS), 
txt_name
(string), 
txt_ttl
(integer), 
txt_value
(string), 
updated_at
(string), 
user_name
(string), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
创建一个FQDN连接。
POST /fqdn_connections
— 必填项：
connection_name
可选项：
active
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_in_webhooks
（布尔值）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
microsoft_teams_sbc
（布尔值）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
rtcp_settings
（对象）、
tags
（字符串数组）、
transport_protocol
（枚举值：UDP、TCP、TLS）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）
javascript
const fqdnConnection = await client.fqdnConnections.create({ connection_name: 'my-resource' });

console.log(fqdnConnection.data);
返回值：
active
（布尔值）、
adjust_dtmf_timestamp
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_enabled
（布尔值）、
call_cost_in_webhooks
（布尔值）、
connection_name
（字符串）、
created_at
（字符串）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
id
（字符串）、
ignore_dtmf_duration
（布尔值）、
ignore_mark_bit
（布尔值）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
microsoft_teams_sbc
（布尔值）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
password
（字符串）、
record_type
（字符串）、
rtcp_settings
（对象）、
rtp_pass_codecs_on_stream_change
（布尔值）、
send_normalized_timestamps
（布尔值）、
tags
（字符串数组）、
third_party_control_enabled
（布尔值）、
transport_protocol
（枚举值：UDP、TCP、TLS）、
txt_name
（字符串）、
txt_ttl
（整数）、
txt_value
（字符串）、
updated_at
（字符串）、
user_name
（字符串）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）

Retrieve an FQDN connection

获取FQDN连接详情

Retrieves the details of an existing FQDN connection.
GET /fqdn_connections/{id}
javascript
const fqdnConnection = await client.fqdnConnections.retrieve('1293384261075731499');

console.log(fqdnConnection.data);
Returns: 
active
(boolean), 
adjust_dtmf_timestamp
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_enabled
(boolean), 
call_cost_in_webhooks
(boolean), 
connection_name
(string), 
created_at
(string), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
id
(string), 
ignore_dtmf_duration
(boolean), 
ignore_mark_bit
(boolean), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
microsoft_teams_sbc
(boolean), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
password
(string), 
record_type
(string), 
rtcp_settings
(object), 
rtp_pass_codecs_on_stream_change
(boolean), 
send_normalized_timestamps
(boolean), 
tags
(array[string]), 
third_party_control_enabled
(boolean), 
transport_protocol
(enum: UDP, TCP, TLS), 
txt_name
(string), 
txt_ttl
(integer), 
txt_value
(string), 
updated_at
(string), 
user_name
(string), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
获取现有FQDN连接的详情。
GET /fqdn_connections/{id}
javascript
const fqdnConnection = await client.fqdnConnections.retrieve('1293384261075731499');

console.log(fqdnConnection.data);
返回值：
active
（布尔值）、
adjust_dtmf_timestamp
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_enabled
（布尔值）、
call_cost_in_webhooks
（布尔值）、
connection_name
（字符串）、
created_at
（字符串）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
id
（字符串）、
ignore_dtmf_duration
（布尔值）、
ignore_mark_bit
（布尔值）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
microsoft_teams_sbc
（布尔值）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
password
（字符串）、
record_type
（字符串）、
rtcp_settings
（对象）、
rtp_pass_codecs_on_stream_change
（布尔值）、
send_normalized_timestamps
（布尔值）、
tags
（字符串数组）、
third_party_control_enabled
（布尔值）、
transport_protocol
（枚举值：UDP、TCP、TLS）、
txt_name
（字符串）、
txt_ttl
（整数）、
txt_value
（字符串）、
updated_at
（字符串）、
user_name
（字符串）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）

Update an FQDN connection

更新FQDN连接

Updates settings of an existing FQDN connection.
PATCH /fqdn_connections/{id}
Optional: 
active
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_in_webhooks
(boolean), 
connection_name
(string), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
rtcp_settings
(object), 
tags
(array[string]), 
transport_protocol
(enum: UDP, TCP, TLS), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
javascript
const fqdnConnection = await client.fqdnConnections.update('1293384261075731499');

console.log(fqdnConnection.data);
Returns: 
active
(boolean), 
adjust_dtmf_timestamp
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_enabled
(boolean), 
call_cost_in_webhooks
(boolean), 
connection_name
(string), 
created_at
(string), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
id
(string), 
ignore_dtmf_duration
(boolean), 
ignore_mark_bit
(boolean), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
microsoft_teams_sbc
(boolean), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
password
(string), 
record_type
(string), 
rtcp_settings
(object), 
rtp_pass_codecs_on_stream_change
(boolean), 
send_normalized_timestamps
(boolean), 
tags
(array[string]), 
third_party_control_enabled
(boolean), 
transport_protocol
(enum: UDP, TCP, TLS), 
txt_name
(string), 
txt_ttl
(integer), 
txt_value
(string), 
updated_at
(string), 
user_name
(string), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
更新现有FQDN连接的设置。
PATCH /fqdn_connections/{id}
可选项：
active
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_in_webhooks
（布尔值）、
connection_name
（字符串）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
rtcp_settings
（对象）、
tags
（字符串数组）、
transport_protocol
（枚举值：UDP、TCP、TLS）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）
javascript
const fqdnConnection = await client.fqdnConnections.update('1293384261075731499');

console.log(fqdnConnection.data);
返回值：
active
（布尔值）、
adjust_dtmf_timestamp
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_enabled
（布尔值）、
call_cost_in_webhooks
（布尔值）、
connection_name
（字符串）、
created_at
（字符串）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
id
（字符串）、
ignore_dtmf_duration
（布尔值）、
ignore_mark_bit
（布尔值）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
microsoft_teams_sbc
（布尔值）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
password
（字符串）、
record_type
（字符串）、
rtcp_settings
（对象）、
rtp_pass_codecs_on_stream_change
（布尔值）、
send_normalized_timestamps
（布尔值）、
tags
（字符串数组）、
third_party_control_enabled
（布尔值）、
transport_protocol
（枚举值：UDP、TCP、TLS）、
txt_name
（字符串）、
txt_ttl
（整数）、
txt_value
（字符串）、
updated_at
（字符串）、
user_name
（字符串）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）

Delete an FQDN connection

删除FQDN连接

Deletes an FQDN connection.
DELETE /fqdn_connections/{id}
javascript
const fqdnConnection = await client.fqdnConnections.delete('1293384261075731499');

console.log(fqdnConnection.data);
Returns: 
active
(boolean), 
adjust_dtmf_timestamp
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_enabled
(boolean), 
call_cost_in_webhooks
(boolean), 
connection_name
(string), 
created_at
(string), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
id
(string), 
ignore_dtmf_duration
(boolean), 
ignore_mark_bit
(boolean), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
microsoft_teams_sbc
(boolean), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
password
(string), 
record_type
(string), 
rtcp_settings
(object), 
rtp_pass_codecs_on_stream_change
(boolean), 
send_normalized_timestamps
(boolean), 
tags
(array[string]), 
third_party_control_enabled
(boolean), 
transport_protocol
(enum: UDP, TCP, TLS), 
txt_name
(string), 
txt_ttl
(integer), 
txt_value
(string), 
updated_at
(string), 
user_name
(string), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
删除FQDN连接。
DELETE /fqdn_connections/{id}
javascript
const fqdnConnection = await client.fqdnConnections.delete('1293384261075731499');

console.log(fqdnConnection.data);
返回值：
active
（布尔值）、
adjust_dtmf_timestamp
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_enabled
（布尔值）、
call_cost_in_webhooks
（布尔值）、
connection_name
（字符串）、
created_at
（字符串）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
id
（字符串）、
ignore_dtmf_duration
（布尔值）、
ignore_mark_bit
（布尔值）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
microsoft_teams_sbc
（布尔值）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
password
（字符串）、
record_type
（字符串）、
rtcp_settings
（对象）、
rtp_pass_codecs_on_stream_change
（布尔值）、
send_normalized_timestamps
（布尔值）、
tags
（字符串数组）、
third_party_control_enabled
（布尔值）、
transport_protocol
（枚举值：UDP、TCP、TLS）、
txt_name
（字符串）、
txt_ttl
（整数）、
txt_value
（字符串）、
updated_at
（字符串）、
user_name
（字符串）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）

List FQDNs

列出FQDN

Get all FQDNs belonging to the user that match the given filters.
GET /fqdns
javascript
// Automatically fetches more pages as needed.
for await (const fqdn of client.fqdns.list()) {
  console.log(fqdn.id);
}
Returns: 
connection_id
(string), 
created_at
(string), 
dns_record_type
(string), 
fqdn
(string), 
id
(string), 
port
(integer), 
record_type
(string), 
updated_at
(string)
获取符合筛选条件的用户所有FQDN。
GET /fqdns
javascript
// 按需自动获取更多页面。
for await (const fqdn of client.fqdns.list()) {
  console.log(fqdn.id);
}
返回值：
connection_id
（字符串）、
created_at
（字符串）、
dns_record_type
（字符串）、
fqdn
（字符串）、
id
（字符串）、
port
（整数）、
record_type
（字符串）、
updated_at
（字符串）

Create an FQDN

创建FQDN

Create a new FQDN object.
POST /fqdns
— Required: 
fqdn
, 
dns_record_type
, 
connection_id
Optional: 
port
(integer | null)
javascript
const fqdn = await client.fqdns.create({
  connection_id: '1516447646313612565',
  dns_record_type: 'a',
  fqdn: 'example.com',
});

console.log(fqdn.data);
Returns: 
connection_id
(string), 
created_at
(string), 
dns_record_type
(string), 
fqdn
(string), 
id
(string), 
port
(integer), 
record_type
(string), 
updated_at
(string)
创建一个新的FQDN对象。
POST /fqdns
— 必填项：
fqdn
、
dns_record_type
、
connection_id
可选项：
port
（整数 | null）
javascript
const fqdn = await client.fqdns.create({
  connection_id: '1516447646313612565',
  dns_record_type: 'a',
  fqdn: 'example.com',
});

console.log(fqdn.data);
返回值：
connection_id
（字符串）、
created_at
（字符串）、
dns_record_type
（字符串）、
fqdn
（字符串）、
id
（字符串）、
port
（整数）、
record_type
（字符串）、
updated_at
（字符串）

Retrieve an FQDN

获取FQDN详情

Return the details regarding a specific FQDN.
GET /fqdns/{id}
javascript
const fqdn = await client.fqdns.retrieve('1517907029795014409');

console.log(fqdn.data);
Returns: 
connection_id
(string), 
created_at
(string), 
dns_record_type
(string), 
fqdn
(string), 
id
(string), 
port
(integer), 
record_type
(string), 
updated_at
(string)
返回特定FQDN的详情。
GET /fqdns/{id}
javascript
const fqdn = await client.fqdns.retrieve('1517907029795014409');

console.log(fqdn.data);
返回值：
connection_id
（字符串）、
created_at
（字符串）、
dns_record_type
（字符串）、
fqdn
（字符串）、
id
（字符串）、
port
（整数）、
record_type
（字符串）、
updated_at
（字符串）

Update an FQDN

更新FQDN

Update the details of a specific FQDN.
PATCH /fqdns/{id}
Optional: 
connection_id
(string), 
dns_record_type
(string), 
fqdn
(string), 
port
(integer | null)
javascript
const fqdn = await client.fqdns.update('1517907029795014409');

console.log(fqdn.data);
Returns: 
connection_id
(string), 
created_at
(string), 
dns_record_type
(string), 
fqdn
(string), 
id
(string), 
port
(integer), 
record_type
(string), 
updated_at
(string)
更新特定FQDN的详情。
PATCH /fqdns/{id}
可选项：
connection_id
（字符串）、
dns_record_type
（字符串）、
fqdn
（字符串）、
port
（整数 | null）
javascript
const fqdn = await client.fqdns.update('1517907029795014409');

console.log(fqdn.data);
返回值：
connection_id
（字符串）、
created_at
（字符串）、
dns_record_type
（字符串）、
fqdn
（字符串）、
id
（字符串）、
port
（整数）、
record_type
（字符串）、
updated_at
（字符串）

Delete an FQDN

删除FQDN

Delete an FQDN.
DELETE /fqdns/{id}
javascript
const fqdn = await client.fqdns.delete('1517907029795014409');

console.log(fqdn.data);
Returns: 
connection_id
(string), 
created_at
(string), 
dns_record_type
(string), 
fqdn
(string), 
id
(string), 
port
(integer), 
record_type
(string), 
updated_at
(string)
删除FQDN。
DELETE /fqdns/{id}
javascript
const fqdn = await client.fqdns.delete('1517907029795014409');

console.log(fqdn.data);
返回值：
connection_id
（字符串）、
created_at
（字符串）、
dns_record_type
（字符串）、
fqdn
（字符串）、
id
（字符串）、
port
（整数）、
record_type
（字符串）、
updated_at
（字符串）

List Ip connections

列出IP连接

Returns a list of your IP connections.
GET /ip_connections
javascript
// Automatically fetches more pages as needed.
for await (const ipConnection of client.ipConnections.list()) {
  console.log(ipConnection.id);
}
Returns: 
active
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_in_webhooks
(boolean), 
connection_name
(string), 
created_at
(string), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
id
(string), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
record_type
(string), 
rtcp_settings
(object), 
tags
(array[string]), 
transport_protocol
(enum: UDP, TCP, TLS), 
updated_at
(string), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
返回所有IP连接列表。
GET /ip_connections
javascript
// 按需自动获取更多页面。
for await (const ipConnection of client.ipConnections.list()) {
  console.log(ipConnection.id);
}
返回值：
active
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_in_webhooks
（布尔值）、
connection_name
（字符串）、
created_at
（字符串）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
id
（字符串）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
record_type
（字符串）、
rtcp_settings
（对象）、
tags
（字符串数组）、
transport_protocol
（枚举值：UDP、TCP、TLS）、
updated_at
（字符串）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）

Create an Ip connection

创建IP连接

Creates an IP connection.
POST /ip_connections
Optional: 
active
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_in_webhooks
(boolean), 
connection_name
(string), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
rtcp_settings
(object), 
tags
(array[string]), 
transport_protocol
(enum: UDP, TCP, TLS), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
javascript
const ipConnection = await client.ipConnections.create({
    connectionName: 'my-ip-connection',
});

console.log(ipConnection.data);
Returns: 
active
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_in_webhooks
(boolean), 
connection_name
(string), 
created_at
(string), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
id
(string), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
record_type
(string), 
rtcp_settings
(object), 
tags
(array[string]), 
transport_protocol
(enum: UDP, TCP, TLS), 
updated_at
(string), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
创建一个IP连接。
POST /ip_connections
可选项：
active
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_in_webhooks
（布尔值）、
connection_name
（字符串）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
rtcp_settings
（对象）、
tags
（字符串数组）、
transport_protocol
（枚举值：UDP、TCP、TLS）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）
javascript
const ipConnection = await client.ipConnections.create({
    connectionName: 'my-ip-connection',
});

console.log(ipConnection.data);
返回值：
active
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_in_webhooks
（布尔值）、
connection_name
（字符串）、
created_at
（字符串）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
id
（字符串）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
record_type
（字符串）、
rtcp_settings
（对象）、
tags
（字符串数组）、
transport_protocol
（枚举值：UDP、TCP、TLS）、
updated_at
（字符串）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）

Retrieve an Ip connection

获取IP连接详情

Retrieves the details of an existing ip connection.
GET /ip_connections/{id}
javascript
const ipConnection = await client.ipConnections.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(ipConnection.data);
Returns: 
active
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_in_webhooks
(boolean), 
connection_name
(string), 
created_at
(string), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
id
(string), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
record_type
(string), 
rtcp_settings
(object), 
tags
(array[string]), 
transport_protocol
(enum: UDP, TCP, TLS), 
updated_at
(string), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
获取现有IP连接的详情。
GET /ip_connections/{id}
javascript
const ipConnection = await client.ipConnections.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(ipConnection.data);
返回值：
active
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_in_webhooks
（布尔值）、
connection_name
（字符串）、
created_at
（字符串）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
id
（字符串）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
record_type
（字符串）、
rtcp_settings
（对象）、
tags
（字符串数组）、
transport_protocol
（枚举值：UDP、TCP、TLS）、
updated_at
（字符串）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）

Update an Ip connection

更新IP连接

Updates settings of an existing IP connection.
PATCH /ip_connections/{id}
Optional: 
active
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_in_webhooks
(boolean), 
connection_name
(string), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
rtcp_settings
(object), 
tags
(array[string]), 
transport_protocol
(enum: UDP, TCP, TLS), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
javascript
const ipConnection = await client.ipConnections.update('550e8400-e29b-41d4-a716-446655440000');

console.log(ipConnection.data);
Returns: 
active
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_in_webhooks
(boolean), 
connection_name
(string), 
created_at
(string), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
id
(string), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
record_type
(string), 
rtcp_settings
(object), 
tags
(array[string]), 
transport_protocol
(enum: UDP, TCP, TLS), 
updated_at
(string), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
更新现有IP连接的设置。
PATCH /ip_connections/{id}
可选项：
active
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_in_webhooks
（布尔值）、
connection_name
（字符串）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
rtcp_settings
（对象）、
tags
（字符串数组）、
transport_protocol
（枚举值：UDP、TCP、TLS）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）
javascript
const ipConnection = await client.ipConnections.update('550e8400-e29b-41d4-a716-446655440000');

console.log(ipConnection.data);
返回值：
active
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_in_webhooks
（布尔值）、
connection_name
（字符串）、
created_at
（字符串）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
id
（字符串）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
record_type
（字符串）、
rtcp_settings
（对象）、
tags
（字符串数组）、
transport_protocol
（枚举值：UDP、TCP、TLS）、
updated_at
（字符串）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）

Delete an Ip connection

删除IP连接

Deletes an existing IP connection.
DELETE /ip_connections/{id}
javascript
const ipConnection = await client.ipConnections.delete('550e8400-e29b-41d4-a716-446655440000');

console.log(ipConnection.data);
Returns: 
active
(boolean), 
anchorsite_override
(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), 
android_push_credential_id
(string | null), 
call_cost_in_webhooks
(boolean), 
connection_name
(string), 
created_at
(string), 
default_on_hold_comfort_noise_enabled
(boolean), 
dtmf_type
(enum: RFC 2833, Inband, SIP INFO), 
encode_contact_header_enabled
(boolean), 
encrypted_media
(enum: SRTP, None), 
id
(string), 
inbound
(object), 
ios_push_credential_id
(string | null), 
jitter_buffer
(object), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
noise_suppression_details
(object), 
onnet_t38_passthrough_enabled
(boolean), 
outbound
(object), 
record_type
(string), 
rtcp_settings
(object), 
tags
(array[string]), 
transport_protocol
(enum: UDP, TCP, TLS), 
updated_at
(string), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(uri), 
webhook_event_url
(uri), 
webhook_timeout_secs
(integer | null)
删除现有IP连接。
DELETE /ip_connections/{id}
javascript
const ipConnection = await client.ipConnections.delete('550e8400-e29b-41d4-a716-446655440000');

console.log(ipConnection.data);
返回值：
active
（布尔值）、
anchorsite_override
（枚举值：Latency、Chicago, IL、Ashburn, VA、San Jose, CA、Sydney, Australia、Amsterdam, Netherlands、London, UK、Toronto, Canada、Vancouver, Canada、Frankfurt, Germany）、
android_push_credential_id
（字符串 | null）、
call_cost_in_webhooks
（布尔值）、
connection_name
（字符串）、
created_at
（字符串）、
default_on_hold_comfort_noise_enabled
（布尔值）、
dtmf_type
（枚举值：RFC 2833、Inband、SIP INFO）、
encode_contact_header_enabled
（布尔值）、
encrypted_media
（枚举值：SRTP、None）、
id
（字符串）、
inbound
（对象）、
ios_push_credential_id
（字符串 | null）、
jitter_buffer
（对象）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
noise_suppression_details
（对象）、
onnet_t38_passthrough_enabled
（布尔值）、
outbound
（对象）、
record_type
（字符串）、
rtcp_settings
（对象）、
tags
（字符串数组）、
transport_protocol
（枚举值：UDP、TCP、TLS）、
updated_at
（字符串）、
webhook_api_version
（枚举值：1、2）、
webhook_event_failover_url
（URI）、
webhook_event_url
（URI）、
webhook_timeout_secs
（整数 | null）

List Ips

列出IP

Get all IPs belonging to the user that match the given filters.
GET /ips
javascript
// Automatically fetches more pages as needed.
for await (const ip of client.ips.list()) {
  console.log(ip.id);
}
Returns: 
connection_id
(string), 
created_at
(string), 
id
(string), 
ip_address
(string), 
port
(integer), 
record_type
(string), 
updated_at
(string)
获取符合筛选条件的用户所有IP。
GET /ips
javascript
// 按需自动获取更多页面。
for await (const ip of client.ips.list()) {
  console.log(ip.id);
}
返回值：
connection_id
（字符串）、
created_at
（字符串）、
id
（字符串）、
ip_address
（字符串）、
port
（整数）、
record_type
（字符串）、
updated_at
（字符串）

Create an Ip

创建IP

Create a new IP object.
POST /ips
— Required: 
ip_address
Optional: 
connection_id
(string), 
port
(integer)
javascript
const ip = await client.ips.create({ ip_address: '192.168.0.0' });

console.log(ip.data);
Returns: 
connection_id
(string), 
created_at
(string), 
id
(string), 
ip_address
(string), 
port
(integer), 
record_type
(string), 
updated_at
(string)
创建一个新的IP对象。
POST /ips
— 必填项：
ip_address
可选项：
connection_id
（字符串）、
port
（整数）
javascript
const ip = await client.ips.create({ ip_address: '192.168.0.0' });

console.log(ip.data);
返回值：
connection_id
（字符串）、
created_at
（字符串）、
id
（字符串）、
ip_address
（字符串）、
port
（整数）、
record_type
（字符串）、
updated_at
（字符串）

Retrieve an Ip

获取IP详情

Return the details regarding a specific IP.
GET /ips/{id}
javascript
const ip = await client.ips.retrieve('6a09cdc3-8948-47f0-aa62-74ac943d6c58');

console.log(ip.data);
Returns: 
connection_id
(string), 
created_at
(string), 
id
(string), 
ip_address
(string), 
port
(integer), 
record_type
(string), 
updated_at
(string)
返回特定IP的详情。
GET /ips/{id}
javascript
const ip = await client.ips.retrieve('6a09cdc3-8948-47f0-aa62-74ac943d6c58');

console.log(ip.data);
返回值：
connection_id
（字符串）、
created_at
（字符串）、
id
（字符串）、
ip_address
（字符串）、
port
（整数）、
record_type
（字符串）、
updated_at
（字符串）

Update an Ip

更新IP

Update the details of a specific IP.
PATCH /ips/{id}
— Required: 
ip_address
Optional: 
connection_id
(string), 
port
(integer)
javascript
const ip = await client.ips.update('6a09cdc3-8948-47f0-aa62-74ac943d6c58', {
  ip_address: '192.168.0.0',
});

console.log(ip.data);
Returns: 
connection_id
(string), 
created_at
(string), 
id
(string), 
ip_address
(string), 
port
(integer), 
record_type
(string), 
updated_at
(string)
更新特定IP的详情。
PATCH /ips/{id}
— 必填项：
ip_address
可选项：
connection_id
（字符串）、
port
（整数）
javascript
const ip = await client.ips.update('6a09cdc3-8948-47f0-aa62-74ac943d6c58', {
  ip_address: '192.168.0.0',
});

console.log(ip.data);
返回值：
connection_id
（字符串）、
created_at
（字符串）、
id
（字符串）、
ip_address
（字符串）、
port
（整数）、
record_type
（字符串）、
updated_at
（字符串）

Delete an Ip

删除IP

Delete an IP.
DELETE /ips/{id}
javascript
const ip = await client.ips.delete('6a09cdc3-8948-47f0-aa62-74ac943d6c58');

console.log(ip.data);
Returns: 
connection_id
(string), 
created_at
(string), 
id
(string), 
ip_address
(string), 
port
(integer), 
record_type
(string), 
updated_at
(string)
删除IP。
DELETE /ips/{id}
javascript
const ip = await client.ips.delete('6a09cdc3-8948-47f0-aa62-74ac943d6c58');

console.log(ip.data);
返回值：
connection_id
（字符串）、
created_at
（字符串）、
id
（字符串）、
ip_address
（字符串）、
port
（整数）、
record_type
（字符串）、
updated_at
（字符串）

Get all outbound voice profiles

获取所有外呼语音配置文件

Get all outbound voice profiles belonging to the user that match the given filters.
GET /outbound_voice_profiles
javascript
// Automatically fetches more pages as needed.
for await (const outboundVoiceProfile of client.outboundVoiceProfiles.list()) {
  console.log(outboundVoiceProfile.id);
}
Returns: 
billing_group_id
(uuid), 
call_recording
(object), 
calling_window
(object), 
concurrent_call_limit
(integer | null), 
connections_count
(integer), 
created_at
(string), 
daily_spend_limit
(string), 
daily_spend_limit_enabled
(boolean), 
enabled
(boolean), 
id
(string), 
max_destination_rate
(number), 
name
(string), 
record_type
(string), 
service_plan
(enum: global), 
tags
(array[string]), 
traffic_type
(enum: conversational), 
updated_at
(string), 
usage_payment_method
(enum: rate-deck), 
whitelisted_destinations
(array[string])
获取符合筛选条件的用户所有外呼语音配置文件。
GET /outbound_voice_profiles
javascript
// 按需自动获取更多页面。
for await (const outboundVoiceProfile of client.outboundVoiceProfiles.list()) {
  console.log(outboundVoiceProfile.id);
}
返回值：
billing_group_id
（UUID）、
call_recording
（对象）、
calling_window
（对象）、
concurrent_call_limit
（整数 | null）、
connections_count
（整数）、
created_at
（字符串）、
daily_spend_limit
（字符串）、
daily_spend_limit_enabled
（布尔值）、
enabled
（布尔值）、
id
（字符串）、
max_destination_rate
（数字）、
name
（字符串）、
record_type
（字符串）、
service_plan
（枚举值：global）、
tags
（字符串数组）、
traffic_type
（枚举值：conversational）、
updated_at
（字符串）、
usage_payment_method
（枚举值：rate-deck）、
whitelisted_destinations
（字符串数组）

Create an outbound voice profile

创建外呼语音配置文件

Create an outbound voice profile.
POST /outbound_voice_profiles
— Required: 
name
Optional: 
billing_group_id
(uuid), 
call_recording
(object), 
calling_window
(object), 
concurrent_call_limit
(integer | null), 
daily_spend_limit
(string), 
daily_spend_limit_enabled
(boolean), 
enabled
(boolean), 
max_destination_rate
(number), 
service_plan
(enum: global), 
tags
(array[string]), 
traffic_type
(enum: conversational), 
usage_payment_method
(enum: rate-deck), 
whitelisted_destinations
(array[string])
javascript
const outboundVoiceProfile = await client.outboundVoiceProfiles.create({ name: 'office' });

console.log(outboundVoiceProfile.data);
Returns: 
billing_group_id
(uuid), 
call_recording
(object), 
calling_window
(object), 
concurrent_call_limit
(integer | null), 
connections_count
(integer), 
created_at
(string), 
daily_spend_limit
(string), 
daily_spend_limit_enabled
(boolean), 
enabled
(boolean), 
id
(string), 
max_destination_rate
(number), 
name
(string), 
record_type
(string), 
service_plan
(enum: global), 
tags
(array[string]), 
traffic_type
(enum: conversational), 
updated_at
(string), 
usage_payment_method
(enum: rate-deck), 
whitelisted_destinations
(array[string])
创建一个外呼语音配置文件。
POST /outbound_voice_profiles
— 必填项：
name
可选项：
billing_group_id
（UUID）、
call_recording
（对象）、
calling_window
（对象）、
concurrent_call_limit
（整数 | null）、
daily_spend_limit
（字符串）、
daily_spend_limit_enabled
（布尔值）、
enabled
（布尔值）、
max_destination_rate
（数字）、
service_plan
（枚举值：global）、
tags
（字符串数组）、
traffic_type
（枚举值：conversational）、
usage_payment_method
（枚举值：rate-deck）、
whitelisted_destinations
（字符串数组）
javascript
const outboundVoiceProfile = await client.outboundVoiceProfiles.create({ name: 'office' });

console.log(outboundVoiceProfile.data);
返回值：
billing_group_id
（UUID）、
call_recording
（对象）、
calling_window
（对象）、
concurrent_call_limit
（整数 | null）、
connections_count
（整数）、
created_at
（字符串）、
daily_spend_limit
（字符串）、
daily_spend_limit_enabled
（布尔值）、
enabled
（布尔值）、
id
（字符串）、
max_destination_rate
（数字）、
name
（字符串）、
record_type
（字符串）、
service_plan
（枚举值：global）、
tags
（字符串数组）、
traffic_type
（枚举值：conversational）、
updated_at
（字符串）、
usage_payment_method
（枚举值：rate-deck）、
whitelisted_destinations
（字符串数组）

Retrieve an outbound voice profile

获取外呼语音配置文件详情

Retrieves the details of an existing outbound voice profile.
GET /outbound_voice_profiles/{id}
javascript
const outboundVoiceProfile = await client.outboundVoiceProfiles.retrieve('1293384261075731499');

console.log(outboundVoiceProfile.data);
Returns: 
billing_group_id
(uuid), 
call_recording
(object), 
calling_window
(object), 
concurrent_call_limit
(integer | null), 
connections_count
(integer), 
created_at
(string), 
daily_spend_limit
(string), 
daily_spend_limit_enabled
(boolean), 
enabled
(boolean), 
id
(string), 
max_destination_rate
(number), 
name
(string), 
record_type
(string), 
service_plan
(enum: global), 
tags
(array[string]), 
traffic_type
(enum: conversational), 
updated_at
(string), 
usage_payment_method
(enum: rate-deck), 
whitelisted_destinations
(array[string])
获取现有外呼语音配置文件的详情。
GET /outbound_voice_profiles/{id}
javascript
const outboundVoiceProfile = await client.outboundVoiceProfiles.retrieve('1293384261075731499');

console.log(outboundVoiceProfile.data);
返回值：
billing_group_id
（UUID）、
call_recording
（对象）、
calling_window
（对象）、
concurrent_call_limit
（整数 | null）、
connections_count
（整数）、
created_at
（字符串）、
daily_spend_limit
（字符串）、
daily_spend_limit_enabled
（布尔值）、
enabled
（布尔值）、
id
（字符串）、
max_destination_rate
（数字）、
name
（字符串）、
record_type
（字符串）、
service_plan
（枚举值：global）、
tags
（字符串数组）、
traffic_type
（枚举值：conversational）、
updated_at
（字符串）、
usage_payment_method
（枚举值：rate-deck）、
whitelisted_destinations
（字符串数组）

Updates an existing outbound voice profile.

更新现有外呼语音配置文件

PATCH /outbound_voice_profiles/{id}
— Required: 
name
Optional: 
billing_group_id
(uuid), 
call_recording
(object), 
calling_window
(object), 
concurrent_call_limit
(integer | null), 
daily_spend_limit
(string), 
daily_spend_limit_enabled
(boolean), 
enabled
(boolean), 
max_destination_rate
(number), 
service_plan
(enum: global), 
tags
(array[string]), 
traffic_type
(enum: conversational), 
usage_payment_method
(enum: rate-deck), 
whitelisted_destinations
(array[string])
javascript
const outboundVoiceProfile = await client.outboundVoiceProfiles.update('1293384261075731499', {
  name: 'office',
});

console.log(outboundVoiceProfile.data);
Returns: 
billing_group_id
(uuid), 
call_recording
(object), 
calling_window
(object), 
concurrent_call_limit
(integer | null), 
connections_count
(integer), 
created_at
(string), 
daily_spend_limit
(string), 
daily_spend_limit_enabled
(boolean), 
enabled
(boolean), 
id
(string), 
max_destination_rate
(number), 
name
(string), 
record_type
(string), 
service_plan
(enum: global), 
tags
(array[string]), 
traffic_type
(enum: conversational), 
updated_at
(string), 
usage_payment_method
(enum: rate-deck), 
whitelisted_destinations
(array[string])
PATCH /outbound_voice_profiles/{id}
— 必填项：
name
可选项：
billing_group_id
（UUID）、
call_recording
（对象）、
calling_window
（对象）、
concurrent_call_limit
（整数 | null）、
daily_spend_limit
（字符串）、
daily_spend_limit_enabled
（布尔值）、
enabled
（布尔值）、
max_destination_rate
（数字）、
service_plan
（枚举值：global）、
tags
（字符串数组）、
traffic_type
（枚举值：conversational）、
usage_payment_method
（枚举值：rate-deck）、
whitelisted_destinations
（字符串数组）
javascript
const outboundVoiceProfile = await client.outboundVoiceProfiles.update('1293384261075731499', {
  name: 'office',
});

console.log(outboundVoiceProfile.data);
返回值：
billing_group_id
（UUID）、
call_recording
（对象）、
calling_window
（对象）、
concurrent_call_limit
（整数 | null）、
connections_count
（整数）、
created_at
（字符串）、
daily_spend_limit
（字符串）、
daily_spend_limit_enabled
（布尔值）、
enabled
（布尔值）、
id
（字符串）、
max_destination_rate
（数字）、
name
（字符串）、
record_type
（字符串）、
service_plan
（枚举值：global）、
tags
（字符串数组）、
traffic_type
（枚举值：conversational）、
updated_at
（字符串）、
usage_payment_method
（枚举值：rate-deck）、
whitelisted_destinations
（字符串数组）

Delete an outbound voice profile

删除外呼语音配置文件

Deletes an existing outbound voice profile.
DELETE /outbound_voice_profiles/{id}
javascript
const outboundVoiceProfile = await client.outboundVoiceProfiles.delete('1293384261075731499');

console.log(outboundVoiceProfile.data);
Returns: 
billing_group_id
(uuid), 
call_recording
(object), 
calling_window
(object), 
concurrent_call_limit
(integer | null), 
connections_count
(integer), 
created_at
(string), 
daily_spend_limit
(string), 
daily_spend_limit_enabled
(boolean), 
enabled
(boolean), 
id
(string), 
max_destination_rate
(number), 
name
(string), 
record_type
(string), 
service_plan
(enum: global), 
tags
(array[string]), 
traffic_type
(enum: conversational), 
updated_at
(string), 
usage_payment_method
(enum: rate-deck), 
whitelisted_destinations
(array[string])
删除现有外呼语音配置文件。
DELETE /outbound_voice_profiles/{id}
javascript
const outboundVoiceProfile = await client.outboundVoiceProfiles.delete('1293384261075731499');

console.log(outboundVoiceProfile.data);
返回值：
billing_group_id
（UUID）、
call_recording
（对象）、
calling_window
（对象）、
concurrent_call_limit
（整数 | null）、
connections_count
（整数）、
created_at
（字符串）、
daily_spend_limit
（字符串）、
daily_spend_limit_enabled
（布尔值）、
enabled
（布尔值）、
id
（字符串）、
max_destination_rate
（数字）、
name
（字符串）、
record_type
（字符串）、
service_plan
（枚举值：global）、
tags
（字符串数组）、
traffic_type
（枚举值：conversational）、
updated_at
（字符串）、
usage_payment_method
（枚举值：rate-deck）、
whitelisted_destinations
（字符串数组）