Retrieve a SIPREC connector

GET 
/siprec_connectors/:connector_name

Returns details of a stored SIPREC connector.

Path Parameters

connector_name stringrequired

Uniquely identifies a SIPREC connector.

200: Return details of the SIPREC connector.

application/json

• Schema
• Example (from schema)

Schema

data

object

required

record_type string

name string

Name for the SIPREC connector resource.

host string

Hostname/IPv4 address of the SIPREC SRS.

port integer

Port for the SIPREC SRS.

app_subdomain string

Subdomain to route calls when using Telnyx SRS (optional).

created_at string

ISO 8601 formatted date/time of creation.

updated_at string

ISO 8601 formatted date/time of last update.

{
  "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"
  }
}

default: Unexpected error.

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code int32required

title stringrequired

detail string

source

object

pointer string

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta

object

property name* any

]

{
  "errors": [
    {
      "code": 0,
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/siprec_connectors/:connector_name' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "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": 0,
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}