Messages

Messages

Generate statistics Message

post

Body

application/json

all_numbersstringOptional

All numbers or special identifiers

messagestringOptional

Message content

send_time_methodstring · enumOptional

Send time method

Possible values:

send_timestring · date-timeOptional

Send time if method is LATER

sms_typestring · enumOptional

SMS type

Possible values:

repeation_timesintegerOptional

Repetition times, if applicable

excle_filestringOptional

Excel file path, if all_numbers is excel_file

calendar_timestring · date-timeOptional

Calendar time if sms_type is CALENDAR

reminderintegerOptional

Reminder if sms_type is CALENDAR

reminder_textstringOptional

Reminder text if sms_type is CALENDAR

location_urlstringOptional

Location URL (optional)

Responses

200

Successful operation

application/json

post

/api/workspaces/{workspace}/channels/{channel}/statistics

HTTPcURLJavaScriptPython

POST /api/workspaces/{workspace}/channels/{channel}/statistics HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 264

{
  "all_numbers": "text",
  "message": "text",
  "send_time_method": "NOW",
  "send_time": "2025-12-18T09:11:52.612Z",
  "sms_type": "NORMAL",
  "repeation_times": 1,
  "excle_file": "text",
  "calendar_time": "2025-12-18T09:11:52.612Z",
  "reminder": 1,
  "reminder_text": "text",
  "location_url": "text"
}

200

Successful operation

{
  "success": true,
  "message": "text",
  "data": {
    "message_id": 1,
    "entries": [
      {
        "id": 966,
        "name_ar": "السعودية",
        "name_en": "Saudi Arabia",
        "coverage_status": 1,
        "cnt": 5,
        "cost": 5
      }
    ],
    "count": 5,
    "cost": 10,
    "can_send": true
  }
}

Send a message

post

Sends a message and performs various validations.

Body

application/json

message_idintegerRequired

ID of the message statistic

Example: 1

Responses

200

Message sent successfully

application/json

403

Validation or balance error

application/json

422

Validation Error(s)

application/json

post

/api/workspaces/{workspace}/channels/{channel}/messages

HTTPcURLJavaScriptPython

POST /api/workspaces/{workspace}/channels/{channel}/messages HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "message_id": 1
}

{
  "success": true,
  "message": "Message sent successfully",
  "data": {
    "message_id": 1
  }
}