Interaction Center Web Services (ICWS)

/icws/{sessionId}/configuration/lines

GET

/icws/{sessionId}/configuration/lines

Retrieves a list of lines. The results can be filtered by specifying a query. All list-based configuration object resources will have a complex property that will serve as its identity. This property is called the configurationId and consists of a {id, displayName, uri}.

The following result limits are enforced by the server regardless of the value of the Range header field:

If no properties are included (see select parameter), then all of the items will be returned.
If any properties are included (see select parameter), then a maximum of 200 items will be returned in the result.

Feature	Version	Obsolete Version
configuration	1

Request

Parameters

Type

Name

Comments

Header

ININ-ICWS-CSRF-Token

Required

The ININ session token necessary for all calls that require a security or user context.

Header

Required

The session cookie. With the exception of the connection request, all requests must provide a session cookie.

Template

sessionId

Required

The ININ session ID necessary for all calls that require a security or user context.

Header

Range

Specifies the range of results to be returned.

Example: Range: items=10-20.

Query

select

A comma-delimited list of fields to include in the query. If no fields are specified, then only the ID of the items is returned.

Example: select=extension,defaultWorkstation

One can also specify that all of the properties should be returned by using the '*' wildcard value. This is a shortcut for specifying all of the properties' names in the parameter.

The selected properties with a NULL value will not be returned to conserve the Interaction Center server's resources.

Query

where

A comma-delimited list of conditions to filter the results of the query. Only items that satisfy all conditions will be returned.

The following operators can be used:

eq - equals
sw - starts with
ct - contains

Example: where=configurationId.id sw Value

It is supported for the following properties:

active
adapterName
allowDeferredAnswer
allowMultipleCodecsInOutboundSDPOffer
asrEnabled
authentication
Show More
authenticationPassword
authenticationUsername
autoDisconnectWhenSilenceDetectedInVoicemail
boardType
callAttributeHeaders
callingAddressLineValueAddress1
callingAddressLineValueAddress2
callingAddressLineValueName1
callingAddressLineValueName2
configurationId.displayName
configurationId.id
connectTimerMs
direction
disableFaxDetection
disableMediaServerPassthru
disconnectOnBrokenRtp
dnsSrv
domainName
dtmfPayload
echoCancellation
enableProcessingOfReceivedSipReferMessages
enableSendingSipReferMessages
enableSendingSipReferMessagesToLinesInOtherLineGroups
enableSipPrackUpdateForEarlyMediaSupport
encryptRecordings
ignoreAddressIfUserPortionIsNotNumeric
inboundProgressTimerMs
includeEarlyAudio
includeHoldMusic
keepTelSchemeWhenUsingAProxy
location
maximumInviteRetry
maximumPacketRetry
maxNumberOfCallsCombinedLimit
maxNumberOfCallsInboundLimit
maxNumberOfCallsOutboundLimit
maxNumberOfCallsUseCombined
maxNumberOfFaxesCombinedLimit
maxNumberOfFaxesInboundLimit
maxNumberOfFaxesOutboundLimit
maxNumberOfFaxesUseCombined
maxProbationTime
mediaReinviteTiming
mediaTiming
notes
permanent
playbackEarlyMediaToInboundCalls
receivePort
registarExternalList
reinviteDelayMs
retryableCauseCodes
retryableReasonCodes
silenceTimeMs
sipAccessDefaultDenyAll
sipAnswerDelayMs
sipDSCPValue
sipSessionTimeout
terminateAnalysisOnConnect
tOneTimerMs
transferHeaders
tTwoTimerMs
useDiversionInfoIfPresent
useOnlyNumericPortion
useProactiveRecording
useSipSessionTimer
useSipsScheme
uuiProtocolDiscriminator
voiceActivationDetection
Show Less

Query

orderBy

The name of the field to sort the results by and an optional sort direction. The default is to sort by configurationId.displayName in ascending order. A query can only be sorted by one field and only supports one (optional) direction indicator: asc (ascending) or desc (descending).

To sort in descending order use: orderBy=configurationId.id desc

To sort in ascending order use: orderBy=configurationId.id (or orderBy=configurationId.id asc)

It is supported for the following properties:

configurationId.displayName
configurationId.id

Default value: configurationId.displayName

Query

rightsFilter

The security right to use when filtering the results.

Default value: admin

Options:

view
admin
recordLineQueue
listenLineQueue
joinLineQueue
coachLineQueue
pickupLineQueue
transferLineQueue
disconnectLineQueue
snipLineQueue

Feature Version Obsolete Version

configuration 11

Response

200 - OK

The result set of the query is included in the response.

Parameters

Type

Name

Comments

Header

Content-Range

Required

Specifies the range of items being returned in the result along with the total number of items.

Example: Content-Range: items 5-10/200

lines

Represents a list of line configuration objects.

Expand All Collapse All

Property

Value

Comments

items

List [Unbounded]: Complex Type: line

Required

The list of line configuration objects.

List item type documentation:

Represents the line configuration object.

configurationId

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.

displayName

String

The display name of this configuration object.

This property can be null.

uri

Uri

A URI used to access this configuration object.

createdDate

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.

customAttributes

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.

name

String

Required

The key identifying this pair.

value

String

Required

The value of this pair.

This property can be null.

lastModifiedDate

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.

notes

String

The notes for this configuration object.

This property can be null.

active

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

adapterName

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

addressFamily

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

ipv4

ipv6

telephonyDefault

allowDeferredAnswer

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

asrEnabled

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

audioPath

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

dynamic

alwaysIn

audioProtocol

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

RTP

SRTP

authentication

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

authenticationPassword

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

authenticationUsername

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

boardType

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.

callAnalysisType

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

mediaServer

mediaServerToInteractionGateway

interactionGateway

callAttributeHeaders

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.

calledAddressSelection

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

useRequestURI

useToHeader

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

none

postConnect

useExtEquals

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

useDiversionHeader

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

none

useDivertedValue

useLineValue1

useLineValue2

usePassedValueIfPresent

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

none

useDivertedValue

useLineValue1

useLineValue2

usePassedValueIfPresent

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

useDivertedValue

useLineValue1

useLineValue2

usePassedValueIfPresent

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

none

useDivertedValue

useLineValue1

useLineValue2

usePassedValueIfPresent

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

none

useDivertedValue

useLineValue1

useLineValue2

usePassedValueIfPresent

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

none

useDivertedValue

useLineValue1

useLineValue2

usePassedValueIfPresent

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

none

useLineValue1

useLineValue2

usePassedValueIfPresent

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

none

useLineValue1

useLineValue2

usePassedValueIfPresent

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

useLineValue1

useLineValue2

usePassedValueIfPresent

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

none

useLineValue1

useLineValue2

usePassedValueIfPresent

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

none

useLineValue1

useLineValue2

usePassedValueIfPresent

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

none

useLineValue1

useLineValue2

usePassedValueIfPresent

callingAddressSelection

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

useFromHeaderOnly

usePAssertedIdentityHeaderOnly

usePAssertedIdentityHeaderThenFromHeader

connectTimerMs

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.

direction

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.

disableFaxDetection

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

disconnectOnBrokenRtp

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

diversionInfo

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

useMostRecent

useOriginal

dnsSrv

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

domainName

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

dtmfPayload

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

dtmfType

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

doNotUseRFC2833

RFC2833IfSupported

RFC2833Only

echoCancellation

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

encryptRecordings

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

faxProtocol

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

none

t30Only

t38Only

t38ThenT30

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

inboundProgressTimerMs

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

includeEarlyAudio

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

includeHoldMusic

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

lineUsage

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

generalPurpose

stationConnections

location

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.

maximumInviteRetry

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

maximumPacketRetry

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.

maxProbationTime

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

mediaAddressFamily

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

ipv4

ipv6

telephonyDefault

mediaReinviteTiming

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

mediaTiming

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

permanent

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

proxyIpList

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.

String

Required

port

Int

Required

receivePort

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

registarExternalList

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.

registrarAddressList

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.

String

Required

port

Int

Required

registrationTime

Int

Required

reinviteDelayMs

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

retryableCauseCodes

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

retryableReasonCodes

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

security

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

endToEdge

minimal

silenceTimeMs

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

sipAccessDefaultDenyAll

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

sipAccessDeniedList

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.

String

Required

subnetPrefixLength

Int

Required

accessValidation

Enumeration: lineAccessValidation

Required

lastHop

originator

sipAccessGrantedList

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.

sipAnswerDelayMs

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

sipDSCPValue

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
18: 06 ( 6, 000110).
1C: 07 ( 7, 000111).
20: 08 ( 8, 001000) CS1.
24: 09 ( 9, 001001).
28: 0A (10, 001010) AF11.
2C: 0B (11, 001011).
30: 0C (12, 001100) AF12.
34: 0D (13, 001101).
38: 0E (14, 001110) AF13.
3C: 0F (15, 001111).
40: 10 (16, 010000) CS2.
44: 11 (17, 010001).
48: 12 (18, 010010) AF21.
4C: 13 (19, 010011).
50: 14 (20, 010100) AF22.
54: 15 (21, 010101).
58: 16 (22, 010110) AF23.
5C: 17 (23, 010111).
60: 18 (24, 011000) CS3.
64: 19 (25, 011001).
68: 1A (26, 011010) AF31.
6C: 1B (27, 011011).
70: 1C (28, 011100) AF32.
74: 1D (29, 011101).
78: 1E (30, 011110) AF33.
7C: 1F (31, 011111).
80: 20 (32, 100000) CS4.
84: 21 (33, 100001).
88: 22 (34, 100010) AF41.
8C: 23 (35, 100011).
90: 24 (36, 100100) AF42.
94: 25 (37, 100101).
98: 26 (38, 100110) AF43.
9C: 27 (39, 100111).
A0: 28 (40, 101000) CS5.
A4: 29 (41, 101001).
A8: 2A (42, 101010).
AC: 2B (43, 101011).
B0: 2C (44, 101100).
B4: 2D (45, 101101).
B8: 2E (46, 101110) EF.
BC: 2F (47, 101111).
C0: 30 (48, 110000) CS6.
C4: 31 (49, 110001).
C8: 32 (50, 110010).
CC: 33 (51, 110011).
D0: 34 (52, 110100).
D4: 35 (53, 110101).
D8: 36 (54, 110110).
DC: 37 (55, 110111).
E0: 38 (56, 111000) CS7.
E4: 39 (57, 111001).
E8: 3A (58, 111010).
EC: 3B (59, 111011).
F0: 3C (60, 111100).
F4: 3D (61, 111101).
F8: 3E (62, 111110).
FC: 3F (63, 111111).
Show Less

This property is required to be present in POST operations.

Feature	Version	Obsolete Version
configuration	6

sipSessionTimeout

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

tOneTimerMs

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

transferHeaders

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.

transportProtocol

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

UDP

TCP

TLS

tTwoTimerMs

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

useOnlyNumericPortion

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

useProactiveRecording

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

userToUserConversion

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

hex

ascii

extendedAscii

userToUserHeader

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

xUserToUser

userToUser

userToUserPdAttribute

useSipSessionTimer

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

useSipsScheme

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

uuiProtocolDiscriminator

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

voiceActivationDetection

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

400 - Bad Request

Invalid parameter value was specified.

Error Responses

Error Identifier

Error Type

Error Description

error.request.invalidRepresentation.malformed

Type: urn:inin.com:common:error

The request representation object was malformed.

Feature	Version	Obsolete Version
configuration	2

error.request.configuration.get.selectAll

Type: urn:inin.com:common:error

Combining the wildcard (*) and one or more specific properties in one request is not supported.

Feature	Version	Obsolete Version
configuration	2

error.request.configuration.getObjectList

Type: urn:inin.com:configuration:getObjectListError

One or more of the properties in the 'rightsFilter', 'select', 'where', or 'orderBy' query parameters are not supported.

Feature	Version	Obsolete Version
configuration	2

error.request.configuration.getObjectList.invalidSortDirection

Type: urn:inin.com:common:error

The sort direction in the 'orderBy' query parameter is not supported.

Feature	Version	Obsolete Version
configuration	2

error.request.configuration.getObjectList.invalidWhereOperator

Type: urn:inin.com:common:error

The operator in the 'where' query parameter is not supported.

Feature	Version	Obsolete Version
configuration	2

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

Multiple options:

The value can be assigned any of the following options.

[option]

Complex Type: error

Provides additional detail for an error.

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

[option]

Complex Type: getObjectListError

Provides details about errors with a GET configuration object list operation.

__type

"urn:inin.com:configuration:getObjectListError"

Required

The JSON type representing this option.

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

select

List [Unbounded]: String

The properties in the select query parameter that are not supported by the object type.

Property type documentation:

Represents a collection of strings.

rightsFilter

String

The properties in the rightsFilter query parameter that are not supported by the object type.

where

List [Unbounded]: String

The properties in the where query parameter that are not supported by the object type.

Property type documentation:

Represents a collection of strings.

orderBy

String

The property in the orderBy query parameter is not supported by the object type.

500 - Internal Server Error

An unexpected error occurred while processing the request.

Error Responses

Error Identifier

Error Type

Error Description

error.request.internalServerError

Type: urn:inin.com:common:error

The server encountered an unexpected, internal error.

Feature	Version	Obsolete Version
configuration	2

error.request.timeout

Type: urn:inin.com:common:error

The request timed out.

Feature	Version	Obsolete Version
configuration	2

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

401 - Unauthorized

The specified session token is missing, invalid, or has expired.

Parameters

Type

Name

Comments

Header

WWW-Authenticate

Required

Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.


								WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

410 - Gone

This resource has been deprecated and removed from the API.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

POST

/icws/{sessionId}/configuration/lines

Creates a new line resource.

Feature	Version	Obsolete Version
configuration	11

Request

Parameters

Type

Name

Comments

Header

ININ-ICWS-CSRF-Token

Required

The ININ session token necessary for all calls that require a security or user context.

Header

Required

The session cookie. With the exception of the connection request, all requests must provide a session cookie.

Template

sessionId

Required

The ININ session ID necessary for all calls that require a security or user context.

Representations

line

Represents the line configuration object.

Expand All Collapse All

Property

Value

Comments

configurationId

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.

displayName

String

The display name of this configuration object.

This property can be null.

uri

Uri

A URI used to access this configuration object.

createdDate

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.

customAttributes

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.

name

String

Required

The key identifying this pair.

value

String

Required

The value of this pair.

This property can be null.

lastModifiedDate

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.

notes

String

The notes for this configuration object.

This property can be null.

active

Boolean

Activates or deactivates the line in the CIC system.

You can not deactivate a line if any calls are on the line.

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

adapterName

String

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

addressFamily

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

ipv4

ipv6

telephonyDefault

allowDeferredAnswer

Boolean

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

asrEnabled

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

audioPath

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

dynamic

alwaysIn

audioProtocol

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

RTP

SRTP

authentication

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

authenticationPassword

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

authenticationUsername

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

boardType

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.

callAnalysisType

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

mediaServer

mediaServerToInteractionGateway

interactionGateway

callAttributeHeaders

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.

calledAddressSelection

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

useRequestURI

useToHeader

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

none

postConnect

useExtEquals

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

useDiversionHeader

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

none

useDivertedValue

useLineValue1

useLineValue2

usePassedValueIfPresent

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

none

useDivertedValue

useLineValue1

useLineValue2

usePassedValueIfPresent

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

useDivertedValue

useLineValue1

useLineValue2

usePassedValueIfPresent

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

none

useDivertedValue

useLineValue1

useLineValue2

usePassedValueIfPresent

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

none

useDivertedValue

useLineValue1

useLineValue2

usePassedValueIfPresent

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

none

useDivertedValue

useLineValue1

useLineValue2

usePassedValueIfPresent

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

none

useLineValue1

useLineValue2

usePassedValueIfPresent

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

none

useLineValue1

useLineValue2

usePassedValueIfPresent

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

useLineValue1

useLineValue2

usePassedValueIfPresent

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

none

useLineValue1

useLineValue2

usePassedValueIfPresent

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

none

useLineValue1

useLineValue2

usePassedValueIfPresent

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

none

useLineValue1

useLineValue2

usePassedValueIfPresent

callingAddressSelection

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

useFromHeaderOnly

usePAssertedIdentityHeaderOnly

usePAssertedIdentityHeaderThenFromHeader

connectTimerMs

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.

direction

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.

disableFaxDetection

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

disconnectOnBrokenRtp

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

diversionInfo

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

useMostRecent

useOriginal

dnsSrv

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

domainName

String

This property is required to be present in POST operations.

Feature	Version	Obsolete Version
configuration	6

dtmfPayload

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

dtmfType

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

doNotUseRFC2833

RFC2833IfSupported

RFC2833Only

echoCancellation

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

encryptRecordings

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.

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

faxProtocol

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

none

t30Only

t38Only

t38ThenT30

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

inboundProgressTimerMs

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

includeEarlyAudio

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

This property is required to be present in POST operations.

Feature	Version	Obsolete Version
configuration	6

includeHoldMusic

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

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

lineUsage

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

generalPurpose

stationConnections

location

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.

maximumInviteRetry

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

maximumPacketRetry

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

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

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

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

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.

maxProbationTime

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

mediaAddressFamily

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

ipv4

ipv6

telephonyDefault

mediaReinviteTiming

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

mediaTiming

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

permanent

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

proxyIpList

List [Unbounded]: Complex Type: lineSipProxy

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.

String

Required

port

Int

Required

receivePort

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

registarExternalList

List [Unbounded]: String

Feature	Version	Obsolete Version
configuration	6

This property can be null.

Property type documentation:

Represents a collection of strings.

registrarAddressList

List [Unbounded]: Complex Type: lineRegistrarAddress

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.

String

Required

port

Int

Required

registrationTime

Int

Required

reinviteDelayMs

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

retryableCauseCodes

String

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

retryableReasonCodes

String

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

security

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.

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

endToEdge

minimal

silenceTimeMs

Int

Is a value of at least 0.

This property is required to be present in POST operations.

Feature	Version	Obsolete Version
configuration	6

sipAccessDefaultDenyAll

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

sipAccessDeniedList

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.

sipAccessGrantedList

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.

sipAnswerDelayMs

Int

Is a value from 0 to 8000.

This property is required to be present in POST operations.

Feature	Version	Obsolete Version
configuration	6

sipDSCPValue

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
18: 06 ( 6, 000110).
1C: 07 ( 7, 000111).
20: 08 ( 8, 001000) CS1.
24: 09 ( 9, 001001).
28: 0A (10, 001010) AF11.
2C: 0B (11, 001011).
30: 0C (12, 001100) AF12.
34: 0D (13, 001101).
38: 0E (14, 001110) AF13.
3C: 0F (15, 001111).
40: 10 (16, 010000) CS2.
44: 11 (17, 010001).
48: 12 (18, 010010) AF21.
4C: 13 (19, 010011).
50: 14 (20, 010100) AF22.
54: 15 (21, 010101).
58: 16 (22, 010110) AF23.
5C: 17 (23, 010111).
60: 18 (24, 011000) CS3.
64: 19 (25, 011001).
68: 1A (26, 011010) AF31.
6C: 1B (27, 011011).
70: 1C (28, 011100) AF32.
74: 1D (29, 011101).
78: 1E (30, 011110) AF33.
7C: 1F (31, 011111).
80: 20 (32, 100000) CS4.
84: 21 (33, 100001).
88: 22 (34, 100010) AF41.
8C: 23 (35, 100011).
90: 24 (36, 100100) AF42.
94: 25 (37, 100101).
98: 26 (38, 100110) AF43.
9C: 27 (39, 100111).
A0: 28 (40, 101000) CS5.
A4: 29 (41, 101001).
A8: 2A (42, 101010).
AC: 2B (43, 101011).
B0: 2C (44, 101100).
B4: 2D (45, 101101).
B8: 2E (46, 101110) EF.
BC: 2F (47, 101111).
C0: 30 (48, 110000) CS6.
C4: 31 (49, 110001).
C8: 32 (50, 110010).
CC: 33 (51, 110011).
D0: 34 (52, 110100).
D4: 35 (53, 110101).
D8: 36 (54, 110110).
DC: 37 (55, 110111).
E0: 38 (56, 111000) CS7.
E4: 39 (57, 111001).
E8: 3A (58, 111010).
EC: 3B (59, 111011).
F0: 3C (60, 111100).
F4: 3D (61, 111101).
F8: 3E (62, 111110).
FC: 3F (63, 111111).
Show Less

This property is required to be present in POST operations.

Feature	Version	Obsolete Version
configuration	6

sipSessionTimeout

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.

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

tOneTimerMs

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

transferHeaders

List [Unbounded]: String

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.

transportProtocol

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

Warning

This property is required to be present in POST operations.

Feature	Version	Obsolete Version
configuration	6

UDP

TCP

TLS

tTwoTimerMs

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

useOnlyNumericPortion

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 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

useProactiveRecording

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

userToUserConversion

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

hex

ascii

extendedAscii

userToUserHeader

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

xUserToUser

userToUser

userToUserPdAttribute

useSipSessionTimer

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

useSipsScheme

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

uuiProtocolDiscriminator

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

voiceActivationDetection

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

Response

201 - Created

The request to create the line was acknowledged. The new object will be available shortly depending on the server's load. The ID provided in the request's body is returned in the response.

updateOperationResult

Represents the result from a put or post operation.

Expand All Collapse All

Property

Value

Comments

String

Required

The unique identifier used to reference this configuration object.

uri

Uri

A URI used to access this configuration object.

licenseProblems

List [1,*]: Complex Type: licenseError

List item type documentation:

Represents a license warning or error that occurred during a commit.

licenseErrorType

Enumeration: licenseErrorType

Required

Property type documentation:

Represents a license warning or error in a request to modify a configuration object.

setOK

Setting the license succeeded. This value is never sent.

setWarningExceedsThreshold

Indicates that a dynamic license was found with an assignment count that exceeds it's assignable and or concurrent thresholds. As this is only a warning to indicate problems, the license in the request was set successfully.

setErrorExceedsThreshold

Indicates that a dynamic license being set exceed it's assignable or concurrent thresholds and was not set as a result. This can be returned for any license assigned to a user or station as part of setting it's licenses because they are all checked for problems as part of the operation.

setWarningMissingQualifiers

Indicates that the ACD media level in the request did not have a corresponding set of ACD media types and the default value(s) for the level were set as a result.

license

Complex Type: configurationId

Required

Property type documentation:

Represents the identifier of a resource. It includes the unique ID and a human readable display name.

400 - Bad Request

Invalid request was provided. If validation errors exist, they will be returned in the response.

Error Responses

Error Identifier

Error Type

Error Description

error.request.invalidRepresentation.malformed

Type: urn:inin.com:common:error

The request representation object was malformed.

error.request.configuration.update

Type: urn:inin.com:configuration:configurationError

The request has one or more license or validation errors in it.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

Multiple options:

The value can be assigned any of the following options.

[option]

Complex Type: error

Provides additional detail for an error.

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

[option]

Complex Type: configurationError

Represents a validation or licensing error that occurred during a commit. It contains a list of the errors that were encountered.

__type

"urn:inin.com:configuration:configurationError"

Required

The JSON type representing this option.

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

validationErrors

List [1,*]: Complex Type: validationError

List item type documentation:

Represents a validation error that occurred during a commit.

validationErrorType

Enumeration: validationErrorType

Required

Property type documentation:

Represents an error in a request to modify a configuration object.

unknownValidator

Unknown validator.

uniqueInstanceId

The value must be unique across objects of this type.

existingInstanceId

The value must represent a valid ID for a configured instance.

existingAttributeValue

The value must match a configured instance.

requiredValue

The value must be specified.

range

The value must be in the correct range.

stringLength

The value must have the correct number of characters.

regex

The value must be formatted correctly.

validValues

The value is not from the allowed set.

collectionCount

The value must have the correct number of items.

collectionItemValidator

One or more items failed to validate successfully.

validatorGroup

The value is not from the allowed set.

validFormat

The value is not in a valid format.

uniqueAttributeValue

The value must be unique across attributes of this type.

requiredAttribute

The attribute must be specified.

acgTreeValidator

The Acg Tree either could not be verified or found, or the Acg Tree depth is not supported.

pronunciationValidator

The value is not a valid pronunciation format.

wordValidator

The value must be a valid word.

rangeFloat

The value must be in the correct range.

existingAttendantProfile

The value must match a configured attendant profile instance.

extension

The value must not be an existing extension.

workstationsSharedAppearanceID

Unknown validator.

multipleOf

The value is not a valid multiple value.

invalidCharacters

The value contains invalid characters.

existingExtension

The value must be an existing extension.

existingInstanceIdWithAttributeValue

The value must represent a valid ID for a configured instance.

characterDelimitedValue

The value contains invalid characters.

analyzerKeywordCount

The number of keywords assigned to the keyword set makes the configuration exceed the maximum number of supported keywords.

workgroupAnalyzerKeywordCount

The number of keywords assigned to the workgroup is greater than the maximum number of supported keywords.

endDateTimeValidator

The end date or time of a schedule must be greater than or equal to the start date or time.

propertyNotApplicable

This property is not applicable with the current configuration.

invalidMailboxFolder

The value is not a valid mailbox.

unsupportedManufacturer

The provided phone manufacturer is unsupported.

unsupportedModel

The provided phone model is unsupported.

audioProtocol

An Audio protocol value of SRTP is only supported when the Registration Group for the configuration object has one or more registered lines with a Transport Protocol of TLS.

recorderPolicyAnalyzerKeywordCount

The number of keywords assigned to the keyword set makes at least one Recorder Policy exceed the maximum number of supported keywords.

referenceCount

The number of reference to this object is exceeding the maximum limit.

Feature	Version	Obsolete Version
configuration	8

wrapUpStatusTimeout

The values of WrapUpStatus or WrapUpTimeout are not valid.

Feature	Version	Obsolete Version
configuration	8

attributeExistence

One or more required attributes was not specified and/or one or more required absent attributes was specifed.

Feature	Version	Obsolete Version
configuration	8

otherAttributeValue

The otherAttributeValue property is expected to have (or not have) a value.

Feature	Version	Obsolete Version
configuration	8

networkAdapter

The network adapter is invalid.

Feature	Version	Obsolete Version
configuration	8

integerComparisonValidator

The integer comparison failed validation based on the comparison type selected.

Feature	Version	Obsolete Version
configuration	8

timeZoneValidator

The time zone is invalid.

Feature	Version	Obsolete Version
configuration	8

existingLanguageValues

The values provided must be languages supported by PureConnect.

Feature	Version	Obsolete Version
configuration	8

characterDelimitedKVPairs

The character delimited key-value pairs are invalid.

Feature	Version	Obsolete Version
configuration	8

objectValidationErrorMutuallyExclusive

Two configuration values are mutually exclusive.

Feature	Version	Obsolete Version
configuration	10

propertyName

String

Required

propertyValue

String

Required

licenseErrors

List [1,*]: Complex Type: licenseError

List item type documentation:

Represents a license warning or error that occurred during a commit.

licenseErrorType

Enumeration: licenseErrorType

Required

Property type documentation:

Represents a license warning or error in a request to modify a configuration object.

setOK

Setting the license succeeded. This value is never sent.

setWarningExceedsThreshold

setErrorExceedsThreshold

setWarningMissingQualifiers

Indicates that the ACD media level in the request did not have a corresponding set of ACD media types and the default value(s) for the level were set as a result.

license

Complex Type: configurationId

Required

Property type documentation:

Represents the identifier of a resource. It includes the unique ID and a human readable display name.

403 - Forbidden

Not authorized to create this resource.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

500 - Internal Server Error

An unexpected error occurred while processing the request.

Error Responses

Error Identifier

Error Type

Error Description

error.request.internalServerError

Type: urn:inin.com:common:error

The server encountered an unexpected, internal error.

Feature	Version	Obsolete Version
configuration	2

error.request.timeout

Type: urn:inin.com:common:error

The request timed out.

Feature	Version	Obsolete Version
configuration	2

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

401 - Unauthorized

The specified session token is missing, invalid, or has expired.

Parameters

Type

Name

Comments

Header

WWW-Authenticate

Required


								WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

410 - Gone

This resource has been deprecated and removed from the API.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.