Sunbird UCI
  • Overview of Sunbird UCI
  • 📙Learn
    • UCI use cases
    • UCI for Education(Case study)
    • Tech Overview
      • Glossary
      • High-level Architecture Design
      • Design Principles
      • Standards
  • 🚀Use
    • Choose your Persona
    • Adopter - Install and use UCI
      • Pre-requisites, Installation Setup, Post Setup
      • Setting up your very first conversation
      • API Documentation
      • Data Exhaust and Analytics
      • Posthog Event
      • Whatsapp (Netcore)
      • Environment Variables
    • Developer - Contribute to UCI
      • UCI Basics
        • XMessage Specification
        • Transformers
          • ODK Transformer
            • Interactive-Messages
            • Media Messages
            • Location
          • Broadcast Transformer
        • Adapters
          • Firebase Notification Adapter
        • User Segment
        • Schema Overview
          • UCI Core Schema
            • XMessage Schema
            • Assessment DB Schema
          • UCI API Schema
      • Development environment
        • Backend Setup
        • Setting up IDE
        • Environment variable setup
        • Debug services
        • Build and Execute UCI
        • Frontend Setup (Admin Console)
        • Frontend Setup (PWA)
        • Transport Socket
      • API Documentation
        • Bot Setup APIs
        • History APIs
        • Direct Message APIs
        • Vault APIs
      • Database Schema
        • Cassandra Xmessage Database
        • Postgres Forms Database
        • Postgres User Analytics Database
        • Postgres Comms Database
      • Contribution Guide
        • Your first PR
        • Contribute an Adapter
        • Adapter Implementation
        • Create a Transformer
    • Contact the administrator
  • ✅Releases
    • Release V2
  • 🤝Engage
    • Software License
    • Acceptable Use Policy
    • Terms of Service
    • Source Code
    • Discussion Forum
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. Use
  2. Developer - Contribute to UCI
  3. UCI Basics
  4. Schema Overview
  5. UCI Core Schema

XMessage Schema

PreviousUCI Core SchemaNextAssessment DB Schema

Last updated 2 years ago

Was this helpful?

UCI saves all conversation data in form of XMessages. These XMessages follow a certain . These XMessage will be saved in cassandra DB. Its object is defined in .

Schema

Field
Type
Description

id

uuid

unique identification

userId

text

to - phone of user/admin

fromId

text

from - phone of user/admin

channel

text

channel (Eg. Whatsapp/SMS)

provider

text

provider (Eg. Gupshup/Netcore)

timestamp

timestamp

messageState

text

state(Eg. Replied/Sent/Read)

xMessage

text

xMessage XML stringyfied

app

text

bot name

auxData

text

auxilary data

messageId

text

id of message from provider

replyId

text

id of user to reply to

causeId

text

sessionId

uuid

session id of conversation

ownerOrgId

text

owner org id of bot

ownerId

text

owner id

botUuid

uuid

bot uuid

🚀
specification
dao repository