curl --request POST \
--url https://api.notifly.tech/projects/{projectId}/campaigns/{campaignId}/send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipients": [
{
"type": "phone-number",
"phoneNumber": "010-1234-5678"
}
]
}
'
{
"code": 200,
"success": true,
"error": null
}
キャンペーンとジャーニー
キャンペーンをトリガーする
キャンペーンをトリガーし、指定した送信先に配信します。
POST
/
projects
/
{projectId}
/
campaigns
/
{campaignId}
/
send
curl --request POST \
--url https://api.notifly.tech/projects/{projectId}/campaigns/{campaignId}/send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipients": [
{
"type": "phone-number",
"phoneNumber": "010-1234-5678"
}
]
}
'
{
"code": 200,
"success": true,
"error": null
}
プロジェクトのチャネル設定に応じて、アプリプッシュ、Webプッシュ、カカオアリムトーク、カカオフレンドトーク、カカオブランドメッセージ、テキストメッセージ(SMS、LMS、MMS)、メール、LINEのキャンペーンをAPIからトリガーできます。フレンドトークは旧チャネルです。
送信先の指定方法とパーソナライズ選択したチャネルで対応していない送信先の指定方法を使うと、
パーソナライズにユーザーデータを使う場合は
400 Bad Requestが返ります。| チャネル | 送信先の指定方法 |
|---|---|
| アプリプッシュ、Webプッシュ | user-id |
| カカオアリムトーク、カカオフレンドトーク、カカオブランドメッセージ、テキストメッセージ | user-id、phone-number |
| メール | user-id、email |
| LINE | user-id、line-user-id |
user-idで指定します。ほかの指定方法では、Notiflyはリクエストに含まれる情報を使います。たとえば本文が{{ user["name"] }} さん、こんにちはの場合、名前が空になり、受信者にはさん、こんにちはと表示されます。イベントパラメーターは、どの指定方法でも使えます。重複した送信先の扱いアプリプッシュとWebプッシュは、同じデバイストークンに一度だけ送信します。カカオアリムトーク、カカオフレンドトーク、カカオブランドメッセージ、テキストメッセージは電話番号で重複を判定します。メールはメールアドレス、LINEはLINEユーザーIDで判定します。
400レスポンスに含まれる無効な送信先送信先の検証に失敗すると、
400レスポンスにerrorDetailsが含まれます。{
"code": 400,
"success": false,
"error": "Bad request: invalid recipients",
"errorDetails": {
"reasonCode": "INVALID_RECIPIENTS",
"channel": "kakao-friendtalk",
"invalidRecipientCount": 2,
"invalidRecipients": [
{
"index": 0,
"type": "user-id",
"userId": "user_001",
"reasonCode": "MISSING_PHONE_NUMBER",
"source": { "pointer": "/recipients/0/userId" }
},
{
"index": 12,
"type": "user-id",
"userId": "user_013",
"reasonCode": "MISSING_PHONE_NUMBER",
"source": { "pointer": "/recipients/12/userId" }
}
]
}
}
| フィールド | 型 | 意味 |
|---|---|---|
reasonCode | string | 常にINVALID_RECIPIENTSです。 |
channel | string | キャンペーンのチャネルです。値はtext-message、kakao-alimtalk、kakao-friendtalk、kakao-brand-message、emailです。 |
invalidRecipientCount | number | 無効な送信先の件数です。 |
invalidRecipients | array | 無効な送信先の一覧です。 |
invalidRecipients[].index | number | リクエストのrecipients配列内の位置です。インデックスは0から始まります。 |
invalidRecipients[].type | string | 常にuser-idです。 |
invalidRecipients[].userId | string | リクエストに含まれるuserIdの値です。 |
invalidRecipients[].reasonCode | string | MISSING_PHONE_NUMBERまたはMISSING_EMAILです。 |
invalidRecipients[].source.pointer | string | JSON Pointerで示したリクエストフィールドの位置です。 |
| チャネル | 必須フィールド | reasonCode |
|---|---|---|
text-message | phone_number | MISSING_PHONE_NUMBER |
kakao-alimtalk | phone_number | MISSING_PHONE_NUMBER |
kakao-friendtalk | phone_number | MISSING_PHONE_NUMBER |
kakao-brand-message | phone_number | MISSING_PHONE_NUMBER |
email | email | MISSING_EMAIL |
push-notification、web-push-notification | 連絡先の検証なし | なし |
400レスポンスにはcode、success、errorが含まれます。errorDetailsが含まれるのは、送信先の検証に失敗した場合だけです。パラメーターが不正な場合やキャンペーンが無効な場合は含まれません。user-idで指定したユーザーがNotiflyに登録済みでも、チャネルに必要な連絡先の情報がなければ無効な送信先になります。存在しないユーザーIDはスキップします。partialSendがfalseまたは省略されている場合、無効な送信先が1件でもあるとリクエスト全体が400で失敗し、メッセージは配信されません。- 再送する場合は、
errorDetails.invalidRecipientsを確認し、無効な送信先をリクエストから削除します。
有効な送信先に限って配信する
partialSendをtrueにすると、一部の送信先に電話番号やメールアドレスがなくても、有効な送信先に配信します。partialSend: false(デフォルト)の場合、無効な送信先が1件でもあるとリクエストは400で失敗し、どの送信先にも配信されません。partialSend: trueの場合、有効な送信先に配信し、無効な送信先をレスポンスに含めます。すべての送信先が無効でも200が返ります。
partialSend: trueで無効な送信先が2件ある場合のレスポンス例です。{
"code": 200,
"success": true,
"error": null,
"errorDetails": {
"reasonCode": "INVALID_RECIPIENTS",
"channel": "kakao-alimtalk",
"invalidRecipientCount": 2,
"invalidRecipients": [
{
"index": 1,
"type": "user-id",
"userId": "user_002",
"reasonCode": "MISSING_PHONE_NUMBER",
"source": { "pointer": "/recipients/1/userId" }
},
{
"index": 3,
"type": "user-id",
"userId": "user_004",
"reasonCode": "MISSING_PHONE_NUMBER",
"source": { "pointer": "/recipients/3/userId" }
}
]
}
}
partialSendに対応するチャネルは、kakao-alimtalk、kakao-friendtalk、kakao-brand-message、text-message、emailです。この連絡先の検証は
user-idで指定した送信先に適用されます。type: "phone-number"またはtype: "email"で直接指定した場合は対象外です。ボディ
application/json
