Loading
Cart Total
$0.00
-
Your shopping cart is empty
Loading
Hello! Log in Your Account
New customer? Start here
Phone Numbers & Call Routing
Storefronts
Customer Management
VoIP Bundle (Subscriptions)
SIP Account Management
Audio Management
Phone Numbers & Call Routing
Phone Calls & CDR Data
VoIP Phone Short Code
eFax Management
Voicemails & Mailboxes
Caller ID
SIP Trunks
Wallboard Statistics
VoIP Phone Provisioning
Call Queueing
Phone Books
VoIP Phone Speed Dial
Text (SMS) Messaging
Time Diaries are used to modify routing based on the time of day
Become a ResellerFilter:
* You will be charged every time this command is run.
Gets a list of all of the active Out of Hours diaries on an account
Back to top
Request Details
Response Details
This command has no URL/Query String parameters
200 Response
{
"result" : [
{
"created_on" : "2023-06-04",
"elements" : [
{}
],
"exceptions" : [
{}
],
"name" : "Pete's Work Schedule",
"timezone" : "Europe/London",
"updated_on" : "2023-06-04",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
}
],
"status_code" : 200,
"status_message" : "OK"
}
Gets a list of all of the active Out of Hours diaries on an account
Back to top
Request Details
Response Details
This command has no URL/Query String parameters
200 Response
{
"result" : [
{
"created_on" : "2023-06-04",
"elements" : [
{}
],
"exceptions" : [
{}
],
"name" : "Pete's Work Schedule",
"timezone" : "Europe/London",
"updated_on" : "2023-06-04",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
}
],
"status_code" : 200,
"status_message" : "OK"
}
Gets the details for a specific Out of Hours diary on an account
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the Out of Hours diary to be queried
200 Response
{
"result" : {
"created_on" : "2023-06-04",
"elements" : [
{}
],
"exceptions" : [
{}
],
"name" : "Pete's Work Schedule",
"timezone" : "Europe/London",
"updated_on" : "2023-06-04",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
},
"status_code" : 200,
"status_message" : "OK"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
Gets the details for a specific Out of Hours diary on an account
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the Out of Hours diary to be queried
200 Response
{
"result" : {
"created_on" : "2023-06-04",
"elements" : [
{}
],
"exceptions" : [
{}
],
"name" : "Pete's Work Schedule",
"timezone" : "Europe/London",
"updated_on" : "2023-06-04",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
},
"status_code" : 200,
"status_message" : "OK"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
Creates a new Out of Hours diary
Back to top
Request Details
Response Details
This command has no URL/Query String parameters
POST body
Name
Type
Required
elements
Array of TimeDiaryElement
True
The list of diary elements
exceptions
Array of TimeDiaryException
True
The list of exception times which override the diary elements
name
String
True
The name of this Time Diary
timezone
String
True
The tz database name of the timezone to use for this diary, (see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
JSON all-fields example:
{
"elements" : [
{}
],
"exceptions" : [
{}
],
"name" : "Pete's Work Schedule",
"timezone" : "Europe/London"
}
201 Response
{
"result" : {
"created_on" : "2023-06-04",
"elements" : [
{}
],
"exceptions" : [
{}
],
"name" : "Pete's Work Schedule",
"timezone" : "Europe/London",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
},
"status_code" : 201,
"status_message" : "Created"
}
400 Response
{
"result" : {},
"status_code" : 400,
"status_message" : "Bad Request"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
Creates a new Out of Hours diary
Back to top
Request Details
Response Details
This command has no URL/Query String parameters
POST body
Name
Type
Required
elements
Array of TimeDiaryElement
True
The list of diary elements
exceptions
Array of TimeDiaryException
True
The list of exception times which override the diary elements
name
String
True
The name of this Time Diary
timezone
String
True
The tz database name of the timezone to use for this diary, (see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
JSON all-fields example:
{
"elements" : [
{}
],
"exceptions" : [
{}
],
"name" : "Pete's Work Schedule",
"timezone" : "Europe/London"
}
201 Response
{
"result" : {
"created_on" : "2023-06-04",
"elements" : [
{}
],
"exceptions" : [
{}
],
"name" : "Pete's Work Schedule",
"timezone" : "Europe/London",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
},
"status_code" : 201,
"status_message" : "Created"
}
400 Response
{
"result" : {},
"status_code" : 400,
"status_message" : "Bad Request"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
Updates the specified Out of Hours diary
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the Out of Hours diary to be updated
PUT body
Name
Type
Required
elements
Array of TimeDiaryElement
True
The list of diary elements
exceptions
Array of TimeDiaryException
True
The list of exception times which override the diary elements
name
String
True
The name of this Time Diary
timezone
String
True
The tz database name of the timezone to use for this diary, (see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
JSON all-fields example:
{
"elements" : [
{}
],
"exceptions" : [
{}
],
"name" : "Pete's Work Schedule",
"timezone" : "Europe/London"
}
201 Response
{
"result" : {
"created_on" : "2023-06-04",
"elements" : [
{}
],
"exceptions" : [
{}
],
"name" : "Pete's Work Schedule",
"timezone" : "Europe/London",
"updated_on" : "2023-06-04",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
},
"status_code" : 201,
"status_message" : "Created"
}
400 Response
{
"result" : {},
"status_code" : 400,
"status_message" : "Bad Request"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
Updates the specified Out of Hours diary
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the Out of Hours diary to be updated
PUT body
Name
Type
Required
elements
Array of TimeDiaryElement
True
The list of diary elements
exceptions
Array of TimeDiaryException
True
The list of exception times which override the diary elements
name
String
True
The name of this Time Diary
timezone
String
True
The tz database name of the timezone to use for this diary, (see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
JSON all-fields example:
{
"elements" : [
{}
],
"exceptions" : [
{}
],
"name" : "Pete's Work Schedule",
"timezone" : "Europe/London"
}
201 Response
{
"result" : {
"created_on" : "2023-06-04",
"elements" : [
{}
],
"exceptions" : [
{}
],
"name" : "Pete's Work Schedule",
"timezone" : "Europe/London",
"updated_on" : "2023-06-04",
"uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
},
"status_code" : 201,
"status_message" : "Created"
}
400 Response
{
"result" : {},
"status_code" : 400,
"status_message" : "Bad Request"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
Deletes the specified Out of Hours diary
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the Out of Hours diary to be deleted
204 Response
{
"result" : {},
"status_code" : 204,
"status_message" : "No Content"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
Deletes the specified Out of Hours diary
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the Out of Hours diary to be deleted
204 Response
{
"result" : {},
"status_code" : 204,
"status_message" : "No Content"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}