API Center/Number Query
 
 

Number Query

POST
https://api.itniotech.com/number/queryPage
Inquire about the number created.
 
Request Parameters
Parameters Description Required Type
current Current page number, 1-N Yes Integer
size Number of displays per page, 1-100 Yes Integer
params Paging parameters Yes JSONObject
appId Application id No String
 
Request Sample
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"
    }
}
 
Response Parameters
Parameters Description Type
status Status code, 0 is successful, other failures refer to the interface response code String
reason Failure cause description String
data Paging data JSONObject
total Total number of records Integer
size Number of displays per page Integer
current Current page number Integer
pages Total page number Integer
records Data collection JSONArray
number Number String
ccode Country code String
country Country String
dueDate Expiration time String
state Status: 3 in use, 4 expired, 5 disabled Integer
inboundPrefix Incoming call prefix String
type Number type: MOBILE, FIXED String
outIp Outgoing ip whitelist String
inIp The incoming call is made to the interconnection ip port String
remark Remark String
appId Number application id String
enableVoicemail Whether to enable voicemail: 1- Yes, 0 no Integer
voicemailFileId Id of the voicemail playback file String
voicemailFileName Name of the voice mailbox playback file String
voicemailMaxHangup The maximum duration of voice messages Integer
 
Response Sample
{
    "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
            }
        ]
    }
}
 
Response Status Code
status Description
0 Successful
-1 Abnormal account authentication
-2 Ip restrictions
-16 Timestamp expired
-18 System anomalies
-22 Parameter exception
-25 Out of time limit
-29 WorkSpace disabled
-30 API Key disabled
-31 Ip is not in the whitelist
Number Global Status Code
Number Configuration

Feedback

Was this page helpful?