Zoca

Zoca Chatbot API

The chatbot API from Zoca — 82 operation(s) for chatbot.

GitHub OpenAPI

Operations 92

GET /chatbot/calls/{callId} Get call details by call ID #
GET /chatbot/calls/{callId}/regenerate-summary Regenerate call summary by call ID #
GET /chatbot/sp-context/{entityId} Get service provider context for an entity #
POST /chatbot/retell/phone/import Import a phone number to Retell #
PUT /chatbot/retell/phone/{phoneNumber} Update a phone number configuration #
POST /chatbot/phone/purchase Purchase a new phone number #
POST /chatbot/phone/verify-virtual-number Verify that a virtual number is properly configured #
GET /chatbot/test/followup-status/{clientId} Test endpoint to check followup status for a client #
POST /chatbot/conversation/state/{clientId} Get conversation state by client ID #
POST /chatbot/card/on-file Create card on file #
POST /chatbot/card/on-file/link Get card on file link #
POST /chatbot/feedback Create a new feedback record #
GET /chatbot/feedback Get all feedback records for an entity with pagination #
PUT /chatbot/feedback/{id} Update an existing feedback record #
DELETE /chatbot/feedback/{id} Soft delete a feedback record #
GET /chatbot/feedback/{id} Get a feedback record by ID #
GET /chatbot/human-handovers/{clientId} Get all human handover records for a client #
POST /tasks/api/v1/chatbot/callhippo-sms-webhook Handle incoming SMS messages from CallHippo #
POST /tasks/api/v1/chatbot/continue-conversation Continue a conversation with the chatbot for testing #
POST /tasks/api/v1/chatbot/soft-delete-messages Soft delete messages from a conversation #
POST /tasks/api/v1/chatbot/start-conversation Start a new conversation with a customer #
POST /tasks/api/v1/chatbot/start-conversation-production Start a new conversation with a customer (Production - No Restrictions) #
POST /tasks/api/v1/chatbot/process-followups Process due follow-ups #
POST /tasks/api/v1/chatbot/deactivate-handover/{clientId} Deactivate human handover for a client #
POST /tasks/api/v1/chatbot/activate-handover/{clientId} Activate human handover for a client #
GET /tasks/api/v1/chatbot/followups/due Get all due followups #
GET /tasks/api/v1/chatbot/followups/{clientId} Get all followups for a client #
POST /tasks/api/v1/chatbot/{clientId}/next-followup Calculate next follow-up for a client #
POST /tasks/api/v1/chatbot/event-webhook Handle various application events #
GET /tasks/api/v1/chatbot/sp-context/{locationEntityId} Test the getSpContext function with a specific location entity ID #
POST /tasks/api/v1/chatbot/booking-requests/update Update booking requests with available slots #
GET /tasks/api/v1/chatbot/booking-requests/pending Get all pending booking requests #
POST /tasks/api/v1/chatbot/booking-requests/test-booking-info Test the getBookingInfo function with direct parameters #
POST /tasks/api/v1/chatbot/booking-info Get available booking slots for a specific service and date #
GET /tasks/api/v1/chatbot/entity-record-l2b/{entityId} Get an entity record for L2B bot configuration #
GET /tasks/api/v1/chatbot/enabled-functions/{entityId} Get enabled chatbot functions for an entity #
POST /tasks/api/v1/chatbot/entity-record-l2b Create an entity record for L2B bot configuration #
POST /tasks/api/v1/chatbot/entity-record-l2b/update/{entityId} Update an entity record for L2B bot configuration #
POST /tasks/api/v1/chatbot/business-info/{entityId} Save business information for L2B entity #
GET /tasks/api/v1/chatbot/business-info/{entityId} Get business information and onboarding data for entity #
GET /tasks/api/v1/chatbot/l2b/non-configured-entities Get entities not configured for L2B or with L2B disabled #
GET /tasks/api/v1/chatbot/l2b/all-phone-numbers Get all L2B entity phone numbers #
GET /tasks/api/v1/chatbot/l2b/entity-phone-numbers/{entityId} Get all L2B entity phone numbers #
GET /tasks/api/v1/chatbot/conversation-partners Get recent conversation partners #
POST /tasks/api/v1/chatbot/mark-read Mark conversation as read for a client #
GET /tasks/api/v1/chatbot/conversation-history Get conversation history #
GET /tasks/api/v1/chatbot/l2b/leads/{entityId} Get L2B leads for an entity with their most recent message #
GET /tasks/api/v1/chatbot/l2b/conversations/{phoneNumber}/{countryCode}/{entityId} Get L2B conversations for a phone number #
GET /tasks/api/v1/chatbot/l2b-entity-phone-numbers/{entityId} Get virtual phone numbers for an entity #
POST /tasks/api/v1/chatbot/calls/initiate Initiate a call to a customer #
GET /tasks/api/v1/chatbot/calls/client/{clientId} Get call history for a client #
POST /tasks/api/v1/chatbot/webhooks/incoming-call Handle incoming call webhook and events from Retell #
GET /tasks/api/v1/chatbot/calls/context Get call context for incoming calls #
GET /tasks/api/v1/chatbot/calls/{callId} Retrieve call details from Retell #
POST /tasks/api/v1/chatbot/webhooks/call-events Handle all call events webhook from Retell (unified endpoint) #
POST /tasks/api/v1/chatbot/test/make-call Make a test outbound call #
POST /tasks/api/v1/chatbot/test/incoming-call Handle test incoming call setup #
GET /tasks/api/v1/chatbot/human-handover/{clientId} Check if human handover is active for a client #
GET /tasks/api/v1/chatbot/call-bridge-number Get the call brige number to which calls will be forwarded if EC calls to… #
GET /tasks/api/v1/chatbot/message-history/{clientId} Get formatted message history for a client #
GET /tasks/api/v1/chatbot/l2b/active-businesses Get all businesses with active L2B bot #
GET /tasks/api/v1/chatbot/entities/{entityId}/preferences Get all chatbot-related preferences for an entity #
GET /tasks/api/v1/chatbot/l2b/business/{entityId}/clients Get clients for a business with conversation and handover status #
GET /tasks/api/v1/chatbot/business/{entityId}/webhook-data Get formatted webhook data for a business entity #
GET /tasks/api/v1/chatbot/l2b/conversations/{clientId} Get conversation history for a client #
POST /tasks/api/v1/chatbot/webhook-data Upsert webhook data for a phone number #
GET /tasks/api/v1/chatbot/test/entity/{entityId}/phones Get phone numbers for an entity (testing) #
POST /tasks/api/v1/chatbot/test/entity/{entityId}/phones Add phone number to entity (testing) #
POST /tasks/api/v1/chatbot/bookings Create a new booking #
GET /tasks/api/v1/chatbot/prompt-variables Get prompt variables with optional full prompt #
GET /tasks/api/v1/chatbot/original-variables Get original variables for non-test entities #
GET /tasks/api/v1/chatbot/internal/prompt-with-fallback Get prompt with multi-tier fallback mechanism #
GET /tasks/api/v1/chatbot/rules/entity/{entityId} List all rules for an entity #
POST /tasks/api/v1/chatbot/rules Create a new ops team rule #
GET /tasks/api/v1/chatbot/rules/{ruleId} Get a rule by ID #
PUT /tasks/api/v1/chatbot/rules/{ruleId} Update a rule #
DELETE /tasks/api/v1/chatbot/rules/{ruleId} Delete a rule #
GET /tasks/api/v1/chatbot/test/category-grouping/{locationEntityId} Test the category grouping function with a specific location entity ID #
POST /tasks/api/v1/chatbot/test/validate-ccof T value #
POST /tasks/api/v1/chatbot/temp/square/bookings T value #
POST /tasks/api/v1/chatbot/square/bookings/no-card-validation T value #
POST /tasks/api/v1/chatbot/square/bookings/accepted T value #
POST /tasks/api/v1/chatbot/test/schedule-response-followup T value #
GET /tasks/api/v1/chatbot/functions Get all available chatbot functions #
GET /tasks/api/v1/chatbot/functions/entity/{entityId} Get enabled chatbot functions for an entity #
POST /tasks/api/v1/chatbot/message-templates Create a new message template #
GET /tasks/api/v1/chatbot/message-templates Get all message templates #
GET /tasks/api/v1/chatbot/message-templates/{id} Get a message template by ID #
PUT /tasks/api/v1/chatbot/message-templates/{id} Update a message template #
DELETE /tasks/api/v1/chatbot/message-templates/{id} Delete a message template #
PUT /tasks/api/v1/chatbot/entity/{entityId}/metadata Update entity metadata #
POST /tasks/api/v1/chatbot/metadata/bulk-update Bulk update entity metadata for L2B entities #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zoca/refs/heads/main/openapi/zoca-chatbot-api-openapi.yml

Other Resources

🔗
Components
https://raw.githubusercontent.com/api-evangelist/zoca/refs/heads/main/components/zoca-components.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/zoca-chatbot-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

zoca-chatbot-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Zoca Chatbot API
  contact: {}
  x-refined-note:
  - x-apievangelist-note differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged chatbot across 2 of this provider''s published API definitions: zoca-platform-openapi.yml, zoca-tasks-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.zoca.ai
  description: Production
- url: https://tasks.zoca.ai
  description: Production
tags:


# --- truncated at 32 KB (95 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoca/refs/heads/main/openapi/zoca-chatbot-api-openapi.yml