Agent Management

Add an Agent

• Type

  API

• URI

  /se-api/user/add

• Request Method

  POST、Content-Type: application/json

• API Description

  Add an agent

• Request Parameter Description

Field	Type	Required	Remarks
username	String	Yes	Agent name
nickname	String	Yes	Nickname
password	String	Yes	Password (plain text)

Request example:

{
  "username": "shun",
  "nickname": "shun123",
  "password": "1234567"
}

• Response Parameter Description

  Parameter Name	Type	Required	Remarks
  code	int	Yes	Status code
  message	String	Yes	Description
  data	String	Yes

{
  "code": 200,
  "message": "success",
  "data": null
}

Delete Agent by Name

• Type

  API

• URI

  /se-api/user/del

• Request Method

  POST、Content-Type: application/json

• API Description

  Delete an agent by name

• Request Parameter Description

Field	Type	Required	Remarks
username	String	Yes	Agent name

Request example:

{
  "username": "shun"
}

• Response Parameter Description

  Parameter Name	Type	Required	Remarks
  code	int	Yes	Status code
  message	String	Yes	Description
  data	String	Yes

{
  "code": 200,
  "message": "success",
  "data": null
}

Query Agent Information

• Type

  API

• URI

  /se-api/user/query

• Request Method

  POST、Content-Type: application/json

• API Description

  Query agent information

• Request Parameter Description

Field	Type	Required	Remarks
username	String	Yes	Agent name

Request example:

{
  "username": "shun"
}

• Response Parameter Description

  Parameter Name	Type	Required	Remarks
  code	int	Yes	Status code
  message	String	Yes	Description
  data	String	Yes	Agent information

• Agent information

  Parameter Name	Type	Remarks
  mainUserId	int	Main account id
  tenantId	int	Company id
  username	String	Agent name (account)
  userId	int	Agent id
  nickname	String	Nickname
  guid	String	guid

{
  "code": 200,
  "message": "success",
  "data": {
    "mainUserId": 621443,
    "tenantId": 520274,
    "username": "202510161",
    "nickname": "1016",
    "guid": "1428695028875792384",
    "userId": 801660
  }
}

Query Agent Information (Legacy)

• Type

  API

• URI

  /group-dispatch-api/user/listUserByTenantId

• Request Method

  POST、Content-Type: application/json

• API Description

  Query whether an agent exists

• Request Parameter Description

Field	Type	Required	Remarks
userName	String	No	Agent name
userId	int	No	Agent id

Request example:

{
  "userName": "shun",
  "userId": 101
}

• Response Parameter Description

  Parameter Name	Type	Required	Remarks
  code	int	Yes	Status code
  message	String	Yes	Description
  data	String	Yes	Agent information list

{
  "code": 200,
  "message": "success",
  "data": [{ "userId": 101, "userName": "shun" }]
}