Referência da API

Jornadas

Crie jornadas em rascunho, teste com um contato, ative, pause ou arquive, ponha contatos nelas e acompanhe as execuções e os números de cada passo.

15 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 as jornadas

GET/v2/journeys

Jornadas da organização, da mais nova para a mais antiga, sem o grafo (passos) — para ele, GET /v2/journeys/{id}. Até 200 jornadas não arquivadas por organização. Permissão: campaigns:read.

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`items`obrigatório	`object[]`
`items[].id`obrigatório	`string`
`items[].name`obrigatório	`string`
`items[].status`obrigatório	`string`	Valores:`rascunhoativapausadaarquivada`
`items[].gatilho`obrigatório	`object`
`items[].gatilho.tipo`opcional	`string`	Valores:`segmento`
`items[].gatilho.listId`opcional	`string`
`items[].gatilho.nome`opcional	`string`
`items[].gatilho.segmentId`opcional	`string`
`items[].reentrada`obrigatório	`string`	Valores:`nuncaapos_concluir`
`items[].intervaloReentradaHoras`opcional	`integer`
`items[].execucoes`opcional	`object`
`items[].execucoes.ativa`obrigatório	`integer`
`items[].execucoes.concluida`obrigatório	`integer`
`items[].execucoes.cancelada`obrigatório	`integer`
`items[].execucoes.erro`obrigatório	`integer`
`items[].pausadaPor`opcional	`object`
`items[].pausadaPor.motivo`obrigatório	`string`
`items[].pausadaPor.passo`obrigatório	`string`
`items[].pausadaPor.em`obrigatório	`string`
`items[].pausadaPor.rotulo`opcional	`string`
`items[].ativadaEm`opcional	`string`
`items[].silencio`opcional	`object`
`items[].silencio.inicio`obrigatório	`string`
`items[].silencio.fim`obrigatório	`string`
`items[].tetoDeFrequencia`opcional	`object`
`items[].tetoDeFrequencia.mensagens`obrigatório	`integer`
`items[].tetoDeFrequencia.dias`obrigatório	`integer`
`items[].meta`opcional	`object`
`items[].meta.evento`obrigatório	`string`
`items[].versao`opcional	`integer`
`items[].versaoDe`opcional	`string`
`items[].substituidaPor`opcional	`string`
`items[].entradasEncerradas`opcional	`boolean`
`items[].createdAt`obrigatório	`string`
`items[].updatedAt`obrigatório	`string`
`items[].canais`obrigatório	`string[]`
`items[].fluxo`obrigatório	`string[]`
`items[].metaEvento`opcional	`string`
`items[].lista`opcional	`object`
`items[].lista.nome`obrigatório	`string`
`items[].lista.tamanho`obrigatório	`integer`
`items[].segmento`opcional	`object`
`items[].segmento.nome`obrigatório	`string`

JSON

{  "items": [    {      "id": "string",      "name": "string",      "status": "rascunho",      "gatilho": {        "tipo": "lista",        "listId": "string"      },      "reentrada": "nunca",      "intervaloReentradaHoras": 0,      "execucoes": {        "ativa": 0,        "concluida": 0,        "cancelada": 0,        "erro": 0      },      "pausadaPor": {        "motivo": "string",        "passo": "string",        "em": "string",        "rotulo": "string"      },      "ativadaEm": "string",      "silencio": {        "inicio": "string",        "fim": "string"      },      "tetoDeFrequencia": {        "mensagens": 1,        "dias": 1      },      "meta": {        "evento": "string"      },      "versao": 1,      "versaoDe": "string",      "substituidaPor": "string",      "entradasEncerradas": true,      "createdAt": "string",      "updatedAt": "string",      "canais": [        "whatsapp"      ],      "fluxo": [        "gatilho"      ],      "metaEvento": "string",      "lista": {        "nome": "string",        "tamanho": 0      },      "segmento": {        "nome": "string"      }    }  ]}

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/journeys' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Cria uma jornada (em rascunho)

POST/v2/journeys

Uma jornada põe contatos numa sequência de passos. Nasce em rascunho e só envia depois de POST …/activate.

Gatilho (gatilho): lista (membros de uma lista estática — cada um entra uma vez), evento (cada POST /v2/events NOVO, de chave de produção, com esse nome e contato, ocorrido depois da ativação e há menos de 72 h) ou api (POST …/entries).

Passos (passos, até 50, sem ciclo):

enviar — WhatsApp (template aprovado + numberId), SMS (smsRoute, padrão premium) ou e-mail. variaveis diz de onde sai cada {{n}}: contato (campo do cadastro), entrada (dado da entrada: properties do evento ou dados do POST …/entries) ou fixo. Envio que não dá para montar (sem telefone, variável vazia, template indisponível) é pulado — nada sai quebrado — e a jornada segue.
esperar — de 1 minuto a 90 dias.
condicao — desvia pelo desfecho de um envio anterior dentro de janelaMinutos, contada a partir do DISPARO: entregue, lido e respondeu (WhatsApp), entregue (SMS) ou converteu (evento do cliente com o nome em evento, qualquer canal). O "não" nunca sai com o envio original ainda na fila: ou ele é recolhido, ou a condição espera. Envio que talvez tenha saído (o provedor não confirmou) não dispara o plano B.
webhook — avisa um sistema seu (ex.: a agenda do vendedor) que o contato chegou a este ponto: POST assinado (X-CCX-Signature, o segredo da assinatura) para uma assinatura cadastrada em Webhooks (webhookId, ativa, com os cabeçalhos próprios dela), evento journey.action, corpo com a jornada, o contato (id, externalId) e os dados da entrada — sem nome, telefone ou e-mail. X-CCX-Idempotency-Key = execução:passo. 2xx segue o proximo; 5xx/429/rede tenta de novo até 3 vezes; 4xx ou esgotado segue seFalhar (padrão: proximo).
fim.

Opt-out cancela a execução do contato: a jornada não segue para outro canal.

Reentrada: nunca (padrão) ou apos_concluir, com intervaloReentradaHoras mínimo entre duas entradas do mesmo contato (padrão 24).

Grafo com problema (passo sem saída, template sem variável mapeada…) é recusado com 422. Com ?permitirProblemas=true o rascunho é salvo assim mesmo e a resposta lista o que falta em problemas — a ativação continua recusando enquanto houver algum. Permissão: campaigns:write.

Parâmetros

Campo	Onde	Tipo	Descrição
`permitirProblemas`opcional	query	`string`	Valores:`truefalse`

Corpo da requisição`application/json`

Campo	Tipo	Descrição
`name`obrigatório	`string`
`gatilho`obrigatório	`object`
`gatilho.tipo`opcional	`string`	Valores:`segmento`
`gatilho.listId`opcional	`string`
`gatilho.nome`opcional	`string`
`gatilho.segmentId`opcional	`string`
`inicio`obrigatório	`string`
`passos`obrigatório	`object[]`
`passos[].id`opcional	`string`
`passos[].tipo`opcional	`string`	Valores:`fim`
`passos[].canal`opcional	`string`	Valores:`whatsappsmsemailrcs`
`passos[].templateId`opcional	`string`
`passos[].numberId`opcional	`string`
`passos[].smsRoute`opcional	`string`	Valores:`premiumotp`
`passos[].rcs`opcional	`object`
`passos[].rcs.conteudo`obrigatório	`object`
`passos[].rcs.fallback`opcional	`object`
`passos[].rcs.rota`opcional	`string`	Valores:`easy_rcseasy_otp_rcs`
`passos[].variaveis`opcional	`object`
`passos[].proximo`opcional	`string`
`passos[].minutos`opcional	`integer`
`passos[].sobre`opcional	`string`
`passos[].sinal`opcional	`string`	Valores:`entreguelidoclicourespondeuconverteu`
`passos[].evento`opcional	`string`
`passos[].janelaMinutos`opcional	`integer`
`passos[].sim`opcional	`string`
`passos[].nao`opcional	`string`
`passos[].webhookId`opcional	`string`
`passos[].seFalhar`opcional	`string`
`passos[].dias`opcional	`integer[]`
`passos[].hora`opcional	`string`
`passos[].ramos`opcional	`object[]`
`passos[].ramos[].nome`obrigatório	`string`
`passos[].ramos[].peso`obrigatório	`integer`
`passos[].ramos[].proximo`obrigatório	`string`
`passos[].campo`opcional	`string`
`passos[].operador`opcional	`string`	Valores:`igualdiferentecontemexistenao_existemaiormenor`
`passos[].valor`opcional	`string`
`reentrada`opcional	`string`	Valores:`nuncaapos_concluir`Padrão:`nunca`
`intervaloReentradaHoras`opcional	`integer`
`silencio`opcional	`object`
`silencio.inicio`obrigatório	`string`
`silencio.fim`obrigatório	`string`
`tetoDeFrequencia`opcional	`object`
`tetoDeFrequencia.mensagens`obrigatório	`integer`
`tetoDeFrequencia.dias`obrigatório	`integer`
`meta`opcional	`object`
`meta.evento`obrigatório	`string`

Exemplo completo do corpo

JSON

{  "name": "string",  "gatilho": {    "tipo": "lista",    "listId": "string"  },  "inicio": "string",  "passos": [    {      "id": "string",      "tipo": "enviar",      "canal": "whatsapp",      "templateId": "string",      "numberId": "string",      "smsRoute": "premium",      "rcs": {        "conteudo": {          "text": "string"        },        "fallback": {          "text": "string"        },        "rota": "easy_rcs"      },      "variaveis": {},      "proximo": "string"    }  ],  "reentrada": "nunca",  "intervaloReentradaHoras": 1,  "silencio": {    "inicio": "string",    "fim": "string"  },  "tetoDeFrequencia": {    "mensagens": 1,    "dias": 1  },  "meta": {    "evento": "string"  }}

Respostas

201Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`id`obrigatório	`string`
`name`obrigatório	`string`
`status`obrigatório	`string`	Valores:`rascunhoativapausadaarquivada`
`gatilho`obrigatório	`object`
`gatilho.tipo`opcional	`string`	Valores:`segmento`
`gatilho.listId`opcional	`string`
`gatilho.nome`opcional	`string`
`gatilho.segmentId`opcional	`string`
`inicio`obrigatório	`string`
`passos`obrigatório	`object[]`
`passos[].id`opcional	`string`
`passos[].tipo`opcional	`string`	Valores:`fim`
`passos[].canal`opcional	`string`	Valores:`whatsappsmsemailrcs`
`passos[].templateId`opcional	`string`
`passos[].numberId`opcional	`string`
`passos[].smsRoute`opcional	`string`	Valores:`premiumotp`
`passos[].rcs`opcional	`object`
`passos[].rcs.conteudo`obrigatório	`object`
`passos[].rcs.fallback`opcional	`object`
`passos[].rcs.rota`opcional	`string`	Valores:`easy_rcseasy_otp_rcs`
`passos[].variaveis`opcional	`object`
`passos[].proximo`opcional	`string`
`passos[].minutos`opcional	`integer`
`passos[].sobre`opcional	`string`
`passos[].sinal`opcional	`string`	Valores:`entreguelidoclicourespondeuconverteu`
`passos[].evento`opcional	`string`
`passos[].janelaMinutos`opcional	`integer`
`passos[].sim`opcional	`string`
`passos[].nao`opcional	`string`
`passos[].webhookId`opcional	`string`
`passos[].seFalhar`opcional	`string`
`passos[].dias`opcional	`integer[]`
`passos[].hora`opcional	`string`
`passos[].ramos`opcional	`object[]`
`passos[].ramos[].nome`obrigatório	`string`
`passos[].ramos[].peso`obrigatório	`integer`
`passos[].ramos[].proximo`obrigatório	`string`
`passos[].campo`opcional	`string`
`passos[].operador`opcional	`string`	Valores:`igualdiferentecontemexistenao_existemaiormenor`
`passos[].valor`opcional	`string`
`reentrada`obrigatório	`string`	Valores:`nuncaapos_concluir`
`intervaloReentradaHoras`opcional	`integer`
`execucoes`opcional	`object`
`execucoes.ativa`obrigatório	`integer`
`execucoes.concluida`obrigatório	`integer`
`execucoes.cancelada`obrigatório	`integer`
`execucoes.erro`obrigatório	`integer`
`pausadaPor`opcional	`object`
`pausadaPor.motivo`obrigatório	`string`
`pausadaPor.passo`obrigatório	`string`
`pausadaPor.em`obrigatório	`string`
`pausadaPor.rotulo`opcional	`string`
`ativadaEm`opcional	`string`
`silencio`opcional	`object`
`silencio.inicio`obrigatório	`string`
`silencio.fim`obrigatório	`string`
`tetoDeFrequencia`opcional	`object`
`tetoDeFrequencia.mensagens`obrigatório	`integer`
`tetoDeFrequencia.dias`obrigatório	`integer`
`meta`opcional	`object`

Mais 8 campos no openapi.json.

JSON

{  "id": "string",  "name": "string",  "status": "rascunho",  "gatilho": {    "tipo": "lista",    "listId": "string"  },  "inicio": "string",  "passos": [    {      "id": "string",      "tipo": "enviar",      "canal": "whatsapp",      "templateId": "string",      "numberId": "string",      "smsRoute": "premium",      "rcs": {        "conteudo": {          "text": "string"        },        "fallback": {          "text": "string"        },        "rota": "easy_rcs"      },      "variaveis": {},      "proximo": "string"    }  ],  "reentrada": "nunca",  "intervaloReentradaHoras": 0,  "execucoes": {    "ativa": 0,    "concluida": 0,    "cancelada": 0,    "erro": 0  },  "pausadaPor": {    "motivo": "string",    "passo": "string",    "em": "string",    "rotulo": "string"  },  "ativadaEm": "string",  "silencio": {    "inicio": "string",    "fim": "string"  },  "tetoDeFrequencia": {    "mensagens": 1,    "dias": 1  },  "meta": {    "evento": "string"  },  "versao": 1,  "versaoDe": "string",  "substituidaPor": "string",  "entradasEncerradas": true,  "problemas": [    "string"  ],  "createdAt": "string",  "updatedAt": "string"}

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).
409RFC 7807 problem details for CONFLICT (409).
412RFC 7807 problem details for PRECONDITION_FAILED (412).
422RFC 7807 problem details for VALIDATION_ERROR (422).

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 -X POST 'https://api.messages.ccxcompany.co/v2/journeys' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Idempotency-Key: order-4821" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "gatilho": {      "tipo": "lista",      "listId": "string"    },    "inicio": "string",    "passos": [      {        "id": "string",        "tipo": "enviar",        "canal": "whatsapp"      }    ]  }'

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Uma jornada, com a contagem das execuções

GET/v2/journeys/{id}

execucoes: quantos contatos estão em curso (ativa), concluíram, foram cancelados (opt-out, arquivamento) ou deram erro. Permissão: campaigns:read.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`id`obrigatório	`string`
`name`obrigatório	`string`
`status`obrigatório	`string`	Valores:`rascunhoativapausadaarquivada`
`gatilho`obrigatório	`object`
`gatilho.tipo`opcional	`string`	Valores:`segmento`
`gatilho.listId`opcional	`string`
`gatilho.nome`opcional	`string`
`gatilho.segmentId`opcional	`string`
`inicio`obrigatório	`string`
`passos`obrigatório	`object[]`
`passos[].id`opcional	`string`
`passos[].tipo`opcional	`string`	Valores:`fim`
`passos[].canal`opcional	`string`	Valores:`whatsappsmsemailrcs`
`passos[].templateId`opcional	`string`
`passos[].numberId`opcional	`string`
`passos[].smsRoute`opcional	`string`	Valores:`premiumotp`
`passos[].rcs`opcional	`object`
`passos[].rcs.conteudo`obrigatório	`object`
`passos[].rcs.fallback`opcional	`object`
`passos[].rcs.rota`opcional	`string`	Valores:`easy_rcseasy_otp_rcs`
`passos[].variaveis`opcional	`object`
`passos[].proximo`opcional	`string`
`passos[].minutos`opcional	`integer`
`passos[].sobre`opcional	`string`
`passos[].sinal`opcional	`string`	Valores:`entreguelidoclicourespondeuconverteu`
`passos[].evento`opcional	`string`
`passos[].janelaMinutos`opcional	`integer`
`passos[].sim`opcional	`string`
`passos[].nao`opcional	`string`
`passos[].webhookId`opcional	`string`
`passos[].seFalhar`opcional	`string`
`passos[].dias`opcional	`integer[]`
`passos[].hora`opcional	`string`
`passos[].ramos`opcional	`object[]`
`passos[].ramos[].nome`obrigatório	`string`
`passos[].ramos[].peso`obrigatório	`integer`
`passos[].ramos[].proximo`obrigatório	`string`
`passos[].campo`opcional	`string`
`passos[].operador`opcional	`string`	Valores:`igualdiferentecontemexistenao_existemaiormenor`
`passos[].valor`opcional	`string`
`reentrada`obrigatório	`string`	Valores:`nuncaapos_concluir`
`intervaloReentradaHoras`opcional	`integer`
`execucoes`opcional	`object`
`execucoes.ativa`obrigatório	`integer`
`execucoes.concluida`obrigatório	`integer`
`execucoes.cancelada`obrigatório	`integer`
`execucoes.erro`obrigatório	`integer`
`pausadaPor`opcional	`object`
`pausadaPor.motivo`obrigatório	`string`
`pausadaPor.passo`obrigatório	`string`
`pausadaPor.em`obrigatório	`string`
`pausadaPor.rotulo`opcional	`string`
`ativadaEm`opcional	`string`
`silencio`opcional	`object`
`silencio.inicio`obrigatório	`string`
`silencio.fim`obrigatório	`string`
`tetoDeFrequencia`opcional	`object`
`tetoDeFrequencia.mensagens`obrigatório	`integer`
`tetoDeFrequencia.dias`obrigatório	`integer`
`meta`opcional	`object`

Mais 8 campos no openapi.json.

JSON

{  "id": "string",  "name": "string",  "status": "rascunho",  "gatilho": {    "tipo": "lista",    "listId": "string"  },  "inicio": "string",  "passos": [    {      "id": "string",      "tipo": "enviar",      "canal": "whatsapp",      "templateId": "string",      "numberId": "string",      "smsRoute": "premium",      "rcs": {        "conteudo": {          "text": "string"        },        "fallback": {          "text": "string"        },        "rota": "easy_rcs"      },      "variaveis": {},      "proximo": "string"    }  ],  "reentrada": "nunca",  "intervaloReentradaHoras": 0,  "execucoes": {    "ativa": 0,    "concluida": 0,    "cancelada": 0,    "erro": 0  },  "pausadaPor": {    "motivo": "string",    "passo": "string",    "em": "string",    "rotulo": "string"  },  "ativadaEm": "string",  "silencio": {    "inicio": "string",    "fim": "string"  },  "tetoDeFrequencia": {    "mensagens": 1,    "dias": 1  },  "meta": {    "evento": "string"  },  "versao": 1,  "versaoDe": "string",  "substituidaPor": "string",  "entradasEncerradas": true,  "problemas": [    "string"  ],  "createdAt": "string",  "updatedAt": "string"}

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/journeys/<id>' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Substitui a definição de uma jornada em rascunho

PUT/v2/journeys/{id}

Só o rascunho é editável — uma execução em curso está parada num passo, e trocar o grafo por baixo dela a perderia. Para mudar uma jornada que já rodou: arquive e crie outra (409). ?permitirProblemas=true salva o rascunho mesmo com problemas no grafo (ver POST /v2/journeys). Permissão: campaigns:write.

Parâmetros

Campo	Onde	Tipo	Descrição
`permitirProblemas`opcional	query	`string`	Valores:`truefalse`
`id`obrigatório	caminho	`string`

Corpo da requisição`application/json`

Campo	Tipo	Descrição
`name`obrigatório	`string`
`gatilho`obrigatório	`object`
`gatilho.tipo`opcional	`string`	Valores:`segmento`
`gatilho.listId`opcional	`string`
`gatilho.nome`opcional	`string`
`gatilho.segmentId`opcional	`string`
`inicio`obrigatório	`string`
`passos`obrigatório	`object[]`
`passos[].id`opcional	`string`
`passos[].tipo`opcional	`string`	Valores:`fim`
`passos[].canal`opcional	`string`	Valores:`whatsappsmsemailrcs`
`passos[].templateId`opcional	`string`
`passos[].numberId`opcional	`string`
`passos[].smsRoute`opcional	`string`	Valores:`premiumotp`
`passos[].rcs`opcional	`object`
`passos[].rcs.conteudo`obrigatório	`object`
`passos[].rcs.fallback`opcional	`object`
`passos[].rcs.rota`opcional	`string`	Valores:`easy_rcseasy_otp_rcs`
`passos[].variaveis`opcional	`object`
`passos[].proximo`opcional	`string`
`passos[].minutos`opcional	`integer`
`passos[].sobre`opcional	`string`
`passos[].sinal`opcional	`string`	Valores:`entreguelidoclicourespondeuconverteu`
`passos[].evento`opcional	`string`
`passos[].janelaMinutos`opcional	`integer`
`passos[].sim`opcional	`string`
`passos[].nao`opcional	`string`
`passos[].webhookId`opcional	`string`
`passos[].seFalhar`opcional	`string`
`passos[].dias`opcional	`integer[]`
`passos[].hora`opcional	`string`
`passos[].ramos`opcional	`object[]`
`passos[].ramos[].nome`obrigatório	`string`
`passos[].ramos[].peso`obrigatório	`integer`
`passos[].ramos[].proximo`obrigatório	`string`
`passos[].campo`opcional	`string`
`passos[].operador`opcional	`string`	Valores:`igualdiferentecontemexistenao_existemaiormenor`
`passos[].valor`opcional	`string`
`reentrada`opcional	`string`	Valores:`nuncaapos_concluir`Padrão:`nunca`
`intervaloReentradaHoras`opcional	`integer`
`silencio`opcional	`object`
`silencio.inicio`obrigatório	`string`
`silencio.fim`obrigatório	`string`
`tetoDeFrequencia`opcional	`object`
`tetoDeFrequencia.mensagens`obrigatório	`integer`
`tetoDeFrequencia.dias`obrigatório	`integer`
`meta`opcional	`object`
`meta.evento`obrigatório	`string`

Exemplo completo do corpo

JSON

{  "name": "string",  "gatilho": {    "tipo": "lista",    "listId": "string"  },  "inicio": "string",  "passos": [    {      "id": "string",      "tipo": "enviar",      "canal": "whatsapp",      "templateId": "string",      "numberId": "string",      "smsRoute": "premium",      "rcs": {        "conteudo": {          "text": "string"        },        "fallback": {          "text": "string"        },        "rota": "easy_rcs"      },      "variaveis": {},      "proximo": "string"    }  ],  "reentrada": "nunca",  "intervaloReentradaHoras": 1,  "silencio": {    "inicio": "string",    "fim": "string"  },  "tetoDeFrequencia": {    "mensagens": 1,    "dias": 1  },  "meta": {    "evento": "string"  }}

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`id`obrigatório	`string`
`name`obrigatório	`string`
`status`obrigatório	`string`	Valores:`rascunhoativapausadaarquivada`
`gatilho`obrigatório	`object`
`gatilho.tipo`opcional	`string`	Valores:`segmento`
`gatilho.listId`opcional	`string`
`gatilho.nome`opcional	`string`
`gatilho.segmentId`opcional	`string`
`inicio`obrigatório	`string`
`passos`obrigatório	`object[]`
`passos[].id`opcional	`string`
`passos[].tipo`opcional	`string`	Valores:`fim`
`passos[].canal`opcional	`string`	Valores:`whatsappsmsemailrcs`
`passos[].templateId`opcional	`string`
`passos[].numberId`opcional	`string`
`passos[].smsRoute`opcional	`string`	Valores:`premiumotp`
`passos[].rcs`opcional	`object`
`passos[].rcs.conteudo`obrigatório	`object`
`passos[].rcs.fallback`opcional	`object`
`passos[].rcs.rota`opcional	`string`	Valores:`easy_rcseasy_otp_rcs`
`passos[].variaveis`opcional	`object`
`passos[].proximo`opcional	`string`
`passos[].minutos`opcional	`integer`
`passos[].sobre`opcional	`string`
`passos[].sinal`opcional	`string`	Valores:`entreguelidoclicourespondeuconverteu`
`passos[].evento`opcional	`string`
`passos[].janelaMinutos`opcional	`integer`
`passos[].sim`opcional	`string`
`passos[].nao`opcional	`string`
`passos[].webhookId`opcional	`string`
`passos[].seFalhar`opcional	`string`
`passos[].dias`opcional	`integer[]`
`passos[].hora`opcional	`string`
`passos[].ramos`opcional	`object[]`
`passos[].ramos[].nome`obrigatório	`string`
`passos[].ramos[].peso`obrigatório	`integer`
`passos[].ramos[].proximo`obrigatório	`string`
`passos[].campo`opcional	`string`
`passos[].operador`opcional	`string`	Valores:`igualdiferentecontemexistenao_existemaiormenor`
`passos[].valor`opcional	`string`
`reentrada`obrigatório	`string`	Valores:`nuncaapos_concluir`
`intervaloReentradaHoras`opcional	`integer`
`execucoes`opcional	`object`
`execucoes.ativa`obrigatório	`integer`
`execucoes.concluida`obrigatório	`integer`
`execucoes.cancelada`obrigatório	`integer`
`execucoes.erro`obrigatório	`integer`
`pausadaPor`opcional	`object`
`pausadaPor.motivo`obrigatório	`string`
`pausadaPor.passo`obrigatório	`string`
`pausadaPor.em`obrigatório	`string`
`pausadaPor.rotulo`opcional	`string`
`ativadaEm`opcional	`string`
`silencio`opcional	`object`
`silencio.inicio`obrigatório	`string`
`silencio.fim`obrigatório	`string`
`tetoDeFrequencia`opcional	`object`
`tetoDeFrequencia.mensagens`obrigatório	`integer`
`tetoDeFrequencia.dias`obrigatório	`integer`
`meta`opcional	`object`

Mais 8 campos no openapi.json.

JSON

{  "id": "string",  "name": "string",  "status": "rascunho",  "gatilho": {    "tipo": "lista",    "listId": "string"  },  "inicio": "string",  "passos": [    {      "id": "string",      "tipo": "enviar",      "canal": "whatsapp",      "templateId": "string",      "numberId": "string",      "smsRoute": "premium",      "rcs": {        "conteudo": {          "text": "string"        },        "fallback": {          "text": "string"        },        "rota": "easy_rcs"      },      "variaveis": {},      "proximo": "string"    }  ],  "reentrada": "nunca",  "intervaloReentradaHoras": 0,  "execucoes": {    "ativa": 0,    "concluida": 0,    "cancelada": 0,    "erro": 0  },  "pausadaPor": {    "motivo": "string",    "passo": "string",    "em": "string",    "rotulo": "string"  },  "ativadaEm": "string",  "silencio": {    "inicio": "string",    "fim": "string"  },  "tetoDeFrequencia": {    "mensagens": 1,    "dias": 1  },  "meta": {    "evento": "string"  },  "versao": 1,  "versaoDe": "string",  "substituidaPor": "string",  "entradasEncerradas": true,  "problemas": [    "string"  ],  "createdAt": "string",  "updatedAt": "string"}

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).
409RFC 7807 problem details for CONFLICT (409).
412RFC 7807 problem details for PRECONDITION_FAILED (412).
422RFC 7807 problem details for VALIDATION_ERROR (422).

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 -X PUT 'https://api.messages.ccxcompany.co/v2/journeys/<id>' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "gatilho": {      "tipo": "lista",      "listId": "string"    },    "inicio": "string",    "passos": [      {        "id": "string",        "tipo": "enviar",        "canal": "whatsapp"      }    ]  }'

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Ativa a jornada (começa a enviar)

POST/v2/journeys/{id}/activate

Confere antes que cada template existe no canal (WhatsApp: aprovado), que o número e a lista são desta organização. Pausada volta a andar de onde parou. Exige chave de produção. Permissão: campaigns:start (a mesma que inicia campanha: ativar é começar a gastar).

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`id`obrigatório	`string`
`name`obrigatório	`string`
`status`obrigatório	`string`	Valores:`rascunhoativapausadaarquivada`
`gatilho`obrigatório	`object`
`gatilho.tipo`opcional	`string`	Valores:`segmento`
`gatilho.listId`opcional	`string`
`gatilho.nome`opcional	`string`
`gatilho.segmentId`opcional	`string`
`inicio`obrigatório	`string`
`passos`obrigatório	`object[]`
`passos[].id`opcional	`string`
`passos[].tipo`opcional	`string`	Valores:`fim`
`passos[].canal`opcional	`string`	Valores:`whatsappsmsemailrcs`
`passos[].templateId`opcional	`string`
`passos[].numberId`opcional	`string`
`passos[].smsRoute`opcional	`string`	Valores:`premiumotp`
`passos[].rcs`opcional	`object`
`passos[].rcs.conteudo`obrigatório	`object`
`passos[].rcs.fallback`opcional	`object`
`passos[].rcs.rota`opcional	`string`	Valores:`easy_rcseasy_otp_rcs`
`passos[].variaveis`opcional	`object`
`passos[].proximo`opcional	`string`
`passos[].minutos`opcional	`integer`
`passos[].sobre`opcional	`string`
`passos[].sinal`opcional	`string`	Valores:`entreguelidoclicourespondeuconverteu`
`passos[].evento`opcional	`string`
`passos[].janelaMinutos`opcional	`integer`
`passos[].sim`opcional	`string`
`passos[].nao`opcional	`string`
`passos[].webhookId`opcional	`string`
`passos[].seFalhar`opcional	`string`
`passos[].dias`opcional	`integer[]`
`passos[].hora`opcional	`string`
`passos[].ramos`opcional	`object[]`
`passos[].ramos[].nome`obrigatório	`string`
`passos[].ramos[].peso`obrigatório	`integer`
`passos[].ramos[].proximo`obrigatório	`string`
`passos[].campo`opcional	`string`
`passos[].operador`opcional	`string`	Valores:`igualdiferentecontemexistenao_existemaiormenor`
`passos[].valor`opcional	`string`
`reentrada`obrigatório	`string`	Valores:`nuncaapos_concluir`
`intervaloReentradaHoras`opcional	`integer`
`execucoes`opcional	`object`
`execucoes.ativa`obrigatório	`integer`
`execucoes.concluida`obrigatório	`integer`
`execucoes.cancelada`obrigatório	`integer`
`execucoes.erro`obrigatório	`integer`
`pausadaPor`opcional	`object`
`pausadaPor.motivo`obrigatório	`string`
`pausadaPor.passo`obrigatório	`string`
`pausadaPor.em`obrigatório	`string`
`pausadaPor.rotulo`opcional	`string`
`ativadaEm`opcional	`string`
`silencio`opcional	`object`
`silencio.inicio`obrigatório	`string`
`silencio.fim`obrigatório	`string`
`tetoDeFrequencia`opcional	`object`
`tetoDeFrequencia.mensagens`obrigatório	`integer`
`tetoDeFrequencia.dias`obrigatório	`integer`
`meta`opcional	`object`

Mais 8 campos no openapi.json.

JSON

{  "id": "string",  "name": "string",  "status": "rascunho",  "gatilho": {    "tipo": "lista",    "listId": "string"  },  "inicio": "string",  "passos": [    {      "id": "string",      "tipo": "enviar",      "canal": "whatsapp",      "templateId": "string",      "numberId": "string",      "smsRoute": "premium",      "rcs": {        "conteudo": {          "text": "string"        },        "fallback": {          "text": "string"        },        "rota": "easy_rcs"      },      "variaveis": {},      "proximo": "string"    }  ],  "reentrada": "nunca",  "intervaloReentradaHoras": 0,  "execucoes": {    "ativa": 0,    "concluida": 0,    "cancelada": 0,    "erro": 0  },  "pausadaPor": {    "motivo": "string",    "passo": "string",    "em": "string",    "rotulo": "string"  },  "ativadaEm": "string",  "silencio": {    "inicio": "string",    "fim": "string"  },  "tetoDeFrequencia": {    "mensagens": 1,    "dias": 1  },  "meta": {    "evento": "string"  },  "versao": 1,  "versaoDe": "string",  "substituidaPor": "string",  "entradasEncerradas": true,  "problemas": [    "string"  ],  "createdAt": "string",  "updatedAt": "string"}

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).
409RFC 7807 problem details for CONFLICT (409).
412RFC 7807 problem details for PRECONDITION_FAILED (412).
422RFC 7807 problem details for VALIDATION_ERROR (422).

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 -X POST 'https://api.messages.ccxcompany.co/v2/journeys/<id>/activate' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Pausa a jornada

POST/v2/journeys/{id}/pause

As execuções param onde estão, nenhum contato entra, e o que já estava na fila de envio espera junto. activate retoma de onde parou. Exige chave de produção. Permissão: campaigns:pause.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`id`obrigatório	`string`
`name`obrigatório	`string`
`status`obrigatório	`string`	Valores:`rascunhoativapausadaarquivada`
`gatilho`obrigatório	`object`
`gatilho.tipo`opcional	`string`	Valores:`segmento`
`gatilho.listId`opcional	`string`
`gatilho.nome`opcional	`string`
`gatilho.segmentId`opcional	`string`
`inicio`obrigatório	`string`
`passos`obrigatório	`object[]`
`passos[].id`opcional	`string`
`passos[].tipo`opcional	`string`	Valores:`fim`
`passos[].canal`opcional	`string`	Valores:`whatsappsmsemailrcs`
`passos[].templateId`opcional	`string`
`passos[].numberId`opcional	`string`
`passos[].smsRoute`opcional	`string`	Valores:`premiumotp`
`passos[].rcs`opcional	`object`
`passos[].rcs.conteudo`obrigatório	`object`
`passos[].rcs.fallback`opcional	`object`
`passos[].rcs.rota`opcional	`string`	Valores:`easy_rcseasy_otp_rcs`
`passos[].variaveis`opcional	`object`
`passos[].proximo`opcional	`string`
`passos[].minutos`opcional	`integer`
`passos[].sobre`opcional	`string`
`passos[].sinal`opcional	`string`	Valores:`entreguelidoclicourespondeuconverteu`
`passos[].evento`opcional	`string`
`passos[].janelaMinutos`opcional	`integer`
`passos[].sim`opcional	`string`
`passos[].nao`opcional	`string`
`passos[].webhookId`opcional	`string`
`passos[].seFalhar`opcional	`string`
`passos[].dias`opcional	`integer[]`
`passos[].hora`opcional	`string`
`passos[].ramos`opcional	`object[]`
`passos[].ramos[].nome`obrigatório	`string`
`passos[].ramos[].peso`obrigatório	`integer`
`passos[].ramos[].proximo`obrigatório	`string`
`passos[].campo`opcional	`string`
`passos[].operador`opcional	`string`	Valores:`igualdiferentecontemexistenao_existemaiormenor`
`passos[].valor`opcional	`string`
`reentrada`obrigatório	`string`	Valores:`nuncaapos_concluir`
`intervaloReentradaHoras`opcional	`integer`
`execucoes`opcional	`object`
`execucoes.ativa`obrigatório	`integer`
`execucoes.concluida`obrigatório	`integer`
`execucoes.cancelada`obrigatório	`integer`
`execucoes.erro`obrigatório	`integer`
`pausadaPor`opcional	`object`
`pausadaPor.motivo`obrigatório	`string`
`pausadaPor.passo`obrigatório	`string`
`pausadaPor.em`obrigatório	`string`
`pausadaPor.rotulo`opcional	`string`
`ativadaEm`opcional	`string`
`silencio`opcional	`object`
`silencio.inicio`obrigatório	`string`
`silencio.fim`obrigatório	`string`
`tetoDeFrequencia`opcional	`object`
`tetoDeFrequencia.mensagens`obrigatório	`integer`
`tetoDeFrequencia.dias`obrigatório	`integer`
`meta`opcional	`object`

Mais 8 campos no openapi.json.

JSON

{  "id": "string",  "name": "string",  "status": "rascunho",  "gatilho": {    "tipo": "lista",    "listId": "string"  },  "inicio": "string",  "passos": [    {      "id": "string",      "tipo": "enviar",      "canal": "whatsapp",      "templateId": "string",      "numberId": "string",      "smsRoute": "premium",      "rcs": {        "conteudo": {          "text": "string"        },        "fallback": {          "text": "string"        },        "rota": "easy_rcs"      },      "variaveis": {},      "proximo": "string"    }  ],  "reentrada": "nunca",  "intervaloReentradaHoras": 0,  "execucoes": {    "ativa": 0,    "concluida": 0,    "cancelada": 0,    "erro": 0  },  "pausadaPor": {    "motivo": "string",    "passo": "string",    "em": "string",    "rotulo": "string"  },  "ativadaEm": "string",  "silencio": {    "inicio": "string",    "fim": "string"  },  "tetoDeFrequencia": {    "mensagens": 1,    "dias": 1  },  "meta": {    "evento": "string"  },  "versao": 1,  "versaoDe": "string",  "substituidaPor": "string",  "entradasEncerradas": true,  "problemas": [    "string"  ],  "createdAt": "string",  "updatedAt": "string"}

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).
409RFC 7807 problem details for CONFLICT (409).
412RFC 7807 problem details for PRECONDITION_FAILED (412).
422RFC 7807 problem details for VALIDATION_ERROR (422).

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 -X POST 'https://api.messages.ccxcompany.co/v2/journeys/<id>/pause' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Arquiva a jornada e cancela as execuções em curso

POST/v2/journeys/{id}/archive

Definitivo: nada mais sai desta jornada. canceladas é quantas execuções foram interrompidas; envios_cancelados, quantas mensagens que estavam na fila de envio foram recolhidas. Exige chave de produção. Permissão: campaigns:write.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`id`obrigatório	`string`
`name`obrigatório	`string`
`status`obrigatório	`string`	Valores:`rascunhoativapausadaarquivada`
`gatilho`obrigatório	`object`
`gatilho.tipo`opcional	`string`	Valores:`segmento`
`gatilho.listId`opcional	`string`
`gatilho.nome`opcional	`string`
`gatilho.segmentId`opcional	`string`
`inicio`obrigatório	`string`
`passos`obrigatório	`object[]`
`passos[].id`opcional	`string`
`passos[].tipo`opcional	`string`	Valores:`fim`
`passos[].canal`opcional	`string`	Valores:`whatsappsmsemailrcs`
`passos[].templateId`opcional	`string`
`passos[].numberId`opcional	`string`
`passos[].smsRoute`opcional	`string`	Valores:`premiumotp`
`passos[].rcs`opcional	`object`
`passos[].rcs.conteudo`obrigatório	`object`
`passos[].rcs.fallback`opcional	`object`
`passos[].rcs.rota`opcional	`string`	Valores:`easy_rcseasy_otp_rcs`
`passos[].variaveis`opcional	`object`
`passos[].proximo`opcional	`string`
`passos[].minutos`opcional	`integer`
`passos[].sobre`opcional	`string`
`passos[].sinal`opcional	`string`	Valores:`entreguelidoclicourespondeuconverteu`
`passos[].evento`opcional	`string`
`passos[].janelaMinutos`opcional	`integer`
`passos[].sim`opcional	`string`
`passos[].nao`opcional	`string`
`passos[].webhookId`opcional	`string`
`passos[].seFalhar`opcional	`string`
`passos[].dias`opcional	`integer[]`
`passos[].hora`opcional	`string`
`passos[].ramos`opcional	`object[]`
`passos[].ramos[].nome`obrigatório	`string`
`passos[].ramos[].peso`obrigatório	`integer`
`passos[].ramos[].proximo`obrigatório	`string`
`passos[].campo`opcional	`string`
`passos[].operador`opcional	`string`	Valores:`igualdiferentecontemexistenao_existemaiormenor`
`passos[].valor`opcional	`string`
`reentrada`obrigatório	`string`	Valores:`nuncaapos_concluir`
`intervaloReentradaHoras`opcional	`integer`
`execucoes`opcional	`object`
`execucoes.ativa`obrigatório	`integer`
`execucoes.concluida`obrigatório	`integer`
`execucoes.cancelada`obrigatório	`integer`
`execucoes.erro`obrigatório	`integer`
`pausadaPor`opcional	`object`
`pausadaPor.motivo`obrigatório	`string`
`pausadaPor.passo`obrigatório	`string`
`pausadaPor.em`obrigatório	`string`
`pausadaPor.rotulo`opcional	`string`
`ativadaEm`opcional	`string`
`silencio`opcional	`object`
`silencio.inicio`obrigatório	`string`
`silencio.fim`obrigatório	`string`
`tetoDeFrequencia`opcional	`object`
`tetoDeFrequencia.mensagens`obrigatório	`integer`
`tetoDeFrequencia.dias`obrigatório	`integer`
`meta`opcional	`object`

Mais 10 campos no openapi.json.

JSON

{  "id": "string",  "name": "string",  "status": "rascunho",  "gatilho": {    "tipo": "lista",    "listId": "string"  },  "inicio": "string",  "passos": [    {      "id": "string",      "tipo": "enviar",      "canal": "whatsapp",      "templateId": "string",      "numberId": "string",      "smsRoute": "premium",      "rcs": {        "conteudo": {          "text": "string"        },        "fallback": {          "text": "string"        },        "rota": "easy_rcs"      },      "variaveis": {},      "proximo": "string"    }  ],  "reentrada": "nunca",  "intervaloReentradaHoras": 0,  "execucoes": {    "ativa": 0,    "concluida": 0,    "cancelada": 0,    "erro": 0  },  "pausadaPor": {    "motivo": "string",    "passo": "string",    "em": "string",    "rotulo": "string"  },  "ativadaEm": "string",  "silencio": {    "inicio": "string",    "fim": "string"  },  "tetoDeFrequencia": {    "mensagens": 1,    "dias": 1  },  "meta": {    "evento": "string"  },  "versao": 1,  "versaoDe": "string",  "substituidaPor": "string",  "entradasEncerradas": true,  "problemas": [    "string"  ],  "createdAt": "string",  "updatedAt": "string",  "canceladas": 0,  "envios_cancelados": 0}

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).
409RFC 7807 problem details for CONFLICT (409).
412RFC 7807 problem details for PRECONDITION_FAILED (412).
422RFC 7807 problem details for VALIDATION_ERROR (422).

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 -X POST 'https://api.messages.ccxcompany.co/v2/journeys/<id>/archive' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Põe contatos numa jornada ativa

POST/v2/journeys/{id}/entries

Até 500 por chamada. dados (opcional, até 30 campos de texto) alimenta as variáveis de origem entrada — ex.: o produto do carrinho.

Um resultado por entrada, na ordem do pedido: inscrito (com o runId), ja_esta (tem execução em curso), ja_passou (reentrada nunca), reentrada_cedo (reentrada apos_concluir antes do intervalo, padrão 24 h), opt_out, contato_inexistente, versao_substituida (esta versão da jornada foi substituída por uma mais nova — inscreva na versão ativa) ou repetido (o mesmo contato mais acima no pedido).

Reenviar o mesmo pedido depois de um timeout não manda duas vezes: quem entrou volta ja_esta/ja_passou/reentrada_cedo.

Exige chave de produção. Permissão: campaigns:start.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Corpo da requisição`application/json`

Campo	Tipo	Descrição
`entradas`obrigatório	`object[]`
`entradas[].contactId`obrigatório	`string`
`entradas[].dados`opcional	`object`

Exemplo completo do corpo

JSON

{  "entradas": [    {      "contactId": "string",      "dados": {}    }  ]}

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`resultados`obrigatório	`object[]`
`resultados[].contactId`obrigatório	`string`
`resultados[].resultado`obrigatório	`string`	Valores:`inscritoja_estaja_passoureentrada_cedocontato_inexistenteopt_outrepetidoversao_substituida`
`resultados[].runId`opcional	`string`
`inscritos`obrigatório	`integer`

JSON

{  "resultados": [    {      "contactId": "string",      "resultado": "inscrito",      "runId": "string"    }  ],  "inscritos": 0}

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).
409RFC 7807 problem details for CONFLICT (409).
412RFC 7807 problem details for PRECONDITION_FAILED (412).
422RFC 7807 problem details for VALIDATION_ERROR (422).

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 -X POST 'https://api.messages.ccxcompany.co/v2/journeys/<id>/entries' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "entradas": [      {        "contactId": "string"      }    ]  }'

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

As execuções de uma jornada

GET/v2/journeys/{id}/runs

Uma execução por contato por passagem, com o passo atual e o histórico (até os 200 últimos eventos), da mais nova para a mais antiga. Filtros: status, contactId, passo (onde a execução está agora) e q (nome, e-mail ou telefone do contato). Cada item traz o nome e o telefone do contato (mascarado sem pii:full).

A primeira página traz o total do filtro; a seguinte, o depois da resposta. Permissão: campaigns:read.

Parâmetros

Campo	Onde	Tipo	Descrição
`status`opcional	query	`string`	Valores:`ativaconcluidacanceladaerro`
`contactId`opcional	query	`string`
`passo`opcional	query	`string`
`q`opcional	query	`string`
`depois`opcional	query	`string`
`limit`opcional	query	`integer`
`id`obrigatório	caminho	`string`

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`items`obrigatório	`object[]`
`items[].id`obrigatório	`string`
`items[].journeyId`obrigatório	`string`
`items[].contactId`obrigatório	`string`
`items[].contactName`opcional	`string`
`items[].contactPhone`opcional	`string`
`items[].status`obrigatório	`string`	Valores:`ativaconcluidacanceladaerro`
`items[].passoAtual`obrigatório	`string`
`items[].proximoEm`obrigatório	`string`
`items[].origem`obrigatório	`object`
`items[].origem.tipo`obrigatório	`string`	Valores:`listaeventoapitestesegmento`
`items[].origem.ref`opcional	`string`
`items[].historico`obrigatório	`object[]`
`items[].historico[].passo`obrigatório	`string`
`items[].historico[].at`obrigatório	`string`
`items[].historico[].resultado`obrigatório	`string`
`items[].historico[].scheduledMessageId`opcional	`string`
`items[].erro`opcional	`string`
`items[].metaEm`opcional	`string`
`items[].criadaEm`obrigatório	`string`
`items[].atualizadaEm`obrigatório	`string`
`depois`opcional	`string`
`total`opcional	`integer`

JSON

{  "items": [    {      "id": "string",      "journeyId": "string",      "contactId": "string",      "contactName": "string",      "contactPhone": "string",      "status": "ativa",      "passoAtual": "string",      "proximoEm": "string",      "origem": {        "tipo": "lista",        "ref": "string"      },      "historico": [        {          "passo": "string",          "at": "string",          "resultado": "string",          "scheduledMessageId": "string"        }      ],      "erro": "string",      "metaEm": "string",      "criadaEm": "string",      "atualizadaEm": "string"    }  ],  "depois": "string",  "total": 0}

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/journeys/<id>/runs' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Números por passo de uma jornada

GET/v2/journeys/{id}/metricas

Por passo: quantos passaram e quantos estão parados nele agora; no enviar, agendados, pulados, enviados, falhas, entregues e lidos (null onde o canal não informa: e-mail e RCS não têm leitura); na condicao, sim e não; no webhook, ok e falhou; no fim, chegaram.

Custo líquido (consumo − estornos) em coins (1 coin = R$ 0,0001), por canal, e conversões atribuídas. Calculado a cada 60 s no máximo. Permissão: campaigns:read.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`passos`obrigatório	`object`
`entraram`obrigatório	`integer`
`execucoes`obrigatório	`object`
`execucoes.ativa`obrigatório	`integer`
`execucoes.concluida`obrigatório	`integer`
`execucoes.cancelada`obrigatório	`integer`
`execucoes.erro`obrigatório	`integer`
`enviadosPorCanal`obrigatório	`object`
`custo`obrigatório	`object`
`custo.totalCoins`obrigatório	`integer`
`custo.porCanal`obrigatório	`object`
`custo.atualizadoAte`obrigatório	`string \| null`
`conversoes`obrigatório	`object`
`conversoes.eventos`obrigatório	`integer`
`conversoes.receita`obrigatório	`number`
`conversoes.moeda`obrigatório	`string`
`calculadoEm`obrigatório	`string`

JSON

{  "passos": {},  "entraram": 0,  "execucoes": {    "ativa": 0,    "concluida": 0,    "cancelada": 0,    "erro": 0  },  "enviadosPorCanal": {},  "custo": {    "totalCoins": 0,    "porCanal": {},    "atualizadoAte": "string"  },  "conversoes": {    "eventos": 0,    "receita": 0,    "moeda": "string"  },  "calculadoEm": "string"}

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/journeys/<id>/metricas' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Uma execução, com os envios

GET/v2/journeys/{id}/runs/{runId}

O contato (telefone e e-mail mascarados sem pii:full), os dados da entrada, cada envio com o que aconteceu (agendado, pulado e por quê, enviado, entregue, lido) e as conversões atribuídas a esta execução. Permissão: campaigns:read.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`
`runId`obrigatório	caminho	`string`

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`id`obrigatório	`string`
`journeyId`obrigatório	`string`
`contactId`obrigatório	`string`
`contactName`opcional	`string`
`contactPhone`opcional	`string`
`status`obrigatório	`string`	Valores:`ativaconcluidacanceladaerro`
`passoAtual`obrigatório	`string`
`proximoEm`obrigatório	`string`
`origem`obrigatório	`object`
`origem.tipo`obrigatório	`string`	Valores:`listaeventoapitestesegmento`
`origem.ref`opcional	`string`
`historico`obrigatório	`object[]`
`historico[].passo`obrigatório	`string`
`historico[].at`obrigatório	`string`
`historico[].resultado`obrigatório	`string`
`historico[].scheduledMessageId`opcional	`string`
`erro`opcional	`string`
`metaEm`opcional	`string`
`criadaEm`obrigatório	`string`
`atualizadaEm`obrigatório	`string`
`contato`obrigatório	`object \| null`
`contato.nome`obrigatório	`string`
`contato.iniciais`obrigatório	`string`
`contato.telefone`opcional	`string`
`contato.email`opcional	`string`
`dados`obrigatório	`object`
`envios`obrigatório	`object[]`
`envios[].passo`obrigatório	`string`
`envios[].canal`obrigatório	`string`	Valores:`whatsappsmsemailrcs`
`envios[].situacao`obrigatório	`string`
`envios[].motivo`opcional	`string`
`envios[].templateNome`opcional	`string`
`envios[].previa`opcional	`string`
`envios[].messageId`opcional	`string`
`envios[].enviadoEm`opcional	`string`
`envios[].entregueEm`opcional	`string`
`envios[].lidoEm`opcional	`string`
`conversoes`obrigatório	`object[]`
`conversoes[].nome`obrigatório	`string`
`conversoes[].em`obrigatório	`string`
`conversoes[].valor`opcional	`number`
`conversoes[].moeda`opcional	`string`

JSON

{  "id": "string",  "journeyId": "string",  "contactId": "string",  "contactName": "string",  "contactPhone": "string",  "status": "ativa",  "passoAtual": "string",  "proximoEm": "string",  "origem": {    "tipo": "lista",    "ref": "string"  },  "historico": [    {      "passo": "string",      "at": "string",      "resultado": "string",      "scheduledMessageId": "string"    }  ],  "erro": "string",  "metaEm": "string",  "criadaEm": "string",  "atualizadaEm": "string",  "contato": {    "nome": "string",    "iniciais": "string",    "telefone": "string",    "email": "string"  },  "dados": {},  "envios": [    {      "passo": "string",      "canal": "whatsapp",      "situacao": "string",      "motivo": "string",      "templateNome": "string",      "previa": "string",      "messageId": "string",      "enviadoEm": "string",      "entregueEm": "string",      "lidoEm": "string"    }  ],  "conversoes": [    {      "nome": "string",      "em": "string",      "valor": 0,      "moeda": "string"    }  ]}

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/journeys/<id>/runs/<runId>' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Tira um contato da jornada

POST/v2/journeys/{id}/runs/{runId}/cancel

Cancela a execução e recolhe o que ela tinha na fila de envio. O que já estava saindo não volta. Execução que não está em curso responde 409. Exige chave de produção. Permissão: campaigns:pause.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`
`runId`obrigatório	caminho	`string`

Respostas

200Default Response
Campos e exemplo da resposta
Campo Tipo Descrição
canceladaobrigatório boolean
enviosRecolhidosobrigatório integer
JSON
```
{  "cancelada": true,  "enviosRecolhidos": 0}
```
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).
409RFC 7807 problem details for CONFLICT (409).
412RFC 7807 problem details for PRECONDITION_FAILED (412).
422RFC 7807 problem details for VALIDATION_ERROR (422).

Campo	Tipo	Descrição
`cancelada`obrigatório	`boolean`
`enviosRecolhidos`obrigatório	`integer`

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 -X POST 'https://api.messages.ccxcompany.co/v2/journeys/<id>/runs/<runId>/cancel' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Testa o rascunho com um contato

POST/v2/journeys/{id}/teste

Roda a jornada em rascunho para UM contato da base (contactId ou identificador: telefone/e-mail). Envia de verdade e é cobrado; toda espera dura 10 s e a janela de uma condição, no máximo 2 min. A mesma conferência da ativação vale aqui. Não conta para a reentrada: depois de ativada, a pessoa entra normalmente.

Ativar a jornada encerra os testes em curso. Exige chave de produção. Permissão: campaigns:start.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Corpo da requisição`application/json`

Campo	Tipo	Descrição
`contactId`opcional	`string`
`identificador`opcional	`string`

Exemplo completo do corpo

JSON

{  "contactId": "string",  "identificador": "string"}

Respostas

201Default Response
Campos e exemplo da resposta
Campo Tipo Descrição
runIdobrigatório string
contatoobrigatório string
JSON
```
{  "runId": "string",  "contato": "string"}
```
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).
409RFC 7807 problem details for CONFLICT (409).
412RFC 7807 problem details for PRECONDITION_FAILED (412).
422RFC 7807 problem details for VALIDATION_ERROR (422).

Campo	Tipo	Descrição
`runId`obrigatório	`string`
`contato`obrigatório	`string`

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 -X POST 'https://api.messages.ccxcompany.co/v2/journeys/<id>/teste' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Cria a próxima versão de uma jornada que já rodou

POST/v2/journeys/{id}/versao

Uma jornada ativa ou pausada não muda (as execuções estão paradas em passos dela): muda-se criando a próxima versão, em rascunho e com a mesma definição. Ao ativar a nova, a anterior deixa de receber entradas (quem está no meio termina nela) e a reentrada passa a valer para as duas — ninguém entra nas duas.

Se o rascunho da próxima versão já existe, ele volta. Permissão: campaigns:write.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

201Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`id`obrigatório	`string`
`name`obrigatório	`string`
`status`obrigatório	`string`	Valores:`rascunhoativapausadaarquivada`
`gatilho`obrigatório	`object`
`gatilho.tipo`opcional	`string`	Valores:`segmento`
`gatilho.listId`opcional	`string`
`gatilho.nome`opcional	`string`
`gatilho.segmentId`opcional	`string`
`inicio`obrigatório	`string`
`passos`obrigatório	`object[]`
`passos[].id`opcional	`string`
`passos[].tipo`opcional	`string`	Valores:`fim`
`passos[].canal`opcional	`string`	Valores:`whatsappsmsemailrcs`
`passos[].templateId`opcional	`string`
`passos[].numberId`opcional	`string`
`passos[].smsRoute`opcional	`string`	Valores:`premiumotp`
`passos[].rcs`opcional	`object`
`passos[].rcs.conteudo`obrigatório	`object`
`passos[].rcs.fallback`opcional	`object`
`passos[].rcs.rota`opcional	`string`	Valores:`easy_rcseasy_otp_rcs`
`passos[].variaveis`opcional	`object`
`passos[].proximo`opcional	`string`
`passos[].minutos`opcional	`integer`
`passos[].sobre`opcional	`string`
`passos[].sinal`opcional	`string`	Valores:`entreguelidoclicourespondeuconverteu`
`passos[].evento`opcional	`string`
`passos[].janelaMinutos`opcional	`integer`
`passos[].sim`opcional	`string`
`passos[].nao`opcional	`string`
`passos[].webhookId`opcional	`string`
`passos[].seFalhar`opcional	`string`
`passos[].dias`opcional	`integer[]`
`passos[].hora`opcional	`string`
`passos[].ramos`opcional	`object[]`
`passos[].ramos[].nome`obrigatório	`string`
`passos[].ramos[].peso`obrigatório	`integer`
`passos[].ramos[].proximo`obrigatório	`string`
`passos[].campo`opcional	`string`
`passos[].operador`opcional	`string`	Valores:`igualdiferentecontemexistenao_existemaiormenor`
`passos[].valor`opcional	`string`
`reentrada`obrigatório	`string`	Valores:`nuncaapos_concluir`
`intervaloReentradaHoras`opcional	`integer`
`execucoes`opcional	`object`
`execucoes.ativa`obrigatório	`integer`
`execucoes.concluida`obrigatório	`integer`
`execucoes.cancelada`obrigatório	`integer`
`execucoes.erro`obrigatório	`integer`
`pausadaPor`opcional	`object`
`pausadaPor.motivo`obrigatório	`string`
`pausadaPor.passo`obrigatório	`string`
`pausadaPor.em`obrigatório	`string`
`pausadaPor.rotulo`opcional	`string`
`ativadaEm`opcional	`string`
`silencio`opcional	`object`
`silencio.inicio`obrigatório	`string`
`silencio.fim`obrigatório	`string`
`tetoDeFrequencia`opcional	`object`
`tetoDeFrequencia.mensagens`obrigatório	`integer`
`tetoDeFrequencia.dias`obrigatório	`integer`
`meta`opcional	`object`

Mais 8 campos no openapi.json.

JSON

{  "id": "string",  "name": "string",  "status": "rascunho",  "gatilho": {    "tipo": "lista",    "listId": "string"  },  "inicio": "string",  "passos": [    {      "id": "string",      "tipo": "enviar",      "canal": "whatsapp",      "templateId": "string",      "numberId": "string",      "smsRoute": "premium",      "rcs": {        "conteudo": {          "text": "string"        },        "fallback": {          "text": "string"        },        "rota": "easy_rcs"      },      "variaveis": {},      "proximo": "string"    }  ],  "reentrada": "nunca",  "intervaloReentradaHoras": 0,  "execucoes": {    "ativa": 0,    "concluida": 0,    "cancelada": 0,    "erro": 0  },  "pausadaPor": {    "motivo": "string",    "passo": "string",    "em": "string",    "rotulo": "string"  },  "ativadaEm": "string",  "silencio": {    "inicio": "string",    "fim": "string"  },  "tetoDeFrequencia": {    "mensagens": 1,    "dias": 1  },  "meta": {    "evento": "string"  },  "versao": 1,  "versaoDe": "string",  "substituidaPor": "string",  "entradasEncerradas": true,  "problemas": [    "string"  ],  "createdAt": "string",  "updatedAt": "string"}

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).
409RFC 7807 problem details for CONFLICT (409).
412RFC 7807 problem details for PRECONDITION_FAILED (412).
422RFC 7807 problem details for VALIDATION_ERROR (422).

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 -X POST 'https://api.messages.ccxcompany.co/v2/journeys/<id>/versao' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Duplica a jornada (em rascunho)

POST/v2/journeys/{id}/duplicate

Uma cópia com a mesma definição, em rascunho e com “(cópia)” no nome. Nada sai até ativar. Permissão: campaigns:write.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

201Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`id`obrigatório	`string`
`name`obrigatório	`string`
`status`obrigatório	`string`	Valores:`rascunhoativapausadaarquivada`
`gatilho`obrigatório	`object`
`gatilho.tipo`opcional	`string`	Valores:`segmento`
`gatilho.listId`opcional	`string`
`gatilho.nome`opcional	`string`
`gatilho.segmentId`opcional	`string`
`inicio`obrigatório	`string`
`passos`obrigatório	`object[]`
`passos[].id`opcional	`string`
`passos[].tipo`opcional	`string`	Valores:`fim`
`passos[].canal`opcional	`string`	Valores:`whatsappsmsemailrcs`
`passos[].templateId`opcional	`string`
`passos[].numberId`opcional	`string`
`passos[].smsRoute`opcional	`string`	Valores:`premiumotp`
`passos[].rcs`opcional	`object`
`passos[].rcs.conteudo`obrigatório	`object`
`passos[].rcs.fallback`opcional	`object`
`passos[].rcs.rota`opcional	`string`	Valores:`easy_rcseasy_otp_rcs`
`passos[].variaveis`opcional	`object`
`passos[].proximo`opcional	`string`
`passos[].minutos`opcional	`integer`
`passos[].sobre`opcional	`string`
`passos[].sinal`opcional	`string`	Valores:`entreguelidoclicourespondeuconverteu`
`passos[].evento`opcional	`string`
`passos[].janelaMinutos`opcional	`integer`
`passos[].sim`opcional	`string`
`passos[].nao`opcional	`string`
`passos[].webhookId`opcional	`string`
`passos[].seFalhar`opcional	`string`
`passos[].dias`opcional	`integer[]`
`passos[].hora`opcional	`string`
`passos[].ramos`opcional	`object[]`
`passos[].ramos[].nome`obrigatório	`string`
`passos[].ramos[].peso`obrigatório	`integer`
`passos[].ramos[].proximo`obrigatório	`string`
`passos[].campo`opcional	`string`
`passos[].operador`opcional	`string`	Valores:`igualdiferentecontemexistenao_existemaiormenor`
`passos[].valor`opcional	`string`
`reentrada`obrigatório	`string`	Valores:`nuncaapos_concluir`
`intervaloReentradaHoras`opcional	`integer`
`execucoes`opcional	`object`
`execucoes.ativa`obrigatório	`integer`
`execucoes.concluida`obrigatório	`integer`
`execucoes.cancelada`obrigatório	`integer`
`execucoes.erro`obrigatório	`integer`
`pausadaPor`opcional	`object`
`pausadaPor.motivo`obrigatório	`string`
`pausadaPor.passo`obrigatório	`string`
`pausadaPor.em`obrigatório	`string`
`pausadaPor.rotulo`opcional	`string`
`ativadaEm`opcional	`string`
`silencio`opcional	`object`
`silencio.inicio`obrigatório	`string`
`silencio.fim`obrigatório	`string`
`tetoDeFrequencia`opcional	`object`
`tetoDeFrequencia.mensagens`obrigatório	`integer`
`tetoDeFrequencia.dias`obrigatório	`integer`
`meta`opcional	`object`

Mais 8 campos no openapi.json.

JSON

{  "id": "string",  "name": "string",  "status": "rascunho",  "gatilho": {    "tipo": "lista",    "listId": "string"  },  "inicio": "string",  "passos": [    {      "id": "string",      "tipo": "enviar",      "canal": "whatsapp",      "templateId": "string",      "numberId": "string",      "smsRoute": "premium",      "rcs": {        "conteudo": {          "text": "string"        },        "fallback": {          "text": "string"        },        "rota": "easy_rcs"      },      "variaveis": {},      "proximo": "string"    }  ],  "reentrada": "nunca",  "intervaloReentradaHoras": 0,  "execucoes": {    "ativa": 0,    "concluida": 0,    "cancelada": 0,    "erro": 0  },  "pausadaPor": {    "motivo": "string",    "passo": "string",    "em": "string",    "rotulo": "string"  },  "ativadaEm": "string",  "silencio": {    "inicio": "string",    "fim": "string"  },  "tetoDeFrequencia": {    "mensagens": 1,    "dias": 1  },  "meta": {    "evento": "string"  },  "versao": 1,  "versaoDe": "string",  "substituidaPor": "string",  "entradasEncerradas": true,  "problemas": [    "string"  ],  "createdAt": "string",  "updatedAt": "string"}

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).
409RFC 7807 problem details for CONFLICT (409).
412RFC 7807 problem details for PRECONDITION_FAILED (412).
422RFC 7807 problem details for VALIDATION_ERROR (422).

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 -X POST 'https://api.messages.ccxcompany.co/v2/journeys/<id>/duplicate' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

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

Criar conta grátis Falar com vendas

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

Jornadas

Respostas

Exemplo em curl

Parâmetros

Corpo da requisiçãoapplication/json

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Corpo da requisiçãoapplication/json

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Corpo da requisiçãoapplication/json

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Corpo da requisiçãoapplication/json

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Outras áreas da API

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

Corpo da requisição`application/json`

Corpo da requisição`application/json`

Corpo da requisição`application/json`

Corpo da requisição`application/json`