AT&T API Platform SDK for Microsoft®  2.3.2
Wrapper classes that allow developers to build robust applications using .NET
 All Classes Namespaces Functions Enumerations Properties
SMS Methods

Classes

class  ATT_MSSDK.RequestFactory
 The RequestFactory manages the connections and calls to the AT&T API Platform. More...

Functions

SmsResponse ATT_MSSDK.RequestFactory.SendSms (string address, string message, bool?notifyDeliveryStatus=null)
 This method sends an SMS message to one Mobile Network device.
SmsResponse ATT_MSSDK.RequestFactory.SendSms (List< string > addresses, string message, bool?notifyDeliveryStatus=null)
 Send an SMS message to the specified addresses.
SmsDeliveryResponse ATT_MSSDK.RequestFactory.GetSmsDeliveryResponse (string deliveryId)
 This method gets the status of a previous SMS delivery request that was successfully accepted by the AT&T Network for delivery to the destination mobile device. The identifier returned in the response of the corresponding SendSMS operation must be provided in the GetSmsDeliveryStatus operation request.
InboundSmsMessageList ATT_MSSDK.RequestFactory.ReceiveSms (string shortCode)
 This method retrieves all SMS messages received on its short code resource via polling mechanism.
static ReceivedSMS ATT_MSSDK.RequestFactory.GetSMS (System.IO.Stream inputStream)
 Parses given stream and returns ATT_MSSDK.SMSv3.ReceivedSMS object.
static SmsDeliveryStatus ATT_MSSDK.RequestFactory.GetSMSDeliveryStatus (System.IO.Stream inputStream)
 Parses given stream and returns ATT_MSSDK.SMSv3.SmsDeliveryStatus object.

Function Documentation

static ReceivedSMS ATT_MSSDK.RequestFactory.GetSMS ( System.IO.Stream  inputStream) [static]

Parses given stream and returns ATT_MSSDK.SMSv3.ReceivedSMS object.

Parameters:
inputStreaminput stream
Returns:
The ATT_MSSDK.SMSv3.ReceivedSMS object.
Exceptions:
System.ArgumentNullExceptionThrown when inputStream is null
InvalidResponseExceptionThrown when unable to parse given stream
SmsDeliveryResponse ATT_MSSDK.RequestFactory.GetSmsDeliveryResponse ( string  deliveryId)

This method gets the status of a previous SMS delivery request that was successfully accepted by the AT&T Network for delivery to the destination mobile device. The identifier returned in the response of the corresponding SendSMS operation must be provided in the GetSmsDeliveryStatus operation request.

Parameters:
deliveryIdA value returned from a previous SendSms call.
Returns:
The ATT_MSSDK.SMSv3.SmsDeliveryResponse returned by the server.
Exceptions:
ArgumentExceptionThrown if an argument is invalid.
InvalidScopeExceptionThrown if the Request Factory scope does not include SMS.
InvalidResponseExceptionThrown if the server returns an error or there is a connection failure.
static SmsDeliveryStatus ATT_MSSDK.RequestFactory.GetSMSDeliveryStatus ( System.IO.Stream  inputStream) [static]

Parses given stream and returns ATT_MSSDK.SMSv3.SmsDeliveryStatus object.

Parameters:
inputStreaminput stream
Returns:
The ATT_MSSDK.SMSv3.SmsDeliveryStatus object.
Exceptions:
System.ArgumentNullExceptionThrown when inputStream is null
InvalidResponseExceptionThrown when unable to parse given stream
InboundSmsMessageList ATT_MSSDK.RequestFactory.ReceiveSms ( string  shortCode)

This method retrieves all SMS messages received on its short code resource via polling mechanism.

Parameters:
shortCodeThe Short Code to check for.
Returns:
The ATT_MSSDK.SMSv3.InboundSmsMessageList object.
Exceptions:
ArgumentExceptionThrown if an argument is invalid.
InvalidScopeExceptionThrown if the Request Factory scope does not include SMS.
InvalidResponseExceptionThrown if the server returns an error or there is a connection failure.
SmsResponse ATT_MSSDK.RequestFactory.SendSms ( string  address,
string  message,
bool?  notifyDeliveryStatus = null 
)

This method sends an SMS message to one Mobile Network device.

Parameters:
addressAddress, which is mobile destination number of the message.
messageThe message text to send.
notifyDeliveryStatusIt is a Boolean flag that could contain either “True” or “False” (case insensitive) to denote the gateway whether delivery status notification is expected by the application or not.
Returns:
ATT_MSSDK.SMSv3.SmsResponse An SmsResponse object containing the results.
Exceptions:
ArgumentExceptionThrown if an argument is invalid.
InvalidScopeExceptionThrown if the Request Factory scope does not include SMS.
InvalidResponseExceptionThrown if the server returns an error or there is a connection failure.
SmsResponse ATT_MSSDK.RequestFactory.SendSms ( List< string >  addresses,
string  message,
bool?  notifyDeliveryStatus = null 
)

Send an SMS message to the specified addresses.

Parameters:
addressesA list of addresses, mobile destination numbers of the message.
messageThe message to send.
notifyDeliveryStatusIt is a Boolean flag that could contain either “True” or “False” (case insensitive) to denote the gateway whether delivery status notification is expected by the application or not.
Returns:
ATT_MSSDK.SMSv3.SmsResponse An SmsResponse object containing the results.
Exceptions:
ArgumentExceptionThrown if an argument is invalid.
InvalidScopeExceptionThrown if the Request Factory scope does not include SMS.
InvalidResponseExceptionThrown if the server returns an error or there is a connection failure.