API中心/号码查询
 
 

号码查询

POST
https://api.itniotech.com/number/queryPage
查询创建的号码
 
请求参数
参数 说明 是否必填 类型
current 当前页码，1-N 是 Integer
size 每页显示数，1-100 是 Integer
params 分页参数 是 JSONObject
appId 应用id 否 String
 
请求示例
Request URL:
    https://api.itniotech.com/number/queryPage
Request Method:
    POST
Request Headers:
    Content-Type: application/json;charset=UTF-8
    Sign: 05d7a50893e22a5c4bb3216ae3396c7c
    Timestamp: 1630468800
    Api-Key: bDqJFiq9
Request Body:
{
    "current":1,
    "size":10,
    "params":{
        "appId":"bDqJFiq9"
    }
}
 
响应参数
参数 说明 类型
status 状态码，0成功，其他失败参见响应状态码说明 String
reason 原因说明 String
data 分页数据 JSONObject
total 总记录条数 Integer
size 每页显示数 Integer
current 当前页码 Integer
pages 总页码 Integer
records 数据集合 JSONArray
number 号码 String
ccode 国家码 String
country 国家 String
dueDate 到期时间 String
state 状态：3使用中，4已过期，5停用中 Integer
inboundPrefix 呼入前缀 String
type 号码类型：MOBILE、FIXED String
outIp 呼出ip白名单 String
inIp 呼入对接ip端口 String
remark 备注 String
appId 号码应用id String
enableVoicemail 是否启用语音信箱，1-是，0否 Integer
voicemailFileId 语音信箱播放文件Id String
voicemailFileName 语音信箱播放文件名称 String
voicemailMaxHangup 语音信箱最大留言时长 Integer
 
响应示例
{
    "status": "0",
    "reason": "success",
    "data": {
        "total": 5,
        "size": 20,
        "current": 1,
        "pages": 1,
        "records": [
            {
                "number": "915027021995",
                "appId": "Wosfeh8Negxaaa",
                "ccode": "91",
                "country": "India",
                "dueDate": "2024-04-11",
                "state": 3,
                "inboundPrefix": "1",
                "type": "FIXED",
                "autoRenew": 0,
                "outIp": "192.168.10.176,192.168.10.16",
                "inIp": "192.168.10.24:5060",
                "remark": "note",
                "enableVoicemail": 0,
                "voicemailFileId": null,
                "voicemailMaxHangup": null
            }
        ]
    }
}
 
响应状态码
status 状态说明
0 成功
-1 账号认证异常
-2 ip限制
-16 时间戳过期
-18 系统异常
-22 参数异常
-25 超出时间范围限制
-29 WorkSpace被禁用
-30 API Key被禁用
-31 ip不在白名单内
平台主动推送通话记录
号码配置

意见反馈

文档内容是否对您有帮助?