From Bright Pattern Documentation
(Updated via BpDeleteTranslateTags script) |
|||
| (4 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ||
= getState = | = getState = | ||
| − | Requests information about an agent's current state and interactions. | + | Requests information about an agent's current state and interactions. getState uses a callback function with command GET_STATE to request agent state and interaction data. |
| − | Note that the agent must be logged in to Agent Desktop in order to use ''getState''. | + | Note that the agent must be logged in to Agent Desktop in order to use ''getState''. See this specification's [[Embedded-agent-desktop-sdk-specification/UseCases/GetAgentStateInteractionInfo | Use Cases]] section for ways to use this method. |
| − | == Syntax == | + | == Request == |
| + | === Syntax === | ||
window.bpspat.api.getState(callback) | window.bpspat.api.getState(callback) | ||
callback = function(data) { | callback = function(data) { | ||
} | } | ||
| − | == Parameters == | + | === Parameters === |
{|border="1" style="border-collapse:collapse" cellpadding="5" | {|border="1" style="border-collapse:collapse" cellpadding="5" | ||
| '''Parameter''' | | '''Parameter''' | ||
| Line 23: | Line 24: | ||
== Response == | == Response == | ||
| − | |||
The following is an example of the response you may get when you call ''getState''. Every time the state changes, the logs display the updated agent state: | The following is an example of the response you may get when you call ''getState''. Every time the state changes, the logs display the updated agent state: | ||
| Line 30: | Line 30: | ||
{"command":"STATE_CHANGED","data":{"agent_id":"jeffery.lozada","status":"not_ready","reason":"Not ready"}} | {"command":"STATE_CHANGED","data":{"agent_id":"jeffery.lozada","status":"not_ready","reason":"Not ready"}} | ||
{"command":"GET_STATE","data":{"agent_id":"jeffery.lozada","interactions":[{"item_id":"5B07EFE4-0658-45E0-AA6E-23AA042C1F0E","screenpop_data":{}}],"status":"ready","reason":""},"request_id":"2"} | {"command":"GET_STATE","data":{"agent_id":"jeffery.lozada","interactions":[{"item_id":"5B07EFE4-0658-45E0-AA6E-23AA042C1F0E","screenpop_data":{}}],"status":"ready","reason":""},"request_id":"2"} | ||
| + | |||
=== Response Fields === | === Response Fields === | ||
| Line 72: | Line 73: | ||
| Phone number dialed (either extension number or full number) | | Phone number dialed (either extension number or full number) | ||
| "1012" | | "1012" | ||
| + | |- | ||
| + | | recording_url | ||
| + | | string | ||
| + | | URL of the call recording | ||
| + | | "/msgplayback?tenant_id=1F64161D-C1C4-4A57-8DC4-B6B2ED7412C8&rtp_processor_id=7C0DCA41-F507-42B9-9D40-0E3B9F302B9F&message=recordings/<tenant>.brightpattern.com/2019-02-09/72E82ED8-769D-4267-85D3-EC890D653240&key_id=D811EFBA-5F8A-4AE5-A80C-8F07B7372BEF&CRC=aaadd10b9dbee5e52dcf60fe104982dd" | ||
| + | |- | ||
| + | | request_id | ||
| + | | number | ||
| + | | Indicates how many times you have made the getState request | ||
| + | | "3" (e.g., this is the third time requesting agent status information) | ||
|- | |- | ||
| service | | service | ||
| Line 81: | Line 92: | ||
| string | | string | ||
| Information shown on screen-pop | | Information shown on screen-pop | ||
| − | | | + | | - |
|- | |- | ||
| attached_data | | attached_data | ||
| object | | object | ||
| − | | | + | | Data attached to a call |
| - | | - | ||
|} | |} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 04:02, 29 May 2024
getState
Requests information about an agent's current state and interactions. getState uses a callback function with command GET_STATE to request agent state and interaction data.
Note that the agent must be logged in to Agent Desktop in order to use getState. See this specification's Use Cases section for ways to use this method.
Request
Syntax
window.bpspat.api.getState(callback)
callback = function(data) {
}
Parameters
| Parameter | Type | Description |
| callback | function | JavaScript method executed when API method request is completed |
Response
The following is an example of the response you may get when you call getState. Every time the state changes, the logs display the updated agent state:
Logs...
{"command":"STATE_CHANGED","data":{"agent_id":"jeffery.lozada","status":"ready","reason":""}}
{"command":"STATE_CHANGED","data":{"agent_id":"jeffery.lozada","status":"not_ready","reason":"Not ready"}}
{"command":"GET_STATE","data":{"agent_id":"jeffery.lozada","interactions":[{"item_id":"5B07EFE4-0658-45E0-AA6E-23AA042C1F0E","screenpop_data":{}}],"status":"ready","reason":""},"request_id":"2"}
Response Fields
| Name | Data Type | Description | Example |
| agent_id | string | agent username | "john.smith" |
| status | string | agent state | "Not ready" |
| reason | string | Not Ready reason | "Lunch" |
| interactions | array | List of interaction data, including data items below | "item_id":"5B07EFE4-0658-45E0-AA6E-23AA042C1F0E","screenpop_data":{} |
| item.id | string | Interaction ID | "5B07EFE4-0658-45E0-AA6E-23AA042C1F0E" |
| global_id | string | Global interaction ID (GIID) | "0CB4F48D-C4D8-4C9F-94F5-770AD5002C40" |
| phone_number | string | Phone number dialed (either extension number or full number) | "1012" |
| recording_url | string | URL of the call recording | "/msgplayback?tenant_id=1F64161D-C1C4-4A57-8DC4-B6B2ED7412C8&rtp_processor_id=7C0DCA41-F507-42B9-9D40-0E3B9F302B9F&message=recordings/<tenant>.brightpattern.com/2019-02-09/72E82ED8-769D-4267-85D3-EC890D653240&key_id=D811EFBA-5F8A-4AE5-A80C-8F07B7372BEF&CRC=aaadd10b9dbee5e52dcf60fe104982dd" |
| request_id | number | Indicates how many times you have made the getState request | "3" (e.g., this is the third time requesting agent status information) |
| service | string | Name of the service handling the interaction | "Maintenance Renewal" |
| screenpop_data | string | Information shown on screen-pop | - |
| attached_data | object | Data attached to a call | - |