ovahubGETBearer トークン
通知メッセージを取得
/api/v1/messages
組織のメッセージと未読件数を取得します。1 ページ 8 件です。
API のフィールド名、型、コードはすべての言語で共通です。
リクエスト例
cURL
curl "https://tovahub.com/api/v1/messages?page=1" \
-H "Authorization: Bearer $TOVAHUB_TOKEN"表示のみ。このページから API リクエストは送信されません。
レスポンス例
JSON
{
"userId": "507f1f77bcf86cd799439013",
"through": "2026-11-07T12:00:00.000Z",
"messages": [],
"unreadCount": 0,
"page": 1,
"pageSize": 8,
"totalCount": 0,
"totalPages": 1
}パラメーター
pageクエリ · 任意string
クエリ文字列で表す正の整数。既定値は "1"。totalPages に従ってページを切り替えてください。
レスポンス
HTTP ステータス 200
組織のメッセージをページ番号方式で取得します。
userIdstring (ObjectId)認証済みユーザーの識別子。
throughstring (ISO 8601)mark_messages_read に渡すメッセージ取得時点の締め切り時刻。
messagesarray必要なフィールドを抽出したメッセージレコード。serverId と dedupeKey は含みません。
messages[]._idstring (ObjectId)メッセージ識別子。
messages[].ticketIdstring (ObjectId) | null存在する場合、関連するサポートチケットの識別子。
messages[].typestringserver_expiring、server_expired、renewal_failed、balance_gift、admin_message、ticket_reply のいずれか。
messages[].serverNamestring | null存在する場合、関連するサーバー名。
messages[].expiresAtstring (ISO 8601) | null存在する場合、関連するサービスの有効期限。
messages[].daysLeftnumber | null存在する場合、通知に含まれる残り日数。
messages[].amountstring | null存在する場合、通知の金額。
messages[].messagestring | null存在する場合、メッセージ本文。
messages[].readAtstring (ISO 8601) | null既読日時、または null。
messages[].createdAtstring (ISO 8601)メッセージの作成日時。
unreadCountnumber組織全体の未読メッセージ件数。
pagenumber実際のページ番号。利用可能なページの範囲内に調整されます。
pageSizenumber (8)固定のページサイズ。
totalCountnumberメッセージの総件数。
totalPagesnumber総ページ数。空の一覧でも最低 1 ページです。