diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/btripopen/2022-05-17 | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/zh_cn/btripopen/2022-05-17')
| -rw-r--r-- | data/zh_cn/btripopen/2022-05-17/api-docs.php | 247 |
1 files changed, 247 insertions, 0 deletions
diff --git a/data/zh_cn/btripopen/2022-05-17/api-docs.php b/data/zh_cn/btripopen/2022-05-17/api-docs.php new file mode 100644 index 0000000..9fc256c --- /dev/null +++ b/data/zh_cn/btripopen/2022-05-17/api-docs.php @@ -0,0 +1,247 @@ +<?php return [ + 'version' => '1.0', + 'info' => ['style' => 'ROA', 'product' => 'btripOpen', 'version' => '2022-05-17'], + 'directories' => [ + [ + 'id' => 167494, + 'title' => '测试hlf', + 'type' => 'directory', + 'children' => ['ScanMsgList'], + ], + [ + 'id' => 167496, + 'title' => '其他', + 'type' => 'directory', + 'children' => ['TakeAccessToken'], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'ScanMsgList' => [ + 'summary' => '商旅消息——消息扫描。', + 'path' => '/ScanMsgList', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'btripOpen' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ChannelType', + 'in' => 'formData', + 'schema' => ['title' => '消息渠道Type', 'description' => '消息渠道Type', 'type' => 'string', 'required' => false, 'example' => 'hdm_alarm_sms,dingtalk'], + ], + [ + 'name' => 'SequenceId', + 'in' => 'formData', + 'schema' => ['title' => '商旅消息Id', 'description' => '商旅消息Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1130107041'], + ], + [ + 'name' => 'Biz', + 'in' => 'formData', + 'schema' => ['title' => '业务类型', 'description' => '业务类型', 'type' => 'string', 'required' => false, 'example' => 'Verify_RPBio'], + ], + [ + 'name' => 'ScanSequence', + 'in' => 'formData', + 'schema' => ['title' => '扫描顺序', 'description' => '扫描顺序', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1122221'], + ], + [ + 'name' => 'Size', + 'in' => 'formData', + 'schema' => ['title' => '查询数量', 'description' => '查询数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'CorpId', + 'in' => 'formData', + 'schema' => ['title' => '企业ID', 'description' => '企业ID', 'type' => 'string', 'required' => false, 'example' => '3562012953454577801'], + ], + [ + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => ['title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'required' => false, 'example' => 'qqqqqqq'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BtripResult<List<BtripMsgDTO>>', + 'description' => 'BtripResult<List<BtripMsgDTO>>', + 'type' => 'object', + 'properties' => [ + 'Success' => ['title' => '成功标识', 'description' => '成功标识', 'type' => 'boolean', 'example' => 'True'], + 'Code' => ['title' => '错误代码', 'description' => '错误代码', 'type' => 'integer', 'format' => 'int32', 'example' => 'OK'], + 'Msg' => ['title' => '出错消息', 'description' => '出错消息', 'type' => 'string', 'example' => 'success'], + 'ExtMsg' => ['title' => '结果扩展信息', 'description' => '结果扩展信息', 'type' => 'string', 'example' => 'dddd'], + 'Module' => [ + 'title' => '返回对象', + 'description' => '返回对象', + 'type' => 'array', + 'items' => [ + 'description' => 'module', + 'type' => 'object', + 'properties' => [ + 'SequenceId' => ['title' => '商旅消息ID', 'description' => '商旅消息ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1135434288'], + 'Biz' => ['title' => '业务类型', 'description' => '业务类型', 'type' => 'string', 'example' => 'CREATE'], + 'Content' => ['title' => '消息内容', 'description' => '消息内容', 'type' => 'string', 'example' => 'True'], + 'SendTime' => ['title' => '发送时间', 'description' => '发送时间', 'type' => 'string', 'example' => '{\\"type\\":\\"week\\",\\"day\\":\\"5\\",\\"date\\":\\"1\\",\\"hour\\":\\"18\\",\\"month\\":\\"1\\"}'], + 'HaveRedDot' => ['title' => '是否有红点', 'description' => '是否有红点', 'type' => 'boolean', 'example' => 'True'], + 'UnReadCount' => ['title' => '未读数量', 'description' => '未读数量', 'type' => 'integer', 'format' => 'int32', 'example' => '111'], + 'ShowMsg' => ['title' => '灰度:是否展示消息', 'description' => '灰度:是否展示消息', 'type' => 'boolean', 'example' => 'True'], + ], + ], + ], + 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'A3F8DCAB-8301-5770-BD9F-71B0BF9E1A6E'], + ], + ], + ], + 400 => [], + 500 => [], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => '1001', 'errorMessage' => '测试错误码'], + ], + 500 => [ + ['errorCode' => '500', 'errorMessage' => '500'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": 0,\\n \\"Msg\\": \\"success\\",\\n \\"ExtMsg\\": \\"dddd\\",\\n \\"Module\\": [\\n {\\n \\"SequenceId\\": 1135434288,\\n \\"Biz\\": \\"CREATE\\",\\n \\"Content\\": \\"True\\",\\n \\"SendTime\\": \\"{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"week\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"day\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"5\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"date\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"hour\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"18\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"month\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}\\",\\n \\"HaveRedDot\\": true,\\n \\"UnReadCount\\": 111,\\n \\"ShowMsg\\": true\\n }\\n ],\\n \\"RequestId\\": \\"A3F8DCAB-8301-5770-BD9F-71B0BF9E1A6E\\"\\n}","type":"json"}]', + 'title' => '消息扫描', + 'description' => '>消息扫描', + 'requestParamsDescription' => 'GET /v1.0/oauth2/apps/authInfo?authCorpId=dingxxx HTTP/1.1'."\n" + ."\n" + .'Host:api.dingtalk.com'."\n" + ."\n" + .'x-acs-dingtalk-access-token:BExxx'."\n" + ."\n" + .'Content-Type:application/json', + 'responseParamsDescription' => '```json'."\n" + .'{'."\n" + .' "authAppInfo" : {'."\n" + .' "agentList" : [ {'."\n" + .' "agentId" : 888,'."\n" + .' "agentName" : "小程序DEMO",'."\n" + .' "appId" : 111,'."\n" + .' "adminList" : [ "manager975" ]'."\n" + .' } ]'."\n" + .' },'."\n" + .' "authCorpInfo" : {'."\n" + .' "inviteCode" : "111",'."\n" + .' "industry" : "201",'."\n" + .' "corpName" : "小程序体验HTTP",'."\n" + .' "licenseCode" : "111",'."\n" + .' "authChannel" : "123",'."\n" + .' "authChannelType" : "1",'."\n" + .' "authLevel" : 1,'."\n" + .' "inviteUrl" : "https://wx.dingtalk.com/invite-page/xxx",'."\n" + .' "corpLogoUrl" : "https://static-legacy.dingtalk.com/xxx"'."\n" + .' },'."\n" + .' "authUserInfo" : {'."\n" + .' "userId" : "manager975"'."\n" + .' }'."\n" + .'}'."\n" + .'```', + ], + 'TakeAccessToken' => [ + 'summary' => 'dddd。', + 'path' => '/btrip/open/access-token/take/{app_key}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'app_key', + 'in' => 'path', + 'schema' => ['type' => 'string', 'required' => false], + ], + [ + 'name' => 'app_secret', + 'in' => 'query', + 'schema' => ['description' => '密钥', 'type' => 'string', 'required' => false, 'example' => 'affsgdfgsgsddg'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '456456575656757'], + 'code' => ['description' => '错误码'."\n", 'type' => 'string', 'example' => 'System.Error'], + 'message' => ['description' => '错误信息', 'type' => 'string', 'example' => '系统错误'], + 'success' => ['description' => '是否成功', 'type' => 'string', 'example' => 'true'], + 'data' => [ + 'description' => '数据', + 'type' => 'object', + 'properties' => [ + 'access_token' => ['description' => 'token', 'type' => 'string', 'example' => '32sfjge'], + 'expire' => ['description' => '过期时间', 'type' => 'integer', 'format' => 'int64', 'example' => '70000'], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'AccessToken.Application.Missing', 'errorMessage' => '找不到对应的应用'], + ['errorCode' => 'AccessToken.AppSecret.Mismatching', 'errorMessage' => 'appSecret不正确'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"456456575656757\\",\\n \\"code\\": \\"System.Error\\",\\n \\"message\\": \\"系统错误\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": {\\n \\"access_token\\": \\"32sfjge\\",\\n \\"expire\\": 70000\\n }\\n}","type":"json"}]', + 'title' => '获取accessToken', + 'description' => "\n" + .'> 要调用此API,需要以下权限之一。'."\n" + .'> - 调用ISV专有API时需要具备的权限'."\n" + ."\n", + 'requestParamsDescription' => 'GET /v1.0/oauth2/apps/authInfo?authCorpId=String HTTP/1.1'."\n" + .'Host:api.dingtalk.com'."\n" + .'x-acs-dingtalk-access-token:String'."\n" + .'Content-Type:application/json', + 'responseParamsDescription' => 'HTTP/1.1 200 OK'."\n" + .'Content-Type:application/json'."\n" + ."\n" + .'{'."\n" + .' "authAppInfo" : {'."\n" + .' "agentList" : [ {'."\n" + .' "agentId" : 888,'."\n" + .' "agentName" : "小程序DEMO",'."\n" + .' "appId" : 111,'."\n" + .' "adminList" : [ "manager975" ]'."\n" + .' } ]'."\n" + .' },'."\n" + .' "authCorpInfo" : {'."\n" + .' "inviteCode" : "111",'."\n" + .' "industry" : "201",'."\n" + .' "corpName" : "小程序体验HTTP",'."\n" + .' "licenseCode" : "111",'."\n" + .' "authChannel" : "123",'."\n" + .' "authChannelType" : "1",'."\n" + .' "authLevel" : 1,'."\n" + .' "inviteUrl" : "https://wx.dingtalk.com/invite-page/xxx",'."\n" + .' "corpLogoUrl" : "https://static-legacy.dingtalk.com/xxx"'."\n" + .' },'."\n" + .' "authUserInfo" : {'."\n" + .' "userId" : "manager975"'."\n" + .' }'."\n" + .'}', + ], + ], + 'endpoints' => [], +]; |
