{ "openapi": "3.0.1", "info": { "title": "FarazSMS Public APIs", "version": "1.0.0" }, "servers": [ { "url": "https://api.iranpayamak.com", "description": "Prod" } ], "paths": { "/ws/v1/account/balance": { "get": { "summary": "Account Balance", "deprecated": false, "description": "", "tags": [ "Account" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/ApiStatus" }, "message": { "$ref": "#/components/schemas/ApiMessage" }, "data": { "type": "object", "properties": { "balanceAmount": { "type": "integer" }, "balanceCount": { "type": "integer" }, "details": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "description": "تعداد پیامک" }, "rate": { "type": "integer", "description": "تعرفه پیامک" }, "amount": { "type": "integer", "description": "موجودی تومانی" } }, "required": [ "count", "rate", "amount" ], "x-apidog-orders": [ "count", "rate", "amount" ], "x-apidog-ignore-properties": [ ] } } }, "required": [ "balanceAmount", "balanceCount", "details" ], "x-apidog-orders": [ "balanceAmount", "balanceCount", "details" ], "x-apidog-ignore-properties": [ ] } }, "required": [ "status", "message", "data" ], "x-apidog-orders": [ "status", "message", "data" ], "x-apidog-ignore-properties": [ ] }, "example": { "status": "success", "message": null, "data": { "balanceAmount": 5000, "balanceCount": 25, "details": [ { "count": 25, "rate": 200, "amount": 5000 } ] } } } }, "headers": { }, "x-apidog-name": "Success" }, "401": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "null" }, "message": { "$ref": "#/components/schemas/ApiMessage" } }, "required": [ "status", "data", "message" ], "x-apidog-orders": [ "status", "data", "message" ], "x-apidog-ignore-properties": [ ] }, "example": { "status": "error", "data": null, "message": "Unauthorized" } } }, "headers": { }, "x-apidog-name": "Unauthorized" } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Account", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-13717911-run", "x-folder": "Account" } }, "/ws/v1/phone_book_data/bulk-upsert": { "post": { "summary": "Add Bulk Contact", "deprecated": false, "description": "It used to import contacts to a phonebook with an {Object}.\nMax contacts can add by Object is 500 in each reques.", "tags": [ "Phonebook/Contacts" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": true, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { } }, "example": "{\r\n \"phone_book_id\": 86292,\r\n \"items\": [\r\n {\r\n \"prefix\": \"man\", // man | woman | co | org\r\n \"mobile\": \"09123456781\",\r\n \"name\": \"test name\",\r\n \"attributes\": [\r\n {\r\n \"attribute_id\": 2,\r\n \"value\": \"2061207342\"\r\n },\r\n {\r\n \"attribute_id\": 3,\r\n \"value\": \"test\"\r\n }\r\n ]\r\n }\r\n ]\r\n}" } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "Success" } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Phonebook/Contacts", "x-apidog-status": "developing", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-34585784-run", "x-folder": "Phonebook/Contacts" } }, "/ws/v1/phone_book_data/excel-upsert": { "post": { "summary": "Add Excel Contact", "deprecated": false, "description": "It 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.", "tags": [ "Phonebook/Contacts" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": true, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "phone_book_id": { "type": "integer", "example": 86292 }, "file": { "format": "binary", "type": "string", "example": "cmMtdXBsb2FkLTE3Nzc3MDA2ODEyOTktMg==/updated_excel_file (7).xlsx" } } }, "examples": { } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "Success" } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Phonebook/Contacts", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-34615972-run", "x-folder": "Phonebook/Contacts" } }, "/ws/v1/phone_book_data": { "post": { "summary": "Add New Contact", "deprecated": false, "description": "", "tags": [ "Phonebook/Contacts" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": true, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { } }, "example": "{\r\n \"phone_book_id\": 33,\r\n \"phone_book_data_id\": 1, // needed only when updating mobile\r\n \"prefix\": \"man\", // man | woman | co | org\r\n \"mobile\": \"09123456781\",\r\n \"name\": \"test name\",\r\n \"attributes\": [\r\n {\r\n \"attribute_id\": 5,\r\n \"value\": \"1378/01/24\"\r\n },\r\n {\r\n \"attribute_id\": 8,\r\n \"value\": \"Tehran\"\r\n }\r\n ]\r\n}" } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "Success" } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Phonebook/Contacts", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-23655867-run", "x-folder": "Phonebook/Contacts" }, "get": { "summary": "Get Phonebook Contacts", "deprecated": false, "description": "Get paged phonebook data for a specific phonebook", "tags": [ "Phonebook/Contacts" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 10 } }, { "name": "phone_book_id", "in": "query", "description": "The phonebook Id", "required": false, "example": 1, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "description": "Search parameter", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultPagedPhonebookData" } } }, "headers": { }, "x-apidog-name": "Phonebook data retrieved successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Phonebook/Contacts", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-13925175-run", "x-folder": "Phonebook/Contacts" } }, "/ws/v1/orders/apply-discount": { "post": { "summary": "Apply Discount on Order", "deprecated": false, "description": "", "tags": [ "Orders" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "orderId": { "type": "string", "examples": [ "18" ], "example": "18" }, "discountCode": { "type": "string", "examples": [ "test" ], "example": "test" } } }, "examples": { } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "" } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Orders", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-25851396-run", "x-folder": "Orders" } }, "/ws/v1/sms/calculate-cost": { "post": { "summary": "Send Postal Code SMS", "deprecated": false, "description": "", "tags": [ "Send/PostalCode" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string" }, "number_format": { "type": "string", "enum": [ "english", "persian" ], "x-apidog-enum": [ { "value": "english", "name": "english", "description": "" }, { "value": "persian", "name": "persian", "description": "" } ] }, "line_id": { "type": "integer" }, "schedule": { "type": "string", "format": "date-time", "nullable": true }, "filters": { "type": "array", "items": { "type": "object", "properties": { "postal_code": { "type": "string", "minLength": 100, "maxLength": 99999 }, "gender_id": { "type": "integer" }, "age_from": { "type": "integer", "minimum": 1300 }, "age_to": { "type": "integer", "maximum": 1500 }, "number_prefix": { "type": "string", "examples": [ "912" ], "nullable": true }, "operator": { "type": "string", "enum": [ "mci", "irancell", "other" ], "x-apidog-enum": [ { "value": "mci", "name": "mci", "description": "" }, { "value": "irancell", "name": "irancell", "description": "" }, { "value": "other", "name": "other", "description": "" } ], "nullable": true }, "row_from": { "type": "integer" }, "row_count": { "type": "integer" } }, "x-apidog-orders": [ "postal_code", "gender_id", "age_from", "age_to", "number_prefix", "operator", "row_from", "row_count" ], "required": [ "postal_code", "gender_id", "age_from", "age_to", "number_prefix", "operator", "row_from", "row_count" ] } } }, "x-apidog-orders": [ "filters", "text", "line_id", "number_format", "schedule" ], "required": [ "text", "line_id", "number_format", "schedule", "filters" ] }, "example": "{\n \"filters\": [\n {\n \"postal_code\": \"12345\", // first [3,4,5] digit of postal code\n \"gender_id\": 1,\n \"age_from\": 1305,\n \"age_to\": 1310,\n \"number_prefix\": \"912\", // nullable\n \"operator\": \"mci\", // mci,irancell,other\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}" } } }, "responses": { "401": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "null" } }, "required": [ "status", "message", "data" ], "x-apidog-orders": [ "status", "message", "data" ] } } }, "headers": { }, "x-apidog-name": "" } }, "security": [ ], "x-apidog-folder": "Send/PostalCode", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-31206192-run", "x-folder": "Send/PostalCode" } }, "/ws/v1/sms/voice/upload-file": { "post": { "summary": "Upload Voice Message File", "deprecated": false, "description": "", "tags": [ "Send/VoiceMessage" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "format": "binary", "type": "string", "example": "" } }, "required": [ "file" ] }, "examples": { } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultNumber" } } }, "headers": { }, "x-apidog-name": "SMS request is enqueued successfully." } }, "security": [ ], "x-apidog-folder": "Send/VoiceMessage", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-31202956-run", "x-folder": "Send/VoiceMessage" } }, "/ws/v1/orders/cancel": { "post": { "summary": "Cancel an Order", "deprecated": false, "description": "", "tags": [ "Orders" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "orderId": { "type": "string", "examples": [ "1" ], "example": "1" } } }, "examples": { } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "" } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Orders", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-25851397-run", "x-folder": "Orders" } }, "/ws/v1/lbs/{lbsId}/cancel": { "patch": { "summary": "Cancel LBS Request", "deprecated": false, "description": "", "tags": [ "Send/LBS" ], "parameters": [ { "name": "lbsId", "in": "path", "description": "", "required": true, "example": "1", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "401": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "null" } }, "required": [ "status", "message", "data" ], "x-apidog-orders": [ "status", "message", "data" ] } } }, "headers": { }, "x-apidog-name": "" } }, "security": [ { "bearer": [ ], "x-apidog": { "required": true, "schemeGroups": [ { "id": "xxe-fnrU-82MmiX4d8g6d", "schemeIds": [ "bearer" ] } ], "use": { "id": "xxe-fnrU-82MmiX4d8g6d" } } } ], "x-apidog-folder": "Send/LBS", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-25851394-run", "x-folder": "Send/LBS" } }, "/ws/v1/account/wallet/charge": { "post": { "summary": "Charge wallet", "deprecated": false, "description": "", "tags": [ "Account" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] }, "example": { "amount": 100000, "redirectUrl": "https://test.com/test" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "OK" } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Account", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-23341923-run", "x-folder": "Account" } }, "/ws/v1/ticket/closed": { "post": { "summary": "Close Ticket", "deprecated": false, "description": "", "tags": [ "Tickets" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ticket_id": { "type": "integer" } }, "x-apidog-orders": [ "ticket_id" ], "required": [ "ticket_id" ] }, "examples": { } } } }, "responses": { "401": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "null" } }, "required": [ "status", "message", "data" ], "x-apidog-orders": [ "status", "message", "data" ] } } }, "headers": { }, "x-apidog-name": "" } }, "security": [ { "apikey-header-Api-Key": [ ], "x-apidog": { "required": true, "schemeGroups": [ { "id": "xxe-fnrU-82MmiX4d8g6d", "schemeIds": [ "apikey-header-Api-Key" ] } ], "use": { "id": "xxe-fnrU-82MmiX4d8g6d" } } } ], "x-apidog-folder": "Tickets", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-31114017-run", "x-folder": "Tickets" } }, "/ws/v1/lbs": { "post": { "summary": "Create New LBS Request", "deprecated": false, "description": "", "tags": [ "Send/LBS" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] }, "example": "{\r\n \"text\": \"test text\",\r\n \"start_time\": 1742773823,\r\n \"end_time\": 1742774823,\r\n \"receiver_count\": 6000,\r\n \"latitude\": 45,\r\n \"longitude\": 90,\r\n \"radius\": 1000,\r\n \"address\": \"some address\",\r\n \"dispatch_moment\": \"حضور\", // 'ورود', 'حضور', 'خروج'\r\n \"receiver_gender\": \"آقا\", // 'همه', 'آقا', 'خانم'\r\n \"receiver_age_from\": 12,\r\n \"receiver_age_to\": 90,\r\n \"device\": \"Android\", // 'همه', 'Android', 'IOS'\r\n}" } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "" } }, "security": [ { "bearer": [ ], "x-apidog": { "required": true, "schemeGroups": [ { "id": "XWg_YarP9jbaqoHQeu0Lo", "schemeIds": [ "bearer" ] } ], "use": { "id": "XWg_YarP9jbaqoHQeu0Lo" } } } ], "x-apidog-folder": "Send/LBS", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-25851390-run", "x-folder": "Send/LBS" }, "get": { "summary": "Get LBS Requests List", "deprecated": false, "description": "", "tags": [ "Send/LBS" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "401": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "null" } }, "required": [ "status", "message", "data" ], "x-apidog-orders": [ "status", "message", "data" ] } } }, "headers": { }, "x-apidog-name": "" } }, "security": [ { "bearer": [ ], "x-apidog": { "required": true, "schemeGroups": [ { "id": "rrEUm8r20jlegQsHsH4Y3", "schemeIds": [ "bearer" ] } ], "use": { "id": "rrEUm8r20jlegQsHsH4Y3" } } } ], "x-apidog-folder": "Send/LBS", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-25851391-run", "x-folder": "Send/LBS" } }, "/ws/v1/patterns": { "post": { "summary": "Create New Pattern", "deprecated": false, "description": "Create a new pattern with API", "tags": [ "Patterns" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string" }, "description": { "description": "nullable", "type": "string" }, "share": { "description": "boolean", "type": "integer" }, "website": { "type": "string" }, "category": { "description": "1 = otp, 2 = club, 3 = order, 255 = others", "type": "integer" }, "vars": { "type": "array", "items": { "type": "object", "properties": { "var": { "type": "string" }, "length": { "type": "integer" }, "type": { "description": "int, str, date", "type": "string" } }, "required": [ "var", "length", "type" ], "x-apidog-orders": [ "var", "length", "type" ], "x-apidog-ignore-properties": [ ] } } }, "required": [ "text", "description", "share", "website", "category", "vars" ], "x-apidog-orders": [ "text", "description", "share", "website", "category", "vars" ], "x-apidog-ignore-properties": [ ] }, "example": "{\r\n \"text\": \"test text %var%, %var2%\",\r\n \"description\": \"test desc\", // nullable\r\n \"share\": 1, // boolean\r\n \"website\": \"example.com\",\r\n \"category\": 1, // 1 = otp, 2 = club, 3 = order, 255 = others\r\n \"vars\": [\r\n {\r\n \"var\": \"var\",\r\n \"length\": 12,\r\n \"type\": \"int\" // int, str, date\r\n },\r\n {\r\n \"var\": \"var2\",\r\n \"length\": 12,\r\n \"type\": \"int\" // int, str, date\r\n }\r\n ]\r\n}" } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultString" } } }, "headers": { }, "x-apidog-name": "Pattern created successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Patterns", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-13925176-run", "x-folder": "Patterns" }, "get": { "summary": "Get List of User's Patterns", "deprecated": false, "description": "", "tags": [ "Patterns" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatternRequestDto" }, "example": "{\r\n \"search\": \"\", // nullable|string\r\n \"staus\": \"active\", // nullable|in:pending,rejected,active\r\n \"share\": 1, // 'nullable|boolean'\r\n \"sort_by\": \"updated_at\", // 'nullable|string|in:created_at,updated_at'\r\n \"sort_type\": \"desc\", // 'nullable|string|in:asc,desc'\r\n}" } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultString" } } }, "headers": { }, "x-apidog-name": "Pattern created successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Patterns", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-21747971-run", "x-folder": "Patterns" } }, "/ws/v1/phone_book": { "post": { "summary": "Create New Phonebook", "deprecated": false, "description": "", "tags": [ "Phonebook" ], "parameters": [ ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhonebookCreateRequestDto" }, "example": "{\r\n \"title\": \"test title\",\r\n \"attributes\": [2] // nullable\r\n}" } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultNumber" } } }, "headers": { }, "x-apidog-name": "Phonebook created successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Phonebook", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-13925172-run", "x-folder": "Phonebook" }, "get": { "summary": "Get Phonebooks", "deprecated": false, "description": "Get paged list of phonebooks", "tags": [ "Phonebook" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 10 } }, { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultPagedPhonebook" } } }, "headers": { }, "x-apidog-name": "Phonebooks retrieved successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Phonebook", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-13925171-run", "x-folder": "Phonebook" } }, "/ws/v1/phone_book_attribute": { "post": { "summary": "Create New Phonebook Attribute", "deprecated": false, "description": "Create a new phonebook attribute like birthdate, national code and etc", "tags": [ "Phonebook/Attrebutes" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhonebookAttributeCreateRequestDto" }, "example": "{\r\n \"title\": \"test attribute\",\r\n \"type\": \"string\" // date | number | string\r\n}" } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultNumber" } } }, "headers": { }, "x-apidog-name": "Phonebook attribute created successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Phonebook/Attrebutes", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-13925174-run", "x-folder": "Phonebook/Attrebutes" }, "get": { "summary": "Get Phonebook Attributes", "deprecated": false, "description": "Get paged list of phonebook attributes", "tags": [ "Phonebook/Attrebutes" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 10 } }, { "name": "type", "in": "query", "description": "date | number | string", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultPagedPhonebookAttribute" } } }, "headers": { }, "x-apidog-name": "Phonebook attributes retrieved successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Phonebook/Attrebutes", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-13925173-run", "x-folder": "Phonebook/Attrebutes" } }, "/ws/v1/ticket": { "post": { "summary": "Create New Ticket", "deprecated": false, "description": "", "tags": [ "Tickets" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "support_department_id": { "example": "", "type": "string" }, "title": { "example": "", "type": "string" }, "importance": { "description": "less_important | normal | important | very_important", "example": "", "type": "string" }, "question": { "example": "", "type": "string" }, "files": { "format": "binary", "type": "string", "example": "" } }, "required": [ "support_department_id", "title", "importance", "question" ] }, "examples": { } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "" } }, "security": [ { "apikey-header-Api-Key": [ ], "x-apidog": { "required": true, "schemeGroups": [ { "id": "XWg_YarP9jbaqoHQeu0Lo", "schemeIds": [ "apikey-header-Api-Key" ] } ], "use": { "id": "XWg_YarP9jbaqoHQeu0Lo" } } } ], "x-apidog-folder": "Tickets", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-31114014-run", "x-folder": "Tickets" }, "get": { "summary": "Get List of Tickets", "deprecated": false, "description": "", "tags": [ "Tickets" ], "parameters": [ { "name": "search", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "pending | referred | closed | asked | answered", "required": false, "schema": { "type": "string" } }, { "name": "support_department_id", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "401": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "null" } }, "required": [ "status", "message", "data" ], "x-apidog-orders": [ "status", "message", "data" ] } } }, "headers": { }, "x-apidog-name": "" } }, "security": [ { "apikey-header-Api-Key": [ ], "x-apidog": { "required": true, "schemeGroups": [ { "id": "rrEUm8r20jlegQsHsH4Y3", "schemeIds": [ "apikey-header-Api-Key" ] } ], "use": { "id": "rrEUm8r20jlegQsHsH4Y3" } } } ], "x-apidog-folder": "Tickets", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-31114013-run", "x-folder": "Tickets" } }, "/ws/v1/phone_book_data/{id}": { "delete": { "summary": "Delete Contact", "deprecated": false, "description": "", "tags": [ "Phonebook/Contacts" ], "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "Success" } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Phonebook/Contacts", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-23696624-run", "x-folder": "Phonebook/Contacts" } }, "/ws/v1/ticket/file/download": { "get": { "summary": "Download Ticket Attached File", "deprecated": false, "description": "", "tags": [ "Tickets" ], "parameters": [ { "name": "ticket_message_id", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "file_index", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "401": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "null" } }, "required": [ "status", "message", "data" ], "x-apidog-orders": [ "status", "message", "data" ] } } }, "headers": { }, "x-apidog-name": "" } }, "security": [ { "apikey-header-Api-Key": [ ], "x-apidog": { "required": true, "schemeGroups": [ { "id": "rrEUm8r20jlegQsHsH4Y3", "schemeIds": [ "apikey-header-Api-Key" ] } ], "use": { "id": "rrEUm8r20jlegQsHsH4Y3" } } } ], "x-apidog-folder": "Tickets", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-31200021-run", "x-folder": "Tickets" } }, "/ws/v1/sms/voice/download-file": { "get": { "summary": "Download Uploded Voice Message File", "deprecated": false, "description": "", "tags": [ "Send/VoiceMessage" ], "parameters": [ { "name": "file_id", "in": "query", "description": "", "required": true, "example": 1, "schema": { "type": "integer" } }, { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "401": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "null" } }, "required": [ "status", "message", "data" ], "x-apidog-orders": [ "status", "message", "data" ] } } }, "headers": { }, "x-apidog-name": "" } }, "security": [ { "apikey-header-Api-Key": [ ], "x-apidog": { "required": true, "schemeGroups": [ { "id": "rrEUm8r20jlegQsHsH4Y3", "schemeIds": [ "apikey-header-Api-Key" ] } ], "use": { "id": "rrEUm8r20jlegQsHsH4Y3" } } } ], "x-apidog-folder": "Send/VoiceMessage", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-31202797-run", "x-folder": "Send/VoiceMessage" } }, "/ws/v1/lbs/{lbsId}": { "put": { "summary": "Edit LBS Request", "deprecated": false, "description": "", "tags": [ "Send/LBS" ], "parameters": [ { "name": "lbsId", "in": "path", "description": "", "required": true, "example": "5", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] }, "example": "{\r\n \"text\": \"test text\",\r\n \"start_time\": 1742773823,\r\n \"end_time\": 1742774823,\r\n \"receiver_count\": 10000,\r\n \"latitude\": 45,\r\n \"longitude\": 90,\r\n \"radius\": 1000,\r\n \"address\": \"some address\",\r\n \"dispatch_moment\": \"حضور\", // 'ورود', 'حضور', 'خروج'\r\n \"receiver_gender\": \"مرد\", // 'همه', 'مرد', 'زن'\r\n \"receiver_age_from\": 12,\r\n \"receiver_age_to\": 90,\r\n \"device\": \"Android\", // 'همه', 'Android', 'IOS'\r\n}" } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "" } }, "security": [ { "bearer": [ ], "x-apidog": { "required": true, "schemeGroups": [ { "id": "wOw_MDv1_uOmvvCPwwv92", "schemeIds": [ "bearer" ] } ], "use": { "id": "wOw_MDv1_uOmvvCPwwv92" } } } ], "x-apidog-folder": "Send/LBS", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-25851393-run", "x-folder": "Send/LBS" }, "get": { "summary": "Show Single LBS Request Details", "deprecated": false, "description": "", "tags": [ "Send/LBS" ], "parameters": [ { "name": "lbsId", "in": "path", "description": "", "required": true, "example": "1", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "401": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "null" } }, "required": [ "status", "message", "data" ], "x-apidog-orders": [ "status", "message", "data" ] } } }, "headers": { }, "x-apidog-name": "" } }, "security": [ { "bearer": [ ], "x-apidog": { "required": true, "schemeGroups": [ { "id": "oOoEM0tFmpyjk38Us2Lrq", "schemeIds": [ "bearer" ] } ], "use": { "id": "oOoEM0tFmpyjk38Us2Lrq" } } } ], "x-apidog-folder": "Send/LBS", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-25851392-run", "x-folder": "Send/LBS" } }, "/ws/v1/patterns/{code}": { "put": { "summary": "Edit Pattern", "deprecated": false, "description": "", "tags": [ "Patterns" ], "parameters": [ { "name": "code", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatternRequestDto" }, "example": "{\r\n \"text\": \"test text %var%, %var2%\",\r\n \"description\": \"test desc\", // nullable\r\n \"share\": 1, // boolean\r\n \"website\": \"example.com\",\r\n \"vars\": [\r\n {\r\n \"var\": \"var\",\r\n \"length\": 12,\r\n \"type\": \"int\" // int, str, date\r\n },\r\n {\r\n \"var\": \"var2\",\r\n \"length\": 12,\r\n \"type\": \"int\" // int, str, date\r\n }\r\n ]\r\n}" } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultString" } } }, "headers": { }, "x-apidog-name": "Pattern created successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Patterns", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-21747970-run", "x-folder": "Patterns" }, "get": { "summary": "Get Pattern Details", "deprecated": false, "description": "This endpoint help to get a pattern by its \"code\"", "tags": [ "Patterns" ], "parameters": [ { "name": "code", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatternRequestDto" }, "example": "" } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultString" } } }, "headers": { }, "x-apidog-name": "Pattern created successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Patterns", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-16297027-run", "x-folder": "Patterns" } }, "/ws/v1/sms/postal/get-available-lines": { "get": { "summary": "Get Available Lines", "deprecated": false, "description": "", "tags": [ "Send/PostalCode" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "401": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "null" } }, "required": [ "status", "message", "data" ], "x-apidog-orders": [ "status", "message", "data" ] } } }, "headers": { }, "x-apidog-name": "" } }, "security": [ { "apikey-header-Api-Key": [ ], "x-apidog": { "required": true, "schemeGroups": [ { "id": "rrEUm8r20jlegQsHsH4Y3", "schemeIds": [ "apikey-header-Api-Key" ] } ], "use": { "id": "rrEUm8r20jlegQsHsH4Y3" } } } ], "x-apidog-folder": "Send/PostalCode", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-31205874-run", "x-folder": "Send/PostalCode" } }, "/example/phone-book/{phone_book}/data.xlsx": { "get": { "summary": "Get Bulk Excel Sample", "deprecated": false, "description": "This endpoint used to get an Excel sample file for each phonebook by its ID.", "tags": [ "Phonebook/Contacts" ], "parameters": [ { "name": "phone_book", "in": "path", "description": "", "required": true, "example": "1", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "", "required": true, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "Success" } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Phonebook/Contacts", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-34610017-run", "x-folder": "Phonebook/Contacts" } }, "/cities": { "get": { "summary": "Get Cities List of Provinces", "deprecated": false, "description": "", "tags": [ "GEO" ], "parameters": [ { "name": "province_id", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "has_any_banks", "in": "query", "description": "If send as TRUE, only banks with at least ONE namber bank returned.", "required": false, "schema": { "type": "boolean" } }, { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultPagedPhonebook" } } }, "headers": { }, "x-apidog-name": "Phonebooks retrieved successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "GEO", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-31200787-run", "x-folder": "GEO" } }, "/ws/v1/sms/postal/get-genders": { "get": { "summary": "Get Genders List", "deprecated": false, "description": "", "tags": [ "Send/PostalCode" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "401": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "null" } }, "required": [ "status", "message", "data" ], "x-apidog-orders": [ "status", "message", "data" ] } } }, "headers": { }, "x-apidog-name": "" } }, "security": [ ], "x-apidog-folder": "Send/PostalCode", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-31283518-run", "x-folder": "Send/PostalCode" } }, "/ws/v1/number_bank": { "get": { "summary": "Get List of Avalibale Banks", "deprecated": false, "description": "", "tags": [ "Send/NumberBank " ], "parameters": [ { "name": "province_id", "in": "query", "description": "", "required": true, "schema": { "type": "integer" } }, { "name": "city_id", "in": "query", "description": "", "required": true, "schema": { "type": "integer" } }, { "name": "search", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "include_public_banks", "in": "query", "description": "If send as TRUE, IranPyamak public number bank returned too", "required": false, "schema": { "type": "boolean" } }, { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultPagedPhonebook" } } }, "headers": { }, "x-apidog-name": "Phonebooks retrieved successfully." } }, "security": [ ], "x-apidog-folder": "Send/NumberBank ", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-31200901-run", "x-folder": "Send/NumberBank " } }, "/ws/v1/inbox": { "get": { "summary": "Get Paged Inbox Messages", "deprecated": false, "description": "", "tags": [ ], "parameters": [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 10 } }, { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultPagedInbox" } } }, "headers": { }, "x-apidog-name": "Inbox messages retrieved successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-13925178-run", "x-folder": "" } }, "/provinces": { "get": { "summary": "Get Provinces List", "deprecated": false, "description": "", "tags": [ "GEO" ], "parameters": [ { "name": "has_any_banks", "in": "query", "description": "If send as TRUE, only banks with at least ONE namber bank returned.", "required": false, "schema": { "type": "boolean" } }, { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultPagedPhonebook" } } }, "headers": { }, "x-apidog-name": "Phonebooks retrieved successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "GEO", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-31200409-run", "x-folder": "GEO" } }, "/ws/v1/sms/postal/get-receiver-count": { "get": { "summary": "Get Receiver Counts", "deprecated": false, "description": "", "tags": [ "Send/PostalCode" ], "parameters": [ { "name": "postal_code", "in": "query", "description": "First [3,4,5] digit of postal code", "required": true, "schema": { "type": "string", "minLength": 100, "maxLength": 99999 } }, { "name": "gender_id", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "age_from", "in": "query", "description": "", "required": true, "example": "1300", "schema": { "type": "string", "default": "1300" } }, { "name": "age_to", "in": "query", "description": "", "required": true, "example": "1400", "schema": { "type": "string", "default": "1400" } }, { "name": "number_prefix", "in": "query", "description": "", "required": false, "example": "912", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "401": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "null" } }, "required": [ "status", "message", "data" ], "x-apidog-orders": [ "status", "message", "data" ] } } }, "headers": { }, "x-apidog-name": "" } }, "security": [ ], "x-apidog-folder": "Send/PostalCode", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-31205984-run", "x-folder": "Send/PostalCode" } }, "/ws/v1/send_request/{send_request_id}/items": { "get": { "summary": "Get Send Request Items", "deprecated": false, "description": "Get paged list of phonebooks", "tags": [ "Send Requests" ], "parameters": [ { "name": "send_request_id", "in": "path", "description": "", "required": true, "example": "407328", "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "not-started | in-queue | sent | send-failure | delivered | delivery-failure | delivery-undetermined | system-error | blacklist", "required": false, "example": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer" } }, { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultPagedPhonebook" } } }, "headers": { }, "x-apidog-name": "Phonebooks retrieved successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Send Requests", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-27724811-run", "x-folder": "Send Requests" } }, "/ws/v1/send_request": { "get": { "summary": "Get Send Requests", "deprecated": false, "description": "Get paged list of phonebooks", "tags": [ "Send Requests" ], "parameters": [ { "name": "search", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "init | pending-approval | insufficient-balance | cancelled | rejected | in-queue | sent", "required": false, "schema": { "type": "string" } }, { "name": "line_id", "in": "query", "description": "", "required": false, "example": 0, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer" } }, { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultPagedPhonebook" } } }, "headers": { }, "x-apidog-name": "Phonebooks retrieved successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Send Requests", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-27724579-run", "x-folder": "Send Requests" } }, "/ws/v1/lines/accessible": { "get": { "summary": "Lines", "deprecated": false, "description": "", "tags": [ "Account" ], "parameters": [ { "name": "search", "in": "query", "description": "", "required": false, "example": "0210000000", "schema": { "type": "string" } }, { "name": "is_dedicated", "in": "query", "description": "", "required": false, "example": "1", "schema": { "type": "boolean" } }, { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "OK" } }, "security": [ { "bearer": [ ], "x-apidog": { "required": true, "schemeGroups": [ { "id": "Y5FiB-47DZMc_agIH_b8r", "schemeIds": [ "bearer" ] } ], "use": { "id": "Y5FiB-47DZMc_agIH_b8r" } } } ], "x-apidog-folder": "Account", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-27039797-run", "x-folder": "Account" } }, "/ws/v1/auth/login": { "post": { "summary": "Login", "deprecated": false, "description": "", "tags": [ "Auth" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { } }, "example": "{\r\n \"username\": \"فراز اس ام اس\",\r\n \"password\": \"1272893596\",\r\n \"method\": null // nullable, sms | ga\r\n}" } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "Success" } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Auth", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-24945813-run", "x-folder": "Auth" } }, "/ws/v1/auth/logout": { "post": { "summary": "Logout", "deprecated": false, "description": "", "tags": [ "Auth" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "Success" } }, "security": [ { "bearer": [ ] } ], "x-apidog-folder": "Auth", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-24946032-run", "x-folder": "Auth" } }, "/ws/v1/orders/pay": { "post": { "summary": "Pay Created Order", "deprecated": false, "description": "", "tags": [ "Orders" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "orderId": { "type": "string", "examples": [ "2" ], "example": "2" }, "paymentSource": { "description": "wallet | gateway | partialGatewayAndWallet", "type": "string", "examples": [ "gateway" ], "example": "gateway" }, "redirectUrl": { "description": "nullable", "type": "string", "examples": [ "https://test.com" ], "example": "https://test.com" } } }, "examples": { } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "" } }, "security": [ { "bearer": [ ], "x-apidog": { "required": true, "schemeGroups": [ { "id": "R_7RhPXKMfI_PzsG6bW1C", "schemeIds": [ "bearer" ] } ], "use": { "id": "R_7RhPXKMfI_PzsG6bW1C" } } } ], "x-apidog-folder": "Orders", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-25851395-run", "x-folder": "Orders" } }, "/ws/v1/account/profile": { "get": { "summary": "Profile", "deprecated": false, "description": "The Login API allows users to authenticate by providing valid credentials like username and password. It typically returns an access token upon successful authentication.", "tags": [ "Account" ], "parameters": [ ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "object", "properties": { }, "x-apidog-orders": [ ], "x-apidog-ignore-properties": [ ] }, "data": { "type": "object", "properties": { "displayName": { "type": "string", "description": "User fullname or organiztion name" }, "mobile": { "type": "string", "description": "Account owner mobile number" }, "verified": { "type": "boolean", "description": "Account verification status" }, "blocked": { "type": "boolean", "description": "Account suspention status" }, "plan": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "expiryDate": { "type": "string" } }, "required": [ "id", "title" ], "x-apidog-orders": [ "id", "title", "expiryDate" ], "description": "Account plan details like name, and expired date (if exists)", "x-apidog-ignore-properties": [ ] }, "permissions": { "type": "string", "description": "Account permitions ans limitations" } }, "required": [ "displayName", "mobile", "verified", "blocked", "plan", "permissions" ], "x-apidog-orders": [ "displayName", "mobile", "verified", "blocked", "plan", "permissions" ], "x-apidog-ignore-properties": [ ] } }, "required": [ "status", "message", "data" ], "x-apidog-orders": [ "status", "message", "data" ], "x-apidog-ignore-properties": [ ] }, "example": { "status": "success", "message": { }, "data": { "displayName": "فراز اس‌ام‌اس", "mobile": "09XXXXXXXXX", "verified": true, "blocked": false, "plan": { "id": 1, "title": "اسم پکیج", "expiryDate": "2025-02-04T15:41:35.000000Z" }, "permissions": "01ffffffffffffffffff" } } } }, "headers": { }, "x-apidog-name": "Success" }, "401": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "null" }, "message": { "$ref": "#/components/schemas/ApiMessage" } }, "required": [ "status", "data", "message" ], "x-apidog-orders": [ "status", "data", "message" ], "x-apidog-ignore-properties": [ ] }, "example": { "status": "error", "data": null, "message": "Unauthorized" } } }, "headers": { }, "x-apidog-name": "Unauthorized" } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Account", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-13716723-run", "x-folder": "Account" } }, "/ws/v1/account/register": { "post": { "summary": "Register", "deprecated": false, "description": "", "tags": [ "Account" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] }, "example": "{\r\n \"plan_id\": 3,\r\n \"person_type\": \"personal\",\r\n \"username\": \"test_name1\",\r\n \"first_name\": \"test fname\",\r\n \"last_name\": \"test lname\",\r\n \"national_code\": \"1234567890\",\r\n \"mobile\": \"09121234567\",\r\n \"discount_code\": \"test_code\", // nullable\r\n \"seller_id\": 1, // nullable\r\n \"should_notify_user\": true, // nullable(default = true)\r\n \"redirect_url\": \"https://test.com/test\" // nullable\r\n}\r\n" } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "OK" } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Account", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-23342012-run", "x-folder": "Account" } }, "/ws/v1/auth/register": { "post": { "summary": "Register", "deprecated": false, "description": "", "tags": [ "Auth" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { } }, "example": "{\r\n \"plan_id\": 3,\r\n \"person_type\": \"personal\",\r\n \"username\": \"test_name2\",\r\n \"first_name\": \"test fname\",\r\n \"last_name\": \"test lname\",\r\n \"national_code\": \"1234567890\",\r\n \"mobile\": \"09121234567\",\r\n \"discount_code\": \"\", // nullable\r\n \"seller_id\": 1, // nullable\r\n \"should_notify_user\": true, // nullable(default = true)\r\n \"redirect_url\": \"https://test.com/test\" // nullable\r\n}\r\n" } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "Success" } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Auth", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-24945818-run", "x-folder": "Auth" } }, "/ws/v1/ticket/replay": { "post": { "summary": "Replay to Ticket", "deprecated": false, "description": "", "tags": [ "Tickets" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "ticket_id": { "example": "", "type": "string" }, "text": { "example": "", "type": "string" }, "files": { "format": "binary", "type": "string", "example": "" } }, "required": [ "ticket_id", "text" ] }, "examples": { } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "" } }, "security": [ { "apikey-header-Api-Key": [ ], "x-apidog": { "required": true, "schemeGroups": [ { "id": "wOw_MDv1_uOmvvCPwwv92", "schemeIds": [ "apikey-header-Api-Key" ] } ], "use": { "id": "wOw_MDv1_uOmvvCPwwv92" } } } ], "x-apidog-folder": "Tickets", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-31114016-run", "x-folder": "Tickets" } }, "/ws/v1/sms/pattern": { "post": { "summary": "Send Pattern-Based SMS", "deprecated": false, "description": "Send a pattern-based message, the pattern UID must be creadted and get from user panel.", "tags": [ "Send" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatternSendRequestDto" }, "example": "{\r\n \"code\": \"SJ3FgPrE0C\",\r\n \"attributes\": {\r\n \"var1\": \"1\",\r\n \"var2\": \"2\"\r\n },\r\n \"recipient\": \"09120000000\",\r\n \"line_number\": \"50002178584000\",\r\n \"number_format\": \"english\"\r\n //, \"schedule\": \"2025-08-20 15:30:00\" // nullable(chosen time to send)\r\n}" } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultNumber" } } }, "headers": { }, "x-apidog-name": "Pattern message sent successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Send", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-13925177-run", "x-folder": "Send" } }, "/ws/v1/send/peer-to-peer": { "post": { "summary": "Send Peer-to-Peer SMS", "deprecated": false, "description": "Send peer-to-peer messages. Each peer contains different text and recipients. Each peer will generate a separate send request record.", "tags": [ "Send/Peer-to-Peer" ], "parameters": [ ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^[0-9]+$", "description": "The line number which is used to send the SMS.", "examples": [ "500012345" ], "example": "500012345" }, "peers": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "text": { "type": "string", "minLength": 3 }, "recipients": { "type": "array", "minItems": 1, "items": { "type": "string", "pattern": "^09\\d{9}$", "description": "Recipient phone number in the format 09XXXXXXXXX." } } }, "required": [ "text", "recipients" ], "x-apidog-orders": [ "text", "recipients" ], "x-apidog-ignore-properties": [ ] }, "example": "" }, "numberFormat": { "type": "string", "enum": [ "en", "fa" ], "description": "When provided, all numbers within the message will be replace with either English or Persian number characters.", "example": "" }, "schedule": { "type": "string", "format": "date-time", "description": "When provided, the message will be send at the time of schedule. It must be a future time if provided.", "example": "" } }, "required": [ "from", "peers" ] }, "examples": { } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultNumberArray" } } }, "headers": { }, "x-apidog-name": "All SMS requests are enqueued successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Send/Peer-to-Peer", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-13909971-run", "x-folder": "Send/Peer-to-Peer" } }, "/ws/v1/send/peer-to-peer-file": { "post": { "summary": "Send Peer-to-Peer SMS from Excel", "deprecated": false, "description": "Send peer-to-peer messages with file input. Each peer contains different text and recipients. Each peer will generate a separate send request record.", "tags": [ "Send/Peer-to-Peer" ], "parameters": [ ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^[0-9]+$", "description": "Numeric string representing a valid user line.", "examples": [ "500012345" ], "example": "500012345" }, "peers": { "type": "string", "format": "binary", "description": "Excel or CSV file containing peer-to-peer message data. Make sure it matches the example structure.", "example": "" }, "numberFormat": { "type": "string", "enum": [ "en", "fa" ], "description": "When provided, all numbers within the message will be replace with either English or Persian number characters.", "example": "" }, "schedule": { "type": "string", "format": "date-time", "description": "When provided, the message will be send at the time of schedule. It must be a future time if provided.", "example": "" } }, "required": [ "from", "peers" ] }, "examples": { } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultNumberArray" } } }, "headers": { }, "x-apidog-name": "All SMS requests are enqueued successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Send/Peer-to-Peer", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-13909972-run", "x-folder": "Send/Peer-to-Peer" } }, "/ws/v1/sms/sample": { "post": { "summary": "Send Sample SMS", "deprecated": false, "description": "Send a sample of message to the account owner", "tags": [ "Send" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ], "x-apidog-ignore-properties": [ ] }, "example": "{\n \"text\": \"test text\",\n \"line_number\": \"50002178584000\",\n \"number_format\": \"english\",\n //\"schedule\": \"2025-08-20 15:30:00\", // nullable(chosen time to send)\n}" } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultNumber" } } }, "headers": { }, "x-apidog-name": "SMS request is enqueued successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Send", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-13909966-run", "x-folder": "Send" } }, "/ws/v1/sms/simple": { "post": { "summary": "Send Simple SMS from Phonebook", "deprecated": false, "description": "Send a Voice message toward many recipients.\nYou must use at least one of the attrebute {recipients} or {selectedPhoneBooks}.", "tags": [ "Send/Simple" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string" }, "selectedPhoneBooks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" } }, "x-apidog-orders": [ "id", "offset", "limit" ], "required": [ "id", "offset", "limit" ], "x-apidog-ignore-properties": [ ] } }, "line_number": { "type": "string" }, "number_format": { "type": "string", "enum": [ "english", "persian" ], "x-apidog-enum": [ { "value": "english", "name": "english", "description": "" }, { "value": "persian", "name": "persian", "description": "" } ] }, "schedule": { "type": "string", "nullable": true } }, "x-apidog-orders": [ "text", "selectedPhoneBooks", "line_number", "number_format", "schedule" ], "required": [ "text", "line_number", "number_format" ], "x-apidog-ignore-properties": [ ] }, "example": "{\r\n \"text\": \"test message\",\r\n \"selectedPhoneBooks\": [\r\n {\r\n \"id\": 1,\r\n \"offset\": 0,\r\n \"limit\": 10\r\n }\r\n ],\r\n \"line_number\": \"98123123\",\r\n \"number_format\": \"english\",\r\n \"schedule\": \"2026-03-20T10:00:00Z\" // nullable(chosen time to send)\r\n}" } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultNumber" } } }, "headers": { }, "x-apidog-name": "SMS request is enqueued successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Send/Simple", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-31206570-run", "x-folder": "Send/Simple" } }, "/ws/v1/sms/simple-file": { "post": { "summary": "Send Simple SMS from Excel", "deprecated": false, "description": "Send a simple message with recipients from excel file.", "tags": [ "Send/Simple" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "text": { "type": "string", "minLength": 3, "example": "test text" }, "line_number": { "type": "string", "pattern": "^[0-9]+$", "description": "The line number which is used to send the SMS.", "examples": [ "500012345" ], "example": "50002178584000" }, "recipients_file": { "type": "string", "format": "binary", "description": "Excel or CSV file containing recipient phone numbers. Make sure it matches the example structure.", "example": "cmMtdXBsb2FkLTE3NTYzODEzNTcxMzctNQ==/New Microsoft Excel Worksheet.xlsx" }, "number_format": { "type": "string", "enum": [ "en", "fa" ], "description": "When provided, all numbers within the message will be replace with either English or Persian number characters.", "example": "english" }, "schedule": { "type": "string", "format": "date-time", "description": "When provided, the message will be send at the time of schedule. It must be a future time if provided.", "example": "" } }, "required": [ "text", "line_number", "recipients_file" ] }, "examples": { } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultNumber" } } }, "headers": { }, "x-apidog-name": "SMS request is enqueued successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Send/Simple", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-13909968-run", "x-folder": "Send/Simple" } }, "/ws/v1/sms/keywords": { "post": { "summary": "Send SMS with Variables", "deprecated": false, "description": "Send a message containing variable keywords. The keywords (attributes) must be wrapped inside % signs within the text (E.g: Hello %first_name%)", "tags": [ "Send/Variable-Based" ], "parameters": [ ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ], "x-apidog-ignore-properties": [ ] }, "example": "{\r\n \"text\": \"test %var1% text\",\r\n \"line_number\": \"50002178584000\",\r\n \"recipients\": [\r\n {\r\n \"mobile\": \"09120000000\",\r\n \"var1\": \"value1\"\r\n },\r\n {\r\n \"mobile\": \"09130000000\",\r\n \"var1\": \"value2\"\r\n }\r\n ], // array of recipient phone numbers + vars\r\n \"number_format\": \"english\",\r\n // \"schedule\": \"2025-08-20 15:30:00\", // nullable(chosen time to send)\r\n}" } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultNumber" } } }, "headers": { }, "x-apidog-name": "SMS request is enqueued successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Send/Variable-Based", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-13909969-run", "x-folder": "Send/Variable-Based" } }, "/v1/send/keyword-file": { "post": { "summary": "Send SMS with Variables from Excel", "deprecated": false, "description": "Send 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%)", "tags": [ "Send/Variable-Based" ], "parameters": [ ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "text": { "type": "string", "minLength": 3, "example": "" }, "from": { "type": "string", "pattern": "^[0-9]+$", "description": "The line number which is used to send the SMS.", "examples": [ "500012345" ], "example": "500012345" }, "recipients": { "type": "string", "format": "binary", "description": "Excel or CSV file containing recipient data. Make sure it matches the example structure.", "example": "" }, "numberFormat": { "type": "string", "enum": [ "en", "fa" ], "description": "When provided, all numbers within the message will be replace with either English or Persian number characters.", "example": "" }, "schedule": { "type": "string", "format": "date-time", "description": "When provided, the message will be send at the time of schedule. It must be a future time if provided.", "example": "" } }, "required": [ "text", "from", "recipients" ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultNumber" } } }, "headers": { }, "x-apidog-name": "SMS request is enqueued successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Send/Variable-Based", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-13909970-run", "x-folder": "Send/Variable-Based" } }, "/ws/v1/sms/bank": { "post": { "summary": "Send to Number Bank", "deprecated": false, "description": "", "tags": [ "Send/NumberBank " ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string" }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "bank_id": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } }, "x-apidog-orders": [ "bank_id", "limit", "offset" ], "required": [ "bank_id", "limit", "offset" ], "x-apidog-ignore-properties": [ ] } }, "line_number": { "type": "string" }, "number_format": { "type": "string", "enum": [ "english", "persian" ], "x-apidog-enum": [ { "value": "english", "name": "english", "description": "" }, { "value": "persian", "name": "persian", "description": "" } ] }, "schedule": { "type": "string", "nullable": true } }, "x-apidog-orders": [ "text", "recipients", "line_number", "number_format", "schedule" ], "required": [ "text", "line_number", "number_format" ], "x-apidog-ignore-properties": [ ] }, "example": "{\r\n \"text\": \"test message\",\r\n \"recipients\": [\r\n {\r\n \"bank_id\": 1,\r\n \"limit\": 50,\r\n \"offset\": 0\r\n },\r\n {\r\n \"bank_id\": 5,\r\n \"limit\": 100,\r\n \"offset\": 50\r\n }\r\n ],\r\n \"line_number\": \"98123123\",\r\n \"number_format\": \"english\",\r\n \"schedule\": \"2026-03-20T10:00:00Z\" // nullable(chosen time to send)\r\n}" } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultNumber" } } }, "headers": { }, "x-apidog-name": "SMS request is enqueued successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Send/NumberBank ", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-31283521-run", "x-folder": "Send/NumberBank " } }, "/ws/v1/sms/voice/send": { "post": { "summary": "Send Voice Message", "deprecated": false, "description": "Send a Voice message toward many recipients.\nYou must use at least one of the attrebute {recipients} or {selectedPhoneBooks}.", "tags": [ "Send/VoiceMessage" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "file_id": { "type": "integer" }, "recipients": { "type": "array", "items": { "type": "string", "examples": [ "09120000000" ] } }, "selectedPhoneBooks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" } }, "x-apidog-orders": [ "id", "offset", "limit" ], "required": [ "id", "offset", "limit" ], "x-apidog-ignore-properties": [ ] } }, "schedule": { "type": "string", "nullable": true } }, "x-apidog-orders": [ "file_id", "recipients", "selectedPhoneBooks", "schedule" ], "required": [ "file_id" ], "x-apidog-ignore-properties": [ ] }, "example": "{\r\n \"file_id\": 1,\r\n \"recipients\": [\r\n \"09120000000\"\r\n ],\r\n \"selectedPhoneBooks\": [\r\n {\r\n \"id\": 1,\r\n \"offset\": 0,\r\n \"limit\": 10\r\n }\r\n ],\r\n \"schedule\": \"2025-08-20 15:30:00\" // nullable(chosen time to send)\r\n}" } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultNumber" } } }, "headers": { }, "x-apidog-name": "SMS request is enqueued successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Send/VoiceMessage", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-31200965-run", "x-folder": "Send/VoiceMessage" } }, "/ws/v1/auth/show_register_form": { "get": { "summary": "Show Register Form", "deprecated": false, "description": "", "tags": [ "Auth" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "Success" } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Auth", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-24945820-run", "x-folder": "Auth" } }, "/ws/v1/send_request/{send_request_id}": { "get": { "summary": "Show Send Request Details", "deprecated": false, "description": "Get paged list of phonebooks", "tags": [ "Send Requests" ], "parameters": [ { "name": "send_request_id", "in": "path", "description": "", "required": true, "example": "407328", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultPagedPhonebook" } } }, "headers": { }, "x-apidog-name": "Phonebooks retrieved successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Send Requests", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-27724809-run", "x-folder": "Send Requests" } }, "/ws/v1/ticket/{id}": { "get": { "summary": "Show Ticket Conversations", "deprecated": false, "description": "", "tags": [ "Tickets" ], "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "responses": { "401": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "null" } }, "required": [ "status", "message", "data" ], "x-apidog-orders": [ "status", "message", "data" ] } } }, "headers": { }, "x-apidog-name": "" } }, "security": [ { "apikey-header-Api-Key": [ ], "x-apidog": { "required": true, "schemeGroups": [ { "id": "oOoEM0tFmpyjk38Us2Lrq", "schemeIds": [ "apikey-header-Api-Key" ] } ], "use": { "id": "oOoEM0tFmpyjk38Us2Lrq" } } } ], "x-apidog-folder": "Tickets", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-31114015-run", "x-folder": "Tickets" } }, "/ws/v1/account/update": { "post": { "summary": "update", "deprecated": false, "description": "", "tags": [ "Account" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] }, "example": "{\r\n \"first_name\": \"Ali\",\r\n \"last_name\": \"Rezaei\",\r\n \"father_name\": \"Mohammad\",\r\n \"gender\": 1, // 1 = men, 2 = women, 3 = other\r\n \"national_code\": \"1234567890\",\r\n \"national_id\": \"A123456789\",\r\n \"br_date\": 631152000, // Example UNIX timestamp (1990-01-01)\r\n \"live_province_id\": 2,\r\n \"live_city_id\": 20,\r\n \"live_postal_code\": \"1234567890\",\r\n \"fixed_phone\": \"02112345678\",\r\n \"mobile\": \"09121234567\",\r\n \"email\": \"ali.rezaei@example.com\",\r\n \"address\": \"123 Example St, Cityname\",\r\n \"ceo\": {\r\n \"has_ceo\": true,\r\n \"first_name\": \"Sara\",\r\n \"last_name\": \"Ahmadi\",\r\n \"father_name\": \"Hossein\",\r\n \"gender\": 1, // 1 = men, 2 = women, 3 = other\r\n \"br_date\": 599616000, // 1989-01-01\r\n \"mobile\": \"09351234567\",\r\n \"national_id\": \"B987654321\",\r\n \"national_code\": \"9876543210\"\r\n },\r\n \"company\": {\r\n \"name\": \"Example Co\",\r\n \"national_id\": \"1122334455\",\r\n \"registration_id\": \"778899\",\r\n \"economic_id\": \"6655443322\",\r\n \"province_id\": 3,\r\n \"city_id\": 30,\r\n \"address\": \"456 Corporate Ave, Business City\",\r\n \"postal_code\": \"4433221100\",\r\n \"fixed_phone\": \"02187654321\",\r\n \"email\": \"info@exampleco.com\"\r\n }\r\n}" } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "OK" } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Account", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-22119667-run", "x-folder": "Account" } }, "/ws/v1/phone_book/{id}": { "put": { "summary": "Update Phonebook", "deprecated": false, "description": "", "tags": [ "Phonebook" ], "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "example": "44", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhonebookCreateRequestDto" }, "example": "{\r\n \"title\": \"updated title\",\r\n \"attributes\": [1, 3] // nullable\r\n}" } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResultNumber" } } }, "headers": { }, "x-apidog-name": "Phonebook created successfully." } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Phonebook", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-23747776-run", "x-folder": "Phonebook" } }, "/ws/v1/auth/verify-2fa": { "post": { "summary": "Verify 2fa", "deprecated": false, "description": "", "tags": [ "Auth" ], "parameters": [ { "name": "Accept", "in": "header", "description": "", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { } }, "example": "{\r\n \"token\": \"5GOXRzVeN9FSo8Kco6ngUGgUPBnVYRsa\",\r\n \"code\": \"264135\",\r\n \"method\": \"sms\" // nullable, sms | ga\r\n}" } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { }, "x-apidog-orders": [ ] } } }, "headers": { }, "x-apidog-name": "Success" } }, "security": [ { "apikey-header-Api-Key": [ ] } ], "x-apidog-folder": "Auth", "x-apidog-status": "released", "x-run-in-apidog": "https://app.apidog.com/web/project/805827/apis/api-24945819-run", "x-folder": "Auth" } } }, "components": { "schemas": { "ApiMessage": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "array", "items": { "type": "string" }, "title": "", "description": "" }, { "type": "object", "properties": { }, "x-apidog-orders": [ "01JK8TSJRZ3DTPBA5E2ZCVQ7A3" ], "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "minProperties": 1, "title": "", "description": "", "x-apidog-ignore-properties": [ ] } ], "x-apidog-folder": "" }, "ApiStatus": { "type": "string", "enum": [ "success", "error" ], "x-apidog-enum": [ { "value": "success", "name": "", "description": "" }, { "value": "error", "name": "", "description": "" } ], "x-apidog-folder": "" }, "ApiResultNumber": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success", "error" ] }, "data": { "type": "number" }, "messages": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "x-apidog-orders": [ ] } ], "type": "null" } }, "required": [ "status", "data", "messages" ], "x-apidog-orders": [ "status", "data", "messages" ], "x-apidog-folder": "" }, "ApiResultNumberArray": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success", "error" ] }, "data": { "type": "array", "items": { "type": "number" } }, "messages": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "x-apidog-orders": [ ] } ], "type": "null" } }, "required": [ "status", "data", "messages" ], "x-apidog-orders": [ "status", "data", "messages" ], "x-apidog-folder": "" }, "InboxMessage": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^09\\d{9}$" }, "to": { "type": "string", "pattern": "^[0-9]+$", "examples": [ "500012345" ] }, "text": { "type": "string" }, "recievedAt": { "type": "string", "format": "date-time" } }, "required": [ "from", "to", "text", "recievedAt" ], "x-apidog-orders": [ "from", "to", "text", "recievedAt" ], "x-apidog-folder": "" }, "PagedInboxMessages": { "type": "object", "properties": { "currentPage": { "type": "number" }, "totalPages": { "type": "number" }, "totalItems": { "type": "number" }, "itemsPerPage": { "type": "number" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/InboxMessage" } } }, "required": [ "currentPage", "totalPages", "totalItems", "itemsPerPage", "items" ], "x-apidog-orders": [ "currentPage", "totalPages", "totalItems", "itemsPerPage", "items" ], "x-apidog-folder": "" }, "ApiResultPagedInbox": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success", "error" ] }, "data": { "$ref": "#/components/schemas/PagedInboxMessages" }, "messages": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "x-apidog-orders": [ ] } ], "type": "null" } }, "required": [ "status", "data", "messages" ], "x-apidog-orders": [ "status", "data", "messages" ], "x-apidog-folder": "" }, "Phonebook": { "type": "object", "properties": { "id": { "type": "number" }, "title": { "type": "string" }, "records": { "type": "number" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/PhonebookAttribute" } } }, "required": [ "id", "title", "records", "attributes" ], "x-apidog-orders": [ "id", "title", "records", "attributes" ], "x-apidog-folder": "" }, "PhonebookAttribute": { "type": "object", "properties": { "id": { "type": "number" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "date", "number", "string" ] }, "code": { "type": "string" } }, "required": [ "id", "title", "type", "code" ], "x-apidog-orders": [ "id", "title", "type", "code" ], "x-apidog-folder": "" }, "PagedPhonebook": { "type": "object", "properties": { "currentPage": { "type": "number" }, "totalPages": { "type": "number" }, "totalItems": { "type": "number" }, "itemsPerPage": { "type": "number" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Phonebook" } } }, "required": [ "currentPage", "totalPages", "totalItems", "itemsPerPage", "items" ], "x-apidog-orders": [ "currentPage", "totalPages", "totalItems", "itemsPerPage", "items" ], "x-apidog-folder": "" }, "ApiResultPagedPhonebook": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success", "error" ] }, "data": { "$ref": "#/components/schemas/PagedPhonebook" }, "messages": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "x-apidog-orders": [ ] } ], "type": "null" } }, "required": [ "status", "data", "messages" ], "x-apidog-orders": [ "status", "data", "messages" ], "x-apidog-folder": "" }, "PagedPhonebookAttribute": { "type": "object", "properties": { "currentPage": { "type": "number" }, "totalPages": { "type": "number" }, "totalItems": { "type": "number" }, "itemsPerPage": { "type": "number" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PhonebookAttribute" } } }, "required": [ "currentPage", "totalPages", "totalItems", "itemsPerPage", "items" ], "x-apidog-orders": [ "currentPage", "totalPages", "totalItems", "itemsPerPage", "items" ], "x-apidog-folder": "" }, "ApiResultPagedPhonebookAttribute": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success", "error" ] }, "data": { "$ref": "#/components/schemas/PagedPhonebookAttribute" }, "messages": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "x-apidog-orders": [ ] } ], "type": "null" } }, "required": [ "status", "data", "messages" ], "x-apidog-orders": [ "status", "data", "messages" ], "x-apidog-folder": "" }, "PhonebookDataRecord": { "type": "object", "properties": { "id": { "type": "number" }, "prefix": { "type": "string", "enum": [ "man", "woman", "co", "org" ], "nullable": true }, "name": { "type": "string", "nullable": true }, "mobile": { "type": "string", "pattern": "^09\\d{9}$" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/PhonebookDataAttribute" } } }, "required": [ "id", "prefix", "name", "mobile", "attributes" ], "x-apidog-orders": [ "id", "prefix", "name", "mobile", "attributes" ], "x-apidog-folder": "" }, "PhonebookDataAttribute": { "type": "object", "properties": { "id": { "type": "number" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "date", "number", "string" ] }, "code": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "type": "null" } }, "required": [ "id", "title", "type", "code", "value" ], "x-apidog-orders": [ "id", "title", "type", "code", "value" ], "x-apidog-folder": "" }, "PagedPhonebookData": { "type": "object", "properties": { "currentPage": { "type": "number" }, "totalPages": { "type": "number" }, "totalItems": { "type": "number" }, "itemsPerPage": { "type": "number" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PhonebookDataRecord" } } }, "required": [ "currentPage", "totalPages", "totalItems", "itemsPerPage", "items" ], "x-apidog-orders": [ "currentPage", "totalPages", "totalItems", "itemsPerPage", "items" ], "x-apidog-folder": "" }, "ApiResultPagedPhonebookData": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success", "error" ] }, "data": { "$ref": "#/components/schemas/PagedPhonebookData" }, "messages": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "x-apidog-orders": [ ] } ], "type": "null" } }, "required": [ "status", "data", "messages" ], "x-apidog-orders": [ "status", "data", "messages" ], "x-apidog-folder": "" }, "ApiResultString": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success", "error" ] }, "data": { "type": "string" }, "messages": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "x-apidog-orders": [ ] } ], "type": "null" } }, "required": [ "status", "data", "messages" ], "x-apidog-orders": [ "status", "data", "messages" ], "x-apidog-folder": "" }, "PhonebookCreateRequestDto": { "type": "object", "properties": { "title": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "integer" } } }, "required": [ "title" ], "x-apidog-orders": [ "title", "attributes" ], "x-apidog-ignore-properties": [ ], "x-apidog-folder": "" }, "PhonebookAttributeCreateRequestDto": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "type": "string", "enum": [ "date", "number", "string" ] } }, "required": [ "title", "type" ], "x-apidog-orders": [ "title", "type" ], "x-apidog-ignore-properties": [ ], "x-apidog-folder": "" }, "PatternRequestDto": { "type": "object", "properties": { "text": { "type": "string", "minLength": 3 }, "description": { "type": "string" }, "shared": { "type": "boolean" }, "website": { "type": "string", "format": "uri" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/PatternAttribute" } } }, "required": [ "text", "shared", "website" ], "x-apidog-orders": [ "text", "description", "shared", "website", "attributes" ], "x-apidog-ignore-properties": [ ], "x-apidog-folder": "" }, "PatternAttribute": { "type": "object", "properties": { "length": { "type": "integer" }, "name": { "type": "string", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" }, "type": { "type": "string", "enum": [ "integer", "string", "date" ], "default": "string" } }, "required": [ "length", "name" ], "x-apidog-orders": [ "length", "name", "type" ], "x-apidog-ignore-properties": [ ], "x-apidog-folder": "" }, "KeywordFileRequestDto": { "type": "object", "properties": { "text": { "type": "string", "minLength": 3 }, "from": { "type": "string", "pattern": "^[0-9]+$", "description": "The line number which is used to send the SMS.", "examples": [ "500012345" ] }, "recipients": { "type": "string", "format": "binary", "description": "Excel or CSV file containing recipient data. Make sure it matches the example structure." }, "numberFormat": { "type": "string", "enum": [ "en", "fa" ], "description": "When provided, all numbers within the message will be replace with either English or Persian number characters." }, "schedule": { "type": "string", "format": "date-time", "description": "When provided, the message will be send at the time of schedule. It must be a future time if provided." } }, "required": [ "text", "from", "recipients" ], "x-apidog-orders": [ "text", "from", "recipients", "numberFormat", "schedule" ], "x-apidog-folder": "" }, "KeywordRequestDto": { "type": "object", "properties": { "text": { "type": "string", "minLength": 3 }, "attributes": { "type": "array", "minItems": 1, "items": { "type": "string", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" }, "description": "Array of attribute (keyword) names that will be used in the recipient mapping. The keyword names must contain alphanumeric and underscore characters and must not start with a number.", "examples": [ [ "additionalProp1", "additionalProp2", "additionalProp3" ] ] }, "from": { "type": "string", "pattern": "^[0-9]+$", "description": "The line number which is used to send the SMS.", "examples": [ "500012345" ] }, "recipients": { "type": "array", "minItems": 1, "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "plain" ], "default": "plain" }, "number": { "type": "string", "pattern": "^09\\d{9}$", "description": "Recipient phone number in the format 09XXXXXXXXX." }, "attributes": { "type": "object", "description": "Mapping of attribute keys to string values.", "additionalProperties": { "type": "string" }, "x-apidog-orders": [ ], "examples": [ { "additionalProp1": "Ahmad", "additionalProp2": "12345", "additionalProp3": "Mr." } ] } }, "required": [ "number", "attributes" ], "additionalProperties": false, "x-apidog-orders": [ "type", "number", "attributes" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "phonebook" ] }, "phonebookId": { "type": "integer", "format": "int64", "description": "Valid user phonebook ID." } }, "required": [ "type", "phonebookId" ], "additionalProperties": false, "x-apidog-orders": [ "type", "phonebookId" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "phonebook_record" ] }, "phonebookRecordId": { "type": "integer", "format": "int64", "description": "Valid record ID from user phonebooks." } }, "required": [ "type", "phonebookRecordId" ], "additionalProperties": false, "x-apidog-orders": [ "type", "phonebookRecordId" ] } ] } }, "numberFormat": { "type": "string", "enum": [ "en", "fa" ], "description": "When provided, all numbers within the message will be replace with either English or Persian number characters." }, "schedule": { "type": "string", "format": "date-time", "description": "When provided, the message will be send at the time of schedule. It must be a future time if provided." } }, "required": [ "text", "attributes", "from", "recipients" ], "x-apidog-orders": [ "text", "attributes", "from", "recipients", "numberFormat", "schedule" ], "x-apidog-folder": "" }, "PatternSendRequestDto": { "type": "object", "properties": { "code": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "description": "Mapping of pattern attribute names to their string values.", "additionalProperties": { "type": "string" }, "x-apidog-orders": [ "attributes.0" ], "properties": { "attributes.0": { "type": "string" } } } }, "schedule": { "type": "string", "format": "date-time", "description": "Maybe it must be null for patterns" }, "line_number": { "type": "string", "pattern": "^[0-9]+$" }, "number_format": { "type": "string", "enum": [ "en", "fa" ], "description": "english | persian" }, "recipient": { "type": "string", "description": "Like: 09120000000" } }, "required": [ "code", "line_number", "recipient", "number_format" ], "x-apidog-orders": [ "code", "recipient", "attributes", "line_number", "number_format", "schedule" ], "x-apidog-folder": "" }, "PeerToPeerFileRequestDto": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^[0-9]+$", "description": "Numeric string representing a valid user line.", "examples": [ "500012345" ] }, "peers": { "type": "string", "format": "binary", "description": "Excel or CSV file containing peer-to-peer message data. Make sure it matches the example structure." }, "numberFormat": { "type": "string", "enum": [ "en", "fa" ], "description": "When provided, all numbers within the message will be replace with either English or Persian number characters." }, "schedule": { "type": "string", "format": "date-time", "description": "When provided, the message will be send at the time of schedule. It must be a future time if provided." } }, "required": [ "from", "peers" ], "x-apidog-orders": [ "from", "peers", "numberFormat", "schedule" ], "x-apidog-folder": "" }, "PeerToPeerRequestDto": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^[0-9]+$", "description": "The line number which is used to send the SMS.", "examples": [ "500012345" ] }, "peers": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "text": { "type": "string", "minLength": 3 }, "recipients": { "type": "array", "minItems": 1, "items": { "type": "string", "pattern": "^09\\d{9}$", "description": "Recipient phone number in the format 09XXXXXXXXX." } } }, "required": [ "text", "recipients" ], "x-apidog-orders": [ "text", "recipients" ] } }, "numberFormat": { "type": "string", "enum": [ "en", "fa" ], "description": "When provided, all numbers within the message will be replace with either English or Persian number characters." }, "schedule": { "type": "string", "format": "date-time", "description": "When provided, the message will be send at the time of schedule. It must be a future time if provided." } }, "required": [ "from", "peers" ], "x-apidog-orders": [ "from", "peers", "numberFormat", "schedule" ], "x-apidog-folder": "" }, "SelfSampleRequestDto": { "type": "object", "properties": { "text": { "type": "string", "minLength": 3 }, "from": { "type": "string", "pattern": "^[0-9]+$", "description": "The line number which is used to send the SMS.", "examples": [ "500012345" ] }, "numberFormat": { "type": "string", "enum": [ "en", "fa" ], "description": "When provided, all numbers within the message will be replace with either English or Persian number characters." }, "schedule": { "type": "string", "format": "date-time", "description": "When provided, the message will be send at the time of schedule. It must be a future time if provided." } }, "required": [ "text", "from" ], "x-apidog-orders": [ "text", "from", "numberFormat", "schedule" ], "x-apidog-folder": "" }, "SimpleFileRequestDto": { "type": "object", "properties": { "text": { "type": "string", "minLength": 3 }, "from": { "type": "string", "pattern": "^[0-9]+$", "description": "The line number which is used to send the SMS.", "examples": [ "500012345" ] }, "recipients": { "type": "string", "format": "binary", "description": "Excel or CSV file containing recipient phone numbers. Make sure it matches the example structure." }, "numberFormat": { "type": "string", "enum": [ "en", "fa" ], "description": "When provided, all numbers within the message will be replace with either English or Persian number characters." }, "schedule": { "type": "string", "format": "date-time", "description": "When provided, the message will be send at the time of schedule. It must be a future time if provided." } }, "required": [ "text", "from", "recipients" ], "x-apidog-orders": [ "text", "from", "recipients", "numberFormat", "schedule" ], "x-apidog-folder": "" }, "SimpleRequestDto": { "type": "object", "properties": { "text": { "type": "string", "minLength": 3 }, "from": { "type": "string", "pattern": "^[0-9]+$", "description": "The line number which is used to send the SMS.", "examples": [ "500012345" ] }, "recipients": { "type": "array", "minItems": 1, "items": { "type": "string", "pattern": "^09\\d{9}$", "description": "Recipient phone number in the format 09XXXXXXXXX." } }, "numberFormat": { "type": "string", "enum": [ "en", "fa" ], "description": "When provided, all numbers within the message will be replace with either English or Persian number characters." }, "schedule": { "type": "string", "format": "date-time", "description": "When provided, the message will be send at the time of schedule. It must be a future time if provided." } }, "required": [ "text", "from", "recipients" ], "x-apidog-orders": [ "text", "from", "recipients", "numberFormat", "schedule" ], "x-apidog-folder": "" } }, "securitySchemes": { "bearer": { "type": "bearer", "scheme": "bearer" }, "apikey-header-Api-Key": { "type": "apiKey", "in": "header", "name": "Api-Key" } } }, "x-folders": { } }