...
| Expand |
|---|
| title | GET - Read ListSecret |
|---|
|
| Code Block |
|---|
| language | groovy |
|---|
| collapse | true |
|---|
| -- 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"} |
|
| Expand |
|---|
| title | POST - Create ListSecret |
|---|
|
| Code Block |
|---|
| 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"
} |
|
...
| Expand |
|---|
| title | DELETE - Remove ListSecret |
|---|
|
| Code Block |
|---|
| 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 use GET method to check if a ListSecret is already configured (if not, you should use POST method). As soon as you get the value of ListSecret you can start sending text messages (refer to next paragraph) with no restrictions.
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
...
| Expand |
|---|
| title | Click here to learn more about request parameters... |
|---|
|
All fields are mandatory Parameter | Description | Type |
|---|
Account ID | Console ID | Integer | List ID | List identifier | Integer | List GUID | Hash code that identifies the list (must match with List ID) | String | List Secret | Key that must be specified on MailUp console in order to enable this API (it’s an auto-generated GUID) | String | CampaignCode | Used to aggregate statistics. If a message named as specified value does not exists, then a new record is created in “SMS” table, otherwise the existing one is reused. | String | Content | Message text. No parsing nor length check is required. (Messages longer than 459 characters are truncated by sending engine) | String | Recipient | The recipient’s number. Use international prefix (either with 00 or +), otherwise default list prefix will be applied (Ask for MailUp standard regex for phone numbers). Only a single phone is allowed Always check subscription status on specified list (SMS_Optin table) | String | IsUnicode | Boolean value indicating whether to use Western alphabets only (0 means "false"), or Eastern alphabets as well, such as Arabic, Russian, Chinese, and so on (1 means "true").
The client is in charge of deciding if the message contains Unicode | Boolean |
|
...