API Documentation
Messages ¶
Overview
A message is as simple as a piece of text sent by a user to a room
Send a message ¶
Send a messagePOST/rooms/{id}/messages
Example URI
POST /rooms/792e4353-ed8b-41db-b146-2632cc7ed089/messages
URI Parameters
- id
string(required) Example: 792e4353-ed8b-41db-b146-2632cc7ed089
Request
Body
{
"comment": "Comment",
"image_url": "http://rechat.com/image_url/image_url.png",
"document_url": "http://rechat.com/document_url/document_url.png",
"video_url": "http://rechat.com/video_url/video_url.png",
"image_thumbnail_url": "http://rechat.com/image_thumbnail_url/image_thumbnail_url.png",
"author": "9a5d2a5e-723a-4f91-a277-16eccc1dbb3f",
"room": "792e4353-ed8b-41db-b146-2632cc7ed089"
}Response
200Body
{
"code": "OK",
"data": {
"type": "message",
"mid": "395c7c82-8b64-4124-9c6f-ebc61aa6764e",
"id": "395c7c82-8b64-4124-9c6f-ebc61aa6764e",
"comment": "Comment",
"image_url": "http://rechat.com/image_url/image_url.png",
"document_url": "http://rechat.com/document_url/document_url.png",
"video_url": "http://rechat.com/video_url/video_url.png",
"recommendation": null,
"author": {
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+16387381959",
"created_at": 1791656513.455528,
"id": "9a5d2a5e-723a-4f91-a277-16eccc1dbb3f",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656513.455544,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "3232c72d-bb96-4320-8279-bacd5478d321",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
},
"created_at": 1791656513.788588,
"updated_at": 1791656513.788588,
"room": "792e4353-ed8b-41db-b146-2632cc7ed089",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": null,
"reference": null,
"mentions": null,
"activity": null,
"role": null,
"attachments": [],
"files": null,
"email_campaigns": null,
"contacts": null,
"crm_tasks": null,
"compact_listings": null,
"input_forms": null,
"artifacts": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": null
}
}Retrieve a Room's messages ¶
Retrieve a Room's messagesGET/rooms/{id}/messages
Example URI
GET /rooms/792e4353-ed8b-41db-b146-2632cc7ed089/messages
URI Parameters
- id
string(required) Example: 792e4353-ed8b-41db-b146-2632cc7ed089
Response
200Body
{
"code": "OK",
"data": [
{
"type": "message",
"mid": "395c7c82-8b64-4124-9c6f-ebc61aa6764e",
"id": "395c7c82-8b64-4124-9c6f-ebc61aa6764e",
"comment": "Comment",
"image_url": "http://rechat.com/image_url/image_url.png",
"document_url": "http://rechat.com/document_url/document_url.png",
"video_url": "http://rechat.com/video_url/video_url.png",
"recommendation": null,
"author": {
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+16387381959",
"created_at": 1791656513.455528,
"id": "9a5d2a5e-723a-4f91-a277-16eccc1dbb3f",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656513.455544,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "3232c72d-bb96-4320-8279-bacd5478d321",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
},
"created_at": 1791656513.788588,
"updated_at": 1791656513.788588,
"room": "792e4353-ed8b-41db-b146-2632cc7ed089",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": null,
"reference": null,
"mentions": null,
"activity": null,
"role": null,
"attachments": [],
"files": null,
"email_campaigns": null,
"contacts": null,
"crm_tasks": null,
"compact_listings": null,
"input_forms": null,
"artifacts": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": [
{
"user": "f9c6b8f9-9ba2-4db3-8ee7-4c8077c27726",
"delivery_type": "sms",
"type": "notification_delivery",
"created_at": "2026-10-10T18:21:53.857217+00:00"
}
]
},
{
"type": "message",
"mid": "33677c0b-5a0a-4392-8980-f1ca8560fdfb",
"id": "33677c0b-5a0a-4392-8980-f1ca8560fdfb",
"comment": "John invited +18598161689 to join.",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": null,
"created_at": 1791656513.694798,
"updated_at": 1791656513.694798,
"room": "792e4353-ed8b-41db-b146-2632cc7ed089",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": {
"type": "notification",
"id": "69f78408-f144-4bd2-b204-9af85b7cc72e",
"object": "792e4353-ed8b-41db-b146-2632cc7ed089",
"message": "John invited +18598161689 to join.",
"created_at": 1791656513.691309,
"updated_at": 1791656513.69131,
"room": "792e4353-ed8b-41db-b146-2632cc7ed089",
"action": "Invited",
"object_class": "Room",
"subject": "9a5d2a5e-723a-4f91-a277-16eccc1dbb3f",
"auxiliary_object_class": "User",
"auxiliary_object": {
"type": "user",
"username": null,
"first_name": "",
"last_name": "",
"email": "[email protected]",
"phone_number": "+18598161689",
"created_at": 1791656513.604042,
"id": "f9c6b8f9-9ba2-4db3-8ee7-4c8077c27726",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656513.604046,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Client",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": true,
"personal_room": "321c299c-c8c2-4963-96fb-98129d4b622b",
"brand": null,
"fake_email": true,
"features": null,
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": null,
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "+18598161689",
"abbreviated_display_name": "+18598161689",
"online_state": "Offline",
"has_password": false
},
"recommendation": null,
"auxiliary_subject": null,
"subject_class": "User",
"auxiliary_subject_class": null,
"extra_subject_class": null,
"extra_object_class": null,
"deleted_at": null,
"specific": null,
"title": null,
"data": null,
"sound": null,
"app": "rechat",
"transports": null,
"phone_number": null,
"notification_type": "UserInvitedRoom",
"seen": true,
"recommendations": null,
"objects": null,
"subjects": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+16387381959",
"created_at": 1791656513.455528,
"id": "9a5d2a5e-723a-4f91-a277-16eccc1dbb3f",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656513.455544,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "3232c72d-bb96-4320-8279-bacd5478d321",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
]
},
"reference": null,
"mentions": null,
"activity": null,
"role": null,
"attachments": [],
"files": null,
"email_campaigns": null,
"contacts": null,
"crm_tasks": null,
"compact_listings": null,
"input_forms": null,
"artifacts": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": [
{
"user": "f9c6b8f9-9ba2-4db3-8ee7-4c8077c27726",
"delivery_type": "sms",
"type": "notification_delivery",
"created_at": "2026-10-10T18:21:53.74788+00:00"
}
]
},
{
"type": "message",
"mid": "607dc40a-2936-4c10-b4dc-43e7b2d7d38d",
"id": "607dc40a-2936-4c10-b4dc-43e7b2d7d38d",
"comment": "John invited [email protected] to join.",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": null,
"created_at": 1791656513.634054,
"updated_at": 1791656513.634054,
"room": "792e4353-ed8b-41db-b146-2632cc7ed089",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": {
"type": "notification",
"id": "7186d75d-5a57-4423-80ec-dac3488d3fcc",
"object": "792e4353-ed8b-41db-b146-2632cc7ed089",
"message": "John invited [email protected] to join.",
"created_at": 1791656513.630329,
"updated_at": 1791656513.630329,
"room": "792e4353-ed8b-41db-b146-2632cc7ed089",
"action": "Invited",
"object_class": "Room",
"subject": "9a5d2a5e-723a-4f91-a277-16eccc1dbb3f",
"auxiliary_object_class": "User",
"auxiliary_object": {
"type": "user",
"username": null,
"first_name": "[email protected]",
"last_name": "",
"email": "[email protected]",
"phone_number": null,
"created_at": 1791656513.603533,
"id": "2d7da53b-49d5-4fa8-a340-9b7a6c20a35c",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656513.603539,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Client",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": true,
"personal_room": "4ff74284-738d-40d1-84bb-709b70d88b8c",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": null,
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "[email protected] ",
"abbreviated_display_name": "[email protected]",
"online_state": "Offline",
"has_password": false
},
"recommendation": null,
"auxiliary_subject": null,
"subject_class": "User",
"auxiliary_subject_class": null,
"extra_subject_class": null,
"extra_object_class": null,
"deleted_at": null,
"specific": null,
"title": null,
"data": null,
"sound": null,
"app": "rechat",
"transports": null,
"phone_number": null,
"notification_type": "UserInvitedRoom",
"seen": true,
"recommendations": null,
"objects": null,
"subjects": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+16387381959",
"created_at": 1791656513.455528,
"id": "9a5d2a5e-723a-4f91-a277-16eccc1dbb3f",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656513.455544,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "3232c72d-bb96-4320-8279-bacd5478d321",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
]
},
"reference": null,
"mentions": null,
"activity": null,
"role": null,
"attachments": [],
"files": null,
"email_campaigns": null,
"contacts": null,
"crm_tasks": null,
"compact_listings": null,
"input_forms": null,
"artifacts": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": null
}
],
"info": {
"count": 3,
"total": 3
}
}