List connections

v1.0.0

Returns a list of your connections irrespective of type.

Input

{
  "type": "object",
  "properties": {
    "filter[connection_name][contains]": {
      "type": "string"
    },
    "filter[outbound_voice_profile_id]": {
      "type": "string",
      "format": "int64"
    },
    "page[number]": {
      "type": "integer"
    },
    "page[size]": {
      "type": "integer"
    },
    "sort": {
      "type": "string",
      "enum": [
        "created_at",
        "connection_name",
        "active"
      ]
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "active": {
            "type": "boolean",
            "description": "Defaults to true"
          },
          "anchorsite_override": {
            "type": "string",
            "description": "`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.",
            "enum": [
              "Latency",
              "Chicago, IL",
              "Ashburn, VA",
              "San Jose, CA",
              "Sydney, Australia",
              "Amsterdam, Netherlands",
              "London, UK",
              "Toronto, Canada",
              "Vancouver, Canada",
              "Frankfurt, Germany"
            ]
          },
          "connection_name": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "description": "ISO 8601 formatted date indicating when the resource was created."
          },
          "id": {
            "type": "string",
            "format": "int64",
            "description": "Identifies the specific resource."
          },
          "outbound_voice_profile_id": {
            "type": "string",
            "format": "int64",
            "description": "Identifies the associated outbound voice profile."
          },
          "record_type": {
            "type": "string",
            "description": "Identifies the type of the resource."
          },
          "updated_at": {
            "type": "string",
            "description": "ISO 8601 formatted date indicating when the resource was updated."
          },
          "webhook_api_version": {
            "type": "string",
            "description": "Determines which webhook format will be used, Telnyx API v1 or v2.",
            "enum": [
              "1",
              "2"
            ]
          },
          "webhook_event_failover_url": {
            "type": "string",
            "format": "url",
            "description": "The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails."
          },
          "webhook_event_url": {
            "type": "string",
            "format": "url",
            "description": "The URL where webhooks related to this connection will be sent."
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "page_number": {
          "type": "integer"
        },
        "page_size": {
          "type": "integer"
        },
        "total_pages": {
          "type": "integer"
        },
        "total_results": {
          "type": "integer"
        }
      }
    }
  }
}