openemail.broadcasts
この名前空間のすべてのメソッドの、シグネチャ、パラメーター、戻り値、例。
メソッド
One message sent to everybody in one or more audiences, a personalised copy for each person, with unsubscribe handled for you.
broadcasts.preview()
Count who a broadcast to some audiences would reach
preview(body: BroadcastPreviewInput, options?: RequestScope): Promise<BroadcastPreviewResource>Returns the numbers send would work from, without sending or writing anything: recipients, the people a broadcast to these audiences would reach now, unsubscribed, the contacts skipped because they have unsubscribed from every one of these audiences they are in, and suppressed, the subscribed contacts skipped because their address is on the suppression list. A contact in several of the audiences counts once.
The count is taken at the moment of the call, so contacts who join or leave before a send change it. Only audienceIds is sent, so you can pass the same object you are about to give send.
パラメーター
body.audienceIdsArray<string>必須1 to 10 audience ids. One that names no audience in the workspace is a 404
audience_not_found.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
戻り値
BroadcastPreviewResource with audienceIds as sent, recipients, unsubscribed and suppressed.
例
const draft = { audienceIds: ['aud_4c1b8e2a7d9f05c36b4e8a71', 'aud_7e3d9a1c5b2f84e06d9a3c51'], from: 'Acme <[email protected]>', subject: 'The September release', text: 'Hi {{firstName|there}}, here is what changed this month.'} const reach = await openemail.broadcasts.preview(draft) console.log(`${reach.recipients} will get it, ${reach.unsubscribed} unsubscribed, ${reach.suppressed} suppressed`) if (reach.recipients > 0) await openemail.broadcasts.send(draft)注意事項
Needs only
audiences:read, so a key that cannot send can still show somebody the count.The SDK retries it after a network failure or a retryable status, since it changes nothing.
ほかの提供先
broadcasts.send()
Send one message to everybody in one or more audiences
send(body: BroadcastCreate, options?: SendScope): Promise<SentBroadcastResource>Creates a broadcast: one message sent to every contact in the audiences you name, as a separate copy for each person. Every copy has exactly one recipient and no cc or bcc, so nobody sees who else it went to, and every copy is an ordinary email with its own msg_ id, events, tracking and webhooks. emails.list({ broadcastId }) lists them. Copies are not filed in the Sent folder, because the broadcast is the record.
The promise settles straight away with the broadcast queued, or scheduled when you pass scheduledAt, and the sending happens in the background, 50 people at a time. Poll get to follow status and counts as it goes.
Who gets it: every contact in at least one of audienceIds, counted once however many of them hold it, except a contact that has unsubscribed from every one of those audiences it is in, and except an address on the suppression list. A contact added to one of the audiences after this call but before the sending reaches it is included. counts.recipients is the estimate taken at the call, and preview returns the same count without sending.
subject, html and text take merge fields, filled in from each contact: {{firstName}}, {{lastName}}, {{name}}, {{email}} and {{unsubscribeUrl}}. Each takes a fallback after a bar, so {{firstName|there}} reads there for a contact with no name. The first name is the first word of the contact's name and the last name is the rest. Values are escaped in html, and any other {{…}} is left as written. With template, the same values are passed as props, but only the ones the template declares.
Every copy carries the one-click unsubscribe headers mail clients and the large mailbox providers look for. An html or text body that does not place {{unsubscribeUrl}} itself gets a one-line footer with the link, while a template is sent as it is, so put {{unsubscribeUrl}} in the template. Following the link marks the person unsubscribed in every audience this broadcast went to; their other audiences, their contact and mail sent to them one message at a time are not affected.
The whole send is checked against the plan's monthly sends before anything is written. A broadcast the allowance cannot cover throws 429 send_quota_exceeded and leaves nothing behind, and each copy counts as one send.
パラメーター
body.audienceIdsArray<string>必須1 to 10 audience ids such as
aud_9f2c4b7e1a0d63d84c5f2e7b. A contact in several of them gets one copy. An id that names no audience in the workspace is a 404audience_not_foundand nothing is sent.body.fromRecipientInput必須Sender as
[email protected],Acme <[email protected]>or{ email, name }. It must be an address the key may send as, otherwise 403from_address_forbidden.body.replyToRecipientInputWhere replies go, the same for every copy.
body.subjectstringRequired unless a template supplies it, at most 998 characters. Takes merge fields.
body.htmlstringHTML body, at most 1,000,000 characters, with merge fields. Without
{{unsubscribeUrl}}in it an unsubscribe footer is added.body.textstringPlain text body, at most 1,000,000 characters, with merge fields. Without
{{unsubscribeUrl}}in it an unsubscribe line is added.body.template{ id: string, version?: number, props?: Record<string, unknown>, slots?: Record<string, unknown> }A stored template instead of
htmlandtext, never beside them. The merge values reach it as props it declares, such asfirstNameandunsubscribeUrl.body.tracking{ opens?: boolean, clicks?: boolean }Open and link tracking for every copy. A field left out follows the address it is sent from when that address set it, and is on otherwise.
body.tagsRecord<string, string>Up to 8 tags, keys of 1 to 64 letters, digits,
_or-, values up to 256 characters. Every copy carries them, plusbroadcast_id, which the server adds.body.scheduledAtDate | stringA
Date, an ISO 8601 instant or a duration such asPT2HorP1D, in the future and at most 365 days out. Left out, the sending starts straight away.options.idempotencyKeystringYour own key, 1 to 255 characters of letters, digits,
_,.,:or-. Left out, the SDK makes one for the call, so its own retries never send twice. Sending the same key again answers with the broadcast it created instead of a new one; the same key with a different body is a 422idempotency_key_reuse.options.signalAbortSignalCancels the HTTP request. An aborted call may still have created the broadcast; call again with the same
idempotencyKeyto find out without sending twice.options.apiKeystringSends with this key instead of the client's.
戻り値
SentBroadcastResource, a BroadcastResource plus replayed, with id (brd_ plus 24 hex), status queued or scheduled, audienceIds, from, subject, scheduledAt, createdAt and counts, whose recipients is the estimate and whose other counts start at 0.
例
const broadcast = await openemail.broadcasts.send({ audienceIds: ['aud_4c1b8e2a7d9f05c36b4e8a71'], from: 'Acme <[email protected]>', subject: '{{firstName|Hello}}, the September release is out', html: '<p>Hi {{firstName|there}},</p><p>Here is what changed this month.</p><p><a href="{{unsubscribeUrl}}">Unsubscribe</a></p>', text: 'Hi {{firstName|there}},\n\nHere is what changed this month.\n\nUnsubscribe: {{unsubscribeUrl}}', tags: { campaign: 'release-2026-09' }, scheduledAt: 'PT2H'}) console.log(broadcast.id, broadcast.status, broadcast.replayed, broadcast.counts.recipients)注意事項
Safe to retry. Every call carries an
Idempotency-Key, yours or one the SDK makes, so a retry after a network failure answers with the broadcast the first attempt created, withreplayed: true, instead of sending again. Keys are scoped to the API key or app that sent them. Reusing a key with a different body is a 422idempotency_key_reuse.Refusals: 422
no_recipientswhen the audiences are empty or everybody in them has unsubscribed or is suppressed, 409domain_not_sendablewhen thefromdomain cannot sign mail yet, 422 ontemplate.*when the template does not resolve.No attachments, cc, bcc, translation or encryption. A body from
htmlortextand atemplatetogether are refused.A test key (
oe_test_) creates a broadcast whose copies are marked sent and delivered to nobody, like any test send.
ほかの提供先
broadcasts.list()
List one page of broadcasts, newest first
list(options?: BroadcastListOptions): Promise<Page<BroadcastResource>>Returns one page of the broadcasts in the workspace, newest first, each with live counts. audienceId keeps the ones that were sent to that audience, alone or beside others.
Paging is keyset: options.limit takes 1 to 100 and defaults to 25, and nextCursor, the id of the last broadcast on the page, goes back as options.cursor while hasMore is true. Send the same audienceId with every page. listAll and iterate do that walk for you.
The individual messages are not here. List the copies of one broadcast with emails.list({ broadcastId }).
パラメーター
options.audienceIdstringOnly the broadcasts that included this audience. An id that names no audience answers an empty page.
options.limitnumberRows per page, a whole number from 1 to 100. The server defaults to 25.
options.cursorstringThe
nextCursorfrom the previous page, a broadcast id. One that names no broadcast in the workspace is a 400invalid_cursor.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
戻り値
Page<BroadcastResource> with items, hasMore and nextCursor. Each item has id, status, audienceIds, from, subject, counts and the timestamps.
例
const page = await openemail.broadcasts.list({ audienceId: 'aud_4c1b8e2a7d9f05c36b4e8a71', limit: 10 }) for (const broadcast of page.items) { console.log(broadcast.createdAt, broadcast.subject, broadcast.status, `${broadcast.counts.sent}/${broadcast.counts.recipients}`)}注意事項
A key limited to particular addresses or domains lists only the broadcasts sent from an address or domain it holds.
ほかの提供先
broadcasts.listAll()
Collect every broadcast into one array
listAll(options?: BroadcastListOptions): Promise<Array<BroadcastResource>>Follows nextCursor from page to page and resolves with every broadcast in the workspace, newest first, or every one sent to audienceId when you pass it. limit sets the page size of each request, not the total.
パラメーター
options.audienceIdstringOnly the broadcasts that included this audience.
options.limitnumberPage size per request, from 1 to 100, defaulting to 25 on the server.
options.cursorstringA broadcast id to start after.
options.signalAbortSignalCancels the request in flight and rejects the whole walk.
options.apiKeystringOverrides the client's API key for every page of this walk.
戻り値
Array<BroadcastResource> holding every broadcast across all pages.
例
const broadcasts = await openemail.broadcasts.listAll({ limit: 100 }) const sent = broadcasts.reduce((total, broadcast) => total + broadcast.counts.sent, 0) console.log(`${broadcasts.length} broadcasts, ${sent} copies sent`)注意事項
A failure on any page rejects the whole call.
Every row carries live counts, so collecting a long history reads the copies of every broadcast in it. Use
iterateto stop early.A key limited to particular addresses or domains lists only the broadcasts sent from an address or domain it holds.
ほかの提供先
broadcasts.iterate()
Stream broadcasts one at a time, newest first
iterate(options?: BroadcastListOptions): AsyncGenerator<BroadcastResource, void, undefined>Returns an async generator that yields broadcasts individually, newest first, and requests the next page only once the current one is drained. Breaking out of the loop stops the requests, so this is the cheap way to find the latest broadcast that matches something the filters cannot express.
パラメーター
options.audienceIdstringOnly the broadcasts that included this audience.
options.limitnumberPage size per request, from 1 to 100, defaulting to 25 on the server.
options.cursorstringA broadcast id to start after.
options.signalAbortSignalCancels the request in flight and ends the iteration with an error.
options.apiKeystringOverrides the client's API key for every page of this walk.
戻り値
AsyncGenerator<BroadcastResource, void, undefined> yielding one broadcast per step.
例
for await (const broadcast of openemail.broadcasts.iterate()) { if (broadcast.status === 'sending') { console.log('still going:', broadcast.id, broadcast.counts.queued, 'waiting') break }}注意事項
The generator is lazy, so an abandoned loop costs only the pages you consumed.
A key limited to particular addresses or domains lists only the broadcasts sent from an address or domain it holds.
ほかの提供先
broadcasts.get()
Read one broadcast and how far it has got
get(id: string, options?: RequestScope): Promise<BroadcastResource>Returns one broadcast with counts read live from its copies, which makes this the call to poll while it sends.
status moves from scheduled or queued to sending and settles on sent once every copy handed over has gone out or failed. It reads sending for as long as copies are still waiting, even after the last person was reached and completedAt was set. cancelled and failed are the other two ends, and on failed lastError says why: the from address can no longer be sent from, the template stopped resolving, the plan ran out part way, the sending itself kept failing, or not one copy could be written.
counts.recipients is the estimate taken when it was created. created is the copies written, one per person reached, skipped the people passed over because their address was suppressed by then, and failedToQueue the people whose copy could not be written. queued, sending, sent, failed and cancelled count the copies by the state each one is in now.
パラメーター
idstring必須A
brd_id fromsendorlist.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
戻り値
BroadcastResource with id, status, mode, source, audienceIds, from, subject, counts, lastError, scheduledAt, startedAt, completedAt, cancelledAt, createdAt and updatedAt.
例
const settled = new Set(['sent', 'cancelled', 'failed']) let broadcast = await openemail.broadcasts.get('brd_5a8c1e3f7b2d94a06c8e1f3b') while (!settled.has(broadcast.status)) { await new Promise((resolve) => setTimeout(resolve, 5_000)) broadcast = await openemail.broadcasts.get(broadcast.id) console.log(`${broadcast.counts.sent} of ${broadcast.counts.recipients} sent`)} console.log(broadcast.status, broadcast.lastError)注意事項
A missing broadcast throws
OpenEmailApiErrorwithisNotFoundtrue and codebroadcast_not_found. An id from another workspace is a 404 too.For who each copy went to and what happened to it, use
listRecipients,getRecipientreads one copy with its content, andstatssums it up.A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds. Any other id throws
broadcast_not_found, as if the broadcast did not exist.
ほかの提供先
broadcasts.stats()
Read how a broadcast performed
stats(id: string, options?: BroadcastStatsOptions): Promise<BroadcastStatsResource>Resolves with the totals and a series for one broadcast. totals counts copies sent, delivered, bounced, complained (reported as spam) and failed, pending for the ones still waiting, and people who opened, clicked and unsubscribed, with opens and clicks as event counts. series is sparse and oldest first: one bucket per grain in which something happened, counting each person once at the first time it happened to them, so it adds up to the totals.
Pass days or minutes to also read what happened lately. window then counts the copies delivered, bounced, reported as spam, opened, clicked and unsubscribed inside it, and series keeps only its buckets, while totals still covers the whole broadcast. Without either, window is null.
パラメーター
idstring必須A
brd_id fromsendorlist.options.grainTrackingGrainBucket width:
minute,hourorday, defaulting tohour.options.offsetMinutesnumberMinutes east of UTC to cut the buckets in, from -840 to 840. Pass
-new Date().getTimezoneOffset()for the local zone.options.daysnumberReads a window of this many days too, from 1 to 1095. It starts at the beginning of its first
grainbucket and ends now.options.minutesnumberThe window in minutes, from 1 to 1576800, which wins over
dayswhen both are sent.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
戻り値
BroadcastStatsResource with broadcastId, grain, totals, window and series, each bucket { bucket, delivered, opened, clicked, unsubscribed }. window is { since, delivered, bounced, complained, opened, clicked, unsubscribed }, or null when no window was asked for.
例
const stats = await openemail.broadcasts.stats('brd_5a8c1e3f7b2d94a06c8e1f3b', { grain: 'day' }) const rate = stats.totals.sent ? stats.totals.opened / stats.totals.sent : 0 console.log(`${Math.round(rate * 100)}% opened`)注意事項
Read only, so the SDK retries it after a network failure like any other read.
A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds. Any other id throws
broadcast_not_found, as if the broadcast did not exist.
ほかの提供先
broadcasts.analytics()
Read how broadcasts did over a time window
analytics(options?: BroadcastAnalyticsOptions): Promise<BroadcastAnalyticsResource>Returns the numbers behind the Analytics tab of the Broadcasts page in one request: how the live broadcasts sent inside a window did, added up in totals and cut to grain in series, and one row per broadcast in broadcasts so they can be compared.
A copy counts when it was sent inside the window, and everything that happened to it afterwards counts with it, so an open today of a copy sent last week is in a 30 day window but not in a 1 day one. Test mode broadcasts are left out. totals and series add up the broadcasts named in broadcastIds, or every one when it is left out, while broadcasts always lists every broadcast in the window, newest first.
series is sparse and oldest first: a bucket in which nothing happened has no entry, so a chart must fill the gaps. It counts each person once, at the first time it happened to them. grain sets the bucket width and the key shape, YYYY-MM-DD, YYYY-MM-DDTHH or YYYY-MM-DDTHH:MM, and offsetMinutes shifts the boundaries so days break where the reader's day does. The window starts at the beginning of its oldest bucket, reported as since, and ends now, reported as until.
パラメーター
options.broadcastIdsArray<string>Up to 50 broadcast ids for
totalsandseriesto add up, sent comma separated. Leave it out, or pass an empty array, for every broadcast in the window. An id with no copy in the window adds nothing, and more than 50 is a 422.options.daysnumberWindow length in days, from 1 to 1095, defaulting to 30.
options.minutesnumberWindow length in minutes, from 1 to 1576800, which wins over
dayswhen both are sent.options.grainTrackingGrainBucket width:
minute,hourorday, defaulting today.options.offsetMinutesnumberMinutes east of UTC to cut the buckets in, from -840 to 840, defaulting to 0. Pass
-new Date().getTimezoneOffset()for the local zone.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
戻り値
BroadcastAnalyticsResource, { object: 'broadcast_analytics', since, until, grain, offsetMinutes, broadcastIds, totals, series, broadcasts }. totals has broadcasts and the counts BroadcastStatsTotals has, each entry of series is { bucket, sent, delivered, opened, clicked, unsubscribed }, and each entry of broadcasts has id, subject, status, sentAt and the same counts.
例
const analytics = await openemail.broadcasts.analytics({ days: 90, offsetMinutes: -new Date().getTimezoneOffset()}) const rate = analytics.totals.delivered ? analytics.totals.opened / analytics.totals.delivered : 0 console.log(`${analytics.totals.broadcasts} broadcasts, ${Math.round(rate * 100)}% opened`) for (const row of analytics.broadcasts) { console.log(row.subject, row.sent, row.opened, row.clicked)}注意事項
Read only, so the SDK retries it after a network failure like any other read.
opened,clickedandunsubscribedcount people, whileopensandclickscount events.A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds, and the rest are left out as if they did not exist.
ほかの提供先
broadcasts.listRecipients()
List who a broadcast went to and what happened to each copy
listRecipients(id: string, options?: BroadcastRecipientListOptions): Promise<Page<BroadcastRecipientResource>>Resolves one page of the people a broadcast went to, one row per copy, sorted by address. Each row says the copy's status, when it was sent and delivered, whether it bounced or was reported as spam, how often it was opened and clicked, and whether the person unsubscribed from one of the broadcast's audiences after it went out.
Opens and clicks leave out image proxies and link scanners, and stay 0 when the broadcast went out with tracking off. emailId is the copy's msg_ id, which getRecipient reads with its content and emails.get reads as a sent email.
パラメーター
idstring必須A
brd_id fromsendorlist.options.filterBroadcastRecipientFilterKeeps one group:
pending,sent,delivered,opened,not_opened(sent and never opened),clicked,bounced,complained,failed(failed or cancelled) orunsubscribed.BROADCAST_RECIPIENT_FILTERSnames them.options.qstringSearches the address and the name, ignoring case.
options.limitnumberPage size, from 1 to 200. The server defaults to 50.
options.cursorstringThe
nextCursorof the previous page. Send the samefilterandqwith it.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
戻り値
Page<BroadcastRecipientResource> with items, hasMore and nextCursor. Each item has emailId, contactId, email, name, status, sentAt, deliveredAt, bouncedAt, complainedAt, failure, opens, firstOpenAt, clicks, firstClickAt and unsubscribedAt.
例
const page = await openemail.broadcasts.listRecipients('brd_5a8c1e3f7b2d94a06c8e1f3b', { filter: 'bounced' }) for (const copy of page.items) console.log(copy.email, copy.bouncedAt)注意事項
A missing broadcast throws
OpenEmailApiErrorwith codebroadcast_not_found.A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds. Any other id throws
broadcast_not_found, as if the broadcast did not exist.
ほかの提供先
broadcasts.listAllRecipients()
Collect everybody a broadcast went to into one array
listAllRecipients(id: string, options?: BroadcastRecipientListOptions): Promise<Array<BroadcastRecipientResource>>Walks every page of listRecipients and resolves with every copy of the broadcast, sorted by address. One request per page, with the same filter and q on each.
パラメーター
idstring必須A
brd_id fromsendorlist.options.filterBroadcastRecipientFilterKeeps one group:
pending,sent,delivered,opened,not_opened(sent and never opened),clicked,bounced,complained,failed(failed or cancelled) orunsubscribed.BROADCAST_RECIPIENT_FILTERSnames them.options.qstringSearches the address and the name, ignoring case.
options.limitnumberPage size for each request, from 1 to 200. The server defaults to 50.
options.cursorstringStarts the walk after this cursor instead of the first page.
options.signalAbortSignalCancels the request in flight and the walk with it.
options.apiKeystringOverrides the client API key for every page of this walk.
戻り値
Array<BroadcastRecipientResource> holding every copy that matches.
例
const unopened = await openemail.broadcasts.listAllRecipients('brd_5a8c1e3f7b2d94a06c8e1f3b', { filter: 'not_opened' }) console.log(unopened.map((copy) => copy.email))注意事項
If any page fails the promise rejects and the rows already fetched are discarded.
A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds. Any other id throws
broadcast_not_found, as if the broadcast did not exist.
ほかの提供先
broadcasts.iterateRecipients()
Walk everybody a broadcast went to, one copy at a time
iterateRecipients(id: string, options?: BroadcastRecipientListOptions): AsyncGenerator<BroadcastRecipientResource, void, undefined>Yields every copy of the broadcast one at a time, fetching the next page only when the loop asks for it, sorted by address. Breaking out of the loop stops the requests.
パラメーター
idstring必須A
brd_id fromsendorlist.options.filterBroadcastRecipientFilterKeeps one group:
pending,sent,delivered,opened,not_opened(sent and never opened),clicked,bounced,complained,failed(failed or cancelled) orunsubscribed.BROADCAST_RECIPIENT_FILTERSnames them.options.qstringSearches the address and the name, ignoring case.
options.limitnumberPage size for each request, from 1 to 200. The server defaults to 50.
options.cursorstringStarts after this cursor instead of the first page.
options.signalAbortSignalCancels the request in flight and the walk with it.
options.apiKeystringOverrides the client API key for every page of this walk.
戻り値
AsyncGenerator<BroadcastRecipientResource, void, undefined> yielding one copy per step.
例
for await (const copy of openemail.broadcasts.iterateRecipients('brd_5a8c1e3f7b2d94a06c8e1f3b', { filter: 'clicked' })) { console.log(copy.email, copy.clicks)}注意事項
Memory stays flat however large the broadcast, because only one page is held at a time.
A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds. Any other id throws
broadcast_not_found, as if the broadcast did not exist.
ほかの提供先
broadcasts.getRecipient()
Read one person's copy of a broadcast
getRecipient(id: string, emailId: string, options?: RequestScope): Promise<BroadcastRecipientContentResource>Resolves with one copy: the same row listRecipients gives, plus the subject, html and text exactly as that person received them, with the merge fields filled in and their own unsubscribe link. The HTML is from before open and click tracking was added.
パラメーター
idstring必須A
brd_id fromsendorlist.emailIdstring必須The
emailIdof the copy, fromlistRecipients.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
戻り値
BroadcastRecipientContentResource: emailId, contactId, email, name, status, sentAt, deliveredAt, bouncedAt, complainedAt, failure, opens, firstOpenAt, clicks, firstClickAt and unsubscribedAt, plus subject, html and text.
例
const copy = await openemail.broadcasts.getRecipient('brd_5a8c1e3f7b2d94a06c8e1f3b', 'msg_01dad25067bc4dac966d515d') console.log(copy.subject, copy.deliveredAt)注意事項
An
emailIdthat is not a copy of this broadcast throws with coderecipient_not_found.A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds. Any other id throws
broadcast_not_found, as if the broadcast did not exist.
ほかの提供先
broadcasts.cancel()
Stop a broadcast that is scheduled, queued or still sending
cancel(id: string, options?: RequestScope): Promise<BroadcastResource>Stops a broadcast that is scheduled, queued or sending, including one that has reached everybody while some copies are still waiting to go. Nobody else is added, and every copy still waiting is cancelled. A copy already being handed over finishes, and copies that have gone cannot be recalled, so counts.sent keeps them and counts.cancelled shows what was stopped.
Once every copy has gone out there is nothing left to stop, and the call throws 409 broadcast_not_cancellable. A failed broadcast with copies still waiting can be cancelled to stop them, and one with nothing waiting is refused the same way. Cancelling a broadcast that is already cancelled resolves with it as it stands, so the call is safe to repeat, and the SDK retries it after a network failure.
パラメーター
idstring必須The
brd_id to cancel.options.signalAbortSignalCancels the HTTP request, not the broadcast. Read it with
getif you abort.options.apiKeystringCancels with this key instead of the client's.
戻り値
BroadcastResource in its new state, status cancelled with cancelledAt set and the copies counted by where each one ended up.
例
const scheduled = await openemail.broadcasts.send({ audienceIds: ['aud_4c1b8e2a7d9f05c36b4e8a71'], from: '[email protected]', subject: 'Doors open on Friday', text: 'Hi {{firstName|there}}, doors open at nine.', scheduledAt: 'P1D'}) const cancelled = await openemail.broadcasts.cancel(scheduled.id) console.log(cancelled.status, cancelled.counts.cancelled)注意事項
Cancelling a scheduled broadcast before
scheduledAtsends nothing at all.A cancelled broadcast stays cancelled. There is no resume, so send again to the audiences that still need it.
A key limited to particular addresses or domains cancels only broadcasts sent from an address or domain it holds. Any other id throws
broadcast_not_found, as if the broadcast did not exist.