getProject - API Docs

listProjectsで取得したプロジェクトのIDを使用して本エンドポイントにリクエストを送ることで、プロジェクト（Welcomeプロジェクト、テンプレートも含む）の詳細情報を取得できます。

情報

message_bodyについては、プレビュー用途で使われる想定で提供されます。
カスタム変数等、受信者によって異なるものについては、設定されている受信者に設定されている値の中からピックアップされたもの、もしくはサンプル値が含まれます。
また、SmartPOSTでデフォルトとして提供しているCSSを利用いただくことを想定しています。
https://public.smartpost.jp/styles/v1/style.css

Requestパラメータ

Authorization

Headerにパラメータ

Authorization

を追加し、その値にはBasicの後にスペースと、Base64でエンコードされたusername:passwordが連結されます

例：

Authorization: Basic *****************

Pathパラメータ

string

必須

プロジェクトのIDを指定します。

サンプル値:

00000000-0000-0000-0000-102101ec7001

Headerパラメータ

string

必須

サンプル値:

application/json

Authorization

string

必須

Basic認証を利用します。値にはBasicの後にスペースとBase64でエンコードされた{API key ID}:{API key secret}を利用します。

サンプル値:

Basic <Base64-encoded-credentials>

Host

string

必須

UAT環境をご利用の場合はmanagement-api-uat.smartpost.jpを指定してください。

サンプル値:

User-Agent

string

必須

サンプル値:

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

string

必須

プロジェクトの識別子です。

サンプル値:

00000000-0000-0000-0000-acc000000001

account_id

string

必須

プロジェクトが属するアカウントの識別子です。

サンプル値:

00000000-0000-0000-0000-acc000000001

title

string

可選

プロジェクトのタイトルです。（メッセージのタイトルではありません。）

<= 255 文字列

サンプル値:

sample title

message_title

string

可選

メッセージのタイトルです。

<= 255 文字列

サンプル値:

sample message title

message_body

string

可選

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

サンプル値:

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

image_ids

array[string]

可選

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

is_set_recipient

boolean

必須

受信者設定についての設定ステータスです。
true: 設定済み
false: 未設定

サンプル値:

true

is_set_content

boolean

必須

メッセージについての設定ステータスです。
true: 設定済み
false: 未設定

サンプル値:

true

is_set_approver

boolean

必須

承認者についての設定ステータスです。
true: 設定済み
false: 未設定

サンプル値:

true

is_set_schedule

boolean

必須

通知日時についての設定ステータスです。
true: 設定済み
false: 未設定

サンプル値:

true

schedule

integer

可選

通知日時（UNIX時間）です。

サンプル値:

1667899934

created_by

string

必須

プロジェクトを作成した管理者のIDです。

サンプル値:

00000000-0000-0000-0000-acc000000001

created_at

integer

必須

プロジェクトが作成された時刻（UNIX時間）です。

サンプル値:

1667899934

updated_by

string

可選

プロジェクトを最後に更新した管理者のIDです。

サンプル値:

00000000-0000-0000-0000-acc000000001

updated_at

integer

可選

プロジェクトが最後に更新された時刻（UNIX時間）です。

サンプル値:

1667899934

sent_to_all_recipients_at

integer

可選

全ての受信者に通知された日時（UNIX時間）です。

サンプル値:

1667899934

all_approved_at

integer

可選

全ての承認者が承認した時刻（UNIX時間）です。

サンプル値:

1667899934

is_disposition_notice

boolean

必須

処分通知についての設定ステータスです。
true: 設定あり
false:設定なし

type

integer

必須

プロジェクトのタイプです。
normal: プロジェクト
welcome: Welcomeプロジェクト
template: テンプレート

サンプル値:

normal

categories

array[integer]

可選

設定されたメッセージカテゴリーに対応した数字の配列が返されます。
数字に対応するメッセージカテゴリーは以下のとおりです。
1: 給付金、補助金
2: 健康、医療
3: 学校、教育
4: 税金
5: 環境
6: 高齢者支援
7: 上下水道
8: 防災、地域安全
9: 選挙
10: 産業
11: 観光
12: 建築
13: 道路
14: 資源、ゴミ
15: 子育て、保育所
16: 生涯学習、図書館
17: 福祉、介護
18: 地域コミュニティ
19: 公共施設
20: 芸術、文化、スポーツ
21: 住民参画、意見募集
22: 個人宛通知
23: セグメント通知

permitted_groups

array [object {2}]

可選

グループ権限で設定されたグループです。

string

必須

グループ権限で設定されたグループのIDです。

サンプル値:

00000000-0000-0000-0000-acc000000001

name

string

必須

グループ権限で設定されたグループ名です。

サンプル値:

sample group

prefecture

string

必須

プロジェクトが属するアカウントの都道府県名です。

サンプル値:

黒須県

city

string

必須

プロジェクトが属するアカウントの市区町村名です。

サンプル値:

黒須市

version

string

必須

プロジェクトのバージョンです。SmartPOSTの内部で利用されるのみの値です。

サンプル値:

例

{
    "id": "00000000-0000-0000-0000-acc000000001",
    "account_id": "00000000-0000-0000-0000-acc000000001",
    "title": "sample title",
    "message_title": "sample message title",
    "message_body": "<div class=\"smartpost-api-exported-content\"><p>example message body</p></div>",
    "image_ids": [
        "00000000-0000-0000-0000-acc000000001"
    ],
    "is_set_recipient": true,
    "is_set_content": true,
    "is_set_approver": true,
    "is_set_schedule": true,
    "schedule": 1667899934,
    "created_by": "00000000-0000-0000-0000-acc000000001",
    "created_at": 1667899934,
    "updated_by": "00000000-0000-0000-0000-acc000000001",
    "updated_at": 1667899934,
    "sent_to_all_recipients_at": 1667899934,
    "all_approved_at": 1667899934,
    "is_disposition_notice": true,
    "type": "normal",
    "categories": [
        1
    ],
    "permitted_groups": [
        {
            "id": "00000000-0000-0000-0000-acc000000001",
            "name": "sample group"
        }
    ],
    "prefecture": "黒須県",
    "city": "黒須市",
    "version": "v2"
}

🟠400Bad Request

🟠401Unauthorized

🟠404Not Found