Skip to main content

Conference

Overview​

The conference action places the caller into a named conference room. Use it for support rooms, team huddles, moderated calls, and multi-party workflows. Place it in the actions array returned by your answer_url. MiniVoice executes actions in order, so put conference before the action that depends on its result and after any prompt or setup the caller should experience first.

Business Use Case​

Use conference for a shared room such as a team bridge, appointment consultation, or support escalation room. Multiple callers can be directed to the same room name.

JSON Example​

{
  "actions": [
    {
      "conference": {
        "room": "support-room-1001"
      }
    }
  ]
}

Parameters​

FieldTypeRequiredDescription
typestringYesMust be conference when using typed action format.
roomstringYesConference room name. Use letters, digits, dot, dash, or underscore.
mutebooleanNoWhether the participant joins muted.
end_on_exitbooleanNoWhether the room should end when this participant exits.

Execution Flow​

  1. MiniVoice validates the room name and options.
  2. It moves the caller into the named room.
  3. Other participants can join the same room using the same room value.
  4. Actions after conference are not run while the caller is in the room.

Webhook Behaviour​

No conference-specific webhook is sent. Use call lifecycle events to observe when participants leave.

Success Example​

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

{
  "actions": [
    {
      "conference": {
        "room": "support-room-1001"
      }
    }
  ]
}

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 room names are rejected. Choose stable room names generated by your application, such as account ID plus meeting ID.

Expected Result​

The caller joins the named room. Other callers sent to the same room can speak with them while normal call lifecycle webhooks continue to track each call.

Testing​

Return the same conference action for two test callers. Confirm both callers hear each other in the room. During testing, log every webhook payload and compare the call ID, action timing, and final call status with the behavior you expected.

Copy/Paste Examples​

Real Request​

Return this from your answer_url:

{
  "actions": [
    {
      "conference": {
        "room": "support-room-1001"
      }
    }
  ]
}

Real Response​

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

{
  "actions": [
    {
      "conference": {
        "room": "support-room-1001"
      }
    }
  ]
}

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 conference for a shared room such as a team bridge, appointment consultation, or support escalation room. Multiple callers can be directed to the same room name.

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.