Get senders list

Description

Retrieves a list of senders available for the current account.

Request URL

Method: POST

https://example.com/api/v1.1/senders/list

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
from_id	int	2	No	The first sender on the list ID. By default – 1
limit	int	10	No	Senders list limit. By default – 1000
format	string	"json"	No	Response data format. By default – json

Request example

JSON

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

XML

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

Response example

JSON

{
    "data": [
        {
            "channel": "email",
            "id": 1,
            "name": "AKMTA sender",
            "type": "akmta"
        },
        {
            "channel": "sms",
            "id": 2,
            "name": "Bulk SMS sender",
            "type": "bulksms_com"
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "next_from_id": 3,
    "total_count": 2
}

XML

<xml>
    <data>
        <channel>email</channel>
        <id>3</id>
        <name>Email sender</name>
        <type>akmta</type>
    </data>
    <data>
        <channel>sms</channel>
        <id>2</id>
        <name>Bulk SMS sender</name>
        <type>bulksms_com</type>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <next_from_id>5</next_from_id>
    <total_count>5</total_count>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
next_from_id	int	The index must be passed in the next request to receive another piece of data, until the result output contains 0 history lines
id	int	Sender ID
name	string	Sender name
type	string	Sender type
channel	string	Communication channel