Interface IBuilderForOptional
- Namespace
- Vonage.Reports.LoadRecords
- Assembly
- Vonage.dll
public interface IBuilderForOptional : IVonageRequestBuilder<LoadRecordsRequest>- Inherited Members
Methods
WithAccountRef(string)
Sets the account reference filter. Optional for SMS.
IBuilderForOptional WithAccountRef(string value)Parameters
valuestring
Returns
Examples
.WithAccountRef("customer1234")WithCallId(string)
Sets the unique call identifier filter. Optional for AMD, ASR, VOICE-CALL, VOICE-FAILED, and WEBSOCKET-CALL.
IBuilderForOptional WithCallId(string value)Parameters
valuestring
Returns
Examples
.WithCallId("dfc0c915f38ae6701d7d114cde2556b1-1")WithChannel(RecordChannel)
Sets the verification channel filter. Optional for VERIFY-V2.
IBuilderForOptional WithChannel(RecordChannel value)Parameters
valueRecordChannel
Returns
Examples
.WithChannel(RecordChannel.SilentAuth)WithConversationId(string)
Sets the conversation ID filter. Optional for CONVERSATION-EVENT, CONVERSATION-MESSAGE, and IN-APP-VOICE.
IBuilderForOptional WithConversationId(string value)Parameters
valuestring
Returns
Examples
.WithConversationId("CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab")WithCorrelationId(string)
Sets the correlation ID filter for Network API events. Optional for NETWORK-API-EVENT.
IBuilderForOptional WithCorrelationId(string value)Parameters
valuestring
Returns
Examples
.WithCorrelationId("aaaaaaaa-bbbb-cccc-dddd-0123456789ab")WithCountry(string)
Sets the ISO two-letter country code filter. Optional for SMS, VOICE-CALL, VOICE-FAILED, ASR, MESSAGES, VERIFY-API, VERIFY-V2, NUMBER-INSIGHT, NUMBER-INSIGHT-V2, and NETWORK-API-EVENT.
IBuilderForOptional WithCountry(string value)Parameters
valuestring
Returns
Examples
.WithCountry("GB")WithCursor(string)
Sets the pagination cursor for retrieving the next page of results (date-based queries only).
IBuilderForOptional WithCursor(string value)Parameters
valuestring
Returns
Examples
.WithCursor("MTY0OTQ3ODAwMDAwMA")WithDateEnd(DateTimeOffset)
Sets the end of the reporting period (exclusive). Defaults to the current time if not provided.
IBuilderForOptional WithDateEnd(DateTimeOffset value)Parameters
valueDateTimeOffset
Returns
Examples
.WithDateEnd(DateTimeOffset.Parse("2024-02-07T14:22:08+00:00"))WithDateStart(DateTimeOffset)
Sets the start of the reporting period (inclusive). Defaults to seven days ago if not provided.
IBuilderForOptional WithDateStart(DateTimeOffset value)Parameters
valueDateTimeOffset
Returns
Examples
.WithDateStart(DateTimeOffset.Parse("2024-02-01T00:00:00+00:00"))WithDirection(RecordDirection)
Sets the direction filter. Required for SMS and MESSAGES; optional for VOICE-CALL, VOICE-FAILED, and ASR.
IBuilderForOptional WithDirection(RecordDirection value)Parameters
valueRecordDirection
Returns
Examples
.WithDirection(RecordDirection.Outbound)WithFrom(string)
Sets the sender ID or number filter. Optional for SMS, MESSAGES, VOICE-CALL, VOICE-FAILED, and ASR.
IBuilderForOptional WithFrom(string value)Parameters
valuestring
Returns
Examples
.WithFrom("447700900001")WithId(string)
Sets the UUID of the message or call to search for. Accepts a comma-separated list of up to 20 UUIDs.
IBuilderForOptional WithId(string value)Parameters
valuestring
Returns
Examples
.WithId("aaaaaaaa-bbbb-cccc-dddd-0123456789ab")WithIncludeMessage(bool)
Includes the message content in the response. Optional for SMS and MESSAGES.
IBuilderForOptional WithIncludeMessage(bool value)Parameters
valuebool
Returns
Examples
.WithIncludeMessage(true)WithIv(string)
Sets the initialization vector for encrypted cursor pagination (date-based queries only).
IBuilderForOptional WithIv(string value)Parameters
valuestring
Returns
Examples
.WithIv("8a2c4e6f-12d3-45b6-78c9-0a1b2c3d4e5f")WithLegId(string)
Sets the unique leg identifier filter. Optional for IN-APP-VOICE.
IBuilderForOptional WithLegId(string value)Parameters
valuestring
Returns
Examples
.WithLegId("aaaaaaaa-bbbb-cccc-dddd-0123456789ab")WithLocale(string)
Sets the language/locale filter. Optional for VERIFY-API and VERIFY-V2.
IBuilderForOptional WithLocale(string value)Parameters
valuestring
Returns
Examples
.WithLocale("en-gb")WithMeetingId(string)
Sets the meeting ID filter. Optional for VIDEO-API.
IBuilderForOptional WithMeetingId(string value)Parameters
valuestring
Returns
Examples
.WithMeetingId("aaaaaaaa-bbbb-cccc-dddd-0123456789ab")WithNetwork(string)
Sets the mobile network code filter. Optional for SMS, VOICE-CALL, VOICE-FAILED, ASR, VERIFY-API, VERIFY-V2, NUMBER-INSIGHT, NUMBER-INSIGHT-V2, and NETWORK-API-EVENT.
IBuilderForOptional WithNetwork(string value)Parameters
valuestring
Returns
Examples
.WithNetwork("12345")WithNumber(string)
Sets the phone number for lookup. Optional for NUMBER-INSIGHT and NUMBER-INSIGHT-V2.
IBuilderForOptional WithNumber(string value)Parameters
valuestring
Returns
Examples
.WithNumber("447700900000")WithNumberType(string)
Sets the number type filter. Optional for VERIFY-API.
IBuilderForOptional WithNumberType(string value)Parameters
valuestring
Returns
Examples
.WithNumberType("mobile")WithParentRequestId(string)
Sets the parent request ID filter. Optional for VERIFY-V2.
IBuilderForOptional WithParentRequestId(string value)Parameters
valuestring
Returns
Examples
.WithParentRequestId("aaaaaaaa-bbbb-cccc-dddd-0123456789ab")WithProductName(string)
Sets the product name filter for Network API events. Optional for NETWORK-API-EVENT.
IBuilderForOptional WithProductName(string value)Parameters
valuestring
Returns
Examples
.WithProductName("simswap")WithProductPath(string)
Sets the API path filter for Network API events. Optional for NETWORK-API-EVENT.
IBuilderForOptional WithProductPath(string value)Parameters
valuestring
Returns
Examples
.WithProductPath("/camara/sim-swap/v040/check")WithProvider(MessagesProvider)
Sets the messaging provider filter. Optional for MESSAGES.
IBuilderForOptional WithProvider(MessagesProvider value)Parameters
valueMessagesProvider
Returns
Examples
.WithProvider(MessagesProvider.WhatsApp)WithRequestSessionId(string)
Sets the request session ID filter for Network API events. Optional for NETWORK-API-EVENT.
IBuilderForOptional WithRequestSessionId(string value)Parameters
valuestring
Returns
Examples
.WithRequestSessionId("aaaaaaaa-bbbb-cccc-dddd-0123456789ab")WithRequestType(string)
Sets the request type filter. Optional for NUMBER-INSIGHT-V2 and NETWORK-API-EVENT.
IBuilderForOptional WithRequestType(string value)Parameters
valuestring
Returns
Examples
.WithRequestType("fraud-score")WithRisk(string)
Sets the risk assessment level filter. Optional for NUMBER-INSIGHT-V2.
IBuilderForOptional WithRisk(string value)Parameters
valuestring
Returns
Examples
.WithRisk("high")WithSessionId(string)
Sets the session ID filter. Optional for VIDEO-API.
IBuilderForOptional WithSessionId(string value)Parameters
valuestring
Returns
Examples
.WithSessionId("aaaaaaaa-bbbb-cccc-dddd-0123456789ab")WithShowConcatenated(bool)
Includes the concatenated field in the report. Optional for SMS with direction outbound.
IBuilderForOptional WithShowConcatenated(bool value)Parameters
valuebool
Returns
Examples
.WithShowConcatenated(false)WithStatus(string)
Sets the status filter. Optional for SMS, CONVERSATION-EVENT, IN-APP-VOICE, MESSAGES, VOICE-CALL, VERIFY-V2, and NUMBER-INSIGHT-V2.
IBuilderForOptional WithStatus(string value)Parameters
valuestring
Returns
Examples
.WithStatus("delivered")WithSwapped(bool)
Filters by whether the number has been ported or swapped. Optional for NUMBER-INSIGHT-V2.
IBuilderForOptional WithSwapped(bool value)Parameters
valuebool
Returns
Examples
.WithSwapped(true)WithTo(string)
Sets the recipient phone number filter. Optional for SMS, VOICE-CALL, VOICE-FAILED, ASR, MESSAGES, VERIFY-API, and VERIFY-V2.
IBuilderForOptional WithTo(string value)Parameters
valuestring
Returns
Examples
.WithTo("447700900000")