メッセージ送信
メッセージ送信API
エンドポイント
| URL | https://poster.ooo/api/v1/message/create |
|---|---|
| Method | POST |
Header
| X-POSTER-CLIENT-ID | Posterから発行された40文字の文字列 （Poster管理画面から確認して下さい。） |
|---|---|
| X-POSTER-CLIENT-SECRET | Posterから発行された80文字の文字列 （Poster管理画面から確認して下さい。） |
Request
RequestBodyに下記パラメータを含むJSON文字列をセットして下さい。
※右にスクロールできます。
| パラメータ名 | 省略 | 型 | 説明 |
|---|---|---|---|
| message_title | 可 | 文字列 | 管理用のメッセージタイトル |
| template_id | 不可*1 | 数字 | 送信可能なテンプレートのID |
| text | 不可*1 | 文字列(最大2,000文字) | 送信するメッセージ本文 |
| send_dt | 可 | 文字列 （YYYY-MM-DD HH:ii:ss） | 配信予約日時（省略時は現在時刻） |
| draft | 可 | 真偽値 | trueを指定すると下書き状態で保存されます（省略時はfalse） |
| target | 可 | オブジェクト | 配信対象者の絞り込み情報（詳細 ） |
| overwrite | 可*2 | オブジェクト | 置換キーに対してテキストやURLを指定してメッセージの一部を置換する事が出来ます 置換可能箇所や置換キーはテンプレート詳細画面でご確認いただけます |
※1 textまたはtemplage_idのどちらか一つを指定して下さい。
※2 templage_idを指定した場合のみ利用可能です
Requestデータサンプル
{
"message_title": "キャンペーンのご案内",
"template_id": 9999999999,
"send_dt": "2020-10-01 10:30:00",
"draft": false,
"overwrite": {
"123456789abcd_title": "アップデートのお知らせ",
"123456789abcd_text": "本日アップデートを実施いたしました。",
"123456789abcd_link_url": "https://poster.ooo/news/",
"123456789abcd_link_label": "詳細を確認する"
},
"target": {
"profile": {
"age": {
"from": 20,
"to": 39
}
}
}
}
ResponseBody (JSON)
| パラメータ名 | 型 | 説明 |
|---|---|---|
| message | 文字列 | 成功時：「success」 エラー時はエラーメッセージ |
| message_id | 数字 | 作成されたメッセージのID |
Responseデータサンプル
{
"message": "success",
"message_id": 5555555555
}
