- Contents
SIP Bulk Caller Technical Reference
Explanation of Outbound Callset Configuration File
|
Element |
Explanation |
|
|
MaximumCalls |
The callset stops after making the number of calls set in MaximumCalls. If the value of MaximumCalls is -1, then the callset runs continuously until the user stops it. |
|
|
ActiveCalls |
The number of calls that can be active simultaneously. If Interaction SIP Bulk Caller reaches this limit, then it stops placing new calls until a call is disconnected. |
|
|
Burst |
The total number of new calls placed together as a burst. |
|
|
BurstRange |
If you want to set up a variable burst rate, then use the BurstRange element instead of Burst. For example, <BurstRange Type="Sequence" StartNumber="2" EndNumber="20" IncrStep="1"/> This code specifies the range of burst and the size of the increment step. If incrstep is set to 2, then burst would be 2,4,6,...,20. If type is Sequence, then the first burst of calls would be 2, the next would be 4, and so on in the cycle. If the type is Random, then the burst could have any value in the range of 2,4,6, … 20. |
|
|
InterBurstDelay |
The delay in seconds between two bursts of calls. For example, if Burst=6 and InterBurstDelay=2, then Interaction SIP Bulk Caller places six calls every two seconds. You can also use decimal values in increments of 0.5, such as 0.5, 1, 1.5, and 2. For example, if Burst=3 and InterBurstDelay=0.5, then Interaction SIP Bulk Caller places three calls every 0.5 seconds. Remember that even if you have a high burst rate, Interaction SIP Bulk Caller stops placing new calls after it reaches the ActiveCalls limit until old calls get disconnected. |
|
|
MaxCallWarmDownTime |
This value is in seconds and the default value is 0. Use this parameter to insert a delay when outbound callset reaches its activecall limit and then a call gets disconnected. Before placing new call, Interaction SIP Bulk Caller waits for the number of seconds that this value specifies. This is used most often when calls are placed to a PBX or gateway where a delay is required to clear the channel before placing a new call. |
|
|
CallDurationWarning |
This value is in seconds and the default value is 900 seconds (15 minutes). If call duration exceeds this value, then Interaction SIP Bulk Caller stores it as a warning message in its logs. This is used to track hung calls. |
|
|
MediaType |
The MediaType values are Normal and Delayed. In a delayed media type, media information is sent in ACK. The default value is Normal. |
|
|
NoAnswerSeconds |
This is the number of seconds for the sipengine will wait for a response. If a response is not received in the specified time, then the sipengine sends a disconnect message for the call. The default value is 30 seconds. |
|
|
AutoStart |
This is a Boolean (true or false) value. If this is set to true, then the callset starts automatically when the Interaction SIP Bulk Caller service starts. |
|
|
ToAddressList |
This is a list of addresses where you want to send SIP calls. Interaction SIP Bulk Caller sends calls to the addresses in either RoundRobin or Random mode based on the Type attribute value. The default is RoundRobin. |
|
|
Address |
This contains CallerIds and SIP addresses where Interaction SIP Bulk Caller can send SIP calls. |
|
|
AddressRange |
You can use this element with a range of addresses in sequence. For example, SIP addresses might be added as sip:5001@icserver1, sip:5002@icserver1, sip:5003@icserver1, ... upto sip:5100@icserver1. |
|
|
FromAddressList |
This is a list of "from" addresses. |
|
|
Script |
The Script consists of one or more Actions to execute in the SIP call. |
|
|
AudioFormat |
The format of the audio data to play. Acceptable values are G711, G711A, G722, G726, G729AB, G729A, or GSM. Note that current Audiolib (HPAA) supports 8-bit 8 KHz CCITT u-law, 8-bit 8 KHz CCITT a-law, 8-bit 8 KHZ GSM, and 16-bit linear PCM for audio wav files. If your audio wav file is not in one of these formats, then manually convert it before using it in Interaction SIP Bulk Caller. |
|
|
RFC2833Dtmf |
This is a Boolean (true or false) value. If it is set to true, then Interaction SIP Bulk Caller sends an RFC2833 event for Dtmf tones. If it is set to false, then Interaction SIP Bulk Caller sends inband dtmf. |
|
|
AbsoluteCallLength |
If this value is 0, then Interaction SIP Bulk Caller ignores it. If it is greater than 0, Interaction SIP Bulk Caller cuts off the call after the number of seconds specified in AbsoluteCallLength. This parameter ensures that the length of SIP calls will not exceed the time specified in AbsoluteCallLength even if calls are transferred from station to station. |
|
|
CheckAudioFiles |
When you load the callset, Interaction SIP Bulk Caller checks the audio file using the callset. If you set this value to false, then Interaction SIP Bulk Caller does not do this check. |
|
|
SendPTime |
Packetization interval in milliseconds of audio sent by the script. Valid values are 10 - 160. For G729A and G729AB, the value is rounded up to the next multiple of 10 ms. This setting has no effect on:
With or without this setting, SIP Bulk Caller ignores any a=ptime and a=maxptime lines in the SDP it receives. |
|
|
Wait Action |
This specifies the number of seconds that a call will send silence RTP packets. |
|
|
Dtmf Action |
Each call plays the dtmf digits specified in the Digits attribute. There is a delay of InterDigitDelay milliseconds between two dtmf digit play. You can also set the duration in milliseconds of each tone. |
|
|
SequenceDtmf Action |
Each call plays different dtmf digits in sequence from StartDigits to EndDigits. For example, the first call might play Dtmf 1000, the second call might play Dtmf 1001, and so on up to Dtmf 2000. After reaching EndDigits Dtmf, the cycle repeats. |
|
|
RandomDtmf Action |
Each call plays different random dtmf digits between StartDigits and EndDigits. For example, a call might play any dtmf digits between 1000 and 2000. |
|
|
Play Action |
Each call plays an audio wav file. In the FileName attribute, put only the name of the audio file; do not include the directory path. If the Play action has a Duration attribute, then a call will play audio file up to the duration. |
|
|
RandomPlay Action |
Each call randomly selects one file from files listed in this action and plays its full length. If the RandomPlay action has a Duration attribute, then the call will play the audio file until the end of the specified duration. |
|
|
SequencePlay Action |
Each call selects an audio file in sequence and plays its full length. The first call plays the first audio file, the second call plays the second audio file, and so on. If the SequencePlay action has a Duration attribute, then calls play the audio file until the end of the specified duration. |
|
|
Fax Action |
This lets you specify the outbound calls as faxes. Interaction SIP Bulk Caller supports T.30 and T.38 fax transmission. To send a fax, add this code to the configuration file: <Action Type="Fax" Direction="Send" FileName="FaxSend.tif"/> Note that a .TIFF file (same as the FileName attribute) must be presentin the resource directory for fax send. In the example, the file FaxSend.tifmust be in the resource directory. TIFF files generated by the CIC Fax Client are not supported attime of releaseby the MediaServer Audio library that SIPBulkCaller uses. |
|
|
Hold Action |
Each call can be placed on hold. In the Filename attribute, put only the name of the audio file. If the Hold action has a Duration attribute, then the hold lasts for the specified duration. The Hold makes the SBC send a SIP UPDATE message to the remote user agent (UA). This action simulates pressing a Hold button on an IP phone. If the Filename attribute is empty ( “”), the SBC sends the unspecified IP (0.0.0.0 or ::) address in the SIP UPDATE message depending on the IP family SIP Line config setting. |
|

