From Bright Pattern Documentation
imported>Tracy |
(Updated via BpDeleteTranslateTags script) |
||
| Line 1: | Line 1: | ||
| − | + | ||
= setStatus = | = setStatus = | ||
Requests an agent routing state change (with or without a reason code). setStatus uses a callback function with command CHANGE_STATE to set the agent state and reason. | Requests an agent routing state change (with or without a reason code). setStatus uses a callback function with command CHANGE_STATE to set the agent state and reason. | ||
| Line 34: | Line 34: | ||
In response to the request, the agent status is changed. | In response to the request, the agent status is changed. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 04:09, 29 May 2024
setStatus
Requests an agent routing state change (with or without a reason code). setStatus uses a callback function with command CHANGE_STATE to set the agent state and reason.
Note that the agent must be logged in to Agent Desktop in order to use setStatus. See this specification's Use Cases section for ways to use this method.
Request
Syntax
window.bpspat.api.setStatus(status,reason_code="")
For example:
window.bpspat.api.setStatus('READY')
Parameters
| Parameter | Data Type | Required/Optional | Description |
| status | string | required | Specifies the agent state to be set |
| reason_code | number | optional | Specifies the reason for agent state change |
Response
Empty.
In response to the request, the agent status is changed.