Netomi

Netomi Platform API

The Netomi backend service that fronts the Agentic OS for CX. It backs the first-party mobile Chat SDKs (session establishment, message exchange, rich media, file attachments, forms, live agent handoff, push notification registration) and exposes per-partner inbound webhook endpoints used by helpdesk integrations such as Gladly at /v1/{partner}/webhook. Sessions are either guest (anonymous, SDK-managed) or JWT-authenticated with a reauthorization flow. Access is provisioned per enterprise account with a bot reference ID and a region environment. A live OpenAPI 3.1.0 description (AgentDesk REST API — 56 paths, 67 operations, 103 schemas) is served at /v3/api-docs with Swagger UI at /swagger-ui.html, though it is not linked from any Netomi documentation and declares no securitySchemes, summaries, descriptions, examples or non-200 responses.

GitHub OpenAPI

Documentation

📖
APIReference
https://api.netomi.com/swagger-ui.html
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/netomi/refs/heads/main/authentication/netomi-authentication.yml
📖
Documentation
https://github.com/msgai/netomi-chat-ios

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/netomi/refs/heads/main/openapi/netomi-agentdesk-openapi.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/netomi/refs/heads/main/overlays/netomi-agentdesk-overlay.yaml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/netomi/refs/heads/main/data-model/netomi-data-model.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/netomi/refs/heads/main/errors/netomi-error-codes.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/netomi/refs/heads/main/asyncapi/netomi-events.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/netomi/refs/heads/main/conventions/netomi-conventions.yml
🔗
AgentSkill
https://raw.githubusercontent.com/api-evangelist/netomi/refs/heads/main/skills/_index.yml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/netomi/refs/heads/main/apis.yml

OpenAPI Specification

netomi-agentdesk-openapi.json Raw ↑ 
{"openapi":"3.1.0","info":{"title":"AgentDesk REST API","description":"AgentDesk Rest API","termsOfService":"Terms of service","contact":{"name":"Netomi Support Team","url":"https://netomi.com","email":"support@netomi.com"},"version":"1.0"},"servers":[{"url":"http://api.netomi.com","description":"Generated server url"}],"paths":{"/v1/rate-limit":{"get":{"tags":["rate-limiter-config-controller"],"operationId":"fetchRateConfig","parameters":[{"name":"botRefId","in":"query","required":false,"schema":{"type":"string"}},{"name":"botId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}},"put":{"tags":["rate-limiter-config-controller"],"operationId":"updatedRateConfig","parameters":[{"name":"botRefId","in":"query","required":false,"schema":{"type":"string"}},{"name":"botId","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitConfigRequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}},"post":{"tags":["rate-limiter-config-controller"],"operationId":"saveRateConfig","parameters":[{"name":"botRefId","in":"query","required":false,"schema":{"type":"string"}},{"name":"botId","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitConfigRequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}},"delete":{"tags":["rate-limiter-config-controller"],"operationId":"deleteRateConfig","parameters":[{"name":"botRefId","in":"query","required":false,"schema":{"type":"string"}},{"name":"botId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v2/webhook/event":{"post":{"tags":["webhook-event-controller"],"operationId":"triggerWebHookEvent","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebHookEventRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v2/test-utterances/bulk":{"post":{"tags":["test-utterance-script-controller"],"operationId":"submitRequest","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v2/test-utterances/bulk/poll":{"post":{"tags":["test-utterance-script-controller"],"operationId":"pollScript","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v2/query-analyzer":{"post":{"tags":["query-analyzer-controller"],"operationId":"submitRequest_1","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v2/messages":{"get":{"tags":["pub-sub-controller"],"operationId":"getResponse","parameters":[{"name":"requestId","in":"query","required":true,"schema":{"type":"string"}},{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":{}}}}}}}},"post":{"tags":["pub-sub-controller"],"operationId":"conversationEngineAsync","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/zoho/webhook":{"get":{"tags":["zoho-webhook-controller"],"operationId":"subscribe","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"tags":["zoho-webhook-controller"],"operationId":"conversationEngineAsync_1","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/zoho/webhook/{botRefId}":{"get":{"tags":["zoho-webhook-controller"],"operationId":"subscribeWithBotRefId","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"tags":["zoho-webhook-controller"],"operationId":"conversationEngineAsyncWithBotRefId","parameters":[{"name":"botRefId","in":"path","required":true,"schema":{"type":"string"}},{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/zendesk/webhook":{"post":{"tags":["zendesk-webhook-controller"],"operationId":"conversationEngineAsync_2","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/zendesk-chat/response":{"post":{"tags":["zen-desk-chat-rest-controller"],"operationId":"getStructuredResponse","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/zendesk-chat/publish-social":{"post":{"tags":["zen-desk-chat-rest-controller"],"operationId":"publishToSocialOutbound","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationResponse"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/zendesk-chat/poll":{"post":{"tags":["zen-desk-chat-rest-controller"],"operationId":"getResponse_1","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/webhook/generic_agent_desk_response":{"post":{"tags":["generic-webhook-controller"],"operationId":"message","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}}}}}},"/v1/webhook/events":{"post":{"tags":["generic-webhook-controller"],"operationId":"event","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/webhook/":{"post":{"tags":["generic-webhook-controller"],"operationId":"messagesPost","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/webhook":{"post":{"tags":["generic-webhook-controller"],"operationId":"messagesPost_1","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/twitter/webhook/{appId}":{"get":{"tags":["twitter-webhook-controller"],"operationId":"subscribe_1","parameters":[{"name":"crc_token","in":"query","required":true,"schema":{"type":"string"}},{"name":"appId","in":"path","required":true,"schema":{"type":"string"}},{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object"}}}}}},"post":{"tags":["twitter-webhook-controller"],"operationId":"messagesPost_2","parameters":[{"name":"appId","in":"path","required":true,"schema":{"type":"string"}},{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/sunshine-conversations/webhook":{"post":{"tags":["sunshine-conversations-webhook-controller"],"operationId":"conversationEngineAsync_3","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/sprinklr/webhook":{"post":{"tags":["sprinklr-webhook-controller"],"operationId":"conversationEngineAsync_4","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/sprinklr/webhook/poll":{"post":{"tags":["sprinklr-webhook-controller"],"operationId":"postResponse","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":{}}}}}}}}},"/v1/salesforce/webhook":{"post":{"tags":["salesforce-webhook-controller"],"operationId":"conversationEngineAsync_5","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/salesforce/webhook/messages/poll":{"post":{"tags":["salesforce-webhook-controller"],"operationId":"postResponse_1","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":{}}}}}}}}},"/v1/nlu/predict":{"post":{"tags":["nluapi-controller"],"operationId":"postRequest","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/nlu/poll":{"post":{"tags":["nluapi-controller"],"operationId":"pollResponse","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/helpshift/webhook":{"post":{"tags":["helpshift-webhook-controller"],"operationId":"conversationEngineAsync_6","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/google/assistant/webhook":{"post":{"tags":["google-assistant-webhook-controller"],"operationId":"googleAssistantPost","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/gladly/webhook":{"get":{"tags":["gladly-webhook-controller"],"operationId":"ping","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}},"post":{"tags":["gladly-webhook-controller"],"operationId":"conversationEngineAsync_7","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/freshdesk/webhook":{"post":{"tags":["freshdesk-webhook-controller"],"operationId":"conversationEngineAsync_8","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/firebase/messages":{"get":{"tags":["firebase-rest-controller"],"operationId":"getResponse_2","parameters":[{"name":"requestId","in":"query","required":true,"schema":{"type":"string"}},{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":{}}}}}}}},"post":{"tags":["firebase-rest-controller"],"operationId":"conversationEngineAsync_9","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/facebook/webhook":{"get":{"tags":["facebook-webhook-controller"],"operationId":"subscribe_2","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}},{"name":"hub.mode","in":"query","required":true,"schema":{"type":"string"}},{"name":"hub.challenge","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}},"post":{"tags":["facebook-webhook-controller"],"operationId":"messagesPost_3","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/facebook/webhook/singtelRoamingActivation/updateTolerancePriorityCost":{"post":{"tags":["singtel-roaming-activation-webhook-controller"],"operationId":"updateTolerancePriorityCost","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/ceaas/messages":{"get":{"tags":["rest-api-controller"],"operationId":"getResponse_3","parameters":[{"name":"requestId","in":"query","required":true,"schema":{"type":"string"}},{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":{}}}}}}}},"post":{"tags":["rest-api-controller"],"operationId":"conversationEngineAsync_10","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/booking":{"post":{"tags":["booking-confirmation-controller"],"operationId":"bookingConfirmation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingConfirmationRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/authorize/visitors":{"post":{"tags":["visitor-authorize-webhook-controller"],"operationId":"messagesPost_4","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalAuthenticationRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/agentdesk/webhook":{"post":{"tags":["agent-desk-webhook-controller"],"operationId":"conversationEngineAsync_11","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/agentdesk/webhook/messages/poll":{"post":{"tags":["agent-desk-webhook-controller"],"operationId":"postResponse_2","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":{}}}}}}}}},"/v1/agentdesk/webhook/form/submit":{"post":{"tags":["agent-desk-webhook-controller"],"operationId":"submitForm","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentDeskFormRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/agentdesk/batch":{"post":{"tags":["agent-desk-rest-api-controller"],"operationId":"conversationEngineAsync_12","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/agentdesk/batch/poll":{"post":{"tags":["agent-desk-rest-api-controller"],"operationId":"postResponse_3","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}}}}}},"/v3/ceaas/messages":{"get":{"tags":["rest-api-controller-v-3"],"operationId":"getResponse_4","parameters":[{"name":"requestId","in":"query","required":true,"schema":{"type":"string"}},{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":{}}}}}}}}},"/v2/webhook/history/{conversationId}":{"get":{"tags":["generic-webhook-controller-v-2"],"operationId":"getConversationHistory","parameters":[{"name":"numberOfDays","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"name":"numberOfMessages","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}},{"name":"timestamp","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v2/ceaas/messages":{"get":{"tags":["rest-api-controller-v-2"],"operationId":"getResponse_5","parameters":[{"name":"requestId","in":"query","required":true,"schema":{"type":"string"}},{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":{}}}}}}}}},"/v1/zendesk-chat/re-activate":{"get":{"tags":["zen-desk-chat-rest-controller"],"operationId":"reActivate","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/zendesk-chat/de-activate":{"get":{"tags":["zen-desk-chat-rest-controller"],"operationId":"deActivate","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/zendesk-chat/check-status/{botRefId}":{"get":{"tags":["zen-desk-chat-rest-controller"],"operationId":"checkStatusAll","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}},{"name":"botRefId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/zendesk-chat/check-status-all":{"get":{"tags":["zen-desk-chat-rest-controller"],"operationId":"checkStatusAll_1","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/zendesk-chat/activate":{"get":{"tags":["zen-desk-chat-rest-controller"],"operationId":"activate","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/webhook/history/{conversationId}":{"get":{"tags":["generic-webhook-controller"],"operationId":"getConversationHistory_1","parameters":[{"name":"numberOfDays","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"name":"numberOfMessages","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":100}},{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}},"/v1/track":{"get":{"tags":["asset-tracker-controller"],"operationId":"assets","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}},{"name":"allRequestParams","in":"query","required":true,"schema":{"type":"object","additionalProperties":{"type":"string"}}}],"responses":{"200":{"description":"OK"}}}},"/v1/salesforce/webhook/messages":{"get":{"tags":["salesforce-webhook-controller"],"operationId":"getResponse_6","parameters":[{"name":"requestId","in":"query","required":true,"schema":{"type":"string"}},{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":{}}}}}}}}},"/v1/platform/status":{"get":{"tags":["platform-status-controller"],"operationId":"statusAPI","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}},{"name":"X-Hub-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Client-Id","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PlatformStatusResponse"}}}}}}},"/v1/oauth/redirect":{"get":{"tags":["oauth-token-redirect-controller"],"operationId":"oAuthRedirect","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}},{"name":"allRequestParams","in":"query","required":true,"schema":{"type":"object","additionalProperties":{}}}],"responses":{"200":{"description":"OK","content":{"text/html;charset=UTF-8":{"schema":{"type":"string"}}}}}}},"/v1/helpshift/quick-reply":{"get":{"tags":["helpshift-webhook-controller"],"operationId":"helpShiftQuickReply","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}},{"name":"requestId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/ceaas/historical/messages":{"get":{"tags":["rest-api-controller-v-3"],"operationId":"getHistoricalConversation","parameters":[{"name":"botId","in":"query","required":true,"schema":{"type":"string"}},{"name":"conversationId","in":"query","required":true,"schema":{"type":"string"}},{"name":"timeInterval","in":"query","required":true,"schema":{"type":"string"}},{"name":"originTime","in":"query","required":true,"schema":{"type":"string"}},{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":{}}}}}}}}},"/v1/agentdesk/webhook/messages":{"get":{"tags":["agent-desk-webhook-controller"],"operationId":"getResponse_7","parameters":[{"name":"requestId","in":"query","required":true,"schema":{"type":"string"}},{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":{}}}}}}}}},"/ceaas/v1/health/{secretId}":{"get":{"tags":["health-check-controller"],"operationId":"healthCheck","parameters":[{"name":"secretId","in":"path","required":true,"schema":{"type":"string"}},{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResponse"}}}}}}}},"components":{"schemas":{"RateLimitConfigRequestDto":{"type":"object","properties":{"minuteLimit":{"type":"integer","format":"int64"},"hourLimit":{"type":"integer","format":"int64"},"dayLimit":{"type":"integer","format":"int64"},"weekLimit":{"type":"integer","format":"int64"},"monthLimit":{"type":"integer","format":"int64"},"yearLimit":{"type":"integer","format":"int64"}}},"BaseError":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"}}},"ServiceResponse":{"type":"object","properties":{"statusCode":{"type":"string"},"statusMessage":{"type":"string"},"exceptionCode":{"type":"string","enum":["DATA_NOT_FOUND","INVALID_PAYMENT_MODE_ERROR","LINK_CANNOT_CREATED","OBJECT_DEEP_COPY_CLONE_FAILED_ERROR","API_EMPTY_PAYLOAD_ERROR","LANGUAGE_NOT_CONFIGURED","CLIENT_API_CREDENTIAL_MISSING_ERROR","CLIENT_API_CREDENTIAL_DOES_NOT_EXIST_ERROR","INVALID_PAYMENT_CARD_ERROR","INVALID_JOB_CLASS_NAME_ERROR","JOB_SCHEDULER_ERROR","DB_FETCH_ERROR","DB_INSERT_ERROR","DOWN_STREAM_SERVICE_ERROR","ILLEGAL_LINK_ID","DESERIALIZATION_FAILED_ERROR","SERIALIZATION_FAILED_ERROR","READING_FILE_FAILED_ERROR","INVALID_INPUT_ERROR","UN_SUPPORTED_OPERATION_ERROR","CONNECTION_TIME_OUT_ERROR","DRUID_QUERY_TIME_OUT_ERROR","AUTHENTICATION_FAILED_ERROR","AUTHORIZATION_FAILED_ERROR","HTTPS_SECURE_GATEWAY_ERROR","CONNECTION_REFUSED_ERROR","RESOURCE_NOT_FOUND_ERROR","ENCRYPTION_FAILED_ERROR","INPUT_DATA_CORRUPTED_ERROR","CONNECTION_RESET_ERROR","THROTTLE_ERROR","RATE_LIMIT_EXCEED_ERROR","UN_AUTHORISED_ERROR","CASSANDRA_DB_ERROR","MYSQL_DB_ERROR","KAFKA_BROKER_ERROR","DRUID_TRANQUILITY_SERVER_ERROR","INSTANTIATION_FAILED_ERROR","ILLEGAL_ACCESS_ERROR","DRUID_QUERY_BROKER_ERROR","UN_AUTHORISED_ACCESS","BAD_CREDENTIAL","ACCESS_TOKEN_EXPIRED","USER_DOES_NOT_EXIST","SIGN_UP_LINK_EXPIRED","RESET_PASSWORD_LINK_EXPIRED","USER_ACCOUNT_TEMPORARY_BLOCKED","LOGIN_SUCCESS","ILLEGAL_PERMISSION_ENTITY_ADDITION","NO_TWO_PERMISSION_ENITITY_EXCEPTION","ILLEGEAL_TOKEN_HEADER","NO_SECURITY_CONTEXT_HOLDER","UNAUTHORIZED_API_REQUEST","INVALID_ROLE","INSUFFICIENT_PERMISSION","MVEL_EXPRESSION_INVALID","MVEL_EXPRESSION_PROPERTY_MISSING","STANDARD_RESPONSE_EMPTY","TARGET_BUCKET_NOT_FOUND","TARGET_BUCKET_RESPONSE_NOT_FOUND","INSUFFICIENT_ATTRIBUTE","CONTEXT_RESPONSE_EMPTY","CONVERSATION_NULL","NULL_TOKEN_CREATED","USER_NOT_FOUND","WORKFLOW_NOT_FOUND","USER_NOT_ACTIVATED","INVALID_BOT_DETAILS","INVALID_CONF","INVALID_CONFIGURATION","COMPRESS_STRING_

# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/netomi/refs/heads/main/openapi/netomi-agentdesk-openapi.json