Useful customizations itgrix_bx (Bitrix24)
Diagram of call processing by Itgrix integration module
"Entity" in connector logic is a contact or lead. A conversation request is the start of a call on an extension. There can be multiple conversations in one call (in case of call transfer).
Short description of customizations
1
customize_activity.php
Update the case fields (at the end of the call).
2
customize_entity.php
Update entity fields (at the end of the call).
3
need_registration.php
Is call registration necessary? You can do black/white lists by extension number/trunk.
4
process_client_phone.php
Change phone number before registration in CRM: You can change the format of the phone number (+7, 8...).
5
process_final_params.php
Change the call finish data.
6
process_originate_params.php
Change parameters when initiating a call from CRM. You can call through a different trunk, through a different context, change the number format, etc.
7
process_record_file_path.php
Customize the path to the conversation recording file.
8
process_registration_params.php
Change the call registration parameters.
9
process_task_creation_params.php
Customize the creation of missed call tasks.
10
process_user_phone.php
Change the user number before searching for the user in B24.
11
customize_autodistribution.php
Change the extension number when autodistributing an incoming call.
12
post_registration.php
Action after call registration.
13
customize_show_call_card.php
Change the display options for the call card.
14
customize_attach_record_url.php
Change the record attachment settings.
Input and output parameters of customizations
1) customize_activity
Input:
Only non-empty/non-zero fields are present in the raw object.
Return:
Detailed description of the case fields in Bitrix24 REST API documentation.
2) customize entity
Input:
Return:
Detailed description of lead fields in Bitrix24 REST API documentation. Detailed description of contact fields in Bitrix24 REST API documentation.
3) need registration
Used to implement black/white list functionality by numbers, trunks and other more complex conditions.
Input:
Return:
4) process_client_phone
Converting customer phone numbers before sending requests to Bitrix24.
Examples in the article Changing the phone number before sending data to CRM.
Input:
Return:
5) process_final_params
Customization of call registration completion parameters.
Input:
Call statuses in Bitrix24 are described in the article Detailed call statuses.
Return:
Detailed description of call termination parameters in Bitrix24 REST API documentation.
6) process_originate_params
Changing parameters when initializing a call from Bitrix24.
Detailed description with examples in the article Changing parameters during click-to-call.
7) process_record_file_path
Convert the path to the conversation recording file.
Since conversion of records can take considerable time, this customization has a special, fixed timeout of 10 seconds, which does not depend on the customization settings. If the record fails to convert before the timeout expires, the original file will be used.
8) process_registration_params
Used to customize the call start registration parameters.
Input:
Call card display is placed in a separate request and is customized by a separate customize_show_call_card customization, so the SHOW parameter is always 0.
This is because you can customize whether to show the call card when dialing or when answering.
Return:
Detailed description of call registration parameters in Bitrix24 REST API documentation.
9) process_task_creation_params
Customization of task creation parameters (on missed incoming call or unanswered outgoing call).
Input:
Return:
Detailed description of task fields in Bitrix24 REST API documentation.
10) process_user_phone
Change the user number before searching for a Bitrix24 user.
Input:
Return:
11) customize_autodistribution
Input:
Return:
name - text that will appear in CallerID and will be displayed in the phone (or softphone) of the operator.
Must be no more than 20 characters (Asterisk limitation)!
12) post_registration
This customization allows you to perform some actions after a call is registered.
It can be called at different moments depending on the type of call:
For click-to-call (c2c) calls, the customization will be invoked at the beginning of the Conversation requested stage processing.
Missed calls on the IVR are logged and terminated at the Call ended stage.
For all other calls, the customization will be invoked after the call registration request is executed in Bitrix24 at the Conversation requested stage.
Input:
Return:
Only state needs to be returned, the rest is ignored:
13) customize_show_call_card
Used to customize call card display options.
Input:
Return:
Detailed description of card display parameters in Bitrix24 REST API documentation.
14) customize_attach_record_url
Customization of attaching a link to a call recording. Runs only if it is configured to attach a link to a record instead of a call record file.
By default, the HTML code of the audio player (audio tag) with a link to the call record is written to the case description.
Input:
Only non-empty/non-zero fields are present in the raw object.
Return:
Detailed description of the case fields in Bitrix24 REST API documentation.
Last updated
Was this helpful?