data/zh_cn/appflow/2023-09-04/api-docs.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

<?php return [
    'version' => '1.0',
    'info' => [
        'style' => 'RPC',
        'product' => 'appflow',
        'version' => '2023-09-04',
    ],
    'directories' => [
        'GenerateUserSessionToken',
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'GenerateUserSessionToken' => [
            'summary' => '生成登录会话Token。',
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'readAndWrite',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'none',
                'riskType' => 'none',
                'chargeType' => 'free',
                'abilityTreeCode' => '214832',
                'abilityTreeNodes' => [
                    'FEATUREcomputenest1X0UFA',
                ],
                'tenantRelevance' => 'tenant',
            ],
            'parameters' => [
                [
                    'name' => 'ChatbotId',
                    'in' => 'query',
                    'schema' => [
                        'title' => 'AI助手ID',
                        'description' => 'AI助手ID',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'cb-069d508f9ab341b1****',
                    ],
                ],
                [
                    'name' => 'IntegrateId',
                    'in' => 'query',
                    'schema' => [
                        'title' => '集成ID',
                        'description' => '集成ID',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'cit-960f499au184m7****',
                    ],
                ],
                [
                    'name' => 'UserId',
                    'in' => 'query',
                    'schema' => [
                        'title' => '用户ID',
                        'description' => '用户ID',
                        'type' => 'string',
                        'required' => true,
                        'example' => '929293312213****',
                    ],
                ],
                [
                    'name' => 'UserName',
                    'in' => 'query',
                    'schema' => [
                        'title' => '用户昵称',
                        'description' => '用户昵称',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'testxxx',
                    ],
                ],
                [
                    'name' => 'UserAvatar',
                    'in' => 'query',
                    'schema' => [
                        'title' => '用户头像',
                        'description' => '用户头像（url地址）',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'https://xxxx.com/xxx',
                    ],
                ],
                [
                    'name' => 'ExpireSecond',
                    'in' => 'query',
                    'schema' => [
                        'title' => '过期时间，单位：秒， 默认24小时',
                        'description' => '过期时间，单位：秒， 默认24小时',
                        'type' => 'integer',
                        'format' => 'int64',
                        'required' => false,
                        'example' => '6000',
                    ],
                ],
                [
                    'name' => 'ExtraInfo',
                    'in' => 'query',
                    'schema' => [
                        'title' => '额外信息：使用 JSON String 格式。示例：'."\n"
                            .'{ "phone": "手机号", "dept":["部门1","部门2"]}',
                        'description' => '额外信息：使用 JSON String 格式。示例：'."\n"
                            .'{ "phone": "手机号", "dept":["部门1","部门2"]}',
                        'type' => 'string',
                        'required' => false,
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'Schema of Response',
                        'description' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => [
                                'title' => 'Id of the request',
                                'description' => '请求ID。',
                                'type' => 'string',
                                'example' => '34C2713A-2270-5EEC-825E-115F9AD3BAC9',
                            ],
                            'UserSessionToken' => [
                                'description' => 'Token',
                                'type' => 'string',
                                'example' => '960f499au184m7****',
                            ],
                        ],
                    ],
                ],
            ],
            'staticInfo' => [
                'returnType' => 'synchronous',
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"RequestId\\": \\"34C2713A-2270-5EEC-825E-115F9AD3BAC9\\",\\n  \\"UserSessionToken\\": \\"960f499au184m7****\\"\\n}","type":"json"}]',
            'title' => '生成登录会话Token',
        ],
    ],
    'endpoints' => [
        [
            'regionId' => 'cn-hangzhou',
            'endpoint' => 'appflow.cn-hangzhou.aliyuncs.com',
        ],
    ],
];