Get virtual sender information

Description

Retrieves a virtual sender information.

Request URL

Method: POST

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

Request example

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
account_id	int	306	Yes	Account ID
id	int	12	Yes	Virtual sender ID
format	string	"json"	No	Response data format By default – json

Request example

JSON

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

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <id>1</id>
  <account_id>1</account_id>
</xml>

Response example

JSON

{
    "data": {
        "id": 1,
        "name": "Virtual sender12",
        "email_rules": [
            {
                "type": "default",
                "value": "",
                "senders": [
                    {
                        "from_email": "",
                        "replyto_email": "",
                        "from_name": "",
                        "sender_id": 3,
                        "percent": 100
                    }
                ]
            }
        ],
        "sms_rules": [],
        "custom_channels": {}
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <data>
        <custom_channels/>
        <email_rules>
            <senders>
                <from_email/>
                <from_name/>
                <percent>100</percent>
                <replyto_email/>
                <sender_id>3</sender_id>
            </senders>
            <type>default</type>
            <value/>
        </email_rules>
        <id>1</id>
        <name>Virtual sender12</name>
        <sms_rules/>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
id	int	Virtual sender ID
name	string	Virtual sender name
email_rules	JSON-object	Rules for email sender
sms_rules	JSON-object	Rules for SMS sender