Send single SMS message

The SendSingleSMSMessage method can be used to send a single SMS message to a contact in your dotMailer account.

Guidance Notes

If you do not have sufficient credit in your dotMailer account then the send will fail.

Parameters

username	string	This is the username from your API key. It is in the format of an email address and will look similar to apiuser‑908709770324@apiconnector.com	required
password	string	This is the password from your API key.	required
telephoneNumber	string	The telephone number to send the SMS to.	required
message	string	The message that you would like to send.	required

Return values

None.

Error responses

ERROR_SMS_INVALIDPHONENUMBER
ERROR_SMS_SENDNOTPERMITTED
ERROR_APIUSAGE_EXCEEDED
ERROR_INVALID_LOGIN
ERROR_PARAMETER_INVALID
ERROR_SYSTEM_SERVICETEMPORARILYUNAVAILABLE
ERROR_UNKNOWN

Request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/SendSingleSMSMessage"

Example of use in C# .NET

/// <summary>
/// This method should be used to send a single SMS message to a contact in your dotMailer account. 
/// </summary>
public void SendSingleSmsMessage()
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
 
    Console.WriteLine("SendSingleSMSMessage");
    Console.WriteLine("--------------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        // send the sms message
        api.SendSingleSMSMessage(username, password, "07976852822","Test from API");
 
        // if we are still here, the method was executed
        Console.WriteLine("SMS sent");
    }
    catch (SoapException ex)  // catch any soap issues/errors from the web service
    {
        Console.WriteLine("Error -> {0}", ex.Message);
    }
 
    Console.WriteLine();   
}

Sample request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/SendSingleSMSMessage"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SendSingleSMSMessage xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <telephoneNumber>string</telephoneNumber>
      <message>string</message>
    </SendSingleSMSMessage>
  </soap:Body>
</soap:Envelope>

Sample response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SendSingleSMSMessageResponse xmlns="http://apiconnector.com" />
  </soap:Body>
</soap:Envelope>

About the API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates

Send single SMS message

The SendSingleSMSMessage method can be used to send a single SMS message to a contact in your dotMailer account.

Guidance Notes

Parameters

Return values

Error responses

Request

Example of use in C# .NET

Sample request

Sample response

Get started with dotMailer: