Home Schema Example JSON Schema

Device Provider Metadata


Device.provider_metadata is used on Devices to store provider specific metadata about the device.

No Additional Properties

Type: object

The following properties are required:

  • botmdhospital
Type: object

The following properties are required:

  • line
Type: object

The following properties are required:

  • messagebird
Type: object

The following properties are required:

  • messenger
Type: object

The following properties are required:

  • mock
Type: object

The following properties are required:

  • noop
Type: object

The following properties are required:

  • pinpoint
Type: object

The following properties are required:

  • promotexter
Type: object

The following properties are required:

  • pusher
Type: object

The following properties are required:

  • qiscus
Type: object

The following properties are required:

  • qontak
Type: object

The following properties are required:

  • ses
Type: object

The following properties are required:

  • smooch
Type: object

The following properties are required:

  • smtp
Type: object

The following properties are required:

  • telegram
Type: object

The following properties are required:

  • twilio
Type: object

The following properties are required:

  • viber
Type: object

The following properties are required:

  • whatsapp

Bot MD Hospital

Type: object

Device provider metadata for Bot MD Hospital.

Line

Type: object

Device provider metadata for Line.

No Additional Properties

User ID

Type: string

The user ID assigned by Line.

Must match regular expression: ^U[0-9a-f]{32}$

Display Name

Type: string

User's display name

Language

Type: string

User's language, as a BCP 47 language tag. e.g. en for English.

Access Token

Type: string

Access token obtained via Line login.

Is Follower

Type: boolean

Is this user a follower of the bot?

Is Follower Updated On

Type: stringFormat: date-time

Date-time of last verification of follower status.

Messagebird

Type: object

Device provider metadata for Messagebird.

No Additional Properties

Messagebird Conversation ID

Type: string or null

The conversation ID that Messagebird uses to identify the conversation that the user has, a conversation can take place over more than 1 channel.

Must match regular expression: ^[A-Za-z0-9\+\/]+$

Messagebird Contact ID

Type: string or null

The contact ID that Messagebird uses to identify the user.

Must match regular expression: ^[A-Za-z0-9\+\/]+$

Messenger

Type: object

Device provider metadata for Messenger.

No Additional Properties

Page Scoped ID

Type: string

The ID that Messenger uses to identify the user.

Must match regular expression: ^[0-9]+$

Facebook Profile ID

Type: string

The user's Facebook profile id. Present only if allowed by the user.

Must be at least 1 characters long

Facebook Profile Name

Type: string

The user's Facebook profile name. Present only if allowed by the user.

Must be at least 1 characters long

Notification Messages Token

Type: string

Notification messages token obtained via the Messaging Optins webhook from Send to Messenger plugin.

Must be at least 1 characters long

Notification Messages Token Expiry Timestamp

Type: stringFormat: date-time

Date-time for when the notification_messages_token will expire.

Noop

Type: object

Device provider metadata for NoopProvider and NoopPhoneProvider.

Noop

Type: object

Device provider metadata for NoopProvider and NoopPhoneProvider.

PromoTexter

Type: object

Device provider metadata for PromoTexter.

Pusher

Type: object

Device provider metadata for Pusher.

No Additional Properties

Channel ID

Type: string

The Pusher channel ID this device is using. Convention dictates that it follows the form private-encrypted-<device uid>.

Must match regular expression: ^private\-[a-zA-Z0-9\-]+$

Socket ID

Type: string

The Pusher socket ID this device is currently using. This is set during the channel authentication step and could be overwritten if there are multiple devices connected.

Must match regular expression: ^[0-9\.]+$

Qiscus

Type: object

Device provider metadata for Qiscus.

No Additional Properties

Channel

Type: enum (of string)

The Qiscus channel that this device is on.

Must be one of:

  • "wa"

Room ID

Type: string

The room ID used by multichannel API. It may not have a room when this device has not been used directly with multichannel API (i.e., outgoing deliveries only through the WhatsApp API).

Name

Type: string

The channel specific user name, e.g., profile name in WhatsApp. This field can be an empty string.

Qontak

Type: object

Device provider metadata for Qontak.

No Additional Properties

Room ID

Type: string

The room ID provided from Qontak. It defines an interaction from customer to Qontak side which message will be forwarded to our side.

Name

Type: string

The recipient Name provided from Qontak. It defines an customer name to Qontak side.

Phone No

Type: string

Customer's phone no identifier.

SESProvider

Type: object

Device provider metadata for SESProvider.

No Additional Properties

Email


The email address.

Type: objectFormat: email
Type: objectFormat: idn-email

Name

Type: string

The name the sender (if provided).

Smooch (Deprecated)

Type: object

Device provider metadata for Smooch.

No Additional Properties

App ID

Type: string

The Smooch App ID.

Must be at least 1 characters long

Conversation ID

Type: string or null

The Smooch conversation ID.

Raw client metadata


This is Smooch provided client dictionary that we store for analytics purposes.

Type: object
Type: const
Specific value: null

SMTP

Type: object

Device provider metadata for SMTP.

No Additional Properties

Email


The email address.

Type: objectFormat: email
Type: objectFormat: idn-email

Name

Type: string

The name the sender (if provided).

TelegramProvider

Type: object

Device provider metadata for TelegramProvider.

No Additional Properties

Chat ID

Type: integer

Telegram internal chat_id for use with the API. This is usually the same as the user ID.

Username


The username of the sender. null for messages sent to channels.

Type: string

Must be at least 1 characters long

Type: null

User Metadata

Type: object

Additional information about the user returned by Telegram.

Additional Properties of any type are allowed.

Type: object

Twilio

Type: object

Device provider metadata for Twilio.

Viber

Type: object

Device provider metadata for Viber.

No Additional Properties

User ID

Type: string

The user ID assigned by Viber.

Must be at least 1 characters long

Display Name

Type: string

User's display name

Language

Type: string

User's language, as a BCP 47 language tag. e.g. en for English.

Is Follower

Type: boolean

Is this user a follower of the bot?

Is Follower Updated On

Type: stringFormat: date-time

Date-time of last verification of follower status.

WhatsApp

Type: object

Device provider metadata for WhatsApp by Meta.

No Additional Properties

WhatsApp ID

Type: string

WhatsApp ID associated with the device. Usually the phone number in E.164 format without +.

Must match regular expression: ^\d{5,}$

Name

Type: string

Name of user as used on their WhatsApp account.

Must be at least 1 characters long

FCM

Type: object

Device provider metadata for FCM.

No Additional Properties

Token

Type: string or null

The device registration token.

Operating System

Type: enum (of string)

The device operating system.

Must be one of:

  • "ios"
  • "android"