This web service exposes REST calls to send text messages directly from our gateway
This method allows you to view the list of sent messages from your account
Array of objects (Messages) [ items ] | |
success | boolean |
message | string |
credit | string |
error | integer |
CURL *hnd = curl_easy_init(); curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.messaggisms.com/messages/"); struct curl_slist *headers = NULL; headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN"); curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); CURLcode ret = curl_easy_perform(hnd);
{- "data": [
- {
- "sender": "alberto",
- "timestamp": "1564411330117",
- "id": "5d3f05c29f2725610c2b4e60"
}, - {
- "sender": "3939989741",
- "timestamp": "1563554978976",
- "id": "5d31f4a29f27257de166d960"
}, - {
- "sender": "3939989741",
- "timestamp": "1562686328690",
- "id": "5d24b3789f27257de1645bda"
}, - {
- "sender": "Nome del mittente",
- "timestamp": "1562142688118",
- "id": "5d1c67e09f27255e2f4079a3"
}, - {
- "sender": "Nome del mittente",
- "timestamp": "1562142398400",
- "id": "5d1c66be9f272563102e8045"
}
], - "success": true,
- "message": "5 Results",
- "credit": "91.00299999999986",
- "error": null
}
This method allows you to send an sms message directly from our gateway
test | boolean Default: "<boolean>" By default it is false, if set to true it simulates a send |
sender required | string Default: "<string>" The sender must be between 3 and 11 characters if alphanumeric and between 3 and 14 if numeric |
body required | string Default: "<string>" Text of the sms; we can insert in the text the values of the 'placeholder' parameters contained in 'fields' in this way: “body”: “Test invio {{name}}” |
required | string or Array of strings or object Phone number of the recipient and wanting the 'fields' object in which to insert the parameters that we want to enter in the 'body' like this: {'number':'+39-34xxxxx987', 'fields':{'name':'simone', 'surname':'rossi'}}. Mandatory is the international prefix which must be separated from the rest by '-' like this: '+39-number'. Any other format will be considered bad recipients and placed among the invalid |
priority | number <double> Default: "<double>" Sending priority; default is 1.00 which is the minimum; increasing the priority increases the total cost of the message but assuming that in the queue there are 1000 messages with priority 1.00, by sending a message with priority 1.01 you skip the queue |
object (Options) | |
transaction | boolean Default: "<boolean>" By default, FALSE is set. Set to TRUE, it starts a transaction by storing the data sent but not putting the request in the queue. Subsequent PUT calls can be made on the end point '/messages/{id}/' to integrate the initial POST call (for example adding recipients) until a PUT is sent with 'transaction' : FALSE. The ID field is returned from the first POST call. At that point the transaction (if valid) is closed and the message queues normally |
Array of objects (Message_Object) [ items ] | |
success | boolean |
message | string |
credit | string |
error | integer |
{- "test": false,
- "sender": "alberto",
- "body": "test invio",
- "recipients": "+39-349xxxxx18"
}
{- "data": [
- {
- "test": false,
- "sender": "alberto",
- "body": "test invio",
- "recipients": {
- "valid": {
- "count": 1
}, - "invalid": {
- "total": 0,
- "list": [ ]
}
}, - "transaction": false,
- "options": {
- "bulk": false,
- "flash": false,
- "realtime": false,
- "timestamp_send": "1564752494920"
}, - "statistics": {
- "error": 0,
- "sent": 0,
- "delivered": 0,
- "total": 1,
- "sms_total": 1
}, - "base_price": 0.0315,
- "timestamp": "1564752494920",
- "last_update": "1564752494920",
- "priority": 1,
- "price": 0.0315,
- "state": 0,
- "id": "5d443a6e9f2725660f3db347"
}
], - "message": "Message Queued",
- "credit": "90.90849999999988",
- "success": true,
- "error": null
}
This method allows you to see the single message related to the parameter passed in the path
id required | string Default: "<string>" Example: 5cf7cc139f272546624d3795 Message Id |
Array of objects (Message_Object) [ items ] | |
success | boolean |
message | string |
credit | string |
error | integer |
CURL *hnd = curl_easy_init(); curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET"); curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.messaggisms.com/messages/%7Bid%7D"); struct curl_slist *headers = NULL; headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN"); curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); CURLcode ret = curl_easy_perform(hnd);
{- "data": [
- {
- "test": false,
- "sender": "Simone",
- "body": "Production test 4 ",
- "recipients": {
- "valid": {
- "count": 1
}, - "invalid": {
- "total": 0,
- "list": [ ]
}
}, - "priority": 1,
- "options": {
- "flash": true,
- "realtime": true,
- "timestamp_send": "326152800000",
- "custom": {
- "test": 123,
- "best": 321,
- "trest": [
- 12,
- 3,
- 12,
- 3
]
},
}, - "transaction": false,
- "statistics": {
- "error": 0,
- "sent": 1,
- "delivered": 1,
- "total": 1,
- "sms_total": 1
}, - "base_price": 0.03,
- "timestamp": "1559743507600",
- "last_update": "1559743510156",
- "price": 0.036,
- "state": 2,
- "id": "5cf7cc139f272546624d3795"
}
], - "message": "1 Result",
- "credit": "90.97149999999986",
- "success": true,
- "error": null
}
If a message exists with 'transaction = true', this method allows integrating the initial POST call (adding recipients for example) until a PUT with 'transaction = false' is passed. At that point the message is closed and put in the sending queue. With this method you can also change the sending date of the message ('timestamp_send') (if it hasn't already been sent or scheduled for sending).
required | string or Array of strings or object Phone number of the recipient and wanting the 'fields' object in which to insert the parameters that we want to enter in the 'body' like this: {'number':'+39-34xxxxx987', 'fields':{'name':'simone', 'surname':'rossi'}}. Mandatory is the international prefix which must be separated from the rest by '-' like this: '+39-number'. Any other format will be considered bad recipients and placed among the invalid |
transaction | boolean Default: "<boolean>" Until it is set to false the transaction is not closed and the message will not go into the sending queue |
object |
object (Message_Object) | |
success | boolean |
message | string |
credit | string |
error | integer |
{- "recipients": [
- "+39-3xxxxxx115"
], - "options": {
- "timestamp_send": "2023-12-25"
}
}
{- "data": {
- "test": false,
- "sender": "alberto",
- "body": "test invio",
- "recipients": {
- "valid": {