LiveChat_Shift
You need the Manage Settings permission to manage Shifts.
LiveChat_Shifts
- LiveChat_Shifts Manage
GET livechat/shifts
GET livechat/shifts/{id}
POST livechat/shifts
PUT livechat/shifts/{id}
DELETE livechat/shifts/{id}
Model
LiveChat_Shift JSON Format
LiveChat_Shift is represented as simple flat JSON objects with the following keys:
| Name | Type | Description |
|---|---|---|
id |
guid | Id of the shift. |
timeZone |
string | Time zone of the shift.Value includes all Time Zone Option identifiers. |
autoDetectDayLightSavingsTime |
bool | Whether auto detect Daylight Saving Time or not. |
name |
string | Name of the shift. |
shiftHolidays |
shiftHolidays[] | Reference to LiveChat_ShiftHoliday. |
shiftWorkingHours |
shiftWorkingHours[] | Reference to Shift Working Hours. |
departmentIds |
array | The list of the shift ids which the department belongs to. |
agentIds |
array | The list of the shift identifiers, which the agent belongs to. |
LiveChat_ShiftHoliday JSON Format:
| Name | Type | Description |
|---|---|---|
id |
guid | Id of the shift holiday. |
name |
string | Name of the shift holiday. |
holidayDate |
datetime | Date of the shift holiday. |
shiftId |
guid | Id of the shift. |
Shift Working Hours JSON Format:
| Name | Type | Description |
|---|---|---|
id |
guid | Id of the shift working hours. |
shiftId |
guid | Id of the shift. |
dayOfWeek |
string | Allowed values are "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday". |
startTime |
time | Start time of the shift working hours. |
endTime |
time | End time of the shift working hours. |
agentAwayStatusId |
guid | Id of the agent away status. |
Endpoint
Get the list of LiveChat_Shifts
GET livechat/shifts
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
include |
string | query | no | Allowed values are "agent", "department", "shiftHoliday", "shiftWorkingHours". |
Response:
An array of LiveChat_Shift
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/shifts \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Get a single LiveChat_Shift
GET livechat/shifts/{id}
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
include |
string | query | no | Allowed values are "agent", "department", "shiftHoliday", "shiftWorkingHours". |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/shifts/8CAF5329-7C46-EB11-8100-00155D081D0B \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Create a new LiveChat_Shift
POST livechat/shifts
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
timeZone |
string | body | yes | Time zone of the shift.Value includes all Time Zone Option identifiers. |
autoDetectDayLightSavingsTime |
bool | body | no | Whether auto detect Daylight Saving Time or not. |
name |
string | body | yes | Name of the shift. |
shiftHolidays |
shiftHolidays[] | body | no | Reference to LiveChat_ShiftHoliday. |
shiftWorkingHours |
shiftWorkingHours[] | body | no | Reference to Shift Working Hours. |
departmentIds |
array | body | no | The list of the shift ids which the department belongs to. |
agentIds |
array | body | no | The list of the shift identifiers, which the agent belongs to. |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/shifts \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"timeZone":"China Standard Time","autoDetectDayLightSavingsTime":false,"name":"shift","shiftHolidays":[{"name":"shiftHoliday","holidayDate":"2021-05-01"}],"shiftWorkingHours":[{"dayOfWeek":"Monday","startTime":"09:00:00","endTime":"18:00:00","agentAwayStatusId":"DFAF5329-7C46-EB11-8100-00155D081D0B"}]}'
Response:
HTTP/1.1 201 Created
Update the LiveChat_Shift
PUT livechat/shifts/{id}
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
timeZone |
string | body | yes | Time zone of the shift.Value includes all Time Zone Option identifiers. |
autoDetectDayLightSavingsTime |
bool | body | no | Whether auto detect Daylight Saving Time or not. |
name |
string | body | yes | Name of the shift. |
shiftHolidays |
shiftHolidays[] | body | no | Reference to LiveChat_ShiftHoliday. |
shiftWorkingHours |
shiftWorkingHours[] | body | no | Reference to Shift Working Hours. |
departmentIds |
array | body | no | The list of the shift ids which the department belongs to. |
agentIds |
array | body | no | The list of the shift identifiers, which the agent belongs to. |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/shifts/8CAF5329-7C46-EB11-8100-00155D081D0B \
-X
'PUT'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"timeZone":"China Standard Time","autoDetectDayLightSavingsTime":false,"name":"shift","shiftHolidays":[{"name":"shiftHoliday","holidayDate":"2021-05-01"}],"shiftWorkingHours":[{"dayOfWeek":"Monday","startTime":"09:00:00","endTime":"18:00:00","agentAwayStatusId":"DFAF5329-7C46-EB11-8100-00155D081D0B"}]}'
Response:
HTTP/1.1 200 OK
Remove the LiveChat_Shift
DELETE livechat/shifts/{id}
Parameters:
No Parameters
Response:
No Content
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/shifts/8CAF5329-7C46-EB11-8100-00155D081D0B \
-X
'DELETE'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 204 No Content