link
Akixi Developer Portal

# Devices

All internal dialable physical & virtual entities within the telephony platform are represented as Devices within the Akixi Service. Devices are used internally within the Akixi Service in order to model which participants are involved in live calls, as well the overall call & ACD status of each associated device. Additionally, Devices and their description, as well as their membership for ACD/hunt group/queue orientated Devices, are used within the Akixi Service’s reporting functionality in order to allow users to select individuals or groups of Devices to specifically filter reports by.

In the following sub-sections, you will learn how to programmatically create, modify, delete and view Devices.

# Supported Operations

Web Services operations where extensions, groups, trunks, and other device types are specified to allow the application to monitor call & device status activity for a designated telephone system start with a Device prefix. They will be referred to as “Device Operations” interchangeably hereafter.

The list of currently supported Device Operations is provided below.

Operation Name Operation Description
DeviceAdd Add a new Device.
DeviceChange Change an existing Device.
DeviceDelete Delete a Device.
DeviceInfo Get information about a Device.
DeviceList List all Devices of a certain Partition.

# Configuring Devices

Generally speaking all “virtual” devices such as hunt groups, ACD (call centre) queues, conference bridges, auto attendants, voice mail devices, etc. should always be configured within the Akixi Service. These device types do not affect monthly billing charges for Customers.

Extension (endpoint) device entries, which do affect monthly billing charges, should then be created as required in order to provide reporting functionality for the designated telephony environment, according to which particular individuals the corresponding Customer has agreed to pay the corresponding monthly reporting data collection cost for.

On most telephony platform types, the automatic “light” configuration synchronisation performed on the owning Partition component will automatically create all required virtual Devices, whereas extension Devices always need a degree of manual maintenance, via either the Akixi Service user interface or programmatically using the Web Services API.

The requirement to maintain Akixi Device configuration is summarised in the table below for each supported telephony platform type:

# PBX Platforms

Telephony Platform Light Synchronisation Extracts Virtual Devices Automatically? Description
Siemens/Unify HiPath No All normal hunt groups, UCD (ACD) groups, trunk Devices, and park Devices need to be maintained manually within the single common devices Partition, either via the user interface or via the Web Services API.

Extension Devices & ACD Agents that the corresponding Customer wishes to specifically pay reporting data capture billing charges for, should also be manually maintained against the Partition accordingly.
Panasonic TDA/NCP Yes Configuration synchronisation at the Telephony Server component level extracts virtual Devices such as hunt groups, ACD groups, trunk Devices, etc. Extension Devices & ACD Agents are also automatically configured against the common devices Partition.

Extension Devices & ACD Agents that the corresponding Customer does not wish to pay reporting data capture billing charges for, should be instead maintained against the [Excluded Devices Partition] Partition, and then immediately deleted from the common devices Partition.

# Hosted Platforms

Telephony Platform Light Synchronisation Extracts Virtual Devices Automatically? Description
Cisco BroadWorks Yes All virtual subscriber devices are automatically extracted by configuration synchronisation performed at the Partition component level.

Extension Devices & ACD Agents that the corresponding Customer wishes to specifically pay billing charges for, should be manually maintained against the Partition accordingly via either the administration user interface or WS API.
BroadSoft M6 Yes Hunt groups and ACD queue Devices are automatically extracted by configuration synchronisation performed at the Partition component level. Other types of virtual devices such conference bridge, Time-Of-Day, voice mail, etc. devices cannot be reported on anyway and are therefore not extracted.

Extension Devices & ACD Agents that the corresponding Customer wishes to specifically pay billing charges for, should be manually maintained against the Partition accordingly via either the administration user interface or WS API.
Demo Simulator [N/A] The Akixi Service Partition configuration as well as the Device & ACD Agent entries are automatically created for Telephony Server components configured with the Simulator type.
MS Teams [TBC] [TBC]

# Device Request Parameters

Some DeviceAdd & DeviceChange request parameters are platform-specific - therefore, you need to populate the appropriate parameters accordingly to the corresponding integration system type. Additionally, the actual integration system that a property depends on varies depending on the property – some depend on the device’s telephony platform, others on its configured chat or e-mail integration entry.

Parameters used within DeviceAdd & DeviceChange operations are listed within the tables below. You can use these tables to check whether a parameter is supported by a certain integration system.

To learn more about DeviceXXX parameters, please refer to the “Device Properties” sub-section of the “Configuration-Specific Properties” chapter.

Parameter Name Cisco Broadworks Broadsoft M6 Siemens/Unify HiPath3000 Panasonic TDA/NCP Demo Simulator MS Teams
TelSysID ✅ ✅ ✅ ✅ ✅ ✅
PartIDInTelSys ✅ ✅ ✅ ✅ ✅ ✅
DeviceNumber ✅ ✅ ✅ ✅ ✅ ✅
DeviceNumberNew ✅ ✅ ✅ ✅ ✅ ✅
Description ✅ ✅ ✅ ✅ ✅ ✅
DeviceType ✅ ✅ ✅ ✅ ✅ ✅
DeviceMembers ✅ ✅ ✅ ✅ ✅ ✅
ACDAgentMembers ✅ ✅ ✅ ✅ ✅ ✅
DeviceNumberInternal ✅ ❌ ❌ ❌ ❌ ✅
IDOnTelSys ✅ ✅ ❌ ✅ ❌ ✅
IDOnTelSysNew ✅ ✅ ❌ ✅ ❌ ✅
IDOnTelSysOwner ✅ ❌ ❌ ❌ ❌ ❌
IDOnTelSysDivision ✅ ✅ ✅ ✅ ✅ ❌
TelSysUserID ❌ ❌ ❌ ❌ ❌ ✅
TelSysPassword ❌ ✅ ❌ ❌ ❌ ❌
OverrideMonitoring ✅ ✅ ✅ ✅ ❌ ✅
DisableRTMonitoring ❌ ❌ ❌ ❌ ❌ ✅
ChatIntegrationEntry ✅ ✅ ✅ ✅ ✅ ❌
EmailIntegrationEntry ✅ ✅ ✅ ✅ ✅ ❌
DNISNumbers ✅ ❌ ❌ ❌ ❌ ❌
DNISGroupNumber ✅ ❌ ❌ ❌ ❌ ❌

Certain parameters must be set to appropriate values based on the telephony platform type as described below:

# All Telephony Platform Types

Parameter Requirements
Description A description of the corresponding device as configured within the underlying telephony platform’s configuration. For BroadWorks platforms which support naming of the extension users using separate First & Last name values within their Profile settings, the description should be a concatenation of both text values with a space character in- between them, e.g. “John Smith” for First & Last name values “John” & “Smith” respectively.
DeviceMembers For normal hunt groups, a comma separated list and/or range of all device members should be specified. Each list sub-value should specify each member device’s DeviceNumber Property within the Akixi Service configuration, e.g. 100-109,111,120 which would implicitly specify 12 group member extension Devices.
ACDAgentMembers For ACD (call centre) Groups, a comma separated list and/or range of all ACD agent members should be specified. Each list sub-value should specific each member agent’s AgentNumber Property within the Akixi Service configuration, e.g. 500-509,512,540 which would implicitly specify 12 group ACD agent members.

# Siemens/Unify HiPath

Parameter Requirements
DeviceNumber The device number value must contain the dialable digits for the corresponding device, which corresponds to the “Call no” value within the underlying telephone system configuration.

# Panasonic TDA/NCP

Parameter Requirements
DeviceNumber The device number value must contain the internal dialable digits for the corresponding device.

# Cisco BroadWorks

Parameter Requirements
DeviceNumber For BroadWorks extension users with a main (primary) public DDI/DID telephone number assigned to their Profile->Addresses->”Phone Number” setting, the device number should be set to that full public number value without the international dial prefix, e.g. 4809629010 (US), 01234568901 (UK), etc. When no primary DDI/DID is assigned (even when the extension user also has Alternate Numbers assigned to them), the device number should be the public number assigned to owning BroadWorks Enterprise Group within its Profile->“Calling Line ID Group Number” setting, then a lower x character, followed by the user’s internal extension number, e.g. 4809629000x1001.

Note:
Both Akixi light & full configuration synchronisations performed on the device’s owning Partition can automatically change this value, when the public number assignment(s) change within the underlying BroadWorks configuration (either at the subscriber level, or at the Group level for non-DID/DDI subscribers). Therefore, external systems should avoid storing DeviceNumber values in order to maintain a virtual correlation back to previously created Device configuration entries within the Akixi Service.Instead it is recommended that the BroadWorks UserID value is used specifically for this purpose, which is the value that can be subsequently extracted via the IDOnTelSys Property for Akixi DeviceList & DeviceInfo API operations.
DeviceNumberInternal The digits used to internally dial the corresponding BroadWorks extension user within the same BroadWorks Group, which is the number assigned under their Profile->Addresses->”Extension” setting. Technically, this particular Property does not need to be specified correctly, as it is extracted automatically via the “light” Partition synchronisation logic, which occurs anyway when new Devices or ACD Agents are added to the Akixi Service configuration.
IDOnTelSys The BroadWorks UserID assigned to the corresponding device under the Profile->Profile settings area for the subscriber. The full (qualified) UserID value should be specified including the domain name part, e.g. thomas.sienfeld@voip.acmeinsurance.com.

Tip:
This is the recommended value to use when writing logic that automatically correlates BroadWorks extension user configuration entries within an external provisioning system to extension device entries within the Akixi Service.
IDOnTelSysOwner The GroupID of the BroadWorks Group component that the corresponding subscriber is associated with. Technically, this particular Property does not need to be specified correctly, as it is extracted automatically via the “light” Partition synchronisation logic, which occurs anyway when new Devices or ACD Agents are added to the Akixi Service configuration.
DeviceType This should be set to the text value Extension when creating Akixi Device entries for BroadWorks extension users.
DNISNumbers For ACD groups, a comma separated list and/or range of DNIS Device numbers that are associated with the group. (You can also set these associations in the DNIS Devices; it is not necessary to set them in both.)
DNISGroupNumber For DNIS Devices, the number of the ACD group it is associated with. (You can also set these associations in the group; it is not necessary to set them in both.)

# BroadSoft M6

Parameter Requirements
DeviceNumber The device's full public telephone number should be specified for phone user accounts. For non-DID/DDI phone user accounts that are defined within the BroadSoft M6 telephony platform's configuration without an assigned DDI number, the device number should be specified using the base telephone number assigned to the associated Partition followed by an ‘x’ character and then the internal dialling address of the corresponding extension (e.g. 01234567000x4000, for extension 4000 in the Partition with assigned public telephone number 01234567000).
IDOnTelSys The underlying OID of the corresponding Endpoint component defined against the corresponding phone user within the telephony platform's configuration. OIDs are 6 multiples of 16 bit (word) values encoded as hex text separated by a full-stop character (e.g. “0000.feda.eda9.da98.a987.9876). The Property is not actually used internally by the Akixi Service, and is provided for informational purposes only when diagnosing integration issues or configuration inconsistencies between the Akixi application and the telephony platform.
TelSysPassword A valid monitor password value must be specified for phone user (extension) devices, otherwise no call or device status information is recorded for them. The monitor password is the same password values used by phone users when logging into their BroadSoft M6 user web portal.
DeviceType This should be set to the text value Extension when creating Akixi Device entries for BroadSoft M6 phone user accounts.

# MS Teams

Parameter Requirements
DeviceNumber [TBC]

# Chat Integration Parameters

Parameter Name Chat Integration Type LiveChat Chat Integration Type Chat Simulator
IDOnChatSys ✅ ✅

Certain parameters must be set to appropriate values based on the chat integration type as described below:

# LiveChat

Parameter Requirements
IDOnChatSys [Not implemented yet.]

# Chat Simulator

Parameter Requirements
IDOnChatSys A chat ID for the group device within the simulated omnichannel contact centre. Note that a group must have a non-empty value configured for this Property, in addition to its ChatIntegrationEntry Property being specified as Chat Simulator, in order for it to distribute virtual chats within the simulator.

# E-mail Integration Parameters

Parameter Name Chat Integration Type LiveChat Chat Integration Type Chat Simulator
EmailSysUserID ✅ ❌
EmailSysPassword ✅ ❌
EmailSysEmailAddress ✅ ✅
IDOnEmailSys ❌ ❌

Certain parameters must be set to appropriate values based on the e-mail integration type as described below:

# POP3 & SMTP

Parameter Requirements
EmailSysUserID The username that will be used to establish POP3 & SMTP protocol communications with the group device’s corresponding mailbox on the associated e-mail server.
EmailSysPassword The password that will be used to establish POP3 & SMTP protocol communications with the group device’s corresponding mailbox on the associated e-mail server.
EmailSysEmailAddress The e-mail address of the group mailbox in the external e-mail server, which will be used when sending e-mails from this group.

# E-mail Simulator

Parameter Requirements
EmailSysEmailAddress An e-mail address for the group device within the simulated omnichannel contact centre. Note that a group must have a non-empty value configured for this Property, in addition to its EmailIntegrationEntry Property being specified as E-mail Simulator, in order for it to distribute virtual e-mails within the simulator.

# DeviceAdd

The DeviceAdd request can be used to add a new Device within a specified Partition component.

# DeviceAdd Request

As mentioned above, DeviceAdd requests are platform-specific. Therefore, you will need to provide request parameters that are relevant to your telephony platform.

Below shows an example of a platform-specific Device creation operation. This request includes all parameters supported by DeviceAdd operation invoked in order to create a new Extension for a Cisco BroadWorks® telephony platform.

Depending on your initial requirements, your actual request might be different from the sample request below.

<Request Operation="DeviceAdd">
    <InvokeID>00014</InvokeID>
    <SessionID>EFA4902A7F61D03E42BF3222B0A246BF</SessionID>
    <OperationPayload>
        <!-- Properties to identify a Partition. -->
        <Property Name="TelSysID">100100</Property>
        <Property Name="PartIDInTelSys">2</Property>
        <!-- Device-related properties. -->
        <Property Name="DeviceNumber">01234567890</Property>
        <Property Name="Description">Derek Trotter</Property>
        <Property Name="DeviceType">Extension</Property>
        <Property Name="DeviceNumberInternal">890</Property>
        <Property Name="IDOnTelSys">rodney.trotter@voip.acmeinsurance.com</Property>
        <Property Name="IDOnTelSysOwner">SampleEnt3Grp1</Property>
        <Property Name="IDOnTelSysDivision">Sales</Property>
        <Property Name="OverrideMonitoring">False</Property>
    </OperationPayload>
</Request>

# DeviceAdd Response

If your operation was successful, you will receive a response similar to the following:

<Response Result="Success">
    <InvokeID>00014</InvokeID>
</Response>

You will now be able to access the newly created Device by invoking other Device-related WS API requests. The Device entry can also be viewed & modified via the AdministrationDevices facility with the Akixi Web Application.

If the request was unsuccessful (i.e. the response’s Result attribute depicts the “Fail” value), then the response’s error code and the message description values should be parsed by the client application and then handled accordingly. Some common errors returned by this operation are provided in the table below:

Error Type Error Codes
General Error Codes 10101, 10103, 10150
Session Related Error Codes 10301, 10302
Authentication Related Error Codes 10305, 10307, 10313
Permissions Related Error Codes 10511, 10512, 10514, 10700, 10701, 10702
Telephony Server Component Related Error Codes 11012, 11013
Partition Related Error Codes 11110, 11113, 11131
Device Related Error Codes 11162, 11163, 11165*, 11166*, 11167*, 11171,11173, 11174, 11175, 11176, 11177, 11178, 11260, 11261, 11262, 11263
DNIS Related Error Codes 11168, 11169, 11179

Errors marked with (*) are returned when the response’s Result attribute depicts the PartialFail value.

Please refer to the “Error Codes” chapter for further details on specific error codes and their meaning.

# DeviceChange

The DeviceChange request can be used to modify an existing Device within a specified Partition component.

# DeviceChange Request

As mentioned above, DeviceChange requests are platform-specific. Therefore, you will need to provide request parameters that are relevant to your telephony platform.

Additionally, in order to change an existing Device component, one needs to specify its corresponding identifier values, which can be done in two different ways:

  • By providing the TelSysID, PartIDInTelSys and DeviceNumber parameters.
  • By providing the TelSysID, PartIDInTelSys and IDOnTelSys parameters (only when the telephony platform type supports IDOnTelSys parameter which can be confirmed via section “Device Request Parameters”).

When both DeviceNumber and IDOnTelSys parameters are specified, the device is searched by DeviceNumber ignoring the IDOnTelSys parameter.

Below shows an example of a platform-specific Device modification operation. This request includes all parameters supported by DeviceChange operation invoked in order to modify an existing Device for a Cisco BroadWorks® telephony platform.

Depending on your initial requirements, your actual request might be shorter than the sample request below.

<Request Operation="DeviceChange">
    <InvokeID>00015</InvokeID>
    <SessionID>EFA4902A7F61D03E42BF3222B0A246BF</SessionID>
    <OperationPayload>
        <!-- Properties to identify a Partition. -->
        <Property Name="TelSysID">100100</Property>
        <Property Name="PartIDInTelSys">2</Property>
        <!-- DeviceNumber Property is used to identify an existing Device. -->
        <Property Name="DeviceNumber">01234567890</Property>
        <!-- DeviceNumberNew Property is used to specify a new device number. -->
        <Property Name="DeviceNumberNew">01234567892</Property>
        <Property Name="Description">Albert Trotter</Property>
        <Property Name="DeviceType">Extension</Property>
        <Property Name="DeviceNumberInternal">892</Property>
        <!-- IDOnTelSysNew Property is used to update device’s current IDOnTelSys Property. -->
        <Property Name="IDOnTelSysNew">albert.trotter@voip.acmeinsurance.com</Property>
        <Property Name="IDOnTelSysOwner">SampleEnt3Grp1</Property>
        <Property Name="IDOnTelSysDivision">Sales</Property>
        <Property Name="OverrideMonitoring">False</Property>
    </OperationPayload>
</Request>

# DeviceChange Response

If your operation was successful, you will receive a response similar to the following:

<Response Result="Success">
    <InvokeID>00015</InvokeID>
</Response>

If the request was unsuccessful (i.e. the response’s Result attribute depicts the Fail value), then the response’s error code and the message description values should be parsed by the client application and then handled accordingly. Some common errors returned by this operation are provided in the table below:

Error Type Error Codes
General Error Codes 10101, 10103, 10150
Session Related Error Codes 10301, 10302
Authentication Related Error Codes 10305, 10307, 10313
Permissions Related Error Codes 10511, 10512, 10514, 10700, 10701, 10702
Telephony Server Component Related Error Codes 11012, 11013
Partition Related Error Codes 11110, 11113, 11131
Device Related Error Codes 11161, 11162, 11163, 11164, 11165*, 11166*, 11167*, 11170, 11171, 11172,11173, 11174, 11175, 11176, 11177, 11178, 11260, 11261, 11262, 11263
DNIS Related Error Codes 11168, 11169, 11179

Errors marked with (*) are returned when the response’s Result attribute depicts the PartialFail value.

Please refer to the “Error Codes” chapter for further details on specific error codes and their meaning.

# DeviceDelete

The DeviceDelete request can be used to delete a device that is configured against a certain Partition component within the Akixi Service.

# DeviceDelete Request

When deleting Devices for the Cisco BroadWorks®, BroadSoft M6, & Panasonic NCP/TDA telephony platforms, any matching ACD agent configuration items are also automatically deleted too. To only delete the corresponding device(s), ensure that the AutoDeleteAgent Property within the request is specifically set to False. Please also note that this setting is not supported for the Siemens/Unify HiPath family of telephone systems, as ACD agents are separate configuration entities within the underlying telephone system configuration that identify ACD workers within a separate address space compared to dialable device entities.

Warning

Unless specifically directed to by your System or Application Provider, you should be particularly careful not to delete the special (pseudo) device such as the [Trunk] or [Conference] entries, which are required to model certain call scenarios on some telephone systems and should not be removed.

The example below shows a Device deletion operation. This request includes generic parameters supported by the DeviceDelete operation invoked in order to delete an existing Device (where the device entry’s DeviceNumber Property is 01234567890).

<Request Operation="DeviceDelete">
    <InvokeID>00016</InvokeID>
    <SessionID>EFA4902A7F61D03E42BF3222B0A246BF</SessionID>
    <OperationPayload>
        <!-- Properties to identify a partition. -->
        <Property Name="TelSysID">100100</Property>
        <Property Name="PartIDInTelSys">2</Property>
        <!-- Device-related properties. -->
        <Property Name="DeviceNumber">01234567890</Property>
        <Property Name="AutoDeleteAgent">True</Property>
    </OperationPayload>
</Request>

When deleting Devices for the Cisco BroadWorks®, BroadSoft M6, & Panasonic NCP/TDA telephony platforms, you can also specify a device by its IDOnTelSys Property:

<Request Operation="DeviceDelete">
    <InvokeID>00016</InvokeID>
    <SessionID>EFA4902A7F61D03E42BF3222B0A246BF</SessionID>
    <OperationPayload>
        <!-- Properties to identify a partition. -->
        <Property Name="TelSysID">100100</Property>
        <Property Name="PartIDInTelSys">2</Property>
        <!-- Device-related properties. -->
        <Property Name="IDOnTelSys">derek.trotter@voip.acmeinsurance.com
        </Property> <!-- Additional special Properties that control how deletion is performed. -->
        <Property Name="AutoDeleteAgent">True</Property>
    </OperationPayload>
</Request>

# DeviceDelete Response

If your operation was successful, you will receive a response similar to the following:

<Response Result="Success">
    <InvokeID>00016</InvokeID>
</Response>

If the request was unsuccessful (i.e. the response’s Result attribute depicts the Fail value), then the response’s error code and the message description values should be parsed by the client application and then handled accordingly. Some common errors returned by this operation are provided in the table below:

Error Type Error Codes
General Error Codes 10101, 10103
Session Related Error Codes 10301, 10302
Authentication Related Error Codes 10305, 10307, 10313
Permissions Related Error Codes 10511, 10512, 10514, 10700, 10701, 10702
Telephony Server Component Related Error Codes 11013
Partition Related Error Codes 11131
Device Related Error Codes 11160, 11161, 11170, 11172

Please refer to the “Error Codes” chapter for further details on specific error codes and their meaning.

# DeviceList

The DeviceList operation can be used to list all Devices that are configured against a certain Partition component within the Akixi Service.

# DeviceList Request

By default, the body of DeviceList requests is quite minimalistic: you can simply specify the Telephony Server Identifier and Partition Identifier within a Telephony Server in order to obtain the list of all underlying Devices (as well as some commonly used device-related parameter values).

If you want to list parameters that are not returned when you invoke a default “minimalistic” request, you can request additional values via DeviceFields Property. If you want to only list Devices containing a specific DeviceNumber or Description, you can request for it via SearchQuery Payload Property. The Offset and Limit parameters can also be specified to request a specific subsection of the listed entries (if not specified these values are assumed to be 0 and 1000 respectively). Offset defines how many entries to skip over (i.e. which entry to start on if the first entry is entry 0) and Limit defines how many entries to retrieve:

<Request Operation="DeviceList">
    <InvokeID>00017</InvokeID>
    <SessionID>EFA4902A7F61D03E42BF3222B0A246BF</SessionID>
    <!-- Specify the number of entries to skip. -->
    <Offset>100</Offset>
    <!-- Specify how many entries to retrieve after the offset. -->
    <Limit>20</Limit>
    <OperationPayload>
        <!-- Specify a Telephony Server component Identifier. -->
        <Property Name="TelSysID">100100</Property>
        <!-- Specify a Partition Identifier within a Telephony Server. -->
        <Property Name="PartIDInTelSys">2</Property>
        <!-- Can be used to list additional parameters of each Device. -->
        <Property Name="DeviceFields">IDOnTelSys,IDOnTelSysOwner,GroupMembership</Property>
        <!-- Optional property to list Devices containing a specific DeviceNumber or Description. -->
        <Property Name="SearchQuery">Add DeviceNumber or Description to query</Property>
    </OperationPayload>
</Request>

The DeviceList operation can only return the following Device configuration entry Properties:

  • DeviceNumber *
  • Description *
  • DeviceType
  • DeviceNumberInternal
  • TelSysID
  • PartIDInTelSys
  • IDOnTelSys
  • IDOnTelSysOwner
  • IDOnTelSysDivision
  • ChatIntegrationEntry
  • IDOnChatSys
  • EmailIntegrationEntry
  • EmailSysEmailAddress
  • IDOnEmailSys
  • GroupMembership
  • QueueStatus

Parameters marked with an asterisk (*) are returned by default (i.e. it is not required to specify them via the DeviceFields Property).

# DeviceList Response

If a DeviceList operation is successful, then you’ll receive a list of Devices and their Properties. If additional parameters were not provided within your request, you will receive default Properties of all Devices (i.e. DeviceNumber and Description values). If additional fields were requested via DeviceFields Property, then corresponding values will also be returned within the operation’s response. If SearchQuery Payload Property was requested for, then operation's response will only contain Devices whose default properties match the search query provided:

<Response Result="Success">
    <InvokeID>00017</InvokeID>
    <Success>
        <Container>
            <!-- Only DeviceNumber and Description parameters are returned by default.-->
            <Property Name="DeviceNumber">01234567890</Property>
            <Property Name="Description">Derek Trotter</Property>
            <!-- Parameters below were requested via DeviceFields Property.-->
            <Property Name="DeviceType">Extension</Property>
            <Property Name="DeviceNumberInternal">7890</Property>
            <Property Name="TelSysID">100100</Property>
            <Property Name="PartIDInTelSys">2</Property>
            <Property Name="IDOnTelSys">derek.trotter@voip.acmeinsurance.com</Property>
            <Property Name="IDOnTelSysOwner">SampleEnt3Grp1</Property>
            <Property Name="IDOnTelSysDivision">Sales</Property>
        </Container>
        <Container>
            <!-- Only DeviceNumber and Description parameters are returned by default.-->
            <Property Name="DeviceNumber">01234567891</Property>
            <Property Name="Description">Rodney Trotter</Property>
            <!-- Parameters below were requested via DeviceFields Property.-->
            <Property Name="DeviceType">Extension</Property>
            <Property Name="DeviceNumberInternal">7891</Property>
            <Property Name="TelSysID">100100</Property>
            <Property Name="PartIDInTelSys">2</Property>
            <Property Name="IDOnTelSys">rodney.trotter@voip.acmeinsurance.com</Property>
            <Property Name="IDOnTelSysOwner">SampleEnt3Grp1</Property>
            <Property Name="IDOnTelSysDivision">Sales</Property>
            <Property Name="ChatIntegrationEntry"></Property>
            <Property Name="IDOnChatSys"></Property>
            <Property Name="EmailIntegrationEntry"></Property>
            <Property Name="EmailSysEmailAddress"></Property>
            <Property Name="IDOnEmailSys"></Property>
            <Property Name="GroupMembership"></Property>
        </Container>
    </Success>
</Response>

If the request was unsuccessful (i.e. the response’s Result attribute depicts the Fail value), then the response’s error code and the message description values should be parsed by the client application and then handled accordingly. Some common errors returned by this operation are provided in the table below:

Error Type Error Codes
General Error Codes 10101, 10103
Session Related Error Codes 10301, 10302
Authentication Related Error Codes 10305, 10307, 10313
Permissions Related Error Codes 10511, 10512, 10514, 10700, 10701, 10702
Telephony Server Component Related Error Codes 11013
Partition Related Error Codes 11131, 11150

Please refer to the “Error Codes” chapter for further details on specific error codes and their meaning.

# DeviceInfo

The DeviceInfo request can be used to obtain the full list of Device Properties.

# DeviceInfo Request

The request below includes generic parameters supported by the DeviceInfo operation. This operation requests the list of all device-related Properties (where the device entry’s DeviceNumber Property is 01234567890).

<Request Operation="DeviceInfo">
    <InvokeID>00018</InvokeID>
    <SessionID>EFA4902A7F61D03E42BF3222B0A246BF</SessionID>
    <OperationPayload>
        <Property Name="TelSysID">100100</Property>
        <Property Name="PartIDInTelSys">2</Property>
        <Property Name="DeviceNumber">01234567890</Property>
    </OperationPayload>
</Request>

On Cisco BroadWorks®, BroadSoft M6, & Panasonic NCP/TDA telephony platforms, you can also specify a device by its IDOnTelSys Property:

<Request Operation="DeviceInfo">
    <InvokeID>00018</InvokeID>
    <SessionID>EFA4902A7F61D03E42BF3222B0A246BF</SessionID>
    <OperationPayload>
        <Property Name="TelSysID">100100</Property>
        <Property Name="PartIDInTelSys">2</Property>
        <Property Name="IDOnTelSys">derek.trotter@voip.acmeinsurance.com</Property>
    </OperationPayload>
</Request>

# DeviceInfo Response

If a DeviceInfo operation is successful, you will receive a response similar to the following:

<Response Result="Success">
    <InvokeID>00018</InvokeID>
    <Success>
        <Property Name="TelSysID">100100</Property>
        <Property Name="PartIDInTelSys">2</Property>
        <Property Name="DeviceNumber">01234567890</Property>
        <Property Name="Description">Derek Trotter</Property>
        <Property Name="DeviceType">Extension</Property>
        <Property Name="DeviceNumberInternal">890</Property>
        <Property Name="IDOnTelSys">rodney.trotter@voip.acmeinsurance.com</Property>
        <Property Name="IDOnTelSysOwner">SampleEnt3Grp1</Property>
        <Property Name="IDOnTelSysDivision">Sales</Property>
        <Property Name="OverrideMonitoring">False</Property>
        <Property Name="ChatIntegrationEntry">LiveChat</Property>
        <Property Name="EmailIntegrationEntry">POP3 SMTP</Property>
    </Success>
</Response>

If the request was unsuccessful (i.e. the response’s Result attribute depicts the Fail value), then the response’s error code and the message description values should be parsed by the client application and then handled accordingly. Some common errors returned by this operation are provided in the table below:

Error Type Error Codes
General Error Codes 10101, 10103
Session Related Error Codes 10301, 10302
Authentication Related Error Codes 10305, 10307, 10313
Permissions Related Error Codes 10511, 10512, 10514, 10700, 10701, 10702
Telephony Server Component Related Error Codes 11013
Partition Related Error Codes 11131
Device Related Error Codes 11160, 11161, 11170, 11172

Please refer to the “Error Codes” chapter for further details on specific error codes and their meaning.

← ACD Agents →