{ "_type": "export", "__export_format": 4, "__export_date": "2023-11-02T13:07:22.874Z", "__export_source": "insomnia.importers:v0.1.0", "resources": [ { "_type": "workspace", "_id": "__WORKSPACE_ID__", "parentId": null, "name": "Redlink API v2.1.1.0", "description": "# Introduction\r\n\r\nWe are pleased to present you our new REST API. At the begining of this documentation we would like to give you some general informations about this API:\r\n\r\n1. It's based on [JSONAPI](https://jsonapi.org/) specification. We hope that following the rules of this specification will make our API easy to understand.\r\n2. This documentation is generated from swagger file - written in [OpenAPI 3.0.2 Specification](https://swagger.io/specification/)\r\n3. This API always accept application/json format at the API input and always return the same format as output.\r\n4. API output always follows this scheme:\r\n```text\r\n{\r\n \"meta\": {\r\n \"numberOfErrors\": NUMBER_OF_ELEMENTS_IN_ERRORS (number),\r\n \"numberOfData\": NUMBER_OF_ELEMENTS_IN_DATA (number),\r\n \"status\": HTTP_STATUS (number),\r\n \"uniqId\": UNIQUE_REQUEST_ID (string)\r\n },\r\n \"data\": [],\r\n \"errors\": [\r\n {\r\n \"title\": ERROR_TITLE (string),\r\n \"message\": ERROR_MESSAGE (string),\r\n \"code\": ERROR_CODE (string),\r\n \"meta\":{\r\n \"parameter\": SOME_VALUE (string),\r\n \"value\": SOME_VALUE (string),\r\n \"source\": SOME_VALUE (string),\r\n \"somefield\": SOME_VALUE (string)\r\n }\r\n }\r\n ]\r\n}\r\n```\r\n\r\nFollowing rules applies to the above scheme:\r\n* `meta` element is always present\r\n* `meta.numberOfErrors` indicates how many elements `errors` array includes\r\n* `meta.numberOfData` indicates how many elements `data` array includes\r\n* `meta.status` indicates response HTTP status\r\n* `meta.uniqId` is used to identify request, if your will have some troubles with your request, please make sure that you sent us `meta.uniqId` value\r\n* `meta` may contain additional fields\r\n* `data` array cannot be present with `errors` array if status code is different than HTTP 207 (MULTI-STATUS)\r\n* `errors` array always consists object with fields: `title`, `message` and `code`.\r\n* `meta` element may be present inside single error object and contain additional information (that can be parsed) about error\r\n* `parameter` the parameter that causes the error\r\n* `value` the value of this parameter passed\r\n* `source` a link to the entity that caused the error, e.g. externalId\r\n* `somefield` additional fields that may appear\r\n\r\n# Authentication\r\n\r\nSecond version of VercomAPI offers authentication with pair of keys: Application-Key and Authorization. You can generate your keys in your account panel. To authenticate simply add to your request header with name `Authorization` and your authorization key as value (string of 128 characters length) and header with name `Application-Key` and your app key as value.\r\n\r\nExample:\r\n\r\n```bash\r\n$ curl --request POST \\\r\n --header 'Content-Type: application/json' \\\r\n --header 'Application-Key: ' \\\r\n --header 'Authorization: ' \\\r\n --url '...'\r\n --data '{ ... }' \r\n```\r\n\r\n# REST clients samples\r\n\r\nTo make integration with our API clear, we have provided examples for some well known REST clients. Feel free to play with these samples.\r\n\r\n[![Run in Postman](https://run.pstmn.io/button.svg)](/postman-collection.json)\r\n\r\n[![Run in Insomnia}](https://insomnia.rest/images/run.svg)](/insomnia.json)\r\n\r\n# Long running actions - Retry-After header explained\r\n\r\nThis API provide some actions that should be used in different way. When we have to deal with long running tasks we don't want to make client wait. To resolve this case we provided support for `Retry-After` header. How it works? Pretty simple:\r\n\r\n1. Client executes long running action (ex. POST /long-running)\r\n2. If response data is available then response with HTTP status 200 and data array is returned\r\n3. If request is not yet available API returns following response:\r\n\r\n```text\r\nHTTP/1.1 202 ACCEPTED\r\n\r\nContent-Type: application/json\r\nRetry-After: \r\nExpires: \r\n\r\n...\r\n```\r\nAnd here we have to explain the meaning of above response headers:\r\n\r\n* `HTTP/1.1 202 ACCEPTED` indicates that response is not yet available\r\n* `Retry-After` indicates how long client should wait before making next request to this endpoint\r\n* `Expires` contains the date/time after which the response is considered stale (client should NOT make another request to this endpoint after time specified at this header)\r\n\r\nThat all. Pretty simple. Isn't it?\r\n\r\n# Input compression\r\n\r\nThis API supports following compression algorithms: gzip.\r\nTo enable this feature just add following header to your request:\r\n\r\n```text\r\nContent-Encoding: gzip \r\n```\r\n\r\nNote that API always returns `application/json` response body.\r\n\r\nIn case of sending not compressed data with `Content-Encoding: gzip` header error will be returned.\r\n\r\n# Using filters\r\n\r\nThis API supports filters for `GET` methods. Almost all of these methods support two filters: `limit` and `offset`. They are used for pagination.\r\n\r\n* `limit` is used to limit number of elements that should API return\r\n* `offset` is used to ommit number of elements from begining\r\n\r\nIn some `GET` methods you can also use additional filters:\r\n\r\n* `getFullDate` is used to get pretty printed DateTime instead Timestamp, accept int values, 0 means get timestamp, 1 means get formated DateTime\r\n\r\n# Dynamic e-mail content\r\n\r\nWith this feature, you can dynamically generate e-mail content (HTML/TEXT of the e-mail) based on additional variables passed in `to` parametr as `vars` or in `globalVars` parameter.\r\nYou can see examples of these parameters in the description of the method.\r\n\r\nThis feature is best suited for transactional e-mails to generate e.g. product lists or personalise the e-mail to suit each individual recipient. Remember that the overall pers request payload limit applies.\r\n\r\nHow to use this feature? Easy.\r\n\r\nYour HTML/TEXT should contain variables and/or: `foreach` loop, `if else` statement. For example like this:\r\n```html\r\n\r\n\r\n \r\n \r\n \r\n \r\n {%if sex == 'female'%}\r\n

Dear Madame,

\r\n {%elseif sex == 'male'%}\r\n

Dear Sir,

\r\n {%else%}\r\n

Hello,

\r\n {%endif%}\r\n \r\n
\r\n\r\n {%if products %}\r\n
Thank you for ordering some products!
\r\n {%endif%}\r\n\r\n

\r\n\r\n {%if promos %}\r\n You have some promos!\r\n \r\n {%endif%}\r\n\r\n

\r\n\r\n BASIC PRODUCT LIST\r\n \r\n\r\n

\r\n\r\n Show some alpaca if user has newsletter option!
\r\n {%if hasNewsletter == true %}\r\n \r\n {%endif%}\r\n\r\n {{footer}}\r\n \r\n \r\n \r\n```\r\nAnd then your `to` parameter could look like this:\r\n```json\r\n{\r\n \"to\":[\r\n {\r\n \"email\":\"jane.doe@acmedomain.com\",\r\n \"messageId\":\"janedoe00001id@acmedomain.com\",\r\n \"name\":\"Jane Doe\",\r\n \"vars\":{\r\n \"hasNewsletter\":true,\r\n \"products\":{\r\n \"1\":{\r\n \"name\":\"skirt\",\r\n \"id\":1,\r\n \"color\":\"green\"\r\n },\r\n \"2\":{\r\n \"name\":\"hoodie\",\r\n \"id\":6,\r\n \"color\":\"red\",\r\n \"options\":[\r\n \"pocket\",\r\n \"print\",\r\n \"glitter\"\r\n ]\r\n },\r\n \"3\":{\r\n \"name\":\"dress\",\r\n \"id\":\"100\",\r\n \"color\":\"blue\"\r\n }\r\n },\r\n \"promos\":{\r\n \"1\":{\r\n \"name\":\"test40\",\r\n \"value\":300\r\n },\r\n \"2\":{\r\n \"name\":\"test800\",\r\n \"value\":3008\r\n }\r\n },\r\n \"footer\":\"
crazy custom footer
\"\r\n }\r\n }\r\n ]\r\n}\r\n```\r\nAnd that's the tea. Happy sending! :)\r\n\r\n# SMS Billing\r\n\r\nSms billing table. GSM-7 characters are standard characters used in SMS messages. The use of other characters significantly shortens the length of individual messages. The tables below illustrate this rule.\r\n\r\n| Only GSM7 characters | SMS count |\r\n|------------------------|-----------|\r\n| 1 - 160 characters | 1 |\r\n| 161 - 306 characters | 2 |\r\n| 307 - 459 characters | 3 |\r\n| 460 - 612 characters | 4 |\r\n| 613 - 765 characters | 5 |\r\n| 766 - 918 characters | 6 |\r\n| 919 - 1071 characters | 7 |\r\n| 1072 - 1224 characters | 8 |\r\n| 1225 - 1377 characters | 9 |\r\n\r\n\r\n| Characters not included in the GSM7 table | SMS count |\r\n|-------------------------------------------|-----------|\r\n| 1 - 70 characters | 1 |\r\n| 71 - 134 characters | 2 |\r\n| 135 - 201 characters | 3 |\r\n| 202 - 268 characters | 4 |\r\n| 269 - 335 characters | 5 |\r\n| 336 - 402 characters | 6 |\r\n| 403 - 469 characters | 7 |\r\n| 470 - 536 characters | 8 |\r\n| 537 - 603 characters | 9 |\r\n\r\n# Incoming webhooks\r\nListen for events on your account so your integration can automatically trigger reactions.\r\n\r\nIt is possible to receive delivery and/or click and/or open statuses of all your sendouts from different channels of communication via webhook. A webhook enables us to push real-time notifications to your app. We use HTTPS to send these notifications to your app as a JSON payload. You can then use these notifications to execute actions in your backend systems. Webhooks are particularly useful for sendouts in which you wish to act on the event or display information about delivery in your systems as soon as possible. Alternatively when you need very detailed status information for each message for a large dataset that cannot be found in our panel (for example due to TTL).\r\n\r\n## Steps to configure webhooks\r\n1. Identify the events you want to monitor and the event payloads to parse (payloads are described below).\r\n2. Create a webhook endpoint as an HTTPS endpoint (URL) on your server.\r\n3. Handle requests by saving each event object (parse it later) and returning 200 response status codes with a string message 'ok'.\r\n4. Test that your webhook endpoint is working properly using settings in our panel\r\n5. Save your webhook configuration in panel\r\n\r\n## Step 1: Identify the events to monitor\r\nThe events you can monitor are dependent on your plan and features that you use. The full list is available in the configuration page in our panel under *Account -> Settings -> Webhooks*.\r\n\r\n## Step 2: Create a webhook endpoint\r\nGenerally you can specify two URLs for each webhook type. Default URL and secondary URL. Unless specified otherwise (in send request), the webhook will be sent to the main URL and when it’s unavailable or fails to respond properly, to the secondary URL.\r\n\r\n## Step 3: Handle requests\r\nThe data is provided in a POST request that consists of an array of events. Each event is structured as an event object but its structure varies in accordance to the type of the event (see below for detailed descriptions for each type). Your endpoint should:\r\ncheck the authorization (in accordance to the setting in panel),\r\nsave the payload,\r\nrespond with `Status: 200` and `Message: ok`. The ‘ok’ is a lowercase string.\r\nYour server should NOT validate the payload before giving the response. The only reasons to respond with something other than success should be authorization failure or an actual internal server error. You should parse your stored payload data into intended structures in a different process (than the receiving endpoint).\r\n\r\nOur request can look like this:\r\n```\r\n[{\"externalId\":\"xxxxxxxxxxxxxxxxxxxxxxxx\",\"phoneNumber\":\"+48XXXXXXXXX\",\"status\":1,\"statusDesc\":\"DELIVERED\",\"statusTime\":\"2021-04-27T00:00:18\",\"webhookUrl\":\"xxxxxxxxxxxxxxx\"}]\r\n```\r\nor like this:\r\n```\r\n[{\"externalId\": \"xxxxxxxxxxxxxxxxxxxxxxxx\",\"appId\": \"xxxxxxxxxxxxxxxxxxxxxxxx\",\"platform\": 1,\"status\": 1,\"statusDesc\": \"Accepted by push operator\",\"statusDetails\": \"NOTIFICATION_CLICK_ACTION\",\"statusTime\": \"2020-12-08T11:57:08\",\"actionId\": null,\"code\":null}]\r\n```\r\nThe specific fields depend on the type of webhook (see below).\r\n\r\n### Authorization\r\n\r\nMake sure that the webhooks actually come from us and stay secure.\r\nIn the panel you can see 2 options for authentication:\r\n- None\r\n- Basic auth.\r\n\r\nWhether you choose to additionally use basic auth or not, you should always check the hash of incoming webhook. With our POST request, in addition to the standard HTTP headers, we send three headers will allow you to verify if the data actually come from us:\r\n\r\n| Header | Type | Description |\r\n|--------------------|--------|-----------------------------------|\r\n| X-Webhook-Date | string | Date on which the webhook is sent |\r\n| X-Webhook-Checksum | string | Checksum | \r\n| Request-Id | string | Unique request ID |\r\n\r\nNow, the checksum is generated from a string built like this:\r\n```\r\nsecretkey|X-Webhook-Date|Request-Id\r\n```\r\n\r\n| Value | Description |\r\n|----------------|------------------------------------------------------------------------|\r\n| secretkey | is a key given to you when you configure your webhook inside the panel |\r\n| X-Webhook-Date | from headers |\r\n| Request-Id | from headers |\r\n\r\nAdditionally, you can protect your script with basic auth. All you need to do is turn the option on and set login and password in the panel. Then, of course, add authentication to your endpoint.\r\n\r\n### Webhook types and event object structures\r\n#### Transactional e-mails\r\n\r\nRemember to use unique message_ids so that you can later aggregate all the webhooks (with consecutive statuses).\r\n\r\nexample:\r\n```\r\n[\r\n{\r\n \"subject\": \"Your chosen subject\",\r\n \"smtpAccount\": \"1.accountname.smtp\",\r\n \"to\": {\r\n \"email\": \"test@test.com\",\r\n \"name\": \"Jane Doe\",\r\n \"messageId\": \"d18aa9aa-109e-1b16-a52d-205eac42e44a@domain.com\"\r\n },\r\n \"from\": {\r\n \"email\": \"test@domain.com\",\r\n \"name\": \"Test Corp.\"\r\n },\r\n \"tags\": null,\r\n \"status\": \"dropped\",\r\n \"statusTime\": 1580996271,\r\n \"statusDesc\": \"test@test.com in blacklist\",\r\n \"allStatuses\": [\r\n {\r\n \"status\": \"injected\",\r\n \"statusTime\": 1580996275,\r\n \"statusDesc\": \"injected\"\r\n },\r\n {\r\n \"status\": \"dropped\",\r\n \"statusTime\": 1580996271,\r\n \"statusDesc\": \"test@test.com in blacklist\"\r\n }\r\n ]\r\n }\r\n]\r\n```\r\n#### Transactional SMS - delivery reports\r\n| Field | Type | Example |\r\n|--------------|--------|----------------------------|\r\n| externalId | string | test123 |\r\n| status | int | 1 |\r\n| statusDesc | string | DELIVERED |\r\n| statusTime | string | 2021-12-12T12:12:12 |\r\n| webhookUrl* | string | https://test.pl/test.aspx |\r\n\r\n*This object contains a `webhookUrl` field because, when sending transactional SMS it is possible to specify a webhook URL inside send request directly. In that case, both default URL and secondary URL configured in the panel will be ignored and the webhook will be sent to this, additionally specified, URL.\r\n\r\nexample:\r\n```\r\n[{\"externalId\":\"xxxxxxxxxxxxxxxxxxxxxxxx\",\"phoneNumber\":\"+48XXXXXXXXX\",\"status\":1,\"statusDesc\":\"DELIVERED\",\"statusTime\":\"2021-04-27T00:00:18\",\"webhookUrl\":\"xxxxxxxxxxxxxxx\"}]\r\n```\r\n\r\n#### Transactional SMS - clicked link\r\n\r\n| Field | Type | Example |\r\n|--------------|--------|------------------------------------------------------------------------------------------------------------------|\r\n| externalId | string | test123 | | phoneNumber | string | +48111222333 |\r\n| url | string | http://www.test.pl/kontact/?place=menu |\r\n| clickTime | string | 2021-12-12T12:12:12 |\r\n| ip | string | 111.222.11.22 |\r\n| userAgent | string | Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/xxx.xx (KHTML, like Gecko) Chrome/xxx.xx.xxx.xx Safari/xxx.xx Google |\r\n| webhookUrl* | string | https://test.pl/test.aspx |\r\n\r\n*This object contains a `webhookUrl` field because, when sending transactional SMS it is possible to specify a webhook URL inside send request directly. In that case, both default URL and secondary URL configured in the panel will be ignored and the webhook will be sent to this, additionally specified, URL.\r\n\r\n#### 2-way communication - Incoming SMS\r\n\r\n| Field | Type | Example |\r\n|-------------|--------|--------------------------------------|\r\n| id | string | F2D21CA2-916E-4B92-B686-606231D9165F |\r\n| phoneNumber | string | +48111222333 |\r\n| message | string | Thank You |\r\n| ndi | string | 48111222333 |\r\n| statusTime | string | 2021-11-15T12:25:32 |\r\n\r\n#### Push messages - delivery reports\r\n\r\n| Field | Type | Example |\r\n|---------------|--------|--------------------------------------|\r\n| externalId | string | xxxxxxxxxxxxxxxxxxxxxxxx |\r\n| appId | string | xxxxxxxxxxxx |\r\n| platform | int | 1 |\r\n| status | int | 1 |\r\n| statusDesc | string | Accepted by push operator |\r\n| statusDetails | string | NOTIFICATION_CLICK_ACTION |\r\n| actionId | int | 1 |\r\n| code | string | null |\r\n| statusTime | string | 2021-11-15T12:25:32 |\r\n\r\nValues for field `platform`:\r\n\r\n| | |\r\n|---|---------|\r\n| 1 | IOS |\r\n| 2 | ANDROID |\r\n\r\nValues for field `status`:\r\n\r\n| | |\r\n|---|------------|\r\n| 1 | DISCARDED |\r\n| 2 | SCHEDULED |\r\n| 3 | SENT |\r\n| 4 | FAILED |\r\n| 5 | RECEIVED |\r\n| 6 | REACTED_ON |\r\n\r\nValues for field `statusDesc`:\r\n\r\n| | |\r\n|------------|-------------------------------------|\r\n| DISCARDED | \"Push validation failed\" |\r\n| SCHEDULED | \"Push accepted by push operator\" |\r\n| SENT | \"Push accepted by FCM/APNS servers\" |\r\n| FAILED | \"Push dropped by FCM/APNS\" |\r\n| RECEIVED | \"Push received by device\" |\r\n| REACTED_ON | \"User reacted on push\" |\r\n\r\nValues for field `statusDetails`:\r\n\r\n| |\r\n|---------------------------|\r\n| NOTIFICATION_CLICK_ACTION |\r\n| NOTIFICATION_SWIPE_ACTION |\r\n| DIALOG_DISSMISS_ACTION |\r\n\r\nexample:\r\n```\r\n[{\"externalId\": \"xxxxxxxxxxxxxxxxxxxxxxxx\",\"appId\": \"xxxxxxxxxxxxxxxxxxxxxxxx\",\"platform\": 1,\"status\": 1,\"statusDesc\": \"Accepted by push operator\",\"statusDetails\": \"NOTIFICATION_CLICK_ACTION\",\"statusTime\": \"2020-12-08T11:57:08\",\"actionId\": null,\"code\":null}]\r\n```\r\n\r\n\r\n#### Email campaign webhooks\r\n\r\n| Field | Type | Example |\r\n|----------------------|-----------------|-----------------------------------------------------------------------------------------------------------------|\r\n| id | string | 345dfsg2-dfws-w451-1245-sdfgsdf23441 |\r\n| contact | object | |\r\n| contact[externalId] | string | 78b556af-c01b-4341-8059-f5ce08f5ad14 |\r\n| contact[email] | string | test@domain.com |\r\n| contact[phoneNumber] | string | +48111222333 |\r\n| campaign | object | |\r\n| campaign[externalId] | string | DFG2345T-3456-6734-6345-FHDF65341235 |\r\n| status | object | |\r\n| status[id] | int | 4 |\r\n| status[desc] | string | CLICKED |\r\n| status[time] | string | 2023-08-08T11:15:53.053 |\r\n| details | object | |\r\n| details[id] | int nullable | 2 |\r\n| details[desc] | string nullable | HARD_BOUNCE |\r\n| details[ip] | string nullable | 100.20.30.400 |\r\n| details[userAgent] | string nullable | Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Mobile Safari/537.36 |\r\n| details[referer] | string nullable | https://www.redlink.pl/ |\r\n\r\nExample:\r\n```\r\n{\r\n \"id\": \"345dfsg2-dfws-w451-1245-sdfgsdf23441\",\r\n \"contact\": {\r\n \"externalId\": \"78b556af-c01b-4341-8059-f5ce08f5ad14\",\r\n \"email\": \"test@domain.com\",\r\n \"phoneNumber\": \"+48111222333\"\r\n },\r\n \"campaign\": {\r\n \"externalId\": \"DFG2345T-3456-6734-6345-FHDF65341235\"\r\n },\r\n \"status\": {\r\n \"id\": 4,\r\n \"desc\": \"CLICKED\",\r\n \"time\": \"2023-08-08T11:15:53.053\"\r\n },\r\n \"details\": {\r\n \"id\": null,\r\n \"desc\": null,\r\n \"ip\": \"100.20.30.400\",\r\n \"userAgent\": \"Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Mobile Safari/537.36\",\r\n \"referer\": \"https://www.redlink.pl/\"\r\n }\r\n}\r\n```\r\n\r\nValues for field `status`:\r\n\r\n| id | desc |\r\n|----|-----------|\r\n| 0 | SENT |\r\n| 1 | DELIVERED |\r\n| 2 | FAILED |\r\n| 3 | RECEIVED |\r\n| 4 | CLICKED |\r\n\r\nValues for field `details`:\r\n\r\n| id | desc |\r\n|----|----------------------------|\r\n| 1 | TRANSIENT |\r\n| 2 | HARD_BOUNCE |\r\n| 3 | AUTO_RESPONDER |\r\n| 4 | ADDRESS_CHANGE |\r\n| 5 | CHALLENGE_VERIFICATION |\r\n| 6 | DNS_ERROR |\r\n| 7 | SPAM_NOTIFICATION |\r\n| 8 | OPEN_RELAY_TEST |\r\n| 9 | UNKNOWN |\r\n| 10 | SOFT_BOUNCE |\r\n| 11 | VIRUS_NOTIFICATION |\r\n| 12 | CANCELLED |\r\n| 13 | CUSTOM_SMTP_SERVER_ERROR |\r\n| 14 | REDLINK_SMTP_SERVER_ERROR |\r\n| 15 | REDLINK_SMTP_EMAIL_TOO_BIG |\r\n| 16 | INSUFFICIENT_FUNDS |\r\n| 17 | LIMIT_EXCEEDED |\r\n| 18 | CONTROL_GROUP |\r\n| 19 | CAPPING_LIMIT_EXCEEDED |\r\n\r\n#### Sms campaign webhooks\r\n\r\n| Field | Type | Example |\r\n|----------------------|-----------------|-----------------------------------------------------------------------------------------------------------------|\r\n| id | string | 345dfsg2-dfws-w451-1245-sdfgsdf23441 |\r\n| contact | object | |\r\n| contact[externalId] | string | 78b556af-c01b-4341-8059-f5ce08f5ad14 |\r\n| contact[email] | string | test@domain.com |\r\n| contact[phoneNumber] | string | +48111222333 |\r\n| campaign | object | |\r\n| campaign[externalId] | string | DFG2345T-3456-6734-6345-FHDF65341235 |\r\n| status | object | |\r\n| status[id] | int | 4 |\r\n| status[desc] | string | CLICKED |\r\n| status[time] | string | 2023-08-08T11:15:53.053 |\r\n| details | object | |\r\n| details[id] | int nullable | 2 |\r\n| details[desc] | string nullable | SMS_ERROR |\r\n| details[ip] | string nullable | 100.20.30.400 |\r\n| details[userAgent] | string nullable | Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Mobile Safari/537.36 |\r\n| details[referer] | string nullable | https://www.redlink.pl/ |\r\n\r\n\r\nExample:\r\n```\r\n{\r\n \"id\": \"345dfsg2-dfws-w451-1245-sdfgsdf23441\",\r\n \"contact\": {\r\n \"externalId\": \"78b556af-c01b-4341-8059-f5ce08f5ad14\",\r\n \"email\": \"test@domain.com\",\r\n \"phoneNumber\": \"+48111222333\"\r\n },\r\n \"campaign\": {\r\n \"externalId\": \"DFG2345T-3456-6734-6345-FHDF65341235\"\r\n },\r\n \"status\": {\r\n \"id\": 4,\r\n \"desc\": \"CLICKED\",\r\n \"time\": \"2023-08-08T11:15:53.053\"\r\n },\r\n \"details\": {\r\n \"id\": null,\r\n \"desc\": null,\r\n \"ip\": \"100.20.30.400\",\r\n \"userAgent\": \"Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Mobile Safari/537.36\",\r\n \"referer\": \"https://www.redlink.pl/\"\r\n }\r\n}\r\n```\r\n\r\nValues for field `status`:\r\n\r\n| id | desc |\r\n|----|-----------|\r\n| 0 | SENT |\r\n| 1 | DELIVERED |\r\n| 2 | FAILED |\r\n| 3 | RECEIVED |\r\n| 4 | CLICKED |\r\n\r\nValues for field `details`:\r\n\r\n| id | desc |\r\n|----|--------------------------|\r\n| 1 | SMS_CANCELED |\r\n| 2 | SMS_ERROR |\r\n| 3 | SMS_BAD_NUMBER |\r\n| 4 | SMS_MESSAGE_TOO_LONG |\r\n| 5 | SMS_MESSAGE_INCORRECT |\r\n| 6 | SMS_WAITING |\r\n| 7 | SMS_MESSAGE_TOO_SHORT |\r\n| 8 | SMS_UNKNOWN_ERROR |\r\n| 10 | SMS_ECO_AS_ABROAD_NUMBER |\r\n| 11 | SMS_ABROAD_NOT_ALLOWED |\r\n| 12 | SMS_NOT_ALLOWED |\r\n| 13 | INSUFFICIENT_FUNDS |\r\n| 14 | SMS_SERVICE_FORBIDDEN |\r\n| 15 | LIMIT_EXCEEDED |\r\n| 16 | UNSUBSCRIBE |\r\n| 17 | CONTROL_GROUP |\r\n| 18 | CAPPING_LIMIT_EXCEEDED |\r\n| 19 | MMS_SEND |\r\n| 20 | MMS_ERROR |\r\n| 21 | MMS_BAD_NUMBER |\r\n| 22 | MMS_MESSAGE_TOO_LONG |\r\n| 23 | MMS_MESSAGE_INCORRECT |\r\n| 24 | MMS_WAITING |\r\n| 25 | MMS_MESSAGE_TOO_SHORT |\r\n| 26 | MMS_UNKNOWN_ERROR |\r\n| 27 | MMS_CANCELED |\r\n\r\n\r\n#### Push campaign webhooks\r\n\r\n| Field | Type | Example |\r\n|----------------------|-----------------|--------------------------------------|\r\n| id | string | 345dfsg2-dfws-w451-1245-sdfgsdf23441 |\r\n| contact | object | |\r\n| contact[externalId] | string | 78b556af-c01b-4341-8059-f5ce08f5ad14 |\r\n| contact[email] | string | test@domain.com |\r\n| contact[phoneNumber] | string | +48111222333 |\r\n| campaign | object | |\r\n| campaign[externalId] | string | DFG2345T-3456-6734-6345-FHDF65341235 |\r\n| status | object | |\r\n| status[id] | int | 4 |\r\n| status[desc] | string | CLICKED |\r\n| status[time] | string | 2023-08-08T11:15:53.053 |\r\n| details | object | |\r\n| details[id] | int nullable | 1 |\r\n| details[desc] | string nullable | NOTIFICATION_CLICK_ACTION |\r\n| details[actionId] | int nullable | 3 |\r\n| details[actionDesc] | string nullable | ACCEPT |\r\n| platform | object | |\r\n| platform[id] | int | 1 |\r\n| platform[desc] | string | ANDROID |\r\n| platform[appId] | int | 50 |\r\n\r\n\r\nExample:\r\n```\r\n{\r\n \"id\": \"345dfsg2-dfws-w451-1245-sdfgsdf23441\",\r\n \"contact\": {\r\n \"externalId\": \"78b556af-c01b-4341-8059-f5ce08f5ad14\",\r\n \"email\": \"test@domain.com\",\r\n \"phoneNumber\": \"+48111222333\"\r\n },\r\n \"campaign\": {\r\n \"externalId\": \"DFG2345T-3456-6734-6345-FHDF65341235\"\r\n },\r\n \"status\": {\r\n \"id\": 4,\r\n \"desc\": \"CLICKED\",\r\n \"time\": \"2023-08-07T17:26:07\"\r\n },\r\n \"details\": {\r\n \"id\": 1,\r\n \"desc\": \"NOTIFICATION_CLICK_ACTION\",\r\n \"actionId\": 3,\r\n \"actionDesc\": \"ACCEPT\"\r\n },\r\n \"platform\": {\r\n \"id\": 1,\r\n \"desc\": \"ANDROID\",\r\n \"appId\": 50\r\n }\r\n}\r\n```\r\n\r\nValues for field `status`:\r\n\r\n| id | desc |\r\n|----|-----------|\r\n| 0 | SENT |\r\n| 1 | DELIVERED |\r\n| 2 | FAILED |\r\n| 3 | RECEIVED |\r\n| 4 | CLICKED |\r\n\r\nValues for field `platform`:\r\n\r\n| id | desc |\r\n|----|---------|\r\n| 1 | ANDROID |\r\n| 2 | IOS |\r\n| 99 | OTHER |\r\n\r\nValues for field `action`:\r\n\r\n| id | desc |\r\n|----|-------------|\r\n| 1 | YES |\r\n| 2 | NO |\r\n| 3 | ACCEPT |\r\n| 4 | DECLINE |\r\n| 5 | BUY_NOW |\r\n| 6 | LATER |\r\n| 7 | ADD_TO_CART |\r\n| 8 | NO_THANKS |\r\n| 9 | OPEN |\r\n| 10 | CLOSE |\r\n| 11 | LOGIN |\r\n| 12 | SHARE |\r\n| 13 | SEE_MORE |\r\n\r\nValues for field `details`:\r\n\r\n| id | desc |\r\n|----|---------------------------------|\r\n| 1 | NOTIFICATION_CLICK_ACTION |\r\n| 2 | NOTIFICATION_SWIPE_ACTION |\r\n| 3 | DIALOG_DISMISS_ACTION |\r\n| 4 | BAD_TOPIC |\r\n| 5 | METHOD_NOT_ALLOWED |\r\n| 6 | TIMEOUT |\r\n| 7 | ALREADY_SENT |\r\n| 8 | BAD_COLLAPSE_ID |\r\n| 9 | DUPLICATE_HEADERS |\r\n| 10 | INTERNAL_SERVER_ERROR |\r\n| 11 | INVALID_PROVIDER_TOKEN |\r\n| 12 | DEVICE_TOKEN_NOT_FOR_TOPIC |\r\n| 13 | UNKNOWN_ERROR |\r\n| 14 | BAD_CERTIFICATE_ENVIRONMENT |\r\n| 15 | INVALID_APNS_CREDENTIAL |\r\n| 16 | SHUTDOWN |\r\n| 17 | INVALID_PARAMETERS |\r\n| 18 | TOO_MANY_PROVIDER_TOKEN_UPDATES |\r\n| 19 | BAD_MESSAGE_ID |\r\n| 29 | NOT_REGISTERED |\r\n| 21 | BAD_EXPIRATION_DATE |\r\n| 22 | TOPIC_DISALLOWED |\r\n| 23 | PAYLOAD_TOO_LARGE |\r\n| 24 | FORBIDDEN |\r\n| 25 | BAD_PATH |\r\n| 26 | INVALID_REGISTRATION |\r\n| 27 | MESSAGE_TOO_BIG |\r\n| 28 | DEVICE_MESSAGE_RATE_EXCEEDED |\r\n| 29 | INVALID_TTL |\r\n| 30 | BAD_CERTIFICATE |\r\n| 31 | TOO_MANY_REQUESTS |\r\n| 32 | IDLE_TIMEOUT |\r\n| 33 | EXPIRED_PROVIDER_TOKEN |\r\n| 34 | INVALID_PACKAGE_NAME |\r\n| 35 | MISSING_PROVIDER_TOKEN |\r\n| 36 | PAYLOAD_EMPTY |\r\n| 37 | BAD_PRIORITY |\r\n| 38 | BAD_DEVICE_TOKEN |\r\n| 39 | MISSING_TOPIC |\r\n| 40 | MISSING_REGISTRATION |\r\n| 41 | SERVICE_UNAVAILABLE |\r\n| 42 | TOPICS_MESSAGE_RATE_EXCEEDED |\r\n| 43 | UNREGISTERED |\r\n| 44 | MISSING_DEVICE_TOKEN |\r\n| 45 | MISMATCH_SENDER_ID |\r\n| 46 | UNAVAILABLE |\r\n| 47 | INVALID_DATA_KEY |\r\n\r\n## Step 4: Test your webhook\r\nOnly after a successful test result can your webhook configuration be saved. Make sure your endpoint returns `Status: 200` and `Message: ok`.\r\n\r\n## Step 5: Save your webhook configuration\r\n*Voilà!* You have configured your webhook integration.\r\n\r\n# External resources\r\n\r\n[Converting OAS specification file RAML, API Blueprint...](https://github.com/LucyBot-Inc/api-spec-converter)\r\n\r\n[Generating clients from OAS file](https://swagger.io/tools/swagger-codegen/)\r\n\r\n[Other tool for client generation](https://openapi-generator.tech/)\r\n\r\n# Current Version\r\n\r\nThis API is using semantic versioning. Current API version is 2.0.0.\r\n\r\nLooking for older one?\r\n\r\n [Click here for v1](/docs/v1/) [Click here for v2](/docs/v2/) [Click here for v2.1](/docs/v2.1/) [Click here for fm_v2.1](/docs/fm_v2.1/) \r\n\r\n# License\r\n\r\nVercom © 2021" }, { "parentId": "__WORKSPACE_ID__", "name": "Base environment", "data": { "base_url": "{{ scheme }}://{{ host }}{{ base_path }}" }, "_type": "environment", "_id": "__BASE_ENVIRONMENT_ID__" }, { "parentId": "__BASE_ENVIRONMENT_ID__", "name": "OpenAPI env", "data": { "scheme": "https", "base_path": "", "host": "api.redlink.pl", "authorization": "authorization", "applicationKey": "applicationKey" }, "_type": "environment", "_id": "env___BASE_ENVIRONMENT_ID___sub" }, { "parentId": "__WORKSPACE_ID__", "name": "Groups", "environment": {}, "_id": "fld___WORKSPACE_ID__ae9629f4", "_type": "request_group", "description": "This API mainly allows you to add, update, delete and list contacts but also you can unsubscribe and resubscribe contact or list segments." }, { "parentId": "__WORKSPACE_ID__", "name": "Contacts", "environment": {}, "_id": "fld___WORKSPACE_ID__b0dd615c", "_type": "request_group", "description": "Contacts methods allows you to manage contacts that are identified by an unique externalId. Using externalId you can add, update, delete contacts, create groups and more." }, { "parentId": "__WORKSPACE_ID__", "name": "Emails", "environment": {}, "_id": "fld___WORKSPACE_ID__47355839", "_type": "request_group", "description": "Email API mainly allows you to send emails to all over the world. You can also create or delete email templates, get clicks, opens and statuses on your emails and more.\n *\n * There are two ways to send emails using our API:\n * - transactional email API that allows you to send emails to a single or an array of email addresses\n * - email campaigns that allows you to send emails to created group through API or account panel" }, { "parentId": "__WORKSPACE_ID__", "name": "Sms", "environment": {}, "_id": "fld___WORKSPACE_ID__d10362d8", "_type": "request_group", "description": "Transactional SMS API allows you to send SMS to a single or an array of phone numbers." }, { "parentId": "__WORKSPACE_ID__", "name": "Blacklist", "environment": {}, "_id": "fld___WORKSPACE_ID__7b2dd04c", "_type": "request_group", "description": "Blacklist API basically allows you to manage email addresses and domains. You can add, update, delete or list receivers addresses or domains on your blacklist. Please be aware that this API can be used only in reference to transactional emails. " }, { "parentId": "__WORKSPACE_ID__", "name": "Campaigns", "environment": {}, "_id": "fld___WORKSPACE_ID__01a23a28", "_type": "request_group", "description": "Email campaigns API allows you to send emails / smses to a specific group created through Create group method or through the panel." }, { "parentId": "__WORKSPACE_ID__", "name": "Pushes", "environment": {}, "_id": "fld___WORKSPACE_ID__2fa464b1", "_type": "request_group", "description": "Push API allows you to send push notifications with images and buttons." }, { "parentId": "fld___WORKSPACE_ID__b0dd615c", "name": "List contacts", "url": "{{ base_url }}/v2.1/contact", "body": {}, "method": "GET", "parameters": [ { "name": "offset", "disabled": true, "value": "0" }, { "name": "limit", "disabled": true, "value": "100" }, { "name": "group", "disabled": true, "value": "0" }, { "name": "id", "disabled": true, "value": "0" }, { "name": "externalId", "disabled": true, "value": "string" }, { "name": "phoneNumber", "disabled": true, "value": "string" }, { "name": "email", "disabled": true, "value": "string" }, { "name": "inArchive", "disabled": true, "value": "null" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__b897417e" }, { "parentId": "fld___WORKSPACE_ID__b0dd615c", "name": "Update contact", "url": "{{ base_url }}/v2.1/contact", "body": { "mimeType": "application/json", "text": "null" }, "method": "PUT", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__3a203c40" }, { "parentId": "fld___WORKSPACE_ID__b0dd615c", "name": "Add contact", "url": "{{ base_url }}/v2.1/contact", "body": { "mimeType": "application/json", "text": "null" }, "method": "POST", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__4cb62a88" }, { "parentId": "fld___WORKSPACE_ID__b0dd615c", "name": "Delete contact", "url": "{{ base_url }}/v2.1/contact", "body": { "mimeType": "application/json", "text": "{\n \"id\": [\n 1\n ]\n}" }, "method": "DELETE", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__17100239" }, { "parentId": "fld___WORKSPACE_ID__b0dd615c", "name": "Resubscribe contact", "url": "{{ base_url }}/v2.1/contact/resubscribe/{{ channel }}", "body": { "mimeType": "application/json", "text": "{\n \"id\": [\n 1\n ]\n}" }, "method": "POST", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__482d77bf" }, { "parentId": "fld___WORKSPACE_ID__b0dd615c", "name": "Unsubscribe contact", "url": "{{ base_url }}/v2.1/contact/unsubscribe/{{ channel }}", "body": { "mimeType": "application/json", "text": "{\n \"id\": [\n 1\n ]\n}" }, "method": "POST", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__2f9f969c" }, { "parentId": "fld___WORKSPACE_ID__d10362d8", "name": "Get statuses of SMS", "url": "{{ base_url }}/v2.1/sms/statuses", "body": {}, "method": "GET", "parameters": [ { "name": "offset", "disabled": true, "value": "0" }, { "name": "limit", "disabled": true, "value": "100" }, { "name": "dateTo", "disabled": true, "value": "YYYY-MM-DD hh:mm:ii" }, { "name": "dateFrom", "disabled": true, "value": "YYYY-MM-DD hh:mm:ii" }, { "name": "sender", "disabled": true, "value": "Sender1,Sender2,Sender3" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__55e21aa7" }, { "parentId": "fld___WORKSPACE_ID__01a23a28", "name": "Send email campaign", "url": "{{ base_url }}/v2.1/campaign/mail", "body": { "mimeType": "application/json", "text": "{\n \"campaignId\": \"first-campaign-id\",\n \"name\": \"firstCampaign\",\n \"description\": \"My first campaign\",\n \"subject\": \"Hello world\",\n \"fromName\": \"John Doe\",\n \"fromAddress\": \"john.doe@example.pl\",\n \"replyTo\": \"john.doe@example.pl\",\n \"htmlFromWebSiteUrl\": \"string\",\n \"htmlContent\": \"

hello there

\",\n \"textContent\": \"hello there!\",\n \"groupId\": \"test-group-id\",\n \"trackLinks\": true,\n \"googleAnalytics\": true,\n \"scheduleTime\": \"2020-09-10 10:15:00\",\n \"state\": \"editable\",\n \"testAddresses\": [\n \"john.doe@example.pl\"\n ],\n \"confirmationAddresses\": [\n \"john.doe@example.pl\"\n ]\n}" }, "method": "POST", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__64960d57" }, { "parentId": "fld___WORKSPACE_ID__01a23a28", "name": "Get email campaign clicks", "url": "{{ base_url }}/v2.1/campaign/email/{{ campaignId }}/report/click", "body": {}, "method": "GET", "parameters": [ { "name": "limit", "disabled": true, "value": "100" }, { "name": "offset", "disabled": true, "value": "0" }, { "name": "dateFrom", "disabled": false, "value": "YYYY-MM-DD hh:mm:ii" }, { "name": "dateTo", "disabled": false, "value": "YYYY-MM-DD hh:mm:ii" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__47e37d38" }, { "parentId": "fld___WORKSPACE_ID__01a23a28", "name": "List email campaigns", "url": "{{ base_url }}/v2.1/campaign/email", "body": {}, "method": "GET", "parameters": [ { "name": "limit", "disabled": true, "value": "100" }, { "name": "offset", "disabled": true, "value": "0" }, { "name": "dateFrom", "disabled": false, "value": "YYYY-MM-DD hh:mm:ii" }, { "name": "dateTo", "disabled": false, "value": "YYYY-MM-DD hh:mm:ii" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__f1d5ac03" }, { "parentId": "fld___WORKSPACE_ID__01a23a28", "name": "Get email campaign opens", "url": "{{ base_url }}/v2.1/campaign/email/{{ campaignId }}/report/open", "body": {}, "method": "GET", "parameters": [ { "name": "limit", "disabled": true, "value": "100" }, { "name": "offset", "disabled": true, "value": "0" }, { "name": "dateFrom", "disabled": false, "value": "YYYY-MM-DD hh:mm:ii" }, { "name": "dateTo", "disabled": false, "value": "YYYY-MM-DD hh:mm:ii" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__444f8b01" }, { "parentId": "fld___WORKSPACE_ID__01a23a28", "name": "List email campaign recipients", "url": "{{ base_url }}/v2.1/campaign/email/report/recipient", "body": {}, "method": "GET", "parameters": [ { "name": "campaignId", "disabled": true, "value": "string" }, { "name": "bouncesOnly", "disabled": true, "value": "null" }, { "name": "dateTo", "disabled": true, "value": "YYYY-MM-DD hh:mm:ii" }, { "name": "dateFrom", "disabled": true, "value": "YYYY-MM-DD hh:mm:ii" }, { "name": "limit", "disabled": true, "value": "100" }, { "name": "offset", "disabled": true, "value": "0" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__1da5245a" }, { "parentId": "fld___WORKSPACE_ID__01a23a28", "name": "Get email campaign unsubscribe report", "url": "{{ base_url }}/v2.1/campaign/email/{{ campaignId }}/report/unsubscribe", "body": {}, "method": "GET", "parameters": [ { "name": "limit", "disabled": true, "value": "100" }, { "name": "offset", "disabled": true, "value": "0" }, { "name": "dateFrom", "disabled": false, "value": "YYYY-MM-DD hh:mm:ii" }, { "name": "dateTo", "disabled": false, "value": "YYYY-MM-DD hh:mm:ii" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__cb975a6f" }, { "parentId": "fld___WORKSPACE_ID__01a23a28", "name": "List push campaigns", "url": "{{ base_url }}/v2.1/campaign/push", "body": {}, "method": "GET", "parameters": [ { "name": "limit", "disabled": true, "value": "100" }, { "name": "offset", "disabled": true, "value": "0" }, { "name": "dateFrom", "disabled": false, "value": "YYYY-MM-DD hh:mm:ii" }, { "name": "dateTo", "disabled": false, "value": "YYYY-MM-DD hh:mm:ii" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__3e93906f" }, { "parentId": "fld___WORKSPACE_ID__01a23a28", "name": "List push campaign recipients", "url": "{{ base_url }}/v2.1/campaign/push/{{ externalId }}/report/recipient", "body": {}, "method": "GET", "parameters": [ { "name": "externalId", "disabled": true, "value": "string" }, { "name": "limit", "disabled": true, "value": "100" }, { "name": "offset", "disabled": true, "value": "0" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__65245939" }, { "parentId": "fld___WORKSPACE_ID__01a23a28", "name": "Change email campaign state", "url": "{{ base_url }}/v2.1/campaign/mail/{{ campaignId }}", "body": { "mimeType": "application/json", "text": "{\n \"state\": null,\n \"scheduleTime\": \"2020-09-10 10:15:00\",\n \"testAddresses\": [\n \"john.doe@example.pl\"\n ]\n}" }, "method": "PATCH", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__7768f464" }, { "parentId": "fld___WORKSPACE_ID__01a23a28", "name": "Get single email campaign", "url": "{{ base_url }}/v2.1/campaign/email/{{ campaignId }}", "body": {}, "method": "GET", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__0da3036b" }, { "parentId": "fld___WORKSPACE_ID__01a23a28", "name": "Get single SMS campaign", "url": "{{ base_url }}/v2.1/campaign/sms/{{ campaignId }}", "body": {}, "method": "GET", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__30bbedee" }, { "parentId": "fld___WORKSPACE_ID__01a23a28", "name": "Get sms campaign clicks", "url": "{{ base_url }}/v2.1/campaign/sms/{{ campaignId }}/report/click", "body": {}, "method": "GET", "parameters": [ { "name": "limit", "disabled": true, "value": "100" }, { "name": "offset", "disabled": true, "value": "0" }, { "name": "dateFrom", "disabled": false, "value": "YYYY-MM-DD hh:mm:ii" }, { "name": "dateTo", "disabled": false, "value": "YYYY-MM-DD hh:mm:ii" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__ac976b4c" }, { "parentId": "fld___WORKSPACE_ID__01a23a28", "name": "List sms campaigns", "url": "{{ base_url }}/v2.1/campaign/sms", "body": {}, "method": "GET", "parameters": [ { "name": "limit", "disabled": true, "value": "100" }, { "name": "offset", "disabled": true, "value": "0" }, { "name": "dateFrom", "disabled": false, "value": "YYYY-MM-DD hh:mm:ii" }, { "name": "dateTo", "disabled": false, "value": "YYYY-MM-DD hh:mm:ii" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__1232afc8" }, { "parentId": "fld___WORKSPACE_ID__01a23a28", "name": "List sms campaign recipients", "url": "{{ base_url }}/v2.1/campaign/sms/{{ campaignId }}/report/recipient", "body": {}, "method": "GET", "parameters": [ { "name": "limit", "disabled": true, "value": "100" }, { "name": "offset", "disabled": true, "value": "0" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__a58a4433" }, { "parentId": "fld___WORKSPACE_ID__01a23a28", "name": "Get sms campaign state", "url": "{{ base_url }}/v2.1/campaign/sms/{{ campaignId }}/report/state", "body": {}, "method": "GET", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__0933ce5d" }, { "parentId": "fld___WORKSPACE_ID__2fa464b1", "name": "Send push", "url": "{{ base_url }}/v2.1/push", "body": { "mimeType": "application/json", "text": "{\n \"applications\": [\n \"XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\"\n ],\n \"to\": [\n {\n \"receiver\": \"example-device-id\",\n \"externalId\": \"xxx-xxx-xxx-xxx\",\n \"type\": 1\n }\n ],\n \"title\": {\n \"pl\": \"test\",\n \"en\": \"test\"\n },\n \"body\": {\n \"pl\": \"test\",\n \"en\": \"test\"\n },\n \"defaultLanguage\": \"pl\",\n \"image\": \"http://absolute.url/to/image\",\n \"silent\": true,\n \"sound\": \"sound-file.wav\",\n \"scheduleTime\": \"2020-01-01 12:12:12\",\n \"ttl\": 1540377351,\n \"externalData\": {\n \"test\": \"x\",\n \"test1\": false\n },\n \"advanced\": {\n \"subtitle\": \"subtitle-only-ios\",\n \"lockscreenVisibility\": 1,\n \"icon\": {\n \"small\": \"/relative-icon-file-path\",\n \"large\": \"/relative-icon-file-path\"\n }\n },\n \"action\": {\n \"url\": \"http://absolute.url/to/redirect/on/click\",\n \"type\": 2\n },\n \"actionButtons\": [\n {\n \"button\": 1,\n \"icon\": \"my_icon.png\",\n \"action\": {\n \"url\": \"www.google.pl\",\n \"type\": 0\n }\n }\n ]\n}" }, "method": "POST", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__de77901b" }, { "parentId": "fld___WORKSPACE_ID__b0dd615c", "name": "List groups for contact", "url": "{{ base_url }}/v2.1/contact/{{ id }}/group", "body": {}, "method": "GET", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__822a6da9" }, { "parentId": "fld___WORKSPACE_ID__b0dd615c", "name": "Add group to contact", "url": "{{ base_url }}/v2.1/contact/{{ id }}/group", "body": { "mimeType": "application/json", "text": "{\n \"id\": [\n 1\n ]\n}" }, "method": "POST", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__caa65eb8" }, { "parentId": "fld___WORKSPACE_ID__b0dd615c", "name": "Delete groups from contact", "url": "{{ base_url }}/v2.1/contact/{{ id }}/group", "body": { "mimeType": "application/json", "text": "{\n \"id\": [\n 1\n ]\n}" }, "method": "DELETE", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__bee5d9c3" }, { "parentId": "fld___WORKSPACE_ID__b0dd615c", "name": "List contact's additional fields", "url": "{{ base_url }}/v2.1/contact/field", "body": {}, "method": "GET", "parameters": [ { "name": "offset", "disabled": true, "value": "0" }, { "name": "limit", "disabled": true, "value": "100" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__41fd90b1" }, { "parentId": "fld___WORKSPACE_ID__b0dd615c", "name": "List segments", "url": "{{ base_url }}/v2.1/contact/segment", "body": {}, "method": "GET", "parameters": [ { "name": "offset", "disabled": true, "value": "0" }, { "name": "limit", "disabled": true, "value": "100" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__2db95b68" }, { "parentId": "fld___WORKSPACE_ID__b0dd615c", "name": "Get single segment", "url": "{{ base_url }}/v2.1/contact/segment/{{ id }}", "body": {}, "method": "GET", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__43cc5b6f" }, { "parentId": "fld___WORKSPACE_ID__47355839", "name": "Get template list", "url": "{{ base_url }}/v2.1/email/template", "body": {}, "method": "GET", "parameters": [ { "name": "offset", "disabled": true, "value": "0" }, { "name": "limit", "disabled": true, "value": "100" }, { "name": "smtpAccount", "disabled": true, "value": "string" }, { "name": "externalId", "disabled": true, "value": "string" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__a174a751" }, { "parentId": "fld___WORKSPACE_ID__47355839", "name": "Add template", "url": "{{ base_url }}/v2.1/email/template", "body": { "mimeType": "application/json", "text": "{\n \"html\": \"string\",\n \"text\": \"string\",\n \"name\": \"string\",\n \"externalId\": \"string\",\n \"smtpAccount\": \"string\"\n}" }, "method": "POST", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__d3937592" }, { "parentId": "fld___WORKSPACE_ID__47355839", "name": "Delete template", "url": "{{ base_url }}/v2.1/email/template", "body": { "mimeType": "application/json", "text": "{\n \"externalId\": [\n \"XXX-XXX\"\n ]\n}" }, "method": "DELETE", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__39abc409" }, { "parentId": "fld___WORKSPACE_ID__47355839", "name": "Get statistics", "url": "{{ base_url }}/v2.1/email/aggregate", "body": {}, "method": "GET", "parameters": [ { "name": "smtpAccount", "disabled": false, "value": "string" }, { "name": "dateFrom", "disabled": false, "value": "string" }, { "name": "dateTo", "disabled": true, "value": "string" }, { "name": "withTags", "disabled": true, "value": "0" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__cf7e60d9" }, { "parentId": "fld___WORKSPACE_ID__7b2dd04c", "name": "Get blacklist domains", "url": "{{ base_url }}/v2.1/email/domain/blacklist/{{ smtp }}", "body": {}, "method": "GET", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__1b426efa" }, { "parentId": "fld___WORKSPACE_ID__7b2dd04c", "name": "Add domains to blacklist", "url": "{{ base_url }}/v2.1/email/domain/blacklist/{{ smtp }}", "body": { "mimeType": "application/json", "text": "{\n \"domain\": null\n}" }, "method": "POST", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__859ad15d" }, { "parentId": "fld___WORKSPACE_ID__7b2dd04c", "name": "Delete domains from blacklist", "url": "{{ base_url }}/v2.1/email/domain/blacklist/{{ smtp }}", "body": { "mimeType": "application/json", "text": "{\n \"id\": [\n \"domain.com\"\n ]\n}" }, "method": "DELETE", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__274fbef3" }, { "parentId": "fld___WORKSPACE_ID__7b2dd04c", "name": "Get blacklisted email addresses", "url": "{{ base_url }}/v2.1/email/blacklist", "body": {}, "method": "GET", "parameters": [ { "name": "offset", "disabled": true, "value": "0" }, { "name": "limit", "disabled": true, "value": "100" }, { "name": "smtpAccount", "disabled": true, "value": "string" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__f2532fb5" }, { "parentId": "fld___WORKSPACE_ID__7b2dd04c", "name": "Add emails to blacklist", "url": "{{ base_url }}/v2.1/email/blacklist", "body": {}, "method": "POST", "parameters": [ { "name": "email", "disabled": false, "value": "string" }, { "name": "smtpAccount", "disabled": false, "value": "string" }, { "name": "reason", "disabled": false, "value": "string" }, { "name": "comment", "disabled": true, "value": "string" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__c0a07b11" }, { "parentId": "fld___WORKSPACE_ID__7b2dd04c", "name": "Delete email addresses from blacklist", "url": "{{ base_url }}/v2.1/email/blacklist/{{ smtp }}", "body": { "mimeType": "application/json", "text": "{\n \"id\": [\n \"mail@mail.com\"\n ]\n}" }, "method": "DELETE", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__cea63848" }, { "parentId": "fld___WORKSPACE_ID__7b2dd04c", "name": "List blacklist reasons", "url": "{{ base_url }}/v2.1/email/blacklist/reason", "body": {}, "method": "OPTIONS", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__f9c2f925" }, { "parentId": "fld___WORKSPACE_ID__47355839", "name": "Get email clicks", "url": "{{ base_url }}/v2.1/email/click", "body": {}, "method": "GET", "parameters": [ { "name": "offset", "disabled": true, "value": "0" }, { "name": "limit", "disabled": true, "value": "100" }, { "name": "dateTo", "disabled": true, "value": "YYYY-MM-DD hh:mm:ii" }, { "name": "dateFrom", "disabled": true, "value": "YYYY-MM-DD hh:mm:ii" }, { "name": "smtpAccount", "disabled": true, "value": "string" }, { "name": "messageId", "disabled": true, "value": "string" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__fe0b45ac" }, { "parentId": "fld___WORKSPACE_ID__47355839", "name": "Get email statuses", "url": "{{ base_url }}/v2.1/email", "body": {}, "method": "GET", "parameters": [ { "name": "offset", "disabled": true, "value": "0" }, { "name": "limit", "disabled": true, "value": "100" }, { "name": "smtpAccount", "disabled": true, "value": "string" }, { "name": "messageId", "disabled": true, "value": "string" }, { "name": "to", "disabled": true, "value": "string" }, { "name": "dateFrom", "disabled": true, "value": "string" }, { "name": "dateTo", "disabled": true, "value": "string" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__07472de9" }, { "parentId": "fld___WORKSPACE_ID__47355839", "name": "Send emails", "url": "{{ base_url }}/v2.1/email", "body": { "mimeType": "application/json", "text": "{\n \"subject\": \"Test email subject\",\n \"smtpAccount\": \"1.test.smtp\",\n \"tags\": [\n \"test-tag\"\n ],\n \"content\": {\n \"html\": \"

Hello world

\",\n \"text\": \"Hello world\",\n \"templateId\": \"as2sCwq\"\n },\n \"bcc\": [\n {\n \"email\": \"string\",\n \"name\": \"string\"\n }\n ],\n \"cc\": [\n {\n \"email\": \"string\",\n \"name\": \"string\"\n }\n ],\n \"from\": {\n \"email\": \"string\",\n \"name\": \"string\"\n },\n \"replyTo\": {\n \"email\": \"string\",\n \"name\": \"string\"\n },\n \"headers\": {\n \"X-TEST-HEADER\": \"val\"\n },\n \"globalVars\": {\n \"sex\": \"unknown\",\n \"hasNewsletter\": false,\n \"promos\": {\n \"1\": {\n \"name\": \"test40\",\n \"value\": 300\n },\n \"2\": {\n \"name\": \"test800\",\n \"value\": 3008\n }\n },\n \"footer\": \"
crazy footer
\"\n },\n \"to\": [\n {\n \"email\": \"test@domena.pl\",\n \"name\": \"Test sender\",\n \"messageId\": \"test0001@domena.pl\",\n \"vars\": {\n \"hasNewsletter\": true,\n \"products\": {\n \"1\": {\n \"name\": \"skirt\",\n \"id\": 1,\n \"color\": \"green\"\n },\n \"2\": {\n \"name\": \"hoodie\",\n \"id\": 6,\n \"color\": \"red\",\n \"options\": [\n \"pocket\",\n \"print\",\n \"glitter\"\n ]\n },\n \"3\": {\n \"name\": \"dress\",\n \"id\": \"100\",\n \"color\": \"blue\"\n }\n }\n }\n }\n ],\n \"attachments\": [\n {\n \"fileName\": \"report.txt\",\n \"fileMime\": \"text/plain\",\n \"fileContent\": \"c29tZSBmaWxlIGNvbnRlbnQ=\",\n \"inline\": \"true\"\n }\n ]\n}" }, "method": "POST", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__f78977dc" }, { "parentId": "fld___WORKSPACE_ID__47355839", "name": "Get email opens", "url": "{{ base_url }}/v2.1/email/open", "body": {}, "method": "GET", "parameters": [ { "name": "offset", "disabled": true, "value": "0" }, { "name": "limit", "disabled": true, "value": "100" }, { "name": "dateTo", "disabled": true, "value": "YYYY-MM-DD hh:mm:ii" }, { "name": "dateFrom", "disabled": true, "value": "YYYY-MM-DD hh:mm:ii" }, { "name": "smtpAccount", "disabled": true, "value": "string" }, { "name": "messageId", "disabled": true, "value": "string" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__9e9927a8" }, { "parentId": "fld___WORKSPACE_ID__47355839", "name": "Get smtp account list", "url": "{{ base_url }}/v2.1/email/smtpAccount", "body": {}, "method": "OPTIONS", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__605ac224" }, { "parentId": "fld___WORKSPACE_ID__ae9629f4", "name": "List contacts in group", "url": "{{ base_url }}/v2.1/group/{{ groupId }}/contact", "body": {}, "method": "GET", "parameters": [ { "name": "offset", "disabled": true, "value": "0" }, { "name": "limit", "disabled": true, "value": "100" }, { "name": "orderBy", "disabled": true, "value": "id" }, { "name": "orderDirection", "disabled": true, "value": "DESC" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__76a85b0b" }, { "parentId": "fld___WORKSPACE_ID__ae9629f4", "name": "Add contacts to group", "url": "{{ base_url }}/v2.1/group/{{ groupId }}/contact", "body": { "mimeType": "application/json", "text": "{\n \"id\": [\n 1\n ]\n}" }, "method": "POST", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__45545858" }, { "parentId": "fld___WORKSPACE_ID__ae9629f4", "name": "Delete contacts from group", "url": "{{ base_url }}/v2.1/group/{{ groupId }}/contact", "body": { "mimeType": "application/json", "text": "{\n \"id\": [\n 1\n ]\n}" }, "method": "DELETE", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__8448193f" }, { "parentId": "fld___WORKSPACE_ID__ae9629f4", "name": "List groups", "url": "{{ base_url }}/v2.1/group", "body": {}, "method": "GET", "parameters": [ { "name": "offset", "disabled": true, "value": "0" }, { "name": "limit", "disabled": true, "value": "100" }, { "name": "orderBy", "disabled": true, "value": "id" }, { "name": "orderDirection", "disabled": true, "value": "DESC" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__1df676dd" }, { "parentId": "fld___WORKSPACE_ID__ae9629f4", "name": "Update group", "url": "{{ base_url }}/v2.1/group", "body": { "mimeType": "application/json", "text": "[\n {\n \"id\": 1234,\n \"name\": \"test\",\n \"description\": \"Test descr\"\n }\n]" }, "method": "PUT", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__ac11a532" }, { "parentId": "fld___WORKSPACE_ID__ae9629f4", "name": "Create group", "url": "{{ base_url }}/v2.1/group", "body": { "mimeType": "application/json", "text": "[\n {\n \"name\": \"test\",\n \"description\": \"Test descr\",\n \"externalId\": \"XXXXX-XXXX-XXXX\"\n }\n]" }, "method": "POST", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__e54fab6d" }, { "parentId": "fld___WORKSPACE_ID__ae9629f4", "name": "Delete group", "url": "{{ base_url }}/v2.1/group", "body": { "mimeType": "application/json", "text": "{\n \"id\": [\n 1\n ]\n}" }, "method": "DELETE", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__4b1f7571" }, { "parentId": "fld___WORKSPACE_ID__ae9629f4", "name": "Count number of contacts in group", "url": "{{ base_url }}/v2.1/group/{{ groupId }}/count", "body": {}, "method": "GET", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__17bc772e" }, { "parentId": "fld___WORKSPACE_ID__2fa464b1", "name": "Add event", "url": "{{ base_url }}/v2.1/event", "body": { "mimeType": "application/json", "text": "null" }, "method": "POST", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__fa4d5b16" }, { "parentId": "fld___WORKSPACE_ID__d10362d8", "name": "Get list of sender IDs", "url": "{{ base_url }}/v2.1/sms/senders", "body": {}, "method": "OPTIONS", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__6a3b4768" }, { "parentId": "fld___WORKSPACE_ID__d10362d8", "name": "Get list of SMS", "url": "{{ base_url }}/v2.1/sms/{{ externalId }}", "body": {}, "method": "GET", "parameters": [ { "name": "offset", "disabled": true, "value": "0" }, { "name": "limit", "disabled": true, "value": "100" }, { "name": "sender", "disabled": true, "value": "string" }, { "name": "phoneNumber", "disabled": true, "value": "+01230123123" }, { "name": "status", "disabled": true, "value": "0" }, { "name": "orderBy", "disabled": true, "value": "string" }, { "name": "orderDirection", "disabled": true, "value": "string" }, { "name": "dateTo", "disabled": true, "value": "YYYY-MM-DD hh:mm:ii" }, { "name": "dateFrom", "disabled": true, "value": "YYYY-MM-DD hh:mm:ii" } ], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__a3ec459f" }, { "parentId": "fld___WORKSPACE_ID__d10362d8", "name": "Hlr", "url": "{{ base_url }}/v2.1/sms/hlr", "body": { "mimeType": "application/json", "text": "{\n \"phone\": \"+48111222333\"\n}" }, "method": "POST", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__33b26fbd" }, { "parentId": "fld___WORKSPACE_ID__d10362d8", "name": "Send SMS", "url": "{{ base_url }}/v2.1/sms", "body": { "mimeType": "application/json", "text": "{\n \"sender\": \"string\",\n \"message\": \"Hello world!\",\n \"phoneNumbers\": [\n \"+48111222333\",\n \"+48111222444\"\n ],\n \"validity\": 0,\n \"scheduleTime\": 0,\n \"type\": 0,\n \"shortLink\": true,\n \"webhookUrl\": \"string\",\n \"externalId\": \"xxxx-xxxx-xxxx\"\n}" }, "method": "POST", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__9513901c" }, { "parentId": "__WORKSPACE_ID__", "name": "Triggering scenario", "url": "{{ base_url }}/v2.1/scenario/trigger", "body": { "mimeType": "application/json", "text": "null" }, "method": "POST", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__bc09ff66" }, { "parentId": "__WORKSPACE_ID__", "name": "Get status", "url": "{{ base_url }}/v2.1/service/status", "body": {}, "method": "GET", "parameters": [], "headers": [ { "name": "Authorization", "disabled": false, "value": "{{ authorization }}" } ], "authentication": {}, "_type": "request", "_id": "req___WORKSPACE_ID__eaecb818" } ] }