Function SipApiFactory

  • SipApiFactory(configuration?, basePath?, axios?): {
        dial(roomId, componentId, dialConfig?, options?): AxiosPromise<void>;
        endCall(roomId, componentId, options?): AxiosPromise<void>;
    }

  • SipApi - factory interface

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        dial(roomId, componentId, dialConfig?, options?): AxiosPromise<void>;
        endCall(roomId, componentId, options?): AxiosPromise<void>;
    }

    • dial:function
      • dial(roomId, componentId, dialConfig?, options?): AxiosPromise<void>

      • Parameters

        • roomId: string

          Room ID

        • componentId: string

          SIP Component ID

        • Optional dialConfig: DialConfig

          Phone Number configuration

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<void>

        Summary

        Make a call from the SIP component to the provided phone number

        Throws

    • endCall:function
      • endCall(roomId, componentId, options?): AxiosPromise<void>

      • Parameters

        • roomId: string

          Room ID

        • componentId: string

          SIP Component ID

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<void>

        Summary

        Finish call made by SIP component

        Throws

    Export

Settings

Member Visibility

Theme