{ "info": { "name": "FarazSMS · وب سرویس پیامک فراز اس ام اس", "description": "# FarazSMS · IranPayamak — وب سرویس پیامک فراز اس ام اس\n\nOfficial Postman collection for the FarazSMS SMS REST API.\n\n## Setup\n1. Set the collection variable **`apiKey`** to your panel API key (Web Service → API Key).\n2. Auth is sent automatically as the **`Api-Key`** header (collection-level).\n\n## Conventions\n- Base URL: `{{baseUrl}}` = https://api.iranpayamak.com\n- Recipients use the local format `09120000000` (no `+98`). Default sender line `90008361`.\n- Always send `\"number_format\": \"english\"`.\n- For **OTP / رمز یک‌بارمصرف** use *Send Pattern-Based SMS* (`POST /ws/v1/sms/pattern`) — instant, never queued.\n\nDocs: https://docs.farazsms.com · SDKs: `pip install farazsms` · `npm install farazsms` · `composer require farazsms/php`", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Api-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "item": [ { "name": "Send SMS", "item": [ { "name": "Send Pattern-Based SMS", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/sms/pattern", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "sms", "pattern" ] }, "description": "**ارسال پیامک پترن (قالب‌دار)**\n\nSend a templated message (OTP, verification codes, transaction alerts). Fastest path and never queued — use this for one-time codes.\n\nSend a pattern-based message, the pattern UID must be creadted and get from user panel.", "body": { "mode": "raw", "raw": "{\n \"code\": \"SJ3FgPrE0C\",\n \"attributes\": {\n \"var1\": \"1\",\n \"var2\": \"2\"\n },\n \"recipient\": \"09120000000\",\n \"line_number\": \"50002178584000\",\n \"number_format\": \"english\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send Simple SMS from Phonebook", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/sms/simple", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "sms", "simple" ] }, "description": "**ارسال پیامک ساده از دفترتلفن**\n\nSend one fixed text to a list of numbers or a phonebook. For announcements and bulk campaigns (goes through the queue).\n\nSend a Voice message toward many recipients.\nYou must use at least one of the attrebute {recipients} or {selectedPhoneBooks}.", "body": { "mode": "raw", "raw": "{\n \"text\": \"test message\",\n \"selectedPhoneBooks\": [\n {\n \"id\": 1,\n \"offset\": 0,\n \"limit\": 10\n }\n ],\n \"line_number\": \"98123123\",\n \"number_format\": \"english\",\n \"schedule\": \"2026-03-20T10:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send SMS with Variables", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/sms/keywords", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "sms", "keywords" ] }, "description": "**ارسال پیامک با متغیر (شخصی‌سازی‌شده)**\n\nBulk personalized send; variables (e.g. the contact's name) sit inside `%...%` in the text.\n\nSend a message containing variable keywords. The keywords (attributes) must be wrapped inside % signs within the text (E.g: Hello %first_name%)", "body": { "mode": "raw", "raw": "{\n \"text\": \"test %var1% text\",\n \"line_number\": \"50002178584000\",\n \"recipients\": [\n {\n \"mobile\": \"09120000000\",\n \"var1\": \"value1\"\n },\n {\n \"mobile\": \"09130000000\",\n \"var1\": \"value2\"\n }\n ],\n \"number_format\": \"english\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send SMS with Variables from Excel", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/send/keyword-file", "host": [ "{{baseUrl}}" ], "path": [ "v1", "send", "keyword-file" ] }, "description": "**ارسال پیامک متغیردار از اکسل**\n\nThe same variable send, but each recipient's data comes from an Excel/CSV file — for large volumes.\n\nSend a message with keywords with its data coming from an excel or CSV file. The keywords (attributes) must be wrapped inside % signs within the text (E.g: Hello %first_name%)" } }, { "name": "Create New LBS Request", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/lbs", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "lbs" ] }, "description": "**ساخت ارسال موقعیت‌محور (LBS)**\n\nCreate a location-based campaign; messages people who are within a chosen area and time window.", "body": { "mode": "raw", "raw": "{\n \"text\": \"test text\",\n \"start_time\": 1742773823,\n \"end_time\": 1742774823,\n \"receiver_count\": 6000,\n \"latitude\": 45,\n \"longitude\": 90,\n \"radius\": 1000,\n \"address\": \"some address\",\n \"dispatch_moment\": \"حضور\",\n \"receiver_gender\": \"آقا\",\n \"receiver_age_from\": 12,\n \"receiver_age_to\": 90,\n \"device\": \"Android\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get LBS Requests List", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/lbs", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "lbs" ] }, "description": "**فهرست ارسال‌های موقعیت‌محور (LBS)**\n\nList your location-based campaigns to track their status." } }, { "name": "Edit LBS Request", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/lbs/:lbsId", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "lbs", ":lbsId" ], "variable": [ { "key": "lbsId", "value": "5", "description": "" } ] }, "description": "**ویرایش ارسال موقعیت‌محور (LBS)**\n\nEdit a location-based campaign before it runs (text, area, filters).", "body": { "mode": "raw", "raw": "{\n \"text\": \"test text\",\n \"start_time\": 1742773823,\n \"end_time\": 1742774823,\n \"receiver_count\": 10000,\n \"latitude\": 45,\n \"longitude\": 90,\n \"radius\": 1000,\n \"address\": \"some address\",\n \"dispatch_moment\": \"حضور\",\n \"receiver_gender\": \"مرد\",\n \"receiver_age_from\": 12,\n \"receiver_age_to\": 90,\n \"device\": \"Android\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Single LBS Request Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/lbs/:lbsId", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "lbs", ":lbsId" ], "variable": [ { "key": "lbsId", "value": "1", "description": "" } ] }, "description": "**جزئیات ارسال موقعیت‌محور (LBS)**\n\nView the full details of one location-based campaign by its id." } }, { "name": "Cancel LBS Request", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/lbs/:lbsId/cancel", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "lbs", ":lbsId", "cancel" ], "variable": [ { "key": "lbsId", "value": "1", "description": "" } ] }, "description": "**لغو ارسال موقعیت‌محور (LBS)**\n\nCancel a location-based campaign before it sends." } }, { "name": "Send Peer-to-Peer SMS", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/send/peer-to-peer", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "send", "peer-to-peer" ] }, "description": "**ارسال نظیربه‌نظیر (Peer-to-Peer)**\n\nPeer-to-peer send: a different text per recipient group — fully personalized messages in one call.\n\nSend peer-to-peer messages. Each peer contains different text and recipients. Each peer will generate a separate send request record." } }, { "name": "Send Peer-to-Peer SMS from Excel", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/send/peer-to-peer-file", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "send", "peer-to-peer-file" ] }, "description": "**ارسال نظیربه‌نظیر از اکسل**\n\nThe same peer-to-peer, but the text/recipient pairs come from an Excel file.\n\nSend peer-to-peer messages with file input. Each peer contains different text and recipients. Each peer will generate a separate send request record." } }, { "name": "Send to Number Bank", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/sms/bank", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "sms", "bank" ] }, "description": "**ارسال پیامک به بانک شماره**\n\nTargeted send to a Number Bank (ready-made numbers by trade/region) without owning a phonebook.", "body": { "mode": "raw", "raw": "{\n \"text\": \"test message\",\n \"recipients\": [\n {\n \"bank_id\": 1,\n \"limit\": 50,\n \"offset\": 0\n },\n {\n \"bank_id\": 5,\n \"limit\": 100,\n \"offset\": 50\n }\n ],\n \"line_number\": \"98123123\",\n \"number_format\": \"english\",\n \"schedule\": \"2026-03-20T10:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send Sample SMS", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/sms/sample", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "sms", "sample" ] }, "description": "**ارسال پیامک نمونه**\n\nSend a sample only to yourself, to test the text and sender line before a bulk campaign.\n\nSend a sample of message to the account owner", "body": { "mode": "raw", "raw": "{\n \"text\": \"test text\",\n \"line_number\": \"50002178584000\",\n \"number_format\": \"english\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send Simple SMS from Excel", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/sms/simple-file", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "sms", "simple-file" ] }, "description": "**ارسال پیامک ساده از اکسل**\n\nSend a fixed text with the recipient list from an Excel file — for large lists.\n\nSend a simple message with recipients from excel file." } }, { "name": "Download Uploded Voice Message File", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/sms/voice/download-file?file_id=1", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "sms", "voice", "download-file" ], "query": [ { "key": "file_id", "value": "1", "description": "", "disabled": false } ] }, "description": "**دانلود فایل پیام صوتی**\n\nRe-download an uploaded voice file by its `file_id`." } }, { "name": "Send Voice Message", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/sms/voice/send", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "sms", "voice", "send" ] }, "description": "**ارسال پیام صوتی**\n\nSend a voice call (recorded message) to recipients; the audio must be uploaded first.\n\nSend a Voice message toward many recipients.\nYou must use at least one of the attrebute {recipients} or {selectedPhoneBooks}.", "body": { "mode": "raw", "raw": "{\n \"file_id\": 1,\n \"recipients\": [\n \"09120000000\"\n ],\n \"selectedPhoneBooks\": [\n {\n \"id\": 1,\n \"offset\": 0,\n \"limit\": 10\n }\n ],\n \"schedule\": \"2025-08-20 15:30:00\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Upload Voice Message File", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/sms/voice/upload-file", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "sms", "voice", "upload-file" ] }, "description": "**آپلود فایل پیام صوتی**\n\nUpload a voice file and get a `file_id` — the prerequisite of a voice send." } } ] }, { "name": "Patterns", "item": [ { "name": "Create New Pattern", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/patterns", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "patterns" ] }, "description": "**ساخت پترن جدید**\n\nCreate a new pattern (template) with variables; the prerequisite of pattern send. Needs approval after creation.\n\nCreate a new pattern with API", "body": { "mode": "raw", "raw": "{\n \"text\": \"test text %var%, %var2%\",\n \"description\": \"test desc\",\n \"share\": 1,\n \"website\": \"example.com\",\n \"category\": 1,\n \"vars\": [\n {\n \"var\": \"var\",\n \"length\": 12,\n \"type\": \"int\"\n },\n {\n \"var\": \"var2\",\n \"length\": 12,\n \"type\": \"int\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get List of User's Patterns", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/patterns", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "patterns" ] }, "description": "**فهرست پترن‌ها**\n\nList your account's patterns; find a pattern's `code` here to send with it." } }, { "name": "Edit Pattern", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/patterns/:code", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "patterns", ":code" ], "variable": [ { "key": "code", "value": "", "description": "" } ] }, "description": "**ویرایش پترن**\n\nEdit an existing pattern's text or variables (may require re-approval).", "body": { "mode": "raw", "raw": "{\n \"text\": \"test text %var%, %var2%\",\n \"description\": \"test desc\",\n \"share\": 1,\n \"website\": \"example.com\",\n \"vars\": [\n {\n \"var\": \"var\",\n \"length\": 12,\n \"type\": \"int\"\n },\n {\n \"var\": \"var2\",\n \"length\": 12,\n \"type\": \"int\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Pattern Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/patterns/:code", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "patterns", ":code" ], "variable": [ { "key": "code", "value": "", "description": "" } ] }, "description": "**جزئیات پترن**\n\nView one pattern's details (variable names and count) so your send matches it exactly.\n\nThis endpoint help to get a pattern by its \"code\"" } } ] }, { "name": "Reports & Inbox", "item": [ { "name": "Get Paged Inbox Messages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/inbox?page=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "inbox" ], "query": [ { "key": "page", "value": "", "description": "Page number", "disabled": true }, { "key": "limit", "value": "", "description": "Number of items per page", "disabled": true } ] }, "description": "**دریافت پیامک‌های ورودی (صندوق دریافت)**\n\nRead inbound messages (customer replies); poll this periodically to make the conversation two-way." } }, { "name": "Get Send Requests", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/send_request?search=&status=&line_id=0&page=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "send_request" ], "query": [ { "key": "search", "value": "", "description": "", "disabled": true }, { "key": "status", "value": "", "description": "init | pending-approval | insufficient-balance | cancelled | rejected | in-queue | sent", "disabled": true }, { "key": "line_id", "value": "0", "description": "", "disabled": true }, { "key": "page", "value": "", "description": "Page number", "disabled": true }, { "key": "limit", "value": "", "description": "Number of items per page", "disabled": true } ] }, "description": "**فهرست درخواست‌های ارسال**\n\nList all your sends with their overall status (queued, sent, rejected…); filter with `status`.\n\nGet paged list of phonebooks" } }, { "name": "Show Send Request Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/send_request/:send_request_id", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "send_request", ":send_request_id" ], "variable": [ { "key": "send_request_id", "value": "407328", "description": "" } ] }, "description": "**جزئیات درخواست ارسال**\n\nView the details of one specific send by its id.\n\nGet paged list of phonebooks" } }, { "name": "Get Send Request Items", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/send_request/:send_request_id/items?search=&status=&page=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "send_request", ":send_request_id", "items" ], "variable": [ { "key": "send_request_id", "value": "407328", "description": "" } ], "query": [ { "key": "search", "value": "", "description": "", "disabled": true }, { "key": "status", "value": "", "description": "not-started | in-queue | sent | send-failure | delivered | delivery-failure | delivery-undetermined | system-error | blacklist", "disabled": true }, { "key": "page", "value": "", "description": "Page number", "disabled": true }, { "key": "limit", "value": "", "description": "Number of items per page", "disabled": true } ] }, "description": "**وضعیت تحویل گیرنده‌ها**\n\nPer-recipient delivery status inside one send (delivered, failed, blacklisted…).\n\nGet paged list of phonebooks" } } ] }, { "name": "Phonebook & Contacts", "item": [ { "name": "Get Bulk Excel Sample", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/example/phone-book/:phone_book/data.xlsx", "host": [ "{{baseUrl}}" ], "path": [ "example", "phone-book", ":phone_book", "data.xlsx" ], "variable": [ { "key": "phone_book", "value": "1", "description": "" } ] }, "description": "**دانلود نمونه اکسل دفترتلفن**\n\nDownload that phonebook's sample Excel; fill the columns to match it — prerequisite of Excel import.\n\nThis endpoint used to get an Excel sample file for each phonebook by its ID." } }, { "name": "Create New Phonebook", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/phone_book", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "phone_book" ] }, "description": "**ساخت دفترتلفن جدید**\n\nCreate a new phonebook to group your contacts.", "body": { "mode": "raw", "raw": "{\n \"title\": \"test title\",\n \"attributes\": [\n 2\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Phonebooks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/phone_book?page=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "phone_book" ], "query": [ { "key": "page", "value": "", "description": "Page number", "disabled": true }, { "key": "limit", "value": "", "description": "Number of items per page", "disabled": true } ] }, "description": "**فهرست دفترتلفن‌ها**\n\nList your phonebooks and their ids.\n\nGet paged list of phonebooks" } }, { "name": "Update Phonebook", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/phone_book/:id", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "phone_book", ":id" ], "variable": [ { "key": "id", "value": "44", "description": "" } ] }, "description": "**ویرایش دفترتلفن**\n\nRename or change the columns of an existing phonebook.", "body": { "mode": "raw", "raw": "{\n \"title\": \"updated title\",\n \"attributes\": [\n 1,\n 3\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create New Phonebook Attribute", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/phone_book_attribute", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "phone_book_attribute" ] }, "description": "**ساخت ویژگی دفترتلفن**\n\nCreate a custom column/attribute (e.g. birthdate or national code) for contacts.\n\nCreate a new phonebook attribute like birthdate, national code and etc", "body": { "mode": "raw", "raw": "{\n \"title\": \"test attribute\",\n \"type\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Phonebook Attributes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/phone_book_attribute?page=&limit=&type=&search=", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "phone_book_attribute" ], "query": [ { "key": "page", "value": "", "description": "Page number", "disabled": true }, { "key": "limit", "value": "", "description": "Number of items per page", "disabled": true }, { "key": "type", "value": "", "description": "date | number | string", "disabled": true }, { "key": "search", "value": "", "description": "", "disabled": true } ] }, "description": "**فهرست ویژگی‌های دفترتلفن**\n\nList your defined attributes and their ids (to use when adding contacts).\n\nGet paged list of phonebook attributes" } }, { "name": "Add New Contact", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/phone_book_data", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "phone_book_data" ] }, "description": "**افزودن مخاطب**\n\nAdd a single contact to a phonebook.", "body": { "mode": "raw", "raw": "{\n \"phone_book_id\": 33,\n \"phone_book_data_id\": 1,\n \"prefix\": \"man\",\n \"mobile\": \"09123456781\",\n \"name\": \"test name\",\n \"attributes\": [\n {\n \"attribute_id\": 5,\n \"value\": \"1378/01/24\"\n },\n {\n \"attribute_id\": 8,\n \"value\": \"Tehran\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Phonebook Contacts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/phone_book_data?page=&limit=&phone_book_id=1&search=", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "phone_book_data" ], "query": [ { "key": "page", "value": "", "description": "Page number", "disabled": true }, { "key": "limit", "value": "", "description": "Number of items per page", "disabled": true }, { "key": "phone_book_id", "value": "1", "description": "The phonebook Id", "disabled": true }, { "key": "search", "value": "", "description": "Search parameter", "disabled": true } ] }, "description": "**فهرست مخاطبین دفترتلفن**\n\nGet a phonebook's contacts with search and pagination.\n\nGet paged phonebook data for a specific phonebook" } }, { "name": "Add Bulk Contact", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/phone_book_data/bulk-upsert", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "phone_book_data", "bulk-upsert" ] }, "description": "**افزودن انبوه مخاطبین**\n\nBulk add/update contacts in a single call (up to 500 contacts).\n\nIt used to import contacts to a phonebook with an {Object}.\nMax contacts can add by Object is 500 in each reques.", "body": { "mode": "raw", "raw": "{\n \"phone_book_id\": 86292,\n \"items\": [\n {\n \"prefix\": \"man\",\n \"mobile\": \"09123456781\",\n \"name\": \"test name\",\n \"attributes\": [\n {\n \"attribute_id\": 2,\n \"value\": \"2061207342\"\n },\n {\n \"attribute_id\": 3,\n \"value\": \"test\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Add Excel Contact", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/phone_book_data/excel-upsert", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "phone_book_data", "excel-upsert" ] }, "description": "**افزودن مخاطبین از اکسل**\n\nImport contacts from an Excel file, with no count limit.\n\nIt used to import contacts to a phonebook with Excel.\nTo use with Excel you must get exaple Excel with another existed endpoint.\nNo limit to import with Excel." } }, { "name": "Delete Contact", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/phone_book_data/:id", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "phone_book_data", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "**حذف مخاطب**\n\nDelete a contact by id (irreversible)." } } ] }, { "name": "Account & Wallet", "item": [ { "name": "Account Balance", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/account/balance", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "account", "balance" ] }, "description": "**موجودی و اعتبار حساب**\n\nCheck your balance; the best free test to confirm your API key works." } }, { "name": "Charge wallet", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/account/wallet/charge", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "account", "wallet", "charge" ] }, "description": "**شارژ کیف‌پول**\n\nCharge your wallet (creates a payable order).", "body": { "mode": "raw", "raw": "{\n \"amount\": 100000,\n \"redirectUrl\": \"https://api.iranpayamak.com\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Profile", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/account/profile", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "account", "profile" ] }, "description": "**پروفایل حساب**\n\nGet your account profile (name and details).\n\nThe Login API allows users to authenticate by providing valid credentials like username and password. It typically returns an access token upon successful authentication." } }, { "name": "Register", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/account/register", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "account", "register" ] }, "description": "**ثبت‌نام حساب**\n\nRegister an account via the API (not needed just to send SMS).", "body": { "mode": "raw", "raw": "{\n \"plan_id\": 3,\n \"person_type\": \"personal\",\n \"username\": \"test_name1\",\n \"first_name\": \"test fname\",\n \"last_name\": \"test lname\",\n \"national_code\": \"1234567890\",\n \"mobile\": \"09121234567\",\n \"discount_code\": \"test_code\",\n \"seller_id\": 1,\n \"should_notify_user\": true,\n \"redirect_url\": \"https://test.com/test\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "update", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/account/update", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "account", "update" ] }, "description": "**به‌روزرسانی حساب**\n\nUpdate your account information.", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Ali\",\n \"last_name\": \"Rezaei\",\n \"father_name\": \"Mohammad\",\n \"gender\": 1,\n \"national_code\": \"1234567890\",\n \"national_id\": \"A123456789\",\n \"br_date\": 631152000,\n \"live_province_id\": 2,\n \"live_city_id\": 20,\n \"live_postal_code\": \"1234567890\",\n \"fixed_phone\": \"02112345678\",\n \"mobile\": \"09121234567\",\n \"email\": \"ali.rezaei@example.com\",\n \"address\": \"123 Example St, Cityname\",\n \"ceo\": {\n \"has_ceo\": true,\n \"first_name\": \"Sara\",\n \"last_name\": \"Ahmadi\",\n \"father_name\": \"Hossein\",\n \"gender\": 1,\n \"br_date\": 599616000,\n \"mobile\": \"09351234567\",\n \"national_id\": \"B987654321\",\n \"national_code\": \"9876543210\"\n },\n \"company\": {\n \"name\": \"Example Co\",\n \"national_id\": \"1122334455\",\n \"registration_id\": \"778899\",\n \"economic_id\": \"6655443322\",\n \"province_id\": 3,\n \"city_id\": 30,\n \"address\": \"456 Corporate Ave, Business City\",\n \"postal_code\": \"4433221100\",\n \"fixed_phone\": \"02187654321\",\n \"email\": \"info@exampleco.com\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Lines", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/lines/accessible?search=0210000000&is_dedicated=1", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "lines", "accessible" ], "query": [ { "key": "search", "value": "0210000000", "description": "", "disabled": true }, { "key": "is_dedicated", "value": "1", "description": "", "disabled": true } ] }, "description": "**خطوط فرستنده‌ی حساب**\n\nList your usable sender lines; take the `line_number` value from here." } }, { "name": "Apply Discount on Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/orders/apply-discount", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "orders", "apply-discount" ] }, "description": "**اعمال کد تخفیف سفارش**\n\nApply a discount code to an order before payment." } }, { "name": "Cancel an Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/orders/cancel", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "orders", "cancel" ] }, "description": "**لغو سفارش**\n\nCancel an unpaid order." } }, { "name": "Pay Created Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/orders/pay", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "orders", "pay" ] }, "description": "**پرداخت سفارش**\n\nPay a created order (e.g. a wallet charge)." } } ] }, { "name": "Tickets", "item": [ { "name": "Create New Ticket", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/ticket", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "ticket" ] }, "description": "**ساخت تیکت پشتیبانی**\n\nOpen a new support ticket." } }, { "name": "Get List of Tickets", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/ticket?search=&status=&support_department_id=", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "ticket" ], "query": [ { "key": "search", "value": "", "description": "", "disabled": true }, { "key": "status", "value": "", "description": "pending | referred | closed | asked | answered", "disabled": true }, { "key": "support_department_id", "value": "", "description": "", "disabled": true } ] }, "description": "**فهرست تیکت‌ها**\n\nList your support tickets (filter by status and department)." } }, { "name": "Close Ticket", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/ticket/closed", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "ticket", "closed" ] }, "description": "**بستن تیکت**\n\nClose a ticket." } }, { "name": "Download Ticket Attached File", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/ticket/file/download?ticket_message_id=&file_index=", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "ticket", "file", "download" ], "query": [ { "key": "ticket_message_id", "value": "", "description": "", "disabled": false }, { "key": "file_index", "value": "", "description": "", "disabled": false } ] }, "description": "**دانلود پیوست تیکت**\n\nDownload a file attached to a ticket message." } }, { "name": "Replay to Ticket", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/ticket/replay", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "ticket", "replay" ] }, "description": "**پاسخ به تیکت**\n\nReply to an existing ticket." } }, { "name": "Show Ticket Conversations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/ticket/:id", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "ticket", ":id" ], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "**مشاهده مکالمات تیکت**\n\nView a ticket's full conversation." } } ] }, { "name": "Reference & Tools", "item": [ { "name": "Get Cities List of Provinces", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/cities?province_id=&has_any_banks=", "host": [ "{{baseUrl}}" ], "path": [ "cities" ], "query": [ { "key": "province_id", "value": "", "description": "", "disabled": false }, { "key": "has_any_banks", "value": "", "description": "If send as TRUE, only banks with at least ONE namber bank returned.", "disabled": true } ] }, "description": "**فهرست شهرهای استان**\n\nList a province's cities (for targeted-send filters)." } }, { "name": "Get Provinces List", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/provinces?has_any_banks=", "host": [ "{{baseUrl}}" ], "path": [ "provinces" ], "query": [ { "key": "has_any_banks", "value": "", "description": "If send as TRUE, only banks with at least ONE namber bank returned.", "disabled": true } ] }, "description": "**فهرست استان‌ها**\n\nList provinces; with `has_any_banks`, only those that have a number bank." } }, { "name": "Get List of Avalibale Banks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/number_bank?province_id=&city_id=&search=&include_public_banks=", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "number_bank" ], "query": [ { "key": "province_id", "value": "", "description": "", "disabled": false }, { "key": "city_id", "value": "", "description": "", "disabled": false }, { "key": "search", "value": "", "description": "", "disabled": true }, { "key": "include_public_banks", "value": "", "description": "If send as TRUE, IranPyamak public number bank returned too", "disabled": true } ] }, "description": "**فهرست بانک‌های شماره**\n\nList the available number banks for targeted sending (filter by province/city)." } }, { "name": "Send Postal Code SMS", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/sms/calculate-cost", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "sms", "calculate-cost" ] }, "description": "**برآورد هزینه‌ی ارسال پیامک**\n\nEstimate the cost of a send (e.g. a postal-code send) before you run it.", "body": { "mode": "raw", "raw": "{\n \"filters\": [\n {\n \"postal_code\": \"12345\",\n \"gender_id\": 1,\n \"age_from\": 1305,\n \"age_to\": 1310,\n \"number_prefix\": \"912\",\n \"operator\": \"mci\",\n \"row_from\": 0,\n \"row_count\": 50\n }\n ],\n \"text\": \"message text\",\n \"line_id\": 12,\n \"number_format\": \"english\",\n \"schedule\": \"2026-04-01T10:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Available Lines", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/sms/postal/get-available-lines", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "sms", "postal", "get-available-lines" ] }, "description": "**خطوط مجاز ارسال کدپستی**\n\nReturns the lines allowed for postal-code sending." } }, { "name": "Get Genders List", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/sms/postal/get-genders", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "sms", "postal", "get-genders" ] }, "description": "**فهرست جنسیت‌ها (ارسال کدپستی)**\n\nGender options for postal-code send filters." } }, { "name": "Get Receiver Counts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/sms/postal/get-receiver-count?postal_code=&gender_id=&age_from=1300&age_to=1400&number_prefix=912", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "sms", "postal", "get-receiver-count" ], "query": [ { "key": "postal_code", "value": "", "description": "First [3,4,5] digit of postal code", "disabled": false }, { "key": "gender_id", "value": "", "description": "", "disabled": true }, { "key": "age_from", "value": "1300", "description": "", "disabled": false }, { "key": "age_to", "value": "1400", "description": "", "disabled": false }, { "key": "number_prefix", "value": "912", "description": "", "disabled": true } ] }, "description": "**تخمین تعداد گیرنده (کدپستی)**\n\nEstimate the recipient count before a postal-code send, based on filters (postal code, gender, age range, prefix)." } } ] }, { "name": "Panel Login & Account", "item": [ { "name": "Login", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/auth/login", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "auth", "login" ] }, "description": "**ورود به پنل**\n\nLogs a user into the panel (not API access). Use the Api-Key for API calls, not this.", "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"username\": \"فراز اس ام اس\",\n \"password\": \"1272893596\",\n \"method\": null\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Logout", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/auth/logout", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "auth", "logout" ] }, "description": "**خروج از پنل**\n\nEnds a panel session; unrelated to the web services." } }, { "name": "Register", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/auth/register", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "auth", "register" ] }, "description": "**ثبت‌نام در پنل**\n\nRegisters a panel user; not needed to use the APIs.", "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"plan_id\": 3,\n \"person_type\": \"personal\",\n \"username\": \"test_name2\",\n \"first_name\": \"test fname\",\n \"last_name\": \"test lname\",\n \"national_code\": \"1234567890\",\n \"mobile\": \"09121234567\",\n \"discount_code\": \"\",\n \"seller_id\": 1,\n \"should_notify_user\": true,\n \"redirect_url\": \"https://test.com/test\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Register Form", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/auth/show_register_form", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "auth", "show_register_form" ] }, "description": "**فرم ثبت‌نام پنل**\n\nReturns the fields required by the panel's register form." } }, { "name": "Verify 2fa", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ws/v1/auth/verify-2fa", "host": [ "{{baseUrl}}" ], "path": [ "ws", "v1", "auth", "verify-2fa" ] }, "description": "**تأیید کد دومرحله‌ای**\n\nVerifies the two-factor code during panel login.", "body": { "mode": "raw", "raw": "{\n \"token\": \"5GOXRzVeN9FSo8Kco6ngUGgUPBnVYRsa\",\n \"code\": \"264135\",\n \"method\": \"sms\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ], "variable": [ { "key": "baseUrl", "value": "https://api.iranpayamak.com", "type": "string" }, { "key": "apiKey", "value": "YOUR_API_KEY", "type": "string" } ] }