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
namespace Voice.Api.Endpoints

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Search for phone numbers
    ///</summary>
    [<Api(Description="Search for phone numbers")>]
    [<AllowNullLiteral>]
    type SearchPhoneNumbers() = 
        interface IGet
        ///<summary>
        ///The account you are searching for
        ///</summary>
        [<ApiMember(Description="The account you are searching for")>]
        member val AccountId:String = null with get,set

        ///<summary>
        ///The area code
        ///</summary>
        [<ApiMember(Description="The area code")>]
        member val AreaCode:String = null with get,set

        ///<summary>
        ///The country code you are searching for
        ///</summary>
        [<ApiMember(Description="The country code you are searching for")>]
        member val CountryCode:String = null with get,set

        ///<summary>
        ///The postal code you are searching for
        ///</summary>
        [<ApiMember(Description="The postal code you are searching for")>]
        member val PostalCode:String = null with get,set

        ///<summary>
        ///The distance from the specified postal code (default is 100)
        ///</summary>
        [<ApiMember(Description="The distance from the specified postal code (default is 100)")>]
        member val Distance:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///Search for fax numbers
        ///</summary>
        [<ApiMember(Description="Search for fax numbers")>]
        member val IsFaxNumber:Boolean = new Boolean() with get,set

        ///<summary>
        ///Contains specific digits
        ///</summary>
        [<ApiMember(Description="Contains specific digits")>]
        member val Contains:String = null with get,set

F# 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>