メインコンテンツへスキップ
GET
get-user-message-history
カーソルベースのページネーションこのAPIはカーソルベースのページネーションを使用します。次のページを取得するには、レスポンスのnext_cursorの値を、次のリクエストのcursorパラメーターに渡してください。next_cursorがnullの場合は、最後のページです。
主なイベント名チャネルによっては、ほかのイベントも存在します。
日付フィルターの利用条件start_dateとend_dateを使用する場合は、timezoneパラメーターも必ず渡してください。start_dateとend_dateは、常に両方を指定する必要があります。

承認

Authorization
string
header
必須

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

パスパラメータ

projectId
string
必須

32文字の16進文字列で表すプロジェクトIDです。

Pattern: ^[0-9a-f]{32}$
userId
string
必須

ユーザーのexternal_user_idです。

Minimum string length: 1

クエリパラメータ

page_size
integer
デフォルト:20

1ページの件数です。1から100まで指定でき、デフォルトは20件です。

必須範囲: 1 <= x <= 100
cursor
string

前のレスポンスに含まれるnext_cursorの値です。

channel
enum<string>

チャネルで絞り込みます。

利用可能なオプション:
push-notification,
web-push-notification,
email,
text-message,
kakao-alimtalk,
kakao-friendtalk,
kakao-brand-message,
line,
in-app-message,
in-web-message,
webhook
resource_type
enum<string>

リソースの種類です。campaignまたはuser_journeyを指定します。

利用可能なオプション:
campaign,
user_journey
resource_id
string

リソースIDです。指定する場合はresource_typeも必須です。

start_date
string<date>

検索範囲の開始日です。指定した日付も検索範囲に含まれます。YYYY-MM-DD形式で、end_dateおよびtimezoneと一緒に指定します。

end_date
string<date>

検索範囲の終了日です。指定した日付も検索範囲に含まれます。YYYY-MM-DD形式で、start_dateおよびtimezoneと一緒に指定します。

timezone
string

日付の解釈に使うタイムゾーンです。Asia/SeoulなどのIANA形式で指定します。

レスポンス

メッセージ履歴を取得しました。

data
object
error
string | null