查询话机 - nxtele/http-api-document GitHub Wiki
简要描述:
- 用户查询话机接口
请求方式:
- URL:
https://api.nxcloud.com/api/sipphone/queryMobs
- Method:
POST
- Content-Type:
application/x-www-form-urlencoded
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
username | 是 | string | 用户登录的用户名 |
password | 是 | string | 用户登录的密码 |
appkey | 否 | string | 审批单的appkey |
page | 否 | int | 当前页(默认1) |
pageSize | 否 | int | 每页条数(默认10) |
请求示例:
curl --location --request POST 'https://api.nxcloud.com/api/sipphone/queryMobs' \
--data-urlencode 'username=asdf' \
--data-urlencode 'password=qwer'
返回示例
{
"code": "success",
"info": {
"total": 1,
"pageSize": 10,
"page": 1,
"rows": [
{
"monile_password": "1234qwer",
"secretkey": "OvHlPwzz",
"name": "aaa",
"appkey": "NCZhOStw",
"account": "wcj001",
"username": "ali02990",
"status": 0
}
]
}
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | string | 返回code码,success代表成功返回数据参数无误 |
total | int | 返回数据的总条数 |
pageSize | int | 每天展示条数 |
page | int | 当前页 |
rows | list | 话机结果集 |
monile_password | string | 话机密码 |
appkey | string | 话机对应审批单的appkey |
secretkey | string | 话机对应审批单的secretkey |
account | string | 审批单账号 |
name | string | 话机昵称 |
status | int | 话机状态(0未启用,1启用 2停用) |
username | string | 话机账号 |
错误参数返回
{
"code": "failed",
"info": "用户名或密码错误"
}
参数名 | 类型 | 说明 |
---|---|---|
code | string | 返回code码,failed表示参数有误 |
info | string | 错误信息 |