开放服务-API列表

热词搜索：订单API 接口查询退款订单 6五四三二一 appkey

suning.cloudinfo.custinstatus.query 客服在线状态查询

￥基础

通过此接口查询客服在线状态。

公共参数

名称	类型	是否必须	示例值	描述
appMethod	String	Y	suning.custom.category.query	方法名
appRequestTime	String	Y	2012-04-25 20:23:30	时间戳，格式为yyyy-MM-dd HH:mm:ss，例如：2012-04-25 20:23:30。API服务端允许客户端请求时间误差为10分钟。
format	String	N	XML	默认xml,可指定格式为xml,json
appKey	String	Y	b0c332a133c102765f39de**********	分配给应用的访问令牌
versionNo	String	Y	v1.2	API的版本，目前为v1.2版本
signInfo	String	Y	460d7ff15b073e463125b4**********	appSecret,appMethod ,appRequestTime, appKey, versionNo, 请求报文base64加密后的数据顺序MD5(32位小写)，其中appSecret为appKey对应的密钥
access_token	String	N	a1c5c62b08df3a3cbf7efd**********	采用OAuth授权方式为必填参数

请求参数

名称	类型	是否必须	示例值	描述
loginName	String	Y	Kefu1@163.com	客服账号
pageNo	String	N	1	页码
pageSize	String	N	10	每页条数
searchTime	String	Y	2016-11-26	查询时间，格式：yyyy-MM-dd，以天为维度，查询当天所有明细

响应参数

名称	类型	示例值	描述
deviceType	String	2	设备类型。2：PC坐席；3：移动端坐席
inStatusTime	String	2016-11-27 08:01:01	进入状态时间
loginName	String	Kefu1@163.com	客服账号，客服登录云信的账号
rowId	String	1	记录ID
statusType	String	1	坐席状态。1：在线；2：忙碌；3：离开；4：离线

请求示例

XML示例
JSON示例

复制全部代码

                                <sn_request>
  <sn_body>
    <queryCustInStatus>
      <pageNo>1</pageNo>
      <pageSize>10</pageSize>
      <searchTime>2016-11-26</searchTime>
      <loginName>Kefu1@163.com</loginName>
    </queryCustInStatus>
  </sn_body>
</sn_request>

                                {
  "sn_request": {
    "sn_body": {
      "queryCustInStatus": {
        "pageNo": "1",
        "pageSize": "10",
        "searchTime": "2016-11-26",
        "loginName": "Kefu1@163.com"
      }
    }
  }
}

响应示例

XML示例
JSON示例

复制全部代码

                              <sn_responseContent>
  <sn_body>
    <queryCustInStatus>
      <statusType>1</statusType>
      <deviceType>2</deviceType>
      <rowId>1</rowId>
      <inStatusTime>2016-11-27 08:01:01</inStatusTime>
      <loginName>Kefu1@163.com</loginName>
    </queryCustInStatus>
  </sn_body>
  <sn_head>
    <pageTotal>1</pageTotal>
    <pageNo>1</pageNo>
    <totalSize>1</totalSize>
    <returnMessage>biz.handler.data-get:success</returnMessage>
  </sn_head>
</sn_responseContent>

                              {
  "sn_responseContent": {
    "sn_head": {
      "pageTotal": "1",
      "pageNo": "1",
      "totalSize": "1",
      "returnMessage": "biz.handler.data-get:success"
    },
    "sn_body": {
      "queryCustInStatus": [
        {
          "deviceType": "2",
          "statusType": "1",
          "rowId": "1",
          "inStatusTime": "2016-11-27 08:01:01",
          "loginName": "Kefu1@163.com"
        }
      ]
    }
  }
}

异常示例

XML示例
JSON示例

复制全部代码


  
  	API异常码
  	异常码中文描述

{
  "sn_responseContent": {
    "sn_error": {
      "error_code": "API异常码",
      "error_msg": "异常码中文描述"
    }
  }
}

业务异常码

异常码	错误描述	解决方案
biz.handler.data-get:no-result	查询没结果	请检查查询参数
biz.cloudinfo.querycustinstatus.missing-parameter:*	缺少必填参数,*表示字段名	请输入正确参数。
biz.cloudinfo.querycustinstatus.format-error:*	格式错误,*表示字段名	请输入正确参数。
isp.sys.service.unavailable.osdrp	服务不可用（系统异常）	请联系苏宁技术人员。
biz.cloudinfo.querycustinstatus.invalid-biz:100	查询无结果	请输入正确参数。
biz.cloudinfo.querycustinstatus.invalid-biz:101	全量数据获取尚未完成	请稍后调用API接口。

公共异常码

异常码	错误描述	解决方案
sys.oauth.check.access_token:inexistence	访问令牌过期或未进行授权	请重新授权或使用刷新令牌刷新新的访问令牌
sys.oauth.check.access_token:overdue	访问令牌已过期	请使用刷新令牌刷新
sys.check.api-permission:inexistence	Api方法不存在	请参考帮助中心
sys.check.api-permission:overdue	Api方法已过期	请参考帮助中心
sys.check.api-permission:authority	无权操作此api	确认是否有访问该方法权限
sys.auth.vendor-request:errory	无权操作此供应商	请确认供应商编码是否正确
sys.controller.api-request:limit	Api请求受控	超过请求次数
sys.check.app-time:error	请求参数错误api请求时间误差大	参考帮助中心
sys.check.request-params:error	请求报文结构错误	参考帮助中心、日期格式等
sys.check.starttime-format:error	请求开始时间错误	参考帮助中心、日期格式等
biz.handler.data-get:success	业务数据查询成功	无
biz.handler.data-get:fail	业务数据查询失败	检查请求条件
biz.handler.data-get:no-result	业务数据结果为空	无
sys.check.pageno-format:error	pageNo格式错误，只允许1到99999之间的整数	检查pageNo输入是否有误
sys.check.pagesize-format:error	pageSize格式错误，只允许1到50之间的整数(订单相关是1到100)	检查pageSize输入是否有误
sys.check.page-param:error	pageNo或者pageSize不在要求范围内，pageNo只允许1到99999之间的整数，pageSize只允许1到50之间的整数(订单相关是1到100)	检查pageNo和pageSize输入是否有误
sys.check.miss-time:starttime	不存在开始时间(节点)	检查输入
sys.check.miss-time:endtime	不存在结束时间(节点)	检查输入
sys.check.starttime-value:null	开始时间为空(值)	检查输入
sys.check.endtime-value:null	结束时间为空(值)	检查输入
sys.check.starttime-format:error	校验开始时间不合法，格式yyyy-MM-dd HH:mm:ss	检查时间格式
sys.check.endtime-format:error	校验结束时间不合法，格式yyyy-MM-dd HH:mm:ss	检查时间格式
sys.check.query-time:error	开始时间是否小于结束时间	检查开始和结束时间大小
sys.check.query-time:outofrange	时间查询是否超出指定范围	检查时间范围
sys.check.app-sign:null	签名信息为空	检查签名信息
sys.check.app-sign:error	签名信息错误	检查签名信息
sys.check.missing-parameter:apiversion	API版本号未指定	检查API版本号
sys.check.missing-parameter:appRequestTime	请求时间丢失	检查请求时间
sys.check.missing-nestElement:sn_body	缺少sn_body节点	检查sn_body是否存在
sys.check.user-permission:inexistence	用户key不存在	检查用户key是否存在
biz.handler.batch-handler:no-support	非查询类API不支持批量操作	检查API类型
biz.handler.request-message:error	查询类API输入多个业务节点	检查业务节点
sys.check.header-param:null	header参数为空	请检查header参数
sys.controller.api-access:limit	访问限制	无
sys.controller.api-frequency:limit	访问频率限制	无
sys.error.network:failure	网络异常	无
sys.error.network-status:?	响应失败 ?为状态码	无
sys.check.app-ip:illegal	请求的客户端IP地址非法，与设置的应用IP白名单信息不符	应用白名单设置增加客户端ip
sys.controller.frequency-limit:004	内部系统超频拦截	无
sys.error.http.network-status:?	内部http请求响应异常码	根据异常码判断响应异常原因
sys.check.snunionid.length.is.not:48	混淆会员编码长度不是48位	使用转换器转换混淆会员编码规定要求混淆会员编码48位

API工具

API TOOLS 在线测试工具异常码查询工具 SDK调用示例 SDK下载

FAQ

云信业务