getDepartment

Input parameter

Parameter	Type	Required	Description
DepartmentID	numeric - ID code	Yes	The identifier of the department to retrieve.

Request format

curl "https://api.boldchat.com/aid/$accountID/data/rest/json/v1/getDepartment?auth=$authHash&DepartmentID=$DepartmentID"

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: 0 - Low priority 1 2 - Medium priority 3 4 - Urgent
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: 0 - Lowest 1 - Low 2 - Medium 3 - High 4 - Highest
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.
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.
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",
    "Data": {
        "DeletedBy": null,
        "Operators": [
            {
                "AssignmentPriority": 4,
                "Priority": 2,
                "OperatorID": "4268164510608180761"
            }
        ],
        "AccountID": "627499986405274345",
        "RolloverDepartmentID": null,
        "Updated": "2019-02-11T17:21:51.123Z",
        "ExceptionOverride": 1,
        "SmsService": {
            "Available": 0,
            "QueueCapacity": 0,
            "OperatorCapacity": 0,
            "Capacity": 0
        },
        "TicketService": {
            "Available": 0,
            "QueueCapacity": 0,
            "OperatorCapacity": 0,
            "Capacity": 0
        },
        "EmailAddress": null,
        "Name": "English Support",
        "Created": "2018-07-10T15:42:58.597Z",
        "LanguageCode": "",
        "TwitterService": {
            "Available": 0,
            "QueueCapacity": 0,
            "OperatorCapacity": 0,
            "Capacity": 0
        },
        "BHTimeZoneID": "US/Eastern",
        "DepartmentID": "623209402056077884",
        "Deleted": null,
        "IgnoreOperatorStatus": 0,
        "EmailService": {
            "Available": 0,
            "QueueCapacity": 0,
            "OperatorCapacity": 0,
            "Capacity": 0
        },
        "ChatService": {
            "Available": 0,
            "QueueCapacity": 0,
            "OperatorCapacity": 0,
            "Capacity": 0
        }
    }
}