Skip to content

KAZOO Support Channels

This documentation is curated by 2600Hz as part of the KAZOO open source project. Join our community forums here for peer support. Only features in the space are included as part of our 2600Hz Support Services plan.


About Connectivity#


Trunkstore configuration document - this is old stuff; do not recommend building off this if possible

Key Description Type Default Required Support Level
account.caller_id.cid_name string(0..35) false
account.caller_id.cid_number string(0..35) false
account.caller_id object() false
account.emergency_caller_id.cid_name string(0..35) false
account.emergency_caller_id.cid_number string(0..35) false
account.emergency_caller_id object() false
account.trunks The number of two-way trunks this account has purchased integer() false
account Information that applies to the account as a whole object() false
name Human-friendly name of the trunkstore account string() false
servers.[].DIDs./^\+?\d*$/.caller_id.cid_name string(1..35) false
servers.[].DIDs./^\+?\d*$/.caller_id.cid_number string(1..35) false
servers.[].DIDs./^\+?\d*$/.caller_id object() false
servers.[].DIDs./^\+?\d*$/.failover.e164 An E.164 formatted DID to dial for failover string() false
servers.[].DIDs./^\+?\d*$/.failover.sip A SIP URI (sip:user@host) to call for failover string() false
servers.[].DIDs./^\+?\d*$/.failover Route inbound call to another destination if this server fails to handle the call object() false
servers.[].DIDs./^\+?\d*$/.force_outbound boolean() false false
servers.[].DIDs./^\+?\d*$/.options.[] string() false
servers.[].DIDs./^\+?\d*$/.options array(string()) false
servers.[].DIDs./^\+?\d*$/ object() false
servers.[].DIDs object() false
servers.[].auth.auth_method What type of auth mechanism to use string('password' | 'Password' | 'IP' | 'ip') password true
servers.[].auth.auth_password Password of the user@auth_realm string(1..) false
servers.[].auth.auth_user Username for authentication string(1..) false
servers.[].auth.ip IP (sip) address for this device string() false
servers.[].auth.port Port to send SIP traffic for the remote device integer() false
servers.[].auth object() true
servers.[].name Human-friendly name of the server string(1..) false
servers.[].options.caller_id.cid_name string(1..35) false
servers.[].options.caller_id.cid_number string(1..35) false
servers.[].options.caller_id object() false
servers.[].options.delay The time, in seconds, to wait before attempting to call the server integer() 0 false
servers.[].options.dynamic_flags.[] string() false
servers.[].options.dynamic_flags List of function names (or 'zone') that are called on the Call record to populate the 'flags' array sent to the resource(s) for matching array(string()) false
servers.[].options.emergency_caller_id.cid_name string(0..35) false
servers.[].options.emergency_caller_id.cid_number string(0..35) false
servers.[].options.emergency_caller_id object() false
servers.[].options.enabled Is the server ready for sending and receiving calls boolean() true false
servers.[].options.failover.e164 An E.164 formatted DID to dial for failover string() false
servers.[].options.failover.sip A SIP URI (sip:user@host) to call for failover string() false
servers.[].options.failover Route inbound call to another destination if this server fails to handle the call object() false
servers.[].options.flags.[] string() false
servers.[].options.flags List of flags to use when matching resources to route the call array(string()) false
servers.[].options.force_outbound If true, will send the call over configured carriers instead of to the server (as opposed to the 'enabled' flag, which will reject the calls) boolean() false false
servers.[].options.hunt_account_id When using local resources, use this account instead of the account making the call (useful for resellers) string() false
servers.[].options.hunt_non_reconcilable Whether to allow routing to continue on a non-reconcilable TO number boolean() false false
servers.[].options.ignore_early_media boolean() false
servers.[].options.inbound_format Determines how the INVITE is sent to the server string('e164' | 'npan' | '1npan' | 'username' | 'strip_plus') npan false
servers.[].options.ip IP (sip) address for this device string() false
servers.[].options.media_handling Determine whether the switch should be in the media path or not string('process' | 'bypass') bypass false
servers.[].options.port Port to send SIP traffic for the remote device integer() false
servers.[].options.progress_timeout The time, in seconds, to wait for the server to progress in the call, before trying an optionally defined failover route or terminating the call integer() false
servers.[].options.sip_headers List of arbitrary SIP headers to add to the INVITE array(object()) false
servers.[].options.timeout The time, in seconds, to wait for an answer from the server integer() false
servers.[].options object() false
servers What servers will be allowed to make/receive calls via this account array(object()) [] false


GET /v2/accounts/{ACCOUNT_ID}/connectivity

curl -v -X GET \
    -H "X-Auth-Token: {AUTH_TOKEN}" \


PUT /v2/accounts/{ACCOUNT_ID}/connectivity

curl -v -X PUT \
    -H "X-Auth-Token: {AUTH_TOKEN}" \


GET /v2/accounts/{ACCOUNT_ID}/connectivity/{CONNECTIVITY_ID}

curl -v -X GET \
    -H "X-Auth-Token: {AUTH_TOKEN}" \


POST /v2/accounts/{ACCOUNT_ID}/connectivity/{CONNECTIVITY_ID}

curl -v -X POST \
    -H "X-Auth-Token: {AUTH_TOKEN}" \


PATCH /v2/accounts/{ACCOUNT_ID}/connectivity/{CONNECTIVITY_ID}

curl -v -X PATCH \
    -H "X-Auth-Token: {AUTH_TOKEN}" \


DELETE /v2/accounts/{ACCOUNT_ID}/connectivity/{CONNECTIVITY_ID}

curl -v -X DELETE \
    -H "X-Auth-Token: {AUTH_TOKEN}" \