Class Call

Клас Call: Описує властивості і методи для роботи з дзвінком, включаючи інформацію про його стан, учасників, медіа потоки, та інші атрибути.

Конструктор Call: client: Клієнт, що керує дзвінком. e: Дані події дзвінка, які використовуються для ініціалізації властивостей класу. В конструкторі здійснюється ініціалізація всіх властивостей класу на основі переданих даних події дзвінка (e). Значення за замовчуванням задаються для необов'язкових полів, якщо вони не присутні в об'єкті e.

Constructors

Properties

_activeCounter: number
_autoAnswerTimerId: any
_eavesdrop: null | EavesdropData
_muted: boolean
answeredAt: number
appId: string
applications: string[]
autoAnswered: boolean
bridgedAt: number
bridgedId: string
client: Client

Клієнт, що керує дзвінком.

contact: null | Contact
createdAt: number
data: any
destination: string
digits: string[]
direction: string
hangupAt: number
hangupCause: string
hangupSipCode: number
id: string
localStreams: MediaStream[]
notificationHangup: boolean
originate: boolean
params: CallParams
parentId?: string
peerStreams: MediaStream[]
postProcessData: object
queue: null | QueueParameters
reportingAt: number
screen: null | string
sip: null | CallSession
sipId: null | string
state: string
task: null | Task
toName: string
toNumber: string
variables: Map<string, string>
voice: boolean

Accessors

  • get active(): boolean
  • Перевіряє, чи дзвінок активний.

    Returns boolean

    Чи дзвінок активний.

  • get allowAnswer(): undefined | boolean
  • Перевіряє, чи дозволено відповісти на дзвінок.

    Returns undefined | boolean

    Чи дозволено відповісти на дзвінок.

  • get allowDtmf(): boolean
  • Перевіряє, чи дозволено DTMF.

    Returns boolean

    Чи дозволено DTMF.

  • get allowHangup(): boolean
  • Перевіряє, чи дозволено завершення дзвінка.

    Returns boolean

    Чи дозволено завершення дзвінка.

  • get allowHold(): boolean
  • Перевіряє, чи дозволено утримання дзвінка.

    Returns boolean

    Чи дозволено утримання дзвінка.

  • get allowInboundVideo(): boolean
  • Перевіряє, чи дозволено відео для вхідних дзвінків.

    Returns boolean

    Чи дозволено відео для вхідних дзвінків.

  • get allowOutboundVideo(): boolean
  • Перевіряє, чи дозволено відео для вихідних дзвінків.

    Returns boolean

    Чи дозволено відео для вихідних дзвінків.

  • get allowReporting(): boolean
  • Перевіряє, чи дозволена звітність.

    Returns boolean

    Чи дозволена звітність.

  • get allowUnHold(): boolean
  • Перевіряє, чи дозволено зняти утримання.

    Returns boolean

    Чи дозволено зняти утримання.

  • get attempt(): null | Task
  • Отримує спробу.

    Returns null | Task

    Спроба.

  • get autoAnswer(): boolean
  • Перевіряє, чи дозволено автоматичне відповідання.

    Returns boolean

    Чи дозволено автоматичне відповідання.

  • get autoAnswerDelay(): number
  • Отримує затримку автоматичного відповідання.

    Returns number

    Затримка автоматичного відповідання.

  • get contactId(): null | number
  • Отримує ідентифікатор контакту.

    Returns null | number

    Ідентифікатор контакту або null.

  • get display(): string
  • Отримує відображення дзвінка.

    Returns string

    Відображення дзвінка.

  • get displayName(): undefined | string
  • Отримує ім'я для відображення.

    Returns undefined | string

    Ім'я для відображення.

  • get displayNumber(): undefined | string
  • Отримує номер для відображення.

    Returns undefined | string

    Номер для відображення.

  • get duration(): number
  • Отримує тривалість дзвінка.

    Returns number

    Тривалість дзвінка в секундах.

  • get eavesdropDuration(): undefined | number
  • Отримує тривалість прослуховування.

    Returns undefined | number

    Тривалість прослуховування.

  • get eavesdropIsConference(): boolean
  • Перевіряє, чи прослуховування є конференцією.

    Returns boolean

    Чи прослуховування є конференцією.

  • get eavesdropIsMuted(): boolean
  • Перевіряє, чи прослуховування в режимі мовчання.

    Returns boolean

    Чи прослуховування в режимі мовчання.

  • get eavesdropIsPrompt(): boolean
  • Перевіряє, чи прослуховування є запитом.

    Returns boolean

    Чи прослуховування є запитом.

  • get eavesdropName(): undefined | string
  • Отримує ім'я прослуховування.

    Returns undefined | string

    Ім'я прослуховування.

  • get eavesdropNumber(): undefined | string
  • Отримує номер прослуховування.

    Returns undefined | string

    Номер прослуховування.

  • get firstActive(): boolean
  • Перевіряє, чи перший активний дзвінок.

    Returns boolean

    Чи перший активний дзвінок.

  • get hasReporting(): boolean
  • Перевіряє, чи є звітність.

    Returns boolean

    Чи є звітність.

  • get hideContact(): null | boolean
  • Перевіряє, чи контакт потрібно приховати.

    Returns null | boolean

    Чи контакт потрібно приховати.

  • get isEavesdrop(): boolean
  • Перевіряє, чи є прослуховування.

    Returns boolean

    Чи є прослуховування.

  • get isHold(): boolean
  • Перевіряє, чи дзвінок перебуває в режимі утримання.

    Returns boolean

    Чи дзвінок перебуває в режимі утримання.

  • get isMember(): boolean
  • Перевіряє, чи дзвінок є учасником.

    Returns boolean

    Чи дзвінок є учасником.

  • get manualDistribution(): null | boolean
  • Перевіряє, чи є ручний розподіл.

    Returns null | boolean

    Чи є ручний розподіл.

  • get memberCommunication(): null | MemberCommunication
  • Отримує комунікацію учасника.

    Returns null | MemberCommunication

    Комунікація учасника або null.

  • get muted(): boolean
  • Перевіряє, чи вимкнений звук.

    Returns boolean

    Чи вимкнений звук.

Methods

  • Відповідає на дзвінок.

    Parameters

    Returns Promise<boolean>

    Чи успішно відповіли.

  • Затримка автоматичного відповідання.

    Parameters

    Returns void

  • Виконує сліпий переказ дзвінка.

    Parameters

    • destination: string

      Місце призначення.

    • Optionalvariables: object

      Змінні.

    Returns Promise<object>

    Результат переказу.

  • Створює міст між дзвінками.

    Parameters

    • call: Call

      Дзвінок, з яким створюється міст.

    • Optionalvariables: object

      Змінні.

    Returns Promise<object>

    Результат створення мосту.

  • Робить запрошення користувача.

    Parameters

    Returns Promise<object>

    Результат запрошення.

  • Змінює стан прослуховування.

    Parameters

    • state: EavesdropState

      Новий стан прослуховування.

    Returns Promise<object>

    Результат зміни стану прослуховування.

  • Запускає прослуховування дзвінка.

    Parameters

    Returns Promise<object>

    Результат прослуховування.

  • Отримує інформацію про учасника.

    Parameters

    Returns Promise<object>

    Інформація про учасника.

    Помилка, якщо дзвінок не з виходу черги.

  • Завершує дзвінок.

    Parameters

    • Optionalcause: string

      Причина завершення.

    Returns Promise<object>

    Результат завершення дзвінка.

  • Утримує дзвінок.

    Returns Promise<object>

    Результат утримання дзвінка.

  • Вимикає або включає мікрофон.

    Parameters

    • mute: boolean = false

      Якщо true, вимикає мікрофон; якщо false, включає мікрофон.

    Returns Promise<object>

    Результат вимикання або включення мікрофона.

  • Оновлює розмову.

    Parameters

    • Optionalsec: number

      Кількість секунд.

    Returns Promise<object>

    Результат оновлення розмови.

  • Надсилає звітність про дзвінок.

    Parameters

    • reporting: Reporting

      Дані звітності.

    Returns Promise<object>

    Результат надсилання звітності.

  • Надсилає DTMF.

    Parameters

    • dtmf: string

      DTMF.

    Returns Promise<object>

    Результат надсилання DTMF.

  • Встановлює активність дзвінка.

    Parameters

    Returns void

  • Встановлює інформацію про мосту.

    Parameters

    Returns void

  • Встановлює контакт для дзвінка.

    Parameters

    • contactId: number

      Ідентифікатор контакту.

    Returns Promise<object>

    Результат встановлення контакту.

  • Встановлює ідентифікатор контакту.

    Parameters

    • id: number

      Ідентифікатор контакту.

    Returns void

  • Встановлює стан прослуховування.

    Parameters

    Returns void

  • Встановлює інформацію про завершення дзвінка.

    Parameters

    • s: CallEventData

      Дані події завершення дзвінка.

    Returns void

  • Встановлює інформацію про утримання.

    Parameters

    Returns void

  • Встановлює інформацію про дзвінок.

    Parameters

    • s: CallInfo

      Інформація про дзвінок.

    Returns void

  • Встановлює локальні потоки.

    Parameters

    • streams: null | MediaStream[]

      Локальні потоки.

    Returns void

  • Встановлює потоки для співрозмовників.

    Parameters

    • streams: null | MediaStream[]

      Потоки для співрозмовників.

    Returns void

  • Встановлює SIP-сесію.

    Parameters

    • sip: null | CallSession

      SIP-сесія.

    Returns void

  • Перемикає утримання дзвінка.

    Returns Promise<object>

    Результат утримання дзвінка.

  • Виймає дзвінок з утримання.

    Returns Promise<object>

    Результат виймання дзвінка з утримання.