Class CallSearchFilter

Namespace

Vonage.Voice

Assembly

Vonage.dll

Represents filter criteria for searching call records via the Get Calls API.

public class CallSearchFilter

Inheritance

object

CallSearchFilter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ConversationUuid

Filter to return only records associated with a specific conversation UUID.

[JsonProperty("conversation_uuid")]
public string ConversationUuid { get; set; }

Property Value

string

DateEnd

Return records that occurred before this point in time. Must be in UTC (not converted).

[JsonProperty("date_end")]
[JsonConverter(typeof(PageListDateTimeConverter))]
public DateTime? DateEnd { get; set; }

Property Value

DateTime?

DateStart

Return records that occurred after this point in time. Must be in UTC (not converted).

[JsonProperty("date_start")]
[JsonConverter(typeof(PageListDateTimeConverter))]
public DateTime? DateStart { get; set; }

Property Value

DateTime?

Order

The sort order for results: "asc" (ascending, default) or "desc" (descending).

[JsonProperty("order")]
public string Order { get; set; }

Property Value

string

PageSize

The number of records to return per page. Range: 1-100. Default is 10.

[JsonProperty("page_size")]
public int? PageSize { get; set; }

Property Value

int?

RecordIndex

The starting index for pagination. For example, set to 5 with a page size of 10 to return records 50-59. Default is 0.

[JsonProperty("record_index")]
public int? RecordIndex { get; set; }

Property Value

int?

Status

Filter by call status. Possible values: "started", "ringing", "answered", "machine", "completed", "busy", "cancelled", "failed", "rejected", "timeout", "unanswered".

[JsonProperty("status")]
public string Status { get; set; }

Property Value

string