inquirySubuser

POST: /amsin/api/v1/business/user/inquirySubuser

需要签名验签

集成商可使用此接口获取万里汇主账号和子账号的信息。

接口结构

万里汇接口报文结构包括:请求头,请求体、响应体。

请求头

字段名

是否必传

范例

说明

Client-Id

Client-Id: *****

关于这些参数的解释说明,详见:请求头

Signature

Signature: algorithm=RSA256, keyVersion=2, signature=*****

Content-Type

Content-Type: application/json; charset=UTF-8

Request-Time

Request-Time: 2019-04-04T12:08:56+08:00

Access-Token

否(有条件要求)

Access-Token: ******

注意此字段

当用 OAUTH 授权时需要传递

请求参数

字段名

数据类型

是否必填

描述

pageSize

整数

每页包含的条目数。

pageNumber

整数

当前页码。

格式:1、2、3......

响应参数

字段名

数据类型

是否必填

描述

result

Result

代表接口调用的结果。

说明:以下字段,只有当 result.resultStatusS 时才会按需返回。

primaryUserInformation

User对象

主账号相关信息。

userInformations

列表<User>对象

子账户相关信息。

totalCount

整数

本次查询结果的总条目数。

更多信息:

  • 最大值:8

totalPageNumber

整数

查询结果的总页数。

更多信息:

  • 最大值:8

currentPageNumber

整数

当前页码。

更多信息:

  • 最大值:8

响应处理

集成商调用接口后,万里汇返回集成商API调用结果。result.resultStatus字段取值范围为:

result.resultStatus

描述

S

API请求成功。

F

API请求失败。

失败原因参见结果码(即result.resultCoderesult.resultMessage

U

API响应结果为UNKNOWN(未知)时,需重试API请求。

重试策略:

  • 重试次数上限:7次
  • 重试时间间隔:5分钟、10分钟、20分钟、40分钟、80分钟、160分钟、320分钟

如果问题依旧,请联系万里汇技术支持。

错误码

result.resultCode

resultCode

resultStatus

resultMessage

处理建议

SUCCESS

S

Success

PROCESS_FAIL

F

A general business failure occurred. Do not retry.

需要人工介入,联系万里汇技术支持以解决此问题

PARAM_ILLEGAL

F

Illegal parameters exist. For example, a non-numeric input, or an invalid date.

参考API文档页面,确认请求头和传参是否正确

KEY_NOT_FOUND

F

The key is not found.

联系万里汇技术支持以解决此问题。

ACCESS_DENIED

F

The access is denied.

联系万里汇技术支持以解决此问题。

REQUEST_TRAFFIC_EXCEED_LIMIT

U

The request traffic exceeds the limit.

重试,若问题依旧,联系万里汇技术支持

INVALID_API

F

The called API is invalid or not active.

确认是否调用正确的API

INVALID_CLIENT

F

The client is invalid.

Client ID不存在或无效

INVALID_SIGNATURE

F

The signature is invalid.

确认请求正确加签

METHOD_NOT_SUPPORTED

F

The server does not implement the requested HTTP method.

确认HTTP请求方法为POST

UNKNOWN_EXCEPTION

U

API failed due to unknown reason.

服务器错误,若稍后重试问题依旧,联系万里汇技术支持以解决问题

UN_SUPPORT_BUSINESS

F

Unsupported business.

使用正确的参数重试

ACCESS_TOKEN_EXPIRED

F

The access token has expired.

刷新token接口以重新获取访问令牌(access token),或联系万里汇技术支持以解决问题

INVALID_ACCESS_TOKEN

F

Invalid access token

请使用正确的访问令牌(access token)

USER_ACCOUNT_NOT_PRIMARY

F

The use account is not primary.

请使用主账号来查询接口

AUTHORIZATION_NOT_EXIST

F

OAUTH does not exist.

当前token授权关系不存在,请联系万里汇技术支持检查token授权关系

示例代码

请求体

copy
{
  "pageSize":10,
  "pageNumber":1
}

响应体

copy
{
    "currentPageNumber": 1,
    "result": {
        "resultCode": "SUCCESS",
        "resultMessage": "success.",
        "resultStatus": "S"
    },
    "totalCount": 14,
    "totalPageNumber": 2,
    "primaryUserInformation": {
      "logonId": "86-188******18",
      "userId": "21202200214*****",
      "userName": {
          "fullName": "*****"
      }
    },
    "userInformations": [
        {
            "logonId": "86-188******18",
            "userId": "21202200214*****",
            "userNickName": {
                "fullName": "*****"
            }
        },
        {
            "logonId": "86-155******15",
            "userId": "21201200666*****",
            "userNickName": {
                "fullName": "test_bind_subaccount"
            }
        },
        {
            "logonId": "86-188******02",
            "userId": "21202200180*****",
            "userNickName": {
                "fullName": "*****"
            }
        },
        {
            "logonId": "852-102******67",
            "userId": "21201200575*****",
            "userNickName": {
                "fullName": "*****"
            }
        },
        {
            "logonId": "86-163******82",
            "userId": "21202200103*****",
            "userNickName": {
                "fullName": "*****"
            }
        },
        {
            "logonId": "852-177******31",
            "userId": "21201200109*****",
            "userNickName": {
                "fullName": "*****"
            }
        },
        {
            "logonId": "852-172******39",
            "userId": "21201200109*****",
            "userNickName": {
                "fullName": "*****"
            }
        },
        {
            "logonId": "86-183******34",
            "userId": "21202200254*****",
            "userNickName": {
                "fullName": "*****"
            }
        },
        {
            "logonId": "852-151***80",
            "userId": "2120220023*****",
            "userNickName": {
                "fullName": "*****"
            }
        },
        {
            "logonId": "86-188******17",
            "userId": "21202200195*****",
            "userNickName": {
                "fullName": "*****"
            }
        }
    ]
}

@2024 WorldFirst