verifyDialOutNumber method

Future<DynamiteResponse<RoomVerifyDialOutNumberResponseApplicationJson, void>> verifyDialOutNumber({ required String number, required String token, ContentString<RoomVerifyDialOutNumberOptions>? options, RoomVerifyDialOutNumberApiVersion? apiVersion, bool? oCSAPIRequest, })

Verify a dial-out number (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:

• 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_Request for the request send by this method.
• $verifyDialOutNumber_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<RoomVerifyDialOutNumberResponseApplicationJson, void>> verifyDialOutNumber({
  required String number,
  required String token,
  ContentString<RoomVerifyDialOutNumberOptions>? options,
  RoomVerifyDialOutNumberApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $verifyDialOutNumber_Request(
    number: number,
    token: token,
    options: options,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

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