List Supported Providers

Discover available telephony providers and the credential fields each one requires

1 min read

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

Request example

curl --request GET \
  --url https://voice.menaceui.com/api/v1/organizations/telephony-providers/metadata \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>'

Response

{
  "providers": [
    {
      "provider": "<string>",
      "display_name": "<string>",
      "connectivity": "api",
      "fields": [
        {
          "name": "<string>",
          "label": "<string>",
          "type": "<string>",
          "required": true,
          "sensitive": true,
          "description": "<string>",
          "placeholder": "<string>",
          "options": [
            {
              "value": "<string>",
              "label": "<string>"
            }
          ],
          "visible_when": {
            "field": "<string>",
            "equals": null
          },
          "section": "<string>"
        }
      ],
      "docs_url": "<string>",
      "estimated_phone_number_price": "<string>",
      "phone_number_url": "<string>",
      "pricing_url": "<string>"
    }
  ]
}

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

Use this endpoint to discover which telephony providers Menace Voice 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.

Headers

authorizationstring · null#

X-API-Keystring · null#

Responses

application/json

Successful Response

providersobject[]required#

Show child attributes

providerstringrequired#

display_namestringrequired#

connectivityenum<string>#

Default: "api"

Options:apisip

fieldsobject[]required#

Show child attributes

namestringrequired#

labelstringrequired#

typestringrequired#

requiredbooleanrequired#

sensitivebooleanrequired#

descriptionstring · null#

Show child attributes

Any of

placeholderstring · null#

Show child attributes

Any of

optionsobject[] · null#

Show child attributes

Any of

valuestringrequired#

labelstringrequired#

visible_whenobject · null#

Show child attributes

Any of

fieldstringrequired#

equalsanyrequired#

sectionstring · null#

Show child attributes

Any of

docs_urlstring · null#

Show child attributes

Any of

estimated_phone_number_pricestring · null#

Show child attributes

Any of

phone_number_urlstring · null#

Show child attributes

Any of

pricing_urlstring · null#

Show child attributes

Any of

Overview List Configurations