Skip to main content
POST
Send session message

Authorizations

Authorization
string
header
required

Beem API credentials: API key as username, API secret as password.

Body

application/json
from
string
required

Your MOJA channel number (WhatsApp-enabled sender).

to
string
required

Recipient mobile number (include the country code)

message_type
enum<string>
required

Type of session message to send.

Available options:
text,
image,
location,
document,
quick_reply,
list,
video
channel
enum<string>
required

Messaging channel.

Available options:
whatsapp,
facebook,
sms,
instagram
transaction_id
string<uuid>

Optional client reference (UUID v4).

callback_url
string<uri>

Optional URL where inbound replies are delivered.

text
string

Message text when message_type is text.

image
object

Image attachment when message_type is image.

video
object

Video attachment when message_type is video.

document
object

Document attachment when message_type is document.

location
object

Location pin when message_type is location.

quick_reply
object

Interactive quick-reply buttons when message_type is quick_reply.

list
object

Interactive list message when message_type is list.

Response

Successful response

message
string
Example:

"SUCCESS"