# List SMS (/docs/api-reference/sms/list-sms)

Messages sent from the API key's environment, newest first. Pass the last `id` as `after` to get the next page while `has_more` is true.

`GET https://api.coss.com/v1/sms`

Authenticate with your API key as a bearer token (`Authorization: Bearer coss_test_…`). Responses are JSON with snake_case fields; errors are `{ error: { type, code, message, param?, issues?, request_id } }` (https://coss.com/docs/api-reference/errors.md).

## Query parameters

- `to` (string): Only messages to this number.
- `status` (string): Only messages in these statuses, comma-separated: `failed`.
- `created_after` (string, date-time): Only messages created at or after this time.
- `created_before` (string, date-time): Only messages created before this time.
- `limit` (integer, 1-100): 1-100, default 20.
- `after` (string, at most 64 characters): Cursor: the `id` of the last item of the previous page.

## Example request

TypeScript (the `coss` package):

```ts
import { Coss } from "coss";

const coss = new Coss({
  apiKey: process.env.COSS_API_KEY,
  baseUrl: "https://api.coss.com",
});

const { data, error } = await coss.sms.list();
```

HTTP:

```sh
curl -X GET "https://api.coss.com/v1/sms" \
  -H "Authorization: Bearer $COSS_API_KEY"
```

Python:

```python
from coss import Coss

client = Coss()  # api_key= or COSS_API_KEY

client.sms.list()
```

Go:

```go
import (
	"context"

	coss "github.com/cosscom/coss-go"
	cossclient "github.com/cosscom/coss-go/client"
)

client := cossclient.NewClient() // option.WithAPIKey(…) or COSS_API_KEY

request := &coss.ListSmsRequest{}
client.Sms.List(
    context.TODO(),
    request,
)
```

Ruby:

```ruby
require "coss"

client = Coss::Client.new # api_key: or COSS_API_KEY

client.sms.list
```

PHP:

```php
<?php

use Coss\Coss;
use Coss\Sms\Requests\ListSmsRequest;

$client = new Coss(); // apiKey: or COSS_API_KEY

$client->sms->list(
    new ListSmsRequest([]),
);
```

Java:

```java
import com.coss.Coss;
import com.coss.resources.sms.requests.ListSmsRequest;

Coss client = Coss.builder().build(); // .apiKey(…) or COSS_API_KEY

client.sms().list(
    ListSmsRequest
        .builder()
        .build()
);
```

.NET:

```csharp
using Coss;

var client = new CossClient(); // apiKey: or COSS_API_KEY

await client.Sms.ListAsync(new ListSmsRequest());
```

## Response 200

A page of messages.

- `object` ("list", required)
- `data` (object[], required)
  - `object` ("sms", required)
  - `id` (string, required)
  - `from` (string, required): The number it's sent from, in E.164.
  - `to` (string, required): The recipient's number, in E.164.
  - `body` (string, required): The text. Empty once discarded.
  - `status` ("queued" | "scheduled" | "sent" | "delivered" | "undelivered" | "failed" | "canceled", required): `queued` until handed to the carrier (`sent`), then `delivered` or `undelivered` once the carrier reports. `failed`: never sent. `scheduled` and `canceled`: scheduled sends.
  - `segments` (integer, required): Segments the body takes (what is billed).
  - `encoding` ("gsm7" | "ucs2", required): `gsm7` fits the basic alphabet; `ucs2` is used for anything else, with smaller segments.
  - `country` (string, required): ISO 3166 country of `to`.
  - `tags` (object[], required): Your tags on the message.
    - `name` (string, required): The tag's name.
    - `value` (string, required): The tag's value.
  - `failure` (object | null, required): Why the message failed or wasn't delivered.
    - `code` (string, required): Machine-readable reason.
    - `message` (string, required): Human-readable explanation.
  - `sandbox` (boolean, required): Sent from a sandbox environment: simulated.
  - `scheduled_at` (string | null, required, date-time): When it's set to send. `null`: it was sent at once.
  - `sent_at` (string | null, required, date-time): When it was handed to the carrier. `null`: not yet.
  - `delivered_at` (string | null, required, date-time): When the carrier reported delivery. `null`: not delivered, or not reported.
  - `created_at` (string, required, date-time)
- `has_more` (boolean, required)

Example:

```json
{
  "object": "list",
  "data": [],
  "has_more": false
}
```

## Errors

- `400`: The `Coss-Version` header names an unknown API version (`invalid_api_version`).
- `401`: The API key is missing, invalid, revoked or expired (`authentication_error`).
- `403`: The API key lacks the permission this endpoint needs (`permission_error`), or its organization is suspended (`organization_suspended`).
- `422`: A query parameter failed validation (`validation_error`, see `issues`).
- `429`: Too many requests with this API key (`rate_limited`), or too many requests with invalid keys from this address (`too_many_failed_authentications`). Retry after `Retry-After` seconds. Successful responses carry `RateLimit-Limit`, `RateLimit-Remaining` and `RateLimit-Reset` (seconds until the limit is fully restored).
- `500`: Unexpected server error (`api_error` / `internal_error`).
- `503`: The API key could not be verified right now; retry (`service_unavailable`).