Get Telephony Providers Metadata

GET /api/v1/organizations/telephony-providers/metadata — request parameters and responses from the Menace Voice API schema.

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

See authentication for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

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

Generate a presigned URL for direct CSV upload Get Telephony Config Warnings