Добавить виртуальный сендер
Описание
Добавить виртуальный сендер.
URL-адрес
Метод: POST
https://example.com/api/v1.1/vsenders/add
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
format | string | "json" | Нет | Формат возвращаемых данных (по умолчанию – "json") |
name | string | "New virtual sender" | Да | Название виртуального сендера |
email_rules | JSON array | "email_rules": [] | Да | Правила для email сендеров |
sms_rules | JSON array | "sms_rules": [] | Да | Правила для SMS сендеров |
Пример запроса
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"name": "New virtual sender",
"email_rules": [
{
"senders": [
{
"from_email": "",
"from_name": "",
"percent": 100,
"replyto_email": "",
"sender_id": 3
}
],
"type": "default",
"value": ""
}
],
"sms_rules": []
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<name>New virtual sender</name>
<email_rules array ='true'>
<senders array = 'true'>
<from_email/>
<from_name/>
<percent>100</percent>
<replyto_email/>
<sender_id>3</sender_id>
</senders>
<type>default</type>
<value/>
</email_rules>
</xml>
Пример ответа
- JSON
- XML
{
"data": {
"saved_id": 8
},
"error": 0,
"error_text": "Successful operation"
}
<xml>
<error>0</error>
<error_text>Successful operation</error_text>
<data>
<saved_id>9</saved_id>
</data>
</xml>
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
error | int | Код ошибки |
error_text | string | Текст ошибки |
saved_id | int | Идентификатор нового виртуального сендера |