getDepartments
Returns all departments for the account.
Input parameters
None.
Request format
curl "https://api.boldchat.com/aid/$accountID/data/rest/json/v1/getDepartments?auth=$authHash"
Return values
Parameters are provided in alphabetic order. See Sample code for probable output.
Parameter | Type | Description |
---|---|---|
AccountID | numeric - ID code | Bold360 product account ID. |
AssignmentPriority | integer | A weighting that can be applied to departments or operators for
ACD assignments:
|
AsyncService | text - heading | Messaging header. |
Available | Boolean | T/F - Shows whether a service - SMS, Twitter, Facebook, etc. - is available for access and use. |
BHTimeZoneID | numeric - ID code | Time zone of the department defined in Organization | Departments in the Bold360 Admin Center. |
Capacity | integer | Quantity of chat assignments that can be made concurrently for a given service. |
ChatService | text - heading | Data header for a JSON array. |
Created | date - ISO/UTC | Date and time when the target resource was created. |
Data | text - heading | JSON array heading that precedes report data output |
Deleted | date - ISO / UTC | Date and time when the item was deleted. The value is null if the item was not deleted. |
DeletedBy | string (max) | The name of the agent who deleted the item. <None> or null value indicates that the <resource> was not deleted. |
DepartmentID | numeric - ID code | ID of the department. |
EmailAddress | string - legal email | Destination for chat transcripts. Sent after chat completion. |
EmailService | codes - set values | Data header showing an integer field, Capacity, and a Boolean field, Available. |
ExceptionOverride | integer | Indicates active Exceptions-by-date option in the Department information in the Bold360 Admin Center. |
FacebookService | text - heading | Data header for the Facebook service |
IgnoreOperatorStatus | integer | The current Ignore Agent Status setting in the Department information in the Bold360 Admin Center. |
LanguageCode | code - ISO 639 | The language of the chat, based on two-letter ISO 639-1 standard. |
Name | string(30) | The name of the folder as defined in the system. |
OmniQueueService | text - heading | Header for Omni-queue channels available for the Operator. |
OperatorCapacity | integer | The maximum number of chat assignments an operator can be assigned at one time. |
OperatorID | numeric - ID code | System-assigned ID of the operator. |
Operators | text - heading | Heading for the operators array. |
Priority | integer | Indicates the priority/urgency of a chat as defined by the rules
engine:
|
QueueCapacity | integer | The number of assignments available for a department for a given service (SMS, Chat, Tickets, etc.) |
RolloverDepartmentID | numeric - ID code | The ID of the rollover department as defined in the Bold360 Admin Center. If Null, check the RolloverDepartmentIDs field. |
RolloverDepartmentIDs | string | The list of rollover department IDs as defined in the Bold360 Admin Center. |
SmsService | text - heading | Header for SMS Service reporting. |
Status | codes - set values | "Success" when the call completes; "Error" when the call fails. |
TicketService | text - heading | Header for Bold360 Ticket Service reporting. |
Truncated | Boolean | TRUE if results were shortened to fit the report, FALSE if full results for the report criteria were returned. If TRUE, you can filter down the results set or contact us to try to find a way to get at the data you are looking for. |
TwitterService | text - heading | Header for Twitter Service reporting. |
Updated | date - ISO / UTC | Date and time when the <event/record> was most recently modified. |
Sample code
{
"Status": "success",
"Truncated": false,
"Data": [
{
"DepartmentID": "150678485807423039",
"Name": "Internal Affairs",
"AccountID": "627499986405274345",
"Created": "2016-08-10T18:54:54.573Z",
"Updated": "2019-03-12T19:02:08.657Z",
"Deleted": null,
"RolloverDepartmentID": null,
"RolloverDepartmentIDs": [],
"DeletedBy": "5676748830204723022",
"LanguageCode": "",
"BHTimeZoneID": "US/Eastern",
"IgnoreOperatorStatus": 0,
"ExceptionOverride": 0,
"Operators": [],
"SmsService": {
"Available": 0,
"QueueCapacity": 0,
"OperatorCapacity": 0,
"Capacity": 0
},
"EmailService": {
"Available": 0,
"QueueCapacity": 0,
"OperatorCapacity": 0,
"Capacity": 0
},
"TicketService": {
"Available": 0,
"QueueCapacity": 0,
"OperatorCapacity": 0,
"Capacity": 0
},
"ChatService": {
"Available": 0,
"QueueCapacity": 0,
"OperatorCapacity": 0,
"Capacity": 0
},
"TwitterService": {
"Available": 0,
"QueueCapacity": 0,
"OperatorCapacity": 0,
"Capacity": 0
}
}
]
}