List connections

GET 
/connections

Returns a list of your connections irrespective of type.

Request

Query Parameters

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load

page[size] integer

Possible values: >= 1 and <= 250

Default value: 250

The size of the page

filter[connection_name][contains] string

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_voice_profile_id] int64

Identifies the associated outbound voice profile.

sort string
Possible values: [created_at, connection_name, active]
Default value: created_at
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.

Responses

200: Successful response with a list of connections.

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

id int64

Identifies the specific resource.

record_type string

Identifies the type of the resource.

active boolean

Defaults to true

anchorsite_override Anchorsite Override (string)

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.

connection_name string

created_at string

ISO 8601 formatted date indicating when the resource was created.

updated_at string

ISO 8601 formatted date indicating when the resource was updated.

webhook_event_url urlnullable

The URL where webhooks related to this connection will be sent.

webhook_event_failover_url urlnullable

The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails.

webhook_api_version string

Possible values: [1, 2]

Default value: 1

Determines which webhook format will be used, Telnyx API v1 or v2.

outbound_voice_profile_id int64

Identifies the associated outbound voice profile.

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "ip_connection",
      "active": true,
      "anchorsite_override": "Latency",
      "connection_name": "string",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "webhook_event_url": "https://example.com",
      "webhook_event_failover_url": "https://failover.example.com",
      "webhook_api_version": "1",
      "outbound_voice_profile_id": "1293384261075731499"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

400: Bad request, the request was unacceptable, often due to missing a required parameter.

application/json

• Schema
• Example (from schema)
• missingParameter

Schema

errors

object[]

Array [

code string

detail string

meta

object

url uri

title string

source

object

pointer string

]

{
  "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

errors

object[]

Array [

code string

detail string

meta

object

url uri

title string

source

object

pointer string

]

{
  "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

errors

object[]

Array [

code string

detail string

meta

object

url uri

title string

source

object

pointer string

]

{
  "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": "/"
      }
    }
  ]
}

Loading...