{
  "opencollection": "1.0.0",
  "info": {
    "name": "Bitrix24 REST BIconnector Telephony API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "auth",
      "value": "{{auth}}",
      "placement": "query"
    }
  },
  "items": [
    {
      "info": {
        "name": "Telephony",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Add Transcription to Call with telephony.call.attachTranscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/telephony.call.attachTranscription",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.call.attachTranscription` adds a transcription of the conversation to a completed call."
        },
        {
          "info": {
            "name": "Attach a Record to a Completed Call telephony.externalCall.attachRecord",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/telephony.externalCall.attachRecord",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.externalCall.attachRecord` attaches a record to a completed call and to the CRM activity of the call. Call this method after [telephony.externalCall.finish](./telephony-external-call-finish.md) when the record is ready."
        },
        {
          "info": {
            "name": "Finish Call and Log It in Telephony Statistics telephony.externalCall.finish",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/telephony.externalCall.finish",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.externalCall.finish` ends an external call, saves it in the statistics, and logs it in the CRM activity. The method works only in the context of the [application](../../settings/app-installation/index.md)"
        },
        {
          "info": {
            "name": "Hide Call Card for User telephony.externalCall.hide",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/telephony.externalCall.hide",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.externalCall.hide` hides the call card for a user or a list of users."
        },
        {
          "info": {
            "name": "Register an External Call in Bitrix24 telephony.externalCall.register",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/telephony.externalCall.register",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.externalCall.register` registers an external call in Bitrix24. To create a CRM activity for the call, you must also call the method [telephony.externalCall.finish](./telephony-external-call-finish.md). The method works only in the context of an [application](../../se"
        },
        {
          "info": {
            "name": "Find a Client in CRM by Phone Number telephony.externalCall.searchCrmEntities",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/telephony.externalCall.searchCrmEntities",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.externalCall.searchCrmEntities` returns CRM entities based on the client's phone number and the details of the responsible employee."
        },
        {
          "info": {
            "name": "Show Call Card to User telephony.externalCall.show",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/telephony.externalCall.show",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.externalCall.show` displays the call card to a user or a list of users."
        },
        {
          "info": {
            "name": "Add External Line telephony.externalLine.add",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/telephony.externalLine.add",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.externalLine.add` adds an external line to the application. The method works only in the context of the [application](../../settings/app-installation/index.md)."
        },
        {
          "info": {
            "name": "Delete External Line telephony.externalLine.delete",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/telephony.externalLine.delete",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.externalLine.delete` removes an external line from the application. The method works only in the context of the [application](../../settings/app-installation/index.md)."
        },
        {
          "info": {
            "name": "Get a List of External Lines with telephony.externalLine.get",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/telephony.externalLine.get",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.externalLine.get` returns a list of external lines for the application. The method works only in the context of the [application](../../settings/app-installation/index.md)."
        },
        {
          "info": {
            "name": "Update External Line telephony.externalLine.update",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/telephony.externalLine.update",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.externalLine.update` modifies the parameters of the application's external line. This method works only in the context of the [application](../../settings/app-installation/index.md)."
        },
        {
          "info": {
            "name": "Start a Callback with voximplant.callback.start",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/voximplant.callback.start",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.callback.start` initiates a callback between an employee and a client."
        },
        {
          "info": {
            "name": "Make an Auto-Call with MP3 Playback using voximplant.infocall.startwithsound",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/voximplant.infocall.startwithsound",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.infocall.startwithsound` initiates an auto-call and plays an MP3 file from a URL."
        },
        {
          "info": {
            "name": "Initiate an Auto-Call with the Voice Automation Rule voximplant.infocall.startwithtext",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/voximplant.infocall.startwithtext",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.infocall.startwithtext` initiates an auto-call and plays the specified text to the recipient using speech synthesis."
        },
        {
          "info": {
            "name": "Get a List of Outgoing Lines voximplant.line.get",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/voximplant.line.get",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.line.get` returns a list of available outgoing lines."
        },
        {
          "info": {
            "name": "Get Line for Outgoing Calls voximplant.line.outgoing.get",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/voximplant.line.outgoing.get",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.line.outgoing.get` returns the identifier of the current default outgoing line."
        },
        {
          "info": {
            "name": "Set Outgoing Line voximplant.line.outgoing.set",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/voximplant.line.outgoing.set",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.line.outgoing.set` sets the default outgoing line."
        },
        {
          "info": {
            "name": "Set Outgoing SIP Line voximplant.line.outgoing.sip.set",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/voximplant.line.outgoing.sip.set",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.line.outgoing.sip.set` sets the SIP line as the default outgoing line."
        },
        {
          "info": {
            "name": "Create SIP Line voximplant.sip.add",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/voximplant.sip.add",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.sip.add` creates a new SIP line associated with an application."
        },
        {
          "info": {
            "name": "Get the Status of the SIP Connector voximplant.sip.connector.status",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/voximplant.sip.connector.status",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.sip.connector.status` returns the current status of the SIP connector."
        },
        {
          "info": {
            "name": "Delete SIP Line voximplant.sip.delete",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/voximplant.sip.delete",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.sip.delete` removes an existing SIP line created by the current application."
        },
        {
          "info": {
            "name": "Get SIP Lines of the Application voximplant.sip.get",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/voximplant.sip.get",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.sip.get` returns a list of SIP lines created by the current application."
        },
        {
          "info": {
            "name": "Get SIP Registration Status voximplant.sip.status",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/voximplant.sip.status",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.sip.status` returns the current SIP registration status for the cloud PBX."
        },
        {
          "info": {
            "name": "Update SIP Line voximplant.sip.update",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/voximplant.sip.update",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.sip.update` updates an existing SIP line created by the current application."
        },
        {
          "info": {
            "name": "Get Call History List voximplant.statistic.get",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/voximplant.statistic.get",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.statistic.get` returns a list of calls from telephony statistics."
        },
        {
          "info": {
            "name": "Get a List of Available Voices for Text-to-Speech voximplant.tts.voices.get",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/voximplant.tts.voices.get",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.tts.voices.get` returns a list of available voices for text-to-speech synthesis."
        },
        {
          "info": {
            "name": "Get Links for Navigation in the Telephony Pages voximplant.url.get",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/voximplant.url.get",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.url.get` returns links for navigation in the telephony pages."
        },
        {
          "info": {
            "name": "Activate User SIP Device voximplant.user.activatePhone",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/voximplant.user.activatePhone",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.user.activatePhone` sets a flag indicating the presence of a SIP device for an employee."
        },
        {
          "info": {
            "name": "Deactivate the employee's SIP phone presence with voximplant.user.deactivatePhone",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/voximplant.user.deactivatePhone",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Some data may be missing here — we will complete it shortly. - The required parameters are not specified - Examples are missing"
        },
        {
          "info": {
            "name": "Get User Settings voximplant.user.get",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/voximplant.user.get",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.user.get` returns user settings. For applications, calling the method requires [administrator confirmation](../../../scopes/confirmation.md)."
        }
      ]
    }
  ],
  "bundled": true
}