(Update with the copy of version: 8.5.2DRAFT) |
(Update with the copy of version: 8.5.2DRAFT) |
||
| Line 3: | Line 3: | ||
This operation is part of the [[VoiceAPI|Voice API]] section of the [[Welcome|Web Services API]]. | This operation is part of the [[VoiceAPI|Voice API]] section of the [[Welcome|Web Services API]]. | ||
==Overview== | ==Overview== | ||
| − | Configures barge to the target device. | + | Configures barge in to the target device. If the agent is currently on a call and T-Server is configured to allow barge in, the supervisor is immediately added to the call. Both the monitored agent and the customer are able to hear and speak with the supervisor. If the target agent is not on a call at the time of the request, the supervisor is brought into the call when the agent receives a new call. |
| − | |||
| − | If the agent is currently on a call and | ||
| − | |||
| − | If the target agent is not on a call at the time of the request, the supervisor | ||
| − | |||
| − | |||
{| | {| | ||
! Request URL | ! Request URL | ||
| − | | /api/v2/me/devices/{id} | + | | /api/v2/me/devices/''{id}'' |
|- | |- | ||
| − | ! HTTP | + | ! HTTP method |
| POST | | POST | ||
|- | |- | ||
| − | ! Required | + | ! Required features |
| api-voice, api-supervisor-monitoring | | api-voice, api-supervisor-monitoring | ||
|} | |} | ||
| Line 31: | Line 25: | ||
| targetDeviceUri | | targetDeviceUri | ||
| The URI of the device to monitor. | | The URI of the device to monitor. | ||
| − | |||
| − | |||
|- | |- | ||
| supervisorMonitoringScope | | supervisorMonitoringScope | ||
| This optional parameter specifies the scope of monitoring: | | This optional parameter specifies the scope of monitoring: | ||
| − | *Agent | + | *Agent — Only activity for the target agent is monitored. If the monitored agent transfers the call to another agent, the supervisor is released from the call with the agent. |
| − | *Call | + | *Call — The supervisor monitors the entire call, regardless of the path it takes. If the monitored agent transfers the call, the supervisor continues to monitor as the customer is serviced by the new agent. |
| − | + | If not specified, Call is the default. | |
|- | |- | ||
| supervisorMonitoringMode | | supervisorMonitoringMode | ||
| This optional parameter specifies the monitoring mode: | | This optional parameter specifies the monitoring mode: | ||
| − | *NextCall | + | *NextCall — Monitor only the next call the agent receives, then stop monitoring. |
| − | *AllCalls | + | *AllCalls — Monitoring all agent calls until monitoring is cancelled. |
| − | + | If not specified, AllCalls is the default. | |
|} | |} | ||
==Sample== | ==Sample== | ||
===Request=== | ===Request=== | ||
| − | < | + | <source lang="text"> |
POST api/v2/me/devices/efe1ab32-53f9-43ce-b65e-5768c61f7d4a | POST api/v2/me/devices/efe1ab32-53f9-43ce-b65e-5768c61f7d4a | ||
{ | { | ||
| Line 55: | Line 47: | ||
"targetDeviceUri": "http://localhost:8080/api/v2/devices/9c14cad7-17c4-48d0-8492-7cf0ff92c224" | "targetDeviceUri": "http://localhost:8080/api/v2/devices/9c14cad7-17c4-48d0-8492-7cf0ff92c224" | ||
} | } | ||
| − | </ | + | </source> |
| − | === | + | ===HTTP response=== |
| − | < | + | <source lang="text"> |
{ | { | ||
"statusCode": 0 | "statusCode": 0 | ||
} | } | ||
| − | </ | + | </source> |
| − | === | + | ===CometD notification=== |
| − | < | + | <source lang="text"> |
{ | { | ||
"data": { | "data": { | ||
| Line 100: | Line 92: | ||
"channel": "/v2/me/devices" | "channel": "/v2/me/devices" | ||
} | } | ||
| − | </ | + | </source> |
[[Category:V:HTCC:8.5.2]] | [[Category:V:HTCC:8.5.2]] | ||
Revision as of 18:22, March 25, 2016
BargeIn
This operation is part of the Voice API section of the Web Services API.
Overview
Configures barge in to the target device. If the agent is currently on a call and T-Server is configured to allow barge in, the supervisor is immediately added to the call. Both the monitored agent and the customer are able to hear and speak with the supervisor. If the target agent is not on a call at the time of the request, the supervisor is brought into the call when the agent receives a new call.
| Request URL | /api/v2/me/devices/{id} |
|---|---|
| HTTP method | POST |
| Required features | api-voice, api-supervisor-monitoring |
Parameters
| Parameter | Value |
|---|---|
| operationName | BargeIn |
| targetDeviceUri | The URI of the device to monitor. |
| supervisorMonitoringScope | This optional parameter specifies the scope of monitoring:
If not specified, Call is the default. |
| supervisorMonitoringMode | This optional parameter specifies the monitoring mode:
If not specified, AllCalls is the default. |
Sample
Request
POST api/v2/me/devices/efe1ab32-53f9-43ce-b65e-5768c61f7d4a
{
"operationName": "BargeIn",
"targetDeviceUri": "http://localhost:8080/api/v2/devices/9c14cad7-17c4-48d0-8492-7cf0ff92c224"
}HTTP response
{
"statusCode": 0
}CometD notification
{
"data": {
"messageType": "DeviceStateChangeMessage",
"devices": [
{
"id": "efe1ab32-53f9-43ce-b65e-5768c61f7d4a",
"deviceState": "Active",
"userState": {
"id": "900D55CC-2BB0-431F-8BF9-D3525B383BE6",
"displayName": "Not Ready",
"state": "NotReady"
},
"phoneNumber": "5005",
"e164Number": "5005",
"telephonyNetwork": "Private",
"doNotDisturb": "On",
"voiceEnvironmentUri": "http://127.0.0.1:8080/api/v2/voice-environments/370ef5e6-9e3c-4d91-9588-7f4dfe67e011",
"capabilities": [
"ForwardCallsOn",
"DoNotDisturbOff",
"ListenIn",
"Coach",
"BargeIn",
"CancelSupervisorMonitoring"
],
"supervisorMonitoringState": {
"state": "BargeIn",
"mode": "AllCalls",
"scope": "Call",
"targetDeviceUri": "http://127.0.0.1:8080/api/v2/devices/9c14cad7-17c4-48d0-8492-7cf0ff92c224"
}
}
]
},
"channel": "/v2/me/devices"
}
Comments or questions about this documentation? Contact us for support!