Edit a SIP Trunk
Change the settings of a SIP trunk.
Request URL
POST {base_url}/{api_path}/trunk/update?access_token={access_token}
Request parameters
- Edit a Register trunk
-
Table 1. Parameter Required Type Description id Yes Integer The unique ID of a trunk. Note: You can query trunk's ID using Search Specific Trunks.name No String Trunk name. enable No Integer Whether to enable or disable the trunk. Valid value:
-
0
: Disabled -
1
: Enabled
transport No String Transport protocol. Valid value:
udp
tcp
tls
dnsnaptr
hostname No String The domain or IP address of the ITSP. port No Integer The registration port of the SIP trunk. domain No String The domain or IP address of the ITSP. username No String The username of the SIP account that is provided by the ITSP. password No String The password of the SIP account. auth_name No String The authentication name that is provided by the ITSP. enb_outbound_proxy No Integer Whether to enable an outbound proxy. Valid value:
-
0
: Disable -
1
: Enable
outbound_proxy_server No String The domain name or IP address of the outbound proxy server. outbound_proxy_port No Integer The port of the outbound proxy server. codec_sel No String Codec settings of the trunk. Valid value:
ulaw
alaw
g729
gsm
h264
h263
h263p
ilbc
g722
g726
speex
adpcm
mpeg4
vp8
def_outbound_cid No String Default outbound caller ID. def_outbound_cid_name No String Default outbound caller ID name. outbound_cid_list No Array <OutCaller_Info> The information of customized outbound caller ID for specific extensions.
did_list No Array <DID_List> DID information associated with the trunk. -
- Edit a Peer trunk
-
Table 5. Parameter Required Type Description id Yes Integer The unique ID of a trunk. Note: You can query trunk's ID using Search Specific Trunks.name No String Trunk name. enable No Integer Whether to enable or disable the trunk. Valid value:
-
0
: Disable -
1
: Enable
transport No String Transport protocol. Valid value:udp
tcp
tls
dnsnaptr
hostname No String The domain or IP address of the ITSP. port No Integer The registration port of the SIP trunk. domain No String The domain or IP address of the ITSP. codec_sel No String Codec settings of the trunk. Valid value:ulaw
alaw
g729
gsm
h264
h263
h263p
ilbc
g722
g726
speex
adpcm
mpeg4
vp8
def_outbound_cid No String Default outbound caller ID. def_outbound_cid_name No String Default outbound caller ID name. outbound_cid_list No Array <OutCaller_Info> The information of customized outbound caller ID for specific extensions.
did_list No Array <DID_List> DID information associated with the trunk. -
- Edit an Account trunk
-
Table 9. Parameter Required Type Description id Yes Integer The unique ID of a trunk. Note: You can query trunk's ID using Search Specific Trunks.name No String Trunk name. enable No Integer Whether to enable or disable the trunk. Valid value:
-
0
: Disable -
1
: Enable
transport No String Transport protocol. Valid value:udp
tcp
tls
username No String The user name of the SIP account trunk. password No String The password associated with the username. auth_name No String The authentication name for a third-party device to register with. codec_sel No String Codec settings of the trunk. Valid value:ulaw
alaw
g729
gsm
h264
h263
h263p
ilbc
g722
g726
speex
adpcm
mpeg4
vp8
def_outbound_cid No String Default outbound caller ID. def_outbound_cid_name No String Default outbound caller ID name. outbound_cid_list No Array <OutCaller_Info> The information of customized outbound caller ID for specific extensions.
-
Response parameters
Parameter | Type | Description |
---|---|---|
errcode | Integer | Returned error code.
Note: You can check the error code and
error message in Error Code and Error Message.
|
errmsg | String | Returned message.
|
Examples
Request example
Change the name of an account trunk (ID: 28) to "test-account-trunking".
POST /openapi/v1.0/trunk/update?access_token=7Vr1qX3sY6UjtocCs9WNLxikkap63Wsy HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json
{
"id": 28,
"name": "test-account-trunking"
}
Response example
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS"
}