| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| GET | /endpoints/phone-numbers/search |
|---|
export class NodeParameterMap
{
[key:string] : NodeParameter;
public constructor(init?: Partial<NodeParameterMap>) { (Object as any).assign(this, init); }
}
/**
* Search for phone numbers
*/
// @Api(Description="Search for phone numbers")
export class SearchPhoneNumbers implements IGet
{
/**
* The account you are searching for
*/
// @ApiMember(Description="The account you are searching for")
public accountId?: string;
/**
* The area code
*/
// @ApiMember(Description="The area code")
public areaCode?: string;
/**
* The country code you are searching for
*/
// @ApiMember(Description="The country code you are searching for")
public countryCode?: string;
/**
* The postal code you are searching for
*/
// @ApiMember(Description="The postal code you are searching for")
public 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 distance?: number;
/**
* Search for fax numbers
*/
// @ApiMember(Description="Search for fax numbers")
public isFaxNumber?: boolean;
/**
* Contains specific digits
*/
// @ApiMember(Description="Contains specific digits")
public contains?: string;
public constructor(init?: Partial<SearchPhoneNumbers>) { (Object as any).assign(this, init); }
}
TypeScript SearchPhoneNumbers DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>