Neppo Chat API — Batch

📘 Documentação Neppo Chat API  |  🏠 Visão Geral (índice)  ·  🔎 Guia de Busca  ·  📦 Modelos de Dados

• O que você pode fazer com este módulo
• Exemplo de chamada
• Referência técnica completa
• V1 — batch-controller (2 endpoints)
• V2 — batch-controller-v-2 (1 endpoints)

O que você pode fazer com este módulo

Exemplo de chamada

Substitua SEU_TOKEN_AQUI pelo Bearer token obtido via OAuth2.

curl -X POST "https://hml-chat-api.neppo.com.br/api/v1/batch/client" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "requestId": "string",
    "client": {
      "displayName": "string",
      "channels": [],
      "phones": [],
      "emails": [],
      "cpfCnpj": "string",
      "birthDate": "string",
      "active": true,
      "externalCode": "string",
      "attributes": [],
      "agentIds": [],
      "channelsIdentifiers": {}
    }
  }
]'

Exemplo de resposta (200 OK):

{}

Valores ilustrativos (esqueleto do schema). Os campos retornados seguem o modelo de dados do recurso.

Referência técnica completa

V1 — batch-controller (2 endpoints)

/api/batch/client

batchClient · operationId: batchClientUsingPOST

Auth: Application & Application User | Escopos: write

Parâmetros

Request body (obrigatório): array<RequestClientDTO>

Exemplo de corpo:

[
  {
    "requestId": "string",
    "client": {
      "displayName": "string",
      "channels": [],
      "phones": [],
      "emails": [],
      "cpfCnpj": "string",
      "birthDate": "string",
      "active": true,
      "externalCode": "string",
      "attributes": [],
      "agentIds": [],
      "channelsIdentifiers": {}
    }
  }
]

Respostas

Exemplo de resposta (200 OK):

{}

/api/v1/batch/client

batchClient · operationId: batchClientUsingPOST_1

Auth: Application & Application User | Escopos: write

Parâmetros

Request body (obrigatório): array<RequestClientDTO>

Exemplo de corpo:

[
  {
    "requestId": "string",
    "client": {
      "displayName": "string",
      "channels": [],
      "phones": [],
      "emails": [],
      "cpfCnpj": "string",
      "birthDate": "string",
      "active": true,
      "externalCode": "string",
      "attributes": [],
      "agentIds": [],
      "channelsIdentifiers": {}
    }
  }
]

Respostas

Exemplo de resposta (200 OK):

{}

V2 — batch-controller-v-2 (1 endpoints)

/api/v2/batch/client

batchClient · operationId: batchClientUsingPOST_2

Auth: Application & Application User | Escopos: write

Parâmetros

Request body (obrigatório): array<RequestClientDTO>

Exemplo de corpo:

[
  {
    "requestId": "string",
    "client": {
      "displayName": "string",
      "channels": [],
      "phones": [],
      "emails": [],
      "cpfCnpj": "string",
      "birthDate": "string",
      "active": true,
      "externalCode": "string",
      "attributes": [],
      "agentIds": [],
      "channelsIdentifiers": {}
    }
  }
]

Respostas

Exemplo de resposta (200 OK):

{}