getImageUrls - API Docs

Requestパラメータ

Authorization

Headerにパラメータ

Authorization

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

例：

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

Pathパラメータ

message_id

string

必須

メッセージのIDを指定します。

サンプル値:

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

Queryパラメータ

image_ids

array[string]

可選

イメージIDでフィルターできまます。複数指定する場合は、カンマ区切りで指定します。

サンプル値:

["00000000-0000-0000-0000-acc000000001,00000000-0000-0000-0000-acc000000002"]

Headerパラメータ

Accept

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

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.smartpost.jp/v1/messages/00000000-0000-0000-0000-acc000000001_00000000-0000-0000-0000-acc000000002/get-image-urls?image_ids=00000000-0000-0000-0000-acc000000001,00000000-0000-0000-0000-acc000000002' \
--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

array of:

image_id

string

可選

メッセージに挿入されている画像のIDです。

サンプル値:

00000000-0000-0000-0000-acc000000001

signed_url

string <uri>

可選

メッセージに挿入されている画像の署名付きURLです。

サンプル値:

https://assets.smartpost.jp/xxxxxx.xxxx?Expires=1738041016&Signature=xxxxx&Key-Pair-Id=XXXX

例

[
    {
        "image_id": "00000000-0000-0000-0000-acc000000001",
        "signed_url": "https://image-sample-url.com/image1.jpg"
    },
    {
        "image_id": "00000000-0000-0000-0000-acc000000002",
        "signed_url": "https://image-sample-url.com/image2.jpg"
    }
]

🟠400Bad Request

🟠401Unauthorized

🟠404Not Found