メッセージ一覧参照API
概要
アプリ内メッセージの一覧を返却します。
URL
/v1/delivery
メソッド
GET
リクエスト
リクエストパラメータ
| パラメータ | 必須 | デフォルト | 最小 | 最大 | 説明 | 詳細 | 備考 |
|---|---|---|---|---|---|---|---|
| count | - | 20 | 1 | 100 | ページ毎の件数 | - | - |
| page | - | 1 | 1 | - | ページ数 | - | - |
リクエストボディ
なし
リクエストのサンプル
curl -H 'X-POPINFO-MAPI-TOKEN: {auth_token}' https://{domain}/v1/delivery
レスポンス
メディアタイプ
application/json
レスポンスヘッダ
| キー | 説明 | 備考 |
|---|---|---|
| link | リンク情報 | 次の形式で「次のページ」と「前のページ」の情報を付与。link: <https://{domain}/v1/delivery?page=3>; rel="next"<https://{domain}/v1/delivery?page=1>; rel="previous" |
成功時レスポンス
「基底オブジェクト」のリストを返却
基底オブジェクト
| キー | 型 | 説明 | 詳細 | 備考 |
|---|---|---|---|---|
| name | 文字列 | メッセージ名 | 100文字以下 | - |
| priority | 数値 | 優先度 | 0以上 | - |
| delivery_id | 数値 | 配信ID | - | - |
| condition | オブジェクト | 配信条件 | - | - |
| message | オブジェクト | メッセージ | - | - |
conditionオブジェクト
| キー | 型 | 説明 | 詳細 | 備考 |
|---|---|---|---|---|
| trigger | オブジェクト | 起動条件 | - | - |
| target | オブジェクト | - | 0以上 | - |
| max_total_count | 数値 | 最大配信回数 | 1以上 | - |
| max_total_count_per_day | 数値 | 1日あたりの最大配信回数 | 1以上 | - |
| condition_id | 数値 | 条件ID | - | - |
| is_active | 真偽値 | 配信ステータス | true: 有効 false: 無効 |
- |
messageオブジェクト
| キー | 型 | 説明 | 詳細 | 備考 |
|---|---|---|---|---|
| template_id | 数値 | テンプレートID | 1: ポップアップ（ボタン1個） 2: ポップアップ（ボタン2個） 3: ポップアップ（画像のみ） 4: フルスクリーン（ボタン1個） 5: フルスクリーン（ボタン2個） 6: ポップアップ（ボタン1個）背景狭 7: ポップアップ（ボタン2個）背景狭 8: ポップアップ（ボタン2個縦並び）背景狭 9: ポップアップ（ボタン2個縦並び） 10: フルスクリーン（ボタン2個縦並び） |
- |
| title | 文字列 | メッセージタイトル | 40文字以下 | - |
| body | 文字列 | メッセージ本文 | 200文字以下 | - |
| image_url | 文字列（URI） | 画像URL | 1文字以上2083文字以下 | - |
| buttons | オブジェクト | ボタン | - | - |
| message_id | 数値 | メッセージID | - | - |
triggerオブジェクト
| キー | 型 | 説明 | 詳細 | 備考 |
|---|---|---|---|---|
| event_name | 文字配列 | イベント名 | アプリ内メッセージを表示するトリガーとなるイベント名 | 最大10個 |
| period | オブジェクト | periodオブジェクト参照 | - | 最大100個 |
targetオブジェクト
| キー | 型 | 説明 | 詳細 | 備考 |
|---|---|---|---|---|
| segmentation_id | 数値 | セグメントID | - | - |
periodオブジェクト
| キー | 型 | 説明 | 詳細 | 備考 |
|---|---|---|---|---|
| start | 文字列（datetime） | 表示開始日時 | - | - |
| end | 文字列（datetime） | 表示終了日時 | - | - |
レスポンスフォーマット
[
{
"name": "string",
"priority": 0,
"delivery_id": 0,
"condition": {
"trigger": {
"event_name": [
"string"
],
"period": [
{
"start": "2019-01-01T12:12:12+09:00",
"end": "2019-01-01T12:12:12+09:00"
}
]
},
"target": {
"segmentation_id": 0
},
"max_total_count": 1,
"max_total_count_per_day": 1,
"category": "string",
"condition_id": 0,
"is_active": true
},
"message": [
{
"template_id": 1,
"title": "string",
"body": "string",
"image_url": "http://example.com",
"buttons": [
{
"id": "string",
"name": "string",
"url": "http://example.com",
"event_name": "string"
}
],
"message_id": 0
}
]
}
]