Jump to: navigation, search

Retrieve

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

Overview

Retrieves a call from hold.

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

Parameters

Parameter Value
operationName Retrieve

Sample

HTTP response

POST api/v2/me/calls/012PUFMMS0ASNAK48O7GK2LAES00000I
{
  "operationName": "Retrieve"
}

CometD notification

{
  "statusCode": 0
}

Notification

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