# Sandbox

Simulate incoming messages and status changes, without WhatsApp.

## Simulate a message received from a customer (sandbox keys only). Triggers the `message.received` webhook.

`POST /sandbox/simulate/inbound-message`

Authentication: API key, or console session with X-Environment-Id · scope: messages:send

Body (JSON):

| Field | Type | | Description |
|---|---|---|---|
| `phoneNumberId` | string | required | ID of a number in the sandbox environment. |
| `from` | string | required | Number of the simulated sender, international format with “+”. |
| `text` | string | required | Text of the simulated message. |

```bash
curl -X POST "$INBOX_API/sandbox/simulate/inbound-message" \
  -H "Authorization: Bearer $INBOX_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phoneNumberId": "4d8e654e-d744-4bf3-8211-9ceffcccfe87",
    "from": "+237611111111",
    "text": "Hello, I'\''d like to reschedule my appointment"
  }'
```

Response 201:

```json
{
  "messageId": "3f3baf5a-f93e-42e8-8263-ce62dc4aadd6",
  "from": "237611111111",
  "status": "received",
  "simulated": true
}
```

## Advance the status of an outbound message (sandbox keys only). Triggers the matching webhook.

`POST /sandbox/simulate/message-status`

Authentication: API key, or console session with X-Environment-Id · scope: messages:send

Body (JSON):

| Field | Type | | Description |
|---|---|---|---|
| `messageId` | string | required | ID of an outbound message in the sandbox environment. |
| `status` | string | required | New status: sent, delivered, read or failed. A status never goes backwards, as with Meta. |

```bash
curl -X POST "$INBOX_API/sandbox/simulate/message-status" \
  -H "Authorization: Bearer $INBOX_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "messageId": "d5ad1e3e-6ab9-4f7f-8e4e-b17104a7bd00",
    "status": "delivered"
  }'
```

Response 200:

```json
{
  "messageId": "d5ad1e3e-6ab9-4f7f-8e4e-b17104a7bd00",
  "status": "delivered",
  "simulated": true
}
```