Skip to main content
GET
/
ip_connections
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const ipConnections = await client.ipConnections.list();

console.log(ipConnections.data);
{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "ip_connection",
      "active": true,
      "anchorsite_override": "Latency",
      "connection_name": "string",
      "transport_protocol": "UDP",
      "default_on_hold_comfort_noise_enabled": true,
      "dtmf_type": "RFC 2833",
      "encode_contact_header_enabled": true,
      "encrypted_media": "SRTP",
      "onnet_t38_passthrough_enabled": true,
      "ios_push_credential_id": "ec0c8e5d-439e-4620-a0c1-9d9c8d02a836",
      "android_push_credential_id": "06b09dfd-7154-4980-8b75-cebf7a9d4f8e",
      "webhook_event_url": "https://example.com",
      "webhook_event_failover_url": "https://failover.example.com",
      "webhook_api_version": "1",
      "webhook_timeout_secs": 25,
      "call_cost_in_webhooks": true,
      "rtcp_settings": {
        "port": "rtcp-mux",
        "capture_enabled": true,
        "report_frequency_secs": 10
      },
      "tags": [
        "tag1",
        "tag2"
      ],
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "inbound": {
        "ani_number_format": "+E.164",
        "dnis_number_format": "+e164",
        "codecs": [
          "G722"
        ],
        "default_primary_ip_id": "192.0.2.1",
        "default_secondary_ip_id": "198.51.100.1",
        "default_tertiary_ip_id": "203.0.113.1",
        "default_routing_method": "sequential",
        "channel_limit": 10,
        "generate_ringback_tone": true,
        "isup_headers_enabled": true,
        "prack_enabled": true,
        "sip_compact_headers_enabled": true,
        "sip_region": "US",
        "sip_subdomain": "string",
        "sip_subdomain_receive_settings": "only_my_connections",
        "timeout_1xx_secs": 10,
        "timeout_2xx_secs": 10,
        "shaken_stir_enabled": true
      },
      "outbound": {
        "call_parking_enabled": true,
        "ani_override": "string",
        "ani_override_type": "always",
        "channel_limit": 10,
        "instant_ringback_enabled": true,
        "generate_ringback_tone": true,
        "localization": "string",
        "t38_reinvite_source": "customer",
        "tech_prefix": "string",
        "ip_authentication_method": "token",
        "ip_authentication_token": "string",
        "outbound_voice_profile_id": "1293384261075731499"
      }
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
filter
object

Consolidated filter parameter (deepObject style). Originally: filter[connection_name], filter[fqdn], filter[outbound_voice_profile_id], filter[outbound.outbound_voice_profile_id]

​
page
object

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

​
sort
enum<string>
default:created_at

Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/> That is: <ul>

<li> <code>connection_name</code>: sorts the result by the <code>connection_name</code> field in ascending order. </li> <li> <code>-connection_name</code>: sorts the result by the <code>connection_name</code> field in descending order. </li> </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order.
Available options:
created_at,
connection_name,
active
Example:

"connection_name"

Response

Successful response with a list of IP connections.

​
data
Ip Connection · object[]
​
meta
object