{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/api.tikosms.com" } ], "info": { "name": "TikoSMS API Documentation", "_postman_id": "a2b58585-08ba-4b45-a452-d2a159ac8e94", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Balance", "description": "", "item": [ { "name": "Get current user's SMS balance", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/balance", "query": [], "raw": "{{baseUrl}}\/v1\/balance" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Requires authentication via Bearer token." }, "response": [ { "header": [], "code": 200, "body": "{\n \"balance_updated\": \"2025.07.03 13:34:34\",\n \"currency_code\": \"EUR\",\n \"balance\": 634.9288,\n \"in_credit_limit\": 1000\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"error\": \"User not authenticated\"\n}", "name": "" } ] } ] }, { "name": "SMS API", "description": "", "item": [ { "name": "POST v1\/messages", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/messages", "query": [], "raw": "{{baseUrl}}\/v1\/messages" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"from\":\"MyBrand\",\"message\":\"Big sale today!\",\"recipients\":[{\"to\":\"380501234567\",\"client_ref\":\"order-1\"}],\"callback_url\":\"https:\\\/\\\/example.com\\\/callback\",\"scheduled_at\":\"2025-08-12 10:00:00\",\"concurrency\":20}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"campaign_id\": \"bc7f100a-bebb-4449-8f5a-cf5154ef2fcf\",\n \"recipients\": 3,\n \"duplicates_removed\": 1\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"error\": \"Invalid callback URL provided\"\n}", "name": "" } ] }, { "name": "GET v1\/get_messages", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/get_messages", "query": [ { "key": "campaign_id", "value": "", "description": "uuid Filter to a single campaign.", "disabled": true } ], "raw": "{{baseUrl}}\/v1\/get_messages?campaign_id=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"campaign_id\":\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"campaigns\": [\n {\n \"campaign_id\": \"bc7f100a-bebb-4449-8f5a-cf5154ef2fcf\",\n \"sender\": \"MyBrand\",\n \"message\": \"Big sale today!\",\n \"recipients\": 1,\n \"created_at\": \"2025-08-11T13:12:34.000000Z\",\n \"updated_at\": \"2025-08-11T13:12:34.000000Z\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"error\": \"Campaign not found\"\n}", "name": "" } ] }, { "name": "POST v1\/message", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/message", "query": [], "raw": "{{baseUrl}}\/v1\/message" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"from\":\"MySender\",\"message\":\"Your OTP is 1234\",\"to\":\"380501234567\",\"callback_url\":\"https:\\\/\\\/yourdomain.com\\\/sms-callback\",\"client_ref\":\"invoice-10294\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message_id\": \"d3b0e5a1-2224-4a7e-8b12-7c61d3a7bfb9\",\n \"campaign_id\": \"7e9d2a5c-3b8e-4b8d-9b5f-1a2c3d4e5f60\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"error\": \"No SMS rate is available for this destination for your account. Please contact sales team.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"error\": \"Oops! We couldn't find this number in any country on Earth. Mind giving it another look?\"\n}", "name": "" } ] }, { "name": "GET v1\/get_message", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/get_message", "query": [ { "key": "message_id", "value": "d3b0e5a1-2224-4a7e-8b12-7c61d3a7bfb9", "description": "The UUID of the message.", "disabled": false }, { "key": "campaign_id", "value": "7e9d2a5c-3b8e-4b8d-9b5f-1a2c3d4e5f60", "description": "The UUID of the campaign.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/get_message?message_id=d3b0e5a1-2224-4a7e-8b12-7c61d3a7bfb9&campaign_id=7e9d2a5c-3b8e-4b8d-9b5f-1a2c3d4e5f60" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"message_id\":\"b\",\"campaign_id\":\"n\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": [\n {\n \"message_id\": \"d3b0e5a1-2224-4a7e-8b12-7c61d3a7bfb9\",\n \"campaign_id\": \"7e9d2a5c-3b8e-4b8d-9b5f-1a2c3d4e5f60\",\n \"to\": \"380501234567\",\n \"message\": \"Your code is 1234\",\n \"from\": \"MySender\",\n \"sender_type\": \"Alpha\",\n \"status\": \"DELIVRD\",\n \"data_coding\": 0,\n \"mccmnc\": \"25501\",\n \"cost\": \"0.050\",\n \"part\": 1,\n \"total_parts\": 1,\n \"sent_at\": \"2025-08-06 12:35:18\",\n \"delivered_at\": \"2025-08-06 12:35:19\",\n \"client_ref\": \"order-123\",\n \"callback_url\": \"https:\/\/example.com\/sms-callback\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"error\": \"Message(s) not found\"\n}", "name": "" } ] } ] }, { "name": "SMS Rates", "description": "", "item": [ { "name": "GET v1\/sms-rates", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/sms-rates", "query": [ { "key": "mccmnc", "value": "255001", "description": "MCCMNC code (e.g. 255001 or 255).", "disabled": false }, { "key": "country", "value": "Ukraine", "description": "Country name.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/sms-rates?mccmnc=255001&country=Ukraine" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"rate\": {\n \"mcc\": \"255\",\n \"mnc\": \"001\",\n \"mccmnc\": \"255001\",\n \"country\": \"Ukraine\",\n \"rate\": \"0.045000\",\n \"rate_start_date\": \"2025-08-01 00:00:00\",\n \"rate_end_date\": \"2100-01-01 00:00:00\"\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"error\": \"No SMS rate found for this destination.\"\n}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }