launch

POSThttps://web.otpcod.ru/api/v1/api/v1/broadcast/broadcasts

Loading code example

Header Parameters

X-API-KEYstringrequired

Enter your X-API-KEY

requestDto

descriptionstring

Optional description of the broadcast

launchTimestring<date-time>

Optional scheduled launch time for the broadcast. If not provided, broadcast will be launched immediately after moderation (if required).

namestring

Optional name for the broadcast. If not provided, a default name will be generated.

payloadobject

payload.contentSettingsobjectrequired

payload.contentTypeinteger<int32>required

Type of content for the broadcast: 1 - Fallback, 2 - Chat Bot, 3 - RCS Capability Check

Allowed values: 1 | 2 | 3

payload.rcsCheckboolean

Flag indicating whether RCS check should be performed

recipientsListarray<object>

List of recipients for the broadcast

recipientsList.namestring

recipientsList.phoneNumberstring

templateIdinteger<int64>

ID of an existing template to use for the broadcast. Either templateId or payload must be provided.

webhookstringrequired

Mandatory webhook URL for receiving broadcast status updates