Offnet

About Offnet

Deprecated; use Resources instead.

Schema

Validator for the deprecated offnet callflow data object

KeyDescriptionTypeDefaultRequiredSupport Level
addresses.emergencyEmergency address to use for PIDF+LO if the carrier supports itobject()false
addressesobject()false
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 add`string()boolean()integer()`
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 add`string()boolean()integer()`

On this page