How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoca Chatbot API

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

Zoca Chatbot API is one of 193 APIs that Zoca publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Chatbots. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 92 operations across 82 paths, and defines 3 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.zoca.ai, https://tasks.zoca.ai.

92 operations 82 paths 3 schemas 3 DELETE44 GET40 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.zoca.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Zoca Chatbot API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (access-token).

  • access-token — Enter JWT token in the format Bearer

Paths & Operations 92

Across 82 paths, the API surfaces 92 operations — 3 DELETE, 44 GET, 40 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Chatbot 92
GET
/chatbot/calls/{callId}
Get call details by call ID
t_value → 200
GET
/chatbot/calls/{callId}/regenerate-summary
Regenerate call summary by call ID
getChatbotCallsByCallIdRegenerateSummary 1 param → 200400404
GET
/chatbot/sp-context/{entityId}
Get service provider context for an entity
getChatbotSpContextByEntityId 1 param → 200
POST
/chatbot/retell/phone/import
Import a phone number to Retell
postChatbotRetellPhoneImport body → 201400
PUT
/chatbot/retell/phone/{phoneNumber}
Update a phone number configuration
putChatbotRetellPhoneByPhoneNumber 1 param body → 200400404
POST
/chatbot/phone/purchase
Purchase a new phone number
postChatbotPhonePurchase → 201
POST
/chatbot/phone/verify-virtual-number
Verify that a virtual number is properly configured
postChatbotPhoneVerifyVirtualNumber body → 200400
GET
/chatbot/test/followup-status/{clientId}
Test endpoint to check followup status for a client
getChatbotTestFollowupStatusByClientId 1 param → 200
POST
/chatbot/conversation/state/{clientId}
Get conversation state by client ID
postChatbotConversationStateByClientId 1 param → 201
POST
/chatbot/card/on-file
Create card on file
postChatbotCardOnFile → 201
POST
/chatbot/card/on-file/link
Get card on file link
postChatbotCardOnFileLink → 201
POST
/chatbot/feedback
Create a new feedback record
postChatbotFeedback → 201400
GET
/chatbot/feedback
Get all feedback records for an entity with pagination
getChatbotFeedback 3 params → 200400
PUT
/chatbot/feedback/{id}
Update an existing feedback record
putChatbotFeedbackById 1 param → 200400404
DELETE
/chatbot/feedback/{id}
Soft delete a feedback record
deleteChatbotFeedbackById 1 param → 200404
GET
/chatbot/feedback/{id}
Get a feedback record by ID
getChatbotFeedbackById 1 param → 200404
GET
/chatbot/human-handovers/{clientId}
Get all human handover records for a client
getChatbotHumanHandoversByClientId 1 param → 200404500
POST
/tasks/api/v1/chatbot/callhippo-sms-webhook
Handle incoming SMS messages from CallHippo
postTasksApiV1ChatbotCallhippoSmsWebhook body → 200400500
POST
/tasks/api/v1/chatbot/continue-conversation
Continue a conversation with the chatbot for testing
postTasksApiV1ChatbotContinueConversation body → 200500
POST
/tasks/api/v1/chatbot/soft-delete-messages
Soft delete messages from a conversation
postTasksApiV1ChatbotSoftDeleteMessages body → 200403404500
POST
/tasks/api/v1/chatbot/start-conversation
Start a new conversation with a customer
postTasksApiV1ChatbotStartConversation body → 200400500
POST
/tasks/api/v1/chatbot/start-conversation-production
Start a new conversation with a customer (Production - No Restrictions)
postTasksApiV1ChatbotStartConversationProduction body → 200400500
POST
/tasks/api/v1/chatbot/process-followups
Process due follow-ups
postTasksApiV1ChatbotProcessFollowups body → 200500
POST
/tasks/api/v1/chatbot/deactivate-handover/{clientId}
Deactivate human handover for a client
postTasksApiV1ChatbotDeactivateHandoverByClientId 2 params → 200500
POST
/tasks/api/v1/chatbot/activate-handover/{clientId}
Activate human handover for a client
postTasksApiV1ChatbotActivateHandoverByClientId 1 param → 200500
GET
/tasks/api/v1/chatbot/followups/due
Get all due followups
getTasksApiV1ChatbotFollowupsDue → 200500
GET
/tasks/api/v1/chatbot/followups/{clientId}
Get all followups for a client
getTasksApiV1ChatbotFollowupsByClientId 1 param → 200500
POST
/tasks/api/v1/chatbot/{clientId}/next-followup
Calculate next follow-up for a client
postTasksApiV1ChatbotByClientIdNextFollowup 1 param body → 200400404500
POST
/tasks/api/v1/chatbot/event-webhook
Handle various application events
postTasksApiV1ChatbotEventWebhook → 200400500
GET
/tasks/api/v1/chatbot/sp-context/{locationEntityId}
Test the getSpContext function with a specific location entity ID
getTasksApiV1ChatbotSpContextByLocationEntityId 1 param → 200500
POST
/tasks/api/v1/chatbot/booking-requests/update
Update booking requests with available slots
postTasksApiV1ChatbotBookingRequestsUpdate body → 200404500
GET
/tasks/api/v1/chatbot/booking-requests/pending
Get all pending booking requests
getTasksApiV1ChatbotBookingRequestsPending → 200500
POST
/tasks/api/v1/chatbot/booking-requests/test-booking-info
Test the getBookingInfo function with direct parameters
postTasksApiV1ChatbotBookingRequestsTestBookingInfo body → 200400500
POST
/tasks/api/v1/chatbot/booking-info
Get available booking slots for a specific service and date
postTasksApiV1ChatbotBookingInfo body → 200400500
GET
/tasks/api/v1/chatbot/entity-record-l2b/{entityId}
Get an entity record for L2B bot configuration
getTasksApiV1ChatbotEntityRecordL2bByEntityId 1 param → 200404500
GET
/tasks/api/v1/chatbot/enabled-functions/{entityId}
Get enabled chatbot functions for an entity
getTasksApiV1ChatbotEnabledFunctionsByEntityId 1 param → 200404500
POST
/tasks/api/v1/chatbot/entity-record-l2b
Create an entity record for L2B bot configuration
postTasksApiV1ChatbotEntityRecordL2b body → 200400500
POST
/tasks/api/v1/chatbot/entity-record-l2b/update/{entityId}
Update an entity record for L2B bot configuration
postTasksApiV1ChatbotEntityRecordL2bUpdateByEntityId 1 param body → 200400404500
POST
/tasks/api/v1/chatbot/business-info/{entityId}
Save business information for L2B entity
postTasksApiV1ChatbotBusinessInfoByEntityId 1 param body → 200400401404500
GET
/tasks/api/v1/chatbot/business-info/{entityId}
Get business information and onboarding data for entity
getTasksApiV1ChatbotBusinessInfoByEntityId 1 param → 200400401404500
GET
/tasks/api/v1/chatbot/l2b/non-configured-entities
Get entities not configured for L2B or with L2B disabled
getTasksApiV1ChatbotL2bNonConfiguredEntities 3 params → 200500
GET
/tasks/api/v1/chatbot/l2b/all-phone-numbers
Get all L2B entity phone numbers
getTasksApiV1ChatbotL2bAllPhoneNumbers 1 param → 200500
GET
/tasks/api/v1/chatbot/l2b/entity-phone-numbers/{entityId}
Get all L2B entity phone numbers
getTasksApiV1ChatbotL2bEntityPhoneNumbersByEntityId 2 params → 200500
GET
/tasks/api/v1/chatbot/conversation-partners
Get recent conversation partners
getTasksApiV1ChatbotConversationPartners 6 params → 200500
POST
/tasks/api/v1/chatbot/mark-read
Mark conversation as read for a client
postTasksApiV1ChatbotMarkRead body → 200400500
GET
/tasks/api/v1/chatbot/conversation-history
Get conversation history
getTasksApiV1ChatbotConversationHistory 1 param → 200400500
GET
/tasks/api/v1/chatbot/l2b/leads/{entityId}
Get L2B leads for an entity with their most recent message
getTasksApiV1ChatbotL2bLeadsByEntityId 3 params → 200500
GET
/tasks/api/v1/chatbot/l2b/conversations/{phoneNumber}/{countryCode}/{entityId}
Get L2B conversations for a phone number
getTasksApiV1ChatbotL2bConversationsByPhoneNumberByCountryCodeByEntityId 5 params → 200500
GET
/tasks/api/v1/chatbot/l2b-entity-phone-numbers/{entityId}
Get virtual phone numbers for an entity
t_value 1 param → 200500
POST
/tasks/api/v1/chatbot/calls/initiate
Initiate a call to a customer
postTasksApiV1ChatbotCallsInitiate body → 200400500
GET
/tasks/api/v1/chatbot/calls/client/{clientId}
Get call history for a client
getTasksApiV1ChatbotCallsClientByClientId 1 param → 200500
POST
/tasks/api/v1/chatbot/webhooks/incoming-call
Handle incoming call webhook and events from Retell
postTasksApiV1ChatbotWebhooksIncomingCall body → 200400
GET
/tasks/api/v1/chatbot/calls/context
Get call context for incoming calls
getTasksApiV1ChatbotCallsContext 3 params → 200
GET
/tasks/api/v1/chatbot/calls/{callId}
Retrieve call details from Retell
getTasksApiV1ChatbotCallsByCallId 1 param → 200500
POST
/tasks/api/v1/chatbot/webhooks/call-events
Handle all call events webhook from Retell (unified endpoint)
postTasksApiV1ChatbotWebhooksCallEvents body → 200400
POST
/tasks/api/v1/chatbot/test/make-call
Make a test outbound call
postTasksApiV1ChatbotTestMakeCall body → 200
POST
/tasks/api/v1/chatbot/test/incoming-call
Handle test incoming call setup
postTasksApiV1ChatbotTestIncomingCall body → 200
GET
/tasks/api/v1/chatbot/human-handover/{clientId}
Check if human handover is active for a client
getTasksApiV1ChatbotHumanHandoverByClientId 1 param → 200500
GET
/tasks/api/v1/chatbot/call-bridge-number
Get the call brige number to which calls will be forwarded if EC calls to…
getTasksApiV1ChatbotCallBridgeNumber → 200500
GET
/tasks/api/v1/chatbot/message-history/{clientId}
Get formatted message history for a client
getTasksApiV1ChatbotMessageHistoryByClientId 2 params → 200400500
GET
/tasks/api/v1/chatbot/l2b/active-businesses
Get all businesses with active L2B bot
getTasksApiV1ChatbotL2bActiveBusinesses 2 params → 200500
GET
/tasks/api/v1/chatbot/entities/{entityId}/preferences
Get all chatbot-related preferences for an entity
getTasksApiV1ChatbotEntitiesByEntityIdPreferences 1 param → 200
GET
/tasks/api/v1/chatbot/l2b/business/{entityId}/clients
Get clients for a business with conversation and handover status
getTasksApiV1ChatbotL2bBusinessByEntityIdClients 3 params → 200500
GET
/tasks/api/v1/chatbot/business/{entityId}/webhook-data
Get formatted webhook data for a business entity
getTasksApiV1ChatbotBusinessByEntityIdWebhookData 1 param → 200404500
GET
/tasks/api/v1/chatbot/l2b/conversations/{clientId}
Get conversation history for a client
getTasksApiV1ChatbotL2bConversationsByClientId 3 params → 200500
POST
/tasks/api/v1/chatbot/webhook-data
Upsert webhook data for a phone number
postTasksApiV1ChatbotWebhookData body → 200400500
GET
/tasks/api/v1/chatbot/test/entity/{entityId}/phones
Get phone numbers for an entity (testing)
getTasksApiV1ChatbotTestEntityByEntityIdPhones 2 params → 200500
POST
/tasks/api/v1/chatbot/test/entity/{entityId}/phones
Add phone number to entity (testing)
postTasksApiV1ChatbotTestEntityByEntityIdPhones 1 param body → 200400500
POST
/tasks/api/v1/chatbot/bookings
Create a new booking
postTasksApiV1ChatbotBookings body → 201400
GET
/tasks/api/v1/chatbot/prompt-variables
Get prompt variables with optional full prompt
getTasksApiV1ChatbotPromptVariables 3 params → 200400500
GET
/tasks/api/v1/chatbot/original-variables
Get original variables for non-test entities
getTasksApiV1ChatbotOriginalVariables 1 param → 200400500
GET
/tasks/api/v1/chatbot/internal/prompt-with-fallback
Get prompt with multi-tier fallback mechanism
getTasksApiV1ChatbotInternalPromptWithFallback 4 params → 200500
GET
/tasks/api/v1/chatbot/rules/entity/{entityId}
List all rules for an entity
getTasksApiV1ChatbotRulesEntityByEntityId 4 params → 200404
POST
/tasks/api/v1/chatbot/rules
Create a new ops team rule
postTasksApiV1ChatbotRules body → 201400
GET
/tasks/api/v1/chatbot/rules/{ruleId}
Get a rule by ID
getTasksApiV1ChatbotRulesByRuleId 1 param → 200404
PUT
/tasks/api/v1/chatbot/rules/{ruleId}
Update a rule
putTasksApiV1ChatbotRulesByRuleId 1 param body → 200400404
DELETE
/tasks/api/v1/chatbot/rules/{ruleId}
Delete a rule
deleteTasksApiV1ChatbotRulesByRuleId 1 param → 204404
GET
/tasks/api/v1/chatbot/test/category-grouping/{locationEntityId}
Test the category grouping function with a specific location entity ID
getTasksApiV1ChatbotTestCategoryGroupingByLocationEntityId 1 param → 200
POST
/tasks/api/v1/chatbot/test/validate-ccof
T value
postTasksApiV1ChatbotTestValidateCcof → 201
POST
/tasks/api/v1/chatbot/temp/square/bookings
T value
postTasksApiV1ChatbotTempSquareBookings → 201
POST
/tasks/api/v1/chatbot/square/bookings/no-card-validation
T value
postTasksApiV1ChatbotSquareBookingsNoCardValidation → 201
POST
/tasks/api/v1/chatbot/square/bookings/accepted
T value
postTasksApiV1ChatbotSquareBookingsAccepted → 201
POST
/tasks/api/v1/chatbot/test/schedule-response-followup
T value
postTasksApiV1ChatbotTestScheduleResponseFollowup → 201
GET
/tasks/api/v1/chatbot/functions
Get all available chatbot functions
getTasksApiV1ChatbotFunctions → 200500
GET
/tasks/api/v1/chatbot/functions/entity/{entityId}
Get enabled chatbot functions for an entity
getTasksApiV1ChatbotFunctionsEntityByEntityId 1 param → 200400500
POST
/tasks/api/v1/chatbot/message-templates
Create a new message template
postTasksApiV1ChatbotMessageTemplates → 201400500
GET
/tasks/api/v1/chatbot/message-templates
Get all message templates
getTasksApiV1ChatbotMessageTemplates 1 param → 200500
GET
/tasks/api/v1/chatbot/message-templates/{id}
Get a message template by ID
getTasksApiV1ChatbotMessageTemplatesById 1 param → 200404500
PUT
/tasks/api/v1/chatbot/message-templates/{id}
Update a message template
putTasksApiV1ChatbotMessageTemplatesById 1 param → 200400404500
DELETE
/tasks/api/v1/chatbot/message-templates/{id}
Delete a message template
deleteTasksApiV1ChatbotMessageTemplatesById 2 params → 200404500
PUT
/tasks/api/v1/chatbot/entity/{entityId}/metadata
Update entity metadata
putTasksApiV1ChatbotEntityByEntityIdMetadata 1 param body → 200404500
POST
/tasks/api/v1/chatbot/metadata/bulk-update
Bulk update entity metadata for L2B entities
postTasksApiV1ChatbotMetadataBulkUpdate → 200400500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are e (6 properties), e_2 (5 properties). Each schema is shown below with its type and property counts.

e
object
6 properties 3 required
Object
object
e_2
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoca-chatbot-api-openapi.yml Raw ↑

Other APIs Zoca publishes across the network.

Zoca ACM API
Zoca Acuity API
Zoca Addon Groups API
Zoca Aeo Lead Magnet API
Zoca Agents API
Zoca API Keys API
Zoca App API
Zoca App Blocker API
Zoca App Blocker Updates API
Zoca Approvals API
Zoca Auth API
Zoca Billing API
Where this information came from

This is an independent, third-party profile of Zoca Chatbot API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.