Page Comparison

...

POST https://sendsms.mailup.com/api/v2.0/lists/1/listsecret HTTP/1.1
User-Agent: Fiddler
Authorization: Basic bTU5NDg0Ok1KOEYzUVVV
Host: sendsms.mailup.com
Content-Length: 55
Content-Type: application/json;odata=verbose;charset=utf-8

{
"ListGUID":"aafa5375-bcf1-4e06-965a-e3a98b626156"
}

Getting started

The MailUp transactional API for text messages (SMS) is the best choice when you have to send single messages, regardless the number of messages you need to send. The main features of this API are the following:

• sending is immediate
• authentication is very simple
• it works on http post, then you can use the "send" command as a callback function into a system that supports webhooks

POST https://sendsms.mailup.com/api/v2.0/sms/{account_ID}/{List_ID} HTTP/1.1
User-Agent: Fiddler
Host: sendsms.mailup.com
Content-Type: application/json;odata=verbose;charset=utf-8
Content-Length: 428
{
"Content":"Hi [Name], welcome to [City]",
"ListGuid":"xxxxxxxx-aaa-bbbb-cccc-e3a98b626156",
"ListSecret":"yyyyyyyy-ddd-eeee-ffff-3e1cb0e6e64c",
"Recipient":"+393350000001",
"CampaignCode":"Welcome messages",
"DynamicFields":[{"N":"Name","V":"John"},{"N":"City","V":"Cremona"}],
"isUnicode":0
}

Getting started

Security is managed by means of "ListSecret" field, which is list specific and it can be enabled/disabled using APIs

You can perform GET, POST, DELETE on /lists/{List_ID}/listsecret resource, Basic Authentication is required.

You can use GET method to check if a ListSecret is already configured (if not, you should use POST method)

-- Request
GET https://sendsms.mailup.com/api/v2.0/lists/1/listsecret HTTP/1.1
User-Agent: Fiddler
Authorization: Basic aBcDeFgHiLmNoPqRsTuVz
Host: sendsms.mailup.com
Content-Length: 0
 
-- Response 1 (when ListSecret does not exist)
HTTP/1.1 200 OK
Content-Length: 71
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Date: Wed, 09 Mar 2016 16:39:24 GMT
{"Data":{"ListSecret":null},"Code":"0","Description":"","State":"DONE"}
 
-- Response 2 (when ListSecret exists)
HTTP/1.1 200 OK
Content-Length: 105
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Date: Wed, 09 Mar 2016 16:45:39 GMT
{"Data":{"ListSecret":""yyyyyyyy-ddd-eeee-ffff-3e1cb0e6e64c"},"Code":"0","Description":"","State":"DONE"}

As soon as you get the value of ListSecret you can start sending text messages (refer to next paragraph).

POST https://sendsms.mailup.com/api/v2.0/lists/{List_ID}/listsecret HTTP/1.1
User-Agent: Fiddler
Authorization: Basic aBcDeFgHiLmNoPqRsTuVz
Host: sendsms.mailup.com
Content-Length: 55
Content-Type: application/json;odata=verbose;charset=utf-8
{
"ListGUID":"xxxxxxxx-aaa-bbbb-cccc-e3a98b626156"
}

If you want to disable transactional APIs, you can use DELETE method, which can also be used, when followed by a POST method, to change the ListSecret value 

DELETE https://sendsms.mailup.com/api/v2.0/lists/1/listsecret?listGUID=xxxxxxxx-aaa-bbbb-cccc-e3a98b626156 HTTP/1.1
User-Agent: Fiddler
Authorization: Basic aBcDeFgHiLmNoPqRsTuVz
Host: sendsms.mailup.com
Content-Length: 0

You can send transactional emails with MailUp in two ways:

• With our SMTP relay
• Using our APIs

They provide virtually the same features. Specifically, the new transactional email API discussed in this section provides the same features that are available with the newest version of our SMTP relay, SMTP+ v2.

In addition, the performance, the aggregation policies and the usage restrictions (i.e. do not use it for promotional emails) are exactly the same as the ones enforced for SMTP+ v2.

Message header vs. JSON object

Although the features are largely the same, the way you access them is different. Parameters that are specified with message headers in SMTP+ v2, in the API are handled as fields of a JSON object that is passed to the web services. For more details about these parameters please check out the examples that are provided for SMTP+ v2

Best Practices

• Message aggregation: avoid using message aggregation types that create several dozens of messages per day in your admin console. 
• CampaignCode: the new CampaignCode field is a great way to aggregate messages in a way that reduces the message count and - at the same time - provides more meaningful statistics. If you don't specify the CampaignCode value, the default value for the SMTP+ user applies (this value is set in the admin console).
• Returned value. Always check the value returned by the API: since most of the returned errors code are due to bad input parameters, any retry attempt will fail when returned code is HTTP 403.

Sending limitations

Please note that free trial accounts are limited to 25 messages sent per month. Once you become a paying customer, your sending speed and volume will be limited by the message frequency that you purchase (e.g. 5,000 messages per hour). See MailUp pricing for more.

Warnings

• Password. If you change the password of your SMTP+ account, then any application based on it, API included, will stop working. 
• Priority. Do not rely too much on the "Priority" field: many restrictions apply on it because its value is properly handled only at a specific stage of message workflow. There is no way to guarantee that the order based on priority value is kept at all delivery stages.
• No API error vs. successful message delivery. Please be aware that - just like with SMTP+ - all methods used to send emails are asynchronous, hence a successful return code means that the request was correct and it has been added to a queue, but it does not guarantee message delivery. In other words, a successful return code indicates that queueing and processing was OK, but the specified recipient might still be unreachable or unsubscribed.

Authentication

Create a SMTP+ user

To access resources and to use the methods, you must have an active account with an enabled SMTP+ user (SMTP+ users have the "sNNNNN_NN" format).

Include credentials in the request

Usename and password must be included in each request through "User" parameter .

"User":{"Username":"YourSmtpPlusUsername","Secret":"YourSmtpPlusPassword"}

An error may be returned when the SMTP+ user is blocked. In this case you could use the "ListUserInfo" method to get more details about that user.

For example, there could be a billing issue.

Resources

Messages

This section includes the methods that can be used to send transactional emails.

Use SendMessage when you need to specify a completely different content for each message, while you can use SendTemplate - and use merge tags - if you want to pick the body of an existing content and simply customize some of its parts.

The two methods provide the same level of performance: pick the one that better fits your needs. 

SendMessage

...

This method allows sending of a transactional message to multiple recipients. This method is not intended for bulk mailings.

The message content is passed as input with HTML code or plain text. The message may also include attachments and embedded images.

...

The method takes as input the document JSON or XML that has the structure MessageDTO defined in the tables below.

...

...

How to send an SMS

Once you have ListSecret, you can start sending text messages and authentication is no more required. The example below sends an SMS to number +393350000001

POST https://sendsms.mailup.com/api/v2.0/sms/{account_ID}/{List_ID} HTTP/1.1
User-Agent: Fiddler
Host: sendsms.mailup.com
Content-Type: application/json;odata=verbose;charset=utf-8
Content-Length: 428
{
"Content":"Hi [Name], welcome to [City]",
"ListGuid":"xxxxxxxx-aaa-bbbb-cccc-e3a98b626156",
"ListSecret":"yyyyyyyy-ddd-eeee-ffff-3e1cb0e6e64c",
"Recipient":"+393350000001",
"CampaignCode":"Welcome messages",
"DynamicFields":[{"N":"

...

Name","V":"

...

John"},{"N":"

...

City","V":"

...

Cremona"}]

...

,

...

{

"Status":"done",
 "Code":"0",
 "Message":"Ok"
}

...

{

"Status":"error",
 "Code":"102",
 "Message":"The operation is not authorized."
}

SendTemplate

...

This method allows sending of a transactional message to multiple recipients. This method is not intended for bulk mailings.

The message content (both HTML body and plain text) is obtained by specifying the unique ID of a message previously created and stored in the MailUp admin console.

The message may also include attachments and embedded images.

...

"isUnicode":0
}

...

...

...

...

{
 "Status":"done",
 "Code":"0",
 "Message":"Ok",
 "UserList":
 [
 {
 "Username":"sMMMM_MM",
 "IdConsole":123,
 "IdList":1,
 "IsEnabled":true,
 "Priority":3,
 "Note":"",
 "CreationDate":"2015-03-31T12:12:04",
 "UpdateDate":"2015-03-31T12:12:34",
 "DomainList":"",
 "SenderList":"",
 "BlockUntil":"0001-01-01T00:00:00",
 "AdminBlock":false
 }
 ]
}

...

{

"Status":"error",
 "Code":"112",
 "Message":"User is deleted."
}

Error codes

...

...

the sender's name and email address

...

 See the SendMessage reference for the definition of the others DTOs (EmailAddressDTO, NameValueDTO, ...)

...

...

{

"TemplateId":694,
 "Subject":"Test message from template",
 "From":{"Name":"Test User","Email":"test@example.com"},

 "To":[{"Name":"Max","Email":"info@example.com"}],
 "Cc":[],
 "Bcc":[],
 "ReplyTo":null,
 "CharSet":"utf-8",
 "ExtendedHeaders":null,
 "Attachments":null,
 "EmbeddedImages":null,
 "XSmtpAPI":null,
 "User":{"Username":"sNNNNN_NN","Secret":"..."}
}

...

{

"Status":"done",
 "Code":"0",
 "Message":"Ok"
}

...

{

"Status":"error",
 "Code":"111",
 "Message":"The template is not found."
}

Users

Use ListUserInfo to retrieve status details about current SMTP+ user or other SMTP+ users that belong to the same List of a specified MailUp account.

ListUserInfo

...

...

{"User":{"Username":"sNNNN_NN","Secret":"..."},"Username":"sMMMM_MM"}

...

...

...

...

...

...

...

...

...