文档中心 > API类目 > 友品海购API

qimen.alibaba.yiupin.community.robot.getrobotlist (自动发品机器人获取机器人列表接口)

自动发品机器人，获取机器人列表接口

公共参数

请求地址：

环境	HTTP请求地址
正式环境	http://qimen.api.taobao.com/router/qm
测试环境	http://qimen.api.taobao.com/router/qmtest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
customerId	String	是	WMS颁发给用户的ID
sign_method	String	是	签名的摘要算法，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。

请求参数

名称	类型	是否必须	示例值	描述
robotStatus	Number	可选	2	机器人运行状态(0：正常，1：异常,2：查全部)
pageNo	Number	必须	1	起始页
pageSize	Number	必须	10	每页条数
robotWxIds	String	可选	wxid_t3nq73kqdm7822,wxid_sncggtsztz5j22	机器人微信ID集合","分隔 null默认查全部

响应参数

名称	类型	示例值	描述
result	Object		返回结果
data Data 返回数据 robotInfoList RobotInfoList [] 机器人列表数据 └ robotWxNo String cat20212816 机器人微信号 └ robotWxId String wxid_80to0x6nzeio22 机器人微信ID └ robotWxName String 江江微信昵称 └ robotStatus Number 0 运行状态(0：正常，1：异常) └ todayAddFriendCount Number 15 今日添加好友数 └ todayEnterGroupCount Number 5 今日进群数 └ total Number 25 数据总数量 └ success Boolean true 是否成功 └ errorMessage String 返回数据成功描述 └ errorCode String 200 成功码

请求示例

{"robotStatus":2,"pageNo":1,"robotWxIds":"wxid_t3nq73kqdm7822,wxid_sncggtsztz5j22","pageSize":10}

响应示例

{
    "result":{
        "data":{
            "robotInfoList":[
                {
                        "robotWxNo":"cat20212816",
                        "robotWxId":"wxid_80to0x6nzeio22",
                        "robotWxName":"江江",
                        "robotStatus":0,
                        "todayAddFriendCount":15,
                        "todayEnterGroupCount":5
                }
            ],
            "total":25
        },
        "success":true,
        "errorMessage":"返回数据成功",
        "errorCode":"200"
    }
}

验签示例

{"result":{"success":"不等于true","errorMessage":"Illegal request","errorCode":"sign-check-failure"}}

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部

开放平台

友品海购API

qimen.alibaba.yiupin.community.robot.getrobotlist (自动发品机器人获取机器人列表接口)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ