startDialOut()

startDialOut(params)

Compatibility:
Prebuilt
Custom

Parameters

  • sipUri is a string used to define the SIP URI of the user being called.
    • This needs to conform to a SIP URI as defined in the RFC.
  • phoneNumber is a string that references the phone number to call. This must be a valid E.164 number (example +12268077097).

Return Value

A dialoutSessionId, which is a UUID string identifying the initiated SIP session.

Errors

Below are the possible errors that the caller of startDialOut() can expect to be thrown:

  • NOT_ALLOWED: will be thrown in case SIP/PSTN is not allowed for the room.
  • DIALOUT_IN_PROGRESS: will be thrown in case the user tries to invoke dialOut more than once.
  • TEMPORARILY_NOT_AVAILABLE: will be thrown in case there are no workers available, usually while we are scaling up.