Device.provider_metadata
is used on Device
s to store provider specific metadata about the device.
Device provider metadata for Bot MD Hospital.
Device provider metadata for Line.
No Additional PropertiesThe user ID assigned by Line.
Must match regular expression:^U[0-9a-f]{32}$
User's display name
Access token obtained via Line login.
Is this user a follower of the bot?
Date-time of last verification of follower status.
Device provider metadata for Messagebird.
No Additional PropertiesThe 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\+\/]+$
The contact ID that Messagebird uses to identify the user.
Must match regular expression:^[A-Za-z0-9\+\/]+$
Device provider metadata for Messenger.
No Additional PropertiesThe ID that Messenger uses to identify the user.
Must match regular expression:^[0-9]+$
The user's Facebook profile id
. Present only if allowed by the user.
Must be at least 1
characters long
The user's Facebook profile name
. Present only if allowed by the user.
Must be at least 1
characters long
Notification messages token obtained via the Messaging Optins webhook from Send to Messenger plugin.
Must be at least 1
characters long
Date-time for when the notification_messages_token
will expire.
Device provider metadata for NoopProvider
and NoopPhoneProvider
.
Device provider metadata for NoopProvider
and NoopPhoneProvider
.
Device provider metadata for PromoTexter.
Device provider metadata for Pusher.
No Additional PropertiesThe Pusher channel ID this device is using. Convention dictates that it follows the form private-encrypted-<device uid>
.
^private\-[a-zA-Z0-9\-]+$
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\.]+$
Device provider metadata for Qiscus.
No Additional PropertiesThe Qiscus channel that this device is on.
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).
The channel specific user name, e.g., profile name in WhatsApp. This field can be an empty string.
Device provider metadata for Qontak.
No Additional PropertiesThe room ID provided from Qontak. It defines an interaction from customer to Qontak side which message will be forwarded to our side.
The recipient Name provided from Qontak. It defines an customer name to Qontak side.
Customer's phone no identifier.
Device provider metadata for SESProvider.
No Additional PropertiesThe email address.
The name the sender (if provided).
Device provider metadata for Smooch.
No Additional PropertiesThe Smooch App ID.
Must be at least 1
characters long
The Smooch conversation ID.
This is Smooch provided client
dictionary that we store for analytics purposes.
null
Device provider metadata for SMTP.
No Additional PropertiesThe email address.
The name the sender (if provided).
Device provider metadata for TelegramProvider.
No Additional PropertiesTelegram internal chat_id
for use with the API. This is usually the same as the user ID.
The username of the sender. null
for messages sent to channels.
Must be at least 1
characters long
Additional information about the user returned by Telegram.
Additional Properties of any type are allowed.
Type: objectDevice provider metadata for Twilio.
Device provider metadata for Viber.
No Additional PropertiesThe user ID assigned by Viber.
Must be at least 1
characters long
User's display name
Is this user a follower of the bot?
Date-time of last verification of follower status.
Device provider metadata for WhatsApp by Meta.
No Additional PropertiesWhatsApp ID associated with the device. Usually the phone number in E.164 format without +
.
^\d{5,}$
Name of user as used on their WhatsApp account.
Must be at least 1
characters long
Device provider metadata for FCM.
No Additional PropertiesThe device registration token.
The device operating system.