AnonymousClass SIPml.Stack.Configuration
SIPml.Stack.Configuration
Defined in: SIPml.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Anonymous SIP Stack configuration object.
|
Field Attributes | Field Name and Description |
---|---|
The display name to use in SIP requests.
|
|
Whether to enable the Click2Call / Click2Dial service.
|
|
Whether to enable the RTCWeb Breaker module to allow calling SIP-legacy networks.
|
|
Object to subscribe to some events.
|
|
The list of the STUN/TURN servers to use.
|
|
The authentication name.
|
|
The full SIP uri address.
|
|
The outbound Proxy URL is used to set the destination IP address and Port to use for all outgoing requests regardless the domain name (a.k.a realm).
|
|
The password to use for SIP authentication.
|
|
The domain name.
|
|
Stack-level SIP headers to add to all outgoing requests.
|
|
The websocket proxy url to connect to (SIP server or gateway address).
|
AnonymousClass Detail
SIPml.Stack.Configuration
Anonymous SIP Stack configuration object.
var configuration = { realm: 'example.org', impi: 'bob', impu: 'sip:bob@example.org', password: 'mysecret', // optional display_name: 'I Am Legend', // optional websocket_proxy_url: 'ws://192.168.0.10:5060', // optional outbound_proxy_url: 'udp://192.168.0.12:5060', // optional enable_rtcweb_breaker: true, // optional enable_click2call: false, // optional events_listener: { events: '*', listener: listenerFunc }, //optional sip_headers: [ //optional {name: 'User-Agent', value: 'IM-client/OMA1.0 sipML5-v1.0.89.0'}, {name: 'Organization', value: 'Doubango Telecom'} ] };
Field Detail
{String}
display_name
The display name to use in SIP requests. This is the String displayed by the called party for incoming calls.
Example: I Am Legend
Example: I Am Legend
{Boolean}
enable_click2call
Whether to enable the Click2Call / Click2Dial service.
Available since version 1.2.181.
Example: true
{Boolean}
enable_rtcweb_breaker
Whether to enable the RTCWeb Breaker module to allow calling SIP-legacy networks.
Example: true
{Object}
events_listener
Object to subscribe to some events.
Example:
- { events: '*', listener: function(e){} }
- { events: 'started', listener: function(e){} }
- { events: ['started', 'stopped'], listener: function(e){} }
{Array}
ice_servers
The list of the STUN/TURN servers to use. The format must be as explained at http://www.w3.org/TR/webrtc/#rtciceserver-type.
Example: [{ url: 'stun:stun.l.google.com:19302'}, { url:'turn:user@numb.viagenie.ca', credential:'myPassword'}]
{String}
impi
The authentication name. Required for stack constructor but optional when used with setConfiguration.
Example: +33600000000 or bob.
Example: +33600000000 or bob.
{string}
impu
The full SIP uri address. Required for stack constructor but optional when used with setConfiguration.
Example: sip:+33600000000@example.com or tel:+33600000000 or sip:bob@example.com
Example: sip:+33600000000@example.com or tel:+33600000000 or sip:bob@example.com
{String}
outbound_proxy_url
The outbound Proxy URL is used to set the destination IP address and Port to use for all outgoing requests regardless the domain name (a.k.a realm).
This is a good option for developers using a SIP domain name without valid DNS A/NAPTR/SRV records. You should not set this value unless you know what you're doing.
Example: udp://192.168.0.12:5060
This is a good option for developers using a SIP domain name without valid DNS A/NAPTR/SRV records. You should not set this value unless you know what you're doing.
Example: udp://192.168.0.12:5060
{String}
password
The password to use for SIP authentication.
Example: mysecret
Example: mysecret
{String}
realm
The domain name. Required for stack constructor but optional when used with setConfiguration.
Example: example.org
Example: example.org
{Array}
sip_headers
Stack-level SIP headers to add to all outgoing requests. Each header is an object with a name and value fields.
Example: sip_headers: [{name: 'User-Agent', value: 'IM-client/OMA1.0 sipML5-v1.0.89.0'}, {name: 'Organization', value: 'Doubango Telecom'}]
Example: sip_headers: [{name: 'User-Agent', value: 'IM-client/OMA1.0 sipML5-v1.0.89.0'}, {name: 'Organization', value: 'Doubango Telecom'}]
{String}
websocket_proxy_url
The websocket proxy url to connect to (SIP server or gateway address). If unset the stack will use sipml5.org as host and a random port. You should not set this value unless you know what you're doing.
Example: ws://sipml5.org:5060
Example: ws://sipml5.org:5060