getMessage - API Docs

listMessageで取得したmessage_idを使用して本エンドポイントにリクエストを送ることで、当該メッセージの本文（message）をHTML形式で取得することができます。

画像のURLについて

本エンドポイントでは、メッセージに画像が含まれる場合、画像取得用の署名付きURLをレスポンスに含みます。有効期間は5分間です。クライアント側に取得したレスポンスを保存する場合等、状況に応じてパラメーターwith-image-id、および、GetImageUrlsの利用を検討してください。

Requestパラメータ

Authorization

Headerにパラメータ

Authorization

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

例：

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

Pathパラメータ

string

必須

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

サンプル値:

00000000-0000-0000-0000-acc000000001_00000000-0000-0000-0000-acc000000001

Queryパラメータ

change-read-status

boolean

可選

メッセージの既読日時（api_read_at）を入力するかどうかを選択するためのオプションパラメーターです。falseを指定することで、メッセージの既読日時を入力することなくメッセージを取得できます。

true: メッセージのapi_read_atを入力します
false: メッセージのapi_read_atを入力しません

サンプル値:

false

with-image-id

string

可選

画像のURLの代わりにimage-idでmessageを取得するためのオプションパラメーターです。クエリパラメーターに文字列with-image-idを付与することで、画像のURLではなく、image-idが含まれた形でレスポンスされます。
（値は不要です）

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

Response

🟢200Success

application/json

Body

message_id

string

必須

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

サンプル値:

00000000-0000-0000-0000-acc000000001

message

string

必須

メッセージの本文（HTML）です。

サンプル値:

<div class="smartpost-api-exported-content"><p>example message body</p><div>

image_ids

array[string]

可選

メッセージに含まれる画像の識別子です。

例

{
    "message_id": "123e4567-e89b-12d3-a456-426614174000_123e4567-e89b-12d3-a456-426614174001",
    "message": "<div class=\"smartpost-api-exported-content\"><p>Test project sending</p></div>"
}

🟠400Bad Request

🟠401Unauthorized

🟠404Not Found