sipDialOut method

Future<DynamiteResponse<CallSipDialOutResponseApplicationJson, void>> sipDialOut({
  1. required String token,
  2. required int attendeeId,
  3. CallSipDialOutApiVersion? apiVersion,
  4. bool? oCSAPIRequest,
})

Call a SIP dial-out attendee.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • apiVersion Defaults to v4.
  • token
  • attendeeId ID of the attendee to call.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 201: Dial-out initiated successfully
  • 400: SIP dial-out not possible
  • 404: Participant could not be found or is a wrong type
  • 501: SIP dial-out is not configured on the server

See:

Implementation

Future<DynamiteResponse<CallSipDialOutResponseApplicationJson, void>> sipDialOut({
  required String token,
  required int attendeeId,
  CallSipDialOutApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = sipDialOutRaw(
    token: token,
    attendeeId: attendeeId,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}