Sender

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: Read

Get sender details.

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

Headers

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

Request Body

-empty-

Response Parameters

Name Type Description Status
data object

Details

(see data object below)
Optional
data object
Name Type Description Status
id string Unique identifier of the sender Optional
account_id string Unique identifier of the account Optional
name string Name (unique identifier) of the sender Optional
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
Optional
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
Optional
type string Type of the sender.
Possible values: alphanumeric, short-code, local, mobile, toll-free
Optional
status string Status of the sender.
Possible values: pending, available, rejected
Optional
country string ISO country code of the sender Optional
monthly_cost string Optional
create_date string Creation date of the sender in UTC, formatted as yyyy-MMdd HH:mm:ss Optional
update_date string Update date of the sender in UTC, formatted as yyyy-MMdd HH:mm:ss Optional
links object

Details

(see links object below)
Optional
links object
Name Type Description Status
self string URL of the sender Optional
account string URL of the account Optional

Example of request body

GET: /v1/senders/48e200b7-be98-4360-b5c7-5dfac16b06f9
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 'data.name' is required
1405 'data.name' is invalid
1406 'data.name' is too long
1407 ‘data.code' is invalid
1408 'data.code' is too long
1409 'data.code' is required
1410 data.country’ is required
1414 'data.channel' value should be: [SMS, VIBER, WHATSAPP]
1439 Invalid status
1440 'data.code' already ordered
1441 'data.name' exists on this channel