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

getPdfUrl

GET

/v1/messages/{message_id}/get-pdf-url

ListMessageで取得したmessage_id および getMessageで取得した pdf_id file_name を使用して本エンドポイントにリクエストを送ることで、当該メッセージに添付されたPDFのURLを取得することができます。

情報

レスポンスに含まれるURLは署名付きURLで有効期間は3分間です。

リクエストパラメータ

Authorization

Headerにパラメータ

Authorization

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

例：

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

パスパラメータ

クエリパラメータ

リクエストコードサンプル

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.smartpost.jp/v1/messages/00000000-0000-0000-0000-acc000000001_00000000-0000-0000-0000-acc000000002/get-pdf-url?pdf_id=00000000-0000-0000-0000-acc000000001_00000000-0000-0000-0000-acc000000002&file_name=sample.pdf' \
--header 'Authorization: Bearer <token>'

レスポンス

🟢200Success

text/plain

ボディ

例

{
    "file_url": "https://files.smartpost.jp/xxxxxx.xxxx?Expires=1738041016&Signature=xxxxx&Key-Pair-Id=XXXX"
}

🟠400Bad Request

🟠401Unauthorized

🟠404Not Found

更新日時 2025-12-19 06:36:04

updateMessageStatusToRead