SingleStepConference

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

Overview

Performs a single-step conference, adding the specified participant to the call.

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

Parameters

Parameter	Value
operationName	SingleStepConference
destination	A JSON object that includes the number to dial.
location	An optional parameter that is used by Web Services to set the location attribute for the corresponding T-Server requests.
userData	An optional JSON object that includes key/value data to be included with the call.

Sample 1

Request

POST api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES000007
{
  "operationName": "SingleStepConference",
  "destination": {
    "phoneNumber": "15002"
  }
}

HTTP response

{
  "statusCode": 0
}

CometD notification

{  
   "data":{  
      "notificationType":"ParticipantsUpdated",
      "call":{  
         "id":"01RCC3N118B1V0SL8O7GK2LAES000007",
         "state":"Established",
         "callUuid":"01RCC3N118B1V0SL8O7GK2LAES000007",
         "connId":"0071027198180007",
         "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"
         ],
         "userData":{  
            "FirstConferencePartyDN":"15000"
         },
         "duration":"52",
         "mute":"Off",
         "supervisorListeningIn":false,
         "monitoredUserMuted":false,
         "monitoring":false,
         "uri":"http://127.0.0.1:8080/api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES000007",
         "path":"/calls/01RCC3N118B1V0SL8O7GK2LAES000007"
      },
      "phoneNumber":"15000",
      "extensions":{  
         "BusinessCall":0
      },
      "messageType":"CallStateChangeMessage"
   },
   "channel":"/v2/me/calls"
}

Sample 2

Request

POST api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES000008
{
  "operationName": "SingleStepConference",
  "destination": {
    "phoneNumber": "15002"
  },
  "userData": {
    "AccountNumber": "12345"
  }
}

HTTP response

{
  "statusCode": 0
}

CometD notification

{  
   "data":{  
      "notificationType":"ParticipantsUpdated",
      "call":{  
         "id":"01RCC3N118B1V0SL8O7GK2LAES000008",
         "state":"Established",
         "callUuid":"01RCC3N118B1V0SL8O7GK2LAES000008",
         "connId":"0071027198180008",
         "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"
         ],
         "userData":{  
            "AccountNumber":"12345",
            "FirstConferencePartyDN":"15000"
         },
         "duration":"64",
         "mute":"Off",
         "supervisorListeningIn":false,
         "monitoredUserMuted":false,
         "monitoring":false,
         "uri":"http://127.0.0.1:8080/api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES000008",
         "path":"/calls/01RCC3N118B1V0SL8O7GK2LAES000008"
      },
      "phoneNumber":"15000",
      "extensions":{  
         "BusinessCall":0
      },
      "messageType":"CallStateChangeMessage"
   },
   "channel":"/v2/me/calls"
}