Pular para o conteúdo

Create Session

POST
/api/v1/whatsapp/sessions

Create a new WhatsApp session.

Creates a user in WuzAPI and returns the session details. The session will be in ‘disconnected’ status until connected via QR code.

x-tenant-id
Any of:
integer
WhatsAppSessionCreate

Schema for creating a WhatsApp session.

object
name
required
Name

Friendly name for the session

string
>= 1 characters <= 255 characters
webhook_url
Any of:
string
<= 500 characters
webhook_events
Any of:
Array<string>
auto_reply_enabled
Auto Reply Enabled

Enable auto-reply

boolean
auto_reply_message
Any of:
string
is_default
Is Default

Set as default session for sending

boolean

Successful Response

WhatsAppSessionResponse

Schema for WhatsApp session response.

object
name
required
Name

Friendly name for the session

string
>= 1 characters <= 255 characters
id
required
Id
integer
phone_number
Any of:
string
wuzapi_user_id
required
Wuzapi User Id
string
status
required
Status
string
connected_at
Any of:
string format: date-time
disconnected_at
Any of:
string format: date-time
last_seen_at
Any of:
string format: date-time
profile_name
Any of:
string
profile_picture_url
Any of:
string
is_active
required
Is Active
boolean
is_default
required
Is Default
boolean
auto_reply_enabled
required
Auto Reply Enabled
boolean
auto_reply_message
Any of:
string
total_messages_sent
required
Total Messages Sent
integer
total_messages_received
required
Total Messages Received
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string