Rasel / Docs
EN
GET/api/v2/sms-senders

List SMS sender names

Sender names for the account. Use approvedOnly=true before sending via /api/v2/messages/send.

When to use it. Pick sender.id for a send request.

Code example

Correct: Approved only

curl --location 'https://raselsms.com/api/v2/sms-senders' \--header 'X-API-Key: YOUR_API_KEY'

Response example

200 — Approved only

{  "success": true,  "data": {    "smsSenders": [      {        "id": "6800abc123def4567890fedc",        "name": "MyBrand",        "status": "approved",        "isDefault": true,        "reviewNote": null      }    ]  }}

401 — Missing or invalid API key.

{  "success": false,  "requestId": "msgreq_1739012345678_abc123",  "code": "UNAUTHORIZED",  "error": "Missing or invalid API key"}

403 — Phone is not verified or the key lacks permission (usually messages:create or api_keys:read).

{  "success": false,  "requestId": "msgreq_1739012345678_abc123",  "code": "FORBIDDEN",  "error": "Phone not verified or missing permission"}

429 — Rate limit exceeded. Honor Retry-After when present.

{  "success": false,  "requestId": "msgreq_1739012345678_abc123",  "code": "RATE_LIMITED",  "error": "Rate limit exceeded",  "retryAfterSeconds": 30}

HTTP request

GET /api/v2/sms-senders

Request Headers

HeaderTypeDescription
X-API-KeystringYour Rasel API key. Send it on every documented request except inbound webhooks. *

Query parameters

FieldTypeDescription
approvedOnlybooleanWhen true, only approved (and for official senders, enabled) rows are returned.

Response Fields

FieldTypeDescriptionExample
successbooleanTrue when the operation succeeded, or when at least one batch recipient succeeded.
dataobjectPrimary payload for list and snapshot endpoints.
data.smsSendersjsonApproved SMS sender names on this account.

Status Codes

StatusDescription
200Success.
401Missing or invalid API key.
403Phone not verified, missing permission, or the account cannot perform this action.
429Rate limit exceeded, or the maximum number of verification attempts was reached.

Try it

Parameters

When true, only approved (and for official senders, enabled) rows are returned.

Request

GET /api/v2/sms-senders

Response

Send a request to see the response.