Class AlertRequest

Represents a request to send an event-based alert message via a pre-approved short code.

public class AlertRequest

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Gets or sets the client reference. This user-defined value is included in delivery receipts for tracking purposes; limited to 40 characters.

[JsonProperty("client-ref")]
public string ClientRef { get; set; }

Gets or sets custom key-value pairs to substitute into the template placeholders.

[JsonProperty("custom")]
public object Custom { get; set; }

Gets or sets whether to request a delivery receipt. Set to "1" to receive delivery status callbacks.

[JsonProperty("status-report-req")]
public string StatusReportReq { get; set; }

Gets or sets the pre-approved message template with optional placeholders (e.g., "Your code is {pin}").

[JsonProperty("template")]
public string Template { get; set; }

Gets or sets the recipient phone number in E.164 format (e.g., "14155551234").

[JsonProperty("to")]
public string To { get; set; }

Gets or sets the message encoding type. Use "text" for standard GSM characters or "unicode" for non-GSM characters.

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