Skip to main content
GET
get-user-message-history
Cursor-based paginationThis API uses cursor-based pagination. To retrieve the next page, pass the response’s next_cursor value as the cursor parameter in the next request. A null value for next_cursor indicates the last page.
Common event namesAdditional events may be available for each channel.
Date filter requirementsWhen you use start_date and end_date, you must also pass the timezone parameter. Always use start_date and end_date together.

Authorizations

Authorization
string
header
required

Pass the token issued by POST /authenticate as a bearer token.

Path Parameters

projectId
string
required

Project ID as a 32-character hexadecimal string.

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

The user's external_user_id.

Minimum string length: 1

Query Parameters

page_size
integer
default:20

Page size from 1 to 100. The default is 20.

Required range: 1 <= x <= 100
cursor
string

The next_cursor value from the previous response.

channel
enum<string>

Filter by channel.

Available options:
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>

Resource type. Use campaign or user_journey.

Available options:
campaign,
user_journey
resource_id
string

Resource ID. If you set this, also set resource_type.

start_date
string<date>

Inclusive start date in YYYY-MM-DD format. Use with end_date and timezone.

end_date
string<date>

Inclusive end date in YYYY-MM-DD format. Use with start_date and timezone.

timezone
string

IANA time zone used to interpret dates, for example Asia/Seoul.

Response

Message history retrieved.

data
object
error
string | null