">mixi Developer Center (mDC)

mixi Connect

mixi Connect (English) » mixi Graph API » Technical Specification » Voice API

Voice API

Mixi voice was developed to allow a large group of users to lightheartedly communicate. In the past mixi Voice was only available through mixi.jp and a small number of cell phones but with the development of the Voice API, third parties are now able to extract mixi Voice posts made by a user and the user's friends, "likes" and comments. In addition, mixi Voice posts are possible through third parties as well.

The method to use Voice API is explained below:

Items required in advance

The following items must be obtained in order to use Voice API.

  • Approved tokens must be used for the "r_voice" or"w_voice" scopes to access Voice API.

Please refer to the Authorization and Authentication Process page on how to obtain the access tokens. Tokens must be used to access Voice API.

Voice API capabilities and scope

There are many capabilities that the Voice API offers but they can be categorized into two major categories: "extracting" and "posting." These two categories are also categorized by the scopes offered which is described below.

Scope Capability
r_voice Acquiring a list of a user or a user's friends mixi Voice posts
Acquiring a list of "likes" on a mixi Voice post
Acquiring a list of comments for a mixi Voice post
w_voice Posting or deleting a mixi Voice post
Posting or deleting a "like" on a mixi Voice post
Posting or deleting a comment on a mixi Voice post

Acquiring a mixi Voice post

Voice API allows the following 3 capabilities for acquiring information

  • Acquiring a user's list of mixi Voice posts
  • Acquiring a user's friends' mixi Voice posts
  • Acquiring specific information included in maxi Voice post

Please access the client program "https://api.mixi-platform.com/2/voice/statuses" to acquire specific information included in a mixi Voice post. The URI for the above 3 capabilities all differ.

Acquiring a list of a user's mixi Voice posts

Please user the following URI to acquire a list of a user's mixi Voice posts.

GET https://api.mixi-platform.com/2/voice/statuses/[User-ID]/user_timeline?since_id=[post-ID]
Parameter Value to specify
User-ID User ID for the user in which information will be acquired or the authorized users represented by "@me"
since_id This parameter allows an acquisition of photos from mixi Voice posts from a certain time frame. (optional)
trim_user If "1", "true" or "t" is specified in this parameter, then only the user's id will be returned as the user's information (user's properties).
Also, if "exclude_screen_name" is specified then the id and screen_name will be returned.
attach_photo If "1", "true" or "t" is specified in this parameter, then the photo information for the photo for the mixi Voice post will be returned.

For the User-ID parameter, only the user-ID approved by the access token, "@me," or that user's friend's user ID can only be specified.

There are limitations to the since_id function due to the count parameter. The count parameter has certainlimitations that may cause all the pictures specified to not be acquired (e.g. maximum 200 pictures can be acquired using the count parameter).

Acquiring a list of a user's friend's mixi Voice posts

Please use the following URI to acquire a list of a user's friend's mixi Voice posts.

GET https://api.mixi-platform.com/2/voice/statuses/friends_timeline/[Group-ID]?since_id=[post-ID]
Parameter Value to specify
Group-ID Group ID (optional)
since_id This parameter allows an acquisition of photos from mixi Voice posts from a certain time frame. (Optional).
trim_user If "1", "true" or "t" is specified in this parameter, then only the user's id will be returned as the user's information (user's properties). Also, if "exclude_screen_name" is specified then the id and screen_name will be returned.
attach_photo If "1", "true" or "t" is specified in this parameter, then the photo information for the photo for the mixi Voice post will be returned.

Using these methods, a list of a user's friend's mixi Voice can be obtained for an access token approved user. By specifying a Group-ID, only the mixi Voice posts for friends in that group will be acquired.

Similar to the rules that apply for "Acquiring a list of a user's mixi Voice posts" there are limitations to the since_id function due to the count parameter. The count parameter has certain limitations that may cause all the pictures specified to not be acquired (e.g. maximum 200 pictures can be acquired using the count parameter).

Acquiring specific information included in a mixi Voice post

Please use one of the following URIs to acquire specific information included in a mixi Voice post. Both of the URIs are capable of performing the task.

GET https://api.mixi-platform.com/2/voice/statuses/show/[Post-ID]
GET https://api.mixi-platform.com/2/voice/statuses/[Post-ID]
Parameter Value to be specified
Post-ID An ID to identify what information to acquire
trim_user If "1", "true" or "t" is specified in this parameter, then only the user's id will be returned as the user's information (user's properties).
Also, if "exclude_screen_name" is specified then the id and screen_name will be returned.
attach_photo If "1", "true" or "t" is specified in this parameter, then the photo information for the photo for the mixi Voice post will be returned.

Acquisition result

The acquisitions result for the mixi Voice post information is as below. It is in JSON format.

[
  {
    "id" : "1FZ3P4ACUWBBC-2010061010321",
    "created_at" : "Thu Jun 10 01:32:13 +0000 2010",
    "text" : "mixi Voice post",
    "user" : {
      "id" : "1FZ3P4ACUWBB",
      "screen_name" : "Becky",
      "profile_image_url" : "http://profile.img.mixi.jp/photo/user/1FZ3P4ACUWBBC_301280930.jpg",
      "url" : "http://mixi.jp/redirect_friend_api.pl?puid=xxxxxxxxxxxxx&client_id=xxxxxxxx"
    },
    "reply_count" : "3",
    "favorite_count" : "5",
    "favorited" : true
  },
  ・・・
]

Each entry is explained below:

Attribute Explanation
id ID to identify the mixi Voice post (Post-ID)
created_at Date the mixi Voice was posted
text The contents of the mixi Voice post
user.id User ID of the mixi Voice poster
user.screen_name Nickname for the mixi Voice poster
user.profile_image_url URL for the profile picture of the user who posted the mixi Voice
user.url URL for the profile page of the user who posted the mixi Voice
reply_count The number of comments for the mixi Voice post
favorite_count The number of "likes" for the mixi Voice post
source The source of the mixi Voice post. If the mixi Voice post was sourced byTwitter, then "twitter" will be returned for this attribute.
favorited Indicate whether the approved user has "liked" this mixi Voice post. If liked "true" will be returned, if not "false" will be returned.

In regards to the user properties, if the user is not a friend of the authorized user, then only the user.id, user.screen_name, user.profile_image_url properties will be returned.

If the attach_photo parameter is used to access the API, the photo properties will also be returned. For instance for the following mixi Voice post:

http://photo.mixi.jp/view_photo.pl?photo_id=3535&owner_id=3535 Tonight's dinner

The following API will be returned:

[
  {
    "id" : "1FZ3P4ACUWBBC-2010061010321",
    "created_at" : "Thu Jun 10 01:32:13 +0000 2010",
    "text" : "Tonight's dinner",
    "user" : {
        ・・・
    },
    "photo" : [
        {
            "thumbnail_url" : "http://id.photo.mixi.jp/....",
            "image_url" : "http://id.photo.mixi.jp/....",
        }
    ],
    ・・・
  },
  ・・・
]
Attribute Explanation
photo The array of the photo information. If there is no photo information then "0 cases" will be returned.
photo.thumbnail_url The URL for the photo thumbnail
photo.image_url The photo URL

When the attach_photo parameter is used, then the photo information must satisfy the following requirements:

  • The URL must have the format "http://photo.mixi.jp/view_photo.pl?photo_id=***&owner_id=***
  • The user who post the mixi Voice and the user who the photo owner must be the same.

The photo properties will be returned regardless of the privacy setting set by the user.

Acquiring a list of comments for a mixi Voice post

Please access the "https://api.mixi- platform.com/2/voice/replies" client program to in order to acquire a list of comments for a mixi Voice post. There are two URI which can be used and either of them can be used to perform the same function.

GET https://api.mixi-platform.com/2/voice/replies/show/[Post-ID]
GET https://api.mixi-platform.com/2/voice/replies/[Post-ID]
Parameter Value to be specified
Post-ID ID for the mixi Voice post in which comments are to be extracted.
trim_user If "1", "true" or "t" is specified in this parameter, then only the user's id will be returned as the user's information (user's properties).

The acquisitions result for the mixi Voice post's comments is as below. It is in JSON format.

[
  {
    "id" : "1FZ3P4ACUWBBC-20090520180336-1FZ3P4ACUWBBC-2009052112112",
    "created_at" : "Thu May 21 03:11:23 +0000 2009",
    "text" : "Comment",
    "user" : {
      "profile_image_url" : "http://profile.img.mixi.jp/photo/user/1FZ3P4ACUWBBC_301280930.jpg",
      "url" : "http://mixi.jp/redirect_friend_api.pl?puid=xxxxxxxxxxxxx&client_id=xxxxxxxx",
      "id" : "1FZ3P4ACUWBB",
      "screen_name" : "Becky"
    }
  },
  ・・・
]

Each entry is explained below:

Attribute Explanation
id ID to specify comment (comment-ID)
created_at Date and time in which comment was posted
text Comment contents
user.id User ID of user who posted comment
user.screen_name Nickname for the user who posted the comment
user.profile_image_url Profile picture URL for the user who posted the comment
user.url Profile page URL for the user who posted the comment

In regards to the user properties, if the user is not a friend of the authorized user, then only the user.id, user.screen_name, user.profile_image_url properties will be returned.

Acquiring a list of "likes" for a mixi Voice post

Please access the "https://api.mixi-platform.com/2/voice/favorites" client program to in order to acquire a list of likes for a mixi Voice post. There are two URI which can be used and either of them can be used to perform the same function.

GET https://api.mixi-platform.com/2/voice/favorites/show/[Post-ID]
GET https://api.mixi-platform.com/2/voice/favorites/[Post-ID]
Parameter Value to be specified
Post-ID ID for the mixi Voice post in which "likes" are to be extracted.
trim_user If "1", "true" or "t" is specified in this parameter, then only the user's id will be returned as the user's information (user's properties).

The acquisitions result for the mixi Voice post's "likes" is as below. It is in JSON format.

[
  {
    "created_at" : "Wed Dec 07 01:09:54 +0000 2011",
    "profile_image_url" : "http://profile.img.mixi.jp/photo/user/C8A4ICPZF1EQ_301280930.jpg",
    "url" : "http://mixi.jp/redirect_friend_api.pl?puid=xxxxxxxxxxxxx&client_id=xxxxxxxx",
    "id" : "C8A4ICPZF1E",
    "screen_name" : "Taro"
  },
  ・・・
]

Each entry is explained below:

Attribute Explanation
id ID for user who posted a "like"
screen_name Nickname of user who posted a "like"
profile_image_url Profile picture URL of user who posted a "like"
url Profile page URL for user who posted a "like"
created_at Date the "like" was posted

In regards to the user properties, if the user is not a friend of the authorized user, then only the user.id, user.screen_name, user.profile_image_url properties will be returned.

Posting and Deleting a mixi Voice

Please access the client program "https://api.mixi-platform.com/2/voice/statuses" to post and delete a mixi Voice.

Posting a mixi Voice

There are two URI which can be used to post a mixi Voice and either of them can be used to perform the same function.

POST https://api.mixi-platform.com/2/voice/statuses/update
POST https://api.mixi-platform.com/2/voice/statuses

For the request body, please set the mixi Voice to application/x-www-form-urlencoded format.

status=%E3%81%A4%E3%81%B6%E3%82%84%E3%81%8D%E3%81%AE%E6%9C%AC%E6%96%87
Parameter Value to be specified
status Body for the mixi Voice post

The text for the value must be formatted for UTF-8 and must be URI encoded for the status parameter.

Posting a mixi Voice with a photo

Photos can also be posted with the mixi Voice post. There are two ways of performing this:

  • Submit a request in "multipart/form-data" format.
  • • Submit a request in "image/jpeg, image/png" format.

If the "multipart/form-data" format is used please use one of the two URIs below. Either of them can be used to perform the same action.

POST https://api.mixi-platform.com/2/voice/statuses/update
POST https://api.mixi-platform.com/2/voice/statuses

Specify "multipart/form-data" in the Content-type request header and specify the two parameters in the request body.

Parameter Value to be specified
status Body of the mixi Voice post. The text for the value must be formatted for UTF-8 and must be URI encoded for the status parameter. If the photo parameter is specified the status parameter can be omitted.
photo Photo binary data

If the "image/jpeg" or "image/png" format is used please use one of the two URIs below. Either of them can be used to perform the same action.

POST https://api.mixi-platform.com/2/voice/statuses/update
POST https://api.mixi-platform.com/2/voice/statuses

Use the following parameter:

Parameter Value to be specified
status Body of the mixi Voice post. The text for the value must be formatted for UTF-8 and must be URI encoded for the status parameter. (optional)

Specify "image/jpg" or "image/png" in the Content-Type request header accordingly. Also specify the photo binary data in the request body.

If properly posted you will be returned with the following. The returned items are similar to the list of mixi Voice posts when using the attach_photo parameter.

[
  {
    "id" : "1FZ3P4ACUWBBC-2010061010321",
    "created_at" : "Thu Jun 10 01:32:13 +0000 2010",
    "text" : "mixi Voice post",
    "user" : {
      "id" : "1FZ3P4ACUWBB",
      "screen_name" : "Becky",
      "profile_image_url" : "http://profile.img.mixi.jp/photo/user/1FZ3P4ACUWBBC_301280930.jpg",
      "url" : "http://mixi.jp/redirect_friend_api.pl?puid=xxxxxxxxxxxxx&client_id=xxxxxxxx"
    },
    "photo" : [
        {
            "thumbnail_url" : "http://id.photo.mixi.jp/....",
            "image_url" : "http://id.photo.mixi.jp/....",
        }
    ],
    "favorited" : false
  }
]

Deleting a mixi Voice post

For deleting a mixi Voice post, there are two URI which can be used and either of them can be used to perform the same function.

POST or DELETE https://api.mixi-platform.com/2/voice/statuses/destroy/[Post-ID]
DELETE https://api.mixi-platform.com/2/voice/statuses/[Post-ID]
Parameter Value to be specified
Post-ID ID to identify which post is to be deleted

The mixi Voice post can only be deleted if it was posted by the user with access token approval.

Posting and Deleting a comment

Please access the client program "https://api.mixi-platform/2/voice/replies" to post and delete comments for a mixi Voice post.

Posting a comment

To post a comment on a mixi Voice post, there are two URI which can be used and either of them can be used to perform the same function.

POST https://api.mixi-platform.com/2/voice/replies/create/[Post-ID]
POST https://api.mixi-platform.com/2/voice/replies/[Post-ID]
Parameter Value to be specified
Post-ID ID of the post in which the comment is to be posted

For the request body, use the "application/x-www-form-urlencoded" format for the comment text.

text=%E3%82%B3%E3%83%A1%E3%83%B3%E3%83%88%E3%81%AE%E6%9C%AC%E6%96%87
Parameter Value to be specified
text Comment text

The text for the value must be formatted for UTF-8 and must be URI encoded for the status parameter.

Deleting a comment

To delete a comment on a mixi Voice post, there are two URI which can be used and either of them can be used to perform the same function.

POST or DELETE https://api.mixi-platform.com/2/voice/replies/destroy/[Post-ID]/[Comment-ID]
DELETE https://api.mixi-platform.com/2/voice/replies/[Post-ID]/[Comment-ID]
Parameter Value to be specified
Post-ID ID to identify the mixi Voice post in which the comment is to be deleted
Comment-ID ID to identify which comment on a mixi Voice post to delete

The comment on the mixi Voice post can only be deleted if it was posted by the user with access token approval.

Posting and Deleting a "like" on a mixi Voice post

Please access the client program "https://api.mixi-platform.com/voice/favorites" to post and delete "likes" for a mixi Voice post.

Posting a "like"

To post a "like" on a mixi Voice post, there are two URI which can be used and either of them can be used to perform the same function.

POST https://api.mixi-platform.com/2/voice/favorites/create/[Post-ID]
POST https://api.mixi-platform.com/2/voice/favorites/[Post-ID]
Parameter Value to be specified
Post-ID ID to identify the mixi Voice post in which a "like" is to be posted

The request body does not need to be specified.

Deleting a "like"

To delete a "like" on a mixi Voice post, there are two URI which can be used and either of them can be used to perform the same function.

POST or DELETE https://api.mixi-platform.com/2/voice/favorites/destroy/[Post-ID]/[User-ID]
DELETE https://api.mixi-platform.com/2/voice/favorites/[Post-ID]/[User-ID]
Parameter Value to be specified
Post-ID ID to identify the mixi Voice post in which the "like" is to be deleted
User-ID User ID of the individual who's "like" on the mixi Voice post is to be deleted

If the user is approved through the access token, the user has the authority to delete all the "likes" that are posted to a particular mixi Voice post. If the user is not approved through the access token, then the user will only have authority to delete the "likes" that he/she has posted.

Paging, Display Format

Voice API supports paging in segments. (Specifically, during request, startIndex and count parameters are supported, but the response will not have paging related information). It is supported in JSON format.

In regards to paging, if the count parameter is omitted then it will return 20 items while the maximum that can be returned is 200. Even if a number larger than 200 is requested, only 200 will be returned.

TOP OF THIS PAGE