Schemas

Chat

id

string

Unique chat identifier

type

string · enum

Chat type

Enum values:

PRIVATE

GROUP

name

string

Chat display name

platformId

string

Platform-specific identifier (e.g. phone number for WhatsApp)

channelId

string

Associated channel ID

contactId

string

Associated contact ID

avatar

string

Avatar URL

createdAt

string · date-time

updatedAt

string · date-time

ChatWithRelations

id

string

Unique chat identifier

type

string · enum

Chat type

Enum values:

PRIVATE

GROUP

name

string

Chat display name

platformId

string

Platform-specific identifier (e.g. phone number for WhatsApp)

channelId

string

Associated channel ID

contactId

string

Associated contact ID

avatar

string

Avatar URL

createdAt

string · date-time

updatedAt

string · date-time

object

Message

id

string

Unique message identifier

chatId

string

Parent chat ID

platformId

string

Platform-specific message identifier

senderId

string

ID of the user who sent the message

text

string

Message text content

type

string · enum

Message type

Enum values:

TEXT

IMAGE

DOCUMENT

AUDIO

VIDEO

STICKER

REACTION

UNSUPPORTED

status

string · enum

Computed message delivery status

Enum values:

sent

delivered

read

failed

pending

sendAt

string · date-time

When the message was sent

receivedAt

string · date-time

When the message was received by the recipient

readAt

string · date-time

When the message was read by the recipient

replyToId

string

ID of the message this is replying to

metadata

object

Additional message metadata

createdAt

string · date-time

updatedAt

string · date-time

Contact

id

string

Unique contact identifier

name

string

Contact display name

email

string

Contact email address

phone

string

Contact phone number

avatar

string

Avatar URL

notes

string

Notes about the contact

createdAt

string · date-time

updatedAt

string · date-time

ContactPlatform

id

string

platformId

string

Platform-specific identifier

platformType

string · enum

Enum values:

WHATSAPP_API

WEB

INSTAGRAM

name

string

avatar

string

email

string

phone

string

contactId

string

channelId

string

metadata

object

createdAt

string · date-time

updatedAt

string · date-time

Channel

id

string

Unique channel identifier

name

string

Channel display name

type

string · enum

Channel type

Enum values:

WHATSAPP_API

WEB

INSTAGRAM

state

string · enum

Current connection state

Enum values:

DISCONNECTED

CONNECTING

CONNECTED

createdAt

string · date-time

updatedAt

string · date-time

MessageTemplate

id

string

Unique template identifier

name

string

Template name

description

string

Template description

content

string

Template content/body

type

string · enum

Template media type

Enum values:

TEXT

IMAGE

VIDEO

DOCUMENT

language

string

Template language code

metadata

object

Additional template metadata (e.g. WhatsApp template details)

createdAt

string · date-time

updatedAt

string · date-time

SendMessageRequest

content

string · required

Message text content

type

string · enum

Message type. Defaults to TEXT unless templateId is provided.

Enum values:

TEXT

IMAGE

DOCUMENT

AUDIO

VIDEO

TEMPLATE

Default: TEXT

senderId

string

User ID of the sender. If not provided, the first organization member will be used.

templateId

string

Template ID to send. When provided, the type is automatically set to TEMPLATE.

object

Variables to fill into the template

SendTemplateRequest

phoneNumber

string · required

Recipient phone number (will be normalized to digits only)

templateId

string · required

ID of the message template to send

object

Variables to fill into the template

channelId

string

Specific WhatsApp API channel to use. If not provided, the first available WhatsApp API channel will be used.

PaginationMeta

total

integer

Total number of items

per_page

integer

Items per page

current_page

integer

Current page number

last_page

integer

Last page number

ErrorResponse

error

string

Error message

Chat

id

string

Unique chat identifier

type

string · enum

Chat type

Enum values:

PRIVATE

GROUP

name

string

Chat display name

platformId

string

Platform-specific identifier (e.g. phone number for WhatsApp)

channelId

string

Associated channel ID

contactId

string

Associated contact ID

avatar

string

Avatar URL

createdAt

string · date-time

updatedAt

string · date-time

ChatWithRelations

id

string

Unique chat identifier

type

string · enum

Chat type

Enum values:

PRIVATE

GROUP

name

string

Chat display name

platformId

string

Platform-specific identifier (e.g. phone number for WhatsApp)

channelId

string

Associated channel ID

contactId

string

Associated contact ID

avatar

string

Avatar URL

createdAt

string · date-time

updatedAt

string · date-time

object

Message

id

string

Unique message identifier

chatId

string

Parent chat ID

platformId

string

Platform-specific message identifier

senderId

string

ID of the user who sent the message

text

string

Message text content

type

string · enum

Message type

Enum values:

TEXT

IMAGE

DOCUMENT

AUDIO

VIDEO

STICKER

REACTION

UNSUPPORTED

status

string · enum

Computed message delivery status

Enum values:

sent

delivered

read

failed

pending

sendAt

string · date-time

When the message was sent

receivedAt

string · date-time

When the message was received by the recipient

readAt

string · date-time

When the message was read by the recipient

replyToId

string

ID of the message this is replying to

metadata

object

Additional message metadata

createdAt

string · date-time

updatedAt

string · date-time

ContactPlatform

id

string

platformId

string

Platform-specific identifier

platformType

string · enum

Enum values:

WHATSAPP_API

WEB

INSTAGRAM

name

string

avatar

string

email

string

phone

string

contactId

string

channelId

string

metadata

object

createdAt

string · date-time

updatedAt

string · date-time

Channel

id

string

Unique channel identifier

name

string

Channel display name

type

string · enum

Channel type

Enum values:

WHATSAPP_API

WEB

INSTAGRAM

state

string · enum

Current connection state

Enum values:

DISCONNECTED

CONNECTING

CONNECTED

createdAt

string · date-time

updatedAt

string · date-time

MessageTemplate

id

string

Unique template identifier

name

string

Template name

description

string

Template description

content

string

Template content/body

type

string · enum

Template media type

Enum values:

TEXT

IMAGE

VIDEO

DOCUMENT

language

string

Template language code

metadata

object

Additional template metadata (e.g. WhatsApp template details)

createdAt

string · date-time

updatedAt

string · date-time

SendMessageRequest

content

string · required

Message text content

type

string · enum

Message type. Defaults to TEXT unless templateId is provided.

Enum values:

TEXT

IMAGE

DOCUMENT

AUDIO

VIDEO

TEMPLATE

Default: TEXT

senderId

string

User ID of the sender. If not provided, the first organization member will be used.

templateId

string

Template ID to send. When provided, the type is automatically set to TEMPLATE.

object

Variables to fill into the template

SendTemplateRequest

phoneNumber

string · required

Recipient phone number (will be normalized to digits only)

templateId

string · required

ID of the message template to send

object

Variables to fill into the template

channelId

string

Specific WhatsApp API channel to use. If not provided, the first available WhatsApp API channel will be used.