Sender endpoints are meant to manage the senders of the account. Sender is a code belonging to the account, which can be used as a sender identifier for messages. Sender IDs can be alphanumeric Senders, Numeric Long Codes, and Short Codes. As an alphanumeric Sender ID, the user can set the name of the brand or company that the recipient will see as the Sender name of the message.

The length of Sender ID must be up to 11 characters, and it can include combinations of both alphabetical and numerical characters. Based on network operators, the other characters can be supported or not. SMS recipients cannot reply to alphanumeric Sender IDs. As a Numeric Long Code, the user can purchase a phone number from an available numbers list. The number can be up to 15 digits. For Short Code, the user needs to register the application manually and receive from 5 to 6 digits code which can be used as a Sender ID. In that case, the user can reply to the message.

Method: Query

Operation to query all senders.

URL /v1/senders
Method Type GET
Authorization API Key
Request Content-Type JSON
Response Content-Type JSON


Name Type Description Status
X-Dexatel-Key string API key Required

Query parameters

Name Type Description Status
filter[channel] string Filters senders by the channel Optional
filter[type] string Filters senders by the senders type Optional
filter[name] string Filter senders by name Optional
filter[status] string Filter senders by status Optional
page_token string token with encoded pagination details Optional
page_size string number of records to be retrieved Optional

Request Body


Response Parameters

Name Type Description
data array


(see data object below)
pagination object


(see pagination object below)
data object
Name Type Description
id string Unique identifier of the sender
account_id string Unique identifier of the account
name string Name (unique identifier) of the sender
code string User's company or brand name used as a sender identifier.
Possible values:
did - up to 15 digits string, consisting of numbers only,
short code - from 5 to 6 digits string consisting of numbers only,
alphanumeric - up to 11 digits string, combination of alphabetical and numerical characters
channel string Channel for which the sender can be used for.
Possible values: SMS, VIBER, WHATSAPP
Note: Every channel can use only its own senders
type string Type of the sender.
Possible values: alphanumeric, short-code, local, mobile, toll-free
status string Status of the sender.
Possible values: pending, available, rejected
country string ISO country code of the sender
monthly_cost string Monthly price for acquiring the number
create_date string Creation date of the sender in UTC, formatted as yyyy-MMdd HH:mm:ss
update_date string Update date of the sender in UTC, formatted as yyyy-MMdd HH:mm:ss
pagination object
Name Type Description
number integer Number of current page
size integer Items count in page
total integer Total count of items
links object


(see links object below)
links object
Name Type Description
first string
current string
previous string
next string

Example of request body

GET: /v1/senders
X-Dexatel-Key: 94d2f2f2884848bca861264ad86d8ace

Example of response body

status - 200


Error Codes

The following error codes are returned in response to a user’s request which contains bad syntax or cannot be fulfilled.

Code Description
1402 Sender not found
1403 'data' is required
1404 '' is required
1405 '' is invalid
1406 '' is too long
1407 ‘data.code' is invalid
1408 'data.code' is too long
1409 'data.code' is required
1410’ is required
1414 '' value should be: [SMS, VIBER, WHATSAPP]
1439 Invalid status
1440 'data.code' already ordered
1441 '' exists on this channel