Skip to content

telephony.providers

Providers and what each needs.

Use this endpoint to discover which telephony providers Decibyl supports and the exact credential fields each one expects. The response drives the configuration form in the dashboard, and is the recommended way to build a provider-agnostic integration.

Reference

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

Auth
API key in X-API-Key
Content
none
Returns
200 · TelephonyProvidersMetadataResponse

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.

Arguments

This method takes no arguments.

Example request

curl -X GET "https://api.decibyl.ai/api/v1/organizations/telephony-providers/metadata" \
  -H "X-API-Key: dcb_your_key"

Response

{
  "providers": [
    {
      "provider": "string",
      "display_name": "string",
      "fields": [
        {}
      ],
      "docs_url": "string"
    }
  ]
}

Errors

StatusWhen
404Not found
422Validation Error