API Docs
Message API
Management API
Message API
Management API
xID for Developers
SmartPOST 管理画面
  1. Message API
  • SmartPOST Message API 概要
  • listAccountSubscriptions
    GET
  • healthcheck
    GET
  • listMessages
    GET
  • getMessage
    GET
  • getImageUrls
    GET
  • updateMessageStatusToRead
    POST
  • getPdfUrl
    GET
  1. Message API

SmartPOST Message API 概要

SmartPOST Message APIへようこそ🙌

SmartPOSTとは#

「SmartPOST（スマートポスト）」は、デジタルID「xIDアプリ」と連携した、自治体向けの郵送DXサービスです。
自治体職員は、LGWAN-ASP(自治体専用回線)サービスとして提供されるSmartPOST管理画面から、マイナンバーカードと連携した住民のxIDアプリに対して、メッセージの一括送信・個別送信ができます。
xIDアプリユーザーは、次の方法で受信したSmartPOSTメッセージを確認することができます。
xIDアプリの「デジタル郵便受け」機能
デジタル郵便受け for Web (https://mail.smartpost.jp)
SmartPOST Message APIを使用してメッセージを取得しているクライアントサービス

APIの概要#

SmartPOST Message APIは、xIDアプリユーザーの「デジタル郵便受け」に届いたメッセージに対して操作を行うことができるAPIです。
管理者としての操作（例：プロジェクトの受信者一覧の取得等）については、Management APIを利用することを推奨します。
現在Message APIでは、次の操作を実施できます。
メッセージの一覧の取得（ListMessage）
各メッセージの内容の取得（GetMessage）
メッセージの既読ステータスの更新（UpdateMessageStatus）
メッセージの画像の取得（GetImageUrls）
メッセージのPDFファイルの取得（GetPdfUrls）
各エンドポイントの仕様については、API仕様をご確認ください。

利用開始方法#

SmartPOST Message APIの利用をご希望の場合は、弊社コーポレートサイトお問い合わせフォームよりお問い合わせください。
なお、SmartPOST Message APIを使用するには、認可クライアントを取得する の手順に沿ってアプリユーザーの認可access_tokenを取得する必要があります。詳細はアクセストークンを取得するをご確認ください。
注意
xIDによる認可時にscopeにopenid, sp_messagesを含めてください。

メッセージのスタイル（CSS）について#

次のCSSを利用いただくことで、メッセージのスタイルを整えることができます。
https://public.smartpost.jp/styles/v1/style.css

レートリミット#

1分間に600リクエストまで
レートリミットは接続元のIPアドレス単位で適用されます。
レートリミットが適用された場合、リクエストは一時的に制限され、ステータスコード 429 を返します。
情報
レートリミットの実装の仕様上、制限が完全に一致することは保証しておりません。
余裕を持った、かつ、レート超過した際のエラーハンドリングの実装等、フールプルーフ設計を推奨しています。

稼働時間#

本番環境：常時稼働
UAT環境：平日 9:00 ~ 19:00
注意
検証環境を利用する場合、xID Client APIとSmartPOST Message APIの稼働時間が異なる点にご留意ください。

エラーレスポンス#

メッセージ説明
"access token is not valid"アクセストークンが無効です。
"could not bind request body"リクエストボディをバインドできませんでした。
"messages limit value is out of range"メッセージの上限値が範囲外です。
"messages offset value can't be negative"メッセージのオフセット値は負の数にできません。
"could not read request body"リクエストボディを読み込めませんでした。
"messages_offset field is missing in request body"リクエストボディにmessages_offsetフィールドがありません。
"messages_limit field is missing in request body"リクエストボディにmessages_limitフィールドがありません。
"incorrect UUID parameter in url"URL内のUUIDパラメータが正しくありません。
"error when processing access token"アクセストークン処理時にエラーが発生しました。
"error when getting user data"ユーザーデータ取得時にエラーが発生しました。
"error when getting message"メッセージ取得時にエラーが発生しました。
"could not prepare message"メッセージを準備できませんでした。
"error when getting list of messages"メッセージリスト取得時にエラーが発生しました。
"error when updating message"メッセージ更新時にエラーが発生しました。
"status read was already set earlier"readステータスが既に設定されています。
"Registered account not found"利用者がデジタル郵便受けに登録されていません。
"messageId not found"指定されたメッセージIDが見つかりませんでした。
"incorrect format of message_id"指定されたメッセージIDのフォーマットが不正です。
"spid not found"トークンから識別した利用者の登録が見つかりませんでした。
"introspect response not found in context"アクセストークン処理時にエラーが発生しました。
"introspect response is not of type IntrospectResponse"アクセストークン処理時にエラーが発生しました。
更新日時 2025-12-19 06:35:21
次へ
listAccountSubscriptions
Built with