Create a SIPREC connector
Creates a new SIPREC connector configuration.
POST
/
siprec_connectors
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.create({
host: 'siprec.telnyx.com',
name: 'my-siprec-connector',
port: 5060,
});
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.create(
host="siprec.telnyx.com",
name="my-siprec-connector",
port=5060,
)
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.New(context.TODO(), telnyx.SiprecConnectorNewParams{
Host: "siprec.telnyx.com",
Name: "my-siprec-connector",
Port: 5060,
})
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.SiprecConnectorCreateParams;
import com.telnyx.sdk.models.siprecconnectors.SiprecConnectorCreateResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
SiprecConnectorCreateParams params = SiprecConnectorCreateParams.builder()
.host("siprec.telnyx.com")
.name("my-siprec-connector")
.port(5060L)
.build();
SiprecConnectorCreateResponse siprecConnector = client.siprecConnectors().create(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
siprec_connector = telnyx.siprec_connectors.create(host: "siprec.telnyx.com", name: "my-siprec-connector", port: 5060)
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->create(
host: 'siprec.telnyx.com',
name: 'my-siprec-connector',
port: 5060,
appSubdomain: 'my-app',
);
var_dump($siprecConnector);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx siprec-connectors create \
--api-key 'My API Key' \
--host siprec.telnyx.com \
--name my-siprec-connector \
--port 5060curl --request POST \
--url https://api.telnyx.com/v2/siprec_connectors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"host": "siprec.telnyx.com",
"port": 5060,
"name": "my-siprec-connector",
"app_subdomain": "my-app"
}
'{
"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": 422,
"title": "Unprocessable Entity",
"detail": "The request parameters failed validation"
}
]
}{
"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.
Body
application/json
The parameters required to create or update a SIPREC connector.
Hostname/IPv4 address of the SIPREC SRS.
Example:
"siprec.telnyx.com"
Port for the SIPREC SRS.
Example:
5060
Name for the SIPREC connector resource.
Example:
"my-siprec-connector"
Subdomain to route the call when using Telnyx SRS (optional for non-Telnyx SRS).
Example:
"my-app-domain"
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.create({
host: 'siprec.telnyx.com',
name: 'my-siprec-connector',
port: 5060,
});
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.create(
host="siprec.telnyx.com",
name="my-siprec-connector",
port=5060,
)
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.New(context.TODO(), telnyx.SiprecConnectorNewParams{
Host: "siprec.telnyx.com",
Name: "my-siprec-connector",
Port: 5060,
})
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.SiprecConnectorCreateParams;
import com.telnyx.sdk.models.siprecconnectors.SiprecConnectorCreateResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
SiprecConnectorCreateParams params = SiprecConnectorCreateParams.builder()
.host("siprec.telnyx.com")
.name("my-siprec-connector")
.port(5060L)
.build();
SiprecConnectorCreateResponse siprecConnector = client.siprecConnectors().create(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
siprec_connector = telnyx.siprec_connectors.create(host: "siprec.telnyx.com", name: "my-siprec-connector", port: 5060)
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->create(
host: 'siprec.telnyx.com',
name: 'my-siprec-connector',
port: 5060,
appSubdomain: 'my-app',
);
var_dump($siprecConnector);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx siprec-connectors create \
--api-key 'My API Key' \
--host siprec.telnyx.com \
--name my-siprec-connector \
--port 5060curl --request POST \
--url https://api.telnyx.com/v2/siprec_connectors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"host": "siprec.telnyx.com",
"port": 5060,
"name": "my-siprec-connector",
"app_subdomain": "my-app"
}
'{
"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": 422,
"title": "Unprocessable Entity",
"detail": "The request parameters failed validation"
}
]
}{
"errors": [
{
"code": 123,
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>"
},
"meta": {}
}
]
}