Showing
1 changed file
with
189 additions
and
11 deletions
@@ -31,16 +31,25 @@ Response Body: | @@ -31,16 +31,25 @@ Response Body: | ||
31 | ``` | 31 | ``` |
32 | { | 32 | { |
33 | "returnCode": 500, | 33 | "returnCode": 500, |
34 | - "returnMsg": "" | 34 | + "returnMsg": "系统内部异常!" |
35 | } | 35 | } |
36 | ``` | 36 | ``` |
37 | 37 | ||
38 | -主叫或被叫未绑定电话号: | 38 | +用户未绑定手机号: |
39 | 39 | ||
40 | ``` | 40 | ``` |
41 | { | 41 | { |
42 | "returnCode": 400, | 42 | "returnCode": 400, |
43 | - "returnMsg": "账号未绑定手机号,请手动拨打010-56469588!" | 43 | + "returnMsg": "用户未绑定手机号,请手动拨打010-56469588!" |
44 | +} | ||
45 | +``` | ||
46 | + | ||
47 | +客服电话不存在: | ||
48 | + | ||
49 | +``` | ||
50 | +{ | ||
51 | + "returnCode": 400, | ||
52 | + "returnMsg": "客服电话不存在,请联系管理员!" | ||
44 | } | 53 | } |
45 | ``` | 54 | ``` |
46 | 55 | ||
@@ -53,32 +62,201 @@ Response Body: | @@ -53,32 +62,201 @@ Response Body: | ||
53 | } | 62 | } |
54 | ``` | 63 | ``` |
55 | 64 | ||
56 | -用户信息有误: | 65 | +呼叫请求的参数有误: |
57 | 66 | ||
58 | ``` | 67 | ``` |
59 | { | 68 | { |
60 | "returnCode": 400, | 69 | "returnCode": 400, |
61 | - "returnMsg": "用户信息有误!" | 70 | + "returnMsg": "呼叫请求的参数有误,请联系管理员!" |
62 | } | 71 | } |
63 | ``` | 72 | ``` |
64 | 73 | ||
65 | -用户信息有误: | 74 | +### 2. 客服呼叫 |
75 | +接口地址:/v1/app/callService?access_token=token | ||
76 | + | ||
77 | +Request Method:GET | ||
78 | + | ||
79 | +Request params: | ||
80 | + | ||
81 | +|参数名 |是否必须 |说明 |参数类型 | | ||
82 | +|--------------|----------|--------|----------| | ||
83 | +|access_token |是 |系统当前登录用户的token |String | | ||
84 | + | ||
85 | +Response Body: | ||
86 | + | ||
87 | +成功建立通话连接: | ||
88 | + | ||
89 | +``` | ||
90 | +{ | ||
91 | + "data": { | ||
92 | + "callSid": "16090510160925480001030600243044" | ||
93 | + } | ||
94 | + }, | ||
95 | + "returnCode": 200, | ||
96 | + "returnMsg": "success" | ||
97 | +} | ||
98 | +``` | ||
99 | + | ||
100 | +系统异常: | ||
101 | + | ||
102 | +``` | ||
103 | +{ | ||
104 | + "returnCode": 500, | ||
105 | + "returnMsg": "系统内部异常!" | ||
106 | +} | ||
107 | +``` | ||
108 | + | ||
109 | +用户未绑定手机号: | ||
66 | 110 | ||
67 | ``` | 111 | ``` |
68 | { | 112 | { |
69 | "returnCode": 400, | 113 | "returnCode": 400, |
70 | - "returnMsg": "用户信息有误!" | 114 | + "returnMsg": "用户未绑定手机号,请手动拨打010-56469588!" |
71 | } | 115 | } |
72 | ``` | 116 | ``` |
73 | 117 | ||
74 | -用户信息有误: | 118 | +客服电话不存在: |
75 | 119 | ||
76 | ``` | 120 | ``` |
77 | { | 121 | { |
78 | "returnCode": 400, | 122 | "returnCode": 400, |
79 | - "returnMsg": "用户信息有误!" | 123 | + "returnMsg": "客服电话不存在,请联系管理员!" |
124 | +} | ||
125 | +``` | ||
126 | + | ||
127 | +无通讯子账户: | ||
128 | + | ||
129 | +``` | ||
130 | +{ | ||
131 | + "returnCode": 400, | ||
132 | + "returnMsg": "无通讯子账户,请联系管理员!" | ||
133 | +} | ||
134 | +``` | ||
135 | + | ||
136 | +呼叫请求的参数有误: | ||
137 | + | ||
138 | +``` | ||
139 | +{ | ||
140 | + "returnCode": 400, | ||
141 | + "returnMsg": "呼叫请求的参数有误,请联系管理员!" | ||
80 | } | 142 | } |
81 | ``` | 143 | ``` |
82 | -### 2. 客服呼叫 | ||
83 | ### 3. 取消呼叫 | 144 | ### 3. 取消呼叫 |
84 | -### 4. 获取通话状态 | 145 | +接口地址:/v1/app/callCancel/{callSid}?access_token=token |
146 | + | ||
147 | +Request Method:GET | ||
148 | + | ||
149 | +Request params: | ||
150 | + | ||
151 | +|参数名 |是否必须 |说明 |参数类型 | | ||
152 | +|--------------|----------|--------|----------| | ||
153 | +|callSid |是 |当前通话的唯一标识 |String | | ||
154 | +|access_token |是 |系统当前登录用户的token |String | | ||
155 | + | ||
156 | +Response Body: | ||
157 | + | ||
158 | +成功取消呼叫: | ||
159 | + | ||
160 | +``` | ||
161 | +{ | ||
162 | + "data": { | ||
163 | + "isSuccess": "success" | ||
164 | + } | ||
165 | + }, | ||
166 | + "returnCode": 200, | ||
167 | + "returnMsg": "success" | ||
168 | +} | ||
169 | +``` | ||
170 | + | ||
171 | +用户信息有误: | ||
172 | + | ||
173 | +``` | ||
174 | +{ | ||
175 | + "returnCode": 400, | ||
176 | + "returnMsg": "用户信息有误!" | ||
177 | +} | ||
178 | +``` | ||
179 | + | ||
180 | +取消呼叫失败: | ||
181 | + | ||
182 | +``` | ||
183 | +{ | ||
184 | + "returnCode": 400, | ||
185 | + "returnMsg": "取消呼叫失败!" | ||
186 | +} | ||
187 | +``` | ||
188 | + | ||
189 | +### 4. 获取通话状态 | ||
190 | +接口地址:/v1/app/callState/{callSid}?access_token=token | ||
191 | + | ||
192 | +Request Method:GET | ||
193 | + | ||
194 | +Request params: | ||
195 | + | ||
196 | +|参数名 |是否必须 |说明 |参数类型 | | ||
197 | +|--------------|----------|--------|----------| | ||
198 | +|callSid |是 |当前通话的唯一标识 |String | | ||
199 | +|access_token |是 |系统当前登录用户的token |String | | ||
200 | + | ||
201 | +Response Body: | ||
202 | + | ||
203 | +请求通话: | ||
204 | + | ||
205 | +``` | ||
206 | +{ | ||
207 | + "data": { | ||
208 | + "stateType": "1" | ||
209 | + } | ||
210 | + }, | ||
211 | + "returnCode": 200, | ||
212 | + "returnMsg": "success" | ||
213 | +} | ||
214 | +``` | ||
215 | + | ||
216 | +响铃(等待接听): | ||
217 | + | ||
218 | +``` | ||
219 | +{ | ||
220 | + "data": { | ||
221 | + "stateType": "2" | ||
222 | + } | ||
223 | + }, | ||
224 | + "returnCode": 200, | ||
225 | + "returnMsg": "success" | ||
226 | +} | ||
227 | +``` | ||
228 | + | ||
229 | +建立通话(被叫已接听): | ||
230 | + | ||
231 | +``` | ||
232 | +{ | ||
233 | + "data": { | ||
234 | + "stateType": "3" | ||
235 | + } | ||
236 | + }, | ||
237 | + "returnCode": 200, | ||
238 | + "returnMsg": "success" | ||
239 | +} | ||
240 | +``` | ||
241 | + | ||
242 | +通话结束: | ||
243 | + | ||
244 | +``` | ||
245 | +{ | ||
246 | + "data": { | ||
247 | + "stateType": "4" | ||
248 | + } | ||
249 | + }, | ||
250 | + "returnCode": 200, | ||
251 | + "returnMsg": "success" | ||
252 | +} | ||
253 | +``` | ||
254 | + | ||
255 | +系统异常: | ||
256 | + | ||
257 | +``` | ||
258 | +{ | ||
259 | + "returnCode": 500, | ||
260 | + "returnMsg": "系统内部异常!" | ||
261 | +} | ||
262 | +``` |
-
Please register or login to post a comment