CRMax icon

CRMax

CRMax CRM - Gestão de Leads via WhatsApp

Conversation → Start

AI-generated

Summary

Starts a conversation with the specified phone number on the selected WhatsApp instance. Optionally skip phone normalization and assign a team.

Inputs

  • phone (required) — Phone number with country code, no + or spaces
  • instanceId (required) — WhatsApp Instance Name or ID
  • options.skipNormalize — Whether to skip Brazilian phone normalization and use the number exactly as typed. Turn on for international numbers already formatted with country code.
  • options.teamId — Team to set on the conversation. Choose from the list, or specify an ID using an expression.

Output shape

Returns the created conversation object (e.g., conversation ID, WhatsApp instance, status). The exact structure is not detailed in the provided source, but the operation initiates a new conversation and typically yields its identifier.

If the operation fails, an error is thrown.

Examples

Example 1: Start a conversation on WhatsApp with a customer

Provide the customer’s phone number (e.g., 5511987654321), choose an active WhatsApp instance, optionally enable skipNormalize for international numbers, and select a team if needed.

Links

Discussion