Jump to: navigation, search

DeleteUserDataPair

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

Overview

Deletes the specified key from the call data.

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

Parameters

Parameter Value
operationName DeleteUserDataPair
key The key to be removed from the call data.

Sample

Before sending this request, the test call has the following userData property:

"userData": {
    "AccountNumber": "12345678",
    "CustomerSegment": "Platinum",
    "CustomerName": "James"
}

Request

POST api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES00000R
{
  "operationName": "DeleteUserDataPair",
  "key": "CustomerSegment"
}

HTTP response

{
  "statusCode": 0
}

CometD notification

{  
   "data":{  
      "notificationType":"AttachedDataChanged",
      "call":{  
         "id":"01RCC3N118B1V0SL8O7GK2LAES00000R",
         "state":"Dialing",
         "callUuid":"01RCC3N118B1V0SL8O7GK2LAES00000R",
         "connId":"007102719818001b",
         "deviceUri":"http://127.0.0.1:8080/api/v2/devices/631608b3-ceb1-472b-ba05-2ae39555b0d1",
         "participants":[  
            {  
               "e164Number":"",
               "formattedPhoneNumber":"15001",
               "phoneNumber":"15001",
               "digits":"15001"
            }
         ],
         "dnis":"15001",
         "callType":"Internal",
         "capabilities":[  
            "UpdateUserData",
            "SendDtmf",
            "AttachUserData",
            "DeleteUserDataPair",
            "DeleteUserData",
            "Hangup"
         ],
         "userData":{  
            "AccountNumber":"12345678",
            "CustomerName":"James"
         },
         "duration":"1110",
         "mute":"Off",
         "supervisorListeningIn":false,
         "monitoredUserMuted":false,
         "monitoring":false,
         "uri":"http://127.0.0.1:8080/api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES00000R",
         "path":"/calls/01RCC3N118B1V0SL8O7GK2LAES00000R"
      },
      "phoneNumber":"15000",
      "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.