Assign SIP trunks

POST

/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 assign SIP trunk(s) that are available on a master account to a sub account.
Prerequisites:

The account making this API request must be a master account with API Partner Plan and SIP Connected Audio Plan.

Scope: sip_trunk:master

请求示例

Shell

JavaScript

Java

Swift

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

响应示例

201 - response

{
    "sip_trunks": [
        {
            "dnis": "dolore43tr4u",
            "id": "represdf324fe",
            "name": "HQ-trunk",
            "number_prefix": "0",
            "sip_server_address": "1.11.123.123"
        }
    ]
}

请求参数

Path 参数

accountId

string

必需

Unique Identifier of the sub account.

Body 参数multipart/form-data

sip_trunks

array [object {3}]

可选

Array of one or more SIP Trunk objects.

>= 1 items<= 30 items

dnis

string

可选

DNIS of the sub account. The prefix of the DNIS (i.e. the first five digits of the DNIS value) must match the DNIS prefix of the master account. To retrieve the DNIS prefix of a master account's SIP Trunk, use the List SIP Trunks API and refer to the first five digits in the dnis value.

For example, if the DNIS of the master account is 1888812345, the DNIS of the sub account must comprise of "18888" + "random_number". The maximum allowed length of the DNIS is 8.

>= 5 字符<= 8 字符

string

可选

Unique identifier of the SIP trunk that will be assigned to the sub account. The value of this field can be retrieved by listing the SIP Trunks of a master account using List SIP Trunks API.

outbound_caller_id

string

可选

Assign an outbound caller Id to the trunk.

<= 32 字符

返回响应

🟢201**HTTP Status Code:** `204` **No Content** SIP Trunk assigned successfully.

application/json

Body

sip_trunks

array [object {5}]

可选

dnis

string

可选

DNIS - identifier for the SIP trunk enabled account.

string

可选

Unique identifier of the SIP trunk.

name

string

可选

Name of the SIP trunk.

number_prefix

string

可选

If the value of this field is "0", it means that all the calls will be routed through this special line. All other values indicate the prefix of the phone number.

sip_server_address

string

可选

IP Address or domain of the SIP trunk.

🟠400**HTTP Status Code:** `400` **Bad Request** **Error Code:** `300` * Request failed because this account is not enrolled in SIP Connected Audio plan. * The master account has no sip trunk configs. * Invalid parameter: sip_trunks.

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

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

List SIP trunks

Delete a SIP trunk