List Telephony Configurations

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

1 min read

get/api/v1/organizations/telephony-configs

Request example

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

Response

{
  "configurations": [
    {
      "id": 1,
      "name": "<string>",
      "provider": "<string>",
      "connectivity": "api",
      "is_default_outbound": true,
      "inactive": false,
      "inactive_since": "2026-08-10T12:00:00Z",
      "inactive_reason": "<string>",
      "phone_number_count": 0,
      "is_ready_for_outbound": true,
      "outbound_blocked_reason": "<string>",
      "created_at": "2026-08-10T12:00:00Z",
      "updated_at": "2026-08-10T12:00:00Z"
    }
  ]
}

get/api/v1/organizations/telephony-configs

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

configurationsobject[]required#

Show child attributes

idintegerrequired#

namestringrequired#

providerstringrequired#

connectivityenum<string>#

Default: "api"

Options:apisip

is_default_outboundbooleanrequired#

inactiveboolean#

Default: false

inactive_sincestring · null#

Show child attributes

Any of

inactive_reasonstring · null#

Show child attributes

Any of

phone_number_countinteger#

Default: 0

is_ready_for_outboundboolean#

Default: true

outbound_blocked_reasonstring · null#

Show child attributes

Any of

created_atstringrequired#

updated_atstringrequired#

Get Telephony Config Warnings Create Telephony Configuration