Get Configuration

Retrieve a telephony configuration by id

1 min read

get/api/v1/organizations/telephony-configs/{config_id}

Request example

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

Response

{
  "id": 1,
  "name": "<string>",
  "provider": "<string>",
  "connectivity": "api",
  "is_default_outbound": true,
  "inactive": false,
  "inactive_since": "2026-08-10T12:00:00Z",
  "inactive_reason": "<string>",
  "credentials": {},
  "sip_connectivity": {
    "provider_display_name": "<string>",
    "regions": [
      {
        "region": "<string>",
        "inbound_transports": [
          {
            "transport": "<string>",
            "hostname": "<string>",
            "port": 1,
            "uri": "<string>"
          }
        ],
        "outbound_origin_ip": "<string>"
      }
    ]
  },
  "setup_checklist": {
    "ready_for_outbound": true,
    "outbound_blocked_reason": "<string>",
    "steps": [
      {
        "key": "<string>",
        "title": "<string>",
        "description": "<string>",
        "complete": true,
        "blocks_outbound": false
      }
    ],
    "docs_url": "<string>"
  },
  "supports_trunks": false,
  "trunks": [
    {
      "id": 1,
      "name": "<string>",
      "enabled": true,
      "settings": {},
      "phone_number_count": 0,
      "created_at": "2026-08-10T12:00:00Z",
      "updated_at": "2026-08-10T12:00:00Z"
    }
  ],
  "created_at": "2026-08-10T12:00:00Z",
  "updated_at": "2026-08-10T12:00:00Z"
}

get/api/v1/organizations/telephony-configs/{config_id}

Sensitive credential fields (API keys, auth tokens) are returned in masked form.

Path parameters

config_idintegerrequired#

Headers

authorizationstring · null#

X-API-Keystring · null#

Responses

application/json

Successful Response

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

credentialsobjectrequired#

sip_connectivityobject · null#

Show child attributes

Any of

provider_display_namestringrequired#

regionsobject[]required#

Show child attributes

regionstringrequired#

inbound_transportsobject[]required#

Show child attributes

transportstringrequired#

hostnamestringrequired#

portintegerrequired#

uristringrequired#

outbound_origin_ipstringrequired#

setup_checklistobject · null#

Show child attributes

Any of

ready_for_outboundbooleanrequired#

outbound_blocked_reasonstring · nullrequired#

Show child attributes

stepsobject[]required#

Show child attributes

keystringrequired#

titlestringrequired#

descriptionstringrequired#

completebooleanrequired#

blocks_outboundboolean#

Default: false

docs_urlstring · null#

Show child attributes

supports_trunksboolean#

Default: false

trunksobject[]#

Show child attributes

idintegerrequired#

namestringrequired#

enabledbooleanrequired#

settingsobjectrequired#

phone_number_countinteger#

Default: 0

created_atstringrequired#

updated_atstringrequired#

created_atstringrequired#

updated_atstringrequired#

Create Configuration Update Configuration