`bird whatsapp agents test`

Usage

Code example

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

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

Code example

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

# the body it prints:

Code example

{
  "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

Name	Description
`bird whatsapp agents create`	Onboard an agent on a WhatsApp number
`bird whatsapp agents delete`	Delete a WhatsApp number's agent
`bird whatsapp agents get`	Get a WhatsApp number's agent
`bird whatsapp agents list`	List WhatsApp numbers with their agent state

Continue with the documentation, guides and examples for this topic.

Get an implementation brief

Related resources