User model

How users are represented in Meya

Each user that interacts with your bot will have a user object stored in your bot's database. Your bot will likely set and get data via the user scope Meya database API.

Field

Note

id string

The Meya defined id. This is an immutable unique identifier. ex UdlY77V2tnl

user_id
string

The integration-specific user identifier. For example, Messenger PSID

integration
string

Represents the integration (chat app) that the user is communicating from. See list of integrations

...

...

{key}
string

Of type: string, integer, float, boolean, dict, list

{
  "first_name": "Kurt", 
  "last_name": "G\u00f6del", 
  "user_id": "1115412093662003", 
  "citizenship": [
    "Austrian", 
    "American"
  ], 
  "locale": "de_AT", 
  "gender": "male", 
  "profession": "mathematician", 
  "integration": "messenger", 
  "alive": false, 
  "avatar_url": "https://upload.wikimedia.org/wikipedia/en/4/42/Kurt_g%C3%B6del.jpg", 
  "timezone": -4, 
  "id": "UrxAAGBZyud", 
  "bot_id": "BA0aelClmnU"
}

Integration-specific user id

Integration

Platform

user_id

meaning

Example

user_id

messenger

Facebook

PSID

11154120936620030

slack

Slack

team id + user id

T138ABGQ8.U057AEGQ1

twilio

Twilio

phone number in E164

+15558675309

kik

Kik

username

kurt.godel.42

telegram

Telegram

chat id

199277562

web

Meya web chat

n/a

n/a

test

Meya test chat

n/a

n/a

intercom

Intercom

Intercom defined id

60a1df123b411efg7bfe91d9

smooch

Smooch Web, Viber, WeChat, LINE, iOS, Email, Android

Smooch _id (or userId if set) learn more

deb920657bbc3adc3fec7963

twitter

Twitter

Twitter user name

potus

webhook

Webhook

Custom

Can be any string