Skip to main content

Hold

This event is used to hold a participant during a call.

{
  "type": "DIALER.HOLD",
  "payload": {
    "shouldHold": "Boolean!",
    "legId": "String!"
  }
}

If you want to hang up an ongoing call, you can use the DIALER.HANGUP event instead.

note

If you try to reject an outgoing call or a call that has already been ended, the event will be ignored and you won't receive any error or acknowledgment.

Reference​

  • shouldHold: Whether the participant should be put on hold or not.
  • legId: The leg identifier of the participant to put on hold.
    • The leg identifier can be retrieved from the list of the participants exposed by the DIALER.SYNC event.