Sign in
latestOpenAPI 3.0.02026-08-10416661.5 MB

e96b3e58b041

Broadcasts

Create broadcast

REQUIRED SCOPES <code>['broadcasts:write']</code><br>Create broadcast

post/broadcasts

Request body

namestring required

Name

number_idinteger required

The ID of the Number

messagestring

Message

media_urlstring[]

The url of the media

send_atstring date

Date of send (For Scheduled Broadcasts). UTC

package_countinteger required

Count of package

is_draftboolean

This is draft?

numbers_check_typeinteger nullable

Indicates if we need to check contacts number and which type of check is needed

send_nowboolean

Is broadcast should be send now?

timezonestring

Timezone Name

enable_quiet_hoursboolean

Is enable quiet hours сheck

Example request

{
  "name": "Test Broadcast",
  "number_id": 1,
  "message": "Broadcast Message",
  "media_url": [
    "https://test.com/test.png"
  ],
  "package_count": 10,
  "send_now": true,
  "timezone": "America/New_York",
  "schedule": {
    "time": "09:00:00"
  },
  "restrict_hours": {
    "start": "09:00:00",
    "stop": "18:00:00",
    "action": "continue|skip"
  },
  "assignee": {
    "type": "default|member|contact_owner|unassigned",
    "member_id": 1
  },
  "filters": {
    "filtersListGroups": {
      "segments": [
        3
      ]
    }
  },
  "chatbot": {
    "id": 1
  },
  "enable_quiet_hours": true
}

Response

OK

idinteger

Transform the resource into an array.

organization_idinteger
owner_idstring
number_idstring
team_idstring
is_send_nowstring
namestring
statusstring
created_atstring
updated_atstring
sent_atstring
send_atstring