Skip to main content

Resume

Overview​

The resume action resumes a call that was previously placed on hold. Use it after preparing a transfer, completing a lookup, or returning from a temporary hold state. Place it in the actions array returned by your answer_url. MiniVoice executes actions in order, so put resume before the action that depends on its result and after any prompt or setup the caller should experience first.

Business Use Case​

Use resume after a hold period when the caller should return to the active call flow. For example, resume before announcing that a receptionist is transferring the call.

JSON Example​

{
  "actions": [
    {
      "resume": {}
    }
  ]
}

Parameters​

FieldTypeRequiredDescription
typestringYesMust be resume when using typed action format.

Execution Flow​

  1. MiniVoice reaches the resume action.
  2. The call is taken off hold.
  3. Audio returns to the normal call path.
  4. MiniVoice continues with any later actions.

Webhook Behaviour​

No action-specific webhook is sent for resume.

Success Example​

A successful answer_url response includes the action in a valid actions array:

{
  "actions": [
    {
      "resume": {}
    }
  ]
}

Your application should store the MiniVoice call ID from webhooks or API responses so you can correlate the action with the call.

Failure Behaviour​

Resume can fail if the call is no longer active or was not in a state that can be resumed. Design flows so resume happens soon after hold.

Expected Result​

MiniVoice resumes the call audio and continues with the next action.

Testing​

Create an answer flow with hold, resume, and say. Place a call and verify audio returns before the say prompt plays. During testing, log every webhook payload and compare the call ID, action timing, and final call status with the behavior you expected.

Integration guidance

Place this action in a short answer_url response first, then combine it with other actions after you have confirmed the single-action behaviour. Always log the answer_url response your application returned for the call. If the caller experience differs from what you expected, compare the logged response with the webhook timeline for that call ID.

When this action is part of a larger IVR, keep each step explicit. For example, play a prompt before collecting input, redirect after collecting input, and transfer only after your application has selected the final destination. This makes the flow easier to test and easier to change later.

For production integrations, build a fallback path. A caller may hang up, enter no digits, reach a busy destination, or disconnect before the flow completes. Your webhook handler should update the call record with the last known step so support teams can understand what happened.

Copy/Paste Examples​

Real Request​

Return this from your answer_url:

{
  "actions": [
    {
      "resume": {}
    }
  ]
}

Real Response​

A valid answer_url response is the JSON action payload itself. MiniVoice accepts the response when it contains an actions array:

{
  "actions": [
    {
      "resume": {}
    }
  ]
}

Real Webhook Example​

{
  "event": "call.completed",
  "created_at": "2026-05-29T12:10:00Z",
  "call": {
    "id": "call_123",
    "customer_id": "cust_123",
    "application_id": "app_123",
    "status": "completed",
    "direction": "inbound",
    "from": "+15551230001",
    "to": "+15551230002"
  },
  "variables": {},
  "data": {}
}

Common Use Case​

Use resume after a hold period when the caller should return to the active call flow. For example, resume before announcing that a receptionist is transferring the call.

Common Failure Case​

{
  "error": {
    "code": "answer_url_error",
    "message": "invalid action payload"
  }
}

Invalid fields or malformed JSON cause MiniVoice to reject the answer_url payload. Log the exact response your server returned while testing.