Requires any of the roles: | SystemAdministrator, Manager, Customer |
GET | /endpoints/phone-numbers/search |
---|
import Foundation
import ServiceStack
/**
* Search for phone numbers
*/
// @Api(Description="Search for phone numbers")
public class SearchPhoneNumbers : IGet, Codable
{
/**
* The account you are searching for
*/
// @ApiMember(Description="The account you are searching for")
public var accountId:String
/**
* The area code
*/
// @ApiMember(Description="The area code")
public var areaCode:String
/**
* The country code you are searching for
*/
// @ApiMember(Description="The country code you are searching for")
public var countryCode:String
/**
* The postal code you are searching for
*/
// @ApiMember(Description="The postal code you are searching for")
public var postalCode:String
/**
* The distance from the specified postal code (default is 100)
*/
// @ApiMember(Description="The distance from the specified postal code (default is 100)")
public var distance:Int?
/**
* Search for fax numbers
*/
// @ApiMember(Description="Search for fax numbers")
public var isFaxNumber:Bool
/**
* Contains specific digits
*/
// @ApiMember(Description="Contains specific digits")
public var contains:String
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length [{"phoneNumber":"String"}]