Get WebSocket endpoint information

Returns information about available WebSocket endpoints and their current status.

GET /api/v1/ws/info

Get WebSocket endpoint information

JavaScript

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://blackbox.dasha.ai/api/v1/ws/info', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "endpoints": [
    {
      "path": "<string>",
      "description": "<string>",
      "requiredParameters": [
        "<string>"
      ],
      "optionalParameters": [
        "<string>"
      ],
      "supportedMessageTypes": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "type": "event",
          "name": "closed",
          "data": {
            "endpoint": "<string>",
            "hangupMsgId": "<string>",
            "startConnectionTimeISO": "<string>",
            "endConnectionTimeISO": "<string>"
          },
          "channelId": "<string>"
        }
      ]
    }
  ],
  "version": "<string>",
  "status": "<string>"
}

Response

200

text/plain

Success

WebSocket endpoint information response

endpoints · object[] | null

Available WebSocket endpoints

Show child attributes

version · string | null

WebSocket API version

status · string | null

Current status of WebSocket service