Create a Business Communication Message

post

https://api.vcita.biz/business/communication/messages

Overview

Send a message to a business. Available for Staff, App, and Directory tokens.

Note: Sending messages requires a channel with active status. Channels are activated asynchronously via webhook callback from the communication-gw, not immediately upon creation. Ensure the channel has been activated before attempting to send messages.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

attachments

array of objects

Message attachments

attachments

channel_uid

string

required

Channel uid. 36 chars uuid.

contact_uid

string

Contact Uid

contact_data

object

Optional channel-provided contact metadata for AI Chat Receptionist context, such as contact_name, email, phone, or other scalar contact details. This object is metadata only: it does not participate in routing or session lookup, and contact_uid/external_uid remain the routing identifiers. When provided on an intercepted inbound message without contact_uid, communication-gw forwards it to the AI receptionist as unverified client context and does not include it in the normal CRM fallback message payload.

created_at

string

Message creation date time [optional | Format: YYYY-MM-DD HH:MM:SS].

direction

string

enum

Message Direction.

Allowed:

external_uid

string

required

Paired contact code.

message

string

required

Message content.

message_uid

string

required

Message uid. Max 255 chars identifier. vCita will send message status updates based on this identifier.Must be unique per channel.

Responses

201Message sent successfully.

401Unauthorized to perform action.