Skip to main content
GET
/
v2
/
mobile_voice_connections
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const mobileVoiceConnection of client.mobileVoiceConnections.list()) {
  console.log(mobileVoiceConnection.id);
}
{
  "data": [
    {
      "id": "<string>",
      "record_type": "mobile_voice_connection",
      "active": true,
      "connection_name": "<string>",
      "tags": [
        "<string>"
      ],
      "webhook_event_url": "<string>",
      "webhook_event_failover_url": "<string>",
      "webhook_api_version": "1",
      "webhook_timeout_secs": 123,
      "outbound": {
        "channel_limit": 123,
        "outbound_voice_profile_id": "<string>"
      },
      "inbound": {
        "channel_limit": 123
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "total_pages": 123,
    "page_number": 123,
    "total_results": 123,
    "page_size": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page[number]
integer

The page number to load

page[size]
integer

The size of the page

filter[connection_name][contains]
string

Filter by connection name containing the given string

sort
string

Sort by field (e.g., created_at, connection_name, active). Prefix with - for descending order.

Response

Successful response

data
object[]
meta
object