HeroSMS API

https://hero-sms.com/api
Admin
HeroSMS is an SMS verification API service that provides phone number rental and SMS receiving...
Tokens:3,185
Snippets:26
Trust Score:5.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### Purchase Email Activation

Source: https://hero-sms.com/api

Example request to purchase a single email activation.

```Shell
curl https://hero-sms.com/api/v1/emails \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: ApiKey ApiKey ' \
  --data '{
  "site": "telegram.com",
  "domain": "gmail.com"
}'
```

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

### GET /activations/offers/{verificationType}

Source: https://hero-sms.com/api

Retrieves a list of activation offers based on the specified verification type.

```APIDOC
## GET /activations/offers/{verificationType}

### Description
Retrieves activation offers for a specific verification type, allowing filtering by services and countries.

### Method
GET

### Endpoint
https://hero-sms.com/api/v1/activations/offers/{verificationType}

### Parameters
#### Path Parameters
- **verificationType** (string) - Required - The type of verification (e.g., sms).

#### Query Parameters
- **services** (string) - Optional - Comma-separated list of services (e.g., tg,go,ig).
- **countries** (string) - Optional - Comma-separated list of country codes (e.g., 6,33,50).
```

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

### Purchase Email Activations in Bulk

Source: https://hero-sms.com/api

Example request to purchase multiple email activations in a single batch request.

```Shell
curl https://hero-sms.com/api/v1/emails/batch \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: ApiKey ApiKey ' \
  --data '{
  "site": "telegram.com",
  "domain": "gmail.com",
  "count": 5,
  "service": "tg"
}'
```

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

### GET /emails/domains

Source: https://hero-sms.com/api

Retrieves a list of available domains for email activations.

```APIDOC
## GET /emails/domains

### Description
Get the list of available domains.

### Method
GET

### Endpoint
/api/v1/emails/domains

### Parameters
#### Query Parameters
- **site** (string) - Optional - Website which an activation is purchased for

### Response
#### Success Response (200)
- **data** (array) - List of domains with name, cost, and count.

#### Response Example
{
  "data": [
    {
      "name": "string",
      "cost": 1,
      "count": 1
    }
  ]
}
```

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

### GET /activations/offers/{verificationType}

Source: https://hero-sms.com/api

Retrieves available OTP activation offers based on the specified verification type.

```APIDOC
## GET /activations/offers/{verificationType}

### Description
Retrieves available OTP activation offers based on the specified verification type.

### Method
GET

### Endpoint
/activations/offers/{verificationType}

### Parameters
#### Path Parameters
- **verificationType** (string) - Required - The type of verification for which to retrieve offers.
```

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

### GET /emails

Source: https://hero-sms.com/api

Retrieves a list of active email activations based on provided filters.

```APIDOC
## GET /emails

### Description
Retrieves the list of active email activations with support for filtering by status, date range, and pagination.

### Method
GET

### Endpoint
https://hero-sms.com/api/v1/emails

### Parameters
#### Query Parameters
- **search** (string) - Optional - Search term
- **size** (integer) - Optional - Size of the page containing data
- **page** (integer) - Optional - Number of the page containing data
- **sort[id]** (string) - Optional - Sort order (asc or desc)
- **status[id]** (array integer[]) - Optional - Statuses to filter by
- **from** (string) - Optional - Start date (ISO 8601)
- **to** (string) - Optional - End date (ISO 8601)

### Response
#### Success Response (200)
- **data** (array) - List of activation objects

#### Response Example
{
  "data": [
    {
      "id": 1,
      "site": "string",
      "email": "string",
      "status": "WAIT",
      "value": "string",
      "cost": 1,
      "currency": 840,
      "date": "2025-12-16T10:30:00.000000Z",
      "message": "string"
    }
  ]
}
```

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

### Retrieve Active Email Purchases

Source: https://hero-sms.com/api

Example request to fetch a list of active email purchases using cURL.

```Shell
curl 'https://hero-sms.com/api/v1/emails?search=&size=1&page=1&sort%5Bid%5D=desc&status%5Bid%5D=3&from=&to=' \
  --header 'Authorization: ApiKey ApiKey '
```

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

### GET /emails/{emailId}

Source: https://hero-sms.com/api

Retrieves the current status and details of a specific email activation by its ID.

```APIDOC
## GET /emails/{emailId}

### Description
Check the status of an activation by mail using its unique ID.

### Method
GET

### Endpoint
/api/v1/emails/{emailId}

### Parameters
#### Path Parameters
- **emailId** (integer) - Required - Email activation ID

### Response
#### Success Response (200)
- **data** (object) - Activation details including id, site, email, status, value, cost, currency, date, and message.

#### Response Example
{
  "data": {
    "id": 1,
    "site": "string",
    "email": "string",
    "status": "WAIT",
    "value": "string",
    "cost": 1,
    "currency": 840,
    "date": "2025-12-16T10:30:00.000000Z",
    "message": "string"
  }
}
```

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

### POST /emails/batch

Source: https://hero-sms.com/api

Purchases multiple activations by mail in a single request.

```APIDOC
## POST /emails/batch

### Description
Allows purchasing multiple email activations in bulk.

### Method
POST

### Endpoint
https://hero-sms.com/api/v1/emails/batch

### Parameters
#### Request Body
- **count** (integer) - Required - Number of emails (1-10)
- **domain** (string) - Required - Mail domain
- **site** (string) - Required - Website for activation
- **service** (string) - Optional - Service code

### Response
#### Success Response (201)
- **data** (array) - List of created activations
- **meta** (object) - Metadata about the batch operation

#### Response Example
{
  "data": [
    {
      "userId": 123,
      "site": "example.com",
      "email": "test@example.com",
      "status": 1,
      "cost": 0.25,
      "domain": "gmail.com"
    }
  ],
  "meta": {
    "info": "Email activation successful",
    "count": 3
  }
}
```

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

### POST /emails

Source: https://hero-sms.com/api

Purchases a single activation by mail.

```APIDOC
## POST /emails

### Description
Creates a new email activation request for a specific site and domain.

### Method
POST

### Endpoint
https://hero-sms.com/api/v1/emails

### Parameters
#### Request Body
- **domain** (string) - Required - Mail domain (e.g., gmail.com)
- **site** (string) - Required - Website for activation (e.g., telegram.com)

### Response
#### Success Response (201)
- **data** (object) - Created activation details

#### Response Example
{
  "data": {
    "id": 1,
    "site": "string",
    "email": "string",
    "status": "WAIT",
    "value": "string",
    "cost": 1,
    "currency": 840,
    "date": "2025-12-16T10:30:00.000000Z",
    "message": "string"
  }
}
```

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

### List available domains

Source: https://hero-sms.com/api

Retrieves a list of available domains for email activations, filtered by site.

```shell
curl 'https://hero-sms.com/api/v1/emails/domains?site=telegram.com' \
  --header 'Authorization: ApiKey ApiKey '
```

```json
{
  "data": [
    {
      "name": "string",
      "cost": 1,
      "count": 1
    }
  ]
}
```

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

### Single Email Purchase Response Schema

Source: https://hero-sms.com/api

The JSON structure returned after successfully purchasing a single email activation.

```JSON
{
  "data": {
    "id": 1,
    "site": "string",
    "email": "string",
    "status": "WAIT",
    "value": "string",
    "cost": 1,
    "currency": 840,
    "date": "2025-12-16T10:30:00.000000Z",
    "message": "string"
  }
}
```

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

### Bulk Email Purchase Response Schema

Source: https://hero-sms.com/api

The JSON structure returned after a successful bulk email activation request.

```JSON
{
  "data": [
    {
      "userId": 123,
      "site": "example.com",
      "email": "test@example.com",
      "status": 1,
      "cost": 0.25,
      "domain": "gmail.com"
    }
  ],
  "meta": {
    "info": "Email activation successful",
    "count": 3
  }
}
```

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

### Check email activation status

Source: https://hero-sms.com/api

Retrieves the current status of an email activation using its ID.

```shell
curl https://hero-sms.com/api/v1/emails/123456789 \
  --header 'Authorization: ApiKey ApiKey '
```

```json
{
  "data": {
    "id": 1,
    "site": "string",
    "email": "string",
    "status": "WAIT",
    "value": "string",
    "cost": 1,
    "currency": 840,
    "date": "2025-12-16T10:30:00.000000Z",
    "message": "string"
  }
}
```

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

### Email Purchase Response Schema

Source: https://hero-sms.com/api

The JSON structure returned when retrieving a list of email purchases.

```JSON
{
  "data": [
    {
      "id": 1,
      "site": "string",
      "email": "string",
      "status": "WAIT",
      "value": "string",
      "cost": 1,
      "currency": 840,
      "date": "2025-12-16T10:30:00.000000Z",
      "message": "string"
    }
  ]
}
```

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

### Reorder email activation

Source: https://hero-sms.com/api

Reorders an existing email activation by ID.

```shell
curl https://hero-sms.com/api/v1/emails/123456789/reorder \
  --request POST \
  --header 'Authorization: ApiKey ApiKey '
```

```json
{
  "data": {
    "id": 1,
    "site": "string",
    "email": "string",
    "status": "WAIT",
    "value": "string",
    "cost": 1,
    "currency": 840,
    "date": "2025-12-16T10:30:00.000000Z",
    "message": "string"
  }
}
```

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

### POST /emails/{emailId}/reorder

Source: https://hero-sms.com/api

Reorders an existing email activation.

```APIDOC
## POST /emails/{emailId}/reorder

### Description
Reorder an activation by mail.

### Method
POST

### Endpoint
/api/v1/emails/{emailId}/reorder

### Parameters
#### Path Parameters
- **emailId** (integer) - Required - Email activation ID

### Response
#### Success Response (200)
- **data** (object) - Activation details.

#### Response Example
{
  "data": {
    "id": 1,
    "site": "string",
    "email": "string",
    "status": "WAIT",
    "value": "string",
    "cost": 1,
    "currency": 840,
    "date": "2025-12-16T10:30:00.000000Z",
    "message": "string"
  }
}
```

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

### POST Webhook: incoming SMS

Source: https://hero-sms.com/api

Real-time event notification mechanism that sends incoming SMS content to specified HTTPS URLs.

```APIDOC
## POST Webhook: incoming SMS

### Description
After a purchase of a number, the service sends incoming SMS content to specified HTTPS URLs using the POST method. Up to 3 webhook URLs are supported.

### Method
POST

### Content-Type
application/json

### Error Handling
- Response timeout: 3 seconds
- If no 200 response is received, the system retries at least 7 times with a delay of 20-30 seconds between attempts.
```

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

### DELETE /emails/{emailId}

Source: https://hero-sms.com/api

Cancels a previously purchased email activation.

```APIDOC
## DELETE /emails/{emailId}

### Description
Cancel the purchase of an activation by mail.

### Method
DELETE

### Endpoint
/api/v1/emails/{emailId}

### Parameters
#### Path Parameters
- **emailId** (integer) - Required - Email activation ID

### Response
#### Success Response (204)
- No content returned.
```

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

### Cancel email activation

Source: https://hero-sms.com/api

Cancels a pending email activation purchase by ID.

```shell
curl https://hero-sms.com/api/v1/emails/123456789 \
  --request DELETE \
  --header 'Authorization: ApiKey ApiKey '
```
Tokens:
Raw