direct messages.conversation

lisztli edited this page Jan 12, 2012 · 4 revisions
Clone this wiki locally

GET /direct_messages/conversation

以对话的形式返回当前用户与某用户的私信

路径

http://api.fanfou.com/direct_messages/conversation.[json|xml]

调用方法

GET 

限制条件

用户登录, API需要有读用户私信的权限

参数:

id

  • 作用: 指定私信对话的用户

  • 格式: id=user_id

  • 字段说明: 必选

count

  • 作用: 指定返回用户的数量, 默认为20

  • 格式: count=user_count

  • 字段说明: 可选, count 取值范围1至60

page

  • 作用: 指定返回结果的页码

  • 格式: page=page_id

  • 字段说明: 可选

max_id

  • 作用: 只返回id小于等于max_id的私信

  • 格式: max_id=msg_id

  • 字段说明: 可选

since_id

  • 作用: 只返回id大于since_id的私信

  • 格式: since_id=msg_id

  • 字段说明: 可选

mode

  • 作用: 当mode=default(默认)时,返回消息中用户信息包含用户自定义profile.mode=lite, profile不会包含在返回信息中

  • 格式: mode=[default|lite]

  • 字段说明: 可选

callback

  • 格式: callback=javascript函数名

  • 作用: 当使用json格式时,生成的json对象将作为参数传给指定的javascript函数

  • 字段说明: 可选

返回结果

成功

  • HTTP Status Code

    200 OK HTTP/1.1

  • 返回值

    • json格式

      返回一个由direct message object组成的数组,direct message object的格式参见direct-messages.new

      {
          direct_message_0,
          direct_message_1,
          direct_message_2,
          direct_message_3,
          ...
      }