技术文档

【咚咚IM】接口导航

1. 查询客服组信息	2. 咨询指定日期的平均等待时长
3. 查询客服评价详情	4. 客服日评价统计
5. 查询客服登录日志	6. 客服日接待量统计
7. 获取会话列表	8. 客服日未回复量统计
9. 日累计在线时长	10. 聊天记录模糊查询
11. 聊天记录查询

1. 查询客服组信息

接口名称

jingdong.im.pop.groupinfo.get

功能说明

查询客服组信息

API用户授权类型

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
				此接口无需输入应用级参数，但需要构建空参数360buy_param_json={}

返回结果：

名称	类型	是否必须	示例值	描述
shopName	String	否		店铺名字
shopUrl	String	否		店铺主页
waiterCount	Number	否		客服数量
waiterList	Waiter[]	否		客服列表

Waiter 属性：

名称	类型	是否必须	示例值	描述
waiter	String	否		客服账号
yn	String	否		是否授权
leader	Boolean	否		是否管理员。true：是 false：否
level	String	否		客服等级

返回示例

JSON数据格式

{
  "jingdong_im_pop_groupinfo_get_response":{
  "popgroup":{
  "shopName":"",
"waiterCount":"",
"shopUrl":"",
"waiterList":[{
  "level":"",
"leader":"",
"yn":"",
"waiter":""
  }]
  }
  }
  }

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
ImPopGroupinfoGetRequest request=new ImPopGroupinfoGetRequest();
ImPopGroupinfoGetResponse response=client.execute(request);

2. 咨询指定日期的平均等待时长

接口名称

jingdong.im.pop.consult.avgwaittime.get

功能说明

咨询指定日期的平均等待时长

API用户授权类型

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
waiter	String	否		需要查询的客服账号（当该字段不输入时，默认查询授权账号。只有在授权账号为主账号，且该字段为授权账号的子账号时，才会产生查询结果）
date	Date	是		需要查询数据的时间，查询的日期距现在不能大于3个月

返回结果：

名称	类型	示例值	描述
avgTime	Number		平均等待时间（秒）

返回示例

JSON数据格式

{
  "jingdong_im_pop_consult_avgwaittime_get_response":{
  "avgTime":""
  }
  }

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
ImPopConsultAvgwaittimeGetRequest request=new ImPopConsultAvgwaittimeGetRequest();
request.setWaiter( "jingdong" );
request.setDate( "2012-12-12 12:12:12" );
ImPopConsultAvgwaittimeGetResponse response=client.execute(request);

3. 查询客服评价详情

接口名称

jingdong.im.pop.evaluationlist.get

功能说明

查询客服评价详情

API用户授权类型

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
waiter	String[]	否		需要查询的客服账号列表，为空默认查询的是商家主账户
startTime	Date	是		需要查询数据的开始时间
endTime	Date	是		需要查询数据的截止时间，查询起止日期相差不能大于7天，查询的日期距现在不能大于3个月
page	Number	是		查询页数
pageSize	Number	是		每页记录数

返回结果：

名称	类型	示例值	描述
Evaluation	Evaluation[]		评价详情

Evaluation 属性

名称	类型	是否必须	示例值	描述
customer	String	否		咨询的顾客
waiter	String	否		客服账号
desc	String	否		评价语
score	Number	否		评价得分。 0 ：非常不满意； 25 ：不满意； 50 ：一般； 75 ：满意 100：非常满意
evaTime	Date	否		评价时间

返回示例

JSON数据格式

{
  "jingdong_im_pop_evaluationlist_get_response":{
  "Evaluation":[{
  "evaTime":"",
"desc":"",
"score":"",
"customer":"",
"waiter":""
  }]
  }
  }

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
ImPopEvaluationlistGetRequest request=new ImPopEvaluationlistGetRequest();
request.setWaiter( "jingdong,yanfa,pop" );
request.setStartTime( "2012-12-12 12:12:12" );
request.setEndTime( "2012-12-12 12:12:12" );
ImPopEvaluationlistGetResponse response=client.execute(request);

4. 客服日评价统计数据

接口名称

jingdong.im.pop.evaluationstat.get

功能说明

客服日评价统计

API用户授权类型

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
waiter	String[]	否		需要查询的客服账号列表，为空默认查询的是商家主账户
startTime	Date	是		需要查询数据的开始日期时间
endTime	Date	是		需要查询数据的截止日期时间，查询起止日期相差不能大于7天，查询的日期距现在不能大于3个月

返回结果：

名称	类型	示例值	描述
WaiterDailyEvaStat	WaiterDailyEvaStat[]		客服日评价统计数据

WaiterDailyEvaStat 属性

名称	类型	是否必须	示例值	描述
date	String	否		统计日期
waiter	String	否		客服账号
score	Number	否		评价得分 0 ：非常不满意 25 ：不满意 50 ：一般 75 ：满意 100：非常满意
count	Number	否		数量

返回示例

JSON数据格式

{
  "jingdong_im_pop_evaluationstat_get_response":{
  "WaiterDailyEvaStat":[{
  "count":"",
"score":"",
"date":"",
"waiter":""
  }]
  }
  }

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
ImPopEvaluationstatGetRequest request=new ImPopEvaluationstatGetRequest();
request.setWaiter( "jingdong,yanfa,pop" );
request.setStartTime( "2012-12-12 12:12:12" );
request.setEndTime( "2012-12-12 12:12:12" );
ImPopEvaluationstatGetResponse response=client.execute(request);

5. 查询客服登录日志

接口名称

jingdong.im.pop.passlog.get

功能说明

查询客服登录日志

API用户授权类型

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
waiter	String[]	否		需要查询的客服账号列表，为空默认查询的是商家主账户
startTime	Date	是		需要查询数据的开始时间
endTime	Date	是		需要查询数据的截止时间，查询起止日期相差不能大于7天，查询的日期距现在不能大于3个月
page	Number	是		查询页数
pageSize	Number	是		每页记录数

返回结果：

名称	类型	示例值	描述
PassLog	PassLog[]		登录日志类

PassLog 属性

名称	类型	是否必须	示例值	描述
waiter	String	否		客服账号
loginTime	Date	否		登录时间
logoutTime	Date	否		退出时间
ip	String	否		登录ip
loginSid	String	否		登录sid

返回示例

JSON数据格式

{
  "jingdong_im_pop_passlog_get_response":{
  "PassLog":[{
  "loginTime":"",
"loginSid":"",
"logoutTime":"",
"waiter":"",
"ip":""
  }]
  }
  }

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
ImPopPasslogGetRequest request=new ImPopPasslogGetRequest();
request.setWaiter( "jingdong,yanfa,pop" );
request.setStartTime( "2012-12-12 12:12:12" );
request.setEndTime( "2012-12-12 12:12:12" );
ImPopPasslogGetResponse response=client.execute(request);

6. 客服日接待量统计

接口名称

jingdong.im.pop.replystat.get

功能说明

客服日接待量统计

API用户授权类型

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
waiter	String[]	否		需要查询的客服账号列表，为空默认查询的是商家主账户
startTime	Date	是		需要查询数据的开始时间
endTime	Date	是		需要查询数据的截止时间，查询起止日期相差不能大于7天，查询的日期距现在不能大于3个月

返回结果：

名称	类型	示例值	描述
WaiterDailyStat	WaiterDailyStat[]		客服日接待量统计数据类

PassLog 属性

名称	类型	是否必须	示例值	描述
date	String	否		统计日期
waiter	String	否		客服账号
result	String	否		接待量

返回示例

JSON数据格式

{
  "jingdong_im_pop_replystat_get_response":{
  "WaiterDailyStat":[{
  "result":"",
"date":"",
"waiter":""
  }]
  }
  }

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
ImPopReplystatGetRequest request=new ImPopReplystatGetRequest();
request.setWaiter( "jingdong,yanfa,pop" );
request.setStartTime( "2012-12-12 12:12:12" );
request.setEndTime( "2012-12-12 12:12:12" );
ImPopReplystatGetResponse response=client.execute(request);

7. 获取会话列表

接口名称

jingdong.im.pop.sessionlist.get

功能说明

获取会话列表

API用户授权类型

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
waiter	String[]	否		需要查询的客服账号列表，为空默认查询的是商家主账户
startTime	Date	是		需要查询数据的开始时间
endTime	Date	是		需要查询数据的截止时间，查询的日期距现在不能大于3个月
page	Number	是		查询页数
pageSize	Number	是	30	每页记录数，取值：10,20,30,40,50

返回结果：

名称	类型	示例值	描述
totalRecord	Number
ChatSession	ChatSession[]		会话

ChatSession 属性

名称	类型	是否必须	示例值	描述
customer	String	否		咨询的顾客
waiter	String	否		客服账号
beginTime	Date	否		咨询开始时间
replyTime	Date	否		客服回复时间，如果未回复此时间为空
endTime	Date	否		会话结束时间，会话结束即会话断开连接时间。
sessionType	Number	否		会话类型 1：在线会话 2：留言
transfer	Boolean	否		是否转接 true: 转接 false：未转接
sid	String	否		会话ID。保留，暂不支持。
skuId	Number	否		顾客咨询的商品编号，为0表示无商品咨询。

返回示例

JSON数据格式

{
  "jingdong_im_pop_sessionlist_get_response":{
  "ChatSession":[{
  "sid":"",
"transfer":"",
"skuId":"",
"sessionType":"",
"beginTime":"",
"endTime":"",
"replyTime":"",
"customer":"",
"waiter":""
  }]
  }
  }

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
ImPopSessionlistGetRequest request=new ImPopSessionlistGetRequest();
request.setWaiter( "jingdong,yanfa,pop" );
request.setStartTime( "2012-12-12 12:12:12" );
request.setEndTime( "2012-12-12 12:12:12" );
ImPopSessionlistGetResponse response=client.execute(request);

8. 客服日未回复量统计

接口名称

jingdong.im.pop.unreplystat.get

功能说明

客服日未回复量统计

API用户授权类型

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
waiter	String[]	否		需要查询的客服账号列表，为空默认查询的是商家主账户
startTime	Date	是		需要查询数据的开始时间
endTime	Date	是		需要查询数据的截止时间，查询起止日期相差不能大于7天，查询的日期距现在不能大于3个月

返回结果：

名称	类型	示例值	描述
WaiterDailyStat	WaiterDailyStat[]		客服日未回复量统计类

WaiterDailyStat 属性

名称	类型	是否必须	示例值	描述
date	String	否		统计日期
waiter	String	否		客服账号
result	String	否		未回复量

返回示例

JSON数据格式

{
  "jingdong_im_pop_unreplystat_get_response":{
  "WaiterDailyStat":[{
  "result":"",
"date":"",
"waiter":""
  }]
  }
  }

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
ImPopUnreplystatGetRequest request=new ImPopUnreplystatGetRequest();
request.setWaiter( "jingdong,yanfa,pop" );
request.setStartTime( "2012-12-12 12:12:12" );
request.setEndTime( "2012-12-12 12:12:12" );
ImPopUnreplystatGetResponse response=client.execute(request);

9. 日累计在线时长

接口名称

jingdong.im.pop.waiter.onlinetime.stat.get

功能说明

日累计在线时长

API用户授权类型

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
waiter	String[]	否		需要查询的客服账号列表，为空默认查询的是商家主账户
startTime	Date	是		需要查询数据的开始时间
endTime	Date	是		需要查询数据的截止时间，查询起止日期相差不能大于7天，查询的日期距现在不能大于3个月

返回结果：

名称	类型	示例值	描述
WaiterDailyStat	WaiterDailyStat[]		客服日在线时长统计类

Waiter 属性：

名称	类型	是否必须	示例值	描述
date	String	否		统计日期
waiter	String	否		客服账号
result	String	否		在线时长，单位：秒

返回示例

JSON数据格式

{
  "jingdong_im_pop_waiter_onlinetime_stat_get_response":{
  "WaiterDailyStat":[{
  "result":"",
"date":"",
"waiter":""
  }]
  }
  }

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
ImPopWaiterOnlinetimeStatGetRequest request=new ImPopWaiterOnlinetimeStatGetRequest();
request.setWaiter( "jingdong,yanfa,pop" );
request.setStartTime( "2012-12-12 12:12:12" );
request.setEndTime( "2012-12-12 12:12:12" );
ImPopWaiterOnlinetimeStatGetResponse response=client.execute(request);

10. 聊天记录模糊查询

接口名称

jingdong.im.pop.chatlog.fuzzy.query

功能说明

聊天记录模糊查询

API用户授权类型

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
waiter	String	否		需要查询的客服账号，为空默认查询的是商家主账户
customer	String	是		要查询的顾客账号
keyWord	String	是		关键词
startTime	Date	是		需要查询数据的开始时间
endTime	Date	是		需要查询数据的截止时间，查询起止日期相差不能大于7天，查询的日期距现在不能大于3个月
page	Number	是		查询页数
pageSize	Number	是		每页记录数

返回结果：

名称	类型	示例值	描述
ChatLog	ChatLog[]		聊天记录

ChatLog 属性

名称	类型	是否必须	示例值	描述
customer	String	否		咨询的顾客
waiter	String	否		客服账号
content	String	否		聊天内容。
sid	String	否		会话ID。
skuId	Number	否		商品id
time	Date	否		消息发送时间
channel	Number	否		消息通道。
waiterSend	Boolean	否		是否是客服发送的

返回示例

JSON数据格式

{
  "jingdong_im_pop_chatlog_fuzzy_query_response":{
  "ChatLog":[{
  "content":"",
"waiterSend":"",
"sid":"",
"time":"",
"skuId":"",
"customer":"",
"channel":"",
"waiter":""
  }]
  }
  }

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
ImPopChatlogFuzzyQueryRequest request=new ImPopChatlogFuzzyQueryRequest();
request.setWaiter( "jingdong" );
request.setCustomer( "jingdong" );
request.setKeyWord( "jingdong" );
request.setStartTime( "2012-12-12 12:12:12" );
request.setEndTime( "2012-12-12 12:12:12" );
request.setPage( 123 );
request.setPageSize( 123 );
ImPopChatlogFuzzyQueryResponse response=client.execute(request);

11. 聊天记录查询

接口名称

jingdong.im.pop.chatlog.get

功能说明

聊天记录查询

API用户授权类型

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
waiter	String	否		需要查询的客服账号，为空默认查询的是商家主账户
customer	String	是		要查询的顾客账号
skuId	Number	否		查询的商品ID
startTime	Date	是	2013-12-29 00:00:00	需要查询数据的开始时间
endTime	Date	是	2013-12-30 00:00:00	需要查询数据的截止时间，查询起止日期相差不能大于7天，查询的日期距现在不能大于3个月
page	Number	是		查询页数
pageSize	Number	是		每页记录数

返回结果：

名称	类型	示例值	描述
ChatLog	ChatLog[]		聊天记录

ChatLog 属性

名称	类型	是否必须	示例值	描述
customer	String	否		咨询的顾客
waiter	String	否		客服账号
content	String	否		聊天内容。
sid	String	否		会话ID。
skuId	Number	否		商品id
time	Date	否		消息发送时间
channel	Number	否		消息通道。
waiterSend	Boolean	否		是否是客服发送的

返回示例

JSON数据格式

{
  "jingdong_im_pop_chatlog_get_response":{
  "ChatLog":[{
  "content":"",
"waiterSend":"",
"sid":"",
"time":"",
"skuId":"",
"customer":"",
"channel":"",
"waiter":""
  }]
  }
  }

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
ImPopChatlogGetRequest request=new ImPopChatlogGetRequest();
request.setWaiter( "jingdong" );
request.setCustomer( "jingdong" );
request.setSkuId( 123 );
request.setStartTime( "2012-12-12 12:12:12" );
request.setEndTime( "2012-12-12 12:12:12" );
request.setPage( 123 );
request.setPageSize( 123 );
ImPopChatlogGetResponse response=client.execute(request);

返回顶部

服务目录

公告栏

接入流程

开发指南

常用工具

业务流程

常见问题

面向买家服务

面向商家服务

京麦服务市场

供应商服务

京东云服务