Smallforce Smallforce Docs

Inbox & Messaging Commands

Manage WhatsApp and cross-platform conversations from the command line — list conversations, read message history, and send replies.

inbox conversations

List inbox conversations for your organization with filtering by platform and status.

smallforce inbox conversations [options]

Options

FlagTypeDefaultDescription
--platform <platform>string—Filter by platform: instagram, facebook, twitter, whatsapp, etc.
--status <status>string—Filter by status: active, archived
--unread-onlybooleanfalseOnly show conversations with unread messages
--cursor <cursor>string—Pagination cursor from a previous response
--limit <n>number—Number of conversations to return (1–100)

List all conversations

smallforce inbox conversations

List unread WhatsApp conversations

smallforce inbox conversations --platform whatsapp --unread-only

Paginate through conversations

# First page
smallforce inbox conversations --limit 10

# Use the cursor from the response
smallforce inbox conversations --limit 10 --cursor "eyJpZCI6Imxhc3RfaWQifQ"

Example output

{
  "conversations": [
    {
      "id": "conv_abc123",
      "platform": "whatsapp",
      "contactName": "Sarah Chen",
      "lastMessage": "Thanks for the follow-up!",
      "unreadCount": 2,
      "status": "active",
      "updatedAt": "2026-03-14T15:30:00Z"
    }
  ],
  "nextCursor": "eyJpZCI6ImNvbnZfYWJjMTIzIn0"
}

inbox conversation-messages

List messages within a specific conversation. Opening a conversation automatically marks it as read.

smallforce inbox conversation-messages <conversation-id> [options]

Options

FlagTypeDefaultDescription
--cursor <cursor>string—Pagination cursor from a previous response
--limit <n>number—Number of messages to return (1–100)

Read messages

smallforce inbox conversation-messages conv_abc123

Paginate through message history

smallforce inbox conversation-messages conv_abc123 --limit 20 --cursor "eyJpZCI6Im1zZ18xMjMifQ"

Example output

{
  "messages": [
    {
      "id": "msg_001",
      "direction": "inbound",
      "content": "Hi, I'd like to learn more about your services",
      "timestamp": "2026-03-14T14:00:00Z"
    },
    {
      "id": "msg_002",
      "direction": "outbound",
      "content": "Of course! Let me send you our latest brochure.",
      "timestamp": "2026-03-14T14:05:00Z"
    }
  ],
  "nextCursor": "eyJpZCI6Im1zZ18wMDIifQ"
}

inbox send

Send a text message to an existing conversation.

smallforce inbox send <conversation-id> --message <text>

Options

FlagTypeRequiredDescription
--message <text>stringYesThe message text to send

Send a reply

smallforce inbox send conv_abc123 --message "Thanks for reaching out! I'll send that over shortly."

Example output

{
  "id": "msg_003",
  "conversationId": "conv_abc123",
  "direction": "outbound",
  "content": "Thanks for reaching out! I'll send that over shortly.",
  "timestamp": "2026-03-14T16:00:00Z",
  "status": "sent"
}