Home Support SMS API

Query SIP Trunk List

Description: Query SIP trunk list.

Request Parameters Description:

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

type

SIP trunk type，1-outgoing call, 2 incoming call

No

Integer

sipTrunkName

SIP trunk name, fuzzy query

No

String

Request URL：

                    
                        https://api.onbuka.com/v3/cc/sipTrunk/query

Request Sample:

                                                
                                                    Request URL:
                                                        https://api.onbuka.com/v3/cc/sipTrunk/query
                                                    Request Method:
                                                        POST
                                                    Request Headers:
                                                        Content-Type: application/json;charset=UTF-8
                                                        Sign: 05d7a50893e22a5c4bb3216ae3396c7c
                                                        Timestamp: 1630468800
                                                        Api-Key: bDqJFiq9
                                                    Request Body:
                                                    {
                                                        "current":1,
                                                        "size":15,
                                                        "params":{
                                                            "type": 1,
                                                            "sipTrunkName":"12"
                                                        }
                                                    }

Response Parameters Description：

Parameters Description Type

status

status code，0 is successful. For other failures, please refer to the interface response code

String

reason

Failure reason description

String

data

collection of objects

JSONArray

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

keyId

Primary key id

Integer

sipGatewayIp

Sip gateway ip

String

sipWhiteIp

Sip whitelist ip

String

type

SIP trunk type，1-outgoing call, 2 incoming call

Integer

state

Status: 0 disabled 1 enabled

Integer

sipTrunkName

SIP trunk name

String

sipPrefix

SIP trunk prefix

String

ccIp

Call center IP

String

sipAccount

Sip registration account

String

sipPassword

Sip registration password

String

sipTrunkState

Gateway status

Boolean

createTime

Creation time

DateTime

updateTime

Update Time

DateTime

groupList

JSONObject

voiceGroupId

Bind Agent group ID

Long

groupName

Bind agent group name

String

number

Phone number after binding agent group

String

Response Sample:

                                                
                                                    {
                                                        "status": 0,
                                                        "reason": "success",
                                                        "data": {
                                                            "total": 1,
                                                            "size": 50,
                                                            "current": 1,
                                                            "searchCount": true,
                                                            "pages": 1,
                                                            "records": [
                                                                {
                                                                    "keyId": 5000028,
                                                                    "sipGatewayIp": "12.325.353.2",
                                                                    "sipWhiteIp": null,
                                                                    "type": 1,
                                                                    "state": 1,
                                                                    "sipTrunkName": "22232",
                                                                    "sipPrefix": null,
                                                                    "ccIp": "0000.000.0.00",
                                                                    "createTime": "2025-01-10 11:31:21",
                                                                    "updateTime": "2025-01-10 11:31:21",
                                                                    "groupList": [
                                                                        {
                                                                            "groupId": 1000026,
                                                                            "groupName": "groupName1",
                                                                            "number": null,
                                                                        }
                                                                    ],
                                                                    "sipAccount": null,
                                                                    "sipPassword": null,
                                                                    "sipTrunkState": false
                                                                }
                                                            ]
                                                        }
                                                    }
 
Previous Topic: Recording File Deletion
Next Topic: BUKA SDK

Feedback

0/500
✖
Service Support
1. Requirements Type
2. Requirements Description
3. Email

Need help?

Click here and start chatting with us!