マニュアル | kukuluLIVE

概要と注意事項

- 予告なく変更や廃止したり、制限を課す場合がありますのでご了承ください。

- 従来より内部で使用しているものも含まれるため、このドキュメントに記載のないレスポンスパラメータが返るものがありますが、維持が保証されないため使用は非推奨です。

- APIの使用方法やその成果物の利用に際してはノンサポートになります。（バグレポートや機能追加の要望は歓迎します）

- 限られたリソースで運営しているため、APIを練習や学習などのために使用することはできません。

- 素材キット（kukuluLIVEのロゴやアイコン）もご利用ください。

APIキーの取得方法

APIキーは下記から生成や再生成できます。

APIキー

kukuluLIVE Remote MCP Server

MCP URL

https://live.erinn.biz/api/mcp/

認証方法（下記のどちらでも認証できます）

Authorization: Bearer APIトークン

https://live.erinn.biz/api/mcp/?apikey=APIキー

live　配信中の配信一覧を取得

リクエストフォーマット

https://live.erinn.biz/api/?category=live
category: live
(認証なし)

レスポンスフォーマット

{
	"live": [
		{
			"hash": 配信番号,
			"_id": 配信者識別番号,
			"profile_page": "配信者のプロフィールページのURL",
			"broadcaster_language": "配信者言語",
			"broadcaster_locale": "配信者接続国",
			"created_at": "配信開始日時",
			"created_at_unix": 配信開始日時のUNIXタイム,
			"name": "配信者の名前@アカウントタイプ",
			"display_name": "配信者の名前表示",
			"game": "プレイ中のゲーム",
			"game_category": "プレイ中のゲームのカテゴリ",
			"games": [
			    "配信でプレイしたゲームの一覧", ...
			],
			"language": "配信のデフォルト言語",
			"logo": "配信者のサムネイル",
			"title": "配信のタイトル",
			"description": "配信の説明",
			"updated_at": "最後のプッシュ接続日時",
			"updated_at_unix": 最後のプッシュ接続日時のUNIXタイム,
			"url": "配信視聴URL",
			"video_banner": "配信映像のサムネイル画像URL(オリジナル)",
			"video_banner_small": "配信映像のサムネイル画像URL(100x100)",
			"video_banner_medium": "配信映像のサムネイル画像URL(300x200)",
			"viewers": 現在の視聴者数,
			"viewers_max": 瞬間最大視聴者数,
			"views": 累積訪問者数,
			"comments": コメント数,
			"partner_hash": 共同配信の場合の配信番号(ない場合は0),
			"nsfw": NSFW属性の有無(無効=0,有効=1)
		}, ...
	],
	"_total": 生配信中の配信の数,
	"success": 取得成功の場合は1,
	"error": エラーの場合はエラー番号
}

live.history　タイムシフトを含む配信一覧を取得

リクエストフォーマット

https://live.erinn.biz/api/?category=live&type=history&page={0-9999}&limit={1-100}
category: live
type: history
page: limitを指定しない場合100件単位で結果が返るため、1以上にすると次の結果をリクエストできます
limit: 求める結果の最大数を1-100で指定します
(認証なし)

レスポンスフォーマット

{
	"live": [
		{
			"hash": 配信番号,
			"_id": 配信者識別番号,
			"status": 配信状態 (配信終了=0, 公開配信中=2),
			"profile_page": "配信者のプロフィールページのURL",
			"broadcaster_language": "配信者言語",
			"broadcaster_locale": "配信者接続国",
			"created_at": "配信開始日時",
			"created_at_unix": 配信開始日時のUNIXタイム,
			"ended_at": "配信終了日時",
			"ended_at_unix": 配信終了日時のUNIXタイム,
			"duration_sec": 配信継続時間の秒数,
			"name": "配信者の名前@アカウントタイプ",
			"display_name": "配信者の名前表示",
			"game": "プレイ中のゲーム",
			"game_category": "プレイ中のゲームのカテゴリ",
			"games": [
			    "配信でプレイしたゲームの一覧", ...
			],
			"language": "配信のデフォルト言語",
			"logo": "配信者のサムネイル",
			"title": "配信のタイトル",
			"description": "配信の説明",
			"updated_at": "最後のプッシュ接続日時",
			"updated_at_unix": 最後のプッシュ接続日時のUNIXタイム,
			"url": "配信視聴URL",
			"video_banner": "配信映像のサムネイル画像URL(オリジナル)",
			"video_banner_small": "配信映像のサムネイル画像URL(100x100)",
			"video_banner_medium": "配信映像のサムネイル画像URL(300x200)",
			"viewers": 現在の視聴者数,
			"viewers_max": 瞬間最大視聴者数,
			"views": 累積訪問者数,
			"comments": コメント数,
			"partner_hash": 共同配信の場合の配信番号(ない場合は0),
			"nsfw": NSFW属性の有無(無効=0,有効=1),
			"timeshift": タイムシフトの有無と公開種別(タイムシフトなし=0,タイムシフト公開中=1,タイムシフト非公開=3,配信者設定でタイムシフト使用禁止=4)
		}, ...
	],
	"_total": 配信の数,
	"success": 取得成功の場合は1,
	"error": エラーの場合はエラー番号
}

mylive.port_get　配信枠の取得

リクエストフォーマット

https://live.erinn.biz/api/?category=mylive&type=port_get&apikey={APIKEY}&eula=1
category: mylive
type: port_get
apikey: APIキー
eula: 1 (=すべてのルールに同意したとみなします)

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

mylive.port_info　自分の配信の配信枠情報を取得

リクエストフォーマット

https://live.erinn.biz/api/?category=mylive&type=port_info&apikey={APIKEY}
category: mylive
type: port_info
apikey: APIキー

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
	"mylive": 配信中の配信枠取得状態(あり=1、なし=0),
	"status": 配信状態(準備中=1, 公開配信中=2、非公開配信中=3, 配信終了=0),
	"connect": プッシュ接続状態(未接続=0, プッシュ接続中=1),
	"hash": 配信番号,
	"livepriv": 配信枠タイプ(録画あり配信枠=10, 録画なし配信枠=11),
	"serveraddr": "RTMP接続先",
	"streamname": "RTMPストリームキー",
	"socketaddr": "チャットサーバアドレス",
	"socketport": チャットサーバポート番号,
	"wssaddr": "チャットサーバ(wss://)アドレス",
	"wssport": チャットサーバ(wss://)ポート番号,
	"livetitle": "配信のタイトル",
	"livecomment": "配信の説明",
	"liveuser_image": "配信者サムネイル",
	"getport_from_pc": 配信枠取得元端末の種別(パソコンまたはAPI=1, スマホアプリ=0),
	"liveowner_key": "配信者認証キー(チャットサーバで使用)"
}

mylive.port_modify　自分の配信の設定を変更

リクエストフォーマット

https://live.erinn.biz/api/?category=mylive&type=port_modify&apikey={APIKEY}&title={TITLE}&description={DESCRIPTION}&hash={LIVEID}
category: mylive
type: port_modify
apikey: APIキー
title: 配信のタイトル
description: 配信の説明
hash: 配信番号(hash)を指定した場合はその配信記録に対して操作する、指定しなかった場合は配信中のものに対して操作する

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

mylive.port_status　自分の配信の配信状態の変更や配信枠の返上

リクエストフォーマット

https://live.erinn.biz/api/?category=mylive&type=port_status&apikey={APIKEY}&status={0|1|2}
category: mylive
type: port_status
apikey: APIキー
status: 0 (=配信枠の返上), 1 (=公開配信の開始), 2 (=非公開配信の開始)

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

mylive.nsfw_add/.nsfw_remove　自分の配信のNSFW属性を変更

リクエストフォーマット

https://live.erinn.biz/api/?category=mylive&type={nsfw_add|nsfw_remove}&apikey={APIKEY}&hash={LIVEID}
category: mylive
type: nsfw_add (=NSFWを付与), nsfw_remove (=NSFWを解除)
apikey: APIキー
hash: 配信番号(hash)を指定した場合はその配信記録に対して操作する、指定しなかった場合は配信中のものに対して操作する

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

mylive.list　自分の配信の記録を一覧で取得

リクエストフォーマット

https://live.erinn.biz/api/?category=mylive&type=list&apikey={APIKEY}&hash={LIVEID}&limit={1-9999}
category: mylive
type: list
apikey: APIキー
hash: 配信番号(hash)を指定した場合はその配信記録のみを返す
limit: 最新の配信からlimit件数のみ返す

レスポンスフォーマット

{
	"live": [
		{
			"hash": 配信番号,
			"_id": 配信者識別番号,
			"profile_page": "配信者のプロフィールページのURL",
			"broadcaster_language": "配信者言語",
			"broadcaster_locale": "配信者接続国",
			"created_at": "配信開始日時",
			"created_at_unix": 配信開始日時のUNIXタイム,
            "ended_at": "配信終了日時",
            "ended_at_unix": 配信終了日時のUNIXタイム,
            "duration_sec": 配信継続時間の秒数,
			"name": "配信者の名前@アカウントタイプ",
			"display_name": "配信者の名前表示",
			"game": "プレイ中のゲーム",
			"game_category": "プレイ中のゲームのカテゴリ",
			"games": [
			    "配信でプレイしたゲームの一覧", ...
			],
			"language": "配信のデフォルト言語",
			"logo": "配信者のサムネイル",
			"title": "配信のタイトル",
			"description": "配信の説明",
			"updated_at": "最後のプッシュ接続日時",
			"updated_at_unix": 最後のプッシュ接続日時のUNIXタイム,
			"url": "配信視聴URL",
			"video_banner": "配信映像のサムネイル画像URL(オリジナル)",
			"video_banner_small": "配信映像のサムネイル画像URL(100x100)",
			"video_banner_medium": "配信映像のサムネイル画像URL(300x200)",
			"viewers": 現在の視聴者数,
			"viewers_max": 瞬間最大視聴者数,
			"views": 累積訪問者数,
			"comments": コメント数,
			"partner_hash": 共同配信の場合の配信番号(ない場合は0),
			"nsfw": NSFW属性の有無(無効=0,有効=1),
			"private": 公開種別(非公開=1,公開=0),
			"timeshift": タイムシフトの有無と公開種別(タイムシフトなし=0,タイムシフト公開中=1,タイムシフト非公開=3,配信者設定でタイムシフト使用禁止=4),
			"gift": {
				"price": 配信で受け取ったMagicalGiftの総額,
				"senders": [
					{
						"name": "ギフトを送ってくれた人の名前",
						"price": "ギフト金額",
						"send_at": "送信日時",
						"send_at_unix": "送信日時のUINXタイム",
						"price_user_total": "この人の累積ギフト金額",
						"price_total": "自分の受け取りギフト総額"
					}
				]
			}
		}, ...
	],
	"_total": 配信の数,
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

mylive.history_delete　自分の配信記録を削除する

リクエストフォーマット

https://live.erinn.biz/api/?category=mylive&type=history_delete&apikey={APIKEY}&hash={LIVEID}&reason={MESSAGE}
category: mylive
type: history_delete
apikey: APIキー
hash: 削除したい配信の配信番号(hash)
reason: 削除理由を公開したい場合はメッセージを記入(任意)

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

mylive.history_set_private/.history_set_open　自分の配信記録を公開/非公開状態にする

リクエストフォーマット

https://live.erinn.biz/api/?category=mylive&type={history_set_private|history_set_open}&apikey={APIKEY}&hash={LIVEID}
category: mylive
type: history_set_private (=配信記録を非公開にする), history_set_open (=配信記録を公開にする)
apikey: APIキー
hash: 操作したい配信の配信番号(hash)

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

mylive.timeshift_set_private/.timeshift_set_open　自分の配信のタイムシフトを公開/非公開状態にする

リクエストフォーマット

https://live.erinn.biz/api/?category=mylive&type={timeshift_set_private|timeshift_set_open}&apikey={APIKEY}&hash={LIVEID}
category: mylive
type: timeshift_set_private (=配信タイムシフトを非公開にする), timeshift_set_open (=配信タイムシフトを公開にする)
apikey: APIキー
hash: 操作したい配信の配信番号(hash)

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

comment.list　自分の配信のコメントを取得

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type=list&apikey={APIKEY}&hash={LIVE_NUMBER}&cnum={COMMENT_ID}
category: comment
type: list
apikey: APIキー
hash: 自身の配信番号 (未指定の場合は有効な配信を自動取得)
cnum: 最新コメントのみを取得する場合は既に取得した最後のコメントID(任意)

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
	"comments": [
		{
			"type": "データ種別(comment=通常コメント,visualchat=お絵描きコメント,sscomment=画像または動画コメント,voicecomment=ボイスコメント,speech=字幕)",
			"cnum": コメントID,
			"from": "投稿種別またはマーカー(空白=一般, master=配信者, partner=共同配信者, #XXXXXX=マーカー色, admin=管理者告知)",
			"date": "投稿時間(HH:MM)",
			"message": "コメント本文",
			"message_additional": {
			      "visualchat_url": "お絵描きコメントの画像URL(お絵描きコメントの場合のみ)", 
			      "sscomment_url": "画像または動画コメントのURL(画像または動画コメントの場合のみ)", 
			      "voicecomment_url": "ボイスコメントの再生URL(ボイスコメントの場合のみ)", 
			},
			"ipid": "配信ごとの視聴者ユニークID",
			"url": "リンク先URL",
			"icon_num": "コテハン番号",
			"icon_name": "コテハンの名前@アカウント種別",
			"time": 投稿時間のUNIXタイム,
			"number": コメント番号,
			"link_number": "レス先のコメント番号",
			"flag_first": 配信ごとの初コメフラグ(1=初コメ, それ以外=初コメではない),
			"language": "日本語以外の場合のみコメントの言語(EN等)",
			"emotions": [
			    "エモーションキー(持ち込みエモーションの場合のみ)": {
			        "url": "エモーションの画像URL",
			        "message": "エモーションの感情表現"
			    }, ...
			]
		}, ...
	],
	"_total": コメント数
}

comment.emotions　自分の配信で使用できるエモーション一覧を取得

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type=emotions&apikey={APIKEY}&hash={LIVE_NUMBER}
category: comment
type: emotions
apikey: APIキー
hash: 自身の配信番号 (未指定の場合は有効な配信を自動取得)

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
	"openemo": エモーション持ち込みの許可状況(0=許可しない, 1=許可する),
	"emotions": [
		"エモーションキー": {
			"url": "エモーションの画像URL(拡張子pngでもgifの場合がありますのでバイナリの冒頭またはvパラメタで判断してください)",
			"message": "エモーションの感情表現"
		}, ...
	],
	"_total": エモーション登録数
}

comment.write　自分の配信にコメントを投稿する

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type=write&apikey={APIKEY}&hash={LIVE_NUMBER}&comment={COMMENT_TEXT}&icon={0|1}
category: comment
type: write
apikey: APIキー
hash: 自身の配信番号 (未指定の場合は有効な配信を自動取得)
comment: コメント本文
anon: 匿名コメントにするか否か(0=配信主コメント, 1=匿名コメント)
icon: 名前表示コメントにするか否か(0=しない, 1=する)

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

comment.delete/.delete_restore　自分の配信のコメントを削除する/削除を元に戻す

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type={delete|delete_restore}&apikey={APIKEY}&hash={LIVE_NUMBER}&comment_number={COMMENT_NUMBER}
category: comment
type: delete (=コメント削除), delete_restore (=削除を元に戻す)
apikey: APIキー
hash: 自身の配信番号 (未指定の場合は有効な配信を自動取得)
comment_number: コメント番号(複数の場合は,で区切る)

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)",
	"success_comment_number": "処理に成功したコメント番号(複数の場合は,で区切る)"
}

comment.block_list　コメントブロックの一覧

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type=block_list&apikey={APIKEY}
category: comment
type: block_list
apikey: APIキー

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)",
	"block": [
		{
			"id": "ブロックID",
			"name": "ブロック名",
			"period": "ブロックの有効期限(永久の場合は0)",
			"time": "ブロックした日時(UNIXTime)",
			"hash": "ブロックした配信の番号"
		}, ...
	]
}

comment.block/.block_change/.block_remove　コメントブロックする/コメントブロックを変更する/コメントブロックを解除する

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type={block|block_change|block_remove}&apikey={APIKEY}&hash={LIVE_NUMBER}&comment_number={COMMENT_NUMBER}&block_id={BLOCK_ID}&block_period={10-31536000}&block_name={BLOCK_NAME}
category: comment
type: block (=コメントブロックする), block_change (=ブロック期限やブロック名を変更する), block_remove (=コメントブロックを解除する)
apikey: APIキー
hash: 配信番号 (comment_number で block する場合、過去の配信も指定できます)
comment_number: コメント番号(複数の場合は,で区切る) *
block_id: ブロックID(複数の場合は,で区切る) *
* comment_number または block_id のどちらか一方が必須
block_period: 期限つきのブロックの場合は秒数で指定
block_name: コメントブロックに管理用の名称を付ける

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)",
	"success_block_id": [
		"処理に成功したブロックIDのリスト", ... 
	],
	"success_comment_number": [
		"処理に成功したコメント番号のリスト", ... 
	]
}

comment.block_remove_tail/block_remove_all　最新からの順で指定した数だけコメントブロックを解除する/コメントブロックをすべて解除する

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type={block_remove_tail|block_remove_all}&apikey={APIKEY}&count={0-99999}
category: comment
type: block_remove_tail (=最新からcount件のコメントブロックを解除), block_remove_all (=コメントブロックを全て解除する)
apikey: APIキー
count: 最新からcount件のコメントブロックを解除

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)",
	"count": block_remove_tailの場合は処理した件数,
}

comment.marker_list　コメントマーカーの一覧

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type=marker_list&apikey={APIKEY}
category: comment
type: marker_list
apikey: APIキー

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)",
	"marker": [
		{
			"id": "マーカーID",
			"name": "マーカー名",
			"time": "マーカーを付与した日時(UNIXTime)",
			"color": "マーカーの色(#FFFFFF形式)"
		}, ...
	]
}

comment.marker/marker_change/marker_remove　コメントマーカーを付与する/コメントマーカーを変更する/コメントマーカーを解除する

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type={marker|marker_change|marker_remove}&apikey={APIKEY}&hash={LIVE_NUMBER}&comment_number={COMMENT_NUMBER}&marker_id={BLOCK_ID}&marker_color=#000000&marker_name={MARKER_NAME}
category: comment
type: marker (=コメントマーカーを付与する), marker_change (=マーカー色やマーカー名を変更する), marker_remove (=コメントマーカーを解除する)
apikey: APIキー
hash: 配信番号 (comment_number で marker する場合、過去の配信も指定できます)
comment_number: コメント番号(複数の場合は,で区切る) *
marker_id: マーカーID(複数の場合は,で区切る) *
* comment_number または marker_id のどちらか一方が必須
marker_color: #FFFFFF形式でマーカー色を指定
marker_name: マーカーブロックに名称を付ける

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)",
	"success_marker_id": [
		"処理に成功したマーカーIDのリスト", ... 
	],
	"success_comment_number": [
		"処理に成功したコメント番号のリスト", ... 
	]
}

comment.marker_remove_tail/marker_remove_all　最新からの順で指定した数だけコメントマーカーを解除する/コメントマーカーをすべて解除する

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type={marker_remove_tail|marker_remove_all}&apikey={APIKEY}&count={0-99999}
category: comment
type: marker_remove_tail (=最新からcount件のコメントマーカーを解除), marker_remove_all (=コメントマーカーを全て解除する)
apikey: APIキー
count: 最新からcount件のコメントマーカーを解除

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)",
	"count": marker_remove_tailの場合は処理した件数,
}

comment.lottery　視聴者機能の抽選を開始する

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type=lottery&apikey={APIKEY}&title={TITLE}&comment={COMMENT}&number={1-100}&open={0|1}&timelimit={30-600}&marker={0|1}
category: comment
type: lottery
apikey: APIキー
title: 抽選のタイトル
comment: 抽選の説明
number: 当選者数
open: 公開抽選=1, 非公開抽選=0 timelimit: 締め切り時間(秒数)
marker: 当選者にマーカーをつける=1, つけない=0

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

comment.vote　視聴者機能の投票を開始する

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type=vote&apikey={APIKEY}&title={TITLE}&reason_mode={0|1}&option={A,B,C,...}&timelimit={30-600}
category: comment
type: vote
apikey: APIキー
title: 投票のタイトル
reason_mode: 0 (=投票理由記入欄を使用しない), 1 (=投票理由記入欄を使用する)
option: 投票選択肢を,で区切って6件まで設定
timelimit: 締め切り時間(秒数)

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

comment.scoring　視聴者機能の採点を開始する

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type=scoring&apikey={APIKEY}&title={TITLE}&reason_mode={0|1}&method={100|10|50|5|90}&timelimit={30-600}
category: comment
type: scoring
apikey: APIキー
title: 採点のタイトル
reason_mode: 0 (=採点理由記入欄を使用しない), 1 (=採点理由記入欄を使用する)
method: 満点方式(100の場合は100点満点)
timelimit: 締め切り時間(秒数)

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

comment.scissorsgame　視聴者機能のジャンボじゃんけんを開始する

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type=scissorsgame&apikey={APIKEY}&title={TITLE}&number={1-100}
category: comment
type: scissorsgame
apikey: APIキー
title: じゃんけんのタイトル
number: 勝ち残りがこの人数になったら終了する

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

comment.pockygame　視聴者機能のポッキーゲームを開始する

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type=pockygame&apikey={APIKEY}
category: comment
type: pockygame
apikey: APIキー

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

comment.roulette　視聴者機能のルーレットを開始する

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type=roulette&apikey={APIKEY}&option={OPTIONS}
category: comment
type: roulette
apikey: APIキー
option: ルーレットのセグメントを改行(\\n)で区切って記入

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

comment.cancel_viewer_function　実行中の視聴者機能をキャンセルする

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type=cancel_viewer_function&apikey={APIKEY}
category: comment
type: cancel_viewer_function
apikey: APIキー

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

comment.ngword_list　コメントNGワードリストを取得

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type=ngword_list&apikey={APIKEY}
category: comment
type: ngword_list
apikey: APIキー

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)",
	"ngword": ["NGワード", ... ]
}

comment.ngword_replace　コメントNGワードリストを置き換える

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type=ngword_replace&apikey={APIKEY}&ngword={NGWORD_LIST}
category: comment
type: ngword_replace
apikey: APIキー
ngword: 新しく設定するNGワードリストを改行(\\n)で区切って記入

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

comment.ngword_removeall　コメントNGワードリストを初期化

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type=ngword_removeall&apikey={APIKEY}
category: comment
type: ngword_removeall
apikey: APIキー

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

comment.ngword_add/.ngword_remove　コメントNGワードを追加/削除

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type={ngword_add|ngword_remove}&apikey={APIKEY}&ngword={NGWORD}
category: comment
type: ngword_add (=NGワードを追加), ngword_remove (=NGワードを削除)
apikey: APIキー
ngword: NGワード(単体)

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)",
	"ngword": ["NGワード", ... ]
}

comment.speech　自分の配信に字幕を追加する

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type=speech&apikey={APIKEY}&hash={LIVE_NUMBER}&text={CC_TEXT}
category: comment
type: speech
apikey: APIキー
hash: 自身の配信番号 (未指定の場合は有効な配信を自動取得)
text: 字幕テキスト

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

comment.mypoint_list　配信者オリジナルポイントの保有量を取得する

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type=mypoint_list&apikey={APIKEY}&hash={LIVE_NUMBER}&cnum={COMMENT_CNUM}&pid={POINT_ID}
category: comment
type: mypoint_list
apikey: APIキー
hash&cnum / pid: 配信番号&コメントID またはポイントID (特定の1ユーザーの保有量を取得する場合)

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)",
	"users": [
		{
			"pid": "ポイントID",
			"time": 最終更新時間のUNIXタイム,
			"point": 保有ポイント数
		}, ... 
	]
}

comment.mypoint_change　配信者オリジナルポイントの保有量を変更する

リクエストフォーマット

https://live.erinn.biz/api/?category=comment&type=mypoint_change&apikey={APIKEY}&hash={LIVE_NUMBER}&cnum={COMMENT_CNUM}&pid={POINT_ID}&point={POINT}
category: comment
type: mypoint_change
apikey: APIキー
hash&cnum / pid: 配信番号&コメントID またはポイントID (特定の1ユーザーの保有量を取得する場合)
point: 変更するポイント保有量

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

myemotion.list　自分もしくは取得済みのエモーションの一覧

リクエストフォーマット

https://live.erinn.biz/api/?category=myemotion&type=list&apikey={APIKEY}&eid={EMOTION_ID}
category: myemotion
type: list
apikey: APIキー
eid: エモーションID(指定がない場合はすべてのエモーションを取得)

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)",
	"emotion": [
		{
            "eid": "エモーションID",
            "key": "エモーションのキー",
            "text": "エモーションの説明文",
            "fav": お気に入り設定 (設定済み=1, 未設定=0),
            "status": エモーションの状態 (非公開=0, 公開=1, 限定公開=10, くくぽで販売中=2, 配信者ポイントで販売中=3),
            "tags": "画像解析から自動で付られたタグ",
            "url": "エモーション画像のURL(拡張子と画像フォーマットが異なることがあるので注意)",
            "giftonly": MagicalGiftプレミアムエモーションの有無 (はい=1,いいえ=0),
            "price": 販売中の場合は価格,
            "cnt_sell": 取得された数,
            "owner": {
            	"number": 制作者のアカウント番号,
            	"name": "製作者の名前"
            }
    	}, ... 
	],
	"_total": emotionの結果の数
}

myemotion.change/.remove　自分もしくは取得済みのエモーションを変更/削除する

リクエストフォーマット

https://live.erinn.biz/api/?category=myemotion&type={change|remove}&apikey={APIKEY}&eid={EMOTION_ID}&key={EMOTION_KEY}&text={EMOTION_TEXT}&sort={up-last|up-once|down-last|down-once}&fav={0|1}
category: myemotion
type: change (=エモーションの設定を変更), remove (=エモーションを削除)
apikey: APIキー
eid: エモーションID
key: エモーション呼び出しキー(変更する場合)
text: エモーションの説明文(変更する場合)
sort: エモーションの並び順を変更する場合 (一番先頭に=up-last,ひとつ前に=up-once,一番後ろに=down-last,ひとつ後ろに=down-once)
fav: お気に入りエモーション=1, お気に入りエモーションの解除=0 (変更する場合)

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

myemotion.set_private/.set_open　自分のエモーションを公開/販売/非公開にする

リクエストフォーマット

https://live.erinn.biz/api/?category=myemotion&type={set_private|set_open}&apikey={APIKEY}&eid={EMOTION_ID}&status={1|2|3|10}price={1-1000000}
category: myemotion
type: set_private (=非公開にする), set_open (=公開または販売にする)
apikey: APIキー
eid: エモーションID
status: 公開 (=1), 限定公開 (=10), くくぽで販売 (=2), 配信者ポイントで販売 (=3)
price: ポイントで販売する場合の価格

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

myemotion.add　自分のエモーションとして画像を登録する

リクエストフォーマット

https://live.erinn.biz/api/?category=myemotion&type=add&apikey={APIKEY}&eid={EMOTION_ID}&key={EMOTION_KEY}&text={EMOTION_TEXT}&image={IMAGE_BASE64}
category: myemotion
type: add
apikey: APIキー
eid: エモーションID
key: エモーション呼び出しキー
text: エモーションの説明文
image: エモーションの画像データ(BASE64エンコード) *
* 受け入れ可能な画像条件はマイエモーションのページを参照してください。
* POSTで画像バイナリをBASE64エンコードしたものを送信してください。

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)",
	"eid": 登録に成功したエモーションID
}

emotion.list　公開エモーションの一覧

リクエストフォーマット

https://live.erinn.biz/api/?category=emotion&type=list&apikey={APIKEY}&eid={EMOTION_ID}&page={0-999}&limit={1-100}
category: emotion
type: list
apikey: APIキー
eid: エモーションID(指定がない場合はすべてのエモーションを取得)
page: 新しい順に最大100件まで取得できるため、次の100件を取得したい場合はpageを1以上に増やします。
limit: 一度に取得する件数

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)",
	"emotion": [
		{
            "eid": "エモーションID",
            "key": "エモーションのキー",
            "text": "エモーションの説明文",
            "status": エモーションの状態 (非公開=0, 公開=1, 限定公開=10, くくぽで販売中=2, 配信者ポイントで販売中=3),
            "tags": "画像解析から自動で付られたタグ",
            "url": "エモーション画像のURL(拡張子と画像フォーマットが異なることがあるので注意)",
            "price": 販売中の場合は価格,
            "cnt_sell": 取得された数,
            "owner": {
            	"number": 制作者のアカウント番号,
            	"name": "製作者の名前"
            },
            "saved": 取得状態(取得済み=1,取得していない=0)
    	}, ... 
	],
	"_total": emotionの結果の数
}

emotion.get　公開エモーションをマイエモーションとして取得する

リクエストフォーマット

https://live.erinn.biz/api/?category=emotion&type=get&apikey={APIKEY}&eid={EMOTION_ID}&purchase={0|1}
category: emotion
type: get
apikey: APIキー
eid: エモーションID
purchase: 対象のエモーションがくくぽ/配信者ポイントで販売されている有料エモーションの場合、購入する (=1), 購入しない (=0)

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)"
}

account　自身のアカウント情報を取得

リクエストフォーマット

https://live.erinn.biz/api/?category=account&type=info&apikey={APIKEY}
category: account
type: info
apikey: APIキー

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)",
	"account": {
        "number": アカウント番号 (くくぽ口座番号),
        "id": "アカウントID",
        "name": "アカウントの名前",
        "url_profile": "プロフィールページのURL",
        "image": "プロフィール画像のURL",
        "point": "くくぽ残高",
        "apikey": "APIキー",
        "mail": "メールアドレス (登録済みの場合)",
        "twitter": {
            "uid": "Twitter UID (連携済みの場合)",
            "screen_name": "Twitter 表示名 (連携済みの場合)"
        }
	}
}

kp.log　自身のくくぽ明細を取得

リクエストフォーマット

https://live.erinn.biz/api/?category=kp&type=log&apikey={APIKEY}&page={0-999}&limit={1-100}
category: kp
type: log
apikey: APIキー
page: limitを指定しない場合100件単位で結果が返るため、1以上にすると次の結果をリクエストできます
limit: 求める結果の最大数を1-100で指定します

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)",
	"logs": [
		{
			"time": UNIXタイム,
			"message": "明細メッセージ"
		}, ...
	]
}

kp.send　自身のくくぽ口座から送くくぽする

リクエストフォーマット

https://live.erinn.biz/api/?category=kp&type=send&apikey={APIKEY}&amount={1000-9999999999}&message={MESSAGE}&to_number={ACCOUNT_NUMBER}&url_back={URL}
category: kp
type: send
apikey: APIキー
amount: 送るくくぽの数を1000以上で指定します。額面の10%がシステム手数料としてAPI実行時に引き落としされ、相手に届くのは90%になります。
message: 受け取り相手の明細などに表示するメッセージ
to_number: 送信先のくくぽ口座番号を指定した場合即座に送信を行います。指定しなかった場合、くくぽ受け取りURL(小切手)を作成し、送くくぽトランザクションを開始します。
url_back: 送くくぽトランザクションの場合、受け取り後に移動させるURL (任意)

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)",
	"transaction_url": "くくぽ受け取りURL (送くくぽトランザクションの場合)",
	"transaction_id": "送くくぽトランザクションのID (kp.transaction で取引を検証する)",
}

kp.recv　自身のくくぽ口座に入くくぽするための取引URLを作成する

リクエストフォーマット

https://live.erinn.biz/api/?category=kp&type=recv&apikey={APIKEY}&amount={1000-9999999999}&message={MESSAGE}&url_back={URL}
category: kp
type: recv
apikey: APIキー
amount: 受け取るくくぽの数を1000以上で指定します。額面の10%がシステム手数料として送信元のくくぽ口座から引き落としされ、自身に届くのは90%になります。
message: 入くくぽする相手の明細などに表示するメッセージ
url_back: 入くくぽ後に移動させるURL

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)",
	"transaction_url": "くくぽ送信URL",
	"transaction_id": "入くくぽトランザクションのID (kp.transaction で取引を検証する)"
}

kp.transaction　送くくぽ/入くくぽの取引トランザクションの状態を取得

リクエストフォーマット

https://live.erinn.biz/api/?category=kp&type=transaction&apikey={APIKEY}&transaction_id={TID}
category: kp
type: transaction
apikey: APIキー
transaction_id: 状態を取得したい送くくぽ/入くくぽのトランザクションのID

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)",
	"transaction_status": トランザクションの状態 (0=送くくぽ/入くくぽ待ち, 1=送くくぽ/入くくぽ完了),
	"transaction_time": 最後に状態が変化した時間のUNIXタイム,
	"transaction_amount": "手数料が控除された実際の送くくぽ/入くくぽ額"
}

auth.create　kukuluID認証トランザクションを作成する

リクエストフォーマット

https://live.erinn.biz/api/?category=auth&type=create&apikey={APIKEY}&url_back={URL}
category: auth
type: create
apikey: APIキー
url_back: 認証成功/失敗時に移動させるURL

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)",
	"transaction_url": "ユーザーに表示させるログイン要求URL",
	"transaction_id": "認証トランザクションのID (auth.transaction で認証を検証する)"
}

auth.transaction　kukuluID認証トランザクションを検証する

リクエストフォーマット

https://live.erinn.biz/api/?category=auth&type=transaction&apikey={APIKEY}&transaction_id={TID}
category: auth
type: transaction
apikey: APIキー
transaction_id: auth.create で作成したトランザクションID

レスポンスフォーマット

{
	"success": 成功した場合は1,
	"error": エラーの場合はエラー番号,
	"error_display": "エラーの詳細情報(ある場合)",
	"transaction_status": 認証の可否 (0=要求中,1=認証成功,-1=拒否または期限切れ),
	"transaction_time": トランザクションの状態が変化したUNIXタイム,
	"account": {
		"number": くくぽ口座番号,
		"mypoint_pid": "オリジナルポイント識別番号 (口座が存在している場合)",
		"name": "アカウント名",
		"url": "プロフィールURL"
	}
}

API　各種イベントの発生時にWebhookを叩く

「外部連携設定」から有効化できます。

kukuluLIVE API

目次