Get virtual senders list

Description

Retrieves a list of virtual senders.

Request URL

Method: POST

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

Request parameters

Parameter	Type	Example	Required	Description
from_id	int	1	No	The first virtual sender on the list ID. By default – 1
limit	int	2	No	Virtual senders list limit. By default – 1000

Request example

JSON

{
    "limit": 2
}

XML

<xml>
    <limit>2</limit>
</xml>

Response example

JSON

{
    "data": [
        {
            "email_channel": true,
            "id": 1,
            "name": "AKMTA virtual sender",
            "push_channel": false,
            "sms_channel": false,
            "custom_channels": []
        },
        {
            "email_channel": false,
            "id": 2,
            "name": "Bulk SMS virtual sender",
            "push_channel": true,
            "sms_channel": true,
            "custom_channels": ["telegram_bot", "whatsapp"]
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "total_count": 2
}

XML

<xml>
<data>
    <custom_channels array='true'></custom_channels>
    <email_channel>true</email_channel>
    <id>1</id>
    <name>AKMTA virtual sender</name>
    <push_channel>false</push_channel>
    <sms_channel>false</sms_channel>
  </data>
  <data>
    <custom_channels array='true'>
      <item>telegram_bot</item>
      <item>whatsapp</item>
    </custom_channels>
    <email_channel>false</email_channel>
    <id>2</id>
    <name>Bulk SMS virtual sender</name>
    <push_channel>true</push_channel>
    <sms_channel>true</sms_channel>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <total_count>2</total_count>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
name	string	Virtual sender name
sms_channel	bool	true, if SMS channel is active
email_channel	bool	true, if email channel is active
push_channel	bool	true, if push channel is active
custom_channels	JSON array	Array of custom channel SIDs