8x8 Contact Center Tenant Schedule API

Overview

The 8x8 Tenant Schedule API is composed of set of URIs to allow the tenants to download the information related to daily schedules/exceptions. Tenant has a choice of adding/modifying schedules at configuration manager user interface. This style of API makes it very easy to compose and send a query, which is always done using an HTTP GET request.

The Tenant schedule Reporting database contains data, related to all or individual schedule(s).

All API requests are authenticated using a token that is issued to a valid 8x8 tenant. Responses are sent in either XML or JSON format.

For security reasons, the Tenant schedule API only accepts request using HTTPS, so that request headers and response data are encrypted.

For compatibility reasons,8x8 Tenant schedule API does not give CSV type of response.

Testing Using A Browser

In the following examples some parts of the URL are expressed as {valuename}.  The curly brackets are not included in the final URL.  Also values such as schedule names may have spaces in the name.  The spaces have to be replaced by %20 for the value to be accepted.  So if the ending of a URL is /{schedule-name} and you wanted to specify the schedule named Default Schedule the end of your URL would be /Default%20Schedule .

The Tenant schedule API makes it easy to submit a query, for experimentation, testing or debugging purposes. From a web browser, simply enter the URL. You will be prompted to enter a username and password. Enter your tenant name as the username, and your authentication token as the password. Then, the query result will be displayed in your browser. For example:

https://vcc-na4.8x8.com/api/provisioning/schedules

Will return the all schedules information. Response will give all schedules; each schedule will have weekday information along with exception(s).

Revise your query URL based on the login URL of your Tenant. (Refer to the Platform URL Guide to retrieve your login URL)

<?xml version='1.0'  encoding='UTF-8' ?>
<schedules>
    <schedule>
        <id>122</id>
        <name>myschedule</name>
        <time-zone>PST8DT</time-zone>
        <week-days>
           <week-day>
              <day>0</day>
              <properties>
                 <status>-1</status>
                 <start-time>08:00</start-time>
                 <end-time>09:00</end-time>
              </properties>
           </week-day>            ... 

    <schedule>
      ... 
</schedules>

https://vcc-na4.8x8.com/api/provisioning/schedulesbyname/{schedule-name}

https://vcc-na4.8x8.com/api/provisioning/schedules/{schedule-id}

https://vcc-na4.8x8.com/api/provisioning/schedules/{schedule-id}/status

https://vcc-na4.8x8.com/api/provisioning/schedules/{schedule-id}/status?utctime=1360821949898

https://vcc-na4.8x8.com/api/provisioning/schedules/{schedule-id}/status?offset=600

https://vcc-na4.8x8.com/api/provisioning/schedules/{schedule-id}/status?utctime=1360821949898offset=600

https://vcc-na4.8x8.com/api/provisioning/schedules/{schedule-id}/nextstatus

https://vcc-na4.8x8.com/api/provisioning/schedules/{schedule-id}/nextstatus?utctime=1360821949898

Testing Using curl

In a Linux environment, the curl utility will submit an HTTP request, and allow you to view the result.

curl -u acme:ac12343934687a839cf https://vcc.na4.8x8.com/api/provisioning/schedules/{schedule-id}  -o {filename}

will return either a XML or JSON output as a file for the schedule. The -u argument identifies the username and password; use your tenant name as the username, and your authentication token as the password.

The -o argument will take the file name as input from user. This will be name of file where content will be saved.

Authentication

In order to make an API request, you must first obtain an authentication token that has been issued for your tenant. This token combines username and password into a single long string. To get your token, log into the Configuration Manager, select "Integration", and click the "API Token" tab. Next, click the "New Token" button next to "Data Request Token". This generates a new private token for your tenant. You will use this token in all requests to the Recordings API. You may generate a new token at any time.

Meaning of status codes

API response codes