メインコンテンツへスキップ
POST
  • 1回のリクエストに含まれるすべての送信先に、同じメッセージ内容を配信します。
  • 画像が必要なタイプでは、先にブランドメッセージの画像をアップロードするを呼び出し、レスポンスのdata.images[].urlを使います。
  • PREMIUM_VIDEOのvideoUrlには、カカオBizMessageの動画アップロードAPIで登録とエンコードを終えた配信用URLを指定します。一般的な動画URLやKakaoTVのページURLは使えません。Notiflyの動画アップロードAPIは現在公開していません。動画のアップロードが必要な場合はcontact@notifly.techにお問い合わせください。
  • 自由形式の配信対象にはM、N、Iを指定できます。I+Nには対応していません。
  • このエンドポイントは、カカオトークの配信プラットフォームがNotiflyのチャネルに対応します。Notifly (Legacy)のチャネルでは利用できません。

承認

Authorization
string
header
必須

POST /authenticateで発行したトークンをBearer形式で送信します。

ボディ

application/json
projectId
string
必須

Notiflyの設定ページで確認できるプロジェクトIDです。

channelId
string
必須

プロジェクトにカカオビジネスメッセージの送信者として登録されているカカオトークチャンネルIDです。

target
enum<string>
必須

送信対象です。Mはマーケティングメッセージの受信に同意した会員、Nはそのうちチャンネルを友だち追加していない会員、Iはチャンネルの友だちです。自由形式メッセージはI+Nに対応していません。

利用可能なオプション:
M,
N,
I
recipientList
object[]
必須

送信先のリストです。同じリクエストに含まれるすべての送信先に、同じメッセージを配信します。

Required array length: 1 - 1000 elements
chatBubbleType
enum<string>
必須

メッセージタイプ

利用可能なオプション:
TEXT
message
string
必須

ユーザーに送信するメッセージです。

  • 改行は最大99個です。
  • URLを入力できます。
Maximum string length: 1300
adult
boolean
デフォルト:false

成人向けメッセージかどうかを指定します。

attachment
object

メッセージの添付内容

レスポンス

配信リクエストをキューに登録しました。このレスポンスが示すのはキューへの登録結果です。

success
enum<boolean>
必須

trueは送信リクエストがキューに受け付けられたことを示します。カカオによる最終的な送信成功を意味するものではありません。

利用可能なオプション:
true