EstadoDesarrolladoresSociosPTENESIniciar sesión
Habla con ventasEmpieza gratis
Empieza gratis
Habla con ventasEmpieza gratis
Iniciar sesiónEstadoPTENES

Referencia de la API

Flows de WhatsApp

Consulta los WhatsApp Flows de tu organización, con el flowJson de cada uno, para enviar formularios y pantallas interactivas por la API de mensajes.

  • 2 operaciones
  • URL basehttps://api.messages.ccxcompany.co
  • AutenticaciónBearer con tu clave de API

El texto técnico de abajo viene del contrato público, openapi.json, en el idioma en que se escribió el contrato.

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

CampoDóndeTipoDescripción
statusopcionalquerystringValores:draftactivepauseddeprecatedarchived
metaStatusopcionalquerystringValores:DRAFTPUBLISHEDDEPRECATEDBLOCKEDTHROTTLED
categoryopcionalquerystringValores:SIGN_UPSIGN_INAPPOINTMENT_BOOKINGLEAD_GENERATIONCONTACT_USCUSTOMER_SUPPORTSURVEYOTHER
numberIdopcionalquerystring
limitopcionalqueryinteger
skipopcionalqueryinteger

Respuestas

  • 200Default Response

    Campos y ejemplo de la respuesta
    CampoTipoDescripción
    itemsobligatorioobject[]
    items[].idobligatoriostring
    items[].organizationIdobligatoriostring
    items[].numberIdobligatoriostring
    items[].nameobligatoriostring
    items[].descriptionopcionalstring
    items[].statusobligatoriostringValores:draftactivepauseddeprecatedarchived
    items[].versionobligatoriointeger
    items[].metaFlowIdopcionalstring
    items[].metaStatusopcionalstringValores:DRAFTPUBLISHEDDEPRECATEDBLOCKEDTHROTTLED
    items[].metaCategoriesobligatoriostring[]
    items[].flowJsonobligatorioobject
    items[].flowJson.versionopcionalstringPor defecto:6.2
    items[].flowJson.data_api_versionopcionalstringPor defecto:3.0
    items[].flowJson.routing_modelopcionalobject
    items[].flowJson.screensobligatorioobject[]
    items[].publishedAtopcionalstring · date-time
    items[].createdAtobligatoriostring · date-time
    items[].updatedAtobligatoriostring · date-time
    totalobligatoriointeger
    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).

Las respuestas de error siguen el formato RFC 7807 (application/problem+json), con un código estable en el campo code. Ver los códigos de error

Ejemplo en curl

cURL
curl 'https://api.messages.ccxcompany.co/v2/flows' \  -H "Authorization: Bearer $CCX_API_KEY"
Solo los campos obligatorios. Cambia los valores de ejemplo por los tuyos.

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

CampoDóndeTipoDescripción
idobligatoriorutastring

Respuestas

  • 200Default Response

    Campos y ejemplo de la respuesta
    CampoTipoDescripción
    idobligatoriostring
    organizationIdobligatoriostring
    numberIdobligatoriostring
    nameobligatoriostring
    descriptionopcionalstring
    statusobligatoriostringValores:draftactivepauseddeprecatedarchived
    versionobligatoriointeger
    metaFlowIdopcionalstring
    metaStatusopcionalstringValores:DRAFTPUBLISHEDDEPRECATEDBLOCKEDTHROTTLED
    metaCategoriesobligatoriostring[]
    flowJsonobligatorioobject
    flowJson.versionopcionalstringPor defecto:6.2
    flowJson.data_api_versionopcionalstringPor defecto:3.0
    flowJson.routing_modelopcionalobject
    flowJson.screensobligatorioobject[]
    flowJson.screens[].idobligatoriostring
    flowJson.screens[].titleopcionalstring
    flowJson.screens[].terminalopcionalboolean
    flowJson.screens[].successopcionalboolean
    flowJson.screens[].refresh_on_backopcionalboolean
    flowJson.screens[].sensitiveopcionalstring[]
    flowJson.screens[].dataopcionalobject
    flowJson.screens[].layoutobligatorioobject
    publishedAtopcionalstring · date-time
    createdAtobligatoriostring · date-time
    updatedAtobligatoriostring · 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).

Las respuestas de error siguen el formato RFC 7807 (application/problem+json), con un código estable en el campo code. Ver los códigos de error

Ejemplo en curl

cURL
curl 'https://api.messages.ccxcompany.co/v2/flows/<id>' \  -H "Authorization: Bearer $CCX_API_KEY"
Solo los campos obligatorios. Cambia los valores de ejemplo por los tuyos.

Otras áreas de la API

¿Atascado en una ruta? Habla con quienes mantienen la API.

Empieza gratisHabla con ventas

Si creas la cuenta desde la web, recibes 5 US$ de crédito de prueba.