Apple Message for Business: Rich Link

Rich Link with Video

{
	"deliverychannel": "AppleBusinessChat",
	"appid": "{{ambAppid}}",
	"destination": [{
		"abcUserId": ["{{abcUserId}}"]
	}],

	"channels": {
		"AppleBusinessChat": {
			"type": "richLink",
			"richLinkData": {
				"url": "https://youtu.be/gM0qOa_H-rs",
				"title": "Mpbile Testing3",
				"assets": {
					"image": {
						"url": "http://clipart-library.com/data_images/320464.png",
						"mimeType": "image/png"
					},

					"video": {
						"url": "https://youtu.be/gM0qOa_H-rs",
						"mimeType": "video/mp4"
					}
				}
			}
		}
	},
	"correlationid": "",
	"callbackData": "",
	"notifyurl": ""
}

Parameter/Object	Parameter within the object	Mandatory	Description
delivery channel			Channel used to send the message i.e., Apple Message for Business in this case.
app id			Contains the applicationid
destination			Unique user id for the recipient of the message on Apple Message for Business.
	abcUserId		Unique user id
channels
	AppleBusinessChat		JSON object for ApplleBusinessChat configuration
	type	Yes	Type of the outbound event. It can be text,typing_start,typing_end,richlink or interactive.
	richLinkData	Yes	Rich link object
	url	Yes	Publicly accessible URL that is a direct link to the media
	title	Yes	Title of the rich link message
	assets	Yes	Contains image or video asset
	image
	url	Yes	Publicly accessible URL that is a direct link to the media
	mimeType	Yes	The MIME type
	video
	url	Yes	Publicly accessible URL that is a direct link to the media
	mimeType	Yes	The MIME type
correlationid			The corrrelationid is a unique identifier that you can attach to every request as a reference a particular transaction or event. This is configured as a part of the request.
callbackData			Data that you have configured to receive on the notify Url. This is configured as a part of the request.
notifyurl			Configure a URL to get notifications on delivery reports for a WhatsApp message. This field accepts only a valid URL or a variable. If an invalid URL is passed in API request or via a variable, then such request will not be considered eligible for retries.

Error Codes

Refer to the below page https://developers.imiconnect.io/reference/channel-specific-status-codes-1#apple-messages-for-business