Get Details for a Schedule
Retrieve Schedule details.
A time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.
Retrieving schedule details requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
Retrieve schedule details in this location.
Type of the schedule.
Retrieve the schedule with the matching ID.
Query Parameters
Retrieve schedule details from this organization.
Response Properties
A unique identifier for the schedule.
Unique name for the schedule.
Type of the schedule.
Business hours schedule type.
Holidays schedule type.
List of schedule events.
A unique identifier for the schedule event.
Name for the event.
Start Date of Event.
End Date of Event.
Start time of event.
End time of event.
An indication of whether given event is an all-day event or not.
Recurrence definition.
Flag to indicate if event will recur forever.
End date of recurrence.
Weekly recurrence definition.
Frequency of occurrence in weeks and select the day - Sunday.
Frequency of occurrence in weeks and select the day - Monday.
Frequency of occurrence in weeks and select the day - Tuesday.
Frequency of occurrence in weeks and select the day - Wednesday.
Frequency of occurrence in weeks and select the day - Thursday.
Frequency of occurrence in weeks and select the day - Friday.
Frequency of occurrence in weeks and select the day - Saturday.
Recurrence definition yearly by date.
Schedule the event on a specific day of the month.
Schedule the event on a specific month of the year.
Recurrence definition yearly by day.
Schedule the event on a specific day.
Schedule the event on a specific week.
Schedule the event on a specific month.
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- Retrieve schedule details from this organization.
{
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFJVDB4SlJFRlo",
"name": "AUTOATTENDANT-HOLIDAY",
"type": "holidays",
"events": [
{
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1RtVjNJRmxsWVhJbmN5QkVZWGs",
"name": "New Year's Day",
"startDate": "2022-01-01",
"endDate": "2022-01-01",
"allDayEnabled": true,
"recurrence": {
"recurForEver": true,
"recurYearlyByDate": {
"dayOfMonth": 1,
"month": "JANUARY"
}
}
}
]
}