$verifyDialOutNumber_Request method

@experimental Request $verifyDialOutNumber_Request({ required String number, required String token, ContentString<RoomVerifyDialOutNumberOptions>? options, RoomVerifyDialOutNumberApiVersion? apiVersion, bool? oCSAPIRequest, })

Verify a dial-out number (SIP bridge).

Returns a DynamiteRequest backing the verifyDialOutNumber operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

• number E164 formatted phone number.
• 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: Participant created successfully
• 400: Phone number and details could not be confirmed
• 401: SIP request invalid
• 404: Phone number is not invited as a participant
• 501: SIP dial-out is not configured

See:

• verifyDialOutNumber for a method executing this request and parsing the response.
• $verifyDialOutNumber_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $verifyDialOutNumber_Request({
  required String number,
  required String token,
  ContentString<RoomVerifyDialOutNumberOptions>? options,
  RoomVerifyDialOutNumberApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $number = _$jsonSerializers.serialize(number, specifiedType: const FullType(String));
  _parameters['number'] = $number;

  final $token = _$jsonSerializers.serialize(token, specifiedType: const FullType(String));
  _i4.checkString(
    $token,
    'token',
    pattern: RegExp(r'^[a-z0-9]{4,30}$'),
  );
  _parameters['token'] = $token;

  final $options = _$jsonSerializers.serialize(
    options,
    specifiedType: const FullType(ContentString, [FullType(RoomVerifyDialOutNumberOptions)]),
  );
  _parameters['options'] = $options;

  var $apiVersion =
      _$jsonSerializers.serialize(apiVersion, specifiedType: const FullType(RoomVerifyDialOutNumberApiVersion));
  $apiVersion ??= 'v4';
  _parameters['apiVersion'] = $apiVersion;

  final _path =
      _i5.UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/verify-dialout{?number*,options*}')
          .expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  }

// coverage:ignore-end
  var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i4.HeaderEncoder().convert($oCSAPIRequest);

  return _request;
}