Realizar envio ativo

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://api-docs.neppo.com.br/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Neppo API MCP server": {
    "url": "https://api-docs.neppo.com.br/mcp"
  }
}

POST /chatapi/1.0/api/v2/direct-message/save

Bearer auth

Salva ou atualiza um envio ativo na base de dados. As informações necessárias dependem do canal escolhido e do tipo de template (com ou sem parâmetros, mídia ou botões).

Pré-requisitos:

status deve ser PROCESSANDO
groupName deve corresponder ao grupo de atendimento cadastrado
Para canais oficiais (WhatsApp), o template deve estar previamente cadastrado na plataforma

Consulte as abas de exemplo ao lado para ver o payload completo de cada canal.

application/json

Body Required

additionalInfo string
agentId integer(int64)
broadcastListId integer(int64)
callback string
campaignName string
channel string
createdAt string(date-time)
createdBy string
description string
dispatchId integer(int64)
email string
executionId integer(int64)
generatedSession boolean
groupConfId integer(int64)
groupName string
hsmTemplate integer(int64)
id integer(int64)
message string
phoneNumber string
recipientId string
resend boolean
sendGroupConfId integer(int64)
sendTimestamp string
senderUserId integer(int64)
sentAt string(date-time)
sessionId integer(int64)
status string
subject string
updatedAt string(date-time)
user object
Hide user attributes Show user attributes object
- accessKey string
- active boolean
- agent object
  Hide agent attributes Show agent attributes object
  
  agentAllHistory boolean
  
  agentAllHistoryOperation boolean
  
  agentAttendSimple boolean
  
  agentToken string
  
  agentViewPhone boolean
  
  attendanceServiceChannel string
  
  audioOn boolean
  
  createdAt string(date-time)
  
  createdBy string
  
  department string
  
  extensionAttendance string
  
  id integer(int64)
  
  loginAttendance string
  
  maxChatChannels integer(int64)
  
  passwordAttendance string
  
  pauseOnReceiveCall boolean
  
  socialToken string
  
  status string
  
  superAgent boolean
  
  updatedAt string(date-time)
  
  updatedBy string
  
  user object
  
  virtualAgent boolean
- birthDate string(date-time)
- company object
  Hide company attributes Show company attributes object
  
  active boolean
  
  address string
  
  cep string
  
  city string
  
  cnpj string
  
  companyName string
  
  complement string
  
  contractSignature integer(int64)
  
  country string
  
  createdAt string(date-time)
  
  createdBy string
  
  dateEndPilot string(date-time)
  
  defaultLocale string
  
  email string
  
  groupCompany object
  
  Hide groupCompany attributes Show groupCompany attributes object
  
  active boolean
  
  companyName string Required
  
  createdAt string(date-time)
  
  createdBy string
  
  id integer(int64)
  
  updatedAt string(date-time)
  
  updatedBy string
  
  id integer(int64)
  
  nameContact string
  
  neighborhood string
  
  number string
  
  phoneContact string
  
  sgemnet string
  
  site string
  
  sku string
  
  state string
  
  stateRegistration string
  
  timeHistory integer(int64)
  
  tradeName string
  
  updatedAt string(date-time)
  
  updatedBy string
- country string
- cpf string
- createdAt string(date-time)
- createdBy string
- createdFromSurvey boolean
- defaultLocale string
- displayName string
- email string
- externalCode string
- firstAccess boolean
- firstLogin string(date-time)
- formal boolean
- id integer(int64)
- lastLogin string(date-time)
- name string
- operation string
- originUser string
- phone string
- priority integer(int64)
- profile object
  Hide profile attributes Show profile attributes object
  
  createdAt string(date-time)
  
  createdBy string
  
  id integer(int64)
  
  name string
  
  typeUser string
  
  updatedAt string(date-time)
  
  updatedBy string
  
  visible boolean
- ticketUserId integer(int64)
- tm2 boolean
- typeUser string
- updatedAt string(date-time)
- updatedBy string
- userName string
- usingMFA boolean
- visible boolean
- password string
userId integer(int64)

Responses

200 application/json

Envio registrado com sucesso
Hide response attributes Show response attributes object
- additionalInfo string
- agentId integer(int64)
- broadcastListId integer(int64)
- callback string
- campaignName string
- channel string
- createdAt string(date-time)
- createdBy string
- description string
- dispatchId integer(int64)
- email string
- executionId integer(int64)
- generatedSession boolean
- groupConfId integer(int64)
- groupName string
- hsmTemplate integer(int64)
- id integer(int64)
- message string
- phoneNumber string
- recipientId string
- resend boolean
- sendGroupConfId integer(int64)
- sendTimestamp string
- senderUserId integer(int64)
- sentAt string(date-time)
- sessionId integer(int64)
- status string
- subject string
- updatedAt string(date-time)
- user object
  
  Hide user attributes Show user attributes object
  
  accessKey string
  
  active boolean
  
  agent object
  
  Hide agent attributes Show agent attributes object
  
  agentAllHistory boolean
  
  agentAllHistoryOperation boolean
  
  agentAttendSimple boolean
  
  agentToken string
  
  agentViewPhone boolean
  
  attendanceServiceChannel string
  
  audioOn boolean
  
  createdAt string(date-time)
  
  createdBy string
  
  department string
  
  extensionAttendance string
  
  id integer(int64)
  
  loginAttendance string
  
  maxChatChannels integer(int64)
  
  passwordAttendance string
  
  pauseOnReceiveCall boolean
  
  socialToken string
  
  status string
  
  superAgent boolean
  
  updatedAt string(date-time)
  
  updatedBy string
  
  user object
  
  virtualAgent boolean
  
  birthDate string(date-time)
  
  company object
  
  Hide company attributes Show company attributes object
  
  active boolean
  
  address string
  
  cep string
  
  city string
  
  cnpj string
  
  companyName string
  
  complement string
  
  contractSignature integer(int64)
  
  country string
  
  createdAt string(date-time)
  
  createdBy string
  
  dateEndPilot string(date-time)
  
  defaultLocale string
  
  email string
  
  groupCompany object
  
  Hide groupCompany attributes Show groupCompany attributes object
  
  active boolean
  
  companyName string Required
  
  createdAt string(date-time)
  
  createdBy string
  
  id integer(int64)
  
  updatedAt string(date-time)
  
  updatedBy string
  
  id integer(int64)
  
  nameContact string
  
  neighborhood string
  
  number string
  
  phoneContact string
  
  sgemnet string
  
  site string
  
  sku string
  
  state string
  
  stateRegistration string
  
  timeHistory integer(int64)
  
  tradeName string
  
  updatedAt string(date-time)
  
  updatedBy string
  
  country string
  
  cpf string
  
  createdAt string(date-time)
  
  createdBy string
  
  createdFromSurvey boolean
  
  defaultLocale string
  
  displayName string
  
  email string
  
  externalCode string
  
  firstAccess boolean
  
  firstLogin string(date-time)
  
  formal boolean
  
  id integer(int64)
  
  lastLogin string(date-time)
  
  name string
  
  operation string
  
  originUser string
  
  phone string
  
  priority integer(int64)
  
  profile object
  
  Hide profile attributes Show profile attributes object
  
  createdAt string(date-time)
  
  createdBy string
  
  id integer(int64)
  
  name string
  
  typeUser string
  
  updatedAt string(date-time)
  
  updatedBy string
  
  visible boolean
  
  ticketUserId integer(int64)
  
  tm2 boolean
  
  typeUser string
  
  updatedAt string(date-time)
  
  updatedBy string
  
  userName string
  
  usingMFA boolean
  
  visible boolean
  
  password string
- userId integer(int64)
401 application/json

Não autorizado — token ausente ou inválido
403 application/json

Acesso proibido — sem permissão para este recurso
404 application/json

Recurso não encontrado

POST /chatapi/1.0/api/v2/direct-message/save

{
  "phoneNumber": "553432563200",
  "channel": "WHATSAPP",
  "message": "Olá esta é uma mensagem de teste",
  "groupName": "Atendentes WhatsApp",
  "additionalInfo": "{\"namespace\":\"e3a68d3e_5b32_4cd0_983d_5c8ac333910e\",\"elementName\":\"atendimento_wa_central\",\"parameters\":{},\"medias\":{},\"openSession\":false}",
  "status": "PROCESSANDO",
  "createdBy": "teste_user",
  "userId": 35978,
  "senderUserId": 35979,
  "groupConfId": 893,
  "generatedSession": 0
}

{
  "phoneNumber": "553432563200",
  "channel": "WHATSAPP",
  "message": "Olá, Usuario! Este é apenas um teste do nosso sistema de whatsapp",
  "groupName": "Atendimento",
  "status": "PROCESSANDO",
  "createdBy": "teste_user",
  "userId": 2279,
  "groupConfId": 1
}

{
  "phoneNumber": "553432563200",
  "channel": "WHATSAPP",
  "message": null,
  "groupName": "Atendentes WhatsApp",
  "additionalInfo": "{\"namespace\":\"47d576a8_cfc0_4054_9f7f_0721314d5ba6\",\"elementName\":\"equipecs\",\"parameters\":{\"BODY\":[{\"type\":\"text\",\"text\":\"Aline\",\"payload\":null,\"currency\":null,\"dateTime\":null},{\"type\":\"text\",\"text\":\"Teste\",\"payload\":null,\"currency\":null,\"dateTime\":null}]},\"medias\":{},\"openSession\":false}",
  "status": "PROCESSANDO",
  "hsmTemplate": 10,
  "createdBy": "teste_user",
  "userId": 2279,
  "groupConfId": 25
}

{
  "phoneNumber": "553432563200",
  "channel": "WHATSAPP",
  "message": "Teste do nosso sistema de whatsapp",
  "groupName": "Comercial Oficial Novo",
  "additionalInfo": "{\"namespace\":\"47d576a8_cfc0_4054_9f7f_0721314d5ba6\",\"elementName\":\"templatemidia\",\"parameters\":{},\"medias\":{\"HEADER\":[{\"url\":\"https://files.tm2digital.com/storage/file/comercial/2024/06/25/1effda00-391d-46f8-a107-e1824102d628.jpg\",\"extension\":\".jpg\"}]},\"openSession\":true}",
  "status": "PROCESSANDO",
  "hsmTemplate": 7,
  "createdBy": "teste_user",
  "userId": 2279,
  "senderUserId": 29279,
  "generatedSession": 0,
  "groupConfId": 103
}

{
  "phoneNumber": "553432563200",
  "channel": "WHATSAPP",
  "message": "Teste do nosso sistema de whatsapp",
  "groupName": "Atendentes WhatsApp",
  "additionalInfo": "{\"namespace\":\"47d576a8_cfc0_4054_9f7f_0721314d5ba6\",\"elementName\":\"teste_botaourl\",\"parameters\":{\"BUTTON\":[{\"type\":\"text\",\"text\":\"teste\",\"payload\":null,\"currency\":null,\"dateTime\":null}]},\"medias\":{},\"openSession\":false}",
  "status": "PROCESSANDO",
  "hsmTemplate": 219,
  "createdBy": "teste_user",
  "userId": 2377,
  "senderUserId": 585,
  "generatedSession": 0,
  "groupConfId": 25,
  "agentId": 81843,
  "sendGroupConfId": 25
}

{
  "phoneNumber": "553432563200",
  "channel": "WHATSAPP",
  "message": "Seu código de verificação é {VERIFICATION_CODE}.",
  "groupName": "Atendentes WhatsApp",
  "additionalInfo": "{\"namespace\":\"47d576a8_cfc0_4054_9f7f_0721314d5ba6\",\"elementName\":\"test_verification_code\",\"parameters\":{\"BODY\":[{\"type\":\"text\",\"text\":\"12345\",\"payload\":null,\"currency\":null,\"dateTime\":null}],\"BUTTON\":[{\"type\":\"text\",\"text\":\"teste\",\"payload\":null,\"currency\":null,\"dateTime\":null}]},\"medias\":{},\"openSession\":false}",
  "status": "PROCESSANDO",
  "hsmTemplate": 24,
  "createdBy": "teste_user",
  "userId": 337,
  "senderUserId": 155,
  "generatedSession": 0,
  "groupConfId": 25,
  "sendGroupConfId": 9
}

{
  "channel": "EMAIL",
  "message": "Olá, Usuario! Este é apenas um teste de envio ativo por e-mail",
  "groupName": "EMAIL",
  "status": "PROCESSANDO",
  "subject": "Email Teste",
  "email": "teste_user@neppo.com.br",
  "createdBy": "teste_user",
  "userId": 35978,
  "senderUserId": 35979,
  "groupConfId": 893,
  "agentId": 10778,
  "sendGroupConfId": 893
}

{
  "phoneNumber": "553432563200",
  "channel": "SMS",
  "message": "Olá, Usuario! Este é apenas um teste do nosso sistema de SMS da Neppo",
  "groupName": "SMS Infobip",
  "status": "PROCESSANDO",
  "createdBy": "teste_user",
  "userId": 32607,
  "senderUserId": 11886,
  "groupConfId": 70,
  "agentId": 5939,
  "sendGroupConfId": 70
}

{
  "phoneNumber": "553432563200",
  "channel": "TELEGRAM",
  "message": "Vamos falar pelo Telegram?",
  "groupName": "360dialog oficial 2",
  "additionalInfo": "OPEN_SESSION",
  "status": "PROCESSANDO",
  "createdBy": "teste_user",
  "userId": 35978,
  "senderUserId": 35979,
  "groupConfId": 893,
  "agentId": 10778,
  "sendGroupConfId": 893
}

curl \
 --request POST 'https://api.neppo.com.br/chatapi/1.0/api/v2/direct-message/save' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"phoneNumber":"553432563200","channel":"WHATSAPP","message":"Olá, Usuario! Este é apenas um teste do nosso sistema de whatsapp","groupName":"Atendimento","status":"PROCESSANDO","createdBy":"teste_user","userId":2279,"groupConfId":1}'

Request example

{
  "phoneNumber": "553432563200",
  "channel": "WHATSAPP",
  "message": "Olá, Usuario! Este é apenas um teste do nosso sistema de whatsapp",
  "groupName": "Atendimento",
  "status": "PROCESSANDO",
  "createdBy": "teste_user",
  "userId": 2279,
  "groupConfId": 1
}

Response examples (200)

{
  "id": 100713,
  "groupName": "Atendentes WhatsApp",
  "channel": "WHATSAPP",
  "message": "Olá esta é uma mensagem de teste",
  "phoneNumber": "553432563200",
  "email": null,
  "subject": null,
  "status": "PROCESSANDO",
  "description": null,
  "additionalInfo": "{\"namespace\":\"e3a68d3e_5b32_4cd0_983d_5c8ac333910e\",\"elementName\":\"atendimento_wa_central\",\"parameters\":{},\"medias\":{},\"openSession\":false}",
  "callback": null,
  "createdAt": "2025-06-04T21:52:26.944+00:00",
  "updatedAt": null,
  "broadcastListId": null,
  "createdBy": "teste_user",
  "sendTimestamp": null,
  "user": null,
  "userId": 35978,
  "senderUserId": 35979,
  "generatedSession": false,
  "campaignName": null,
  "dispatchId": null,
  "sessionId": null,
  "groupConfId": 893,
  "hsmTemplate": null,
  "agentId": null,
  "sendGroupConfId": null,
  "sentAt": null,
  "resend": true,
  "recipientId": null
}

Response examples (401)

{
  "status": "Unauthorized"
}

Response examples (403)

{
  "status": "Forbidden"
}

Response examples (404)

{
  "status": "Not Found"
}