List SIP trunks

GET

/accounts/{accountId}/sip_trunk/trunks

With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers’ IP telephony network, will be connected over this trunk rather than over the PSTN.

Use this API to list all the SIP trunks assigned to a master account or a sub account of the master account. To retrieve SIP trunks assigned to a sub account, provide the account ID of the sub account in the accountId path parameter. To retrieve SIP trunks of a master account, provide me as the value of the accountId path parameter.

Scope: sip_trunk:read:admin

Prerequisites:

The account must either be a master account or a sub account with API Partner Plan and SIP Connected Audio Plan.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/accounts//sip_trunk/trunks'

响应示例

200 - response

{
    "sip_trunks": [
        {
            "dnis": "90001258",
            "id": "268",
            "name": "test1",
            "number_prefix": "0",
            "sip_server_address": "111.111.1.1"
        },
        {
            "dnis": "80001748",
            "id": "281",
            "name": "test2",
            "number_prefix": "0",
            "sip_server_address": "111.111.1.34"
        }
    ],
    "total_records": 1
}

请求参数

Path 参数

accountId

string

必需

Unique Identifier of the Account. To retrieve SIP trunks assigned to a sub account, provide the account ID of the sub account in the as the value of this field. To retrieve SIP trunks of a master account, provide me as the value of this field.

返回响应

🟢200**HTTP Status Code:** `200` **OK** List of SIP Trunks returned.

application/json

Body

sip_trunks

array [object {6}]

可选

dnis

string

可选

DNIS of the SIP trunk.

string

可选

Unique identifier of the sip trunk.

name

string

可选

Name assigned to the SIP trunk.

number_prefix

string

可选

Prefix of the SIP Connected Audio phone number.

outbound_caller_id

string

可选

Outbound caller Id assigned to the trunk.

sip_server_address

string

可选

IP address or domain of the SIP trunk.

total_records

integer

可选

Total number of records returned.

🟠400**HTTP Status Code:** `400` **Bad Request** **Error Code:** `300` Request failed because this account is not enrolled in SIP Connected Audio plan.

🟠404**HTTP Status Code:** `404` **Not Found** **Error Code:** `2001` Account does not exist: {0}.

修改于 2024-04-24 09:06:48

Assign SIP trunk configuration

Assign SIP trunks