Documentation

telephony.externalcall.finish

Scope: catalog Permissions to execute: for all

Method completes the call, registers it in the statistics and hides the call ID screen from the user.

Returned value

Returns an array similar to the method voximplant.statistic.get.

Function parameters

Parameter DescriptionType of value
CALL_ID Call ID from the telephony.externalcall.register method. Required.string
USER_ID User ID. Required. User indicated as responsible in a lead will be updated with the passed USER_ID. This responsible user will be updated only for the lead created automatically when calling the method telephony.externalcall.register. Responsible user isn't updated for the existing lead. int
DURATION Duration in seconds. Required.int
COST Call cost.double
COST_CURRENCY Currency, in which the call cost is indicated. List of currencies can be retrieved by crm.currency.list method.string
STATUS_CODE Call code (see. table with call codes.string
FAILED_REASON Reason for an unsuccessful call.string
RECORD_URL File URL (preferably mp3) with the call record.

Bitrix24 instance attempts to download the record by specified address. If unsuccessful, record won't be attached and no error notification is sent.

This parameter has been deprecated and remains for compatibility purposes only. It's strongly recommended not to use it. Use the method telephony.externalCall.attachRecord to download the call record instead.

string
VOTE Evaluation of a call by the user (if PBX supports functionality of conversation evaluation).int
ADD_TO_CHAT Option to add a message on the performed call to the B24 employee into chat (Possible values are 0 or 1, by default is 0).int

Instead of USER_ID also can be USER_PHONE_INNER.



© «Bitrix24», 2001-2024