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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Voice.Api.Endpoints

Namespace Global

    Namespace Voice.Api.Endpoints

        '''<Summary>
        '''Search for phone numbers
        '''</Summary>
        <Api(Description:="Search for phone numbers")>
        Public Partial Class SearchPhoneNumbers
            Implements IGet
            '''<Summary>
            '''The account you are searching for
            '''</Summary>
            <ApiMember(Description:="The account you are searching for")>
            Public Overridable Property AccountId As String

            '''<Summary>
            '''The area code
            '''</Summary>
            <ApiMember(Description:="The area code")>
            Public Overridable Property AreaCode As String

            '''<Summary>
            '''The country code you are searching for
            '''</Summary>
            <ApiMember(Description:="The country code you are searching for")>
            Public Overridable Property CountryCode As String

            '''<Summary>
            '''The postal code you are searching for
            '''</Summary>
            <ApiMember(Description:="The postal code you are searching for")>
            Public Overridable Property PostalCode As String

            '''<Summary>
            '''The distance from the specified postal code (default is 100)
            '''</Summary>
            <ApiMember(Description:="The distance from the specified postal code (default is 100)")>
            Public Overridable Property Distance As Integer?

            '''<Summary>
            '''Search for fax numbers
            '''</Summary>
            <ApiMember(Description:="Search for fax numbers")>
            Public Overridable Property IsFaxNumber As Boolean

            '''<Summary>
            '''Contains specific digits
            '''</Summary>
            <ApiMember(Description:="Contains specific digits")>
            Public Overridable Property Contains As String
        End Class
    End Namespace
End Namespace

VB.NET 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>