Class ViberRequest

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

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

See

(https://developers.viber.com/docs/api/rest-bot-api/) Смотри тут

Hierarchy

ViberRequest

Index

Constructors

constructor

new ViberRequest(): ViberRequest
ViberRequest constructor.

Returns ViberRequest
- Defined in src/api/ViberRequest.ts:46

Properties

`Protected` _error

_error: null | string

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

`Protected` _request

_request: Request

Отправка запросов.

See

Request Смотри тут

token

token: null | string

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

Methods

`Protected` _log

_log(error?: string): void
Запись логов.
Parameters
- error: string = ''
  
  Текст ошибки.
Returns void
- Defined in src/api/ViberRequest.ts:289

call

call<T>(method: string): Promise<null | T>
Отвечает за отправку запросов на viber сервер.

Returns
Promise

Api
Type Parameters
- T extends IViberApi
Parameters
- method: string
  
  Название метода.
Returns Promise<null | T>
- Defined in src/api/ViberRequest.ts:72

getUserDetails

getUserDetails(id: string): Promise<null | IViberGetUserDetails>
Запрос будет получать сведения о конкретном пользователе Viber на основе его уникального идентификатора. Этот запрос может быть отправлен дважды в течение 12 часов для каждого идентификатора пользователя.

See
(https://developers.viber.com/docs/api/rest-bot-api/#get-user-details) Смотри тут

Returns
Promise [
- 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: Тип устройства пользователя. ] ]
Api
Parameters
- id: string
  
  Уникальный идентификатор пользователя.
Returns Promise<null | IViberGetUserDetails>
- Defined in src/api/ViberRequest.ts:129

initToken

initToken(token: string): void
Установить токен.

Api
Parameters
- token: string
  
  Токен необходимый для отправки данных на сервер.
Returns void
- Defined in src/api/ViberRequest.ts:61

richMedia

richMedia(receiver: string, richMedia: IViberButton[], params?: null | IViberRichMediaParams): Promise<null | IViberApi>
Отправка карточки пользователю.

See
- (https://developers.viber.com/docs/api/rest-bot-api/#message-types) Смотри тут
- sendMessage() Смотри тут
Returns
Promise

Api
Parameters
- receiver: string
  
  Уникальный идентификатор пользователя Viber.
- richMedia: IViberButton[]
  
  Отображаемые данные. Параметр 'Buttons'.
- params: null | IViberRichMediaParams = null
  
  Дополнительные параметры.
Returns Promise<null | IViberApi>
- Defined in src/api/ViberRequest.ts:239

sendFile

sendFile(receiver: string, file: string, params?: null | IViberParams): null | Promise<null | IViberApi>
Отправить файл на сервер.

Returns
Promise

See
sendMessage() Смотри тут

Api
Parameters
- receiver: string
  
  Уникальный идентификатор пользователя Viber.
- file: string
  
  Ссылка на файл.
- params: null | IViberParams = null
  
  Дополнительные параметры.
Returns null | Promise<null | IViberApi>
- Defined in src/api/ViberRequest.ts:267

sendMessage

sendMessage(receiver: string, sender: string | IViberSender, text: string, params?: null | IViberParams): Promise<null | IViberApi>
Отправка сообщения пользователю. Отправка сообщения пользователю будет возможна только после того, как пользователь подпишется на бота, отправив ему сообщение.

See
(https://developers.viber.com/docs/api/rest-bot-api/#send-message) Смотри тут

Returns
Promise

Api
Parameters
- receiver: string
  
  Уникальный идентификатор пользователя Viber.
- sender: string | IViberSender
  Отправитель: [
  - string name: Имя отправителя для отображения (Максимум 28 символов).
  - string avatar: URL-адрес Аватара отправителя (Размер аватара должен быть не более 100 Кб. Рекомендуется 720x720). ]
- text: string
  
  Текст сообщения.
- params: null | IViberParams = null
  Дополнительные параметры: [
  - 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. ]
Returns Promise<null | IViberApi>
- Defined in src/api/ViberRequest.ts:176

setWebhook

setWebhook(url: string, params?: null | IViberWebhookParams): Promise<null | IViberApi>
Установка webhook для vider.

See
(https://developers.viber.com/docs/api/rest-bot-api/#webhooks) Смотри тут

Returns
Promise

Api
Parameters
- url: string
  
  Адрес webhook`а.
- params: null | IViberWebhookParams = null
  
  Дополнительные параметры.
Returns Promise<null | IViberApi>
- Defined in src/api/ViberRequest.ts:202

Class ViberRequest

See

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ViberRequest

Properties

Protected _error

Protected _request

See

token

Methods

Protected _log

Parameters

error: string = ''

Returns void

call

Returns

Api

Type Parameters

T extends IViberApi

Parameters

method: string

Returns Promise<null | T>

getUserDetails

See

Returns

Api

Parameters

id: string

Returns Promise<null | IViberGetUserDetails>

initToken

Api

Parameters

token: string

Returns void

richMedia

See

Returns

Api

Parameters

receiver: string

richMedia: IViberButton[]

params: null | IViberRichMediaParams = null

Returns Promise<null | IViberApi>

sendFile

Returns

See

Api

Parameters

receiver: string

file: string

params: null | IViberParams = null

Returns null | Promise<null | IViberApi>

sendMessage

See

Returns

Api

Parameters

receiver: string

sender: string | IViberSender

text: string

params: null | IViberParams = null

Returns Promise<null | IViberApi>

setWebhook

See

Returns

Api

Parameters

url: string

params: null | IViberWebhookParams = null

Returns Promise<null | IViberApi>

Settings

Member Visibility

Theme

`Protected` _error

`Protected` _request

`Protected` _log