Home Support SMS API

Inquire Phone

Description: Inquire phones created under a designated audio application.

Request Parameters Description:

Parameters Description Required Type

current

Current page number: 1-N, default 1, cannot be passed empty

Yes

Int

size

Number displayed on each page: 1-100, default 25, cannot be passed empty

Yes

Int

params

Parameters on each page

Yes

JSONObject

appId

Audio application ID

Yes

String

Request URL:

                    
                      https://api.onbuka.com/v3/voice/sipQuery
                    
                  

Request Sample:

                    
                      RequestURL:
                        https://api.onbuka.com/v3/voice/sipQuery
                      RequestMethod:
                        POST
                      RequestHeaders:
                        Content-Type:application/json;charset=UTF-8
                        Sign:05d7a50893e22a5c4bb3216ae3396c7c
                        Timestamp:1630468800
                        Api-Key:bDqJFiq9
                      RequestBody:
                        {
                          "current":1,
                          "size":10,
                          "params":{
                            "appId":"4luaKsL2"
                          }
                        }
                    
                  

Response Parameters Description:

Parameters Description Type

status

"0"means successful, others than 0 means failure, seeing Status code description.

String

reason

Failure reason description

String

data

Data on each page

JSONObject

total

Total record number

Int

size

Number displayed on each page

Int

current

Current page number

Int

pages

Total pages

Int

records

Data set

JSONArray

groupName

Name of phone group

String

phoneName

Phone name

String

account

Phone account

String

password

Phone password

String

displayNum

Phone display number

String

Response Sample:

                    
                      {
                        "status": "0",
                        "reason":" success",
                        "data": {
                          "total": 5,
                          "size": 20,
                          "current": 1,
                          "pages": 1,
                          "records":[
                            {
                              "groupName":"sipGroup",
                              "phoneName":"sip-1",
                              "account":"test_001",
                              "password":"LX9FZdF2",
                              "displayNum":"861000000"
                            }
                          ]
                        }
                      }
                    
                  
 

Previous Topic: Create Phone

Feedback

0/500

Need help?

Click here and start chatting with us!