Skip to main content
GET
/
telephony_credentials
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 telephonyCredential of client.telephonyCredentials.list()) {
  console.log(telephonyCredential.id);
}
import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
page = client.telephony_credentials.list()
page = page.data[0]
print(page.id)
package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.TelephonyCredentials.List(context.TODO(), telnyx.TelephonyCredentialListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}
package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialListPage;
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        TelephonyCredentialListPage page = client.telephonyCredentials().list();
    }
}
require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

page = telnyx.telephony_credentials.list

puts(page)
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->telephonyCredentials->list(
    filter: [
      'name' => 'name',
      'resourceID' => 'resource_id',
      'sipUsername' => 'sip_username',
      'status' => 'status',
      'tag' => 'tag',
    ],
    pageNumber: 0,
    pageSize: 0,
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}
telnyx telephony-credentials list \
  --api-key 'My API Key'
curl --request GET \
  --url https://api.telnyx.com/v2/telephony_credentials \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "c215ade3-0d39-418e-94be-c5f780760199",
      "record_type": "credential",
      "name": "2020-06-18 21:32:38.917732Z",
      "expired": false,
      "user_id": "user-id",
      "resource_id": "connection:804252963366242252",
      "sip_password": "a92dbcfb60184a8cb330b0acb2f7617b",
      "sip_username": "gencrednCvHU5IYpSBPPsXI2iQsDX",
      "created_at": "2020-06-18T21:32:38",
      "expires_at": "2042-06-18T21:32:38",
      "updated_at": "2020-06-18T21:32:38.000Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
object

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

​
filter
object

Consolidated filter parameter (deepObject style). Originally: filter[tag], filter[name], filter[status], filter[resource_id], filter[sip_username]

Response

Successful response with multiple credentials

​
data
On-demand Credential · object[]
​
meta
object