Skip to main content

Unmute

Overview​

The unmute action restores audio after a mute action. Use it as the paired action for mute in privacy or coached-call flows. Place it in the actions array returned by your answer_url. MiniVoice executes actions in order, so put unmute before the action that depends on its result and after any prompt or setup the caller should experience first.

Business Use Case​

Use unmute to restore audio after a caller was muted in a conference or controlled bridge flow.

JSON Example​

{
  "actions": [
    {
      "unmute": {
        "direction": "read"
      }
    }
  ]
}

Parameters​

FieldTypeRequiredDescription
typestringYesMust be unmute when using typed action format.
directionstringYesread, write, or both.

Execution Flow​

  1. MiniVoice validates the direction.
  2. It restores the requested audio path.
  3. The call remains active.
  4. Later actions continue normally.

Webhook Behaviour​

No action-specific webhook is sent for unmute.

Success Example​

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

{
  "actions": [
    {
      "unmute": {
        "direction": "read"
      }
    }
  ]
}

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

Failure Behaviour​

Invalid direction values are rejected. If the call is no longer active, unmute cannot be applied.

Expected Result​

MiniVoice restores the requested audio direction and continues executing the action list.

Testing​

Run mute and unmute in sequence during a test call. Confirm audio behavior changes as expected. 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": [
    {
      "unmute": {
        "direction": "read"
      }
    }
  ]
}

Real Response​

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

{
  "actions": [
    {
      "unmute": {
        "direction": "read"
      }
    }
  ]
}

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 unmute to restore audio after a caller was muted in a conference or controlled bridge flow.

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.