Skip to main content

List Supported Providers

GET/api/v1/organizations/telephony-providers/metadata

Return the list of available telephony providers and their form schemas. The UI uses this to render the configuration form generically instead of hard-coding fields per provider. Adding a new provider only requires declaring its ui_metadata in providers/<name>/__init__.py.

cURL example

curl -X GET \
  'https://app.intracord.hu/api/v1/organizations/telephony-providers/metadata' \
  -H "X-API-Key: $INTRACORD_API_KEY"

Parameters

NameLocationTypeDescription
authorizationheaderobject
X-API-Keyheaderobject

Responses

200Successful Response
application/json
View schema
{
  "properties": {
    "providers": {
      "items": {
        "$ref": "#/components/schemas/TelephonyProviderMetadata"
      },
      "type": "array",
      "title": "Providers"
    }
  },
  "type": "object",
  "required": [
    "providers"
  ],
  "title": "TelephonyProvidersMetadataResponse",
  "description": "List of UI form definitions used by the telephony-config screen."
}
404Not found
422Validation Error
application/json
View schema
{
  "properties": {
    "detail": {
      "items": {
        "$ref": "#/components/schemas/ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}