Module yeti internals

NOTE: This section is for developers. it describes basic internals and documents things to be used by the DB layer.

Callprofile fields

DB layer controls yeti module's call processing behavior by returning callprofiles list.

Each callprofile configures single legB(termination) attempt.

Yeti module will try to connect call for the first callprofile and failover to the next ones depending on hunting configuration.

Last callprofile MUST have disconnect_code_id set.

signalling/routing fields

disconnect_code_id (integer. default: 0)

internal disconnect code id. causes callprofile reject if set.

failover will be performed depending on hunting configuration for the code (see: translator.* keys at Entities caching)

ruri (string. default: empty)

R-URI for the legB SIP dialog. callprofile MUST have ruri or disconnect_code_id set.

from (string. default: empty)

From for the legB SIP dialog. will use value from the original INVITE if not set.

to (string. default: empty)

To for the legB SIP dialog. will use value from the original INVITE if not set.

call_id (string. default: empty)

set Call-ID for legB SIP dialog. will generate value by AmSession::getNewId() if not set.

if set and contains %uuid placeholder, then placeholder will be replaced with value generated by AmSession::getNewId()

aleg_outbound_proxy, outbound_proxy (string. default: empty)

set outbound proxy URI for related SIP dialog.

adds specified URI as topmost Route-Set entry on requests sending

aleg_force_outbound_proxy, force_outbound_proxy (boolean. default: false)

specifies whether to force outbound proxy usage for in-dialog requests (with remote_tag set)

aleg_route_set, bleg_route_set (string. default: empty)

comma-separated URIs to force Route-Set for dialogs

bleg_force_cancel_routeset (boolean. default: false)

override force_cancel_route_set for legB

next_hop, aleg_next_hop (string. default: empty)

override transport next_hop for dialog (skip standard next_hop resolving by Route-Set or RURI)

it allows to send request to destination not specified in Route headers or RURI

next_hop_1st_req (boolean. default: false)

whether to override next_hop for initial request only

patch_ruri_next_hop (boolean. default: false)

patch RURI-host with IP-address of the transport endpoint

dlg_nat_handling (boolean. default: false)

if enabled, automatically set next_hop for legA dialog to the endpoint from initial INVITE received

outbound_interface, aleg_outbound_interface (string. default: empty)

set signalling interface name configured in signaling-interfaces

will skip signalling interface lookup by src IP address for next_hop after OS routing.

lega_res, legb_res (string. default: empty)

configuration for capacity and rate limiting

lega_res will be checked once for the first callprofile. legb_res will be checked for each call_profile before an attempt to create related legB.

resources can have two algorithms: capacity limit and rate limit. resource algorithm is specified for each resource type. resource types are loaded once on node start by SELECT * FROM load_resource_types() routing DB query (can be checked by RPC method yeti.show.resource.types)

single resource format:

for capacity resources: type:id:limit:takes

for ratelimit resources: type:id:limit:wsize

WHERE:

type

resource type id for mapping loaded by load_resource_types()

id

resource id. (type/id combination is supposed to be unique)

limit

allowed sumiltaneous resource usage count

takes

how much resource one get() operation takes for capacity resources

wsize

sliding-window size in seconds for ratelimit resources

resource atom format:

resources can be combined using | separator to perform failover. this will work like lazy-evaluated logical OR.

for example 1:42:100:1|2:314:100:1 means: try to grab resource with type:1 id:42 which is limited by 100 and takes 1 for call. if resources is not available then failover to resource with type:2 and id:314

resources spec format:

full resources spec contains resource atoms separated by semicolons (;). specified resources are grabbed as all-or-nothing so semicolons works as logical AND.

for example 1:42:100:1|2:314:100:1;3:111:10:1 means: try to grab ((1:42 OR 2:314) AND 3:111) resources

time_limit (integer. default: 0)

specifies maximum call duration in seconds if set. node will terminate call with internal code/reason 200/Call duration limit reached and send BYE to both legs`

ringing_timeout(integer. default: 0)

set timeout for Ringing state (after 18x). on timeout will terminate call with internal code 1505

trusted_hdrs_gw (boolean. default: false)

whether to parse and save legb_response_cdr_headers on 200OK from termination gateway.

transit_headers_a2b, transit_headers_b2a (string. default: empty)

comma-separated whitelist for additional SIP headers to transit between legs. Default behavior is to filter-out everything (empty whiltelist)

append_headers (string. default: empty)

\r\n separated list for SIP headers to be appended to the initial legB INVITE

append_headers_req, aleg_append_headers_req (string. default: empty)

\r\n separated list for SIP headers to be appended for all SIP requests

aleg_append_headers_reply (string. default: empty)

\r\n separated list for SIP headers to be appended for all 200,18x legA replies

aleg_policy_id, bleg_policy_id (integer. default: 0)

Disconnect codes/hunting overrides (see: translator.dc_*_override keys at Entities caching)

aleg_rel100_mode_id, bleg_rel100_mode_id (integer. default: 4/Ignored)

rel100 processing mode. see Rel100 Modes

aleg_relay_options, bleg_relay_options (boolean. default: false)

whether to relay OPTIONS requests to the another leg. a/b means leg which received request

aleg_relay_update, bleg_relay_update (boolean. default: false)

whether to relay UPDATE requests to the another leg. a/b means leg which received request

aleg_relay_reinvite, bleg_relay_reinvite (boolean. default: true)

whether to relay reINVITE requests to the another leg. a/b means leg which received request

aleg_relay_hold, bleg_relay_hold (boolean. default: true)

whether to relay hold/unhold reINVITes requests to the another leg when related aleg_relay_reinvite/bleg_relay_reinvite is disabled. a/b means leg which received request

aleg_contact_user, bleg_contact_user (string. default: empty)

set Contact header user for INVITE/UPDATE requests/replies

filter_noaudio_streams (boolean. default: false)

enable workaround mode which removes image(T38) streams

allow_1xx_wo2tag (boolean. default: false)

compatibility option. Do not ignore 1xx replies without To-tag. will patch reply internally with saved To-tag value for dialog before processing

invite_timeout (integer. default: TIMER_B)

invite transaction timeout override in seconds

srv_failover_timeout (integer. default: TIMER_M)

override timeout between DNS SRV entries failover in seconds

fake_180_timer (integer. default: 0)

generate 180 reply for originator after no 18x replies in fake_180_timer seconds

bleg_transport_protocol_id (integer. default: 0)

patch RURI transport with specified Transport protocol id

aleg_outbound_proxy_transport_protocol_id, bleg_outbound_proxy_transport_protocol_id (integer. default: 0)

patch related outbound proxies transport with specified Transport protocol id

bleg_protocol_priority_id (integer. default: 0/IPv4_only)

set DNS resolver IPv4/IPv6 priority for legB

bleg_max_30x_redirects (integer. default: 0)

allow max bleg_max_30x_redirects for the call if set.

uses callprofile which received redirect with RURI patched with Contact from 30x

bleg_max_transfers (integer. default: 0)

allow max bleg_max_transfers REFERS for the call if set.

uses callprofile which received redirect with RURI patched with Refer-To from REFER

if Refer-To contains tel-URI then uses transfer_tel_uri_host from the gateway cache for legB as URI-host and transfer_append_headers_req to add additional headers to the new INVITE

aleg_auth_required (boolean. default: false)

stop request processing and send auth challenge if set. used by DB layer when auth can not be offloaded to the yeti module

registered_aor_id (integer. default: 0)

registration id (usually it's termination gateway id) to resolve before processing

registered_aor_mode_id (integer. default: 1/REGISTERED_AOR_MODE_AS_IS)

set Registered AoR mode

Also, if To-host is set to unknown.invalid it will be replaced by Binding-host

enable_auth, enable_aleg_auth (boolean. default: false)

enable uac_uath module hook for session. so uac_auth will handle 401/407 auth challenges and perform SIP Digest auth

auth_user, auth_aleg_user, auth_pwd, auth_aleg_pwd (string. default: empty)

credentials for uac_uath module

radius_auth_profile_id (integer. default: 0)

profile id with parameters for RADIUS Auth request (see: radius_authorization_profiles key at Entities caching)

aleg_radius_acc_profile_id, bleg_radius_acc_profile_id (integer. default: 0)

profile id with parameters for RADIUS Accounting requests (see: radius_accounting_profiles key at Entities caching)

{routing.lega_gw_cache_key}/orig_gw_id (string. default: empty)

Points to the origination gateway cache entry (see: gateways_cache key at Entities caching).

Origination gateway cache entry is used to set per-gateway behavior. see Gateways Cache Data

{routing.legb_gw_cache_key}/term_gw_id (string. default: empty)

Points to the termination gateway cache entry (see: gateways_cache key at Entities caching).

Termination gateway cache entry is used to set per-gateway behavior. see Gateways Cache Data

SST

enable_session_timer (boolean. default: false)

enable timer moule session hook for legB

enable_aleg_session_timer (boolean. default: enable_session_timer)

enable timer moule session hook for legA

session_expires, aleg_session_expires (string. default: 300)

set expire value to be announced for SST

minimum_timer, aleg_minimum_timer (string. default: 90)

set minimum allowed expire value

maximum_timer, aleg_maximum_timer (string. default: 1800)

set maximum allowed expire value

accept_501_reply, aleg_accept_501_reply (string. default: false)

do not terminate session on 501 replies for SST reINVITE/UPDATEs

session_refresh_method_id, aleg_session_refresh_method_id (integer. default: 1)

set how to perform SST session refreshing. see SST Refresh method id

media fields

enable_rtprelay (boolean. default: false)

whether to relay/transcode RTP via node. false means do not touch SDP body so media will go directly between originatior/terminator

rtprelay_dtmf_filtering (boolean. default: false)

DEPRECATED. Unused

rtprelay_dtmf_detection (boolean. default: false)

force DTMF detection when stream was put on hold (AmRtpStream::receiving flag and is false / local SDP has recvonly/inactive attribute)

rtprelay_force_dtmf_relay (boolean. default: true)

DEPRECATED. Unused

aleg_force_symmetric_rtp, bleg_force_symmetric_rtp (boolean. default: false)

force SymmetricRTP mode for media connections

aleg_symmetric_rtp_nonstop, bleg_symmetric_rtp_nonstop (boolean. default: false)

never leave passive mode so SymmetricRTP will woork even after a remote endpoint learned

aleg_rtp_ping, bleg_rtp_ping (boolean. default: false)

send RTP ping packet after the stream initialization

aleg_sdp_c_location_id, bleg_sdp_c_location_id (integer. default: 0)

set SDP c-line location normalization. see Connection location id

dead_rtp_time (integer. default: sems.conf:general.dead_rtp_time)

override RTP timeout value. see SEMS configuration / media processing/ dead_rtp_time

rtp_relay_timestamp_aligning (boolean. default: false)

DEPRECATED. Unused

rtp_force_relay_cn (boolean. default: false)

force CN/13 (RFC 3389) RTP payload relay

aleg_dtmf_send_mode_id, bleg_dtmf_send_mode_id (integer. default: 1. TODO: add see enums)

set DTMF sending format. see: DTMF TX Mode id

aleg_dtmf_recv_modes, bleg_dtmf_recv_modes (integer. default: 7. TODO: add see enums)

set allowed incoming DTMF formats. see: DTMF RX Mode id

aleg_rtp_filter_inband_dtmf, bleg_rtp_filter_inband_dtmf (boolean. default: false)

set to filter out detected inband dtmf from the outgoing audio stream

needed to avoid events duplication if other side detects inband together with another methods usage

suppress_early_media (boolean. default: false)

clear body from 18x legB replies and replace all 18x codes with 180

force_one_way_early_media (boolean. default: false)

disable RTP receiving from the originator in early media state

aleg_media_encryption_mode_id, bleg_media_encryption_mode_id (integer. default: 0)

RTP media profile to match for incoming SDP offers

RTP media profile to use for outgoung SDP offers

see Encryption mode id

aleg_rtp_acl, bleg_rtp_acl (array of strings. default: empty)

subnets list to use as whitelist for incoming RTP

aleg_codecs_group_id, bleg_codecs_group_id (integer. default: 0)

set codec group to use ((see: codec_groups key at Entities caching)).

codec group specifies allowed codecs list and ptime

aleg_single_codec_in_200ok, bleg_single_codec_in_200ok (boolean. default : false)

reduce codecs for SDP answers in 200ok to single payload (except of telephone-event ones)

try_avoid_transcoding (boolean. default: false)

affects codecs ordering for Bleg. increases chance to setup relay mode instead of transcoding

rtprelay_interface, aleg_rtprelay_interface (string. default: empty)

set media interface name configured in media-interfaces

default value will use media iface with index 0 (the first described in configuration)

if set will skip media interface usage set in default-media-interface for the resolved signalling interface

other fields

record_audio (boolean. default: false)

enable call recording to MP3,RSR files

dump_level_id (integer. default: 0)

set PCAP file dump level. see: Dump level id

0 - means do not write file

aleg_sensor_id, bleg_sensor_id (integer. default: -1)

enabled sensor for the certain leg to mirror call traffic (see: sensors key at Entities caching)

aleg_sensor_level_id, bleg_sensor_level_id (integer. default: 0)

set dump level for sensors set by aleg_sensor_id/bleg_sensor_id

values are the same as for dump_level_id. see: Dump level id

global_tag (string. default: empty)

set transparent call identifier for tracking between systems

cache_id (string. default: empty)

set callprofile template id to be merged into callprofile returned by DB. (see: callprofiles key at Entities caching)

...dynamic fields...

all fields returned by SELECT * FROM {routing.schema}.load_interface_out() will be saved to CDR transparently

Entities caching

yeti module performs in-memory caching for multiple entities.

Caches are invalidated by timer interval set in db_refresh_interval option.

Timer calls SELECT * FROM check_states() function for configured routing DB connection and compares entities versions from DB reply against local ones, then reloads updated entities if necessary.

RPC method to check local/DB states: yeti.show.db-states

Supported entities table:

Key name	SQL to reload	Description
ip_auth	SELECT * FROM load_ip_auth({node_id}, {pop_id})	see:IP Auth Data
trusted_lb	SELECT * FROM load_trusted_lb()	see:Load Balancers Data
sensors	SELECT * FROM load_sensor()	see:Sensors Data
translations.dc_rerouting	SELECT * FROM load_disconnect_code_rerouting()	see:Disconnect Code Rerouting Data
translations.dc_rewrite	SELECT * FROM load_disconnect_code_rewrite()	see:Disconnect Code Rewrite Data
translations.dc_refuse	SELECT * FROM load_disconnect_code_refuse()	see:Disconnect Code Refuse Data
translations.dc_rerouting_override	SELECT * FROM load_disconnect_code_rerouting_overrides()	Per-callprofile mappings override for translations.dc_rerouting. Same fields plus o_policy_id
translations.dc_rewrite_override	SELECT * FROM load_disconnect_code_rewrite_overrides()	Per-callprofile mappings override for translations.dc_rewrite. Same fields plus o_policy_id
translations.dc_refuse_override	SELECT * FROM load_disconnect_code_refuse_overrides()	Per-callprofile mappings override for translations.dc_refuse. Same fields plus o_policy_id
codec_groups	SELECT * FROM load_codec_groups() or SELECT * FROM load_codecs()	see:Codecs Data
registrations	SELECT * FROM load_registrations_out({node_id}, {pop_id})	see:Registrations Data
radius_authorization_profiles	SELECT * FROM load_radius_profiles()	see:Radius Athorization Profiles Data
radius_accounting_profiles	SELECT * FROM load_radius_accounting_profiles()	see:Radius Accounting Profiles Data
auth_credentials	SELECT * FROM load_incoming_auth()	see:Auth Credentials Data
options_probers	SELECT * FROM load_sip_options_probers({node_id})	see:Options Probers Data
gateways_cache	SELECT * FROM load_gateway_attributes_cache()	see:Gateways Cache Data
callprofiles	SELECT * FROM load_callprofiles()	see:Callprofile Templates Data

IP Auth Data

Cache to match incoming gateways by subnets longest match

RPC: yeti.show.ip-auth

ip (string. default: empty)

Subnet in CIDR notation to match incoming calls src IP address

x_yeti_auth(string. default: empty)

value to match against header specified in ip_auth_header module parameter

require_incoming_auth(boolean. default: false)

require request to be authorized if set. used to reduce count of requests to the routing DB

reply with 401 if has no Authorization header. reply with 403 if has Authorization header with wrong credentials.

Load Balancers Data

Cache to check for trusted balancers addresses

RPC: yeti.show.trusted-balancers

id (integer. mandatory)

Trusted load balancer unique id

name (string. mandatory)

Trusted load balancer name

signalling_ip (string. mandatory)

Trusted load balancer signalling IP address

Sensors Data

Sensors parameters cache. see: aleg_sensor_id, bleg_sensor_id callprofile fields

RPC: yeti.show.sensors

o_id (integer. mandatory)

Sensor id

o_mode_id (integer. mandatory)

Sensor mode id

1 - IPIP, 2 - ETHERNET, 3 - HEP

o_source_ip(string. mandatory for o_mode_id==1)

Src IP for IPIP Sensor

o_target_ip(string. mandatory for o_mode_id==1)

Dst IP for IPIP Sensor

o_source_interface(string. mandatory for o_mode_id==2)

Source interface name for Ethernet sensor

o_target_mac(string. mandatory for o_mode_id==2)

Target MAC address for Ethernet sensor

o_target_ip(string. mandatory for o_mode_id==3)

Target IP address for HEP sensor

o_target_port(integer. default: 15060)

Target port for HEP sensor

o_hep_capture_id(integer. default: ${node_id})

Target capture id for HEP sensor

o_capture_password(string. default: empty)

Not used

o_capture_compression(bool. default: false)

Not used

Disconnect Code Rerouting Data

Global mapping for SIP disconnect codes whether to try rerouting to another callprofile/gateway

RPC: yeti.show.configuration | translator.hunting, yeti.show.configuration | translator.overrides.hunting

received_code (integer. default: 0)

SIP Code to check rerouting policy for

stop_rerouting (boolean. default: true)

Perform rerouting to the next callprofile if false, finish call otherwise

Disconnect Code Rewrite Data

Global mapping for SIP disconnect codes with rewrites for aleg code/reason and CDR values

RPC: yeti.show.configuration | translator.response_translations, yeti.show.configuration | translator.overrides.response_translations

o_code (integer. default: 0)

SIP disconnect code

o_rewrited_code (integer. default: ${o_code})

SIP disconnect for originator

o_rewrited_reason (string, default: ${o_reason})

SIP reason for originator

o_reason (string, default: empty)

SIP replay reason for the internal disconnect code

o_pass_reason_to_originator (bool, default: false)

Whether to pass o_reason transparently or replace it with o_rewrited_reason in SIP reply to originator

Disconnect Code Refuse Data

Global mapping for internal disconnect codes with behavior settings and rewrites to SIP code/reasons

RPC: yeti.show.configuration | translator.internal_translations, yeti.show.configuration | translator.overrides.internal_translations

o_id (integer. default: 0)

Internal disconnect code id

o_code (integer. default: 0)

internal SIP code for internal disconnect code id

o_reason (string. default: empty)

internal SIP code for internal disconnect code id

o_rewrited_code (integer. default: ${o_code})

SIP code for reply to originator

o_rewrited_reason (string. default: empty

SIP reason for reply to originator

o_store_cdr (boolean. default: true)

Whether to store CDR for this internal disconnect code id

o_silently_drop (boolean. default: false)

Whether to drop reply for this internal disconnect code id and do not send any reply for rejected request

Codecs Data

Codec groups cache. see: aleg_codecs_group_id,bleg_codecs_group_id callprofile fields

RPC: yeti.show.configuration | codecs_groups

codecs (array of structs. default: empty)

array of codecs definitions. see subparams below

codecs.name (string. default: empty)

codec standard name for SDP together with codec rate. for example "PCMU/8000"

codecs.format_parameters (string. default: empty)

fmtp a-line value for SDP

codec.dynamic_payload_type (integer, default: -1)

lock dynamic payload type to the certain value

ptime (integer, default: 0)

set packetization interval in ms for codec group. will use default one for node if not set

Registrations Data

Outgoing registrations list. uses registrar_client module

RPC: registrar-client.listRegistrations

o_id (string, default: empty)

Registration id. usually related gateway id

o_domain (string, default: empty)

Registration Domain

o_user (string, default: empty)

Registration User

o_display_name (string, default: empty)

Registration Contact display name

o_auth_user (string, default: empty)

Registration user for SIP Digest auth

o_auth_password (string, default: empty)

Registration password for SIP Digest auth

o_proxy (string, default: empty)

Outbound proxy SIP URI

o_route_set (string, default: empty)

Predefined route set for REGISTER requests (overrides o_proxy)

o_contact (string. default: empty)

Contact header value override

o_sip_interface_name (string. default: empty)

SIP interface name to use for registration

o_expire (integer. default: 3600)

Registration expire interval to offer

o_force_expire (integer. default: false)

Force local expiration interval ignoring expiration from registration reply

o_retry_delay (integer. default: 120)

Retry delay between failed registration attempts

o_max_attempts (integer. default: 0/unlimited)

Do max registration attempts if set then leave registration in error state

o_transport_protocol_id (integer. default: 1/UDP)

Transport protocol id for RURI. see Transport protocol id

o_proxy_transport_protocol_id (integer. default: 1/UDP)

Transport protocol id for proxy URI. see Transport protocol id

o_scheme_id (integer. default: 1/SIP)

SIP scheme for URI. see SIP scheme id

Radius Athorization Profiles Data

Radius autorization profiles cache. see: radius_auth_profile_id callprofile field

RPC: radius-client.showAuthConnections, radius-client.showAuthStat

id (integer)

Radus auth connection id

name (string)

Radus auth connection name

server (string)

Radus server host

port (integer)

Radus server port

secret (string)

Radus server secret

reject_on_error (boolean)

Whether to reject call on radius auth connection errors

timeout (integer)

Radius server reply timeout in ms

attempts (integer)

Attempts count on timeout

avps (array of structs)

AVPS to use in RADIUS Auth request. see subitems below

avps.name (string)

AVP name

avps.type_id (integer)

AVP type id

avps.value (string)

AVP value. it will be converted on attribute adding depending on format value

avps.format (string)

AVP format. allowed values: string, integer, octets, date, ipaddr, ip6addr

avps.is_vsa (boolean)

add VSA header for attribute

avps.vsa_vendor_id (integer)

VSA header vendor_id field

avps.vsa_vendor_id (integer)

VSA header vendor_id field

avps.vsa_vendor_type (integer)

vendor_type for attribute after VSA header. overrides avps.type_id

Radius Accounting Profiles Data

Radius accounting profiles cache. see: aleg_radius_acc_profile_id, bleg_radius_acc_profile_id callprofile fields

RPC: radius-client.showAccConnections, radius-client.showAuthStat

id (integer)

Radus accounting connection id

name (string)

Radus accounting connection name

server (string)

Radus server host

port (integer)

Radus server port

secret (string)

Radus server secret

timeout (integer)

Radius server reply timeout in ms

attempts (integer)

Attempts count on timeout

start_avps (array of structs)

AVPS to use in RADIUS start accounting request. see avp for Radius Athorization Profiles Data

interim_avps (array of structs)

AVPS to use in RADIUS interim accounting requests. see avp for Radius Athorization Profiles Data

stop_avps (array of structs)

AVPS to use in RADIUS stop accounting request. see avp for Radius Athorization Profiles Data

enable_start_accounting (boolean)

Whether to send RADIUS start accounting request

enable_interim_accounting (boolean)

Whether to send RADIUS interim accounting requests

enable_stop_accounting (boolean)

Whether to send RADIUS stop accounting request

interim_accounting_interval (integer)

Interval for sending RADIUS interim accounting request in seconds

Auth Credentials Data

Credentials cache for SIP Digest/JWT auth

RPC: yeti.show.auth.credentials.all, yeti.show.auth.credentials.id <gateway_id>, yeti.show.auth.credentials.user <username>

id (integer)

Credentials Auth id. usually related gateway id

username (string, default: empty)

If set add username/password entry for SIP Digest auth

password (string. default: empty)

If set add username/password entry for SIP Digest auth

allow_jwt_auth (boolean. default: false)

If set then enable JWT auth by relatedid (will lookup value from JWT 'id' claim)

jwt_gid (integer)

If set then enable JWT auth by specified group id (will lookup value from JWT 'gid' claim and then resolve to id)

Options Probers Data

Probers list to send OPTIONS. usess options_prober module

RPC: options-prober.show.probers

id (integer)

Prober id

name (string)

Prober name

ruri_domain (string)

RURI-domain for OPTIONS requests

ruri_username (string. default: empty)

RURI-user for OPTIONS requests

from_uri (string. default: RURI)

From URI for OPTIONS requests

to_uri (string, default: RURI)

To URI for OPTIONS requests

interval (integer)

Interval in secionds for OPTIONS requests

transport_protocol_id (integer, default: 1/UDP)

patch RURI transport with specified Transport protocol id

sip_schema_id (integer, default: 1/SIP)

SIP scheme for RURI. see SIP scheme id

contact_uri (string. default: empty)

Override Contact header value

proxy (string. default: empty)

Set outbound proxy URI

proxy_transport_protocol_id (integer, default: 1/UDP)

Patch proxy URI transport with specified Transport protocol id

route_set (string. default: empty)

Set predefined route set for OPTIONS requests. overrides proxy

append_headers (string. default:empty)

Custom headers to set for OPTIONS request

sip_interface_name (string. default: empty)

SIP interface name to use for OPTIONS request

auth_username (string, default: empty)

User for SIP Digest auth

auth_password (string, default: empty)

Password for SIP Digest auth

Gateways Cache Data

Gateways parameters cache. see $routing.lega_gw_cache_key, $routing.legb_gw_cache_key callprofile fields

RPC: yeti.show.gateways-cache [gateway_id]

transfer_tel_uri_host (string. default: empty)

Host to use for destination SIP URI on transfer by Bleg REFER with tel-URI in Refer-To

transfer_append_headers_req (array of strings. default: empty)

Headers to append to the INVITE generated on transfer by Bleg REFER

allowed_methods (array of string. default: empty)

Overrides allowed_methods module option for the call

supported_tags (array of string. default: empty)

Overrides supported_tags module option for the call

ice_mode_id (integer. default: MEDIA_MODE_ENABLE_WHEN_OFFERED)

Set ICE media mode id. see: Media Mode id

rtcp_mux_mode_id (integer. default: MEDIA_MODE_ENABLE_WHEN_OFFERED)

Set RTCP-MUX media mode id. see: Media Mode id

rtcp_feedback_mode_id (integer. default: MEDIA_MODE_ENABLE_WHEN_OFFERED)

Set RTCP feedback (RTPAVPF/RTPSAVPF/UDPTLSRTPSAVPF) media mode id. see: Media Mode id

throttling_codes (array of strings. default: empty)

SIP reply codes to use for throttling statistics update on failed SIP replies for the gateway

any code can be prefixed with local_ to catch locally generated ones (eg: 408 Timeout)

NOTE: if throttling is enabled then runtime throttling stats will be added to the yeti.show.gateways-cache [gateway_id] RPC method output

throttling_minimum_calls (integer. mandatory when throttling_codes is not empty)

Minimal calls count to start apply failure rate statistics for throttling

throttling_window (integer. mandatory when throttling_codes is not empty)

Throttling statistics (essentially failure replies) sliding window size in seconds

throttling_threshold_start (double. mandatory when throttling_codes is not empty)

Failure rate throttling threshold start

Start failure rate threshold value corresponds to 0% drop probability by throttling

throttling_threshold_end (double. mandatory when throttling_codes is not empty)

Failure rate throttling threshold end

End failure rate threshold value corresponds to 100% drop probability by throttling

Callprofile Templates Data

Callprofiles templates cache. see cache_id callprofile field

Useful to configure some global behavior

cache_id (string. default: empty)

Callprofile template id to lookup if callprofile cache_id set

Templates configuration can have single profile without cache_id which will be merged into all callprofiles despite cache_id field is set

...arbitrary fields...

Any fields. They will be merged into DB callprofile reply before parsing. Merge means to add fields that not exist in reply and do not touch existent ones

Internal Enums

Internal disconnect codes

Code	Description
114	From parsing failed
115	To parsing failed
116	Contact parsing failed
117	No Prepared statement to get callprofiles in DB
118	Empty response from routing DB
119	Failed to read callprofiles from routing DB
120	Failed to evaluate/validate callprofiles
121	No routing DB connection
122	NOT USED. was DB broken exception
123	NOT USED. was DB conversion exception
124	NOT USED. was DB base exception
125	legA RTP timeout
126	ACK timeout
127	PRACK timeout
128	Session timeout (SST)
129	Internal Error from CallLeg
130	SIP Transaction timeout
131	Gateway is not registered. see: registered_aor_id callprofile field
132	legB RTP timeout
133	Failure rate throttling
140	Codec group not found. see: aleg_codecs_group_id,bleg_codecs_group_id callprofile fields
141	SDP offer codecs not matched with assigned codecs group
142	No suitable media streams
143	Invalid media transport (failed to match RTP profile)
144	RTP stream packet sending error
145	reINVITE error reply
146	finalized (usually BYE) before DB response
1500	SDP generic exception
1501	SDP parsing failed
1502	Empty/No SDP answer
1503	Wrong streams count in SDP answer
1504	Wrong streams types in SDP answer
1505	Ringing timeout. see ringing_timeout callprofile field
1600	Resources cache error
1601	Unknown resource type

Dump level id

Dump level is a bitmask so flags can be combined

Flag	Description
1	log SIP
2	log RTP

Rel100 Modes

Value	Description
0	Disabled. Never announce, reject if received
1	Supported. Announce and enable if received
2	SupportedNotAnnounced. Do not announce and enable if received
3	Require. Always announce fail if not received
4	Ignored. Do not process

Transport protocol id

Value	Description
1	UDP
2	TCP
3	TLS
4	SCTP
5	WS
6	WSS

SIP scheme id

Value	Description
1	SIP
2	SIPS
3	TEL

DNS Priority id

Value	Description
0	IPv4_only. use A entries only
1	IPv6_only. use AAAA entries only
3	Dualstack. use A and AAAA entries. do not sort
4	IPv4_pref. use A and AAAA entries. prioritize A entries
5	IPv6_pref. use A and AAAA entries. prioritize AAAA entries

Registered AoR mode id

Value	Description
1	REGISTERED_AOR_MODE_AS_IS Use registration binding as RURI
2	REGISTERED_AOR_MODE_REPLACE_RURI_TRANSPORT_INFO Use registration binding as RURI but merge with callprofile RURI URI-params

SST Refresh method id

Value	Description
1	REFRESH_METHOD_INVITE: use INVITE for SST
2	REFRESH_METHOD_UPDATE: use UPDATE for SST
3	REFRESH_METHOD_UPDATE_FALLBACK_INVITE: use UPDATE for SST. fallback to INVITE if UPDATE tag is not listed in Allow

Connection location id

Value	Description
0	BOTH: normalize SDP so c-line presented both at media and stream levels
1	SESSION_ONLY: normalize SDP so c-line presented at session level only
2	MEDIA_ONLY: normalize SDP so c-line presented at media level only

DTMF TX Mode id

Value	Description
0	DTMF_TX_MODE_DISABLED Avoid sending
1	DTMF_TX_MODE_RFC2833: telephone-event RTP payload
2	DTMF_TX_MODE_INFO_DTMF_RELAY SIP INFO with application/dtmf-relay body
4	DTMF_TX_MODE_INFO_DTMF SIP INFO with application/dtmf body
8	DTMF_TX_MODE_INBAND inband DTMF

DTMF RX Mode id

DTMF RX Mode id is a bitmask so flags can be combined

Flag	Description
1	DTMF_RX_MODE_RFC2833 telephone-event RTP payload
2	DTMF_RX_MODE_INFO: SIP INFO (both application/dtmf-relay and application/dtmf)
4	DTMF_RX_MODE_INBAND detect inband DTMF (WARN: forces transcoding mode)

Encryption mode id

Value	Description
0	RTP/AVP and RTP/AVPF
1	RTP/SAVP and RTP/SAVPF (SRTP SDES)
2	UDP/TLS/RTP/SAVP and UDP/TLS/RTP/SAVPF (SRTP DTLS)
3	RTP/AVP and RTP/AVPF but use/check for zrtp_hash SDP a-line

Media Mode id

Value	Description
0	MEDIA_MODE_DISABLED ignore/reject in incoming Offer, do not announce in outgoing Offer
1	MEDIA_MODE_ENABLE_WHEN_OFFERED accept in incoming Offer, do not announce in outgoing Offer
2	MEDIA_MODE_ENABLED accept in incoming Offer, announce in outgoing Offer