Create Configuration

Create Telephony Configuration

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

import requests

url = "https://app.dograh.com/api/v1/organizations/telephony-configs"

payload = {
    "name": "<string>",
    "config": {
        "ari_endpoint": "<string>",
        "app_name": "<string>",
        "app_password": "<string>",
        "provider": "ari",
        "ws_client_name": "",
        "dial_string_template": "PJSIP/{number}",
        "external_pbx": {
            "agent_api": {
                "url": "<string>",
                "username": "<string>",
                "password": "<string>",
                "source": "dograh"
            },
            "type": "vicidial",
            "non_agent_api": {
                "url": "<string>",
                "username": "<string>",
                "password": "<string>",
                "source": "dograh"
            },
            "timeout_seconds": 8
        }
    },
    "is_default_outbound": False
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    config: {
      ari_endpoint: '<string>',
      app_name: '<string>',
      app_password: '<string>',
      provider: 'ari',
      ws_client_name: '',
      dial_string_template: 'PJSIP/{number}',
      external_pbx: {
        agent_api: {url: '<string>', username: '<string>', password: '<string>', source: 'dograh'},
        type: 'vicidial',
        non_agent_api: {url: '<string>', username: '<string>', password: '<string>', source: 'dograh'},
        timeout_seconds: 8
      }
    },
    is_default_outbound: false
  })
};

fetch('https://app.dograh.com/api/v1/organizations/telephony-configs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.dograh.com/api/v1/organizations/telephony-configs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'config' => [
        'ari_endpoint' => '<string>',
        'app_name' => '<string>',
        'app_password' => '<string>',
        'provider' => 'ari',
        'ws_client_name' => '',
        'dial_string_template' => 'PJSIP/{number}',
        'external_pbx' => [
                'agent_api' => [
                                'url' => '<string>',
                                'username' => '<string>',
                                'password' => '<string>',
                                'source' => 'dograh'
                ],
                'type' => 'vicidial',
                'non_agent_api' => [
                                'url' => '<string>',
                                'username' => '<string>',
                                'password' => '<string>',
                                'source' => 'dograh'
                ],
                'timeout_seconds' => 8
        ]
    ],
    'is_default_outbound' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.dograh.com/api/v1/organizations/telephony-configs"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"config\": {\n    \"ari_endpoint\": \"<string>\",\n    \"app_name\": \"<string>\",\n    \"app_password\": \"<string>\",\n    \"provider\": \"ari\",\n    \"ws_client_name\": \"\",\n    \"dial_string_template\": \"PJSIP/{number}\",\n    \"external_pbx\": {\n      \"agent_api\": {\n        \"url\": \"<string>\",\n        \"username\": \"<string>\",\n        \"password\": \"<string>\",\n        \"source\": \"dograh\"\n      },\n      \"type\": \"vicidial\",\n      \"non_agent_api\": {\n        \"url\": \"<string>\",\n        \"username\": \"<string>\",\n        \"password\": \"<string>\",\n        \"source\": \"dograh\"\n      },\n      \"timeout_seconds\": 8\n    }\n  },\n  \"is_default_outbound\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.dograh.com/api/v1/organizations/telephony-configs")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"config\": {\n    \"ari_endpoint\": \"<string>\",\n    \"app_name\": \"<string>\",\n    \"app_password\": \"<string>\",\n    \"provider\": \"ari\",\n    \"ws_client_name\": \"\",\n    \"dial_string_template\": \"PJSIP/{number}\",\n    \"external_pbx\": {\n      \"agent_api\": {\n        \"url\": \"<string>\",\n        \"username\": \"<string>\",\n        \"password\": \"<string>\",\n        \"source\": \"dograh\"\n      },\n      \"type\": \"vicidial\",\n      \"non_agent_api\": {\n        \"url\": \"<string>\",\n        \"username\": \"<string>\",\n        \"password\": \"<string>\",\n        \"source\": \"dograh\"\n      },\n      \"timeout_seconds\": 8\n    }\n  },\n  \"is_default_outbound\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.dograh.com/api/v1/organizations/telephony-configs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"config\": {\n    \"ari_endpoint\": \"<string>\",\n    \"app_name\": \"<string>\",\n    \"app_password\": \"<string>\",\n    \"provider\": \"ari\",\n    \"ws_client_name\": \"\",\n    \"dial_string_template\": \"PJSIP/{number}\",\n    \"external_pbx\": {\n      \"agent_api\": {\n        \"url\": \"<string>\",\n        \"username\": \"<string>\",\n        \"password\": \"<string>\",\n        \"source\": \"dograh\"\n      },\n      \"type\": \"vicidial\",\n      \"non_agent_api\": {\n        \"url\": \"<string>\",\n        \"username\": \"<string>\",\n        \"password\": \"<string>\",\n        \"source\": \"dograh\"\n      },\n      \"timeout_seconds\": 8\n    }\n  },\n  \"is_default_outbound\": false\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "name": "<string>",
  "provider": "<string>",
  "is_default_outbound": true,
  "credentials": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "connectivity": "api",
  "inactive": false,
  "inactive_since": "2023-11-07T05:31:56Z",
  "inactive_reason": "<string>",
  "sip_connectivity": {
    "provider_display_name": "<string>",
    "regions": [
      {
        "region": "<string>",
        "inbound_transports": [
          {
            "transport": "<string>",
            "hostname": "<string>",
            "port": 123,
            "uri": "<string>"
          }
        ],
        "outbound_origin_ip": "<string>"
      }
    ]
  },
  "supports_outbound": true,
  "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": 123,
      "name": "<string>",
      "enabled": true,
      "settings": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "phone_number_count": 0
    }
  ],
  "supports_phone_number_sync": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

api

organizations

telephony-configs

Create Telephony Configuration

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

import requests

url = "https://app.dograh.com/api/v1/organizations/telephony-configs"

payload = {
    "name": "<string>",
    "config": {
        "ari_endpoint": "<string>",
        "app_name": "<string>",
        "app_password": "<string>",
        "provider": "ari",
        "ws_client_name": "",
        "dial_string_template": "PJSIP/{number}",
        "external_pbx": {
            "agent_api": {
                "url": "<string>",
                "username": "<string>",
                "password": "<string>",
                "source": "dograh"
            },
            "type": "vicidial",
            "non_agent_api": {
                "url": "<string>",
                "username": "<string>",
                "password": "<string>",
                "source": "dograh"
            },
            "timeout_seconds": 8
        }
    },
    "is_default_outbound": False
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    config: {
      ari_endpoint: '<string>',
      app_name: '<string>',
      app_password: '<string>',
      provider: 'ari',
      ws_client_name: '',
      dial_string_template: 'PJSIP/{number}',
      external_pbx: {
        agent_api: {url: '<string>', username: '<string>', password: '<string>', source: 'dograh'},
        type: 'vicidial',
        non_agent_api: {url: '<string>', username: '<string>', password: '<string>', source: 'dograh'},
        timeout_seconds: 8
      }
    },
    is_default_outbound: false
  })
};

fetch('https://app.dograh.com/api/v1/organizations/telephony-configs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.dograh.com/api/v1/organizations/telephony-configs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'config' => [
        'ari_endpoint' => '<string>',
        'app_name' => '<string>',
        'app_password' => '<string>',
        'provider' => 'ari',
        'ws_client_name' => '',
        'dial_string_template' => 'PJSIP/{number}',
        'external_pbx' => [
                'agent_api' => [
                                'url' => '<string>',
                                'username' => '<string>',
                                'password' => '<string>',
                                'source' => 'dograh'
                ],
                'type' => 'vicidial',
                'non_agent_api' => [
                                'url' => '<string>',
                                'username' => '<string>',
                                'password' => '<string>',
                                'source' => 'dograh'
                ],
                'timeout_seconds' => 8
        ]
    ],
    'is_default_outbound' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.dograh.com/api/v1/organizations/telephony-configs"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"config\": {\n    \"ari_endpoint\": \"<string>\",\n    \"app_name\": \"<string>\",\n    \"app_password\": \"<string>\",\n    \"provider\": \"ari\",\n    \"ws_client_name\": \"\",\n    \"dial_string_template\": \"PJSIP/{number}\",\n    \"external_pbx\": {\n      \"agent_api\": {\n        \"url\": \"<string>\",\n        \"username\": \"<string>\",\n        \"password\": \"<string>\",\n        \"source\": \"dograh\"\n      },\n      \"type\": \"vicidial\",\n      \"non_agent_api\": {\n        \"url\": \"<string>\",\n        \"username\": \"<string>\",\n        \"password\": \"<string>\",\n        \"source\": \"dograh\"\n      },\n      \"timeout_seconds\": 8\n    }\n  },\n  \"is_default_outbound\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.dograh.com/api/v1/organizations/telephony-configs")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"config\": {\n    \"ari_endpoint\": \"<string>\",\n    \"app_name\": \"<string>\",\n    \"app_password\": \"<string>\",\n    \"provider\": \"ari\",\n    \"ws_client_name\": \"\",\n    \"dial_string_template\": \"PJSIP/{number}\",\n    \"external_pbx\": {\n      \"agent_api\": {\n        \"url\": \"<string>\",\n        \"username\": \"<string>\",\n        \"password\": \"<string>\",\n        \"source\": \"dograh\"\n      },\n      \"type\": \"vicidial\",\n      \"non_agent_api\": {\n        \"url\": \"<string>\",\n        \"username\": \"<string>\",\n        \"password\": \"<string>\",\n        \"source\": \"dograh\"\n      },\n      \"timeout_seconds\": 8\n    }\n  },\n  \"is_default_outbound\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.dograh.com/api/v1/organizations/telephony-configs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"config\": {\n    \"ari_endpoint\": \"<string>\",\n    \"app_name\": \"<string>\",\n    \"app_password\": \"<string>\",\n    \"provider\": \"ari\",\n    \"ws_client_name\": \"\",\n    \"dial_string_template\": \"PJSIP/{number}\",\n    \"external_pbx\": {\n      \"agent_api\": {\n        \"url\": \"<string>\",\n        \"username\": \"<string>\",\n        \"password\": \"<string>\",\n        \"source\": \"dograh\"\n      },\n      \"type\": \"vicidial\",\n      \"non_agent_api\": {\n        \"url\": \"<string>\",\n        \"username\": \"<string>\",\n        \"password\": \"<string>\",\n        \"source\": \"dograh\"\n      },\n      \"timeout_seconds\": 8\n    }\n  },\n  \"is_default_outbound\": false\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "name": "<string>",
  "provider": "<string>",
  "is_default_outbound": true,
  "credentials": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "connectivity": "api",
  "inactive": false,
  "inactive_since": "2023-11-07T05:31:56Z",
  "inactive_reason": "<string>",
  "sip_connectivity": {
    "provider_display_name": "<string>",
    "regions": [
      {
        "region": "<string>",
        "inbound_transports": [
          {
            "transport": "<string>",
            "hostname": "<string>",
            "port": 123,
            "uri": "<string>"
          }
        ],
        "outbound_origin_ip": "<string>"
      }
    ]
  },
  "supports_outbound": true,
  "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": 123,
      "name": "<string>",
      "enabled": true,
      "settings": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "phone_number_count": 0
    }
  ],
  "supports_phone_number_sync": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

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

authorization

string | null

X-API-Key

string | null

Body

application/json

Body for POST /telephony-configs.

config carries the provider-specific credential fields (the same discriminated union used by the legacy single-config endpoint). Any from_numbers on the inner config are ignored — phone numbers are managed via the dedicated phone-numbers endpoints.

name

string

required

Required string length: 1 - 64

config

ARIConfigurationRequest · object

required

Request schema for Asterisk ARI configuration.

Show child attributes

is_default_outbound

boolean

default:false

Response

Successful Response

Body of GET /telephony-configs/{id} — credentials are masked.

integer

required

name

string

required

provider

string

required

is_default_outbound

boolean

required

credentials

Credentials · object

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

connectivity

enum<string>

default:api

Available options:

api,

sip

inactive

boolean

default:false

inactive_since

string<date-time> | null

inactive_reason

string | null

sip_connectivity

SIPConnectivityDetails · object | null

Provider-supplied SIP connection details displayed to customers.

Show child attributes

supports_outbound

boolean

default:true

setup_checklist

ProviderSetupChecklist · object | null

A configuration's setup progress, as computed by its provider.

ready_for_outbound is derived rather than reported independently so a provider cannot claim readiness while leaving a blocking step incomplete.

Show child attributes

supports_trunks

boolean

default:false

trunks

TrunkResponse · object[]

Show child attributes

supports_phone_number_sync

boolean

default:false

Resources

Authentication & Errors

Create Configuration

Headers

Body

Response