Expanded Call Variable API

URL

Operations

• create: Creates one expanded call variable.

  Note

  In solutions that only use the default ECC payload, the Logger does not create an ECC variable that exceeds the 2000-byte limit for an ECC payload. The Logger does this because it automatically adds all ECC variables to the default ECC payload if that is the only ECC payload. If you create another ECC payload, the Logger no longer checks the 2000-byte limit. The Logger creates ECC variables without automatically assigning them to an ECC payload. Assign the new ECC variable to an appropriate ECC payload yourself, either through the ECC Payload API or through the ECC Payload Tool.

• delete: Marks one expanded call variable for deletion, but does not permanently delete it.

• get: Returns one expanded call variable, using the URL https://<server>/unifiedconfig/config/expandedcallvariable/<id>.

• list: Retrieves a list of expanded call variables.

• update: Updates one expanded call variable.

• update: Updates one expanded call variable.

Parameters

• refURL: The refURL of the expanded call variable. See Shared Parameters.

• name: The name of the expanded call variable. See Shared Parameters.

• changeStamp: See Shared Parameters.

• description: See Shared Parameters.

• maximumLength: The maximum length of the expanded call variable. The value is 1 to 210.

  Note	Cisco Provided POD.ID variable, Maximum length can be modified.

• eccArray: Indicates whether the expanded call variable is an array. Values are true/false.

• maximumArraySize: The maximum number of elements in the array is 1 to 255. Required if eccArray is true; must be blank or not specified if eccArray is false.

• enabled: Indicates whether the expanded call variable is enabled. Values are true/false.

• persistent: Specifies whether the expanded call variable is written to the historical database with each Termination Call Detail and Route Call Detail record. Values are true/false.

  • No persistent, enabled arrays are allowed.

  • The maximum number of persistent, scalar, enabled variables is 20.

• ciscoProvided: Indicates whether the expanded call variable is provided by Cisco. Values are true/false. Read-only.

• bytesRequired: The number of bytes required to store the expanded call variable in the system. Read-only.

  The size is calculated using the following formula:

  • If eccArray is false, the size is 5+Maximum Length.

  • If eccArray is true, the size is 5+(1+Maximum length)*Maximum Array size.

• bytesRequiredInCtiServer: The number of bytes required to send this variable to CTI Server. Read-only.

  The size is calculated using the following formula:

  • If eccArray is false, the size is Length of name+Maximum length+4.

  • If eccArray is true, the size is (Length of name+Maximum length+5)*Maximum array size.

  • The total bytesRequired of all the ECC variables in an ECC payload cannot exceed 2000 bytes.

  • The total bytesRequiredInCtiServer of all the ECC variables in an ECC payload cannot exceed 2500 bytes (2000 bytes for the values and 500 bytes for the ECC variable names).

Search and Sort Values

The following table shows the parameters that are searched and the parameters that are sortable.

See Search and Sort.

Example Get Response

Copy<expandedCallVariable>
    <refURL>/unifiedconfig/config/expandedcallvariable/(id)</refURL>
    <name>test</name>
    <maximumLength>9</maximumLength>
    <maximumArraySize>10</maximumArraySize>
    <eccArray>true</eccArray>
    <enabled>true</enabled>
    <ciscoProvided>false</ciscoProvided>
    <description>test expanded call variable</description>
    <persistent>false</persistent>
    <changeStamp>0</changeStamp>
    <bytesRequired>105</bytesRequired>
    <bytesRequiredInCtiServer>180</bytesRequiredInCtiServer>
</expandedCallVariable>