OpenAPI MCP Server

{ "openapi": "3.0.1", "info": { "title": "Default module", "description": "", "version": "1.0.0" }, "tags": [ { "name": "ReadOnlyDomain" } ], "paths": { "/domains/~/users/list": { "get": { "summary": "List Basic Info on Users in Domain", "deprecated": false, "description": "", "operationId": "ListUsers", "tags": [ "ReadOnlyDomain" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicUserInfo" }, "example": [ { "user": "1001", "domain": "example", "site": "", "name-first-name": "example SU", "name-last-name": "test", "department": "", "directory-name-number-dtmf-mapping": 837 }, { "user": "1002", "domain": "example", "site": "", "name-first-name": "example", "name-last-name": "test", "department": "", "directory-name-number-dtmf-mapping": 837 }, { "user": "1003", "domain": "example", "site": "", "name-first-name": "example another", "name-last-name": "test", "department": "", "directory-name-number-dtmf-mapping": 837 }, { "user": "2002", "domain": "example", "site": "", "name-first-name": "test", "name-last-name": "user", "department": "department example 2", "directory-name-number-dtmf-mapping": 873 }, { "user": "5555", "domain": "example", "site": "", "name-first-name": "s", "name-last-name": "s", "department": "", "directory-name-number-dtmf-mapping": 7 }, { "user": "9999", "domain": "example", "site": "", "name-first-name": "example", "name-last-name": "user", "department": "", "directory-name-number-dtmf-mapping": 873 } ] } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 404, "message": "Domain example does not exist" } } }, "headers": {} }, "x-404:Record not found": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/~/callqueues/list": { "get": { "summary": "Read Basic info on Call Queues in Domain", "deprecated": false, "description": "", "operationId": "ListCallqueues", "tags": [ "ReadOnlyDomain" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CallQueue" } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "x-400:Bad Request": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } } }, "components": { "schemas": { "CallQueue": { "type": "object", "properties": { "callqueue": { "type": "string", "description": "This is the main call queue extension which is the identifier for this call quieue. " }, "domain": { "$ref": "#/components/schemas/DomainName" }, "description": { "type": "string", "description": "This is a simple description of the callqueue which can be used to better explain the use or purpose of this call queue. " }, "callqueue-dispatch-type": { "type": "string", "description": "This is the main dispatch type for hunting agents. The options are described below. \n#Round-robin\n#Tiered Round-robin\n#Ring All\n#Linear Cascade\n#Linear Hunt\n#Call Park\n", "title": "", "enum": [ "Round-robin", "Tiered Round-robin", "Ring All", "Linear Cascade", "Linear Hunt", "Call Park" ] }, "callqueue-calculate-statistics": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will allow stats to be calculated. " }, "active-queued-calls-total-current": { "type": "integer", "description": "This is the current calls waiting in the call queue waiting to be dispatched. ", "readOnly": true }, "callqueue-agent-dispatch-timeout-seconds": { "type": "integer", "description": "This is the timeout in seconds the call queue will attempt an agent before timing out and retrying additional resources." }, "callqueue-count-agents-available": { "type": "integer", "description": "This is the current number of agents logged in and available for work. ", "readOnly": true }, "callqueue-count-agents-total": { "type": "integer", "description": "This is the current number of agents configured for this callqueue. " }, "callqueue-debug": { "$ref": "#/components/schemas/YesNoString", "description": "Enable debug only when wanting more detailed trace to troublehsoot dispatching issues with agent. Will enable per agent status logging at the time of dispatch showing in more detail why agents were and were not selected. " }, "callqueue-force-full-intro-playback": { "$ref": "#/components/schemas/YesNoString", "description": "Enable to force the first MOH file to be played completly before attempting to dispatch the caller. This allows for a message to be played in full if needed. " }, "callqueue-max-callback-queueing-hours": { "type": "integer", "description": "This setting will allow callback's in the callqueue allowing callers to press a buton and opt for a callback instead of waiting. 0 the default is off, any other positive number will enable callback and allow callback up to that many hours after the callback is requested. ", "default": 0, "minimum": 0, "maximum": 6 }, "callqueue-max-current-callers-to-accept-new-callers": { "type": "integer", "description": "This setting is the maximum number of callers allowed in the queue before forward busy answer rules will be followed. 0 is unlimited", "minimum": 0, "default": 0 }, "callqueue-max-current-wait-to-accept-new-callers-seconds": { "type": "integer", "description": "This setting is the maximum expected wait time allowed in the queue before forward busy answer rules will be followed. 0 is unlimited", "minimum": 0, "default": 0 }, "callqueue-max-wait-timeout-minutes": { "type": "integer", "description": "This is the max wait time in minutes that it would allow a call to wait before being forced out of the queue. 0 is unlimited", "default": 0, "minimum": 0 }, "callqueue-require-available-agents-to-accept-new-callers": { "$ref": "#/components/schemas/YesNoStringNoDefault", "description": "When enabled this setting will require at least 1 agent to be in a logged in status in order to start queuing the call, if no agents are logged in then the call will be forwarded to answer rules. " }, "callqueue-source-match": { "type": "string", "description": "This is a optional setting that will control the source match for the forward dispatch leg of calls allowing if needed different matches to connecting devices when calls come through the queue. ", "nullable": true }, "callqueue-sms-enable": { "$ref": "#/components/schemas/YesNoStringNoDefault", "description": "When enabled this setting will open up SMS queue options for the queue including support for the features/fields below. " }, "recording-configuration": { "$ref": "#/components/schemas/RecordingConfiguration" }, "callqueue-sms-phrase-initiate-chat": { "type": "string", "description": "This is the keyword that will be the trigger for a new SMS queueing session ", "nullable": true }, "callqueue-sms-phrase-initiate-success": { "type": "string", "description": "The message to auto reply to a inbound SMS message once the trigger keyword is detected", "nullable": true }, "callqueue-sms-phrase-initiation-fail ": { "type": "string", "description": "The message that will be auto replied when a message wihtout the keywork is detected. ", "nullable": true }, "callqueue-sms-phrase-no-agents-available": { "type": "string", "description": "The message that will be auto replied when there are no agents available and the system is unable to setup a sms chat session at this time. ", "nullable": true }, "callqueue-sms-phrase-terminate-chat": { "type": "string", "description": "This is the keyword that will be the trigger to end a active SMS session. ", "nullable": true }, "callqueue-sms-phrase-terminate-success": { "type": "string", "description": "The message that will be played after a successfully termination of a session via a keyword. ", "nullable": true }, "callqueue-agent-auto-logout-after-missed": { "$ref": "#/components/schemas/YesNoStringNoDefault", "description": "When enabled this setting will trigger the core switch to logout the agent from the queue if they miss a call dispatched to them. " }, "callqueue-sim-ring-1st-round": { "type": "integer", "description": "When using a callqueue-dispatch-type value that allows for mutlple agents to be run on at a time this setting controls the amount of agents that are dispatched in the first round.", "minimum": 0, "maximum": 99, "default": 0 }, "callqueue-sim-ring-increment": { "type": "integer", "description": "When using a callqueue-dispatch-type value that allows for mutlple agents to be run on at a time this setting controls the amount of agents that will be added to the group activly ringing at each agent timeout level. ", "minimum": 0, "maximum": 99, "default": 1 } }, "required": [ "domain", "callqueue" ] }, "PublicUserInfo": { "type": "array", "items": { "type": "object", "properties": { "user": { "type": "string" }, "domain": { "type": "string" }, "site": { "type": "string" }, "name-first-name": { "type": "string" }, "name-last-name": { "type": "string" }, "department": { "type": "string" }, "directory-name-number-dtmf-mapping": { "type": "integer" } } } }, "YesNoString": { "type": "string", "enum": [ "yes", "no" ] }, "YesNoStringNoDefault": { "type": "string", "enum": [ "yes", "no" ], "default": "no" }, "DomainName": { "type": "string", "description": "This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (\\*). ", "pattern": "^[A-Za-z0-9._-]+|\\*", "maxLength": 64, "example": "example.com" }, "ErrorResponse": { "type": "object", "properties": { "code": { "type": "integer", "description": "This is the HTTP error code that was returned." }, "message": { "type": "string", "description": "This is a more detailed description of what the error was and any potential correction steps. " } }, "required": [ "code", "message" ] }, "RecordingConfiguration": { "type": "string", "description": "Option whether to record calls or not. Available options are \"yes\", \"yes-with-transcription\", \"yes-with-transcription-and-sentiment\", or \"no\"", "enum": [ "yes", "yes-with-transcription", "yes-with-transcription-and-sentiment", "no" ], "default": "no" } }, "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer" } } }, "servers": [], "security": [ { "bearer": [] } ] }