verifyDialInPin method

Future<DynamiteResponse<RoomVerifyDialInPinResponseApplicationJson, void>> verifyDialInPin({ required String pin, required String token, RoomVerifyDialInPinApiVersion? apiVersion, bool? oCSAPIRequest, })

Verify a dial-in PIN (SIP bridge).

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:

• pin PIN the participant used to dial-in.
• apiVersion Defaults to "v4".
• token
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Participant returned
• 401: SIP request invalid
• 404: Participant not found
• 501: SIP dial-in is not configured

See:

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

Implementation

Future<_i1.DynamiteResponse<RoomVerifyDialInPinResponseApplicationJson, void>> verifyDialInPin({
  required String pin,
  required String token,
  RoomVerifyDialInPinApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $verifyDialInPin_Request(
    pin: pin,
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

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