Storefronts
- Invoices
- Credit Notes
Customer Management
VoIP Bundle (Subscriptions)
- VoIP Subscription Bundle
SIP Account Management
Audio Management
- Sounds
- Playlists
Phone Numbers & Call Routing
Phone Calls & CDR Data
VoIP Phone Short Code
- Short Codes
eFax Management
- Fax Messages
- Fax Authorized Senders
Voicemails & Mailboxes
Caller ID
- Caller IDs
- Caller ID Requests
SIP Trunks
- Trunk Authentication
- VoIP Trunks
Wallboard Statistics
VoIP Phone Provisioning
- Devices
Call Queueing
Phone Books
- Phone Book
- Phone Book Contact
VoIP Phone Speed Dial
- Speed Dials
Text (SMS) Messaging
- Text Message Campaign

API Access

Build custom apps using our JSON API

Configure API

Time Diaries

Time Diaries are used to modify routing based on the time of day

Become a Reseller

Filter:

All
GET
POST
PUT
DELETE
Chargeable *

* You will be charged every time this command is run.

GET/voip/time-diary

Gets a list of all of the active Out of Hours diaries on an account

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

Response Details

200 Response

{
    "result" : [
        {
            "created_on" : "2023-02-03",
            "elements" : [
                {}
            ],
            "exceptions" : [
                {}
            ],
            "name" : "Pete's Work Schedule",
            "timezone" : "Europe/London",
            "updated_on" : "2023-02-03",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        }
    ],
    "status_code" : 200,
    "status_message" : "OK"
}

GET/voip/out-of-hours

Gets a list of all of the active Out of Hours diaries on an account

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

Response Details

200 Response

{
    "result" : [
        {
            "created_on" : "2023-02-03",
            "elements" : [
                {}
            ],
            "exceptions" : [
                {}
            ],
            "name" : "Pete's Work Schedule",
            "timezone" : "Europe/London",
            "updated_on" : "2023-02-03",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        }
    ],
    "status_code" : 200,
    "status_message" : "OK"
}

GET/voip/time-diary/{uuid}

Gets the details for a specific Out of Hours diary on an account

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the Out of Hours diary to be queried

Response Details

200 Response

{
    "result" : {
        "created_on" : "2023-02-03",
        "elements" : [
            {}
        ],
        "exceptions" : [
            {}
        ],
        "name" : "Pete's Work Schedule",
        "timezone" : "Europe/London",
        "updated_on" : "2023-02-03",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

GET/voip/out-of-hours/{uuid}

Gets the details for a specific Out of Hours diary on an account

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the Out of Hours diary to be queried

Response Details

200 Response

{
    "result" : {
        "created_on" : "2023-02-03",
        "elements" : [
            {}
        ],
        "exceptions" : [
            {}
        ],
        "name" : "Pete's Work Schedule",
        "timezone" : "Europe/London",
        "updated_on" : "2023-02-03",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

POST/voip/time-diary

Creates a new Out of Hours diary

Request Details

Response Details

Request 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)

TimeDiaryElement

TimeDiaryException

JSON all-fields example:

{
    "elements" : [
        {}
    ],
    "exceptions" : [
        {}
    ],
    "name" : "Pete's Work Schedule",
    "timezone" : "Europe/London"
}

Response Details

201 Response

{
    "result" : {
        "created_on" : "2023-02-03",
        "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"
}

POST/voip/out-of-hours

Creates a new Out of Hours diary

Request Details

Response Details

Request 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)

TimeDiaryElement

TimeDiaryException

JSON all-fields example:

{
    "elements" : [
        {}
    ],
    "exceptions" : [
        {}
    ],
    "name" : "Pete's Work Schedule",
    "timezone" : "Europe/London"
}

Response Details

201 Response

{
    "result" : {
        "created_on" : "2023-02-03",
        "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"
}

PUT/voip/time-diary/{uuid}

Updates the specified Out of Hours diary
Back to top

Request Details

Response Details
Request 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)
TimeDiaryElement
TimeDiaryException
JSON all-fields example:
{ "elements" : [ {} ], "exceptions" : [ {} ], "name" : "Pete's Work Schedule", "timezone" : "Europe/London" }
Response Details

201 Response
```
{
    "result" : {
        "created_on" : "2023-02-03",
        "elements" : [
            {}
        ],
        "exceptions" : [
            {}
        ],
        "name" : "Pete's Work Schedule",
        "timezone" : "Europe/London",
        "updated_on" : "2023-02-03",
        "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"
}
```
PUT/voip/out-of-hours/{uuid}

Updates the specified Out of Hours diary
Back to top

Request Details

Response Details
Request 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)
TimeDiaryElement
TimeDiaryException
JSON all-fields example:
{ "elements" : [ {} ], "exceptions" : [ {} ], "name" : "Pete's Work Schedule", "timezone" : "Europe/London" }
Response Details

201 Response
```
{
    "result" : {
        "created_on" : "2023-02-03",
        "elements" : [
            {}
        ],
        "exceptions" : [
            {}
        ],
        "name" : "Pete's Work Schedule",
        "timezone" : "Europe/London",
        "updated_on" : "2023-02-03",
        "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"
}
```
DELETE/voip/time-diary/{uuid}

Deletes the specified Out of Hours diary
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the Out of Hours diary to be deleted
Response Details

204 Response
```
{
    "result" : {},
    "status_code" : 204,
    "status_message" : "No Content"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```
DELETE/voip/out-of-hours/{uuid}

Deletes the specified Out of Hours diary
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the Out of Hours diary to be deleted
Response Details

204 Response
```
{
    "result" : {},
    "status_code" : 204,
    "status_message" : "No Content"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```

API Access

Time Diaries

GET/voip/time-diary

Request Details

Response Details

GET/voip/out-of-hours

Request Details

Response Details

GET/voip/time-diary/{uuid}

Request Details

Response Details

GET/voip/out-of-hours/{uuid}

Request Details

Response Details

POST/voip/time-diary

Request Details

TimeDiaryElement

TimeDiaryException

Response Details

POST/voip/out-of-hours

Request Details

TimeDiaryElement

TimeDiaryException

Response Details

PUT/voip/time-diary/{uuid}

Request Details

TimeDiaryElement

TimeDiaryException

Response Details

PUT/voip/out-of-hours/{uuid}

Request Details

TimeDiaryElement

TimeDiaryException

Response Details

DELETE/voip/time-diary/{uuid}

Request Details

Response Details

DELETE/voip/out-of-hours/{uuid}

Request Details

Response Details