# `bird whatsapp agents test`

## Usage

```bash
bird whatsapp agents test <number-id> [flags]
```

## Description

Send an agent a test message

Put a message to the agent on this WhatsApp number and read its answer, without anything reaching a contact. It answers from its live configuration, which is the only one there is, so a change you have just saved is what gets tested. Pass the reply's `meta_conversation_id` back to `bird whatsapp agents test` to ask a follow-up in context.

Build the request from flags, a JSON WhatsAppAgentTestMessageRequest body via --body-file ("-" reads
stdin), or both — a flag overrides the matching body field. Run --example to
print a ready-to-edit body, or --dry-run to print the resolved request without
sending it.

## Examples

```bash
# print the body shape (no credentials needed)
bird whatsapp agents test --example

# the body it prints:
```

```json
{
  "text": "Do you deliver to Rotterdam on a Saturday?"
}
```

## Options

#### Request

| Name                | Description                                                  |
| ------------------- | ------------------------------------------------------------ |
| `--body-file`       | Read the JSON request body from this file; "-" reads stdin   |
| `--example`         | Print a complete example request body, then exit             |
| `--dry-run`         | Print the resolved request without sending it, then exit     |
| `--idempotency-key` | Deduplication key; a retry with the same key won't act twice |

#### Options

| Name                     | Description                                                                                                                                                                               |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--text`                 | What to say to the agent, as a contact would write it. (required; or in --body-file)                                                                                                      |
| `--meta-conversation-id` | Continue an earlier test conversation, using the meta\_conversation\_id its reply returned. Omit to start a new one, which the agent answers with no memory of anything you asked before. |
| `--response-schema`      | Print the fields this command returns, then exit                                                                                                                                          |

## Related

| Name                                                                        | Description                                  |
| --------------------------------------------------------------------------- | -------------------------------------------- |
| [`bird whatsapp agents create`](/docs/cli/reference/whatsapp-agents-create) | Onboard an agent on a WhatsApp number        |
| [`bird whatsapp agents delete`](/docs/cli/reference/whatsapp-agents-delete) | Delete a WhatsApp number's agent             |
| [`bird whatsapp agents get`](/docs/cli/reference/whatsapp-agents-get)       | Get a WhatsApp number's agent                |
| [`bird whatsapp agents list`](/docs/cli/reference/whatsapp-agents-list)     | List WhatsApp numbers with their agent state |

## Related resources

- [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer)
- [Build your first integration](/learn/paths/integration) (course)
- [Send your first email](/docs/get-started/send-your-first-email) (docs)

[Get an implementation brief](/learn/workspace?topic=api-basics)