Retrieve a SIPREC connector
Returns details of a stored SIPREC connector.
GET
/
siprec_connectors
/
{connector_name}
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const siprecConnector = await client.siprecConnectors.retrieve('connector_name');
console.log(siprecConnector.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
siprec_connector = client.siprec_connectors.retrieve(
"connector_name",
)
print(siprec_connector.data)
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"),
)
siprecConnector, err := client.SiprecConnectors.Get(context.TODO(), "connector_name")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", siprecConnector.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.siprecconnectors.SiprecConnectorRetrieveParams;
import com.telnyx.sdk.models.siprecconnectors.SiprecConnectorRetrieveResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
SiprecConnectorRetrieveResponse siprecConnector = client.siprecConnectors().retrieve("connector_name");
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
siprec_connector = telnyx.siprec_connectors.retrieve("connector_name")
puts(siprec_connector)<?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 {
$siprecConnector = $client->siprecConnectors->retrieve('connector_name');
var_dump($siprecConnector);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx siprec-connectors retrieve \
--api-key 'My API Key' \
--connector-name connector_namecurl --request GET \
--url https://api.telnyx.com/v2/siprec_connectors/{connector_name} \
--header 'Authorization: Bearer <token>'{
"data": {
"record_type": "siprec_connector",
"name": "siprec-connector",
"host": "siprec.telnyx.com",
"port": 5060,
"app_subdomain": "my-app-domain",
"created_at": "2024-01-23T18:10:02.574Z",
"updated_at": "2024-01-23T18:10:02.574Z"
}
}{
"errors": [
{
"code": 404,
"title": "Not Found",
"detail": "The requested resource does not exist"
}
]
}{
"errors": [
{
"code": 123,
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>"
},
"meta": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Uniquely identifies a SIPREC connector.
Response
Return details of the SIPREC connector.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const siprecConnector = await client.siprecConnectors.retrieve('connector_name');
console.log(siprecConnector.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
siprec_connector = client.siprec_connectors.retrieve(
"connector_name",
)
print(siprec_connector.data)
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"),
)
siprecConnector, err := client.SiprecConnectors.Get(context.TODO(), "connector_name")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", siprecConnector.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.siprecconnectors.SiprecConnectorRetrieveParams;
import com.telnyx.sdk.models.siprecconnectors.SiprecConnectorRetrieveResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
SiprecConnectorRetrieveResponse siprecConnector = client.siprecConnectors().retrieve("connector_name");
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
siprec_connector = telnyx.siprec_connectors.retrieve("connector_name")
puts(siprec_connector)<?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 {
$siprecConnector = $client->siprecConnectors->retrieve('connector_name');
var_dump($siprecConnector);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx siprec-connectors retrieve \
--api-key 'My API Key' \
--connector-name connector_namecurl --request GET \
--url https://api.telnyx.com/v2/siprec_connectors/{connector_name} \
--header 'Authorization: Bearer <token>'{
"data": {
"record_type": "siprec_connector",
"name": "siprec-connector",
"host": "siprec.telnyx.com",
"port": 5060,
"app_subdomain": "my-app-domain",
"created_at": "2024-01-23T18:10:02.574Z",
"updated_at": "2024-01-23T18:10:02.574Z"
}
}{
"errors": [
{
"code": 404,
"title": "Not Found",
"detail": "The requested resource does not exist"
}
]
}{
"errors": [
{
"code": 123,
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>"
},
"meta": {}
}
]
}