Start conference call

This event is used to start a conference call by inviting a participant to an ongoing regular call.

{
  "type": "DIALER.INVITE_PARTICIPANT",
  "payload": {
    "to": "String"
  }
}

Upon starting the conference by inviting a participant, you shall receive the following DIALER.CALL_STATUS event:

{
  "type": "DIALER.CALL_STATUS",
  "payload": {
    "flow": "regular",
    "status": "startingConference"
  }
}

When the invited participant is ringing, you shall receive the following DIALER.CALL_STATUS event:

{
  "type": "DIALER.CALL_STATUS",
  "payload": {
    "flow": "conference",
    "status": "initiating"
  }
}

If the invited participant doesn't pick-up the call, the call shall revert to a regular call flow, and you shall receive the following DIALER.CALL_STATUS event:

{
  "type": "DIALER.CALL_STATUS",
  "payload": {
    "flow": "regular",
    "status": "connected"
  }
}

If the invited participant picks-up the call, you shall receive the following DIALER.CALL_STATUS event:

{
  "type": "DIALER.CALL_STATUS",
  "payload": {
    "flow": "conference",
    "status": "initiated"
  }
}

A conference call requires a minimum of three participants. Once the conference call has started, if an additional participant is invited, the call remains a conference call and will not trigger the call status events mentioned previously.

However, if at any moment the number of participants is less than three participants, the call shall revert to a regular call flow. In this case, you shall receive the following DIALER.CALL_STATUS event:

{
  "type": "DIALER.CALL_STATUS",
  "payload": {
    "flow": "regular",
    "status": "connected"
  }
}

To determine the individual state of each participant, such as whether they are ringing or answering, you should refer to the DIALER.SYNC event. In the case of conference calls, this event exposes, as part of metadata, a participants property that lists the participants in the conference call. Each participant has a state property that indicates their current status within the call.

note

The current user is not included in the participants list. To determine the state of the current user, you should refer to the me property.