{
  "name": "partners",
  "display_name": "渠道合作伙伴",
  "description": "介绍如何使用API对渠道合作伙伴进行操作，包括业务信息、客户操作、订单操作等。",
  "domain": "other",
  "api_version": "2018-03-21",
  "endpoint": "partners.tencentcloudapi.com",
  "actions": [
    {
      "name": "AgentPayDeals",
      "description": "代理商支付订单接口，支持自付/代付",
      "status": "online",
      "parameters": [
        {
          "name": "OwnerUin",
          "type": "string",
          "required": true,
          "description": "订单所有者uin",
          "example": "100000032030"
        },
        {
          "name": "AgentPay",
          "type": "integer",
          "required": true,
          "description": "代付标志，1：代付；0：自付",
          "example": "1"
        },
        {
          "name": "DealNames",
          "type": "array",
          "required": true,
          "description": "订单号数组",
          "example": "[\"20180204123456\\n\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "OwnerUin",
        "AgentPay",
        "DealNames"
      ]
    },
    {
      "name": "AgentTransferMoney",
      "description": "为合作伙伴提供转账给客户能力。仅支持合作伙伴为自己名下客户转账。",
      "status": "online",
      "parameters": [
        {
          "name": "ClientUin",
          "type": "string",
          "required": true,
          "description": "客户账号ID",
          "example": "125****938"
        },
        {
          "name": "Amount",
          "type": "integer",
          "required": true,
          "description": "转账金额，单位分",
          "example": "100"
        }
      ],
      "required": [
        "ClientUin",
        "Amount"
      ]
    },
    {
      "name": "AssignClientsToSales",
      "description": "为代客or申请中代客分派跟进人（业务员），入参可从以下API获取 - 代客列表获取API： [DescribeAgentAuditedClients](https://cloud.tencent.com/document/product/563/19184) - 申请中代客列表获取API：[DescribeAgentClients](https://cloud.tencent.com/document/product/563/16046) - 业务员列表获取API：[DescribeSalesmans](https://cloud.tencent.com/document/product/563/35196)",
      "status": "online",
      "parameters": [
        {
          "name": "ClientUins",
          "type": "array",
          "required": true,
          "description": "代客/申请中代客uin列表，最大50条",
          "example": "[\"12345\",\"12346\"]",
          "item_type": "string"
        },
        {
          "name": "SalesUin",
          "type": "string",
          "required": true,
          "description": "业务员uin",
          "example": "12347"
        },
        {
          "name": "AssignClientStatus",
          "type": "string",
          "required": true,
          "description": "代客类型:normal-代客 apply-申请中代客",
          "example": "normal"
        },
        {
          "name": "AssignActionType",
          "type": "string",
          "required": true,
          "description": "操作类型:assign-执行分派 cancel-取消分派",
          "example": "assign"
        }
      ],
      "required": [
        "ClientUins",
        "SalesUin",
        "AssignClientStatus",
        "AssignActionType"
      ]
    },
    {
      "name": "AuditApplyClient",
      "description": "代理商可以审核其名下申请中代客",
      "status": "online",
      "parameters": [
        {
          "name": "ClientUin",
          "type": "string",
          "required": true,
          "description": "待审核客户账号ID",
          "example": "2000002"
        },
        {
          "name": "AuditResult",
          "type": "string",
          "required": true,
          "description": "审核结果，可能的取值：accept/reject",
          "example": "accept"
        },
        {
          "name": "Note",
          "type": "string",
          "required": true,
          "description": "申请理由，B类客户审核通过时必须填写申请理由",
          "example": "reason"
        }
      ],
      "required": [
        "ClientUin",
        "AuditResult",
        "Note"
      ]
    },
    {
      "name": "CreatePayRelationForClient",
      "description": "合作伙伴为客户创建强代付关系",
      "status": "online",
      "parameters": [
        {
          "name": "ClientUin",
          "type": "string",
          "required": true,
          "description": "客户账号ID",
          "example": "100000032030"
        }
      ],
      "required": [
        "ClientUin"
      ]
    },
    {
      "name": "DescribeAgentAuditedClients",
      "description": "查询已审核客户列表",
      "status": "online",
      "parameters": [
        {
          "name": "ClientUin",
          "type": "string",
          "required": false,
          "description": "客户账号ID",
          "example": "10000"
        },
        {
          "name": "ClientName",
          "type": "string",
          "required": false,
          "description": "客户名称。由于涉及隐私，名称打码显示，故名称仅支持打码后的模糊搜索",
          "example": "腾讯"
        },
        {
          "name": "ClientFlag",
          "type": "string",
          "required": false,
          "description": "客户类型，a/b，类型定义参考代理商相关政策文档",
          "example": "b"
        },
        {
          "name": "OrderDirection",
          "type": "string",
          "required": false,
          "description": "ASC/DESC， 不区分大小写，按审核通过时间排序",
          "example": "DESC"
        },
        {
          "name": "ClientUins",
          "type": "array",
          "required": false,
          "description": "客户账号ID列表",
          "example": "[\"1000021\", \"10000022\"]",
          "item_type": "string"
        },
        {
          "name": "HasOverdueBill",
          "type": "integer",
          "required": false,
          "description": "是否欠费。0：不欠费；1：欠费",
          "example": "1"
        },
        {
          "name": "ClientRemark",
          "type": "string",
          "required": false,
          "description": "客户备注",
          "example": "腾讯"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "*偏移量 【请保持必传】",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "*限制数目 【请保持必传】最大2000",
          "example": "10"
        },
        {
          "name": "ClientType",
          "type": "string",
          "required": false,
          "description": "可以为new(自拓)/assign(指派)/old(官网)/direct(直销)/direct_newopp(直销(新商机))/空",
          "example": "old"
        },
        {
          "name": "ProjectType",
          "type": "string",
          "required": false,
          "description": "项目类型：可以为self(自拓项目)/platform(合作项目)/repeat(复算项目 )/空",
          "example": "self"
        },
        {
          "name": "SalesUin",
          "type": "string",
          "required": false,
          "description": "业务员ID",
          "example": "10002"
        },
        {
          "name": "SalesName",
          "type": "string",
          "required": false,
          "description": "业务员姓名（模糊查询）",
          "example": "腾讯"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeAgentBills",
      "description": "代理商可查询自己及名下代客所有业务明细",
      "status": "online",
      "parameters": [
        {
          "name": "SettleMonth",
          "type": "string",
          "required": true,
          "description": "支付月份，如2018-02",
          "example": "2018-02"
        },
        {
          "name": "ClientUin",
          "type": "string",
          "required": false,
          "description": "客户账号ID",
          "example": "2000002"
        },
        {
          "name": "PayMode",
          "type": "string",
          "required": false,
          "description": "支付方式，prepay/postpay",
          "example": "prepay"
        },
        {
          "name": "OrderId",
          "type": "string",
          "required": false,
          "description": "预付费订单号",
          "example": "202400000122223"
        },
        {
          "name": "ClientRemark",
          "type": "string",
          "required": false,
          "description": "客户备注名称",
          "example": "客户备注名称"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "限制数目",
          "example": "3"
        }
      ],
      "required": [
        "SettleMonth"
      ]
    },
    {
      "name": "DescribeAgentClientGrade",
      "description": "传入代客uin，查客户级别，客户审核状态，客户实名认证状态",
      "status": "online",
      "parameters": [
        {
          "name": "ClientUin",
          "type": "string",
          "required": true,
          "description": "代客uin",
          "example": "1000002"
        }
      ],
      "required": [
        "ClientUin"
      ]
    },
    {
      "name": "DescribeAgentClients",
      "description": "代理商可查询自己名下待审核客户列表",
      "status": "online",
      "parameters": [
        {
          "name": "ClientUin",
          "type": "string",
          "required": false,
          "description": "客户账号ID",
          "example": "200002"
        },
        {
          "name": "ClientName",
          "type": "string",
          "required": false,
          "description": "客户名称。由于涉及隐私，名称打码显示，故名称仅支持打码后的模糊搜索",
          "example": "t**est"
        },
        {
          "name": "ClientFlag",
          "type": "string",
          "required": false,
          "description": "客户类型，a/b，类型定义参考代理商相关政策文档",
          "example": "b"
        },
        {
          "name": "OrderDirection",
          "type": "string",
          "required": false,
          "description": "ASC/DESC， 不区分大小写，按申请时间排序",
          "example": "DESC"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "限制数目",
          "example": "1"
        },
        {
          "name": "SalesUin",
          "type": "string",
          "required": false,
          "description": "业务员ID",
          "example": "1000002"
        },
        {
          "name": "SalesName",
          "type": "string",
          "required": false,
          "description": "业务员姓名（模糊查询）",
          "example": "testSales"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeAgentDealsByCache",
      "description": "供代理商拉取全量预付费普通客户订单 （对应控制台：客户订单-预付费-普通订单）",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "限制数目 最大200",
          "example": "10"
        },
        {
          "name": "CreatTimeRangeStart",
          "type": "string",
          "required": false,
          "description": "下单时间范围起始点【*请必传并控制时间范围最大90天，避免出现超时】",
          "example": "2020-01-01 00:00:00"
        },
        {
          "name": "CreatTimeRangeEnd",
          "type": "string",
          "required": false,
          "description": "下单时间范围终止点【*请必传并控制时间范围最大90天，避免出现超时】",
          "example": "2020-01-01 00:00:00"
        },
        {
          "name": "Order",
          "type": "integer",
          "required": false,
          "description": "0:下单时间降序；其他：下单时间升序",
          "example": "0"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": false,
          "description": "子订单状态(1-待支付,2-已支付,3-发货中,4-已发货,5-发货失败,6-已退款,7-已取消,8-已过期,9-已失效,12-支付中,13-退款中,30-处理中)控制台订单状态为以上状态的组合：未支付(1) 处理中(2,3,5,12,13,30) 已取消(7) 交易成功(4) 已过期(8) 已退款(6) 订单错误(9)",
          "example": "1"
        },
        {
          "name": "OwnerUins",
          "type": "array",
          "required": false,
          "description": "下单人账号ID列表",
          "example": "[\"100001\"]",
          "item_type": "string"
        },
        {
          "name": "DealNames",
          "type": "array",
          "required": false,
          "description": "子订单号列表",
          "example": "[\"20250630941003020261651\", \"20250528341002900634981\"]",
          "item_type": "string"
        },
        {
          "name": "BigDealIds",
          "type": "array",
          "required": false,
          "description": "大订单号列表",
          "example": "[\"20250630941003020261641\", \"20250528341002900634971\"]",
          "item_type": "string"
        },
        {
          "name": "PayerMode",
          "type": "integer",
          "required": false,
          "description": "支付方式，0：自付；1：代付",
          "example": "0"
        }
      ],
      "required": [
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "DescribeAgentDealsPriceDetailByDealName",
      "description": "供代理商使用名下有效普通代客的预付费子订单号查询订单费用详情",
      "status": "online",
      "parameters": [
        {
          "name": "DealCreatYear",
          "type": "integer",
          "required": true,
          "description": "下单年份（订单创建时间归属年份）",
          "example": "2025"
        },
        {
          "name": "DealNames",
          "type": "array",
          "required": true,
          "description": "子订单号，每个请求最多查询100条",
          "example": "[\"20250411030002711111111\", \"20250411030002722222222\"]",
          "item_type": "string"
        },
        {
          "name": "OwnerUin",
          "type": "string",
          "required": false,
          "description": "订单归属代客uin",
          "example": "100001"
        }
      ],
      "required": [
        "DealCreatYear",
        "DealNames"
      ]
    },
    {
      "name": "DescribeAgentPayDealsV2",
      "description": "查询最近15天内的代理商代付订单",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "限制数目 最大100",
          "example": "10"
        },
        {
          "name": "CreatTimeRangeStart",
          "type": "string",
          "required": false,
          "description": "下单时间范围起始点(不传时会默认查最近15天内订单，传值时需要传最近15天内的起始时间)",
          "example": "2020-01-01 00:00:00"
        },
        {
          "name": "CreatTimeRangeEnd",
          "type": "string",
          "required": false,
          "description": "下单时间范围终止点",
          "example": "2020-01-01 00:00:00"
        },
        {
          "name": "Order",
          "type": "integer",
          "required": false,
          "description": "0:下单时间降序；其他：下单时间升序",
          "example": "0"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": false,
          "description": "订单的状态(1：未支付;2：已支付;3：发货中;4：已发货;5：发货失败;6：已退款;7：已关单;8：订单过期;9：订单已失效;10：产品已失效;11：代付拒绝;12：支付中)",
          "example": "2"
        },
        {
          "name": "OwnerUins",
          "type": "array",
          "required": false,
          "description": "下单人账号ID列表",
          "example": "[\"100001\",\"100002\"]",
          "item_type": "string"
        },
        {
          "name": "DealNames",
          "type": "array",
          "required": false,
          "description": "子订单号列表",
          "example": "[\"2020101030303\"]",
          "item_type": "string"
        },
        {
          "name": "BigDealIds",
          "type": "array",
          "required": false,
          "description": "大订单号列表",
          "example": "[\"2020101030303\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "DescribeAgentRelateBigDealIds",
      "description": "根据大订单号查询关联申请合并支付的其他订单号",
      "status": "online",
      "parameters": [
        {
          "name": "BigDealId",
          "type": "string",
          "required": true,
          "description": "大订单号",
          "example": "20241012848002188543031"
        }
      ],
      "required": [
        "BigDealId"
      ]
    },
    {
      "name": "DescribeAgentSelfPayDealsV2",
      "description": "查询代理商名下指定代客最近15天内的自付订单（预付费）",
      "status": "online",
      "parameters": [
        {
          "name": "OwnerUin",
          "type": "string",
          "required": true,
          "description": "下单人账号ID",
          "example": "1000001"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "限制数目 最大100",
          "example": "1"
        },
        {
          "name": "CreatTimeRangeStart",
          "type": "string",
          "required": false,
          "description": "下单时间范围起始点(不传时会默认查最近15天内订单，传值时需要传最近15天内的起始时间)",
          "example": "2020-01-01 00:00:00"
        },
        {
          "name": "CreatTimeRangeEnd",
          "type": "string",
          "required": false,
          "description": "下单时间范围终止点",
          "example": "2020-01-01 00:00:00"
        },
        {
          "name": "Order",
          "type": "integer",
          "required": false,
          "description": "0:下单时间降序；其他：下单时间升序",
          "example": "0"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": false,
          "description": "订单的状态(1：未支付;2：已支付;3：发货中;4：已发货;5：发货失败;6：已退款;7：已关单;8：订单过期;9：订单已失效;10：产品已失效;11：代付拒绝;12：支付中)",
          "example": "2"
        },
        {
          "name": "DealNames",
          "type": "array",
          "required": false,
          "description": "子订单号列表",
          "example": "[\"2022030303010\"]",
          "item_type": "string"
        },
        {
          "name": "BigDealIds",
          "type": "array",
          "required": false,
          "description": "大订单号列表",
          "example": "[\"2022030303010\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "OwnerUin",
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "DescribeClientBalanceNew",
      "description": "为合作伙伴提供查询客户余额能力。调用者必须是合作伙伴，只能查询自己名下客户余额",
      "status": "online",
      "parameters": [
        {
          "name": "ClientUin",
          "type": "string",
          "required": true,
          "description": "客户(代客)账号ID",
          "example": "125****938"
        }
      ],
      "required": [
        "ClientUin"
      ]
    },
    {
      "name": "DescribeClientJoinIncreaseList",
      "description": "查询合作伙伴名下客户的参与增量激励考核信息列表",
      "status": "online",
      "parameters": [
        {
          "name": "ClientUins",
          "type": "array",
          "required": true,
          "description": "客户UIN列表",
          "example": "{\"1000000\",\"1000001\"}",
          "item_type": "string"
        }
      ],
      "required": [
        "ClientUins"
      ]
    },
    {
      "name": "DescribeClientSwitchTraTaskInfo",
      "description": "查询客户的交易类型切换任务的信息，查询成功则获取当前用户的切换链接，查询失败则返回失败的原因",
      "status": "online",
      "parameters": [
        {
          "name": "ClientUin",
          "type": "string",
          "required": true,
          "description": "代客UIN",
          "example": "10000001"
        },
        {
          "name": "SwitchType",
          "type": "integer",
          "required": true,
          "description": "1：代理，2：代采",
          "example": "1"
        }
      ],
      "required": [
        "ClientUin",
        "SwitchType"
      ]
    },
    {
      "name": "DescribeRebateInfos",
      "description": "【该接口已下线，请切换使用升级版本DescribeRebateInfosNew】代理商可查询自己名下全部返佣信息",
      "status": "online",
      "parameters": [
        {
          "name": "RebateMonth",
          "type": "string",
          "required": false,
          "description": "返佣月份，如2018-02",
          "example": "2018-02"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "限制数目",
          "example": "1"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeRebateInfosNew",
      "description": "代理商可查询自己名下全部返佣信息",
      "status": "online",
      "parameters": [
        {
          "name": "RebateMonth",
          "type": "string",
          "required": false,
          "description": "返佣月份，如2018-02",
          "example": "2018-02"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "限制数目",
          "example": "1"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeSalesmans",
      "description": "代理商查询名下业务员列表信息",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "限制数目",
          "example": "1"
        },
        {
          "name": "SalesName",
          "type": "string",
          "required": false,
          "description": "业务员姓名(模糊查询)",
          "example": "测试业务员"
        },
        {
          "name": "SalesUin",
          "type": "string",
          "required": false,
          "description": "业务员ID",
          "example": "100002"
        },
        {
          "name": "OrderDirection",
          "type": "string",
          "required": false,
          "description": "ASC/DESC， 不区分大小写，按创建通过时间排序",
          "example": "DESC"
        }
      ],
      "required": [
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "DescribeUnbindClientList",
      "description": "代理商名下客户解绑记录查询接口",
      "status": "online",
      "parameters": [
        {
          "name": "Status",
          "type": "integer",
          "required": true,
          "description": "解绑状态：0:所有,1:审核中,2已解绑",
          "example": "1"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量",
          "example": "1"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "限制数目",
          "example": "1"
        },
        {
          "name": "UnbindUin",
          "type": "string",
          "required": false,
          "description": "解绑账号ID",
          "example": "1000002"
        },
        {
          "name": "ApplyTimeStart",
          "type": "string",
          "required": false,
          "description": "解绑申请时间范围起始点",
          "example": "2020-09-22"
        },
        {
          "name": "ApplyTimeEnd",
          "type": "string",
          "required": false,
          "description": "解绑申请时间范围终止点",
          "example": "2020-09-22"
        },
        {
          "name": "OrderDirection",
          "type": "string",
          "required": false,
          "description": "对申请时间的升序降序，值：asc，desc",
          "example": "desc"
        }
      ],
      "required": [
        "Status",
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "ModifyClientRemark",
      "description": "代理商可以对名下客户添加备注、修改备注",
      "status": "online",
      "parameters": [
        {
          "name": "ClientRemark",
          "type": "string",
          "required": true,
          "description": "客户备注名称",
          "example": "testName"
        },
        {
          "name": "ClientUin",
          "type": "string",
          "required": true,
          "description": "客户账号ID",
          "example": "100002"
        }
      ],
      "required": [
        "ClientRemark",
        "ClientUin"
      ]
    },
    {
      "name": "RemovePayRelationForClient",
      "description": "合作伙伴为客户消除强代付关系",
      "status": "online",
      "parameters": [
        {
          "name": "ClientUin",
          "type": "string",
          "required": true,
          "description": "客户账号ID",
          "example": "1000002"
        }
      ],
      "required": [
        "ClientUin"
      ]
    }
  ]
}