{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/app.gotsms.org" } ], "info": { "name": "GotSMS API Documentation", "_postman_id": "d2cc90f2-4388-4f8e-b1e9-197650cc2876", "description": "REST API documentation.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "API", "description": "GotSMS API methods.", "item": [ { "name": "Pricelist", "description": "", "item": [ { "name": "Get public pricelist", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pricelist", "query": [], "raw": "{{baseUrl}}\/api\/pricelist" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":[{\"name\":\"Telegram\",\"plans\":[{\"service_name\":\"Telegram\",\"period\":1,\"period_type\":\"day\",\"period_type_label\":\"day\",\"duration_translation\":\"1 day\",\"price\":1,\"renew_price\":1,\"country\":\"USA\",\"billing_type\":\"duration\"}]},{\"name\":\"WhatsApp\",\"plans\":[{\"service_name\":\"WhatsApp\",\"period\":1,\"period_type\":\"month\",\"period_type_label\":\"month\",\"duration_translation\":\"1 month\",\"price\":4.99,\"renew_price\":4.99,\"country\":\"USA\",\"billing_type\":\"duration\"}]}]}", "name": "" } ] } ] }, { "name": "Account", "description": "", "item": [ { "name": "Get account balance", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/account", "query": [], "raw": "{{baseUrl}}\/api\/account" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":{\"balance\":125.5}}", "name": "" } ] } ] }, { "name": "Services", "description": "", "item": [ { "name": "Get available services", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/services", "query": [ { "key": "search", "value": "", "description": "Search in service name.", "disabled": true }, { "key": "per_page", "value": "", "description": "Pagination size (max 100).", "disabled": true } ], "raw": "{{baseUrl}}\/api\/services?search=&per_page=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":[{\"id\":\"uuid\",\"name\":\"Telegram\"}],\"meta\":{\"current_page\":1,\"last_page\":1,\"per_page\":25,\"total\":1}}", "name": "" } ] } ] }, { "name": "Rents", "description": "", "item": [ { "name": "Get available rent plans", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/rents\/plans", "query": [ { "key": "service_id", "value": "", "description": "Filter by service UUID.", "disabled": true }, { "key": "country_id", "value": "", "description": "Filter by country UUID.", "disabled": true }, { "key": "duration_type", "value": "", "description": "Filter by duration type.", "disabled": true }, { "key": "billing_type", "value": "", "description": "Filter by billing type.", "disabled": true }, { "key": "search", "value": "", "description": "Search in service name.", "disabled": true }, { "key": "per_page", "value": "", "description": "Pagination size (max 100).", "disabled": true } ], "raw": "{{baseUrl}}\/api\/rents\/plans?service_id=&country_id=&duration_type=&billing_type=&search=&per_page=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":[{\"id\":\"uuid\",\"service\":{\"id\":\"uuid\",\"name\":\"Telegram\"},\"country\":{\"id\":\"uuid\",\"name\":\"USA\"},\"billing_type\":\"duration\",\"duration_type\":\"day\",\"duration_in_type\":1,\"duration_in_minutes\":1440,\"duration_translation\":\"1 day\",\"price\":1,\"renew_price\":1,\"is_monthly_supported\":false}],\"meta\":{\"current_page\":1,\"last_page\":1,\"per_page\":25,\"total\":1}}", "name": "" } ] }, { "name": "List user rents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/rents", "query": [ { "key": "status", "value": "", "description": "Filter by status.", "disabled": true }, { "key": "service", "value": "", "description": "Service name search.", "disabled": true }, { "key": "phone", "value": "", "description": "Phone search.", "disabled": true }, { "key": "per_page", "value": "", "description": "Pagination size (max 100).", "disabled": true } ], "raw": "{{baseUrl}}\/api\/rents?status=&service=&phone=&per_page=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":[{\"id\":\"uuid\",\"service\":{\"id\":\"uuid\",\"name\":\"Telegram\"},\"plan\":{\"id\":\"uuid\",\"billing_type\":\"duration\",\"duration_type\":\"day\",\"duration_in_type\":1,\"duration_translation\":\"1 day\",\"price\":1,\"renew_price\":1},\"phone\":\"+1 800 123 4567\",\"price\":1,\"status\":\"active\",\"is_included_for_next_renewal\":false,\"active_from\":\"2026-03-11T12:00:00+00:00\",\"active_till\":\"2026-03-12T12:00:00+00:00\",\"wake_from\":null,\"wake_till\":null,\"can_wake_up\":true,\"transition_options\":[]}],\"meta\":{\"current_page\":1,\"last_page\":1,\"per_page\":20,\"total\":1}}", "name": "" } ] }, { "name": "Create new rent", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/rents", "query": [], "raw": "{{baseUrl}}\/api\/rents" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"plan_id\":null}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\"success\":true,\"message\":\"Rent created successfully.\",\"data\":{\"id\":\"uuid\",\"service\":{\"id\":\"uuid\",\"name\":\"Telegram\"},\"plan\":{\"id\":\"uuid\",\"billing_type\":\"duration\",\"duration_type\":\"day\",\"duration_in_type\":1,\"duration_translation\":\"1 day\",\"price\":1,\"renew_price\":1},\"phone\":\"+1 800 123 4567\",\"price\":1,\"status\":\"active\",\"is_included_for_next_renewal\":false,\"active_from\":\"2026-03-11T12:00:00+00:00\",\"active_till\":\"2026-03-12T12:00:00+00:00\",\"wake_from\":null,\"wake_till\":null,\"can_wake_up\":true,\"transition_options\":[]}}", "name": "" } ] }, { "name": "Transition rent to a longer plan", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/rents\/:rent_id\/transition", "query": [], "raw": "{{baseUrl}}\/api\/rents\/:rent_id\/transition", "variable": [ { "id": "rent_id", "key": "rent_id", "value": "9d3f8f6a-1b2c-4d5e-8f90-1a2b3c4d5e6f", "description": "Rent UUID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"plan_id\":null}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Plan transitioned successfully.\",\"data\":{\"id\":\"uuid\",\"status\":\"active\"}}", "name": "" }, { "header": [], "code": 422, "body": "{\"success\":false,\"message\":\"Current rent plan must be daily for this transition endpoint.\"}", "name": "" } ] }, { "name": "Toggle auto renewal for monthly tariffs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/rents\/:rent_id\/renewal\/toggle", "query": [], "raw": "{{baseUrl}}\/api\/rents\/:rent_id\/renewal\/toggle", "variable": [ { "id": "rent_id", "key": "rent_id", "value": "9d3f8f6a-1b2c-4d5e-8f90-1a2b3c4d5e6f", "description": "Rent UUID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Auto renewal enabled.\",\"data\":{\"id\":\"uuid\",\"is_included_for_next_renewal\":true}}", "name": "" }, { "header": [], "code": 422, "body": "{\"success\":false,\"message\":\"Auto renewal can be toggled only for monthly 1\\\/3\\\/6\\\/12 plans.\"}", "name": "" } ] }, { "name": "Refund rent", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/rents\/:rent_id\/refund", "query": [], "raw": "{{baseUrl}}\/api\/rents\/:rent_id\/refund", "variable": [ { "id": "rent_id", "key": "rent_id", "value": "9d3f8f6a-1b2c-4d5e-8f90-1a2b3c4d5e6f", "description": "Rent UUID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Rent has been refunded successfully.\",\"data\":{\"id\":\"uuid\",\"status\":\"finished\"}}", "name": "" }, { "header": [], "code": 422, "body": "{\"success\":false,\"message\":\"Refund not available for this rent.\"}", "name": "" } ] } ] }, { "name": "Messages", "description": "", "item": [ { "name": "List all SMS messages across all rents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/messages", "query": [ { "key": "service_id", "value": "", "description": "Filter by service UUID. \u0417\u043d\u0430\u0447\u0435\u043d\u0438\u0435 \u043f\u043e\u043b\u044f value \u0434\u043e\u043b\u0436\u043d\u043e \u0431\u044b\u0442\u044c \u043a\u043e\u0440\u0440\u0435\u043a\u0442\u043d\u044b\u043c UUID.", "disabled": true }, { "key": "phone", "value": "", "description": "Phone search. \u041a\u043e\u043b\u0438\u0447\u0435\u0441\u0442\u0432\u043e \u0441\u0438\u043c\u0432\u043e\u043b\u043e\u0432 \u0432 \u0437\u043d\u0430\u0447\u0435\u043d\u0438\u0438 \u043f\u043e\u043b\u044f value \u043d\u0435 \u043c\u043e\u0436\u0435\u0442 \u043f\u0440\u0435\u0432\u044b\u0448\u0430\u0442\u044c 32.", "disabled": true }, { "key": "per_page", "value": "", "description": "Pagination size (max 100). \u0417\u043d\u0430\u0447\u0435\u043d\u0438\u0435 \u043f\u043e\u043b\u044f value \u0434\u043e\u043b\u0436\u043d\u043e \u0431\u044b\u0442\u044c \u043d\u0435 \u043c\u0435\u043d\u044c\u0448\u0435 1. \u0417\u043d\u0430\u0447\u0435\u043d\u0438\u0435 \u043f\u043e\u043b\u044f value \u043d\u0435 \u043c\u043e\u0436\u0435\u0442 \u0431\u044b\u0442\u044c \u0431\u043e\u043b\u044c\u0448\u0435 100.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/messages?service_id=&phone=&per_page=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":[{\"id\":\"uuid\",\"rent_id\":\"uuid\",\"service\":{\"id\":\"uuid\",\"name\":\"Telegram\"},\"phone\":\"+1 800 123 4567\",\"from\":\"+18001234567\",\"to\":\"+18009876543\",\"body\":\"Your verification code is 123456\",\"code\":\"123456\",\"received_at\":\"2026-03-11T12:00:00+00:00\"}],\"meta\":{\"current_page\":1,\"last_page\":1,\"per_page\":20,\"total\":1}}", "name": "" } ] }, { "name": "List unread SMS messages", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/messages\/unread", "query": [ { "key": "service_id", "value": "", "description": "Filter by service UUID.", "disabled": true }, { "key": "rent_id", "value": "", "description": "Filter by rent UUID.", "disabled": true }, { "key": "phone", "value": "", "description": "Phone search.", "disabled": true }, { "key": "per_page", "value": "", "description": "Pagination size (max 100).", "disabled": true }, { "key": "mark_as_read", "value": "", "description": "Mark returned messages as read.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/messages\/unread?service_id=&rent_id=&phone=&per_page=&mark_as_read=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":[{\"id\":\"uuid\",\"rent_id\":\"uuid\",\"service\":{\"id\":\"uuid\",\"name\":\"Telegram\"},\"phone\":\"+1 800 123 4567\",\"from\":\"+18001234567\",\"to\":\"+18009876543\",\"body\":\"Your verification code is 123456\",\"code\":\"123456\",\"received_at\":\"2026-03-11T12:00:00+00:00\"}],\"meta\":{\"current_page\":1,\"last_page\":1,\"per_page\":20,\"total\":1}}", "name": "" } ] } ] }, { "name": "Numbers", "description": "", "item": [ { "name": "Wake up a rented number", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/numbers\/:rent_id\/wake-up", "query": [], "raw": "{{baseUrl}}\/api\/numbers\/:rent_id\/wake-up", "variable": [ { "id": "rent_id", "key": "rent_id", "value": "9d3f8f6a-1b2c-4d5e-8f90-1a2b3c4d5e6f", "description": "Rent UUID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Wake up request sent.\"}", "name": "" } ] }, { "name": "Get SMS messages for a rent", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/numbers\/:rent_id\/messages", "query": [ { "key": "limit", "value": "", "description": "Number of records (max 100).", "disabled": true }, { "key": "before_id", "value": "", "description": "Fetch messages with id less than this UUID.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/numbers\/:rent_id\/messages?limit=&before_id=", "variable": [ { "id": "rent_id", "key": "rent_id", "value": "9d3f8f6a-1b2c-4d5e-8f90-1a2b3c4d5e6f", "description": "Rent UUID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":[{\"id\":\"uuid\",\"from\":\"+18001234567\",\"to\":\"+18009876543\",\"body\":\"Your verification code is 123456\",\"code\":\"123456\",\"received_at\":\"2026-03-11T12:00:00+00:00\"}],\"meta\":{\"next_before_id\":\"uuid\",\"count\":1}}", "name": "" } ] }, { "name": "Get number queue\/wakeup\/online status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/numbers\/:rent_id\/status", "query": [], "raw": "{{baseUrl}}\/api\/numbers\/:rent_id\/status", "variable": [ { "id": "rent_id", "key": "rent_id", "value": "9d3f8f6a-1b2c-4d5e-8f90-1a2b3c4d5e6f", "description": "Rent UUID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":{\"rent_id\":\"uuid\",\"status\":\"active\",\"active_from\":\"2026-03-11T12:00:00+00:00\",\"active_till\":\"2026-03-12T12:00:00+00:00\",\"wake_from\":\"2026-03-11T12:00:00+00:00\",\"wake_till\":\"2026-03-11T12:05:00+00:00\",\"online_till\":\"2026-03-11T12:35:00+00:00\",\"wakeup_time_left_seconds\":120,\"online_time_left_seconds\":1800,\"can_wake_up\":false}}", "name": "" } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }