Skip to main content
POST
Send a message

Authorizations

x-bigco-hmac-sha256
string
header
required

Base64-encoded HMAC-SHA256 signature of the request. Every request must also include the x-bigco-hmac-username and x-date headers, and POST/PUT requests must include x-digest. See the Authentication guide for the full signing procedure.

Body

application/json
user_id
integer
required

The ID of the recipient user.

Required range: x >= 1
Example:

123

body
string | null

The text of the message.

Example:

"Thank you for contacting us! How can we help you today?"

media_item_uuids
string<uuid>[] | null

UUIDs of media items (uploaded via the Files API) to attach to the message.

Example:
type
string | null

The message type, e.g. CONVERSATIONAL.

Example:

"CONVERSATIONAL"

Response

The message that was queued for delivery.

id
integer
required
Example:

12345

user_id
integer
required
Required range: x >= 1
Example:

123

direction
enum<string>
required

inbound if received from a user, outbound if sent to a user.

Available options:
inbound,
outbound
Example:

"outbound"

status
enum<string>
required

Delivery status of the message.

Available options:
queued,
sent,
delivered,
failed,
undelivered
Example:

"delivered"

date_created
string<date-time>
required
Example:

"2024-05-15T10:29:50Z"

body
string | null
Example:

"Thank you for contacting us! How can we help you today?"

media_item_uuids
string<uuid>[] | null
Example:
type
string | null
Example:

"CONVERSATIONAL"

date_sent
string<date-time> | null
Example:

"2024-05-15T10:30:00Z"

date_delivered
string<date-time> | null
Example:

"2024-05-15T10:30:05Z"