N-INE Public API (1.0.13)

Download OpenAPI specification:

N-INE クライアント向け公開API

カレンダーイベントを作成

カレンダーイベントを作成します。

終日イベントの場合の注意点:

  • isAllDay: trueの場合、startAtの時刻部分は自動的に00:00:00 UTCに正規化されます
  • endAtは無視され、常にnullとして保存されます
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
miniappId
required
string

ミニアプリID

genreId
required
string

ジャンルID

title
required
string

イベントタイトル

url
string or null

イベントURL

visibleFrom
required
string <date-time>

表示開始日時(ISO 8601形式)

isAllDay
required
boolean

終日イベントかどうか

startAt
required
string <date-time>

イベント開始日時(ISO 8601形式) 終日イベントの場合、時刻部分は自動的に00:00:00 UTCに正規化されます

endAt
string or null <date-time>

イベント終了日時(ISO 8601形式) 終日イベントの場合、この値は無視され、常にnullとして保存されます

Responses

Request samples

Content type
application/json
Example
{
  • "miniappId": "01HQZX1234567890ABCDEFGHIJ",
  • "genreId": "01HQZY1234567890ABCDEFGHIJ",
  • "title": "重要なイベント",
  • "visibleFrom": "2025-12-01T00:00:00Z",
  • "isAllDay": false,
  • "startAt": "2025-12-25T10:00:00Z",
  • "endAt": "2025-12-25T12:00:00Z"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "calendarEvent": {
    }
}

マルチキャスト配信を作成

LINEマルチキャスト配信を作成します。

重要な制限事項:

  • LINE Messaging API制限により、1回のリクエストで最大5件のメッセージまで送信可能です
  • ブロードキャスト配信でない場合、targetingSettingsは必須です
  • targetingSettings.includeTargetTypeがTAGSの場合、includeTagIdsは必須です
  • LINE連携情報(Messaging API・LINEログインのチャネル)が未登録のCRMアカウントは指定できません(400 LINE account configuration not found)
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
crmAccountId
required
string

CRMアカウントID

isBroadcast
required
boolean

ブロードキャスト配信かどうか

scheduledAt
string or null <date-time>

配信予約日時(ISO 8601形式)

customAggregationUnit
string or null

カスタム集計単位

object or null

ブロードキャスト配信でない場合は必須

includeTagIds
Array of strings

配信対象タグID(includeTargetType='TAGS'の場合は必須)

excludeTagIds
Array of strings

除外対象タグID

required
Array of objects [ 1 .. 5 ] items

配信するメッセージ(最低1件、最大5件)

Responses

Request samples

Content type
application/json
Example
{
  • "crmAccountId": "01HQZW1234567890ABCDEFGHIJ",
  • "isBroadcast": true,
  • "messages": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "multicast": {
    }
}

全てのタグ情報を取得

全てのタグ情報を取得します。

Authorizations:
ApiKeyAuth
query Parameters
limit
integer >= 1
Default: 100

1ページあたりの取得件数。デフォルトは100件。

offset
integer >= 0
Default: 0

取得開始位置。デフォルトは0(最初のアイテムから取得)。

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "tags": [
    ],
  • "totalCount": 100,
  • "limit": 100,
  • "offset": 0
}

LINEユーザーに紐づくタグ情報を取得

指定したLINEユーザーIDに紐づくタグ情報を取得します。

Authorizations:
ApiKeyAuth
path Parameters
lineUserId
required
string

タグ情報を取得する対象のLINEユーザーID。

query Parameters
limit
integer >= 1
Default: 100

1ページあたりの取得件数。デフォルトは100件。

offset
integer >= 0
Default: 0

取得開始位置。デフォルトは0(最初のアイテムから取得)。

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "lineUserId": "string",
  • "tags": [
    ],
  • "totalCount": 100,
  • "limit": 100,
  • "offset": 0
}

ミニアプリに紐づくジャンル一覧を取得

指定したミニアプリIDに紐づくジャンルグループとジャンルの階層構造を取得します。

リマインダーの通知がONの利用者に配信する場合: 利用タグ(usageTagId)でミニアプリの利用者に絞り込み、対象ジャンルの通知OFFタグ(tagId)で除外します。 初期値のまま通知がONの利用者も対象です。初期設定が必要なミニアプリでは、初期設定を完了した利用者、 または既存の通知設定により初期設定が不要な利用者が対象となり、初期設定が必要なまま未完了の利用者は対象外です。 初期設定が不要なミニアプリでは、起動した利用者が対象です。

利用開始前に、利用タグの設定と既存利用者の移行が完了していることをサービス担当者へ確認してください。 usageTagId が返されるだけでは移行完了を判断できません。 usageTagId または対象ジャンルの tagId が null の場合、この方法での配信は行わず、サービス担当者へ確認してください。

対象ジャンルを1件指定する場合、POST /multicasts に次の配信条件を設定します。 CRMアカウントID、メッセージ、配信予約日時などは、同APIの仕様に従って指定してください。

  • isBroadcast: false
  • includeTagIds: usageTagId のみを含む配列
  • excludeTagIds: 対象ジャンルの tagId のみを含む配列
  • targetingSettings.includeTargetType: TAGS
  • targetingSettings.includeTagConditionType: AND
  • targetingSettings.excludeTagConditionType: OR

利用タグはサービスが自動的に付与します。管理画面・一括操作・APIで利用者に付け外ししたり、タグ自体を削除したりしないでください。 配信対象の絞り込み専用のため、タグ付与をきっかけにするステップ配信やリッチメニューの切り替え条件には使用しないでください。

Authorizations:
ApiKeyAuth
path Parameters
miniappId
required
string
Example: 01HQZX1234567890ABCDEFGHIJ

ジャンル情報を取得する対象のミニアプリID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "usageTagId": "01HQZUSER1234567890ABCDEFGH",
  • "genreGroups": [
    ]
}

LINEユーザーにタグを付与

LINEユーザーにタグを付与します。

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
lineUserId
string

タグを削除するLINEユーザーのID。

※lineUserIdまたはlineUserIdsのいずれか必須

lineUserIds
Array of strings [ 1 .. 100 ] items

タグを付与するLINEユーザーのIDのリスト。最大100件まで指定可能。

tagIds
required
Array of strings [ 1 .. 100 ] items

LINEユーザーに付与するタグIDのリスト。最大100件まで指定可能。

Responses

Request samples

Content type
application/json
{
  • "lineUserId": "U1234567890abcdef1234567890abcdef",
  • "tagIds": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

LINEユーザーからタグを削除

LINEユーザーに付与されているタグを削除します。

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
lineUserId
string

タグを削除するLINEユーザーのID。

※lineUserIdまたはlineUserIdsのいずれか必須

lineUserIds
Array of strings [ 1 .. 100 ] items

タグを削除するLINEユーザーのIDのリスト。最大100件まで指定可能。

tagIds
required
Array of strings [ 1 .. 100 ] items

LINEユーザーから削除するタグIDのリスト。最大100件まで指定可能。

Responses

Request samples

Content type
application/json
{
  • "lineUserId": "U1234567890abcdef1234567890abcdef",
  • "tagIds": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}