Webhook订阅

Webhook订阅

post

订阅各类消息，例如交易成交信息，详细内容可以参考交易通知消息说明

Header parameters

companyIdstringRequired

公司ID

Example: {{company}}

tracestringRequired

全局链路唯一标志

Example: {{mock_trace}}

apiKeystringRequired

apiKey

Example: {{apikey}}

recvWindowstringOptional

时间窗口

Example: 5000

signaturestringRequired

签名

Example: {{sign}}

langstringOptional

语言

Example: zh-CN

versionstringOptional

接口版本

Example: 0.0.1

Body

application/json

apiKeystringRequired

apiKey

webhookUrlstringRequired

消息通知回调地址

Responses

200Success

application/json

codestringRequired

系统通用返回码。0-成功，其他异常

msgstringRequired

返回信息

bizCodestringRequired

模块标识码

tmnumberRequired

处理时长（毫秒）

tracestringRequired

全局链路标志信息

msgParamsstring · nullableRequired

返回描述中占位符参数串，多个参数间以,分割

databooleanRequired

返回结果

post

/global/admin.admin.CompanyApiKeyDubboService.subscribe

HTTPcURLJavaScriptPython

POST /global/admin.admin.CompanyApiKeyDubboService.subscribe HTTP/1.1
companyId: text
trace: text
apiKey: text
signature: text
Content-Type: application/json
Accept: */*
Content-Length: 118

{
  "apiKey": "dc483e80a7a0bd9ef71d8cf973673924",
  "webhookUrl": "https://webhook.site/4fe19259-6b56-425a-ab03-f9575e4a2c36"
}

200Success

{
  "msg": "Success",
  "fail": false,
  "trace": "t-h2jv9x-4to64-9mp4wd7-793nv-1661227305",
  "code": "0",
  "data": "true",
  "bizCode": "",
  "tm": 236026513,
  "msgParams": null,
  "ok": true
}