NotiSend

https://notisend.ru/dev/
Admin
NotiSend is a multi-channel communication API platform for sending transactional and marketing...
Tokens:42,189
Snippets:188
Trust Score:8.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Get Email Lists with Pagination (curl)

Source: https://notisend.ru/dev/email/api

Example using curl to fetch a paginated list of email recipients. It includes the base URL, endpoint, and required headers for content type and authorization. Pagination is controlled by 'page_number' and 'page_size' parameters.

```curl
curl -X GET https://api.notisend.ru/v1/email/lists?page_number=2&page_size=3 \
     -H 'Content-Type: application/json'         \
     -H 'Authorization: Bearer $API_TOKEN'
```

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

### GET /email/templates

Source: https://notisend.ru/dev/email/api

Retrieves a paginated list of all email templates available in the account.

```APIDOC
## GET /email/templates

### Description
Retrieves a paginated list of email templates.

### Method
GET

### Endpoint
https://api.notisend.ru/v1/email/templates

### Response
#### Success Response (200)
- **total_count** (integer) - Total number of templates
- **collection** (array) - List of template objects

#### Response Example
{
  "total_count": 3,
  "total_pages": 1,
  "page_number": 1,
  "page_size": 25,
  "collection": [
    { "id": 1, "name": "My Template" }
  ]
}
```

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

### Create and Manage Webhooks via API

Source: https://notisend.ru/dev/email/api

Examples for creating a new webhook and retrieving a list of existing webhooks using the Notisend REST API. Requires an authorization bearer token for authentication.

```json
{
    "title": "Api delivered webhooks",
    "url": "https://mysite.org/webhook",
    "kinds": ["api"],
    "events": ["delivered"]
}
```

```bash
curl -X POST https://api.notisend.ru/v1/email/messages_webhooks \
     -H 'Content-Type: application/json'             \
     -H 'Authorization: Bearer $API_TOKEN'           \
     -d '...JSON...'
```

```bash
curl -X GET https://api.notisend.ru/v1/email/messages_webhooks \
     -H 'Content-Type: application/json'            \
     -H 'Authorization: Bearer $API_TOKEN'
```

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

### GET /email/messages_webhooks

Source: https://notisend.ru/dev/email/api

Retrieves a paginated list of all configured email webhooks.

```APIDOC
## GET /email/messages_webhooks

### Description
Returns a collection of all registered webhooks. Supports pagination.

### Method
GET

### Endpoint
https://api.notisend.ru/v1/email/messages_webhooks

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

### Response
#### Success Response (200)
- **total_count** (integer) - Total number of webhooks
- **total_pages** (integer) - Total number of pages
- **page_number** (integer) - Current page
- **collection** (array) - List of webhook objects

#### Response Example
{
    "total_count": 1,
    "total_pages": 1,
    "page_number": 1,
    "page_size": 25,
    "collection": [
        {
            "id": 1,
            "url": "https://mysite.org/webhook",
            "events": ["delivered"],
            "kinds": ["api"],
            "status": "active",
            "title": "Api delivered webhooks"
        }
    ]
}
```

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

### GET /api/contact/exists

Source: https://notisend.ru/dev/sms/api/contact

Checks for the existence of a contact in the system using a phone number and project identifier.

```APIDOC
## GET /api/contact/exists

### Description
Checks if a contact exists in the system by providing a phone number. Returns contact details if found, or an error if not found.

### Method
GET

### Endpoint
https://sms.notisend.ru/api/contact/exists

### Parameters
#### Query Parameters
- **project** (string) - Required - The name of the project.
- **phone** (string/array) - Required - Phone number, comma-separated list of numbers, or an array of numbers.
- **sign** (string) - Required - Request signature in lowercase.

### Request Example
https://sms.notisend.ru/api/contact/exists?project=notisend&phone=89539224424&sign=e2271659a8b05d318b4b53c644ba8b47

### Response
#### Success Response (200)
- **phone** (string) - Phone number
- **lastname** (string) - Last name
- **firstname** (string) - First name
- **patronymic** (string) - Patronymic name
- **birthday** (string) - Date of birth
- **param1** (string) - Custom parameter 1
- **param2** (string) - Custom parameter 2
- **description** (string) - Contact description
- **groups** (array) - List of group IDs

#### Response Example
{
  "phone": "89539224424",
  "lastname": "Иванов",
  "firstname": "Иван",
  "patronymic": "Иванович",
  "birthday": "29.01.1987",
  "param1": "последняя оплата: 01.11.2020",
  "param2": "пароль: 12345",
  "description": "платящий",
  "groups": [1]
}
```

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

### GET /email/lists

Source: https://notisend.ru/dev/email/api

Retrieves a paginated list of all recipient groups.

```APIDOC
## GET /email/lists

### Description
Returns a collection of recipient groups with pagination support.

### Method
GET

### Endpoint
https://api.notisend.ru/v1/email/lists

### Response
#### Success Response (200)
- **total_count** (integer) - Total number of groups
- **total_pages** (integer) - Total number of pages
- **page_number** (integer) - Current page number
- **collection** (array) - List of group objects

#### Response Example
{
  "total_count": 3,
  "collection": [
    { "id": 1, "title": "My Recipients" }
  ]
}
```

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

### GET /email/messages_webhooks/events

Source: https://notisend.ru/dev/email/api

Retrieves a list of all supported events that can trigger a webhook.

```APIDOC
## GET /email/messages_webhooks/events

### Description
Retrieves a list of all supported events that can trigger a webhook notification.

### Method
GET

### Endpoint
/email/messages_webhooks/events

### Response
#### Success Response (200)
- **events** (array of strings) - A list of supported events.

#### Response Example
```json
{
    "events": [
        "delivered",
        "hard_bounced",
        "skipped",
        "opened",
        "clicked",
        "unsubscribed",
        "complained",
        "soft_bounced"
    ]
}
```
```

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

### GET /email/organizations/current

Source: https://notisend.ru/dev/email/api

Retrieves the details of the organization currently set as default.

```APIDOC
## GET /email/organizations/current

### Description
Retrieves the details of the organization currently set as default.

### Method
GET

### Endpoint
https://api.notisend.ru/v1/email/organizations/current

### Response
#### Success Response (200)
- **id** (integer) - Identifier
- **name** (string) - Name
- **address** (string) - Address
- **country** (string) - Country
- **city** (string) - City
- **phone** (string) - Phone
- **zip** (string) - Zip code
- **current** (boolean) - Is default organization

### Response Example
{
  "id": 1,
  "name": "My Organization",
  "address": "Lenina 40",
  "country": "Russia",
  "city": "Tomsk",
  "phone": "+7-3822-123-456",
  "zip": "634000",
  "current": true
}
```

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

### GET /email/campaigns

Source: https://notisend.ru/dev/email/api

Retrieves a list of all email campaigns for an account. Supports pagination and optional statistics.

```APIDOC
## GET /email/campaigns

### Description
Retrieves a list of all email campaigns for an account. This method supports paginated results.

### Method
GET

### Endpoint
/email/campaigns

### Query Parameters
- **statistic** (boolean) - Optional - Whether to include the statistics block in the response. Defaults to true. Setting to false can significantly speed up the request.

### Request Example
```bash
curl -X GET https://api.notisend.ru/v1/email/campaigns?statistic=false \
     -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer $API_TOKEN'
```

### Response
#### Success Response (200)
- **total_count** (integer) - The total number of campaigns available.
- **total_pages** (integer) - The total number of pages for the given page size.
- **page_number** (integer) - The current page number.
- **page_size** (integer) - The number of campaigns per page.
- **collection** (array) - An array of campaign objects.
  - **id** (integer) - The unique identifier for the campaign.
  - **from_email** (string) - The sender's email address.
  - **from_name** (string) - The sender's name.
  - **html** (string) - The HTML content of the email.
  - **text** (string) - The plain text content of the email.
  - **state** (string) - The current state of the campaign (e.g., draft, pending, sending, completed).
  - **recipients_count** (integer) - The number of recipients for this campaign.
  - **purchase** (object) - Information about the billing for this campaign.
    - **enable** (boolean) - Indicates if sending is possible based on the plan.
    - **subscribers** (integer) - The number of subscribers that will be deducted from the plan.
    - **credits** (integer) - The number of emails that will be deducted from the plan.
    - **deficit** (integer) - The amount by which subscribers or emails need to be increased in the plan.
  - **statistics** (object) - Statistics related to the campaign (only included if `statistic` parameter is true).
    - **delivered** (integer) - Number of delivered messages.
    - **bounced** (integer) - Number of undelivered messages.
    - **delivering** (integer) - Number of messages currently being delivered.
    - **uniq_open** (integer) - Number of unique opens.
    - **total_open** (integer) - Total number of opens.
    - **last_open_at** (timestamp) - Timestamp of the last open.
    - **uniq_click** (integer) - Number of unique clicks.
    - **total_click** (integer) - Total number of clicks.
    - **last_click_at** (timestamp) - Timestamp of the last click.
    - **unsubscription** (integer) - Number of unsubscriptions.
    - **spam** (integer) - Number of "spam" button clicks.

#### Response Example
```json
{
  "total_count": 1,
  "total_pages": 1,
  "page_number": 1,
  "page_size": 25,
  "collection": [
    {
      "id": 1,
      "from_email": "test@example.com",
      "from_name": "Test",
      "html": "<p>test</p>",
      "text": "test",
      "state": "draft",
      "recipients_count": 10,
      "purchase": {
        "enable": true,
        "subscribers": 0,
        "credits": 10,
        "deficit": 0
      },
      "statistics":{
        "delivered":1,
        "bounced":0,
        "delivering":0,
        "uniq_open":0,
        "total_open": 0,
        "last_open_at": null,
        "uniq_click":0,
        "total_click": 0,
        "last_click_at": null,
        "unsubscription":0,
        "spam":0
      }
    }
  ]
}
```
```

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

### GET /email/balance

Source: https://notisend.ru/dev/email/api

Retrieves the current account balance and tariff information, including subscriber limits and remaining credits.

```APIDOC
## GET /email/balance

### Description
Retrieves the current account balance and tariff information.

### Method
GET

### Endpoint
https://api.notisend.ru/v1/email/balance

### Response
#### Success Response (200)
- **tariff.subscribers.total** (integer) - Total number of subscribers
- **tariff.subscribers.available** (integer) - Available number of subscribers
- **tariff.credits** (integer) - Number of credits
- **tariff.expires_at** (timestamp) - Tariff expiration time
- **balance** (float) - Current balance amount

#### Response Example
{
  "tariff": {
    "subscribers": {
      "total": 1000,
      "available": 997
    },
    "credits": 0,
    "expires_at": 1629273060
  },
  "balance": 12965.96
}
```

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

### API Collection Response Example

Source: https://notisend.ru/dev/email/api

This JSON object shows the structure of a successful response when retrieving a list of data (Collection). It includes pagination details like total count, total pages, current page number, and page size, along with the 'collection' array containing the actual data items.

```json
{
  "total_count":23,
  "total_pages":8,
  "page_number":2,
  "page_size":3,
  "collection":[
    {
      "id":1,
      "title":"My Recipients"
    },
    {
      "id":2,
      "title":"My Recipients #2"
    },
    {
      "id":3,
      "title":"My Recipients #3"
    }
  ]
}
```

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

### Send Message via cURL

Source: https://notisend.ru/dev/sms/api

Example of sending a message to the NotiSend API using a cURL command with the required project, sender, message, recipient, and signature parameters.

```bash
curl -X GET http://sms.notisend.ru/api/message/send \
  -H 'Accept: application/json' \
  -F project=notisend \
  -F sender=NotiSend \
  -F message=test \
  -F recipients=89031231234 \
  -F sign=3eb8e51846f271ea09378b4d1a597345
```

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

### GET /email/lists/{id}/parameters

Source: https://notisend.ru/dev/email/api

Retrieves a list of parameters for a specific email list. Supports pagination.

```APIDOC
## Get List Parameters

### Description
Retrieves a list of parameters for a specific email list. This method supports paginated results.

### Method
GET

### Endpoint
`/email/lists/{id}/parameters`

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the list to retrieve parameters for.

### Request Example
```bash
curl -X GET https://api.notisend.ru/v1/email/lists/1/parameters \
     -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer $API_TOKEN'
```

### Response
#### Success Response (200)
- **total_count** (integer) - The total number of parameters available.
- **total_pages** (integer) - The total number of pages for the results.
- **page_number** (integer) - The current page number.
- **page_size** (integer) - The number of items per page.
- **collection** (array) - An array of parameter objects.
  - **id** (integer) - The ID of the parameter.
  - **title** (string) - The name of the parameter.
  - **kind** (string) - The type of the parameter (e.g., 'string', 'numeric').
  - **list_id** (integer) - The ID of the list this parameter belongs to.

#### Response Example
```json
{
  "total_count": 2,
  "total_pages": 1,
  "page_number": 1,
  "page_size": 25,
  "collection": [
    {
      "id": 1,
      "title": "Name",
      "kind": "string",
      "list_id": 1
    },
    {
      "id": 2,
      "title": "Age",
      "kind": "numeric",
      "list_id": 1
    }
  ]
}
```
```

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

### API Error Response Example

Source: https://notisend.ru/dev/email/api

This JSON structure represents an error response from the API. It includes an 'errors' array, where each object contains an error 'code' and a 'detail' message explaining the issue.

```json
{
  "errors": [
    {
      "code": 400,
      "detail": "subject is empty"
    }
  ]
}
```

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

### Message Sending API

Source: https://notisend.ru/dev/sms/api

This section details how to send messages using the NotiSend.ru API. It covers the required parameters, authentication methods, and provides an example request.

```APIDOC
## POST /api/message/send

### Description
Sends a message to specified recipients. Requires project and signature for authentication.

### Method
POST

### Endpoint
http://sms.notisend.ru/api/message/send

### Parameters
#### Query Parameters
- **project** (string) - Required - The name of the project configured in the NotiSend.ru personal account.
- **sender** (string) - Required - The sender ID for the message.
- **message** (string) - Required - The content of the message to be sent.
- **recipients** (string) - Required - A comma-separated list of recipient phone numbers.
- **sign** (string) - Required - The signature generated for authentication. Alternatively, `apikey` can be used.

### Request Example
```
curl -X POST http://sms.notisend.ru/api/message/send \
     -H 'Accept: application/json' \
     -F project=notisend \
     -F sender=NotiSend \
     -F message=test \
     -F recipients=89031231234 \
     -F sign=3eb8e51846f271ea09378b4d1a597345
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation (e.g., 'success').
- **message_id** (string) - The unique identifier for the sent message.

#### Response Example
```json
{
  "status": "success",
  "message_id": "1234567890"
}
```

## Signature Generation

### Description
Explains how to generate the `sign` parameter for API requests. This involves sorting parameters, concatenating values, and applying SHA1 and MD5 hashing.

### Method
N/A (This is a process, not an HTTP method)

### Endpoint
N/A

### Parameters
#### Input Parameters for Signature Calculation
- **project** (string) - The project name.
- **sender** (string) - The sender ID.
- **message** (string) - The message content.
- **recipients** (string) - The recipient phone numbers.
- **apikey** (string) - The API key associated with the project.

### Process
1. **Sort Parameters**: Collect all parameters (excluding `sign` or `apikey`) and sort them alphabetically by parameter name.
2. **Concatenate Values**: Concatenate the values of the sorted parameters, separated by a semicolon (`;`).
3. **Append API Key**: Append the project's API key to the end of the concatenated string, preceded by a semicolon (`;`).
   *Example*: `sorted_param1_value;sorted_param2_value;...;apikey`
4. **SHA1 Hash**: Apply the SHA1 hashing function to the resulting string.
   *Example*: `sha1(concatenated_string)`
5. **MD5 Hash**: Apply the MD5 hashing function to the result of the SHA1 hash.
   *Example*: `md5(sha1_hash_result)`
   The final result is the `sign` parameter.

### Example Calculation
Given:
- `project=notisend`
- `sender=NotiSend`
- `message=test`
- `recipients=89031231234`
- `apikey=a1329b954831c`

1. **Sorted Parameters**: `message`, `project`, `sender`, `recipients`
2. **Concatenated String**: `test;notisend;NotiSend;89031231234`
3. **Append API Key**: `test;notisend;NotiSend;89031231234;a1329b954831c`
4. **SHA1 Hash**: `sha1("test;notisend;NotiSend;89031231234;a1329b954831c")` results in `e9336cf11651384c2ddda7e0d8a2b07de60d5720`
5. **MD5 Hash**: `md5("e9336cf11651384c2ddda7e0d8a2b07de60d5720")` results in `3eb8e51846f271ea09378b4d1a597345`

Therefore, `sign = 3eb8e51846f271ea09378b4d1a597345`.
```

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

### Send Viber Message with Rich Content

Source: https://notisend.ru/dev/sms/api/main

Example of sending a Viber message including an image and an action button. Requires the project to be configured for Viber and all three media parameters (image, button, button_url) to be provided.

```bash
curl -X GET https://sms.notisend.ru/api/message/send \
    -H 'Accept: application/json' \
    -F project=my_project_name \
    -F recipients=79121231235 \
    -F message="viber message with image" \
    -F button="Buy" \
    -F button_url="https://foo.bar/catalog" \
    -F image="https://foo.bar/images/promo.png" \
    -F sign=6263e4da2e7a0cef6f199edd3e4baa55
```

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

### Campaign Response JSON Schema

Source: https://notisend.ru/dev/email/api

Example of the JSON structure returned by the API when fetching email campaigns. It includes campaign metadata, billing status, and performance statistics.

```json
{
  "total_count": 1,
  "total_pages": 1,
  "page_number": 1,
  "page_size": 25,
  "collection": [
    {
      "id": 1,
      "from_email": "test@example.com",
      "from_name": "Test",
      "html": "<p>test</p>",
      "text": "test",
      "state": "draft",
      "recipients_count": 10,
      "purchase": {
        "enable": true,
        "subscribers": 0,
        "credits": 10,
        "deficit": 0
      },
      "statistics": {
        "delivered": 1,
        "bounced": 0,
        "delivering": 0,
        "uniq_open": 0,
        "total_open": 0,
        "last_open_at": null,
        "uniq_click": 0,
        "total_click": 0,
        "last_click_at": null,
        "unsubscription": 0,
        "spam": 0
      }
    }
  ]
}
```

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

### Send SMS via API Key

Source: https://notisend.ru/dev/sms/api/main

Example of sending a single SMS message using an API key for authentication. This method is straightforward for simple integrations.

```bash
curl -X GET https://sms.notisend.ru/api/message/send \
    -H 'Accept: application/json' \
    -F project=notisend \
    -F recipients=79121231235 \
    -F message="my api test" \
    -F apikey=a8b05d318b4b5cb1
```

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

### Initialize and Use NotiSend Python Client

Source: https://notisend.ru/dev/sms/integration/python

Demonstrates how to authenticate with the NotiSend service using a project name and API key, and how to execute core operations like sending SMS, checking balances, and managing campaigns.

```python
# -*- coding: utf-8 -*-
import notisend

# Authentication variables
project = 'o-black'
api_key = '590aaaac792d2'

# Create client object
sms = notisend.SMS(project, api_key)

# Send SMS
sms.sendSMS("79999999999", "с новым годом!", run_at="01.01.2013 00:00")

# Get account balance
balance = sms.getBalance()

# Calculate message cost
price = sms.messagePrice("79999999991,79999999992,79999999993", "проверка")

# Get phone info (operator, region)
info = sms.info("79999999991,79999999992,79999999993")
print(info['info'][0]["name"])

# Check SMS status
print(sms.statusSMS("15553126,15553516"))

# Create SMS campaign
campaign = sms.create('10000', 'текст сообщения', name='имя рассылки')
print(campaign['id'])

# Fetch groups and campaign status
sms.groups("all")
sms.status("555555")
```

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

### Get SMS Message Price

Source: https://notisend.ru/dev/sms/api/main

This endpoint allows you to get the pricing information for sending SMS messages. You need to provide the project name, recipients' phone numbers, message text, and a signature for authentication.

```APIDOC
## Get SMS Message Price

### Description
Retrieves pricing details for sending SMS messages.

### Method
GET

### Endpoint
https://sms.notisend.ru/api/message/price

### Parameters
#### Query Parameters
- **project** (string) - Required - The name of the project.
- **recipients** (string) - Required - A comma-separated string of recipient phone numbers.
- **message** (string) - Required - The UTF-8 encoded text of the message.
- **sign** (string) - Required - A lowercase signature of the request for authentication.
- **apikey** (string) - Optional - An API key for authentication (alternative to `sign`).

### Request Example
```curl
curl -X GET https://sms.notisend.ru/api/message/price \
    -H 'Accept: application/json' \
    -F project=notisend \
    -F recipients=79121231235 \
    -F message="my api test" \
    -F sign=c894bff0ce53f7aefb3c80b470b26a28
```

### Response
#### Success Response (200)
- **status** (string) - Indicates 'success' if the request was processed successfully.
- **recipients** (array) - An array of valid recipient phone numbers (10 characters each).
- **parts** (integer) - The number of parts the message is divided into.
- **count** (integer) - The total number of messages to be sent.
- **price** (number) - The calculated price for sending the messages.
- **balance** (number) - The remaining balance on the account.

#### Error Response (e.g., 400)
- **status** (string) - Indicates 'error' if there was an issue.
- **error** (integer) - An error code.
- **message** (string) - A description of the error.

#### Response Example (Success)
```json
{
  "status": "success",
  "recipients": [
    "9121231234",
    "9121231235"
  ],
  "parts": 1,
  "count": 2,
  "price": 0.7,
  "balance": 99.3
}
```

#### Response Example (Error)
```json
{
  "status": "error",
  "error": 2,
  "message": "invalid signature"
}
```

### Error Codes
- **1**: `param project is blank` - The project parameter is empty.
- **2**: `invalid signature` - The request signature is invalid.
- **3**: `param message is blank` - The message parameter is empty.
- **4**: `param recipients is blank` - The recipients parameter is empty.
- **5**: `project not found` - The specified project was not found.
- **6**: `recipients not found or bad format` - The recipients parameter is empty or has a bad format.
- **7**: `not enough money` - Insufficient funds on the account to calculate the price. A positive balance is required.
```

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

### PHP SMS Gateway Integration with NotiSend

Source: https://notisend.ru/dev/sms/integration/php

This snippet demonstrates how to integrate the NotiSend SMS gateway into a PHP application. It covers initializing the API client, checking the balance, sending SMS messages, handling different character encodings, retrieving server responses, checking message statuses, querying message prices, obtaining phone number information, and canceling scheduled messages. Dependencies include the 'notisend.class.php' file. Inputs typically include project credentials, recipient numbers, message content, sender ID, and optional parameters for scheduling and testing. Outputs include balance information, sending status (true/false), message statuses, pricing, and phone info arrays.

```php
<?php
// Подключение класса
require_once 'notisend.class.php' ;

// NotiSend Инициализация объекта
// Список параметров ($project, $key, $useSSL = false, $testMode = false)
// $project - название проекта
// $key - ключ проекта
// $useSSL - не обязательный параметр, если true то взаимодействие будет осуществляться по протоколу https иначе http
// $testMode - не обязательный параметр, если true то сообщения не будут отправляться и деньги не будут списываться(используется для отладки)
$api = new Notisend ( 'your_project_name' , 'e24a61ef07e80', false, false );

// getBalance Запрос баланса, возвращает остаток на балансе в случае успеха и false в случае ошибки
// Параметров нет
echo 'Текущий баланс: ' . $api->getBalance (), PHP_EOL ;

// sendSMS отправка SMS, возвращает true в случае успеха, false в случае ошибки
// список параметров sendSMS($recipients, $message, $sender, $run_at = null)
// $recipients - получатели в любом формате, пример 89121231234,9121231235
// $message - текст сообщения в кодировке UTF-8
// $sender - имя отправителя
// %run_at - не обязательный параметр, дата и время кода будет отправлено сообщение, пример '03.10.2011 17:00'.
echo 'отправка СМС/а SMS: ' . $api->sendSMS ( '89121231234' , 'api test' , 'notisend', '03.10.2011 17:00' ), PHP_EOL ;

Если используется отличная от UTF-8 кодировок, $message необходимо конвертировать в UTF-8 ( в PHP можно использовать например iconv или mb_convert_encoding )
$api->sendSMS ( '89121231234' , mb_convert_encoding("апи тест", "UTF-8") , 'notisend', '03.10.2011 17:00' );

// getResponse - последний ответ от сервера
$response = $api->getResponse ();
// checkStatus запрос статуса сообщения, возвращает ассоциативный массив статусов, пример {"1567" : "delivered", "1568" : "accepted"} 
// список параметров checkStatus ($messagesId)
// $messagesId - id сообщений через запятую, пример 1567,1568 
$result = $api->checkStatus ( $response [ 'messages_id' ]);
foreach ( $result as $message_id => $status ) {
echo sprintf ( 'Статус сообщения %s: %s' , $message_id , $status ), PHP_EOL ;
}

// messagePrice - запрос стоимости SMS, возвращает сумму которая спишется в случае отправки сообщения или false в случае ошибки
// список параметров ($recipients, $message)
// $recipients - получатели в любом формате, пример 89121231234,9121231235
// $message - текст сообщения
echo 'запрос стоимости SMS: ' . $api->messagePrice ( '89121231234,9121231235', 'api test' ), PHP_EOL ;


// phoneInfo - запрос информации о номерах, возвращает массив ответов содержащий названия операторов, регион, код.
// список параметров phoneInfo( $phones )
// $phones - номера телефонов в любом формате, пример 89121231234,9121231235
echo 'запрос информации о номерах: ' . $api->phoneInfo ( '89121231234,9121231235' ), PHP_EOL ;

// cancelSMS отмена запланированного сообщения, возвращает ассоциативный массив статусов, пример {"1567" : "canceled", "1568" : "canceled"} 
// список параметров cancelSMS ($messagesId)
// $messagesId - id сообщений через запятую, пример 1567,1568 
// $api->cancelSMS ( $response [ 'messages_id' ]);

// Для отладки используйте getResponse
// $response = $api->getResponse ();
// var_dump($response);
// В случае обнаружение каких либо ошибок обращайтесь в техническую поддержку sms.notisend.ru http://sms.notisend.ru/support/run
?>
```

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

### GET /api/group/list

Source: https://notisend.ru/dev/sms/api/group

Retrieves a list of SMS recipient groups associated with a project.

```APIDOC
## GET /api/group/list

### Description
Returns a list of groups filtered by type.

### Method
GET

### Endpoint
https://sms.notisend.ru/api/group/list

### Parameters
#### Query Parameters
- **project** (string) - Required - Name of the project
- **type** (string) - Optional - Type of groups (all, system, user, main, stop)
- **sign** (string) - Required - Request signature in lowercase

### Request Example
https://sms.notisend.ru/api/group/list?project=notisend&sign=e2271659a8b05d318b4b53c644ba8b47

### Response
#### Success Response (200)
- **id** (number) - ID of the group
- **name** (string) - Name of the group
- **type** (string) - Type of the group
- **contacts** (number) - Number of contacts in the group

#### Response Example
{
  "id": 1,
  "name": "Моя группа контактов",
  "type": "user",
  "contacts": 550
}
```

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

### Send and Manage SMS with NotiSend C# Library

Source: https://notisend.ru/dev/sms/integration/csharp

Demonstrates the initialization of the SmsApi object and usage of core methods including balance retrieval, cost estimation, message dispatch, status tracking, cancellation, and phone information lookup.

```csharp
Sms sms = new Sms("myshop", "c72a61ef07e80");

// getBalance() Запрос баланса
ResponseBalance rBalance = sms.getBalance();
if (rBalance.status == "success") MessageBox.Show(rBalance.balance);
else MessageBox.Show(rBalance.message);

// getMessagesPrice(sender, recipients, message) запрос стоимости
ResponsePrice rprice = sms.getMessagesPrice("89121231234,9121231235", "api_test");
if (rprice.status == "success") MessageBox.Show(rprice.price);
else MessageBox.Show(rprice.message);

// send(sender, recipients, message, run_at) - отправка сообщения
ResponseSend rsend = sms.send("testsend", "89999999998,9999999999", "testtext");
if (rsend.status == "success") MessageBox.Show("ok");
else MessageBox.Show(rsend.message);

// getMessagesStatus(messages_id) - запрос статуса сообщений
ResponseStatus rstatus = sms.getMessagesStatus("119,118");
if (rstatus.status == "success") MessageBox.Show("119 - " + rstatus.messages["119"] + "; 118 - " + rstatus.messages["118"]);
else MessageBox.Show(rstatus.message);

// cancelSms(messages_id) - отмена запланированных сообщений
ResponseCancel rcancel = sms.cancelSms("119,118");
if (rcancel.status == "success") MessageBox.Show("119 - " + rcancel.messages["119"] + "; 118 - " + rcancel.messages["118"]);
else MessageBox.Show(rcancel.message);

// info(phones) - запрос информации по номерам
ResponseInfo rinfo = sms.info("89121231234,9121231235");
if (rinfo.status == "success")
{
    foreach (PhoneInfo pi in rinfo.info)
    {
        MessageBox.Show("Номер - " + pi.phone + "; Оператор - " + pi.name + "; Регион - " + pi.region);
    }
}
else MessageBox.Show(rinfo.message);
```

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

### GET /email/segments

Source: https://notisend.ru/dev/email/api

Retrieves a paginated list of email segments.

```APIDOC
## GET /email/segments

### Description
Retrieves a list of available segments. Supports pagination with a maximum page_size of 1000.

### Method
GET

### Endpoint
https://api.notisend.ru/v1/email/segments

### Response
#### Success Response (200)
- **id** (integer) - Segment identifier
- **title** (string) - Segment name

#### Response Example
{
  "collection": [{"id": 1, "title": "Segment Number One"}]
}
```

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

### POST /api/contact/create

Source: https://notisend.ru/dev/sms/api/contact

Creates one or more SMS contacts in the NotiSend system. Supports bulk creation by passing multiple phone numbers as a comma-separated string or an array.

```APIDOC
## POST /api/contact/create

### Description
Creates new SMS contacts. You can add up to 1000 numbers in a single request.

### Method
POST

### Endpoint
https://sms.notisend.ru/api/contact/create

### Parameters
#### Query Parameters
- **project** (string) - Required - Project name
- **phone** (string/array) - Required - One or more phone numbers
- **group** (string) - Optional - Group ID
- **lastname** (string) - Optional - Last name
- **firstname** (string) - Optional - First name
- **patronymic** (string) - Optional - Patronymic
- **birthday** (string) - Optional - Date of birth (DD.MM.YYYY)
- **param1** (string) - Optional - Custom parameter 1
- **param2** (string) - Optional - Custom parameter 2
- **sign** (string) - Required - Request signature in lowercase

### Request Example
https://sms.notisend.ru/api/contact/create?project=notisend&phone=89599224424&firstname=Иван&sign=e2271659a8b05d3

### Response
#### Success Response (200)
- **phones** (array) - List of formatted phone numbers
- **group** (array/int) - Group ID or list of group IDs

#### Response Example
{
  "phones": ["89599224424"],
  "group": 1
}
```

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

### POST /email/campaigns

Source: https://notisend.ru/dev/email/api

Creates a new email campaign with a 'draft' status.

```APIDOC
## POST /email/campaigns

### Description
Creates a new email campaign with a 'draft' status. Use other methods to send the campaign.

### Method
POST

### Endpoint
https://api.notisend.ru/v1/email/campaigns

### Request Body
- **from_email** (string) - Required - Sender email
- **subject** (string) - Required - Email subject
- **text** (string) - Optional - Plain text content
- **html** (string) - Optional - HTML content
- **lists** (array) - Optional - List of recipient IDs

### Response Example
{
  "id": 1,
  "state": "draft",
  "from_email": "hello@world.com"
}
```

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

### POST /email/organizations

Source: https://notisend.ru/dev/email/api

Creates a new organization profile.

```APIDOC
## POST /email/organizations

### Description
Creates a new organization in the system.

### Method
POST

### Endpoint
https://api.notisend.ru/v1/email/organizations

### Parameters
#### Request Body
- **name** (string) - Required
- **address** (string) - Required
- **country** (string) - Required
- **city** (string) - Required
- **phone** (string) - Required
- **zip** (string) - Required

### Response
#### Success Response (200)
- **id** (integer) - Organization ID
- **current** (boolean) - Default status

#### Response Example
{
  "id": 1,
  "name": "My Organization",
  "current": true
}
```

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

### GET /email/organizations/:id

Source: https://notisend.ru/dev/email/api

Retrieves detailed information about a specific organization.

```APIDOC
## GET /email/organizations/:id

### Description
Fetches details for a specific organization by its ID.

### Method
GET

### Endpoint
https://api.notisend.ru/v1/email/organizations/:id

### Parameters
#### Path Parameters
- **id** (integer) - Required - The organization identifier.

### Response
#### Success Response (200)
- **id** (integer) - Organization ID
- **name** (string) - Organization name

#### Response Example
{
  "id": 1,
  "name": "My Organization"
}
```

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

### Perform SMTP Session Authentication and Email Delivery

Source: https://notisend.ru/dev/email/api

Demonstrates a manual SMTP session using telnet to authenticate via PLAIN mechanism and send an email with custom headers. Requires valid credentials obtained from the Notisend dashboard.

```text
$ telnet smtp.msndr.net 25
...
ehlo sender
auth plain AHVzZXJAZXhhbXBsZS5vcmcAc29tZS1zdXBlci1wdXBlci1zZWNyZXQta2V5
mail from: mail@from.com
rcpt to: rcpt@to.com
data
From: Mail From <mail@from.com>
Subject: Hello
X-Client-Id: 123

How are you doing?
.
quit
```

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

### Send Email via SMTP Protocol (PHP)

Source: https://notisend.ru/dev/email/api

Implements a manual SMTP client using PHP's `fsockopen` to establish a connection. It handles EHLO, AUTH PLAIN authentication, and the DATA command sequence to transmit an email.

```PHP
<?php
error_reporting(E_ALL);
ini_set('display_errors', 1);
$smtp_config = [
  'host' => 'smtp.msndr.net',
  'port' => 587,
  'username' => 'CHANGE_ME',
  'password' => 'CHANGE_ME',
  'from' => 'CHANGE_ME',
  'to' => 'CHANGE_ME',
  'subject' => 'Test Subject',
  'message' => 'Test Message'
];
extract($smtp_config);
$s = fsockopen($host, $port);
if ($s) {
  fgets($s);
  fputs($s, "EHLO localhost\r\n"); while(fgets($s)){}
    $auth = base64_encode("\0" . $username . "\0" . $password);
  fputs($s, "AUTH PLAIN $auth\r\n");
  if (strpos(fgets($s), '235') !== false) {
    fputs($s, "MAIL FROM: <$from>\r\n"); fgets($s);
    fputs($s, "RCPT TO: <$to>\r\n"); fgets($s);
    fputs($s, "DATA\r\n"); fgets($s);
    fputs($s, "Subject: $subject\r\n\r\n$message\r\n.\r\n");
    echo "Result: " . fgets($s);
  } else {
    echo "Authentication failed";
  }
  fputs($s, "QUIT\r\n");
  fclose($s);
} else {
  echo "Connection failed";
}
```

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

### Get Default Sender Name

Source: https://notisend.ru/dev/sms/api/sender

Retrieves the currently set default sender name for your project.

```APIDOC
## GET /api/sender/default

### Description
Retrieves the sender name that is currently set as the default for the specified project.

### Method
GET

### Endpoint
https://sms.notisend.ru/api/sender/default

### Parameters
#### Query Parameters
- **project** (string) - Required - The name of the project.
- **sign** (string) - Required - A signature for the request, in lowercase.

### Request Example
https://sms.notisend.ru/api/sender/default?project=notisend&sign=e2271659a8b05d318b4b53c644ba8b47

### Response
#### Success Response (200)
- **project** (string) - The name of the project.
- **sender** (string) - The name of the default sender.

#### Response Example
{
  "project": "notisend",
  "sender": "sendertest"
}
```
Tokens:
Raw