SMS Aero

https://smsaero.ru/integration/documentation/
Admin
SMS Aero is a Russian messaging platform that provides API for sending SMS, Viber, WhatsApp...
Tokens:23,399
Snippets:171
Trust Score:8.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Retrieve test messages via GET

Source: https://smsaero.ru/integration/documentation/api

Example URL for fetching the list of test messages using authentication credentials.

```text
https://email:api_key@gate.smsaero.ru/v2/sms/testlist
```

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

### Balance Response Format

Source: https://smsaero.ru/integration/documentation/api

Example JSON response for the balance endpoint.

```json
{
	"success": true,
	"data": {
		"balance": 1389.26
	},
	"message": null
}
```

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

### Tariff Response Format

Source: https://smsaero.ru/integration/documentation/api

Example JSON response for the tariffs endpoint.

```json
{
	"success": true,
	"data": {
		"PAY SIGN": {
			"MEGAFON": 2.79,
			"MTS": 2.79,
			"BEELINE": 2.89,
			"t2": 2.96,
			"OTHER": 3.49
		},
		"SERVICE": {
			"MEGAFON": 2.39,
			"MTS": 1.89,
			"BEELINE": 2.25,
			"t2": 1.85,
			"OTHER": 3.49
		},
		"FREE SIGN": {
			"MEGAFON": 5.89,
			"MTS": 3.59,
			"BEELINE": 3.69,
			"t2": 3.49,
			"OTHER": 3.49
		},
		"AUTH": {
			"MEGAFON": 1.89,
			"MTS": 1.89,
			"BEELINE": 2.25,
			"t2": 1.85,
			"OTHER": 3.49
		}
	},
	"message": null
}
```

```json
{
	"success": true,
	"data": {
		"channel": {
			"operator": price,
			...
		},
	},
	"message": null
}
```

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

### Test SMS Status Request

Source: https://smsaero.ru/integration/documentation

Example GET request to retrieve the status of a test SMS message.

```http
https://email:api_key@gate.smsaero.ru/v2/sms/teststatus?id=5
```

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

### GET viber/list

Source: https://smsaero.ru/integration/documentation

Retrieves a list of all Viber campaigns created in the system.

```APIDOC
## GET /v2/viber/list

### Description
Returns a paginated list of all Viber campaigns with their current status, costs, and delivery metrics.

### Method
GET

### Endpoint
/v2/viber/list

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains the list of campaigns and pagination links.
- **message** (string|null) - Error message if applicable.
```

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

### GET /v2/viber/list

Source: https://smsaero.ru/integration/documentation/api

Retrieves a list of all Viber campaigns created in the system.

```APIDOC
## GET /v2/viber/list

### Description
Returns a paginated list of Viber campaigns with their current status and cost details.

### Method
GET

### Endpoint
/v2/viber/list

### Response
#### Success Response (200)
- **id** (integer) - Campaign identifier.
- **dateCreate** (integer) - Creation date in unixtime.
- **dateSend** (integer) - Sending date in unixtime.
- **count** (integer) - Total number of messages.
- **sign** (string) - Sender name.
- **channel** (string) - Sending channel.
- **text** (string) - Message content.
- **cost** (float) - Campaign cost.
- **status** (integer) - Campaign status: 0 (rejected), 1 (moderation), 2 (in progress), 3 (completed), 4 (scheduled), 5 (insufficient funds).
- **extendStatus** (string) - Description of the status.
```

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

### Authentication Response Format

Source: https://smsaero.ru/integration/documentation/api

Example of a successful JSON response from the authentication endpoint.

```json
{
    "success": true,
    "data": null,
    "message": "Successful authorization."
}
```

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

### Cards Response Format

Source: https://smsaero.ru/integration/documentation/api

Example JSON response for the cards endpoint.

```json
{
	"success": true,
	"data": {
		"0": {
			"id": 6274,
			"number": Visa*****1234
		},
		"1": {
			"id": 6780,
			"number": MasterCard*****4321
		}
	},
	"message": null
}
```

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

### Send SMS Messages via API

Source: https://smsaero.ru/integration/documentation/api

Examples of sending single or multiple SMS messages using HTTP GET requests with authentication credentials.

```http
https://email:api_key@gate.smsaero.ru/v2/sms/send?number=79990000000&text=your+text&sign=SMS Aero
```

```http
https://email:api_key@gate.smsaero.ru/v2/sms/send?numbers[]=79990000000&numbers[]=79990000001&text=your+text&sign=SMS Aero
```

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

### GET /sign/list

Source: https://smsaero.ru/integration/documentation/api

Retrieves a list of SMS or Viber signs.

```APIDOC
## GET /sign/list

### Description
Retrieves a list of SMS or Viber signs. Supports pagination via the page parameter.

### Method
GET

### Endpoint
/v2/sign/list or /v2/viber/sign/list

### Parameters
#### Query Parameters
- **page** (string) - Optional - Page number for navigation.

### Response
#### Success Response (200)
- **totalCount** (string) - Total number of signs.
- **data** (object) - List of signs with status and operator details.
```

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

### GET /auth

Source: https://smsaero.ru/integration/documentation

Verifies user authentication credentials using HTTP Basic Auth.

```APIDOC
## GET /auth

### Description
Tests the user's authentication credentials against the SMS Aero API.

### Method
GET

### Endpoint
https://gate.smsaero.ru/v2/auth

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the authorization was successful.
- **data** (null) - Null value.
- **message** (string) - Message regarding the success or failure of the authorization.
```

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

### Operator Response

Source: https://smsaero.ru/integration/documentation/api

Example JSON response for an operator lookup request.

```json
{
	"success": true,
	"data": {
		"number": "79131234567",
		"operator": 4,
		"extendOperator": "MTS"
	},
	"message": null
}
```

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

### GET /auth

Source: https://smsaero.ru/integration/documentation/api

A test method used to verify user authorization credentials.

```APIDOC
## GET /auth

### Description
Verifies the provided user credentials and API key for authentication.

### Method
GET

### Endpoint
https://gate.smsaero.ru/v2/auth

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the authorization was successful.
- **data** (null) - Null value.
- **message** (string) - Message regarding the success or failure of the authorization.
```

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

### WhatsApp Send Response

Source: https://smsaero.ru/integration/documentation/api

Example JSON response after initiating a WhatsApp message send request.

```json
{
    "success": true,
    "data": {
        "id": 42318,
        "status": 6
    },
    "message": null
}
```

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

### Mobile ID Send Request and Response

Source: https://smsaero.ru/integration/documentation/api

Example of initiating an authentication request and the corresponding JSON response.

```bash
curl -X POST 'https://gate.smsaero.ru/v2/mobile-id/send' \
  -u 'login:api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "number": "79XXXXXXXXX",
    "sign": "MID_SIGN",
    "callbackUrl": "https://your.site/webhooks/mobile-id"
  }'
```

```json
{
  "success": true,
  "data": {
    "id": 17,
    "number": "79XXXXXXXXX",
    "status": 0,
    "cost": 0,
    "timeCreated": 1772784233,
    "timeSend": 1772784233
  },
  "message": null
}
```

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

### Retrieve WhatsApp Chat List

Source: https://smsaero.ru/integration/documentation/api

Example JSON response for the whatsapp/get-chats endpoint, returning a list of chat objects with their respective statuses and identifiers.

```json
{
    "success": true,
    "count": "1",
    "data": [{
        "id": 8902,
        "type": 4,
        "address": "71111111111",
        "status": 1,
        "subject": "SMSAero_WA",
        "timeOpen": 1688312268,
        "timeLastAnswer": 1688312268,
        "timeClosed": 1688398668,
        "isPaid": 0,
        "subjectName": "SMS Aero",
        "lastIdWorker": null
    }, ]
}
```

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

### Get Groups List

Source: https://smsaero.ru/integration/documentation/api

Retrieve a paginated list of contact groups.

```http
https://email:api_key@gate.smsaero.ru/v2/group/list?page=1
```

```json
{
	"success": true,
	"data": {
		0: {
			"id": "217809",
			"name": "group"
		},
		...
		"links": {
			"self": "/v2/group/list?page=1",
			"first": "/v2/group/list?page=1",
			"prev": "",
			"next": "/v2/group/list?page=2",
			"last": "/v2/group/list?page=2"
		},
	"message": null
}
```

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

### GET /v2/viber/sign/list

Source: https://smsaero.ru/integration/documentation/api

Retrieves a list of available sender names for Viber campaigns.

```APIDOC
## GET /v2/viber/sign/list

### Description
Returns a list of sender names available for use in Viber campaigns, including their status and type.

### Method
GET

### Endpoint
/v2/viber/sign/list

### Response
#### Success Response (200)
- **name** (string) - The sender name.
- **status** (integer) - Status: 0 (moderation), 1 (active), 2 (rejected), 4 (Viber moderation).
- **type** (string) - Type: INFO (service info), USER (custom name).
- **extendStatus** (string) - Extended status description.
- **rejectReason** (string) - Reason for rejection (if applicable).
```

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

### GET /group/list

Source: https://smsaero.ru/integration/documentation/api

Retrieves a list of contact groups.

```APIDOC
## GET /group/list

### Description
Retrieves a paginated list of contact groups.

### Method
GET

### Endpoint
/v2/group/list

### Parameters
#### Query Parameters
- **page** (string) - Optional - Page number for pagination.

### Response
#### Success Response (200)
- **data** (object) - List of groups.
- **links** (object) - Pagination links (self, first, prev, next, last).
```

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

### GET /messages

Source: https://smsaero.ru/integration/documentation/api

Retrieves a list of WhatsApp messages based on provided filters.

```APIDOC
## GET /messages

### Description
Retrieves a list of WhatsApp messages. Supports pagination and filtering by time range and recipient address.

### Method
GET

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of messages to return.
- **offset** (integer) - Optional - Offset for pagination.
- **timeFrom** (timestamp) - Optional - Filter messages starting from this time.
- **timeTo** (timestamp) - Optional - Filter messages up to this time.
- **address** (string) - Optional - Filter messages by recipient address.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains the count and the list of messages.
- **count** (string) - Total number of messages.
- **msg** (array) - List of message objects.

#### Response Example
{
    "success": true,
    "data": {
        "count": "40864",
        "msg": [{
            "id": 42077,
            "status": 2,
            "subject": "SMSAero_WA",
            "address": "71111111111",
            "contentType": "button",
            "text": null,
            "files": {
                "attachmentUrl": null,
                "attachmentName": null
            },
            "location": {
                "caption": null,
                "longitude": null,
                "latitude": null,
                "locationAddress": null
            },
            "header": null,
            "footer": null,
            "buttons": null,
            "cost": "0.00",
            "isHSM": 0,
            "type": 4,
            "idTemplate": null,
            "isAnswer": 1,
            "userInfo": {
                "userName": "Никита",
                "firstName": null,
                "lastName": null,
                "avatarUrl": null
            },
            "timeCreate": 1688396995,
            "timeSend": null,
            "timeUpdate": 1688396995,
            "isPackageMessage": 0,
            "idChat": 8912,
            "idWorker": null,
            "subjectName": null
        }]
    },
    "message": null
}
```

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

### Authentication Status Webhook

Source: https://smsaero.ru/integration/documentation/api

Example of the JSON payload sent to the configured callback URL when an authentication status changes.

```json
{
  "id": 17,
  "status": 3,
  "number": "79XXXXXXXXX"
}
```

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

### GET whatsapp/status

Source: https://smsaero.ru/integration/documentation/api

Retrieves detailed information about a specific WhatsApp message by its ID.

```APIDOC
## GET whatsapp/status

### Description
Retrieves detailed information about a specific WhatsApp message.

### Method
GET

### Endpoint
whatsapp/status

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains message details including id, status, subject, address, contentType, and timestamps.

#### Response Example
{
    "success": true,
    "data": {
        "id": 42318,
        "status": 6,
        "subject": "SMSAero_WA",
        "address": "71111111111",
        "contentType": "image",
        "timeCreate": 1688574503
    }
}
```

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

### Mobile ID Status Request and Response

Source: https://smsaero.ru/integration/documentation/api

Example of checking the authentication status using the request ID.

```bash
curl -X POST 'https://gate.smsaero.ru/v2/mobile-id/status' \
  -u 'login:api_key' \
  -H 'Content-Type: application/json' \
  -d '{ "id": 11 }'
```

```json
{
  "success": true,
  "data": {
    "id": 11,
    "number": "79XXXXXXXXX",
    "status": 3,
    "cost": 6.38,
    "timeCreated": 1771320878,
    "timeSend": 1771320878
  },
  "message": null
}
```

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

### Mobile ID Verify Request and Response

Source: https://smsaero.ru/integration/documentation/api

Example of verifying an OTP code and the corresponding JSON response.

```bash
curl -X POST 'https://gate.smsaero.ru/v2/mobile-id/verify' \
  -u 'login:api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 16,
    "sign": "MID_SIGN",
    "code": "1234"
  }'
```

```json
{
  "success": true,
  "data": {
    "id": 16,
    "number": "79XXXXXXXXX",
    "status": 3,
    "cost": 0,
    "timeCreated": 1772783375,
    "timeSend": 1772783375
  },
  "message": null
}
```

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

### SMS List Response Format

Source: https://smsaero.ru/integration/documentation/api

Example JSON response structure for the SMS list endpoint.

```json
{
	"success": true,
	"data": {
		0: {
			"id": 41637294,
			"from": "news",
			"number": "79087913177",
			"text": "test",
			"status": 1,
			"extendStatus": "delivery",
			"channel": "FREE SIGN",
			"cost": "1.95",
			"dateCreate": 1510656981,
			"dateSend": 1510656981,
			"dateAnswer": 1510656987
		},
		...
		"links": {
			"self": "/v2/sms/list?page=1",
			"first": "/v2/sms/list?page=1",
			"prev": "",
			"next": "/v2/sms/list?page=2",
			"last": "/v2/sms/list?page=2"
		},
	"message": null
}
```

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

### GET whatsapp/get-chats

Source: https://smsaero.ru/integration/documentation/api

Retrieves a list of WhatsApp chats with optional filtering by status and pagination.

```APIDOC
## GET whatsapp/get-chats

### Description
Retrieves a list of WhatsApp chats based on status and pagination parameters.

### Method
GET

### Endpoint
whatsapp/get-chats

### Parameters
#### Query Parameters
- **status** (integer) - Optional - 1 for open chats, 2 for closed chats.
- **limit** (integer) - Optional - Number of chats to return.
- **offset** (integer) - Optional - Number of chats to skip.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **count** (string) - Total number of chats.
- **data** (array) - List of chat objects.

#### Response Example
{
    "success": true,
    "count": "1",
    "data": [{
        "id": 8902,
        "type": 4,
        "address": "71111111111",
        "status": 1
    }]
}
```

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

### HLR Status Response

Source: https://smsaero.ru/integration/documentation/api

Example JSON response for an HLR status request.

```json
{
	"success": true,
	"data": {
		"id": 123,
		"number": "79131234567",
		"hlrStatus": 1,
		"extendHlrStatus": "available"
	},
	"message": null
}
```

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

### GET viber/sign/list

Source: https://smsaero.ru/integration/documentation

Retrieves a list of available sender names (signs) for Viber campaigns.

```APIDOC
## GET /v2/viber/sign/list

### Description
Returns a list of all sender names available for use in Viber campaigns, including their status and type.

### Method
GET

### Endpoint
/v2/viber/sign/list

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (array) - List of sender name objects.
- **message** (string|null) - Error message if applicable.
```

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

### Test SMS Sending API

Source: https://smsaero.ru/integration/documentation/api

Example of a test SMS request and the corresponding JSON response structure.

```http
https://email:api_key@gate.smsaero.ru/v2/sms/testsend?number=79990000000&text=Test+text&sign=BIZNES
```

```json
{
	"success": true,
	"data": {
			"id": 5,
			"from": "BIZNES",
			"number": "79990000000",
			"text": "Test text",
			"status": 1,
			"extendStatus": "delivery",
			"channel": "FREE SIGN",
			"cost": 2.2,
			"dateCreate": 1532342510,
			"dateSend": 1532342510
		},
	"message": null
}
```

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

### GET /v2/hlr/status

Source: https://smsaero.ru/integration/documentation

Retrieves the HLR status for a specific request ID.

```APIDOC
## GET /v2/hlr/status

### Description
Retrieves the current HLR status for a given request identifier.

### Method
GET

### Endpoint
/v2/hlr/status

### Parameters
#### Query Parameters
- **id** (integer) - Required - The identifier of the request.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains the HLR details (id, number, hlrStatus, extendHlrStatus).
- **message** (string) - Error or status message.
```

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

### Get Operator Request

Source: https://smsaero.ru/integration/documentation/api

Request the operator information for a specific phone number.

```text
https://email:api_key@gate.smsaero.ru/v2/number/operator?number=79131234567
```

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

### GET whatsapp/get-chat-msg

Source: https://smsaero.ru/integration/documentation/api

Retrieves a list of messages for a specific WhatsApp chat identified by its ID.

```APIDOC
## GET whatsapp/get-chat-msg

### Description
Retrieves the list of messages associated with a specific WhatsApp chat.

### Endpoint
whatsapp/get-chat-msg

### Parameters
#### Query Parameters
- **id** (integer) - Required - ID of the chat, obtainable via the whatsapp/get-chats method.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains infoChat and msg array.
- **infoChat** (object) - Information about the chat.
- **msg** (array) - List of messages in the chat.

#### Response Example
{
    "success": true,
    "data": {
        "infoChat": {
            "id": 8904,
            "type": 4,
            "address": "71111111111",
            "status": 1,
            "subject": "SMSAero_WA",
            "timeOpen": 1688371487,
            "timeLastAnswer": 1688371487,
            "timeClosed": 1688457887,
            "isPaid": 0,
            "subjectName": "SMS Aero",
            "lastIdWorker": null
        },
        "msg": [{
            "id": 41953,
            "status": 2,
            "subject": "SMSAero_WA",
            "address": "71111111111",
            "contentType": "text",
            "text": "Текст сообщения",
            "files": {
                "attachmentUrl": null,
                "attachmentName": null
            },
            "location": {
                "caption": null,
                "longitude": null,
                "latitude": null,
                "locationAddress": null
            },
            "header": null,
            "footer": null,
            "buttons": null,
            "cost": "0.00",
            "isHSM": 0,
            "type": 4,
            "idTemplate": null,
            "isAnswer": 1,
            "userInfo": {
                "userName": "Иван",
                "firstName": null,
                "lastName": null,
                "avatarUrl": null
            },
            "timeCreate": 1688371487,
            "timeSend": null,
            "timeUpdate": 1688371487,
            "isPackageMessage": 0,
            "idChat": 8904,
            "idWorker": null,
            "subjectName": null
        }]
    }
}
```

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

### List contacts

Source: https://smsaero.ru/integration/documentation/api

Retrieves a paginated list of contacts. Use the 'page' parameter via GET to navigate results.

```http
https://email:api_key@gate.smsaero.ru/v2/contact/list
```

```json
{
	"success": true,
	"data": {
		0: {
			"id": 123,
			"number": "79131234567",
			"lname": "Иванов",
			"fname": "Иван",
			"sname": "Иванович",
			"param1": "",
			"param2": "",
			"param3": "",
			"sex": "undefined",
			"operator": 5,
			"extendOperator": "BEELINE",
			"groups": [
				{
					"id": 123,
					"name": "TEST1"
				},
				{
					"id": 1234,
					"name": "TEST2"
				}
			],
			"hlrStatus": 1,
			"extendHlrStatus": "available"
		},
		...
		"links": {
			"self": "/v2/contact/list?page=1",
			"next": "/v2/contact/list?page=2",
			"last": "/v2/contact/list?page=3"
		}
	},
	"message": null
}
```

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

### GET /v2/number/operator

Source: https://smsaero.ru/integration/documentation

Determines the mobile network operator for one or more phone numbers.

```APIDOC
## GET /v2/number/operator

### Description
Identifies the mobile network operator associated with the provided phone number or list of numbers.

### Method
GET

### Endpoint
/v2/number/operator

### Parameters
#### Query Parameters
- **number** (string) - Optional - A single phone number.
- **numbers** (array) - Optional - A list of phone numbers.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains operator details (number, operator, extendOperator).
- **message** (string) - Error or status message.
```

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

### Test SMS Sending Request

Source: https://smsaero.ru/integration/documentation

Example URL for performing a test SMS send request for debugging purposes.

```http
https://email:api_key@gate.smsaero.ru/v2/sms/testsend?number=79990000000&text=Test+text&sign=BIZNES
```

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

### GET viber/statistic

Source: https://smsaero.ru/integration/documentation

Retrieves detailed statistics for a specific Viber campaign identified by its sendingId.

```APIDOC
## GET /v2/viber/statistic

### Description
Retrieves the delivery and read status of messages within a specific Viber campaign.

### Method
GET

### Endpoint
/v2/viber/statistic

### Parameters
#### Query Parameters
- **sendingId** (integer) - Required - The unique identifier of the Viber campaign.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains the list of message statuses and pagination links.
- **message** (string|null) - Error message if applicable.
```

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

### WhatsApp Chat Messages Response Structure

Source: https://smsaero.ru/integration/documentation/api

Example JSON response returned by the whatsapp/get-chat-msg endpoint containing chat information and a list of messages.

```json
{
    "success": true,
    "data": {
        "infoChat": {
            "id": 8904,
            "type": 4,
            "address": "71111111111",
            "status": 1,
            "subject": "SMSAero_WA",
            "timeOpen": 1688371487,
            "timeLastAnswer": 1688371487,
            "timeClosed": 1688457887,
            "isPaid": 0,
            "subjectName": "SMS Aero",
            "lastIdWorker": null
        },
        "msg": [{
            "id": 41953,
            "status": 2,
            "subject": "SMSAero_WA",
            "address": "71111111111",
            "contentType": "text",
            "text": "Текст сообщения",
            "files": {
                "attachmentUrl": null,
                "attachmentName": null
            },
            "location": {
                "caption": null,
                "longitude": null,
                "latitude": null,
                "locationAddress": null
            },
            "header": null,
            "footer": null,
            "buttons": null,
            "cost": "0.00",
            "isHSM": 0,
            "type": 4,
            "idTemplate": null,
            "isAnswer": 1,
            "userInfo": {
                "userName": "Иван",
                "firstName": null,
                "lastName": null,
                "avatarUrl": null
            },
            "timeCreate": 1688371487,
            "timeSend": null,
            "timeUpdate": 1688371487,
            "isPackageMessage": 0,
            "idChat": 8904,
            "idWorker": null,
            "subjectName": null
        }]
    }
}
```

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

### Retrieve WhatsApp Message Status

Source: https://smsaero.ru/integration/documentation/api

Example JSON response for the whatsapp/status endpoint, providing detailed message metadata including status, content type, and timestamps.

```json
{
    "success": true,
    "data": {
        "id": 42318,
        "status": 6,
        "subject": "SMSAero_WA",
        "address": "71111111111",
        "contentType": "image",
        "text": null,
        "files": {
            "attachmentUrl": "https://smsaero.ru//upload/chatfiles/3kvoDmNNSm8kalT2YrzrlV4ZzZPhBN8t.jpg",
            "attachmentName": "test"
        },
        "location": {
            "caption": null,
            "longitude": null,
            "latitude": null,
            "locationAddress": null
        },
        "header": null,
        "footer": null,
        "buttons": null,
        "cost": "0.00",
        "isHSM": 0,
        "type": 3,
        "idTemplate": null,
        "isAnswer": 0,
        "userInfo": null,
        "timeCreate": 1688574503,
        "timeSend": 1688574503,
        "timeUpdate": 1688574516,
        "isPackageMessage": 0,
        "isApi": 1,
        "idChat": 8924,
        "idWorker": null,
        "subjectName": null,
        "worker": null
    },
    "message": null
}
```

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

### Add contact to blacklist

Source: https://smsaero.ru/integration/documentation/api

Endpoint for adding a contact to the blacklist via GET or POST request.

```http
https://email:api_key@gate.smsaero.ru/v2/blacklist/add?number=79131234567
```

```json
{
	"success": true,
	"data": {
		"id": 123,
		"number": "79131234567",
		"fname": null,
		"lname": null,
		"sname": null,
		"bday": null,
		"sex": null,
		"param": null,
		"param2": null,
		"param3": null
	},
	"message": null
}
```

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

### GET /v2/sms/testsend

Source: https://smsaero.ru/integration/documentation/api

Sends a test SMS message for debugging purposes. This method does not deduct balance or affect statistics.

```APIDOC
## GET /v2/sms/testsend

### Description
Sends a test SMS message for debugging purposes. This method does not deduct balance or affect statistics.

### Method
GET

### Endpoint
https://gate.smsaero.ru/v2/sms/testsend

### Query Parameters
- **number** (string) - Required - The recipient phone number.
- **text** (string) - Required - The text of the message.
- **sign** (string) - Required - The sender signature.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains message details including id, from, number, text, status, extendStatus, channel, cost, dateCreate, and dateSend.

#### Response Example
{
	"success": true,
	"data": {
			"id": 5,
			"from": "BIZNES",
			"number": "79990000000",
			"text": "Test text",
			"status": 1,
			"extendStatus": "delivery",
			"channel": "FREE SIGN",
			"cost": 2.2,
			"dateCreate": 1532342510,
			"dateSend": 1532342510
		},
	"message": null
}
```

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

### Test message list response structure

Source: https://smsaero.ru/integration/documentation/api

Example JSON response body returned by the sms/testlist endpoint, including message data and pagination links.

```json
{
	"success": true,
	"data": {
		0: {
			"id": 5,
			"from": "BIZNES",
			"number": "79990000000",
			"text": "Test text",
			"status": 1,
			"extendStatus": "delivery",
			"channel": "FREE SIGN",
			"cost": "2.2",
			"dateCreate": 1532342510,
			"dateSend": 1532342510,
			"dateAnswer": 1510656987
		},
		...
		"links": {
			"self": "/v2/sms/testlist?page=1",
			"first": "/v2/sms/testlist?page=1",
			"prev": "",
			"next": "/v2/sms/testlist?page=2",
			"last": "/v2/sms/testlist?page=2"
		},
	"message": null
}
```

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

### Test SMS Status Verification

Source: https://smsaero.ru/integration/documentation/api

Example of checking the status of a test SMS message and the expected JSON response.

```http
https://email:api_key@gate.smsaero.ru/v2/sms/teststatus?id=5
```

```json
{
	"success": true,
	"data": {
		"id": 5,
		"from": "BIZNES",
		"number": "79990000000",
		"text": "Test text",
		"status": 1,
		"extendStatus": "delivery",
		"channel": "FREE SIGN",
		"cost": "2.2",
		"dateCreate": 1532342510,
		"dateSend": 1532342510,
		"dateAnswer": 1510656987
	},
	"message": null
}
```

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

### GET /v2/sms/testlist

Source: https://smsaero.ru/integration/documentation/api

Retrieves a list of sent test messages. Supports filtering by phone number and text, and pagination.

```APIDOC
## GET /v2/sms/testlist

### Description
Retrieves a list of sent test messages. The request returns 50 messages at a time.

### Method
GET

### Endpoint
/v2/sms/testlist

### Parameters
#### Query Parameters
- **number** (string) - Optional - Filter messages by phone number.
- **text** (string) - Optional - Filter messages by text content.
- **page** (integer) - Optional - Page number for navigation.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains the list of messages and pagination links.
- **message** (null) - Error message if applicable.

#### Response Example
{
	"success": true,
	"data": {
		"0": {
			"id": 5,
			"from": "BIZNES",
			"number": "79990000000",
			"text": "Test text",
			"status": 1,
			"extendStatus": "delivery",
			"channel": "FREE SIGN",
			"cost": "2.2",
			"dateCreate": 1532342510,
			"dateSend": 1532342510,
			"dateAnswer": 1510656987
		},
		"links": {
			"self": "/v2/sms/testlist?page=1",
			"first": "/v2/sms/testlist?page=1",
			"prev": "",
			"next": "/v2/sms/testlist?page=2",
			"last": "/v2/sms/testlist?page=2"
		}
	},
	"message": null
}
```

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

### GET /v2/sms/list

Source: https://smsaero.ru/integration/documentation/api

Retrieves a list of sent messages. Supports filtering by phone number or text, and pagination.

```APIDOC
## GET /v2/sms/list

### Description
Retrieves a list of sent messages. The API returns 50 messages per request.

### Method
GET

### Endpoint
/v2/sms/list

### Parameters
#### Query Parameters
- **number** (string) - Optional - Filter messages by phone number.
- **text** (string) - Optional - Filter messages by text content.
- **page** (integer) - Optional - Page number for navigation.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - List of messages and pagination links.
- **message** (null) - Error message if any.
```

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

### Get Sender Names List

Source: https://smsaero.ru/integration/documentation/api

Retrieve lists of SMS or Viber sender names. Use the page parameter for pagination.

```http
https://email:api_key@gate.smsaero.ru/v2/sign/list
```

```http
https://email:api_key@gate.smsaero.ru/v2/viber/sign/list
```

```json
{
	"success": true,
	"data": {
		"totalCount": "36",
		"0": {
			"id": 179077,
			"name": "GOOD SIGN",
			"status": 1,
			"extendStatus": "active",
			"statusOperators": {
				"1": {
					"operator": 1,
					"extendOperator": "MEGAFON",
					"status": 0,
					"extendStatus": "moderation"
				},
				"4": {
					"operator": 4,
					"extendOperator": "MTS",
					"status": 2,
					"extendStatus": "reject"
				},
				"5": {
					"operator": 5,
					"extendOperator": "BEELINE",
					"status": 1,
					"extendStatus": "approve"
				},
				"6": {
					"operator": 6,
					"extendOperator": "t2",
					"status": 1,
					"extendStatus": "approve"
				}
			}
		},
		"1": {
			"id": 70719,
			"name": "BAD SIGN",
			"status": 2,
			"extendStatus": "reject",
			"rejectReason": "Причина ..."
		}
	},
	"message": null
}
```

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

### Message Retrieval JSON Response

Source: https://smsaero.ru/integration/documentation/api

Example of the JSON response structure returned by the message retrieval API.

```json
{
    "success": true,
    "data": {
        "count": "40864",
        "msg": [{
            "id": 42077,
            "status": 2,
            "subject": "SMSAero_WA",
            "address": "71111111111",
            "contentType": "button",
            "text": null,
            "files": {
                "attachmentUrl": null,
                "attachmentName": null
            },
            "location": {
                "caption": null,
                "longitude": null,
                "latitude": null,
                "locationAddress": null
            },
            "header": null,
            "footer": null,
            "buttons": null,
            "cost": "0.00",
            "isHSM": 0,
            "type": 4,
            "idTemplate": null,
            "isAnswer": 1,
            "userInfo": {
                "userName": "Никита",
                "firstName": null,
                "lastName": null,
                "avatarUrl": null
            },
            "timeCreate": 1688396995,
            "timeSend": null,
            "timeUpdate": 1688396995,
            "isPackageMessage": 0,
            "idChat": 8912,
            "idWorker": null,
            "subjectName": null
        }]
    },
    "message": null
}
```

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

### Примеры запросов для создания Viber-рассылки

Source: https://smsaero.ru/integration/documentation/api

Примеры использования GET и POST запросов для отправки сообщений через API.

```http
https://email:api_key@gate.smsaero.ru/v2/viber/send?groupId=1&numbers[]=79990000000&numbers[]=79990000001&text=your+text&sign=Hello!&channel=OFFICIAL
```

```bash
curl -d curl -d 'numbers[]=79136535500&text=your+text&sign=Бонус&channel=OFFICIAL&imageSource=jpg#/9j/4AAQSkZJRgAB5UUUVRof/Z&textButton=Текст_кнопки&linkButton=https://you-link.com' https://email:api_key@gate.smsaero.ru/v2/viber/send
```

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

### Get HLR Status Request

Source: https://smsaero.ru/integration/documentation/api

Request the status of an HLR request using a GET or POST method.

```text
https://email:api_key@gate.smsaero.ru/v2/hlr/status?id=123
```

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

### GET/POST /v2/contact/add

Source: https://smsaero.ru/integration/documentation/api

Adds a new contact to the system.

```APIDOC
## GET/POST /v2/contact/add

### Description
Adds a new contact to the system.

### Method
GET or POST

### Endpoint
https://gate.smsaero.ru/v2/contact/add

### Parameters
#### Query Parameters
- **number** (string) - Required - Номер абонента.
- **groupId** (integer) - Optional - Идентификатор группы.
- **birthday** (integer) - Optional - Дата рождения абонента в формате Unix time.
- **sex** (string) - Optional - Пол (male/female).
- **lname** (string) - Optional - Фамилия абонента.
- **fname** (string) - Optional - Имя абонента.
- **sname** (string) - Optional - Отчество абонента.
- **param1** (string) - Optional - Свободный параметр.
- **param2** (string) - Optional - Свободный параметр.
- **param3** (string) - Optional - Свободный параметр.

### Response
#### Success Response (200)
- **success** (boolean) - Статус выполнения.
- **data** (object) - Объект с данными созданного контакта.
```

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

### Authentication Sequence Diagram

Source: https://smsaero.ru/integration/documentation/api

Visual representation of the authentication flow using SIM-PUSH and fallback to SMS OTP.

```mermaid
sequenceDiagram
autonumber
participant AB as "Абонент"
participant CL as "Клиент"
participant SV as "Сервер"
participant API as "SMS Aero API"

AB->>CL: Вводит номер телефона
CL->>SV: Запрашивает аутентификацию по номеру
SV->>API: POST /v2/mobile-id/send (number, sign, callbackUrl)
API-->>SV: success + data.id

alt SIM-PUSH доступен и подтверждён
  API-->>AB: Запрос подтверждения (SIM-PUSH)
  AB->>CL: Нажимает «Подтвердить»
  API-->>SV: POST callbackUrl (status=1 или status=2)
  SV-->>CL: Отобразить результат аутентификации
else SIM-PUSH не сработал
  API-->>AB: Отправляет SMS OTP (одноразовый код)
  API-->>SV: POST callbackUrl (status=3, требуется SMS OTP)
  SV-->>CL: Показать форму ввода OTP
  AB->>CL: Вводит OTP-код
  CL->>SV: Передаёт введённый code
  SV->>API: POST /v2/mobile-id/verify (id, sign, code)
  API-->>SV: success
  API-->>SV: POST callbackUrl (final status=1 или status=2)
  SV-->>CL: Отобразить результат аутентификации
end
```

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

### GET/POST /v2/tariffs

Source: https://smsaero.ru/integration/documentation/api

Retrieves current pricing tariffs for different channels and operators.

```APIDOC
## GET/POST /v2/tariffs

### Description
Retrieves current pricing tariffs for different channels and operators.

### Method
GET or POST

### Endpoint
/v2/tariffs

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Mapping of channels to operator prices.
```

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

### POST /group/add

Source: https://smsaero.ru/integration/documentation/api

Creates a new contact group.

```APIDOC
## POST /group/add

### Description
Creates a new contact group with the specified name.

### Method
POST

### Endpoint
/v2/group/add

### Parameters
#### Query Parameters
- **name** (string) - Required - Name of the group.

### Response
#### Success Response (200)
- **id** (integer) - The ID of the created group.
- **name** (string) - The name of the created group.
```

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

### Add Group

Source: https://smsaero.ru/integration/documentation/api

Create a new contact group.

```http
https://email:api_key@gate.smsaero.ru/v2/group/add?name=Test+Name
```

```json
{
	"success": true,
	"data": {
		"id": 218243,
		"name": "Test Name"
	},
	"message": null
}
```
Tokens:
Raw