Object

RichLinkDataRef

Keys for the richLinkDataRef dictionary.

Properties

bid
string
(Required)

A string of the bid of the rich link message that was uploaded to content. Identifies the Messages framework extensions. For example:

com.apple.messages.URLBalloonProvider

dataRefSig
string
(Required)

String of the dataref signatures associated to the message and the business. Used to verify that the dataref messages sent by the business are associated with the same business.

key
string
(Required)

A string representation of the key needed to decrypt the encrypted attachment.

owner
string
(Required)

A string representation of the owner of the attachment.

signature-base64
byte
(Required)

The file checksum, represented as a Base64-encoded string, returned in the response for the upload request.

size
integer
(Required)

The size, in bytes, of the encrypted attachment represented by an integer.

url
string
(Required)

String URL used by the Business Chat server to identify the attachment or content reference that is uploaded to content.

Discussion

When a rich link with richLinkData is sent by the Customer Service Platform (CSP) or business, Business Chat (mspgw) returns an optional dataRef in the HTTP response body. The CSP uses this dataRef to represent the richLinkDataRef field in a rich link message.

See Also

Rich Link Dictionaries

object ImageAsset

Keys in the image asset dictionary.

object RichLinkData

Keys in the richLinkData dictionary.

object RichLinkResponse

Subdictionary keys contained in the JSON response's dataRef key.

object VideoAsset

Keys in the video asset dictionary.

type RichLinkMessage

Rich link message containing an inline image or video.