GET - Get business hours profiles

Purpose

Use this API to fetch the business hours profiles.

Authorization

HeaderKey	Description
Authorization*	Zoho-oauthtoken<space><ACCESS_TOKEN>
Accept*	Set to application/json.

Request URL

Method: GET

https://voice.zoho.com/rest/json/zv/workday

Scope: ZohoVoice.telephony.READ

Parameters:

Param Name	Data Type	Description
from*	Number	Represents the starting index for retrieving records.
offset*	Number	Represents the number of records to be returned.
id	Long	Represents the ID of an existing business hours profile.
searchText	String	Represents the keyword used to search profile data. The value is matched against the profile name, timezone, email addresses, and ZUIDs of users configured under the profile.

Sample Request

Copiedcurl "https://voice.zoho.com/rest/json/zv/workday" \
-X GET \
-H "Authorization:Zoho-oauthtoken *****"

Sample Response - Success

Copied{
  "code": "200",
  "workday": [
    {
      "profileName": "US Weekday Hours",
      "holidayPid": "4501000001309003",
      "hours": {
        "0": [
          {
            "startTime": "09:00",
            "endTime": "17:00"
          }
        ],
        "1": [
          {
            "startTime": "09:00",
            "endTime": "17:00"
          }
        ],
        "2": [
          {
            "startTime": "09:00",
            "endTime": "17:00"
          }
        ],
        "3": [
          {
            "startTime": "09:00",
            "endTime": "17:00"
          }
        ],
        "4": [
          {
            "startTime": "09:00",
            "endTime": "17:00"
          }
        ],
        "5": [
          {
            "startTime": "09:00",
            "endTime": "17:00"
          }
        ],
        "6": [
          {
            "startTime": "09:00",
            "endTime": "17:00"
          }
        ]
      },
      "timezone": "PST",
      "emailId": "zylkersupport@zylker.com",
      "id": "4501000000773003",
      "fallback": {
        "mode": "audio",
        "audioName": "test1",
        "audioId": "58421713_1611813895349.mp3",
        "message": "",
        "config": {
          "offline": {
            "actionType": "group",
            "id": "4501000002819011",
            "fallback": {
              "mode": "text",
              "actionType": "voicemail",
              "audioVoice": "2",
              "audioLanguage": "en-US",
              "message": "Sorry, you've reached voicemail. Please leave a message."
            }
          },
          "busy": {
            "actionType": "group",
            "id": "4501000002819011",
            "fallback": {
              "mode": "text",
              "actionType": "voicemail",
              "audioVoice": "2",
              "audioLanguage": "en-US",
              "message": "Sorry, you've reached voicemail. Please leave a message."
            }
          },
          "name": "Default Action Handler"
        }
      },
      "holidayName": "US Holidays"
    }
  ],
  "status": "SUCCESS"
}

Sample Response - Error

Copied{
  "status": "ERROR",
  "code": "500",
  "message": "An error occurred"
}