Skip to main content

Retrieve a connection

GET 
/security/connections/:id

Retrieves the details of an existing connection.

Request​

Path Parameters

    id stringrequired

    Connection ID

Responses​

200: success

Schema

    id stringrequired
    connection_name stringrequired
    tech_prefix stringrequired

    Numerical chars only, exactly 4 characters.

    authentication_type integerrequired

    Default value: 1

    Unspecified = 1, IP Auth = 2, Credential Auth = 3

    active booleanrequired

    Defaults to true

    dnis_number_format integerrequired

    Default value: 1

    0 = E.164
    1 = Strip-1
    2 = Strip-2

    timeout_1xx stringrequired

    Time(sec) before aborting if connection is not made (min: 1, max: 20).

    timeout_2xx stringrequired

    Time(sec) before aborting if call is unanswered (min: 1, max: 600).

    forward_only booleanrequired

    Every Telnyx user automatically gets and only one forward-only connection. This
    is useful for setting up call forwarding on Telnyx numbers.

    ani_override_type string

    Possible values: [always, normal, emergency]

    Default value: always

    Specifies when we apply your ani_override setting. Only applies when ani_override is not blank.

    ani_override string

    Set a phone number as the ani_override value to override caller id number on outbound calls.

    registration_status integer

    Default value: 0

    0 = Not Applicable
    1 = Not Registered
    2 = Failed
    3 = Expired
    4 = Success
    5 = Unregistered

    last_registered_ip string

    IP from the last successful registration attempt.

    registration_status_updated_at string
    sip_compact_headers_enabled booleanrequired

    Default value: true

    Defaults to true.

    transport_protocol stringrequired

    Default value: UDP

    One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication.

    third_party_control_enabled booleanrequired

    Applies to calls sent TO this connection.

    privacy_zone_enabled booleanrequired

    By default, Telnyx does not send caller-id information when the caller has chosen to hide this information. When this option is enabled, Telnyx will send the SIP header Privacy:id plus the caller-id information so that the receiver side can choose when to hide it.

    codecs string[]required

    Default value: G722,G711U,G711A,G729,OPUS,H.264

    Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP.

    prack_enabled boolean

    Enable PRACK messages as defined in RFC3262.

    default_routing_method string

    Possible values: [sequential, round-robin]

    Default routing method to be used when a number is associated with the connection. Must be one of the routing method types or left blank, other values are not allowed.

    default_primary_authorized_ip_id integer

    The default primary IP to use for the number. Only settable if the connection is of IP authentication type. Value must be the ID of an authorized IP set on the connection.

    default_secondary_authorized_ip_id integer

    The default secondary IP to use for the number. Only settable if the connection is of IP authentication type. Value must be the ID of an authorized IP set on the connection.

    default_tertiary_authorized_ip_id integer

    The default tertiary IP to use for the number. Only settable if the connection is of IP authentication type. Value must be the ID of an authorized IP set on the connection.

    anchorsite_override string

    Possible values: [Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada]

    Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

    encrypted_media stringrequired

    Possible values: [SRTP, ZRTP]

    Enable use of SRTP or ZRTP for encryption. Valid values are those listed or null. Cannot be set to non-null if the transport_portocol is TLS.

    call_failure_check_enabled boolean

    Disable connection IPs temporarily after call timeout or rejection

    instant_ringback_enabled boolean

    Default value: true

    When set, ringback will not wait for indication before sending ringback tone to calling party.

    t38_reinvite_source string

    Possible values: [telnyx, customer, disabled, passthru, caller-passthru, callee-passthru]

    Default value: telnyx

    This setting only affects connections with Fax-type Outbound Profiles. The setting dictates whether or not Telnyx sends a t.38 reinvite.

    By default, Telnyx will send the re-invite. If set to customer, the caller is expected to send the t.38 reinvite.

    ani_number_format string

    Possible values: [+E.164, E.164, +E.164-national, E.164-national]

    Default value: E.164-national

    This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls.

    isup_headers_enabled boolean

    Possible values: [true, false]

    When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.)

    encode_contact_header_enabled boolean

    Possible values: [true, false]

    Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.

    inbound_generate_ringback_tone boolean

    Possible values: [true, false]

    Generate ringback tone through 183 session progress message with early media.

    outbound_generate_ringback_tone boolean

    Possible values: [true, false]

    Generate ringback tone through 183 session progress message with early media.

    rtcp_report_enabled boolean

    Default value: true

    DEPRECATED - RTCP reports are always sent to customers/vendors. For backwards compatibility, the value is always true.

    rtcp_report_frequency_seconds integer

    Default value: 10

    RTCP reports are sent to customers based on the frequency set. Frequency is in seconds and it can be set to values from 5 to 3000 seconds.

    rtcp_port

    Possible values: [rtcp-mux, rtp+1]

    Default value: rtp+1

    RTCP port by default is rtp+1, it can also be set to rtcp-mux

    dtmf_type string

    Possible values: [RFC 2833, Inband, SIP INFO]

    Default value: RFC 2833

    Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.

    outbound_localization string

    A 2-character country code specifying the country whose national dialing rules should be used. For example, if set to US then any US number can be dialed without preprending +1 to the number. When left blank, Telnyx will try US and GB dialing rules, in that order, by default.

    inbound_channel_limit integer

    When set, this will limit the total number of inbound calls to phone numbers associated with this connection.

    outbound_channel_limit integer

    When set, this will limit the total number of outbound calls to phone numbers associated with this connection.

    onnet_t38_passthrough_enabled integer

    Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings.

    sip_region string

    Possible values: [US, Europe, Australia]

    Default value: US

    Selects which sip_region to receive inbound calls from. If null, the default region (US) will be used.

    sip_uri_calling_preference string

    Possible values: [disabled, unrestricted, internal]

    Default value: disabled

    This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI @telnyx.com will be connected to your Connection. You can also choose to allow only calls that are originated on any Connections under your account (internal).

    sip_subdomain string

    Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.

    sip_subdomain_receive_settings string

    Possible values: [only_my_connections, from_anyone]

    This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in the public Internet) or "Only my connections" (any connection assigned to the same Telnyx user).

    webhook_api_version string

    Possible values: [1, 2]

    Default value: 1

    Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 2010-04-01 format.

400: Bad request

401: Unauthorized

404: Resource not found

Loading...