curl --request POST \
--url https://api.nupapia.com.br/api/chat/conversations/start-whatsapp \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"channel_id": 123,
"phone": "+5511999999999",
"name": "<string>",
"lastname": "<string>",
"template_name": "<string>",
"language": "pt_BR",
"variables": {},
"text": "<string>",
"content_type": "<string>",
"file_url": "<string>",
"file_name": "<string>",
"topic": "<string>",
"pipeline_id": 123,
"pipeline_stage_id": 123
}
'import requests
url = "https://api.nupapia.com.br/api/chat/conversations/start-whatsapp"
payload = {
"channel_id": 123,
"phone": "+5511999999999",
"name": "<string>",
"lastname": "<string>",
"template_name": "<string>",
"language": "pt_BR",
"variables": {},
"text": "<string>",
"content_type": "<string>",
"file_url": "<string>",
"file_name": "<string>",
"topic": "<string>",
"pipeline_id": 123,
"pipeline_stage_id": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
channel_id: 123,
phone: '+5511999999999',
name: '<string>',
lastname: '<string>',
template_name: '<string>',
language: 'pt_BR',
variables: {},
text: '<string>',
content_type: '<string>',
file_url: '<string>',
file_name: '<string>',
topic: '<string>',
pipeline_id: 123,
pipeline_stage_id: 123
})
};
fetch('https://api.nupapia.com.br/api/chat/conversations/start-whatsapp', 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://api.nupapia.com.br/api/chat/conversations/start-whatsapp",
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([
'channel_id' => 123,
'phone' => '+5511999999999',
'name' => '<string>',
'lastname' => '<string>',
'template_name' => '<string>',
'language' => 'pt_BR',
'variables' => [
],
'text' => '<string>',
'content_type' => '<string>',
'file_url' => '<string>',
'file_name' => '<string>',
'topic' => '<string>',
'pipeline_id' => 123,
'pipeline_stage_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.nupapia.com.br/api/chat/conversations/start-whatsapp"
payload := strings.NewReader("{\n \"channel_id\": 123,\n \"phone\": \"+5511999999999\",\n \"name\": \"<string>\",\n \"lastname\": \"<string>\",\n \"template_name\": \"<string>\",\n \"language\": \"pt_BR\",\n \"variables\": {},\n \"text\": \"<string>\",\n \"content_type\": \"<string>\",\n \"file_url\": \"<string>\",\n \"file_name\": \"<string>\",\n \"topic\": \"<string>\",\n \"pipeline_id\": 123,\n \"pipeline_stage_id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.nupapia.com.br/api/chat/conversations/start-whatsapp")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"channel_id\": 123,\n \"phone\": \"+5511999999999\",\n \"name\": \"<string>\",\n \"lastname\": \"<string>\",\n \"template_name\": \"<string>\",\n \"language\": \"pt_BR\",\n \"variables\": {},\n \"text\": \"<string>\",\n \"content_type\": \"<string>\",\n \"file_url\": \"<string>\",\n \"file_name\": \"<string>\",\n \"topic\": \"<string>\",\n \"pipeline_id\": 123,\n \"pipeline_stage_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nupapia.com.br/api/chat/conversations/start-whatsapp")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channel_id\": 123,\n \"phone\": \"+5511999999999\",\n \"name\": \"<string>\",\n \"lastname\": \"<string>\",\n \"template_name\": \"<string>\",\n \"language\": \"pt_BR\",\n \"variables\": {},\n \"text\": \"<string>\",\n \"content_type\": \"<string>\",\n \"file_url\": \"<string>\",\n \"file_name\": \"<string>\",\n \"topic\": \"<string>\",\n \"pipeline_id\": 123,\n \"pipeline_stage_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"conversation_id": "<string>",
"client_id": "<string>",
"message_id": 123
}
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}{
"success": true,
"message": "<string>",
"meta": {},
"data": {
"conversation_id": "<string>",
"client_id": "<string>"
}
}Iniciar conversa com um contato novo
Único jeito de falar com alguém que nunca conversou com a empresa — acha ou cria o cliente pelo telefone, cria (ou reaproveita, se já houver uma aberta) a conversa, e envia a primeira mensagem.
Aceita canal channel_id de dois tipos, com regras diferentes — o type de cada canal vem em GET /company/{id}/channels:
wba/whatsapp(WhatsApp Cloud API oficial da Meta): aceitasend_type: templateesend_type: text. Fora da janela de 24h de atendimento, só template funciona — a Meta rejeita texto livre pra quem nunca recebeu mensagem sua. UseGET /wba/templates?status=APPROVEDpra listar os templates aprovados. Cumprir a política de uso da Meta (destinatário deu opt-in, etc.) é responsabilidade de quem integra — a Nupapia repassa o erro da Meta tal como veio, sem validação própria.ww(WhatsApp Web): sósend_type: text— não existe conceito de template aprovado nesse canal.send_type: templateretorna422.
Mídia — só em canal ww. content_type, file_url e file_name são aceitos apenas quando channel_id aponta pra um canal ww. Em wba/whatsapp esses campos retornam 422 (mande a primeira mensagem como texto e depois chame POST /chat/conversations/{id}/messages, que aceita mídia em qualquer tipo de canal, pra anexar o arquivo na conversa recém-criada).
A conversa nasce como automated, não “aceita por um humano”. Isso existe pra não lotar a fila de atendimento humano com milhares de conversas “aceitas” que ninguém revisou num disparo em massa — é o mesmo status que a IA usa. Um atendente pode assumir a qualquer momento com POST /chat/conversations/{id}/take-over.
Se o envio falhar (Meta recusou, ou o serviço de WhatsApp Web está fora do ar), o cliente e a conversa continuam existindo (resposta 502 com os ids) — dá pra tentar de novo na mesma conversa via POST /chat/conversations/{id}/wba-send-template (só wba/whatsapp) ou POST /chat/conversations/{id}/messages.
curl --request POST \
--url https://api.nupapia.com.br/api/chat/conversations/start-whatsapp \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"channel_id": 123,
"phone": "+5511999999999",
"name": "<string>",
"lastname": "<string>",
"template_name": "<string>",
"language": "pt_BR",
"variables": {},
"text": "<string>",
"content_type": "<string>",
"file_url": "<string>",
"file_name": "<string>",
"topic": "<string>",
"pipeline_id": 123,
"pipeline_stage_id": 123
}
'import requests
url = "https://api.nupapia.com.br/api/chat/conversations/start-whatsapp"
payload = {
"channel_id": 123,
"phone": "+5511999999999",
"name": "<string>",
"lastname": "<string>",
"template_name": "<string>",
"language": "pt_BR",
"variables": {},
"text": "<string>",
"content_type": "<string>",
"file_url": "<string>",
"file_name": "<string>",
"topic": "<string>",
"pipeline_id": 123,
"pipeline_stage_id": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
channel_id: 123,
phone: '+5511999999999',
name: '<string>',
lastname: '<string>',
template_name: '<string>',
language: 'pt_BR',
variables: {},
text: '<string>',
content_type: '<string>',
file_url: '<string>',
file_name: '<string>',
topic: '<string>',
pipeline_id: 123,
pipeline_stage_id: 123
})
};
fetch('https://api.nupapia.com.br/api/chat/conversations/start-whatsapp', 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://api.nupapia.com.br/api/chat/conversations/start-whatsapp",
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([
'channel_id' => 123,
'phone' => '+5511999999999',
'name' => '<string>',
'lastname' => '<string>',
'template_name' => '<string>',
'language' => 'pt_BR',
'variables' => [
],
'text' => '<string>',
'content_type' => '<string>',
'file_url' => '<string>',
'file_name' => '<string>',
'topic' => '<string>',
'pipeline_id' => 123,
'pipeline_stage_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.nupapia.com.br/api/chat/conversations/start-whatsapp"
payload := strings.NewReader("{\n \"channel_id\": 123,\n \"phone\": \"+5511999999999\",\n \"name\": \"<string>\",\n \"lastname\": \"<string>\",\n \"template_name\": \"<string>\",\n \"language\": \"pt_BR\",\n \"variables\": {},\n \"text\": \"<string>\",\n \"content_type\": \"<string>\",\n \"file_url\": \"<string>\",\n \"file_name\": \"<string>\",\n \"topic\": \"<string>\",\n \"pipeline_id\": 123,\n \"pipeline_stage_id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.nupapia.com.br/api/chat/conversations/start-whatsapp")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"channel_id\": 123,\n \"phone\": \"+5511999999999\",\n \"name\": \"<string>\",\n \"lastname\": \"<string>\",\n \"template_name\": \"<string>\",\n \"language\": \"pt_BR\",\n \"variables\": {},\n \"text\": \"<string>\",\n \"content_type\": \"<string>\",\n \"file_url\": \"<string>\",\n \"file_name\": \"<string>\",\n \"topic\": \"<string>\",\n \"pipeline_id\": 123,\n \"pipeline_stage_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nupapia.com.br/api/chat/conversations/start-whatsapp")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channel_id\": 123,\n \"phone\": \"+5511999999999\",\n \"name\": \"<string>\",\n \"lastname\": \"<string>\",\n \"template_name\": \"<string>\",\n \"language\": \"pt_BR\",\n \"variables\": {},\n \"text\": \"<string>\",\n \"content_type\": \"<string>\",\n \"file_url\": \"<string>\",\n \"file_name\": \"<string>\",\n \"topic\": \"<string>\",\n \"pipeline_id\": 123,\n \"pipeline_stage_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"conversation_id": "<string>",
"client_id": "<string>",
"message_id": 123
}
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}{
"success": true,
"message": "<string>",
"meta": {},
"data": {
"conversation_id": "<string>",
"client_id": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Canal de WhatsApp da empresa (type wba, whatsapp ou ww) — veja GET /company/{id}/channels.
"+5511999999999"
template, text Obrigatório se send_type=template. Só vale pra canais wba/whatsapp.
"pt_BR"
Atalho pras variáveis do template — mapa {"1": "valor"}.
Obrigatório se send_type=text. Em canais wba/whatsapp só funciona dentro da janela de 24h.
Só em canal ww. image, video, audio ou document (aceita também MIME completo, ex: image/png).
Só em canal ww. Obrigatório content_type junto.
Só em canal ww, opcional.