Send Plain Text

Send Text

curl --request POST \
  --url https://{server-url}/message/sendText/{instance} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "number": "<string>",
  "text": "<string>",
  "delay": 123,
  "linkPreview": true,
  "mentionsEveryOne": true,
  "mentioned": [
    "{{remoteJID}}"
  ],
  "quoted": {
    "key": {
      "id": "<string>"
    },
    "message": {
      "conversation": "<string>"
    }
  }
}
'

import requests

url = "https://{server-url}/message/sendText/{instance}"

payload = {
    "number": "<string>",
    "text": "<string>",
    "delay": 123,
    "linkPreview": True,
    "mentionsEveryOne": True,
    "mentioned": ["{{remoteJID}}"],
    "quoted": {
        "key": { "id": "<string>" },
        "message": { "conversation": "<string>" }
    }
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    number: '<string>',
    text: '<string>',
    delay: 123,
    linkPreview: true,
    mentionsEveryOne: true,
    mentioned: ['{{remoteJID}}'],
    quoted: {key: {id: '<string>'}, message: {conversation: '<string>'}}
  })
};

fetch('https://{server-url}/message/sendText/{instance}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{server-url}/message/sendText/{instance}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'number' => '<string>',
    'text' => '<string>',
    'delay' => 123,
    'linkPreview' => true,
    'mentionsEveryOne' => true,
    'mentioned' => [
        '{{remoteJID}}'
    ],
    'quoted' => [
        'key' => [
                'id' => '<string>'
        ],
        'message' => [
                'conversation' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{server-url}/message/sendText/{instance}"

	payload := strings.NewReader("{\n  \"number\": \"<string>\",\n  \"text\": \"<string>\",\n  \"delay\": 123,\n  \"linkPreview\": true,\n  \"mentionsEveryOne\": true,\n  \"mentioned\": [\n    \"{{remoteJID}}\"\n  ],\n  \"quoted\": {\n    \"key\": {\n      \"id\": \"<string>\"\n    },\n    \"message\": {\n      \"conversation\": \"<string>\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("apikey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{server-url}/message/sendText/{instance}")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"number\": \"<string>\",\n  \"text\": \"<string>\",\n  \"delay\": 123,\n  \"linkPreview\": true,\n  \"mentionsEveryOne\": true,\n  \"mentioned\": [\n    \"{{remoteJID}}\"\n  ],\n  \"quoted\": {\n    \"key\": {\n      \"id\": \"<string>\"\n    },\n    \"message\": {\n      \"conversation\": \"<string>\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{server-url}/message/sendText/{instance}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"number\": \"<string>\",\n  \"text\": \"<string>\",\n  \"delay\": 123,\n  \"linkPreview\": true,\n  \"mentionsEveryOne\": true,\n  \"mentioned\": [\n    \"{{remoteJID}}\"\n  ],\n  \"quoted\": {\n    \"key\": {\n      \"id\": \"<string>\"\n    },\n    \"message\": {\n      \"conversation\": \"<string>\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "key": {
    "remoteJid": "553198296801@s.whatsapp.net",
    "fromMe": true,
    "id": "BAE594145F4C59B4"
  },
  "message": {
    "extendedTextMessage": {
      "text": "Olá!"
    }
  },
  "messageTimestamp": "1717689097",
  "status": "PENDING"
}

POST

message

sendText

{instance}

Send Text

curl --request POST \
  --url https://{server-url}/message/sendText/{instance} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "number": "<string>",
  "text": "<string>",
  "delay": 123,
  "linkPreview": true,
  "mentionsEveryOne": true,
  "mentioned": [
    "{{remoteJID}}"
  ],
  "quoted": {
    "key": {
      "id": "<string>"
    },
    "message": {
      "conversation": "<string>"
    }
  }
}
'

import requests

url = "https://{server-url}/message/sendText/{instance}"

payload = {
    "number": "<string>",
    "text": "<string>",
    "delay": 123,
    "linkPreview": True,
    "mentionsEveryOne": True,
    "mentioned": ["{{remoteJID}}"],
    "quoted": {
        "key": { "id": "<string>" },
        "message": { "conversation": "<string>" }
    }
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    number: '<string>',
    text: '<string>',
    delay: 123,
    linkPreview: true,
    mentionsEveryOne: true,
    mentioned: ['{{remoteJID}}'],
    quoted: {key: {id: '<string>'}, message: {conversation: '<string>'}}
  })
};

fetch('https://{server-url}/message/sendText/{instance}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{server-url}/message/sendText/{instance}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'number' => '<string>',
    'text' => '<string>',
    'delay' => 123,
    'linkPreview' => true,
    'mentionsEveryOne' => true,
    'mentioned' => [
        '{{remoteJID}}'
    ],
    'quoted' => [
        'key' => [
                'id' => '<string>'
        ],
        'message' => [
                'conversation' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{server-url}/message/sendText/{instance}"

	payload := strings.NewReader("{\n  \"number\": \"<string>\",\n  \"text\": \"<string>\",\n  \"delay\": 123,\n  \"linkPreview\": true,\n  \"mentionsEveryOne\": true,\n  \"mentioned\": [\n    \"{{remoteJID}}\"\n  ],\n  \"quoted\": {\n    \"key\": {\n      \"id\": \"<string>\"\n    },\n    \"message\": {\n      \"conversation\": \"<string>\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("apikey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{server-url}/message/sendText/{instance}")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"number\": \"<string>\",\n  \"text\": \"<string>\",\n  \"delay\": 123,\n  \"linkPreview\": true,\n  \"mentionsEveryOne\": true,\n  \"mentioned\": [\n    \"{{remoteJID}}\"\n  ],\n  \"quoted\": {\n    \"key\": {\n      \"id\": \"<string>\"\n    },\n    \"message\": {\n      \"conversation\": \"<string>\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{server-url}/message/sendText/{instance}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"number\": \"<string>\",\n  \"text\": \"<string>\",\n  \"delay\": 123,\n  \"linkPreview\": true,\n  \"mentionsEveryOne\": true,\n  \"mentioned\": [\n    \"{{remoteJID}}\"\n  ],\n  \"quoted\": {\n    \"key\": {\n      \"id\": \"<string>\"\n    },\n    \"message\": {\n      \"conversation\": \"<string>\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "key": {
    "remoteJid": "553198296801@s.whatsapp.net",
    "fromMe": true,
    "id": "BAE594145F4C59B4"
  },
  "message": {
    "extendedTextMessage": {
      "text": "Olá!"
    }
  },
  "messageTimestamp": "1717689097",
  "status": "PENDING"
}

Authorizations

apikey

string

header

required

Your authorization key header

Path Parameters

instance

string

required

Name of the instance

Body

application/json

number

string

required

Number to receive the message (with country code)

text

string

required

Test message to send

delay

integer

Presence time in milliseconds before sending message

linkPreview

boolean

Shows a preview of the target website if there's a link within the message

mentionsEveryOne

boolean

Mentioned everyone when the message send

mentioned

enum<string>[]

Numbers to mention

Available options:

{{remoteJID}}

quoted

object

Show child attributes

Response

201 - application/json

Created

key

object

Show child attributes

message

object

Show child attributes

messageTimestamp

string

The timestamp of the message.

status

string

The status of the message.

Início

Instances

Webhook

Settings

Send Message

Chat Controller

Profile Settings

Group Controller

Typebot

OpenAI

Evolution Bot

Dify

n8n

EvoAI

Flowise

Chatwoot

Websocket

SQS

RabbitMQ

Authorizations

Path Parameters

Body

Response