IPPanel Edge API

https://ippanelcom.github.io/Edge-Document/
Admin
IPPanel Edge API is a comprehensive messaging platform that enables sending SMS messages, managing...
Tokens:125,934
Snippets:394
Trust Score:8.3
Update:7 months ago
Show doc for...
Tokens:
Raw
### Example Request for Get Bulk Recipients

Source: https://ippanelcom.github.io/Edge-Document/report/bulk-recipient

An example cURL command to demonstrate how to call the Get Bulk Recipients API. It includes the necessary headers for authentication and content type, along with the endpoint URL and parameters.

```bash
curl --location '{base_url}/api/report/recipients?page=1&per_page=10&bulk_id={messages_outbox_id}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Your Apikey/Token'
```

--------------------------------

### Example Request for Get Parents Tree

Source: https://ippanelcom.github.io/Edge-Document/user/parents-tree

This example demonstrates how to make a request to the Get Parents Tree endpoint using cURL. It includes setting the Content-Type and Authorization headers, along with the user ID parameter.

```cURL
curl --location '{base_url}/api/user/parents_tree?user_id={user_id}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Your Apikey/Token'
```

--------------------------------

### Example Request using cURL

Source: https://ippanelcom.github.io/Edge-Document/send/jobs/categories

An example of how to make a request to the 'Get Jobs Categories' endpoint using cURL. This demonstrates the necessary headers for authentication and content type.

```cURL
curl --location '{base_url}/api/send/jobs/categories' \
--header 'Content-Type: application/json' \
--header 'Authorization: APIKEY OR TOKEN'
```

--------------------------------

### Example Request using cURL

Source: https://ippanelcom.github.io/Edge-Document/send/country/city

This example demonstrates how to call the 'Get Cities' API using cURL. It specifies the endpoint URL, the county ID, and includes necessary headers for authentication and content type.

```bash
curl --location '{base_url}/api/send/banks/cities?county_id={county_id}' \
--header 'Content-Type: application/json' \
--header 'Authorization: API TOKEN'
```

--------------------------------

### Get Bulk Stats API Example Request (cURL)

Source: https://ippanelcom.github.io/Edge-Document/report/bulk-stats

A cURL command to demonstrate how to make a request to the Get Bulk Stats API. Includes necessary headers and parameters.

```bash
curl --location '{base_url}/api/report/bulk_stats?bulk_id={messages_outbox_id}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Your Apikey/Token'
```

--------------------------------

### Example Request using cURL

Source: https://ippanelcom.github.io/Edge-Document/send/country/gender

This example demonstrates how to make a request to the Get Genders API using cURL. It includes the necessary headers for content type and authorization.

```curl
curl --location '{base_url}/api/send/banks/genders' \
--header 'Content-Type: application/json' \
--header 'Authorization: API TOKEN'
```

--------------------------------

### Example API Request (cURL)

Source: https://ippanelcom.github.io/Edge-Document/report/outbox-report

This cURL command demonstrates how to make a POST request to the '/api/report/new_list' endpoint of the IPPanel API. It includes necessary headers for content type and authorization, along with a JSON payload containing pagination and filtering parameters.

```curl
curl --location '{base_url}/api/report/new_list' \
--header 'Content-Type: application/json' \
--header 'Authorization: Your Apikey/Token' \
--data '{
    "page": 1,
    "limit": 10,
    "filters": {
        "username": "*",
        "number": "+98217000070",
        "messages_outbox_id": "1100972179",
        "create_from_date": "1744102007",
        "create_to_date": "1744102007",
        "send_from_date": "1744102007",
        "send_to_date": "1744102007",
        "from_exit_count": 1,
        "to_exit_count": 100,
        "message": "تست",
        "state_id":"6"
    }
}'
```

--------------------------------

### Login API Example Request using cURL

Source: https://ippanelcom.github.io/Edge-Document/auth/login

This snippet provides an example of how to make a Login API request using the cURL command-line tool. It demonstrates setting the endpoint, content type, and request body.

```bash
curl --location '{base_url}/api/acl/auth/login' \
--header 'Content-Type: application/json' \
--data-raw '{
  "username": "your-username",
  "password": "your-password"
}'
```

--------------------------------

### Example Request for Get Recipients Count (curl)

Source: https://ippanelcom.github.io/Edge-Document/send/country/count

An example of how to make a request to the 'Get Recipients Count' API using curl. It demonstrates the necessary headers, including Content-Type and Authorization.

```curl
curl --location '{base_url}/api/send/banks/counts' \
--header 'Content-Type: application/json' \
--header 'Authorization: API TOKEN'
```

--------------------------------

### Example Request to List Packages with Filters

Source: https://ippanelcom.github.io/Edge-Document/package/list-packages

This cURL example demonstrates how to call the List Packages API. It includes the necessary Authorization and Content-Type headers, and shows how to apply a filter for 'package_id'.

```cURL
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'
```

--------------------------------

### Support Information

Source: https://ippanelcom.github.io/Edge-Document/index

Information on how to get support for the IPPanel API.

```APIDOC
## Support
If you need help or have questions, please create a support ticket through the Tickets section or contact our support team via our website. You can also reach out to our technical team by opening an issue directly on our GitHub repository.
```

--------------------------------

### Example Request using cURL

Source: https://ippanelcom.github.io/Edge-Document/payment/my-credit

This cURL command demonstrates how to make a request to the credit balance API. It includes the necessary Content-Type and Authorization headers.

```bash
curl --location '{base_url}/api/payment/credit/mine' \
--header 'Content-Type: application/json' \
--header 'Authorization: Your Apikey/Token'
```

--------------------------------

### cURL Example for Sending Peer to Peer by File

Source: https://ippanelcom.github.io/Edge-Document/send/peer-to-peer-file

A command-line example using cURL to send peer-to-peer messages via a file. It demonstrates how to set headers, form data, and specify the file path for upload.

```bash
curl --location '{base_url}/api/send' \
--header 'Content-Type: multipart/form-data' \
--header 'Accept: application/json' \
--form 'sending_type="peer_to_peer_file"' \
--form 'from_number="+983000505"' \
--form 'send_time="2025-04-25 10:10:10"' \
--form 'files[]=@"/path/to/your/file.csv"'
```

--------------------------------

### Show User API Example Request (cURL)

Source: https://ippanelcom.github.io/Edge-Document/user/show-user

This cURL command demonstrates how to make a request to the Show User API. It includes the necessary headers for authorization and content type, along with the user ID parameter.

```Shell
curl --location '{base_url}/api/user/show?user_id=123456' \
--header 'Authorization: Your Apikey' \
--header 'Content-Type: application/json'
```

--------------------------------

### Register User API cURL Example

Source: https://ippanelcom.github.io/Edge-Document/user/register-user

A cURL command demonstrating how to make a request to the user registration API. It includes the endpoint URL, necessary headers, and a sample JSON payload for creating a new user.

```bash
curl --location '{base_url}/api/user/create' \
--header 'Authorization: Your Apikey' \
--header 'Content-Type: application/json' \
--data '{ \
    "user_name": "username", \
    "password": "q8?6Man96Q]%%U|q", \
    "national_code": "1111111111", \
    "mobile_number": "0912000000", \
    "birth_date": "1990-01-01", \
    "acl_id": 12345 \
}'
```

--------------------------------

### Get Bulk Stats API Success Response

Source: https://ippanelcom.github.io/Edge-Document/report/bulk-stats

Example of a successful response from the Get Bulk Stats API, detailing message statistics by operator and status.

```json
{
  "data": {
    "operators_blacklist": {
      "irancell": {
        "en": 0,
        "fa": 0
      },
      "mci": {
        "en": 0,
        "fa": 0
      }
    },
    "operators_failed": {
      "irancell": {
        "en": 0,
        "fa": 0
      },
      "mci": {
        "en": 0,
        "fa": 0
      }
    },
    "operators_pending": {
      "irancell": {
        "en": 0,
        "fa": 0
      },
      "mci": {
        "en": 0,
        "fa": 0
      }
    },
    "operators_sent": {
      "irancell": {
        "en": 0,
        "fa": 0
      },
      "mci": {
        "en": 0,
        "fa": 0
      }
    },
    "operators_delivered": {
      "irancell": {
        "en": 0,
        "fa": "1"
      },
      "mci": {
        "en": 0,
        "fa": 0
      }
    }
  },
  "meta": {
    "status": true,
    "message": "انجام شد",
    "message_parameters": [],
    "message_code": "200-1"
  }
}
```

--------------------------------

### Success Response Example (JSON)

Source: https://ippanelcom.github.io/Edge-Document/send/country/county

This is an example of a successful response from the 'Get Counties' API. It returns a JSON object with a 'data' field containing an array of county objects, each with an 'id' and 'name'. The 'meta' field provides status and message information.

```json
{
  "data": [
    {
      "id": 147,
      "name": "بیرجند"
    },
    {
      "id": 246,
      "name": "نامشخص"
    },
    {
      "id": 884,
      "name": "طبس"
    },
    {
      "id": 901,
      "name": "قائنات"
    },
    {
      "id": 990,
      "name": "بشرویه"
    },
    {
      "id": 1026,
      "name": "خوسف"
    },
    {
      "id": 1031,
      "name": "درمیان"
    },
    {
      "id": 1053,
      "name": "زیرکوه"
    },
    {
      "id": 1056,
      "name": "سرایان"
    },
    {
      "id": 1058,
      "name": "سربیشه"
    },
    {
      "id": 1080,
      "name": "فردوس"
    },
    {
      "id": 1110,
      "name": "نهبندان"
    }
  ],
  "meta": {
    "status": true,
    "message": "انجام شد",
    "message_code": "200-1"
  }
}
```

--------------------------------

### Create Pattern API Example Request (cURL)

Source: https://ippanelcom.github.io/Edge-Document/pattern/create-pattern

A cURL command demonstrating how to make a request to the 'Create Pattern' API endpoint. It includes the necessary headers and the JSON payload for creating a pattern.

```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 Phonebook Creation Request (cURL)

Source: https://ippanelcom.github.io/Edge-Document/phonebook/phonebook/store-phonebook

An example cURL command to demonstrate how to make a request to the phonebook creation API endpoint. It shows the necessary headers and the JSON payload for creating a new entry.

```bash
curl --location '{base_url}/api/phonebooks' \
--header 'Authorization: Your Apikey/Token' \
--header 'Content-Type: application/json' \
--data '{ \
    "title": "تست", \
    "options": [ \
        "123", \
        "456" \
    ] \
}'
```

--------------------------------

### Example cURL Request for Get Inbox Report

Source: https://ippanelcom.github.io/Edge-Document/report/inbox-report

This cURL command demonstrates how to make a POST request to the Get Inbox Report API, including necessary headers and the JSON request body.

```bash
curl --location '{base_url}/api/report/messages-inbox' \
--header 'Content-Type: application/json' \
--header 'Authorization: Your Apikey/Token' \
--data '{ \
    "page": 1, \
    "per_page": 10, \
    "filters" : { \
        "from_id":125 \
    }
}'
```

--------------------------------

### Example Request using cURL

Source: https://ippanelcom.github.io/Edge-Document/send/jobs/count

An example of how to call the Get Recipients Count API using cURL. It demonstrates setting the necessary headers, including Content-Type and Authorization, and constructing the URL with the main_category_id. This request will return the number of recipients matching the specified criteria.

```cURL
curl --location '{base_url}/api/send/jobs/number-count?main_category_id={category_id}' \
--header 'Content-Type: application/json' \
--header 'Authorization: APIKEY OR TOKEN'
```

--------------------------------

### Create Draft API Example Request using cURL

Source: https://ippanelcom.github.io/Edge-Document/draft/create-draft

An example of how to make a POST request to the Create Draft API endpoint using cURL. It demonstrates setting the necessary headers and providing the request body.

```curl
curl --location '{base_url}/api/user/draft' \
--header 'Content-Type: application/json' \
--header 'Authorization: Your Apikey/Token' \
--data-raw '{ 
    "draft_group_id": 123456, 
    "message": "تست پیام پیشفرض"
}'
```

--------------------------------

### Retrieve Counties by Province ID (Shell)

Source: https://ippanelcom.github.io/Edge-Document/send/country/county

This example demonstrates how to call the 'Get Counties' API using `curl`. It requires the base URL, a valid API token for authorization, and the province ID as a query parameter. The response will be a JSON object containing a list of counties or an error message.

```shell
curl --location '{base_url}/api/send/banks/counties?province_id={province_id}' \
--header 'Content-Type: application/json' \
--header 'Authorization: API TOKEN' 
```

--------------------------------

### Get Recipients Count API Endpoint

Source: https://ippanelcom.github.io/Edge-Document/send/jobs/count

This is the primary endpoint for retrieving the count of recipients. It requires a main category ID and accepts optional sub-category ID, operator ID, start index, and size parameters. The response includes counts for different mobile operators and metadata about the request status.

```HTTP
GET {base_url}/api/send/jobs/number-count?main_category_id={category_id}
```

--------------------------------

### API Sections Overview

Source: https://ippanelcom.github.io/Edge-Document/index

An overview of the different sections available within the IPPanel API.

```APIDOC
## API Sections
* **🔐 Authentication**: Login, logout, and token management
* **📨 Send SMS**: Send SMS messages using various methods
* **📊 Reports**: Get delivery reports and statistics
* **📞 Numbers**: Manage your phone numbers
* **👤 Users**: User management APIs
* **📦 Packages**: Package and credit management
* **🎫 Ticket**: Support ticket system
* **📝 Drafts**: Message draft management
* **💳 Payment**: Payment and credit information
* **🎯 Patterns**: SMS pattern management
* **📁 Phonebook**: Contact management
```

--------------------------------

### POST /api/user/pattern

Source: https://ippanelcom.github.io/Edge-Document/pattern/create-pattern

Creates a new pattern with the provided details. This includes setting a title, description, message template, and defining variables.

```APIDOC
## POST /api/user/pattern

### Description
Creates a new pattern with the provided details. This includes setting a title, description, message template, and defining variables.

### Method
POST

### Endpoint
`POST {base_url}/api/user/pattern`

### Headers
- **Authorization** (string) - Required - YOUR_TOKEN_HERE
- **Content-Type** (string) - Required - application/json

### Request Body
- **title** (string) - Optional - The title of the pattern.
- **description** (string) - Yes - A brief description of the pattern.
- **is_share** (boolean) - Yes - Whether the pattern can be shared with sub users. Default is false.
- **message** (string) - Yes - The message template containing variables.
- **website** (string) - Optional - The website associated with the pattern.
- **variable** (array) - Yes - An array of variable objects defining the variables used in the message.
  - **name** (string) - Yes - The name of the variable.
  - **type** (string) - Yes - The type of the variable (`string`, `integer`).

### Request Example
```json
{
  "title": "test pattern",
  "description": "پترن تستی",
  "is_share": false,
  "message": "پترن تستی %var% . کد شما %code%",
  "website": "https://yoursite.com",
  "variable": [
    {
      "name": "var",
      "type": "string"
    },
    {
      "name": "code",
      "type": "integer"
    }
  ]
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains the created pattern details.
  - **id** (string) - The unique identifier of the pattern.
  - **title** (string) - The title of the pattern.
  - **username** (string) - The username associated with the pattern.
  - **pattern_code** (string) - A unique code for the pattern.
  - **pattern_message** (string) - The message template.
  - **admin_comment** (string) - Admin's comment on the pattern.
  - **pattern_description** (string) - The description of the pattern.
  - **pattern_status** (string) - The status of the pattern (e.g., 'pending').
  - **pattern_is_share** (boolean) - Whether the pattern is shared.
  - **reject_text** (string) - Reason for rejection, if any.
  - **type** (string) - The type of the pattern (e.g., 'sms').
  - **variable** (array) - An array of variable objects.
    - **name** (string) - The name of the variable.
    - **type** (string) - The type of the variable.
    - **len** (integer) - The length of the variable.
  - **delimiter** (string) - The delimiter used in the message.
  - **updated_at** (string) - The timestamp of the last update.
  - **time** (integer) - The timestamp in seconds.
  - **pattern_state_revision** (any) - Revision details for pattern state.
  - **pattern_message_revision** (any) - Revision details for pattern message.
  - **pattern_is_share_revision** (any) - Revision details for pattern share status.
  - **pattern_description_revision** (any) - Revision details for pattern description.
  - **pattern_delimiter_revision** (any) - Revision details for pattern delimiter.
  - **pattern_state_log** (any) - Log for pattern state changes.
  - **pattern_message_log** (any) - Log for pattern message changes.
  - **pattern_is_share_log** (any) - Log for pattern share status changes.
  - **pattern_description_log** (any) - Log for pattern description changes.
  - **pattern_delimiter_log** (any) - Log for pattern delimiter changes.
- **meta** (object) - Metadata about the response.
  - **status** (boolean) - Indicates if the request was successful.
  - **message** (string) - A message describing the outcome.
  - **message_code** (string) - A code for the message.

#### Response Example
```json
{
  "data": {
    "id": "683c0ef4ad9979cd75066974",
    "title": "test pattern",
    "username": "username",
    "pattern_code": "jhaskdab45s6f4sfw",
    "pattern_message": "پترن تستی %var% . کد شما %code%",
    "admin_comment": null,
    "pattern_description": "پترن تستی",
    "pattern_status": "pending",
    "pattern_is_share": false,
    "reject_text": "",
    "type": "sms",
    "variable": [
      {
        "name": "var",
        "type": "string",
        "len": 40
      },
      {
        "name": "code",
        "type": "integer",
        "len": 40
      }
    ],
    "delimiter": "%",
    "updated_at": "2025-06-01T08:27:32.244000Z",
    "time": 1748766452,
    "pattern_state_revision": null,
    "pattern_message_revision": null,
    "pattern_is_share_revision": null,
    "pattern_description_revision": null,
    "pattern_delimiter_revision": null,
    "pattern_state_log": null,
    "pattern_message_log": null,
    "pattern_is_share_log": null,
    "pattern_description_log": null,
    "pattern_delimiter_log": null
  },
  "meta": {
    "status": true,
    "message": "انجام شد",
    "message_code": "200-1"
  }
}
```

#### Error Response (401) - Invalid or Expired Token
- **data** (null)
- **meta** (object)
  - **status** (boolean) - Indicates failure.
  - **message** (string) - Error message (e.g., "اطلاعات وارد شده صحیح نمی باشد").
  - **message_parameters** (array)
  - **message_code** (string) - Error code (e.g., "400-1").
  - **errors** (object)

#### Error Response (422) - Invalid Request
- **data** (null)
- **meta** (object)
  - **status** (boolean) - Indicates failure.
  - **message** (string) - Error message detailing missing or invalid fields (e.g., "تکمیل گزینه description الزامی است (و 1 خطای دیگر)").
  - **message_parameters** (array)
  - **message_code** (string) - Error code (e.g., "400-2").
  - **errors** (object) - Object containing field-specific validation errors.
    - **description** (array) - Error messages for the 'description' field.
    - **message** (array) - Error messages for the 'message' field.
    - **variable.0.name** (array) - Error messages for the 'name' field of the first variable.
    - **variable.0.type** (array) - Error messages for the 'type' field of the first variable.
```

--------------------------------

### Error Response - Invalid Request (422)

Source: https://ippanelcom.github.io/Edge-Document/send/country/count

An example of an error response for an invalid request, such as providing incorrect or non-existent IDs for filters like county_id. This typically returns a 422 status code.

```json
{
  "data": null,
  "meta": {
    "status": false,
    "message": "گزینه انتخاب شده county id صحیح نمی باشد",
    "message_parameters": [],
    "message_code": "400-2",
    "errors": {
      "county_id": [
        "گزینه انتخاب شده county id صحیح نمی باشد"
      ]
    }
  }
}
```

--------------------------------

### Example Request using cURL

Source: https://ippanelcom.github.io/Edge-Document/draft/list-draft-group

This example demonstrates how to make a request to the List Draft Groups API using cURL. It includes the necessary URL, Content-Type, and Authorization headers. This is a command-line utility and not tied to a specific programming language.

```curl
curl --location '{base_url}/api/user/draft/group/list' \
--header 'Content-Type: application/json' \
--header 'Authorization: Your Apikey/Token'
```

--------------------------------

### Upload User Document API Request Example (cURL)

Source: https://ippanelcom.github.io/Edge-Document/user/documents/upload-document

This snippet demonstrates how to upload a user document using a cURL command. It specifies the endpoint, content type, authorization token, and includes form data for the document ID and files. Ensure to replace placeholders like {base_url} and your-api-token with actual values.

```curl
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"'
```

--------------------------------

### Error Response Example - Invalid Province ID (JSON)

Source: https://ippanelcom.github.io/Edge-Document/send/country/county

This JSON object illustrates an error response for an invalid or non-existent province ID (HTTP status code 422). The 'data' is null, and the 'meta' section details the error, including a specific message and an 'errors' object that highlights the problematic 'province_id' parameter.

```json
{
  "data": null,
  "meta": {
    "status": false,
    "message": "گزینه انتخاب شده province id صحیح نمی باشد",
    "message_parameters": [],
    "message_code": "400-2",
    "errors": {
      "province_id": [
        "گزینه انتخاب شده province id صحیح نمی باشد"
      ]
    }
  }
}
```

--------------------------------

### Success Response for Get Genders

Source: https://ippanelcom.github.io/Edge-Document/send/country/gender

This is a successful response from the Get Genders API, returning a JSON object containing a list of genders, each with an ID and a name.

```json
{
  "data": [
    {
      "id": 1,
      "name": "مرد"
    },
    {
      "id": 2,
      "name": "زن"
    },
    {
      "id": 3,
      "name": "سازمانی- حقوقی"
    }
  ]
}
```

--------------------------------

### Get Bulk Stats API Endpoint

Source: https://ippanelcom.github.io/Edge-Document/report/bulk-stats

The GET endpoint for retrieving bulk message statistics. Requires a base URL and a bulk_id parameter.

```http
GET {base_url}/api/report/bulk_stats?bulk_id={messages_outbox_id}
```

--------------------------------

### GET /api/send/banks/genders

Source: https://ippanelcom.github.io/Edge-Document/send/country/gender

Retrieves a list of available genders.

```APIDOC
## GET /api/send/banks/genders

### Description
Retrieves the list of Genders, which can be used to filter recipients.

### Method
GET

### Endpoint
`{base_url}/api/send/banks/genders`

### Parameters
#### Headers
- **Authorization** (string) - Required - YOUR_TOKEN_HERE
- **Content-Type** (string) - Required - application/json

### Request Example
```bash
curl --location '{base_url}/api/send/banks/genders' \
--header 'Content-Type: application/json' \
--header 'Authorization: API TOKEN'
```

### Response
#### Success Response (200)
- **data** (array) - Contains a list of gender objects.
  - **id** (integer) - The unique identifier for the gender.
  - **name** (string) - The name of the gender.

#### Response Example
```json
{
  "data": [
    {
      "id": 1,
      "name": "مرد"
    },
    {
      "id": 2,
      "name": "زن"
    },
    {
      "id": 3,
      "name": "سازمانی- حقوقی"
    }
  ]
}
```

#### Error Response (401)
- **data** (null)
- **meta** (object)
  - **status** (boolean) - Indicates if the request was successful.
  - **message** (string) - Error message.
  - **message_parameters** (object)
  - **message_code** (string)
  - **errors** (object)

#### Error Response Example (401)
```json
{
  "data": null,
  "meta": {
    "status": false,
    "message": "اطلاعات وارد شده صحیح نمی باشد",
    "message_parameters": [],
    "message_code": "400-1",
    "errors": {}
  }
}
```
```

--------------------------------

### POST /api/user/create

Source: https://ippanelcom.github.io/Edge-Document/user/register-user

Registers a new user with the provided details and assigns an ACL role. The new user will be created under your reseller account.

```APIDOC
## POST /api/user/create

### Description
Registers a new user with the provided details and assigns an ACL role. The new user will be created under your reseller account.

### Method
POST

### Endpoint
`{base_url}/api/user/create`

### Headers
- **Authorization** (string) - Required - YOUR_TOKEN_HERE
- **Content-Type** (string) - Required - application/json

### Parameters
#### Request Body
- **user_name** (string) - Required - The user_name for the new user. Must be unique and not already in use.
- **password** (string) - Required - The password for the new user. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number, and one special character.
- **national_code** (string) - Required - The national code of the new user. Must be a valid Iranian national code.
- **mobile_number** (string) - Required - The mobile number of the new user. Must be a valid Iranian mobile number and must belong to the same person as the provided national ID.
- **birth_date** (string) - Required - The birth date of the new user must be in the Gregorian calendar format (YYYY-MM-DD) and must exactly match the date recorded in the official national registry.
- **acl_id** (integer) - Required - The ACL role ID for the new user. This determines the permissions and access level of the user within the system. Must be a valid ACL role ID.
- **name_family** (string) - Optional - The full name of the new user.
- **email** (string) - Optional - The email address of the new user.
- **description** (string) - Optional - A brief description or notes about the new user.
- **company** (string) - Optional - The company name of the new user.
- **expire_time** (string) - Optional - The expiration time for the new user's account in Gregorian calendar format (YYYY-MM-DD).
- **zip_code** (string) - Optional - The postal code of the new user's address.
- **tell** (string) - Optional - The telephone number of the new user.
- **address** (string) - Optional - The physical address of the new user.

### Request Example
```json
{
  "user_name": "newuser",
  "password": "StrongPassword123!",
  "national_code": "1234567890",
  "mobile_number": "09120000000",
  "birth_date": "1990-01-01",
  "acl_id": 12345
}
```

### Response
#### Success Response (200)
- **data** (null) - Null value on success.
- **meta** (object) - Contains metadata about the operation.
  - **status** (boolean) - Indicates if the operation was successful.
  - **message** (string) - A message describing the result of the operation.
  - **message_parameters** (array) - Parameters for the message.
  - **message_code** (string) - A code representing the message.

#### Response Example (Success)
```json
{
  "data": null,
  "meta": {
    "status": true,
    "message": "انجام شد",
    "message_parameters": [],
    "message_code": "200-1"
  }
}
```

#### Error Response (401 - Invalid or Expired Token)
- **data** (null) - Null value on error.
- **meta** (object) - Contains metadata about the error.
  - **status** (boolean) - Indicates if the operation was successful (false on error).
  - **message** (string) - A message describing the error.
  - **message_parameters** (array) - Parameters for the error message.
  - **message_code** (string) - A code representing the error.
  - **errors** (object) - An object containing specific error details.

#### Response Example (401)
```json
{
  "data": null,
  "meta": {
    "status": false,
    "message": "اطلاعات وارد شده صحیح نمی باشد",
    "message_parameters": [],
    "message_code": "400-1",
    "errors": {}
  }
}
```

#### Error Response (422 - Missing Required Fields)
- **data** (null) - Null value on error.
- **meta** (object) - Contains metadata about the error.
  - **status** (boolean) - Indicates if the operation was successful (false on error).
  - **message** (string) - A message describing the error.
  - **message_parameters** (array) - Parameters for the error message.
  - **message_code** (string) - A code representing the error.
  - **errors** (object) - An object containing specific validation errors for fields.

#### Response Example (422)
```json
{
  "data": null,
  "meta": {
    "status": false,
    "message": "تکمیل گزینه شماره تماس الزامی است (و 1 خطای دیگر)",
    "message_parameters": [],
    "message_code": "400-2",
    "errors": {
      "mobile_number": [
        "تکمیل گزینه شماره تماس الزامی است"
      ],
      "birth_date": [
        "تکمیل گزینه birth date الزامی است"
      ]
    }
  }
}
```
```

--------------------------------

### Example Request using cURL

Source: https://ippanelcom.github.io/Edge-Document/numbers/list-numbers

An example of how to make a request to the List Numbers API using cURL. It demonstrates the inclusion of necessary headers such as Content-Type and Authorization.

```bash
curl --location '{base_url}/api/number/numbers?page=1&per_page=10' \
--header 'Content-Type: application/json' \
--header 'Authorization: Your Apikey/Token'
```

--------------------------------

### Get Genders API Endpoint

Source: https://ippanelcom.github.io/Edge-Document/send/country/gender

This snippet shows the GET request endpoint for retrieving the list of genders. It requires a base URL and specific headers for authentication and content type.

```http
GET {base_url}/api/send/banks/genders
```

--------------------------------

### User Tariff API Sample Request using cURL

Source: https://ippanelcom.github.io/Edge-Document/user/user-tariff

This example demonstrates how to make a request to the User Tariff API using cURL. It includes the necessary headers: Authorization with the user's token and Content-Type set to application/json.

```Shell
curl --location '{base_url}/api/user/get_tariff' \
--header 'Authorization: Your Apikey' \
--header 'Content-Type: application/json'
```

--------------------------------

### Success Response for Get Inbox Report

Source: https://ippanelcom.github.io/Edge-Document/report/inbox-report

A successful response from the Get Inbox Report API includes a 'data' array containing message objects and a 'meta' object with pagination and status information.

```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"
  }
}
```
Tokens:
Raw