Flows

Listar respostas do Flow

Os formulários que os clientes enviaram para UM Flow, os mais novos primeiro. O Flow é resolvido primeiro dentro da WABA da própria chave, e essa resolução é a única coisa que escopa o resto — um Flow de outra WABA (inclusive outra WABA do mesmo tenant) responde 404 e nenhuma resposta chega a ser lida.

Respostas fora da janela de retenção são excluídas AQUI, não só pela tarefa de poda, para que ninguém leia um envio que a janela publicada diz ter sumido. contactPhone vem null quando o telefone já não é nosso para publicar. externalMessageId é o wamid da Meta e é NOMEADO como id de provedor de propósito — todo outro id desta superfície é local.

notice: "FLOW_RESPONSES_WINDOW_TRUNCATED" aparece na página quando o Flow cunhou mais envios do que uma requisição correlaciona (teto de 10.000 sessões). Uma resposta curta que não diz que é curta é o que faz o cliente concluir que perdeu envios. Permissão flows:read.

Exige chave com escopo de número. Uma chave de tenant precisa nomear o número no header x-whatsapp-number-id, senão recebe 403 TENANT_SCOPE_NOT_ALLOWED.

GET

flows

{id}

responses

Listar respostas do Flow

curl --request GET \
  --url https://pilotstatus.com.br/v1/flows/{id}/responses \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://pilotstatus.com.br/v1/flows/{id}/responses', 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://pilotstatus.com.br/v1/flows/{id}/responses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://pilotstatus.com.br/v1/flows/{id}/responses"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/flows/{id}/responses")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "responses": [
    {
      "id": "cmf9z8y7x6w5v4u3t2s1r0q9",
      "flowId": "cmf1a2b3c4d5e6f7g8h9i0j1",
      "contactPhone": "5564999978874",
      "flowToken": "b7c1e4f2a9d84c6e8f0a1b2c3d4e5f60",
      "externalMessageId": "wamid.HBgNNTU2NDk5OTc4ODc0FQIAERgSN0E5...",
      "response": {
        "screen_0_nome": "Amanda",
        "screen_0_nota": "9"
      },
      "receivedAt": "2026-09-01T18:22:11.000Z",
      "expiresAt": "2026-10-01T18:22:11.000Z"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 30,
  "totalPages": 1
}

{
  "error": "Paginação profunda demais: page × pageSize não pode passar de 10000.",
  "errorEN": "Pagination too deep: page × pageSize must not exceed 10000.",
  "code": "INVALID_PAGINATION"
}

{
  "error": "Unauthorized"
}

{
  "error": "Tenant-scoped keys cannot call number endpoints",
  "code": "TENANT_SCOPE_NOT_ALLOWED"
}

{
  "error": "Flow não encontrado para o número desta chave.",
  "errorEN": "Flow not found for this key's number.",
  "code": "FLOW_NOT_FOUND"
}

{
  "error": "Flows existem apenas em números Meta (API Oficial). O número desta chave não é Meta ou não tem uma WABA associada — use uma chave de um número Meta.",
  "errorEN": "Flows only exist on Meta (Cloud API) numbers. This key's number is not a Meta number, or has no WABA behind it — use a key bound to a Meta number.",
  "code": "FLOW_REQUIRES_META_NUMBER"
}

{
  "error": "Too many requests"
}

{
  "error": "Erro interno do servidor.",
  "errorEN": "Internal server error.",
  "code": "INTERNAL_ERROR"
}

Autorizações

x-api-key

string

header

obrigatório

Sua chave de API ps_

Parâmetros de caminho

string

obrigatório

O id local do Flow — o campo id que GET /v1/flows devolve, nunca o metaFlowId.

Parâmetros de consulta

page

integer

padrão:1

Número da página, começando em 1.

Intervalo obrigatório: x >= 1

pageSize

integer

padrão:30

Linhas por página. Padrão 30, máximo 100.

Intervalo obrigatório: 1 <= x <= 100

Resposta

Listar respostas do Flow

curl --request GET \
  --url https://pilotstatus.com.br/v1/flows/{id}/responses \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://pilotstatus.com.br/v1/flows/{id}/responses', 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://pilotstatus.com.br/v1/flows/{id}/responses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://pilotstatus.com.br/v1/flows/{id}/responses"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/flows/{id}/responses")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "responses": [
    {
      "id": "cmf9z8y7x6w5v4u3t2s1r0q9",
      "flowId": "cmf1a2b3c4d5e6f7g8h9i0j1",
      "contactPhone": "5564999978874",
      "flowToken": "b7c1e4f2a9d84c6e8f0a1b2c3d4e5f60",
      "externalMessageId": "wamid.HBgNNTU2NDk5OTc4ODc0FQIAERgSN0E5...",
      "response": {
        "screen_0_nome": "Amanda",
        "screen_0_nota": "9"
      },
      "receivedAt": "2026-09-01T18:22:11.000Z",
      "expiresAt": "2026-10-01T18:22:11.000Z"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 30,
  "totalPages": 1
}

{
  "error": "Paginação profunda demais: page × pageSize não pode passar de 10000.",
  "errorEN": "Pagination too deep: page × pageSize must not exceed 10000.",
  "code": "INVALID_PAGINATION"
}

{
  "error": "Unauthorized"
}

{
  "error": "Tenant-scoped keys cannot call number endpoints",
  "code": "TENANT_SCOPE_NOT_ALLOWED"
}

{
  "error": "Flow não encontrado para o número desta chave.",
  "errorEN": "Flow not found for this key's number.",
  "code": "FLOW_NOT_FOUND"
}

{
  "error": "Flows existem apenas em números Meta (API Oficial). O número desta chave não é Meta ou não tem uma WABA associada — use uma chave de um número Meta.",
  "errorEN": "Flows only exist on Meta (Cloud API) numbers. This key's number is not a Meta number, or has no WABA behind it — use a key bound to a Meta number.",
  "code": "FLOW_REQUIRES_META_NUMBER"
}

{
  "error": "Too many requests"
}

{
  "error": "Erro interno do servidor.",
  "errorEN": "Internal server error.",
  "code": "INTERNAL_ERROR"
}

Endpoints

Workspace

Listar respostas do Flow

Autorizações

Parâmetros de caminho

Parâmetros de consulta

Resposta