SmartPOSTの公開APIドキュメントです。

listMessages

GET

/v1/message-list

このエンドポイントを使用することで、xIDアプリユーザーがSmartPOSTに受信したメッセージの一覧を取得することができます。

Requestパラメータ

Authorization

Headerにパラメータ

Authorization

を追加し、その値にはBearerの後にTokenを連結します

例：

Authorization: Bearer ********************

Queryパラメータ

Headerパラメータ

サンプルコード

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.smartpost.jp/v1/message-list?messages_offset=0&messages_limit=20' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Host: api.smartpost.jp' \
--header 'User-Agent: Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion'

Response

🟢200Success

application/json

Body

例

{
    "messages": [
        {
            "message_id": "123e4567-e89b-12d3-a456-426614174000_123e4567-e89b-12d3-a456-426614174001",
            "title": "Example message title 1",
            "issuer": "黒須県黒須市",
            "sent_at": 1733810881,
            "arrived_at": 1734997829,
            "api_arrived_at": 1734997826,
            "read_at": 1734997829,
            "api_read_at": 1734997827
        },
        {
            "message_id": "123e4567-e89b-12d3-a456-426614174002_123e4567-e89b-12d3-a456-426614174003",
            "title": "Example message title 2",
            "issuer": "黒須県黒須市",
            "sent_at": 1733379044,
            "arrived_at": 1733379045,
            "api_arrived_at": 1733379531,
            "read_at": 1733379533,
            "api_read_at": 1733379533
        }
    ],
    "total_count": 2
}

🟠400Bad Request

🟠401Unauthorized

🟠404Not Found

更新日時 2025-05-15 07:43:34

healthcheck

getMessage