![]() |
AT&T API Platform SDK for Microsoft®
2.3.3
Wrapper classes that allow developers to build robust applications using .NET
|
Classes | |
class | ATT_MSSDK.RequestFactory |
The RequestFactory manages the connections and calls to the AT&T API Platform. More... | |
Functions | |
GetMessageHeadersResponse | ATT_MSSDK.RequestFactory.GetMessageHeaders (int headerCount, string indexCursor=null) |
This method gets meta-data for one or more Subscriber Messages from the AT&T Messages environment. | |
GetMessageContentResponse | ATT_MSSDK.RequestFactory.GetMessage (string messageId, string partNumber) |
This method gets one or more subscriber messages from the AT&T Messages environment. | |
SendMessageResponse | ATT_MSSDK.RequestFactory.SendMessage (string address, string text, string subject=null, bool group=false, int maxAddressCount=10) |
Send a message to the specified address. | |
SendMessageResponse | ATT_MSSDK.RequestFactory.SendMessage (List< string > addresses, string text, string subject=null, bool group=false, int maxAddressCount=10) |
Send a message to the specified address list. | |
SendMessageResponse | ATT_MSSDK.RequestFactory.SendMessage (string address, List< string > attachments, string text, string subject=null, bool group=false, int maxAddressCount=10) |
Send a message to the specified address. | |
SendMessageResponse | ATT_MSSDK.RequestFactory.SendMessage (List< string > addresses, List< string > attachments, string text, string subject=null, bool group=false, int maxAddressCount=10) |
Send a message to the specified address list. |
GetMessageContentResponse ATT_MSSDK.RequestFactory.GetMessage | ( | string | messageId, |
string | partNumber | ||
) |
This method gets one or more subscriber messages from the AT&T Messages environment.
messageId | A MessageId representing a Subscriber Message in the AT&T Messages environment. |
partNumber | A content identifier representing an attachment in the referenced Subscriber Message. |
GetMessageHeadersResponse ATT_MSSDK.RequestFactory.GetMessageHeaders | ( | int | headerCount, |
string | indexCursor = null |
||
) |
This method gets meta-data for one or more Subscriber Messages from the AT&T Messages environment.
headerCount | The number of Headers to be returned: Valid Range: Min = 1, Max = 500 HeaderCount will be relative to the most recent Subscriber message. |
indexCursor | An index value, for which HeaderCount will start. |
SendMessageResponse ATT_MSSDK.RequestFactory.SendMessage | ( | string | address, |
string | text, | ||
string | subject = null , |
||
bool | group = false , |
||
int | maxAddressCount = 10 |
||
) |
Send a message to the specified address.
address | Address to send message. |
text | The text to send. |
subject | The subject to send |
group | Flag to send as broadcast or group |
maxAddressCount | Maximum number of addresses. Its default to 10, but, if APIPlatform changes the value, use the new value as argument |
ArgumentException | Thrown if an argument is invalid. |
InvalidScopeException | Thrown if the Request Factory scope does not include SMS. |
InvalidResponseException | Thrown if the server returns an error or there is a connection failure. |
SendMessageResponse ATT_MSSDK.RequestFactory.SendMessage | ( | List< string > | addresses, |
string | text, | ||
string | subject = null , |
||
bool | group = false , |
||
int | maxAddressCount = 10 |
||
) |
Send a message to the specified address list.
addresses | Address List |
text | The text to send. |
subject | The subject to send |
group | Flag to send as broadcast or group |
maxAddressCount | Maximum number of addresses. Its default to 10, but, if APIPlatform changes the value, use the new value as argument |
ArgumentException | Thrown if an argument is invalid. |
InvalidScopeException | Thrown if the Request Factory scope does not include SMS. |
InvalidResponseException | Thrown if the server returns an error or there is a connection failure. |
SendMessageResponse ATT_MSSDK.RequestFactory.SendMessage | ( | string | address, |
List< string > | attachments, | ||
string | text, | ||
string | subject = null , |
||
bool | group = false , |
||
int | maxAddressCount = 10 |
||
) |
Send a message to the specified address.
address | Address to send message |
attachments | List of attachments |
text | The text to send. |
subject | The subject to send |
group | Flag to send as broadcast or group |
maxAddressCount | Maximum number of addresses. Its default to 10, but, if APIPlatform changes the value, use the new value as argument |
ArgumentException | Thrown if an argument is invalid. |
InvalidScopeException | Thrown if the Request Factory scope does not include SMS. |
InvalidResponseException | Thrown if the server returns an error or there is a connection failure. |
SendMessageResponse ATT_MSSDK.RequestFactory.SendMessage | ( | List< string > | addresses, |
List< string > | attachments, | ||
string | text, | ||
string | subject = null , |
||
bool | group = false , |
||
int | maxAddressCount = 10 |
||
) |
Send a message to the specified address list.
addresses | Address List |
attachments | List of attachments |
text | The text to send. |
subject | The subject to send |
group | Flag to send as broadcast or group |
maxAddressCount | Maximum number of addresses. Its default to 10, but, if APIPlatform changes the value, use the new value as argument |
ArgumentException | Thrown if an argument is invalid. |
InvalidScopeException | Thrown if the Request Factory scope does not include SMS. |
InvalidResponseException | Thrown if the server returns an error or there is a connection failure. |