Jump to: navigation, search

CompleteConference

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

Overview

Completes a previously initiated conference. Once completed, the two separate calls are brought together so that all three parties are participating in the same call.

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

Parameters

Parameter Value
operationName CompleteConference
consultCallUri You can use this optional parameter to specify the consult call that should be used to complete the conference. If not provided, Web Services determines the related call.

Sample

Request

POST api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES00000B
{
  "operationName": "CompleteConference"
}

HTTP response

{
  "statusCode": 0
}

CometD notification

The first notification is that the consult call is released:

{  
   "data":{  
      "notificationType":"StatusChange",
      "call":{  
         "id":"01RCC3N118B1V0SL8O7GK2LAES00000B",
         "state":"Released",
         "callUuid":"01RCC3N118B1V0SL8O7GK2LAES00000B",
         "connId":"007102719818000b",
         "deviceUri":"http://127.0.0.1:8080/api/v2/devices/631608b3-ceb1-472b-ba05-2ae39555b0d1",
         "participants":[  
            {  
               "e164Number":"",
               "formattedPhoneNumber":"15002",
               "phoneNumber":"15002",
               "digits":"15002"
            }
         ],
         "dnis":"15002",
         "callType":"Consult",
         "capabilities":[  
 
         ],
         "parentCallUri":"http://127.0.0.1:8080/api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES000009",
         "duration":"24",
         "mute":"Off",
         "supervisorListeningIn":false,
         "monitoredUserMuted":false,
         "monitoring":false,
         "uri":"http://127.0.0.1:8080/api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES00000B",
         "path":"/calls/01RCC3N118B1V0SL8O7GK2LAES00000B",
         "parentCallPath":"/calls/01RCC3N118B1V0SL8O7GK2LAES000009"
      },
      "phoneNumber":"15000",
      "extensions":{  
         "BusinessCall":0
      },
      "messageType":"CallStateChangeMessage"
   },
   "channel":"/v2/me/calls"
}


The second notification is that the participants for the original call have been updated to include the new party:

{  
   "data":{  
      "notificationType":"ParticipantsUpdated",
      "call":{  
         "id":"01RCC3N118B1V0SL8O7GK2LAES000009",
         "state":"Established",
         "callUuid":"01RCC3N118B1V0SL8O7GK2LAES000009",
         "connId":"0071027198180009",
         "deviceUri":"http://127.0.0.1:8080/api/v2/devices/631608b3-ceb1-472b-ba05-2ae39555b0d1",
         "participants":[  
            {  
               "e164Number":"",
               "formattedPhoneNumber":"15002",
               "phoneNumber":"15002",
               "digits":"15002"
            },
            {  
               "e164Number":"",
               "formattedPhoneNumber":"15001",
               "phoneNumber":"15001",
               "digits":"15001"
            }
         ],
         "dnis":"15001",
         "callType":"Internal",
         "capabilities":[  
            "UpdateUserData",
            "SendDtmf",
            "InitiateConference",
            "Hold",
            "SingleStepTransfer",
            "InitiateTransfer",
            "RemoveParticipantFromConference",
            "AttachUserData",
            "DeleteUserDataPair",
            "SingleStepConference",
            "DeleteUserData",
            "MuteCall",
            "Hangup"
         ],
         "duration":"748",
         "mute":"Off",
         "supervisorListeningIn":false,
         "monitoredUserMuted":false,
         "monitoring":false,
         "uri":"http://127.0.0.1:8080/api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES000009",
         "path":"/calls/01RCC3N118B1V0SL8O7GK2LAES000009"
      },
      "phoneNumber":"15000",
      "extensions":{  
         "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.