Message Log

omnichannel.message · numbered MSG-{YYYY}-{##########}

Fields

Every record also has id, created_at and updated_at.

Field	Label	Type	Rules
channel	channel	select	required; one of: Email, WhatsApp, SMS, Slack, Voice
direction	direction	select	one of: Outbound, Inbound; default "Outbound"
portal	portal	link → omnichannel.portal
provider	provider	link → omnichannel.provider
template	template	link → omnichannel.template
template_version_no	template version no	number
campaign	campaign	link → omnichannel.campaign
student	student	link → core.student
user	user	link → core.user
recipient	recipient	text	required; personal data; max 190 characters
cc	cc	text	personal data; max 1000 characters
bcc	bcc	text	personal data; max 1000 characters
sender	sender	text	max 190 characters
reply_to	reply to	text	max 190 characters
subject	subject	text	max 500 characters
body	body	longtext	personal data
variables	variables	json	personal data
status	status	select	one of: Queued, Deferred, Sent, Delivered, Read, Opened, Clicked, Bounced, Failed, Spam reported, Unsubscribed; default "Queued"
provider_message_id	provider message id	text	max 190 characters
error	error	text	max 1000 characters
retry_count	retry count	number	default 0; min 0
sent_at	sent at	datetime
delivered_at	delivered at	datetime
read_at	read at	datetime
clicked_at	clicked at	datetime
bounced_at	bounced at	datetime
failed_at	failed at	datetime

Permissions

Role	Can
omnichannel:admin	read, export
omnichannel:editor	read, export
omnichannel:viewer	read, export

API

GET    /api/omnichannel/message?<field>=<value>&limit=100&offset=0
POST   /api/omnichannel/message
GET    /api/omnichannel/message/:id
PATCH  /api/omnichannel/message/:id
DELETE /api/omnichannel/message/:id