Граф наследования:AbstractProvider:

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

Базовый класс провайдера услуг телефонии

Открытые члены
	getTitle ()

	getId ()

	onEvent (Request $url)

	setUrlSecret ($secret)

	getUrlSecret ()

	getEventGateUrl ($event_type=null)

	getAllowEventTypes ()

	getEventTestObject ()

	getActionsByCall (CallHistory $call)

	getExtensionIdByUserId ($user_id)

	getUserIdByExtensionId ($extension_id)

	getConnectSettingsInfo ()

	getRequester ()

	authorizeRequester (Requester $requester, $force=false)

	getAccessToken ($params=[], $force=false)

	canApiRequest ()

	isEnableAutoDownloadRecord ()

	getRecordDataLocalPath (CallHistory $call)

	issetRecordLocal (CallHistory $call)

	downloadRecord (CallHistory $call)

	getRecordData (CallHistory $call, $find_local=true)

	getRecordContentType ()

	canCalling ()

	CallPhoneNumber ($number)

	isInternalCall (CallHistory $call)

	setError ($error)

	getLastError ()

Открытые статические члены
static	getRecordLocalBaseDir ()

Поля данных
const	EVENT_TYPE_DIAL_IN = 'dial-in'

const	EVENT_TYPE_DIAL_OUT = 'dial-out'

const	EVENT_TYPE_ANSWER = 'answer'

const	EVENT_TYPE_HANGOUT = 'hangup'

const	METHOD_GET = 'GET'

const	METHOD_POST = 'POST'

Защищенные данные
	$settings_info_template = ''

	$last_error

Методы

authorizeRequester	(	Requester	$requester,
			$force = `false`
	)

abstract

Получает авторизационный токен и устанавливает его в Requester

Аргументы

Requester	$requester
bool	$force

Возвращает: mixed

CallPhoneNumber ( $number )

abstract

Отправляет запрос на исходящий вызов

Аргументы

$number

Возвращает: bool

canApiRequest ( )

abstract

Возвращает true, если заполнены все данные для проведения исходящих запросов к API

Возвращает: bool

canCalling ( )

abstract

Возвращает true, если телфония поддерживает исходящие звонки

Возвращает: bool

downloadRecord ( CallHistory $call )

abstract

Производит попытку загрузки записи на локальный диск

Аргументы

CallHistory $call

Возвращает: bool

getAccessToken	(	$params = `[]`,
		$force = `false`
	)

abstract

Возвращает последний полученный AccessToken. Если force=true, то происходит принудительная переполучение токена

Аргументы

bool $force

Возвращает: string | bool(false)

getActionsByCall ( CallHistory $call )

abstract

Возвращает список действий, который можно произвести со звонком в зависимости от статуса звонка

Аргументы

CallHistory $call

Возвращает: array [ ['text' => 'ТЕКСТ КНОПКИ','attr' => ['data-url' => '', АТТРИБУТЫ...]], ['text' => 'ТЕКСТ КНОПКИ','attr' => ['data-url' => '', АТТРИБУТЫ...]], ]

data-url - может содержать ссылку на контроллер действий звонков crm-callactions, с GET параметрами:

call_id ID звонка
call_action имя действия. В этом случае должен присутствовать метод do{ИМЯ_ДЕЙСТВИЯ} в классе провайдера

getAllowEventTypes ( )

Возвращает поддерживаемые типы входящих событий

Возвращает: array

getConnectSettingsInfo ( )

Возвращает HTML со сведениями о настройке телефонии

Возвращает: string

getEventGateUrl ( $event_type = null )

Возвращает URL обработчика события

Аргументы

string $event_type Зарезервировано для различных типов событий

Возвращает: string

getEventTestObject ( )

abstract

Возвращает объект, который описывает тесты для данного провайдера.

Возвращает: AbstractProviderTest

getExtensionIdByUserId ( $user_id )

abstract

Возвращает добавочный номер для администратора user_id, если таковой задан. Иначе - false

Аргументы

integer $user_id

Возвращает: integer|bool(false)

getId ( )

abstract

Возвращает внутренний строковый идентификатор провайдера связи

Возвращает: string

getLastError ( )

Возвращает последнюю ошибку

Возвращает: string

getRecordContentType ( )

abstract

Возвращает Mime тип аудиозаписи

Возвращает: string

getRecordData	(	CallHistory	$call,
			$find_local = `true`
	)

abstract

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

Аргументы

CallHistory	$call
bool	$find_local

Возвращает: bool

getRecordDataLocalPath ( CallHistory $call )

abstract

Возвращает путь записи на локальном диске. Или false - в случае, если провайдер не поддерживает работу с записями

Аргументы

CallHistory $call

Возвращает: string|bool(false)

static getRecordLocalBaseDir ( )

static

Возвращает базовый абсолютный путь к папке с записями

Возвращает: string

getRequester ( )

Возвращает объект для запросов, сразу инициализированный функцией

Возвращает: Requester

getTitle ( )

abstract

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

Возвращает: string

getUrlSecret ( )

Возвращает секретный ключ, который будет использоваться в URL для событий

Возвращает: string

getUserIdByExtensionId ( $extension_id )

abstract

Возвращает ID пользователя по добавочному номеру

Аргументы

$extension_id

Возвращает: mixed

isEnableAutoDownloadRecord ( )

abstract

Возвращает true, если включена автоматическая загрузка записей разговоров после отбоя

Возвращает: bool

Исключения

\RS\Exception

isInternalCall ( CallHistory $call )

abstract

Возвращает true, если удается определить, что это внутренний вызов между сотрудниками телефонии. Такие вызовы должны игнорироваться и не регистрироваться в административной панели

Аргументы

CallHistory $call Здесь будет объект звонка, который еще не присутствует в базе (ID = null)

Возвращает: mixed

issetRecordLocal ( CallHistory $call )

abstract

Возвращает true, если запись разговора присутствует локально

Аргументы

CallHistory $call

Возвращает: bool

onEvent ( Request $url )

abstract

Обрабатывает входящий запрос с событием от сервиса телефонии

Аргументы

Request $url

Возвращает: CallEvent

setError ( $error )

Устанавливает ошибку

Аргументы

$error

Возвращает: bool(false)

setUrlSecret ( $secret )

Устанавливает секретный ключ, который будет использоваться в URL для событий

Аргументы

$secret

Поля

$last_error

protected

$settings_info_template = ''

protected

const EVENT_TYPE_ANSWER = 'answer'

const EVENT_TYPE_DIAL_IN = 'dial-in'

const EVENT_TYPE_DIAL_OUT = 'dial-out'

const EVENT_TYPE_HANGOUT = 'hangup'

const METHOD_GET = 'GET'

const METHOD_POST = 'POST'

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

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

Открытые статические члены

Поля данных

Защищенные данные

Методы

Поля