Class SendSmsRequest

Namespace

Vonage.Messaging

Assembly

Vonage.dll

Represents a request to send an SMS message via the Vonage SMS API.

public class SendSmsRequest

Inheritance

object

SendSmsRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AccountRef

An optional string used to identify separate accounts using the SMS endpoint for billing purposes. To use this feature, please email support@nexmo.com

[JsonProperty("account-ref", Order = 12)]
public string AccountRef { get; set; }

Property Value

string

Body

Hex encoded binary data. Depends on type parameter having the value binary.

[JsonProperty("body", Order = 8)]
public string Body { get; set; }

Property Value

string

Callback

The webhook endpoint the delivery receipt for this sms is sent to. This parameter overrides the webhook endpoint you set in Dashboard.

[JsonProperty("callback", Order = 5)]
public string Callback { get; set; }

Property Value

string

ClientRef

You can optionally include your own reference of up to 40 characters.

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

Property Value

string

ContentId

A string parameter that satisfies regulatory requirements when sending an SMS to specific countries. For more information please refer to the Country-Specific Outbound SMS Features

[JsonProperty("content-id", Order = 14)]
public string ContentId { get; set; }

Property Value

string

EntityId

A string parameter that satisfies regulatory requirements when sending an SMS to specific countries. For more information please refer to the Country-Specific Outbound SMS Features

[JsonProperty("entity-id", Order = 13)]
public string EntityId { get; set; }

Property Value

string

From

The name or number the message should be sent from. Alphanumeric senderID's are not supported in all countries, see Global Messaging for more details. If alphanumeric, spaces will be ignored. Numbers are specified in E.164 format.

[JsonProperty("from", Order = 0)]
public string From { get; set; }

Property Value

string

MessageClass

The Data Coding Scheme value of the message Must be one of: 0, 1, 2 or 3

[JsonProperty("message-class", Order = 6)]
public int? MessageClass { get; set; }

Property Value

int?

ProtocolId

The value of the protocol identifier to use. Ensure that the value is aligned with udh.

[JsonProperty("protocol-id", Order = 10)]
public int? ProtocolId { get; set; }

Property Value

int?

StatusReportReq

Boolean indicating if you like to receive a Delivery Receipt.

[JsonProperty("status-report-req", Order = 4)]
public bool? StatusReportReq { get; set; }

Property Value

bool?

Text

The body of the message being sent. If your message contains characters that can be encoded according to the GSM Standard and Extended tables then you can set the type to text. If your message contains characters outside this range, then you will need to set the type to unicode.

[JsonProperty("text", Order = 2)]
public string Text { get; set; }

Property Value

string

To

The number that the message should be sent to. Numbers are specified in E.164 format.

[JsonProperty("to", Order = 1)]
public string To { get; set; }

Property Value

string

TrustedNumber

Indicates whether Fraud Defender protection is skipped.

[JsonProperty("trusted-number", Order = 15)]
public bool? TrustedNumber { get; set; }

Property Value

bool?

Ttl

The duration in milliseconds the delivery of an SMS will be attempted. By default Vonage attempt delivery for 72 hours, however the maximum effective value depends on the operator and is typically 24 - 48 hours. We recommend this value should be kept at its default or at least 30 minutes.

[JsonProperty("ttl", Order = 3)]
public int? Ttl { get; set; }

Property Value

int?

Type

The format of the message body

[JsonProperty("type", Order = 7)]
[JsonConverter(typeof(StringEnumConverter))]
public SmsType? Type { get; set; }

Property Value

SmsType?

Udh

Your custom Hex encoded User Data Header. Depends on type parameter having the value binary.

[JsonProperty("udh", Order = 9)]
public string Udh { get; set; }

Property Value

string