verifyDialInPinDeprecated method
Future<DynamiteResponse<RoomVerifyDialInPinDeprecatedResponseApplicationJson, void> >
verifyDialInPinDeprecated({
- required String token,
- required String pin,
- RoomVerifyDialInPinDeprecatedApiVersion? 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:
apiVersion
Defaults to"v4"
.token
pin
PIN the participant used to dial-in.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Participant returned
- 401: SIP request invalid
- 404: Participant not found
- 501: SIP dial-in is not configured
See:
- $verifyDialInPinDeprecated_Request for the request send by this method.
- $verifyDialInPinDeprecated_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<RoomVerifyDialInPinDeprecatedResponseApplicationJson, void>> verifyDialInPinDeprecated({
required String token,
required String pin,
RoomVerifyDialInPinDeprecatedApiVersion? apiVersion,
bool? oCSAPIRequest,
}) async {
final _request = $verifyDialInPinDeprecated_Request(
token: token,
pin: pin,
apiVersion: apiVersion,
oCSAPIRequest: oCSAPIRequest,
);
final _streamedResponse = await _rootClient.httpClient.send(_request);
final _response = await _i3.Response.fromStream(_streamedResponse);
final _serializer = $verifyDialInPinDeprecated_Serializer();
return _i1.ResponseConverter<RoomVerifyDialInPinDeprecatedResponseApplicationJson, void>(_serializer)
.convert(_response);
}