Описание класса ViberRequest | Universal Bot

ViberRequest
in

Класс отвечающий за отправку запросов на viber сервер.

Документация по viber api.

Table of Contents

API_ENDPOINT 'https://chatapi.viber.com/pa/'
$request Отправка запросов. Request
$error Ошибки при выполнении. string
$token Авторизационный токен бота, необходимый для отправки данных. string|null
__construct() ViberRequest constructor. mixed
initToken() Установить токен. void
call() Отвечает за отправку запросов на viber сервер. array|null
getUserDetails() Запрос будет получать сведения о конкретном пользователе Viber на основе его уникального идентификатора. array|null
sendMessage() Отправка сообщения пользователю. array|null
setWebhook() Установка webhook для vider. array|null
richMedia() Отправка карточки пользователю. array|null
sendFile() Отправить файл на сервер. array|null
log() Запись логов. void

Constants

API_ENDPOINT

mixed $API_ENDPOINT = 'https://chatapi.viber.com/pa/'

Properties

$error

Ошибки при выполнении.

protected string $error

$token

Авторизационный токен бота, необходимый для отправки данных.

public string|null $token

Methods

__construct()

ViberRequest constructor.

public __construct( ) : mixed
Return values
mixed

initToken()

Установить токен.

public initToken( $token : string ) : void
Parameters
$token : string

Токен необходимый для отправки данных на сервер.

Tags
api

call()

Отвечает за отправку запросов на viber сервер.

public call( $method : string ) : array|null
Parameters
$method : string

Название метода.

Tags
api
throws
Return values
array|null

getUserDetails()

Запрос будет получать сведения о конкретном пользователе Viber на основе его уникального идентификатора.

public getUserDetails( $id : string ) : array|null

Этот запрос может быть отправлен дважды в течение 12 часов для каждого идентификатора пользователя.

Parameters
$id : string

Уникальный идентификатор пользователя.

Tags
see

Смотри тут

api
throws
Return values
array|null —

[

  • int status: Результат действия.
  • string status_message: Статус сообщения.
  • int message_token: Уникальный идентификатор сообщения.
  • array user: Информация о пользователе. [
    • string id: Уникальный идентификатор пользователя Viber.
    • string name: Имя пользователя Viber.
    • string avatar: URL-адрес аватара пользователя.
    • string country: Код страны пользователя.
    • string language: Язык телефона пользователя. Будет возвращен в соответствии с языком устройства.
    • string primary_device_os: Тип операционной системы и версия основного устройства пользователя.
    • int api_version: Версия Viber, установленная на основном устройстве пользователя.
    • string viber_version: Версия Viber, установленная на основном устройстве пользователя.
    • int mcc: Мобильный код страны.
    • int mnc: Код мобильной сети.
    • string device_type: Тип устройства пользователя. ] ]

sendMessage()

Отправка сообщения пользователю.

public sendMessage( $receiver : string , $sender : array|string , $text : string [, $params : array = [] ] ) : array|null

Отправка сообщения пользователю будет возможна только после того, как пользователь подпишется на бота, отправив ему сообщение.

Parameters
$receiver : string

Уникальный идентификатор пользователя Viber.

$sender : array|string

Отправитель: [

  • string name: Имя отправителя для отображения (Максимум 28 символов).
  • string avatar: URL-адрес Аватара отправителя (Размер аватара должен быть не более 100 Кб. Рекомендуется 720x720). ]
$text : string

Текст сообщения.

$params : array = []

Дополнительные параметры: [

  • string receiver: Уникальный идентификатор пользователя Viber.
  • string type: Тип сообщения. (Доступные типы сообщений: text, picture, video, file, location, contact, sticker, carousel content и url).
  • string $sender Отправитель.
  • string tracking_data: Разрешить учетной записи отслеживать сообщения и ответы пользователя. Отправлено tracking_data значение будет передано обратно с ответом пользователя.
  • string min_api_version: Минимальная версия API, необходимая клиентам для этого сообщения (по умолчанию 1).
  • string $text Текст сообщения. (Обязательный параметр).
  • string media: Url адрес отправляемого контента. Актуально при отправке файлов.
  • string thumbnail: URL-адрес изображения уменьшенного размера. Актуально при отправке файлов.
  • int size: Размер файла в байтах.
  • int duration: Продолжительность видео или аудио в секундах. Будет отображаться на приемнике.
  • string file_name: Имя файла. Актуально для type = file.
  • array contact: Контакты пользователя. Актуально для type = contact. [
    • string name: Имя контактного лица.
    • string phone_number: Номер телефона контактного лица. ]
  • array location: Координаты местоположения. Актуально для type = location. [
    • string lat: Координата lat.
    • string lon: Координата lon. ]
  • int sticker_id: Уникальный идентификатор стикера Viber. Актуально для type = sticker. ]
Tags
see

Смотри тут

api
throws
Return values
array|null

setWebhook()

Установка webhook для vider.

public setWebhook( $url : string [, $params : array = [] ] ) : array|null
Parameters
$url : string

Адрес webhook`а.

$params : array = []

Дополнительные параметры.

Tags
see

Смотри тут

api
throws
Return values
array|null

richMedia()

Отправка карточки пользователю.

public richMedia( $receiver : string , $richMedia : array [, $params : array = [] ] ) : array|null
Parameters
$receiver : string

Уникальный идентификатор пользователя Viber.

$richMedia : array

Отображаемые данные. Параметр 'Buttons'.

$params : array = []

Дополнительные параметры.

Tags
see

Смотри тут

see

Смотри тут

api
throws
Return values
array|null

sendFile()

Отправить файл на сервер.

public sendFile( $receiver : string , $file : string [, $params : array = [] ] ) : array|null
Parameters
$receiver : string

Уникальный идентификатор пользователя Viber.

$file : string

Ссылка на файл.

$params : array = []

Дополнительные параметры.

Tags
see

Смотри тут

api
throws
Return values
array|null

log()

Запись логов.

protected log( $error : string ) : void
Parameters
$error : string

Текст ошибки.

Tags
throws

Search results