Bitrix API

BitrixCall extends Call

Table of Contents

Constants

PROVIDER_BITRIX  = 'Bitrix'
PROVIDER_PLAIN  = 'Plain'
PROVIDER_VOXIMPLANT  = 'Voximplant'
STATE_ANSWERED  = 'answered'
STATE_FINISHED  = 'finished'
STATE_INVITING  = 'inviting'
STATE_NEW  = 'new'
TYPE_INSTANT  = 1
TYPE_LANGE  = 3
TYPE_PERMANENT  = 2

Methods

addError()  : void
Upends stack of errors.
addErrors()  : void
Add multiple errors
addUser()  : CallUser|null
Adds new user to the call.
autoStartRecording()  : bool
Do need to record call.
checkAccess()  : bool
Returns true if specified user has access to the call.
createWithArray()  : Call
Creates new instance of the Call with values from the database.
createWithEntity()  : Call
Use this constructor only for creating new calls
disableAiAnalyze()  : self
Disable AI analyze.
disableAudioRecord()  : self
Disable record call.
enableAiAnalyze()  : self
Do AI analyze.
enableAudioRecord()  : self
Do need to record call.
finish()  : void
getActionUserId()  : int|null
getAssociatedEntity()  : AbstractEntity|null
getCallUsers()  : array<string|int, CallUser>
Returns arrays of the users, currently participating in the call.
getChatId()  : int
Returns id of the chat, associated with the call.
getConnectionData()  : array<string|int, mixed>
getDuration()  : int
Returns call duration.
getEndDate()  : DateTime|null
Returns date of the call end (if there is one).
getEndpoint()  : mixed
getErrors()  : array<string|int, Error>
getId()  : int
getInitiatorId()  : int
getLogService()  : string
getLogToken()  : string
getMaxCallLimit()  : int
getMaxCallServerParticipants()  : int
getMaxParticipants()  : int
getMaxUsers()  : int
getParentId()  : int|null
getProvider()  : string
getSecretKey()  : mixed
getSignaling()  : Signaling
getStartDate()  : DateTime
Returns date of the call start.
getState()  : string
getType()  : int
getUser()  : CallUser|null
getUserCount()  : int
getUserData()  : array<string|int, mixed>
Returns arrays of information about the users currently participating in the call.
getUsers()  : array<string|int, int>
Returns arrays of ids of the users, currently participating in the call.
getUuid()  : mixed
hasActiveUsers()  : bool
Call is considered active if it has at least: - one user in ready state - another user in ready or calling state
hasErrors()  : bool
Tells true if error have happened.
hasUser()  : bool
Return true if a user is the part of the call.
inviteUsers()  : void
isAiAnalyzeEnabled()  : bool
Analyze call with AI enabled.
isAudioRecordEnabled()  : bool
Record call.
isBitrixCallEnabled()  : bool
isCallServerEnabled()  : bool
isFeedbackAllowed()  : bool
isIosBetaEnabled()  : bool
loadWithId()  : Call|null
makeClone()  : Call
onVoximplantConferenceFinished()  : void
removeUser()  : void
save()  : void
setActionUserId()  : self
setAssociatedEntity()  : void
setEndpoint()  : void
setLogUrl()  : void
toArray()  : array<string|int, mixed>
updateState()  : bool

Constants

PROVIDER_BITRIX

public mixed PROVIDER_BITRIX = 'Bitrix'

PROVIDER_PLAIN

public mixed PROVIDER_PLAIN = 'Plain'

PROVIDER_VOXIMPLANT

public mixed PROVIDER_VOXIMPLANT = 'Voximplant'

STATE_ANSWERED

public mixed STATE_ANSWERED = 'answered'

STATE_FINISHED

public mixed STATE_FINISHED = 'finished'

STATE_INVITING

public mixed STATE_INVITING = 'inviting'

STATE_NEW

public mixed STATE_NEW = 'new'

TYPE_INSTANT

public mixed TYPE_INSTANT = 1

TYPE_LANGE

public mixed TYPE_LANGE = 3

TYPE_PERMANENT

public mixed TYPE_PERMANENT = 2

Methods

addError()

Upends stack of errors.

public addError(Error $error) : void
Parameters
$error : Error

Error message object.

addErrors()

Add multiple errors

public addErrors(array<string|int, Error> $errors) : void
Parameters
$errors : array<string|int, Error>

addUser()

Adds new user to the call.

public addUser(int $newUserId) : CallUser|null
Parameters
$newUserId : int
Return values
CallUser|null

autoStartRecording()

Do need to record call.

public autoStartRecording() : bool
Return values
bool

checkAccess()

Returns true if specified user has access to the call.

public checkAccess(int $userId) : bool
Parameters
$userId : int

Id of the user.

Return values
bool

createWithArray()

Creates new instance of the Call with values from the database.

public static createWithArray(array<string|int, mixed> $fields) : Call
Parameters
$fields : array<string|int, mixed>

Call fields

Return values
Call

createWithEntity()

Use this constructor only for creating new calls

public static createWithEntity(int $type, string $provider, string $entityType, string $entityId, int $initiatorId) : Call
Parameters
$type : int
$provider : string
$entityType : string
$entityId : string
$initiatorId : int
Return values
Call

disableAiAnalyze()

Disable AI analyze.

public disableAiAnalyze() : self
Return values
self

disableAudioRecord()

Disable record call.

public disableAudioRecord() : self
Return values
self

enableAiAnalyze()

Do AI analyze.

public enableAiAnalyze() : self
Return values
self

enableAudioRecord()

Do need to record call.

public enableAudioRecord() : self
Return values
self

getActionUserId()

public getActionUserId() : int|null
Return values
int|null

getCallUsers()

Returns arrays of the users, currently participating in the call.

public getCallUsers() : array<string|int, CallUser>
Return values
array<string|int, CallUser>

getChatId()

Returns id of the chat, associated with the call.

public getChatId() : int
Return values
int

getConnectionData()

public getConnectionData(int $userId) : array<string|int, mixed>
Parameters
$userId : int
Return values
array<string|int, mixed>

getDuration()

Returns call duration.

public getDuration() : int
Return values
int

getEndDate()

Returns date of the call end (if there is one).

public getEndDate() : DateTime|null
Return values
DateTime|null

getEndpoint()

public getEndpoint() : mixed

getErrors()

public getErrors() : array<string|int, Error>
Return values
array<string|int, Error>

getId()

public getId() : int
Return values
int

getInitiatorId()

public getInitiatorId() : int
Return values
int

getLogService()

public static getLogService() : string
Return values
string

getLogToken()

public getLogToken([int $userId = 0 ][, int $ttl = 3600 ]) : string
Parameters
$userId : int = 0
$ttl : int = 3600
Return values
string

getMaxCallLimit()

public static getMaxCallLimit() : int
Return values
int

getMaxCallServerParticipants()

public static getMaxCallServerParticipants() : int
Return values
int

getMaxParticipants()

public static getMaxParticipants() : int
Return values
int

getMaxUsers()

public getMaxUsers() : int
Return values
int

getParentId()

public getParentId() : int|null
Return values
int|null

getProvider()

public getProvider() : string
Return values
string

getSecretKey()

public getSecretKey() : mixed

getState()

public getState() : string
Return values
string

getType()

public getType() : int
Return values
int

getUser()

public getUser(int $userId) : CallUser|null
Parameters
$userId : int
Return values
CallUser|null

getUserCount()

public getUserCount() : int
Return values
int

getUserData()

Returns arrays of information about the users currently participating in the call.

public getUserData() : array<string|int, mixed>
Return values
array<string|int, mixed>

getUsers()

Returns arrays of ids of the users, currently participating in the call.

public getUsers() : array<string|int, int>
Return values
array<string|int, int>

getUuid()

public getUuid() : mixed

hasActiveUsers()

Call is considered active if it has at least: - one user in ready state - another user in ready or calling state

public hasActiveUsers([bool $strict = true ]) : bool
Parameters
$strict : bool = true
Return values
bool

hasErrors()

Tells true if error have happened.

public hasErrors() : bool
Return values
bool

hasUser()

Return true if a user is the part of the call.

public hasUser(int $userId) : bool
Parameters
$userId : int

Id of the user.

Return values
bool

inviteUsers()

public inviteUsers(int $senderId, array<string|int, mixed> $toUserIds, mixed $isLegacyMobile[, mixed $video = false ][, mixed $sendPush = true ]) : void
Parameters
$senderId : int
$toUserIds : array<string|int, mixed>
$isLegacyMobile : mixed
$video : mixed = false
$sendPush : mixed = true

isAiAnalyzeEnabled()

Analyze call with AI enabled.

public isAiAnalyzeEnabled() : bool
Return values
bool

isAudioRecordEnabled()

Record call.

public isAudioRecordEnabled() : bool
Return values
bool

isBitrixCallEnabled()

public static isBitrixCallEnabled() : bool
Return values
bool

isCallServerEnabled()

public static isCallServerEnabled() : bool
Return values
bool

isFeedbackAllowed()

public static isFeedbackAllowed() : bool
Return values
bool

isIosBetaEnabled()

public static isIosBetaEnabled() : bool
Return values
bool

loadWithId()

public static loadWithId(mixed $id) : Call|null
Parameters
$id : mixed
Return values
Call|null

makeClone()

public makeClone([mixed $newProvider = null ]) : Call
Parameters
$newProvider : mixed = null
Return values
Call

onVoximplantConferenceFinished()

public static onVoximplantConferenceFinished(Event $event) : void
Parameters
$event : Event

removeUser()

public removeUser(mixed $userId) : void
Parameters
$userId : mixed

save()

public save() : void

setActionUserId()

public setActionUserId(int $byUserId) : self
Parameters
$byUserId : int
Return values
self

setAssociatedEntity()

public setAssociatedEntity(string $entityType, int $entityId) : void
Parameters
$entityType : string
$entityId : int
Tags
throws
ArgumentException

setEndpoint()

public setEndpoint(mixed $endpoint) : void
Parameters
$endpoint : mixed

setLogUrl()

public setLogUrl(string $logUrl) : void
Parameters
$logUrl : string

toArray()

public toArray([mixed $currentUserId = 0 ][, mixed $withSecrets = false ]) : array<string|int, mixed>
Parameters
$currentUserId : mixed = 0
$withSecrets : mixed = false
Return values
array<string|int, mixed>

updateState()

public updateState(string $state) : bool
Parameters
$state : string
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results