Skip to content
SIP.IO
DocsStart free

Live Call Control

Your app can drive a call that is already up: put it on hold, mute it, send keypresses, park it, or hang it up. This is what a CRM’s “Hold” button or an agent desktop’s “End call” button calls under the hood.

Terminal window
curl -X POST 'https://api.sip.io/v1/calls/mine/control' \
-H 'x-api-key: sk_…' -H 'content-type: application/json' \
-d '{ "action": "hold" }'
actionEffect
hold · unholdHold the far end (they hear hold music) and take it back.
mute · unmuteStop and restart sending your audio.
dtmfSend keypresses into the call, with digits (for an IVR on the far end).
parkPark the call so someone else can pick it up.
hangupEnd the call.
  • mine is the call the credential’s own user is on, which is all a softphone or agent app needs.
  • With the calls:all scope an admin or supervisor app can control any live call in the account, named by its SIP Call-ID or its media-edge channel id (as the live board reports it).
  • A session token is always limited to its own user’s calls.
StatuserrorMeaning
403not_your_callWithout calls:all, the call must be yours.
404no_active_call · call_not_found · call_endedThere is no live call by that id.
409call_control_refusedThe media edge refused the action: the call has just ended, or is not anchored on it.
502node_error · no_nodeThe node carrying the call could not be reached.