共通仕様

API Endpoint

https://api.bocco.me/alpha

文字コード

UTF-8

レスポンスの Content-Type

application/json

レスポンス中の user_type

メッセージを送信したユーザの種別を判断する際等に利用します。

説明
human アプリユーザ
bocco BOCCO 本体
sensor_door 振動センサ
sensor_lock 鍵センサ

レスポンス中の message_type

メッセージの種別を判断する際に利用します。

説明
normal センサ通知等ではない通常のメッセージ
system.human_joined 部屋に新しいユーザが参加した際のメッセージ
system.sensor_joined 部屋に新しいセンサが追加された際のメッセージ

アクセストークンの取得 [POST /sessions]

ユーザの入力したアカウント情報からセッション情報を作成し、アクセストークンを取得します。

リクエスト

Content-Type

application/x-www-form-urlencoded

Body

  • apikey (必須, string, xxxxxxxxxxx) … BOCCOサポートから受け取ったAPIキー。
  • email (必須, string, email@example.com) … アカウント登録時に入力したメールアドレス。
  • password (必須, string, xxxxxxxxxxx) … アカウント登録時に入力したパスワード。

レスポンス

200

新しい access_token が返されます。

{
    "access_token" : "x2c4sjxacw4tq72q5h9vrsgjbcz3p55ixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "uuid" : "e8bdc076-4045-45a7-abea-xxxxxxxxxxxx"
}

401

apikey, email, password のいずれかが誤っている場合 401 が返ります。

{
    "code": 401001,
    "message" : "Unauthorized"
}

チャットルームの取得 [GET /rooms/joined]

自分が入っているチャットルームの一覧を取得します。

リクエスト

クエリストリング

  • access_token (必須, string, x2c4sjxacw4tq72q5h9vrsgjbcz3p55ixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx) … 取得したアクセストークン。

レスポンス

200

[
  {
    "uuid": "E7607BA3-2AA0-4DEB-8959-XXXXXXXXXXXX",
    "name": "Happy Family",
    "updated_at": "2015-07-31T21:47:46+09:00",
    "background_image": "http://localhost:8000/1/rooms/E7607BA3-2AA0-4DEB-8959-XXXXXXXXXXXX/df5dfb71-9d58-4b50-b82f-000000000000.png",
    "members": [
      {
        "user": {
          "uuid": "eb11c90f-f1a2-43a8-8a12-xxxxxxxxxxxx",
          "user_type": "human",
          "nickname": "5",
          "icon": "",
          "seller": ""
        },
        "joined_at": "2015-05-11T23:52:39+09:00",
        "read_id": 23843
      },
      ...
    ],
    "messages": [
      {
        "id": 24686,
        "unique_id": "1DB34B93-0DFA-4150-AEF5-YYYYYYYYYYYY",
        "date": "2015-07-31T21:47:46+09:00",
        "media": "text",
        "message_type": "normal",
        "user": {
          "uuid": "cffbf787-dd20-4157-8279-yyyyyyyyyyyy",
          "user_type": "human",
          "nickname": "mash",
          "icon": "http://localhost:8000/1/users/cffbf787-dd20-4157-8279-yyyyyyyyyyyy/d4187679-bd07-49f8-94c9-000000000000.png",
          "seller": ""
        },
        "text": "hoge",
        "audio": "http://localhost:8000/1/messages/24686.ogg",
        "image": "",
        "sender": "cffbf787-dd20-4157-8279-yyyyyyyyyyyy",
        "detail": null
      }
    ],
    "sensors": [
      {
        "uuid": "AAA5EC17-7981-4FDC-B783-ZZZZZZZZZZZZ",
        "user_type": "sensor_fire",
        "nickname": "sensor_fire",
        "icon": "",
        "seller": "",
        "address": ""
      },
      ...
    ]
  }
]

メッセージ一覧の取得 [GET /rooms/{room_id}/messages]

このAPIにアクセスするためには、追加の権限が必要です。BOCCOサポートにお問い合わせください。

リクエスト

URLパラメータ

  • room_id (必須, string, E7607BA3-2AA0-4DEB-8959-XXXXXXXXXXXX) … チャットルームのuuid。

クエリストリング

  • newer_than (任意, integer, 1) … 指定した id より新しいメッセージが返ります。指定した id のメッセージは含まれません。
  • older_than (任意, integer, 9) … 指定した id より古いメッセージが返ります。指定した id のメッセージは含まれません。
  • access_token (必須, string, x2c4sjxacw4tq72q5h9vrsgjbcz3p55ixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx) … 取得したアクセストークン。
  • read (任意, bool, 1) … 1 が指定された場合、レスポンスに含まれる最新のメッセージを既読にします。

レスポンス

200

並び順はメッセージは id昇順 です。アプリのメッセージ一覧と同じ並び順です。
detail キーの内容は、 message_type によって異なります。

[
  {
    "id": 60,
    "unique_id": "4ECD2AC5-C9EB-4415-BFAF-XXXXXXXXXXXX",
    "text": "F",
    "sender": "1bb7bf12-83cf-40fa-9c33-xxxxxxxxxxxx",
    "user": {
      "uuid": "1bb7bf12-83cf-40fa-9c33-xxxxxxxxxxxx",
      "user_type": "human",
      "nickname": "aopico",
      "icon": "http://localhost:8000/assets/images/23fe1d3a-c1e1-4c56-87ed-000000000000.png",
      "seller": ""
    },
    "date": "2014-12-23T14:58:06+09:00",
    "media": "text",
    "audio": "http://localhost:8000/1/messages/60.wav",
    "message_type": "normal",
    "detail": null
  },
  {
    "id": 61,
    "unique_id": "849C4F97-BB2D-4047-8A8E-YYYYYYYYYYYY",
    "text": "G",
    "sender": "1bb7bf12-83cf-40fa-9c33-yyyyyyyyyyyy",
    "user": {
      "uuid": "1bb7bf12-83cf-40fa-9c33-yyyyyyyyyyyy",
      "user_type": "human",
      "nickname": "aopico",
      "icon": "http://localhost:8000/assets/images/23fe1d3a-c1e1-4c56-87ed-000000000000.png",
      "seller": ""
    },
    "date": "2014-12-23T14:58:38+09:00",
    "media": "text",
    "audio": "http://localhost:8000/1/messages/C4D86E06-2C1F-4672-988F-000000000000.wav",
    "message_type": "normal",
    "detail": null
  }
]
message_type が system.human_joined もしくは system.sensor_joined の場合
{
  "id": 12345,
  "unique_id": "4a169f98-065d-4937-aed8-xxxxxxxxxxxx",
  "date": "2015-07-16T02:54:59Z",
  "media": "text",
  "message_type": "system.human_joined",
  "user": {
    "uuid": "c20807b7-8a4b-44c6-a5b4-xxxxxxxxxxxx",
    "user_type": "bocco",
    "nickname": "BOCCO",
    "icon": "",
    "seller": ""
  },
  "text": " joined our room. Welcome, !",
  "audio": "https://api.bocco.me/1/messages/110508.ogg",
  "image": "",
  "sender": "c20807b7-8a4b-44c6-a5b4-xxxxxxxxxxxx",
  "detail": {
    "joined_user": {
      "uuid": "57b32f63-6398-46b1-aa5f-xxxxxxxxxxxx",
      "user_type": "human",
      "nickname": "",
      "icon": "",
      "seller": ""
    }
  }
}

メッセージの送信 [POST /rooms/{room_id}/messages]

リクエスト

Content-Type

application/x-www-form-urlencoded, multipart/form-data

Body

  • text (任意, string, Hi!) … text を送信する場合、 media パラメータを text に指定します。テキストの文字コードはUTF-8で送信してください。
  • audio (任意, binary) … audioファイルをバイナリで指定します。 audio を送信する場合、 ヘッダーに Content-Type: multipart/form-data を指定して、media パラメータを audio に指定します。
  • image (任意, binary) … imageファイルをバイナリで指定します。 image を送信する場合、 ヘッダーに Content-Type: multipart/form-data を指定して、media パラメータを image に指定します。
  • unique_id (必須, string, F7827189-E419-4012-820F-ZZZZZZZZZZZZ) … 冪等性を担保するため、クライアント側で生成したユニークIDを指定します。ユニークIDが同じメッセージは送られません。UUID version 4 の使用が推奨です。uuidgen コマンドなどを使用して生成してください。

  • media (必須, string, text or audio or image) … 送信するメッセージの種類を指定します。
  • access_token (必須, string, x2c4sjxacw4tq72q5h9vrsgjbcz3p55ixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx) … 取得したアクセストークン。

Headers

  • Accept-Language: ja … 日本語を指定します。
リクエストBody例 (multipart/form-data; boundary=BOUNDARY)
--BOUNDARY
Content-Disposition: form-data; name="audio"; filename="audio1.wav"
Content-Type: application/octet-stream

...binary...

--BOUNDARY
Content-Disposition: form-data; name="access_token"

x2c4sjxacw4tq72q5h9vrsgjbcz3p55ixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
--BOUNDARY
Content-Disposition: form-data; name="unique_id"

F7827189-E419-4012-820F-ZZZZZZZZZZZZ
--BOUNDARY
Content-Disposition: form-data; name="media"

audio
--BOUNDARY--

レスポンス

201

メッセージが作成された。

{
  "id":60,
  "unique_id":"F7827189-E419-4012-820F-ZZZZZZZZZZZZ",
  "text":"F",
  "sender":"1bb7bf12-83cf-40fa-9c33-xxxxxxxxxxxx",
  "user":{
    "uuid":"1bb7bf12-83cf-40fa-9c33-xxxxxxxxxxxx",
    "user_type":"human",
    "nickname":"aopico",
    "icon":"http://localhost:8000/assets/images/23fe1d3a-c1e1-4c56-87ed-000000000000.png",
    "seller":""
  },
  "date":"2014-12-23T14:58:06+09:00",
  "media":"text",
  "audio":"http://localhost:8000/1/messages/60.wav",
  "message_type":"normal"
}

200

メッセージが既に保存されたものであった場合、ステータスコード 200 が返ります。 unique_id によって識別されます。

{
  "date":"2014-12-23T14:58:06+09:00",
  "id":60,
  "media":"text",
  "message_type":"normal"
  "unique_id":"F7827189-E419-4012-820F-ZZZZZZZZZZZZ"
}

イベントの取得 [GET /rooms/{room_id}/subscribe]

このAPIにアクセスするためには、追加の権限が必要です。BOCCOサポートにお問い合わせください。

リクエスト

URLパラメータ

  • room_id (必須, string, E7607BA3-2AA0-4DEB-8959-XXXXXXXXXXXX) … チャットルームのUUID。

クエリストリング

  • newer_than (必須, integer, 1) … 指定した id より新しいメッセージが返ります。指定した id のメッセージは含まれません。
  • access_token (必須, string, x2c4sjxacw4tq72q5h9vrsgjbcz3p55ixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx) … 取得したアクセストークン。
  • read (任意, bool, 1) … 1 が指定された場合、レスポンスに含まれる最新のメッセージを既読にします。

レスポンス

並び順はメッセージは id昇順 です。アプリのメッセージ一覧と同じ並び順です。

このAPIはロングポーリングのリクエストです。 newer_than パラメータより新しいメッセージが来た場合に、レスポンスとして返ります。来なかった場合はタイムアウトとなります。

レスポンスには event として message または member が返ります。全てのイベントには eventbody キーが含まれます。クライアントは event キーの中身を見て、処理を分岐する必要があります。 message イベントのフォーマットは、 “メッセージの取得” API のフォーマットと同じです。

200

event が message の場合
{
  "event": "message",
  "body": {
    "id": 23927,
    "unique_id": "A2B68E53-235E-41EF-9C41-XXXXXXXXXXXX",
    "date": "2015-06-18T18:08:05+09:00",
    "media": "image",
    "message_type": "normal",
    "user": {
      "uuid": "63686d8f-c07b-431d-bd08-xxxxxxxxxxxx",
      "user_type": "human",
      "nickname": "iPhone6",
      "icon": "http://localhost:8000/1/users/63686d8f-c07b-431d-bd08-xxxxxxxxxxxx/e3e84fcc-82c9-456f-b2f3-000000000000.png",
      "seller": ""
    },
    "text": "Sent a photo",
    "audio": "http://localhost:8000/1/messages/23927.ogg",
    "image": "http://localhost:8000/1/messages/23927.png",
    "sender": "63686d8f-c07b-431d-bd08-xxxxxxxxxxxx",
    "detail": null
  }
}
event が member の場合
{
  "event": "member",
  "body": {
    "user": {
      "uuid": "63686d8f-c07b-431d-bd08-xxxxxxxxxxxx",
      "user_type": "human",
      "nickname": "iPhone6",
      "icon": "http://localhost:8000/1/users/63686d8f-c07b-431d-bd08-xxxxxxxxxxxx/e3e84fcc-82c9-456f-b2f3-000000000000.png",
      "seller": ""
    },
    "joined_at": "2014-12-21T16:50:41+09:00",
    "read_id": 333
  }
}

408

ロングポーリング中に、 newer_than より新しいメッセージが届かなかったら、 408 が返ります。

{
    "code" : 408001,
    "message" : "Request Timeout"
}

メッセージを既読にする [POST /rooms/{room_id}/messages/{message_id}/read]

このAPIにアクセスするためには、追加の権限が必要です。BOCCOサポートにお問い合わせください。

リクエスト

URLパラメータ

  • room_id (必須, string, E7607BA3-2AA0-4DEB-8959-XXXXXXXXXXXX) … チャットルームのUUID。
  • message_id (必須, int, 123) … メッセージの id

クエリストリング

  • access_token (必須, string, x2c4sjxacw4tq72q5h9vrsgjbcz3p55ixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx) … 取得したアクセストークン。

レスポンス

200

{}

音声ファイルを取得する [GET /messages/{unique_id}.{extname}]

リクエスト

取得したい音声に対応するメッセージの,audioパラメータが音声ファイルのリクエストURLとなります.

URLパラメータ

  • unique_id (必須, string, 8C0507DD-FDA1-4229-8731-XXXXXXXXXXXX) … メッセージの unique_id
  • extname (必須,string,wav) … 音声ファイルの拡張子.audioパラメータの拡張子ではなくwavファイルが欲しい場合,このパラメータをwavに変更します.

クエリストリング

  • access_token (必須, string, x2c4sjxacw4tq72q5h9vrsgjbcz3p55ixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx) … 取得したアクセストークン。

レスポンス

200

音声ファイルがダウンロードされます.

エラー

HTTP ステータスコード

HTTP ステータスコードは本来の意味で使われます。詳しくは、HTTPステータスコード(ウィキペディア) をご覧ください。

  • 401 : access_token が不正です。全てを初期化して、初めの手順からやり直す必要があります。
  • 400 : GET/POST リクエストのパラメータが不正です。パラメータを確認してください。
  • 404 : リクエストされたリソースが見つからない、もしくは権限がありません。リソースがアクセス可能なことを確認してください。
  • 408 : リクエストタイムアウト。ネットワーク状態を確認してください。
  • 429 : 過剰なリクエスト頻度。しばらく待ってから、再度リクエストしてください。
  • 500 : 内部エラー。BOCCOサポートへお問い合わせください。
  • 502 : 不正なゲートウェイ。BOCCOサポートへお問い合わせください。
  • 503 : サービス利用不可。BOCCOサポートへお問い合わせください。

レスポンス

HTTPステータスが 200 以外のとき、下記のような Body が返ります。

{
    "code" : xxxxxx,
    "message" : xxxxxxxx
}

code はエラー識別子です。各APIの詳細を確認してください。
message はローカライズされた人間可読なエラーメッセージです。

Tags: reference