Retrieve a credential connection
GET/credential_connections/:id
Retrieves the details of an existing credential connection.
Request
Path Parameters
Identifies the resource.
Responses
200: Successful response with details about a credential connection.
- application/json
- Schema
- Example (from schema)
Schema
data
object
Identifies the type of resource.
Identifies the type of the resource.
Defaults to true
The user name to be used as part of the credentials. Must be 4-32 characters long and alphanumeric values only (no spaces or special characters).
The password to be used as part of the credentials. Must be 8 to 128 characters long.
ISO-8601 formatted date indicating when the resource was created.
ISO-8601 formatted date indicating when the resource was updated.
Possible values: [Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany]
Default value: Latency
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.
Possible values: [disabled, unrestricted, internal]
This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI
Default value: true
When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout.
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.
Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.
Possible values: [SRTP]
Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TLS.
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.
The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.
Possible values: [1, 2]
Default value: 1
Determines which webhook format will be used, Telnyx API v1 or v2.
Possible values: <= 30
Specifies how many seconds to wait before timing out a webhook.
rtcp_settings
object
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
BETA - Enable the capture and storage of RTCP messages to create QoS reports on the Telnyx Mission Control Portal.
Default value: 5
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.
inbound
object
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.
Possible values: [+e164, e164, national, sip_username]
Default value: e164
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.
When set, this will limit the total number of inbound calls to phone numbers associated with this connection.
Generate ringback tone through 183 session progress message with early media.
When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.)
Enable PRACK messages as defined in RFC3262.
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.
Default value: true
Defaults to true.
Possible values: >= 1 and <= 120
Default value: 3
Time(sec) before aborting if connection is not made.
Possible values: >= 1 and <= 600
Default value: 90
Time(sec) before aborting if call is unanswered (min: 1, max: 600).
When enabled the SIP Connection will receive the Identity header with Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP transport.
outbound
object
Forces all SIP calls originated on this connection to be "parked" instead of "bridged" to the destination specified on the URI. Parked calls will return ringback to the caller and will await for a Call Control command to define which action will be taken next.
Set a phone number as the ani_override value to override caller id number on outbound calls.
Possible values: [always, normal, emergency]
Default value: always
Specifies when we apply your ani_override setting. Only applies when ani_override is not blank.
When set, this will limit the total number of outbound calls to phone numbers associated with this connection.
Default value: true
When set, ringback will not wait for indication before sending ringback tone to calling party.
Generate ringback tone through 183 session progress message with early media.
Default value: US
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.
Possible values: [telnyx, customer, disabled, passthru, caller-passthru, callee-passthru]
Default value: telnyx
This setting only affects connections with Fax-type Outbound Voice 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.
Identifies the associated outbound voice profile.
{
"data": {
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "credential_connection",
"active": true,
"user_name": "myusername123",
"password": "my123secure456password789",
"created_at": "2018-02-02T22:25:27.521Z",
"updated_at": "2018-02-02T22:25:27.521Z",
"anchorsite_override": "Latency",
"connection_name": "string",
"sip_uri_calling_preference": "disabled",
"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,
"rtcp_settings": {
"port": "rtp+1",
"capture_enabled": true,
"report_frequency_seconds": 10
},
"inbound": {
"ani_number_format": "+E.164",
"dnis_number_format": "+e164",
"codecs": [
"G722"
],
"channel_limit": 10,
"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",
"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": "telnyx",
"outbound_voice_profile_id": "1293384261075731499"
}
}
}
400: Bad request, the request was unacceptable, often due to missing a required parameter.
- application/json
- Schema
- Example (from schema)
- missingParameter
Schema
Array [
]
errors
object[]
meta
object
source
object
{
"errors": [
{
"code": "string",
"detail": "string",
"meta": {
"url": "string"
},
"title": "string",
"source": {
"pointer": "string"
}
}
]
}
{
"errors": [
{
"code": "10015",
"title": "Bad Request",
"detail": "The request failed because it was not well-formed.",
"source": {
"pointer": "/"
},
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10015"
}
}
]
}
401: Unauthorized
- application/json
- Schema
- Example (from schema)
- Authentication Failed
Schema
Array [
]
errors
object[]
meta
object
source
object
{
"errors": [
{
"code": "string",
"detail": "string",
"meta": {
"url": "string"
},
"title": "string",
"source": {
"pointer": "string"
}
}
]
}
{
"errors": [
{
"code": "10009",
"title": "Authentication failed",
"detail": "Could not understand the provided credentials.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10009"
}
}
]
}
403: The user doesn't have the required permissions to perform the requested action.
- application/json
- Schema
- Example (from schema)
- notAuthorized
Schema
Array [
]
errors
object[]
meta
object
source
object
{
"errors": [
{
"code": "string",
"detail": "string",
"meta": {
"url": "string"
},
"title": "string",
"source": {
"pointer": "string"
}
}
]
}
{
"errors": [
{
"code": "10010",
"title": "Not authorized",
"detail": "You are not authorized to access the requested resource.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10010"
},
"source": {
"pointer": "/"
}
}
]
}
404: The requested resource doesn't exist.
- application/json
- Schema
- Example (from schema)
- notFound
Schema
Array [
]
errors
object[]
meta
object
source
object
{
"errors": [
{
"code": "string",
"detail": "string",
"meta": {
"url": "string"
},
"title": "string",
"source": {
"pointer": "string"
}
}
]
}
{
"errors": [
{
"code": "10005",
"title": "Resource not found",
"detail": "The requested resource or URL could not be found.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10005"
},
"source": {
"pointer": "/"
}
}
]
}