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
"use strict";
export class SearchPhoneNumbers {
    /** @param {{accountId?:string,areaCode?:string,countryCode?:string,postalCode?:string,distance?:number,isFaxNumber?:boolean,contains?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The account you are searching for */
    accountId;
    /**
     * @type {string}
     * @description The area code */
    areaCode;
    /**
     * @type {string}
     * @description The country code you are searching for */
    countryCode;
    /**
     * @type {string}
     * @description The postal code you are searching for */
    postalCode;
    /**
     * @type {?number}
     * @description The distance from the specified postal code (default is 100) */
    distance;
    /**
     * @type {boolean}
     * @description Search for fax numbers */
    isFaxNumber;
    /**
     * @type {string}
     * @description Contains specific digits */
    contains;
}

JavaScript SearchPhoneNumbers DTOs

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

HTTP + XML

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/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfPhoneNumberInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Endpoints">
  <PhoneNumberInfo>
    <PhoneNumber>String</PhoneNumber>
  </PhoneNumberInfo>
</ArrayOfPhoneNumberInfo>