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

API Docs

listMessages

GET

/v1/message-list

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

Requestパラメータ

Authorization

Headerにパラメータ

Authorization

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

例：

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

Queryパラメータ

messages_offset

integer

可選

最新のメッセージとの相対位置を示すパラメーターです。本パラメーターが0の時、最新のメッセージから一覧が取得されます。

サンプル値:

messages_limit

integer

可選

一度に取得するメッセージの件数です。0~20の間で指定できます。0が設定された場合は20として扱われます。範囲外の数値が設定された場合、パラメーターが設定されていない場合はエラーが返却されます。

サンプル値:

Headerパラメータ

string

必須

サンプル値:

application/json

Authorization

string

必須

サンプル値:

Bearer <TOKEN>

Host

string

必須

UAT環境をご利用の場合はapi-uat.smartpost.jpを指定してください。

サンプル値:

User-Agent

string

必須

リクエスト元のアプリケーションやOS、ブラウザ、ユーザーエージェントのバージョンを識別するための文字列です。

サンプル値:

Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion

サンプルコード

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

array[object (ListMessageItem) {9}]

必須

メッセージの一覧です。

message_id

string

必須

メッセージの識別子です。

サンプル値:

00000000-0000-0000-0000-acc000000001_00000000-0000-0000-0000-acc000000002

title

string

必須

メッセージのタイトルです。

サンプル値:

Sample title

issuer

string

必須

メッセージ送信元のSmartPOSTアカウントです。

サンプル値:

黒須県黒須市

sent_at

integer

必須

SmartPOST管理画面からSmartPOSTにメッセージが送信された日時です。UNIX時間で返却されます。

サンプル値:

1667121000

arrived_at

integer

可選

デジタル郵便受けの「メッセージ一覧」画面にメッセージが表示された日時です。メッセージが同画面で一度も表示されていない場合は本パラメーターは返却されません。UNIX時間で返却されます。

サンプル値:

1667121000

api_arrived_at

integer

可選

ListMessageエンドポイントによってメッセージ情報が初めて取得された日時です。メッセージが初めてlistMessageによって取得される場合には本パラメーターは返却されません。UNIX時間で返却されます。

サンプル値:

1667121000

read_at

integer

可選

xIDアプリのデジタル郵便受けでメッセージが開かれた日時です。メッセージがデジタル郵便受け内で一度も開かれたことがない場合は本パラメーターは返却されません。UNIX時間で返却されます。

サンプル値:

1667121000

api_read_at

integer

可選

メッセージの内容がgetMessageエンドポイントによって初めて取得された日時です。メッセージがgetMessageエンドポイントによって一度も取得されていない場合は本パラメーターは返却されません。UNIX時間で返却されます。

サンプル値:

1667121000

categories

array[integer]

可選

設定されたメッセージカテゴリーに対応した数字の配列が返されます。
数字に対応するメッセージカテゴリーは以下のとおりです。
1: 給付金、補助金
2: 健康、医療
3: 学校、教育
4: 税金
5: 環境
6: 高齢者支援
7: 上下水道
8: 防災、地域安全
9: 選挙
10: 産業
11: 観光
12: 建築
13: 道路
14: 資源、ゴミ
15: 子育て、保育所
16: 生涯学習、図書館
17: 福祉、介護
18: 地域コミュニティ
19: 公共施設
20: 芸術、文化、スポーツ
21: 住民参画、意見募集
22: 個人宛通知
23: セグメント通知

total_count

integer

必須

利用者が受信したメッセージの総数です。

サンプル値:

100

例

{
    "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

healthcheck

getMessage