Create Configuration

Create a new telephony configuration

1 min read

post/api/v1/organizations/telephony-configs

Request example

curl --request POST \
  --url https://voice.menaceui.com/api/v1/organizations/telephony-configs \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "is_default_outbound": false,
  "config": {
    "provider": "ari",
    "ari_endpoint": "<string>",
    "app_name": "<string>",
    "app_password": "<string>",
    "ws_client_name": "",
    "external_pbx": {
      "type": "vicidial",
      "agent_api": {
        "url": "<string>",
        "username": "<string>",
        "password": "<string>",
        "source": "dograh"
      },
      "non_agent_api": {
        "url": "<string>",
        "username": "<string>",
        "password": "<string>",
        "source": "dograh"
      },
      "timeout_seconds": 8
    }
  }
}'

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"
}

post/api/v1/organizations/telephony-configs

Call List Supported Providers first to discover the credential fields for the provider you want to configure — they vary per provider.

Configuration name must be unique within your organization. Set is_default_outbound: true to mark this configuration as the org-wide default for outbound calls (any existing default is unset). New configurations have no phone numbers; add them via Add a phone number.

Headers

authorizationstring · null#

X-API-Keystring · null#

Body

application/json

namestringrequired#

Length: 1–64

is_default_outboundboolean#

Default: false

configobjectrequired#

Show child attributes

One of

providerenum<string>#

Default: "ari"

Options:ari

ari_endpointstringrequired#

ARI base URL (e.g., http://asterisk.example.com:8088)

app_namestringrequired#

ARI username, matching the ari.conf section name

app_passwordstringrequired#

ARI user password

ws_client_namestring#

websocket_client.conf connection name for externalMedia (e.g., dograh_staging)

Default: ""

external_pbxobject · null#

Optional external PBX connected through this Asterisk instance

Show child attributes

providerenum<string>#

Default: "cloudonix"

Options:cloudonix

bearer_tokenstringrequired#

Cloudonix API Bearer Token

domain_idstringrequired#

Cloudonix domain name

webhook_secretstring · null#

Webhook bearer secret, distinct from the Cloudonix API token. Saving synchronizes the domain profile authorization-api-key.

Show child attributes

application_namestring · null#

Cloudonix Voice Application name. The application's url is updated when inbound workflows are attached to numbers on this domain. If omitted, an application is auto-created on save and its name is stored on the configuration.

Show child attributes

providerenum<string>#

Default: "plivo"

Options:plivo

auth_idstringrequired#

Plivo Auth ID

auth_tokenstringrequired#

Plivo Auth Token

application_idstring · null#

Plivo Application ID. The application's answer_url is updated when inbound workflows are attached to numbers on this account. If omitted, an application is auto-created on save and its id is stored on the configuration.

Show child attributes

providerenum<string>#

Default: "telnyx"

Options:telnyx

api_keystringrequired#

Telnyx API Key

connection_idstring · null#

Telnyx Call Control Application ID (connection_id). If omitted, a Call Control Application is auto-created on save and its id is stored on the configuration.

Show child attributes

webhook_public_keystring · null#

Webhook public key from Mission Control Portal → Keys & Credentials → Public Key. Used to verify Telnyx webhook signatures.

Show child attributes

providerenum<string>#

Default: "twilio"

Options:twilio

account_sidstringrequired#

Twilio Account SID

auth_tokenstringrequired#

Twilio Auth Token

amd_enabledboolean#

Detect whether outbound calls are answered by a person or machine. Twilio may bill AMD as an additional per-call feature.

Default: false

providerenum<string>#

Default: "vobiz"

Options:vobiz

auth_idstringrequired#

Vobiz Account ID (e.g., MA_SYQRLN1K)

auth_tokenstringrequired#

Vobiz Auth Token

application_idstring · null#

Vobiz Application ID. The application's answer_url is updated when inbound workflows are attached to numbers on this account. If omitted, an application is auto-created on save and its id is stored on the configuration.

Show child attributes

providerenum<string>#

Default: "vonage"

Options:vonage

api_keystringrequired#

Vonage API Key

api_secretstringrequired#

Vonage API Secret

application_idstringrequired#

Vonage Application ID

private_keystringrequired#

Private key for JWT generation

signature_secretstring · null#

Vonage signature secret used to verify signed webhooks

Show child attributes

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#

List Configurations Get Configuration