Call Control

Hold a call

Places an active call on hold, pausing audio while keeping the connection alive. This is useful for transfers, multi-line handling, or when temporarily stepping away during a customer interaction.

Provider Support

Most providers support this operation, though behavior may vary.

Note: 3CX does not support call hold and will return an HTTP 404 if this endpoint is used.

Behavior

When invoked, audio is suspended for all participants while the call remains connected. Depending on provider settings, hold music or silence may be played. The call can be resumed using the Resume Call endpoint. Call duration and billing ( if applicable) typically continue during the hold period.

Requirements and Errors

Requires a valid call_id for an active (answered) call and a provider that supports hold.

Errors may occur if:

  • The provider (e.g., 3CX) does not support hold.
  • The call is not in an active state.
  • The call_id is invalid or not found.
  • Permissions are insufficient to control the call.
PUT/v1/accounts/:accountID/applications/:applicationID/providers/:providerID/calls/:callID/hold
Click to copy
curl --request PUT \
  --url http://api.voistrix.com/v1/accounts/:accountID/applications/:applicationID/providers/:providerID/calls/:callID/hold \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Path Parameters

  • :accountID - REQUIRED[String]

    The referenced account ID.

  • :applicationID - REQUIRED[String]

    The referenced application ID.

  • :providerID - REQUIRED[String]

    The referenced provider ID.

  • :callID - REQUIRED[String]

    The referenced call ID.

Response

Indicates the request was successful. Returns a status code of 204 with no content returned in the response body.

Errors

A common set of Error Responses can be found here.