Rate this page:

callConference

Copy URL
callConference(conferenceId: 

string

,
callerid:

string

,
displayName:

string

,
headers:

{[header: string]: string}

,
scheme:

{[id: string]: any}

):

Call

Make a call to a conference using Conference module. If there's no such conference, it'll be created in the first method's call. The method is designed to be called in simple incoming scenario, then it can trigger another special scenario which contains logic of the conference. The method can trigger the Failed event in 60 sec, see the details in VoxEngine session limits.

Parameters

  • conferenceId:

    string

    Id of the conference. The parameter has to be the same as a pattern in a rule so the method triggers appropriate rule with conference logic.

  • callerid:

    string

    CallerID of the caller that will be displayed to the callee user. Usage of whitespaces is not allowed. Normally it's some phone number that can be used for callback. IMPORTANT: test numbers rented from Voximplant can't be used as CallerID, use only real numbers.

  • displayName:

    string

    Name of the caller that will be displayed to the callee. Normally it's a human-readable version of CallerID, e.g. a person's name.

  • headers:

    {[header: string]: string}

    Optional

    Optional SIP headers to be passed with a call to conference. Custom header names have to begin with the 'X-' prefix. The "X-" headers can be handled by a SIP phone or WEB SDK (e.g. see the incomingCall event). Example: {'X-header':'value'}

  • scheme:

    {[id: string]: any}

    Optional

    Internal information about codecs from the AppEvents.CallAlerting event.

Returns