Custom Away Status

You need Manage Custom Away Status permission to manage Custom Away Status.

Custom Away Statuses
- Custom Away Statuses Manage
GET global/agentAwayStatuses
GET global/agentAwayStatuses/{id}
POST global/agentAwayStatuses
PUT global/agentAwayStatuses/{id}
DELETE global/agentAwayStatuses/{id}
Model
Custom Away Status JSON Format

Custom Away Status is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of the custom away status.
name string Name of the custom away status.
order integer Order of the custom away status.
isSystem bool Whether the custom away status is system or not.
Endpoint
Get the list of Custom Away Statuses

GET global/agentAwayStatuses

Parameters:
No Parameters
Response:

An array of   Custom Away Status

Example

Sample Request:

curl https://api15.comm100.io/v4/global/agentAwayStatuses \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"id":"5827eacf-c08e-4eb9-b09c-00155d081d0b","name":"Away","order":0,"isSystem":true}]
Get a single Custom Away Status

GET global/agentAwayStatuses/{id}

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/global/agentAwayStatuses/5827eacf-c08e-4eb9-b09c-00155d081d0b \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"5827eacf-c08e-4eb9-b09c-00155d081d0b","name":"Away","order":0,"isSystem":true}
Create a new Custom Away Status

POST global/agentAwayStatuses

Parameters:
Name Type In Required Description
name string body yes Name of the custom away status.
order integer body no Order of the custom away status.
isSystem bool body no Whether the custom away status is system or not.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/global/agentAwayStatuses \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"name":"Away","order":0,"isSystem":true}'

Response:

 HTTP/1.1 201 Created

{"id":"5827eacf-c08e-4eb9-b09c-00155d081d0b","name":"Away","order":0,"isSystem":true}
Update the Custom Away Status

PUT global/agentAwayStatuses/{id}

Parameters:
Name Type In Required Description
name string body yes Name of the custom away status.
order integer body no Order of the custom away status.
isSystem bool body no Whether the custom away status is system or not.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/global/agentAwayStatuses/5827eacf-c08e-4eb9-b09c-00155d081d0b \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"name":"Away","order":0,"isSystem":true}'

Response:

 HTTP/1.1 200 OK

{"id":"5827eacf-c08e-4eb9-b09c-00155d081d0b","name":"Away","order":0,"isSystem":true}
Remove the Custom Away Status

DELETE global/agentAwayStatuses/{id}

Parameters:
No Parameters
Response:

No Content

Example

Sample Request:

curl https://api15.comm100.io/v4/global/agentAwayStatuses/5827eacf-c08e-4eb9-b09c-00155d081d0b \
-X 'DELETE' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 204 No Content