Jump to: navigation, search

SwitchToListenIn

This operation is part of the Voice API section of the Web Services API.

Overview

Switches to ListenIn for the current call. If the supervisor switches from Coach to ListenIn, they cannot switch back to Coach and can only move to BargeIn.

Request URL /api/v2/me/calls/{id}
HTTP method POST
Required features api-voice, api-supervisor-monitoring

Parameters

Parameter Value
operationName SwitchToListenIn

Sample

Request

POST api/v2/me/calls/011DJV5JI898NB2L04000VTAES00000I
{
  "operationName": "SwitchToListenIn"
}

HTTP response

{
  "statusCode": 0
}

CometD notification

Important
Note that mute now has a value of On.
{  
   "data":{  
      "notificationType":"StatusChange",
      "call":{  
         "id":"011DJV5JI898NB2L04000VTAES00000I",
         "state":"Established",
         "callUuid":"011DJV5JI898NB2L04000VTAES00000I",
         "connId":"007102385535e00e",
         "deviceUri":"http://127.0.0.1:8080/api/v2/devices/efe1ab32-53f9-43ce-b65e-5768c61f7d4a",
         "participants":[  
            {  
               "e164Number":"",
               "formattedPhoneNumber":"5000",
               "phoneNumber":"5000",
               "digits":"5000"
            },
            {  
               "e164Number":"",
               "formattedPhoneNumber":"5001",
               "phoneNumber":"5001",
               "digits":"5001"
            }
         ],
         "dnis":"5001",
         "callType":"Internal",
         "capabilities":[  
            "AttachUserData",
            "InitiateConference",
            "UpdateUserData",
            "Hold",
            "SingleStepTransfer",
            "DeleteUserData",
            "SingleStepConference",
            "Hangup",
            "DeleteUserDataPair",
            "SendDtmf",
            "InitiateTransfer",
            "SwitchToBargeIn",
            "RemoveParticipantFromConference"
         ],
         "duration":"75",
         "mute":"On",
         "supervisorListeningIn":false,
         "monitoredUserMuted":false,
         "uri":"http://127.0.0.1:8080/api/v2/me/calls/011DJV5JI898NB2L04000VTAES00000I",
         "path":"calls/011DJV5JI898NB2L04000VTAES00000I"
      },
      "phoneNumber":"5005",
      "extensions":{  
         "WrapUpTime":0,
         "BusinessCall":0
      },
      "messageType":"CallStateChangeMessage"
   },
   "channel":"/v2/me/calls"
}

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on March 25, 2016, at 10:22.