GET /sms/lines/{line}/scheduled
List scheduled messages
| Scope | sms:read |
| Role permission | Phone numbers — line must be one of theirs |
| Cost | Free |
What is queued to go out from this line, with the price each will cost.
Path parameters
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
line | string | yes | 12125550188 | One of your account's numbers. Digits. |
Responses
200
The queued messages.
| Field | Type | Description |
|---|---|---|
[].id | integer | |
[].line | string | |
[].recipients | string[] | |
[].subject | string | |
[].text | string | |
[].media | string[] | |
[].sendAt | string (RFC 3339) | |
[].price | number | What it will cost, fixed at the moment it was scheduled. A later rate-card change does not re-price a message you already committed to; the charge lands when it goes out. |
[].currency | USD |
Errors
| Status | Meaning |
|---|---|
400 | invalid_request — a missing or malformed field, an unknown enum value, or an unknown field in the body. Nothing was charged. |
401 | unauthenticated — no credential, or one that is invalid, revoked or expired. The WWW-Authenticate header names the scope the endpoint wanted. |
403 | Two different failures share this status, and the type tells them apart: |
500 | internal_error — something failed on our side. For a send, nothing was charged, guaranteed, which is what makes a retry safe. |
See Errors for the full catalog and what to do about each.
Example
curl -X GET 'https://api.account.telebroad.com/api/public/v1/sms/lines/12125550188/scheduled' \
-H "Authorization: Bearer $TB_KEY"