Falconsender

https://falconsender.ru/api.html
Admin
Falconsender is an email marketing service providing an API to remotely manage campaigns, subscriber...
Tokens:3,969
Snippets:19
Trust Score:6.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### API Callback: Subscriber Activated

Source: https://falconsender.ru/api.html

Callback triggered when a subscriber is activated. The script must respond with 'request_id:subscriber_activated:ok'.

```APIDOC
## POST Callback: subscriber_activated

### Description
Callback triggered when a subscriber is activated. The script must respond with a string in the format 'request_id:subscriber_activated:ok'.

### Method
POST

### Endpoint
[Your callback URL]

### Parameters
#### Request Body (POST variables)
- **request_id** (string) - Required - Unique request ID. Should be saved to avoid duplicate events.
- **date_tstamp** (integer) - Required - Event date in UNIX time (Moscow timezone).
date** (string) - Required - Event date in format 'DD/MM/YYYY HH:MM:SS' (Moscow timezone).
dubscriber_id** (integer) - Required - Subscriber ID.
email** (string) - Required - Subscriber email address.
action** (string) - Required - Event code, value 'subscriber_activated'.

### Response
#### Success Response (200)
- **body** (string) - Must return 'request_id:subscriber_activated:ok'.

#### Response Example
12345:subscriber_activated:ok
```

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

### Формат ответа API Falconsender

Source: https://falconsender.ru/api.html

Структура ответа API Falconsender. Содержит результат запроса (1 — успех, 0 — ошибка), поле error с кодом и сообщением при ошибке, а также данные интерфейса.

```xml
<response>
<result></result>
<error code="" message=""/>
<данные>
...
<данные>
</response>
```

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

### API Callback: Subscriber Added

Source: https://falconsender.ru/api.html

Callback triggered when a new subscriber is added. The script must respond with 'request_id:subscriber_added:ok'.

```APIDOC
## POST Callback: subscriber_added

### Description
Callback triggered when a new subscriber is added to the author's list. The script must respond with a string in the format 'request_id:subscriber_added:ok'.

### Method
POST

### Endpoint
[Your callback URL]

### Parameters
#### Request Body (POST variables)
- **request_id** (string) - Required - Unique request ID. Should be saved to avoid duplicate events.
- **date_tstamp** (integer) - Required - Event date in UNIX time (Moscow timezone).
- **date** (string) - Required - Event date in format 'DD/MM/YYYY HH:MM:SS' (Moscow timezone).
- **subscriber_id** (integer) - Required - Subscriber ID.
- **email** (string) - Required - Subscriber email address.
- **action** (string) - Required - Event code, value 'subscriber_added'.
- **name_last** (string) - Optional - Subscriber's last name.
- **name_first** (string) - Optional - Subscriber's first name.
- **name_mid** (string) - Optional - Subscriber's middle name.
- **birth_day** (integer) - Optional - Subscriber's birth day.
- **birth_month** (integer) - Optional - Subscriber's birth month.
- **birth_year** (integer) - Optional - Subscriber's birth year.
- **city** (string) - Optional - Subscriber's city.
- **company** (string) - Optional - Subscriber's company.

### Response
#### Success Response (200)
- **body** (string) - Must return 'request_id:subscriber_added:ok'.

#### Response Example
12345:subscriber_added:ok
```

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

### API Callback: Subscriber Unsubscribed

Source: https://falconsender.ru/api.html

Callback triggered when a subscriber unsubscribes from a mailing. The script must respond with 'request_id:subscriber_unsubscribed:ok'.

```APIDOC
## POST Callback: subscriber_unsubscribed

### Description
Callback triggered when a subscriber unsubscribes from a mailing. The script must respond with a string in the format 'request_id:subscriber_unsubscribed:ok'.

### Method
POST

### Endpoint
[Your callback URL]

### Parameters
#### Request Body (POST variables)
- **request_id** (string) - Required - Unique request ID. Should be saved to avoid duplicate events.
- **date_tstamp** (integer) - Required - Event date in UNIX time (Moscow timezone).
- **date** (string) - Required - Event date in format 'DD/MM/YYYY HH:MM:SS' (Moscow timezone).
- **subscriber_id** (integer) - Required - Subscriber ID.
- **email** (string) - Required - Subscriber email address.
- **action** (string) - Required - Event code, value 'subscriber_unsubscribed'.
- **delivery_id** (integer) - Optional - ID of the mailing from which the subscriber unsubscribed.

### Response
#### Success Response (200)
- **body** (string) - Must return 'request_id:subscriber_unsubscribed:ok'.

#### Response Example
12345:subscriber_unsubscribed:ok
```

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

### API Callback: Subscriber Subscribed

Source: https://falconsender.ru/api.html

Callback triggered when a subscriber subscribes to a mailing. The script must respond with 'request_id:subscriber_subscribed:ok'.

```APIDOC
## POST Callback: subscriber_subscribed

### Description
Callback triggered when a subscriber subscribes to a mailing. The script must respond with a string in the format 'request_id:subscriber_subscribed:ok'.

### Method
POST

### Endpoint
[Your callback URL]

### Parameters
#### Request Body (POST variables)
- **request_id** (string) - Required - Unique request ID. Should be saved to avoid duplicate events.
- **date_tstamp** (integer) - Required - Event date in UNIX time (Moscow timezone).
- **date** (string) - Required - Event date in format 'DD/MM/YYYY HH:MM:SS' (Moscow timezone).
- **subscriber_id** (integer) - Required - Subscriber ID.
- **email** (string) - Required - Subscriber email address.
- **action** (string) - Required - Event code, value 'subscriber_subscribed'.
- **delivery_id** (integer) - Optional - ID of the mailing to which the subscriber subscribed.

### Response
#### Success Response (200)
- **body** (string) - Must return 'request_id:subscriber_subscribed:ok'.

#### Response Example
12345:subscriber_subscribed:ok
```

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

### API Callback: Subscriber Deleted

Source: https://falconsender.ru/api.html

Callback triggered when a subscriber deletes themselves from the author's list. The script must respond with 'request_id:subscriber_deleted:ok'.

```APIDOC
## POST Callback: subscriber_deleted


### Description
Callback triggered when a subscriber deletes themselves from the author's list. The script must respond with a string in the format 'request_id:subscriber_deleted:ok'.

### Method
POST

### Endpoint
[Your callback URL]

### Parameters
#### Request Body (POST variables)
- **request_id** (string) - Required - Unique request ID. Should be saved to avoid duplicate events.
- **date_tstamp** (integer) - Required - Event date in UNIX time (Moscow timezone).
date** (string) - Required - Event date in format 'DD/MM/YYYY HH:MM:SS' (Moscow timezone).
dubscriber_id** (integer) - Required - Subscriber ID.
email** (string) - Required - Subscriber email address.
action** (string) - Required - Event code, value 'subscriber_deleted'.

### Response
#### Success Response (200)
- **body** (string) - Must return 'request_id:subscriber_deleted:ok'.

#### Response Example
12345:subscriber_deleted:ok
```
Tokens:
Raw