Get senders list

Description

Retrieves Altcraft service instance senders list.

Request URL

Method: POST

https://example.com/api/v1.1/admin/senders/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 sender ID on the list By default –1
limit	int	100	No	Senders list limit By default – 1000

Request example

JSON

{
  "token": "abcdefghijklmnqrstuvwxyz"
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
</xml>

Response example

JSON

{
    "data": [
        {
            "id": 3,
            "name": "Email sender",
            "type": "akmta",
            "channel_type": "email"
        },
        {
            "id": 6,
            "name": "new sender",
            "type": "sms_notify",
            "channel_type": "custom"
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "total_count": 4
}

XML

<xml>
    <data>
        <channel_type>email</channel_type>
        <id>3</id>
        <name>Email sender</name>
        <type>akmta</type>
    </data>
    <data>
        <channel_type>custom</channel_type>
        <id>6</id>
        <name>new sender</name>
        <type>sms_notify</type>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <total_count>4</total_count>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
id	int	Sender ID
name	string	Sender name
type	string	Sender type
channel_type	string	Communication channel