UCaaS Connector API

https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/
Admin
UCaaS Connector API is a cloud communications API for Enghouse products that enables call...
Tokens:84,720
Snippets:192
Trust Score:3.8
Update:10 months ago
Show doc for...
Tokens:
Raw
### Start Recording

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

Initiates a recording for a specific interaction. This endpoint supports various media types and recording modes.

```APIDOC
## POST /api/recordings/start

### Description
Initiates a recording for a specific interaction. This endpoint supports various media types and recording modes.

### Method
POST

### Endpoint
/api/recordings/start

### Parameters
#### Request Body
- **mode** (string) - Required - The recording mode (mono or stereo).
- **mediatypes** (array) - Optional - The media types to record (audio, video, any).
- **stereoTrackingParticipantId** (string) - Optional - The id of the participant to focus on for stereo recording.
- **mimeType** (string) - Optional - The mime type to use for recording. Possible values are platform-specific.
- **fileExtension** (string) - Optional - The file extension to use for recording file.
- **requestOriginURL** (string) - Optional - Consumers can use this field to specifiy a URL that will be returned in the response.
- **requestId** (string) - Optional - Identifier of the request. Can be provided by the consumer or generated by the system.
- **platformSpecificParameters** (object) - Optional - A JSON structure containing platform-specific parameters for the operation.
- **endpointId** (string) - Optional - A unique identifier for the caller(source) endpoint.
- **interactionId** (string) - Optional - The interaction to record

### Request Example
```json
{
  "mode": "stereo",
  "mediatypes": ["audio", "video"],
  "interactionId": "interaction123",
  "endpointId": "endpoint456"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success status of the operation.

#### Response Example
```json
{
  "status": "Recording started successfully"
}
```
```

--------------------------------

### POST /utilities/ttsInputMenu

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

Starts a TTS-based input menu on the call. The menu will play TTS messages and collect DTMF input from the caller.

```APIDOC
## POST /utilities/ttsInputMenu

### Description
Starts a TTS-based input menu on the call. The menu will play TTS messages and collect DTMF input from the caller.

### Method
POST

### Endpoint
/utilities/ttsInputMenu

### Parameters
#### Request Body
- **endpointId** (string) - Required - The endpoint which will start the input menu.
- **interactionId** (string) - Required - The audio interaction where the menu will execute.
- **initialMessage** (string) - Optional - The message to play when the menu starts.
- **noInputMessage** (string) - Optional - The message to be played if no input is received (the initial message is the default, if defined).
- **badInputMessage** (string) - Optional - The message to be played if bad input is received (the initial message is the default, if defined).
- **minDigitCount** (integer) - Optional - Minimum number of dtmf digits to receive.
- **maxDigitCount** (integer) - Optional - Maximum number of dtmf digits to receive.
- **terminatingDigit** (string) - Optional - Specific terminating digit to end the input menu (allows results of less than maxDigitCount).
- **firstDigitTimeoutInSec** (integer) - Optional - First digit input timeout. Starts after playing the initial prompt (cancels the menu with reason=noInput on timeout).
- **nextDigitTimeoutInSec** (integer) - Optional - Next digit input timeout. Starts after the previous digit has been received (cancels the menu with reason=badInput on timeout).
- **noInputRetries** (integer) - Optional - Number of 'no input' retries (default is 0).
- **badInputRetries** (integer) - Optional - Number of 'bad input' retries (default is 0).
- **digitStopsMessage** (boolean) - Optional - Enables interrupting the first prompt by receiving a dtmf digit (default is false).
- **inputBufferEnabled** (boolean) - Optional - Enables the input buffer: considers digits pressed before the start of the menu as input. If disabled, any existing buffer will be cleared so any following menus can’t use them.

### Request Example
```json
{
  "endpointId": "string",
  "interactionId": "string",
  "initialMessage": "string",
  "noInputMessage": "string",
  "badInputMessage": "string",
  "minDigitCount": 0,
  "maxDigitCount": 0,
  "terminatingDigit": "string",
  "firstDigitTimeoutInSec": 0,
  "nextDigitTimeoutInSec": 0,
  "noInputRetries": 0,
  "badInputRetries": 0,
  "digitStopsMessage": true,
  "inputBufferEnabled": true
}
```

### Response
#### Success Response (201)
- **description** (string) - Indicates the resource was created successfully.
```

--------------------------------

### GET /endpoints

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

Gets information about all endpoints.

```APIDOC
## GET /endpoints

### Description
Gets information about all available endpoints.

### Method
GET

### Endpoint
/endpoints

### Parameters
#### Query Parameters
- **endpointType** (string) - Optional. Filters endpoints by type. Allowed values: "unknown"

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **endpoints** (array) - A list of endpoint objects.
  - **name** (string) - The name of the endpoint.
  - **type** (string) - The type of the endpoint.

#### Response Example
{
  "endpoints": [
    {
      "name": "GetMetrics",
      "type": "metrics"
    },
    {
      "name": "GetServiceInfo",
      "type": "diagnostics"
    }
  ]
}
```

--------------------------------

### POST /websites/engdev-1_eis-dev_enghouse-ops_net_ucaas-connector_cxengage-1_0/interactions/{interactionId}/menus

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

Initiates an input menu on a specified audio interaction. This endpoint allows for custom prompts, input validation, and timeouts to guide user interaction.

```APIDOC
## POST /interactions/{interactionId}/menus

### Description
Initiates an input menu on a specified audio interaction. This endpoint allows for custom prompts, input validation, and timeouts to guide user interaction.

### Method
POST

### Endpoint
`/interactions/{interactionId}/menus`

### Parameters
#### Path Parameters
- **interactionId** (string) - Required - The audio interaction where the menu will execute.

#### Query Parameters
- **endpointId** (string) - Required - The endpoint which will start the input menu.

#### Request Body
- **initialMessage** (array) - Optional - The message to play when the menu starts. This is a list of TTS and/or audio files.
- **noInputMessage** (array) - Optional - The message to be played if no input is received (the initial message is the default, if defined). This is a list of TTS and/or audio files.
- **badInputMessage** (array) - Optional - The message to be played if bad input is received (the initial message is the default, if defined). This is a list of TTS and/or audio files.
- **minDigitCount** (integer) - Optional - Minimum number of dtmf digits to receive.
- **maxDigitCount** (integer) - Optional - Maximum number of dtmf digits to receive.
- **terminatingDigit** (string) - Optional - Specific terminating digit to end the input menu (allows results of less than maxDigitCount).
- **firstDigitTimeoutInSec** (integer) - Optional - First digit input timeout. Starts after playing the initial prompt (cancels the menu with reason=noInput on timeout).
- **nextDigitTimeoutInSec** (integer) - Optional - Next digit input timeout. Starts after the previous digit has been received (cancels the menu with reason=badInput on timeout).
- **noInputRetries** (integer) - Optional - Number of 'no input' retries (default is 0).
- **badInputRetries** (integer) - Optional - Number of 'bad input' retries (default is 0).
- **digitStopsMessage** (boolean) - Optional - Enables interrupting the first prompt by receiving a dtmf digit (default is false).
- **inputBufferEnabled** (boolean) - Optional - Enables the input buffer: considers digits pressed before the start of the menu as input. If disabled, any existing buffer will be cleared so any following menus can’t use them either (default value is false).
- **requestOriginURL** (string) - Optional - An optional URL from the requester to be included in the response. To be used by man-in-the-middle components such as load balancers.
- **requestId** (string) - Optional - Request unique identifier to be included in the response.
- **platformSpecificParameters** (object) - Optional - A JSON structure containing platform-specific parameters for the operation.

### Request Example
```json
{
  "endpointId": "ivr-endpoint-123",
  "initialMessage": [
    {
      "type": "tts",
      "text": "Welcome to our service."
    }
  ],
  "maxDigitCount": 4,
  "terminatingDigit": "#"
}
```

### Response
#### Success Response (200)
- **interactionId** (string) - The ID of the interaction.
- **status** (string) - The status of the menu operation.

#### Response Example
```json
{
  "interactionId": "interaction-abc-789",
  "status": "success"
}
```

#### Error Handling
- **400 Bad Request**: Returned if the request is malformed or contains invalid parameters. The response body will contain details about the error.

```

--------------------------------

### Utilities API

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/index

Provides utility functions for call interactions, including starting and stopping media operations and input menus.

```APIDOC
## POST /utilities/promptInputMenu

### Description
Starts a prompt-based input menu on the call. The menu will play prompts and collect DTMF input from the caller.

### Method
POST

### Endpoint
/utilities/promptInputMenu

### Parameters
#### Request Body
- **interactionId** (string) - Required - The ID of the interaction.
- **prompts** (array) - Required - A list of prompts to play.
- **maxDigits** (integer) - Optional - The maximum number of digits to collect.

### Request Example
```json
{
  "interactionId": "int-12345",
  "prompts": [
    "Please enter your account number."
  ],
  "maxDigits": 10
}
```

### Response
#### Success Response (200)
- **menuOperationId** (string) - The ID of the input menu operation.

#### Response Example
```json
{
  "menuOperationId": "menu-prompt-11111"
}
```

## POST /utilities/ttsInputMenu

### Description
Starts a TTS-based input menu on the call. The menu will play TTS messages and collect DTMF input from the caller.

### Method
POST

### Endpoint
/utilities/ttsInputMenu

### Parameters
#### Request Body
- **interactionId** (string) - Required - The ID of the interaction.
- **ttsMessages** (array) - Required - A list of TTS messages to play.
- **maxDigits** (integer) - Optional - The maximum number of digits to collect.

### Request Example
```json
{
  "interactionId": "int-12345",
  "ttsMessages": [
    "For English, press 1. Para Español, oprima dos."
  ],
  "maxDigits": 1
}
```

### Response
#### Success Response (200)
- **menuOperationId** (string) - The ID of the input menu operation.

#### Response Example
```json
{
  "menuOperationId": "menu-tts-22222"
}
```

## POST /utilities/mixedMediaInputMenu

### Description
Starts a mixed media-based input menu on the call. The menu will play lists of TTS and/or prompt messages and collect DTMF input from the caller.

### Method
POST

### Endpoint
/utilities/mixedMediaInputMenu

### Parameters
#### Request Body
- **interactionId** (string) - Required - The ID of the interaction.
- **mediaItems** (array) - Required - A list of media items (TTS messages or prompts).
- **maxDigits** (integer) - Optional - The maximum number of digits to collect.

### Request Example
```json
{
  "interactionId": "int-12345",
  "mediaItems": [
    { "type": "tts", "text": "Please choose an option." },
    { "type": "prompt", "promptId": "welcome_prompt" }
  ],
  "maxDigits": 5
}
```

### Response
#### Success Response (200)
- **menuOperationId** (string) - The ID of the input menu operation.

#### Response Example
```json
{
  "menuOperationId": "menu-mixed-33333"
}
```

## POST /utilities/stop

### Description
Stops any running media operation (prompt, tts, record message, recording etc).

### Method
POST

### Endpoint
/utilities/stop

### Parameters
#### Request Body
- **interactionId** (string) - Required - The ID of the interaction.

### Request Example
```json
{
  "interactionId": "int-12345"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Media operation stopped."
}
```
```

--------------------------------

### POST /recordings/start

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

Starts recording an interaction, such as a call or conference. It allows specifying the endpoint, interaction ID, recording mode, media types, and optional parameters like MIME type and file extension.

```APIDOC
## POST /recordings/start

### Description
Starts recording an interaction (call or conference).

### Method
POST

### Endpoint
/recordings/start

### Parameters
#### Request Body
- **endpointId** (string) - Required - The endpoint identifier that will start the recording.
- **interactionId** (string) - Required - The interaction to answer.
- **mode** (string) - Required - The recording mode (mono or stereo).
- **mediaTypes** (string) - Required - The media types to record (audio, video, any).
- **stereoTrackingParticipantId** (string) - Required - The media types to record (audio, video, any).
- **mimeType** (string) - Optional - The mime type to use for recording. Possible values are platform-specific. If unspecified, a default value will be provided.
- **fileExtension** (string) - Optional - The file extension to use for the recording file. Default values depend on mime type. If unspecified, a default value will be provided.
- **requestOriginURL** (string) - Optional - An optional URL from the requester to be included in the response. To be used by man-in-the-middle components such as load balancers.
- **requestId** (string) - Optional - Request unique identifier to be included in the response.
- **platformSpecificParameters** (object) - Optional - A JSON structure containing platform-specific parameters for the operation.

### Request Example
```json
{
  "endpointId": "some-endpoint-id",
  "interactionId": "some-interaction-id",
  "mode": "stereo",
  "mediaTypes": "audio",
  "stereoTrackingParticipantId": "participant-id",
  "mimeType": "audio/wav",
  "fileExtension": ".wav",
  "requestOriginURL": "http://example.com/origin",
  "requestId": "unique-request-id",
  "platformSpecificParameters": {}
}
```

### Response
#### Success Response (200)
- **InteractionActionFlags** (object) - Action success. Returns the interaction action flags

#### Error Response (400)
- **ProblemDetails** (object) - Bad Request, check the returned error

#### Error Response (401)
- **ProblemDetails** (object) - Unauthorized, the request lacks a valid authentication token

#### Error Response (403)
- **N/A** - Forbidden, action not allowed

#### Error Response (500)
- **N/A** - Internal Server Error
```

--------------------------------

### Start Recording

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

Initiates a call recording operation. This endpoint allows configuration of various recording parameters such as prompts, duration, silence timeouts, and file formats.

```APIDOC
## POST /recordings/start

### Description
Initiates a call recording operation with configurable parameters.

### Method
POST

### Endpoint
/recordings/start

### Parameters
#### Request Body
- **platformSpecificParameters** (object) - Optional - A JSON structure containing platform-specific parameters for the operation.
- **endpointId** (string) - Optional - Unique identifier of the endpoint which will start the recording.
- **interactionId** (string) - Optional - The interaction the call belongs to.
- **prompts** (array) - Optional - List of prompts to play before starting the recording.
  - **items** (object, ref: '#/components/schemas/MediaInfo') - Media information for prompts.
- **maxLengthInSec** (integer) - Optional - Maximum length of the recording. Default = 120 (2 minutes).
- **initialSilenceTimeoutInSec** (integer) - Optional - Maximum initial silence allowed before timeout. Default = 5 seconds, Min = 1, Max = 120.
- **maxSilenceTimeoutInSec** (integer) - Optional - Maximum silence allowed after user starts speaking. Default = 5 seconds, Min = 1, Max = 120.
- **playBeep** (boolean) - Optional - If true, plays a beep to indicate the user can start recording. Default = true.
- **terminatingCharacters** (string) - Optional - Stop tones specified to end recording. Accepts 'any'.
- **mimeType** (string) - Optional - The mime type to use for recording. Platform-specific.
- **fileExtension** (string) - Optional - The file extension for the recording file. Default depends on mime type.

### Request Example
```json
{
  "maxLengthInSec": 180,
  "playBeep": false,
  "terminatingCharacters": "#"
}
```

### Response
#### Success Response (200)
- **recordingId** (string) - Unique identifier for the initiated recording.
- **status** (string) - The status of the recording operation.
```

--------------------------------

### GET /diagnostics/info

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

Returns service information (ex: version, tenant, image...). Use with caution: calling this method too frequently may impact performance.

```APIDOC
## GET /diagnostics/info

### Description
Returns service information (e.g., version, tenant, image). Use with caution: calling this method too frequently may impact performance.

### Method
GET

### Endpoint
/diagnostics/info

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **serviceInfo** (object) - An object containing service details.

#### Response Example
{
  "version": "1.0.0",
  "tenant": "main",
  "image": "englis.net/ucaas-connector:1.0"
}
```

--------------------------------

### GET /diagnostics/metrics

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

Returns Memory, CPU, threads, IPv4 and other metrics. Use with caution: calling this method too frequently may impact performance.

```APIDOC
## GET /diagnostics/metrics

### Description
Returns Memory, CPU, threads, IPv4 and other metrics. Use with caution: calling this method too frequently may impact performance.

### Method
GET

### Endpoint
/diagnostics/metrics

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **metrics** (object) - An object containing various system metrics.

#### Response Example
{
  "memory": {
    "total": 16777216,
    "available": 10485760
  },
  "cpu": {
    "cores": 4,
    "usage": 0.25
  },
  "threads": {
    "total": 150,
    "active": 50
  },
  "ipv4": [
    "192.168.1.100",
    "10.0.0.5"
  ]
}
```

--------------------------------

### Recording Management API

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/index

Endpoints for starting, pausing, resuming, and stopping call recordings.

```APIDOC
## POST /recordings/start

### Description
Starts recording an interaction (call or conference).

### Method
POST

### Endpoint
/recordings/start

### Parameters
#### Query Parameters
- **interactionId** (string) - Required - The ID of the interaction to record.

### Request Example
```json
{
  "interactionId": "int123"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}

```

```APIDOC
## POST /recordings/pause

### Description
Pauses the ongoing recording.

### Method
POST

### Endpoint
/recordings/pause

### Parameters
#### Query Parameters
- **interactionId** (string) - Required - The ID of the interaction whose recording should be paused.

### Request Example
```json
{
  "interactionId": "int123"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}

```

```APIDOC
## POST /recordings/resume

### Description
Resumes recording.

### Method
POST

### Endpoint
/recordings/resume

### Parameters
#### Query Parameters
- **interactionId** (string) - Required - The ID of the interaction whose recording should be resumed.

### Request Example
```json
{
  "interactionId": "int123"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}

```

```APIDOC
## POST /recordings/stop

### Description
Stops the ongoing recording.

### Method
POST

### Endpoint
/recordings/stop

### Parameters
#### Query Parameters
- **interactionId** (string) - Required - The ID of the interaction whose recording should be stopped.

### Request Example
```json
{
  "interactionId": "int123"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}

```

--------------------------------

### Input Menu API

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

This endpoint allows the consumer to start an input menu, enabling users to provide input via DTMF digits. It supports various configurations for digit collection, timeouts, and retry mechanisms.

```APIDOC
## POST /websites/engdev-1_eis-dev_enghouse-ops_net_ucaas-connector_cxengage-1_0/inputMenu

### Description
Initiates an input menu for user interaction, allowing DTMF digit collection with configurable parameters.

### Method
POST

### Endpoint
/websites/engdev-1_eis-dev_enghouse-ops_net_ucaas-connector_cxengage-1_0/inputMenu

### Parameters
#### Request Body
- **PromptInputMenuArgs** (object) - Required - Arguments for starting an input menu.
  - **requestOriginURL** (string) - Optional - URL to be returned in the response.
  - **requestId** (string) - Optional - Identifier for the request.
  - **platformSpecificParameters** (object) - Optional - Platform-specific parameters.
  - **endpointId** (string) - Optional - Unique identifier of the endpoint.
  - **interactionId** (string) - Optional - The audio interaction ID.
  - **minDigitCount** (integer) - Optional - Minimum number of DTMF digits to receive (default is 1).
  - **maxDigitCount** (integer) - Optional - Maximum number of DTMF digits to receive (default is 1).
  - **terminatingDigit** (string) - Optional - Specific terminating digit to end the input menu.
  - **firstDigitTimeoutInSec** (integer) - Optional - Timeout for the first digit input (default is 10s).
  - **nextDigitTimeoutInSec** (integer) - Optional - Timeout for subsequent digit inputs (default is 5s).
  - **noInputRetries** (integer) - Optional - Number of 'no input' retries (default is 0).
  - **badInputRetries** (integer) - Optional - Number of 'bad input' retries (default is 0).
  - **digitStopsMessage** (boolean) - Optional - If true, digits interrupt messages (default is false).
  - **inputBufferEnabled** (boolean) - Optional - Enables input buffer (default is false).
  - **initialMessage** (MediaInfo) - Optional - The initial message to play.
  - **noInputMessage** (MediaInfo) - Optional - The message to play on no input.
  - **badInputMessage** (MediaInfo) - Optional - The message to play on bad input.

### Request Example
```json
{
  "endpointId": "ivr-endpoint-123",
  "interactionId": "interaction-abc-456",
  "maxDigitCount": 4,
  "terminatingDigit": "#",
  "initialMessage": {
    "type": "text",
    "content": "Please enter your account number."
  }
}
```

### Response
#### Success Response (200)
- **Result** (object) - The result of the input menu operation.
  - **type** (string) - Type of result (e.g., "digits", "timeout", "cancel").
  - **digits** (string) - The collected digits, if applicable.
  - **reason** (string) - Reason for the result (e.g., "noInput", "badInput"), if applicable.

#### Response Example
```json
{
  "Result": {
    "type": "digits",
    "digits": "1234"
  }
}
```
```

--------------------------------

### Define Recording Control Parameters (JSON Schema)

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

Defines boolean parameters for controlling audio and video recording, including start, stop, pause, and resume actions. These are typically used in API requests to manage recording sessions.

```json
{
  "type": "object",
  "properties": {
    "startRecordingAudio": {"type": "boolean"},
    "stopRecordingAudio": {"type": "boolean"},
    "pauseRecordingAudio": {"type": "boolean"},
    "resumeRecordingAudio": {"type": "boolean"},
    "startRecordingVideo": {"type": "boolean"},
    "stopRecordingVideo": {"type": "boolean"},
    "pauseRecordingVideo": {"type": "boolean"},
    "resumeRecordingVideo": {"type": "boolean"}
  },
  "additionalProperties": false
}
```

--------------------------------

### GET /websites/engdev-1_eis-dev_enghouse-ops_net_ucaas-connector_cxengage-1_0/endpoints

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

Retrieves a list of all available endpoints. This endpoint supports filtering by address, ID, address type, format, platform type, and platform instance.

```APIDOC
## GET /endpoints

### Description
Retrieves a list of all available endpoints. This endpoint supports filtering by address, ID, address type, format, platform type, and platform instance.

### Method
GET

### Endpoint
/endpoints

### Parameters
#### Query Parameters
- **address** (string) - Optional - Address filter (accepts '*' wildcard).
- **id** (string) - Optional - Endpoint identifier filter.
- **addressType** (string) - Optional - Address type filter. Allowed values: "unknown", "uniqueName", "phoneNumber", "uniqueId".
- **format** (string) - Optional - Address format filter. Allowed values: "unknown", "exactMatch", "range", "regex".
- **platformType** (string) - Optional - Platform type filter. Allowed values: "Unknown", "Reference", "Webex", "Teams", "CTISimulator", "Swarm", "ACS", "XMS".
- **platformInstance** (string) - Optional - Platform instance (platform name) filter.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **endpoints** (array of objects) - Description of the endpoint information, including details of each endpoint.

#### Response Example
```json
[
  {
    "address": "string",
    "id": "string",
    "addressType": "unknown",
    "format": "unknown",
    "platformType": "Unknown",
    "platformInstance": "string"
  }
]
```

#### Error Responses
- **400 Bad Request**: The request is malformed or invalid.
- **401 Unauthorized**: The request lacks a valid authentication token.
- **404 Not Found**: A resource specified in the request was not found.
- **403 Forbidden**: The server understood the request, but refuses to authorize it.
- **500 Internal Server Error**: An unexpected error occurred on the server.
```

--------------------------------

### GET /diagnostics/transformers

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

Retrieves a list of all transformers. This endpoint is part of the Diagnostics API.

```APIDOC
## GET /diagnostics/transformers

### Description
Retrieves a list of all transformers. This endpoint is part of the Diagnostics API.

### Method
GET

### Endpoint
/diagnostics/transformers

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **Transformers**: (Array) - A list of transformer objects.

#### Response Example
```json
{
  "transformers": [
    {
      "id": "transformer-1",
      "name": "Transformer One",
      "status": "active"
    },
    {
      "id": "transformer-2",
      "name": "Transformer Two",
      "status": "inactive"
    }
  ]
}
```

#### Error Responses
- **400**: Bad Request, check the returned error.
- **401**: Unauthorized, the request lacks a valid authentication token.
- **403**: Forbidden, action not allowed.
- **404**: A resource was not found, check the returned error.
- **500**: Internal Server Error.
```

--------------------------------

### GET /diagnostics/subscriptions

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

Retrieves a list of all subscriptions. This endpoint is part of the Diagnostics API.

```APIDOC
## GET /diagnostics/subscriptions

### Description
Lists all subscriptions.

### Method
GET

### Endpoint
/diagnostics/subscriptions

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **description** (string) - Action success. Returns all subscriptions information

#### Response Example
{
  "example": "[Subscription details]"
}

#### Error Responses
- **400**: Bad Request, check the returned error
- **401**: Unauthorized, the request lacks a valid authentication token
- **404**: A resource was not found, check the returned error
- **403**: Forbidden, action not allowed
- **500**: Internal Server Error
```

--------------------------------

### GET /subscriptions/{subscriptionId}

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

Retrieves the details of a specific subscription using its unique identifier.

```APIDOC
## GET /subscriptions/{subscriptionId}

### Description
Retrieves the details of a specific subscription using its unique identifier.

### Method
GET

### Endpoint
/subscriptions/{subscriptionId}

### Parameters
#### Path Parameters
- **subscriptionId** (string) - Required - The unique identifier of the subscription (UUID format).

### Response
#### Success Response (200)
- **subscriptionId** (string) - The unique identifier of the subscription.
- **webhookUrl** (string) - The URL of the webhook.
- **eventTypes** (array of strings) - The subscribed event types.

#### Response Example
```json
{
  "subscriptionId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "webhookUrl": "https://example.com/webhook",
  "eventTypes": ["user.created", "user.deleted"]
}
```

#### Error Response (400 Bad Request)
- **title** (string) - Error title.
- **status** (integer) - HTTP status code.
- **detail** (string) - Error details.

#### Error Response (401 Unauthorized)
- **title** (string) - Error title.
- **status** (integer) - HTTP status code.
- **detail** (string) - Error details.

#### Error Response (403 Forbidden)
- **title** (string) - Error title.
- **status** (integer) - HTTP status code.
- **detail** (string) - Error details.

#### Error Response (404 Not Found)
- **title** (string) - Error title.
- **status** (integer) - HTTP status code.
- **detail** (string) - Error details.

#### Error Response (500 Internal Server Error)
- **title** (string) - Error title.
- **status** (integer) - HTTP status code.
- **detail** (string) - Error details.
```

--------------------------------

### POST /websites/engdev-1_eis-dev_enghouse-ops_net_ucaas-connector_cxengage-1_0

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

Initiates an input menu for an audio interaction, allowing for DTMF input collection with various configuration options.

```APIDOC
## POST /websites/engdev-1_eis-dev_enghouse-ops_net_ucaas-connector_cxengage-1_0

### Description
This endpoint initiates an input menu for an audio interaction. It allows configuration of various aspects of the menu, such as initial messages, timeouts, retry attempts, and input validation.

### Method
POST

### Endpoint
/websites/engdev-1_eis-dev_enghouse-ops_net_ucaas-connector_cxengage-1_0

### Parameters
#### Request Body
- **endpointId** (string) - Required - The endpoint which will start the input menu.
- **interactionId** (string) - Required - The audio interaction where the menu will execute.
- **initialMessage** (string) - Optional - The message to play when the menu starts.
- **noInputMessage** (string) - Optional - The message to be played if no input is received.
- **badInputMessage** (string) - Optional - The message to be played if bad input is received.
- **minDigitCount** (integer) - Optional - Minimum number of dtmf digits to receive.
- **maxDigitCount** (integer) - Optional - Maximum number of dtmf digits to receive.
- **terminatingDigit** (string) - Optional - Specific terminating digit to end the input menu.
- **firstDigitTimeoutInSec** (integer) - Optional - First digit input timeout.
- **nextDigitTimeoutInSec** (integer) - Optional - Next digit input timeout.
- **noInputRetries** (integer) - Optional - Number of 'no input' retries (default is 0).
- **badInputRetries** (integer) - Optional - Number of 'bad input' retries (default is 0).
- **digitStopsMessage** (boolean) - Optional - Enables interrupting the first prompt by receiving a dtmf digit (default is false).
- **inputBufferEnabled** (boolean) - Optional - Enables the input buffer (default value is false).
- **requestOriginURL** (string) - Optional - An optional URL from the requester to be included in the response.
- **requestId** (string) - Optional - Request unique identifier to be included in the response.
- **platformSpecificParameters** (object) - Optional - A JSON structure containing platform-specific parameters for the operation.

### Request Example
```json
{
  "endpointId": "exampleEndpointId",
  "interactionId": "exampleInteractionId",
  "initialMessage": "Please enter your selection.",
  "maxDigitCount": 1,
  "terminatingDigit": "#"
}
```

### Response
#### Success Response (200)
(No specific success response schema provided in the input. Typically, a success response would indicate the operation was acknowledged or provide relevant details.)

#### Response Example
(No example provided in the input.)

#### Error Response (400)
- **type** (string) - The type of the error.
- **title** (string) - The title of the error.
- **status** (integer) - The HTTP status code.
- **detail** (string) - A detailed description of the error.
- **instance** (string) - The instance of the error.

#### Response Example
```json
{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "Invalid input provided.",
  "instance": "/websites/engdev-1_eis-dev_enghouse-ops_net_ucaas-connector_cxengage-1_0"
}
```
```

--------------------------------

### GET /endpoints/{endpointId}/actionFlags

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

Retrieves the allowed action flags for a given endpoint.

```APIDOC
## GET /endpoints/{endpointId}/actionFlags

### Description
Retrieves the allowed action flags for a given endpoint.

### Method
GET

### Endpoint
/endpoints/{endpointId}/actionFlags

#### Path Parameters
- **endpointId** (string) - Required - The endpoint unique identifier.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **ActionFlags** - An object or list representing the allowed action flags for the endpoint.

#### Response Example
{
  "example": "{\"canRead\": true, \"canWrite\": false}"
}

#### Error Responses
- **400 Bad Request**: Indicates a problem with the request parameters.
- **401 Unauthorized**: The request lacks a valid authentication token.
- **403 Forbidden**: Action not allowed.
- **404 Not Found**: The specified endpoint resource was not found.
- **500 Internal Server Error**: An unexpected error occurred on the server.
```

--------------------------------

### GET /diagnostics/getTokenDetails

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

Retrieves the access token details. This endpoint is part of the Diagnostics API.

```APIDOC
## GET /diagnostics/getTokenDetails

### Description
Retrieves the access token details. This endpoint is part of the Diagnostics API.

### Method
GET

### Endpoint
/diagnostics/getTokenDetails

### Parameters
#### Query Parameters
- **endpointId** (string) - Optional - The ID of the endpoint for which to retrieve token details.

#### Request Body
None

### Request Example
```
GET /diagnostics/getTokenDetails?endpointId=some-endpoint-id
```

### Response
#### Success Response (200)
- **tokenDetails**: (Object) - An object containing the access token details.

#### Response Example
```json
{
  "tokenDetails": {
    "tokenId": "a1b2c3d4e5f6",
    "issuedAt": "2023-10-27T10:00:00Z",
    "expiresAt": "2023-10-27T11:00:00Z",
    "scopes": [
      "read",
      "write"
    ]
  }
}
```

#### Error Responses
- **400**: Bad Request, check the returned error.
- **401**: Unauthorized, the request lacks a valid authentication token.
- **403**: Forbidden, action not allowed.
- **404**: A resource was not found, check the returned error.
- **500**: Internal Server Error.
```

--------------------------------

### POST /utilities/mixedMediaInputMenu

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

Initiates a mixed media input menu for a call. This endpoint plays audio prompts (TTS or pre-recorded) and captures touch-tone (DTMF) input from the caller.

```APIDOC
## POST /utilities/mixedMediaInputMenu

### Description
Starts a mixed media-based input menu on the call. The menu will play lists of TTS and/or prompt messages and collect DTMF input from the caller.

### Method
POST

### Endpoint
/utilities/mixedMediaInputMenu

### Parameters
#### Request Body
- **ttsInputMenuArgs** (TTSInputMenuArgs) - Required - Arguments for the TTS input menu.
  - **includeTrace** (boolean) - Optional - Flag to include trace information in the response.
  - **requestOriginURL** (string) - Optional - A URL from the requester to be included in the response, used by man-in-the-middle components.
  - **requestId** (string) - Optional - A unique identifier for the request to be included in the response.
  - **platformSpecificParameters** (object) - Optional - A JSON structure containing platform-specific parameters.

### Request Example
```json
{
  "ttsInputMenuArgs": {
    "includeTrace": false,
    "requestOriginURL": "http://example.com/request",
    "requestId": "unique-request-id",
    "platformSpecificParameters": {
      "key": "value"
    }
  }
}
```

### Response
#### Success Response (201)
- Description: Created

#### Error Responses
- **400 Bad Request**: Check the returned error.
- **401 Unauthorized**: The request lacks a valid authentication token.
- **403 Forbidden**: Action not allowed.
- **404 Not Found**: A resource was not found, check the returned error.
- **500 Internal Server Error**: An unexpected error occurred on the server.
```

--------------------------------

### MixedMediaInputMenuArgs Object

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

Arguments for initiating an input menu that supports mixed media (TTS and audio prompts). It includes fields for request origin, ID, platform-specific parameters, and endpoint/interaction IDs.

```APIDOC
## MixedMediaInputMenuArgs Object

### Description
Arguments for starting an input menu that supports mixed media.

### Properties
- **requestOriginURL** (string, nullable) - Consumers can use this field to specify a URL that will be returned in the response. Use case: load balancers between UCaaS instances and other services.
- **requestId** (string, nullable) - Identifier of the request. Can be provided by the consumer or generated by the system. It's not guaranteed to be unique.
- **platformSpecificParameters** (any, nullable) - A JSON structure containing platform-specific parameters for the operation.
- **endpointId** (string, nullable) - Unique identifier of the endpoint which will start the input menu.
- **interactionId** (string) - Identifier of the interaction for which the input menu is being started.
```

--------------------------------

### GET /endpoints/{endpointId}

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

Retrieves detailed information for a specific endpoint using its unique identifier.

```APIDOC
## GET /endpoints/{endpointId}

### Description
Retrieves detailed information for a specific endpoint using its unique identifier.

### Method
GET

### Endpoint
/endpoints/{endpointId}

#### Path Parameters
- **endpointId** (string) - Required - The endpoint unique identifier.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **IEndpoint** - The endpoint object containing its details.

#### Response Example
{
  "example": "{\"id\": \"some-uuid\", \"name\": \"Example Endpoint\", \"description\": \"This is an example endpoint.\"}"
}

#### Error Responses
- **400 Bad Request**: Indicates a problem with the request parameters.
- **401 Unauthorized**: The request lacks a valid authentication token.
- **403 Forbidden**: Action not allowed.
- **404 Not Found**: The specified endpoint resource was not found.
- **500 Internal Server Error**: An unexpected error occurred on the server.
```

--------------------------------

### TTSInputMenuArgs

Source: https://engdev-1.eis-dev.enghouse-ops.net/ucaas-connector/cxengage-1/0/swagger/1/swagger

Arguments for initiating a Text-to-Speech (TTS) input menu.

```APIDOC
## TTSInputMenuArgs

### Description
Arguments for initiating a Text-to-Speech (TTS) input menu. This includes request details, endpoint and interaction IDs, and DTMF digit collection parameters.

### Method
N/A (This describes an argument object, not an endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **requestOriginURL** (string) - Optional - Consumers can use this field to specify a URL that will be returned in the response. Use case: load balancers between UCaaS instances and other services.
- **requestId** (string) - Optional - Identifier of the request. Can be provided by the consumer or generated by the system. It's not guaranteed to be unique.
- **platformSpecificParameters** (object) - Optional - A JSON structure containing platform-specific parameters for the operation.
- **endpointId** (string) - Optional - Unique identifier of the endpoint which will start the input menu.
- **interactionId** (string) - Optional - The audio interaction where the input menu will be executed.
- **minDigitCount** (integer) - Optional - Minimum number of dtmf digits to receive (default is 1). If the terminating digit is defined and arrives before collecting minDigitCount digits, the menu will be canceled with reason=badInput.
- **maxDigitCount** (integer) - Optional - Maximum number of dtmf digits to receive (default is 1).
- **terminatingDigit** (string) - Optional - The digit that will terminate the input menu.

### Request Example
```json
{
  "requestOriginURL": "http://example.com/lb",
  "requestId": "req-abcde",
  "endpointId": "ep-12345",
  "interactionId": "int-67890",
  "minDigitCount": 2,
  "maxDigitCount": 4,
  "terminatingDigit": "#"
}
```

### Response
#### Success Response (200)
N/A (This describes an argument object, not an endpoint)

#### Response Example
N/A
```
Tokens:
Raw