Get virtual senders list
Description
Retrieves a list of virtual senders.
Request URL
Method: POST
https://example.com/api/v1.1/vsenders/list
Request parameters
Parameter | Type | Example | Required | Description |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Yes | API token |
format | string | "json" | No | Response data format. By default – json |
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
{
"limit": 2,
"token": "abcdefghijklmnqrstuvwxyz"
}
Response example
{
"data": [
{
"email_channel": true,
"id": 1,
"name": "AKMTA virtual sender",
"sms_channel": false
},
{
"email_channel": false,
"id": 2,
"name": "Bulk SMS virtual sender",
"sms_channel": true
}
],
"error": 0,
"error_text": "Successful operation",
"total_count": 2
}
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 |