Class NumberSearchRequest

Namespace

Vonage.Numbers

Assembly

Vonage.dll

Represents a request to search for available or owned phone numbers with optional filtering criteria.

public class NumberSearchRequest

Inheritance

object

NumberSearchRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ApplicationId

The application Id linked to the number.

[JsonProperty("application_id", NullValueHandling = NullValueHandling.Ignore)]
public string ApplicationId { get; set; }

Property Value

string

Country

The two character country code in ISO 3166-1 alpha-2 format

[JsonProperty("country")]
public string Country { get; set; }

Property Value

string

Features

Available features are SMS, VOICE and MMS. To look for numbers that support multiple features, use a comma-separated value: SMS,MMS,VOICE. Must be one of: SMS, VOICE, SMS,VOICE, MMS, SMS,MMS, VOICE,MMS or SMS,MMS,VOICE

[JsonProperty("features")]
public string Features { get; set; }

Property Value

string

HasApplication

Set this optional field to true to restrict your results to numbers associated with an Application (any Application). Set to false to find all numbers not associated with any Application. Omit the field to avoid filtering on whether or not the number is assigned to an Application.

[JsonProperty("has_application", NullValueHandling = NullValueHandling.Ignore)]
public bool? HasApplication { get; set; }

Property Value

bool?

Index

Page index

[JsonProperty("index", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
public int? Index { get; set; }

Property Value

int?

Pattern

The number pattern you want to search for. Use in conjunction with search_pattern.

[JsonProperty("pattern")]
public string Pattern { get; set; }

Property Value

string

SearchPattern

The strategy you want to use for matching

[JsonProperty("search_pattern")]
public SearchPattern? SearchPattern { get; set; }

Property Value

SearchPattern?

Size

Page size

[JsonProperty("size", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
public int? Size { get; set; }

Property Value

int?

Type

Set this parameter to filter the type of number, such as mobile or landline Must be one of: landline, mobile-lvn or landline-toll-free

[JsonProperty("type")]
public string Type { get; set; }

Property Value

string