Skip to main content
GET
Get broadcasts

Авторизации

Authorization
string
header
обязательно

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Заголовки

X-Tenant-Id
integer

Компания, в контексте которой выполняется запрос — её id из GET /v1/tenant/. Пользователь должен состоять в этой компании: чужой id доступа к данным не даёт. Без заголовка компания определяется по домену запроса.

Параметры пути

id
integer
обязательно

Ответ

200 - application/json
id
integer
обязательно
read-only
name
string
обязательно
Maximum string length: 255
message
string
обязательно
Maximum string length: 1024
tenant
integer
обязательно
read-only
created_at
string<date-time>
обязательно
read-only
updated_at
string<date-time>
обязательно
read-only
recipients
object[]
обязательно
trigger
enum<integer>
  • 0 - По умолчанию
  • 1 - День рождения
  • 2 - Задолженность
  • 3 - Штраф
  • 4 - Поздравление
Доступные опции:
0,
1,
2,
3,
4
Требуемый диапазон: 0 <= x <= 32767
schedule
string | null
Maximum string length: 64
Pattern: ^(\*|([0-9]|[1-5][0-9])) (\*|([01]?[0-9]|2[0-3])) (\*|([1-9]|[12][0-9]|3[01])) (\*|([1-9]|1[0-2])) (\*|([0-6]))$
send_time
string<date-time> | null
enabled
boolean
all
boolean
по умолчанию:false
exclude
object[]