Bold360 and BoldChat Developer Center

getOperator

Returns full detail for a specified operator / agent.

Input parameter

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

Request format

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

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 priority
Available Boolean T/F - Shows whether a service - SMS, Twitter, Facebook, etc. - is available for access and use.
Capacity integer Quantity of chat assignments that can be made concurrently for a given service.
ChatName string The name of the customer, captured within the VisitName parameter or through Name in pre-chat survey.
ChatService text - heading Data header for a JSON array.
Data text - heading JSON array heading that precedes report data output.
DepartmentID numeric - ID code ID of the department.
Departments text - heading Heading for an array of department data.
Disabled Boolean Shows the operator's disabled status. Disabled operators cannot login.
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.
EmailService codes - set values Data header showing an integer field, Capacity, and a Boolean field, Available.
LoginID numeric - ID code Operator's Bold360 login ID.
Name string(30) The name of the folder as defined in the system.
PermissionGroupID numeric - ID code Unique ID for the billing system permission group.
Priority integer Indicates the priority/urgency of a chat as defined by the rules engine:
  • 0 - Lowest
  • 1 - Low
  • 2 - Normal
  • 3 - High
  • 4 - Highest
SmsService text - heading Header for SMS Service reporting.
SSONameID string The single sign-on ID of the operator.
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.
UserName string (max) The user name of the Operator. Note: it cannot be changed later and must be unique.

Sample code

{			
	"Status": "success",		
	"Data": {		
		"Departments": [	
		{	
			"AssignmentPriority": null,
			"Priority": 2,
			"DepartmentID": "445206667043018690"
		}	
	],		
	"UserName": "norbert1234",		
	"Email": "norbert.budincsevity@logmein.com",		
	"LoginID": "445466616075741692",		
	"ChatName": null,		
	"SmsService": {		
		"Capacity": 0,	
		"Available": false	
	},		
	"TicketService": {		
		"Capacity": 0,	
		"Available": false	
	},		
	"Name": "Herbert",		
	"SSONameID": null,		
	"EmailName": null,		
	"TwitterService": {		
		"Capacity": 0,	
		"Available": false	
	},		
		"PermissionGroupID": null,	
		"EmailService": {	
		"Capacity": 0,	
		"Available": false	
	},		
		"Disabled": null,	
		"ChatService": {	
		"Capacity": 0,	
		"Available": false	
	}		
	}		
}