line
Represents the line configuration object.
Complex Type: configurationId
The unique identifier. The value must conform to all of these criteria:
- Is a value containing none of the characters '
\
', '"
', or '|
'. - Is a string with from 1 to 50 characters.
This property is required to be present in POST operations.
Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
String
Required
The unique identifier used to reference this configuration object.
String
The display name of this configuration object.
This property can be null.
Uri
A URI used to access this configuration object.
DateTime
The date this configuration object was created.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
List [Unbounded]: Complex Type: customAttribute
The custom attributes for the configuration object.
This property can be null.
List item type documentation:
Represents a Custom Attribute value for a configuration object.
String
Required
The key identifying this pair.
String
Required
The value of this pair.
This property can be null.
DateTime
The date this configuration object was last modified.
This is a read only property and can not be changed with PUT or POST operations.
This property can be null.
String
The notes for this configuration object.
This property can be null.
Boolean
Activates or deactivates the line in the CIC system.
You can not deactivate a line if any calls are on the line.
If you change line configuration parameters or to perform
other line maintenance, you may have to deactivate a line and then reactivate it in order for the changes to take effect. For example, if you change the SIP line transport protocol.
Note
Genesys counts only active lines to determine whether you are in compliance with your license agreement.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
String
The actual name of your network adapter. Determines the local server IP address. This value is typically Local Area Connection because that is the default network adapter name that Windows uses. The value must conform to all of these criteria:
- Is the name of a valid, existing network adapter on the IC Server.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Enumeration: lineAddressFamily
Sets the family of addresses to which CIC listens. CIC listens to all IP address assigned to each family.
This option is available only if the EnableIPv6 server parameter is set to 1 (true).
- IPv4
- IPv6
- Telephony Default (IPv4 and IPv6). The host name resolves to both IPv4 and IPv6.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Boolean
Indicates whether to delay answering an incoming call until an agent is reached or an IVR system is entered.
This gives callers time to disconnect the call without being charged by their telecommunications provider.
Note
Deferred answer is not used with ACD calls. If a call is placed to the DID of an ACD workgroup, interactions are immediately answered before alerting occurs.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
allowMultipleCodecsInOutboundSDPOffer Boolean
Allows multiple codecs to be offered in an outbound SDP Offer.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Boolean
Determines whether ASR (Automatic Speech Recognition) resources are allocated for this SIP line.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Enumeration: lineAudioPath
See the latest version of "SIP Application Note" on the Product Information site.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Enumeration: lineAudioProtocol
Indicates whether the audio stream is unencrypted or encrypted.
The options are:
- RTP
- RTP (Real Time Protocol): The audio stream is unencrypted.
- SRTP
- The audio stream is encrypted. This option is available only if you select the TLS transport protocol. Select SRTP only if the endpoint(s) on this line support SRTP.
If you select SRTP, the Security option is also available. Calls between devices that transmit and receive SIP TLS messages and SRTP audio are completely secure.
The value must conform to all of these criteria:
- If this property is present, the other property
TransportProtocol
must have the value TLS, if this property's value equals SRTP.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Boolean
Determines whether authentication is enabled for this SIP line. The value must conform to all of these criteria:
- If this property is present, the other property
AuthenticationUsername
must not have the value null
, if this property's value equals true. - If this property is present, the other property
AuthenticationPassword
must not have the value null
, if this property's value equals true.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
String
Specifies the Password that is used in the authentication process. The value must conform to all of these criteria:
- The following additional properties must also be included in requests that contain this property: '
AuthenticationUsername
'. - If this property is present, the other property
Authentication
must have the value true.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
String
Specifies the User Name that is used in the authentication process. The value must conform to all of these criteria:
- The following additional properties must also be included in requests that contain this property: '
AuthenticationPassword
'. - If this property is present, the other property
Authentication
must have the value true.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
autoDisconnectWhenSilenceDetectedInVoicemail Boolean
Designates whether CIC automatically disconnects a call that is in voice mail after a certain number of seconds of silence.
This option is important if your CO (public exchange switch) does not send a disconnect signal (a forward disconnect notice) when a caller disconnects a call.
If true, when a call is left in voice mail, CIC waits for the number of seconds of silence that you specify in silenceTime, and then it automatically disconnects the call.
If the CO does not send a disconnect signal, and if this is false, then the voice mail will continue to record silence.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
String
The line's board type.
This is a read only property and can not be changed with PUT or POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
This property can be null.
Enumeration: lineCallAnalysisType
Indicates the call analysis type for this SIP line. The options are:
- Media Server
- The Media server listens to the RTP stream and performs call analysis. Use this option with a third-party gateway.
- Interaction Gateway (Gen2 only; not recommended for new deployments)
- The CIC server defers to the Interaction Gateway, which listens to the TDM (ISDN) lines and returns the results via SIP messages. Do not use this option with Interaction Gateway.
- Media Server to Interaction Gateway
- Interaction Gateway and Media Server are both used; the Media Server performs call analysis. This is the preferred setting to use with Interaction Gateway and Interaction Gateway Gen2.
Do not use this option with any third-party gateway.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
mediaServerToInteractionGateway 1
List [Unbounded]: String
Specifies the headers that are collected from the initial inbound INVITE message and transferred to the outbound INVITE message to the partner or connection call.
Define the header for use by both the inbound line and the outbound line.
Is a collection of items that each conform to all of these criteria:
- Is a value matching the regular expression '^[0-9a-zA-Z\.\!%\*-\+`'~]+$'.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
This property can be null.
Property type documentation:
Represents a collection of strings.
Enumeration: lineCalledAddressSelection
Designates the local selection method.
The options are:
- Use Request URI
- Displays the destination address in the form sip:counsel@acme.com.
- Use 'To' header
-
Displays the "To" field in the SIP header as the called address (the destination address).
If the field contains both a URI and a display name, then both of these items are displayed.
For example, "Patty Johnson" sip:counsel@acme.com. If the field contains only a display name, then it is displayed alone. For example, "Patty Johnson".
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
calledAddressSendExtension Enumeration: lineSendExtension
Determines whether CIC dials an extension if one is passed. If this option is selected, then CIC dials it after "/."
The options are:>
- None
- CIC does not include the extension in the SIP message.
- Post Connect
- After the call connects, CIC sends the extension as DTMF tones.
- Use 'ext='.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
callingAddressDiversionMethod Enumeration: lineDiversionMethod
Sets how an outbound call on this line is indicated to the network.
The Use 'Diversion' Header setting causes the line to use a header with diversion information, such as the origination address or the most recent address.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
callingAddressDivertedCallsDivertedHeaderAddress Enumeration: lineCallingAddressDivertedCalls
Sets the value that appears as the destination address in the diversion header for an outbound SIP interaction that is redirected. This is typically a follow-me interaction or forwarded interaction.
The options are:
- Use line value 1
- Displays the value in the Line Value 1 field.
- Use line value 2
- Displays the value in the Line Value 2 field.
- Use passed value if present
- Displays the address value that the handlers pass. If the handlers do not pass a value then CIC displays the CIC user 1 outbound ANI, if it is configured.
For example, "CIC User 1 Outbound ANI" sip:+13178723000@ICServer.ININ.com.
- Use diverted value
- Displays the CIC user 1 outbound ANI, if it is configured. For example, "CIC User 1 Outbound ANI" tel:+13178723000.
- None
- Displays neither the address nor the name.
The value must conform to all of these criteria:
- If this property is present, the other property
CallingAddressLineValueAddress2
must not have the value null
, if this property's value equals UseLine2Value.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
callingAddressDivertedCallsDivertedHeaderName Enumeration: lineCallingAddressDivertedCalls
Sets the value that appears as the destination name in the diversion header for an outbound SIP interaction that is redirected. This is typically a follow-me or forwarded interaction.
The options are:
- Use line value 1
- Displays the value in the Line Value 1 field.
- Use line value 2
- Displays the value in the Line Value 2 field.
- Select "Use passed value if present
- Displays the name value that the handlers pass. If the handlers do not pass a value then CIC displays the CIC user 1 display name, if the user's outbound ANI is configured.
For example, "CIC User 1 display name" sip:+13178723000@ICServer.ININ.com.
- Use diverted value
- Displays the CIC user 1 display name if the user's outbound ANI is configured. For example, "CIC User 1 display name" sip:+13178723000@ICServer.ININ.com.
- None
- Displays neither the address nor the name.
Note
This setting is unavailable if callingAddressDivertedCallsDivertedHeaderAddress is set to None.
The value must conform to all of these criteria:
- If this property is present, the other property
CallingAddressDivertedCallsDivertedHeaderAddress
must not have the value UseNone, if this property's value doesn't equal UseNone.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
callingAddressDivertedCallsFromHeaderAddress Enumeration: lineCallingAddressDivertedCallsFromHeaderAddress
Sets the value that appears as the local address in an outbound SIP interaction that is redirected. This is typically a follow-me or forwarded interaction.
The options are:
- Use line value 1
- Displays the value in the Line Value 1 field.
- Use line value 2
- Displays the value in the Line Value 2 field.
- Use passed value if present
- Displays the CIC calling user 1 outbound ANI. For example, "User 1 Name if Present" sip:+13178723000@ICServer.ININ.com.
For external to follow-me interactions and forwarded interactions, CIC displays the From address of the external device.
- Use diverted value
- Displays the CIC user 2 outbound ANI. For example, "User 2 Name if Present" sip:+13178723000@ICServer.ININ.com.
The value must conform to all of these criteria:
- If this property is present, the other property
CallingAddressLineValueAddress2
must not have the value null
, if this property's value equals UseLine2Value.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
callingAddressDivertedCallsFromHeaderHame Enumeration: lineCallingAddressDivertedCalls
Sets the value that appears as the local name in an outbound SIP interaction that is redirected. This is typically a follow-me or forwarded interaction.
The options are:
- Use line value 1
- Displays the value in the Line Value 1 field.
- Use line value 2
- Displays the value in the Line Value 2 field.
- Use passed value if present
- Displays the CIC calling user 1 display name, if the user's outbound ANI is configured. For example, "CIC User 1 display name" sip:+13178723000@ICServer.ININ.com.
For external to follow-me interactions and forwarded interactions, CIC displays the From name of the external device.
- Use diverted value
- Displays the CIC user 2 display name if the user's outbound ANI is configured. For example, "CIC User 2 display name" sip:+13178723000@ICServer.ININ.com.
- None
- displays the address only.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
callingAddressDivertedCallsPAssertedIdentityAddress Enumeration: lineCallingAddressDivertedCalls
Sets the value that appears as the authenticated local address in an outbound SIP interaction that is redirected. This is typically a follow-me interaction or a forwarded interaction.
The options are:
- Use line value 1
- Displays the value in the Line Value 1 field.
- Use line value 2
- Displays the value in the Line Value 2 field.
- Use passed value if present
- Displays the CIC calling user 1 outbound ANI. For example, "User 1 Name if Present" sip:+13178723000@ICServer.ININ.com.
For external to follow-me interactions or forwarded interactions, CIC displays the authenticated From address of the external device.
- Use diverted value
- Displays the CIC user 2 outbound ANI. For example, "User 2 Name if present" sip:+13178723000@ICServer.ININ.com.
- None
- displays neither the address nor the name.
The value must conform to all of these criteria:
- If this property is present, the other property
CallingAddressLineValueAddress2
must not have the value null
, if this property's value equals UseLine2Value.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
callingAddressDivertedCallsPAssertedIdentityName Enumeration: lineCallingAddressDivertedCalls
Sets the value that appears as the authenticated local name in an outbound SIP interaction that is redirected. This is typically a follow-me interaction or a forwarded interaction.
The options are:
- Use line value 1
- Displays the value in the Line Value 1 field.
- Use line value 2
- Displays the value in the Line Value 2 field.
- Use passed value if present
- Displays the name value that the handlers pass. If the handlers do not pass a value, then CIC displays the user's outbound ANI, if it is configured.
For example, "CIC user's Outbound ANI" sip:+13178723000@ICServer.ININ.com. For external to follow-me interactions or forward interactions,
CIC displays the authenticated From name of the external device.
- Use diverted value
- Displays the CIC user 1 display name if the user's outbound ANI is configured. For example, "CIC User 1 display name" sip:+13178723000@ICServer.ININ.com.
- None
- Displays the address only.
Note
This option is unavailable if callingAddressDivertedCallsPAssertedIdentityAddress is set to None.
The value must conform to all of these criteria:
- If this property is present, the other property
CallingAddressDivertedCallsPAssertedIdentityAddress
must not have the value UseNone, if this property's value doesn't equal UseNone.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
callingAddressLineValueAddress1 String
Sets the first calling address line value address.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
callingAddressLineValueAddress2 String
Sets the second calling address line value address. The value must conform to all of these criteria:
- If this property is present, the other property
CallingAddressNormalCallsFromHeaderAddress
must not have the value UseLine2Value, if this property's value equals null. - If this property is present, the other property
CallingAddressNormalCallsPAssertedIdentityHeaderAddress
must not have the value UseLine2Value, if this property's value equals null. - If this property is present, the other property
CallingAddressNormalCallsDivertedHeaderAddress
must not have the value UseLine2Value, if this property's value equals null. - If this property is present, the other property
CallingAddressDivertedCallsFromHeaderAddress
must not have the value UseLine2Value, if this property's value equals null. - If this property is present, the other property
CallingAddressDivertedCallsPAssertedIdentityAddress
must not have the value UseLine2Value, if this property's value equals null. - If this property is present, the other property
CallingAddressDivertedCallsDivertedHeaderAddress
must not have the value UseLine2Value, if this property's value equals null.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
This property can be null.
callingAddressLineValueName1 String
Sets the first calling address line value name.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
This property can be null.
callingAddressLineValueName2 String
Sets the second calling address line value name.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
This property can be null.
callingAddressNormalCallsDivertedHeaderAddress Enumeration: lineCallingAddressNormalCalls
Sets the value that appears as the destination address in the diversion header for the outbound SIP interaction.
The options are:
- Use line value 1
- Displays the value in the Line Value 1 field.
- Use line value 2
- Displays the value in the Line Value 2 field.
- Use passed value if present
- Displays the address value that the handlers pass. If the handlers do not pass a value then CIC uses the CIC user's outbound ANI. For example, "Name if Present" tel:+13178723000.
- None
- Displays neither the address nor the name.
The value must conform to all of these criteria:
- If this property is present, the other property
CallingAddressLineValueAddress2
must not have the value null
, if this property's value equals UseLine2Value.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
callingAddressNormalCallsDivertedHeaderName Enumeration: lineCallingAddressNormalCalls
Sets the value that appears as the destination name in the diversion header for an outbound SIP interaction.
The options are:
- Use line value 1
- Displays the value in the Line Value 1 field.
- Use line value 2
- Displays the value in the Line Value 2 field.
- Use passed value if present
- Displays the name value that the handlers pass. If the handlers do not pass a value, and if the CIC user's outbound ANI is configured, then CIC displays the CIC user's display name.
For example, "CIC User's Display Name" tel:+13178723000.
- None
- Displays neither the address nor the name.
Note
This setting is not available if callingAddressNormalCallsDivertedHeaderAddress is set to None.
The value must conform to all of these criteria:
- If this property is present, the other property
CallingAddressNormalCallsDivertedHeaderAddress
must not have the value UseNone, if this property's value doesn't equal UseNone.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
callingAddressNormalCallsFromHeaderAddress Enumeration: lineCallingAddressNormalCallsFromHeaderAddress
Sets the value that appears as the local address in an outbound SIP interaction that is not diverted or redirected.
The options are:
- Use line value 1
- Displays the value in the Line Value 1 field.
- Use line value 2
- Displays the value in the Line Value 2 field.
- Use passed value if present
- Displays the CIC user's outbound ANI. For example, "Name if present" sip:+13178723000@ICServer.ININ.com.
The value must conform to all of these criteria:
- If this property is present, the other property
CallingAddressLineValueAddress2
must not have the value null
, if this property's value equals UseLine2Value.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
callingAddressNormalCallsFromHeaderName Enumeration: lineCallingAddressNormalCalls
Sets the value that appears as the local name in an outbound SIP interaction that is not diverted or redirected.
The options are:
- Use line value 1
- Displays the value in the Line Value 1 field.
- Use line value 2
- Displays the value in the Line Value 2 field.
- Use passed value if present
- Displays the name value that the handlers pass. If the handlers do not pass a value, and if the CIC user's outbound ANI is configured, then CIC uses the CIC user's display name.
For example, "CIC User's Display Name" sip:+13178723000@ICServer.ININ.com.
- None
- Displays neither the address nor the name.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
callingAddressNormalCallsPAssertedIdentityHeaderAddress Enumeration: lineCallingAddressNormalCalls
Sets the value that appears as the authenticated local address in the outbound SIP interaction that is not diverted or redirected.
The options are:
- Use line value 1
- Displays the value in the Line Value 1 field.
- Use line value 2
- Displays the value in the Line Value 2 field.
- Use passed value if present
- Displays the address value that the handlers pass. If the handlers do not pass a value, then CIC displays the CIC user's outbound ANI.
For example, "Name if present" sip:+13178723000@ICServer.ININ.com.
- None
- Displays neither the address nor the name.
The value must conform to all of these criteria:
- If this property is present, the other property
CallingAddressLineValueAddress2
must not have the value null
, if this property's value equals UseLine2Value.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
callingAddressNormalCallsPAssertedIdentityHeaderName Enumeration: lineCallingAddressNormalCalls
Sets the value that appears as the authenticated local name in the outbound SIP interaction that is not diverted or redirected.
The options are:
- Use line value 1
- Displays the value in the Line Value 1 field.
- Use line value 2
- Displays the value in the Line Value 2 field.
- Use passed value if present
- Displays the name value that the handlers pass. If the handlers do not pass a value, and if the CIC user's outbound ANI is configured, then CIC displays the CIC user's display name.
For example, "CIC User's Display Name" sip:+13178723000@ICServer.ININ.com.
- None
- Displays neither the address nor the name.
The value must conform to all of these criteria:
- If this property is present, the other property
CallingAddressNormalCallsPAssertedIdentityHeaderAddress
must not have the value UseNone, if this property's value doesn't equal UseNone.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Enumeration: lineCallingAddressSelection
Designates the remote selection method.
P-Asserted-Identity is a header field in a SIP message that contains a URI and display name (optional). For example, "Patty Johnson" sip:counsel@acme.com.
The options are:
- Use 'From' header only
-
Displays only the "From" field in the SIP header as the calling address (the origination address).
If the field contains both a URI and a display name, then both of these items are displayed. For example, "Patty Johnson" sip:counsel@acme.com.
If the field contains only a display name, then it is displayed alone. For example, "Patty Johnson".
- Use 'P-Asserted-Identity' header only
-
Displays only the authenticated sender origination information from the SIP message. If the "P-Asserted-Identity" header information is not available and no value is set in the header,
then the number appears as “Private number,” and the name appears as “Unknown Name.”
- Use 'P-Asserted-Identity' header then 'From' header (default)
-
Displays the authenticated sender information from the SIP message.
If the "P-Asserted-Identity" header is known, then that value is used and then the "From" header information is used.
If the "P-Asserted-Identity" header is unknown, then only the "From" header information is used.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
usePAssertedIdentityHeaderOnly 1
usePAssertedIdentityHeaderThenFromHeader 2
Int
TCP and TLS only: Sets the timer value in milliseconds for TCP connections on the SIP Line. The value must conform to all of these criteria:
- Is a value from 500 to 20000.
- If this property is present, the other property
TransportProtocol
must not have the value UDP.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
This property can be null.
String
The line direction.
This is a read only property and can not be changed with PUT or POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
This property can be null.
Boolean
Indicates whether fax tones are detected when
allowDeferredAnswer is true.To determine whether to play the fax detection prompt or not,
the system evaluates the value of this attribute:
- If false, then the system overrides the user's setting.
- If true, then the system uses the user's setting.
The value must conform to all of these criteria:
- If this property is present, the other property
FaxProtocol
must not have the value None, if this property's value equals false.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
disableMediaServerPassthru Boolean
Determines whether the media server rewrites the SSRC header.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Int
Determines if a VoIP call remains active if the audio is disrupted. Audio is considered disrupted if no RTP, RTCP, and no comfort noise packet is received from the remote device.
For false, set this value to 0. For true, set this value to 30
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Enumeration: lineDiversionInfo
This information is contained in the URI address field in the SIP message.
The options are:
- Use most recent
- Use original
Use of this option must be enabled by setting useDiversionInfoIfPresent to true.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Boolean
Dynamically requests a list of proxy servers from a DNS server when set to true.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
String
Specifies the domain name that is used to formulate SIP-URLs for CIC users and phone numbers. This domain name is automatically appended to all REGISTER requests
that are sent by the Interaction Center. This value is used in the "From" header in outbound SIP calls.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Int
Sets the value that is used for the DTMF Real-time Transport Protocol (RTP) payload value.
The vendor-specific values are: 100, 102-105. Vendor-specific values should not be used for AudioCodes stations.
The value must conform to all of these criteria:
- Is a value from 96 to 127.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Enumeration: lineDTMFType
Sets the Dual Tone Multi-Frequency (DTMF) type for the station.
The options are:
- Do not use RFC2833 inband only.
- RFC2833 if supported, otherwise inband (default).
- RFC2833 only.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Boolean
Determines whether echo cancellation is used.
Echo cancellation removes echoes from voice communication to improve the sound quality.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
enableProcessingOfReceivedSipReferMessages Boolean
Determines whether CIC allows the party sending the REFER to be notified of the outcome of the received request.
This option is typically set on lines going to internal gateways or IC servers.
Note
Because this option can be used to enable other applications including call transfer, it can create additional calls and carrier charges.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
enableSendingSipReferMessages Boolean
Determines whether CIC can do the following items without tying up two CIC lines (one for the original call and one for the call to the destination):
- Receive a call from the PSTN or a PBX.
- Perform some processing on the call.
- Transfer the call to a non-CIC destination (a PBX station or a remote number).
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
enableSendingSipReferMessagesToLinesInOtherLineGroups Boolean
Determines whether IC can send SIP REFER messages to lines in other line groups.
This option is available only if enableSendingSipReferMessages is selected.
The value must conform to all of these criteria:
- If this property is present, the other property
EnableSendingSipReferMessages
must not have the value false.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
This property can be null.
enableSipPrackUpdateForEarlyMediaSupport Boolean
This option indicates whether the system tells the SIP line to enable PRACK in the outbound and inbound registration.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Boolean
Determines whether the recordings are encrypted.
This option is available only if the useProactiveRecording option is set to true.
Note
This setting overrides the Encrypt the Recording setting in an initiation policy.
For example, if Encrypt the Recordings setting is not selected in an initiation policy, and both the useProactiveRecording and encryptRecordings settings are set to true here,
then the recording is encrypted.
If Encrypt the Recording setting is selected in an initiation policy, and the useProactiveRecording setting is true,
but the encryptRecordings setting is false here, then the recording is not encrypted.
In the event of a conflicting record call request, a Configuration Error warning message is logged in the Application log.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Enumeration: lineFaxProtocol
Indicates the fax protocol to use. The options are:
- T30 only
- T38 only
- T38 then T30
- If you select this option, CIC tries the T38 fax protocol first. If the recipient endpoint does not support this protocol, then CIC tries the T30 fax protocol.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
ignoreAddressIfUserPortionIsNotNumeric Boolean
If the address is not numeric (for example, sip:counsel@acme.com), then this option sets the
From field to "Unknown."
You can optionally use this option with the useOnlyNumericPortion value. Either way, the CIC client displays the call as "Private Number".
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Int
Sets the number of milliseconds to wait before sending the 180 RINGING message. If the call is answered before this time expires, the 180 RINGING message is not sent.
For No Inbound Progress Timer, set the value to -1.
The value must conform to at least one of these criteria:
- Is a value from 1000 to 60000.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Boolean
Determines whether the recordings include IVR and ACD Wait audio.
Note
This option is available only if you have the appropriate license.
This option is available only if the useProactiveRecording option is true.
Note
The default compression format for a new SIP line with Proactive Recording selected is "µ-law."
The compression format can be changed for this SIP line by configuring Interaction Recorder's recording processing.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Boolean
Determines whether the recordings include hold music.
This option is available only if the useProactiveRecording option is true.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
keepTelSchemeWhenUsingAProxy Boolean
Determines whether CIC uses the telephone format (tel:NNNNNNNNNN) for the remote address. If you do not select this option,
CIC converts the phone and phone number to the SIP format (SIP:NNNNNNN@ipaddress).
Note
This option is available only if one or more proxy addresses are configured. It is available for all three line protocols.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Enumeration: lineUsage
Designates the usage of the line.
Warning
ICWS only supports configuring lines of types "General Purpose" and "Station Connections".
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
String
Sets a location for this SIP line. The value must conform to all of these criteria:
- An instance of the Location object type.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
This property can be null.
Int
UDP only: Sets the maximum number of packet retry attempts for INVITE and ACK requests. The value must conform to all of these criteria:
- Is a value from 0 to 6.
- If this property is present, the other property
TransportProtocol
must have the value UDP.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Int
UDP only: Sets the maximum number of packet retry attempts for requests. The value must conform to all of these criteria:
- Is a value from 0 to 10.
- If this property is present, the other property
TransportProtocol
must have the value UDP.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
maxNumberOfCallsCombinedLimit Int
Designates the maximum combined number of calls that the SIP line processes. When the number of calls is reached, this line processes no more calls.
Must be greater than 0, and -1 indicates no limit.
Combined means that the maximum number is the sum of both inbound calls and outbound calls.
The value must conform to all of these criteria:
- Is a value of at least 1.
- The following additional properties must not be included in requests that contain this property: '
MaxNumberOfCallsInboundLimit
' or 'MaxNumberOfCallsOutboundLimit
'.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
This property can be null.
maxNumberOfCallsInboundLimit Int
Designates the maximum number of inbound calls (outbound is specified by the attribute
maxNumberOfCallsOutboundLimit) that the SIP line processes.
When the number of calls is reached, this line processes no more calls.
Must be greater than or equal to 0, and -1 indicates no limit.
Inbound/Outbound means that the values specified for each type of call count towards the maximum number of calls.
The value must conform to all of these criteria:
- Is a value of at least 0.
- The following additional properties must also be included in requests that contain this property: '
MaxNumberOfCallsOutboundLimit
'. - The following additional properties must not be included in requests that contain this property: '
MaxNumberOfCallsCombinedLimit
'. - If this property is present, the other property
MaxNumberOfCallsOutboundLimit
must not have the value 0, if this property's value equals 0.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Setting this property to null will set it to its default value.
Default value: -1
maxNumberOfCallsOutboundLimit Int
Designates the maximum number of outbound calls (inbound is specified by the attribute
maxNumberOfCallsInboundLimit) that the SIP line processes.
When the number of calls is reached, this line processes no more calls.
Must be greater than or equal to 0, and -1 indicates no limit.
Inbound/Outbound means that the values specified for each type of call count towards the maximum number of calls.
The value must conform to all of these criteria:
- Is a value of at least 0.
- The following additional properties must also be included in requests that contain this property: '
MaxNumberOfCallsInboundLimit
'. - The following additional properties must not be included in requests that contain this property: '
MaxNumberOfCallsCombinedLimit
'. - If this property is present, the other property
MaxNumberOfCallsInboundLimit
must not have the value 0, if this property's value equals 0.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Setting this property to null will set it to its default value.
Default value: -1
maxNumberOfCallsUseCombined Boolean
Indicates that the line is configured to set the maximum number of inbound and outbound calls based on a combined pool rather than individually.
This is a read only property and can not be changed with PUT or POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
This property can be null.
maxNumberOfFaxesCombinedLimit Int
Designates the maximum combined number of faxes that the SIP line processes. When the number of faxes is reached, this line processes no more faxes.
Must be greater than 0, and -1 indicates no limit.
Combined means that the maximum number is the sum of both inbound faxes and outbound faxes.
The value must conform to all of these criteria:
- Is a value of at least 1.
- The following additional properties must not be included in requests that contain this property: '
MaxNumberOfFaxesInboundLimit
' or 'MaxNumberOfFaxesOutboundLimit
'.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
This property can be null.
maxNumberOfFaxesInboundLimit Int
Designates the maximum number of inbound faxes (outbound is specified by the attribute
maxNumberOfFaxesOutboundLimit) that the SIP line processes.
When the number of faxes is reached, this line processes no more faxes.
Must be greater than or equal to 0, and -1 indicates no limit.
Inbound/Outbound means that the values specified for each type of fax count towards the maximum number of faxes.
The value must conform to all of these criteria:
- Is a value of at least 0.
- The following additional properties must also be included in requests that contain this property: '
MaxNumberOfFaxesOutboundLimit
'. - The following additional properties must not be included in requests that contain this property: '
MaxNumberOfFaxesCombinedLimit
'. - If this property is present, the other property
MaxNumberOfFaxesOutboundLimit
must not have the value 0, if this property's value equals 0.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Setting this property to null will set it to its default value.
Default value: -1
maxNumberOfFaxesOutboundLimit Int
Designates the maximum number of outbound faxes (inbound is specified by the attribute
maxNumberOfFaxesInboundLimit) that the SIP line processes.
When the number of faxes is reached, this line processes no more faxes.
Must be greater than or equal to 0, and -1 indicates no limit.
Inbound/Outbound means that the values specified for each type of fax count towards the maximum number of faxes.
The value must conform to all of these criteria:
- Is a value of at least 0.
- The following additional properties must also be included in requests that contain this property: '
MaxNumberOfFaxesInboundLimit
'. - The following additional properties must not be included in requests that contain this property: '
MaxNumberOfFaxesCombinedLimit
'. - If this property is present, the other property
MaxNumberOfFaxesInboundLimit
must not have the value 0, if this property's value equals 0.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Setting this property to null will set it to its default value.
Default value: -1
maxNumberOfFaxesUseCombined Boolean
Indicates that the line is configured to set the maximum number of inbound and outbound faxes based on a combined pool rather than individually.
This is a read only property and can not be changed with PUT or POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
This property can be null.
Int
This is the maximum time in seconds for probation on a failed line.
To improve query times, the query for line selection ignores lines that are on probation.
The value must conform to all of these criteria:
- Is a value of at least 0.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Enumeration: lineMediaAddressFamily
Specifies the media address family to which CIC should listen.
This option is available only if the EnableIPv6 server parameter is set to 1 (true).
The options are:
- IPv4
- IPv6
- Telephony Default (IPv4 and IPv6). The host name resolves to both IPv4 and IPv6. This option is typically used when CIC offers media,
but it also helps to determine an answer when CIC receives identical media types and transport protocols for IPv4 and IPv6 information in the session description protocol (SDP).
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Boolean
Specifies if the media attempts to add media streams to the session immediately or if the timing is delayed when it receives a reINVITE.
- For Normal, set this value to true.
- For Delayed, set this value to false.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Boolean
For information on this option, see the latest version of
SIP Application Note on the Product Information site.
- For Normal, set this value to true.
- For Delayed, set this value to false.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Boolean
Determines whether this line is permanent.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
playbackEarlyMediaToInboundCalls Boolean
Indicates whether to use early media (when the remote party sends SDP before the call is answered in a 183 response) instead of ringback on an inbound call.
This option does not apply to ACD calls on this line.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
List [Unbounded]: Complex Type: lineSipProxy
A prioritized list of outbound proxy addresses that are available to CIC. All messages are sent to the first proxy address in this list. The remaining proxy addresses are used only if the first proxy address is not operational. "Not operational" means that CIC did not receive any response from the proxy and the request timed out.
For each IP address, specify the port number at which the proxy services requests. Valid port numbers are 1024 to 65535.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
This property can be null.
Property type documentation:
Represents a collection of SIP Proxy addresses and ports.
List item type documentation:
Represents a SIP Proxy IP address and port.
Int
This option sets the port number for which the CIC SIP engine services requests.
The valid values are 1024 to 65535.
TLS runs on top of TCP. There is a conflict if TCP is set on the same port or the same protocol.
A new SIP line cannot have the same port and the same protocol as an existing SIP line. However, a new line may use the same port of an existing line if it uses a different protocol.
The value must conform to all of these criteria:
- Is a value from 1024 to 65535.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
List [Unbounded]: String
This is a list of External Phone Numbers that are not configured in CIC but that need to be directed to the IC server when they are encountered.
Therefore, CIC (via TS) must register these external phone numbers with the registrar. Typically, these are numbers that are provisioned on the PSTN interface
but that are not provisioned in the CIC system, such as a 1-800 number.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
This property can be null.
Property type documentation:
Represents a collection of strings.
List [Unbounded]: Complex Type: lineRegistrarAddress
This is a list of registrars in order of priority that are available for contact registration by CIC.
If a registrar is configured, then all CIC contacts are sent to it in a SIP REGISTER message by TS. The SIP engine
attempts to register the given telephone numbers to every host in the registrar list.
Each entry in the list must be either an IP address in the IPv4 dotted-notation or a fully qualified domain name.
For each IP address there should be a port. The port number identifies the port at which the registrar will be servicing requests.
Valid port values are from 1024 to 65535.
For each IP address, you must also specify the registration time in seconds. The value for the registration time must be an integer
between 0 and 360000 (100 hours) inclusive.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
This property can be null.
Int
UDP only: Sets the reinvite delay in milliseconds. The value must conform to all of these criteria:
- Is a value from 50 to 1000.
- If this property is present, the other property
TransportProtocol
must have the value UDP.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
String
Defines a list of SIP cause codes. Cause codes take precedence over SIP response codes for retry attempts.
If dial attempts are exhausted, the disconnect is treated as the most recent cause code if a cause code was present on any of the dial attempts.
All dial attempts are traced at the note level when multiple retries are not treated as a 'no available lines' error.
Separate cause codes with commas. For example: "503, 507, 550".
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
String
Defines the list of valid SIP reason codes. If this line is part of a line group, and an outbound call that is made on this line returns a valid SIP reason code,
then CIC retries the call on the next line in the line group.
Separate reason codes or ranges of reason codes with commas. For example:
- "500-599"
- "401, 480, 490-495, 500-599"
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Enumeration: lineSecurity
The Security setting determines, in part, whether the security lock icon appears in the CIC clients when a user places or receives an insecure call on this SIP line.
The Security option is available only when you select the SRTP audio protocol.
In an CIC system environment, some devices may be configured to use SRTP while others do not. When two devices that use SRTP connect directly,
both Interaction Clients display the lock icon to indicate that the call is secure from "end to end." The display of this lock icon is automatic and is not configurable.
If one device uses SRTP and another device does not, then at least one segment of a call between these devices is insecure.
The audio between these devices needs to be transcrypted (converted) between SRTP and RTP via an intermediate device such as the Interaction Media Server.
If a SIP line handles insecure calls, you can configure the display of an open-lock icon to inform CIC client users that the call is not secure.
The options are:
- Minimal
- Hides the display of the open-lock icon on non-secure calls. If you select this option, completely secure calls always show the lock icon and all other calls show no lock icon.
If a secure call creates a conference that includes a non-secure call, the lock icon disappears to indicate that the call is no longer secure.
- End-to-Edge
- Displays the open-lock icon when a call, or at least one segment of a call in the CIC system domain is or becomes non-secure.
End-to-edge means from one end of the call in the CIC system up to the edge of the CIC system (a gateway connected to the PSTN).
It does not indicate security conditions on the PSTN or service provider outside of the IC domain.
If you select this option, secure calls always show the lock icon and all other calls that are non-secure show the open-lock icon.
If a secure call creates a conference that includes a non-secure call, all parties in the conference see the lock icon turn into an open-lock icon.
Conversely, if a non-secure conference call becomes secure from all of the end points to the edge of the CIC system, the open-lock icons change to lock icons.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Int
When a call is left in voice mail, the number of milliseconds of silence that CIC waits before automatically disconnecting the call, if
autoDisconnectWhenSilenceDetectedInVoicemail is true. The value must conform to all of these criteria:
- Is a value of at least 0.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Boolean
Indicates the default access level for all computers. True denies all by default, false grants all by default.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
List [Unbounded]: Complex Type: lineAccessLevel
Lists the computers that are exceptions to the default granted access level.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
This property can be null.
Property type documentation:
Represents a collection of SIP line access levels.
List item type documentation:
Represents a SIP Line access level. Used for configuring DOS protection.
Enumeration: lineAccessValidation
List [Unbounded]: Complex Type: lineAccessLevel
Lists the computers that are exceptions to the default denied access level.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
This property can be null.
Property type documentation:
Represents a collection of SIP line access levels.
List item type documentation:
Represents a SIP Line access level. Used for configuring DOS protection.
Int
Sets the number of milliseconds of delay to insert before a call is answered. This setting is useful when there is some audio loss during call setup.
The acceptable values are from 0 through 8,000 milliseconds. If the value is greater than or equal to 1000 milliseconds, an 180 Ringing SIP signal is sent before delay is inserted.
Regardless of the value, the delay is always inserted after 200 OK is sent back. The value must conform to all of these criteria:
- Is a value from 0 to 8000.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
String
Sets the Differentiated Services Code Point (DSCP) value of Quality of Service (QoS) in transmitted SIP packets.
The range of valid values is 0 (00, 000000) through 63 (3F, 111111).
The value must be one of the following (the value to use is to the left of the colon in bold, the corresponding value from Interaction Administrator is to the right of the colon)
- 00: 00 ( 0, 000000).
- 04: 01 ( 1, 000001).
- 08: 02 ( 2, 000010).
- 0C: 03 ( 3, 000011).
- 10: 04 ( 4, 000100).
- 14: 05 ( 5, 000101).
- Show More
- Show Less
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Int
The recurrence interval (in seconds) of the OPTIONS message that is sent when the
Use SIP Session Timer check box is selected. The value must conform to all of these criteria:
- Is a value from 30 to 100000.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
terminateAnalysisOnConnect Boolean
Terminates the call analysis procedure when a SIP connection indication from the network is received.
For example, Interaction Center makes its PSTN call via SIP calls through a SIP/ISDN gateway. In this example,
the SIP/ISDN gateway sends only a SIP connect message back to Interaction Center after the remote party answers the call.
If call analysis is used, you would want to set terminateAnalysisOnConnect to true,
so that call analysis terminates when the SIP connect message is received.
For example, Interaction Center makes its PSTN call via SIP calls through a SIP/Analog gateway.
In this example, the SIP/Analog gateway always sends a SIP connect message back to Interaction Center prematurely, before the remote party answers the call.
If call analysis is used, you would want to set terminateAnalysisOnConnect to false, so that call analysis continues after the SIP connect message is received.
If the connection is to a station, the terminateAnalysisOnConnect configured in the station is used.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Int
UDP only: Sets the timer value in milliseconds that represents the initial incremental delay between packet retransmission.
The valid values are 500 to T2 (milliseconds).
The value must conform to all of these criteria:
- Is a value of at least 500.
- If this property is present, the other property
TransportProtocol
must have the value UDP. - Has a value that is less than the object's other property
TTwoTimerMs
.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
List [Unbounded]: String
Specifies the headers that are collected on inbound SIP messages. These headers are converted into CIC attributes for use by the IC subsystems. Is a collection of items that each conform to all of these criteria:
- Is a value matching the regular expression '^[0-9a-zA-Z\.\!%\*-\+`'~]+$'.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
This property can be null.
Property type documentation:
Represents a collection of strings.
Enumeration: lineTransportProtocol
Sets the transport protocol. Your selection depends on the protocols that are supported by your SIP-enabled devices (gateway, phones, and so on).
The options are:
- TCP
- (Transmission Control Protocol). The TCP station line is available if needed. Most new IP phones support TCP.
- TLS
- (Transport Layer Security or SSL). This option requires the Advanced Security feature license. After you select it, the TLS Security configuration option appears.
- UDP
- (User Datagram Protocol). Nearly all IP phones support UDP.
Note
If you change the transport protocol, you must deactivate and reactivate the line in order for the change to take effect. The line cannot be deactivated if any calls are active on it.
When a line is deactivated, no calls can be taken. Therefore, after you deactivate the line, reactivate it and then verify that it can take calls.
Warning
You cannot change the transport protocol away from TLS if a registration group references this line, at least one SRTP phone references that registration group,
and this line is the only TLS registration for that registration group.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Int
UDP only: Sets the timer value in milliseconds that represents the maximum incremental delay between packet retransmissions.
The valid values are any values greater than or equal to 1000 (milliseconds).
The value must conform to all of these criteria:
- Is a value of at least 1000.
- If this property is present, the other property
TransportProtocol
must have the value UDP. - Has a value that is greater than the object's other property
TOneTimerMs
.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
useDiversionInfoIfPresent Boolean
Setting this value to true enables setting the value of
diversionInfo.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Boolean
Determines whether only the numeric portion of the caller ID is displayed. If this option is true, then all other information is removed.
For example:
- If true, the caller ID appears as 3178723000.
- If false, the caller ID appears as sip:3178723000@123.45.67.89.
Note
If this value is false, then CIC's telephony services do not change the inbound address and extension before the dial plan standardizes the address.
The address appears in this format: sip:8723000;ext=999@inin.com.
If this value is true, then CIC's telephony services changes the inbound address and extension before the dial plan standardizes the address.
The address appears in this format: (317) 872-3000 ^ 999.
If this value is true, and if the user portion of the SIP address is not numeric, then the entire SIP address is used as the caller ID.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Boolean
Determines whether IC starts recording as soon as audio starts on a call and continues that recording until the call disconnects.
Note: Not all proactive recordings are stored. CIC retains proactive recordings only when all of the following occur:
- CIC receives a 2-party connect event from Tracker.
- The recording is run through Recorder Policies.
- Tracker data is stored.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Enumeration: lineUserToUserConversion
Selects the encoding format for the header.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Setting this property to null will set it to its default value.
Default value: 0
Enumeration: lineUserToUserHeader
Selects the type of UUI header information.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Setting this property to null will set it to its default value.
Default value: 0
Boolean
Determines whether a recurring OPTIONS message is sent to the remote device. If the remote device does not respond to the OPTIONS message, the call is disconnected.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Boolean
Converts the SIP address in the "From" header to use SIPS instead of SIP. SIPS is a secure transmission that uses the URI format. For example: sips:+13178723000@ICServer:5061.
If you do not select this option, CIC converts all SIPS to SIP.
Note
This option is applicable only to TLS lines.
The value must conform to all of these criteria:
- If this property is present, the other property
TransportProtocol
must have the value TLS, if this property's value equals true.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
String
A two digit hex value that describes the user protocol message being transferred.
If the X-UserToUser header is used, this option is not applicable
The value must conform to all of these criteria:
- Is a string with from 2 to 2 characters.
- Is a value matching the regular expression '^[0-9a-fA-F]+$'.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|
Boolean
Determines whether packets are sent for silence.
When Voice Activation Detection is selected, no packets are sent for silence. This option saves bandwidth on your network. However, like compression, there is some loss of voice quality.
This property is required to be present in POST operations.
Feature |
Version |
Obsolete Version |
configuration |
6 |
|