Bold360 and BoldChat Developer Center

getDepartmentOperators

Returns operators (agents) for a specified department.

Input parameters

Parameter Type Required Description
Department ID numeric - ID code Yes Department identifier.

Request format

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

Return values

Parameters are provided in alphabetic order. See Sample code for probable output.

Parameter Type Description
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
ChatName string The name of the customer, captured within the VisitName parameter or through Name in pre-chat survey.
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.
Deleted Boolean A True/False setting for whether the item referred to has been 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.
Departments text - heading Heading for an array of department data.
Disable Boolean Disables the operator and prevents them from logging in.
Disabled Boolean Shows the operator's disabled status. Disabled operators cannot login.
Disconnected date - ISO / UTC Date and time the chat operator disconnected from the chat.
Email string - legal email Email address of the message's sender, if available. Must contain @ character.
EmailName string A personal name for the operator in the From address of emails the operator sends.
LoginID numeric - ID code Operator's Bold360 login ID.
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:
  • 0 - Lowest
  • 1 - Low
  • 2 - Medium
  • 3 - High
  • 4 - Highest
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.
UserName string (max) The user name of the Operator.
Note: It cannot be changed later and must be unique.

Sample code

{	
"Status": "success",	
"Truncated": false,	
"Data": [	
	{
	"LoginID": "445438016075741692",
	"UserName": "norbert1234",
	"ChatName": null,
	"Name": "norbert",
	"Email": "norbert.budincsevity@logmein.com",
	"EmailName": null,
	"Priority": 2,
	"AssignmentPriority": null
	},
]	
}