The content in this section relects our KAZOO open source repository (version 4.3), which is no longer maintained.

Resources

Resources

Route the caller to external resources (typically upstream providers).

Schema

Validator for the resources callflow data object

KeyDescriptionTypeDefaultRequiredSupport Level
bypass_e164Use the original requested number instead of normalizing to E164boolean()false
caller_id_typeWhich configured caller-id to use (key in the ‘caller_id’ object)string()externalfalse
custom_sip_headers.inCustom SIP Headers to be applied to calls inbound to Kazoo from the endpoint#/definitions/custom_sip_headersfalse
custom_sip_headers.outCustom SIP Headers to be applied to calls outbound from Kazoo to the endpoint#/definitions/custom_sip_headersfalse
custom_sip_headers.^[a-zA-z0-9_\-]+$The SIP header to addstring()false
custom_sip_headersA property list of SIP headersobject()false
do_not_normalizeUse the original requested number instead of normalizing; otherwise try to apply the endpoint’s dialplan to the requested numberboolean()false
dynamic_flags.[]string()false
dynamic_flagsList of function names (or ‘zone’) that are called on the Call record to populate the ‘flags’ array sent to the resource(s) for matchingarray(string())false
emit_account_idToggles whether to put the account id in the SIP packetsboolean()false
format_from_uriIf true, puts the account realm in the From headerboolean()false
from_uri_realmOverride the From realm in the SIP packetsstring()false
hunt_account_idWhen using local resources, use this account instead of the account making the call (useful for resellers)string()false
ignore_early_mediaToggle whether to ignore early mediaboolean()falsefalse
outbound_flags.[]string()false
outbound_flagsList of flags to use when matching resources to route the callarray(string())[]false
resource_typesets a custom resource type for the published amqp messagestring()false
ringbackTone or file to play while waiting for the leg to be answeredstring()false
skip_moduleWhen set to true this callflow action is skipped, advancing to the wildcard branch (if any)boolean()false
timeoutHow long, in seconds, to wait for the call to be answeredinteger()false
to_didStatically set the DID to dialstring()false
use_local_resourcesToggle whether to use the account’s (or hunt_account_id’s) resources vs the system resourcesboolean()truefalse

custom_sip_headers

Custom SIP headers applied to an INVITE

KeyDescriptionTypeDefaultRequiredSupport Level
^[a-zA-z0-9_\-]+$The SIP header to addstring()false

Special Dynamic Flags

Zone

Adding the value "zone" to the dynamic_flags array will result in a flag set to the zone name that is executing the call.

Custom Channel Vars

Adding the value "custom_channel_vars." appended with a normalized variable name will add the value (if present) to the flags array. For example, "custom_channel_vars.owner_id".

PLEASE NOTE

Developers can expect that custom channel variables (CCVs) will be an available field. They can further expect that any variables they have placed there will always be available. However, developers should not assume that all variables offered in CCVs will always be available. Internal KAZOO applications also add CCVs to channels, however they may not always continue to add those variables or add them in a consistent way. Should you need to utilize a CCV added by an internal KAZOO app, we advise completing QA on all KAZOO versions to ensure these values are still present and in the format you are expecting before installing those versions on your or your customers’ clusters.

Examples

Route to the system carriers

{"module":"resources",
 "data":{
   "use_local_resources":false
 }
}

Route to the account’s local carriers

{"module":"resources",
 "data":{
   "use_local_resources":true
 }
}

Route to another account’s local carriers

{"module":"resources",
 "data":{
   "use_local_resources":true,
   "hunt_account_id":"{OTHER_ACCOUNT_ID}"
 }
}

This is great for resellers; they can set their reseller account id as the hunt_account_id in callflows for their child accounts (such as in the no_match callflow).

Dynamic Flags

{"module":"resources",
 "data":{
   "dynamic_flags": ["custom_channel_vars.owner_id", "zone"]
 }
}

This will add the zone name processing the call and owner ID of the endpoint to the required flags of the resource requests. In this example only resources for that zone and owner will be selected (the resources would need the corresponding values set as available flags).

Custom SIP Headers

You can include a couple macros that will be replaced at the time of a call in the SIP headers. For instance, if you need to send the Caller-ID number as an “X-” SIP header:

{"module":"resources",
 "data":{
   "use_local_resources":true,
   "hunt_account_id":"{OTHER_ACCOUNT_ID}",
   "custom_sip_headers":{
     "X-Billing-Number":"{caller_id_number}"
   }
 }
}

By using {caller_id_number}, Kazoo will replace the header value with the actual Caller-ID number for that call. If the number was 4158867900 then the SIP INVITE would include the header X-Billing-Number: 4158867900.

You can find the listing of available macros in the /v2/schemas/ecallmgr API call; look for the expandable_macros defaults.