Interface IBuilderForOptional
- Namespace
- Vonage.Reports.CreateReport
- Assembly
- Vonage.dll
public interface IBuilderForOptional : IVonageRequestBuilder<CreateReportRequest>- 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("dfc0c915-1")WithCallbackUrl(Uri)
Sets the webhook URL that receives a notification when the report is ready.
IBuilderForOptional WithCallbackUrl(Uri value)Parameters
valueUri
Returns
Examples
.WithCallbackUrl(new Uri("https://example.com/webhook"))WithChannel(RecordChannel)
Sets the verification channel filter. Optional for VERIFY-V2.
IBuilderForOptional WithChannel(RecordChannel value)Parameters
valueRecordChannel
Returns
Examples
.WithChannel(RecordChannel.SilentAuth)WithClientRef(string)
Sets the optional custom reference value filter. Optional for SMS.
IBuilderForOptional WithClientRef(string value)Parameters
valuestring
Returns
Examples
.WithClientRef("my-personal-reference")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.
IBuilderForOptional WithCountry(string value)Parameters
valuestring
Returns
Examples
.WithCountry("PL")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-02T13:50: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.
IBuilderForOptional WithFrom(string value)Parameters
valuestring
Returns
Examples
.WithFrom("447700900001")WithIncludeMessage(bool)
Includes the message content in the report. Optional for SMS and MESSAGES.
IBuilderForOptional WithIncludeMessage(bool value)Parameters
valuebool
Returns
Examples
.WithIncludeMessage(true)WithIncludeSubaccounts(bool)
Includes data from sub-accounts in the report.
IBuilderForOptional WithIncludeSubaccounts(bool value)Parameters
valuebool
Returns
Examples
.WithIncludeSubaccounts(true)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.
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.
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.
IBuilderForOptional WithTo(string value)Parameters
valuestring
Returns
Examples
.WithTo("447700900000")