List credential connections

gethttps://api.telnyx.com/v2/credential_connections

Returns a list of your credential connections.

curl -X GET \ --header "Content-Type: application/json" \ --header "Accept: application/json" \ --header "Authorization: Bearer YOUR_API_KEY" \ --globoff "https://api.telnyx.com/v2/credential_connections?page[number]=1&page[size]=20"

Parameters

In Query
page[number]
integer
(1)
optional
The page number to load
Default:
1
page[size]
integer
(1 - 250)
optional
The size of the page
Default:
20
filter[connection_name][contains]
string
optional
If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
filter[outbound.outbound_voice_profile_id]
string
(int64)
optional
Identifies the associated outbound voice profile.
Example: "1293384261075731499"
sort
string
optional
Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

That is:
  • connection_name: sorts the result by the connection_name field in ascending order.
  • -connection_name: sorts the result by the connection_name field in descending order.

If not given, results are sorted by created_at in descending order.
Default:
"created_at"
Example: "connection_name"Options: [ "created_at", "connection_name", "active" ]

Responses

200
Successful response with a list of credential connections.
400
Bad request
401
Unauthorized
404
Resource not found

Success Response

{
  "data": {
    "active": true,
    "anchorsite_override": "Latency",
    "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"
      ],
      "dnis_number_format": "+e164",
      "generate_ringback_tone": true,
      "isup_headers_enabled": true,
      "prack_enabled": true,
      "privacy_zone_enabled": true,
      "sip_compact_headers_enabled": true,
      "timeout_1xx_secs": 10,
      "timeout_2xx_secs": "15"
    },
    "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,
      "localization": "string",
      "outbound_voice_profile_id": "1293384261075731499",
      "t38_reinvite_source": "telnyx"
    },
    "password": "my123secure456password789",
    "record_type": "credential_connection",
    "rtcp_settings": {
      "capture_enabled": true,
      "port": "rtp+1",
      "report_frequency_seconds": 10
    },
    "sip_uri_calling_preference": "disabled",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "user_name": "myusername123",
    "webhook_api_version": "1",
    "webhook_event_failover_url": "https://failover.example.com",
    "webhook_event_url": "https://example.com",
    "webhook_timeout_secs": 25
  },
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

...

posthttps://api.telnyx.com/v2/credential_connections

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/credential_connections/{id}

...

...

Parameters

Responses

Success Response

...

patchhttps://api.telnyx.com/v2/credential_connections/{id}

...

...

Parameters

Responses

Success Response

...

deletehttps://api.telnyx.com/v2/credential_connections/{id}

...

...

Parameters

Responses

Success Response

Was this page helpful?