![](\"https://smshosting.s3.eu-west-3.amazonaws.com/cover-progetto.jpg\")
\n\nThanks to the REST API you can integrate your software with our gateway in a simple and fast way.
\nThe REST API are based on HTTP methods so for the integration you can use an HTTP Client written in any programming language.
\nThrough the REST API you can perform the following operations:
\nsend single sms and campaigns
\nsend email campaigns
\nsearch and show the details of sent sms
\nsearch and visualize the sms received with the reception service
\ndisplay your Smshosting.it profile data
\nmanage contacts and groups of the address book
\nmanage Fidelity Cards
\nmanage coupons
\nIf you haven't already done so, register to Smshosting.it for free.
\nThe base URL to use to access the REST API is the following
\nhttps://api.smshosting.it/rest/api
or, for resellers
\nhttps://api.smstools.it/rest/api
For security reasons, REST API only allows HTTPS connections (HTTP is not supported).
\nAll requests to the REST API need to be authenticated using the HTTP Basic authentication.
\nThe username and password to be provided are the AUTH_KEY and AUTH_SECRET codes associated to your profile on Smshosting.it. Visit the API security management section in your private area to retrieve them.
\nYou can test your credentials by simply calling from the browser the following URL:
\nhttps://AUTH_KEY:AUTH_SECRET@api.smshosting.it/rest/api/user
or by running from Linux shell the command
\ncurl --user AUTH_KEY:AUTH_SECRET https://api.smshosting.it/rest/api/user
The HTTP error 401 will be received if the authentication fails.
\nAll requests to the REST API must be UTF-8 encoded.
\nHTTP POST and HTTP PUT must have Content-Type in the header set as application/x-www-form-urlencoded unless otherwise indicated.
Smshosting.it REST API can return information in either JSON (default) or XML format.
\nTo get the response in the desired format use the HTTP header \"Accept\" in your request.
\ncurl -H \"Accept: application/json\" --user AUTH_KEY:AUTH_SECRET https://api.smshosting.it/rest/api/user
curl -H \"Accept: application/xml\" --user AUTH_KEY:AUTH_SECRET https://api.smshosting.it/rest/api/user
We want to inform you that, in order to guarantee the highest security standards, we will no longer support TLS 1.0 and TLS 1.1 cryptography protocols since the 31st of March 2023 allowing the access using only TLS 1.2 or higher.
\nFor each request, the REST API returns one of the following HTTP Status Codes:
\n200 - Request completed successfully
204 - Request completed successfully. Deleted Resource.
400 - Missing parameter
401 - Authentication failed
404 - Resource not found
405 - HTTP method not allowed
500 - Unexpected server error
For every HTTP GET and HTTP POST request completed successfully (HTTP status equal to 200) the REST API returns a JSON/XML as content.
\nIn case of a successful HTTP PUT and HTTP DELETE call (HTTP status equal to 200 or 204) the content of the response will be empty.
\nIf a call terminates with an error (HTTP status other than 200 or 204), a JSON/XML explaining the error is returned:
\nerrorCode - HTTP status code
errorMsg - Detailed error code
For example, if the authentication fails the REST API will return a 401 HTTP Status Code and the following JSON as content:
\n{\n \"errorMsg\":\"BAD_CREDENTIALS\",\n \"errorCode\":401\n}\n\nSome resources (sent or received sms search, contact search, etc.) return paginated results.
\nFor example the sent sms search returns the following JSON
\n{\n \"metadata\":{\n \"count\":1,\n \"offset\":0,\n \"limit\":20\n },\n \"smsList\":[\n {\n \"id\":389395385,\n \"to\":\"393480000000\",\n \"text\":\"Test Sms\",\n \"from\":\"mrossi\",\n \"status\":\"DELIVERED\",\n \"insertDate\":\"2014-01-13T15:01:35+0100\",\n \"sentDate\":\"2014-01-13T15:01:37+0100\",\n \"deliveryDate\":\"2014-01-13T15:01:40+0100\",\n \"transactionId\":\"72810108d4114097b9edb42b255b273c\",\n \"price\":0.0945\n }\n ]\n}\n\nThe metadata field contains useful information for managing the pagination of results.
The count property indicates the total number of results found for that search.
The offset and limit fields indicate respectively the index of the first result and the number of results returned by the call.
offset and limit can be used as parameters in the request to control the range of results returned.
For example, if a search finds 100 results and the page size is 20 elements
\n{\n \"metadata\":{\n \"count\":100,\n \"offset\":0,\n \"limit\":20\n },\n .......\n}\n\nit will be possible to get 5 pages using the following values of offset and limit:
page 1 - offset=0&limit=20
page 2 - offset=20&limit=20
page 3 - offset=40&limit=20
page 4 - offset=60&limit=20
page 5 - offset=80&limit=20
It allows you to integrate our services into your Java projects, adding the ability to send SMS, Email, manage customers and much more.
View Sources
Integrate Smshosting functionality into your PHP project.
View Sources
C# library that allows you to integrate Smshosting in your projects: SMS, Email, customers management and much more. You can find it on Github or NuGet
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Make a request","slug":"make-a-request"},{"content":"Deprecation of TLS 1.0 and 1.1","slug":"deprecation-of-tls-10-and-11"},{"content":"Response handling","slug":"response-handling"},{"content":"Libraries","slug":"libraries"}],"owner":"1793341","collectionId":"26c7eb83-3738-43c5-889f-bef45346c9d8","publishedId":"UV5XhcrB","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-10-19T09:42:35.000Z"},"item":[{"name":"Send SMS","item":[{"name":"Send SMS","id":"be77bcba-0752-42a9-b0f3-1d3f89c38f05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"from","value":"www.smshosting.it","description":"[String] (Optional)
\nThe sender of the SMS.
\nIt can be a validated phone number or an alphanumeric string of maximum 11 characters. If not specified, the default sender of your profile will be used.
\nTo use an alphanumeric sender it is mandatory to register it. This procedure can be done from our web panel or via API.
\nUnverified senders will be replaced with a random numeric sender.
\n","type":"text","disabled":true},{"key":"to","value":"393480000000","description":"[String] (Optional. One parameter between to and group must be set)
\nThe recipient of the message.
\nIt must be a cell phone number including country code.\nYou can specify multiple phone numbers (max 10 numbers) by separating them with the comma character \",\".\nIf there are more than 10 recipients, we suggest to use the send bulk request.
\nFor example:
\n393481234567 or 393481234567,393481234568,393481234568
Each object must have the msisdn property valorized.\nThe other properties of these objects can be used to customize the text of the message (see the text field).
\nFor example:
\n[{msisdn:'393481234567'},{msisdn:'393481234568'},{msisdn:'393481234568'}]
\n","type":"text"},{"key":"group","value":"gruppo","description":"[String] (Optional. One parameter between to and group must be set)
\nId of the group in the Address Book to which you want to send the message.
\nIt is possible to specify multiple address book groups by separating them with the comma character \",\".
\nFor example, if in the address book there are the groups Friends (id=1) and School (id=2) it will be possible to indicate:
1 or 1,2
\n","type":"text","disabled":true},{"key":"text","value":"sms di test","description":"[String] (Required)
\nText of the message.\nIf the message exceeds 160 characters, multiple concatenated sms up to a maximum of 7 are sent.
\nSome extended characters occupy 2 characters. If an SMS exceed the standard length of 160 characters because of some extended characters, these will be replaced with simple characters in order to mantain the cost of a single SMS instead of the cost of 2 SMS.
\nThe text can contain placeholders that will be replaced by the values associated with the respective recipient when sending.\nThe placeholder must be specified with the syntax ${property name}.
\nIn case the text contains placeholders the to field must be valorized with a JSON array and each object of the array must contain the property indicated in the placeholder.
\nFor example:\nto=[{msisdn:'393481234567',name:'Mario Rossi'},{msisdn:'393481234568',name:'Luigi Bianchi'}]\ntext=Test SMS to ${name}
\n","type":"text"},{"key":"date","value":"2017-03-24T00:00:00+0100","description":"[String] (Optional)
\nDate (in yyyy-MM-ddTHH:mm:ssZ format) on which the message will be sent. If not specified, the message is sent immediately.\nThe Z character indicates the timezone in RFC 822 4-digit format. (For Italy +0200 during summer time and +0100 during the rest of the year).
\nFor example:\n2014-12-25T08:00:00+0200 indicate the 25/12/2014 at 08:00:00 referring to GMT +2
\n","type":"text","disabled":true},{"key":"transactionId","value":"123456789ABCDE","description":"[String] (Optional)
\nA personal identifier for the sending.
\nAllows you to set an identifier to all SMS, so that you can use it to retrieve the status of all the SMS. Max 60 characters.
\n","type":"text","disabled":true},{"key":"sandbox","value":"true","description":"[String] (Optional)
\nAllows you to make the call without actually sending the message.\nUseful parameter when developing possible integrations with the REST API.
\nPossible values true/false
\n","type":"text"},{"key":"statusCallback","value":"https://tuodominio.com/tuo-percorso-callback","description":"[String] (Optional)
\nURL to which a notification will be sent via HTTP/HTTPS with the status (Delivered, Not Delivered) of the SMS.
\nSee SMS Status Callback management
\n","type":"text"},{"key":"encoding","value":"7BIT","description":"[String] (Optional)
\nThe encoding to be used for the message text.\nPossible values are:
\n7BIT - standard encoding for GSM messages. Maximum length for a single sms is 160 characters.
\nUCS2 - 8-bit encoding for sending GSM messages with non-ASCII content. Maximum length for a single sms is 70 characters.
\nAUTO - The encoding to be used is automatically identified based on the content of the text field.
\nDefault : 7BIT
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/sms/send","description":"Send an sms to one or more individual recipients or to one or more groups in the address book.
\nYou can test the sending by setting the sandbox parameter to true in the request.
The statusCallback parameter allows you to record a URL to which a notification will be sent via HTTP with the status (Delivered, Not Delivered, etc...) of the SMS.
![](\"https://smshosting.s3.eu-west-3.amazonaws.com/warning_en.png\")
\n\n\n\nPay special attention because the id of the SMS could be a 64-bit integer (int64)
\n
Check that your platform can handle it!
\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
[String] (Optional)
\nURL to which a notification with the overall status of the sending will be sent via HTTP
\nFor more details see Send Bulk Callback
\n","type":"text","disabled":true},{"key":"from","value":"www.SmsH.it","description":"See Send SMS
\n","type":"text","disabled":true},{"key":"to","value":"393480000000","description":"See Send SMS
\n","type":"text"},{"key":"group","value":"gruppo","description":"See Send SMS
\n","type":"text","disabled":true},{"key":"text","value":"sms di test","description":"See Send SMS
\n","type":"text"},{"key":"date","value":"2017-03-24T00:00:00+0100","description":"See Send SMS
\n","type":"text","disabled":true},{"key":"transactionId","value":"123456789ABCDE","description":"See Send SMS
\n","type":"text","disabled":true},{"key":"sandbox","value":"true","description":"See Send SMS
\n","type":"text"},{"key":"statusCallback","value":"http://user_callback","description":"See Send SMS
\n","type":"text","disabled":true},{"key":"encoding","value":"7BIT","description":"See Send SMS
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/sms/sendbulk","description":"Asynchronous sms sending mode to be used with a high number of recipients (more than 10 recipients for each request).
\nOnce the request is sent, a transactionId is returned which is useful to identify the sms later on.
\nIn case the sending can't be completed because of an error, and email containing the error code will be sent.
\nNote****__: If you send up to 10 recipients for a single request we suggest to use the Send SMS function.
\n\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
[String] (Required)
\nBinary content of the message expressed as a hexadecimal string.\nEach byte must be represented by a two-character hexadecimal value.
\nFor example:\n0fc24abf3413ba
[String] (Optional)
\nOptional field containing the UDH (User Data Header) of the message in a hexadecimal format.\nFor example:\n00c34abf300311
[Number] (Optional)
\nOptional field containing the protocol ID (Protocol identifier) to use with a decimal format.
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/sms/sendbinary","description":"Send an SMS with binary content.
\nNotes on the message length:
\nThe maximum length of a single binary SMS is 140 bytes (280 characters expressed in hexadecimal format).
\nSpecifying a longer text will send concatenated SMS. The space available for concatenated SMS is 134 bytes for each SMS (268 characters expressed in hexadecimal format).
\n\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
The returned sending data is the same as the request Send SMS.
\n","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}},"urlObject":{"path":["rest","api","sms","sendbinary"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"b874de0c-a07a-41d3-a5ce-48f489a2fec4","name":"Invio SMS Binario","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"text","value":"sms di test","description":"[String] *(Obbligatorio)*\n\nContenuto binario del messaggio espresso come stringa esadecimale.\nOgni byte deve essere rappresentato con un valore esadecimale di due caratteri.\n\nAd esempio:\n`0fc24abf3413ba`","type":"text"},{"key":"udh","value":"","description":"[String] *(Opzionale)*\nCampo facoltativo contenente l'UDH ([User Data Header](https://en.wikipedia.org/wiki/User_Data_Header)) del messaggio in formato esadecimale.\nAd esempio:\n`00c34abf300311`","type":"text","disabled":true},{"key":"transactionCallback","value":"","description":"Vedi [Invio SMS](#descrizione-invio-sms)\n\nURL al quale sarà inviata via HTTP una notifica con lo stato complessivo dell'invio\n[Gestione notificationCallback](#sms-status-callback)","type":"text","disabled":true},{"key":"pid","value":"","description":"[Number] *(Opzionale)*\nCampo facoltativo contenente l'id protocollo ([Protocol identifier](https://en.wikipedia.org/wiki/GSM_03.40#Protocol_Identifier)) da utilizzare in formato decimale.","type":"text","disabled":true},{"key":"from","value":"www.SmsH.it","description":"Vedi [Invio SMS](#descrizione-invio-sms)","type":"text","disabled":true},{"key":"to","value":"393480000000","description":"Vedi [Invio SMS](#descrizione-invio-sms)","type":"text"},{"key":"group","value":"gruppo","description":"Vedi [Invio SMS](#descrizione-invio-sms)","type":"text","disabled":true},{"key":"date","value":"2017-03-24T00:00:00+0100","description":"Vedi [Invio SMS](#descrizione-invio-sms)","type":"text","disabled":true},{"key":"transactionId","value":"123456789ABCDE","description":"Vedi [Invio SMS](#descrizione-invio-sms)","type":"text","disabled":true},{"key":"sandbox","value":"true","description":"Vedi [Invio SMS](#descrizione-invio-sms)","type":"text"},{"key":"statusCallback","value":"http://user_callback","description":"Vedi [Invio SMS](#descrizione-invio-sms)","type":"text","disabled":true},{"key":"encoding","value":"7BIT","description":"Vedi [Invio SMS](#descrizione-invio-sms)","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/sms/sendbulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"from\":\"mrossi\",\n \"text\":\"0fc24abf3413ba\",\n \"transactionId\":\"e51ea840fc7276922ac61b733027301d\"\n}"}],"_postman_id":"9edba09e-b35e-43c8-862d-dd4c0e218e13"},{"name":"Search SMS","id":"e0c57ac8-8dd3-4125-986f-2182101c0054","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/sms/search?id&transactionId=123456789ABCDE&msisdn&fromDate&toDate&status&offset=0&limit=20","description":"Search for sent SMS.
\nValue at least one of the following parameters:
\n[String] (Optional)
\nInternal ID of the sent message.
\nIt is possible to specify more ids by separating them with a comma character \",\". (Maximum 2000 ids)
\nFor example:
\n12312 or 432432,543543,435435
\n","type":"text/plain"},"key":"id","value":null},{"description":{"content":"[String] (Optional)
\ntransactionId assigned to the sending.
\n","type":"text/plain"},"key":"transactionId","value":"123456789ABCDE"},{"description":{"content":"[String] (Optional)
\nNumber to which the SMS was sent
\n","type":"text/plain"},"key":"msisdn","value":null},{"description":{"content":"[String] (Optional)
\nSearch the sms sent since this date (format yyyy-MM-ddTHH:mm:ssZ)
\nThe Z character indicates the timezone in RFC822 4-digit format.\nFor Italy +0200 during summer time and +0100 during the rest of the year_.
\n","type":"text/plain"},"key":"fromDate","value":null},{"description":{"content":"[String] (Optional)
\nSearch the sms sent until this date (format yyyy-MM-ddTHH:mm:ssZ)
\n","type":"text/plain"},"key":"toDate","value":null},{"description":{"content":"[String] (Optional)
\nStatus of the Sms
\n","type":"text/plain"},"key":"status","value":null},{"description":{"content":"[Number] (Optional)
\nPosition of the first result that will be returned.
\nExample:\nIf the search finds 100 sms, the offset field is set to 50 and the limit field to 10 the sms from 51 to 60 will be returned.\nDefault : 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"[Number] (Optional)
\nNumber of retrieved results.\nDefault: 20
\n","type":"text/plain"},"key":"limit","value":"20"}],"variable":[]}},"response":[{"id":"89e730e7-bc26-4217-85d4-7804fc280f35","name":"Cerca SMS","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/sms/search?id&transactionId=123456789ABCDE&msisdn&fromDate&toDate&status&offset=0&limit=20","host":["{{BaseUrl}}"],"path":["rest","api","sms","search"],"query":[{"key":"id","value":null,"description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\nId interno del messaggio inviato.\n\nÈ possibile specificare **più id** separandoli con il carattere virgola \"**,**\".\n\nAd esempio:\n\n**12312** oppure **432432,543543,435435**"},{"key":"transactionId","value":"123456789ABCDE","description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\n**transactionId** assegnato all'invio."},{"key":"msisdn","value":null,"description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\nNumero al quale è stato inviato il messaggio"},{"key":"fromDate","value":null,"description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\nCerca gli sms stati inviati da questa data (formato **yyyy-MM-ddTHH:mm:ssZ**)\n\nIl carattere **Z** indica il timezone nel formato RFC822 4-digit. _Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno_."},{"key":"toDate","value":null,"description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\nCerca gli sms stati inviati fino a questa data (formato **yyyy-MM-ddTHH:mm:ssZ**)"},{"key":"status","value":null,"description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\nStato degli sms [Vedi valori] (#32ddccbd-f896-924a-b9df-7d716a8e4d9d)"},{"key":"offset","value":"0","description":"[Number] *(Opzionale [§note](#note-ricerca-sms))*\n\nPosizione del primo risultato che verrà restituito.\n\nEsempio:\nSe la ricerca trova 100 sms, il campo **offset** viene valorizzato a 50 ed il campo **limit** a 10 verranno restituiti gli sms da 51 a 60.\n**Default : 0**"},{"key":"limit","value":"20","description":"[Number] *(Opzionale [§note](#note-ricerca-sms))*\n\nNumero di risultati che verranno restituiti.\n**Default: 20**"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"limit\": 20\n },\n \"smsList\": [\n {\n \"id\": 389395385,\n \"to\": \"393480000000\",\n \"text\": \"Test Sms\",\n \"from\": \"mrossi\",\n \"status\": \"DELIVERED\",\n \"insertDate\": \"2014-01-13T15:01:35+0100\",\n \"sentDate\": \"2014-01-13T15:01:37+0100\",\n \"deliveryDate\": \"2014-01-13T15:01:40+0100\",\n \"transactionId\": \"72810108d4114097b9edb42b255b273c\",\n \"price\": 0.0945\n }\n ]\n}"}],"_postman_id":"e0c57ac8-8dd3-4125-986f-2182101c0054"},{"name":"Cancel SMS Sending","id":"78f07e00-a9a5-4809-85ea-1268f4bdf3a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"1","description":"[Number] (Optional) -> one parameter between id and transactionId must be set
internal id of the sent message.
You can specify multiple ids by separating them with the comma character \",\".\nFor example:\n12312 or 432432,543543,435435
\n","type":"text","disabled":true},{"key":"transactionId","value":"123456789ABCDE","description":"[String] (Optional) -> one parameter between id and transactionId must be set
transactionId assigned to the sending
Cancel the sending of an SMS not yet sent (delayed sending).
\nThe call returns the list of canceled text messages.
\nFor details of the properties of each sms see the Response Description of the Search Sms function.
\n","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}},"urlObject":{"path":["rest","api","sms","cancel"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"ef5bb976-2368-4868-8bd4-e57db9cd72cb","name":"Annulla Invio SMS","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"1","description":"[Number] *(Opzionale ¹)*\n\nId interno del messaggio inviato.\n\nÈ possibile specificare **più id** separandoli con il carattere virgola \"**,**\".\n\nAd esempio:\n**12312** oppure **432432,543543,435435**","type":"text","disabled":true},{"key":"transactionId","value":"123456789ABCDE","description":"[String] *(Opzionale ¹)*\n\n**transactionId** assegnato all'invio","type":"text"}]},"url":"{{BaseUrl}}/rest/api/sms/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 389451366,\n \"to\": \"393480000000\",\n \"text\": \"Test Sms\",\n \"from\": \"mrossi\",\n \"status\": \"NOSENT\",\n \"insertDate\": \"2014-01-16T13:46:11+0100\",\n \"transactionId\": \"1389876345449\",\n \"price\": 0\n }\n]"}],"_postman_id":"78f07e00-a9a5-4809-85ea-1268f4bdf3a0"},{"name":"SMS Sending Quotation","id":"4f9361c6-224f-4a6c-af9c-5959226127ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"from","value":"www.smshosting.it","description":"[String] Optional
\nSMS sender.
\nIt can be a validated phone number or an alphanumeric string of maximum 11 characters. If not specified, the default sender of your profile is used.
\n","type":"text","disabled":true},{"key":"to","value":"393480000000","description":"[String] Optional (one parameter between to and group must be set)
\nMessage recipient.
\nIt must be a cell phone number including country code.
\nYou can specify multiple phone numbers (max 1000 numbers) by separating them with the comma character \",\".
\nFor example:\n393481234567 or 393481234567,393481234568,393481234568
[String] Optional (one parameter between to and group must be set)
\nId of the group in the phonebook to which the SMS has to be sent. \nYou can specify multiple groups by separating them with the comma character \",\".
\nFor example if in the address book there are the groups Friends (id=1) and School (id=2) it will be possible to indicate\n1 or 1,2
\n","type":"text","disabled":true},{"key":"text","value":"sms di test","type":"text"},{"key":"encoding","value":"7BIT","description":"[String] (Optional)
\nThe encoding to use for the message text.\nPossible values are:
\nDefault : 7BIT
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/sms/estimate","description":"Calculation of the credit needed for an SMS sending (single or multiple sending).
\n\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
With these requests you can send and manage single or bulk SMS messages.
\nThe possible SMS status code (status field) values are:
\n","_postman_id":"cdf843f8-d185-4222-8605-8bdfa72448e2","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}}},{"name":"Send OTP SMS (2FA)","item":[{"name":"Send OTP Code (2FA)","id":"e64a90af-2b73-4d0a-b5e7-9bb8adbe7387","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"to","value":"393480000000","description":"[String] (Required)
\nRecipient of the message.
\nMust be a cell phone number including country code.
\nFor example:\n393481234567
\n","type":"text"},{"key":"text","value":"your code: ${verify_code}","description":"[String] (Required)
\nMessage text.
\nIf the message exceeds 160 characters, more than one text message will be sent in sequence up to a maximum of 7.\nThe text must contain the placeholder that will be replaced by the OTP code during the sending phase.
\nThe placeholder must be specified with the syntax ${verify_code}.
\nFor example:\ntext=Here is your code ${verify_code}
\n","type":"text"},{"key":"from","value":"www.SmsH.it","description":"[String] (Optional)
\nThe sender of the SMS.
\nIt can be a validated phone number or an alphanumeric string of 11 characters. If not specified, the default sender of your profile will be used.
\n","type":"text","disabled":true},{"key":"sandbox","value":"true","description":"[String] (Optional)
\nAllows you to make the call without actually sending the message.
\nUseful parameter when developing possible integrations with the REST API.
\nPossible values are true/false
\n","type":"text"},{"key":"app_id","value":"myappid","description":"[String] (Optional)
\nIdentifies the application for which you are requesting the code.
\nYou can specify your own identifier
\nCaution: You cannot generate 2 active codes at the same time for the same recipient for the same application.
\n","type":"text"},{"key":"encoding","value":"7BIT","description":"[String] (Optional)
\nThe encoding to be used for the message text.
\nPossible values are:
\nDefault : 7BIT
\n","type":"text","disabled":true},{"key":"code_len","value":"5","description":"[String] (Optional)
\nOTP code length
\nPossible values are from 4 to 6.
\nDefault: 4
\n","type":"text","disabled":true},{"key":"max_retry","value":"5","description":"[String] (Optional)
\nMaximum number of attempts allowed.
\nPossible values are from 1 to 20.
\nDefault: 3
\n","type":"text","disabled":true},{"key":"ttl","value":"300","description":"[String] (Optional)
\nValidity in seconds of the code.
\nThe minimum value is 10.
\nDefault: 300
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/verify/send","description":"Send a numeric OTP (One Time Password) code to a recipient. This is suitable for implementing the 2FA (2 Factor Authentication)
\n\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
Validate an OTP code sent by SMS.
\n[String] (Required)
\nThe verify_id code received in the send command response.
\n","type":"text/plain"},"key":"verify_id","value":"334ecb42ebda471a02adfa044b546e94c2059c97"},{"description":{"content":"[String] (Required)
\nOTP code to verify.
\n","type":"text/plain"},"key":"verify_code","value":"1234"},{"disabled":true,"description":{"content":"[String) (Optional)
\nThe retrievable IP address will be saved along with the other data from the code verification by calling Code Search
\n","type":"text/plain"},"key":"ip_address","value":"192.168.0.1"}],"variable":[]}},"response":[{"id":"4f4f1e08-ad03-46a2-9622-fa75f320fda7","name":"Verifica Codice","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/verify/check?verify_id=334ecb42ebda471a02adfa044b546e94c2059c97&verify_code=1234","host":["{{BaseUrl}}"],"path":["rest","api","verify","check"],"query":[{"key":"verify_id","value":"334ecb42ebda471a02adfa044b546e94c2059c97","description":"[String] *(Obbligatorio)*\n\nIl codice **verify_id** ricevuto nella risposta del comando send.\n"},{"key":"verify_code","value":"1234","description":"[String] *(Obbligatorio)*\n\nIl codice OTP da verificare."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id_sms\": \"410065822\",\n \"verify_status\": \"VERIFIED\"\n}"}],"_postman_id":"9ef01035-a50d-4c40-91bf-384cea28c3b5"},{"name":"Cancel Code","id":"54c06fd5-2ef1-4985-9b50-fa8255ef1769","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"verify_id","value":"334ecb42ebda471a02adfa044b546e94c2059c97","description":"[String] (Required)
\nThe verify_id code received in the send command response.
\n","type":"text"},{"key":"command","value":"DELETE","description":"[String] (Required)
\nCan have the value:\nDELETE
Cancels an active and still usable OTP code.
\n\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
Get the details of an OTP code.
\n[String] (Required)
\nThe verify_id code received in the send command response.
\n","type":"text/plain"},"key":"verify_id","value":"334ecb42ebda471a02adfa044b546e94c2059c97"}],"variable":[]}},"response":[{"id":"e353f9ac-98aa-4320-9761-82e8c23faa76","name":"Ricerca Codice","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/verify/search?verify_id=334ecb42ebda471a02adfa044b546e94c2059c97","host":["{{BaseUrl}}"],"path":["rest","api","verify","search"],"query":[{"key":"verify_id","value":"334ecb42ebda471a02adfa044b546e94c2059c97"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"verify_id\": \"334ecb42ebda471a02adfa044b546e94c2059c97\",\n \"verify_status\": \"VERIFIED\",\n \"to\": \"393480000000\",\n \"from\": \"393480000000\",\n \"id_sms\": \"410065825\",\n \"date_submit\": 1480499821000,\n \"valid_until\": 1480500121000,\n \"checks\": [\n {\n \"date\": 1480499858000,\n \"verify_code\": \"4506\",\n \"verify_status\": \"VERIFIED\",\n \"ip_address\": \"192.168.1.1\"\n }\n ]\n}"}],"_postman_id":"3d1a844d-97a3-47e4-b90e-368fedd92017"}],"id":"0e455bb9-968a-4ddc-acae-69050c8259c7","description":"With these requests you will be able to easily send OTP codes without worrying about the sending/validation logic:
\n${verify_code} placeholderThe list of configured aliases returns.
\n[String] (Required)
\nAlias identifier string.
\nThe string cannot exceed 11 characters.
\nIt can only contain uppercase or lowercase letters (a-z), numbers, spaces and the characters. _ - & @ * ''
\n","type":"text"},{"key":"businessname","value":"ACME Company","description":"[String] (Required)
\nCompany name to be associated with the alias
\n","type":"text"},{"key":"address","value":"via Roma, 1","description":"[String] (Required)
\nAddress of the company headquarters to be associated with the alias
\n","type":"text"},{"key":"city","value":"Belluno","description":"[String] (Required)
\nCity of the company headquarters to associate with the alias
\n","type":"text"},{"key":"postcode","value":"32100","description":"[String] (Required)
\nPostal code of the company headquarters to be associated with the alias
\n","type":"text"},{"key":"province","value":"BL","description":"[String] (Required)
\nProvince of the company headquarters to be associated with the alias (two-letter acronym)
\n","type":"text"},{"key":"country","value":"IT","description":"[String] (Required)
\nCountry of the company headquarters to be associated with the alias.
\nSpecify the two-letter ISO 3166-1 code.
\nFor example, for Italy specify IT
\n","type":"text"},{"key":"vatnumber","value":"01010101251","description":"[String] (Required)
\nVAT number of the company to be associated with the alias
\n","type":"text"},{"key":"email","value":"info@acme.company","description":"[String] (Required)
\nCompany email address to associate with the alias
\n","type":"text"},{"key":"contact","value":"3480000000","description":"[String] (Required)
\nCompany telephone number, fax and opening hours to be associated with the alias
\n","type":"text"},{"key":"taxcode","value":"01010101251","description":"[String] (Required)
\nCompany tax code to associate with the alias
\n","type":"text"},{"key":"pec","value":"acmecompany@acmepec.it","description":"[String] (Required)
\nCertified email (PEC) to be associated with the alias, for companies not resident in Italy, enter an email address
\n","type":"text"},{"key":"statusCallback","value":"https://tuodominio.com/tuo-percorso-callback","description":"[String] (Optional)
\nURL to which a POST notification will be sent via HTTP/HTTPS with the status (VERIFIED, NOTVERIFIED) of the alias\n.\nThe parameters passed to the call are id, alias and status and the Content Type used is application/x-www-form-urlencoded
\n","type":"text"}]},"url":"{{BaseUrl}}/rest/api/alias/","description":"Create a new Alias: in order to use a personalized sender for sending SMS it is mandatory to create a new alias via API or via web interface.
The creation of a new Alias via API requires acceptance of the following clause:
\"I declare that the data indicated above comply with AGCOM resolutions no. 42/13/CIR, 50/14/CIR, 18/17/CIR, 306/20/CIR and subsequent resolutions issued from time to time and refer to the user of the 'Alias; I also agree that the data provided for registration is publishable and subject to processes for identifying the real originator of the messaging.\"
\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
Permanently delete an Alias.
\n[Number] (Required)
\nInternal identifier of the alias to delete
\n","type":"text/plain"},"type":"any","value":"123","key":"aliasId"}]}},"response":[{"id":"cb2a01cb-a6ef-46fd-b7ea-9c000bc263d0","name":"Delete Alias","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":{"raw":"{{BaseUrl}}/rest/api/alias/:aliasId","host":["{{BaseUrl}}"],"path":["rest","api","alias",":aliasId"],"variable":[{"key":"aliasId","value":"123","description":"[Number] *(Obbligatorio)*\n\nIdentificativo interno dell'alias da eliminare"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"87ac8de1-2b3a-4aa5-92b0-525d9641f409"}],"id":"2007d0c4-544b-44be-bc84-0e2b59027264","description":"Aliases are alphanumeric senders (max 11 characters) used for sending SMSs.
\n","_postman_id":"2007d0c4-544b-44be-bc84-0e2b59027264","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}}},{"name":"SMS Reception","item":[{"name":"Search Received SMS","id":"4c90590d-61d1-431f-a998-85282b4dd5b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/sms/received/search?from=393480000000&simIdRef=&fromDate=&toDate","description":"Search for text messages received with the reception service.
\nValue at least one of the following parameters:
\nfrom
simIdRef
fromDate
toDate
[String] (Optional)
\nSender of received text messages.
\nIt must be a mobile number including the international prefix.\nYou can specify multiple phone numbers by separating them with the comma character \",\".
\nFor example:
\n393481234567 or 393481234567,393481234568,393481234568
\n","type":"text/plain"},"key":"from","value":"393480000000"},{"description":{"content":"[Number] (Optional)
\nIdentifier of the reception service on which the text messages were received
\n","type":"text/plain"},"key":"simIdRef","value":""},{"description":{"content":"[String] (Optional)
\nMessages received \"from date\" in format yyyy-MM-ddTHH:mm:ssZ format\nThe character Z indicates the timezone in RFC 822 4-digit format. (For Italy +0200 during summer time and +0100 in the rest of the year)
\n","type":"text/plain"},"key":"fromDate","value":""},{"disabled":true,"description":{"content":"[Number] (Optional)
\nPosition of the first result that will be sent back. See pagination.
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"[Number] (Optional)
\nMax number of results that will be sent back. See pagination.
\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"[String] (Optional)\nMessages received \"to date\" in format yyyy-MM-ddTHH:mm:ssZ format\nThe character Z indicates the timezone in RFC 822 4-digit format. (For Italy +0200 during summer time and +0100 in the rest of the year)
\n","type":"text/plain"},"key":"toDate","value":null}],"variable":[]}},"response":[{"id":"99b74ea5-d8d7-46de-b071-b32efbe5ca98","name":"Cerca SMS Ricevuti","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/sms/received/search?from=393480000000&simIdRef=&fromDate=&toDate","host":["{{BaseUrl}}"],"path":["rest","api","sms","received","search"],"query":[{"key":"from","value":"393480000000","description":"[String] _(Opzionale: valorizzare almeno uno tra **from**, **simIdRef**, **fromDate** o **toDate**)_\n\nMittente degli sms ricevuti.\n\nDeve essere un numero di cellulare compreso di prefisso internazionale.\nÈ possibile specificare _più numeri di telefono_ separandoli con il carattere virgola \",\".\n\nAd esempio:\n\n**393481234567** oppure **393481234567,393481234568,393481234568**"},{"key":"simIdRef","value":"","description":"[Number] _(Opzionale: valorizzare almeno uno tra **from**, **simIdRef**, **fromDate** o **toDate**)_\n\nIdentificativo del servizio di ricezione sui quali sono stati ricevuti gli sms"},{"key":"fromDate","value":"","description":"[String] _(Opzionale: valorizzare almeno uno tra **from**, **simIdRef**, **fromDate** o **toDate**)_\n\nData dalla quale gli sms sono stati ricevuti in formato **yyyy-MM-ddTHH:mm:ssZ**\nIl carattere **Z** indica il timezone nel formato RFC 822 4-digit.(Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno)"},{"key":"toDate","value":null,"description":"[String] _(Opzionale: valorizzare almeno uno tra **from**, **simIdRef**, **fromDate** o **toDate**)_\n\nData fino alla quale gli sms sono stati ricevuti in formato **yyyy-MM-ddTHH:mm:ssZ**\nIl carattere **Z** indica il timezone nel formato RFC 822 4-digit.(Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno)"},{"key":"offset","value":"0","description":"[Number] *(Opzionale)*\n\nPosizione del primo risultato che verrà restituito. Vedi [paginazione](#gestire-la-risposta).","disabled":true},{"key":"limit","value":"20","description":"[Number] *(Opzionale)*\n\nNumero massimo di risultati che verranno restituiti. Vedi [paginazione](#gestire-la-risposta).","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"limit\": 20\n },\n \"smsList\": [\n {\n \"from\": \"+393450000000\",\n \"text\": \"Test sms 1\",\n \"receiveDate\": \"2011-04-21T13:23:13+0200\"\n },\n {\n \"from\": \"+393480000000\",\n \"text\": \"Test sms 1\",\n \"receiveDate\": \"2011-01-18T11:42:51+0100\"\n }\n ]\n}"}],"_postman_id":"4c90590d-61d1-431f-a998-85282b4dd5b2"},{"name":"List of Reception Services","id":"2c0a8d8d-76df-48bc-a474-1a42b75f6fa9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/sms/received/sim/list","description":"The list of reception services purchased returns.
\nWith these API calls you can interact with the \"Forward SMS\" service.
\n","_postman_id":"d6180702-c35a-474d-a547-2c549e0635f9","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}}},{"name":"RCS Reception","item":[{"name":"Search Received RCS","id":"80079d47-eca1-4aeb-9143-c2337fa9b35e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/rcs/message/received/search?agentId=1","description":"Search for received RCS.
\nSet the value to at least one of these parameters:
\nfromsimIdReffromDatetoDate[String] (Optional)
\nSender of received RCS.
\nMust be a phone number with international prefix.
\nIt's possible to set more phone numbers dividing them with the comma character \",\".
\nFor example:\n393481234567 or 393481234567,393481234568,393481234568
\n","type":"text/plain"},"key":"from","value":""},{"description":{"content":"[Number] (Optional)
\nIdentifier of the agent
\n","type":"text/plain"},"key":"agentId","value":"1"},{"disabled":true,"description":{"content":"[String] (Optional)
\nDate where the RCS were received with format yyyy-MM-ddTHH:mm:ssZ
\nThe character Z indicates the timezone in the RFC 822 4-digit format.(For Italy +0200 during the summer timezone and +0100 during the rest of the year)
\n","type":"text/plain"},"key":"fromDate","value":""},{"disabled":true,"description":{"content":"[String] (Optional)
\nDate until the RCS were received in the yyyy-MM-ddTHH:mm:ssZ format
\nThe character Z indicates the timezone in the RFC 822 4-digit format.(For Italy +0200 during the summer timezone and +0100 during the rest of the year)
\n","type":"text/plain"},"key":"toDate","value":""},{"disabled":true,"description":{"content":"[String] (Optional)
\ntransactionId assigned during the sending.
\n","type":"text/plain"},"key":"transactionId","value":""},{"disabled":true,"description":{"content":"[Number] (Optional)
\nPosition of the first record received. See pagination.
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"[Number] (Optional)\nMaximum number of records in the response. See pagination.
\n","type":"text/plain"},"key":"limit","value":""}],"variable":[]}},"response":[{"id":"0e66effe-3bec-4b25-9067-e86b8b4dda71","name":"Search Received RCS","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/rcs/message/received/search?agentId=1","host":["{{BaseUrl}}"],"path":["rest","api","rcs","message","received","search"],"query":[{"key":"from","value":"","description":"[String] _(Optional)_\n\nSender of received RCS.\n\nMust be a phone number with international prefix.\n\nIt's possible to set _more phone numbers_ dividing them with the comma character \",\".\n\nFor example:\n**393481234567** or **393481234567,393481234568,393481234568**","disabled":true},{"key":"agentId","value":"1","description":"[Number] _(Optional)_\n\nIdentifier of the agent"},{"key":"fromDate","value":"","description":"[String] _(Optional)_\n\nDate where the RCS were received with format **yyyy-MM-ddTHH:mm:ssZ**\n\nThe character **Z** indicates the timezone in the RFC 822 4-digit format.(For Italy +0200 during the summer timezone and +0100 during the rest of the year)","type":"text","disabled":true},{"key":"toDate","value":"","description":"[String] _(Optional)_\n\nDate until the RCS were received in the **yyyy-MM-ddTHH:mm:ssZ format**\n\nThe character **Z** indicates the timezone in the RFC 822 4-digit format.(For Italy +0200 during the summer timezone and +0100 during the rest of the year)","type":"text","disabled":true},{"key":"transactionId","value":"","description":"[String] *(Optional)*\n\n**transactionId** assigned during the sending.","type":"text","disabled":true},{"key":"offset","value":"","description":"[Number] *(Optional)*\n\nPosition of the first record received. See [pagination](#gestire-la-risposta).","type":"text","disabled":true},{"key":"limit","value":"","description":"[Number] *(Optional)*\nMaximum number of records in the reponse. See [pagination](#gestire-la-risposta).","type":"text","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"limit\": 20\n },\n \"rcsList\": [\n {\n \"agentId\": \"1\",\n \"from\": \"3400000000\",\n \"text\": \"{\\n \\\"agentId\\\": \\\"AGENT_ID\\\",\\n \\\"senderPhoneNumber\\\": \\\"PHONE_NUMBER\\\",\\n \\\"messageId\\\": \\\"MESSAGE_ID\\\",\\n \\\"sendTime\\\": \\\"2018-12-31T15:01:23.045123456Z\\\",\\n \\\"text\\\": \\\"Hello, world!\\\"\\n}\",\n \"receiveDate\": \"2022-07-07T18:14:26+0200\"\n }\n ]\n}"}],"_postman_id":"80079d47-eca1-4aeb-9143-c2337fa9b35e"}],"id":"7293693b-4e30-486d-8e0d-0145ef1264d5","description":"With these API requests you will be able to interact with the RCS Reception service.
\n","_postman_id":"7293693b-4e30-486d-8e0d-0145ef1264d5","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}}},{"name":"Send Email","item":[{"name":"Sender List","id":"2a09bb5c-7d85-42ef-a804-729f5b03ba5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/email/sender/list","description":"Retrieve the list of senders configured by the user using the web interface.
\nDisplays the list of all email templates created by the user using the web interface.
\nThe response is a JSON containing a list of template , each with the following properties:
[Number] (Optional)
\nPosition of the first result that will be retrieved.
\nExample:
\nIf the offset field is set to 50 and the limit field to 10, the templates from 51 to 60 will be returned.
\nDefault: 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"[Number] (Optional)
\nMaximum number of results that will be retrieved by the search.
\n","type":"text/plain"},"key":"limit","value":"5"}],"variable":[]}},"response":[{"id":"ef2f0140-a397-4a6d-901a-bdb84d61a1cd","name":"Lista Modelli","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/email/template/list?offset=0&limit=5","host":["{{BaseUrl}}"],"path":["rest","api","email","template","list"],"query":[{"key":"offset","value":"0"},{"key":"limit","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"limit\": 20\n },\n \"templates\": [\n {\n \"id\": 2038,\n \"title\": \"Modello Uno\",\n \"editorType\": \"B\",\n \"contentType\": \"multipart/alternative\",\n \"insertDate\": \"2020-06-30T13:48:27+0200\",\n \"updateDate\": \"2020-06-30T14:33:33+0200\",\n \"customFieldsKey\": [\n \"f_s_nome\"\n ]\n },\n {\n \"id\": 299,\n \"title\": \"test\",\n \"editorType\": \"B\",\n \"contentType\": \"multipart/alternative\",\n \"insertDate\": \"2020-04-10T12:27:37+0200\",\n \"updateDate\": \"2020-04-10T12:27:50+0200\"\n }\n ]\n}"}],"_postman_id":"abf2b8dc-e355-4dc1-91f5-60098629000f"},{"name":"Template Detail","id":"851d77da-82a7-444b-aa3c-2b7e0db2a629","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/email/template/:templateId","description":"Returns the detail of a single email template. The detail also contains the customFieldsKey field which contains the id of the dynamic fields to be filled within the template.
Returns the list of sent email campaigns.
\nThe response is a JSON containing campaignList , each one has the following properties:
[Number] (Optional)
\nPosition of the first result that will be retrieved.
\nExample:
\nIf the offset field is set to 50 and the limit field to 10, campaigns 51 through 60 will be returned.
\nDefault: 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"[Number] (Optional)
\nMaximum number of results that will be returned by the search.
\nDefault : 20
\n","type":"text/plain"},"key":"limit","value":"5"}],"variable":[]}},"response":[{"id":"5342657f-2b9d-44e8-b614-829657d3f8b8","name":"Lista Campagne Email","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/email/campaign/list?offset=0&limit=5","host":["{{BaseUrl}}"],"path":["rest","api","email","campaign","list"],"query":[{"key":"offset","value":"0","description":"[Number] *(Opzionale)*\n\nPosizione del primo risultato che verrà restituito.\n\nEsempio:\n\nSe il campo **offset** viene valorizzato a 50 e il campo **limit** a 10 verranno restituiti i coupon **da 51 a 60**.\n\n**Default: 0**"},{"key":"limit","value":"5","description":"[Number] *(Opzionale)*\n\nNumero massimo di risultati che verranno restituiti nella ricerca.\n\n**Default : 20**"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"limit\": 5\n },\n \"campaignList\": [\n {\n \"id\": 2385,\n \"campaignTitle\": \"Invio Orange Friday\",\n \"templateId\": 2038,\n \"from\": \"mr.brown@fake.it\",\n \"fromName\": \"Orange Friday\",\n \"subject\": \"Why only black? Get the orange\",\n \"subjectPreviewText\": \"Orange Friday 2020\",\n \"enableOpenTracking\": true,\n \"enableLinkTracking\": true,\n \"stats\": {\n \"countEmailInserted\": 1,\n \"countEmailStatusPending\": 0,\n \"countEmailStatusNoSent\": 0,\n \"countEmailTotSent\": 1,\n \"countEmailStatusBounced\": 0,\n \"countEmailOpenedUnique\": 1,\n \"countEmailClickUnique\": 0,\n \"countEmailStatusSpamReport\": 0,\n \"countEmailCauseUnsubscribed\": 0\n }\n },\n {\n \"id\": 2570,\n \"campaignTitle\": \"Invio Blue Monday\",\n \"templateId\": 2385,\n \"from\": \"mr.brown@fake.it\",\n \"fromName\": \"Mr. Brown\",\n \"subject\": \"Why only black? Get the blue\",\n \"subjectPreviewText\": \"Get the blue today!\",\n \"enableOpenTracking\": false,\n \"enableLinkTracking\": false,\n \"stats\": {\n \"countEmailInserted\": 9,\n \"countEmailStatusPending\": 0,\n \"countEmailStatusNoSent\": 0,\n \"countEmailTotSent\": 9,\n \"countEmailStatusBounced\": 0,\n \"countEmailOpenedUnique\": 0,\n \"countEmailClickUnique\": 0,\n \"countEmailStatusSpamReport\": 0,\n \"countEmailCauseUnsubscribed\": 0\n }\n }\n ]\n}"}],"_postman_id":"17361157-e4cc-4cdb-9a93-398bbbe66e38"},{"name":"Email Campaign Detail","id":"ee03432a-ea65-4b03-868d-f8fdb5d4f998","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/email/campaign/:campaignId","description":"Returns the detail with data and statistics of a single email campaign.
\n[String] (Required)
\nid of the email campaign whose details you want to retrieve
Returns all emails sent with a campaign
\n[String] (Optional)\nEmail Status:
\nNOSENT - Email not sentBOUNCED - Email not deliveredSPAMREPORT - Email reported as SPAMOPENED - Email openedCLICKED - Email clickedUNSUBSCRIBED - Unsubscribed by the recipient[String] (Optional)
\nRecipient email address
\n","type":"text/plain"},"key":"email","value":""},{"disabled":true,"description":{"content":"[String] (Optional)
\nInternal ID of the email sent.\nMultiple ids can be specified by separating them with the comma character \",\". (Maximum 2000 id).\nFor example:\n12312 or 432432,543543,435435
\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"[Number] (Optional)
\nPosition of the first result that will be returned.\nExample:\nIf the search finds 100 emails, the offset field is set to 50 and the limit field to 10, emails from 51 to 60 will be returned.\nDefault : 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"[Number] (Optional)
\nNumber of results that will be returned.\nDefault: 20
\n","type":"text/plain"},"key":"limit","value":"20"}],"variable":[{"description":{"content":"[String] (Required)\nid of the email campaign whose sent emails
\n","type":"text/plain"},"type":"any","value":"123","key":"campaignId"}]}},"response":[{"id":"355236e2-1fd3-4b1a-bb86-1d205376327e","name":"Cerca Email","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx"}],"url":{"raw":"{{BaseUrl}}/rest/api/sms/search?status=OPENED&email=msbrown@fake.com&offset=0&limit=20","host":["{{BaseUrl}}"],"path":["rest","api","sms","search"],"query":[{"key":"status","value":"OPENED","description":"[String] *(Opzionale)*\nStato dell'email:\n* `NOSENT` - Email non inviata\n* `BOUNCED` - Email non consegnata\n* `SPAMREPORT` - Email segnalata come SPAM\n* `OPENED` - Email aperta\n* `CLICKED` - Email cliccata\n* `UNSUBSCRIBED` - Effettuata disiscrizione da parte del destinatario\n"},{"key":"email","value":"msbrown@fake.com","description":"[String] *(Opzionale)*\nIndirizzo email del destinatario"},{"key":"offset","value":"0","description":"[Number] *(Opzionale)*\nPosizione del primo risultato che verrà restituito.\nEsempio:\nSe la ricerca trova 100 email, il campo **offset** viene valorizzato a 50 ed il campo **limit** a 10 verranno restituiti le email da 51 a 60.\n**Default : 0**"},{"key":"limit","value":"20","description":"[Number] *(Opzionale)*\nNumero di risultati che verranno restituiti.\n**Default: 20**"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"limit\": 20\n },\n \"emailList\": [\n {\n \"id\": 10002,\n \"campaignId\": 33333,\n \"templateId\": 44444,\n \"to\": \"msbrown@fake.com\",\n \"status\": \"OPENED\",\n \"statusDate\": \"2024-04-22T17:15:03+0200\",\n \"insertDate\": \"2024-04-22T15:41:27+0200\"\n }\n ]\n} "}],"_postman_id":"526a0263-aec0-4864-8331-144ba1448e2e"},{"name":"Email Detail","id":"600e2312-4018-4821-a3ab-24c13681c178","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/email/:emailId","description":"Returns the details of a single sent email.
\nid of the email message whose details you want to retrieve
[Number] (Required)
\nid of the template that will be used for the sending. It can be recovered from web interface from the page of detail of the template. To see the detail click: Email -> Templates -> Edit Template -> \"Internal Identifier\".
[String] (Required)
\nEmail address of the sender, it must be a verified sender from web interface
\n","type":"text"},{"key":"fromName","value":"Orange Friday","description":"[String] (Required)
\nName that will appear to the recipient as the sender of the email
\n","type":"text"},{"key":"group","value":"103838","description":"[Number] (Required)
\nid of the group to which the email should be sent, retrievable from the web interface or through the call Groups Address Book -> Group List.
[String] (Required)
\nEmail subject.
\n","type":"text"},{"key":"campaignTitle","value":"Invio Orange Friday","description":"[String] (Required)
\nEmail campaign title.
\n","type":"text"},{"key":"subjectPreviewText","value":"Orange Friday 2020","description":"[String] (Optional)
\nPreview of the email text (this text is only displayed in some mail clients)
\n","type":"text"},{"key":"enableOpenTracking","value":"false","description":"[Boolean] (Optional)
\nIf set to false disable tracking of the email opening
Default: true
\n","type":"text","disabled":true},{"key":"enableLinkTracking","value":"false","description":"[Boolean] (Optional)
\nIf set to false disable tracking for clicks on links in the email
Default: true
\n","type":"text","disabled":true},{"key":"date\n","value":"2029-01-01T00:00:01%2B0200","description":"[String] (Optional)
\nSends the campaign at the specified date and time in the format yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text","disabled":true},{"key":"sandbox","value":"true","description":"[Boolean] (Optional)
\nIf set to true, it simulates sending without actually sending the email.
Default: false
\n","type":"text"},{"key":"replyTo","value":"replytoAddress@fake.it","description":"[String] (Optional)\nEmail Reply To Address
\n","type":"text","disabled":true},{"key":"replyToName","value":"replyToName","description":"[String] (Optional)\nName connected to the reply to address
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/email/campaign/send","description":"Allows you to send an email campaign to a group of contacts in your address book.
\n\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
[Number] (Required)
\nid of the template to be used for the sending. It can be recovered from web interface from the template detail page. To see the detail click: Email -> Templates -> Edit Template -> \"Internal Identifier\".
[String] (Required)
\nEmail address of the sender. It must be a verified sender from web interface
\n","type":"text"},{"key":"fromName","value":"Mr. Brown","description":"[String] (Required)
\nName that will appear to the recipient as the sender of the email
\n","type":"text"},{"key":"to","value":"[{'to':'ms.green@fake.it','f_s_nome':'Clara'},{'to':'mr.yellow@fake.it','f_s_nome':'John'}]","description":"[String] (Required)
\nRecipient of the email in one of the following formats:
\nms.green@fake.it[{'to':'ms.green@fake.it','f_s_nome':'Ms Green'},{'to':'mr.yellow@fake.it','f_s_nome':'John Yellow'}][String] (Required)
\nEmail subject
\n","type":"text"},{"key":"subjectPreviewText","value":"preview","description":"[String] (Optional)
\nPreview of the text of the email (this text is only displayed in some mail clients)
\n","type":"text"},{"key":"enableOpenTracking","value":"false","description":"[Boolean] (Optional)
\nIf set to false disable tracking for the email openings
Default: true
\n","type":"text","disabled":true},{"key":"enableLinkTracking","value":"false","description":"[Boolean] (Optional)
\nIf set to false disable tracking for clicks on links in the email
Default: true
\n","type":"text","disabled":true},{"key":"date","value":"2029-01-01T00:00:01%2B0200","description":"[String] (Optional)
\nSends the campaign at the specified date and time in the format yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text","disabled":true},{"key":"sandbox","value":"true","description":"[Boolean] (Optional)
\nIf set to true, it simulates the sending without actually sending the email.\nDefault: false
[String] (Optional)\nEmail Reply To Address
\n","type":"text","disabled":true},{"key":"replyToName","value":"replyToName","description":"[String] (Optional)\nName connected to the reply to address
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/email/send","description":"Allows you to send a single email to up to 50 recipients, even if they are not in an address book group.
\n\n\n\n\nPay special attention because the id of the Email could be a 64-bit integer (int64)
\n
Check that your platform can handle it!
\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
These APIs allow you to automatically manage your email campaigns.
\n\n\nEmail sending is a Premium Plan feature. Activate your trial period for free.
\n
\n\n","_postman_id":"2ebc1f03-784f-4038-8923-0686d27ecc21","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}}},{"name":"Fidelity Card","item":[{"name":"Fidelity List","id":"5dfefcac-007e-47a7-b07f-222b9980adbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/fidelity/list","description":"To be able to use the Email API you must request the specific permission.\nApply here
\n
Returns the list of the user's Fidelity programs.
\nThe paged list of all Fidelity Cards associated with the Fidelity program returns.
\n[Number] (Optional)
\nMaximum number of results that will be returned in the search.
\nDefault : 20
\n","type":"text/plain"},"key":"limit","value":"5"},{"disabled":true,"description":{"content":"[Number] (Optional)
\nPosition of the first result that will be returned.
\nExample:
\nIf the offset field is set to 50 and the limit field to 10, fidelity cards from 51 to 60 will be returned.
\nDefault: 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"[String] (Optional)
\nFidelity Card issue date in the format yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text/plain"},"key":"fromDate","value":"2019-11-22T11:22:33%2B0200"},{"disabled":true,"description":{"content":"[String] (Optional)
\nFidelity Card issue date in the format yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text/plain"},"key":"toDate","value":"2019-11-23T11:22:33%2B0200"},{"disabled":true,"description":{"content":"[Number] (Optional)
\nId of the contact to which the fidelity is associated
\n","type":"text/plain"},"key":"idContact","value":"123"}],"variable":[{"description":{"content":"[Number (Required)
\nid of the Fidelity program retrieved with the Fidelity List call
\n","type":"text/plain"},"type":"any","value":"123","key":"id"}]}},"response":[{"id":"e545f90e-0ac0-47bc-8f8f-274b963d0248","name":"Fidelity Card List","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/fidelity/:id/card/list","host":["{{BaseUrl}}"],"path":["rest","api","fidelity",":id","card","list"],"query":[{"key":"limit","value":"5","description":"[Number] *(Opzionale)*\n\nNumero massimo di risultati che verranno restituiti nella ricerca.\n\n**Default : 20**","disabled":true},{"key":"offset","value":"0","description":"[Number] *(Opzionale)*\n\nPosizione del primo risultato che verrà restituito.\n\nEsempio:\n\nSe il campo **offset** viene valorizzato a 50 e il campo **limit** a 10 verranno restituite le fidelity card **da 51 a 60**.\n\n**Default: 0**","disabled":true},{"key":"fromDate","value":"2019-11-22T11:22:33%2B0200","description":"[String] *(Opzionale)*\n\nData di emissione della Fidelity Card nel formato **yyyy-MM-dd'T'HH:mm:ssZ**","disabled":true},{"key":"toDate","value":"2019-11-23T11:22:33%2B0200","description":"[String] *(Opzionale)*\n\nData di emissione della Fidelity Card nel formato **yyyy-MM-dd'T'HH:mm:ssZ**\n","disabled":true},{"key":null,"value":null,"disabled":true}],"variable":[{"key":"id","value":"123","description":"[Number] *(Obbligatorio)*\n\n**id** del *programma Fidelity* recuperato con la chiamata _**Fidelity List**_"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 15,\n \"offset\": 0,\n \"limit\": 3\n },\n \"fidelityCardList\": [\n {\n \"fidelityId\": 123,\n \"fidelityCardId\": 2668,\n \"fidelityCode\": \"CARD_00011\",\n \"activationDate\": \"2019-11-22T16:11:23+0100\",\n \"active\": true,\n \"points\": 21\n },\n {\n \"fidelityId\": 123,\n \"fidelityCardId\": 2669,\n \"fidelityCode\": \"CARD_00014\",\n \"activationDate\": \"2019-11-22T16:11:23+0100\",\n \"active\": true,\n \"points\": 0\n },\n {\n \"fidelityId\": 123,\n \"fidelityCardId\": 2670,\n \"fidelityCode\": \"CARD_00021\",\n \"activationDate\": \"2019-11-22T16:11:23+0100\",\n \"active\": true,\n \"points\": 0\n }\n ]\n}"}],"_postman_id":"55415d80-6e81-447e-8a4f-40ae908463ec"},{"name":"Fidelity Card Add","id":"a2c4a27e-8271-4f96-bd0e-aadeb52835a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"msisdn","value":"393400000000","description":"[String] (Required)
\nContact's phone number (country code included).
\nEs. 393400000000
\n","type":"text"},{"key":"cardCode","value":"CARD0001","description":"[String] (Optional)
\nFidelity Card code from 6 to 30 characters 0-9A-Za-z_.
\nIf not set, a random one (15 characters) will be generated automatically.
\n","type":"text"},{"key":"startingPoints","value":"3","description":"[Number] (Optional)
\nPoints added to the fidelity card during creation.
\n","type":"text","disabled":true},{"key":"startingAmount","value":"7.15","description":"[Decimal] (Optional)
\nAmount spent to add to the Fidelity Card upon creation.
\n","type":"text","disabled":true},{"key":"sendSms","value":"false","description":"[Boolean] (Optional)
\nDefault: true send an sms to the contact with a short url to let them add the Fidelity Card to a digital wallet (Google Pay or Apple Wallet)
If set tofalse the sms is not sent.
Adds a Fidelity Card to the Fidelity Program and adds it to the contact.
\n\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
[Number] (Required)
\nid of the Fidelity program retrieved with the Fidelity List call
\n","type":"text/plain"},"type":"any","value":"123","key":"id"}]}},"response":[{"id":"3c6d21e2-7d96-4f32-80fa-8587b9457af1","name":"Fidelity Card Add","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"msisdn","value":"393400000000","description":"[String] *(Obbligatorio)*\n\nNumero di cellulare del contatto compreso di prefisso internazionale.\n\nEs. **393400000000**","type":"text"},{"key":"cardCode","value":"CARD0001","description":"[String] *(Opzionale)*\n\nCodice della Fidelity Card da **6** a **30** caratteri **0-9A-Za-z_**.\n\nSe assente ne verrà generato uno di **15** caratteri in automatico.","type":"text"},{"key":"startingPoints","value":"3","description":"[Number] *(Opzionale)*\n\nPunti caricati sulla Fidelity Card al momento della creazione.","type":"text","disabled":true},{"key":"startingAmount","value":"7.15","description":"[Decimal] *(Opzionale)*\n\nImporto speso associato alla Fidelity Card al momento della creazione.","type":"text","disabled":true},{"key":"sendSms","value":"false","description":"[Boolean] *(Opzionale)*\n\nDefault: `true` manda un sms al contatto con uno short url che permette di aggiungere la Fidelity Card al wallet dello smartphone (Google Pay o Apple Wallet).\n\nSe valorizzato a `false` non manda l'sms al contatto.\n","type":"text","disabled":true}]},"url":{"raw":"{{BaseUrl}}/rest/api/fidelity/:id/card","host":["{{BaseUrl}}"],"path":["rest","api","fidelity",":id","card"],"variable":[{"key":"id","value":"123","description":"[Number *(Obbligatorio)*\n\n**id** del *programma Fidelity* recuperato con la chiamata _**Fidelity List**_"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"fidelityId\": 38,\n \"fidelityCardId\": 1234,\n \"fidelityCode\": \"F582323963717\",\n \"activationDate\": \"2019-12-03T14:26:48+0100\",\n \"active\": true,\n \"points\": 0\n}"}],"_postman_id":"a2c4a27e-8271-4f96-bd0e-aadeb52835a2"},{"name":"Fidelity Card Detail","id":"7285e71d-e10b-4dd6-9956-44ba254bc197","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/fidelity/:id/card/:fidelityCode","description":"The detail of a Fidelity Card returns.
\n[Number] (Required)
\nid of the Fidelity program retrieved with the Fidelity List call
\n","type":"text/plain"},"type":"any","value":"123","key":"id"},{"description":{"content":"[String] (Required)
\nFidelity Card code
\n","type":"text/plain"},"type":"any","value":"CARD0001","key":"fidelityCode"}]}},"response":[{"id":"aae96af1-d7c9-4ffd-8d28-66a72d8a1d79","name":"Fidelity Card Detail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/fidelity/:id/card/:fidelityCode","host":["{{BaseUrl}}"],"path":["rest","api","fidelity",":id","card",":fidelityCode"],"variable":[{"key":"id","value":"123","description":"[Number] *(Obbligatorio)*\n\n**id** del *programma Fidelity* recuperato con la chiamata _**Fidelity List**_"},{"key":"fidelityCode","value":"CARD0001","description":"[String] *(Obbligatorio)*\n\nCodice della *Fidelity Card*"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"fidelityId\": 123,\n \"fidelityCardId\": 12345,\n \"fidelityName\": \"Programma fidelity supercool\",\n \"contactDetail\": {\n \"msisdn\": \"393480000000\",\n \"name\": \"Mario\",\n \"lastname\": \"Rossi\",\n \"email\": \"mario.rossi@fake.it\",\n \"groups\": [\n {\n \"id\": 10001,\n \"name\": \"amici\"\n }\n ],\n \"customFields\": [\n {\n \"fieldKey\": \"f_s_msisdn\",\n \"fieldName\": \"Cellulare\",\n \"fieldValue\": \"393480000000\"\n },\n {\n \"fieldKey\": \"f_s_email\",\n \"fieldName\": \"Email\",\n \"fieldValue\": \"mario.rossi@fake.it\"\n },\n {\n \"fieldKey\": \"f_s_nome\",\n \"fieldName\": \"Nome\",\n \"fieldValue\": \"Mario\"\n },\n {\n \"fieldKey\": \"f_s_cognome\",\n \"fieldName\": \"Cognome\",\n \"fieldValue\": \"Rossi\"\n }\n ]\n },\n \"fidelityCode\": \"CARD0001\",\n \"activationDate\": \"2019-11-22T16:11:23+0100\",\n \"active\": true,\n \"points\": 7\n}"}],"_postman_id":"7285e71d-e10b-4dd6-9956-44ba254bc197"},{"name":"Fidelity Card Records","id":"132a0ca4-33be-4b18-90eb-3e415f8e6bc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/fidelity/:id/card/:fidelityCode/record/list","description":"Get the paged list of all the points/rewards assigned to the Fidelity Card.
\n[String] (Optional)
\nFilter the type of operation carried out on fidelity, the possible values are:
\nADD - Points added to the Loyalty CardREWARD - Rewards assigned to the Loyalty CardRESET - Resetting pointsIMPORT - Points added to Fidelity Card bulk importCREATE - Points added when creating Loyalty CardPLAN_NOT_ENABLED - This call is not allowed in the user plan[Number] (Optional)
\nMaximum number of results that will be returned in the search.
\nDefault : 20
\n","type":"text/plain"},"key":"limit","value":"10"},{"disabled":true,"description":{"content":"[Number] (Optional)
\nPosition of the first result that will be returned.
\nExample:
\nIf the offset field is set to 50 and the limit field to 10, records 51 to 60 will be returned.\nDefault: 0
\n","type":"text/plain"},"key":"offset","value":"10"},{"disabled":true,"description":{"content":"[String] (Optional)
\nDate of the operation on the Fidelity Card in the format yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text/plain"},"key":"fromDate","value":"2019-11-27T15:38:09%2B0100"},{"disabled":true,"description":{"content":"[String] (Optional)
\nDate of the operation on the Fidelity Card in the format yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text/plain"},"key":"toDate","value":"2019-11-22T11:22:33%2B0200"}],"variable":[{"description":{"content":"[Number] (Required)
\nid of the Fidelity program retrieved with the Fidelity List call
\n","type":"text/plain"},"type":"any","value":"123","key":"id"},{"description":{"content":"[String] (Required)
\nFidelity Card code
\n","type":"text/plain"},"type":"any","value":"CARD0001","key":"fidelityCode"}]}},"response":[{"id":"9f46250e-52ea-4c52-b9e2-37e4bf31819e","name":"Fidelity Card Records","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/fidelity/:id/card/:fidelityCode/record/list","host":["{{BaseUrl}}"],"path":["rest","api","fidelity",":id","card",":fidelityCode","record","list"],"query":[{"key":"action","value":"ADD","description":"[String] *(Opzionale)*\n\nFiltra il tipo di operazione effettuata sulla fidelity, i possibili valori sono:\n\n* `ADD` - Punti aggiunti alla Fidelity Card\n* `REWARD` - Premi assegnato alla Fidelity Card\n* `AZZERA` - Azzeramento punti\n* `IMPORT` - Punti aggiunti all'import bulk della Fidelity Card\n* `CREATE` - Punti aggiunti alla creazione della Fidelity Card\n* `PLAN_NOT_ENABLED` - Questa chiamata non è permessa nel piano utente","disabled":true},{"key":"limit","value":"10","description":"[Number] *(Opzionale)*\n\nNumero massimo di risultati che verranno restituiti nella ricerca.\n\n**Default : 20**","disabled":true},{"key":"offset","value":"10","description":"[Number] *(Opzionale)*\n\nPosizione del primo risultato che verrà restituito.\n\nEsempio:\n\nSe il campo **offset** viene valorizzato a **50** e il campo limit a **10** verranno restituiti i record **da 51 a 60**.\n\n**Default: 0**","disabled":true},{"key":"fromDate","value":"2019-11-27T15:38:09%2B0100","description":"[String] *(Opzionale)*\n\nData dell'operazione sulla Fidelity Card nel formato **yyyy-MM-dd'T'HH:mm:ssZ**","disabled":true},{"key":"toDate","value":"2019-11-22T11:22:33%2B0200","description":"[String] *(Opzionale)*\n\nData dell'operazione sulla Fidelity Card nel formato **yyyy-MM-dd'T'HH:mm:ssZ**","disabled":true}],"variable":[{"key":"id","value":"123","description":"[Number] *(Obbligatorio)*\n\n**id** del *programma Fidelity* recuperato con la chiamata _**Fidelity List**_"},{"key":"fidelityCode","value":"CARD0001","description":"[String] *(Obbligatorio)*\n\nCodice della *Fidelity Card*"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"158"},{"key":"Date","value":"Tue, 11 May 2021 10:52:09 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"limit\": 20\n },\n \"fidelityCardRecordList\": [\n {\n \"id\": 123456,\n \"points\": 2,\n \"amount\": 5.38,\n \"action\": \"ADD\",\n \"date\": \"2021-05-11T12:52:02+0200\"\n }\n ]\n}"}],"_postman_id":"132a0ca4-33be-4b18-90eb-3e415f8e6bc3"},{"name":"Fidelity Card Record Retrieve","id":"36c10008-b7b5-4b33-ac71-1ba09fa4eb22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/fidelity/:id/card/:fidelityCode/record/:recordId","description":"Retrieve information from a points movement record on a Fidelity Card
\n[Number] (Required)
\nid of the Fidelity program retrieved with the Fidelity List call
\n","type":"text/plain"},"type":"any","value":"123","key":"id"},{"description":{"content":"[String] (Required)
\nFidelity Card code
\n","type":"text/plain"},"type":"any","value":"CARD0001","key":"fidelityCode"},{"description":{"content":"[Number] (Required)
\nid of the record to retrieve, obtainable after calling Fidelity Card Record Add or Fidelity Card Records
Delete a points movement record from a Loyalty Card.
\n[Number] (Required)
\nid of the Fidelity program retrieved with the Fidelity List call
\n","type":"text/plain"},"type":"any","value":"123","key":"id"},{"description":{"content":"[String] (Required)
\nFidelity Card code
\n","type":"text/plain"},"type":"any","value":"CARD0001","key":"fidelityCode"},{"description":{"content":"[Number] (Required)
\nid of the record to delete, obtainable by calling Fidelity Card Record Add or Fidelity Card Records
[String] (Required)
\nType of operation done to the Fidelity Card, the possible values are:
\nADD - Add points/amount to the Fidelity CardREWARD - Reward assigned to the Fidelity CardAZZERA - Reset points[Number] (Optional) -> set one of the parameters points or amount for the action ADD
Points assigned to the Fidelity Card.
\nIf not set, the amount of points assigned will be based on the amount spent and the value of a single point (points = amount / single_point_value).
\n","type":"text"},{"key":"amount","value":"5.38","description":"[Decimal] (Optional) -> set one of the parameters points or amount for the action ADD
Amount spent.
\nIf not set, the amount of points assigned will be base on the value of the parameter points.
[Number] (Optional) -> required for the action REWARD
Reward ID to be assigned to the fidelity card
\n","type":"text","disabled":true},{"key":"note","value":"My notes","description":"[String] (Optional)
\nGeneric field for notes linked to the operation.
\n","type":"text","disabled":true},{"key":"sendSms","value":"false","description":"[Boolean] (Optional)
\nDefault: true if the contact has reached the amount of points needed to get a reward, an sms will be sent automatically.
If set to false the sms will not be sent.
Change the score of a Loyalty Card. The following movements are currently supported:
\nADD - Adds pointsREWARD - Gives a rewardRESET - Resets the card score to zero\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
[Number] (Required)
\nid of the Fidelity program retrieved with the Fidelity List call
\n","type":"text/plain"},"type":"any","value":"123","key":"id"},{"description":{"content":"[String] (Required)
\nFidelity Card code
\n","type":"text/plain"},"type":"any","value":"CARD0001","key":"fidelityCode"}]}},"response":[{"id":"d106c8d4-8df4-4eb8-aeae-fa42319f6b48","name":"Fidelity Card Record Add","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"action","value":"ADD","description":"[String] *(Obbligatorio)*\n\nTipo di operazione effettuata sulla Fidelity Card, i possibili valori sono:\n* `ADD` - Aggiunta punti/importo alla Fidelity Card\n* `REWARD` - Premi assegnato alla Fidelity Card\n* `AZZERA` - Azzeramento punti","type":"text"},{"key":"points","value":"2","description":"[Number] *(Opzionale)*\n\nPunti assegnati alla Fidelity Card.\n\nSe questo parametro non viene valorizzato, verranno aggiunti i punti alla fidelity a seconda dell'amount (**amount = punti * valore_singolo_punto**).\n\n_**Nota**: almeno uno tra i parametri `points` o `importo` sono obbligatori per la action `ADD`._","type":"text"},{"key":"amount","value":"5.38","description":"[Decimal] *(Opzionale)*\n\nImporto speso con con l'operazione di assegnazione punti.\n\nSe questo parametro non viene valorizzato, verrano aggiunti i punti alla fidelity in rapporto all'importo speso (**punti = amount / valore_singolo_punto**).\n\n_**Nota**: almeno uno tra i parametri `points` o `importo` sono obbligatori per la action `ADD`._","type":"text"},{"key":"rewardId","value":"11","description":"[Number] *(Opzionale)*\n\nIdentificativo del premio da assegnare alla Fidelity Card.\n\n_**Nota**: parametro obbligatorio per la action `REWARD`._","type":"text","disabled":true},{"key":"note","value":"My notes","description":"[String] *(Opzionale)*\n\nCampo generico per delle note associate all'operazione.","type":"text","disabled":true},{"key":"sendSms","value":"false","description":"[Boolean] *(Opzionale)*\n\nDefault: `true` se il contatto ha raggiunto i punti per riscattare un premio, viene inviato in automatico un sms.\n\nSe valorizzato a `false` non manda l'sms al contatto.","type":"text","disabled":true}]},"url":{"raw":"{{BaseUrl}}/rest/api/fidelity/:id/card/:fidelityCode/record","host":["{{BaseUrl}}"],"path":["rest","api","fidelity",":id","card",":fidelityCode","record"],"variable":[{"key":"id","value":"123","description":"[Number] *(Obbligatorio)*\n\n**id** del *programma Fidelity* recuperato con la chiamata _**Fidelity List**_"},{"key":"fidelityCode","value":"CARD0001","description":"[String] *(Obbligatorio)*\n\nCodice della *Fidelity Card*"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": 123,\n \"points\": 2,\n \"amount\": 11.12,\n \"action\": \"ADD\",\n \"date\": \"2020-07-06T12:53:41+0200\"\n}"}],"_postman_id":"a5d52559-27ee-4372-bd36-f82184583699"}],"id":"d441b69e-3e98-4898-902c-b1a560453bb3","description":"Complete management of fidelity cards via REST API.
\nCreate card
\nAdd/remove points
\nAdd/remove spending amounts
\nDetail assigned rewards
\n\n\n","_postman_id":"d441b69e-3e98-4898-902c-b1a560453bb3","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}}},{"name":"Digital Coupons","item":[{"name":"Coupon Campaign List","id":"9f18cd19-2be9-43ff-bc71-1531919406ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/digitalcoupon/campaign/list","description":"Fidelity Cards are a Premium Plan feature. Activate your free trial.
\n
Returns the list of the user's Coupon Campaigns.
\nThe detail of a Coupon Campaign returns.
\n[Number] (Required)
\nid of the coupon campaign
[String] (Required)
\nCoupon Campaign Name (e.g. Black Friday Coupon)
[String] (Required)
\nF or D Fxed or Ddynamic Coupon
[String] (Optional)
\nCoupon code if Fixed type F (e.g. MYCOUPON_F_12345)
[String] (Optional)
\nValidity start date of the Coupon Campaign in the format yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text","disabled":true},{"key":"endDate","value":"2020-07-18T19:22:33+0200","description":"[String] (Optional)
\nEnd of validity date of the Coupon Campaign in the format yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/digitalcoupon/campaign","description":"Create a new Coupon Campaign.
\n\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
Returns the list of the user's Fidelity programs.
\nLook for a coupon
\n[Number] (Optional)
\nid of the Coupon Campaign
[String] (Optional)
\n coupon code
[Number] (Optional)\nid of the contact
[Number] (Optional)
\nMaximum number of results that will be returned in the search.
\nDefault : 20
\n","type":"text/plain"},"key":"limit","value":"10"},{"disabled":true,"description":{"content":"[Number] (Optional)
\nPosition of the first result that will be returned.
\nExample:
\nIf the offset field is set to 50 and the limit field to 10, coupons 51 to 60 will be returned.
\nDefault: 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"[String] (Optional)
\nCoupon creation \"from date\" in the format yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text/plain"},"key":"fromDate","value":"2020-06-18T19:22:33%2B0200"},{"disabled":true,"description":{"content":"[String] (Optional)\nCoupon creation \"to date\" in the format yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text/plain"},"key":"toDate","value":"2020-11-22T11:22:33%2B0200"},{"description":{"content":"[String] (Optional)\ntrue to get only the usable coupons (not expired, not already used, etc)
\n","type":"text/plain"},"key":"onlyUsable","value":"true"}],"variable":[]}},"response":[{"id":"b2a1006e-c5cb-4146-86c3-71c37532e315","name":"Coupon Search","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/digitalcoupon/coupon/search?campaignId=138","host":["{{BaseUrl}}"],"path":["rest","api","digitalcoupon","coupon","search"],"query":[{"key":"campaignId","value":"138","description":"[Number] *(Opzionale)*\n\n`id` della Campagna Coupon\n"},{"key":"couponCode","value":"3VWYF1OTIEYN","description":"[String] *(Opzionale)*\n\n `codice` del coupon","disabled":true},{"key":"limit","value":"10","description":"[Number] *(Opzionale)*\n\nNumero massimo di risultati che verranno restituiti nella ricerca.\n\n**Default : 20**","disabled":true},{"key":"offset","value":"0","description":"[Number] *(Opzionale)*\n\nPosizione del primo risultato che verrà restituito.\n\nEsempio:\n\nSe il campo **offset** viene valorizzato a 50 e il campo **limit** a 10 verranno restituiti i coupon **da 51 a 60**.\n\n**Default: 0**","disabled":true},{"key":"fromDate","value":"2020-06-18T19:22:33%2B0200","description":"[String] *(Opzionale)*\n\nData di creazione del coupon nel formato **yyyy-MM-dd'T'HH:mm:ssZ**","disabled":true},{"key":"toDate","value":"2020-11-22T11:22:33%2B0200","description":"[String] *(Opzionale)*\nData di creazione del coupon nel formato **yyyy-MM-dd'T'HH:mm:ssZ**","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 11,\n \"offset\": 0,\n \"limit\": 2\n },\n \"couponList\": [\n {\n \"code\": \"vwtthwrh\",\n \"insertDate\": \"2020-06-30T08:54:33+0200\",\n \"campaignId\": 38\n },\n {\n \"code\": \"1NBNFME8PR\",\n \"insertDate\": \"2020-06-29T14:31:14+0200\",\n \"campaignId\": 38\n }\n ]\n}"}],"_postman_id":"2cbd3419-b138-4959-be3e-7e14ae0e30bb"},{"name":"Coupon Detail","id":"7a04543d-0d16-40ae-926c-b4b1a9252394","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/digitalcoupon/coupon/:couponCode","description":"Returns the detail of a Coupon
\n[String] (Required)
\nCoupon code whose details you want to retrieve
\n","type":"text/plain"},"type":"any","value":"MYCOUPON123","key":"couponCode"}]}},"response":[{"id":"b2d58cb9-618a-4eb2-ae1d-500be3453e4a","name":"Coupon Detail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/digitalcoupon/coupon/:couponCode","host":["{{BaseUrl}}"],"path":["rest","api","digitalcoupon","coupon",":couponCode"],"variable":[{"key":"couponCode","value":"MYCOUPON123","description":"[String] *(Obbligatorio)*\n\nCodice del coupon di cui si vogliono recuperare i dettagli"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"MYCOUPON123\",\n \"insertDate\": \"2026-01-10T16:20:02+0100\",\n \"campaignId\": 38,\n \"usages\": 5,\n \"couponType\": \"D\",\n \"dstList\": [\n {\n \"idcoupon\": 8475684,\n \"idsms\": 9871425,\n \"idcontatto\": 102,\n \"msisdn\": \"393000000000\",\n \"insertDate\": \"2026-01-10T16:20:02+0100\"\n }\n ]\n}"}],"_postman_id":"7a04543d-0d16-40ae-926c-b4b1a9252394"},{"name":"Generate Coupon","id":"00a9d54f-6b76-4f3a-ad58-c3a78d0e6797","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"campaignId","value":"138","description":"[Number] (Required)
\nid of the coupon campaign to add the coupon to
[String] (Optional)
\nCoupon code if of Ddynamic type (between 6 and 32 characters). If not provided, a random Coupon Code provided in the response will be generated.
\n","disabled":true},{"key":"couponLength","value":"10","description":"[Number] (Optional)
\nAutomatically generated random Coupon Code length
\nDefault: 6
\n","type":"text","disabled":true},{"key":"contactId","value":"123","description":"[Number] (Optional)\nContact Id to associate with the generated coupon
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/digitalcoupon/coupon","description":"Generate a new Coupon in a D campaign (Ddynamic coupon).
\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
[String] (Required)
\nCoupon code you want to report as used.
\n","type":"text/plain"},"type":"any","value":"MYCOUPON_2020","key":"couponCode"}]}},"response":[{"id":"2ab5dfb2-784e-42fb-afcc-e243d44e1a99","name":"Coupon Usage","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":{"raw":"{{BaseUrl}}/rest/api/digitalcoupon/coupon/:couponCode/usage","host":["{{BaseUrl}}"],"path":["rest","api","digitalcoupon","coupon",":couponCode","usage"],"variable":[{"key":"couponCode","value":"MYCOUPON_2020","description":"[String] *(Obbligatorio)*\n\nCodice del coupon che si vuole segnalare come utilizzato."}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"MYCOUPON_2020\",\n \"insertDate\": \"2020-06-29T12:51:53+0200\",\n \"campaignId\": 38,\n \"usages\": 10\n}"}],"_postman_id":"fffea608-f865-4bd9-872f-b9db8ccc37e6"}],"id":"8373350e-b40a-4be5-94d1-fbc838ab2d83","description":"Complete management of digital coupons via REST API.
\n\n\n","_postman_id":"8373350e-b40a-4be5-94d1-fbc838ab2d83","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}}},{"name":"Booking","item":[{"name":"Calendar List","id":"d2dca001-5958-4b49-8261-e5f52d6c3f17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/booking/calendar","description":"Digital Coupons are a Premium Plan feature. Activate your free trial.
\n
Returns the list of all calendars configured by the user.
\nReturns the detail of a calendar.
\n[Number] (Required)
\nid of the calendar whose details you want to retrieve, see call Calendar List
Returns the list of services (task) associated with the calendar.
\n[Number] (Required)
\nid of the calendar whose activities you want to recover (task), see call Calendar List
Returns the list of reservations (reservation) associated with the calendar.
\n[Number] (Required)
\nid of the calendar whose activity you want to retrieve (task), see call Calendar List
[Number] (Required)
\nid of the service (task) whose details you want to retrieve, see Task List call
Returns the list of times with the bookable slots for the specified day.
The time is returned in the format HH:mm
[Number] (Required)
\nid of the calendar from which you want to retrieve the reservations, see call Calendar List
[Number] (Required)
\nid of the service (task) for which you want to retrieve the list of free slots, see Task List call
Returns the list of reservations (reservation) associated with the calendar.
\n[Number] (Optional)
\nFilter only reservations for the task with this id
[String] (Optional)
\nFilter by reservation status, the possible values are:
\nCONFIRMED - Show only confirmed reservationsUNCONFIRMED - Show only reservations not yet confirmedDELETED - Show only deleted reservations[String] (Optional)
\nFilter based on the starting date of the reservation in the format yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text/plain"},"key":"fromDate","value":"2021-03-27T15:38:09%2B0100"},{"disabled":true,"description":{"content":"[String] (Optional)
\nFilter based on the starting date of the reservation in the format yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text/plain"},"key":"toDate","value":"2021-02-27T15:38:09%2B0100"},{"description":{"content":"[Number] (Optional)
\nMaximum number of results that will be returned in the search.\nDefault : 20
\n","type":"text/plain"},"key":"limit","value":"5"},{"description":{"content":"[Number] (Optional)\nPosition of the first result that will be returned.\nExample:\nIf the offset field is set to 50 and the limit field to 10, fidelity cards from 51 to 60 will be returned.\nDefault: 0
\nExample:
\nIf the offset field is set to 50 and the limit field to 10, fidelity cards from 51 to 60 will be returned.
\nDefault: 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"[String] (Optional)
\nFilter reservations that contain this string in the contact first or last name
\n","type":"text/plain"},"key":"query","value":"Mario"}],"variable":[{"description":{"content":"[Number] (Required)
\nid of the calendar from which you want to retrieve the reservations, see call Calendar List
Returns the list of reservations (reservation) associated with the calendar.
\n[Number] (Required)
\nid of the calendar from which you want to retrieve the reservations, see call Calendar List
[Number] (Required)
\nid of the reservation whose details you want to retrieve
[Number] (Required)
\nid of the service (task) to which you want to add a reservation
[Number] (Required)
\nid of the contact you want to associate the booking with
[String] (Required)
\nBooking start date and time in the format yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text"},{"key":"status","value":"CONFIRMED","description":"[String] (Optional)
\nStatus of the new booking, the possible values are:CONFIRMED - booking confirmedUNCONFIRMED - booking to be confirmed
Note: if the status is not specified the booking is inserted with the policy specified by the web interface [CONFIRMED|UNCONFIRMED]
[String] (Optional)
\nNotes associated with the booking
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/booking/calendar/:calendarId/reservation","description":"Adds a Booking to the specified Calendar.
\n\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
[Number] (Required)
\nid of the calendar to which you want to add the reservation, see call Calendar List
[Number] (Optional)
\nid of the contact you want to associate the booking with
[String] (Optional)
\nBooking start date and time in the format yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text","disabled":true},{"key":"status","value":"CONFIRMED","description":"[String] (Optional)
\nBooking status, the possible values are:CONFIRMED - booking confirmedUNCONFIRMED - booking to be confirmedDELETED - booking deleted
Note: if it is not Once the status is specified, the reservation is inserted with the policy specified by the web interface [CONFIRMED|UNCONFIRMED]
[String] (Optional)
\nNotes associated with the booking
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/booking/calendar/:calendarId/reservation/:reservationId","description":"Edit a Reservation in the specified Calendar.
\nIt is only possible to modify reservations that have not yet expired or been deleted.
\nA confirmed (CONFIRMED) reservation can only be rejected (REFUSED) or deleted (DELETED).
If rejected a notification message will be sent to the contact (as configured from the web panel), if deleted no notification will be sent to the contact
\n\n\nThe \"Content-Type\" for this PUT request must be \"application/x-www-form-urlencoded\"
\n
[Number] (Required)
\nid of the calendar to which you want to add the reservation, see call Calendar List
[Number] (Required)
\nid of the reservation you want to edit
Delete a Booking from the specified Calendar.
\n\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
[Number] (Required)
\nid of the calendar to which the reservation to be deleted belongs, see call Calendar List
[Number] (Required)
\nid of the reservation you want to delete
Search for a contact in the address book.
\n[String] (Optional)
\nFull name of the contact.
\nThe search is performed on the name and lastname fields
[String] (Optional)
\nContact's mobile number.
\nThe mobile number must include the international prefix e.g. 393480000000
\n","type":"text/plain"},"key":"msisdn","value":"393480000000"},{"disabled":true,"description":{"content":"[String] (Optional)
\nContact email address
\n","type":"text/plain"},"key":"email","value":"test@test.it"},{"disabled":true,"description":{"content":"[String] (Optional)
\nSearch by specific field.
\nEnter the key relating to the field you want to use for the search.
\nThe keys of the custom fields can be retrieved by calling Field List
\n","type":"text/plain"},"key":"fieldKey","value":""},{"disabled":true,"description":{"content":"[String] (Optional)
\nSearch by specific field.
\nEnter the value you want to find, the search will be performed within the field specified in the fieldKey parameter.
[Number] (Optional)
\nPosition of the first result that will be returned. See pagination.
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"[Number] (Optional)
\nMaximum number of results that will be returned. See pagination.
\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"[String] (Optional)\nField by which you want to sort the results:
\nname - Name fieldlastname - Last name field[String] (Optional)\nHow contacts are sorted:
\nASC - A-Z orderDESC - Z-A orderThe detail of a contact inserted in the address book returns.
\n[Number] (Required)
\nUnique contact identifier
\n","type":"text/plain"},"type":"any","value":"12345678","key":"contactId"}]}},"response":[{"id":"b1488218-9edd-4d31-88d4-ee066da5162e","name":"Dettaglio Contatto","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/phonebook/contact/:contactId","host":["{{BaseUrl}}"],"path":["rest","api","phonebook","contact",":contactId"],"variable":[{"key":"contactId","value":"","description":"[Number] *(Obbligatorio)*\n\nIdentificativo univoco del contatto"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": 123456789,\n \"msisdn\": \"393480000000\",\n \"name\": \"Mario\",\n \"lastname\": \"Rossi\",\n \"email\": \"mario.rossi@fake.it\",\n \"groups\": [\n {\n \"id\": 13197,\n \"name\": \"Friends\"\n },\n {\n \"id\": 1947,\n \"name\": \"Business\"\n }\n ],\n \"customFields\": [\n {\n \"fieldKey\": \"f_indirizzo\",\n \"fieldName\": \"Indirizzo\",\n \"fieldValue\": \"via roma 1\"\n },\n {\n \"fieldKey\": \"f_cap\",\n \"fieldName\": \"CAP\",\n \"fieldValue\": \"30000\"\n }\n ]\n}"}],"_postman_id":"9a20e9c4-a9cd-45b7-9ef1-e698f19fe76b"},{"name":"New Contact","id":"2d897f51-38ae-4780-8529-471f1c788d69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"customFieldUniqueKey","value":"msisdn","description":"[String] (Required)
\nIt is the key that is used to determine which field uniquely identifies the contact. If not specified it is the telephone number (msisdn).
Possible values: msisdn, email, name, lastname, f_*
[String] (Optional)
\nContact's mobile number.
\nThe mobile number must include the international prefix e.g. 393480000000
\n","type":"text"},{"key":"name","value":"Mario","description":"[String] (Required)
\nContact name (max 20 characters)
\n","type":"text"},{"key":"lastname","value":"Rossi","description":"[String] (Optional)
\nContact surname (max 20 characters)
\n","type":"text","disabled":true},{"key":"email","value":"mariorossi@fake.it","description":"[String] (Optional)
\nEmail address
\n","type":"text","disabled":true},{"key":"groupsId","value":"0","description":"[Number] (Optional)
\nInternal ID of the contact list in which to insert the contact.
\nYou can specify multiple lists by separating them with the comma character \",\".
\nFor example:
\n1245 or 1245.3432
[String] (Optional)
\nKey/value of the custom field you want to populate
\nThe list of available keys, to be used as parameter name, can be retrieved with the call List of Custom Fields
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/phonebook/contact","description":"Adds a contact to the address book
\n\n\nThe \"Content-Type\" for POST requests must be \"application/x-www-form-urlencoded\"
\n
See the call contact detail
\n","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}},"urlObject":{"path":["rest","api","phonebook","contact"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"82d0a0f3-42fe-4473-9b50-de906ea9a70a","name":"Nuovo Contatto","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"customFieldUniqueKey","value":"msisdn","description":"[String] *(Obbligatorio)*\n\nE' la chiave che serve a determinare quale campo identifica univocamente il contatto. Se non specificato è il numero di telefono (`msisdn`).\n\nPossbili valori: `msisdn`, `email`, `name`, `lastname`, `f_*`","type":"text"},{"key":"msisdn","value":"393480000000","description":"[String] *(Opzionale)*\n\nNumero di cellulare del contatto.\n\nIl numero di cellulare deve essere comprensivo del prefisso internazionale es. **393480000000**","type":"text"},{"key":"name","value":"Mario","description":"[String] *(Obbligatorio)*\n\nNome del contatto (**max 20 caratteri**)","type":"text"},{"key":"lastname","value":"Rossi","description":"[String] *(Opzionale)*\n\nCognome del contatto (**max 20 caratteri**)","type":"text","disabled":true},{"key":"email","value":"mariorossi@fake.it","description":"[String] *(Opzionale)*\n\nIndirizzo email","type":"text","disabled":true},{"key":"groupsId","value":"0","description":"[Number] *(Opzionale)*\n\nId inteno della lista contatti in cui inserire il contatto.\n\nÈ possibile specificare più liste separandole con il carattere virgola \"**,**\".\n\nAd esempio:\n\n**`1245`** oppure **`1245,3432`**","type":"text","disabled":true},{"key":"${fieldKey}","value":"","description":"[String] *(Opzionale)*\n\nChiave/valore del campo pesonalizzato che si vuole popolare\n\nL'elenco delle chiavi disponibili, da usare come **nome parametro**, può essere recuperato con la chiamata [Lista Campi Personalizzati](#dettaglio-lista-campi-personalizzati)","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/phonebook/contact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": 123456789,\n \"msisdn\": \"393480000000\",\n \"name\": \"Mario\",\n \"lastname\": \"Rossi\",\n \"customFields\": [\n {\n \"fieldKey\": \"f_indirizzo\",\n \"fieldName\": \"Indirizzo\",\n \"fieldValue\": \"via roma 1\"\n }\n ]\n}"}],"_postman_id":"2d897f51-38ae-4780-8529-471f1c788d69"},{"name":"Upload Bulk Contacts","id":"a41983a9-5efa-4b92-ba97-9c2e8dae820c","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/home/plolrt/Desktop/TMP/esempio_rubrica.csv"}]},"url":"{{BaseUrl}}/rest/api/phonebook/contact/addContactBulk","description":"Mass loading of contacts
\n\n\nThe \"Content-Type\" for this POST request must be \"multipart/form-data\"
\n
In case of massive upload, it shows the progress.
\n[String] (Optional §note)
\nSee New Contact
\n","type":"text","disabled":true},{"key":"msisdn","value":"393480000000","description":"[String] (Optional §note)
\nSee New Contact
\n","type":"text"},{"key":"name","value":"Mario","description":"[String] (Optional §note)
\nSee New Contact
\n","type":"text"},{"key":"lastname","value":"Rossi","description":"[String] (Optional §note)
\nSee New Contact
\n","type":"text","disabled":true},{"key":"email","value":"mariorossi@fake.it","description":"[String] (Optional §note)
\nSee New Contact
\n","type":"text","disabled":true},{"key":"groupsId","value":"0","description":"[Number] (Optional §note)
\nSee New Contact
\n","type":"text","disabled":true},{"key":"${fieldKey}","value":"","description":"[String] (Optional §note)
\nSee New Contact
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/phonebook/contact/:contactId","description":"Edit a contact already present in the address book.
\n\n\nThe \"Content-Type\" for POST requests must be \"application/x-www-form-urlencoded\"
\n
It is mandatory to complete at least one parameter in the body of the call.
\n","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}},"urlObject":{"path":["rest","api","phonebook","contact",":contactId"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"[Number] (Required)
\nUnique contact identifier
\n","type":"text/plain"},"type":"any","value":"12345678","key":"contactId"}]}},"response":[{"id":"6f10222a-3117-4856-a715-b73e08190534","name":"Aggiorna Contatto","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"customFieldUniqueKey","value":"msisdn","description":"[String] *(Opzionale)*\n\nVedi [Nuovo Contatto](#descrizione-nuovo-contatto)","type":"text","disabled":true},{"key":"msisdn","value":"393480000000","description":"[String] *(Opzionale)*\n\nVedi [Nuovo Contatto](#descrizione-nuovo-contatto)","type":"text"},{"key":"name","value":"Mario","description":"[String] *(Opzionale)*\n\nVedi [Nuovo Contatto](#descrizione-nuovo-contatto)","type":"text"},{"key":"lastname","value":"Rossi","description":"[String] *(Opzionale)*\n\nVedi [Nuovo Contatto](#descrizione-nuovo-contatto)","type":"text","disabled":true},{"key":"email","value":"mariorossi@fake.it","description":"[String] *(Opzionale)*\n\nVedi [Nuovo Contatto](#descrizione-nuovo-contatto)","type":"text","disabled":true},{"key":"groupsId","value":"0","description":"[Number] *(Opzionale)*\n\nVedi [Nuovo Contatto](#descrizione-nuovo-contatto)","type":"text","disabled":true},{"key":"${fieldKey}","value":"","description":"[String] *(Opzionale)*\n\nVedi [Nuovo Contatto](#descrizione-nuovo-contatto)","type":"text","disabled":true}]},"url":{"raw":"{{BaseUrl}}/rest/api/phonebook/contact/:contactId","host":["{{BaseUrl}}"],"path":["rest","api","phonebook","contact",":contactId"],"variable":[{"key":"contactId","value":"12345678","description":"[Number] *(Obbligatorio)*\n\nIdentificativo univoco del contatto"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 11 May 2021 10:37:01 GMT"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e86e01d3-6315-4107-8682-bff362bcab12"},{"name":"Delete Contact","id":"f641342c-c877-4341-bd8a-b7289abc357a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{BaseUrl}}/rest/api/phonebook/contact/:contactId","description":"Delete a contact in the address book
\n[Number] (Required)
\nUnique contact identifier
\n","type":"text/plain"},"type":"any","value":"12345678","key":"contactId"}]}},"response":[{"id":"74f18d3c-e216-4742-ae24-da1d1e2b45df","name":"Elimina Contatto","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":{"raw":"{{BaseUrl}}/rest/api/phonebook/contact/:contactId","host":["{{BaseUrl}}"],"path":["rest","api","phonebook","contact",":contactId"],"variable":[{"key":"contactId","value":"12345678","description":"[Number] *(Obbligatorio)*\n\nIdentificativo univoco del contatto"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 11 May 2021 10:38:41 GMT"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f641342c-c877-4341-bd8a-b7289abc357a"},{"name":"Add Contact to List","id":"a1570ef0-4e5b-4f65-bfa1-082d37514e9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"groupsId","value":"100321","description":"[Number] (Required)
\nInternal ID of the group to which to assign the contact.
\nMultiple groups can be specified by separating them with the comma character \",\".
\nFor example:
\n1245 or 1245.3432
Adds a contact already present in the address book to an existing contact list.
\n\n\nThe \"Content-Type\" for PUT requests must be \"application/x-www-form-urlencoded\"
\n
[Number] (Required)
\nUnique contact identifier
\n","type":"text/plain"},"type":"any","value":"12345678","key":"contactId"}]}},"response":[{"id":"d4c57baf-bbb4-417b-9332-777e88ed702e","name":"Aggiungi Contatto a Lista","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"groupsId","value":"100321","description":"[Number] *(Obbligatorio)*\n\nId inteno del gruppo ai quale assegnare il contatto.\n\nÈ possibile specificare **più gruppi** separandoli con il carattere virgola \"**,**\".\n\nAd esempio:\n**`1245`** oppure **`1245,3432`**","type":"text"}]},"url":{"raw":"{{BaseUrl}}/rest/api/phonebook/contact/:contactId/groups/add","host":["{{BaseUrl}}"],"path":["rest","api","phonebook","contact",":contactId","groups","add"],"variable":[{"key":"contactId","value":"12345678","description":"[Number] *(Obbligatorio)*\n\nIdentificativo univoco del contatto"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 11 May 2021 10:40:10 GMT"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a1570ef0-4e5b-4f65-bfa1-082d37514e9d"},{"name":"Remove Contact from List","id":"508d3b98-8f6b-436f-b517-992fbd586903","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"groupsId","value":"1234567","description":"[Number] (Required)
\nInternal ID of the group from which you want to remove the contact.
\nMultiple groups can be specified by separating them with the comma character \",\".
\nFor example:
\n1245 or 1245.3432
Removes a contact already present in the address book from an existing contact list.
\n\n\nThe \"Content-Type\" for PUT requests must be \"application/x-www-form-urlencoded\"
\n
[Number] (Required)
\nUnique contact identifier
\n","type":"text/plain"},"type":"any","value":"12345678","key":"contactId"}]}},"response":[{"id":"fe967487-8e65-4641-ade6-f6430fb9e8cd","name":"Rimuovi Contatto da Lista","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"groupsId","value":"100321","description":"[Number] *(Obbligatorio)*\n\nId inteno del gruppo dal quale si vuole rimuovere il contatto.\n\nÈ possibile specificare **più gruppi** separandoli con il carattere virgola \"**,**\".\n\nAd esempio:\n**`1245`** oppure **`1245,3432`**","type":"text"}]},"url":{"raw":"{{BaseUrl}}/rest/api/phonebook/contact/:contactId/groups/remove","host":["{{BaseUrl}}"],"path":["rest","api","phonebook","contact",":contactId","groups","remove"],"variable":[{"key":"contactId","value":"12345678","description":"[Number] *(Obbligatorio)*\n\nIdentificativo univoco del contatto"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 11 May 2021 10:41:11 GMT"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"508d3b98-8f6b-436f-b517-992fbd586903"}],"id":"d2d971c3-7a71-47e0-b314-fe4f3c3e3539","_postman_id":"d2d971c3-7a71-47e0-b314-fe4f3c3e3539","description":"","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}}},{"name":"Contacts Lists","item":[{"name":"Contact Lists","id":"2eeffe40-4b0c-40bc-a981-b037acff660b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/phonebook/group/list","description":"The list of all contact lists present in the address book returns.
\nThe contact list detail returns
\n[Number] (Required)
\nInternal ID of the contact list
\n","type":"text/plain"},"type":"any","value":"","key":"listId"}]}},"response":[{"id":"2fe6c1c7-cf7d-441f-90ab-dac8a9301a63","name":"Dettagliio Lista","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/phonebook/group/:listId","host":["{{BaseUrl}}"],"path":["rest","api","phonebook","group",":listId"],"variable":[{"key":"listId","value":"","description":"[Number] *(Obbligatorio)*\n\nId interno della lista contatti"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": 3838,\n \"name\": \"Friends\",\n \"contactCount\": 1\n}"}],"_postman_id":"44c3f2e5-1448-4703-8a9b-c0e944ab3f47"},{"name":"Contacts in a List","id":"47e11a7c-5a75-4a56-a58d-c5697367df83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/phonebook/group/:listId/contacts","description":"Returns all contacts present in a list.
\n[Number] (Optional)
\nPosition of the first result that will be returned. See pagination.
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"[Number] (Optional)
\nMaximum number of results that will be returned. See pagination.
\n","type":"text/plain"},"key":"limit","value":""}],"variable":[{"description":{"content":"[Number] (Required)
\nInternal ID of the contact list
\n","type":"text/plain"},"type":"any","value":"","key":"listId"}]}},"response":[{"id":"9abfe3cf-b144-400c-a926-a70f5e27ab01","name":"Contatti in una Lista","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/phonebook/group/:listId/contacts","host":["{{BaseUrl}}"],"path":["rest","api","phonebook","group",":listId","contacts"],"query":[{"key":"offset","value":null,"description":"[Number] *(Opzionale)*\n\nPosizione del primo risultato che verrà restituito. Vedi [paginazione](#gestire-la-risposta).","disabled":true},{"key":"limit","value":null,"description":"[Number] *(Opzionale)*\n\nNumero massimo di risultati che verranno restituiti. Vedi [paginazione](#gestire-la-risposta).","disabled":true}],"variable":[{"key":"listId","value":"","description":"[Number] *(Obbligatorio)*\n\nId interno della lista contatti"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"limit\": 20\n },\n \"contacts\": [\n {\n \"msisdn\": \"393480000000\",\n \"name\": \"Mario\",\n \"lastname\": \"Rossi\",\n \"address\": \"via Italia 1\",\n \"city\": \"Roma\",\n \"postCode\": 144,\n \"province\": \"RM\",\n \"country\": \"IT\",\n \"email\": \"mario.rossi@fake.it\",\n \"homePhoneNumber\": \"\",\n \"groups\": [\n {\n \"id\": 13197,\n \"name\": \"Amici\"\n },\n {\n \"id\": 1947,\n \"name\": \"Lavoro\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"47e11a7c-5a75-4a56-a58d-c5697367df83"},{"name":"New List","id":"bab70ed9-ace2-4948-9711-8426b61f0f36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"Nuova Lista","description":"[String] (Required)
\nName of the new contact list
\n","type":"text"}]},"url":"{{BaseUrl}}/rest/api/phonebook/group","description":"Adds a contact list to your address book
\n\n\nThe \"Content-Type\" for POST requests must be \"application/x-www-form-urlencoded\"
\n
[String] *(Required)
\nNew name to assign to the contact list.
\n","type":"text"}]},"url":"{{BaseUrl}}/rest/api/phonebook/group/:listId","description":"Edit an existing contact list
\n\n\nThe \"Content-Type\" for PUT requests must be \"application/x-www-form-urlencoded\"
\n
[Number] (Required)
\nInternal ID of the contact list
\n","type":"text/plain"},"type":"any","value":"100321","key":"listId"}]}},"response":[{"id":"787725a3-8554-451b-9e94-7045c1a8eed3","name":"Aggiorna Lista","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"New Name","description":"[String] *(Obbligatorio)\n\nNuovo nome da assegnare alla lista contatti.","type":"text"}]},"url":{"raw":"{{BaseUrl}}/rest/api/phonebook/group/:listId","host":["{{BaseUrl}}"],"path":["rest","api","phonebook","group",":listId"],"variable":[{"key":"listId","value":"100321","description":"[Number] *(Obbligatorio)*\n\nId interno della lista contatti"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 11 May 2021 10:45:19 GMT"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"08e9e2af-6e38-46a4-a40b-24cee8b2056e"},{"name":"Delete List","id":"39aa1bef-79aa-4dd9-b4f1-17ed0eec811a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{BaseUrl}}/rest/api/phonebook/group/:listId?delete_contacts=true","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}},"urlObject":{"path":["rest","api","phonebook","group",":listId"],"host":["{{BaseUrl}}"],"query":[{"description":{"content":"[Boolean] (Optional)
\nIf set to true, all contacts belonging to this contact list will be permanently deleted.
Default: false
\n","type":"text/plain"},"key":"delete_contacts","value":"true"}],"variable":[{"description":{"content":"[Number] *(Required)
\nNew name to assign to the contact list.
\n","type":"text/plain"},"type":"any","value":"100321","key":"listId"}]}},"response":[{"id":"4aae5074-d671-4ff8-bf39-5ae9fd7f849a","name":"Elimina Lista","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":{"raw":"{{BaseUrl}}/rest/api/phonebook/group/:listId?delete_contacts=true","host":["{{BaseUrl}}"],"path":["rest","api","phonebook","group",":listId"],"query":[{"key":"delete_contacts","value":"true","description":"[Boolean] *(Opzionale)*\n\nSe valorizzato a `true` verranno _eliminati definitivamente_ tutti i contatti appartenenti a questa lista contatti.\n\nDefault: **false**"}],"variable":[{"key":"listId","value":"100321","description":"[Number] *(Obbligatorio)\n\nNuovo nome da assegnare alla lista contatti."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 11 May 2021 10:46:31 GMT"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"39aa1bef-79aa-4dd9-b4f1-17ed0eec811a"}],"id":"2b63734f-3501-4d6a-8c7f-683c916cd33d","_postman_id":"2b63734f-3501-4d6a-8c7f-683c916cd33d","description":"","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}}},{"name":"Custom Fields","item":[{"name":"Fields List","id":"bc871101-2cb4-42db-bc81-c7a19f99b608","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/phonebook/customfields/list","description":"List of user-defined custom fields.
\nTo create new custom fields, refer to the guide \"Customize contacts\"
\nReturns the list of published Privacy Information.
\nReturns the list of published GDPR consents.
\nReturn the current status of the contact's accepted/denied GDPR consents.
\n[Number] (Required)
\nID of the contact whose GDPR current consents you want to retrieve
\n","type":"text/plain"},"type":"any","value":"","key":"contactId"}]}},"response":[{"id":"d3f045c0-591c-44f6-85af-b5b4bbc98bdb","name":"Storico Consensi GDPR Contatto","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/gdpr/history/contact/:contactId","host":["{{BaseUrl}}"],"path":["rest","api","gdpr","history","contact",":contactId"],"variable":[{"key":"contactId","value":"","description":"[Number] *(Obbligatorio)*\n\nId del contatto di cui si desidera ricevere lo storico dei consensi GDPR."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"gdprContactInfo\": [\n {\n \"consent_type\": \"PRIVACY\",\n \"consent_id\": 4601,\n \"granted\": true,\n \"insert_date\": \"2020-10-13T08:15:21+0200\",\n \"ip\": \"0:0:0:0:0:0:0:1\",\n \"source\": \"api\",\n \"consent_title\": \"Privacy URL\"\n },\n {\n \"consent_type\": \"CONSENT\",\n \"consent_id\": 7687,\n \"granted\": false,\n \"insert_date\": \"2020-10-12T16:25:53+0200\",\n \"ip\": \"0:0:0:0:0:0:0:1\",\n \"source\": \"api\",\n \"consent_title\": \"Do il consenso per le comunicazioni a terzi\"\n }\n ]\n}"}],"_postman_id":"effae315-c4b7-4f57-8b35-34c9a1ec6420"},{"name":"History Contact's GDPR Consents","id":"568d9dc6-136f-4186-a78b-eb4875073a23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/gdpr/history/contact/:contactId","description":"Return the history of contact's GDPR accepted/denied consents.
\n[Number] (Required)
\nID of the contact whose GDPR consents history you want to retrieve.
\n","type":"text/plain"},"type":"any","value":"","key":"contactId"}]}},"response":[{"id":"16ec8a36-f2d5-49e3-9b9f-ba3b27bf6487","name":"Storico Consensi GDPR Contatto","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/gdpr/history/contact/:contactId","host":["{{BaseUrl}}"],"path":["rest","api","gdpr","history","contact",":contactId"],"variable":[{"key":"contactId","value":"","description":"[Number] *(Obbligatorio)*\n\nId del contatto di cui si desidera ricevere lo storico dei consensi GDPR."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"gdprContactInfo\": [\n {\n \"consent_type\": \"PRIVACY\",\n \"consent_id\": 4601,\n \"granted\": true,\n \"insert_date\": \"2020-10-13T08:15:21+0200\",\n \"ip\": \"0:0:0:0:0:0:0:1\",\n \"source\": \"api\",\n \"consent_title\": \"Privacy URL\"\n },\n {\n \"consent_type\": \"PRIVACY\",\n \"consent_id\": 4326,\n \"granted\": false,\n \"insert_date\": \"2020-10-13T08:08:10+0200\",\n \"ip\": \"0:0:0:0:0:0:0:1\",\n \"source\": \"api\",\n \"consent_title\": \"Privacy\"\n },\n {\n \"consent_type\": \"CONSENT\",\n \"consent_id\": 7687,\n \"granted\": false,\n \"insert_date\": \"2020-10-12T16:25:53+0200\",\n \"ip\": \"0:0:0:0:0:0:0:1\",\n \"source\": \"api\",\n \"consent_title\": \"Do il consenso per le comunicazioni a terzi\"\n }\n ]\n}"}],"_postman_id":"568d9dc6-136f-4186-a78b-eb4875073a23"},{"name":"Add GDPR Consent","id":"944ea6f8-932b-4cc6-973b-bc68eeda9fbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"1234","description":"[Number] (Required)
\nSpecify the ID of the consent or privacy to add to the contact
\n","type":"text"},{"key":"insert_date","value":"","description":"[String] (Optional)
\nDate when the contact gave the consent (format yyyy-MM-ddTHH:mm:ssZ) .\nIf not set, the current date is used
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/gdpr/contact/add/:type/:contactId","description":"Add GDPR consent to contact.
\n\n\nThe \"Content-Type\" for POST requests must be \"application/x-www-form-urlencoded\"
\n
[String] (Required)
\nSpecify the type of consent that you want to add\nPossible values: privacy, consent
[Number] (Required)
\nID of the contact to which you want to add the GDPR consent
\n","type":"text/plain"},"type":"any","value":"12345678","key":"contactId"}]}},"response":[{"id":"e367305d-2261-4de5-82e7-5af9754d4e8a","name":"Aggiunta Consenso GDPR","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"1234","description":"[Number] *(Obbligatorio)*\n\nSpecificare l'ID del consenso o privacy da aggiungere al contatto.","type":"text"},{"key":"insert_date","value":"","description":"[String] *(Opzionale)*\n\nData in cui il contatto ha dato il consenso (in formato **yyyy-MM-ddTHH:mm:ssZ**) .\nSe questo campo non viene valorizzato viene usata la data attuale.","type":"text","disabled":true}]},"url":{"raw":"{{BaseUrl}}/rest/api/gdpr/contact/add/:type/:contactId","host":["{{BaseUrl}}"],"path":["rest","api","gdpr","contact","add",":type",":contactId"],"variable":[{"key":"type","value":"privacy","description":"[String] *(Obbligatorio)*\n\nSpecificare il tipo di consenso che si vuole aggiungere\nPossbili valori: `privacy`, `consent`"},{"key":"contactId","value":"12345678","description":"[Number] *(Obbligatorio)*\n\nId del contatto a cui si desidera aggiungere il consenso GDPR."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"gdprContactInfo\": [\n {\n \"consent_type\": \"PRIVACY\",\n \"consent_id\": 38413,\n \"granted\": true,\n \"insert_date\": \"2021-04-20T16:34:05+0200\",\n \"ip\": \"79.6.173.152\",\n \"source\": \"api\",\n \"consent_title\": \"v3\"\n },\n {\n \"consent_type\": \"PRIVACY\",\n \"consent_id\": 4875,\n \"granted\": true,\n \"insert_date\": \"2021-03-22T15:25:14+0100\",\n \"ip\": \"79.6.173.152\",\n \"source\": \"form\",\n \"consent_title\": \"v1\"\n },\n {\n \"consent_type\": \"CONSENT\",\n \"consent_id\": 4875,\n \"granted\": true,\n \"insert_date\": \"2020-12-10T09:05:57+0100\",\n \"ip\": \"5.157.101.77\",\n \"source\": \"form\",\n \"consent_title\": \"Do il consenso a ricevere comunicazioni, sconti e promozioni tramite SMS e email\"\n }\n ]\n}"}],"_postman_id":"944ea6f8-932b-4cc6-973b-bc68eeda9fbe"},{"name":"Remove GDPR Consent","id":"cde91bbe-aea8-469d-8d90-f58c64885ce8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"","description":"[Number] (Required)
\nSpecify the ID of the consent or privacy to remove from the contact
\n","type":"text"}]},"url":"{{BaseUrl}}/rest/api/gdpr/contact/remove/:type/:contactId","description":"Remove a GDPR consent from a contact.
\n[String] (Required)
\nSpecify the type of consent that you want to remove.\nPossible values: privacy, consent
[Number] (Required)
\nID of the contact from which you want to remove the GDPR consent
\n","type":"text/plain"},"type":"any","value":"","key":"contactId"}]}},"response":[{"id":"29a5ac7d-a021-4d31-929e-bd08d605cc74","name":"Rimozione Consenso GDPR","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"","description":"[Number] *(Obbligatorio)*\n\nSpecificare l'ID del consenso o privacy da rimuovere dal contatto.","type":"text"}]},"url":{"raw":"{{BaseUrl}}/rest/api/gdpr/contact/remove/:type/:contactId","host":["{{BaseUrl}}"],"path":["rest","api","gdpr","contact","remove",":type",":contactId"],"variable":[{"key":"type","value":"","description":"[String] *(Obbligatorio)*\n\nSpecificare il tipo di consenso che si vuole rimuovere\nPossbili valori: `privacy`, `consent`"},{"key":"contactId","value":"","description":"[Number] *(Obbligatorio)*\n\nId del contatto dal quale si vuole rimuovere il consenso GDPR."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"gdprContactInfo\": [\n {\n \"consent_type\": \"PRIVACY\",\n \"consent_id\": 38413,\n \"granted\": true,\n \"insert_date\": \"2021-04-20T16:34:05+0200\",\n \"ip\": \"79.6.173.152\",\n \"source\": \"api\",\n \"consent_title\": \"v3\"\n },\n {\n \"consent_type\": \"PRIVACY\",\n \"consent_id\": 4875,\n \"granted\": true,\n \"insert_date\": \"2021-03-22T15:25:14+0100\",\n \"ip\": \"79.6.173.152\",\n \"source\": \"form\",\n \"consent_title\": \"v1\"\n },\n {\n \"consent_type\": \"CONSENT\",\n \"consent_id\": 4875,\n \"granted\": true,\n \"insert_date\": \"2020-12-10T09:05:57+0100\",\n \"ip\": \"5.157.101.77\",\n \"source\": \"form\",\n \"consent_title\": \"Do il consenso a ricevere comunicazioni, sconti e promozioni tramite SMS e email\"\n }\n ]\n}"}],"_postman_id":"cde91bbe-aea8-469d-8d90-f58c64885ce8"}],"id":"d5207a58-b8c2-41de-a194-c84e33c314f9","_postman_id":"d5207a58-b8c2-41de-a194-c84e33c314f9","description":"","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}}},{"name":"User","item":[{"name":"Get user","id":"47462f6a-5431-49d1-bca4-da5a0511609c","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/user","description":"Returns the details and credit relating to your profile on Smshosting.
\n[String] (Required)
\nThe username must be alphanumeric string between 5 and50 characters long.
\nIt can also contain the following characters: . @ _ -
[String] (Required)
\nThe password must be alphanumeric string between 5 and20 characters long.
\n","type":"text"},{"key":"name","value":"Mario","description":"[String] (Required)
\nName of the account owner
\n","type":"text"},{"key":"lastname","value":"Rossi","description":"[String] (Required)
\nLastname of the account owner
\n","type":"text"},{"key":"email","value":"mariorossi@fakeaddress.it","description":"[String] (Required)
\nValid email address
\n","type":"text"},{"key":"companyType","value":"true","description":"[Boolean] (Optional)
\nSet to true if the account is linked to a company
\nPossible values [true|false]
[String] (Optional)
\nRequired if companyType=true
Legal business name
\n","type":"text","disabled":true},{"key":"address","value":"","description":"[String] (Optional)
\nAddress
\n","type":"text","disabled":true},{"key":"city","value":"","description":"[String] (Optional)
\nCity
\n","type":"text","disabled":true},{"key":"postcode","value":"","description":"[String] (Optional)\nPostcode
\n","type":"text","disabled":true},{"key":"province","value":"","description":"[String] (Optional)
\nProvince
\n","type":"text","disabled":true},{"key":"country","value":"","description":"[String] (Optional)
\nNation
\n","type":"text","disabled":true},{"key":"birthdate","value":"","description":"[String] (Optional)
\nDate of Birth in format yyyy-MM-dd'T'HH:mm:ssZ
\n","type":"text","disabled":true},{"key":"phone","value":"","description":"[String] (Optional)
\nPhone number
\n","type":"text","disabled":true},{"key":"msisdn","value":"","description":"[String] (Optional)
\nMobile phone number
\n","type":"text","disabled":true},{"key":"taxcode","value":"","description":"[String] (Optional)\nTax Code
\n","type":"text","disabled":true},{"key":"vatnumber","value":"","description":"[String] (Optional)
\nVAT Number
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/reseller/subuser","description":"Create a new sub-account
\n\n\nThe \"Content-Type\" for POST requests must be \"application/x-www-form-urlencoded\"
\n
See New sub-account
\n","type":"text"},{"key":"name","value":"Mario","description":"See New sub-account
\n","type":"text"},{"key":"lastname","value":"Rossi","description":"See New sub-account
\n","type":"text"},{"key":"email","value":"mariorossi@fakeaddress.it","description":"See New sub-account
\n","type":"text"},{"key":"companyType","value":"true","description":"See New sub-account
\n","type":"text","disabled":true},{"key":"businessname","value":"ACME COMPANY","description":"See New sub-account
\n","type":"text","disabled":true},{"key":"address","value":"","description":"See New sub-account
\n","type":"text","disabled":true},{"key":"city","value":"","description":"See New sub-account
\n","type":"text","disabled":true},{"key":"postcode","value":"","description":"See New sub-account
\n","type":"text","disabled":true},{"key":"province","value":"","description":"See New sub-account
\n","type":"text","disabled":true},{"key":"country","value":"","description":"See New sub-account
\n","type":"text","disabled":true},{"key":"birthdate","value":"","description":"See New sub-account
\n","type":"text","disabled":true},{"key":"phone","value":"","description":"See New sub-account
\n","type":"text","disabled":true},{"key":"msisdn","value":"","description":"See New sub-account
\n","type":"text","disabled":true},{"key":"taxcode","value":"","description":"See New sub-account
\n","type":"text","disabled":true},{"key":"vatnumber","value":"","description":"See New sub-account
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/reseller/subuser/:subuserId","description":"Update sub-account data.
\n\n\nThe \"Content-Type\" for this PUT request must be \"application/x-www-form-urlencoded\"
\n
See call new sub-account for the detail of the response.
\n","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}},"urlObject":{"path":["rest","api","reseller","subuser",":subuserId"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"[Number] (Required)
\nID of the sub-acount to edit
\n","type":"text/plain"},"type":"any","value":"","key":"subuserId"}]}},"response":[{"id":"61f75d47-7f49-440a-a564-d9a5c6011939","name":"Modifica Sub-Account","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"mariorossi","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text"},{"key":"name","value":"Mario","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text"},{"key":"lastname","value":"Rossi","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text"},{"key":"email","value":"mariorossi@fakeaddress.it","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text"},{"key":"companyType","value":"true","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"businessname","value":"ACME COMPANY","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"address","value":"","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"city","value":"","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"postcode","value":"","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"province","value":"","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"country","value":"","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"birthdate","value":"","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"phone","value":"","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"msisdn","value":"","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"taxcode","value":"","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true},{"key":"vatnumber","value":"","description":"Vedi [Nuovo sub-account](#descrizione-nuovo-sub-account)","type":"text","disabled":true}]},"url":{"raw":"{{BaseUrl}}/rest/api/reseller/subuser/:subuserId","host":["{{BaseUrl}}"],"path":["rest","api","reseller","subuser",":subuserId"],"variable":[{"key":"subuserId","value":"","description":"[Number] *(Obbligatorio)*\n\nIdentificativo del sub-account che si vuole modificare"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1\",\n \"name\": \"Mario\",\n \"lastname\": \"Rossi\",\n \"username\": \"mariorossi\",\n \"email\": \"mariorossi@fakeaddress.it\",\n \"address\": \"\",\n \"city\": \"\",\n \"postcode\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"msisdn\": \"\",\n \"sender\": \"ACMECOMPANY\",\n \"registrationDate\": \"2015-08-04T12:04:56+0200\",\n \"expirationDate\": \"2016-08-04T12:04:56+0200\",\n \"credit\": 0.6,\n \"italysms\": 5,\n \"senderAlias\": [],\n \"authKey\": \"0000\",\n \"authSecret\": \"0000\"\n}"}],"_postman_id":"36cab97f-8873-465e-a120-947f4913fd11"},{"name":"Remove Sub-Account","id":"dc54fed9-45ac-4119-9627-d7990ef51939","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{BaseUrl}}/rest/api/reseller/subuser/:accountId","description":"Permanently remove sub-account.
\n[Number] (Required)
\nid of the sub-account to remove
Returns the detail of a sub-account.
\nSee call new sub-account for the detail of the response.
\n","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}},"urlObject":{"path":["rest","api","reseller","subuser",":accountId"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"[Number] (Required)
\nid of sub-account whose detail you want to retrive.
Search sub-account based on the parameters provided.
\nSee call new sub-account for the detail of the response.
\n","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}},"urlObject":{"path":["rest","api","reseller","subuser","search"],"host":["{{BaseUrl}}"],"query":[{"description":{"content":"[String] (Optional)
\nSearch a sub-account by username, name and last name
\n","type":"text/plain"},"key":"query","value":"mariorossi"},{"disabled":true,"description":{"content":"[String] (Optional)
\nCreation date (from) in format yyyy-MM-ddTHH:mm:ssZ
\n","type":"text/plain"},"key":"fromDate","value":"2017-03-24T00:00:00+0100"},{"disabled":true,"description":{"content":"[String] (Optional)\nCreation date (to) in format yyyy-MM-ddTHH:mm:ssZ
\n","type":"text/plain"},"key":"toDate","value":"2020-07-19T00:00:00+0100"},{"disabled":true,"description":{"content":"[Number] (Optional)
\nPosition of the first result to be returned
\nSee pagination
\nDefault: 0
\n","type":"text/plain"},"key":"offset","value":"20"},{"disabled":true,"description":{"content":"[Number] (Optional)
\nNumber of results to be returned
\nSee pagination
\nDefault: 20
\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"4f718164-c08d-46ef-a085-a270279894be","name":"Cerca Sub-Account","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/reseller/subuser/search?query=mariorossi","host":["{{BaseUrl}}"],"path":["rest","api","reseller","subuser","search"],"query":[{"key":"query","value":"mariorossi","description":"[String] *(Opzionale)*\n\nRicerca un sub-account per username, nome e cognome"},{"key":"fromDate","value":"2017-03-24T00:00:00+0100","description":"[String] *(Opzionale)*\n\nData di creazione in formato **yyyy-MM-ddTHH:mm:ssZ**","disabled":true},{"key":"toDate","value":"2020-07-19T00:00:00+0100","description":"[String] *(Opzionale)*\nData di creazione in formato **yyyy-MM-ddTHH:mm:ssZ**","disabled":true},{"key":"offset","value":"20","description":"[Number] *(Opzionale)*\n\nPosizione del primo risultato che verrà restituito\n\nVedi [dettagli paginazione](#gestire-la-risposta)\n\nDefault: **0**","disabled":true},{"key":"limit","value":"10","description":"[Number] *(Opzionale)*\n\nNumero di risultati che verranno restituiti\n\nVedi [dettagli paginazione](#gestire-la-risposta)\n\nDefault: **20**","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"limit\": 20\n },\n \"subUserList\": [\n {\n \"id\": \"1\",\n \"name\": \"Mario\",\n \"lastname\": \"Rossi\",\n \"username\": \"mariorossi\",\n \"email\": \"mariorossi@fakeaddress.it\",\n \"address\": \"\",\n \"city\": \"\",\n \"postcode\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"msisdn\": \"\",\n \"sender\": \"ACMECOMPANY\",\n \"registrationDate\": \"2015-08-04T12:04:56+0200\",\n \"expirationDate\": \"2016-08-04T12:04:56+0200\",\n \"credit\": 0.6,\n \"italysms\": 5,\n \"senderAlias\": [],\n \"authKey\": \"0000\",\n \"authSecret\": \"0000\"\n }\n ]\n}"}],"_postman_id":"d1137f56-11bf-4cc6-bf90-e9ee2064dca8"},{"name":"Create Order","id":"6d6bf409-a4cd-4b31-9032-f8b442131885","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"packId","value":"1234","description":"[Number] (Optional: set at least one of packId ornewPackSmsItaly)
\nID of the SMS package to activate. Use the endpoint Packages List to get the ID
\n","type":"text"},{"key":"newPackSmsItaly","value":"14","description":"[Number] (Optional: set at least one of packId e newPackSmsItaly)
\nNumber of SMSs to be assigned: a new package will be created.
\n","type":"text","disabled":true},{"key":"newPackUnitCostItaly","value":"","description":"[Decimal] (Optional)
\nCost single SMS used in the creation of the new package. It's used in combination with the parameter newPackSmsItaly
\nDefault: 0.07 €
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/reseller/subuser/:accountId/order","description":"Create and enable an order for a sub-account.
\nIt's possible to assign an existing SMS package or, alternatively, create a new package by simply specifying the number of SMS to be assigned.
\n\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
[Number] (Required)
\nid of the sub-account for which you want to create an order
Return the list of SMS packages for sale.
\nReset the credit of a sub-account and riassign it to the reseller.
\n\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
[Number] (Required)
\nid of the sub-account whose credit you want to reset
Queste API ti permettono di gestire il tuo piano rivenditore e i tuoi subaccount.
\n\n\n","_postman_id":"31b54c95-4e2d-4295-9590-0130cee0aa75","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}}},{"name":"Send RCS","item":[{"name":"Quote Send RCS","id":"ad955929-b299-4e74-8cbb-b6cc93a89cf8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{auth_secret}}","username":"{{auth_key}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"to","value":"393400000000","description":"Per poter utilizzare le Reseller API è necessario avere un account rivenditore e richiedere la specifica abilitazione.\nRichiedila qui
\n
[String] (Optional specify at least one of to and group)\nThe recipient of the message.
\nIt must be a mobile number including the international prefix.
\nIt is possible to specify multiple telephone numbers (max 1000 numbers) by separating them with the comma character \",\".
\nFor example:
\n393481234567 or 393481234567,393481234568,393481234568
Alternatively, the parameter can be enhanced with a JSON array containing the objects that describe the recipient.
\nEach object must necessarily have the msisdn property valued.
\nThe other properties of these objects can be used to parameterize the message text (see the text field).
\nFor example:
\n[{msisdn:'393481234567'},{msisdn:'393481234568'},{msisdn:'393481234568'}]
\n","type":"text"},{"key":"group","value":"gruppo","description":"[String] (Optional specify at least one of to and group)\nId of the group in the address book to send to
\nYou can specify multiple address book groups by separating them with the comma \",\" character.
\nFor example, if the address book contains the Friends (id=1) and School (id=2) groups, it will be possible to indicate:
1 or 1.2
\n","type":"text","disabled":true},{"key":"agentId","value":"id agent","description":"[String] (Required)
\nId of the Agent that you want to use to send the RCS message
\n","type":"text"},{"key":"contentMessage","value":"{\"contentMessage\":{\"text\":\"Hi there!\",\"suggestions\":[]}}","description":"[String] (Required)
\nString representing the JSON containing the RCS message.
\n\n","type":"text"},{"key":"fallbackSms","value":"true","description":"[boolean] (Required)
\nTrue if you want to enable SMS fallback
\n","type":"text"},{"key":"fromSms","value":"mittente SMS","description":"[String] (Optional)
\nThe sender of the fallback SMS.
\nIt can be a validated telephone number or an alphanumeric string of up to 11 characters. If not specified, the default sender of your profile is used.
\nTo use an alphanumeric sender, registration is mandatory; this procedure can be carried out from our web panel or via API.
\nUnverified senders will be replaced with a random numeric sender.
\n","type":"text"},{"key":"textSms","value":"testo SMS ","description":"[String] (Optional)
\nRequired if fallbackSms is true.
\nText of the fallback SMS message.
\nIf the message exceeds 160 characters, [multiple concatenated text messages] are sent (https://help.smshosting.it/it/nio-sms/caratteriche-sms/lunghezza-testo-e-codifiche-supportate) up to a maximum of 7.
\nSome extended characters occupy 2 characters. In the case of SMS that exceed the standard length of 160 characters only due to some extended characters, these will be replaced with simple characters keeping the cost at 1 SMS instead of 2.
\nThe text may contain placeholders which will be replaced during sending by the values associated with the respective recipient.
\nThe placeholder must be specified with the syntax ${property name}
\nIf the text contains placeholders the to field must be populated with a JSON array and each object in the array must contain the property indicated in the placeholder.
\nFor example:\nto=[{msisdn:'393481234567',name:'Mario Rossi'},{msisdn:'393481234568',name:'Luigi Bianchi'}]\ntext=Send test sms to ${name}
\n","type":"text"},{"key":"encoding","value":"7BIT","description":"[String] (Optional)
\nThe encoding to use for the message text.
\nPossible values are:
\n7BIT - standard encoding for GSM messages. The maximum length for a single text message is 160 characters.
\nUCS2 - 8-bit encoding for sending GSM messages with non-ASCII content. The maximum length for a single text message is 70 characters.
\nAUTO - The encoding to be used is automatically identified based on the content of the text field.
\nDefault : 7BIT
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/rcs/message/estimate","description":"Calculation of the credit needed for an RCS shipment (single or multiple shipment).
\n\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
[String] (Optional, set at least one of to and group)\nThe recipient of the message.
\nIt must be a mobile number including the international prefix.
\nIt is possible to specify multiple telephone numbers (max 10 numbers) by separating them with the comma character \",\".\nIf there are more than 10 recipients, we suggest to use the send bulk request.
\nFor example:\n393481234567 or 393481234567,393481234568,393481234568
Alternatively, the parameter can be enhanced with a JSON array containing the objects that describe the recipient.\nEach object must necessarily have the msisdn property valued.\nThe other properties of these objects can be used to parameterize the message text (see the text field).
\nFor example:\n[{msisdn:'393481234567'},{msisdn:'393481234568'},{msisdn:'393481234568'}]
\n","type":"text"},{"key":"group","value":"gruppo","description":"[String] (Optional, set at least one of to and group)
\nId of the group in the phonebook to send to
\nIt is possible to specify multiple groups from the phonebook by separating them with a comma \",\".
\nFor example, if in the phonebook there is the group \"friends\" (id=1) and \"school\" (id=2), you can use:
1 or 1,2
\n","type":"text","disabled":true},{"key":"date","value":"2017-03-24T00:00:00+0100","description":"[String] (Optional)
\nDate (format yyyy-MM-ddTHH:mm:ssZ) when the message will be sent. If not set, the message will be sent immediatly.\nThe character Z specifies the timezone according to RFC 822 4-digit format (In Italy, the timezone offset is +0200 during daylight saving time (summer) and +0100 during standard time (winter).).
\nFor example:\n2014-12-25T08:00:00+0200 means 25/12/2014 at 08:00:00 GMT +2
\n","type":"text","disabled":true},{"key":"agentId","value":"id agent","description":"[String] (Required)
\nID of the agent to use to send the RCS message
\n","type":"text"},{"key":"contentMessage","value":"{\"contentMessage\":{\"text\":\"Hi there!\",\"suggestions\":[]}}","description":"[String] (Optional, set at least one of contentMessage and templateId)
\nString representing the JSON containing the RCS message.\nRefer to https://developers.google.com/business-communications/rcs-business-messaging/reference/rest/v1/phones.agentMessages
\n","type":"text"},{"key":"templateId","value":"id template","description":"[String] (Optional, set at least one of contentMessage and templateId)\nID of the template to use.
\n","type":"text","disabled":true},{"key":"fallbackSms","value":"true","description":"[boolean] (Required)
\nTrue if you want to enable SMS fallback
\n","type":"text"},{"key":"fromSms","value":"mittente SMS","description":"[String] (Optional)
\nThe sender of the fallback SMS.
\nIt can be a validated telephone number or an alphanumeric string of up to 11 characters. If not specified, the default sender of your profile is used.
\nTo use an alphanumeric sender, registration is mandatory; this procedure can be carried out from our web panel or via API.
\nUnverified senders will be replaced with a random numeric sender.
\n","type":"text"},{"key":"textSms","value":"Hi there!","description":"[String] (Optional)
\nRequired if fallbackSms is true.
\nText of the fallback SMS message.
\nIf the message exceeds 160 characters, [multiple concatenated text messages] are sent (https://help.smshosting.it/it/nio-sms/caratteriche-sms/lunghezza-testo-e-codifiche-supportate) up to a maximum of 7.
\nSome extended characters occupy 2 characters. In the case of SMS that exceed the standard length of 160 characters only due to some extended characters, these will be replaced with simple characters keeping the cost at 1 SMS instead of 2.
\nThe text may contain placeholders which will be replaced during sending by the values associated with the respective recipient.\nThe placeholder must be specified with the syntax ${property name}\nIf the text contains placeholders the to field must be populated with a JSON array and each object in the array must contain the property indicated in the placeholder.
\nFor example:\nto=[{msisdn:'393481234567',name:'Mario Rossi'},{msisdn:'393481234568',name:'Luigi Bianchi'}]\ntext=Send test sms to ${name}
\n","type":"text"},{"key":"transactionId","value":"123456789ABCDE","description":"[String] (Optional)
\nCustom ID for the send operation.\nIt allows you to assign the same ID to all messages sent with the same call in order to use this parameter to get the status of the messages. Max 60 characters.
\n","type":"text","disabled":true},{"key":"encoding","value":"7BIT","description":"[String] (Optional)
\nThe encoding to use for the text of the message.\nThe possible values are:
\n7BIT - Encoding standard for GSM messages. The max length for a single sms is 160 characters.
\nUCS2 - 8-bit Encoding for GSM messages with also not ASCII content. The max length for a single message is 70 characters.
\nAUTO - the encoding to use is automatically selected based on the content of the text field.
\nDefault : 7BIT
\n","type":"text","disabled":true},{"key":"statusCallback","value":"https://tuodominio.com/tuo-percorso-callback","description":"[String] (Optional)
\nURL to which a notification with the status (Delivered, Not Delivered) of the message will be sent via HTTP/HTTPS.
\nSee RCS Status Callback Management
\n","type":"text"},{"key":"sandbox","value":"true","description":"[String] (Optional)
\nIt allows you to make the call without actually sending the message. Useful parameter when developing possible integrations with the REST API.
\nPossible valued: true/false
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/rcs/message/send","description":"Sending a message to one or more individual recipients or to one or more groups in the address book.
\nYou can test sending by setting the sandbox parameter to true in the request.
The statusCallback parameter allows you to register a URL to which a notification with the status (Delivered, Not Delivered, etc...) of the message will be sent via HTTP.
\n\nPay particular attention to the fact that the id of the message could be a 64-bit integer (int64)\nCheck if your platform can handle it!
\n
\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
[String] (Optional, set at least one of to and group)\nThe recipient of the message.
\nIt must be a mobile number including the international prefix.\nIt is possible to set multiple telephone numbers (max 1000 numbers) by separating them with the comma character \",\".
\nFor example:\n393481234567 or 393481234567,393481234568,393481234568
Alternatively, the parameter can be enhanced with a JSON array containing the objects that describe the recipient.\nEach object must necessarily have the msisdn property valued.\nThe other properties of these objects can be used to parameterize the message text (see the text field).
\nFor example:\n[{msisdn:'393481234567'},{msisdn:'393481234568'},{msisdn:'393481234568'}]
\n","type":"text"},{"key":"group","value":"gruppo","description":"[String] (Optional, set at least one of to and group)\nId of the group in the phonebook to send to\nIt is possible to specify multiple groups from the phonebook by separating them with a comma \",\".\nFor example, if in the phonebook there is the froup \"friends\" (id=1) and \"school\" (id=2), you can use:\n1 or 1,2
[String] (Optional)\nDate (format yyyy-MM-ddTHH:mm:ssZ) when the message will be sent. If not set, the message will be sent immediatly.\nThe character Z specifies the timezone according to RFC 822 4-digit format (In Italy, the timezone offset is +0200 during daylight saving time (summer) and +0100 during standard time (winter).).\nFor example:\n2014-12-25T08:00:00+0200 means 25/12/2014 at 08:00:00 GMT +2
\n","type":"text","disabled":true},{"key":"agentId","value":"id agent","description":"[String] (Required)
\nID of the agent to use to send the RCS message
\n","type":"text"},{"key":"contentMessage","value":"{\"contentMessage\":{\"text\":\"Hi there!\",\"suggestions\":[]}}","description":"[String] (Optional, set at least one of contentMessage and templateId)
\nString representing the JSON containing the RCS message.
\n\n","type":"text"},{"key":"templateId","value":"id template","description":"[String] (Optional, set at least one of contentMessage and templateId)\nID of the template to use.
\n","type":"text","disabled":true},{"key":"fallbackSms","value":"true","description":"[boolean] (Required)
\nTrue if you want to enable SMS fallback
\n","type":"text"},{"key":"fromSms","value":"mittente SMS","description":"[String] (Optional)
\nThe sender of the fallback SMS.
\nIt can be a validated telephone number or an alphanumeric string of up to 11 characters. If not specified, the default sender of your profile is used.
\nTo use an alphanumeric sender, registration is mandatory; this procedure can be carried out from our web panel or via API.
\nUnverified senders will be replaced with a random numeric sender.
\n","type":"text"},{"key":"textSms","value":"Hi there!","description":"[String] (Optional)
\nRequired if fallbackSms is true.
\nText of the fallback SMS message.
\nIf the message exceeds 160 characters, [multiple concatenated text messages] are sent (https://help.smshosting.it/it/nio-sms/caratteriche-sms/lunghezza-testo-e-codifiche-supportate) up to a maximum of 7.
\nSome extended characters occupy 2 characters. In the case of SMS that exceed the standard length of 160 characters only due to some extended characters, these will be replaced with simple characters keeping the cost at 1 SMS instead of 2.
\nThe text may contain placeholders which will be replaced during sending by the values associated with the respective recipient.
\nThe placeholder must be specified with the syntax ${property name}\nIf the text contains placeholders the to field must be populated with a JSON array and each object in the array must contain the property indicated in the placeholder.
\nFor example:\nto=[{msisdn:'393481234567',name:'Mario Rossi'},{msisdn:'393481234568',name:'Luigi Bianchi'}]\ntext=Send test sms to ${name}
\n","type":"text"},{"key":"transactionId","value":"51e533f557062a2e0dfce81d064a60db","description":"[String] (Optional)\nCustom ID for the operation.\nIt allows you to assign the same ID to all messages sent with the same call in order to use this parameter to get the status of the messages. Max 60 characters.
\n","type":"text","disabled":true},{"key":"encoding","value":"7BIT","description":"[String] (Optional)\nThe encoding to use for the text of the message.\nThe possible values are:
\n[String] (Optional)
\nURL to which a notification with the status (Delivered, Not Delivered) of the message will be sent via HTTP/HTTPS.
\nSee RCS Status Callback Management
\n","type":"text"},{"key":"sandbox","value":"true","description":"[String] (Optional)\nIt allows you to make the call without actually sending the message. Useful parameter when developing possible integrations with the REST API.\nPossible valued: true/false
\n","type":"text","disabled":true},{"key":"transactionCallback","value":"https://tuodominio.com/tuo-percorso-callback","type":"text","description":"[String] (Optional)
\nA personal identifier of the submission.
\nAllows you to assign the same identifier to all messages sent with a call so that this parameter can be used to search by status. Maximum 60 characters.\"
\n"}]},"url":"{{BaseUrl}}/rest/api/rcs/message/sendbulk","description":"Asynchronous SMS sending mode to be used with a large number of recipients (More than 10 recipients per single request).
\nOnce the request has been sent, a transactionId is returned which is useful for subsequently identifying the messages.
\nIf the submission cannot be completed due to an error, an email containing the error code will be sent.
\nNote: If you send up to 10 recipients per single request we recommend using the RCS Send function
\n\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
[Number] (Optional) -> value at least one of the id or transactionId parameters
Internal id of the sent message.
Multiple ids can be specified by separating them with the comma character \",\".
\nFor example:\n12312 or 432432,543543,435435
\n","type":"text"},{"key":"transactionId","value":"123456789ABCDE","description":"[String] (Optional) -> set at least one of id or transactionId
transactionId of the send operation
Cancel sending a message not yet sent (deferred sending).
\nThe call returns the list of canceled messages.
\nFor details of the properties of each individual message, see the Response Description of the Search Rcs.
\n","urlObject":{"path":["rest","api","rcs","message","cancel"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"25b095a5-df38-4bc6-aef6-bdb4a2eeccc4","name":"Annulla Invio RCS","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"1","description":"[Number] *(Opzionale ¹)*\n\nId interno del messaggio inviato.\n\nÈ possibile specificare **più id** separandoli con il carattere virgola \"**,**\".\n\nAd esempio:\n**12312** oppure **432432,543543,435435**","type":"text","disabled":true},{"key":"transactionId","value":"123456789ABCDE","description":"[String] *(Opzionale ¹)*\n\n**transactionId** assegnato all'invio","type":"text"}]},"url":"{{BaseUrl}}/rest/api/rcs/message/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"to\": \"393331111111\",\n \"text\": \"Ciao Rossi!\",\n \"from\": \"DemoSMS\",\n \"status\": \"NOSENT\",\n \"insertDate\": \"2022-05-27T17:41:04+0200\",\n \"transactionId\": \"rkEctAS0WRZzZTWtDXuGiLh5QWsgStYv59tnLRsj9UwA5BWjdbTxFhydYSb64TaU\",\n \"price\": 0.085,\n \"agent\": \"Agent default\",\n \"contentMessage\": \"{\\\"contentMessage\\\":{\\\"text\\\":\\\"Hi there!\\\",\\\"suggestions\\\":[]}}\",\n \"contentType\": \"card\",\n \"sentAs\": \"unknown\"\n }\n]"}],"_postman_id":"a929b9e0-69a5-4ccc-8ee3-40ea681bdb7a"},{"name":"Search RCS Messages","id":"4ca390b4-0e13-4690-93d8-7e4ca6e880c1","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{auth_secret}}","username":"{{auth_key}}"},"isInherited":false},"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/rcs/message/search?id=450189291&offset=0&limit=20","description":"Search among sent RCS messages.
\nValue at least one of the following parameters:
\nid
\ntransactionId
\nmsisdn
\nfromDate
\nstatus
\n[String] (Optional)
\nInternal ID of the message sent.
\nMultiple ids can be specified by separating them with the comma character \",\". (Maximum 2000 id).
\nFor example:\n12312 or 432432,543543,435435
\n","type":"text/plain"},"key":"id","value":"450189291"},{"disabled":true,"description":{"content":"[String] (Optional)
\ntransactionId of the send operation.
\n","type":"text/plain"},"key":"transactionId","value":""},{"disabled":true,"description":{"content":"[String] (Optional)
\nPhone Number to which the message was sent.
\n","type":"text/plain"},"key":"msisdn","value":""},{"disabled":true,"description":{"content":"[String] (Optional)
\nFind messages sent since this date (format yyyy-MM-ddTHH:mm:ssZ)
\nThe character Z specifies the timezone according to RFC 822 4-digit format (In Italy, the timezone offset is +0200 during daylight saving time (summer) and +0100 during standard time (winter).
\n","type":"text/plain"},"key":"fromDate","value":""},{"disabled":true,"description":{"content":"[String] (Optional)
\nFind message send up to this date (format yyyy-MM-ddTHH:mm:ssZ)
\n","type":"text/plain"},"key":"toDate","value":""},{"disabled":true,"description":{"content":"[String] (Optional)
\nStatus of the messages
\n","type":"text/plain"},"key":"status","value":"PENDING"},{"description":{"content":"[Number] (Optional)
\nPosition of the first result that will be returned.
\nExample:\nIf the search finds 100 messages, the offset field is set to 50 and the limit field to 10, messages from 51 to 60 will be returned.\nDefault : 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"[Number] (Optional)
\nNumber of results that will be returned.\nDefault: 20
\n","type":"text/plain"},"key":"limit","value":"20"}],"variable":[]}},"response":[{"id":"c8c2b66c-a4a1-4049-ad47-093171cf17d6","name":"Cerca Messaggi RCS","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/rcs/message/search?id&transactionId=&msisdn&fromDate&toDate&status=PENDING&offset=0&limit=20","host":["{{BaseUrl}}"],"path":["rest","api","rcs","message","search"],"query":[{"key":"id","value":null,"description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\nId interno del messaggio inviato.\n\nÈ possibile specificare **più id** separandoli con il carattere virgola \"**,**\".\n\nAd esempio:\n\n**12312** oppure **432432,543543,435435**"},{"key":"transactionId","value":"","description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\n**transactionId** assegnato all'invio."},{"key":"msisdn","value":null,"description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\nNumero al quale è stato inviato il messaggio"},{"key":"fromDate","value":null,"description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\nCerca gli sms stati inviati da questa data (formato **yyyy-MM-ddTHH:mm:ssZ**)\n\nIl carattere **Z** indica il timezone nel formato RFC822 4-digit. _Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno_."},{"key":"toDate","value":null,"description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\nCerca gli sms stati inviati fino a questa data (formato **yyyy-MM-ddTHH:mm:ssZ**)"},{"key":"status","value":"PENDING","description":"[String] *(Opzionale [§note](#note-ricerca-sms))*\n\nStato degli sms [Vedi valori] (#32ddccbd-f896-924a-b9df-7d716a8e4d9d)"},{"key":"offset","value":"0","description":"[Number] *(Opzionale [§note](#note-ricerca-sms))*\n\nPosizione del primo risultato che verrà restituito.\n\nEsempio:\nSe la ricerca trova 100 sms, il campo **offset** viene valorizzato a 50 ed il campo **limit** a 10 verranno restituiti gli sms da 51 a 60.\n**Default : 0**"},{"key":"limit","value":"20","description":"[Number] *(Opzionale [§note](#note-ricerca-sms))*\n\nNumero di risultati che verranno restituiti.\n**Default: 20**"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"limit\": 20\n },\n \"rcsList\": [\n {\n \"id\": 70,\n \"to\": \"393000000000\",\n \"text\": \"Hi There!\",\n \"from\": \"DemoSMS\",\n \"status\": \"PENDING\",\n \"insertDate\": \"2022-05-27T17:41:04+0200\",\n \"transactionId\": \"rkEctAS0WRZzZTWtDXuGiLh5QWsgStYv59tnLRsj9UwA5BWjdbTxFhydYSb64TaU\",\n \"price\": 0.085,\n \"agentId\": 8,\n \"contentMessage\": \"{\\\"contentMessage\\\":{\\\"text\\\":\\\"Hi there!\\\",\\\"suggestions\\\":[]}}\",\n \"contentType\": \"text\",\n \"sentAs\": \"unknown\"\n }\n ]\n}"}],"_postman_id":"4ca390b4-0e13-4690-93d8-7e4ca6e880c1"},{"name":"RCS Agent List","id":"31d7ed04-bd96-4ace-ba0a-88b6636b9104","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{auth_secret}}","username":"{{auth_key}}"},"isInherited":false},"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/rcs/agent/list","description":"Get the list of configured RCS agents.
\nGet the list of configured RCS templates.
\nThe response contains a JSON containing a list of templates, each with the following properties:
Returns the detail of a single WhatsApp template.
\nSearch among sent Whatsapp messages.
\nValue at least one of the following parameters:
\n[String] (Optional)\nInternal ID of the message sent.\nMultiple ids can be specified by separating them with the comma \",\". (Maximum 2000 id).\nFor example:\n12312 or 432432,543543,435435
\n","type":"text/plain"},"key":"id","value":""},{"description":{"content":"[String] (Optional)\ntransactionId of the send operation.
\n","type":"text/plain"},"key":"transactionId","value":"123456789ABCDE"},{"disabled":true,"description":{"content":"[String] (Optional)\nPhone Number to which the message was sent.
\n","type":"text/plain"},"key":"msisdn","value":""},{"disabled":true,"description":{"content":"[String] (Optional)\nFind messages a sent since this date (format yyyy-MM-ddTHH:mm:ssZ)\nThe character Z specifies the timezone according to RFC 822 4-digit format (In Italy, the timezone offset is +0200 during daylight saving time (summer) and +0100 during standard time (winter).
\n","type":"text/plain"},"key":"fromDate","value":""},{"disabled":true,"description":{"content":"[String] (Optional)\nFind message send up to this date (format yyyy-MM-ddTHH:mm:ssZ)
\n","type":"text/plain"},"key":"toDate","value":""},{"disabled":true,"description":{"content":"[String] (Optional)\nStatus of the messages
\n","type":"text/plain"},"key":"status","value":""},{"description":{"content":"[Number] (Optional)\nPosition of the first result that will be returned.\nExample:\nIf the search finds 100 messages, the offset field is set to 50 and the limit field to 10, messages from 51 to 60 will be returned.\nDefault : 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"[Number] (Optional)\nNumber of results that will be returned.\nDefault: 20
\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"0d1afe2b-be02-424b-8787-81dfaa134dd1","name":"Cerca Whatsapp","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseUrl}}/rest/api/wa/message/search?id=&transactionId=DZNyyWr3Fd59iidfSSy2GU3im1aozQeE2qSyk6d1rwTDUa2ybuMI7IxDWPE1BS0j&offset=0&limit=10","host":["{{BaseUrl}}"],"path":["rest","api","wa","message","search"],"query":[{"key":"id","value":""},{"key":"transactionId","value":"DZNyyWr3Fd59iidfSSy2GU3im1aozQeE2qSyk6d1rwTDUa2ybuMI7IxDWPE1BS0j"},{"key":"msisdn","value":"","disabled":true},{"key":"fromDate","value":"","disabled":true},{"key":"toDate","value":"","disabled":true},{"key":"status","value":"","disabled":true},{"key":"offset","value":"0"},{"key":"limit","value":"10"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"limit\": 10\n },\n \"waList\": [\n {\n \"id\": 2692017410,\n \"to\": \"393400000000\",\n \"fromSms\": \"-\",\n \"status\": \"NOSENT\",\n \"insertDate\": \"2023-09-25T10:18:42+0200\",\n \"dataDifferito\": \"2023-09-27T09:00:00+0200\",\n \"transactionId\": \"DZNyyWr3Fd59iidfSSy2GU3im1aozQeE2qSyk6d1rwTDUa2ybuMI7IxDWPE1BS0j\",\n \"price\": 0,\n \"phoneNumberId\": 3,\n \"contentMessage\": \"{\\\"type\\\":\\\"template\\\",\\\"template\\\":{\\\"namespace\\\":\\\"867f4be9_6b3d_4884_be59_123d372a3819\\\",\\\"name\\\":\\\"testmediaimg\\\",\\\"language\\\":{\\\"code\\\":\\\"it\\\"},\\\"components\\\":[{\\\"type\\\":\\\"header\\\",\\\"parameters\\\":[{\\\"type\\\":\\\"image\\\",\\\"image\\\":{\\\"link\\\":\\\"https://beeediot-svil.s3.eu-west-1.amazonaws.com/msgeditor-test/public/1/50/51_loginlogo_1627887014900.jpg\\\"}}]},{\\\"type\\\":\\\"body\\\",\\\"parameters\\\":[{\\\"type\\\":\\\"text\\\",\\\"text\\\":\\\"Marco\\\"}]}]}}\",\n \"sentAs\": \"unknown\"\n }\n ]\n}"}],"_postman_id":"662ca1b9-882e-4c1b-b3c8-1784f3def10b"},{"name":"Numbers List","id":"e567ac10-b51b-407d-bc06-cfdade61b459","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{auth_secret}}","username":"{{auth_key}}"},"isInherited":false},"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/wa/phonenumber/list","description":"Get the list of configured Whatsapp numbers.
\n[String] (Optional, set at least one of to and group)\nThe recipient of the message.\nIt must be a mobile number including the international prefix.\nIt is possible to specify multiple telephone numbers (max 10 numbers) by separating them with the comma character \",\".\nIf there are more than 10 recipients, we suggest to use the send bulk request.
\nFor example:\n393481234567 or 393481234567,393481234568,393481234568
Alternatively, the parameter can be enhanced with a JSON array containing the objects that describe the recipient.\nEach object must necessarily have the msisdn property valued.\nThe other properties of these objects can be used to parameterize the message text (see the text field).
\nFor example:\n[{msisdn:'393481234567'},{msisdn:'393481234568'},{msisdn:'393481234568'}]
\n"},{"key":"group","value":"","type":"text","description":"[String] (Optional, set at least one of to and group)\nId of the group in the phonebook to send to\nIt is possible to specify multiple groups from the phonebook by separating them with a comma \",\".\nFor example, if in the phonebook there is the group \"friends\" (id=1) and \"school\" (id=2), you can use:\n1 or 1,2
[String] (Optional)\nDate (format yyyy-MM-ddTHH:mm:ssZ) when the message will be sent. If not set, the message will be sent immediatly.\nThe character Z specifies the timezone according to RFC 822 4-digit format (In Italy, the timezone offset is +0200 during daylight saving time (summer) and +0100 during standard time (winter).).\nFor example:\n2014-12-25T08:00:00+0200 means 25/12/2014 at 08:00:00 GMT +2
\n","disabled":true},{"key":"phoneNumberId","value":"3","type":"text","description":"[String] (Optional, set at least one of phoneNumberId and phoneNumber)
\nID of the phone number you want to use to send the Whatsapp message
\n"},{"key":"phoneNumber","value":"","type":"text","description":"[String] (Optional, set at least one of phoneNumberId and phoneNumber)
\nPhone number you want to use to send the Whatsapp message
\n","disabled":true},{"key":"contentMessage","value":"{... JSON CONTENT ...}","type":"text","description":"[String] (Required)\nString representing the JSON containing the Whatsapp message
\nIf you wish to use an existing template, we recommend that you first make the Template Detail request and insert the JSON returned in the exampleSendPayload property
\nThe contentMessage (in the parameters) may contain placeholders which will be replaced during the send by the values associated with the respective recipient. The placeholder shall be specified with the syntax ${property name}
\nIn the case that the contentMessage contains placeholders the to field must be set to a JSON array and each object in the array must contain the property indicated in the placeholder.\nFor example:
\nto=[{msisdn:'393481234567',name:'Mario Rossi'},{msisdn:'393481234568',name:'Luigi Bianchi'}]
\ncontentMessage = .... \"parameters\": [{\"type\": \"text\", \"text\":\"${name}\"}]....
\nFor JSON specifications, please refer to https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages
\n"},{"key":"fallbackSms","value":"true","type":"text","description":"[boolean] (Required)
\nTrue if you want to enable SMS fallback
\n"},{"key":"fromSms","value":"SMS_SENDER","type":"text","description":"[String] (Optional)
\nThe sender of the fallback SMS.
\nIt can be a validated telephone number or an alphanumeric string of up to 11 characters. If not specified, the default sender of your profile is used.\nTo use an alphanumeric sender, registration is mandatory; this procedure can be carried out from our web panel or via API.
\nUnverified senders will be replaced with a random numeric sender.
\n"},{"key":"textSms","value":"SMS CONTENT","type":"text","description":"[String] (Optional)
\nRequired if fallbackSms is true.
\nText of the fallback SMS message.
\nIf the message exceeds 160 characters, [multiple concatenated text messages] are sent (https://help.smshosting.it/it/nio-sms/caratteriche-sms/lunghezza-testo-e-codifiche-supportate) up to a maximum of 7.
\nSome extended characters occupy 2 characters. In the case of SMS that exceed the standard length of 160 characters only due to some extended characters, these will be replaced with simple characters keeping the cost at 1 SMS instead of 2.
\nThe text may contain placeholder which will be replaced during sending by the values associated with the respective recipient.\nThe placeholder must be specified with the syntax ${property name}\nIf the text contains placeholder the to field must be populated with a JSON array and each object in the array must contain the property indicated in the placeholder.
\nFor example:\nto=[{msisdn:'393481234567',name:'Mario Rossi'},{msisdn:'393481234568',name:'Luigi Bianchi'}]\ntext=Send test sms to ${name}
\n"},{"key":"transactionId","value":"","type":"text","description":"[String] (Optional)\nCustom ID for the send operation.\nIt allows you to assign the same ID to all messages sent with the same call in order to use this parameter to get the status of the messages. Max 60 characters.
\n","disabled":true},{"key":"statusCallback","value":"","type":"text","description":"[String] (Optional)\nURL to which a notification with the status (Delivered, Not Delivered) of the message will be sent via HTTP/HTTPS.
\n","disabled":true},{"key":"encoding","value":"","type":"text","description":"[String] (Optional)\nThe encoding to use for the text of the message.\nThe possible values are:
\n[String] (Optional)\nIt allows you to make the call without actually sending the message. Useful parameter when developing possible integrations with the REST API.\nPossible valued: true/false
\n","disabled":true}]},"url":"{{BaseUrl}}/rest/api/wa/message/send","description":"Sending a message to one or more individual recipients or to one or more groups in the address book.
\nYou can test sending by setting the sandbox parameter to true in the request.
The statusCallback parameter allows you to register a URL to which a notification with the status (Delivered, Not Delivered, etc...) of the message will be sent via HTTP.
\n\nPay particular attention to the fact that the id of the message could be a 64-bit integer (int64)
\n
Check if your platform can handle this!
\n\nIf you want to send an existing template, you will have to insert in the ContentMessage parameter a JSON formatted like the one obtained in the exampleSendPayload property of the Model Detail
\n
\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
[String] (Optional, set at least one of to and group)\nThe recipient of the message.
\nIt must be a mobile number including the international prefix.
\nIt is possible to specify multiple telephone numbers (max 1000 numbers) by separating them with the comma character \",\".
\nFor example:\n393481234567 or 393481234567,393481234568,393481234568
Alternatively, the parameter can be enhanced with a JSON array containing the objects that describe the recipient.\nEach object must necessarily have the msisdn property valued.\nThe other properties of these objects can be used to parameterize the message text (see the text field).
\nFor example:\n[{msisdn:'393481234567'},{msisdn:'393481234568'},{msisdn:'393481234568'}]
\n"},{"key":"group","value":"","type":"text","description":"[String] (Optional, set at least one of to and group)\nId of the group in the phonebook to send to\nIt is possible to specify multiple groups from the phonebook by separating them with a comma \",\".\nFor example, if in the phonebook there is the group \"friends\" (id=1) and \"school\" (id=2), you can use:\n1 or 1,2
[String] (Optional)\nDate (format yyyy-MM-ddTHH:mm:ssZ) when the message will be sent. If not set, the message will be sent immediatly.\nThe character Z specifies the timezone according to RFC 822 4-digit format (In Italy, the timezone offset is +0200 during daylight saving time (summer) and +0100 during standard time (winter).).\nFor example:\n2014-12-25T08:00:00+0200 means 25/12/2014 at 08:00:00 GMT +2
\n","disabled":true},{"key":"phoneNumberId","value":"3","type":"text","description":"[String] (Optional, set at least one of phoneNumberId and phoneNumber)\nID of the phone number you want to use to send the Whatsapp message
\n"},{"key":"phoneNumber","value":"","type":"text","description":"[String] (Optional, set at least one of phoneNumberId and phoneNumber)\nPhone number you want to use to send the Whatsapp message
\n","disabled":true},{"key":"contentMessage","value":"{... JSON CONTENT ...}","type":"text","description":"[String] (Required)\nString representing the JSON containing the Whatsapp message\nIf you wish to use an existing template, we recommend that you first make the Template Detail request and insert the JSON returned in the exampleSendPayload property\nThe contentMessage (in the parameters) may contain placeholders which will be replaced during the send by the values associated with the respective recipient. The placeholder shall be specified with the syntax ${property name}\nIn the case that the contentMessage contains placeholders the to field must be set to a JSON array and each object in the array must contain the property indicated in the placeholder.\nFor example:\nto=[{msisdn:'393481234567',name:'Mario Rossi'},{msisdn:'393481234568',name:'Luigi Bianchi'}]\ncontentMessage = .... \"parameters\": [{\"type\": \"text\", \"text\":\"${name}\"}]....\nFor JSON specifications, please refer to https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages
\n"},{"key":"fallbackSms","value":"true","type":"text","description":"[boolean] (Required)
\nTrue if you want to enable SMS fallback
\n"},{"key":"fromSms","value":"SMS_SENDER","type":"text","description":"[String] (Optional)
\nThe sender of the fallback SMS.
\nIt can be a validated telephone number or an alphanumeric string of up to 11 characters. If not specified, the default sender of your profile is used.\nTo use an alphanumeric sender, registration is mandatory; this procedure can be carried out from our web panel or via API.
\nUnverified senders will be replaced with a random numeric sender.
\n"},{"key":"textSms","value":"SMS CONTENT","type":"text","description":"[String] (Optional)
\nRequired if fallbackSms is true.
\nText of the fallback SMS message.
\nIf the message exceeds 160 characters, [multiple concatenated text messages] are sent (https://help.smshosting.it/it/nio-sms/caratteriche-sms/lunghezza-testo-e-codifiche-supportate) up to a maximum of 7.
\nSome extended characters occupy 2 characters. In the case of SMS that exceed the standard length of 160 characters only due to some extended characters, these will be replaced with simple characters keeping the cost at 1 SMS instead of 2.
\nThe text may contain placeholders which will be replaced during sending by the values associated with the respective recipient.\nThe placeholder must be specified with the syntax ${property name}\nIf the text contains placeholders the to field must be populated with a JSON array and each object in the array must contain the property indicated in the placeholder.
\nFor example:\nto=[{msisdn:'393481234567',name:'Mario Rossi'},{msisdn:'393481234568',name:'Luigi Bianchi'}]\ntext=Send test sms to ${name}
\n"},{"key":"transactionId","value":"","type":"text","description":"[String] (Optional)\nCustom ID for the send operation.\nIt allows you to assign the same ID to all messages sent with the same call in order to use this parameter to get the status of the messages. Max 60 characters.
\n","disabled":true},{"key":"statusCallback","value":"","type":"text","description":"[String] (Optional)\nURL to which a notification with the status (Delivered, Not Delivered) of the message will be sent via HTTP/HTTPS.
\n","disabled":true},{"key":"encoding","value":"","type":"text","description":"[String] (Optional)\nThe encoding to use for the text of the message.\nThe possible values are:
\n[String] (Optional)\nIt allows you to make the call without actually sending the message. Useful parameter when developing possible integrations with the REST API.\nPossible valued: true/false
\n","disabled":true}]},"url":"{{BaseUrl}}/rest/api/wa/message/sendbulk","description":"Asynchronous SMS sending mode to be used with a large number of recipients (More than 10 recipients per single request).
\nOnce the request has been sent, a transactionId is returned which is useful for subsequently identifying the messages.
\nIf the submission cannot be completed due to an error, an email containing the error code will be sent.
\nNote: If you send up to 10 recipients per single request we recommend using the Whatsapp sending function
\nATTENTION!
\n\n\nIf you want to send an existing template, you will have to insert in the ContentMessage parameter a JSON formatted like the one obtained in the exampleSendPayload property of the Model Detail
\n
\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
[Number] (Optional) -> set at least one of id or transactionId parameters
Internal id of the sent message.\nMultiple ids can be specified by separating them with the comma character \",\".
For example:\n12312 or 432432,543543,435435
\n"},{"key":"transactionId","value":"","type":"text","description":"[String] (Optional) -> set at least one of id or transactionId parameters
transactionId of the send operation
Cancel sending a message not yet sent (deferred sending).
\nThe call returns the list of canceled messages.
\nFor details of the properties of each individual message, see the Response Description of the Search Whatsapp
\n","urlObject":{"path":["rest","api","wa","message","cancel"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"b9feb32a-2004-4bc5-930e-5620eb96b822","name":"cancel Whatsapp","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"2692017506","type":"text"},{"key":"transactionId","value":"","type":"text","disabled":true}]},"url":"{{BaseUrl}}/rest/api/wa/message/cancel"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 2692017506,\n \"to\": \"393400000000\",\n \"textSms\": \"test messaggio\",\n \"fromSms\": \"#RANDOMNUM#\",\n \"status\": \"NOSENT\",\n \"insertDate\": \"2023-10-13T11:46:15+0200\",\n \"dataDifferito\": \"2023-10-25T10:18:42+0200\",\n \"transactionId\": \"7aa8fd1f030daa16282a36fd0c194a2e\",\n \"price\": 0.04,\n \"phoneNumberId\": 3,\n \"contentMessage\": \"{\\\"messaging_product\\\":\\\"whatsapp\\\",\\\"recipient_type\\\":\\\"individual\\\",\\\"to\\\":\\\"{{msgeditor_whatsapp_message_to}}\\\",\\\"type\\\":\\\"text\\\",\\\"text\\\":{\\\"body\\\":\\\"Ops, non ho capito\\\",\\\"preview_url\\\":false}}\",\n \"sentAs\": \"unknown\"\n }\n]"}],"_postman_id":"72579f41-76b2-42a4-9e22-81ba6183b286"}],"id":"d26f3314-a65f-4481-bae7-2d4ffe6eab58","_postman_id":"d26f3314-a65f-4481-bae7-2d4ffe6eab58","description":"","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}}},{"name":"WhatsApp Template Management","item":[{"name":"Template Detail","id":"98c033f5-ef11-426b-a504-bec859c7799d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{auth_secret}}","username":"{{auth_key}}"},"isInherited":false},"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/wa/template/:templateId","description":"Returns the detail of a single WhatsApp template.
\nView the list of all WhatsApp templates created by the user via web interface.
\nThe response contains a JSON containing a list of templates, each with the following properties:
[Integer] (Required)\nId of the number with which you want to associate the new template
\n","type":"text"},{"key":"contentSchema","value":"{...JSON_CONTENT...}","description":"[String] (Required)\nJSON representing the Whatsapp template generated by the embedded editor.
\n","type":"text"}]},"url":"{{BaseUrl}}/rest/api/wa/template/create","description":"Create a template on the platform
\n[Integer] (Required)\nId of the number with which you want to associate the new template
\n","type":"text"},{"key":"contentSchema","value":"{...JSON_CONTENT...}","description":"[String] (Required)\nJSON representing the Whatsapp template generated by the embedded editor.
\n","type":"text"}]},"url":"{{BaseUrl}}/rest/api/wa/template/:templateID","description":"Edit a model in platform.
\n[Integer] (Required)\nId of the template to Edit
\n","type":"text/plain"},"type":"any","value":"1234","key":"templateID"}]}},"response":[{"id":"845e7d73-660b-45f4-9530-504be6fd5cee","name":"Edit Template","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"numberId","value":"1","description":"[String] *(Obbligatorio)*\nId del numero a cui si vuole associare il nuovo template","type":"text"},{"key":"contentSchema","value":"{\"modified\":\"2025-01-15T11:21:25.569Z\",\"config\":{\"name\":\"template_name\",\"language\":\"it\",\"category\":\"MARKETING\",\"previewTemplateMessageComponents\":[],\"headerMedia\":{\"format\":\"\",\"url\":\"\",\"placeholder\":\"{{msgeditor_header_media_url}}\"}},\"contentMessage\":{\"name\":\"template_name\",\"language\":\"it\",\"category\":\"MARKETING\",\"components\":[{\"type\":\"HEADER\",\"format\":\"TEXT\",\"text\":\"template_header\"},{\"type\":\"BODY\",\"text\":\"template_body\"},{\"type\":\"FOOTER\",\"text\":\"template_footer\"}]}}","description":"[String] *(Obbligatorio)*\nJSON rappresentante il modello Whatsapp generato dall' embedded editor.","type":"text"}]},"url":{"raw":"{{BaseUrl}}/rest/api/wa/template/:templateID","host":["{{BaseUrl}}"],"path":["rest","api","wa","template",":templateID"],"variable":[{"key":"templateID","value":"1234","description":"[Integer] *(Obbligatorio)*\nId del modello da modificare"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"templateDetail\": {\n \"id\": 1234,\n \"name\": \"template_name\",\n \"language\": \"it\",\n \"category\": \"MARKETING\",\n \"status\": \"PENDING\",\n \"numberIds\": [\n 3\n ],\n \"contentMessage\": {\n \"components\": [\n {\n \"format\": \"TEXT\",\n \"text\": \"template_header\",\n \"type\": \"HEADER\"\n },\n {\n \"text\": \"template_body\",\n \"type\": \"BODY\"\n },\n {\n \"text\": \"template_footer\",\n \"type\": \"FOOTER\"\n }\n ],\n \"name\": \"template_name\",\n \"language\": \"it\",\n \"category\": \"MARKETING\"\n },\n \"contentSchema\": {\n \"contentMessage\": {\n \"components\": [\n {\n \"format\": \"TEXT\",\n \"text\": \"template_header\",\n \"type\": \"HEADER\"\n },\n {\n \"text\": \"template_body\",\n \"type\": \"BODY\"\n },\n {\n \"text\": \"template_footer\",\n \"type\": \"FOOTER\"\n }\n ],\n \"name\": \"template_name\",\n \"language\": \"it\",\n \"category\": \"MARKETING\"\n },\n \"modified\": \"2025-01-15T11:21:25.569Z\",\n \"config\": {\n \"previewTemplateMessageComponents\": [],\n \"headerMedia\": {\n \"format\": \"\",\n \"placeholder\": \"{{msgeditor_header_media_url}}\",\n \"url\": \"\"\n },\n \"name\": \"template_name\",\n \"language\": \"it\",\n \"category\": \"MARKETING\"\n }\n },\n \"insertDate\": \"2025-01-15T12:23:01+0100\",\n \"updateDate\": \"2025-01-15T12:23:01+0100\",\n \"exampleSendPayload\": {\n \"template\": {\n \"components\": [],\n \"namespace\": \"\",\n \"name\": \"template_name\",\n \"language\": {\n \"code\": \"it\",\n \"policy\": \"deterministic\"\n }\n },\n \"type\": \"template\"\n }\n }\n}"}],"_postman_id":"0258ec1d-b5c2-4cb7-bfaf-138a87159cd6"},{"name":"Delete Template","id":"32137922-42c2-4a2f-a50d-c195d6699616","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{BaseUrl}}/rest/api/wa/template/:templateID","description":"Delete a template in the platform
\n[Integer] (Required)\nId of the template to delete
\n","type":"text/plain"},"type":"any","value":"1234","key":"templateID"}]}},"response":[{"id":"808ec3e1-92cc-4d62-b5a8-8f7015c91edd","name":"Delete Template","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{BaseUrl}}/rest/api/wa/template/:templateID","host":["{{BaseUrl}}"],"path":["rest","api","wa","template",":templateID"],"variable":[{"key":"templateID","value":"1234","description":"[Integer] *(Required)*\nId of the template to delete"}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"32137922-42c2-4a2f-a50d-c195d6699616"},{"name":"Sync Template on Meta","id":"ef6d2892-04cd-42e4-8819-33d38ddadbf6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"syncCallback","value":"https://tuodominio.com/tuo-percorso-callback","description":"[String] (Required)\nURL to be retrieved with the result of template synchronization
\n","type":"text"}]},"url":"{{BaseUrl}}/rest/api/wa/template/sync/:templateId","description":"Sync template on Meta
\nOnce the template synchronization is finished, the updated detail of the Template will be sent to the given URL.
\n","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}},"urlObject":{"path":["rest","api","wa","template","sync",":templateId"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"[Integer] (Required)\nId of the template to be synced
\n","type":"text/plain"},"type":"any","value":"1234","key":"templateId"}]}},"response":[{"id":"6e875aed-089c-4ccb-b498-0c8ff5b6abf7","name":"Sync Template on Meta","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"syncCallback","value":"https://tuodominio.com/tuo-percorso-callback","description":"[String] *(Obbligatorio)*\nURL da richiamare con il risultato della sincronizzazione del template","type":"text"}]},"url":{"raw":"{{BaseUrl}}/rest/api/wa/template/sync/:templateId","host":["{{BaseUrl}}"],"path":["rest","api","wa","template","sync",":templateId"],"variable":[{"key":"templateId","value":"1234","description":"[Integer] *(Required)*\nId of the template to be synced"}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"ef6d2892-04cd-42e4-8819-33d38ddadbf6"},{"name":"Sync all templates on Meta","id":"d5a9ba41-9cc1-427c-af6b-3c0f32bd757c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"syncCallback","value":"https://tuodominio.com/tuo-percorso-callback","description":"[String] (Required)\nURL to be retrieved with the result of template synchronization
\n","type":"text"},{"key":"numberId","value":"1","description":"[Integer] (Optional)\nWhatsapp number whose templates you want to synchronize
\n","type":"text"}]},"url":"{{BaseUrl}}/rest/api/wa/template/sync/all","description":"Sync all templates on Meta
\nOnce the template synchronization is finished, the updated template list will be sent to the given URL.
\n","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}},"urlObject":{"path":["rest","api","wa","template","sync","all"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"be3b9b57-294a-4dd7-858c-26c047690487","name":"Sync all templates on Meta","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"syncCallback","value":"https://tuodominio.com/tuo-percorso-callback","description":"[String] *(Required)*\nURL to be retrieved with the result of template synchronization","type":"text"},{"key":"numberId","value":"1","description":"[Integer] *(Optional)*\nWhatsapp number whose templates you want to synchronize","type":"text"}]},"url":"{{BaseUrl}}/rest/api/wa/template/sync/all"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d5a9ba41-9cc1-427c-af6b-3c0f32bd757c"}],"id":"fec05567-a26e-47a1-a4a9-1da5730b4537","_postman_id":"fec05567-a26e-47a1-a4a9-1da5730b4537","description":"","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}}},{"name":"SSO (beta)","item":[{"name":"New Token","id":"63cb9428-6887-4a0d-874e-8f9bda46666a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{BaseUrl}}/rest/api/sso/token","description":"Crete a new token to log into the platform.
\n\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
Thanks to this API it's possible to access the platform using a temporary token.
\n\n\n","_postman_id":"b77ebd9c-dcb3-4ff6-b091-74dca51422ab","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}}},{"name":"Blacklist","item":[{"name":"Add contact to Blacklist","id":"e3600ac4-1082-4727-ba03-377514042acf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"sms","value":"true","description":"In order to use the SSO API you must ask for permissions..
\n
Ask here
[Boolean] (Mandatory)
\nadd to the SMS Blacklist
\n","type":"text"},{"key":"email","value":"false","description":"[Boolean] (Mandatory)
\nAdd to the Email Blacklist
\n","type":"text"}]},"url":"{{BaseUrl}}/rest/api/blacklist/contact/:contactId","description":"Add or remove the contact to the SMS or Email blacklist
\n\n\nThe \"Content-Type\" for this POST request must be \"application/x-www-form-urlencoded\"
\n
[Number] (Mandatory)
\nID of the contact to add to the blacklist
\n","type":"text/plain"},"type":"any","value":"12345678","key":"contactId"}]}},"response":[{"id":"5c195dd0-05d3-4f40-9c2d-69d114b294a6","name":"Aggiungi contatto a blacklist","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"sms","value":"true","description":"[Boolean] *(Obbligatorio)*\n\nInserisci contatto nella Blacklist SMS","type":"text"},{"key":"email","value":"false","description":"[Boolean] *(Obbligatorio)*\n\nInserisci contatto nella Blacklist Email","type":"text"}]},"url":{"raw":"{{BaseUrl}}/rest/api/blacklist/contact/:contactId/add","host":["{{BaseUrl}}"],"path":["rest","api","blacklist","contact",":contactId","add"],"variable":[{"key":"contactId","value":"12345678","description":"[Number] *(Obbligatorio)*\n\nID del contatto da inserire in Blacklist"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"59"},{"key":"date","value":"Tue, 25 May 2021 06:54:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"blacklistSms\": \"INSERTED\",\n \"blacklistEmail\": \"NOT_INSERTED\"\n}"}],"_postman_id":"e3600ac4-1082-4727-ba03-377514042acf"},{"name":"Get contact from Blacklist","id":"d7d6cdb0-ac44-4c69-9abd-096e0913daab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/blacklist/contact/:contactId","description":"Check if the contact is in the SMS or Email Blacklist.
\n[Number] (Mandatory)
\nID of the contact to check
\n","type":"text/plain"},"type":"any","value":"12345678","key":"contactId"}]}},"response":[{"id":"36834cf5-15d6-4710-ac8a-fe233b8ad0e5","name":"Contatto in blacklist","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/blacklist/contact/:contactId","host":["{{BaseUrl}}"],"path":["rest","api","blacklist","contact",":contactId"],"variable":[{"key":"contactId","value":"12345678","description":"[Number] *(Obbligatorio)*\n\nID del contatto da inserire in Blacklist"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"59"},{"key":"date","value":"Tue, 25 May 2021 06:55:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"blacklistSms\": \"INSERTED\",\n \"blacklistEmail\": \"NOT_INSERTED\"\n}"}],"_postman_id":"d7d6cdb0-ac44-4c69-9abd-096e0913daab"},{"name":"Get MSISDN Blacklist","id":"2898e780-cf32-4574-8a5f-29d94d6ca9f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/blacklist/msisdn/list","description":"Get the list of phone numbers in your SMS Blacklist
\n[String] (Optional)\nContact's phone number.\nThe number must contain the international prefix. ex. 393480000000
\n","type":"text/plain"},"key":"msisdn","value":"393400000000"},{"disabled":true,"description":{"content":"[String] (Optional )\nSearch the blacklist entities added since this date (format yyyy-MM-ddTHH:mm:ssZ)\nThe Z character indicates the timezone in RFC822 4-digit format.\nFor Italy +0200 during summer time and +0100 during the rest of the year.
\n","type":"text/plain"},"key":"fromDate","value":"2022-03-07T00:00:00%2b0100"},{"disabled":true,"description":{"content":"[Number] (Optional)\nPosition of the first result that will be returned.
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"[Number] (Optional)\nNumber of retrieved results.\nDefault: 20
\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"3e465386-eddd-4500-be37-f5d8f95a9984","name":"Get MSISDN Blacklist","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/blacklist/msisdn/list?limit=10&fromDate=2022-03-07T00:00:00%2b0100","host":["{{BaseUrl}}"],"path":["rest","api","blacklist","msisdn","list"],"query":[{"key":"limit","value":"10","type":"text"},{"key":"fromDate","value":"2022-03-07T00:00:00%2b0100","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"59"},{"key":"date","value":"Tue, 25 May 2021 06:55:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"limit\": 50\n },\n \"blacklist\": [\n \"393400000000\"\n ]\n}"}],"_postman_id":"2898e780-cf32-4574-8a5f-29d94d6ca9f9"},{"name":"Get Email Blacklist","id":"8cde2ce5-475d-4e25-8090-a1daa8da115f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUrl}}/rest/api/blacklist/email/list","description":"Get the list of emails in your Emsil Blacklist
\n[String] (Optional)\nEmail to check
\n","type":"text/plain"},"key":"email","value":"testblacklist@fake.it"},{"disabled":true,"description":{"content":"[String] (Optional )\nSearch the blacklist entities added since this date (format yyyy-MM-ddTHH:mm:ssZ)\nThe Z character indicates the timezone in RFC822 4-digit format.\nFor Italy +0200 during summer time and +0100 during the rest of the year.
\n","type":"text/plain"},"key":"fromDate","value":"2022-03-07T00:00:00%2b0100"},{"disabled":true,"description":{"content":"[Number] (Optional)\nPosition of the first result that will be returned.
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"[Number] (Optional)\nNumber of retrieved results.\nDefault: 20
\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"844d3696-4a66-4a18-aa16-4e5959fd2a40","name":"Get Email Blacklist","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AAAxxxxxxxxxxxxxxxxxxx","type":"text"}],"url":{"raw":"{{BaseUrl}}/rest/api/blacklist/email/list?limit=10&fromDate=2022-03-07T00:00:00%2b0100","host":["{{BaseUrl}}"],"path":["rest","api","blacklist","email","list"],"query":[{"key":"limit","value":"10"},{"key":"fromDate","value":"2022-03-07T00:00:00%2b0100"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"59"},{"key":"date","value":"Tue, 25 May 2021 06:55:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"limit\": 50\n },\n \"blacklist\": [\n \"testblacklist@fake.it\"\n ]\n}"}],"_postman_id":"8cde2ce5-475d-4e25-8090-a1daa8da115f"}],"id":"7097b760-1e0e-4386-a6a0-166e38989304","description":"With these requests you can add or remove phone numbers or email from your blacklist, or get the entire list of blacklisted emails or number.
\n","_postman_id":"7097b760-1e0e-4386-a6a0-166e38989304","auth":{"type":"basic","basic":{"username":"{{auth_key}}","password":"{{auth_secret}}"},"isInherited":true,"source":{"_postman_id":"26c7eb83-3738-43c5-889f-bef45346c9d8","id":"26c7eb83-3738-43c5-889f-bef45346c9d8","name":"Smshosting REST API EN","type":"collection"}}},{"name":"Webhook","item":[{"name":"Status Callback","id":"02b24930-30f5-4183-bea2-93f2748276d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"12345678","description":"[String]
\nInternal ID of the sent message
\n","type":"text"},{"key":"transactionId","value":"a1b2c3d4e5f6","description":"[String]
\nPersonal identifier of the send.
\n","type":"text"},{"key":"to","value":"3480000000","description":"[String]
\nThe recipient of the message.
\n","type":"text"},{"key":"channel","value":"SMS","description":"[String]
\nThe message channel in its current state.\nThis parameter can be enhanced with:
\nsms - The message is in the SMS channelrcs - The message is in the RCS channelwhatsapp - The message is in the WhatsApp channel[String]
\nThe status of the message.
\nThis parameter will be valorised with:
\nDELIVERED - delivered SMS NOTDELIVERED - undeliverable SMS[String]
\nString that explains the cause of a possible error
\n","type":"text","uuid":"735ea89f-95c7-4c80-b5b2-f907a5f16cb1"},{"key":"notificationDate","value":"2021-01-01T13%3A11%3A03%2B0200","description":"[String]
\nDate the message changed status (url encoded in yyyy-MM-ddTHH:mm:ssZ format) .
\nThe Z character indicates the timezone in RFC 822 4-digit format. (For Italy +0200 during summer time and +0100 in the rest of the year).
\nFor example:
\n2014-12-25T08:00:00+0200 indicates 12/25/2014 at 08:00:00 referring to GMT +2
\n","type":"text"}]},"url":"https://tuodominio.com/tuo-percorso-callback","description":"If the statusCallback parameter was set during sending, our server will make a POST call to the URL you specified to notify you of the sending status.
If you don't want to manage the Status Callback you can at any time query the status of one or more messages sent with the \"search\" function of the channel used.
\n\n\nThe \"Content-Type\" of this POST call will be \"application/x-www-form-urlencoded\"
\n
Our server will accept these response codes to the call made to your url:
\n","urlObject":{"protocol":"https","path":["tuo-percorso-callback"],"host":["tuodominio","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"02b24930-30f5-4183-bea2-93f2748276d5"},{"name":"Send Bulk Callback","id":"b8baa8cf-2f66-43e1-b84c-cfc3dfa0434e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://tuodominio.com/tuo-percorso-bulk-callback","description":"In bulk sending you can specify a URL with the transactionCallback parameter.
Our server will make calls to this URL to notify the outcome of the sending once it is completed.
\n\n\nThe \"Content-Type\" of this POST call will be \"application/json\"
\n
Our server will accept these response codes to the call made to your URL
\n{\"status\": \"ERROR\", \"errorMsg\": \"NO_CREDIT\", \"transactionId\": \"a1b2c3d4e5f6\"}\n\n{\n \"status\": \"COMPLETED\",\n \"from\": \"TestSender\",\n \"text\": \"Sending TEST\",\n \"transactionId\": \"a1b2c3d4e5f6\",\n \"smsInserted\": 1,\n \"smsNotInserted\": 0,\n \"sms\":[\n {\n \"to\":\"39340000000\",\n \"status\":\"INSERTED\",\n \"id\":12345678\n }\n ]\n}\n\n