Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Method: POST /rest/siptrunkgroup/{identifier}

Modifies a SIP Trunk Group given a specific Entry ID.

URL:

https://192.168.0.111/rest/siptrunkgroup/{identifier}

HTTP Method

POST

Requires Authentication:

true

Noprint
Panel
bgColortransparent
titleBGColor#DDD
title[siptrunkgroup - REST API Methods|Resource - siptrunkgroup]

Page Tree
root@parent

Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
DescriptionNoNostringnone64 - Max LengthShort description of the SIP Trunk Group.
TypeYesYesEnum0Possible values:
  • 0 - eTgDtgOtg
  • 1 - eTgTgrp
The type of SIP Trunk Group.
TrunkGroupIDYesYesstringnone64 - Max LengthThe ID of this Trunk Group.
TrunkContextNoYesstringnone255 - Max LengthThe trunk-context of this Trunk Group. Mandatory for Trunk Groups of the TGRP type. Not applicable for DTG/OTG Trunk Groups.
SignalingGroupListYesYesstring140 - Max LengthSpecifies the Signaling Groups to be associated with this Trunk Group provided as a comma-separated string of the Signaling Group IDs
IncludeIDInOutboundCallsYesNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether the Trunk Group ID should be applied to invites originating from this trunk group. Note this will be either the OTG or the TGRP parameter depending on the Type configuration.
UseIDForRoutingInboundCallsYesNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether the Trunk Group ID is used when routing invites destined to this trunk group. Note this will be either the DTG or the TGRP parameter depending on the Type configuration.

Tip
titleHelpful Tip

The POST can contain either only the attributes that are being updated, or the full set of attributes for the resource