API Center/Querying the Number Pool
 
 

Querying the Number Pool

POST
https://api.itniotech.com/number/queryNumberPool
Number pool query
 
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 No JSONObject
 
Request Sample
Request URL:
    https://api.itniotech.com/number/queryNumberPool
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":{}
}
 
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
poolNumber Number pool Virtual calling number String
customerWhitelist Customer ip whitelist. Multiple ip addresses are separated by commas (,) String
maxConcurrency Max concurrency String
numberList Collection of numbers Array
 
Response Sample
{
    "status": "0",
    "reason": "success",
    "data": {
        "total": 5,
        "size": 20,
        "current": 1,
        "pages": 1,
        "records": [
            {
                "poolNumber": "915027021995",
                "customerWhitelist":"192.168.10.17,192.168.10.18",
                "maxConcurrency":99,
                "numberList":["9178605501","9178605502"]
            }
        ]
    }
}
 
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 Pool Creation
Number Pool Configuration

Feedback

Was this page helpful?