# Send SMS with Laravel

Source: https://jointextkit.com/docs/send-with-laravel
Index: https://jointextkit.com/llms.txt

Send a text from Laravel with its built-in HTTP client and TextKit's REST API. No package to install.

## Prompt for your AI agent

Paste this into Claude Code, Cursor or any coding agent to have it do the
integration:

```text
Add SMS sending to this Laravel project with TextKit.

- Docs for this stack: https://jointextkit.com/docs/send-with-laravel.md
- API: POST https://api.jointextkit.com/v1/messages with `Authorization: Bearer
  <key>` and a JSON body `{"to": "+1...", "body": "..."}`.
- There is no Laravel package: POST JSON to
  https://api.jointextkit.com/v1/messages with `Http::withToken(...)` (Laravel's
  HTTP client).
- Read the key from the `TEXTKIT_API_KEY` environment variable. Never hardcode
  it or send it to the browser.
- Phone numbers are E.164 and US or Canada only (`+1` followed by 10 digits).
- A test key (`ssms_sk_test_`) simulates: `+15005550006` always ends `delivered`
  and no phone gets a text.
- Errors are JSON: `{"error": {"code", "message", "param"}}` with a 4xx status.
  On `429`, wait `Retry-After` seconds and retry.
- Send only from server code that runs after a real event (a signup, an order).
  Never expose an endpoint that texts any number a visitor types.
```

## Before you start

- **An API key.** [Create a free account](/signup) and copy the test key
  (`ssms_sk_test_...`) from Home in the console. It works at once, no card.
- **Laravel 10 or later.**
- Put the key in an environment variable:

```bash
export TEXTKIT_API_KEY=ssms_sk_test_...
```

## 1. Add the key to config

In `.env`:

```bash
TEXTKIT_API_KEY=ssms_sk_test_...
```

In `config/services.php`:

```php
'textkit' => [
    'key' => env('TEXTKIT_API_KEY'),
],
```

## 2. Send a test from Artisan

Add to `routes/console.php`:

```php
use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\Http;

Artisan::command('sms:test {to}', function (string $to) {
    $message = Http::withToken(config('services.textkit.key'))
        ->post('https://api.jointextkit.com/v1/messages', [
            'to' => $to,
            'body' => 'Hello from TextKit',
        ])
        ->throw()
        ->json();

    $this->info($message['id'] . ' ' . $message['status']);
});
```

```bash
php artisan sms:test +15005550006
```

It prints the message ID (`msg_...`) and `delivered`. Use the same
`Http::withToken(...)->post(...)` call in a job or a controller.

## What the test key did

`+15005550006` is a sandbox number: the send comes back `delivered` and no
phone gets a text (the response says `"simulated": true`). Put your own
verified phone in `to` and the test key texts it for real. See
[Sandbox & test numbers](/docs/sandbox).

## Handle errors

`->throw()` raises `Illuminate\Http\Client\RequestException` on a 4xx or
5xx; `$e->response->json('error.code')` is the API's code. A failed request returns a 4xx status and a JSON body
`{"error": {"code": "...", "message": "...", "param": "..."}}`. On `429
rate_limited`, wait the `Retry-After` seconds and try again. Send an
`Idempotency-Key` header (any unique string per message) and a retried request
returns the first result instead of sending twice.

| Status | Code | What to do |
| --- | --- | --- |
| 400 | `invalid_request` | A field is missing or malformed; `param` names it. |
| 401 | `invalid_api_key` | The key is missing, revoked or mistyped. |
| 402 | `insufficient_credits` | Add credits; nothing was sent or charged. |
| 403 | `recipient_opted_out` | They texted STOP. Do not retry. |
| 429 | `rate_limited` | Wait `Retry-After` seconds, then retry. |

Every code is in [Errors](/docs/errors).

## Go live

1. **Add a number** in the [console](/console).
2. **Register your use case.** We file your 10DLC registration; toll-free
   numbers use a guided verification form. Until carriers approve it, the number
   texts only your verified numbers. See [Compliance & registration](/docs/compliance).
3. **Swap in a live key** (`ssms_sk_live_...`). The code stays the same.

## Next steps

- [Webhooks](/docs/webhooks): delivery receipts and replies, pushed to your server.
- [Verify](/docs/verify): one-time codes in two calls, billed only when verified.
- [Send an SMS](/docs/api/messages/send): every field the endpoint takes.
- [All quickstarts](/docs/quickstarts): the same guide for other languages and frameworks.