Версия: 6.x
burger close
Класс CallEvent

Подробное описание

Класс описывает стандартизированный объект события от телефонии. Такой объект ожидается от любого провайдера, после обработки входящего запроса от телефонии.

Открытые члены

 __construct (AbstractProvider $provider)
 
 getProvider ()
 
 getEventType ()
 
 setEventType ($eventType)
 
 getCallID ()
 
 setCallID ($callID)
 
 getCallerNumber ()
 
 setCallerNumber ($callerNumber)
 
 getCalledNumber ()
 
 setCalledNumber ($calledNumber)
 
 getCallStatus ()
 
 setCallStatus ($callStatus)
 
 getCallFlow ()
 
 setCallFlow ($callFlow)
 
 getSubCallID ()
 
 setSubCallID ($subCallID)
 
 getRecID ()
 
 setRecID ($recID)
 
 getDuration ()
 
 setDuration ($duration)
 
 getCallAPIID ()
 
 setCallAPIID ($callAPIID)
 
 getEventTime ()
 
 setEventTime ($eventTime)
 
 getData ()
 
 setData (array $data)
 
 getCalledDID ()
 
 setCalledDID ($calledDID)
 
 getReturnData ()
 
 setReturnData ($returnData)
 
 getCallSubStatus ()
 
 setCallSubStatus ($callSubStatus)
 
 getCallIdWithProvider ()
 
 getCallerId ()
 
 setCallerId ($callerId)
 
 getCalledId ()
 
 setCalledId ($calledId)
 

Конструктор(ы)

__construct ( AbstractProvider  $provider)

Конструктор

Аргументы
AbstractProvider$provider

Методы

getCallAPIID ( )

Возвращает содержимое SIP заголовка "Client-Api-Id"

Возвращает
string
getCalledDID ( )

Возвращает публичный номер вызываемого абонента (если есть)

Возвращает
string
getCalledId ( )

Возвращает ID вызываемого в телефонии

Возвращает
mixed
getCalledNumber ( )

Возвращает номер вызываемого абонента

Возвращает
string
getCallerId ( )

Возвращает ID звонящего в телефонии

Возвращает
mixed
getCallerNumber ( )

Возвращает номер вызывающего абонента в нормализованом виде

Возвращает
string
getCallFlow ( )

Возвращает направление звонка

Возвращает
string
getCallID ( )

Возвращает ID вызова

Возвращает
string
getCallIdWithProvider ( )

Возвращает ID звонка вместе с провайдером

Возвращает
string
getCallStatus ( )

Возвращает статус звонка

Возвращает
string
getCallSubStatus ( )

Возвращает статус звонка на момент завершения разговора

Возвращает
mixed
getData ( )

Возвращает дополнительные произвольные сведения

Возвращает
array
getDuration ( )

Возвращает длительность разговора, в микросекундах

Возвращает
int
getEventTime ( )

Возвращает время события в формате YYYY-MM-DD HH:MM:SS

Возвращает
string
getEventType ( )

Возвращает тип события. Может принимать значния dial-in, dial-out, hangup или answer в зависимости от типа события.

Возвращает
string
getProvider ( )

Возвращает провайдера телефонии

Возвращает
AbstractProvider
getRecID ( )

Возвращает ID файла с записью разговора

Возвращает
string
getReturnData ( )

Возвращает данные, которые необходимо вернуть в ответ на запрос

Возвращает
string
getSubCallID ( )

Возвращает ID звонка с учетом переадресации

Возвращает
string
setCallAPIID (   $callAPIID)

Устанавливает содержимое SIP заголовка "Client-Api-Id"

Аргументы
string$callAPIID
Возвращает
self
setCalledDID (   $calledDID)

Устанавливает публичный номер вызываемого абонента (если есть)

Аргументы
string$calledDID
Возвращает
self
setCalledId (   $calledId)

Устанавливает ID вызываемого в телефонии

Аргументы
mixed$calledId
Возвращает
self
setCalledNumber (   $calledNumber)

Устанавливает номер вызываемого абонента

Аргументы
string$calledNumber
Возвращает
self
setCallerId (   $callerId)

Устанавливает ID звонящего в телефонии

Аргументы
mixed$callerId
Возвращает
self
setCallerNumber (   $callerNumber)

Устанавливает номер вызывающего абонента

Аргументы
string$callerNumber
Возвращает
self
setCallFlow (   $callFlow)

Устанавливает направление звонка

Аргументы
string$callFlow
Возвращает
self
setCallID (   $callID)

Устанавливает ID вызова

Аргументы
string$callID
Возвращает
self
setCallStatus (   $callStatus)

Устанавливает статус звонка (Идет звонок, идет разговор, разговор завершен)

Аргументы
string$callStatus
Возвращает
self
setCallSubStatus (   $callSubStatus)

Устанавливает статус звонка на момент завершения разговора

Аргументы
string$callSubStatus
Возвращает
self
setData ( array  $data)

Устанавливает дополнительные произвольные сведения

Аргументы
array$data
Возвращает
self
setDuration (   $duration)

Устанавливает длительность разговора, в микросекундах

Аргументы
int$duration
Возвращает
self
setEventTime (   $eventTime)

Устанваливает время события в формате YYYY-MM-DD HH:MM:SS

Аргументы
string$eventTime
Возвращает
self
setEventType (   $eventType)

Устанавливает тип события

Аргументы
string$eventType
Возвращает
self
setRecID (   $recID)

Устанавливает ID файла с записью разговора

Аргументы
string$recID
Возвращает
self
setReturnData (   $returnData)

Устанавливает данные, которые необходимо вернуть в ответ на запрос

Аргументы
string$returnData
Возвращает
self
setSubCallID (   $subCallID)

Устанавливает ID звонка с учетом переадресации

Аргументы
string$subCallID
Возвращает
self