searchByPhoneNumbers method

Future<DynamiteResponse<UsersSearchByPhoneNumbersResponseApplicationJson, void>> searchByPhoneNumbers({
  1. required String location,
  2. required ContentString<BuiltMap<String, BuiltList<String>>> search,
  3. bool? oCSAPIRequest,
})

Search users by their phone numbers.

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:

  • location Location of the phone number (for country code).
  • search Phone numbers to search for.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Users returned
  • 400: Invalid location

See:

Implementation

Future<_i1.DynamiteResponse<UsersSearchByPhoneNumbersResponseApplicationJson, void>> searchByPhoneNumbers({
  required String location,
  required ContentString<BuiltMap<String, BuiltList<String>>> search,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = searchByPhoneNumbersRaw(
    location: location,
    search: search,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}