| 種類 | 操作 | メソッド | URL |
|---|---|---|---|
| つぶやき (statuses) |
つぶやきの投稿 | POST | /voice/statuses/update |
| 友人のつぶやき一覧の取得 | GET | /voice/statuses/friends_timeline | |
| 特定ユーザーのつぶやき一覧の取得 | GET | /voice/statuses/User-ID/user_timeline | |
| 特定のつぶやきの情報取得 | GET | /voice/statuses/show/Post-ID | |
| つぶやきの削除 | POST | /voice/statuses/destroy/Post-ID | |
| コメント (replies) |
コメントの投稿 | POST | /voice/replies/create/Post-ID |
| コメントの取得 | GET | /voice/replies/show/Post-ID | |
| コメントの削除 | POST | /voice/replies/destroy/Post-ID/Comment-ID | |
| イイネ! (favorites) |
イイネ!の投稿 | POST | /voice/favorites/create/Post-ID |
| イイネ!の削除 | POST | /voice/favorites/destroy/Post-ID/User-ID |
リクエストに失敗した場合には、
{"error":"unknown error. code:404"}
のようなJSON形式でエラーが返されます。
POST https://api.mixi-platform.com/2/voice/statuses/update
のURLに対して、URLエンコードされたテキストをstatusパラメータとしてPOSTします。
投稿に成功した場合には、特定のつぶやきを取得した結果と同様の形式でつぶやいた内容が返されます。
つぶやきの文字数が制限 (150文字) を超えたり、不正なパラメータを指定したときには、HTTPヘッダで「400 Bad Request」が返されます。
サポートされる画像フォーマットは、
の2種類です。それ以外の画像を投稿したときには「400 Bad Request」で{"error":"unknown error. code:400"}返されます。
| フォト | Content-Type |
|---|---|
| なし | application/x-www-form-urlencoded |
| あり | multipart/form-data |
GET https://api.mixi-platform.com/2/voice/statuses/friends_timeline/Group-ID
mixiの最新のつぶやきの内容を取得できます。ドキュメントでは友人のつぶやきを取得すると解説されていますが、返されるデータには自分のつぶやきも含まれます。
| パラメータ | 説明 |
|---|---|
| Group-ID | グループのID |
| since_id | results_directionの起点となるID |
| results_direction | since_idを起点とした、取得するつぶやきの種類
|
| count | 取得件数の上限。既定値は20で、最大値は200。 |
| trim_user | "true"とすると、ユーザー情報としてidだけ返される。"exclude_screen_name"とすると、idとscreen_nameだけが返される。 |
| attach_photo | "true"とすると、つぶやきに含まれるフォト情報をphotoプロパティとして抜き出す |
https://api.mixi-platform.com/2/voice/statuses/friends_timeline/%40topFriends?count=1Group-IDあり
https://api.mixi-platform.com/2/voice/statuses/friends_timeline/?count=1Group-IDなし
GET https://api.mixi-platform.com/2/voice/statuses/User-ID/user_timeline
User-IDを「@me」とすると、mixiの自分のつぶやきの内容が返されます。
GET https://api.mixi-platform.com/2/voice/statuses/show/Post-ID
| 属性名 | 説明 |
|---|---|
| id | つぶやきを特定するためのID (Post-ID) |
| created_at | 投稿日時 |
| text | つぶやきの本文 |
| user | 投稿したユーザーの情報 |
| reply_count | コメントの件数 |
| favorite_count | イイネ!の件数 |
| source | このつぶやきがTwitterから取り込まれた場合に含まれる。そのときの値は"twitter"。 |
| favorited | 認可ユーザーがこのつぶやきに"イイネ!"している場合にtrue。さもなくばfalse。 |
| photo | つぶやきに含まれるフォト情報
(この情報を取得するには、リクエスト時にattach_photo=trueとする必要がある) |
| 属性名 | 説明 |
|---|---|
| id | ユーザーID |
| screen_name | ユーザーのニックネーム |
| profile_image_url | ユーザーのプロフィール画像のURL |
| url※1 | ユーザーのプロフィールページのURL
http://mixi.jp/show_friend.pl?uid=idの形式で、idはユーザーID。 |
urlとprofile_image_urlのURLについては、URLのルール << mixi Developer Centerに詳細があります。
| 属性名 | 説明 |
|---|---|
| image_url | フォトのURL |
| thumbnail_url | フォトのサムネイルのURL |
つぶやきのIDは、つぶやきを投稿したユーザーのIDと投稿日時により決定されます。たとえば、
ならば、つぶやきIDはそれらを連結して"abc-20100102034050"となります。
| URL | |
|---|---|
| プロフィール情報 | http://mixi.jp/show_profile.pl?id=旧ユーザーID |
http://mixi.jp/show_friend.pl?id=旧ユーザーID |
POST https://api.mixi-platform.com/2/voice/statuses/destroy/Post-ID
削除に成功した場合には、削除したつぶやきの内容が返されます。
POST https://api.mixi-platform.com/2/voice/replies/create/Post-ID
GET https://api.mixi-platform.com/2/voice/replies/show/Post-ID
| 属性名 | 説明 |
|---|---|
| id | コメントを特定するためのID (Comment-ID) |
| created_at | 投稿日時 |
| text | コメントの本文 |
| user | 投稿したユーザの情報
(つぶやきのuserプロパティに同じ) |
コメントIDは、コメントしたつぶやきのIDとコメントしたユーザーのID、およびその投稿日時により決定されます。たとえば、
ならば、コメントIDはそれらを連結して"abc-20100102034050-def-20100203034050"となります。
POST https://api.mixi-platform.com/2/voice/favorites/create/Post-ID
投稿の成否は、レスポンスのHTTPヘッダで確認できます。
| ステータス | 状況 |
|---|---|
| 200 OK | 投稿に成功した。このとき、イイネ!を投稿したつぶやきの情報が返される。 |
| 401 Authorization Required | 認可が得られていない。 |
| 403 Forbidden | すでにイイネ!を投稿してあるつぶやきに再度イイネ!の投稿を行った、または認可されないユーザーのつぶやきにイイネ!を投稿した。 |
| 413 Request Entity Too Large | リクエストボディの指定に誤りがある。 ※「Content-Length: 0」となるように空のデータを指定する必要がある。 |
投稿に成功した場合のみレスポンス ボディが返され、それはイイネ!を投稿したつぶやきの情報となっています。そこにはイイネ!の件数を表すfavorite_countも含まれますが、その件数にはこの投稿は含まれません。