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 |
|---|---|---|
| data | object |
Details (see data object below) |
| 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 |
| links | object |
Details (see links object below) |
| Name | Type | Description |
|---|---|---|
| self | string | URL of the sender |
| account | string | URL of the account |
Example of request body
Example of response body
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 |