How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Bitrix24

Bitrix24 Telephony API

The Telephony API from Bitrix24 — 30 operation(s) for telephony.

Documentation Provider Profile APIs.io OpenAPI GitHub

Bitrix24 Telephony API is one of 36 APIs that Bitrix24 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Telephony. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 30 operations across 30 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://{portal}.bitrix24.com/rest, https://{host}/rest.

30 operations 30 paths 3 schemas 30 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://{installation}.bitrix24.com/rest/
Authentication
API Key, OAuth 2.0
Contact
Bitrix24 Developer Support
License
MIT
Resource Areas
1

Authentication & Security 2

Bitrix24 Telephony API declares 2 security schemes for authenticating requests. An API key is passed in the query as auth (AccessToken). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 45 scopes. By default, every request must be authenticated.

  • AccessToken — OAuth 2.0 accesstoken or incoming webhook token
  • OAuth2 — OAuth 2.0 authorization

Paths & Operations 30

Across 30 paths, the API surfaces 30 operations — 30 POST. Each is listed below with its method, path, parameters, and response codes.

Telephony 30
POST
/telephony.call.attachTranscription
Add Transcription to Call with telephony.call.attachTranscription
telephony_call_attachTranscription body → 2004XX
POST
/telephony.externalCall.attachRecord
Attach a Record to a Completed Call telephony.externalCall.attachRecord
telephony_externalCall_attachRecord body → 2004XX
POST
/telephony.externalCall.finish
Finish Call and Log It in Telephony Statistics telephony.externalCall.finish
telephony_externalCall_finish body → 2004XX
POST
/telephony.externalCall.hide
Hide Call Card for User telephony.externalCall.hide
telephony_externalCall_hide body → 2004XX
POST
/telephony.externalCall.register
Register an External Call in Bitrix24 telephony.externalCall.register
telephony_externalCall_register body → 2004XX
POST
/telephony.externalCall.searchCrmEntities
Find a Client in CRM by Phone Number telephony.externalCall.searchCrmEntities
telephony_externalCall_searchCrmEntities body → 2004XX
POST
/telephony.externalCall.show
Show Call Card to User telephony.externalCall.show
telephony_externalCall_show body → 2004XX
POST
/telephony.externalLine.add
Add External Line telephony.externalLine.add
telephony_externalLine_add body → 2004XX
POST
/telephony.externalLine.delete
Delete External Line telephony.externalLine.delete
telephony_externalLine_delete body → 2004XX
POST
/telephony.externalLine.get
Get a List of External Lines with telephony.externalLine.get
telephony_externalLine_get body → 2004XX
POST
/telephony.externalLine.update
Update External Line telephony.externalLine.update
telephony_externalLine_update body → 2004XX
POST
/voximplant.callback.start
Start a Callback with voximplant.callback.start
voximplant_callback_start body → 2004XX
POST
/voximplant.infocall.startwithsound
Make an Auto-Call with MP3 Playback using voximplant.infocall.startwithsound
voximplant_infocall_startwithsound body → 2004XX
POST
/voximplant.infocall.startwithtext
Initiate an Auto-Call with the Voice Automation Rule voximplant.infocall.startwithtext
voximplant_infocall_startwithtext body → 2004XX
POST
/voximplant.line.get
Get a List of Outgoing Lines voximplant.line.get
voximplant_line_get body → 2004XX
POST
/voximplant.line.outgoing.get
Get Line for Outgoing Calls voximplant.line.outgoing.get
voximplant_line_outgoing_get body → 2004XX
POST
/voximplant.line.outgoing.set
Set Outgoing Line voximplant.line.outgoing.set
voximplant_line_outgoing_set body → 2004XX
POST
/voximplant.line.outgoing.sip.set
Set Outgoing SIP Line voximplant.line.outgoing.sip.set
voximplant_line_outgoing_sip_set body → 2004XX
POST
/voximplant.sip.add
Create SIP Line voximplant.sip.add
voximplant_sip_add body → 2004XX
POST
/voximplant.sip.connector.status
Get the Status of the SIP Connector voximplant.sip.connector.status
voximplant_sip_connector_status body → 2004XX
POST
/voximplant.sip.delete
Delete SIP Line voximplant.sip.delete
voximplant_sip_delete body → 2004XX
POST
/voximplant.sip.get
Get SIP Lines of the Application voximplant.sip.get
voximplant_sip_get body → 2004XX
POST
/voximplant.sip.status
Get SIP Registration Status voximplant.sip.status
voximplant_sip_status body → 2004XX
POST
/voximplant.sip.update
Update SIP Line voximplant.sip.update
voximplant_sip_update body → 2004XX
POST
/voximplant.statistic.get
Get Call History List voximplant.statistic.get
voximplant_statistic_get body → 2004XX
POST
/voximplant.tts.voices.get
Get a List of Available Voices for Text-to-Speech voximplant.tts.voices.get
voximplant_tts_voices_get body → 2004XX
POST
/voximplant.url.get
Get Links for Navigation in the Telephony Pages voximplant.url.get
voximplant_url_get body → 2004XX
POST
/voximplant.user.activatePhone
Activate User SIP Device voximplant.user.activatePhone
voximplant_user_activatePhone body → 2004XX
POST
/voximplant.user.deactivatePhone
Deactivate the employee's SIP phone presence with voximplant.user.deactivatePhone
voximplant_user_deactivatePhone body → 2004XX
POST
/voximplant.user.get
Get User Settings voximplant.user.get
voximplant_user_get body → 2004XX

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are BitrixTime (8 properties), BitrixResponse (4 properties), BitrixError (2 properties). Each schema is shown below with its type and property counts.

BitrixError
object
Bitrix24 REST API error response
2 properties 2 required
BitrixTime
object
Request execution time information
8 properties
BitrixResponse
object
Standard Bitrix24 REST API response
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bitrix24-telephony-api-openapi.yml Raw ↑

Other APIs Bitrix24 publishes across the network.

Bitrix24 REST API
AE Profile APIs.io
Bitrix24 BIconnector API
AE Profile APIs.io
Bitrix24 Business Processes API
AE Profile APIs.io
Bitrix24 Calendar API
AE Profile APIs.io
Bitrix24 Chatbots API
AE Profile APIs.io
Bitrix24 Chats API
AE Profile APIs.io
Bitrix24 Company Structure API
AE Profile APIs.io
Bitrix24 CoPilot / AI API
AE Profile APIs.io
Bitrix24 CRM API
AE Profile APIs.io
Bitrix24 Data Storage API
AE Profile APIs.io
Bitrix24 Deprecated Methods API
AE Profile APIs.io
Bitrix24 Document Generator API
AE Profile APIs.io
#Telephony
← Back to B APIs
API Details
ID
bitrix24:bitrix24-telephony-api
Base URL
https://{installation}.bitrix24.com/rest/
Docs
https://apidocs.bitrix24.com/
Provider
Bitrix24
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=bitrix24-telephony-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/bitrix24-telephony-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Bitrix24 Telephony API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.