Type alias PageAPIOperator

Type declaration

• avatar_url: string

  Url of the operator's avatar.

• externalAttributes: Record<string, any>

  Attributes that can be defined for the operator. From livesupp's perspective, this is a blackbox, it does not try to understand the content. The purpose for this is to allow arbitrary data to be saved for each operator in order to ease the usage of PageAPI. For example: externalAttributes can be used to save the operator's id in the system of the PageAPI user application

• id: number

  Autoincrement unique identifier

• in_conversation: boolean

  Boolean describing whether the operator is having a conversation right now.

• isAssignedToYou: boolean

  Boolean describing whether the operator is assigned to this customer.

• isAvailable: boolean

  Boolean describing whether the operator is available. Being available means online and ready to accept connections.

• name: string

  Name of the operator.

  Example

  John Smith
  Copy

• title: string

  A short string describing the operator's role in the company.

  Example

  Customer Support
  Copy

• video: boolean

  Boolean describing whether the operator can handle video calls.

• voice: boolean

  Boolean describing whether the operator can handle voice calls.