Update Call

This request changes the call state.

put	/calls/{id}

Sample Request

This is a sample PUT request to update a call:

curl -X PUT \
'https://api.carrierx.com/conference/v1/calls/6889184' \
-H 'Content-Type: application/json' \
--data-binary '{"customName": "name"}' \
-u '[your_user_name]:[your_password]'

Sample Response

200 status code with a serialized copy of the updated Call object:

{
    "calls": [
        {
            "accessCode": "111",
            "addressFrom": "+15162065319",
            "addressTo": "\"15162065318\" <sip:15162065318@10.2.114.15>",
            "bridgeName": "MIA-FCC4D",
            "callee": "15162065318",
            "caller": "+15162065319",
            "codec": "PCMU",
            "connectionStatus": 0,
            "created": 1544643810000,
            "customName": "",
            "duration": 171,
            "gainLevel": 0,
            "holdMode": 0,
            "id": 6889184,
            "joined": 1544643810000,
            "meetingNumber": 106131,
            "muteMode": 0,
            "nodeName": "10.2.114.15",
            "presenterMedia": 0,
            "qaMode": 0,
            "role": 1,
            "state": 2
        }
    ],
    "last": 0,
    "offset": 0,
    "total": 1
}

A Call object can be updated using a PUT request. The call ID is passed in the query URL, and the values to be modified are passed in the request body.

Path Arguments

Parameter	Data Type	Description
id required	integer	The call ID.

Body Arguments

JSON representation of the fields and values to be updated.

Fields that can be modified are:

• accessCode
• addressFrom
• addressTo
• callee
• caller
• codec
• connectionStatus
• customName
• gainLevel
• holdMode
• muteMode
• nodeName
• presenterMedia
• role
• state

Refer to this table to view all fields that appear in the Call object.