Evo Voice

<back to all web services

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


export class NodeParameterMap
{
    [key:string] : NodeParameter;

    public constructor(init?: Partial<NodeParameterMap>) { (Object as any).assign(this, init); }
}


/** @description Search for phone numbers */
// @Api(Description="Search for phone numbers")
export class SearchPhoneNumbers implements IGet
{
    /** @description The account you are searching for */
    // @ApiMember(Description="The account you are searching for")
    public accountId: string;

    /** @description The area code */
    // @ApiMember(Description="The area code")
    public areaCode: string;

    /** @description The country code you are searching for */
    // @ApiMember(Description="The country code you are searching for")
    public countryCode: string;

    /** @description The postal code you are searching for */
    // @ApiMember(Description="The postal code you are searching for")
    public postalCode: string;

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

    /** @description Search for fax numbers */
    // @ApiMember(Description="Search for fax numbers")
    public isFaxNumber: boolean;

    /** @description Contains specific digits */
    // @ApiMember(Description="Contains specific digits")
    public contains: string;

    public constructor(init?: Partial<SearchPhoneNumbers>) { (Object as any).assign(this, init); }
}

TypeScript SearchPhoneNumbers DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: team.evovoice.io 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[{"phoneNumber":"String"}]