Skip to main content
POST
/
message
/
image
Send an image message
curl --request POST \
  --url https://api.interacto.io/message/image \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Instance-Id: <instance-id>' \
  --data '
{
  "to": "551198888888",
  "media": {
    "url": "https://example.com/image.jpg",
    "caption": "Check out this cool image!"
  },
  "delay": 2,
  "typing": 8,
  "priority": 2,
  "tags": [
    "urgent",
    "lead"
  ],
  "metadata": {
    "leadId": "1234533"
  }
}
'
{
  "statusCode": 201,
  "message": "request successful",
  "data": {
    "id": "66b3c041eac929f51c6f160f",
    "instanceId": "66a09db606fd14660c8fc1d0",
    "to": "551198888888",
    "midia": {
      "url": "https://example.com/my-image.png",
      "caption": "Check out this cool image!"
    },
    "status": "QUEUED",
    "sended": true,
    "priority": 123,
    "timestamp": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}

​
Notas

Certifique-se de que o número do destinatário esteja no formato internacional (E.164). O tempo de atraso e a simulação de digitação são úteis para criar uma experiência mais natural de envio de mensagens, especialmente em aplicações onde o realismo na comunicação é importante.

​
Atenção!

Recomendamos fortemente que você utilize as opções de delay ou typing ao enviar múltiplas mensagens em sequência. O envio de mensagens em grande volume sem essas configurações pode resultar no bloqueio temporário ou permanente de sua conta no WhatsApp. Use essas opções para garantir uma experiência mais natural e segura na plataforma.

Authorizations

​
Authorization
string
header
required

API Key needed to access the endpoints

Headers

​
Instance-Id
string
required

Unique identifier for the instance

Body

application/json
​
to
string
required

O número de telefone do destinatário no formato E.164.

Example:

"551198888888"

​
media
object
required
​
delay
number

Tempo de atraso em segundos antes do envio da mensagem.

Required range: x <= 5
Example:

2

​
typing
number

Tempo em segundos para simular a digitação da mensagem.

Required range: x <= 15
Example:

8

​
priority
number

Nível de prioridade da mensagem, representado como um número inteiro.

Required range: x <= 15
Example:

2

​
tags
string[]

Tags para categorização da mensagem.

Example:
["urgent", "lead"]
​
metadata
object

Metadados adicionais que podem ser utilizados na sua aplicação.

Example:
{ "leadId": "1234533" }

Response

Message sent successfully

​
statusCode
integer
Example:

201

​
message
string
Example:

"request successful"

​
data
object