API Reference
Start typing to search…

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.

Body Params
attachments
array of objects

Message attachments

attachments
string
required

Channel uid. 36 chars uuid.

string

Contact Uid

string

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

string
enum

Message Direction.

Allowed:
string
required

Paired contact code.

string
required

Message content.

string
required

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

Responses

Updated about 2 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 months ago