Get virtual sender information

Description

Retrieves a virtual sender detailed information.

Request URL

Method: POST

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

Request parameters

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

Request example

JSON

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

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <id>2</id>
</xml>

Response example

JSON

{
    "data": {
        "id": 1,
        "name": "Virtual sender",
        "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>
    <id>1</id>
    <name>Virtual sender</name>
    <email_rules>
      <type>default</type>
      <value></value>
      <senders>
        <from_email></from_email>
        <replyto_email></replyto_email>
        <from_name></from_name>
        <sender_id>3</sender_id>
        <percent>100</percent>
      </senders>
    </email_rules>
    <sms_rules/>
    <custom_channels/>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error type
error_text	string	Error text
id	int	Virtual sender ID
name	string	Virtual sender name
email_rules	JSON array	Rules for email senders
sms_rules	JSON array	Rules for SMS senders