SmartPOSTの公開APIドキュメントです。
SmartPOST Message API 概要
SmartPOSTとは
APIの概要
管理者としての操作（例：プロジェクトの受信者一覧の取得等）については、Management APIを利用することを推奨します。
現在Message APIでは、次の操作を実施できます。
利用開始方法
access_tokenを取得する必要があります。詳細はアクセストークンを取得するをご確認ください。注意
scopeにopenid, sp_messagesを含めてください。メッセージのスタイル（CSS）について
レートリミット
レートリミットが適用された場合、リクエストは一時的に制限され、ステータスコード 429 を返します。
情報
余裕を持った、かつ、レート超過した際のエラーハンドリングの実装等、フールプルーフ設計を推奨しています。
稼働時間
注意
エラーレスポンス
| メッセージ | 説明 |
|---|---|
| "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-05-14 08:04:14