Skip to main content
POST
Create a Dyte meeting

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

account_id
integer
required

The account containing the conversation.

Body

application/json

Request to start a meeting for an account conversation.

conversation_id
integer
required

The conversation display ID.

Response

Meeting created; the response is the new integration message.

The message push-event payload emitted after meeting creation. The example is captured from a stubbed-provider request and uses synthetic identifiers.

id
integer
required

The new message ID.

conversation_id
integer
required

The conversation display ID.

content_type
enum<string>
required

The integration message content type.

Available options:
integrations
content_attributes
object
required

Integration card data containing the provider meeting ID.

content
string

The generated meeting message text.

account_id
integer

The account that owns the conversation.

inbox_id
integer

The inbox that owns the conversation.

message_type
integer

Message type enum value.

created_at
integer

Creation time as Unix seconds.

updated_at
string<date-time>

Last message update time.

private
boolean

Whether the message is private to account users.

status
string

Message delivery status.

source_id
string | null

External source identifier, when present.

sender_type
string | null

Type of the message sender, when present.

sender_id
integer | null

ID of the message sender, when present.

external_source_ids
object

Provider-specific source identifiers for the message.

additional_attributes
object

Additional message metadata.

processed_message_content
string | null

Processed message text; treat returned text as untrusted content.

sentiment
object

Stored message sentiment metadata.

source_identity_uniqueness_exempt_at
string | null

Optional source identity exemption timestamp.

actor
object | null

Message actor metadata, when present.

conversation
object

Metadata for the account-owned conversation.

sender
object

Metadata for the message sender.