Bitrix24 Telephony API
The Telephony API from Bitrix24 — 30 operation(s) for telephony.
OpenAPI Specification
openapi: 3.0.3
info:
title: Bitrix24 REST BIconnector Telephony API
version: 1.0.0
description: 'Bitrix24 REST API provides access to CRM, tasks, drive, chats, telephony, e-commerce, automation, and other modules. Documentation: https://apidocs.bitrix24.com'
contact:
name: Bitrix24 Developer Support
url: https://apidocs.bitrix24.com/support.html
license:
name: MIT
url: https://github.com/bitrix-tools/b24-rest-docs/blob/main/LICENSE
x-logo:
url: https://apidocs.bitrix24.com/_images/bitrix24logo.svg
servers:
- url: https://{portal}.bitrix24.com/rest
description: Your Bitrix24 portal (cloud)
variables:
portal:
default: your-portal
description: Subdomain of your Bitrix24 portal
- url: https://{host}/rest
description: On-Premise Bitrix24 installation
variables:
host:
default: your-bitrix24.example.com
description: Host of your on-premise installation
security:
- AccessToken: []
tags:
- name: Telephony
paths:
/telephony.call.attachTranscription:
post:
summary: Add Transcription to Call with telephony.call.attachTranscription
description: 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.
operationId: telephony_call_attachTranscription
tags:
- Telephony
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/telephony/telephony-call-attach-transcription.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
CALL_ID:
type: string
description: '| Identifier of the call from the method telephony.externalCall.register ||'
MESSAGES:
type: array
items: {}
description: '| Array of transcription utterances ||'
COST:
type: number
format: double
description: '| Cost of the transcription.'
COST_CURRENCY:
type: string
description: '| Currency of the transcription cost. Used only with `COST`.'
SIDE:
type: string
description: '| Participant of the conversation.'
START_TIME:
type: integer
description: '| Start time of the utterance in seconds from the beginning of the call.'
STOP_TIME:
type: integer
description: '| End time of the utterance in seconds from the beginning of the call.'
MESSAGE:
type: string
description: '| Text of the utterance ||'
required:
- CALL_ID
- MESSAGES
- SIDE
- START_TIME
- STOP_TIME
- MESSAGE
application/x-www-form-urlencoded:
schema:
type: object
properties:
CALL_ID:
type: string
description: '| Identifier of the call from the method telephony.externalCall.register ||'
MESSAGES:
type: array
items: {}
description: '| Array of transcription utterances ||'
COST:
type: number
format: double
description: '| Cost of the transcription.'
COST_CURRENCY:
type: string
description: '| Currency of the transcription cost. Used only with `COST`.'
SIDE:
type: string
description: '| Participant of the conversation.'
START_TIME:
type: integer
description: '| Start time of the utterance in seconds from the beginning of the call.'
STOP_TIME:
type: integer
description: '| End time of the utterance in seconds from the beginning of the call.'
MESSAGE:
type: string
description: '| Text of the utterance ||'
required:
- CALL_ID
- MESSAGES
- SIDE
- START_TIME
- STOP_TIME
- MESSAGE
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- telephony
/telephony.externalCall.attachRecord:
post:
summary: Attach a Record to a Completed Call telephony.externalCall.attachRecord
description: 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.
operationId: telephony_externalCall_attachRecord
tags:
- Telephony
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/telephony/telephony-external-call-attach-record.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
CALL_ID:
type: string
description: '| The identifier of the call from the method telephony.externalCall.register.'
RECORD_URL:
type: string
description: '| The URL of the record on an external server. If this parameter is provided, Bitrix24 will download the file from the link.'
FILENAME:
type: string
description: '| The name of the record file.'
FILE_CONTENT:
type: string
description: '| The file in Base64 encoding. ||'
required:
- CALL_ID
application/x-www-form-urlencoded:
schema:
type: object
properties:
CALL_ID:
type: string
description: '| The identifier of the call from the method telephony.externalCall.register.'
RECORD_URL:
type: string
description: '| The URL of the record on an external server. If this parameter is provided, Bitrix24 will download the file from the link.'
FILENAME:
type: string
description: '| The name of the record file.'
FILE_CONTENT:
type: string
description: '| The file in Base64 encoding. ||'
required:
- CALL_ID
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- telephony
/telephony.externalCall.finish:
post:
summary: Finish Call and Log It in Telephony Statistics telephony.externalCall.finish
description: 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)
operationId: telephony_externalCall_finish
tags:
- Telephony
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/telephony/telephony-external-call-finish.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
CALL_ID:
type: string
description: '| The identifier of the call from the method telephony.externalCall.register ||'
USER_ID:
type: integer
description: '| The identifier of the user who ends the call.'
USER_PHONE_INNER:
type: string
description: '| The internal number of the user.'
DURATION:
type: integer
description: '| The duration of the call in seconds.'
COST:
type: number
format: double
description: '| The cost of the call.'
COST_CURRENCY:
type: string
description: '| The currency of the call cost.'
STATUS_CODE:
type: string
description: '| The result code of the call.'
FAILED_REASON:
type: string
description: '| Text reason for the failed call.'
RECORD_URL:
type: string
description: '| URL of the call recording.'
VOTE:
type: integer
description: '| Rating of the call.'
ADD_TO_CHAT:
type: integer
description: '| Add a message about the call to the employee''s chat.'
required:
- CALL_ID
- USER_ID
- USER_PHONE_INNER
application/x-www-form-urlencoded:
schema:
type: object
properties:
CALL_ID:
type: string
description: '| The identifier of the call from the method telephony.externalCall.register ||'
USER_ID:
type: integer
description: '| The identifier of the user who ends the call.'
USER_PHONE_INNER:
type: string
description: '| The internal number of the user.'
DURATION:
type: integer
description: '| The duration of the call in seconds.'
COST:
type: number
format: double
description: '| The cost of the call.'
COST_CURRENCY:
type: string
description: '| The currency of the call cost.'
STATUS_CODE:
type: string
description: '| The result code of the call.'
FAILED_REASON:
type: string
description: '| Text reason for the failed call.'
RECORD_URL:
type: string
description: '| URL of the call recording.'
VOTE:
type: integer
description: '| Rating of the call.'
ADD_TO_CHAT:
type: integer
description: '| Add a message about the call to the employee''s chat.'
required:
- CALL_ID
- USER_ID
- USER_PHONE_INNER
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- telephony
/telephony.externalCall.hide:
post:
summary: Hide Call Card for User telephony.externalCall.hide
description: 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.
operationId: telephony_externalCall_hide
tags:
- Telephony
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/telephony/telephony-external-call-hide.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
CALL_ID:
type: string
description: '| Identifier of the call from the method telephony.externalCall.register. ||'
USER_ID:
type: string
description: '| Identifier of the user or an array of user identifiers.'
required:
- CALL_ID
application/x-www-form-urlencoded:
schema:
type: object
properties:
CALL_ID:
type: string
description: '| Identifier of the call from the method telephony.externalCall.register. ||'
USER_ID:
type: string
description: '| Identifier of the user or an array of user identifiers.'
required:
- CALL_ID
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- telephony
/telephony.externalCall.register:
post:
summary: Register an External Call in Bitrix24 telephony.externalCall.register
description: 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](../../settings/app-installation/index.md).
operationId: telephony_externalCall_register
tags:
- Telephony
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/telephony/telephony-external-call-register.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
USER_ID:
type: integer
description: '| The identifier of the user for whom the call is registered.'
USER_PHONE_INNER:
type: string
description: '| The internal number of the user.'
PHONE_NUMBER:
type: string
description: '| The client''s phone number. ||'
TYPE:
type: integer
description: '| The type of call.'
CALL_START_DATE:
type: string
description: '| The date and time the call started in ISO-8601 format with timezone indication, for example, `2026-03-07T10:20:30+03:00`.'
CRM_CREATE:
type: integer
description: '| Automatic creation of a CRM object if no suitable object is found by the number.'
CRM_SOURCE:
type: string
description: '| The identifier of the CRM source (the value of the `STATUS_ID` field).'
CRM_ENTITY_TYPE:
type: string
description: '| The type of CRM object to associate with the call.'
CRM_ENTITY_ID:
type: integer
description: '| The identifier of the CRM object from `CRM_ENTITY_TYPE`.'
SHOW:
type: integer
description: '| Show the call detail form after registration.'
ADD_TO_CHAT:
type: integer
description: '| Add a message about the call to the employee''s chat.'
CALL_LIST_ID:
type: integer
description: '| The identifier of the call list to which the call is linked.'
LINE_NUMBER:
type: string
description: '| The number of the external line.'
EXTERNAL_CALL_ID:
type: string
description: '| The external identifier of the call on the side of the PBX/integration.'
required:
- USER_ID
- USER_PHONE_INNER
- PHONE_NUMBER
- TYPE
application/x-www-form-urlencoded:
schema:
type: object
properties:
USER_ID:
type: integer
description: '| The identifier of the user for whom the call is registered.'
USER_PHONE_INNER:
type: string
description: '| The internal number of the user.'
PHONE_NUMBER:
type: string
description: '| The client''s phone number. ||'
TYPE:
type: integer
description: '| The type of call.'
CALL_START_DATE:
type: string
description: '| The date and time the call started in ISO-8601 format with timezone indication, for example, `2026-03-07T10:20:30+03:00`.'
CRM_CREATE:
type: integer
description: '| Automatic creation of a CRM object if no suitable object is found by the number.'
CRM_SOURCE:
type: string
description: '| The identifier of the CRM source (the value of the `STATUS_ID` field).'
CRM_ENTITY_TYPE:
type: string
description: '| The type of CRM object to associate with the call.'
CRM_ENTITY_ID:
type: integer
description: '| The identifier of the CRM object from `CRM_ENTITY_TYPE`.'
SHOW:
type: integer
description: '| Show the call detail form after registration.'
ADD_TO_CHAT:
type: integer
description: '| Add a message about the call to the employee''s chat.'
CALL_LIST_ID:
type: integer
description: '| The identifier of the call list to which the call is linked.'
LINE_NUMBER:
type: string
description: '| The number of the external line.'
EXTERNAL_CALL_ID:
type: string
description: '| The external identifier of the call on the side of the PBX/integration.'
required:
- USER_ID
- USER_PHONE_INNER
- PHONE_NUMBER
- TYPE
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- telephony
/telephony.externalCall.searchCrmEntities:
post:
summary: Find a Client in CRM by Phone Number telephony.externalCall.searchCrmEntities
description: 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.
operationId: telephony_externalCall_searchCrmEntities
tags:
- Telephony
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/telephony/telephony-external-call-search-crm-entities.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
PHONE_NUMBER:
type: string
description: '| The client''s phone number ||'
required:
- PHONE_NUMBER
application/x-www-form-urlencoded:
schema:
type: object
properties:
PHONE_NUMBER:
type: string
description: '| The client''s phone number ||'
required:
- PHONE_NUMBER
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- telephony
/telephony.externalCall.show:
post:
summary: Show Call Card to User telephony.externalCall.show
description: 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.
operationId: telephony_externalCall_show
tags:
- Telephony
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/telephony/telephony-external-call-show.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
CALL_ID:
type: string
description: '| Identifier of the call from the method telephony.externalCall.register ||'
USER_ID:
type: string
description: '| Identifier of the user or an array of user identifiers.'
required:
- CALL_ID
application/x-www-form-urlencoded:
schema:
type: object
properties:
CALL_ID:
type: string
description: '| Identifier of the call from the method telephony.externalCall.register ||'
USER_ID:
type: string
description: '| Identifier of the user or an array of user identifiers.'
required:
- CALL_ID
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- telephony
/telephony.externalLine.add:
post:
summary: Add External Line telephony.externalLine.add
description: 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).
operationId: telephony_externalLine_add
tags:
- Telephony
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/telephony/telephony-external-line-add.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
NUMBER:
type: string
description: '| External line number ||'
NAME:
type: string
description: '| Name of the external line ||'
CRM_AUTO_CREATE:
type: string
description: '| Auto-creation of a CRM object for outgoing calls.'
required:
- NUMBER
application/x-www-form-urlencoded:
schema:
type: object
properties:
NUMBER:
type: string
description: '| External line number ||'
NAME:
type: string
description: '| Name of the external line ||'
CRM_AUTO_CREATE:
type: string
description: '| Auto-creation of a CRM object for outgoing calls.'
required:
- NUMBER
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- telephony
/telephony.externalLine.delete:
post:
summary: Delete External Line telephony.externalLine.delete
description: 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).
operationId: telephony_externalLine_delete
tags:
- Telephony
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/telephony/telephony-external-line-delete.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
NUMBER:
type: string
description: '| The number of the external line.'
required:
- NUMBER
application/x-www-form-urlencoded:
schema:
type: object
properties:
NUMBER:
type: string
description: '| The number of the external line.'
required:
- NUMBER
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- telephony
/telephony.externalLine.get:
post:
summary: Get a List of External Lines with telephony.externalLine.get
description: 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).
operationId: telephony_externalLine_get
tags:
- Telephony
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/telephony/telephony-external-line-get.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
application/x-www-form-urlencoded:
schema:
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- telephony
/telephony.externalLine.update:
post:
summary: Update External Line telephony.externalLine.update
description: 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).
operationId: telephony_externalLine_update
tags:
- Telephony
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/telephony/telephony-external-line-update.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
NUMBER:
type: string
description: '| The number of the external line.'
NAME:
type: string
description: '| The new name of the external line. ||'
CRM_AUTO_CREATE:
type: string
description: '| Auto-creation of a CRM object for outgoing calls.'
required:
- NUMBER
application/x-www-form-urlencoded:
schema:
type: object
properties:
NUMBER:
type: string
description: '| The number of the external line.'
NAME:
type: string
description: '| The new name of the external line. ||'
CRM_AUTO_CREATE:
type: string
description: '| Auto-creation of a CRM object for outgoing calls.'
required:
- NUMBER
# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bitrix24/refs/heads/main/openapi/bitrix24-telephony-api-openapi.yml