Call Hold
Function: CALL_HOLD
The CALL_HOLD function is used to place an ongoing call on hold or resume a call on the test device. This function is essential for testing call hold and resume features.
Supported on: Android and iOS.
Before this step: a call must already be connected, normally by an earlier MAKE_CALL or ANSWER_CALL step.
Parameters¶
| Parameter Name | Description | Example Values | Required | Default Value |
|---|---|---|---|---|
| STATUS | The status to set for the call hold action: ON puts the active call on hold, OFF resumes the held call. |
ON, OFF |
Yes | ON |
| TIMEOUT | The maximum time to wait for the call hold action before considering it a failure. Whole seconds, 0-3700. | Recommended 15 - 60 | Yes | |
| EXPECT | The expected result of the call hold attempt. It defines what constitutes a successful call hold. | SUCCESS, FAIL |
Yes | SUCCESS |
The step editor pre-selects ON. In an API payload STATUS must be present: a step without it is rejected with 400 ("Missing required parameters"). The OFF that GET /api/v2/functionparams lists as its default is not filled in for you.