Get virtual senders list

Description

Retrieves virtual senders detailed information.

Request URL

Method: POST

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

Request examples

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
account_id	int	306	Yes	Account ID
from_id	int	11768	No	The first virtual sender ID on the list By default –1
limit	int	10	No	Virtual senders list limit By default – 1000
format	string	"json"	No	Response data format By default – json

Request example

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "limit": 2,
    "account_id": 1
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <limit>2</limit>
    <account_id>1</account_id>
</xml>

Response example

JSON

{
    "data": [
        {
            "id": 1,
            "name": "Virtual sender12",
            "sms_channel": false,
            "email_channel": true,
            "custom_channels": {}
        },
    ],
    "error": 0,
    "error_text": "Successful operation",
    "total_count": 10
}

XML

<xml>
    <data>
        <custom_channels/>
        <email_channel>true</email_channel>
        <id>1</id>
        <name>Virtual sender12</name>
        <sms_channel>false</sms_channel>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <total_count>10</total_count>
</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
sms_channel	bool	true if SMS channel is enabled
email_channel	bool	true if email channel is enabled