接口方法
该接口仅支持GET方法,不支持PUT、POST和DELETE等方法。
接口URI
https://ip:port/agentgateway/resource/config/sys/uap/user?uapId=0&startPhoneNum=xxxx&endPhoneNum=xxxx
其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。
URI中携带的参数说明如表1所示。
表1 URI携带参数说明
|
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
|
1 |
uapId |
number |
False |
uap标识id,CTI Pool模式下为必选。 |
|
2 |
startPhoneNum |
string |
False |
起始用户号码。
最大长度为32个字符。 |
|
3 |
endPhoneNum |
string |
False |
结束用户号码。
最大长度为32个字符。
说明:
- 如果起始用户号码和结束号码都不填,默认最多返回前500条数据。
- 结束用户号码减去起始号码必须小于等于500。
|
请求消息
- 消息头
表2 消息头参数说明
|
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
|
1 |
Content-Type |
string |
True |
消息主体编码方式,缺省值:application/json; charset=UTF-8 |
|
2 |
Guid |
string |
True |
Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。 |
响应消息
表3 消息体参数说明
|
序号 |
名称 |
参数类型 |
说明 |
|
1 |
message |
string |
返回消息 |
|
2 |
retcode |
string |
操作的结果原因码。
取值类型为整数。
|
|
3 |
result |
array |
返回结果。该对象参数说明请参见表4。 |
表4 result参数说明
|
序号 |
名称 |
参数类型 |
说明 |
|
3.1 |
equipmentId |
string |
设备标识 |
|
3.2 |
signalIpAddress |
string |
信令IP地址 |
|
3.3 |
ccuModuleNum |
string |
CCU模块号 |
|
3.4 |
subscribeNumber |
string |
用户号码 |
|
3.5 |
unregisteredAuth |
string |
注销时鉴权 |
|
3.6 |
authFlag |
string |
鉴权模式
0:UAP鉴权
1:业务鉴权 |
|
3.7 |
algorithmType |
string |
加密算法类型 |
报文样例
- 消息头
Content-Type:application/json; charset=UTF-8
Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
- 请求参数
无
- 响应参数
{
"result": [
{
"subscribeNumber": "88880000",
"signalIpAddress": "10.10.10.10"
}
],
"message": "success",
"retcode": "0"
}