接続情報
共通ヘッダー
APIトークンの有効期間は1時間です。有効期限が切れたら、トークンを再発行してリクエストを再送します。
リクエストとレスポンスの形式
/v1/projects/{projectId}/catalogs以下のCatalog APIは、{ "data": ..., "error": ... }形式でレスポンスを返します。Catalog REST APIを使い始めるで使い方を確認できます。トークンを発行してイベントを送信する
主要なリファレンス
APIトークンを発行する
POST /authenticateでトークンを発行します。
APIのエラー
ステータスコードとレスポンスのフィールドを確認します。
イベントとユーザー
イベントを記録する
ユーザーイベントまたはグローバルイベントを記録します。
ユーザー属性を設定する
1人または複数のユーザーの属性を登録、更新します。
ユーザーを削除する
1人または複数のユーザーを削除します。
キャンペーンとユーザージャーニー
キャンペーンをトリガーする
APIを呼び出して、キャンペーンの配信を開始します。
ユーザージャーニーをトリガーする
APIで対象ユーザーを指定し、そのユーザーのジャーニーを開始します。
メッセージ配信
SMS、LMS、MMSを送信する
SMS、LMS、MMSのいずれかを送信します。
カカオアリムトークを配信する
アリムトークのテンプレートを使って配信します。
カカオフレンドトーク
従来のフレンドトーク用エンドポイントを確認します。
テンプレートを使ってカカオブランドメッセージを配信する
テンプレートを使ってブランドメッセージを配信します。
カカオブランドメッセージを自由形式で配信する
自由形式でブランドメッセージを配信します。
メッセージ配信の管理
アリムトークのテンプレートを更新する
既存のアリムトークテンプレートを更新します。
080受信拒否サービス
受信拒否番号を照会、登録、削除します。
エクスポートと分析
キャンペーンイベントをエクスポートする
メッセージイベントのエクスポートを作成します。
キャンペーン統計を取得する
メッセージの統計を日付ごとに取得します。
キャンペーンの詳細統計を取得する
指定したキャンペーンの集計値と日別統計を取得します。
ユーザーのメッセージ履歴を取得する
ユーザーに送信されたメッセージを確認します。
