Evo Voice

SearchPhoneNumbers

Search for phone numbers

**Requires Authentication**
Requires any of the roles:	SystemAdministrator, Manager, Customer

The following routes are available for this service:
GET	/endpoints/phone-numbers/search

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

/**
* Search for phone numbers
*/
// @Api(Description="Search for phone numbers")
class SearchPhoneNumbers implements IGet, IConvertible
{
    /**
    * The account you are searching for
    */
    // @ApiMember(Description="The account you are searching for")
    String? accountId;

    /**
    * The area code
    */
    // @ApiMember(Description="The area code")
    String? areaCode;

    /**
    * The country code you are searching for
    */
    // @ApiMember(Description="The country code you are searching for")
    String? countryCode;

    /**
    * The postal code you are searching for
    */
    // @ApiMember(Description="The postal code you are searching for")
    String? postalCode;

    /**
    * The distance from the specified postal code (default is 100)
    */
    // @ApiMember(Description="The distance from the specified postal code (default is 100)")
    int? distance;

    /**
    * Search for fax numbers
    */
    // @ApiMember(Description="Search for fax numbers")
    bool? isFaxNumber;

    /**
    * Contains specific digits
    */
    // @ApiMember(Description="Contains specific digits")
    String? contains;

    SearchPhoneNumbers({this.accountId,this.areaCode,this.countryCode,this.postalCode,this.distance,this.isFaxNumber,this.contains});
    SearchPhoneNumbers.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        accountId = json['accountId'];
        areaCode = json['areaCode'];
        countryCode = json['countryCode'];
        postalCode = json['postalCode'];
        distance = json['distance'];
        isFaxNumber = json['isFaxNumber'];
        contains = json['contains'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'accountId': accountId,
        'areaCode': areaCode,
        'countryCode': countryCode,
        'postalCode': postalCode,
        'distance': distance,
        'isFaxNumber': isFaxNumber,
        'contains': contains
    };

    getTypeName() => "SearchPhoneNumbers";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'evovoice.io', types: <String, TypeInfo> {
    'SearchPhoneNumbers': TypeInfo(TypeOf.Class, create:() => SearchPhoneNumbers()),
});

Dart SearchPhoneNumbers DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /endpoints/phone-numbers/search HTTP/1.1 
Host: evovoice.io 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"phoneNumber":"String"}]