Chat Module Catalog Events

List of Catalogs

Catalog	Description
User Catalog	Catalog representing the users of the chat plaform
Group Catalog	Catalog representing the information about the managed public chat groups
Bot Catalog	Catalog keeping tabs on the managed bots

---

"Required Catalog Fields"

Some catalog fields can be marked as optional below but may be required for your app. Please refer to your integration notes to verify which fields are required for your application.

User Catalog

Below are the User Catalog values.

Overview

Param	Usability	Format	Description
id	REQUIRED	STRING	Unique id for a user, provided by the partner.
name	OPTIONAL	STRING	Name of the user, provided by the partner.
country	OPTIONAL	STRING	ISO-3166 country name in which the user is registered.
region_state	OPTIONAL	STRING	Region/State in which the user is registered.
city	OPTIONAL	STRING	City for facility, provided by the partner
language	OPTIONAL	STRING	Comma separated ISO-639-1 language names the user is speaking/using.
birth_year	OPTIONAL	INT	birth year of the user, in format of YYYY.
gender	OPTIONAL	STRING	type of the user gender: male, female, other
timezone	REQUIRED	STRING	Timezone for which the user is currently in.

Usage

[
    {
        "id": "1e7c1a8b-c291-48df-9ad2-55aecd684270",
        "name": "Rosalina Rodriguez",
        "country": "Spain",
        "region_state": "Catalunya",
        "city": "Barcelona",
        "language": "es, en",
        "birth_year": 1989,
        "gender": "female",
        "timezone": "+0100"
    }
]

---

Group Catalog

Below are the Group Catalog values.

Overview

Param	Usability	Format	Description
id	REQUIRED	STRING	Unique id for a chat group
name	REQUIRED	STRING	Name of the chat group
description	OPTIONAL	STRING	Group's description in bio.
timezone	OPTIONAL	STRING	Timezone for which the group is currently in.

Usage

[
    {
        "id": "4bbaf4a2-1136-4888-ba9f-1e205ea1bed9",
        "name": "Estudiantes de Lorem ipsum 🐣🌃👢💍🌰🍚",
        "description": "It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout.",
        "timezone": "+0100"
    }
]

---

Bot Catalog

Below are the Bot Catalog values.

Overview

Param	Usability	Format	Description
id	REQUIRED	STRING	Unique id for the bot
name	REQUIRED	STRING	Name of the bot
description	OPTIONAL	STRING	Bot's info in bio
timezone	OPTIONAL	STRING	Timezone for which the bot presumably operates from

Usage

[
    {
        "id": "913c37fd-341b-42d5-9814-0a061c45617e",
        "name": "Dolor sit amet",
        "description": "Lorem Ipsum archive custodian",
        "timezone": "+0100"
    }
]

---