Consultar status de execução da campanha

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

mcp.json 
{
  "Neppo API MCP server": {
    "url": "https://api-docs.neppo.com.br/mcp"
  }
}
Close
POST /chatapi/1.0/api/v3/campaign/execute/status
Bearer auth

Retorna o status atual da execução de uma campanha, incluindo progresso e resultados parciais.

application/json

Body Required

campaignStatusRequest

  • executionId integer(int64)
  • campaignId integer(int64)

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • campaignId integer(int64)
    • executionId integer(int64)
    • message string
    • status string
    • statusMessages array[object]
      Hide statusMessages attributes Show statusMessages attributes object
      • id integer(int64)
      • message string
      • recipient string
      • recipientId string
      • status string
  • 201

    Created

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Not Found

POST /chatapi/1.0/api/v3/campaign/execute/status 
curl \
 --request POST 'https://api.neppo.com.br/chatapi/1.0/api/v3/campaign/execute/status' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"executionId":42,"campaignId":42}'
Request examples 
{
  "executionId": 42,
  "campaignId": 42
}
Response examples (200) 
{
  "campaignId": 42,
  "executionId": 42,
  "message": "string",
  "status": "string",
  "statusMessages": [
    {
      "id": 42,
      "message": "string",
      "recipient": "string",
      "recipientId": "string",
      "status": "string"
    }
  ]
}