rejectedDialOutRequest method

Future<DynamiteResponse<RoomRejectedDialOutRequestResponseApplicationJson, void>> rejectedDialOutRequest({
  1. required String callId,
  2. required String token,
  3. ContentString<RoomRejectedDialOutRequestOptions>? options,
  4. RoomRejectedDialOutRequestApiVersion? apiVersion,
  5. 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:

  • 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.
  • apiVersion Defaults to "v4".
  • token
  • 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:

Implementation

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

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