Callisto Knowledge Base

This page is optimized for desktop computers and tablets. To access it, try one of the following points:

  • Access this page from a different device.
  • If you’re on a tablet, rotate it.
  • Check the “Desktop site” option in your browser settings.
Return to CTModule homepage
Knowledge Base
PhoneDiversions › REST services manual

Phone diversion functions

Table of Contents

Info: All examples shown here use the following placeholders. Replace these placeholders with the appropriate data:

  • <user> and <password>: Credentials of a Callisto user with REST Authentication privilege.
  • <callisto>: The base domain name or IP address of the Callisto server.

This section describes the Phone Diversion REST functions.

listGroups

HTTP request method: GET

List the diversion groups with their data based on the provided parameters.

Parameters

groupId Only the data for the group that matches the ID is listed
groupName Lists the groups (along with data) based on the provided group name.

If parameters are ommited, all groups are listed.

Example: Show the group with ID 27.

Example data

groupId=27: ID of the group

Request

curl --user <user>:<password> --data "groupId=27" -H "accept: application/xml" http://callisto_phoneDiversion/Rest/listGroups.asp

Response (successful)

<?xml version="1.0" encoding="iso-8859-1" ?>
<Callisto>
    <Request>listGroups</Request>
    <Response>
        <DiversionGroups>
            <Group>
                <GroupID>27</GroupID>
                <GroupName>Front Desk</GroupName>
                <Destination>1022</Destination>
                <State>ON</State>
                <Description>Diversion to the front desk phone</Description>
            </Group>
        </DiversionGroups>
    </Response>
</Callisto>

Response (no data)

<?xml version="1.0" encoding="iso-8859-1" ?>
<Callisto>
    <Request>listGroups</Request>
    <Response>NOT_FOUND</Response>
</Callisto>