API Reference
API StatusSupportLog In

Update a Live Call

post
https://www.freeclimb.com/apiserver/Accounts//Calls/

Update the status of a live call in order to hang up. Call hang up may take time. A 202 status code is returned if the hangup request was successfully queued by FreeClimb. Otherwise, an error code is returned. If successfully queued, the asynchronous callback for the result will occur after some time through the statusCallbackUrl.

An inbound call which is currently ringing is in progress from the point of view of FreeClimb and requires status=completed to hang up. This means it will be answered and then hung up. Use PerCL Reject to reject the call without it being answered.

Path Params
string
required

ID of the account that created this call.

string
required

String that uniquely identifies this call resource.

Body Params
string
required

Either canceled or completed. Specifying canceled attempts to cancel (and not bill for) an outdialed call that hasn't been answered yet, otherwise will hang it up if it has been answered. Specifying completed attempts to hang up a call already in progress, and an inbound ringing call will be answered and then hung up.

Response

Updated 12 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 months ago