getOperatorDepartments
Returns all departments for a specified operator (agent).
Input parameters
Parameter | Type | Required | Description |
---|---|---|---|
OperatorID | numeric - ID code | Yes | The identifier of the operator. |
Request format
curl "https://api.boldchat.com/aid/$accountID/data/rest/json/v1/getOperatorDepartments?auth=$authHash&OperatorID=$OperatorID"
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:
|
BHTimeZoneID | numeric - ID code | Time zone of the department defined in | in the Bold360 Admin Center.
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. |
ExceptionOverride | integer | Indicates active Exceptions-by-date option in the Department information in the Bold360 Admin Center. |
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. |
Priority | integer | Indicates the priority/urgency of a chat as defined by the rules
engine:
|
RolloverDepartmentID | numeric - ID code | The ID of the rollover department as defined in the Bold360 Admin Center. If Null, check the RolloverDepartmentIDs field. |
Status | codes - set values | "Success" when the call completes; "Error" when the call fails. |
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. |
Updated | date - ISO / UTC | Date and time when the <event/record> was most recently modified. |
Sample code
{
"Status": "success",
"Truncated": false,
"Data": [
{
"DepartmentID": "445201227043018690",
"Name": "WhatsApp Dept.",
"EmailAddress": null,
"AccountID": "447307266697849894",
"Created": "2019-09-26T12:44:52.917Z",
"Updated": "2019-09-26T12:44:52.917Z",
"Deleted": null,
"RolloverDepartmentID": null,
"DeletedBy": null,
"LanguageCode": "",
"BHTimeZoneID": null,
"IgnoreOperatorStatus": 0,
"ExceptionOverride": 0,
"Priority": 2,
"AssignmentPriority": null
}
]
}