sipDialOut method

Future<DynamiteResponse<CallSipDialOutResponseApplicationJson, void>> sipDialOut({ required String token, required int attendeeId, CallSipDialOutApiVersion? apiVersion, 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:

• $sipDialOut_Request for the request send by this method.
• $sipDialOut_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<CallSipDialOutResponseApplicationJson, void>> sipDialOut({
  required String token,
  required int attendeeId,
  CallSipDialOutApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $sipDialOut_Request(
    token: token,
    attendeeId: attendeeId,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $sipDialOut_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<CallSipDialOutResponseApplicationJson, void>(_serializer).convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}