Получить информацию о виртуальном сендере

Описание

Получить информацию о виртуальном сендере.

URL-адрес

Метод: POST

https://example.com/api/v1.1/vsenders/get

Параметры запроса

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
id	int	1	Да	Идентификатор виртуального сендера
format	string	"json"	Нет	Формат возвращаемых данных (по умолчанию – "json")

Пример запроса

{
    "id": 1,
    "token": "abcdefghijklmnqrstuvwxyz"
}

Пример ответа

{
    "data": {
        "id": 1,
        "name": "Example virtual sender",
        "email_rules": [
            {
                "type": "from_domain",
                "value": "example.com",
                "senders": [
                    {
                        "from_email": "noreply@example.com",
                        "from_name": "",
                        "percent": 100,
                        "replyto_email": "noreply@example.com",
                        "sender_id": 1
                    }
                ]
            }
        ],
        "sms_rules": [
            {
                "type": "default",
                "value": "",
                "senders": [
                    {
                        "from_email": "",
                        "from_name": "Example",
                        "percent": 100,
                        "replyto_email": "",
                        "sender_id": 2
                    }
                ]
            }
        ]
    },
    "error": 0,
    "error_text": "Successful operation"
}

Возвращаемые параметры

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
id	int	Идентификатор виртуального сендера
name	string	Название виртуального сендера
email_rules	JSON array	Email-правила
sms_rules	JSON array	SMS-правила