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 |
---|---|
| The Meya defined id. This is an immutable unique identifier. ex |
| The integration-specific user identifier. For example, Messenger PSID |
| Represents the integration (chat app) that the user is communicating from. See list of integrations |
... | ... |
{key} | Of type: |
{
"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 |
meaning | Example
|
---|---|---|---|
| PSID |
| |
| Slack | team id + user id |
|
| Twilio | phone number in E164 |
|
| Kik | username |
|
| Telegram | chat id |
|
| Meya web chat | n/a | n/a |
| Meya test chat | n/a | n/a |
| Intercom | Intercom defined id |
|
| Smooch Web, Viber, WeChat, LINE, iOS, Email, Android | Smooch _id (or userId if set) learn more |
|
| Twitter user name |
| |
| Webhook | Custom | Can be any string |