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

updateMessageStatusToRead

POST

/v1/messages/{id}/read

getMessageのリクエストの際にchange-read-status: falseでレスポンスを取得する場合、クライアントサービスにおいてユーザーがメッセージを開くタイミングで本APIのリクエストをお願いします。対象のメッセージのmessage_idを使用してリクエストすると、SmartPOSTサービス上における当メッセージの既読時刻（api_read_at）が入力されます。

Requestパラメータ

Authorization

Headerにパラメータ

Authorization

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

例：

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

Pathパラメータ

string

必須

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

サンプル値:

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

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

curl --location --request POST 'https://api.smartpost.jp/v1/messages/00000000-0000-0000-0000-acc000000001_00000000-0000-0000-0000-acc000000002/read' \
--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

text/plain

Body

object {0}

🟠400Bad Request

🟠401Unauthorized

getImageUrls