End of Life Products and Features - sip_settings.save
Description
Save global SIP parameters.
Arguments
name | value type | default value |
|---|---|---|
pedantic | 0/1 | 1 |
compactheaders | 0/1 | 0 |
sdpowner | string | root |
disallowed_methods | array of SIP methods: ACK, BYE, CANCEL, OPTIONS, REGISTER, PRACK, SUBSCRIBE, NOTIFY, PUBLISH, INFO, REFER, MESSAGE, UPDATE |
|
shrinkcallerid | 0/1 | 0 |
maxexpiry | number | 3600 |
minexpiry | number | 60 |
defaultexpiry | number | 120 |
registertimeout | number | 20 |
registerattempts | number | 0 |
udpbindaddr | <UDP Bind IP Address>:<UDP Bind port #> | 0.0.0.0:5060 |
tcpenable | 0/1 | 0 |
tcpbindaddr | <TCP Bind IP Address>:<TCP Bind port #> | 0.0.0.0:5060 |
tcpauthtimeout | number |
|
tcpauthlimit | number |
|
srvlookup | 0/1 | 1 |
matchexternaddrlocally | 0/1 | 0 |
dynamic_exclude_static | 0/1 | 0 |
localnet | array of ip ranges |
|
externtcpport | port number |
|
externhost | domain or IP address |
|
externrefresh | number |
|
rtpstart | port number | 10000 |
rtpend | port number | 12000 |
match_auth_username | 0/1 | 0 |
realm | string |
|
domainasrealm | 0/1 | 0 |
alwaysauthreject | 0/1 | 0 |
auth_options_request | 0/1 | 0 |
allowguest | 0/1 | 0 |
prematuremedia | 0/1 | 0 |
tos_sip | string |
|
tos_audio | string |
|
subscribe_network_change_event | 0 |
|
jbenable | 1 |
|
Example Requests & Responses
Example One
Request
Save one or more global SIP parameters.
{
'method' => 'sip_settings.save',
'parameters' => {
'udptlfecentries' => '3',
'domainasrealm' => 0,
'tcpbindaddr' => '0.0.0.0:5060',
'srvlookup' => 1,
'tcpauthlimit' => '99',
'registertimeout' => '20',
'registerattempts' => '0',
'maxexpiry' => '3600',
'minexpiry' => '60',
'pedantic' => 0,
'alwaysauthreject' => 0,
'externrefresh' => '180',
'tos_sip' => 'cs3',
'subscribe_network_change_event' => 0,
'tos_audio' => 'ef',
'dynamic_exclude_static' => 0,
'rtpstart' => '10000',
'externtcpport' => '5060',
'use_even_ports' => 0,
'match_auth_username' => 0,
'prematuremedia' => 1,
'matchexternaddrlocally' => 0,
'tcpauthtimeout' => '30',
'udptlchecksums' => 0,
'udptlend' => '4999',
'udpbindaddr' => '0.0.0.0:5061',
'tcpenable' => 0,
'realm' => '',
'disallowed_methods' => [],
'localnet' => [],
'udptlfecspan' => '3',
'externhost' => '',
'udptlstart' => '4000',
'shrinkcallerid' => 1,
'jbenable' => 1,
'compactheaders' => 0,
'defaultexpiry' => '120',
'allowguest' => 0,
'sdpowner' => 'root',
'auth_options_request' => 0
}
} |
Response
{
'result' => 'success'
} |
Or
{
'result' => 'error',
'error' => 'An Error String',
} |