Account XML¶

title¶

<title>Account Title</title>

username¶

<username>johndoe</username>

password¶

<password>secretPhrase</password>

userDisplayName¶

<userDisplayName>John Doe</userDisplayName>

authUsername¶

<authUsername>johndoe</authUsername>

host¶

<host>sip.example.com[:port]</host>

transport¶

<transport>udp</transport>``

userCallerId¶

<userCallerId>John Doe</userCallerId>

expires¶

<expires>600</expires>

allowMessage¶

<allowMessage>1</allowMessage>

proxy¶

<proxy>proxy.example.com[:port]</proxy>

• if <proxy> is empty, address = <host>, otherwise address = <proxy>

• if address is not numeric (a.b.c.d) and port is not specified in address, do a SRV DNS resolution for _sip._udp.address (or _sip._tcp.address)

  • if SRV record exists, address = DNSResultAddress:DNSResultPort
  • else use address

outboundProxy¶

<proxy>proxy.example.com[:port]</proxy>

• if <proxy> is empty, address = <host>, otherwise address = <proxy>

• if address is not numeric (a.b.c.d) and port is not specified in address, do a SRV DNS resolution for _sip._udp.address (or _sip._tcp.address)

  • if SRV record exists, address = DNSResultAddress:DNSResultPort
  • else use address

voiceMailNumber¶

<voiceMailNumber>*69</voiceMailNumber>

subscribeForVoicemail¶

<subscribeForVoicemail>1</subscribeForVoicemail>

codecOrder¶

<codecOrder>103,9,0,8,18,102,3</codecOrder>

0   :  G711 μ-law
3   :  GSM
8   :  G711 a-law
9   :  G722 wideband codec
102 :  iLBC
18  :  G729
103 :  Opus

codecOrder3G¶

<codecOrder3G>18,103,102,3,9,0,8</codecOrder3G>

honorTheirCodecListWiFi¶

<honorTheirCodecListWiFi>0</honorTheirCodecListWiFi>

honorTheirCodecList3G¶

<honorTheirCodecList3G>0</honorTheirCodecList3G>

ptime¶

<ptime>20</ptime>

ptime3G¶

<ptime3G>30</ptime3G>

forcePtime¶

<forcePtime>0</forcePtime>

forcePtime3G¶

<forcePtime3G>0</forcePtime3G>

opusOptions.class¶

<opusOptions.class>wb</opusOptions.class>
<opusOptions3G.class>nb</opusOptions3G.class>

opusOptions.bandwidth¶

<opusOptions.bandwidth>wb</opusOptions.bandwidth>
<opusOptions3G.bandwidth>nb</opusOptions3G.bandwidth>

opusOptions.complexity¶

<opusOptions.complexity></opusOptions.complexity>
<opusOptions3G.complexity>5</opusOptions3G.complexity>

opusOptions.bitrate¶

<opusOptions.bitrate>20500</opusOptions.bitrate>
<opusOptions3G.bitrate>15500</opusOptions3G.bitrate>

opusOptions.fec¶

<opusOptions.fec>1</opusOptions.fec>
<opusOptions3G.fec>1</opusOptions3G.fec>

opusOptions.dtx¶

<opusOptions.dtx>1</opusOptions.dtx>
<opusOptions3G.dtx>1</opusOptions3G.dtx>

opusOptions.vbr¶

<opusOptions.vbr>1</opusOptions.vbr>
<opusOptions3G.vbr>1</opusOptions3G.vbr>

opusOptions.expectedPacketLoss¶

<opusOptions.expectedPacketLoss>5</opusOptions.expectedPacketLoss>
<opusOptions3G.expectedPacketLoss>5</opusOptions3G.expectedPacketLoss>

videoCodecOrder¶

<videoCodecOrder>108,34,99</videoCodecOrder>

108 : VP8
34  : H263
99  : H264

videoCodecOrder3G¶

<videoCodecOrder3G>108,34,99</videoCodecOrder3G>

videoMinKbpsWifi and videoMaxKbpsWifi¶

<videoMinKbpsWifi>64</videoMinKbpsWifi>
<videoMaxKbpsWifi>384</videoMaxKbpsWifi>

videoMinKbps3G and videoMaxKbps3G¶

<videoMinKbps3G>64</videoMinKbps3G>
<videoMaxKbps3G>384</videoMaxKbps3G>

videoDimsWifi¶

<videoDimsWifi>qcif</videoDimsWifi>

videoDims3G¶

<videoDims3G>qcif</videoDims3G>

videoFPSWifi¶

<videoFPSWifi>15</videoFPSWifi>

videoFPS3G¶

<videoFPS3G>15</videoFPS3G>

autoSendVideoWifi¶

<autoSendVideoWifi>1</autoSendVideoWifi>

autoSendVideo3G¶

<autoSendVideo3G>1</autoSendVideo3G>

autoReceiveVideoWifi¶

<autoReceiveVideoWifi>1</autoReceiveVideoWifi>

autoReceiveVideo3G¶

<autoReceiveVideo3G>1</autoReceiveVideo3G>

dtmfOrder¶

<dtmfOrder>rfc2833,info,audio</dtmfOrder>

dtmfAll¶

<dtmfAll>0</dtmfAll>

STUN¶

<STUN>stun.example.com:[port]</STUN>

STUNUsername¶

<STUNUsername>user</STUNUsername>

STUNPassword¶

<STUNPassword>password</STUNPassword>

natTraversal¶

<natTraversal>auto</natTraversal>

ignoreSymmetricNat¶

<ignoreSymmetricNat>1</ignoreSymmetricNat>

iceDefaultCandidateOrder¶

<iceDefaultCandidateOrder>relay,srflx,host</iceDefaultCandidateOrder>

contactIP¶

<contactIP>internal</contactIP>

forcedContact¶

<forcedContact>192.168.100.100:7777</forcedContact>

sendAudioBack¶

<sendAudioBack>0</sendAudioBack>

keepAlive¶

<keepAlive>1</keepAlive>

keepAlivePeriod¶

<keepAlivePeriod>30</keepAlivePeriod>

rtpPortRangeStart and rtpPortRangeEnd¶

<rtpPortRangeStart>10000<rtpPortRangeStart>
<rtpPortRangeEnd>65530<rtpPortRangeEnd>

listeningPort¶

<listeningPort>5060</listeningPort>

maxTimeToWaitForWorkingNetworkInMilliseconds¶

<maxTimeToWaitForWorkingNetworkInMilliseconds>15000</maxTimeToWaitForWorkingNetworkInMilliseconds>

icm_auto¶

Deprecated since version C4AEB: builds after Dec 2016.

See icm instead.

<icm_auto>1</icm_auto>

Valid values: 0,1

Determines whether or not to use the global setting for incoming calls.

Default value is 1 which means the global setting for incoming calls will be used.

incomingDisabled¶

Deprecated since version C4AEB: builds after Dec 2016.

See icm instead.

<incomingDisabled>1</incomingDisabled>

Valid Values: 0,1

Default Value: N/A

pushMethod¶

Deprecated since version C4AEB: (builds after Dec 2016).

See icm instead.

<pushMethod>tunnel</pushMethod>

Valid Values: off, tunnel

Enables Push Notifications for incoming calls.

Default: N/A

bgrEnabled¶

Deprecated since version C4AEB: builds after Dec 2016.

See icm instead.

<bgrEnabled>1</bgrEnabled>

Valid Values: 0,1

Enables backgrounding for incoming calls (1 is enabled).

Default Value: N/A

Note: The transport protocol must be TCP or TLS for backgrounding to work.

forceRegistration¶

Deprecated since version C4AEB: builds after Dec 2016.

See icm instead.

<forceRegistration>1</forceRegistration>

Valid Values: 0,1

Forces registration when incoming calls are off. Use 1 to force registration, only necessary if using incoming calls off with registration.

Default Value: N/A

<icm_auto>0</icm_auto>
<pushMethod>tunnel</pushMethod>

icm¶

New in version C4AEB: builds after Dec 2016.

<icm>auto</icm>

From Dec 2016, the incoming call mode configuration has been greatly simplified. The properties above have been deprecated (if you set them, the apps will still migrate them to the icm property though.

Valid Values: auto, push, keepAwake, off

Specifies the incoming call mode to be used for this account. If “auto” is set, the mode is taken from global app settings.

Default Value: auto

requiresRegistrationForOutgoingCalls¶

New in version C4AEB: builds after Dec 2016.

<requiresRegistrationForOutgoingCalls>1</requiresRegistrationForOutgoingCalls>

Valid Values: 0,1

When icm is set to off, the app will not register for incoming calls. When it makes an outgoing call, some SIP backends will reject it because they only accept call attempts from registered endpoints.

In case this parameter is set to 1, we will register the account when the outgoing call is made and keep it registered for the duration of the call.

Default Value: 1

pushBlockReg¶

<pushBlockReg>1</pushBlockReg>

Default value: 0

Setting to 1 blocks registration on the device until any Pushed incoming call has ended.

remoteContact¶

<remoteContact>pai,from,rpid,ppi</remoteContact>

Default value: as above

Specifies where in the incoming INVITE packet should we look for calling party identification. The value is a coma- separated list of identifiers described below. When incoming INVITE packet is received, we look for the remote party identification at places defined by the order here and use the first found value:

identifier	SIP header
pai	P-Asserted-Identity header
from	From header
rpid	Remote-Party-ID header
ppi	P-Preferred-Identity header

extProvUrl¶

<extProvUrl>https://my.server.com/prov.php?u=%account[username]%&amp;p=%account[password]%</extProvUrl>

Default value: empty.

Reprovisioning URL, the app will ask this URL for complete account details. The service is expected to return <account> with all the required properties.

extProvInterval¶

<extProvInterval>3600</extProvInterval>

Default value: 0

How often (in seconds) will the app ask the reprovisioning service for account updates. If the value is 0, the periodic reprovisioning is disabled and reprovisioning URL is contacted only when saving the account on Edit Account screen.

wcb_enabled¶

<wcb_enabled>1</wcb_enabled>

Default value: 0

This node is used to enable/disable web callback web service.

Other properties:

wcb_url
wcb_method
wcb_contentType
wcb_postData
wcb_customHeaders

cth_enabled¶

<cth_enabled>1</cth_enabled>

Default value: 0

This node is used to enable/disable callthrough service.

cth_dialString¶

<cth_dialString>1</cth_dialString>

Default value: 0

This dial string to dial via GSM for callthrough service. The dial string may use placeholder replacement described in Global parameters and Account parameters scopes.

cth_ws_enabled¶

<cth_ws_enabled>1</cth_ws_enabled>

Default value: 0

This node is used to enable/disable callthrough service via a web service. The web service and its parameters are described in detail in Web Call-Through page.

Properties:

cth_ws_url
cth_ws_method
cth_ws_contentType
cth_ws_postData
cth_ws_customHeaders

forwardingEnabled¶

<forwardingEnabled>1</forwardingEnabled>

Default value: 0

When set to 1, any incoming call will be automatically forwarded to the number defined in forwardingNumber field.

forwardingNumber¶

<forwardingNumber>500</forwardingNumber>

Default value: empty.

All incoming calls are redirected to the number you specify.

vpnStartupUrl¶

<vpnStartupUrl>https://my.server.com/dummy</vpnStartupUrl>

Default value: empty

If non empty, the web service is called before every registration attempt. Sometimes it’s required to bring VPN up.

Elementary Tones¶

sine( duration, amplitude, freqs… )

Creates a sine wave of given duration and amplitude. In case more than one frequency is specified, the tone will play the sine waves of given frequencies simultaneously.

silence( duration )

Plays a silence of given duration.

wav( identifier )

Plays a WAV or CAF file. The files should be PCM or ADPCM (ima4) encoded, 8 or 16KHz. Stereo files are converted to mono.

On iOS, it should specify filename with extension, the library will first search in NSApplicationSupportDirectory, if not found, then in bundle resourcePath.

On Android, the parameter should be asset filename.

Tone Operators¶

periodic( tones… )

Plays the given tone segments in a loop. Tones may be any elementary tones, or compound tone.

compound( tones… )

Plays the given tones simultaneously. For simultaneous sine waves, a shortcut syntax of sine(…) with multiple frequencies is easier to write.

tryingTone

<tryingTone>periodic(sine(50ms,500,440Hz),silence(40ms))</tryingTone>

Played when outgoing call is being establishes, before we get Ringing notification from the remote side.

ringingTone

<ringingTone>periodic(sine(2000ms,2500,440Hz),silence(4000ms))</ringingTone>

Played when outgoing call is ringing at the remote side.

endCallTone

<endCallTone>periodic(sine(300ms,1000,400Hz),silence(400ms),sine(300ms,1000,400Hz),silence(400ms),sine(300ms,1000,400Hz),silence(700000ms))</endCallTone>

Played to notify local user that the remote party hung up the call.

busyTone

<busyTone>periodic(sine(500ms,2000,400Hz),silence(500ms))</busyTone>

Played when we receive “Busy” answer on outgoing call.

callWaitingTone

<callWaitingTone>periodic(silence(1000ms),sine(300ms,7500,440Hz),silence(9000ms))</callWaitingTone>

Played in case there is an established call and another incoming call is waiting to be answered.

zrtpHandshakeTone

<zrtpHandshakeTone>periodic(sine(50ms,500,400Hz,450Hz),silence(80ms))</zrtpHandshakeTone>

Played during ZRTP handshake.