Query Number Information

POST

https://api.itniotech.com/wa/queryBusinessPhoneInfo

Query the number information under the account.
 
Request Parameters
Parameters Description Required Type
params   Yes Object
appIds Application ID is empty to check all accounts, up to 100 Yes String
phoneNumbers Mobile phone number, empty check all numbers under the application No List
current Current page No Integer
size Number of items displayed on each page, default 25 No Integer
 
Request Sample
Request URL:
    https://api.itniotech.com/wa/template/queryBusinessPhoneInfo
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": "Gw1p1000xLZ",
        "phoneNumbers":[]
    }
}
 
Response Parameters
Parameters Description Type
status Status code, 0 is successful, other failures refer to the interface response code String
reason Success or failure description String
data Send result Object
records WABA array Array
wabaId WABA id String
timeStamp The current timestamp String
dataList Data list Array
displayPhoneNumber WABA Integer
displayPhoneNumber Display phone number String
phoneNumber Phone number String
status Number status: Pending 0 (PENDING); Delete 1 (DELETED); Migrate 2 (MIGRATED); Disable 3 (BANNED); Limit 4 (RESTRICTED); 5-RATE_LIMITED; Flag 6 (FLAGGED); Connected 7 (CONNECTED); DISCONNECTED 8; UNKNOWN 9; UNVERIFIED 10 Integer
verificationStatus Phone number verification: Not verified 0 (NOT_VERIFIED); Verified 1 (VERIFIED); Expired 2 (EXPIRED) Integer
messagingLimitTier Message sending limit: 50 users/24 hours (0:TIER_50); 250 users/24 hours (1:TIER_250); 1,000 users/24 hours (2:TIER_1K); 10,000 users/24 hours (3:TIER_10K ); 100,000 users/24 hours (5:TIER_100K); unlimited (5:TIER_UNLIMITED) Integer
qualityRating Number quality: high quality (0: GREEN); medium quality (1: YELLOW); low quality (2: RED); unknown (3: UNKNOW) Integer
verifiedName Certification name String
nameStatus Number name review status: No certificate available (0:NONE); name approved (1:APPROVED); certificate for phone number can be downloaded and display name can be used without review (2:AVAILABLE_WITHOUT_REVIEW); name not yet approved; You cannot download the certificate (3:DECLINED); your certificate has expired and cannot be downloaded (4:EXPIRED); and your name request is under review. You cannot download the certificate (5:PENDING_REVIEW) Integer
newNameStatus Number name review status: No certificate available (0:NONE); name approved (1:APPROVED); certificate for phone number can be downloaded and display name can be used without review (2:AVAILABLE_WITHOUT_REVIEW); name not yet approved; You cannot download the certificate (3:DECLINED); your certificate has expired and cannot be downloaded (4:EXPIRED); and your name request is under review. You cannot download the certificate (5:PENDING_REVIEW) Integer
isOfficialBusinessAccount Whether it is a commercial certification account (green label) (0: no, 1: yes) Integer
isPinEnabled Whether to enable two-step verification (0: no, 1: yes) Integer
total Total Integer
size Size Integer
current Number of items displayed on each page, default 25 Integer