Pular para o conteúdo principal
POST
Criar mensagem

Autorizações

x-api-key
string
header
obrigatório

Copy the API key as provided by the Bridge Console.

Parâmetros de caminho

workspaceId
string<uuid>
obrigatório

Identificador único do workspace (UUID v4).

Exemplo:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

Corpo

application/json

Corpo da solicitação para criar uma mensagem em uma conversa específica.

conversationId
string
obrigatório

Identificador da conversa.

Exemplo:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

messageBody
string
obrigatório

Corpo da mensagem.

Exemplo:

"Hello, welcome to Bridge!"

enableExternalBroadcast
boolean
obrigatório

Controla se uma mensagem aceita é elegível para entrega externa. Com false, a mensagem é criada, mas o broadcast externo é ignorado. Com true, entra no fluxo normal de entrega externa quando as regras da conversa e do destinatário permitem. Uma resposta de criação bem-sucedida e messageId não são confirmações de entrega. Este indicador não concede visibilidade nem ignora permissões. Também não desativa os modelos de onboarding iniciados por uma solicitação separada de criação de conversa.

Exemplos:

true

false

replyToMessageId
string | null

Identificador da mensagem à qual se está respondendo.

Exemplo:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

mediaIds
string[]

Lista de IDs de mídia associados à mensagem.

Exemplo:

Resposta

Resposta bem-sucedida

Corpo da resposta para operações com mensagens.

messageId
string
obrigatório

Identificador único da mensagem como string UUID.

Exemplo:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

messagingProduct
string
padrão:bridge

Nome do produto.

Exemplo:

"bridge"