Skip to main content

Room

A Room represents a chat room

type Room {
  agentId: ID
  assigneeType: String
  channelId: ID
  contact: RoomContactType
  id: ID!
  isRead: Boolean
  isStarred: Boolean
  name: String
  number: Int
  roomType: RoomKindType!
  snoozedUntilTimestamp: BigInt
  state: RoomStateType
  tags: [ID!]
  teamId: ID
  topic: String
  updatedTimestamp: BigInt!
}

Fields

`Room.agentId` ● `ID` scalar common

The ID of the agent assigned to the chat room.

`Room.assigneeType` ● `String` scalar common

The type of the chat room assignee.

`Room.channelId` ● `ID` scalar common

The channel ID.

`Room.contact` ● `RoomContactType` object common

Basic contact information for this room

`Room.id` ● `ID!` non-null scalar common

The chat room ID.

`Room.isRead` ● `Boolean` scalar common

True if the chat room is read; false otherwise.

`Room.isStarred` ● `Boolean` scalar common

True if the chat room is starred; false otherwise.

`Room.name` ● `String` scalar common

The chat room name.

`Room.number` ● `Int` scalar common

The ID of the conversation within the account.

`Room.roomType` ● `RoomKindType!` non-null enum common

The kind of the chat room.

`Room.snoozedUntilTimestamp` ● `BigInt` scalar common

The date and time until which the conversation is snoozed. If blank, it is snoozed indefinitely.

`Room.state` ● `RoomStateType` enum common

The state of the chat room.

`Room.tags` ● `[ID!]` list scalar common

The list of tags on the chat room.

`Room.teamId` ● `ID` scalar common

The ID of the team assigned to the chat room.

`Room.topic` ● `String` scalar common

The chat room topic.

`Room.updatedTimestamp` ● `BigInt!` non-null scalar common

The date and time that the chat room was last updated.

Member of

RoomConnection object ● RoomEdge object

Fields
Member of