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
ManagerAssistant Group › REST services manual

Service 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.
  • <MAGroup>: The name of the ManagerAssistant Group application instance to call.

All functions related to phone services and service integration are called by URLs containing the following path:

http://<callisto>/Applications/inbound/<MAGroup>/rest/services

getIntegrationURLs

HTTP request methods: POST; GET

Retrieves the integration URLs. With these URLs, the ManagerAssistant Group instance can be integrated in Jabber, COC, or as a standalone gadget in any modern web browser.

Parameter

login

The login method to use for accessing the services. The following values are available:

manual: The user will be prompted to log in manually when accessing the URL. Recommended for terminals used by multiple users.
auto: Provides URLs containing two xxx placeholders that need to be replaced with a user’s username and password. Accessing this URL will perform automatic login using the provided credentials. Recommended for Jabber integration.
coc: To be used with the Callisto Operator Console. Will perform automatig login based in the credentials used in the COC application.

If this parameter is omitted, all available URLs are returned.

Response

If the parameter login was set, the <Response> element contains the requested URL in an element labeled <IntegrationURL>.

If the parameter login was not set, the <Response> element contains an element labeled <IntegrationURLs> which contains three elements labeled <manual>, <auto>, and <coc>, each containing the respective integration URL.

Example 1: Retrieve the integration URL using manual login.

Example data

  • login=manual: Retrieve the URL using manual login.

Request

curl --user <user>:<password> --data "login=manual" http://<callisto>/Applications/inbound/<MAGroup>/rest/services/getIntegrationURLs.asp

Response

<Callisto>
    <Request>getIntegrationURLs</Request>
    <Response>
        <IntegrationURL>http://<callisto>/Applications/inbound/<MAGroup>/src/Jabber.asp</IntegrationURL>
    </Response>
</Callisto>

Example 2: Retrieve all integration URLs.

Request

curl --user <user>:<password> http://<callisto>/Applications/inbound/<MAGroup>/rest/services/getIntegrationURLs.asp

Response

<Callisto>
    <Request>getIntegrationURLs</Request>
    <Response>
        <IntegrationURLs>
            <manual>http://<callisto>/Applications/inbound/<MAGroup>/src/Jabber.asp</manual>
            <auto>http://<callisto>/LogonPage.asp?page=/Applications/inbound/<MAGroup>/src/Jabber.asp&amp;user=xxx&amp;pwd=xxx</auto>
            <coc>http://<callisto>/LogonPage.asp?page=/Applications/inbound/<MAGroup>/src/Jabber.asp&amp;user=%user%&amp;pwd=%pwd%</coc>
        </IntegrationURLs>
    </Response>
</Callisto>

getPhoneServiceURLs

HTTP request methods: POST; GET

Retrieves URLs used for CUCM phone services.

Parameter

service

The name of the service whose URL to retrieve. The following values are available:

MainMenu: URL to access the phone main menu.
1ButtonService: URL to access the 1 Button Service.
TransferCall: URL to access the transfer call service.
PickupCalls: URL to access the pickup calls service.
DirectCall: URL to access the direct call service.
ChangeGroup: URL to access the change group service.
ChangeStatus: URL to access the change status service.
TeamStatus: URL to access the team status service.
SetForwarding: URL to access the set forwarding service.

If this parameter is omitted, all available URLs are returned.

Response

The <Response> element contains the requested URLs in respectively labeled elements.

Example 1: Retrieve the integration URL for the 1 Button Service.

Example data

  • service=1ButtonService: Retrieve the URL for the 1 Button Service.

Request

curl --user <user>:<password> --data "service=1ButtonService" http://<callisto>/Applications/inbound/<MAGroup>/rest/services/getPhoneServiceURLs.asp

Response

<Callisto>
    <Request>services</Request>
    <Response>
        <1ButtonService>http://<callisto>/Applications/inbound/<MAGroup>/src/OneButton.asp?device=#DEVICENAME#</1ButtonService>
    </Response>
</Callisto>

Example 2: Retrieve the integration URLs for all phone services.

Request

curl --user <user>:<password> http://<callisto>/Applications/inbound/<MAGroup>/rest/services/getPhoneServiceURLs.asp

Response

<Callisto>
    <Request>getIntegrationURLs</Request>
    <Response>
        <MainMenu>http://<callisto>/Applications/inbound/<MAGroup>/src/PhoneMenu.asp?device=#DEVICENAME#</MainMenu>
        <1ButtonService>http://<callisto>/Applications/inbound/<MAGroup>/src/OneButton.asp?device=#DEVICENAME#</1ButtonService>
        <TransferCall>http://<callisto>/Applications/inbound/<MAGroup>/src/IndependentServices.asp?action=transferCall&device=#DEVICENAME#</TransferCall>
        <PickupCall>http://<callisto>/Applications/inbound/<MAGroup>/src/src/IndependentServices.asp?action=pickupCalls&device=#DEVICENAME#</PickupCall>
        <DirectCall>http://<callisto>/Applications/inbound/<MAGroup>/src/IndependentServices.asp?action=directCall&device=#DEVICENAME#</DirectCall>
        <ChangeGroup>http://<callisto>/Applications/inbound/<MAGroup>/src/IndependentServices.asp?action=changeGroup&device=#DEVICENAME#</ChangeGroup>
        <ChangeStatus>http://<callisto>/Applications/inbound/<MAGroup>/src/IndependentServices.asp?action=changeStatus&device=#DEVICENAME#</ChangeStatus>
        <TeamStatus>http://<callisto>/Applications/inbound/<MAGroup>/src/IndependentServices.asp?action=teamStatus&device=#DEVICENAME#</TeamStatus>
        <SetForwarding>http://<callisto>/Applications/inbound/<MAGroup>/src/IndependentServices.asp?action=setForwarding&device=#DEVICENAME#</SetForwarding>
    </Response>
</Callisto>