{
  "aid": "swaggerhub.feedyou:bot-telephony-1.1.1",
  "name": "Feedyou Bot Telephony API",
  "type": "Index",
  "description": "This API allows to use Feedyou bot with telephony PBX which implements TTS/STT voice processing on its own.\n\n - When user calls PBX, `call_start` event is sent to the bot\n - Bot loads set of intro messages and sends them one by one using `queue_tts` to the PBX (endpoint where PBX is listening for events from bot should be defined in `callback_endpoint` property)\n - PBX should transform them to the voice audio using TTS engine add then play them in sequence (some other messages can come even during playback of previous one)\n - When `queue_tts` has the `next_state=listen` flag, PBX should switch to the listening mode when given message played to the end and forward incoming audio stream to the STT service (some STT settings such as speech context could be included in the event from bot)\n - When STT detects end of user input, recognized text should be sent to the bot using `recognized_text` event (when end of utterance is not detected until selected `listen_timeout`, `listen_timeout_reached` event is sent to the bot)\n - Then the cycle continues until user hangs up bot sends `queue_tts` with `next_state=hangup` or `next_state=transfer` event (it transfers call to some other phone number)\n\nSee the following sequence diagram to understand basic principles.\n<br /><br /> <img alt=\"Sequence diagram\" src=\"https://feedyou.blob.core.windows.net/docs/voice-bot-pbx.png\" />\n",
  "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/swaggerhub.feedyou/bot-telephony/1.1.1/apis.json",
  "tags": [
    "swaggerhub.feedyou",
    "bot-telephony"
  ],
  "created": "2026-04-02",
  "modified": "2026-04-02",
  "specificationVersion": "0.19",
  "access": "3rd-Party",
  "maintainers": [
    {
      "FN": "Jentic",
      "X-github": "jentic",
      "url": "https://github.com/jentic"
    }
  ],
  "apis": [
    {
      "aid": "swaggerhub.feedyou:bot-telephony-1.1.1",
      "name": "Feedyou Bot Telephony API",
      "description": "This API allows to use Feedyou bot with telephony PBX which implements TTS/STT voice processing on its own.\n\n - When user calls PBX, `call_start` event is sent to the bot\n - Bot loads set of intro messages and sends them one by one using `queue_tts` to the PBX (endpoint where PBX is listening for events from bot should be defined in `callback_endpoint` property)\n - PBX should transform them to the voice audio using TTS engine add then play them in sequence (some other messages can come even during playback of previous one)\n - When `queue_tts` has the `next_state=listen` flag, PBX should switch to the listening mode when given message played to the end and forward incoming audio stream to the STT service (some STT settings such as speech context could be included in the event from bot)\n - When STT detects end of user input, recognized text should be sent to the bot using `recognized_text` event (when end of utterance is not detected until selected `listen_timeout`, `listen_timeout_reached` event is sent to the bot)\n - Then the cycle continues until user hangs up bot sends `queue_tts` with `next_state=hangup` or `next_state=transfer` event (it transfers call to some other phone number)\n\nSee the following sequence diagram to understand basic principles.\n<br /><br /> <img alt=\"Sequence diagram\" src=\"https://feedyou.blob.core.windows.net/docs/voice-bot-pbx.png\" />\n",
      "image": "",
      "baseURL": "https://virtserver.swaggerhub.com/feedyou/bot-telephony/1.1.1",
      "humanURL": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/swaggerhub.feedyou/bot-telephony/1.1.1",
      "version": "1.1.1",
      "tags": [
        "swaggerhub.feedyou",
        "bot-telephony"
      ],
      "properties": [
        {
          "type": "OpenAPI",
          "name": "OpenAPI definition",
          "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/swaggerhub.feedyou/bot-telephony/1.1.1/openapi.json",
          "mediaType": "application/openapi+json"
        },
        {
          "type": "GitHubRepo",
          "url": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/swaggerhub.feedyou/bot-telephony/1.1.1"
        }
      ]
    }
  ]
}