rejectedDialOutRequest method

Future<DynamiteResponse<RoomRejectedDialOutRequestResponseApplicationJson, void>> rejectedDialOutRequest({ required String token, required String callId, RoomRejectedDialOutRequestApiVersion? apiVersion, String? options, bool? oCSAPIRequest, })

Reset call ID of a dial-out participant when the SIP gateway rejected it.

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
• callId The call ID provided by the SIP bridge earlier to uniquely identify the call to terminate.
• options Additional details to verify the validity of the request.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Call ID reset
• 400: Call ID mismatch or attendeeId not found in $options
• 401: SIP request invalid
• 404: Participant was not found
• 501: SIP dial-out is not configured

See:

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

Implementation

Future<_i1.DynamiteResponse<RoomRejectedDialOutRequestResponseApplicationJson, void>> rejectedDialOutRequest({
  required String token,
  required String callId,
  RoomRejectedDialOutRequestApiVersion? apiVersion,
  String? options,
  bool? oCSAPIRequest,
}) async {
  final _request = $rejectedDialOutRequest_Request(
    token: token,
    callId: callId,
    apiVersion: apiVersion,
    options: options,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $rejectedDialOutRequest_Serializer();
  return _i1.ResponseConverter<RoomRejectedDialOutRequestResponseApplicationJson, void>(_serializer)
      .convert(_response);
}