Skip to content

Sender List GET ​

Returns the sender names your account may send SMS with. Use one as from in Send SMS.

Authorization ​

API Key (Authentication) in the header Authorization: Bearer <API_KEY>.

HTTP Request ​

http
GET https://public-api.smsup-plus.com/sms/senderlist

Content Type ​

No body and no query parameters.

Parameter Description ​

None — the account is taken from the API key.

Response Description ​

PropertyTypeDescription
statusnumber200
dataarray of stringSender names approved for the account (unique, case-insensitive) — [] when there are none

Request Example ​

bash
curl 'https://public-api.smsup-plus.com/sms/senderlist' \
  -H 'Authorization: Bearer <API_KEY>'
js
const res = await fetch('https://public-api.smsup-plus.com/sms/senderlist', {
  headers: { Authorization: 'Bearer <API_KEY>' },
})
console.log(await res.json())

Response Example ​

json
{
  "status": 200,
  "data": ["MyBrand", "MyShop"]
}

Possible Errors ​

See Error Codes for the overview.

HTTPResponseCause
401{"error":{"statusCode":"401","description":"Invalid account","message":"UNAUTHORIZED"}}No account could be resolved from the credentials
404{"error":{"statusCode":"404","description":"Account not found","message":"NOT_FOUND"}}Account not found
429{"error":{"statusCode":"429","description":"rate limit exceeded: max 50 requests per second per account","message":"TOO_MANY_REQUESTS"}}Too many requests — wait as told by Retry-After
500{"error":{"statusCode":"500","description":"Failed to load sender list","message":"INTERNAL_ERROR"}}Temporary failure loading the list