Group Trunk Group¶

Display group’s trunk group list¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/trunk_groups/¶: The API is mapped to GroupTrunkGroupGetInstanceListRequest

Add group’s trunk group¶

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/trunk_groups/¶

The API is mapped to GroupTrunkGroupAddInstanceRequest

Additional information:

Request JSON Object:

maxActiveCalls (integer) – the maximum number of concurrent active trunk calls. Value >= 1.
maxIncomingCalls (integer) – can only be 0 (no calls allowed) with OCI 21 and later.
maxOutgoingCalls (integer) – can only be 0 (no calls allowed) with OCI 21 and later.

Display group’s trunk group¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/trunk_groups/(string: instance_name)/¶

The API is mapped to GroupTrunkGroupGetInstanceRequest

Additional information:

Response JSON Object:

maxActiveCalls (integer) – the maximum number of concurrent active trunk calls. Value >= 1.
invitationTimeout (integer) – Value between 1 and 15 (extremes included).
pilotUserCallingLineIdentityForExternalCallsPolicy (string) – the policy of the pilot user for calling line identity in presence of external calls. One of ‘All Originating Calls’, ‘Unscreened Originating Calls’, ‘No Calls’
pilotUserChargeNumberPolicy (string) – One of ‘All Originating Calls’, ‘Unscreened Originating Calls’, ‘No Calls’
continuousOptionsSendingIntervalSeconds (integer) – the interval in seconds between one OPTIONS message and the other. Value between 30 and 86400 (extremes included).
failureOptionsSendingIntervalSeconds (integer) – the interval in seconds between a failure and the next OPTIONS message. Value between 10 and 86400 (extremes included).
failureThresholdCounter (integer) – the max number of failures allowed. Value between 1 and 60 (extremes included).
successThresholdCounter (integer) – the max number of successes allowed. Value between 1 and 60 (extremes included).
inviteFailureThresholdCounter (integer) – the max number of failures allowed for INVITE messages. Value between 1 and 60 (extremes included).
inviteFailureThresholdWindowSeconds (integer) – the window in seconds to wait for an INVITE message to fail. Value between 30 and 240 (extremes included).
pilotUserCallingLineAssertedIdentityPolicy (string) – the calling line asserted identity policy of the pilot user. One of ‘All Originating Calls’, ‘Unscreened Originating Calls’
pilotUserCallOptimizationPolicy (string) – the call optimization policy of the pilot user. One of ‘Optimize For User Services’, ‘Optimize For High Call Volume’
clidSourceForScreenedCallsPolicy (string) – the calling line ID source for screened calls policy of the pilot user. One of ‘Profile Name Profile Number’, ‘Received Name Profile Number’, ‘Received Name Received Number’
userLookupPolicy (string) – the lookup policy of the pilot user. One of ‘Basic’, ‘Extended’
pilotUserCallingLineIdentityForEmergencyCallsPolicy (string) – the calling line identity for emergency calls policy of the pilot user. One of ‘All Originating Calls’, ‘Unscreened Originating Calls’, ‘No Calls’

Update group’s trunk group¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/trunk_groups/(string: instance_name)/¶

The API is mapped to GroupTrunkGroupModifyInstanceRequest

Additional information:

Request JSON Object:

maxActiveCalls (integer) – the maximum number of concurrent active trunk calls. Value <= 1.
maxIncomingCalls (integer) – can only be 0 (no calls allowed) with OCI 21 and later.
maxOutgoingCalls (integer) – can only be 0 (no calls allowed) with OCI 21 and later.
invitationTimeout (integer) – Value between 1 and 15 (extremes included).
pilotUserCallingLineIdentityForExternalCallsPolicy (string) – the policy of the pilot user for calling line identity in presence of external calls. One of ‘All Originating Calls’, ‘Unscreened Originating Calls’, ‘No Calls’
pilotUserChargeNumberPolicy (string) – One of ‘All Originating Calls’, ‘Unscreened Originating Calls’, ‘No Calls’
continuousOptionsSendingIntervalSeconds (integer) – the interval in seconds between one OPTIONS message and the other. Value between 30 and 86400 (extremes included).
failureOptionsSendingIntervalSeconds (integer) – the interval in seconds between a failure and the next OPTIONS message. Value between 10 and 86400 (extremes included).
failureThresholdCounter (integer) – the max number of failures allowed. Value between 1 and 60 (extremes included).
successThresholdCounter (integer) – the max number of successes allowed. Value between 1 and 60 (extremes included).
inviteFailureThresholdCounter (integer) – the max number of failures allowed for INVITE messages. Value between 1 and 60 (extremes included).
inviteFailureThresholdWindowSeconds (integer) – the window in seconds to wait for an INVITE message to fail. Value between 30 and 240 (extremes included).
pilotUserCallingLineAssertedIdentityPolicy (string) – the calling line asserted identity policy of the pilot user. One of ‘All Originating Calls’, ‘Unscreened Originating Calls’
pilotUserCallOptimizationPolicy (string) – the call optimization policy of the pilot user. One of ‘Optimize For User Services’, ‘Optimize For High Call Volume’
clidSourceForScreenedCallsPolicy (string) – the calling line ID source for screened calls policy of the pilot user. One of ‘Profile Name Profile Number’, ‘Received Name Profile Number’, ‘Received Name Received Number’
userLookupPolicy (string) – the lookup policy of the pilot user. One of ‘Basic’, ‘Extended’
pilotUserCallingLineIdentityForEmergencyCallsPolicy (string) – the calling line identity for emergency calls policy of the pilot user. One of ‘All Originating Calls’, ‘Unscreened Originating Calls’, ‘No Calls’

Delete a group’s announcement¶

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/trunk_groups/(string: instance_name)/¶: The API is mapped to GroupTrunkGroupDeleteInstanceRequest

Display group’s trunk group backup details¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/trunk_groups/(string: instance_name)/backup/¶: Virtual API not supported by Broadsoft

Update group’s trunk group backup details¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/trunk_groups/(string: instance_name)/backup/¶: Virtual API not supported by Broadsoft