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

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

Response example

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

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