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
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Search for phone numbers
*/
@Api(Description="Search for phone numbers")
open class SearchPhoneNumbers : IGet
{
    /**
    * The account you are searching for
    */
    @ApiMember(Description="The account you are searching for")
    var accountId:String? = null

    /**
    * The area code
    */
    @ApiMember(Description="The area code")
    var areaCode:String? = null

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

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

    /**
    * The distance from the specified postal code (default is 100)
    */
    @ApiMember(Description="The distance from the specified postal code (default is 100)")
    var distance:Int? = null

    /**
    * Search for fax numbers
    */
    @ApiMember(Description="Search for fax numbers")
    var isFaxNumber:Boolean? = null

    /**
    * Contains specific digits
    */
    @ApiMember(Description="Contains specific digits")
    var contains:String? = null
}

Kotlin 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: 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>