Skip to main content
POST
Criar mensagem rápida

Authorizations

x-jurichat-api-key
string
header
required

Chave de API do escritório (criada no painel). Envie o valor no header x-jurichat-api-key.

Body

application/json
title
string
required

Título da mensagem rápida.

Minimum string length: 1
inboxId
string
required

ID da inbox à qual a mensagem rápida será vinculada.

type
enum<string>
default:TEXT

Tipo da mensagem rápida. SEQUENCE envia vários blocos em ordem, um por mensagem.

Available options:
TEXT,
AUDIO,
IMAGE,
VIDEO,
SEQUENCE
content
string

Texto da mensagem rápida ou legenda opcional de imagem/vídeo. Obrigatório quando type é TEXT.

metadata
object

Dados da mídia. Obrigatório para áudio, imagem e vídeo. O url é o caminho devolvido pelo endpoint de upload correspondente.

blocks
object[]

Blocos da sequência. Obrigatório quando type é SEQUENCE.

Required array length: 1 - 20 elements
tagId
string[]

IDs das tags associadas. Opcional.

Response

Default Response

id
string
required

ID da mensagem rápida.

title
string
required

Título da mensagem rápida.

type
enum<string>
required

Tipo da mensagem rápida. SEQUENCE envia vários blocos em ordem, um por mensagem.

Available options:
TEXT,
AUDIO,
IMAGE,
VIDEO,
SEQUENCE
content
string | null
required

Texto da mensagem. Null quando é mídia.

metadata
object | null
required

Dados da mídia, com a URL já assinada. Null quando é texto.

supportedChannels
string[] | null
required

Canais que aceitam esse formato de mídia. Null quando é texto.

blocks
object[] | null
required

Blocos da sequência, em ordem. Null quando não é sequência.

inboxId
string
required

ID da inbox à qual a mensagem rápida pertence.

createdAt
string<date-time>
required

Data e hora de criação.

updatedAt
string<date-time>
required

Data e hora da última atualização.