OkayAPI Docs


API Path: /api/App/Market_ChatMessage/TakeMessageList

API Description: 获取与某一位会员的单人会话消息列表。使用前请先安装私信插件

1
API Traffic
HTTP/HTTPS
Protocol
GET/POST
Method
UTF-8
Charset
JSON
Response

API Debug   


API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
other_uuidStringRequiredMIN: 32;MAX: 32私信对话的会员uuid
last_idStringOptaion0MIN: 0上一次的消息ID,通过传递前面的私信消息ID以保证消息的连贯性。
directionEnumOptaiondownRange: up/down获取私信消息的方向,up表示向上滑动,即取前面的旧消息;down表示向下滑动,即获取最新的消息。
perpageIntOptaion20MIN: 1;MAX: 100分页数量

API Debug

KEYREQUIREDVALUE
app_key *Required
other_uuid *Required
last_id Option
direction Option
perpage Option

API Response

KEYTypeDescription
err_codeInt操作码,0表示成功,1不能和自己聊天,9表示插件未安装
err_msgString错误提示信息,err_code非0时参考此提示信息
listArray消息列表
list[].idInt
list[].chat_message_to_uuidString当前会话的会员uuid
list[].chat_message_dataObject消息数据结构体
list[].chat_message_typeString消息类型
list[].chat_message_is_readInt是否已读,0未读1已读
list[].chat_message_ioString消息方向,in表示自己发出的,out表示收到的
list[].add_timeString消息发送时间
unread_numInt未读消息数量

HTTP Response Code

HTTP Status CodeDescription
Http Status = 200Success
Http Status = 400Illegal-Params
Http Status = 401Illegal-Token
Http Status = 402IP-Banned
Http Status = 404API-NOT-Exsits
Http Status = 406Illegal-APPKEY
Http Status = 407APPKEY-Expired-Out
Http Status = 408APPKEY-Busy
Http Status = 409Illegal-Sign
Http Status = 413API-Traffic-NOT-Enough
Http Status = 415API-LOCKED
Http Status = 500Internal-Server-Error