v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
IP Connections

Retrieve an Ip connection

Retrieves the details of an existing ip connection.

get/ip_connections/{id}

Path parameters

idstring required

IP Connection ID

Response

Successful response with details about an IP connection.

Example response

{
  "data": {
    "active": true,
    "anchorsite_override": "Latency",
    "android_push_credential_id": "06b09dfd-7154-4980-8b75-cebf7a9d4f8e",
    "call_cost_in_webhooks": true,
    "connection_name": "string",
    "created_at": "2018-02-02T22:25:27.521Z",
    "default_on_hold_comfort_noise_enabled": true,
    "dtmf_type": "RFC 2833",
    "encode_contact_header_enabled": true,
    "encrypted_media": "SRTP",
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "inbound": {
      "ani_number_format": "+E.164",
      "channel_limit": 10,
      "codecs": [
        "G722"
      ],
      "default_primary_ip_id": "192.0.2.1",
      "default_routing_method": "sequential",
      "default_secondary_ip_id": "198.51.100.1",
      "default_tertiary_ip_id": "203.0.113.1",
      "dnis_number_format": "+e164",
      "generate_ringback_tone": true,
      "isup_headers_enabled": true,
      "prack_enabled": true,
      "shaken_stir_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
    },
    "ios_push_credential_id": "ec0c8e5d-439e-4620-a0c1-9d9c8d02a836",
    "jitter_buffer": {
      "enable_jitter_buffer": true,
      "jitterbuffer_msec_max": 200,
      "jitterbuffer_msec_min": 60
    },
    "noise_suppression": "both",
    "noise_suppression_details": {
      "attenuation_limit": 80,
      "engine": "deep_filter_net"
    },
    "onnet_t38_passthrough_enabled": true,
    "outbound": {
      "ani_override": "string",
      "ani_override_type": "always",
      "call_parking_enabled": true,
      "channel_limit": 10,
      "generate_ringback_tone": true,
      "instant_ringback_enabled": true,
      "ip_authentication_method": "token",
      "ip_authentication_token": "string",
      "localization": "string",
      "outbound_voice_profile_id": "1293384261075731499",
      "t38_reinvite_source": "customer",
      "tech_prefix": "string"
    },
    "record_type": "ip_connection",
    "rtcp_settings": {
      "capture_enabled": true,
      "port": "rtcp-mux",
      "report_frequency_secs": 10
    },
    "tags": [
      "tag1",
      "tag2"
    ],
    "transport_protocol": "UDP",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "webhook_api_version": "1",
    "webhook_event_failover_url": "https://failover.example.com",
    "webhook_event_url": "https://example.com",
    "webhook_timeout_secs": 25
  }
}