Skip to main content
POST

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
source_addr
string
required

Sender ID. Alphanumeric sender IDs must not exceed 11 characters. Must be active on your account.

Example:

"INFO"

​
message
string
required

SMS message text.

Example:

"Hello World"

​
encoding
integer
required

Message encoding type. Use 0 for default GSM encoding.

Example:

0

​
recipients
object[]
required

List of message recipients.

Minimum array length: 1
​
schedule_time
string

Optional scheduled send time in GMT+0 using the format yyyy-mm-dd hh:mm. Leave empty to send immediately.

Example:

""

​
job_name
string

Optional job name for tracking.

​
campaign_title
string

Optional campaign title for tracking.

Response

Successful response

​
successful
boolean
required

True when the message was accepted for processing.

​
request_id
string
required

Beem transaction ID — use with delivery reports to track status.

​
code
integer
required

API response code (100 = success).

​
message
string
required

Human-readable status message.

​
valid
integer
required

Number of valid recipients accepted.

​
invalid
integer
required

Number of recipients rejected due to validation errors.

​
duplicates
integer
required

Number of duplicate recipient entries removed.

​
opted_out
integer
required

Number of recipients who have opted out of SMS.

​
total_validated
integer
required

Total number of recipients validated in the request.