# 法人ユーザー向けオプションAPIリファレンス
本ドキュメントに記載の機能は、所定の申請等を行った法人ユーザーのみがご利用いただけます。 自社のLINE公式アカウントでご利用になりたいお客様は、担当営業までご連絡いただくか、弊社パートナー (opens new window)にお問い合わせください。
# 共通仕様
# ステータスコード
『Messaging APIリファレンス』の「ステータスコード」を参照してください。
# ミッションスタンプAPI
ミッションスタンプは、ミッションの達成を条件としてユーザーに提供するスタンプです。スタンプをインセンティブに、ユーザーに「ID情報の連携」や「会員登録」、「アンケート回答」などを促すことができます。
# ミッションスタンプを送る(v3)
ユーザーに、任意のタイミングでミッションスタンプを送信します。
「ミッションスタンプを送る(v2)」と異なり、このエンドポイントを呼び出すサーバーのIPアドレスまたはネットワークアドレスを、LINE Developersコンソールに登録する必要はありません。
リクエストの例
# HTTPリクエスト
POST https://api.line.me/shop/v3/mission
# リクエストヘッダー
Content-Type
application/json
Authorization
Bearer {channel access token}
# リクエストボディ
to
String
送信先のユーザーID
productType
String
STICKER
productId
String
スタンプセットのパッケージID
sendPresentMessage
Boolean
false
# レスポンス
ステータスコード200
と空のレスポンスボディを返します。
# エラーレスポンス
エラー発生時は、以下のJSONデータを含むレスポンスボディが返されます。
message
String
エラー情報を含むメッセージ。詳しくは、以下の「エラーメッセージ」を参照してください。
# エラーメッセージ
エラーのJSONレスポンスのmessage
プロパティに含まれる、主なエラーメッセージは以下のとおりです。
メッセージ | 説明 |
---|---|
invalid request | ユーザーの状態が原因で、スタンプの送信に失敗しました。たとえば以下のような場合です。
|
not found | productId に指定したパッケージIDが無効です。 |
internal error | productId に指定したパッケージIDが無効です。 |
not allowed to use the API | チャネルに、ミッションスタンプAPIの利用権限が付与されていない。 |
not_sales_period | スタンプを送信した日時が、スタンプの有効期間外です。 |
# ミッションスタンプを送る(v2)
ユーザーに、任意のタイミングでミッションスタンプを送信します。
このエンドポイントを呼び出すサーバーのIPアドレスまたはネットワークアドレスを、LINE Developersコンソールに登録する必要があります。対象のチャネルの[セキュリティ管理]タブに、サーバーのIPアドレスまたはネットワークアドレスを追加してください。
リクエストの例
# HTTPリクエスト
POST https://api.line.me/v2/missionSticker/send
# リクエストヘッダー
Content-Type
application/json
X-Line-ChannelId
チャネルID。LINE Developersコンソールで確認できます。
X-Line-ChannelSecret
チャネルシークレット。LINE Developersコンソールで確認できます。
X-Line-Trusted-User-With-ACL
ミッションスタンプAPIの利用権限が付与されたときに、割り当てられた値。詳しくは、担当営業にお問い合わせください。
# リクエストボディ
to
String
送信先のユーザーID
messages
Array
packageId
プロパティとisPresent
プロパティを含むオブジェクトの配列。1個のみ指定できます。
messages[].packageId
String
スタンプセットのパッケージID
messages[].isPresent
Boolean
false
# レスポンス
ステータスコード200
と以下のプロパティを含むJSONオブジェクトを返します。
ticketId
String
LINEの内部で使われる値。
ticketId
が返された場合、APIリクエストは成功しています。
レスポンスの例
# エラーレスポンス
エラー発生時は、以下のJSONデータを含むレスポンスボディが返されます。
message
String
エラー情報を含むメッセージ。詳しくは、以下の「エラーメッセージ」を参照してください。
# エラーメッセージ
エラーのJSONレスポンスのmessage
プロパティに含まれる、主なエラーメッセージは以下のとおりです。
メッセージ | 説明 |
---|---|
authentication failed | 以下のいずれか、または両方です。
|
CHANNEL_MISSION_STICKER_NOT_USABLE | チャネルに、ミッションスタンプAPIの利用権限が付与されていない。 |
# オーディエンスマッチAPI
# レート制限
オーディエンスマッチAPIのAPIリクエストに関する制限は、Messaging APIのレート制限と同じです。
# メッセージタイプ
Messaging APIのメッセージタイプをすべて利用できます。
以下のメッセージタイプでは、URIアクション以外のアクションは設定できません。
URIアクション以外のアクションを設定すると、メッセージは送信されません。また、同じリクエストに含まれるその他のメッセージも送信されません。
# サポートされていない機能
オーディエンスマッチAPIでは、以下のプロパティやリクエストヘッダーは利用できません。
- emojisプロパティ
- X-Line-Retry-Keyリクエストヘッダー
- trackingIdプロパティ
# モバイル広告IDを利用してメッセージを送る
ユーザーが保有するモバイル広告ID(IFA:Identifier for Advertisers)に基づいたターゲティング配信を行います。
リクエストの例
# HTTPリクエスト
POST https://api.line.me/v2/bot/ad/message/multicast
# リクエストヘッダー
Content-Type
application/json
Authorization
Bearer {channel access token}
# リクエストボディ
to
Object
メッセージの送信先(IFA)。
to.type
String
ifa
to.ids
Array
IFA文字列の配列。
最大件数:150
messages
Array
送信するメッセージのメッセージオブジェクトの配列。
最大件数:5
notificationDisabled
Boolean
true
:メッセージ送信時に、ユーザーに通知されない。false
:メッセージ送信時に、ユーザーに通知される。ただし、LINEで通知をオフにしている場合は通知されません。
デフォルト値はfalse
です。
# レスポンス
ステータスコード200
と空のJSONオブジェクトを返します。
レスポンスの例
# モバイル広告IDを利用したメッセージ配信の結果を取得する
「モバイル広告IDを利用してメッセージを送る」で配信したメッセージの配信結果を取得します。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/message/delivery/ad_ifa?date={date}
# リクエストヘッダー
Content-Type
application/json
Authorization
Bearer {channel access token}
# クエリパラメータ
date
メッセージが送信された日付
- フォーマット:
yyyyMMdd
(例:20190831
) - タイムゾーン:UTC+9
# レスポンス
ステータスコード200
と以下の情報を含むJSONオブジェクトを返します。
status
String
集計処理の状態。以下のいずれかの値です。
ready
:メッセージ数を取得できます。unready
:date
に指定した日付のメッセージ数の集計がまだ完了していません。例えば、配信当日や未来の日付を指定した場合に返されます。通常、集計処理は配信の翌日中に完了します。unavailable_for_privacy
:該当日の通数の合計が20通未満です。out_of_service
:date
に指定した日付が、集計システムの稼働開始日(2018年03月31日)より前です。
success
Long
date
に指定した日付に、モバイル広告IDを利用して配信されたメッセージの数。status
の値がready
の場合にのみ、レスポンスに含まれます。
# 電話番号を利用してメッセージを送る
ユーザーの電話番号に基づいたターゲティング配信を行います。
リクエストの例
# HTTPリクエスト
POST https://api.line.me/bot/ad/multicast/phone
# リクエストヘッダー
Content-Type
application/json
Authorization
Bearer {channel access token}
# リクエストボディ
to
ハッシュ化した電話番号の配列
メッセージの送信先(E.164形式に正規化された電話番号を、SHA256でハッシュ化した値)。
最大件数:150
messages
メッセージオブジェクトの配列
送信するメッセージ。
最大件数:5
notificationDisabled
Boolean
true
:メッセージ送信時に、ユーザーに通知されない。false
:メッセージ送信時に、ユーザーに通知される。ただし、LINEで通知をオフにしている場合は通知されません。
デフォルト値はfalse
です。
# レスポンス
ステータスコード200
と空のJSONオブジェクトを返します。
レスポンスの例
# 電話番号を利用したメッセージ配信の結果を取得する
「電話番号を利用してメッセージを送る」で配信したメッセージの配信結果を取得します。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/message/delivery/ad_phone?date={date}
# リクエストヘッダー
Content-Type
application/json
Authorization
Bearer {channel access token}
# クエリパラメータ
date
メッセージが送信された日付
- フォーマット:
yyyyMMdd
(例:20190831
) - タイムゾーン:UTC+9
# レスポンス
ステータスコード200
と以下の情報を含むJSONオブジェクトを返します。
status
String
集計処理の状態。以下のいずれかの値です。
ready
:メッセージ数を取得できます。unready
:date
に指定した日付のメッセージ数の集計がまだ完了していません。例えば、配信当日や未来の日付を指定した場合に返されます。通常、集計処理は配信の翌日中に完了します。unavailable_for_privacy
:該当日の通数の合計が20通未満です。out_of_service
:date
に指定した日付が、集計システムの稼働開始日(2018年03月31日)より前です。
success
Long
date
に指定した日付に、電話番号を利用して配信されたメッセージの数。status
の値がready
の場合にのみ、レスポンスに含まれます。
# Mark-as-Read
# ユーザーからのメッセージに既読を付ける
特定のユーザーから送信されたすべてのメッセージに、任意のタイミングで"既読"を表示できます。
リクエストの例
# HTTPリクエスト
POST https://api.line.me/v2/bot/message/markAsRead
# リクエストヘッダー
Content-Type
application/json
Authorization
Bearer {channel access token}
# リクエストボディ
chat.userId
String
対象のユーザーID。
# レスポンス
ステータスコード200
と空のJSONオブジェクトを返します。
レスポンスの例