Skip to main content
POST
/
session
/
{sessionId}
/
message
/
document
Send document message
curl --request POST \
  --url https://api.zappaz.io/api/v1/session/{sessionId}/message/document \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "5511999999999",
  "source": "https://example.com/document.pdf",
  "fileName": "my-document.pdf",
  "caption": "Check out this document!",
  "mentions": [
    "5511999999999",
    "[email protected]"
  ],
  "quoted": "3EB0B5EED74106A7F4EC06",
  "delay": 2000
}
'
{
  "status": "success",
  "data": {}
}

Authorizations

​
Authorization
string
header
required

Token de usuário ou sessão, passado diretamente como uma string no cabeçalho 'Authorization'. O token de usuário tem escopo sobre todas as sessões pertencentes ao usuário. O token de sessão é limitado à própria sessão.

Path Parameters

​
sessionId
string
required

Identificador único da sessão

Body

application/json
​
number
string
required

Número do WhatsApp para enviar a mensagem

Example:

"5511999999999"

​
source
string
required

URL para um arquivo de documento ou dados do documento codificados em base64 (sem qualquer prefixo do esquema URI de dados como 'data:application/pdf;base64,')

Example:

"https://example.com/document.pdf"

​
fileName
string

(Opcional) Nome personalizado para o arquivo do documento

Example:

"my-document.pdf"

​
caption
string

(Opcional) Legenda para o documento

Example:

"Check out this document!"

​
mentions
string[]

(Opcional) Um array de JIDs ou números de telefone para mencionar na legenda

Example:
[
  "5511999999999",
  "[email protected]"
]
​
quoted
string

(Opcional) ID da mensagem para citar

Example:

"3EB0B5EED74106A7F4EC06"

​
delay
number

(Opcional) Atraso em segundos antes de enviar a mensagem

Example:

2000

Response

Mensagem com documento enviada com sucesso

​
status
enum<string>
Available options:
success,
failed
​
data
object