Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB
Provider

Get provider by ID

Retrieves the provider details for the specified ID.

get/providers/{id}

Path parameters

idstring required

The ID of the provider

Response

The details of the provider with the specified ID.

idstring uuid

The unique identifier of the provider. Returned from the POST /providers or GET /providers response.

type'sip'

Defines the type of the provider. Currently, only 'sip' is supported for VoIP/SIP providers.

hostnamestring

The destination hostname for the provider.

tech_prefixstring

The tech prefix, valid only for SIP type providers.

tech_postfixstring

The tech postfix, valid only for SIP type providers.

tech_headersobject

The tech headers, valid only for SIP type providers.

metadataobject nullable

Carrier-specific resource identifiers stored during automated setup. For Telnyx providers created via POST /providers/setup, contains telnyx_profile_id, telnyx_connection_id, and telnyx_ip_ids. Read-only — populated automatically by the setup endpoint. Empty object {} for providers created manually via POST /providers.

namestring

The name of the provider.

detailstring

The details about the provider.

codecsstring

Comma-separated codec list offered to this provider (e.g. "PCMU,PCMA"). Empty means server-default negotiation. Applied to outgoing PSTN dial attempts only; has no effect on SIP-to-SIP traffic.

health_status'unknown' | 'healthy' | 'unhealthy'

The health status of the provider as determined by periodic SIP OPTIONS probes.

health_checked_atstring date-time

The timestamp of the last successful health check probe.

tm_createstring date-time

The creation timestamp.

tm_updatestring date-time

The last update timestamp.

tm_deletestring date-time

The deletion timestamp.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "type": "sip",
  "hostname": "sip.provider.example.com",
  "tech_prefix": "9",
  "tech_postfix": "#",
  "tech_headers": {
    "X-Custom-Header": "value1"
  },
  "metadata": {
    "telnyx_profile_id": "2944757397136082899",
    "telnyx_connection_id": "2944757397198982899",
    "telnyx_ip_ids": [
      "2944757397261882899"
    ]
  },
  "name": "Twilio SIP Provider",
  "detail": "Primary outbound SIP provider",
  "codecs": "PCMU,PCMA",
  "health_status": "healthy",
  "health_checked_at": "2026-04-20T10:00:00.000000Z",
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-16T14:20:00.000000Z",
  "tm_delete": "2026-01-17T18:45:00.000000Z"
}