Skip to main content

Common Request Header Description

FieldNameTypeRequiredDescription
cmd_idProtocol numberuint32Provided in each interface definition
seq_idSequence numberuint32YesGenerated uniquely by the requester. The response keeps the same value as the request.
traceTrace IDstringYesGenerated uniquely by the requester. The response keeps the same value as the request. Maximum length: 64.
dataData bodyobjectYesSee each interface definition for the specific data format.
{
  "cmd_id": 22000,
  "seq_id": 123,
  "trace": "asdfsdfa",
  "data": {}
}

Common Response Header Description

FieldNameTypeDescription
retReturn valueint32Error Code Description
msgMessagestringSpecific description of success or failure.
cmd_idProtocol numberuint32Provided in each interface definition.
seq_idSequence numberuint32Generated uniquely by the requester. The response keeps the same value as the request.
traceTrace IDstringGenerated uniquely by the requester. The response keeps the same value as the request. Maximum length: 64.
dataData bodyobjectSee each interface definition for the specific data format.
{
  "ret": 201,
  "msg": "request header param invalid",
  "cmd_id": 0,
  "seq_id": 0,
  "trace": "",
  "data": {}
}

AllTick Website

Official website: https://alltick.co/