{"info":{"_postman_id":"d2a70e7a-fb5d-4208-be75-34e7cc3364a5","name":"Blinkage API","description":"<html><head></head><body><p>use this API endpoint to send SMS messages</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"13226507","collectionId":"d2a70e7a-fb5d-4208-be75-34e7cc3364a5","publishedId":"2s7Z13iND4","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"284FD0","highlight":"e83e8c"},"publishDate":"2023-04-03T07:34:00.000Z"},"item":[{"name":"Send SMS","item":[{"name":"send-sms","id":"6024ce50-05a9-48a0-aa20-a9c3de1541f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"password","value":"123456789a","type":"text","description":"<p>your blinkage password</p>\n"},{"key":"user_id","value":"XXXXXXXXXXXXXXXX","type":"text","description":"<p>User id. you can retrieve it from the website.</p>\n"},{"key":"message","value":"Hi {firstName}, transaction number: {transactionNumber} is success, please visit our website for more information.","type":"text","description":"<p>text message, you can insert categories with this format \"{category_name}\" </p>\n"},{"key":"recipients","value":"[{\"phone_number\": \"+972540000000\",\"firstName\": \"Avi\", \"transactionNumber\":\"123456789\"},{\"phone_number\": \"+972500000000\", \"firsName\": \"David\"\"transactionNumber\":\"123456788\"},{\"phone_number\": \"+972520000000\", \"firsName\": \"David\"\"transactionNumber\":\"123456787\"}]","type":"text","description":"<p>array of objects, etch object must contain \"phone_number\", with the option to insert recipient categories</p>\n"},{"key":"sender_id","value":"Blinkage","type":"text","description":"<p>sender id, will be displayed in the sms title, 11 chars maximum - for phone number sender you must verify the number first</p>\n"},{"key":"delivery_delay","value":"0","type":"text","description":"<p>delivery delay in minutes</p>\n"},{"key":"unique_id","value":"50005d0dfffxc","type":"text","description":"<p>transaction unique id, you can use it to identify this transation</p>\n"},{"key":"channel","value":"sms","type":"text","description":"<p>use \"sms\" to send sms messages</p>\n"},{"key":"webhook_url","value":"https://yoursite.com/webhook","description":"<p>optional - your custome endpoint url to get webhook updates of your transactions you can find the transaction by the unique_id - maximum 255 chars length  </p>\n","type":"text"},{"key":"is_short_link","value":"true","description":"<p>optional - will replace all the links you have in the message to short link</p>\n","type":"text"}]},"url":"https://www.blinkage.com/send-sms/api","urlObject":{"protocol":"https","path":["send-sms","api"],"host":["www","blinkage","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6024ce50-05a9-48a0-aa20-a9c3de1541f0"},{"name":"search by phone","id":"f0cda4c4-bdb7-40fc-bd82-fe686959f4bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"user_id","value":"XXXXXXXXXXXXXXXXXX","type":"text","description":"<p>Your Blinkage user id </p>\n"},{"key":"password","value":"123456789a","type":"text","description":"<p>Your Blinkage password</p>\n"},{"key":"phone","value":"+10000000","description":"<p>Phone number you wish to search</p>\n","type":"text"}]},"url":"https://www.blinkage.com/management/api/get-tx-details","urlObject":{"protocol":"https","path":["management","api","get-tx-details"],"host":["www","blinkage","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f0cda4c4-bdb7-40fc-bd82-fe686959f4bb"},{"name":"webhook example","id":"5239f6f8-eb21-43d6-8571-f5c75c8d49a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"id\": \"0717481a-2d9d-47ab-b3f1-cab637r02ddc\", // Blinkage unique ID\r\n    \"createdAt\": \"2022-12-06 18:04:24.689\",\r\n    \"errorCode\": 0,\r\n    \"errorMessage\": \"OK\",\r\n    \"status\": \"DELIVERED\",\r\n    \"isSuccess\": true,\r\n    \"sentTime\": \"2022-12-06 18:04:24.989\",\r\n    \"channel\": \"SMS\",\r\n    \"webhookUrl\": \"https://your.web/webhook-url\",\r\n    \"uniqueId\": \"cdb798cf-d3b6-4a4a-ad6e-95644bfd8845\", // your unique id\r\n    \"recipients\": \"+972501234567\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://your.web/webhook-url","urlObject":{"protocol":"https","path":["webhook-url"],"host":["your","web"],"query":[],"variable":[]}},"response":[],"_postman_id":"5239f6f8-eb21-43d6-8571-f5c75c8d49a9"}],"id":"e8faf94c-f462-4c53-9a7a-ddc497ded6fc","_postman_id":"e8faf94c-f462-4c53-9a7a-ddc497ded6fc","description":""},{"name":"Black List","item":[{"name":"add-blacklist","id":"0b0b93f6-71bb-4052-ac71-f6c05daacf85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"user_id","value":"XXXXXXXXXXXXXXXXXX","type":"text","description":"<p>Your Blinkage user id </p>\n"},{"key":"password","value":"123456789a","type":"text","description":"<p>Your Blinkage password</p>\n"},{"key":"is_active","value":"true","type":"text","description":"<p>true - block active / false - bloack non-active</p>\n"},{"key":"phone","value":"+972547566154","type":"text","description":"<p>Phone number you wish to add / remove from black list</p>\n"}]},"url":"https://www.blinkage.com/black-list/api/add-blacklist","urlObject":{"protocol":"https","path":["black-list","api","add-blacklist"],"host":["www","blinkage","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0b0b93f6-71bb-4052-ac71-f6c05daacf85"},{"name":"get-blacklist","id":"6d5741ec-8324-47a2-aa1d-db153231bf09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"user_id","value":"XXXXXXXXXXXXXXXXXX","type":"text","description":"<p>Your Blinkage user id </p>\n"},{"key":"password","value":"123456789a","type":"text","description":"<p>Your Blinkage password</p>\n"}]},"url":"https://www.blinkage.com/black-list/api/get-blacklist","urlObject":{"protocol":"https","path":["black-list","api","get-blacklist"],"host":["www","blinkage","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6d5741ec-8324-47a2-aa1d-db153231bf09"},{"name":"add black-list","id":"42454628-31ad-4f4b-9fe1-12fe56271692","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.blinkage.com/black-list/block-phone/XXXXXXX/+972540000000","description":"<h2 id=\"in-order-to-add-phone-number-to-black-list-you-can-use-the-following-end-point\">In order to add phone number to black list you can use the following end-point:</h2>\n<p>StartFragment</p>\n<p><a href=\"https://BASE_URL/black-list/block-phone/**%7Byour-user-id%7D**/**%7Bphone-number-to-block%7D\">https://BASE_URL/black-list/block-phone/**{your-user-id}**/**{phone-number-to-block}</a>**</p>\n<p>EndFragment</p>\n","urlObject":{"protocol":"https","path":["black-list","block-phone","XXXXXXX","+972540000000"],"host":["www","blinkage","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"42454628-31ad-4f4b-9fe1-12fe56271692"}],"id":"80ebaaa4-1379-402c-8064-a8359a497ae5","_postman_id":"80ebaaa4-1379-402c-8064-a8359a497ae5","description":""},{"name":"Sender","item":[{"name":"send-otp","id":"7a45a5ce-4be2-4c82-b1ce-09f80c0ae7ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"user_id","value":"XXXXXXXXXXXXXXXXXX","type":"text","description":"<p>Your Blinkage user id </p>\n"},{"key":"password","value":"YOUR-PASSWORD","type":"text","description":"<p>Your Blinkage password</p>\n"},{"key":"phone","value":"+972547566154","type":"text","description":"<p>Phone number you wish to send otp to verify sender</p>\n"}]},"url":"https://www.blinkage.com/sender/host/api/send-otp","urlObject":{"protocol":"https","path":["sender","host","api","send-otp"],"host":["www","blinkage","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7a45a5ce-4be2-4c82-b1ce-09f80c0ae7ea"},{"name":"verify-otp","id":"37f88794-de4c-4c93-aafb-3cbe91e3a35d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"user_id","value":"XXXXXXXXXXXXXXXXXX","type":"text","description":"<p>Your Blinkage user id </p>\n"},{"key":"password","value":"YOUR-PASSWORD","type":"text","description":"<p>Your Blinkage password</p>\n"},{"key":"code","value":"123456","type":"text","description":"<p>6 digits code sender got in SMS</p>\n"},{"key":"phone","value":"+972547566154","type":"text","description":"<p>Phone number you wish to send otp to verify sender</p>\n"}]},"url":"https://www.blinkage.com/sender/host/api/verify-otp","urlObject":{"protocol":"https","path":["sender","host","api","verify-otp"],"host":["www","blinkage","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"37f88794-de4c-4c93-aafb-3cbe91e3a35d"}],"id":"c9624636-1486-45d1-99bb-750a57cd0db9","_postman_id":"c9624636-1486-45d1-99bb-750a57cd0db9","description":""},{"name":"User information","item":[{"name":"get-info","id":"6fbee336-6d27-41e7-81ae-d45d69423bc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"user_id","value":"XXXXXXXXXXXXXXXXXX","type":"text","description":"<p>Your Blinkage user id </p>\n"},{"key":"password","value":"123456789a","type":"text","description":"<p>Your Blinkage password</p>\n"}]},"url":"https://www.blinkage.com/auth/api/get-info","description":"<p>Use this api call to get Blinkage user information such as:</p>\n<ul>\n<li>current balance</li>\n<li>price list</li>\n<li>your user information</li>\n</ul>\n","urlObject":{"protocol":"https","path":["auth","api","get-info"],"host":["www","blinkage","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6fbee336-6d27-41e7-81ae-d45d69423bc9"}],"id":"95f2290e-8cb0-4f32-b9a1-376481a722f0","_postman_id":"95f2290e-8cb0-4f32-b9a1-376481a722f0","description":""},{"name":"Short URL","item":[{"name":"generate-url","id":"c521245e-daf1-469e-8589-e335c552172b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"user_id","value":"XXXXXXXXXXXXXXXXXX","type":"text","description":"<p>Your Blinkage user id </p>\n"},{"key":"password","value":"123456789a","type":"text","description":"<p>Your Blinkage password</p>\n"},{"key":"original_url","value":"https://yourdomain.com/123456","type":"text","description":"<p>your original link address</p>\n"}]},"url":"https://www.blinkage.com/s/generate-url","urlObject":{"protocol":"https","path":["s","generate-url"],"host":["www","blinkage","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c521245e-daf1-469e-8589-e335c552172b"},{"name":"urlId","id":"1cb33506-65f2-4545-bd5b-fdd8560ec08d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"b-rm.io/s/{id}","urlObject":{"path":["s","{id}"],"host":["b-rm","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"1cb33506-65f2-4545-bd5b-fdd8560ec08d"}],"id":"9d14fdf9-d2e1-4dc8-88ae-85eb1f80d334","_postman_id":"9d14fdf9-d2e1-4dc8-88ae-85eb1f80d334","description":""}]}