単語記事: ニコ生アラート(本家)の仕様

編集

はじめに

このページはニコ生アラート(本家)が行っている処理の2009/8/27現在における仕様についてまとめたものです。

このページの目的はユーザーが開発するニコニコ生放送の番組通知ソフトウェア/Webサービスにニコ生アラート(本家)と同様の処理を組み込んで頂き、ニコニコ生放送の負荷低減を目指すことです。

このページの内容及び公開しているAPIの仕様は予告なく変更される可能性があります。また仕様変更時にこのページの内容は修正されない可能性があります。

ツールおよびサービスでこれらのAPIにアクセスする時、そのツール名/サービス名とバージョン情報が含まれているユーザーエージェントでアクセスすることを推奨します。

ログインAPIその1

  • URL
    https://secure.nicovideo.jp/secure/login?site=nicolive_antenna
  • ・パラメータ(POSTのみ)
    mail=[メールアドレス:example@example.com]
    password=[パスワード:example]
  • レスポンス
    <?xml version="1.0" encoding="utf-8" ?>
    <nicovideo_user_response status="ok">
    <ticket>[認証用チケット:1234512345678901234567890]</ticket>
    </nicovideo_user_response>

認証APIその2

  • URL
    http://live.nicovideo.jp/api/getalertstatus
  • パラメータ
    ticket=[認証APIその1]で取得した認証用チケット
  • レスポンス
    <getalertstatus status="ok" time="[アクセスタイム]">
    <user_id>[ユーザーID:0000]</user_id>
    <user_hash>[認証用ハッシュ:XXXXXXXXXXXXXXXXXXXXXXXXXXX]</user_hash>
    <user_name>[ユーザー名]</user_name>
    <user_prefecture>[都道府県名:xx]]</user_prefecture>
    <user_age>[年齢]</user_age>
    <user_sex>[性別]</user_sex>
    <is_premium>[一般かプレミアムか:0 or 1]</is_premium>
    <communities>
    <community_id>[加入コミュニティID:coXXXX]</community_id>
    <community_id>[加入チャンネルID:chXXXX]</community_id>
    </communities>
    <ms>
    <addr>[コメントサーバーのアドレス]</addr>
    <port>[コメントサーバーのポート]</port>
    <thread>[スレッドID]</thread>
    </ms>
    </getalertstatus>

ユーザー認証を行わないAPI

  • URL
    http://live.nicovideo.jp/api/getalertinfo
  • レスポンス
    <getalertstatus status="ok" time="[アクセスタイム]">
    <user_id>[ユーザーID]</user_id>
    <user_hash>[認証用ハッシュ]</user_hash>
    <ms>
    <addr>[コメントサーバーのアドレス]</addr>
    <port>[コメントサーバーのポート]</port>
    <thread>[スレッドID]</thread>
    </ms>
    </getalertstatus>

コメントサーバー

認証APIで取得したコメントサーバーのアドレスとポートにXMLSocketで接続を行います。接続しただけではデータを受信することはできません。以下のデータを送信することで対象スレッドを取得して継続的にPUSHされる状態となります。
<thread thread="[スレッドID]" version="20061206" res_from="-1"/>

  • PUSHされるデータのサンプル
    • スレッド情報取得リクエストへのレスポンス
      このレスポンスは番組通知とは関係がないので無視してかまいません。
      <thread last_res="XXXX" resultcode="0" thread="[スレッドID]" ticket="XXXXXXXXX"/>
    • 番組通知が1分間行われなかったときに発行されるダミーデータ
      chatタグのテキスト部分に現在のUnixタイムが格納されています。このレスポンスは番組通知とは関係がないので無視してかまいません。
    • 番組通知時にPUSHされるデータ
      chatタグのテキスト部分に[放送ID],[チャンネル&コミュニティID],[放送主のユーザーID]がカンマ区切りで格納されています。公式生の場合はチャンネルIDのところが "official" という文字列(ダブルクオーテーションは含まれない)になります。
      chatタグの各種属性はコメントサーバー側で使用する値なので無視してかまいません。
      <chat date="1234567890" no="XXXX" thread="[スレッドID]" vpos="XXXX">[放送ID],[チャンネル&コミュニティID],[放送主のユーザーID]</chat>

番組情報取得API

  • URL
  • http://live.nicovideo.jp/api/getstreaminfo/lv[放送ID]
  • レスポンス
    <getstreaminfo status="ok">
    <request_id>[放送ID]</request_id>
    <streaminfo>
    <title>[番組タイトル]</title>
    <description>[番組説明文]</description>
    <provider_type>[コミュニティなら"community"、チャンネルなら"channel"]</provider_type>
    <default_community>[チャンネル&コミュニティID]</default_community>
    </streaminfo>
    <communityinfo>
    <name>[チャンネル&コミュニティの名前]</name>
    <thumbnail>[チャンネル&コミュニティのサムネイルURL]</thumbnail>
    </communityinfo>
    </getstreaminfo>

関連項目

  • ニコニコ生放送
  • ユーザー生放送
  • API
  • ニコニコ動画API

【スポンサーリンク】

携帯版URL:
http://dic.nicomoba.jp/k/a/%E3%83%8B%E3%82%B3%E7%94%9F%E3%82%A2%E3%83%A9%E3%83%BC%E3%83%88%28%E6%9C%AC%E5%AE%B6%29%E3%81%AE%E4%BB%95%E6%A7%98
ページ番号: 4147874 リビジョン番号: 859315
読み:ニコナマアラートホンケノシヨウ
初版作成日: 09/08/27 10:56 ◆ 最終更新日: 10/08/11 16:31
編集内容についての説明/コメント: 取得できるレスポンスの追記
記事編集 / 編集履歴を閲覧

この記事の掲示板に最近描かれたお絵カキコ

お絵カキコがありません

この記事の掲示板に最近投稿されたピコカキコ

ピコカキコがありません

ニコ生アラート(本家)の仕様について語るスレ

102 : ななしのよっしん :2010/12/19(日) 02:53:08 ID: 437Usfb0hW
こんな記事あったのか…乙
103 : ななしのよっしん :2011/02/02(水) 17:00:19 ID: aL4LCP+u7M
ログウィンドウが毎回リセットされてしまうのは不便。
前回使用した場所や大きさを、記憶できるようにしてもらえないだろうか。
104 : ななしのよっしん :2011/06/14(火) 20:34:34 ID: RhuVCVNiHP
最近アラートが仕事をしてくれない・・・
105 : ななしのよっしん :2011/06/16(木) 15:01:34 ID: kydevcoZ5F
開くブラウザ位選べるようにしてくれ・・・
106 : acv1234SP :2011/09/08(木) 21:35:49 ID: RBkFum2LGg
このニコ生アラート(本家)使えるSE(BGM)はmp3しかないのでgガンの明鏡止水使ってるw
107 : ななしのよっしん :2011/09/28(水) 11:53:21 ID: olAKxZmnMT
この記事
技術者向けの内部的な仕様はわかるんですが、
「登録していない公式放送も受信する」「クリックすると落ちる」「メモリ○○MB食う」
のようにインターフェースの仕様も書くべきだと思います。
そうでなければ記事名を変更すべきです。
108 : ななしのよっしん :2012/07/12(木) 16:14:34 ID: /u4aukuG3r
zeroになって仕様変わったのか…
109 : ななしのよっしん :2012/08/26(日) 15:59:44 ID: 0c3CiN+Exv
公式放送の通知はくるけどお気に入りに登録してもアニメ上映会の通知は来ない
110 : ななしのよっしん :2013/02/06(水) 00:31:40 ID: SLHjrn0xoy
賛同票1

>ログウィンドウが毎回リセットされてしまうのは不便。
前回使用した場所や大きさを、記憶できるようにしてもらえないだろうか。
111 : ななしのよっしん :2014/02/18(火) 08:27:18 ID: M8M1oZdyLV
>>107
公式放送は物によるしクリックすると落ちた事は僕個人ではないしメモリの消費量なんてそれこそ場合によるから…
  JASRAC許諾番号: 9011622001Y31015