{"info":{"_postman_id":"106a4cbd-92ba-61cf-b508-bddfb5d899ae","name":"smSend","description":"

Rest API SMS documentation

Create test and develop application with our SMS core functions.

Create contact, manage groups and purchase, send sms, receive sms etc.

Full example in SHELL, JAVA, PHP, PYTHON, NODE, RUBY, C# and PERL available on https://www.smsend.it/rest-api/

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"439263","collectionId":"106a4cbd-92ba-61cf-b508-bddfb5d899ae","publishedId":"SVSHqp9i","public":true,"customColor":{"top-bar":"EDEDED","right-sidebar":"393939","highlight":"367DCD"},"publishDate":"2019-07-12T16:15:39.000Z"},"item":[{"name":"Authentication API","item":[{"name":"Authenticate using a session key","id":"e2ea7f7d-995d-457d-9e1e-556659d626a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://app.gateway.smsend.it/API/v1.0/REST/login?username=&password=","description":"

The login with session key API lets you authenticate by using your username and password, and returns a token to be used for authenticating the next API calls.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","login"],"host":["app","gateway","smsend","it"],"query":[{"description":{"content":"

Your account’s username

\n","type":"text/plain"},"key":"username","value":""},{"description":{"content":"

Your account’s dispositive password

\n","type":"text/plain"},"key":"password","value":""}],"variable":[]}},"response":[{"id":"8ac3c38e-96b1-4685-a4b0-fc5a4634bf72","name":"Authenticate using a session key","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/login?username=&password=","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","login"],"query":[{"key":"username","value":"","description":"Your account’s username"},{"key":"password","value":"","description":"Your account’s dispositive password"}]}},"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{USER_KEY};{SESSION_KEY}"}],"_postman_id":"e2ea7f7d-995d-457d-9e1e-556659d626a9"},{"name":"Authenticate using a user token","id":"3b7004e9-03ae-49d8-b71a-905b31a0a97f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://app.gateway.smsend.it/API/v1.0/REST/token?username=&password=","description":"

The login with token API lets you authenticate by using your username and password, and returns a token to be used for authenticating the next API calls.

\n","urlObject":{"protocol":"http","path":["API","v1.0","REST","token"],"host":["app","gateway","smsend","it"],"query":[{"description":{"content":"

Your account’s username

\n","type":"text/plain"},"key":"username","value":""},{"description":{"content":"

Your account’s dispositive password

\n","type":"text/plain"},"key":"password","value":""}],"variable":[]}},"response":[{"id":"5835acd8-d7bf-421e-bd03-e1879ea40905","name":"Authenticate using a user token{USER_KEY};{SESSION_KEY}","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://app.gateway.smsend.it/API/v1.0/REST/token?username=&password=","protocol":"http","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","token"],"query":[{"key":"username","value":"","description":"Your account’s username"},{"key":"password","value":"","description":"Your account’s dispositive password"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{USER_KEY};{ACCESS_TOKEN}"}],"_postman_id":"3b7004e9-03ae-49d8-b71a-905b31a0a97f"}],"id":"6cf9d435-614f-4491-ae30-95e3b41fcbca","description":"

Authentication methods\nThe following are the two available methods to authenticate a user, given a username and a password (registration required):

Using a temporary session key, which expires after a certain amount of time has passed with no performed API calls with that key.
\n
Using a temporary session key, which expires after a certain amount of time has passed with no performed API calls with that key.
\n

In both cases, the returned user_key, as well as the session key or the token, are required to be provided in the HTTP request headers in order to perform any API call after the login.

\n","event":[{"listen":"prerequest","script":{"id":"27367903-dd6f-4cbd-aa60-e210f3bcc527","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d6b0ad29-878e-4903-9d3f-b13c9c7beda0","type":"text/javascript","exec":[""]}}],"_postman_id":"6cf9d435-614f-4491-ae30-95e3b41fcbca"},{"name":"User API","item":[{"name":"Dashboard","id":"fc6955b1-c6ec-44fb-bfc7-245047c8360c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user_key","value":"","description":"

Authenticated user_key

\n","type":"text"},{"key":"Session_key","value":"","description":"

Authenticated Session_key

\n","type":"text"}],"url":"https://app.gateway.smsend.it/API/v1.0/REST/dashboard","description":"

API used to retrieve the dashboard URL of the authenticated user

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","dashboard"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"c22bb853-f075-4c5f-a2b5-bfc4aac91df4","name":"Dashboard","originalRequest":{"method":"GET","header":[{"key":"user_key","value":"","description":"Authenticated user_key ","type":"text"},{"key":"Session_key","value":"","description":"Authenticated Session_key","type":"text"}],"url":"https://app.gateway.smsend.it/API/v1.0/REST/dashboard"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"https://app.gateway.smsend.it/API/v1.0/REST//s/user/external-auth?k=07366A25DF70038A22B9D284AB13E856BD95C6227&action=FC07AD201AE372F378&action-params=7010AB"}],"_postman_id":"fc6955b1-c6ec-44fb-bfc7-245047c8360c"},{"name":"Verify session","id":"edfb9749-c30c-4b16-bf44-f03b400b31c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user_key","value":"","description":"

Authenticated user_key

\n","type":"text"},{"key":"Session_key","value":"","description":"

Authenticated Session_key

\n","type":"text"}],"url":"https://app.gateway.smsend.it/API/v1.0/REST/checksession","description":"

Checks whether the user session is still active and valid (without renewal).

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","checksession"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"7a444124-2ab5-45ce-bee5-4cceb6c430e8","name":"Verify session","originalRequest":{"method":"GET","header":[{"key":"user_key","value":"","description":"Authenticated user_key ","type":"text"},{"key":"Session_key","value":"","description":"Authenticated Session_key","type":"text"}],"url":"https://app.gateway.smsend.it/API/v1.0/REST/checksession"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"\"true\" or \"false\""}],"_postman_id":"edfb9749-c30c-4b16-bf44-f03b400b31c2"},{"name":"Reset password","id":"e3d97731-51ee-4e40-8796-de11559c84bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"url":"https://app.gateway.smsend.it/API/v1.0/REST/pwdreset?password=","description":"

Changes the authenticated user’s password

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","pwdreset"],"host":["app","gateway","smsend","it"],"query":[{"description":{"content":"

The new user password

\n","type":"text/plain"},"key":"password","value":""}],"variable":[]}},"response":[{"id":"e684271c-1576-4375-a9b9-014abb1d5003","name":"Reset password","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/pwdreset?password=","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","pwdreset"],"query":[{"key":"password","value":"","description":"The new user password"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"\"true\" or \"false\""}],"_postman_id":"e3d97731-51ee-4e40-8796-de11559c84bc"},{"name":"User Status","id":"bbb0c656-4462-477b-b294-e4cc32c7c1c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"url":"https://app.gateway.smsend.it/API/v1.0/REST/status?getMoney=false","description":"

Used to retrieve the services status of the user identified by the id.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","status"],"host":["app","gateway","smsend","it"],"query":[{"description":{"content":"

Add user current money to response

\n","type":"text/plain"},"key":"getMoney","value":"false"}],"variable":[]}},"response":[{"id":"e7c03828-7cde-4a7b-ab2b-068f1df85df3","name":"User Status","originalRequest":{"method":"GET","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/status?getMoney=false","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","status"],"query":[{"key":"getMoney","value":"false","description":"Add user current money to response"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"money\": null, \r\n \"sms\": [\r\n {\r\n \"type\": \"LL\", \r\n \"quantity\": 16079\r\n }, \r\n {\r\n \"type\": \"L\", \r\n \"quantity\": 11815\r\n }, \r\n {\r\n \"type\": \"N\", \r\n \"quantity\": 10407\r\n }, \r\n {\r\n \"type\": \"EE\", \r\n \"quantity\": 10387\r\n }\r\n ], \r\n \"email\": {\r\n \"bandwidth\": 2000.0, \r\n \"purchased\": \"2015-01-16\", \r\n \"billing\": \"EMAILPERHOUR\", \r\n \"expiry\": \"2016-01-17\"\r\n }, \r\n \"landing\": null\r\n}"}],"_postman_id":"bbb0c656-4462-477b-b294-e4cc32c7c1c3"}],"id":"75443545-9857-4f37-b40e-9df2040126d8","description":"

The following are utility functions regarding the Authenticated User

E.g. the user status, password reset, dashboard access etc

Remember to provide the authentication HTTP headers as described in the Authenticate using a session key and the Authenticate using a user tokeny sections.

All the query string parameters in URL must be UTF-8 URL Encoded.

\n","event":[{"listen":"prerequest","script":{"id":"eccff535-05f1-4d1b-8002-cdb130da10e5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4f35ac83-59da-446a-b022-68e5a760eb0a","type":"text/javascript","exec":[""]}}],"_postman_id":"75443545-9857-4f37-b40e-9df2040126d8"},{"name":"Contacts API","item":[{"name":"Add a contact","id":"5d0f772b-5b5d-4bce-90c6-88457e8836c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String (A valid email)","description":"

The email of the contact

\n","key":"email","type":"text","value":""},{"contentType":"String (A non empty string)","description":"

The phone number of the contact

\n","key":"phoneNumber","type":"text","value":"\"\""},{"contentType":"String (max 40 chars)","description":"

The first name of the contact

\n","key":"name","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 40 chars)","description":"

The last name of the contact

\n","key":"surname","type":"text","value":"\"\"","disabled":true},{"contentType":"String (“m” or “f”)","description":"

The gender of the contact

\n","key":"gender","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 32 chars)","description":"

The Fax number of the contact

\n","key":"fax","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 256 chars)","description":"

The address of the contact

\n","key":"address","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 32 chars)","description":"

The city of the contact

\n","key":"city","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 32 chars)","description":"

The province of the contact

\n","key":"province","type":"text","value":"\"\"","disabled":true},{"contentType":"String [ddMMyy, yyyyMMdd, ddMMyyHHmm, yyyyMMddHHmmss, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm.0]","description":"

The birth date of the contact

\n","key":"birthdate","type":"text","value":"\"\"","disabled":true},{"contentType":"String [ddMMyy, yyyyMMdd, ddMMyyHHmm, yyyyMMddHHmmss, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm.0]","description":"

An additional date field

\n","key":"promotiondate","type":"text","value":"\"\"","disabled":true},{"contentType":"String [ddMMyy, yyyyMMdd, ddMMyyHHmm, yyyyMMddHHmmss, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm.0]","description":"

An additional date field

\n","key":"rememberdate","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 16 chars)","description":"

The ZIP code of the contact

\n","key":"zip","type":"text","value":"\"\"","disabled":true},{"contentType":"List(String)","description":"

The groups (Ids) in which the contact will be added

\n","key":"groupIds","type":"text","value":"[]","disabled":true},{"contentType":"String","description":"

Custom field 1

\n","key":"custom1","type":"text","value":"\"\"","disabled":true},{"contentType":"String","description":"

Custom field 2

\n","key":"custom2","type":"text","value":"\"\"","disabled":true},{"contentType":"String","description":"

Custom field 3

\n","key":"custom3","type":"text","value":"\"\"","disabled":true},{"contentType":"String","description":"

Custom field 4

\n","key":"custom4","type":"text","value":"\"\"","disabled":true},{"contentType":"String","description":"

Custom field 5

\n","key":"custom5","type":"text","value":"\"\"","disabled":true},{"contentType":"String","description":"

Custom field 6

\n","key":"custom6","type":"text","value":"\"\"","disabled":true},{"contentType":"String","description":"

Custom field 7

\n","key":"custom7","type":"text","value":"\"\"","disabled":true},{"contentType":"String","description":"

Custom field 8

\n","key":"custom8","type":"text","value":"\"\"","disabled":true},{"contentType":"String","description":"

Custom field 9

\n","key":"custom9","type":"text","value":"\"\"","disabled":true},{"contentType":"String","description":"

Custom field 10

\n","key":"custom10","type":"text","value":"\"\"","disabled":true}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/contact","description":"

Add a contact to the user’s addressbook.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","contact"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"ab45ad7c-31dd-4d30-a734-c9186cc6dfb7","name":"Add a contact","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String (A valid email)","description":"The email of the contact","key":"email","type":"text","value":""},{"contentType":"String (A non empty string)","description":"The phone number of the contact","key":"phoneNumber","type":"text","value":"\"\""},{"contentType":"String (max 40 chars)","description":"The first name of the contact\t","key":"name","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 40 chars)","description":"The last name of the contact","key":"surname","type":"text","value":"\"\"","disabled":true},{"contentType":"String (“m” or “f”)","description":"The gender of the contact","key":"gender","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 32 chars)","description":"The Fax number of the contact","key":"fax","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 256 chars)","description":"The address of the contact","key":"address","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 32 chars)","description":"The city of the contact","key":"city","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 32 chars)","description":"The province of the contact","key":"province","type":"text","value":"\"\"","disabled":true},{"contentType":"String [ddMMyy, yyyyMMdd, ddMMyyHHmm, yyyyMMddHHmmss, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm.0]","description":"The birth date of the contact","key":"birthdate","type":"text","value":"\"\"","disabled":true},{"contentType":"String [ddMMyy, yyyyMMdd, ddMMyyHHmm, yyyyMMddHHmmss, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm.0]","description":"An additional date field","key":"promotiondate","type":"text","value":"\"\"","disabled":true},{"contentType":"String [ddMMyy, yyyyMMdd, ddMMyyHHmm, yyyyMMddHHmmss, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm.0]","description":"An additional date field","key":"rememberdate","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 16 chars)","description":"The ZIP code of the contact","key":"zip","type":"text","value":"\"\"","disabled":true},{"contentType":"List(String)","description":"The groups (Ids) in which the contact will be added","key":"groupIds","type":"text","value":"[]","disabled":true},{"contentType":"String","description":"Custom field 1","key":"custom1","type":"text","value":"\"\"","disabled":true},{"contentType":"String","description":"Custom field 2","key":"custom2","type":"text","value":"\"\"","disabled":true},{"contentType":"String","description":"Custom field 3","key":"custom3","type":"text","value":"\"\"","disabled":true},{"contentType":"String","description":"Custom field 4","key":"custom4","type":"text","value":"\"\"","disabled":true},{"contentType":"String","description":"Custom field 5","key":"custom5","type":"text","value":"\"\"","disabled":true},{"contentType":"String","description":"Custom field 6","key":"custom6","type":"text","value":"\"\"","disabled":true},{"contentType":"String","description":"Custom field 7","key":"custom7","type":"text","value":"\"\"","disabled":true},{"contentType":"String","description":"Custom field 8","key":"custom8","type":"text","value":"\"\"","disabled":true},{"contentType":"String","description":"Custom field 9","key":"custom9","type":"text","value":"\"\"","disabled":true},{"contentType":"String","description":"Custom field 10","key":"custom10","type":"text","value":"\"\"","disabled":true}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/contact"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"On success, the above command returns the following response:\r\n# The HTTP location header that points to the created contact:\r\nLocation': '/contact/AVvZEwZHHnl8wUZve6CT'"}],"_postman_id":"5d0f772b-5b5d-4bce-90c6-88457e8836c3"},{"name":"Add multiple contacts","id":"e5dad32e-f672-434c-9b76-eac793e66440","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"key":"contacts","value":"\"\"","description":"

Array of Json object, formatted as ADD a contact

\n","type":"text","contentType":"Json array of Contacts\t"},{"key":"updateExistingContact","value":"false","description":"

True to update existing contacts in case of clash, false to drop and insert them

\n","type":"text","contentType":"Boolean","disabled":true},{"key":"keepExistingGroupsAndCampaigns","value":"false","description":"

True to keep all old contact groups associations and campaigns subscription

\n","type":"text","contentType":"Boolean","disabled":true}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/contact","description":"

Add multiple contacts to the user’s addressbook.

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/contact/{contactid}","description":"

Get a contact’s details

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","contact","{contactid}"],"host":["app","gateway","smsend","it"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"ddf7ce84-45b3-470f-ab34-99e0d635c5c7","name":"Get a contact","originalRequest":{"method":"GET","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/contact/{contactid}","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","contact","{contactid}"],"query":[{"key":"","value":"","type":"text","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"email\":\"alessandro.magno@macedonia.com\",\r\n \"phoneNumber\":\"+39349123456789\",\r\n \"name\": \"Alessandro\",\r\n \"surname\": \"Magno\",\r\n \"groupIds\":[ ],\r\n \"gender\":\"m\",\r\n \"fax\":null,\r\n \"address\":null,\r\n \"city\":null,\r\n \"province\":null,\r\n \"birthdate\":\"2017-05-11\",\r\n \"zip\":null\r\n}"}],"_postman_id":"90a1a580-4da5-4ba7-8140-b8c50fb2a916"},{"name":"Registration of a contact to a list","id":"026be257-401f-42da-bef6-2f6400f3a76a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String (A valid email)","description":"

The email of the contact

\n","key":"email","type":"text","value":""},{"contentType":"String (A non empty string)","description":"

The phone number of the contact

\n","key":"phoneNumber","type":"text","value":"\"\""},{"contentType":"String (max 40 chars)","description":"

The first name of the contact

\n","key":"name","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 40 chars)","description":"

The last name of the contact

\n","key":"surname","type":"text","value":"\"\"","disabled":true},{"contentType":"String (“m” or “f”)","description":"

The gender of the contact

\n","key":"gender","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 32 chars)","description":"

The Fax number of the contact

\n","key":"fax","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 256 chars)","description":"

The address of the contact

\n","key":"address","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 32 chars)","description":"

The city of the contact

\n","key":"city","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 32 chars)","description":"

The province of the contact

\n","key":"province","type":"text","value":"\"\"","disabled":true},{"contentType":"String [ddMMyy, yyyyMMdd, ddMMyyHHmm, yyyyMMddHHmmss, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm.0]","description":"

The birth date of the contact

\n","key":"birthdate","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 16 chars)","description":"

The ZIP code of the contact

\n","key":"zip","type":"text","value":"\"\"","disabled":true},{"contentType":"List(String)","description":"

The groups (Ids) in which the contact will be added

\n","key":"groupIds","type":"text","value":"[]","disabled":true}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/list/{campaign_id}/contact","description":"

Creates a new contact entry and adds it onto the specified campaign.

These APIs are intended to be used in external “User registration forms” where a user is invited to Opt-in by submitting an email address together with some other personal data (e.g. first name and last name)

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","list","{campaign_id}","contact"],"host":["app","gateway","smsend","it"],"query":[{"disabled":true,"description":{"content":"

Send an Opt-In email to the contact’s email

\n","type":"text/plain"},"key":"SendOptIn","value":"false"}],"variable":[]}},"response":[{"id":"f14ac381-9af5-4b01-b3e5-4fe07072c973","name":"Registration of a contact to a list","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String (A valid email)","description":"The email of the contact","key":"email","type":"text","value":""},{"contentType":"String (A non empty string)","description":"The phone number of the contact","key":"phoneNumber","type":"text","value":"\"\""},{"contentType":"String (max 40 chars)","description":"The first name of the contact\t","key":"name","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 40 chars)","description":"The last name of the contact","key":"surname","type":"text","value":"\"\"","disabled":true},{"contentType":"String (“m” or “f”)","description":"The gender of the contact","key":"gender","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 32 chars)","description":"The Fax number of the contact","key":"fax","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 256 chars)","description":"The address of the contact","key":"address","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 32 chars)","description":"The city of the contact","key":"city","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 32 chars)","description":"The province of the contact","key":"province","type":"text","value":"\"\"","disabled":true},{"contentType":"String [ddMMyy, yyyyMMdd, ddMMyyHHmm, yyyyMMddHHmmss, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm.0]","description":"The birth date of the contact","key":"birthdate","type":"text","value":"\"\"","disabled":true},{"contentType":"String (max 16 chars)","description":"The ZIP code of the contact","key":"zip","type":"text","value":"\"\"","disabled":true},{"contentType":"List(String)","description":"The groups (Ids) in which the contact will be added","key":"groupIds","type":"text","value":"[]","disabled":true}]},"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/list/{campaign_id}/contact","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","list","{campaign_id}","contact"],"query":[{"key":"SendOptIn","value":"false","description":"Send an Opt-In email to the contact’s email","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"\"\""}],"_postman_id":"026be257-401f-42da-bef6-2f6400f3a76a"},{"name":"List contact’s custom fields","id":"bce7b0a3-00e2-4853-a6d3-a46d24406131","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.smsend.it/API/v1.0/REST/contacts/fields","description":"

Returns the list of user’s defined custom fields

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","contacts","fields"],"host":["api","smsend","it"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"12c4e685-0240-4954-90db-44ed94f2e3b2","name":"List contact’s custom fields","originalRequest":{"method":"GET","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.smsend.it/API/v1.0/REST/contacts/fields","protocol":"https","host":["api","smsend","it"],"path":["API","v1.0","REST","contacts","fields"],"query":[{"key":"","type":"text","value":"","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"idField\": \"{CUSTOM_KEY}\",\r\n \"placeholder\": \"%{PLACEHOLDER_NAME}%\",\r\n \"label\": \"{LABEL_OR_KEY_TO_BE_DISPLAYED}\",\r\n \"dataType\": \"{STRING|INTEGER|DATE|EMAIL|BOOLEAN}\"\r\n }\r\n]"}],"_postman_id":"bce7b0a3-00e2-4853-a6d3-a46d24406131"},{"name":"Add contact to sms blacklist","id":"8fd7a1b9-9622-4d43-9a62-87eda1d7da3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/contact/add_to_blacklist/{CONTACT_ID}","description":"

Returns the result of operation

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","contact","add_to_blacklist","{CONTACT_ID}"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"08a8bfdf-087b-4c15-bbcb-bd52f978a488","name":"Add contact to sms blacklist","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/contact/add_to_blacklist/{CONTACT_ID}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"8fd7a1b9-9622-4d43-9a62-87eda1d7da3a"},{"name":"Add multiple contacts to sms blacklist","id":"ad39ae12-07cb-4de1-9573-3e1436bc9838","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"key":"","value":"[]","description":"

Array of contact ids

\n","type":"text","contentType":"List(String)"}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/contact/add_to_blacklist_batch","description":"

Add multiple contacts to the user’s blacklist.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","contact","add_to_blacklist_batch"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"aac570e9-5672-4eea-bf00-fd7753532032","name":"Add multiple contacts to sms blacklist","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"key":"","value":"[]","description":"Array of contact ids","type":"text","contentType":"List(String)"}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/contact/add_to_blacklist_batch"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"On success, the above command returns the following response: 2 (number of contact put in blacklist)"}],"_postman_id":"ad39ae12-07cb-4de1-9573-3e1436bc9838"},{"name":"Add phone number to sms blacklist","id":"7cb6b6b0-93ed-4962-bf82-25779b8d8abb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/contacts/add_to_blacklist?phoneNumber=","description":"

Creates a new contact entry and adds it onto the specified campaign.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","contacts","add_to_blacklist"],"host":["app","gateway","smsend","it"],"query":[{"description":{"content":"

The phone number that will be added to blacklist

\n","type":"text/plain"},"key":"phoneNumber","value":""}],"variable":[]}},"response":[{"id":"578f281d-d5db-416a-86ad-db900aa89817","name":"Add phone number to sms blacklist","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/contacts/add_to_blacklist?phoneNumber=","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","contacts","add_to_blacklist"],"query":[{"key":"phoneNumber","value":"","description":"The phone number that will be added to blacklist"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"7cb6b6b0-93ed-4962-bf82-25779b8d8abb"}],"id":"97b64690-42f6-4465-b8a7-80e37c5096ab","description":"

This part of the API is used to manage contacts.

A contact can be used both in SMS and Email sending, provided that a phone number and/or an email address are given.

Remember to provide the authentication HTTP headers as described in the Authenticate using a session key and the Authenticate using a user tokeny sections.

All the query string parameters in URL must be UTF-8 URL Encoded.

\n","event":[{"listen":"prerequest","script":{"id":"d05de5ab-0534-43a7-80ad-5fd0e94d176e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"484454d7-37ac-4149-b4cc-40179de2c95d","type":"text/javascript","exec":[""]}}],"_postman_id":"97b64690-42f6-4465-b8a7-80e37c5096ab"},{"name":"Contacts groups API","item":[{"name":"Create a contacts group","id":"f9ca32e9-7d6a-4fc9-a71b-1d5313d542a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String","description":"

The name of the group

\n","key":"name","type":"text","value":""},{"contentType":"String","description":"

The description of the group

\n","key":"description","type":"text","value":""}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/group","description":"

Creates an empty group of contacts given a name and a description.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","group"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"7e46182c-6861-4141-bc03-2d136fe9cd95","name":"Create a contacts group","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String","description":"The name of the group","key":"name","type":"text","value":""},{"contentType":"String","description":"The description of the group","key":"description","type":"text","value":""}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/group"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"On success, the above command returns the following response:\r\n# The HTTP location header that points to the created group:\r\n'Location': '/group/{group_id}'"}],"_postman_id":"f9ca32e9-7d6a-4fc9-a71b-1d5313d542a6"},{"name":"Modify an existing contacts group","id":"cdc1f278-37b0-4013-b08e-98dc959a3809","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String","description":"

The name of the group

\n","key":"name","type":"text","value":""},{"contentType":"String","description":"

The description of the group

\n","key":"description","type":"text","value":""}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/group/{group_id}","description":"

Updates a given contacts group

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","group","{group_id}"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"82756103-899d-4290-8ece-099e5218ac90","name":"Modify an existing contacts group","originalRequest":{"method":"PUT","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String","description":"The name of the group","key":"name","type":"text","value":""},{"contentType":"String","description":"The description of the group","key":"description","type":"text","value":""}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/group/{group_id}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"On success, the above command returns the following response:\r\n# The HTTP location header that points to the modified group:\r\n'Location': '/group/{group_id}'"}],"_postman_id":"cdc1f278-37b0-4013-b08e-98dc959a3809"},{"name":"Delete a contacts group","id":"4e88b637-cf5e-4736-b4ed-35e17626f1fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/group/{group_id}?deletecontacts=false","description":"

Deletes the contacts group identified by the given ID.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","group","{group_id}"],"host":["app","gateway","smsend","it"],"query":[{"description":{"content":"

If “true”, also deletes all contacts in the group

\n","type":"text/plain"},"key":"deletecontacts","value":"false"}],"variable":[]}},"response":[{"id":"95f4a6bf-b420-4f4f-a48a-65f54ae04ce5","name":"Delete a contacts group","originalRequest":{"method":"DELETE","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/group/{group_id}?deletecontacts=false","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","group","{group_id}"],"query":[{"key":"deletecontacts","value":"false","description":"If “true”, also deletes all contacts in the group"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"\"\""}],"_postman_id":"4e88b637-cf5e-4736-b4ed-35e17626f1fe"},{"name":"List contacts groups","id":"567851ed-f018-4ffc-8e65-485f9d5e5164","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/groups?pageNumber={1}&pageSize={5}","description":"

Returns the list of existing contacts groups, paginated.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","groups"],"host":["app","gateway","smsend","it"],"query":[{"description":{"content":"

The page number

\n","type":"text/plain"},"key":"pageNumber","value":"{1}"},{"description":{"content":"

The page size

\n","type":"text/plain"},"key":"pageSize","value":"{5}"}],"variable":[]}},"response":[{"id":"4005ae09-c572-4471-b59d-67d7cab55c7c","name":"List contacts groups","originalRequest":{"method":"GET","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/groups?pageNumber={1}&pageSize={5}","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","groups"],"query":[{"key":"pageNumber","value":"{1}","description":"The page number"},{"key":"pageSize","value":"{5}","description":"The page size"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"groups\":[ \"// The list of groups\"\r\n {\r\n \"id_group\": (string), \"// The ID of a group in the list\"\r\n \"group_name\": (string), \"// The group name\"\r\n \"group_description\": (string) \"// The group description\"\r\n },\r\n {...} \"// Other groups in the list (omitted..)\"\r\n ],\r\n \"pageNumber\": (int), \"// Paging: The page number\"\r\n \"pageSize\": (int), \"// Paging: The page size\"\r\n \"Total\": (int) \"// Paging: The total number of groups\"\r\n}"}],"_postman_id":"567851ed-f018-4ffc-8e65-485f9d5e5164"},{"name":"Add a contact to a group","id":"116f13d4-be5c-4cc2-a936-d5ce728380f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/group/{group_id}/contact/{contact_id}","description":"

Adds the specified contact in the specified contacts group.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","group","{group_id}","contact","{contact_id}"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"d84e18c4-90be-4cd5-b688-c9d1877e4118","name":"Add a contact to a group","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/group/{group_id}/contact/{contact_id}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"On success, the above command returns the following response:\r\n# The HTTP location header that points to the contact:\r\n'Location': '/contact/{contact_id}'"}],"_postman_id":"116f13d4-be5c-4cc2-a936-d5ce728380f8"},{"name":"Remove a contact from a group","id":"d22f3898-1f1e-4a9f-a520-1078b26e8059","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/group/{group_id}/contact/{contact_id}","description":"

Removes the specified contact from the specified contacts group.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","group","{group_id}","contact","{contact_id}"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"d8e61d86-24fa-4323-a73e-c2cc44a43e65","name":"Remove a contact from a group","originalRequest":{"method":"DELETE","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/group/{group_id}/contact/{contact_id}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"On success, the above command returns the following response:\r\n# The HTTP location header that points to the contact:\r\n'Location': '/contact/{contact_id}'"}],"_postman_id":"d22f3898-1f1e-4a9f-a520-1078b26e8059"}],"id":"0219db77-cb8a-4c5e-9712-3f514340a16a","description":"

This section describes how groups of contacts are created, updated and deleted.

SMS messages and emails can be directly sent to groups of contacts.

Remember to provide the authentication HTTP headers as described in the Authenticate using a session key and the Authenticate using a user tokeny sections.

All the query string parameters in URL must be UTF-8 URL Encoded.

\n","_postman_id":"0219db77-cb8a-4c5e-9712-3f514340a16a"},{"name":"TPOA API","item":[{"name":"Create a new alias","id":"9fea3d49-6b6d-486d-8638-aa5d2eb8d412","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String","description":"

The sender that will be shown on SMS

\n","key":"alias","type":"text","value":""},{"contentType":"String","description":"

The name of company associated to this alias

\n","key":"company-name","type":"text","value":""},{"contentType":"String","description":"

The name of physical person rappresenting the company

\n","key":"contact-name","type":"text","value":""},{"contentType":"String","description":"

The surname of physical person rappresenting the company

\n","key":"contact-surname","type":"text","value":""},{"contentType":"String","description":"

The fiscal code of company

\n","key":"cod-fiscale","type":"text","value":""},{"contentType":"String","description":"

The vat number of company

\n","key":"vat-number","type":"text","value":""},{"contentType":"String","description":"

The address of company

\n","key":"contact-address","type":"text","value":""},{"contentType":"String","description":"

The city of company

\n","key":"contact-city","type":"text","value":""},{"contentType":"String","description":"

The ZIP/Postal-code/CAP code of company

\n","key":"contact-pcode","type":"text","value":""},{"contentType":"String","description":"

The type of contact referred to contact-info: String enum(SERVICE_PHONE, MAIN_PHONE, FAX, EMAIL, PEC, WEB)

\n","key":"contact-type","type":"text","value":""},{"contentType":"String","description":"

The value of contact

\n","key":"contact-info","type":"text","value":""}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/alias","description":"

Creates a new TPOA Alias.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","alias"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"ad514ce6-63ab-48b3-9059-c2b5019a5d3e","name":"Create a new alias","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String","description":"The sender that will be shown on SMS\n","key":"alias","type":"text","value":""},{"contentType":"String","description":"The name of company associated to this alias\t","key":"company-name","type":"text","value":""},{"contentType":"String","description":"The name of physical person rappresenting the company","key":"contact-name","type":"text","value":""},{"contentType":"String","description":"The surname of physical person rappresenting the company","key":"contact-surname","type":"text","value":""},{"contentType":"String","description":"The fiscal code of company","key":"cod-fiscale","type":"text","value":""},{"contentType":"String","description":"The vat number of company","key":"vat-number","type":"text","value":""},{"contentType":"String","description":"The address of company","key":"contact-address","type":"text","value":""},{"contentType":"String","description":"The city of company","key":"contact-city","type":"text","value":""},{"contentType":"String","description":"The ZIP/Postal-code/CAP code of company","key":"contact-pcode","type":"text","value":""},{"contentType":"String","description":"The type of contact referred to contact-info: String enum(SERVICE_PHONE, MAIN_PHONE, FAX, EMAIL, PEC, WEB)","key":"contact-type","type":"text","value":""},{"contentType":"String","description":"The value of contact","key":"contact-info","type":"text","value":""}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/alias"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"result\": \"OK\"\r\n}"}],"_postman_id":"9fea3d49-6b6d-486d-8638-aa5d2eb8d412"},{"name":"Get all aliases","id":"4a4bbf62-1131-46ed-aae6-90830ec04f0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/alias?pageNumber={1}&pageSize={10}&hide-not-approved=false","description":"

Returns a paginated list of the user’s TPOA aliases.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","alias"],"host":["app","gateway","smsend","it"],"query":[{"description":{"content":"

Return the given results page

\n","type":"text/plain"},"key":"pageNumber","value":"{1}"},{"description":{"content":"

The number of results in a page

\n","type":"text/plain"},"key":"pageSize","value":"{10}"},{"description":{"content":"

Show or hide not-yet-approved aliases

\n","type":"text/plain"},"key":"hide-not-approved","value":"false"}],"variable":[]}},"response":[{"id":"f659b101-6f0d-479f-af9a-4ba5c88323a9","name":"Get all aliases","originalRequest":{"method":"GET","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/alias?pageNumber={1}&pageSize={10}&hide-not-approved=false","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","alias"],"query":[{"key":"pageNumber","value":"{1}","description":"Return the given results page"},{"key":"pageSize","value":"{10}","description":"The number of results in a page"},{"key":"hide-not-approved","value":"false","description":"Show or hide not-yet-approved aliases"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"alias\": [\r\n {\r\n \"contact-surname\": \"Dallago\",\r\n \"notification-time\": \"20140704124747\",\r\n \"cod-fiscale\": \"01843020221\",\r\n \"alias-state\": 3,\r\n \"contact-city\": \"Trento\",\r\n \"id-alias\": 36,\r\n \"contact-pcode\": \"38122\",\r\n \"vat-number\": \"01843020221\",\r\n \"alias\": \"Alias123\",\r\n \"company-name\": \"smSend\",\r\n \"contact-type\": \"FAX\",\r\n \"contact-info\": \"024113727142\",\r\n \"contact-name\": \"Stefano\",\r\n \"is-numeric\": false,\r\n \"contact-address\": \"Via Rosaccio 6\"\r\n },\r\n {\r\n \"contact-surname\": \"Dallago\",\r\n \"notification-time\": \"20161123155102\",\r\n \"cod-fiscale\": \"01843020221\",\r\n \"alias-state\": 2,\r\n \"contact-city\": \"Trento\",\r\n \"id-alias\": 662,\r\n \"contact-pcode\": \"38122\",\r\n \"vat-number\": \"03843020821\",\r\n \"alias\": \"dunp\",\r\n \"company-name\": \"smSend\",\r\n \"contact-type\": \"FAX\",\r\n \"contact-info\": \"04317378142\",\r\n \"contact-name\": \"Stefano\",\r\n \"is-numeric\": false,\r\n \"contact-address\": \"Via Rosaccio 6\"\r\n }\r\n ],\r\n \"total\": 2,\r\n \"pageNumber\": 1,\r\n \"result\": \"OK\",\r\n \"pageSize\": 10\r\n}"}],"_postman_id":"4a4bbf62-1131-46ed-aae6-90830ec04f0b"},{"name":"Get a specific alias","id":"e82490e3-f961-4750-91ff-4881111dbe65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/alias/{alias_id}","description":"

Returns the data of the given TPOA Alias ID.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","alias","{alias_id}"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"9062f0dd-7283-49d6-8c61-5aff3acd56f1","name":"Get a specific alias","originalRequest":{"method":"GET","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/alias/{alias_id}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"result\":\"OK\",\r\n \"alias\":{\r\n \"id-alias\":35,\r\n \"alias\":\"+393458922223\",\r\n \"notification-time\":\"20140704141759\",\r\n \"alias-state\":3,\r\n \"is-numeric\":true,\r\n \"company-name\":\"aCompany\",\r\n \"contact-name\":null,\r\n \"contact-surname\":null,\r\n \"cod-fiscale\":\"\",\r\n \"vat-number\":\"\",\r\n \"contact-address\":null,\r\n \"contact-city\":null,\r\n \"contact-pcode\":null,\r\n \"contact-type\":\"123456789\",\r\n \"contact-info\":\"\"\r\n }\r\n}"}],"_postman_id":"e82490e3-f961-4750-91ff-4881111dbe65"},{"name":"Remove an alias","id":"a8f57642-e411-47f2-bdb6-efc5d82076fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/alias/{alias_id}","description":"

Deletes the given TPOA Alias.

The TPOA (Transmission Path Originating Address) API is used to deal with TPOA entries (i.e. “SMS Sender aliases”) of the user.

Remember to provide the authentication HTTP headers as described in the Authenticate using a session key and the Authenticate using a user tokeny sections.

All the query string parameters in URL must be UTF-8 URL Encoded.

\n","_postman_id":"6aa85013-328b-47f7-a493-3f443a0b5751"},{"name":"SMS Send API","item":[{"name":"Send an SMS message","id":"fb8717ad-bfdf-4734-a6e3-fbbba87e108b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String (“N” for High quality with reception notification, “L” for Medium Quality, “LL” For Low Cost)","description":"

The type of SMS.

\n","key":"message_type","type":"text","value":""},{"contentType":"String (max 1000 chars)","description":"

The body of the message. *Message max length could be 160 chars when using low-quality SMSs

\n","key":"message","type":"text","value":""},{"contentType":"List(String)","description":"

A list of recipents phone numbers

\n","key":"recipient","type":"text","value":""},{"contentType":"String","description":"

The Sender name. If the message type allows a custom TPOA and the field is left empty, the user’s preferred TPOA is used. Must be empty if the message type does not allow a custom TPOA

\n","key":"sender","type":"text","value":"\"\"","disabled":true},{"contentType":"String [ddMMyy, yyyyMMdd, ddMMyyHHmm, yyyyMMddHHmmss, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm.0]","description":"

The messages will be sent at the given scheduled time

\n","key":"scheduled_delivery_time","type":"text","value":"null","disabled":true},{"key":"scheduled_delivery_timezone","value":"","description":"

Optional timezone applied to scheduled_delivery_time date

\n","type":"text","contentType":"Timezone(IANA time zone)","disabled":true},{"contentType":"String","description":"

Specifies a custom order ID

\n","key":"order_id","type":"text","value":"Generated UUID","disabled":true},{"contentType":"Bool","description":"

Returns the number of credits used instead of the number of messages. i.e. when message is more than 160 chars long more than one credit is used

\n","key":"returnCredits","type":"text","value":"false","disabled":true},{"key":"returnRemaining","value":"false","description":"

Returs the number of remaining SMSs

\n","type":"text","contentType":"Bool","disabled":true},{"key":"allowInvalidRecipients","value":"false","description":"

Sending to an invalid recipient does not block the operation

\n","type":"text","contentType":"Bool","disabled":true},{"contentType":"String (“gsm” or “ucs2”)","description":"

The SMS encoding. Use UCS2 for non standard character sets

\n","key":"encoding","type":"text","value":"gsm","disabled":true},{"key":"id_landing","value":"","description":"

The id of the published page. Also add the %PAGESLINK____________% placeholder in the message body

\n","type":"text","contentType":"int","disabled":true},{"key":"campaign_name","value":"","description":"

The campaign name

\n","type":"text","contentType":"String","disabled":true},{"key":"short_link_url","value":"","description":"

The url where the short link redirects. Also add the %SHORT_LINK% placeholder in the message body

\n","type":"text","contentType":"String","disabled":true}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/sms","description":"

Sends an SMS message to a given list of recipients.

Landing Pages URLs
\nIt is possible to include a link to a published Landing Page by specifying the {id_landing} parameter and by adding the following placeholder in the message body: {%PAGESLINK____________%}.

Landing pages must be first created and published in your user panel, since you will need {id_landing} to send it.

A list of published landing pages can be retrieved by using the Landing Pages APIs

Short URLs
\nWhen including URLs in the message, it may be convinient to use short URLs to limit the number of characters used in the SMS message.

Our API can automatically generate a short link starting from a long one, and add it in the message.

o use this feature, use the {%SHORT_LINK%} placeholder in the message body, that will be replaced with the generated short link, and the respective {short_link_url} parameter, that should be set to a valid URL. For shortlink dns personalization please contact us at helpdesk@smsend.it

Sender Alias
\nAlphanumeric aliases require to be registered first, and need to be approved both from Us and AGCOM.

Aliases can be used only with high-quality message types.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","sms"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"8c615972-31b5-49bb-864c-33c9f5a0418e","name":"Send an SMS message","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String (“N” for High quality with reception notification, “L” for Medium Quality, “LL” For Low Cost)","description":"The type of SMS.","key":"message_type","type":"text","value":""},{"contentType":"String (max 1000 chars)","description":"The body of the message. *Message max length could be 160 chars when using low-quality SMSs","key":"message","type":"text","value":""},{"contentType":"List(String)","description":"A list of recipents phone numbers","key":"recipient","type":"text","value":""},{"contentType":"String","description":"The Sender name. If the message type allows a custom TPOA and the field is left empty, the user’s preferred TPOA is used. Must be empty if the message type does not allow a custom TPOA","key":"sender","type":"text","value":"\"\"","disabled":true},{"contentType":"String [ddMMyy, yyyyMMdd, ddMMyyHHmm, yyyyMMddHHmmss, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm.0]","description":"The messages will be sent at the given scheduled time","key":"scheduled_delivery_time","type":"text","value":"null","disabled":true},{"key":"scheduled_delivery_timezone","value":"","description":"Optional timezone applied to scheduled_delivery_time date","type":"text","contentType":"Timezone(IANA time zone)","disabled":true},{"contentType":"String","description":"Specifies a custom order ID","key":"order_id","type":"text","value":"Generated UUID","disabled":true},{"contentType":"Bool","description":"Returns the number of credits used instead of the number of messages. i.e. when message is more than 160 chars long more than one credit is used","key":"returnCredits","type":"text","value":"false","disabled":true},{"key":"returnRemaining","value":"false","description":"Returs the number of remaining SMSs","type":"text","contentType":"Bool","disabled":true},{"key":"allowInvalidRecipients","value":"false","description":"Sending to an invalid recipient does not block the operation","type":"text","contentType":"Bool","disabled":true},{"contentType":"String (“gsm” or “ucs2”)","description":"The SMS encoding. Use UCS2 for non standard character sets","key":"encoding","type":"text","value":"gsm","disabled":true},{"key":"id_landing","value":"","description":"The id of the published page. Also add the %PAGESLINK____________% placeholder in the message body","type":"text","contentType":"int","disabled":true},{"key":"campaign_name","value":"","description":"The campaign name","type":"text","contentType":"String","disabled":true},{"key":"short_link_url","value":"","description":"The url where the short link redirects. Also add the %SHORT_LINK% placeholder in the message body","type":"text","contentType":"String","disabled":true}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/sms"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"result\" : \"OK\", \"//OK or errors\"\r\n \"order_id\" : \"123456789\",\r\n \"total_sent\" : 2 \"//SMS sent or credits used\"\r\n}"}],"_postman_id":"fb8717ad-bfdf-4734-a6e3-fbbba87e108b"},{"name":"Send a parametric SMS message","id":"5a564e62-72ed-453b-a45e-dd837b41ac5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

The type of SMS.

\n","key":"message_type","type":"text","value":""},{"contentType":"String (max 1000 chars)","description":"

The body of the message. *Message max length could be 160 chars when using low-quality SMSs

\n","key":"message","type":"text","value":""},{"contentType":"Map(String, Map(String, String))","description":"

A map of recipents and relative parameters

\n","key":"recipients","type":"text","value":""},{"contentType":"String","description":"

The Sender name. If the message type allows a custom TPOA and the field is left empty, the user’s preferred TPOA is used. Must be empty if the message type does not allow a custom TPOA

\n","key":"sender","type":"text","value":"\"\"","disabled":true},{"contentType":"String [ddMMyy, yyyyMMdd, ddMMyyHHmm, yyyyMMddHHmmss, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm.0]","description":"

The messages will be sent at the given scheduled time

\n","key":"scheduled_delivery_time","type":"text","value":"null","disabled":true},{"key":"scheduled_delivery_timezone","value":"","description":"

Optional timezone applied to scheduled_delivery_time date

\n","type":"text","contentType":"Timezone(IANA time zone)","disabled":true},{"contentType":"String","description":"

Specifies a custom order ID

\n","key":"order_id","type":"text","value":"Generated UUID","disabled":true},{"contentType":"Bool","description":"

Returns the number of credits used instead of the number of messages. i.e. when message is more than 160 chars long more than one credit is used

\n","key":"returnCredits","type":"text","value":"false","disabled":true},{"key":"returnRemaining","value":"false","description":"

Returs the number of remaining SMSs

\n","type":"text","contentType":"Bool","disabled":true},{"key":"allowInvalidRecipients","value":"false","description":"

Sending to an invalid recipient does not block the operation

\n","type":"text","contentType":"Bool","disabled":true},{"contentType":"String (“gsm” or “ucs2”)","description":"

The SMS encoding. Use UCS2 for non standard character sets

\n","key":"encoding","type":"text","value":"gsm","disabled":true},{"key":"id_landing","value":"","description":"

The id of the published page. Also add the %PAGESLINK____________% placeholder in the message body

\n","type":"text","contentType":"Int","disabled":true},{"key":"campaign_name","value":"","description":"

The campaign name

\n","type":"text","contentType":"String","disabled":true},{"key":"short_link_url","value":"","description":"

The url where the short link redirects. Also add the %SHORT_LINK% placeholder in the message body

\n","type":"text","contentType":"String","disabled":true}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/paramsms","description":"

Sends a parametric SMS message to a given list of recipients. With this API it is possible to put placeholders in the message body, and then, for each recipient, specify the values that will replace the placeholders in the message body, for that particular recipient message.

Placeholders are in the form ${ParameterName}

When using parameters, the message length possibly changes between recipents. If a message length, when processed, exceeds the 1000 characters, an error code will be returned

Landing pages must be first created and published in your user panel, since you will need {id_landing} to send it.

A list of published landing pages can be retrieved by using the Landing Pages APIs

Short URLs
\nWhen including URLs in the message, it may be convinient to use short URLs to limit the number of characters used in the SMS message.

Our API can automatically generate a short link starting from a long one, and add it in the message.

Sender Alias
\nAlphanumeric aliases require to be registered first, and need to be approved both from Us and AGCOM.

Aliases can be used only with high-quality message types.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","paramsms"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"cc349038-8b40-4f50-a078-a04ba40d56db","name":"Send a parametric SMS message","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String (“N” for High quality with reception notification, “L” for Medium Quality, “LL” For Low Cost)","description":"The type of SMS.","key":"message_type","type":"text","value":""},{"contentType":"String (max 1000 chars)","description":"The body of the message. *Message max length could be 160 chars when using low-quality SMSs","key":"message","type":"text","value":""},{"contentType":"Map(String, Map(String, String))","description":"A map of recipents and relative parameters","key":"recipients","type":"text","value":""},{"contentType":"String","description":"The Sender name. If the message type allows a custom TPOA and the field is left empty, the user’s preferred TPOA is used. Must be empty if the message type does not allow a custom TPOA","key":"sender","type":"text","value":"\"\"","disabled":true},{"contentType":"String [ddMMyy, yyyyMMdd, ddMMyyHHmm, yyyyMMddHHmmss, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm.0]","description":"The messages will be sent at the given scheduled time","key":"scheduled_delivery_time","type":"text","value":"null","disabled":true},{"key":"scheduled_delivery_timezone","value":"","description":"Optional timezone applied to scheduled_delivery_time date","type":"text","contentType":"Timezone(IANA time zone)","disabled":true},{"contentType":"String","description":"Specifies a custom order ID","key":"order_id","type":"text","value":"Generated UUID","disabled":true},{"contentType":"Bool","description":"Returns the number of credits used instead of the number of messages. i.e. when message is more than 160 chars long more than one credit is used","key":"returnCredits","type":"text","value":"false","disabled":true},{"key":"returnRemaining","value":"false","description":"Returs the number of remaining SMSs","type":"text","contentType":"Bool","disabled":true},{"key":"allowInvalidRecipients","value":"false","description":"Sending to an invalid recipient does not block the operation","type":"text","contentType":"Bool","disabled":true},{"contentType":"String (“gsm” or “ucs2”)","description":"The SMS encoding. Use UCS2 for non standard character sets","key":"encoding","type":"text","value":"gsm","disabled":true},{"key":"id_landing","value":"","description":"The id of the published page. Also add the %PAGESLINK____________% placeholder in the message body","type":"text","contentType":"Int","disabled":true},{"key":"campaign_name","value":"","description":"The campaign name","type":"text","contentType":"String","disabled":true},{"key":"short_link_url","value":"","description":"The url where the short link redirects. Also add the %SHORT_LINK% placeholder in the message body","type":"text","contentType":"String","disabled":true}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/paramsms"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"result\" : \"OK\", \"//OK or errors\"\r\n \"order_id\" : \"123456789\",\r\n \"total_sent\" : 2 \"//SMS sent or credits used\"\r\n}"}],"_postman_id":"5a564e62-72ed-453b-a45e-dd837b41ac5d"},{"name":"Send an SMS message to a group","id":"2c9297b1-af39-435d-9e2e-1a9436056261","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

The type of SMS.

\n","key":"message_type","type":"text","value":""},{"contentType":"String (max 1000 chars)","description":"

The body of the message. *Message max length could be 160 chars when using low-quality SMSs

\n","key":"message","type":"text","value":""},{"contentType":"List(String)","description":"

A list of recipents phone numbers

\n","key":"recipient","type":"text","value":""},{"contentType":"String","description":"

The Sender name. If the message type allows a custom TPOA and the field is left empty, the user’s preferred TPOA is used. Must be empty if the message type does not allow a custom TPOA

\n","key":"sender","type":"text","value":"\"\"","disabled":true},{"contentType":"String [ddMMyy, yyyyMMdd, ddMMyyHHmm, yyyyMMddHHmmss, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm.0]","description":"

The messages will be sent at the given scheduled time

\n","key":"scheduled_delivery_time","type":"text","value":"null","disabled":true},{"contentType":"Timezone(IANA time zone)","description":"

Optional timezone applied to scheduled_delivery_time date

\n","key":"scheduled_delivery_timezone","type":"text","value":"","disabled":true},{"contentType":"String","description":"

Specifies a custom order ID

\n","key":"order_id","type":"text","value":"Generated UUID","disabled":true},{"contentType":"Bool","description":"

Returns the number of credits used instead of the number of messages. i.e. when message is more than 160 chars long more than one credit is used

\n","key":"returnCredits","type":"text","value":"false","disabled":true},{"contentType":"Bool","description":"

Returs the number of remaining SMSs

\n","key":"returnRemaining","type":"text","value":"false","disabled":true},{"contentType":"Bool","description":"

Sending to an invalid recipient does not block the operation

\n","key":"allowInvalidRecipients","type":"text","value":"false","disabled":true},{"contentType":"String (“gsm” or “ucs2”)","description":"

The SMS encoding. Use UCS2 for non standard character sets

\n","key":"encoding","type":"text","value":"gsm","disabled":true},{"contentType":"int","description":"

The id of the published page. Also add the %PAGESLINK____________% placeholder in the message body

\n","key":"id_landing","type":"text","value":"","disabled":true},{"contentType":"String","description":"

The campaign name

\n","key":"campaign_name","type":"text","value":"","disabled":true},{"contentType":"String","description":"

The url where the short link redirects. Also add the %SHORT_LINK% placeholder in the message body

\n","key":"short_link_url","type":"text","value":"","disabled":true}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/smstogroups\n","description":"

Sends an SMS message to a set of contacts groups.

Landing pages must be first created and published in your user panel, since you will need {id_landing} to send it.

A list of published landing pages can be retrieved by using the Landing Pages APIs

Short URLs
\nWhen including URLs in the message, it may be convinient to use short URLs to limit the number of characters used in the SMS message.

Our API can automatically generate a short link starting from a long one, and add it in the message.

Sender Alias
\nAlphanumeric aliases require to be registered first, and need to be approved both from Us and AGCOM.

Aliases can be used only with high-quality message types.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","smstogroups\n"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"c5790081-ade2-45f1-af54-ea15ee686e79","name":"Send an SMS message to a group","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String (“N” for High quality with reception notification, “L” for Medium Quality, “LL” For Low Cost)","description":"The type of SMS.","key":"message_type","type":"text","value":""},{"contentType":"String (max 1000 chars)","description":"The body of the message. *Message max length could be 160 chars when using low-quality SMSs","key":"message","type":"text","value":""},{"contentType":"List(String)","description":"A list of recipents phone numbers","key":"recipient","type":"text","value":""},{"contentType":"String","description":"The Sender name. If the message type allows a custom TPOA and the field is left empty, the user’s preferred TPOA is used. Must be empty if the message type does not allow a custom TPOA","key":"sender","type":"text","value":"\"\"","disabled":true},{"contentType":"String [ddMMyy, yyyyMMdd, ddMMyyHHmm, yyyyMMddHHmmss, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm.0]","description":"The messages will be sent at the given scheduled time","key":"scheduled_delivery_time","type":"text","value":"null","disabled":true},{"contentType":"Timezone(IANA time zone)","description":"Optional timezone applied to scheduled_delivery_time date","key":"scheduled_delivery_timezone","type":"text","value":"","disabled":true},{"contentType":"String","description":"Specifies a custom order ID","key":"order_id","type":"text","value":"Generated UUID","disabled":true},{"contentType":"Bool","description":"Returns the number of credits used instead of the number of messages. i.e. when message is more than 160 chars long more than one credit is used","key":"returnCredits","type":"text","value":"false","disabled":true},{"contentType":"Bool","description":"Returs the number of remaining SMSs","key":"returnRemaining","type":"text","value":"false","disabled":true},{"contentType":"Bool","description":"Sending to an invalid recipient does not block the operation","key":"allowInvalidRecipients","type":"text","value":"false","disabled":true},{"contentType":"String (“gsm” or “ucs2”)","description":"The SMS encoding. Use UCS2 for non standard character sets","key":"encoding","type":"text","value":"gsm","disabled":true},{"contentType":"int","description":"The id of the published page. Also add the %PAGESLINK____________% placeholder in the message body","key":"id_landing","type":"text","value":"","disabled":true},{"contentType":"String","description":"The campaign name","key":"campaign_name","type":"text","value":"","disabled":true},{"contentType":"String","description":"The url where the short link redirects. Also add the %SHORT_LINK% placeholder in the message body","key":"short_link_url","type":"text","value":"","disabled":true}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/smstogroups\n"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"result\" : \"OK\", \"//OK or errors\"\r\n \"order_id\" : \"123456789\",\r\n \"total_sent\" : 2 \"//SMS sent or credits used\"\r\n}"}],"_postman_id":"2c9297b1-af39-435d-9e2e-1a9436056261"},{"name":"Get SMS message state","id":"e3704d7b-7a03-4a04-ae86-6c8e8233cffc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/sms/{order_id}","description":"

Get informations on the SMS delivery status of the given {order_id}.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","sms","{order_id}"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"0fa627ed-7e15-4a42-8660-348f372e9eeb","name":"Get SMS message state","originalRequest":{"method":"GET","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/sms/{order_id}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"recipient_number\": 1,\r\n \"result\": \"OK\",\r\n \"recipients\": [\r\n {\r\n \"status\": \"WAITING\",\r\n \"destination\": \"+393471234567\",\r\n \"delivery_date\": \"\"\r\n }\r\n ]\r\n}"}],"_postman_id":"e3704d7b-7a03-4a04-ae86-6c8e8233cffc"},{"name":"Delete a scheduled message","id":"feeb2623-7c9d-4c85-86f9-55174d156425","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/sms/{order_id}","description":"

Deletes the SMS delivery process of the given {order_id}.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","sms","{order_id}"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"4a6957b7-8d79-4662-a631-badfe3541a45","name":"Delete a scheduled message","originalRequest":{"method":"DELETE","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/sms/{order_id}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"result\":\"OK\"\n}"}],"_postman_id":"feeb2623-7c9d-4c85-86f9-55174d156425"}],"id":"94708f01-fe7c-458d-82a1-66fa7101a59a","description":"

This is the part of the API that allows to send SMS messages, to single recipients, saved contacts or groups of contacts.

All the query string parameters in URL must be UTF-8 URL Encoded.

\n","_postman_id":"94708f01-fe7c-458d-82a1-66fa7101a59a"},{"name":"SMS History API","item":[{"name":"Get sent SMS messages history","id":"1f4ea5e4-f64f-467c-b3d6-d23242d85cc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/smshistory?from={fromdate}","description":"

Returns the user’s SMS messages history

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","smshistory"],"host":["app","gateway","smsend","it"],"query":[{"description":{"content":"

Return results from the given date

\n","type":"text/plain"},"key":"from","value":"{fromdate}"},{"disabled":true,"description":{"content":"

Return results up to the given date

\n","type":"text/plain"},"key":"to","value":"{todate}"},{"disabled":true,"description":{"content":"

Return the given results page

\n","type":"text/plain"},"key":"pageNumber","value":"{1}"},{"disabled":true,"description":{"content":"

The number of results in a page

\n","type":"text/plain"},"key":"pageSize","value":"{10}"},{"disabled":true,"description":{"content":"

Timezone(IANA time zone)

\n","type":"text/plain"},"key":"timezone","value":""}],"variable":[]}},"response":[{"id":"55702fd7-3a3d-4e7a-8d01-4b93e4e33f8c","name":"Get sent SMS messages history","originalRequest":{"method":"GET","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/smshistory?from={fromdate}","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","smshistory"],"query":[{"key":"from","value":"{fromdate}","description":"Return results from the given date"},{"key":"to","value":"{todate}","description":"Return results up to the given date","disabled":true},{"key":"pageNumber","value":"{1}","description":"Return the given results page","disabled":true},{"key":"pageSize","value":"{10}","description":"The number of results in a page","disabled":true},{"key":"timezone","value":"","description":"Timezone(IANA time zone)","type":"text","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"total\": 1, \"// The total number of results\"\r\n \"pageNumber\": 1, \"// The returned page number\"\r\n \"result\": \"OK\", \"// The status of the request\"\r\n \"pageSize\": 10, \"// The page size\"\r\n \"smshistory\": [ \"// The SMS history\"\r\n { \r\n \"order_id\" : \"XYZABCQWERTY\", \"// The order ID\" \r\n \"create_time\" : \"yyyyMMddHHmmss\", \"// When the order was created\" \r\n \"schedule_time\" : \"yyyyMMddHHmmss\", \"// When the sending is scheduled\"\r\n \"message_type\" : \"N\", \"// The message type\"\r\n \"sender\" : \"MySender\", \"// The sender's alias\"\r\n \"num_recipients\" : 2 \"// The number of recipients\"\r\n }, \r\n { \r\n ... \r\n }\r\n ]\r\n}"}],"_postman_id":"1f4ea5e4-f64f-467c-b3d6-d23242d85cc3"}],"id":"b7eedd13-1298-4c77-a696-ba66c27e3b22","description":"

This API is used to retrieve the SMS messages sending history.

Remember to provide the authentication HTTP headers as described in the Authenticate using a session key and the Authenticate using a user tokeny sections.

All the query string parameters in URL must be UTF-8 URL Encoded

\n","_postman_id":"b7eedd13-1298-4c77-a696-ba66c27e3b22"},{"name":"SMS Blacklist / Stop SMS","item":[{"name":"Add Phone Number to Blacklist","id":"5588bb67-91bc-4da5-92fc-f96b0b9bdc24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/blacklist/sms?phoneNumber=","description":"

Add Phone Number to SMS Blacklist The Phone number will no longer receive an SMS from the user requesting the addition to the blacklist.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","blacklist","sms"],"host":["app","gateway","smsend","it"],"query":[{"description":{"content":"

The phone number of the user. The format must be +1111111111 or 001111111111

\n","type":"text/plain"},"key":"phoneNumber","value":""}],"variable":[]}},"response":[{"id":"0d9643e7-de75-40c4-92e4-595182e4ede5","name":"Add Phone Number to Blacklist","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/blacklist/sms?phoneNumber=","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","blacklist","sms"],"query":[{"key":"phoneNumber","value":"","description":"The phone number of the user. The format must be +1111111111 or 001111111111"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"5588bb67-91bc-4da5-92fc-f96b0b9bdc24"},{"name":"Add multiple numbers to sms blacklist","id":"990314d3-0ffd-4dfe-82f3-a3eb3bdfb7c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"key":"","value":"\"\"","description":"

Array of phone numbers

\n","type":"text","contentType":"List(String)"}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/blacklist/smsbatch","description":"

Add multiple numbers to the user’s blacklist.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","blacklist","smsbatch"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"fa235d04-f6a0-46e9-b29f-27f66fb83c05","name":"Add multiple numbers to sms blacklist","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"key":"","value":"\"\"","description":"Array of phone numbers","type":"text","contentType":"List(String)"}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/blacklist/smsbatch"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"On success, the above command returns the following response: 2 (number of phone numbers added in blacklist)"}],"_postman_id":"990314d3-0ffd-4dfe-82f3-a3eb3bdfb7c1"},{"name":"Retrieve list of phone numbers in blacklist","id":"c0db609c-f46c-45f0-8f15-c463724fb82f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/blacklist/sms","description":"

Retrieve the paginated list of Phone numbers in SMS Blacklist

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","blacklist","sms"],"host":["app","gateway","smsend","it"],"query":[{"disabled":true,"description":{"content":"

Return results from the given date

\n","type":"text/plain"},"key":"from","value":""},{"disabled":true,"description":{"content":"

Return results up to the given date

\n","type":"text/plain"},"key":"to","value":""},{"disabled":true,"description":{"content":"

Optional timezone applied to from or to dates

\n","type":"text/plain"},"key":"timezone","value":""},{"disabled":true,"description":{"content":"

Return results that contains this phone number or part of it.

\n","type":"text/plain"},"key":"number","value":""},{"disabled":true,"description":{"content":"

List of origins(API, WEB, STOPSMS) separated by ‘,’ used for filter the results

\n","type":"text/plain"},"key":"origins","value":""},{"disabled":true,"description":{"content":"

Return the given results page

\n","type":"text/plain"},"key":"pageNumber","value":""},{"disabled":true,"description":{"content":"

The number of results in a page

\n","type":"text/plain"},"key":"pageSize","value":""}],"variable":[]}},"response":[{"id":"cb2b2362-2700-4981-87e3-3624a08f381b","name":"Retrieve list of phone numbers in blacklist","originalRequest":{"method":"GET","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/blacklist/sms","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","blacklist","sms"],"query":[{"key":"from","value":"","description":"Return results from the given date","type":"text","disabled":true},{"key":"to","value":"","description":"Return results up to the given date","type":"text","disabled":true},{"key":"timezone","value":"","description":"Optional timezone applied to from or to dates","type":"text","disabled":true},{"key":"number","value":"","description":"Return results that contains this phone number or part of it.","type":"text","disabled":true},{"key":"origins","value":"","description":"List of origins(API, WEB, STOPSMS) separated by ‘,’ used for filter the results","type":"text","disabled":true},{"key":"pageNumber","value":"","description":"Return the given results page","type":"text","disabled":true},{"key":"pageSize","value":"","description":"The number of results in a page","type":"text","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"totalElements\": 3, \"// The total number of results\"\r\n \"totalPages\": 1, \"// The total pages of results\"\r\n \"last\": true, \"// Is last page\"\r\n \"first\": true, \"// Is first page\"\r\n \"size\": 10, \"// Page size\"\r\n \"number\": 0, \"// Page number\"\r\n \"sort\": null, \"// Sort\"\r\n \"numberOfElements\": 3, \"// Number of element in page\"\r\n \"content\": [\r\n {\r\n \"number\": \"+39123456789\", \"// The complete phone number\"\r\n \"idNation\": \"ita\", \"// The nation of phone number\"\r\n \"rcptPrefix\": \"123\", \"// The operator prefix\"\r\n \"rcptNumber\": \"456789\", \"// The number\"\r\n \"origin\": \"API\", \"// Origin of insert (API, WEB, STOPSMS)\"\r\n \"insertTime\": \"2018-10-10 08:00:00\" \"// The datetime of insert in blacklist\"\r\n },\r\n {\r\n ...\r\n }\r\n ]\r\n}"}],"_postman_id":"c0db609c-f46c-45f0-8f15-c463724fb82f"}],"id":"baf67c97-2412-4863-8f5e-0336c1355aca","description":"

This is the part of the API that allow to insert and to retrieve the list of SMS blacklist / Stop SMS.

The SMS blacklist contains the phone numbers to which you don't want to send any SMS.

If the Stop SMS Service is active, any person who receive an SMS can add their phone number to the blacklist.

Remember to provide the authentication HTTP headers as described in the Authenticate using a session key and the Authenticate using a user tokeny sections.

All the query string parameters in URL must be UTF-8 URL Encoded.

\n","_postman_id":"baf67c97-2412-4863-8f5e-0336c1355aca"},{"name":"Received SMS API","item":[{"name":"Get new received messages for all SIMs","id":"fa2b5bbb-1bd7-44ec-a8fd-820453c7f856","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/newsrsmsmessage","description":"

Returns the list of received messages on the given sim_id since the last call of this method, or the beginning of time if it’s the first call. The list is limited to max. 100 entries.

This method requires activation by smSend. If you want to request the received SMS messages through this API, please contact us at helpdesk@smsend.it

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","newsrsmsmessage"],"host":["app","gateway","smsend","it"],"query":[{"disabled":true,"description":{"content":"

The max. number of entries returned

\n","type":"text/plain"},"key":"limit","value":"{100}"}],"variable":[]}},"response":[{"id":"c93890cb-0f0d-4cca-b58a-e7f1eed5c258","name":"Get new received messages for all SIMs","originalRequest":{"method":"GET","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/newsrsmsmessage","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","newsrsmsmessage"],"query":[{"key":"limit","value":"{100}","description":"The max. number of entries returned","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"result\": \"OK\",\r\n \"srsmshistory\": [\r\n {\r\n \"id_message\": \"31\",\r\n \"id_sim\": \"+393400000001\",\r\n \"sender\": \"+393356242290\",\r\n \"message\": \"sadasd\",\r\n \"sms_date\": \"20160503102231\",\r\n \"keyword\": \"qwe\"\r\n },\r\n {\r\n \"id_message\": \"29\",\r\n \"id_sim\": \"+393400000001\",\r\n \"sender\": \"+393356242290\",\r\n \"message\": \"sadasd\",\r\n \"sms_date\": \"20160503102231\",\r\n \"keyword\": \"qwe\"\r\n }\r\n ]\r\n}"}],"_postman_id":"fa2b5bbb-1bd7-44ec-a8fd-820453c7f856"},{"name":"Get new received messages for one specific SIM","id":"498cd1d8-5b65-47a4-a814-2a10131618f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/newsrsmsmessage/{id_sim}","description":"

Returns the list of received messages on the given sim_id since the last call of this method, or the beginning of time if it’s the first call. The list is limited to max. 100 entries.

This method requires activation by smSend. If you want to request the received SMS messages through this API, please contact us at helpdesk@smsend.it

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","newsrsmsmessage","{id_sim}"],"host":["app","gateway","smsend","it"],"query":[{"disabled":true,"description":{"content":"

The max. number of entries returned

\n","type":"text/plain"},"key":"limit","value":"{100}"}],"variable":[]}},"response":[{"id":"82b343e1-9b1a-4697-9954-b03d306d3c3f","name":"Get new received messages for one specific SIM","originalRequest":{"method":"GET","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/newsrsmsmessage/{id_sim}","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","newsrsmsmessage","{id_sim}"],"query":[{"key":"limit","value":"{100}","description":"The max. number of entries returned","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"result\": \"OK\",\r\n \"srsmshistory\": [\r\n {\r\n \"id_message\": \"31\",\r\n \"id_sim\": \"+393400000001\",\r\n \"sender\": \"+393356242290\",\r\n \"message\": \"sadasd\",\r\n \"sms_date\": \"20160503102231\",\r\n \"keyword\": \"qwe\"\r\n },\r\n {\r\n \"id_message\": \"29\",\r\n \"id_sim\": \"+393400000001\",\r\n \"sender\": \"+393356242290\",\r\n \"message\": \"sadasd\",\r\n \"sms_date\": \"20160503102231\",\r\n \"keyword\": \"qwe\"\r\n }\r\n ]\r\n}"}],"_postman_id":"498cd1d8-5b65-47a4-a814-2a10131618f8"},{"name":"Get the received SMS messages for all SIMs","id":"3a13c5d8-842b-49b2-8f30-5cc0d95d1df4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/srsmshistory?from={fromdate}","description":"

Get the paginated list of received SMS messages.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","srsmshistory"],"host":["app","gateway","smsend","it"],"query":[{"description":{"content":"

Return results from the given date

\n","type":"text/plain"},"key":"from","value":"{fromdate}"},{"disabled":true,"description":{"content":"

Return results up to the given date

\n","type":"text/plain"},"key":"to","value":"{todate}"},{"disabled":true,"description":{"content":"

Optional timezone applied to from or to datesThe max. number of entries returned

\n","type":"text/plain"},"key":"timezone","value":""},{"disabled":true,"description":{"content":"

Return the given results page

\n","type":"text/plain"},"key":"pageNumber","value":"{page}"},{"disabled":true,"description":{"content":"

The number of results in a page

\n","type":"text/plain"},"key":"pageSize","value":"{size}"}],"variable":[]}},"response":[{"id":"4a1a8494-c0ae-4447-8b96-c0e4939579d5","name":"Get the received SMS messages for all SIMs","originalRequest":{"method":"GET","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/srsmshistory?from={fromdate}","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","srsmshistory"],"query":[{"key":"from","value":"{fromdate}","description":"Return results from the given date"},{"key":"to","value":"{todate}","description":"Return results up to the given date","disabled":true},{"description":"Optional timezone applied to from or to datesThe max. number of entries returned","key":"timezone","value":"","disabled":true},{"key":"pageNumber","value":"{page}","description":"Return the given results page","disabled":true},{"key":"pageSize","value":"{size}","description":"The number of results in a page","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"result\": \"OK\",\r\n \"srsmshistory\": [\r\n {\r\n \"id_message\": \"2\",\r\n \"id_sim\": \"+393400000001\",\r\n \"sender\": \"+393356242290\",\r\n \"message\": \"abcde\",\r\n \"sms_date\": \"20160503102231\",\r\n \"keyword\": \"\"\r\n }\r\n ],\r\n \"pageNumber\": 1,\r\n \"pageSize\": 10,\r\n \"total\": 1\r\n}"}],"_postman_id":"3a13c5d8-842b-49b2-8f30-5cc0d95d1df4"},{"name":"Get the received SMS messages for one specific SIM","id":"9b6b4505-48b9-4e46-9078-242eadb82cab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/srsmshistory/{id_sim}?from={fromdate}","description":"

Get the paginated list of received SMS messages.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","srsmshistory","{id_sim}"],"host":["app","gateway","smsend","it"],"query":[{"description":{"content":"

Return results from the given date

\n","type":"text/plain"},"key":"from","value":"{fromdate}"},{"disabled":true,"description":{"content":"

Return results up to the given date

\n","type":"text/plain"},"key":"to","value":"{todate}"},{"disabled":true,"description":{"content":"

Optional timezone applied to from or to datesThe max. number of entries returned

\n","type":"text/plain"},"key":"timezone","value":""},{"disabled":true,"description":{"content":"

Return the given results page

\n","type":"text/plain"},"key":"pageNumber","value":"{page}"},{"disabled":true,"description":{"content":"

The number of results in a page

\n","type":"text/plain"},"key":"pageSize","value":"{size}"}],"variable":[]}},"response":[{"id":"889e6858-7385-4c0e-bc9f-811150fd8707","name":"Get the received SMS messages for one specific SIM","originalRequest":{"method":"GET","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/srsmshistory/{id_sim}?from={fromdate}","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","srsmshistory","{id_sim}"],"query":[{"key":"from","value":"{fromdate}","description":"Return results from the given date"},{"key":"to","value":"{todate}","description":"Return results up to the given date","disabled":true},{"description":"Optional timezone applied to from or to datesThe max. number of entries returned","key":"timezone","value":"","disabled":true},{"key":"pageNumber","value":"{page}","description":"Return the given results page","disabled":true},{"key":"pageSize","value":"{size}","description":"The number of results in a page","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"result\": \"OK\",\r\n \"srsmshistory\": [\r\n {\r\n \"id_message\": \"2\",\r\n \"id_sim\": \"+393400000001\",\r\n \"sender\": \"+393356242290\",\r\n \"message\": \"abcde\",\r\n \"sms_date\": \"20160503102231\",\r\n \"keyword\": \"\"\r\n }\r\n ],\r\n \"pageNumber\": 1,\r\n \"pageSize\": 10,\r\n \"total\": 1\r\n}"}],"_postman_id":"9b6b4505-48b9-4e46-9078-242eadb82cab"},{"name":"Get the received SMS messages after a specified message","id":"fc6655e5-e740-4bb9-8388-413a3a684538","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/srsmshistory/{id_sim}/{id_message}","description":"

Returns a list (limited to max. 100 entries) of SMS messages received after the given SMS message ID {id_message}, for the given SIM {id_sim}.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","srsmshistory","{id_sim}","{id_message}"],"host":["app","gateway","smsend","it"],"query":[{"disabled":true,"description":{"content":"

The max. number of entries in the returned list

\n","type":"text/plain"},"key":"limit","value":"{100}"}],"variable":[]}},"response":[{"id":"b9fad853-9e07-4cdd-86bb-ac6ba46f4b7a","name":"Get the received SMS messages after a specified message","originalRequest":{"method":"GET","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/srsmshistory/{id_sim}/{id_message}","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","srsmshistory","{id_sim}","{id_message}"],"query":[{"key":"limit","value":"{100}","description":"The max. number of entries in the returned list","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"result\": \"OK\",\r\n \"srsmshistory\": [\r\n {\r\n \"id_message\": \"6\",\r\n \"id_sim\": \"+393400000000\",\r\n \"sender\": \"+393356242290\",\r\n \"message\": \"abcdef\",\r\n \"sms_date\": \"20160503102231\",\r\n \"keyword\": \"\"\r\n },\r\n {\r\n \"id_message\": \"7\",\r\n \"id_sim\": \"+393400000000\",\r\n \"sender\": \"+393356242290\",\r\n \"message\": \"abcdef\",\r\n \"sms_date\": \"20160503102231\",\r\n \"keyword\": \"\"\r\n },\r\n {\r\n \"id_message\": \"8\",\r\n \"id_sim\": \"+393400000000\",\r\n \"sender\": \"+393356242290\",\r\n \"message\": \"abcdef\",\r\n \"sms_date\": \"20160503102231\",\r\n \"keyword\": \"\"\r\n }\r\n ]\r\n}"}],"_postman_id":"fc6655e5-e740-4bb9-8388-413a3a684538"},{"name":"Get the MO received messages","id":"232014d9-76d3-480d-844a-8997f118a2f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/mosmshistory?type=","description":"

This feature is available only for French customers!.\nReturns a list (limited to max. 100 entries) of MO messages received for the give type which could be STOP or CONTACT or OTHER; type is a mandatory parameter, the other are optional.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","mosmshistory"],"host":["app","gateway","smsend","it"],"query":[{"description":{"content":"

Type of the MO and could be one of STOP, CONTACT or OTHER. String (“STOP” or “CONTACT” or “OTHER”)

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

Return results from the given date\nDate(yyyyMMddHHmmss)

\n","type":"text/plain"},"key":"from","value":""},{"disabled":true,"description":{"content":"

Return results up to the given date\nDate(yyyyMMddHHmmss)

\n","type":"text/plain"},"key":"to","value":""},{"disabled":true,"description":{"content":"

Optional timezone applied to from or to dates

\n","type":"text/plain"},"key":"timezone","value":""},{"disabled":true,"description":{"content":"

Return the given results page

\n","type":"text/plain"},"key":"pageNumber","value":"{1}"},{"disabled":true,"description":{"content":"

The number of results in a page

\n","type":"text/plain"},"key":"pageSize","value":"{10}"}],"variable":[]}},"response":[{"id":"97e5380b-24a9-467a-906b-9f1fe921064d","name":"Get the MO received messages","originalRequest":{"method":"GET","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/mosmshistory?type=","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","mosmshistory"],"query":[{"key":"type","value":"","description":"Type of the MO and could be one of STOP, CONTACT or OTHER. String (“STOP” or “CONTACT” or “OTHER”)"},{"key":"from","value":"","description":"Return results from the given date\nDate(yyyyMMddHHmmss)","disabled":true},{"key":"to","value":"","description":"Return results up to the given date\nDate(yyyyMMddHHmmss)","disabled":true},{"description":"Optional timezone applied to from or to dates","key":"timezone","value":"","disabled":true},{"key":"pageNumber","value":"{1}","description":"Return the given results page","disabled":true},{"key":"pageSize","value":"{10}","description":"The number of results in a page\t","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"result\": \"OK\",\r\n \"srsmshistory\": [\r\n {\r\n \"id_message\": \"6\",\r\n \"id_sim\": \"SMS STOP\",\r\n \"sender\": \"+393356242290\",\r\n \"message\": \"STOP asd\",\r\n \"sms_date\": \"20160503102231\",\r\n \"keyword\": \"\"\r\n },\r\n {\r\n \"id_message\": \"7\",\r\n \"id_sim\": \"SMS STOP\",\r\n \"sender\": \"+393356242290\",\r\n \"message\": \"STOP abcdef\",\r\n \"sms_date\": \"20160503102231\",\r\n \"keyword\": \"\"\r\n }\r\n ]\r\n}"}],"_postman_id":"232014d9-76d3-480d-844a-8997f118a2f7"}],"id":"56bb2463-86d7-4e0d-be73-60e70fe0f932","description":"

This API allows to query the received SMS messages on the owned SIMs.

Remember to provide the authentication HTTP headers as described in the Authenticate using a session key and the Authenticate using a user tokeny sections.

All the query string parameters in URL must be UTF-8 URL Encoded.

\n","_postman_id":"56bb2463-86d7-4e0d-be73-60e70fe0f932"},{"name":"Landing pages API","item":[{"name":"List the published landing pages","id":"0b933278-eb9b-4b3c-ba4b-e59533ad52ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/landings","description":"

Returns the list of published landing pages of the user.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","landings"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"245ca8ca-8b43-4c0f-929e-c9bae3779e85","name":"List the published landing pages","originalRequest":{"method":"GET","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/landings"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"result\": \"OK\",\r\n \"landings\": [\r\n {\r\n \"id_landing\": 18,\r\n \"name\": \"agoodpage\",\r\n \"description\": \"Test page\",\r\n \"long_description\": null,\r\n \"created\": 1513066300000,\r\n \"modified\": 1513067151000,\r\n \"html_title\": null\r\n },\r\n {\r\n \"id_landing\": 19,\r\n \"name\": \"anicepage\",\r\n \"description\": \"A nice page\",\r\n \"long_description\": null,\r\n \"created\": 1513067137000,\r\n \"modified\": 1513067563000,\r\n \"html_title\": null\r\n }\r\n ]\r\n}"}],"_postman_id":"0b933278-eb9b-4b3c-ba4b-e59533ad52ec"}],"id":"a38ae6d8-8371-4bd6-a4ce-adbbb6bc2daf","description":"

This is the part of the API that regards the Landing Pages service.

Remember to provide the authentication HTTP headers as described in the Authenticate using a session key and the Authenticate using a user tokeny sections.

All the query string parameters in URL must be UTF-8 URL Encoded.

\n","_postman_id":"a38ae6d8-8371-4bd6-a4ce-adbbb6bc2daf"},{"name":"Email Campaign API","item":[{"name":"Create a new list","id":"026b7cfd-3ec6-4262-b8e2-9cc346a106e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"key":"title","value":"","description":"

The list name

\n","type":"text","contentType":"String"},{"key":"id_language","value":"","description":"

The list default language

\n","type":"text","contentType":"String (eg \"ita\")"},{"key":"email_sender","value":"","description":"

The sender’s email address

\n","type":"text","contentType":"String"},{"key":"reply_to","value":"","description":"

The email to be used for the ‘reply_to’ email field

\n","type":"text","contentType":"String"},{"key":"company_name","value":"","description":"

The company name

\n","type":"text","contentType":"String"},{"key":"company_address","value":"","description":"

The company address

\n","type":"text","contentType":"String"},{"key":"company_url","value":"","description":"

The company website URL

\n","type":"text","contentType":"String"},{"key":"company_phone","value":"","description":"

The company phone number

\n","type":"text","contentType":"String"},{"key":"company_fax","value":"","description":"

The company FAX number

\n","type":"text","contentType":"String"}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/list","description":"

Create a new sending list.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","list"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"774ed199-ae4c-4599-a29a-2235eb5bb024","name":"Create a new list","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"key":"title","value":"","description":"The list name","type":"text","contentType":"String"},{"key":"id_language","value":"","description":"The list default language","type":"text","contentType":"String (eg \"ita\")"},{"key":"email_sender","value":"","description":"The sender’s email address","type":"text","contentType":"String"},{"key":"reply_to","value":"","description":"The email to be used for the ‘reply_to’ email field","type":"text","contentType":"String"},{"key":"company_name","value":"","description":"The company name","type":"text","contentType":"String"},{"key":"company_address","value":"","description":"The company address","type":"text","contentType":"String"},{"key":"company_url","value":"","description":"The company website URL","type":"text","contentType":"String"},{"key":"company_phone","value":"","description":"The company phone number","type":"text","contentType":"String"},{"key":"company_fax","value":"","description":"The company FAX number","type":"text","contentType":"String"}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/list"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"On success, the above command returns the following response:\r\n# The HTTP location header that points to the created list:\r\n'Location': '/list/{list_id}'"}],"_postman_id":"026b7cfd-3ec6-4262-b8e2-9cc346a106e5"},{"name":"Modify a list","id":"7c8322aa-918b-472b-9df8-b64af05622a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String","description":"

The list name

\n","key":"title","type":"text","value":"","disabled":true},{"contentType":"String (eg \"ita\")","description":"

The list default language

\n","key":"id_language","type":"text","value":"","disabled":true},{"contentType":"String","description":"

The sender’s email address

\n","key":"email_sender","type":"text","value":"","disabled":true},{"contentType":"String","description":"

The email to be used for the ‘reply_to’ email field

\n","key":"reply_to","type":"text","value":"","disabled":true},{"contentType":"String","description":"

The company name

\n","key":"company_name","type":"text","value":"","disabled":true},{"contentType":"String","description":"

The company address

\n","key":"company_address","type":"text","value":"","disabled":true},{"contentType":"String","description":"

The company website URL

\n","key":"company_url","type":"text","value":"","disabled":true},{"contentType":"String","description":"

The company phone number

\n","key":"company_phone","type":"text","value":"","disabled":true},{"contentType":"String","description":"

The company FAX number

\n","key":"company_fax","type":"text","value":"","disabled":true},{"key":"status","value":"","description":"

The list status (0 = Active, 1 = Archived, 2 = To Be Activated)

\n","type":"text","contentType":"Int","disabled":true}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/list/{list_id}","description":"

Updates a sending list.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","list","{list_id}"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"4ee5b6c7-dbe6-4bf4-9a1c-f9792da352bd","name":"Modify a list","originalRequest":{"method":"PUT","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String","description":"The list name","key":"title","type":"text","value":"","disabled":true},{"contentType":"String (eg \"ita\")","description":"The list default language","key":"id_language","type":"text","value":"","disabled":true},{"contentType":"String","description":"The sender’s email address","key":"email_sender","type":"text","value":"","disabled":true},{"contentType":"String","description":"The email to be used for the ‘reply_to’ email field","key":"reply_to","type":"text","value":"","disabled":true},{"contentType":"String","description":"The company name","key":"company_name","type":"text","value":"","disabled":true},{"contentType":"String","description":"The company address","key":"company_address","type":"text","value":"","disabled":true},{"contentType":"String","description":"The company website URL","key":"company_url","type":"text","value":"","disabled":true},{"contentType":"String","description":"The company phone number","key":"company_phone","type":"text","value":"","disabled":true},{"contentType":"String","description":"The company FAX number","key":"company_fax","type":"text","value":"","disabled":true},{"key":"status","value":"","description":"The list status (0 = Active, 1 = Archived, 2 = To Be Activated)","type":"text","contentType":"Int","disabled":true}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/list/{list_id}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"On success, the above command returns the following response:\r\n# The HTTP location header that points to the updated list:\r\n'Location': '/list/{list_id}'"}],"_postman_id":"7c8322aa-918b-472b-9df8-b64af05622a3"},{"name":"Get list of campaigns by statuses","id":"4126f031-9ac2-4973-bc68-27f1818e760c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/list","description":"

Get list of campaigns by statuses. If statuses is not specified by default return only ACTIVE campaign.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","list"],"host":["app","gateway","smsend","it"],"query":[{"disabled":true,"description":{"content":"

List of campaign statuses separated by comma (ACTIVE, ARCHIVED, TO_ACTIVATE)

\n","type":"text/plain"},"key":"statuses","value":"ACTIVE"}],"variable":[]}},"response":[{"id":"87332d0d-c79c-4691-8ad7-d2946695f25d","name":"Get list of campaigns by statuses","originalRequest":{"method":"GET","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/list","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","list"],"query":[{"key":"statuses","value":"ACTIVE","description":"List of campaign statuses separated by comma (ACTIVE, ARCHIVED, TO_ACTIVATE)","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[{\r\n \"id_campaign\": 10,\r\n \"title\": \"MyList1\",\r\n \"id_language\": \"ita\",\r\n \"email_sender\": \"ema@il.com\",\r\n \"reply_to\": \"ema@il.com\",\r\n \"company_name\": \"MyCompany\",\r\n \"company_address\": \"My Company Address\",\r\n \"company_url\": \"www.mycompany.com\",\r\n \"company_phone\": \"+34123456789\",\r\n \"company_fax\": \"+341234567810\",\r\n \"status\": \"ACTIVE\",\r\n \"create_date\": \"2018-02-27 15:30:56\"\r\n},\r\n{\r\n \"id_campaign\": 11,\r\n \"title\": \"MyList2\",\r\n \"id_language\": \"ita\",\r\n \"email_sender\": \"ema@il.com\",\r\n \"reply_to\": \"ema@il.com\",\r\n \"company_name\": \"MyCompany\",\r\n \"company_address\": \"My Company Address\",\r\n \"company_url\": \"www.mycompany.com\",\r\n \"company_phone\": \"+34123456789\",\r\n \"company_fax\": \"+341234567810\",\r\n \"status\": \"ACTIVE\",\r\n \"create_date\": \"2018-02-27 15:31:06\"\r\n}]"}],"_postman_id":"4126f031-9ac2-4973-bc68-27f1818e760c"},{"name":"Add a contacts group to a list of distribution","id":"499b8997-72d4-4b9a-a1e2-e15665fef8b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/list/{list_id}/group/{group_id}","description":"

Add all contacts of the given group to the given list of distribution.

Emails can be only sent to contacts that belong to a distribution list.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","list","{list_id}","group","{group_id}"],"host":["app","gateway","smsend","it"],"query":[{"disabled":true,"description":{"content":"

Send the Opt-in email to the group’s contacts

\n","type":"text/plain"},"key":"sendoptin","value":"false"}],"variable":[]}},"response":[],"_postman_id":"499b8997-72d4-4b9a-a1e2-e15665fef8b7"},{"name":"Create a new email draft","id":"a926b639-9a6e-4339-a260-210fce44e265","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"key":"title","value":"","description":"

The issue title

\n","type":"text","contentType":"String"},{"key":"subject","value":"","description":"

The subject for the issue

\n","type":"text","contentType":"String"},{"key":"share_social","value":"","description":"

Adds the social share buttons

\n","type":"text","contentType":"Bool"},{"key":"web_analytics","value":"","description":"

The WebAnalytics tracing code

\n","type":"text","contentType":"String","disabled":true},{"key":"text_content","value":"","description":"

The Email text body

\n","type":"text","contentType":"String"},{"key":"html_content","value":"","description":"

The Email HTML body

\n","type":"text","contentType":"String"},{"key":"attachments","value":"","description":"

The list of attachments (can be empty)

\n","type":"text","contentType":"List(Attachment)"},{"key":"Attachment.file_name\t","value":"","description":"

The file name of the attachment

\n","type":"text","contentType":"String"},{"key":"Attachment.file_content_base64","value":"","description":"

The base64-encoded attachment

\n","type":"text","contentType":"String"}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/list/{list_id}/issue","description":"

Creates a new email draft. Every email draft must be associated to a distribution list.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","list","{list_id}","issue"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"714a3530-54bc-41f5-a9a6-f2903b96340c","name":"Create a new email draft","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"key":"title","value":"","description":"The issue title","type":"text","contentType":"String"},{"key":"subject","value":"","description":"The subject for the issue","type":"text","contentType":"String"},{"key":"share_social","value":"","description":"Adds the social share buttons","type":"text","contentType":"Bool"},{"key":"web_analytics","value":"","description":"The WebAnalytics tracing code","type":"text","contentType":"String","disabled":true},{"key":"text_content","value":"","description":"The Email text body","type":"text","contentType":"String"},{"key":"html_content","value":"","description":"The Email HTML body","type":"text","contentType":"String"},{"key":"attachments","value":"","description":"The list of attachments (can be empty)","type":"text","contentType":"List(Attachment)"},{"key":"Attachment.file_name\t","value":"","description":"The file name of the attachment","type":"text","contentType":"String"},{"key":"Attachment.file_content_base64","value":"","description":"The base64-encoded attachment","type":"text","contentType":"String"}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/list/{list_id}/issue"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"# The HTTP location header that points to the created issue:\r\n'Location': '/issue/{issue_id}'"}],"_postman_id":"a926b639-9a6e-4339-a260-210fce44e265"},{"name":"Create new issue using a specified template","id":"2231d696-ca3d-4b65-b25d-c5aeadd5f5d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String","description":"

The issue title

\n","key":"title","type":"text","value":""},{"contentType":"String","description":"

The subject for the issue

\n","key":"subject","type":"text","value":""}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/list/{campaignId}/issue/template/{template}","description":"

Creates a new issue starting from the specified template.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","list","{campaignId}","issue","template","{template}"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"0ec83ca7-a876-46bc-9a71-3b1f7d9c10e1","name":"Create new issue using a specified template","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String","description":"The issue title","key":"title","type":"text","value":""},{"contentType":"String","description":"The subject for the issue","key":"subject","type":"text","value":""}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/list/{campaignId}/issue/template/{template}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"# The HTTP location header that points to the contact:\r\n'Location': '/contact/{contact_id}'"}],"_postman_id":"2231d696-ca3d-4b65-b25d-c5aeadd5f5d3"},{"name":"Send an issue to preloaded contacts","id":"e26639af-2645-40f7-bbdf-414b84e5aead","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String[]","description":"

The list of contact Ids of the recipients

\n","key":"contactIds","type":"text","value":""},{"contentType":"String","description":"

When send the mailing in format yyyy-MM-dd hh:mm:ss

\n","key":"scheduleTime","type":"text","value":""}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/list/{campaignId}/issue/{idIssue}","description":"

Schedule an issue to be sent to a specified list of contacts Ids at a given time.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","list","{campaignId}","issue","{idIssue}"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[],"_postman_id":"e26639af-2645-40f7-bbdf-414b84e5aead"}],"id":"4dece030-9a89-44cb-91bf-ca9766783542","description":"

This API exposes methods for creating and managing Email campaigns.

Emails can be sent to a list, that is used for contacts subscription.

A list allows contacts to subscribe to it, and also defines some basic email sending settings, such as: - Name of the list - Language - Sender’s name and email - Reply-to email - Customized Opt-in email

An Email campaign is a sending of an email to a certain list.

Remember to provide the authentication HTTP headers as described in the Authenticate using a session key and the Authenticate using a user tokeny sections.

All the query string parameters in URL must be UTF-8 URL Encoded.

\n","_postman_id":"4dece030-9a89-44cb-91bf-ca9766783542"},{"name":"Subaccount API","item":[{"name":"Get the list of subaccounts","id":"7715061a-ebc7-40cf-94a7-cc341b11540c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/subaccounts","description":"

Create a new sending list.

\n","urlObject":{"protocol":"https","path":["subaccounts"],"host":["app","gateway","smsend","it"],"query":[{"disabled":true,"description":{"content":"

Return the given results page

\n","type":"text/plain"},"key":"pageNumber","value":"{1}"},{"disabled":true,"description":{"content":"

The number of results in a page

\n","type":"text/plain"},"key":"pageSize","value":"{10}\n"}],"variable":[]}},"response":[{"id":"60b394eb-a798-4cea-bc16-59e5c440d9cc","name":"Get the list of subaccounts","originalRequest":{"method":"GET","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.gateway.smsend.it/subaccounts","protocol":"https","host":["app","gateway","smsend","it"],"path":["subaccounts"],"query":[{"key":"pageNumber","value":"{1}","description":"Return the given results page","disabled":true},{"key":"pageSize","value":"{10}\n","description":"The number of results in a page","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"result\": \"OK\",\r\n \"pageNumber\": 1,\r\n \"pageSize\": 10,\r\n \"total\": 2,\r\n \"subaccount\": [\r\n {\r\n \"activation-time\": \"20160823\",\r\n \"active\": true,\r\n \"address\": \"via viotta\",\r\n \"allowtpoavalidation\": true,\r\n \"cell\": \"+393385958233\",\r\n \"city\": \"Città\",\r\n \"fiscal-code\": \"PRRFCC92L09L488E\",\r\n \"pa-code\": null,\r\n \"company\": false,\r\n \"company-name\": null,\r\n \"create-time\": \"20160823\",\r\n \"credit-eat-mode\": 2,\r\n \"credits-sum\": \"€ 0,000\",\r\n \"default-message-type\": \"SI\",\r\n \"default-nation\": \"ita\",\r\n \"dfeu\": true,\r\n \"email\": \"prova@prova.pr\",\r\n \"fax\": \"0461757575\",\r\n \"foreign\": false,\r\n \"id-user\": 5,\r\n \"invoicing-email\": null,\r\n \"language\": \"ita\",\r\n \"legal-agreement-time\": \"20160823\",\r\n \"legalAgreementVersion\": 0,\r\n \"login\": \"logon\",\r\n \"max-subaccounts\": -1,\r\n \"name\": \"nome\",\r\n \"num-cell-for-test-sms\": \"+393385958233\",\r\n \"partner\": false,\r\n \"partner-code\": null,\r\n \"phone\": \"0461757575\",\r\n \"piva\": null,\r\n \"preferred-tpoa\": \"+393385958233\",\r\n \"private\": true,\r\n \"province\": \"Trento\",\r\n \"referral\": false,\r\n \"shop_cart_check\": true,\r\n \"split-payment\": false,\r\n \"subaccount\": true,\r\n \"subaccount-types\": 0,\r\n \"super-account-name\": \"\",\r\n \"superaccount\": false,\r\n \"surname\": \"asdasd\",\r\n \"use24\": true,\r\n \"user-nation\": \"ita\",\r\n \"zip-code\": \"38010\",\r\n \"credits\": [\r\n {\r\n \"id\": \"N\",\r\n \"qty\": 10\r\n },\r\n {\r\n \"id\": \"L\",\r\n \"qty\": 10\r\n },\r\n {\r\n \"id\": \"LL\",\r\n \"qty\": 10\r\n },\r\n {\r\n \"id\": \"EE\",\r\n \"qty\": 10\r\n }\r\n ]\r\n }\r\n ]\r\n}"}],"_postman_id":"7715061a-ebc7-40cf-94a7-cc341b11540c"},{"name":"Create a subaccount","id":"3e1233c5-1e94-4be5-bbb3-3fe8a20d159c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"key":"address","value":"","description":"

The subaccount address

\n","type":"text","contentType":"String"},{"key":"cell","value":"","description":"

The subaccount mobile phone number

\n","type":"text","contentType":"String"},{"key":"city","value":"","description":"

The subaccount city

\n","type":"text","contentType":"String"},{"key":"company","value":"true","description":"

Is the subaccount a company?

\n","type":"text","contentType":"Bool","disabled":true},{"key":"company-name","value":"","description":"

The company name. \nMandatory if company=true

\n","type":"text","contentType":"String","disabled":true},{"key":"credit-eat-mode","value":"","description":"

Tells from who credits are scaled. 0 = own credits, 1 = superaccount credits, 2 = own credits and superaccount ones

\n","type":"text","contentType":"Int (0, 1, 2)"},{"key":"dfeu","value":"","description":"

Use the Date Format in EUropean format

\n","type":"text","contentType":"Bool","disabled":true},{"key":"email","value":"","description":"

The subaccount email

\n","type":"text","contentType":"String (a valid Email)"},{"key":"fax","value":"","description":"

The subaccount FAX number

\n","type":"text","contentType":"String","disabled":true},{"key":"invoicing-email","value":"","description":"

If provided, invoices will be sent here instead of the default email

\n","type":"text","contentType":"String (a valid Email)","disabled":true},{"key":"language","value":"","description":"

The subaccount language. If none, defaults to the one of the superaccount

\n","type":"text","contentType":"String","disabled":true},{"key":"login","value":"","description":"

The subaccount login username (must not contain any spaces)

\n","type":"text","contentType":"String"},{"key":"name","value":"","description":"

The subaccount owner first name

\n","type":"text","contentType":"String"},{"key":"num-cell-for-test-sms","value":"","description":"

A phone number where test SMS messages will be sent

\n","type":"text","contentType":"String (Phone number)","disabled":true},{"key":"password","value":"If null, will be autogenerated","description":"

The subaccount password (min 8 chars, max 16 chars)

\n","type":"text","contentType":"String","disabled":true},{"key":"phone","value":"\"\"","description":"

The subaccount phone number

\n","type":"text","contentType":"String (PhoneNumber)","disabled":true},{"key":"piva","value":"","description":"

The subaccount VAT number (P.Iva in Italy).\nMandatory if company=true

\n","type":"text","contentType":"String","disabled":true},{"key":"province","value":"","description":"

The subaccount province

\n","type":"text","contentType":"String"},{"key":"superaccount","value":"false","description":"

The subaccount is a superaccount itself (i.e. it can create his own subaccounts)

\n","type":"text","contentType":"Bool","disabled":true},{"key":"surname","value":"","description":"

The subaccount last name

\n","type":"text","contentType":"String"},{"key":"use24","value":"true","description":"

Use the 24 hour format for time

\n","type":"text","contentType":"Bool","disabled":true},{"key":"zip-code","value":"","description":"

The subaccount ZIP Code

\n","type":"text","contentType":"String"},{"key":"id-subaccount-profile","value":"","description":"

Specifying a custom subaccount profile allows a superaccount to narrow down the subaccount enabled features (e.g. Only send SMS messages, or even further, only send a specific type of SMS message)

\n","type":"text","contentType":"Int","disabled":true}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/subaccount","description":"

Creates a new subaccount for the authenticated user, which has to be a superaccount.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","subaccount"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"3f8133e1-fcd6-4087-abbe-e73d71eed036","name":"Create a subaccount","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"key":"address","value":"","description":"The subaccount address","type":"text","contentType":"String"},{"key":"cell","value":"","description":"The subaccount mobile phone number","type":"text","contentType":"String"},{"key":"city","value":"","description":"The subaccount city","type":"text","contentType":"String"},{"key":"company","value":"true","description":"Is the subaccount a company?","type":"text","contentType":"Bool","disabled":true},{"key":"company-name","value":"","description":"The company name. \nMandatory if company=true","type":"text","contentType":"String","disabled":true},{"key":"credit-eat-mode","value":"","description":"Tells from who credits are scaled. 0 = own credits, 1 = superaccount credits, 2 = own credits and superaccount ones","type":"text","contentType":"Int (0, 1, 2)"},{"key":"dfeu","value":"","description":"Use the Date Format in EUropean format\t","type":"text","contentType":"Bool","disabled":true},{"key":"email","value":"","description":"The subaccount email","type":"text","contentType":"String (a valid Email)"},{"key":"fax","value":"","description":"The subaccount FAX number","type":"text","contentType":"String","disabled":true},{"key":"invoicing-email","value":"","description":"If provided, invoices will be sent here instead of the default email","type":"text","contentType":"String (a valid Email)","disabled":true},{"key":"language","value":"","description":"The subaccount language. If none, defaults to the one of the superaccount","type":"text","contentType":"String","disabled":true},{"key":"login","value":"","description":"The subaccount login username (must not contain any spaces)","type":"text","contentType":"String"},{"key":"name","value":"","description":"The subaccount owner first name","type":"text","contentType":"String"},{"key":"num-cell-for-test-sms","value":"","description":"A phone number where test SMS messages will be sent","type":"text","contentType":"String (Phone number)","disabled":true},{"key":"password","value":"If null, will be autogenerated","description":"The subaccount password (min 8 chars, max 16 chars)","type":"text","contentType":"String","disabled":true},{"key":"phone","value":"\"\"","description":"The subaccount phone number","type":"text","contentType":"String (PhoneNumber)","disabled":true},{"key":"piva","value":"","description":"The subaccount VAT number (P.Iva in Italy).\nMandatory if company=true","type":"text","contentType":"String","disabled":true},{"key":"province","value":"","description":"The subaccount province","type":"text","contentType":"String"},{"key":"superaccount","value":"false","description":"The subaccount is a superaccount itself (i.e. it can create his own subaccounts)","type":"text","contentType":"Bool","disabled":true},{"key":"surname","value":"","description":"The subaccount last name","type":"text","contentType":"String"},{"key":"use24","value":"true","description":"Use the 24 hour format for time","type":"text","contentType":"Bool","disabled":true},{"key":"zip-code","value":"","description":"The subaccount ZIP Code","type":"text","contentType":"String"},{"key":"id-subaccount-profile","value":"","description":"Specifying a custom subaccount profile allows a superaccount to narrow down the subaccount enabled features (e.g. Only send SMS messages, or even further, only send a specific type of SMS message)","type":"text","contentType":"Int","disabled":true}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/subaccount"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"On success, the above command returns the following response:\r\n# The HTTP location header that points to the created subaccount:\r\n'Location': '/subaccount/18107'"}],"_postman_id":"3e1233c5-1e94-4be5-bbb3-3fe8a20d159c"},{"name":"Edit subaccount","id":"d8c0bb3c-6487-4d67-ac1d-1e9a831d96ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String","description":"

The subaccount address

\n","key":"address","type":"text","value":""},{"contentType":"String","description":"

The subaccount mobile phone number

\n","key":"cell","type":"text","value":""},{"contentType":"String","description":"

The subaccount city

\n","key":"city","type":"text","value":""},{"contentType":"Bool","description":"

Is the subaccount a company?

\n","key":"company","type":"text","value":"true","disabled":true},{"contentType":"String","description":"

The company name. \nMandatory if company=true

\n","key":"company-name","type":"text","value":"","disabled":true},{"contentType":"Int (0, 1, 2)","description":"

Tells from who credits are scaled. 0 = own credits, 1 = superaccount credits, 2 = own credits and superaccount ones

\n","key":"credit-eat-mode","type":"text","value":""},{"contentType":"Bool","description":"

Use the Date Format in EUropean format

\n","key":"dfeu","type":"text","value":"","disabled":true},{"contentType":"String (a valid Email)","description":"

The subaccount email

\n","key":"email","type":"text","value":""},{"contentType":"String","description":"

The subaccount FAX number

\n","key":"fax","type":"text","value":"","disabled":true},{"contentType":"String (a valid Email)","description":"

If provided, invoices will be sent here instead of the default email

\n","key":"invoicing-email","type":"text","value":"","disabled":true},{"contentType":"String","description":"

The subaccount language. If none, defaults to the one of the superaccount

\n","key":"language","type":"text","value":"","disabled":true},{"contentType":"String","description":"

The subaccount login username (must not contain any spaces)

\n","key":"login","type":"text","value":""},{"contentType":"String","description":"

The subaccount owner first name

\n","key":"name","type":"text","value":""},{"contentType":"String (Phone number)","description":"

A phone number where test SMS messages will be sent

\n","key":"num-cell-for-test-sms","type":"text","value":"","disabled":true},{"contentType":"String","description":"

The subaccount password (min 8 chars, max 16 chars)

\n","key":"password","type":"text","value":"If null, will be autogenerated","disabled":true},{"contentType":"String (PhoneNumber)","description":"

The subaccount phone number

\n","key":"phone","type":"text","value":"\"\"","disabled":true},{"contentType":"String","description":"

The subaccount VAT number (P.Iva in Italy).\nMandatory if company=true

\n","key":"piva","type":"text","value":"","disabled":true},{"contentType":"String","description":"

The subaccount province

\n","key":"province","type":"text","value":""},{"contentType":"Bool","description":"

The subaccount is a superaccount itself (i.e. it can create his own subaccounts)

\n","key":"superaccount","type":"text","value":"false","disabled":true},{"contentType":"String","description":"

The subaccount last name

\n","key":"surname","type":"text","value":""},{"contentType":"Bool","description":"

Use the 24 hour format for time

\n","key":"use24","type":"text","value":"true","disabled":true},{"contentType":"String","description":"

The subaccount ZIP Code

\n","key":"zip-code","type":"text","value":""},{"contentType":"Int","description":"

Specifying a custom subaccount profile allows a superaccount to narrow down the subaccount enabled features (e.g. Only send SMS messages, or even further, only send a specific type of SMS message)

\n","key":"id-subaccount-profile","type":"text","value":"","disabled":true}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/subaccount/{subaccount_id}","description":"

Edits the subaccount identified by the given {subaccount_id}.\nCalling user must be a superaccount.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","subaccount","{subaccount_id}"],"host":["app","gateway","smsend","it"],"query":[{"disabled":true,"description":{"content":"

Activate or deactivate the subaccount

\n","type":"text/plain"},"key":"lock-subaccount","value":"{false}"}],"variable":[]}},"response":[{"id":"878652eb-0f75-4609-b065-fecfc8b422ee","name":"Edit subaccount","originalRequest":{"method":"PUT","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String","description":"The subaccount address","key":"address","type":"text","value":""},{"contentType":"String","description":"The subaccount mobile phone number","key":"cell","type":"text","value":""},{"contentType":"String","description":"The subaccount city","key":"city","type":"text","value":""},{"contentType":"Bool","description":"Is the subaccount a company?","key":"company","type":"text","value":"true","disabled":true},{"contentType":"String","description":"The company name. \nMandatory if company=true","key":"company-name","type":"text","value":"","disabled":true},{"contentType":"Int (0, 1, 2)","description":"Tells from who credits are scaled. 0 = own credits, 1 = superaccount credits, 2 = own credits and superaccount ones","key":"credit-eat-mode","type":"text","value":""},{"contentType":"Bool","description":"Use the Date Format in EUropean format\t","key":"dfeu","type":"text","value":"","disabled":true},{"contentType":"String (a valid Email)","description":"The subaccount email","key":"email","type":"text","value":""},{"contentType":"String","description":"The subaccount FAX number","key":"fax","type":"text","value":"","disabled":true},{"contentType":"String (a valid Email)","description":"If provided, invoices will be sent here instead of the default email","key":"invoicing-email","type":"text","value":"","disabled":true},{"contentType":"String","description":"The subaccount language. If none, defaults to the one of the superaccount","key":"language","type":"text","value":"","disabled":true},{"contentType":"String","description":"The subaccount login username (must not contain any spaces)","key":"login","type":"text","value":""},{"contentType":"String","description":"The subaccount owner first name","key":"name","type":"text","value":""},{"contentType":"String (Phone number)","description":"A phone number where test SMS messages will be sent","key":"num-cell-for-test-sms","type":"text","value":"","disabled":true},{"contentType":"String","description":"The subaccount password (min 8 chars, max 16 chars)","key":"password","type":"text","value":"If null, will be autogenerated","disabled":true},{"contentType":"String (PhoneNumber)","description":"The subaccount phone number","key":"phone","type":"text","value":"\"\"","disabled":true},{"contentType":"String","description":"The subaccount VAT number (P.Iva in Italy).\nMandatory if company=true","key":"piva","type":"text","value":"","disabled":true},{"contentType":"String","description":"The subaccount province","key":"province","type":"text","value":""},{"contentType":"Bool","description":"The subaccount is a superaccount itself (i.e. it can create his own subaccounts)","key":"superaccount","type":"text","value":"false","disabled":true},{"contentType":"String","description":"The subaccount last name","key":"surname","type":"text","value":""},{"contentType":"Bool","description":"Use the 24 hour format for time","key":"use24","type":"text","value":"true","disabled":true},{"contentType":"String","description":"The subaccount ZIP Code","key":"zip-code","type":"text","value":""},{"contentType":"Int","description":"Specifying a custom subaccount profile allows a superaccount to narrow down the subaccount enabled features (e.g. Only send SMS messages, or even further, only send a specific type of SMS message)","key":"id-subaccount-profile","type":"text","value":"","disabled":true}]},"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/subaccount/{subaccount_id}","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","subaccount","{subaccount_id}"],"query":[{"key":"lock-subaccount","value":"{false}","description":"Activate or deactivate the subaccount","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"On success, the above command returns the following response:\r\n# The HTTP location header that points to the edited subaccount:\r\n'Location': '/subaccount/18107'"}],"_postman_id":"d8c0bb3c-6487-4d67-ac1d-1e9a831d96ad"},{"name":"Change subaccount password","id":"d578bfb1-7b29-4854-b63e-672156f52060","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String","description":"

The subaccount password (min 8 chars, max 16 chars)

\n","key":"passwd","type":"text","value":""}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/subaccount/{subaccount_id}/changepwd","description":"

Change a subaccount’s password

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","subaccount","{subaccount_id}","changepwd"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"fae4d44b-3dab-4fe4-b740-945ec9242fec","name":"Change subaccount password","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String","description":"The subaccount password (min 8 chars, max 16 chars)","key":"passwd","type":"text","value":""}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/subaccount/{subaccount_id}/changepwd"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"On success, the above command returns the following response:\r\n# The HTTP location header that points to the subaccount 'change password' URL:\r\n'Location': '/subaccount/{subaccount_id}/changepwd'"}],"_postman_id":"d578bfb1-7b29-4854-b63e-672156f52060"},{"name":"Get subaccount","id":"86d87c1a-7596-4337-b8c5-e9af1963a861","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/subaccount/{subaccount_id}","description":"

Get a subaccount’s details

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","subaccount","{subaccount_id}"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"3f23b520-62ff-470f-8335-47ed59f4f7a0","name":"Get subaccount","originalRequest":{"method":"GET","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/subaccount/{subaccount_id}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"activation-time\": \"20160823\",\r\n \"active\": true,\r\n \"address\": \"via\",\r\n \"allowtpoavalidation\": true,\r\n \"cell\": \"+393385958233\",\r\n \"city\": \"Città\",\r\n \"fiscal-code\": \"FDFWEE92L45L458E\",\r\n \"pa-code\": null,\r\n \"company\": false,\r\n \"company-name\": null,\r\n \"create-time\": \"20160823\",\r\n \"credit-eat-mode\": 2,\r\n \"credits-sum\": \"€ 0,000\",\r\n \"default-message-type\": \"L\",\r\n \"default-nation\": \"ita\",\r\n \"dfeu\": true,\r\n \"email\": \"prova@prova.pr\",\r\n \"fax\": \"0461657575\",\r\n \"foreign\": false,\r\n \"id-user\": 5,\r\n \"invoicing-email\": null,\r\n \"language\": \"ita\",\r\n \"legal-agreement-time\": \"20160823\",\r\n \"legalAgreementVersion\": 0,\r\n \"login\": \"logon\",\r\n \"max-subaccounts\": -1,\r\n \"name\": \"nome\",\r\n \"num-cell-for-test-sms\": \"+393385958233\",\r\n \"partner\": false,\r\n \"partner-code\": null,\r\n \"phone\": \"0461657575\",\r\n \"piva\": null,\r\n \"preferred-tpoa\": \"+393385958233\",\r\n \"private\": true,\r\n \"province\": \"Trento\",\r\n \"referral\": false,\r\n \"shop_cart_check\": true,\r\n \"split-payment\": false,\r\n \"subaccount\": true,\r\n \"subaccount-types\": 0,\r\n \"super-account-name\": \"\",\r\n \"superaccount\": false,\r\n \"surname\": \"asdasd\",\r\n \"use24\": true,\r\n \"user-nation\": \"ita\",\r\n \"zip-code\": \"38010\",\r\n \"credits\": [\r\n {\r\n \"id\": \"N\",\r\n \"qty\": 0\r\n },\r\n {\r\n \"id\": \"L\",\r\n \"qty\": 0\r\n },\r\n {\r\n \"id\": \"LL\",\r\n \"qty\": 0\r\n },\r\n {\r\n \"id\": \"EE\",\r\n \"qty\": 0\r\n }\r\n ]\r\n}"}],"_postman_id":"86d87c1a-7596-4337-b8c5-e9af1963a861"},{"name":"Move credits from/to subaccount","id":"6d7ea9b5-7770-4e49-b5df-213ede562c81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"key":"credits","value":"","description":"

The list of credits to move

\n","type":"text","contentType":"List(Credit)"},{"key":"Credit.message-type","value":"","description":"

The message type (“N” for High quality with reception notification, “L” for Medium Quality, “LL” For Low Cost)

\n","type":"text","contentType":"String"},{"key":"Credit.amount","value":"","description":"

The number of credits to transfer

\n","type":"text","contentType":"Int"},{"key":"Credit.super-to-sub","value":"","description":"

The transfer direction. true for superaccount to subaccount, false for subaccount to superaccount

\n","type":"text","contentType":"Bool"}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/subaccount/{subaccount_id}/credit","description":"

Transfers credits between a superaccount and a subaccount.

The subaccount must be enabled to have its own credits (i.e. subaccount credit-eat-mode is 0 or 2)

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","subaccount","{subaccount_id}","credit"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"d8042f78-6737-4d71-80f0-0cac30441a3e","name":"Move credits from/to subaccount","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"key":"credits","value":"","description":"The list of credits to move","type":"text","contentType":"List(Credit)"},{"key":"Credit.message-type","value":"","description":"The message type (“N” for High quality with reception notification, “L” for Medium Quality, “LL” For Low Cost)","type":"text","contentType":"String"},{"key":"Credit.amount","value":"","description":"The number of credits to transfer","type":"text","contentType":"Int"},{"key":"Credit.super-to-sub","value":"","description":"The transfer direction. true for superaccount to subaccount, false for subaccount to superaccount","type":"text","contentType":"Bool"}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/subaccount/{subaccount_id}/credit"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"On success, the above command returns the following response:\r\n# The HTTP Location header points to the API to recover credits:\r\n'Location': '/subaccount/{subaccount_id}/credit'"}],"_postman_id":"6d7ea9b5-7770-4e49-b5df-213ede562c81"},{"name":"Get subaccount available credits","id":"90f48463-f141-4d5a-a4b1-6ce7c887b92e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/subaccount/{subaccount_id}/credit","description":"

Returns the available credits of the given subaccount

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/subaccount/{subaccount_id}/purchase","description":"

Returns the paginated list of purchases made by a subaccount. Caller must be a superaccount.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","subaccount","{subaccount_id}","purchase"],"host":["app","gateway","smsend","it"],"query":[{"disabled":true,"description":{"content":"

Return the given results page

\n","type":"text/plain"},"key":"pageNumber","value":"{1}"},{"disabled":true,"description":{"content":"

The number of results in a page

\n","type":"text/plain"},"key":"pageSize","value":"{10}"}],"variable":[]}},"response":[{"id":"4fe6fdbc-cbea-4fb2-8d44-f96235185fc3","name":"Get a subaccount’s purchases","originalRequest":{"method":"GET","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.gateway.smsend.it/API/v1.0/REST/subaccount/{subaccount_id}/purchase","protocol":"https","host":["app","gateway","smsend","it"],"path":["API","v1.0","REST","subaccount","{subaccount_id}","purchase"],"query":[{"key":"pageNumber","value":"{1}","description":"Return the given results page","disabled":true},{"key":"pageSize","value":"{10}","description":"The number of results in a page","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"result\": \"OK\",\r\n \"purchases\": [\r\n {\r\n \"super-to-sub\": false,\r\n \"amount\": 37,\r\n \"create-time\": \"20160826104539\",\r\n \"id_purchase\": 20,\r\n \"price\": 37,\r\n \"available\": 0,\r\n \"message-types\": [\r\n {\r\n \"message-type\": \"N\",\r\n \"unit-price\": 1.2\r\n },\r\n {\r\n \"message-type\": \"LL\",\r\n \"unit-price\": 0.8\r\n }\r\n ]\r\n },\r\n {\r\n \"super-to-sub\": true,\r\n \"amount\": 37,\r\n \"create-time\": \"20160826103027\",\r\n \"id_purchase\": 20,\r\n \"price\": 37,\r\n \"available\": 0,\r\n \"message-types\": [\r\n {\r\n \"message-type\": \"N\",\r\n \"unit-price\": 1.2\r\n },\r\n {\r\n \"message-type\": \"LL\",\r\n \"unit-price\": 0.8\r\n }\r\n ]\r\n }\r\n ],\r\n \"pageNumber\": 1,\r\n \"pageSize\": 10,\r\n \"total\": 2\r\n}"}],"_postman_id":"ca837095-5dfd-4af5-868a-338387568235"},{"name":"Create a subaccount purchase","id":"224c4246-eaa3-4240-a4a9-576023a0cc07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"key":"purchases","value":"","description":"

The list of purchases to be created

\n","type":"text","contentType":"List(Purchase)"},{"key":"Purchase.message-types","value":"","description":"

The purchase’s message types

\n","type":"text","contentType":"List(MessageType)"},{"key":"Purchase.price","value":"","description":"

The quantity of purchased credits

\n","type":"text","contentType":"Float"},{"key":"MessageType.message-type","value":"","description":"

The message type (“N” for High quality with reception notification, “L” for Medium Quality, “LL” For Low Cost)

\n","type":"text","contentType":"String"},{"key":"MessageType.unit-price","value":"","description":"

The cost for the subaccount of a unit of the respective message-type

\n","type":"text","contentType":"Float"}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/subaccount/{subaccount}/purchase","description":"

Creates one or more purchases for the given subaccount.

Subaccount credit-eat-mode must be 2. Caller must be a superaccount.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","subaccount","{subaccount}","purchase"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"482ae43a-d1f6-4c5e-bf19-10a36c29fce1","name":"Create a subaccount purchase","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"key":"purchases","value":"","description":"The list of purchases to be created","type":"text","contentType":"List(Purchase)"},{"key":"Purchase.message-types","value":"","description":"The purchase’s message types","type":"text","contentType":"List(MessageType)"},{"key":"Purchase.price","value":"","description":"The quantity of purchased credits","type":"text","contentType":"Float"},{"key":"MessageType.message-type","value":"","description":"The message type (“N” for High quality with reception notification, “L” for Medium Quality, “LL” For Low Cost)","type":"text","contentType":"String"},{"key":"MessageType.unit-price","value":"","description":"The cost for the subaccount of a unit of the respective message-type","type":"text","contentType":"Float"}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/subaccount/{subaccount}/purchase"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"On success, the above command returns the following response:\r\n# The HTTP location header that points to the subaccount 'create purchase' URL:\r\n'Location': '/subaccount/{subaccount_id}/purchase'"}],"_postman_id":"224c4246-eaa3-4240-a4a9-576023a0cc07"},{"name":"Delete a subaccount’s purchase","id":"baf0f157-b997-4da7-bdb3-b6ecf850e149","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/subaccount/{subaccount_id}/purchase/{purchase_id}","description":"

Deletes a purchase of the given subaccount.

Caller must be a superaccount, and the Subaccount’s credit-eat-mode should be 2.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","subaccount","{subaccount_id}","purchase","{purchase_id}"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"f3e25b44-9f17-4824-94a3-c4807e0c1288","name":"Delete a subaccount’s purchase","originalRequest":{"method":"DELETE","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/subaccount/{subaccount_id}/purchase/{purchase_id}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"result\":\"OK\"\n}"}],"_postman_id":"baf0f157-b997-4da7-bdb3-b6ecf850e149"}],"id":"e05315ed-700d-4908-8439-e88f150e6324","description":"

If enabled as a superaccount or reseller, the user can create subaccounts that can be assigned to third-parties.

Superaccounts may or may not share credits with their subaccounts.

Remember to provide the authentication HTTP headers as described in the Authenticate using a session key and the Authenticate using a user tokeny sections.

All the query string parameters in URL must be UTF-8 URL Encoded.

\n","_postman_id":"e05315ed-700d-4908-8439-e88f150e6324"},{"name":"Two Factor Authentication API","item":[{"name":"Request a 2FA Pin","id":"f5343934-9829-42f1-a079-83fa2e8d9db7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"key":"recipient","value":"","description":"

The phone number of the user. The format must be +1111111111 or 001111111111

\n","type":"text","contentType":"String"},{"key":"senderName","value":"","description":"

The sender name or number for the text message

\n","type":"text","contentType":"String","disabled":true},{"key":"expiry","value":"60","description":"

The expiration time of the PIN, in minutes

\n","type":"text","contentType":"Integer","disabled":true},{"key":"messageBody","value":"","description":"

The message body. \nPIN position in the text can be specified using the %PIN% placeholder. \nIf the placeholder is not provided the pin will be added at the end of message body.

\n","type":"text","contentType":"String"}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/2fa/request","description":"

Request a Two Factor Authentication via text message. This method generates a pin and sends it via text message to the user.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","2fa","request"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"55762ee3-917f-4840-957e-a92a8a973708","name":"Request a 2FA Pin","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"key":"recipient","value":"","description":"The phone number of the user. The format must be +1111111111 or 001111111111","type":"text","contentType":"String"},{"key":"senderName","value":"","description":"The sender name or number for the text message","type":"text","contentType":"String","disabled":true},{"key":"expiry","value":"60","description":"The expiration time of the PIN, in minutes","type":"text","contentType":"Integer","disabled":true},{"key":"messageBody","value":"","description":"The message body. \nPIN position in the text can be specified using the %PIN% placeholder. \nIf the placeholder is not provided the pin will be added at the end of message body.","type":"text","contentType":"String"}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/2fa/request"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"f5343934-9829-42f1-a079-83fa2e8d9db7"},{"name":"Verify a 2FA Pin","id":"13895afa-67ef-494a-933c-938fa66c6a5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Authenticated user_key

\n","key":"user_key","type":"text","value":""},{"description":"

Authenticated Session_key

\n","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String","description":"

The phone number of the user. The format must be +1111111111 or 001111111111

\n","key":"recipient","type":"text","value":""},{"contentType":"String","description":"

The pin inserted by the user

\n","key":"pin","type":"text","value":""}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/2fa/verify","description":"

Verify that the pin inserted by the user is valid.

\n","urlObject":{"protocol":"https","path":["API","v1.0","REST","2fa","verify"],"host":["app","gateway","smsend","it"],"query":[],"variable":[]}},"response":[{"id":"27be3b45-afb2-4f36-bb38-75416ced4494","name":"Verify a 2FA Pin","originalRequest":{"method":"POST","header":[{"description":"Authenticated user_key ","key":"user_key","type":"text","value":""},{"description":"Authenticated Session_key","key":"Session_key","type":"text","value":""}],"body":{"mode":"formdata","formdata":[{"contentType":"String","description":"The phone number of the user. The format must be +1111111111 or 001111111111","key":"recipient","type":"text","value":""},{"contentType":"String","description":"The pin inserted by the user","key":"pin","type":"text","value":""}]},"url":"https://app.gateway.smsend.it/API/v1.0/REST/2fa/verify"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"13895afa-67ef-494a-933c-938fa66c6a5f"}],"id":"7b06bcf4-112d-49c8-b951-17fda7c01f45","description":"

This is the part of the API that provides the Two Factor Authentication. The flow of 2FA is:

The User specifies his number in your App.
\n
Your App sends a 2FA request via API.
\n
The platform sends a text message to the specified recipient.
\n
User receives the PIN via text message
\n
User enters the PIN in your App.
\n
Your App sends the 2FA verify via API and receives the authorization or an invalid pin error.
\n

The text message is sent with the highest quality on a preferred route, to guarantee a quick delivery.

Remember to provide the authentication HTTP headers as described in the Authenticate using a session key and the Authenticate using a user tokeny sections.

All the query string parameters in URL must be UTF-8 URL Encoded.

\n","_postman_id":"7b06bcf4-112d-49c8-b951-17fda7c01f45"}],"event":[{"listen":"prerequest","script":{"id":"4268205b-7ff5-4cee-ad41-9abf45d91a8a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5bbd6e53-ecc7-4ac4-b157-560dc8baacd7","type":"text/javascript","exec":[""]}}]}