StatusDesenvolvedoresParceirosPTENESEntrar
Falar com vendasCriar conta grátis
Criar conta grátis
Falar com vendasCriar conta grátis
EntrarStatusPTENES

Referência da API

Flows do WhatsApp

Consulte os WhatsApp Flows da sua organização, com o flowJson de cada um, para enviar formulários e telas interativas pela API de mensagens de WhatsApp.

  • 2 operações
  • URL basehttps://api.messages.ccxcompany.co
  • AutenticaçãoBearer com a sua chave de API

O texto técnico abaixo vem do contrato público, o openapi.json, no idioma em que o contrato foi escrito.

Lista os flows da organização

GET/v2/flows

Devolve os flows da organização da credencial, com o flowJson de cada um.

A organização vem da credencial — não existe parâmetro para escolhê-la.

Campos internos (segredos do endpoint, estado do builder, config de envio) não fazem parte do contrato e não são devolvidos.

Parâmetros

CampoOndeTipoDescrição
statusopcionalquerystringValores:draftactivepauseddeprecatedarchived
metaStatusopcionalquerystringValores:DRAFTPUBLISHEDDEPRECATEDBLOCKEDTHROTTLED
categoryopcionalquerystringValores:SIGN_UPSIGN_INAPPOINTMENT_BOOKINGLEAD_GENERATIONCONTACT_USCUSTOMER_SUPPORTSURVEYOTHER
numberIdopcionalquerystring
limitopcionalqueryinteger
skipopcionalqueryinteger

Respostas

  • 200Default Response

    Campos e exemplo da resposta
    CampoTipoDescrição
    itemsobrigatórioobject[]
    items[].idobrigatóriostring
    items[].organizationIdobrigatóriostring
    items[].numberIdobrigatóriostring
    items[].nameobrigatóriostring
    items[].descriptionopcionalstring
    items[].statusobrigatóriostringValores:draftactivepauseddeprecatedarchived
    items[].versionobrigatóriointeger
    items[].metaFlowIdopcionalstring
    items[].metaStatusopcionalstringValores:DRAFTPUBLISHEDDEPRECATEDBLOCKEDTHROTTLED
    items[].metaCategoriesobrigatóriostring[]
    items[].flowJsonobrigatórioobject
    items[].flowJson.versionopcionalstringPadrão:6.2
    items[].flowJson.data_api_versionopcionalstringPadrão:3.0
    items[].flowJson.routing_modelopcionalobject
    items[].flowJson.screensobrigatórioobject[]
    items[].publishedAtopcionalstring · date-time
    items[].createdAtobrigatóriostring · date-time
    items[].updatedAtobrigatóriostring · date-time
    totalobrigatóriointeger
    JSON
    {  "items": [    {      "id": "string",      "organizationId": "string",      "numberId": "string",      "name": "string",      "description": "string",      "status": "draft",      "version": 1,      "metaFlowId": "string",      "metaStatus": "DRAFT",      "metaCategories": [        "SIGN_UP"      ],      "flowJson": {        "version": "6.2",        "data_api_version": "3.0",        "routing_model": {},        "screens": [          {            "id": "string",            "title": "string",            "terminal": true,            "success": true,            "refresh_on_back": true,            "sensitive": [              "string"            ],            "data": {},            "layout": {              "type": "SingleColumnLayout",              "children": [                {                  "type": null                }              ]            }          }        ]      },      "publishedAt": "2026-10-16T12:00:00.000Z",      "createdAt": "2026-10-16T12:00:00.000Z",      "updatedAt": "2026-10-16T12:00:00.000Z"    }  ],  "total": 0}

  • 400RFC 7807 problem details for BAD_REQUEST (400).

  • 401RFC 7807 problem details for UNAUTHORIZED (401).

  • 403RFC 7807 problem details for FORBIDDEN (403).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL
curl 'https://api.messages.ccxcompany.co/v2/flows' \  -H "Authorization: Bearer $CCX_API_KEY"
Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Lê um flow pelo id

GET/v2/flows/{id}

Devolve um flow da organização da credencial.

404 também é a resposta para um flow de outra organização: distinguir “não existe” de “não é seu” contaria a existência de dado alheio.

Parâmetros

CampoOndeTipoDescrição
idobrigatóriocaminhostring

Respostas

  • 200Default Response

    Campos e exemplo da resposta
    CampoTipoDescrição
    idobrigatóriostring
    organizationIdobrigatóriostring
    numberIdobrigatóriostring
    nameobrigatóriostring
    descriptionopcionalstring
    statusobrigatóriostringValores:draftactivepauseddeprecatedarchived
    versionobrigatóriointeger
    metaFlowIdopcionalstring
    metaStatusopcionalstringValores:DRAFTPUBLISHEDDEPRECATEDBLOCKEDTHROTTLED
    metaCategoriesobrigatóriostring[]
    flowJsonobrigatórioobject
    flowJson.versionopcionalstringPadrão:6.2
    flowJson.data_api_versionopcionalstringPadrão:3.0
    flowJson.routing_modelopcionalobject
    flowJson.screensobrigatórioobject[]
    flowJson.screens[].idobrigatóriostring
    flowJson.screens[].titleopcionalstring
    flowJson.screens[].terminalopcionalboolean
    flowJson.screens[].successopcionalboolean
    flowJson.screens[].refresh_on_backopcionalboolean
    flowJson.screens[].sensitiveopcionalstring[]
    flowJson.screens[].dataopcionalobject
    flowJson.screens[].layoutobrigatórioobject
    publishedAtopcionalstring · date-time
    createdAtobrigatóriostring · date-time
    updatedAtobrigatóriostring · date-time
    JSON
    {  "id": "string",  "organizationId": "string",  "numberId": "string",  "name": "string",  "description": "string",  "status": "draft",  "version": 1,  "metaFlowId": "string",  "metaStatus": "DRAFT",  "metaCategories": [    "SIGN_UP"  ],  "flowJson": {    "version": "6.2",    "data_api_version": "3.0",    "routing_model": {},    "screens": [      {        "id": "string",        "title": "string",        "terminal": true,        "success": true,        "refresh_on_back": true,        "sensitive": [          "string"        ],        "data": {},        "layout": {          "type": "SingleColumnLayout",          "children": [            {              "type": "string"            }          ]        }      }    ]  },  "publishedAt": "2026-10-16T12:00:00.000Z",  "createdAt": "2026-10-16T12:00:00.000Z",  "updatedAt": "2026-10-16T12:00:00.000Z"}

  • 400RFC 7807 problem details for BAD_REQUEST (400).

  • 401RFC 7807 problem details for UNAUTHORIZED (401).

  • 403RFC 7807 problem details for FORBIDDEN (403).

  • 404RFC 7807 problem details for NOT_FOUND (404).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL
curl 'https://api.messages.ccxcompany.co/v2/flows/<id>' \  -H "Authorization: Bearer $CCX_API_KEY"
Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Outras áreas da API

Travou em alguma rota? Fale com quem mantém a API.

Criar conta grátisFalar com vendas

Criando a conta pelo site, você ganha R$ 10 de crédito de teste.