From Bright Pattern Documentation
| Line 5: | Line 5: | ||
Note that the agent must be logged in to Agent Desktop in order to use setStatus. See this specification's [[Embedded-agent-desktop-sdk-specification/UseCases/ChangeAgentState | Use Cases]] section for ways to use this method. | Note that the agent must be logged in to Agent Desktop in order to use setStatus. See this specification's [[Embedded-agent-desktop-sdk-specification/UseCases/ChangeAgentState | Use Cases]] section for ways to use this method. | ||
| − | == Syntax == | + | == Request == |
| + | === Syntax === | ||
window.bpspat.api.setStatus(status,reason_code="") | window.bpspat.api.setStatus(status,reason_code="") | ||
| Line 11: | Line 12: | ||
window.bpspat.api.setStatus('READY') | window.bpspat.api.setStatus('READY') | ||
| − | == Parameters == | + | === Parameters === |
{|border="1" style="border-collapse:collapse" cellpadding="5" | {|border="1" style="border-collapse:collapse" cellpadding="5" | ||
| '''Parameter''' | | '''Parameter''' | ||
| Line 29: | Line 30: | ||
|} | |} | ||
| + | == Response == | ||
| + | Empty. | ||
| + | |||
| + | In response to the request, the agent status is changed. | ||
Revision as of 00:28, 9 February 2019
<translate>
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.
</translate>