Struct VoiceWorkflow

Represents a verification workflow that delivers the PIN code via text-to-speech voice call.

public readonly struct VoiceWorkflow : IVerificationWorkflow

Inherited Members: ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

The verification channel identifier (e.g., "sms", "voice", "email", "whatsapp", "whatsapp_interactive", "silent_auth").

[JsonPropertyOrder(0)]
public string Channel { get; }

The recipient phone number in E.164 format without leading + or 00 (e.g., "447700900000").

[JsonPropertyOrder(1)]
[JsonConverter(typeof(PhoneNumberJsonConverter))]
public PhoneNumber To { get; }

Creates a new Voice verification workflow.

public static Result<VoiceWorkflow> Parse(string to)

to string: The recipient phone number in E.164 format without leading + or 00 (e.g., "447700900000").

Result<VoiceWorkflow>: A Result<T> containing the workflow if successful, or validation errors if the phone number is invalid.

var workflow = VoiceWorkflow.Parse("447700900000");

Serializes the workflow configuration to JSON format for the API request.

public string Serialize(IJsonSerializer serializer)