">mixi Developer Center (mDC)

The Message API is a frequently used service among various mixi APIs. Many services share their content with the user's friends. The Message API is mainly for one to one communication. The user is able to send messages from various locations and receive the messages on a variety of devices by using the Message API.

Items required in advance

To use the Message API, please have these items prepared beforehand.

• Access token approved for “r_message” or “w_message”scope, or both scope.

Message API cannot be accessed using other scopes not specified above. For instructions on how to acquire the access token, please refer to the authentication approval procedure.

Message API capabilities and scopes

The Message API supplies various functions that can roughly be classified by "reference type" and "contribution type." The two types exactly correspond to Message API scopes. Correspondence between scopes and capabilities is shown below:

Getting the received message list

The following is a URL to acquire the authorized user's received message list:

GET https://api.mixi-platform.com/2/messages/[User-ID]/@inbox/[Message-ID]

In addition, the query parameters below are supported:

Returned results are shown below.

{
    "entry" : [
        {
            "id" : "e5f820e4f9f459b91c3730cc261e2629",
            "status" : "replied",
            "timeSent" : "2010-11-10T17:26:23+09:00",
            "title" : "title",
            "body" : "text",
            "sender" : {
                "id" : "rdqz7s6ew176q",
                "displayName" : "nickname",
                "thumbnailUrl" : "http://mixi.jp/photo/user/rdqz7s6ew176q_2105834213.jpg",
                "profileUrl" : "http://mixi.jp/show_friend.pl?uid=rdqz7s6ew176q"
            },
        },
        ・・・
    ],
    ・・・
}

The information contained in each entry is shown below.

Obtaining sent message list

The URL to obtain the approved user's sent message or list of messages is as follows:

GET https://api.mixi-platform.com/2/messages/[User-ID]/@outbox/[Message-ID]

In addition, the query parameter below is supported:

Returned results are shown below.

{
    "entry" : [
        {
            "id" : "e5f820e4f1f458b91c3730cc261e1619",
            "timeSent" : "2010-11-10T17:26:23+09:00",
            "title" : "title",
            "body" : "text",
            "recipient" : {
                "id" : "rdqz7s6ew176q",
                "displayName" : "nickname",
                "thumbnailUrl" : "http://mixi.jp/photo/user/rdqz7s6ew176q_2105834213.jpg",
                "profileUrl" : "http://mixi.jp/show_friend.pl?uid=rdqz7s6ew176q"
            },
        },
        ・・・
    ],
    ・・・
}

The information contained in each entry is shown below.

Obtaining announcements from mixi

The URL to obtain the approved user's announcements received from mixi is as follows:

GET https://api.mixi-platform.com/2/messages/[User-ID]/@noticebox/[Message-ID]

In addition, the query parameter below is supported:

Returned results are shown below.

{
    "entry" : [
        {
            "id" : "e5f820e4f1f458b91c3730cc261e1619",
            "status" : "read",
            "timeSent" : "2010-11-10T17:26:23+09:00",
            "title" : "title",
            "body" : "text",
            "sender" : {
                "displayName" : "mixi",
                "thumbnailUrl" : "http://img.mixi.net/img/basic/common/mixi_logo_thumbnail001.gif"

            },
        },
        ・・・
    ],
    ・・・
}

The information contained in each entry is shown below.

Sending message

The URL to send a message is shown below.

POST https://api.mixi-platform.com/2/messages/[User-ID]/@self/@outbox

Specify the content type of the message sent in the request body as application/json format as below.

{
    "title" : "Subject",
    "body" : "Text",
    "recipients" : ["rdqz7s6ew176q"]
}

Using content type application/json format, replying to a received message can be achieved as shown below.

{
    "title" : "Title",
    "body" : "Body",
    "inReplyTo : "e5f820e5f9we455691c3720cc261e2629"
}

The value to be specified for each field is shown below.

If sending the message is successful, a status code of 200 and JSON string with an ID to specify
its message will be returned as shown below.

{
    "id" : "e5f820e4f9f459b91c3730cc261e2629"
}

If sending the message failed, a Json string with the error message as shown below will be returned along with a status code of either 400s or 500s.

{
    "error" : "access_denied",
    "error_description" : "your account is temporary prohibited"
}

Changing the message browsing state

The URI to change the received message's browsing state is as shown below.

PUT https://api.mixi-platform.com/2/messages/[User-ID]/@self/@inbox/[Message-ID]

Or, to change the state of an announcement from mixi, use the URI below.

PUT https://api.mixi-platform.com/2/messages/[User-ID]/@self/@noticebox/[Message-ID]

Specify the modified browsing state with a JSON format request body.

{
    "status" : "read"
}

If the modification process has succeeded, a status code of 200 and a JSON string with a success message as shown below will be returned.

{
    "status" : "status changed"
}

If the modification process has a problem, a JSON string that has an error message along with a status code of either 400s or 500s will be returned.

{
    "error" : "status_conflicted",
    "error_description" : "status cannot be changed"
}

If replying to the message has succeeded,
the replied message in the received message browsing view will change to “replied” automatically.

Deleting Messages

The URI to delete a received message into the recycle bin is as shown below.

DELETE https://api.mixi-platform.com/2/messages/[User-ID]/@self/@inbox/[Message-ID]

The URI to delete a sent message into the recycle bin is as shown below.

DELETE https://api.mixi-platform.com/2/messages/[User-ID]/@self/@outbox/[Message-ID]

Announcements from mixi can be deleted permanently by using the URI below.

DELETE https://api.mixi-platform.com/2/messages/[User-ID]/@self/@noticebox/[Message-ID]

If the delete was successful, a status code 200 and the JSON string with the message shown below will be returned.

{
    "status" : "delete done"
}

If the delete failed, a JSON string that has error message as that shown below along with a status code in the 400s or 500s will be returned.

{
    "error" : "not_found",
    "error_description" : "message not found"
}

Paging, Format

The message API supports paging which is supported in JSON format.

For paging, if the API acquisition count parameter is not specified, the count will be 50.

For character encoding, the encoding in the request can be specified by the charset value of a Content-Type request header. The encoding used for reply is UTF-8.