Created
August 6, 2026 10:16
-
-
Save vgrch/c9409c1297d145176fe51cb0d0f206d1 to your computer and use it in GitHub Desktop.
3CX call control
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "openapi": "3.0.4", | |
| "info": { | |
| "title": "3CX CALL CONTROL API V1", | |
| "description": "Call Control WebHook/REST API (DRAFT)", | |
| "version": "v1" | |
| }, | |
| "paths": { | |
| "/callcontrol/ws": { | |
| "get": { | |
| "tags": [ | |
| "CallControl" | |
| ], | |
| "operationId": "CallControl_Get", | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| }, | |
| "401": { | |
| "description": "Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "Application": [ ] | |
| } | |
| ] | |
| } | |
| }, | |
| "/callcontrol": { | |
| "get": { | |
| "tags": [ | |
| "CallControl" | |
| ], | |
| "operationId": "CallControl_GetFullInfo", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=false": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=true": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| } | |
| }, | |
| "text/plain": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=false": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=true": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| } | |
| }, | |
| "text/plain": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "Application": [ ] | |
| } | |
| ] | |
| } | |
| }, | |
| "/callcontrol/{dnnumber}": { | |
| "get": { | |
| "tags": [ | |
| "CallControl" | |
| ], | |
| "operationId": "CallControl_GetDNInfo", | |
| "parameters": [ | |
| { | |
| "name": "dnnumber", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=false": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=true": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| }, | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNInfo" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden" | |
| }, | |
| "401": { | |
| "description": "Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "Application": [ ] | |
| } | |
| ] | |
| } | |
| }, | |
| "/callcontrol/{dnnumber}/devices": { | |
| "get": { | |
| "tags": [ | |
| "CallControl" | |
| ], | |
| "operationId": "CallControl_GetDNDevices", | |
| "parameters": [ | |
| { | |
| "name": "dnnumber", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "403": { | |
| "description": "Forbidden" | |
| }, | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNDevice" | |
| } | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=false": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNDevice" | |
| } | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=true": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNDevice" | |
| } | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNDevice" | |
| } | |
| } | |
| }, | |
| "text/plain": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNDevice" | |
| } | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNDevice" | |
| } | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNDevice" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "Application": [ ] | |
| } | |
| ] | |
| } | |
| }, | |
| "/callcontrol/{dnnumber}/devices/{deviceid}": { | |
| "get": { | |
| "tags": [ | |
| "CallControl" | |
| ], | |
| "operationId": "CallControl_GetDNDevice", | |
| "parameters": [ | |
| { | |
| "name": "dnnumber", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "deviceid", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNDevice" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=false": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNDevice" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=true": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNDevice" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNDevice" | |
| } | |
| }, | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNDevice" | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNDevice" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNDevice" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| }, | |
| "401": { | |
| "description": "Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "Application": [ ] | |
| } | |
| ] | |
| } | |
| }, | |
| "/callcontrol/{dnnumber}/participants": { | |
| "get": { | |
| "tags": [ | |
| "CallControl" | |
| ], | |
| "operationId": "CallControl_GetDNParticipants", | |
| "parameters": [ | |
| { | |
| "name": "dnnumber", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNCallParticipant" | |
| } | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=false": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNCallParticipant" | |
| } | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=true": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNCallParticipant" | |
| } | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNCallParticipant" | |
| } | |
| } | |
| }, | |
| "text/plain": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNCallParticipant" | |
| } | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNCallParticipant" | |
| } | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNCallParticipant" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden" | |
| }, | |
| "401": { | |
| "description": "Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "Application": [ ] | |
| } | |
| ] | |
| } | |
| }, | |
| "/callcontrol/{dnnumber}/participants/{id}": { | |
| "get": { | |
| "tags": [ | |
| "CallControl" | |
| ], | |
| "operationId": "CallControl_GetDNParticipant", | |
| "parameters": [ | |
| { | |
| "name": "dnnumber", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallParticipant" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=false": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallParticipant" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=true": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallParticipant" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallParticipant" | |
| } | |
| }, | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallParticipant" | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallParticipant" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallParticipant" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| }, | |
| "401": { | |
| "description": "Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "Application": [ ] | |
| } | |
| ] | |
| } | |
| }, | |
| "/callcontrol/{dnnumber}/makecall": { | |
| "post": { | |
| "tags": [ | |
| "CallControl" | |
| ], | |
| "operationId": "CallControl_MakeCallFromDN", | |
| "parameters": [ | |
| { | |
| "name": "dnnumber", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/CallControlRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=false": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=true": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "202": { | |
| "description": "Accepted", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=false": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=true": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden" | |
| }, | |
| "422": { | |
| "description": "Unprocessable Content" | |
| }, | |
| "424": { | |
| "description": "Failed Dependency", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=false": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=true": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "Application": [ ] | |
| } | |
| ] | |
| } | |
| }, | |
| "/callcontrol/{dnnumber}/devices/{deviceid}/makecall": { | |
| "post": { | |
| "tags": [ | |
| "CallControl" | |
| ], | |
| "operationId": "CallControl_MakeCallFromDevice", | |
| "parameters": [ | |
| { | |
| "name": "dnnumber", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "deviceid", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/CallControlRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=false": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=true": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "202": { | |
| "description": "Accepted", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=false": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=true": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden" | |
| }, | |
| "422": { | |
| "description": "Unprocessable Content" | |
| }, | |
| "424": { | |
| "description": "Failed Dependency", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=false": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=true": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "Application": [ ] | |
| } | |
| ] | |
| } | |
| }, | |
| "/callcontrol/{dnnumber}/participants/{id}/stream": { | |
| "get": { | |
| "tags": [ | |
| "CallControl" | |
| ], | |
| "operationId": "CallControl_GetRTstream", | |
| "parameters": [ | |
| { | |
| "name": "dnnumber", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "404": { | |
| "description": "Not Found" | |
| }, | |
| "403": { | |
| "description": "Forbidden" | |
| }, | |
| "424": { | |
| "description": "Failed Dependency" | |
| }, | |
| "401": { | |
| "description": "Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "Application": [ ] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "CallControl" | |
| ], | |
| "operationId": "CallControl_PostRTstream", | |
| "parameters": [ | |
| { | |
| "name": "dnnumber", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| }, | |
| "403": { | |
| "description": "Forbidden" | |
| }, | |
| "424": { | |
| "description": "Failed Dependency" | |
| }, | |
| "401": { | |
| "description": "Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "Application": [ ] | |
| } | |
| ] | |
| } | |
| }, | |
| "/callcontrol/{dnnumber}/participants/{id}/playprompt": { | |
| "post": { | |
| "tags": [ | |
| "CallControl" | |
| ], | |
| "operationId": "CallControl_DTMFDialogue", | |
| "parameters": [ | |
| { | |
| "name": "dnnumber", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DTMFDialogueRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=false": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=true": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "202": { | |
| "description": "Accepted", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=false": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=true": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| }, | |
| "422": { | |
| "description": "Unprocessable Content" | |
| }, | |
| "501": { | |
| "description": "Not Implemented" | |
| }, | |
| "424": { | |
| "description": "Failed Dependency", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=false": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=true": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "Application": [ ] | |
| } | |
| ] | |
| } | |
| }, | |
| "/callcontrol/{dnnumber}/participants/{id}/{callaction}": { | |
| "post": { | |
| "tags": [ | |
| "CallControl" | |
| ], | |
| "operationId": "CallControl_ControlParticipant", | |
| "parameters": [ | |
| { | |
| "name": "dnnumber", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "callaction", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/CallControlRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=false": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=true": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "202": { | |
| "description": "Accepted", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=false": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=true": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| }, | |
| "422": { | |
| "description": "Unprocessable Content" | |
| }, | |
| "424": { | |
| "description": "Failed Dependency", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=false": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/json;IEEE754Compatible=true": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DNCallControlResultResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "Application": [ ] | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "components": { | |
| "schemas": { | |
| "CallControlRequest": { | |
| "type": "object", | |
| "properties": { | |
| "reason": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "destination": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "timeout": { | |
| "type": "integer", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "attacheddata": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CallParticipant": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "status": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "party_caller_name": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "party_dn": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "party_caller_id": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "device_id": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "party_dn_type": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "direct_control": { | |
| "type": "boolean" | |
| }, | |
| "callid": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "legid": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "dn": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "DNCallControlResultResponse": { | |
| "type": "object", | |
| "properties": { | |
| "finalstatus": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "reason": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "result": { | |
| "$ref": "#/components/schemas/DNCallParticipant" | |
| }, | |
| "reasontext": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "DNCallParticipant": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "status": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "dn": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "party_caller_name": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "party_dn": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "party_caller_id": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "party_did": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "device_id": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "party_dn_type": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "direct_control": { | |
| "type": "boolean" | |
| }, | |
| "originated_by_dn": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "originated_by_type": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "referred_by_dn": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "referred_by_type": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "on_behalf_of_dn": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "on_behalf_of_type": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "callid": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "legid": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "DNDevice": { | |
| "type": "object", | |
| "properties": { | |
| "dn": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "device_id": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "user_agent": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "DNInfo": { | |
| "type": "object", | |
| "properties": { | |
| "dn": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "type": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "devices": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DNDevice" | |
| }, | |
| "nullable": true | |
| }, | |
| "participants": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CallParticipant" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "DTMFDialogueRequest": { | |
| "type": "object", | |
| "properties": { | |
| "prompt_id": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "promptset": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "files": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "nullable": true | |
| }, | |
| "interdigit_timeout": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "no_input_timeout": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| "additionalProperties": false | |
| } | |
| }, | |
| "securitySchemes": { | |
| "Application": { | |
| "type": "oauth2", | |
| "description": "Use service principal credentials created via Admin/Integrations/API", | |
| "flows": { | |
| "clientCredentials": { | |
| "tokenUrl": "/connect/token", | |
| "scopes": { } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| { | |
| "name": "CallControl" | |
| } | |
| ] | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment