SmsCheckSendWindow¶

GET sms/sendWindow/check

Answers whether a number can be messaged right now, shows the local time it was judged by, and — when the window is closed — exactly when it opens.

opensAt is what the UI shows instead of a bare refusal: "will be sent at 09:00 local time" is an answer an operator can work with.

Access Control¶

Allowed roles: admin, leader, manager.

Request¶

RESTTCPSDK

GET request

GET https://{broker_domain}/sms/sendWindow/check?phone=+380951234567
Authorization: <JWT_TOKEN>

{
  "command": "SmsCheckSendWindow",
  "extID": "1",
  "data": {
    "phone": "+380951234567"
  }
}

const res = await platform.SmsCheckSendWindow({
  phone: "+380951234567"
});

Request Data¶

Field	Type	Required	Description
`phone`	string	Yes	Number in any human format

Response Data¶

Reasons: OUTSIDE_SENDING_HOURS, OUTSIDE_SENDING_DAYS, WINDOW_NOT_CONFIGURED, NO_WINDOW_CONFIGURED. The last two allow sending — they say the module had nothing to check.

{
  "phone": "+380951234567",
  "country": { "iso": "UA", "name": "Ukraine", "dialCode": "380" },
  "windowId": 6,
  "allowed": false,
  "reason": "OUTSIDE_SENDING_HOURS",
  "timezone": "Europe/Kyiv",
  "localTime": "22:14",
  "weekday": 1,
  "window": "09:00–20:00",
  "deferOutsideWindow": true,
  "opensAt": "2026-08-25T06:00:00.000Z"
}

Errors¶

Code	Error	Description
`400`	`VALIDATION_ERROR`	Number is too short to be a phone number