マニュアル | kukuluLIVE

概要と注意事項

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

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

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

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

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

認証方法

APIキーでの認証

APIキーは下記から生成や再生成できます。自身のサーバからAPIを使いたい場合はこちらをご利用ください。

APIキー

Cookieでの認証

APIキー(apikey)のパラメーターが指定されない場合は、Cookieでの認証を試みます。ソフトウェアに簡易的に組み込みたい場合などはこちらをご利用ください。

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

リクエストフォーマット

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": [
{
"hash": 4566456456543,
"_id": 9930,
"profile_page": "https://live.erinn.biz/userdata.php?uid://******/",
"broadcaster_language": "JP",
"broadcaster_locale": "JP",
"created_at": "2019-07-27 12:42:58",
"created_at_unix": 1564198978,
"name": "kukusama@Twitter",
"display_name": "kukusama",
"game": "",
"game_category": "",
"games": [

],
"language": "JP",
"logo": "https://live.erinn.biz/reguser/noimage.jpeg",
"title": "初配信です",
"description": "人生初心者ですがよろしくお願いします",
"updated_at": "2019-07-27 12:45:19",
"updated_at_unix": 1564199119,
"url": "https://live.erinn.biz/live.php?h0",
"video_banner": "https://live.erinn.biz/live.capture.view.php?hash=0",
"video_banner_small": "https://live.erinn.biz/1.jpg?hash=0",
"video_banner_medium": "https://live.erinn.biz/1.jpg?hash=0",
"viewers": 141,
"viewers_max": 216,
"views": 231,
"comments": 855,
"partner_hash": 0,
"nsfw": 0
},
{
"hash": 4566456456544,
"_id": 9931,
"profile_page": "https://live.erinn.biz/userdata.php?uid://******/",
"broadcaster_language": "JP",
"broadcaster_locale": "JP",
"created_at": "2019-07-27 12:38:30",
"created_at_unix": 1564198710,
"name": "くくさま",
"display_name": "くくさまりゆ",
"game": "マビノギ",
"game_category": "MMO",
"games": [
    "マビノギ", "ぷーさんのホームランダービー", "Minecraft"
],
"language": "JP",
"logo": "https://live.erinn.biz/reguser/noimage.jpeg",
"title": "ウィズエリートTA",
"description": "目指せ24時間切り",
"updated_at": "2019-07-27 12:39:27",
"updated_at_unix": 1564198767,
"url": "https://live.erinn.biz/live.php?h0",
"video_banner": "https://live.erinn.biz/live.capture.view.php?hash=0",
"video_banner_small": "https://live.erinn.biz/1.jpg?hash=0",
"video_banner_medium": "https://live.erinn.biz/1.jpg?hash=0",
"viewers": 542,
"viewers_max": 952,
"views": 3126,
"comments": 1252,
"partner_hash": 0,
"nsfw": 0
}
],
"_total": 2,
"success": 1,
"error": 0
}

API　配信枠の取得

リクエストフォーマット

https://live.erinn.biz/api/?category=mylive&type=port_get&apikey={APIKEY}&eula=1&withrec={0|1}
category: mylive
type: port_get
apikey: APIキー
eula: 1 (=すべてのルールに同意したとみなします)
withrec: 1 (=録画あり配信枠), 0 (=録画なし配信枠)

レスポンスフォーマット

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

レスポンサンプル

{
"success": 1,
"error": 0
}

API　自分の配信の配信枠情報を取得

リクエストフォーマット

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": チャットサーバポート番号,
"livetitle": "配信のタイトル",
"livecomment": "配信の説明",
"liveuser_image": "配信者サムネイル",
"getport_from_pc": 配信枠取得元端末の種別(パソコンまたはAPI=1, スマホアプリ=0),
"liveowner_key": "配信者認証キー(チャットサーバで使用)"
}

レスポンサンプル

{
"success": 1,
"mylive": 1,
"status": 1,
"connect": 0,
"hash": 98797645345222,
"livepriv": 10,
"serveraddr": "rtmp://pushlive-edge-000-00-000-00.erinn.biz:11935/live/",
"streamname": "h98797645345222_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"socketaddr": "livec2.kukulu.erinn.biz",
"socketport": 6862225,
"livetitle": "初配信です",
"livecomment": "人生初心者ですが優しくしてください",
"liveuser_image": "https://kukulu.erinn.biz/reguser/noimage.jpeg",
"getport_from_pc": 1,
"liveowner_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

API　自分の配信の設定を変更

リクエストフォーマット

https://live.erinn.biz/api/?category=mylive&type=port_modify&apikey={APIKEY}&title={TITLE}&description={DESCRIPTION}
category: mylive
type: port_modify
apikey: APIキー
title: 配信のタイトル
description: 配信の説明

レスポンスフォーマット

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

レスポンサンプル

{
"success": 1,
"error": 0
}

API　自分の配信の配信状態の変更や配信枠の返上

リクエストフォーマット

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": "エラーの詳細情報(ある場合)"
}

レスポンサンプル

{
"success": 1,
"error": 0
}

API　自分の配信のコメントを取得

リクエストフォーマット

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": コメント数
}

レスポンサンプル

{
"success": 1,
"error": 0,
"comments": [
{
"type": "comment",
"cnum": 59176067,
"from": "",
"date": "18:32",
"message": "1: やふーじゃぱん https://kuku.lu/s3/",
"message_additional": [
],
"ipid": "fc6be1",
"url": "https://kuku.lu/s3/",
"icon_num": "",
"icon_name": "",
"time": 1564219964,
"number": 1,
"link_number": "",
"flag_first": "",
"language": "",
"emotions": [
]
},
{
"type": "comment",
"cnum": 59176070,
"from": "",
"date": "18:32",
"message": "2: ほげほげ",
"message_additional": [
],
"ipid": "fc6be1",
"url": "",
"icon_num": "",
"icon_name": "",
"time": 1564219967,
"number": 2,
"link_number": "",
"flag_first": "",
"language": "",
"emotions": [
]
},
{
"type": "comment",
"cnum": 59176078,
"from": "master",
"date": "18:32",
"message": "3: てすとてすと",
"message_additional": {
},
"ipid": "",
"url": "",
"icon_num": 1,
"icon_name": "くくさまりゆ@Twitter",
"time": 1564219973,
"number": 3,
"link_number": "",
"flag_first": "",
"language": "",
"emotions": [
]
}
],
"_total": 3
}

API　自分のエモーション一覧を取得

リクエストフォーマット

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": エモーション登録数
}

レスポンサンプル

{
"success": 1,
"error": 0,
"openemo": 1,
"emotions": {
"otu": {
"url": "https://live.erinn.biz/live/emotion/44418/0d054.png?v=d41d8c-1550319114",
"message": "おつ"
},
"daisuki": {
"url": "https://live.erinn.biz/live/emotion/7347/f5313.png?v=d41d8c-1550196696-gif",
"message": "だいすき"
}
},
"_total": 2
}

API　自分の配信にコメントを投稿する

リクエストフォーマット

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": "エラーの詳細情報(ある場合)"
}

レスポンサンプル

{
"success": 1,
"error": 0
}

API　自分の配信に字幕を追加する

リクエストフォーマット

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

レスポンスフォーマット

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

レスポンサンプル

{
"success": 1,
"error": 0
}

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

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

kukuluLIVE API

目次