接口方法
该接口仅支持GET方法,不支持PUT、POST和DELETE等方法。
接口URI
https://ip:port/agentgateway/resource/config/vdn/uap/user/status?uapId=0&phoneNum=xxxx
其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。
URI中携带的参数说明如表1所示。
表1 URI携带参数说明
|
序号 |
参数名 |
数据类型 |
选取原则 |
说明 |
|
1 |
uapId |
number |
False |
uap标识id。 |
|
2 |
phoneNum |
string |
True |
用户号码。
最大长度为32个字符。 |
日志中的方法名
queryPhoneNumStatus
请求消息
- 消息头
表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 |
object |
返回结果。该对象参数说明请参见表4。 |
表4 result参数说明
|
序号 |
名称 |
参数类型 |
说明 |
|
3.1 |
phoneNum |
string |
用户号码 |
|
3.2 |
registerStatus |
string |
注册状态
|
报文样例
- 消息头
Content-Type:application/json; charset=UTF-8
Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
- 请求参数
无
- 响应参数
{
"result": {
"registerStatus": "1",
"phoneNum": "88880000"
},
"message": "success",
"retcode": "0"
}