### Example Request using cURL Source: https://github.com/ippanelcom/edge-document/blob/main/docs/send/countryV2/county.md This cURL command demonstrates how to make a request to the Get Counties API, including necessary headers. ```bash curl --location '{base_url}/v2/api/send/banks/counties?province_id={province_id}' \ --header 'Content-Type: application/json' \ --header 'Authorization: API TOKEN' ' ``` -------------------------------- ### Example cURL Request Source: https://github.com/ippanelcom/edge-document/blob/main/docs/send/jobs/sub-category.md This cURL command demonstrates how to make a GET request to retrieve job sub-categories. Ensure you replace placeholders with your actual base URL and authentication token. ```bash curl --location '{base_url}/api/send/jobs/sub-categories?main_category_id={category_id}' \ --header 'Content-Type: application/json' \ --header 'Authorization: APIKEY OR TOKEN' ``` -------------------------------- ### Example Request using cURL Source: https://github.com/ippanelcom/edge-document/blob/main/docs/send/countryV2/province.md Demonstrates how to make a request to the Get Provinces API using cURL. Ensure to replace 'API TOKEN' with your actual authorization token. ```bash curl --location '{base_url}/v2/api/send/banks/provinces' \ --header 'Content-Type: application/json' \ --header 'Authorization: API TOKEN' ' ``` -------------------------------- ### Example Request Source: https://github.com/ippanelcom/edge-document/blob/main/docs/send/countryV2/count.md This example demonstrates how to call the API using curl to get recipient counts with specified filters. Ensure you replace placeholders like '{base_url}' and 'API TOKEN' with your actual values. ```bash curl --location '{base_url}/v2/api/send/banks/counts?province_id=1&city_id=1&from_age=1304&to_age=1404&gender=1&pre=912' \ --header 'Content-Type: application/json' \ --header 'Authorization: API TOKEN' ``` -------------------------------- ### Example Request using cURL Source: https://github.com/ippanelcom/edge-document/blob/main/docs/report/outbox-report-id.md Demonstrates how to make a GET request to the outbox report endpoint using cURL. Ensure to replace placeholders with actual values. ```bash curl --location --request GET '{base_url}/api/report/by_bulk?messages_outbox_id={messages_outbox_id}' \ --header 'Content-Type: application/json' \ --header 'Authorization: Your Apikey/Token' ``` -------------------------------- ### Example Request using cURL Source: https://github.com/ippanelcom/edge-document/blob/main/docs/user/parents-tree.md Demonstrates how to call the Get Parents Tree API using cURL. Ensure you replace placeholders with your actual token and user ID. ```bash curl --location '{base_url}/api/user/parents_tree?user_id={user_id}' \ --header 'Content-Type: application/json' \ --header 'Authorization: Your Apikey/Token' ``` -------------------------------- ### Example cURL Request Source: https://github.com/ippanelcom/edge-document/blob/main/docs/send/country/city.md Use this cURL command to make a request to the Get Cities API. Ensure you replace placeholders with actual values. ```bash curl --location '{base_url}/api/send/banks/cities?county_id={county_id}' \ --header 'Content-Type: application/json' \ --header 'Authorization: API TOKEN' ' ``` -------------------------------- ### Success Response Example Source: https://github.com/ippanelcom/edge-document/blob/main/docs/package/list-packages.md Example of a successful response when listing packages. Includes package details and pagination metadata. ```json { "data": [ { "acl_role_id": 123, "acl_role_parent_id": 1, "acl_role_name": "package name", "price": 2000000, "special_disc": 20, "min_sms_charge": 0, "time": 1740216700, "user_id": 123, "type": "normal", "acl_type": "user", "status": "active", "priority": null, "expire_time": null, "acl_role_type_registration": "online", "is_transferred": "0", "election": "0", "updated_at": "2025-02-22 09:31:40", "updated_at_man": null }, { "acl_role_id": 123, "acl_role_parent_id": 1, "acl_role_name": "package name", "price": 2000000, "special_disc": 20, "min_sms_charge": 0, "time": 1740216700, "user_id": 123, "type": "normal", "acl_type": "user", "status": "active", "priority": null, "expire_time": null, "acl_role_type_registration": "online", "is_transferred": "0", "election": "0", "updated_at": "2025-02-22 09:31:40", "updated_at_man": null } ], "meta": { "current_page": 1, "from": 1, "last_page": 62, "path": "https://baseurl/api/acl/package/list", "per_page": 2, "to": 1, "total": 62, "status": true, "message": "انجام شد", "message_code": "200-1" } } ``` -------------------------------- ### Example SMS Request with Username/Password Source: https://github.com/ippanelcom/edge-document/blob/main/docs/send/url.md A cURL example demonstrating how to send an SMS using username and password for authentication. ```bash curl -X GET '{base_url}/api/send/webservice?from=+983000505&message=متن پیام&to=+989120000000&username=username&password=password' ``` -------------------------------- ### Success Response Example Source: https://github.com/ippanelcom/edge-document/blob/main/docs/user/check-exist.md Example of a successful response when the username is available for registration. ```json { "data": null, "meta": { "status": true, "message": "این نام کاربری قابل ثبت می باشد", "message_parameters": [], "message_code": "200-1" } } ``` -------------------------------- ### Success Response Example Source: https://github.com/ippanelcom/edge-document/blob/main/docs/auth/check-token.md Example of a successful response when a token is valid. ```json { "data": { "user_name": "ippanel", "user_id": 58745, "document_block": false, "is_reseller": true, "send_block": false, "name": "test" }, "meta": { "status": true, "message": "انجام شد", "message_parameters": [], "message_code": "200-1" } } ``` -------------------------------- ### Success Response Example Source: https://github.com/ippanelcom/edge-document/blob/main/docs/user/show-user.md Example of a successful response when retrieving user details. Includes user data and metadata. ```json { "data": { "status": "active", "time": 1560257010, "uname": "testuser", "document_block": "no", "special_disc": 0, "parent": { "user_id": 1, "uname": "parentusername" }, "user_id": 123456, "accounting_id": null, "is_reseller": "yes", "name": "محمد محمدی", "national_id": "1234569874", "certificate_id": "1234569874", "tell": "+982112345678", "mobile": "9123456789", "address": "تهران، خیابان ولیعصر، پلاک 123", "company": "شرکت تست", "postalcode": 1234567890, "send_block": "no", "email": "test@test.com", "add_status": "normal", "acl_role_id": 1234, "last_login": 1754819326, "confirm": "0", "user_create": "yes", "show_status": "active", "expire_time": null, "user_description": "تست فنی", "description": "تست فنی", "is_bought_panel": "1", "main_parent": "admin", "credit": { "credit": 9071593.719021048, "user_id": 123456 }, "acl_role": { "acl_role_id": 1234, "acl_role_name": "نمایندگی ویژه" }, "parent_id": 1, "need_changing_password": "no" }, "meta": { "status": true, "message": "انجام شد", "message_code": "200-1" } } ``` -------------------------------- ### Example SMS Request with API Key Source: https://github.com/ippanelcom/edge-document/blob/main/docs/send/url.md A cURL example demonstrating how to send an SMS using an API key for authentication. ```bash curl -X GET '{base_url}/api/send/webservice?from=+983000505&message=متن پیام&to=+989120000000&apikey=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' ``` -------------------------------- ### Request Body Example Source: https://github.com/ippanelcom/edge-document/blob/main/docs/report/inbox-report.md Example JSON structure for the request body, including pagination and filters. ```json { "page": 1, "per_page": 10, "filters" : { "from_id":125 } } ``` -------------------------------- ### Example Request for OTP Source: https://github.com/ippanelcom/edge-document/blob/main/docs/auth/forgot-password.md Example cURL command to request an OTP for password reset. Ensure the Content-Type header is set to application/json. ```bash curl --location '{base_url}/api/acl/auth/forgot_password' \ --header 'Content-Type: application/json' \ --data '{ "username":"your-username", "mobile":"your-mobile-number" }' ``` -------------------------------- ### Example Phonebook List Request Source: https://github.com/ippanelcom/edge-document/blob/main/docs/phonebook/phonebook/phonebook-list.md Example cURL command to request the phonebook list, including necessary headers. ```bash curl --location --globoff '{base_url}/api/phonebooks/list-new' \ --header 'Content-Type: application/json' \ --header 'Authorization: Your Apikey/Token' ' ``` -------------------------------- ### Example cURL Request Source: https://github.com/ippanelcom/edge-document/blob/main/docs/auth/check-token.md A cURL command to demonstrate how to call the Check Token endpoint. ```bash curl --location '{base_url}/api/acl/auth/check_token' \ --header 'Content-Type: application/json' \ --header 'Authorization: your-token' ``` -------------------------------- ### Example cURL Request Source: https://github.com/ippanelcom/edge-document/blob/main/docs/send/countryV2/index.md Example of how to send a country SMS using cURL. Ensure to replace 'API TOKEN' with your actual authorization token. ```bash curl --location --globoff '{base_url}/api/send' \ --header 'Content-Type: application/json' \ --header 'Authorization: API TOKEN' \ --data '{ \ "sending_type": "geolocation", \ "from_number": "+98BANK", \ "message": "تست", \ "params": [ \ { \ "province_id": 1, \ "county_id": 2, \ "city_id": 5, \ "pre": "912", \ "gender" : 2, \ "from_age" : 1354, \ "to_age": 1364, \ "operator": [ \ { \ "start": 0, \ "size": 10, \ "id": 1 \ }, \ { \ "start": 0, \ "size": 20, \ "id": 2 \ } \ ] \ } \ ], \ "other_recipients": [ \ "+989121111111", \ "+989351111111" \ ] \ }' ``` -------------------------------- ### Example cURL Request Source: https://github.com/ippanelcom/edge-document/blob/main/docs/send/country/gender.md A cURL command to demonstrate how to request the list of genders from the API. ```bash curl --location '{base_url}/api/send/banks/genders' \ --header 'Content-Type: application/json' \ --header 'Authorization: API TOKEN' ``` -------------------------------- ### Navigate to Site Directory and Start Development Server Source: https://github.com/ippanelcom/edge-document/blob/main/docs/intro.md Change to your new Docusaurus site's directory and run the development server to view your site locally. The site reloads automatically on changes. ```bash cd my-website npm run start ``` -------------------------------- ### Serve Production Build Locally Source: https://github.com/ippanelcom/edge-document/blob/main/docs/tutorial-basics/deploy-your-site.md Use this command to test your production build locally before deploying. The `build` folder will be served at http://localhost:3000/. ```bash npm run serve ``` -------------------------------- ### Example Request using cURL Source: https://github.com/ippanelcom/edge-document/blob/main/docs/user/documents/list-document.md This cURL command demonstrates how to make a request to the User Document List endpoint. ```bash curl --location '{base_url}/api/user/documents' \ --header 'Content-Type: application/json' \ --header 'Authorization: API TOKEN' ``` -------------------------------- ### Create a Docs Version Source: https://github.com/ippanelcom/edge-document/blob/main/docs/tutorial-extras/manage-docs-versions.md Use this command to create a new version of your documentation. This will copy the current docs into a versioned directory and create a versions.json file. ```bash npm run docusaurus docs:version 1.0 ``` -------------------------------- ### Example Request using cURL Source: https://github.com/ippanelcom/edge-document/blob/main/docs/pattern/create-pattern.md This cURL command demonstrates how to send a POST request to create a pattern, including the necessary headers and JSON payload. ```bash curl --location '{base_url}/api/patterns/normal' \ --header 'Content-Type: application/json' \ --header 'Authorization: Your Apikey/Token' \ --data-raw '{ "title": "test pattern", "description": "پترن تستی", "is_share": false, "message": "پترن تستی %var% . کد شما %code%", "variable": [ { "name": "var", "type": "string" }, { "name": "code", "type": "integer" } ] }' ``` -------------------------------- ### Example cURL Request Source: https://github.com/ippanelcom/edge-document/blob/main/docs/user/user-tariff.md This cURL command demonstrates how to make a request to the user tariff endpoint, including necessary headers. ```bash curl --location '{base_url}/api/user/get_tariff' \ --header 'Authorization: Your Apikey' \ --header 'Content-Type: application/json' ``` -------------------------------- ### Example Login Request using cURL Source: https://github.com/ippanelcom/edge-document/blob/main/docs/auth/login.md A cURL command to demonstrate how to make a login request to the API. ```bash curl --location '{base_url}/api/acl/auth/login' \ --header 'Content-Type: application/json' \ --data-raw '{ "username": "your-username", "password": "your-password" }' ``` -------------------------------- ### Example Request to Get Counties Source: https://github.com/ippanelcom/edge-document/blob/main/docs/send/country/county.md Use this cURL command to make a request to the counties endpoint. Ensure you replace `{base_url}` and `{province_id}` with your actual values and provide a valid API token. ```bash curl --location '{base_url}/api/send/banks/counties?province_id={province_id}' \ --header 'Content-Type: application/json' \ --header 'Authorization: API TOKEN' ' ``` -------------------------------- ### Get User Tariff Source: https://github.com/ippanelcom/edge-document/blob/main/docs/user/index.md Get the tariff information for a specific user. ```APIDOC ## GET /v1/user/tariff ### Description Retrieves the tariff information for a specific user. ### Method GET ### Endpoint /v1/user/tariff ### Parameters #### Query Parameters - **userId** (string) - Required - The ID of the user for whom to retrieve tariff information. ### Response #### Success Response (200) - **data** (object) - Contains the tariff information for the user. - **meta** (object) - Contains status information about the request. ``` -------------------------------- ### Get Sample Import Number Source: https://github.com/ippanelcom/edge-document/blob/main/docs/phonebook/number/index.md Get a sample import number file. ```APIDOC ## GET /phonebook/number/sample-import ### Description Download a sample Excel file for importing phonebook contacts. ### Method GET ### Endpoint https://edge.ippanel.com/v1/phonebook/number/sample-import ``` -------------------------------- ### Example cURL Request Source: https://github.com/ippanelcom/edge-document/blob/main/docs/payment/my-credit.md This cURL command demonstrates how to make a request to the credit balance endpoint. Replace placeholders with your actual base URL and token. ```bash curl --location '{base_url}/api/payment/credit/mine' \ --header 'Content-Type: application/json' \ --header 'Authorization: Your Apikey/Token' ``` -------------------------------- ### Success Response Example Source: https://github.com/ippanelcom/edge-document/blob/main/docs/send/country/count.md Example of a successful response containing recipient counts by provider. ```json { "data": { "mci_count": 256171, "irancell_count": 134380, "other_count": 10425 }, "meta": { "status": true, "message": "count", "message_parameters": [], "message_code": "200-1" } } ``` -------------------------------- ### Success Response Example Source: https://github.com/ippanelcom/edge-document/blob/main/docs/report/inbox-report.md Example of a successful response, containing message data and metadata. ```json { "data": [ { "messages_inbox_id": 123, "from": "+989122222222", "number": "+981000123", "message": "message text", "type": "normal", "time": 1747808125, "seen": "0" }, { "messages_inbox_id": 122, "from": "+989122222222", "number": "+981000123", "message": "message text", "type": "normal", "time": 1747808120, "seen": "0" } ], "meta": { "current_page": 1, "from": 1, "last_page": 4066539, "path": "https://baseurl/api/report/messages-inbox", "per_page": 2, "to": 1, "total": 4066539, "status": true, "message": "انجام شد", "message_code": "200-1" } } ``` -------------------------------- ### Get Ticket By ID Source: https://github.com/ippanelcom/edge-document/blob/main/docs/ticket/index.md Get a specific ticket by its ID. This endpoint is available only to resellers. ```APIDOC ## GET /ticket/{id} ### Description Get a specific ticket by its ID. This endpoint is available only to resellers. ### Method GET ### Endpoint https://edge.ippanel.com/v1/ticket/{id} ### Authentication Requires an Authorization token in the header: `Authorization: YOUR_TOKEN_HERE` ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the ticket. ### Response #### Success Response (200) - **data** (object) - Contains the requested ticket information. - **meta** (object) - Contains status information. #### Response Example { "example": "{\"data\": {\"id\": \"TKT-12345\", \"subject\": \"New Feature Request\", \"message\": \"I would like to request a new feature for the platform.\", \"status\": \"open\", \"createdAt\": \"2023-10-27T10:00:00Z\"}, \"meta\": {\"status\": \"success\", \"message\": \"Ticket retrieved successfully\"}}" } ``` -------------------------------- ### Example cURL Request Source: https://github.com/ippanelcom/edge-document/blob/main/docs/ticket/reply-ticket.md Demonstrates how to use cURL to send a reply to a ticket, including headers and form data for ticket ID, description, and an optional file. ```bash curl --location '{base_url}/api/ticket/interaction' \ --header 'Content-Type: multipart/form-data' \ --header 'Authorization: Your Apikey/Token' \ --form 'ticket_id="100001"' \ --form 'description="Sample reply"' \ --form 'file=@"/path/to/your/file.zip"' ``` -------------------------------- ### Success Response Example Source: https://github.com/ippanelcom/edge-document/blob/main/docs/send/country/gender.md Example of a successful response containing a list of genders with their IDs and names. ```json { "data": [ { "id": 1, "name": "مرد" }, { "id": 2, "name": "زن" }, { "id": 3, "name": "سازمانی- حقوقی" } ] } ``` -------------------------------- ### Error Response Example - User Already Exists Source: https://github.com/ippanelcom/edge-document/blob/main/docs/user/check-exist.md Example of an error response when the username already exists (409). ```json { "data": null, "meta": { "status": false, "message": "نام کاربری وارد شده قبلا ثبت شده است", "message_parameters": [], "message_code": "400-1", "errors": {} } } ``` -------------------------------- ### Example cURL Request Source: https://github.com/ippanelcom/edge-document/blob/main/docs/package/list-packages.md A cURL command to demonstrate how to make a request to the List Packages API, including pagination and filtering by package ID. ```bash curl --location '{base_url}/api/acl/package/list?page=1&per_page=10&package_id=1234' \ --header 'Content-Type: application/json' \ --header 'Authorization: Your Apikey/Token' ``` -------------------------------- ### Success Response Example Source: https://github.com/ippanelcom/edge-document/blob/main/docs/report/bulk-recipient.md Example JSON response for a successful request, showing recipient details and message status. ```json { "data": [ { "recipient": "+989190000000", "message": "متن پیام", "is_readable": true, "msg_parts": "1", "message_status": "1" }, { "recipient": "+989120000000", "message": "با سلام", "is_readable": true, "msg_parts": "1", "message_status": "1" } ], "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "/api/report/recipients", "per_page": 10, "to": 2, "total": 2, "status": true, "message": "انجام شد", "message_code": "200-1" } } ``` -------------------------------- ### Example cURL Request Source: https://github.com/ippanelcom/edge-document/blob/main/docs/user/show-user.md A cURL command to demonstrate how to make a request to the Show User API, including necessary headers. ```bash curl --location '{base_url}/api/user/show?user_id=123456' \ --header 'Authorization: Your Apikey' \ --header 'Content-Type: application/json' ``` -------------------------------- ### Get Provinces Endpoint Source: https://github.com/ippanelcom/edge-document/blob/main/docs/send/country/province.md This is the GET endpoint to retrieve a list of provinces. Ensure you include the correct base URL. ```bash curl --location '{base_url}/api/send/banks/provinces' \ --header 'Content-Type: application/json' \ --header 'Authorization: API TOKEN' ' ``` -------------------------------- ### Example cURL Request Source: https://github.com/ippanelcom/edge-document/blob/main/docs/draft/create-draft.md This cURL command demonstrates how to make a request to the create draft endpoint, including necessary headers and the request body. ```bash curl --location '{base_url}/api/user/draft' \ --header 'Content-Type: application/json' \ --header 'Authorization: Your Apikey/Token' \ --data-raw '{ \ "draft_group_id": 123456, \ "message": "تست پیام پیشفرض" \ }' ``` -------------------------------- ### Start Localized Site in French Source: https://github.com/ippanelcom/edge-document/blob/main/docs/tutorial-extras/translate-your-site.md Run your Docusaurus development server with the French locale to preview your translated site. ```bash npm run start -- --locale fr ``` -------------------------------- ### Error Response Example - Missing Required Fields Source: https://github.com/ippanelcom/edge-document/blob/main/docs/user/check-exist.md Example of an error response when required fields are missing or invalid (422). ```json { "data": null, "meta": { "status": false, "message": "نام کاربری باید شامل حروف انگلیسی بزرگ و کوچک و اعداد و - و . باشد", "message_parameters": [], "message_code": "400-1", "errors": {} } } ``` -------------------------------- ### cURL Example Request Source: https://github.com/ippanelcom/edge-document/blob/main/docs/user/documents/upload-document.md This cURL command demonstrates how to make a multipart/form-data request to upload user documents, including specifying the document ID and multiple files. ```bash curl --location '{base_url}/api/user/documents/upload' \ --header 'Content-Type: multipart/form-data' \ --header 'Authorization: your-api-token' \ --form 'document_id="6"' \ --form 'files[0]=@"1.png"' \ --form 'files[1]=@"2.png"' ``` -------------------------------- ### Example cURL Request to Update Phonebook Source: https://github.com/ippanelcom/edge-document/blob/main/docs/phonebook/phonebook/update-phonebook.md An example cURL command to update a phonebook entry, including headers and request body. ```bash curl --location '{base_url}/api/phonebooks/{phonebook_id}' \ --header 'Authorization: Your Apikey/Token' \ --header 'Content-Type: application/json' \ --data '{ \ "title": "title", \ "options": [ \ "123" \ ] \ }' ``` -------------------------------- ### Example cURL Request to Remove Document Source: https://github.com/ippanelcom/edge-document/blob/main/docs/user/documents/remove-document.md This example demonstrates how to use cURL to call the remove document endpoint with the necessary headers and data. ```bash curl '{base_url}/api/user/documents/remove' \ -H 'accept: application/json, text/plain, */*' \ -H 'Authorization: your-api-token' \ -H 'content-type: application/json' \ --data-raw '{"document_id":6}' ``` -------------------------------- ### Example Logout Request using cURL Source: https://github.com/ippanelcom/edge-document/blob/main/docs/auth/logout.md Demonstrates how to make a logout request using cURL, including necessary headers. ```bash curl --location '{base_url}/api/acl/auth/logout' \ --header 'Content-Type: application/json' \ --header 'Authorization: your-token' ``` -------------------------------- ### Example cURL Request Source: https://github.com/ippanelcom/edge-document/blob/main/docs/numbers/assign-number.md A cURL command demonstrating how to call the Assign Number API with sample data. ```bash curl --location '{base_url}/api/numbers/assign' \ --header 'Content-Type: application/json' \ --header 'Authorization: Your Apikey/Token' \ --data '{ "number_id": 10, "target_user_id": 123, "number": "+983000505", "target_user": "testuser", "send": true, "gets": false }' ``` -------------------------------- ### Example cURL Request Source: https://github.com/ippanelcom/edge-document/blob/main/docs/draft/delete-draft.md An example of how to use cURL to send a request to the delete draft endpoint, including necessary headers and the request body. ```bash curl --location '{base_url}/api/user/draft/delete' \ --header 'Authorization: Your Apikey/Token' \ --header 'Content-Type: application/json' \ --data '{ "draft_ids":[100626] }' ```