Chat Widget

概要

チャット画面用 HTML を取得する為の API です。

  • 1 ユーザにつき、1 チャットルームを作成し、特定ユーザーのみにメッセージ(ゲームからのお知らせ)を送る行為は禁止されています。
  • 1アプリケーションにつき生成できるチャンネルの最大エントリ数は 1,000,000 件 になります。
ゲームチャットの使い方に関しては、こちらのチュートリアルをご確認下さい。

ChatWidget オブジェクトフィールド

チャットの widget を表すオブジェクトです。

説明

名前空間

補足

content

本文

xs:string

http://ns.dena.jp/mbga/gameapi/v1

display

表示設定

xs:string

http://ns.dena.jp/mbga/gameapi/v1

ChatWidgetDisplay オブジェクト

style

スタイル指定

xs:string

http://ns.dena.jp/mbga/gameapi/v1

ChatWidgetStyle オブジェクト

callbackUrl

投稿完了のエンドポイント URL

xs:string

http://ns.dena.jp/mbga/gameapi/v1

ChatChannelOwner オブジェクト

userAgent

UserAgent 文字列

xs:string

http://ns.dena.jp/mbga/gameapi/v1

docomo, au, Softbank のフィーチャーフォンで Mobage がサポートしている端末の User-Agent のみ指定可能

published

生成日時

xs:date

http://ns.dena.jp/mbga/gameapi/v1

生成日時 (ISO8601, GMT表記)

ChatWidgetDisplay オブジェクトフィールド

チャットの widget に関する表示設定を表すオブジェクトです。

説明

名前空間

補足

title

ヘッダーに表示されるテキスト

xs:string

http://ns.dena.jp/mbga/gameapi/v1

空文字は不可

hasHeader

ヘッダーの表示フラグ

xs:boolean

http://ns.dena.jp/mbga/gameapi/v1

デフォルトは true

defaultMessage

メッセージ投稿フォームに表示されるデフォルト文言

xs:string

http://ns.dena.jp/mbga/gameapi/v1

maximumMessages

メッセージの表示件数

xs:int

http://ns.dena.jp/mbga/gameapi/v1

デフォルトは 10

marksAsRead

表示済みメッセージの既読処理フラグ

xs:boolean

http://ns.dena.jp/mbga/gameapi/v1

デフォルトは true

hasNextLink

もっと見るボタンの表示フラグ

xs:boolean

http://ns.dena.jp/mbga/gameapi/v1

デフォルトは true

ChatWidgetDisplay オブジェクトフィールド

チャットの widget に関する表示設定を表すオブジェクトです。

説明

名前空間

補足

theme

テーマ名

xs:string

http://ns.dena.jp/mbga/gameapi/v1

"light" , "dark" のいずれか

color

テキスト色

xs:string

http://ns.dena.jp/mbga/gameapi/v1

backgroundColor

背景色

xs:string

http://ns.dena.jp/mbga/gameapi/v1

  • theme を指定している場合は、color, backgroundColor は無視されます。
  • color, backgroundColor には "#aaaaaa", "#FFFFFF", "#111111" などの16進数による RGB 指定の形式のみ受け付けており、いわゆるCSSで扱えるその他の "red" や "#aaa" の形式は使用出来ません。

API リクエスト

HTTP メソッド

Proxy モデル

  • POST
    • チャット用 Widget の HTML を生成する

エンドポイント URL

  • Sandbox 環境
    http://sb.app.mbga.jp/social/api/restful/v2/chat/{appId}/channels/{channelId}/widgets
  • 本番環境
    http://app.mbga.jp/social/api/restful/v2/chat/{appId}/channels/{channelId}/widgets

    URI Template パラメータ

    appId
    appId パラメータは下記のいずれかの値を指定します。

    説明

    備考

    @app

    現在実行中のアプリケーション ID

    必須

    channelId

channelId パラメータは下記のいずれかの値を指定します。

説明

備考

{channelId}

チャンネル ID

任意

クエリパラメータ

下記のクエリパラメータを指定する事が出来ます。

format

レスポンス形式を指定する事が出来ます。

説明

備考

json

"application/json; charset=utf8"

任意、デフォルト値


API レスポンス

レスポンスコード

API のレスポンスコードは以下のいずれかになります。

リクエスト HTTP メソッド

レスポンスコード

レスポンスメッセージ

説明

POST

201

Created

Widget の生成が成功した場合

POST

400

Bad Request

データ形式が不正な場合

POST

401

Unauthorized

不正な Authorization ヘッダの場合

POST

403

Forbidden

実行しようと操作の権限がない場合

POST

404

Not Found

存在しない appId, channelId, id が指定された場合

POST

500

Internal Server Error

サーバー側の処理でエラーが発生した場合

POST

503

Service Unavailable

サーバー側が一時的にサービス停止している場合

サンプル

チャット用 Widget の HTML を生成する

リクエスト形式

POST /social/api/restful/v2/chat/@app/channels/110/widgets
Content-Type: application/json; charset=utf-8
 
{
   "display" : {
      "title" : "非空挺団だクポー",
      "hasHeader" : true,
      "defaultMessage" : "クピポー",
      "maximumMessages" : 10,
      "marksAsRead" : true,
      "hasNextLink" : true
   },
   "style" : {
      "theme" : "dark"
   },
   "callbackUrl" : "http://example.com/finish_send_message_cb",
   "userAgent" : "DoCoMo/2.0 P906i(c100;TB;W24H15)"
}

レスポンス形式

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8

{
   "content" : "<div class=\"mobage-chat\">\n<!-- Chat widget html -->\n</div>\n",
   "display" : {
      "title" : "非空挺団だクポー",
      "hasHeader" : true,
      "defaultMessage" : "クピポー",
      "maximumMessages" : 10,
      "marksAsRead" : true,
      "hasNextLink" : true
   },
   "callbackUrl" : "http://example.com/finish_send_message_cb",
   "userAgent" : "DoCoMo/2.0 P906i(c100;TB;W24H15)",
   "published" : "2013-04-09T08:18:57",
   "style" : {
      "theme" : "dark",
      "color" : "inherit",
      "backgroundColor" : "inherit"
   }
}

参考資料

The OAuth 1.0 Protocol (RFC 5849)
URI Template (RFC6570)
5.6. Internet Date/Time Format - Date and Time on the Internet: Timestamps (RFC 3339)
7.3.1. date-time - JSON Schema: interactive and non interactive validation draft-fge-json-schema-validation-00

更新履歴

  • 2013/10/01
    • OAuth Signed Request (xoauth_requestor_id) に関する記述を削除しました。
  • 2013/06/20
    • データ型の誤植修正
  • 2013/05/17
    • color, backgroundColor の指定方法を補足
    • title に空文字は指定できない旨追記
  • 2013/04/25
    • 新規作成

PREVIOUS

Chat Message

NEXT

User Chat Channel