Trunking
SIP Trunks allow to connect traditional PBXes to the platform. You can setup trunkgroups and connect numbers (aka DIDs) to them. A trunkgoup always requires access trunks. An access trunk is a point-to-point connection between the PBX and the fusion platform. A trunkgroup must have at least 1 but can have multiple access trunk.
List all SIP trunks of a subscription
Use this endpoint to retrieve all SIP trunks currently assigned to a subscription.
Request
Endpoint
GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups
Authorization
Required role
tenants.instance.subscriptions.instance.trunkgroups.list
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant to which the subscription belongs |
sub_id | integer | Index of the subscription for which you want to list the existing SIP trunks |
URL/Query parameters
N/A
Response
Status codes
| Parameter | Description |
|---|---|
200 | One or more SIP trunks found |
400 | Error while processing the request |
404 | No SIP trunk found for the specified subscription |
403 | The API consumer doesn't have sufficient rights to perform this action |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
trunkgroups | array | List containing all SIP trunks for the tenant | no |
SIP Trunk Summary Object
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
id | integer | Index of the SIP trunk | no |
name | string | Name of the SIP trunk | no |
external | boolean | Flag that indicates if a SIP trunk is configured as external | no |
Example
json
{
"trunkgroups": [
{
"id": 7,
"name": "My Cisco Trunk Group",
"external": false
},
{
"id": 8,
"name": "Xelion",
"external": true
}
]
}Get details of a specific SIP trunk
Use this endpoint to retrieve the details of a SIP trunk currently assigned to a subscription.
Request
Endpoint
GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{id}
Authorization
Required role
tenants.instance.subscriptions.instance.trunkgroups.read
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant to which the subscription belongs |
sub_id | integer | Index of the subscription for which you want to list the existing SIP trunks |
id | integer | Index of an existing SIP trunk |
URL/Query parameters
N/A
Response
Status codes
| Parameter | Description |
|---|---|
200 | Details of the SIP trunk could be retrieved |
400 | Error while processing the request |
404 | No SIP trunk found for the specified subscription and SIP trunk index |
403 | The API consumer doesn't have sufficient rights to perform this action |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
name | string | Name of the SIP trunk | no |
external | boolean | Flag that indicates if the SIP trunk is configured as external | no |
presentationFormat | string | Determines how the number should be presented on the trunk. This can be e164,national_with_0 or national_without_0 | no |
maxCalls | integer | Maximum simultaneous calls allowed for the SIP trunk | yes |
maxIncomingCalls | integer | Maximum incoming calls allowed for the SIP trunk | yes |
maxOutgoingCalls | integer | Maximum outgoing calls allowed for the SIP trunk | yes |
emergencyLocation | object | Emergency location as defined by this structure in common parameters | yes |
pilot | object | Object representing the pilot number of the trunk. Acts as main number | yes |
blockUnscreenedCalls | Boolean | Block calls that have a CLI that doesn't belong to this trunk | no |
overwiteUnscreenedCallsWithPilot | Boolean | Overwrite the CLI to the pilot number for calls with a CLI that doesn't belong to this trunk | no |
cfaActive | boolean | Flag enabling or disabling call forwarding always on the SIP trunk | no |
cfaDestination | string | Call forwarding always destination | no |
cfnrActive | boolean | Flag enabling or disabling call forwarding not reachable on the SIP trunk | no |
cfnrDestination | string | Call forwarding not reachable destination | no |
cfnrTimer | integer | Timer in seconds before call forwarding not reachable | no |
The role of an external SIP trunk
External SIP trunks are special trunks that do not follow the classical settings of non-external SIP trunks. They do not need a specific SBC configuration as this has been set once in a static way for all customers. A static trunk is set per default for every subscriptions if the group properties draas_external_trunkgroup_nameand draas_external_trunkgroup_name have been set. This external SIP trunk cannot be deleted and has a limited set of settings that may be managed.
Phone Number Object
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
id | integer | Index of the phone number | yes |
connectionId | integer | Index of the connection ID linking the phone number to the trunk | no |
fullNumber | string | Phone number in E.164 international format | no |
Example
json
{
"name": "My Cisco Trunk Group",
"external": false,
"presentationFormat": "e164",
"emergencyLocation": {
"id": 1,
"name": "Brussels"
},
"maxCalls": 10,
"pilot": {
"connectionId": 705,
"fullNumber": "+3225405387"
},
"blockUnscreenedCalls": false,
"overwiteUnscreenedCallsWithPilot": true,
"cfaActive": false,
"cfncActive": true,
"cfnrDestination": "+33613575607",
"cfnrTimer": 10,
"cfaActive": false,
"cfnrActive": true,
}Create a new SIP trunk
Use this endpoint to associate a new SIP trunk to a subscription
Request
Endpoint
POST /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups
Authorization
Required role
tenants.instance.subscriptions.instance.trunkgroups.create
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant to which the subscription belongs |
sub_id | integer | Index of the subscription to which you want to add a SIP trunk |
URL/Query parameters
N/A
Body
| Parameter | Type | Description | Required? |
|---|---|---|---|
name | string | Name of the new SIP trunk. This name must be unique within a subscription | yes |
presentationFormat | string | Determines how the number should be presented on the trunk. This can be e164,national_with_0 or national_without_0 | no |
maxCalls | integer | Maximum simultaneous calls allowed for the SIP trunk | no |
maxIncomingCalls | integer | Maximum incoming calls allowed for the SIP trunk | no |
maxOutgoingCalls | integer | Maximum outgoing calls allowed for the SIP trunk | no |
emergencyLocation | object | Emergency location as defined by this structure in common parameters | yes |
blockUnscreenedCalls | Boolean | Block calls that have a CLI that doesn't belong to this trunk | no |
overwiteUnscreenedCallsWithPilot | Boolean | Overwrite the CLI to the pilot number for calls with a CLI that doesn't belong to this trunk | no |
cfaActive | boolean | Flag enabling or disabling call forwarding always on the SIP trunk | no |
cfaDestination | string | Call forwarding always destination | no |
cfnrActive | boolean | Flag enabling or disabling call forwarding not reachable on the SIP trunk | no |
cfnrDestination | string | Call forwarding not reachable destination | no |
cfnrTimer | integer | Timer in seconds before call forwarding not reachable | no |
Example
json
{
"name": "My New SIP Trunk"
}Response
Status codes
| Parameter | Description |
|---|---|
200 | The SIP trunk was created successfully |
400 | Error while creating the SIP trunk |
403 | The API consumer doesn't have sufficient rights to perform this action |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
id | integer | Index of the created SIP trunk | no |
Example
json
{
"id": 7
}Modify an existing SIP trunk
Use this endpoint to modify an existing SIP trunk.
Request
Endpoint
PUT /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{id}
Authorization
Required role
tenants.instance.subscriptions.instance.trunkgroups.update
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant to which the subscription belongs |
sub_id | integer | Index of the subscription for which you want to list the existing SIP trunks |
id | integer | Index of an existing SIP trunk |
URL/Query parameters
N/A
Body
| Parameter | Type | Description | Required? |
|---|---|---|---|
name | string | Name of the new SIP trunk. This name must be unique within a subscription | yes |
presentationFormat | string | Determines how the number should be presented on the trunk. This can be e164,national_with_0 or national_without_0 | no |
maxCalls | integer | Maximum simultaneous calls allowed for the SIP trunk | no |
maxIncomingCalls | integer | Maximum incoming calls allowed for the SIP trunk | no |
maxOutgoingCalls | integer | Maximum outgoing calls allowed for the SIP trunk | no |
emergencyLocation | object | Emergency location as defined by this structure in common parameters | yes |
pilot | integer | Connection ID of the DID you want to assign as pilot | yes |
blockUnscreenedCalls | Boolean | Block calls that have a CLI that doesn't belong to this trunk | no |
overwiteUnscreenedCallsWithPilot | Boolean | Overwrite the CLI to the pilot number for calls with a CLI that doesn't belong to this trunk | no |
cfaActive | boolean | Flag enabling or disabling call forwarding always on the SIP trunk | no |
cfaDestination | string | Call forwarding always destination | no |
cfnrActive | boolean | Flag enabling or disabling call forwarding not reachable on the SIP trunk | no |
cfnrDestination | string | Call forwarding not reachable destination | no |
cfnrTimer | integer | Timer in seconds before call forwarding not reachable | no |
Response
Status codes
| Parameter | Description |
|---|---|
204 | SIP trunk has been updated |
400 | Error while processing the request |
404 | No SIP trunk found for the specified subscription and SIP trunk index |
403 | The API consumer doesn't have sufficient rights to perform this action |
500 | Uncatched error on server side |
Success
Body
N/A
Delete an existing SIP trunk
Use this endpoint to remove an existing SIP trunk from a subscription.
Request
Endpoint
DELETE /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{id}
Authorization
Required role
tenants.instance.subscriptions.instance.trunkgroups.delete
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant to which the subscription belongs |
sub_id | integer | Index of the subscription for which you want to list the existing SIP trunks |
id | integer | Index of an existing SIP trunk |
URL/Query parameters
N/A
Body
N/A
Response
Status codes
| Parameter | Description |
|---|---|
204 | SIP trunk has been deleted |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
500 | Uncatched error on server side |
Auto removing of phone numbers
If the SIP trunk still has numbers associated, the deletion bill be refused. Please make sure the numbers are disconnected from the trunk, prior to deleting the trunk.
Success
Body
N/A
Get numbers from a SIP trunk
Use this endpoint to get all phonenumbers connected to a trunk.
Request
Endpoint
GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{trunkgroup_id}/numbers
Authorization
Required role
tenants.instance.subscriptions.instance.trunkgroups.instance.numbers.list
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant to which the subscription belongs |
sub_id | integer | Index of the subscription to which the SIP trunk belongs |
trunkgroup_id | integer | Index of the SIP trunk |
URL/Query parameters
N/A
Body
N/A
Response
Status codes
| Parameter | Description |
|---|---|
204 | The phone numbers have been successfully removed (might be the complete list or a partial list) |
400 | Error while removing the phone numbers |
404 | No SIP trunk found for the specified subscription and SIP trunk index |
403 | The API consumer doesn't have sufficient rights to perform this action |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
numbers | array | Array of phone numbers that have been assigned to the SIP trunk | yes |
Phone Number Object
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
id | integer | Index of the phone number | yes |
connectionId | integer | Index of the connection ID linking the phone number to the trunk | no |
fullNumber | string | Phone number in E.164 international format | no |
Example
json
{
"numbers": [
{
"id": 872,
"connectionId": 137,
"fullNumber": "+3225405440"
},
{
"id": 1042,
"connectionId": 136,
"fullNumber": "+3225409843"
},
{
"id": 1043,
"connectionId": 135,
"fullNumber": "+3225409844"
}
]
}Add numbers to a SIP trunk
Use this endpoint to add phone numbers to an existing SIP trunk.
Request
Endpoint
POST /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{trunkgroup_id}/numbers
Authorization
Required role
tenants.instance.subscriptions.instance.trunkgroups.instance.numbers.create
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant to which the subscription belongs |
sub_id | integer | Index of the subscription to which the SIP trunk belongs |
trunkgroup_id | integer | Index of the SIP trunk |
URL/Query parameters
N/A
Body
| Parameter | Type | Description | Required? |
|---|---|---|---|
numbers | array | Array of numbers in e164 forma that you want to add | yes |
Example
json
{
"countryCode": "+32",
"numbers": [
"+3225405220",
"+3225405221",
"+3225405230",
"+3225405231",
]
}Response
Status codes
| Parameter | Description |
|---|---|
200 | The phone numbers have been successfully added (might be the complete list or a partial list) |
400 | Error while adding the phone numbers |
404 | No SIP trunk found for the specified subscription and SIP trunk index |
403 | The API consumer doesn't have sufficient rights to perform this action |
500 | Uncatched error on server side |
Remove numbers from a SIP trunk
Use this endpoint to remove phone numbers from an existing SIP trunk.
Request
Endpoint
DELETE /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{trunkgroup_id}/numbers
Authorization
Required role
tenants.instance.subscriptions.instance.trunkgroups.instance.numbers.delete
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant to which the subscription belongs |
sub_id | integer | Index of the subscription to which the SIP trunk belongs |
trunkgroup_id | integer | Index of the SIP trunk |
URL/Query parameters
N/A
Body
| Parameter | Type | Description | Required? |
|---|---|---|---|
connectionIds | array | Array of connection ID's used to link phone numbers to the SIP trunk as returned by this API | yes |
Example
json
{
"connectionIds": [
125,
138,
139
]
}Response
Status codes
| Parameter | Description |
|---|---|
204 | The phone numbers have been successfully removed (might be the complete list or a partial list) |
400 | Error while removing the phone numbers |
404 | No SIP trunk found for the specified subscription and SIP trunk index |
403 | The API consumer doesn't have sufficient rights to perform this action |
500 | Uncatched error on server side |
List all SIP access trunks linked to a SIP trunk
Use this endpoint to retrieve all SIP access trunks currently linked to a SIP trunk.
Request
Endpoint
GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{trunkgroup_id}/access_trunks
Authorization
Required role
tenants.instance.subscriptions.instance.trunkgroups.instance.access_trunks.list
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant to which the subscription belongs |
sub_id | integer | Index of the subscription for which you want to list the existing SIP access trunks |
trunkgroup_id | integer | Index of an existing SIP trunk |
URL/Query parameters
| Parameter | Type | Description | Required? |
|---|---|---|---|
search | string | Used to perform a search through all searchable properties of a SIP access trunk that look like the string passed | no |
sort | string | Allows to specify one searchable property of a SIP access trunk to apply a sorting operation | no |
dir | string | When performing a sort operation, specifies the type. Allowed values are asc for ascending (default) or desc for descending | no |
page_size | integer | Used for pagination, determines the maximum number of records on one page of results (defaults to 10) | no |
next | string | A token used to get the next records in the list. This token is taken back from the results of the previous call | no |
Response
Status codes
| Parameter | Description |
|---|---|
200 | One or more SIP access trunk found |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
404 | No SIP trunk found for the specified subscription and tenant |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
results | string | Total count of results that match your query | no |
pages | string | Total count of result pages that are available | no |
page | string | ID of the page that is currently returned | no |
next | string | A token used for infinite scrolling, to be used in the next call to retrieve subsequent records. Only present if the list of numbers has to be continued | yes |
accessTrunks | array | List containing all SIP access trunks for the tenant | no |
SIP Access Trunk Summary Object
| Parameter | Type | Description | Conditional? | Searchable? |
|---|---|---|---|---|
id | integer | Index of the SIP access trunk | no | no |
name | string | Name of the SIP access trunk | no | yes |
pop | array | 0ject describing the details of the Trunking access POP to which the trunk is connected | no | |
weight | integer | Weight applicable to this access trunk | no | no |
priority | integer | Priority applicable to this access trunk | no | no |
primaryPeerIp | string | IP address of your PBX | yes | yes |
primaryPeerPort | integer | Port of your PBX | yes | no |
ipWhitelist | string | A string giving a list of white listed IP addresses | yes | no |
authRequired | boolean | Flag indicating if authorization is required for this access trunk | no | no |
authUsername | string | Username used in authorization for this access trunk | no | no |
authPassword | string | Password used in authorization for this access trunk | no | no |
Trunking POP Object
| Parameter | Type | Description | Conditional? | Searchable? |
|---|---|---|---|---|
id | integer | Internal ID representing the access point in the network to which this trunk is connected | no | no |
name | string | Friendly name of the POP | no | no |
accessFQDN | string | FQDN that can be used by the PBX as outbound proxy | no | no |
accessPort | integer | UDP port to wh | no | no |
Example
json
"accessTrunks": [
{
"authRequired": false,
"id": 9,
"name": "Another CBUR Access Trunk Test",
"pop": {
"accessFQDN": "amsterdam.trunking.copaco.nl",
"id": "2",
"name": "Trunking Access Amsterdam"
},
"primaryPeerIp": "192.168.0.1",
"primaryPeerPort": 5060,
"priority": 1,
"weight": 5
},
{
"authRequired": false,
"id": 7,
"ipWhitelist": "192.168.0.1,192.168.1.1",
"name": "CBUR Access Trunk Test",
"pop": {
"accessFQDN": "eindhoven.trunking.copaco.nl",
"id": "1",
"name": "Trunking Access Eindhoven"
},
"primaryPeerIp": "10.0.0.1",
"primaryPeerPort": 5061,
"priority": 2,
"weight": 10
},
{
"authPassword": "2nice!",
"authRequired": true,
"authUsername": "brice",
"id": 10,
"name": "Modified CBUR Access Trunk Test",
"primaryPeerIp": "10.1.1.2",
"primaryPeerPort": 5061,
"priority": 2,
"weight": 5
}
],
"page": 1,
"pages": 1,
"results": 3
}Create a new SIP access trunk
Use this endpoint to associate a new SIP access trunk to an existing SIP trunk.
Request
Endpoint
POST /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{trunkgroup_id}/access_trunks
Authorization
Required role
tenants.instance.subscriptions.instance.trunkgroups.instance.access_trunks.create
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant to which the subscription belongs |
sub_id | integer | Index of the subscription to which you want to add a SIP access trunk |
trunkgroup_id | integer | Index of an existing SIP trunk |
URL/Query parameters
N/A
Body
| Parameter | Type | Description | Required? |
|---|---|---|---|
name | string | Name of the SIP access trunk | yes |
trunkingPopId | integer | Index of the associated trunking pop | no |
weight | integer | Weight applicable to this access trunk | no |
priority | integer | Priority applicable to this access trunk | no |
primaryPeerIp | string | IP address of your PBX | no |
primaryPeerPort | integer | Port of your PBX | no |
ipWhitelist | string | A string giving a list of white listed IP addresses | no |
authRequired | boolean | Flag indicating if authorization is required for this access trunk | no |
authUsername | string | Username used in authorization for this access trunk | no |
authPassword | string | Password used in authorization for this access trunk | no |
Business Rules
If authorization is required, then the primary peer IP is not mandatory. If authorization is not required, then one of those IP addresses is required.
Example
json
{
"name": "CBUR Access Trunk Test",
"weight": 10,
"priority": 2,
"primaryPeerIP": "10.0.0.1",
"primaryPeerPort": 5061,
"ipWhitelist": "192.168.0.1,192.168.1.1",
"authRequired": true,
"authUsername": "brice",
"authPassword": "2nice!"
}Response
Status codes
| Parameter | Description |
|---|---|
200 | SIP access trunk has been added |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
404 | No SIP trunk found for the specified subscription and tenant |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
id | integer | Index of the created SIP access trunk | no |
Example
json
{
"id": 12
}Modify an existing SIP access trunk
Use this endpoint to modify an existing SIP access trunk.
Request
Endpoint
PUT /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{trunkgroup_id}/access_trunks/{id}
Authorization
Required role
tenants.instance.subscriptions.instance.trunkgroups.instance.access_trunks.instance.update
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant to which the subscription belongs |
sub_id | integer | Index of the subscription for which you want to modify the existing SIP access trunk |
trunkgroup_id | integer | Index of an existing SIP trunk |
URL/Query parameters
N/A
Body
| Parameter | Type | Description | Required? |
|---|---|---|---|
name | string | Name of the SIP access trunk | no |
trunkingPopId | integer | Index of the associated trunking pop | no |
weight | integer | Weight applicable to this access trunk | no |
priority | integer | Priority applicable to this access trunk | no |
primaryPeerIp | string or null | IP address of your PBX. Set to null to remove | no |
primaryPeerPort | integer | Port of your PBX | no |
ipWhitelist | string or null | A string giving a list of white listed IP addresses. Set to null to remove | no |
authRequired | boolean | Flag indicating if authorization is required for this access trunk | no |
authUsername | string or null | Username used in authorization for this access trunk. Set to null to remove | no |
authPassword | string or null | Password used in authorization for this access trunk. Set to null to remove | no |
Business Rules
If authorization is required, then the primary peer IP is not mandatory. If authorization is not required, then one of those IP addresses is required. This is checked against new provided data and existing data for coherence.
Example
json
{
"name": "Modified CBUR Access Trunk Test",
"weight": 5,
"priority": 2,
"primaryPeerIp": "10.1.1.2",
"ipWhitelist": null,
"authRequired": false,
"authUsername": null,
"authPassword": null
}Response
Status codes
| Parameter | Description |
|---|---|
204 | SIP access trunk has been modified |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
404 | No SIP trunk found for the specified subscription and tenant |
500 | Uncatched error on server side |
Success
Body
N/A
Delete an existing SIP access trunk
Use this endpoint to remove an existing SIP access trunk from an existing SIP trunk.
Request
Endpoint
DELETE /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{trunkgroup_id}/access_trunks/{id}
Authorization
Required role
tenants.instance.subscriptions.instance.trunkgroups.instance.access_trunks.instance.delete
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant to which the subscription belongs |
sub_id | integer | Index of the subscription for which you want to delete the SIP access trunk |
trunkgroup_id | integer | Index of an existing SIP trunk |
id | integer | Index of an existing SIP access trunk linked to the SIP trunk |
URL/Query parameters
N/A
Body
N/A
Response
Status codes
| Parameter | Description |
|---|---|
204 | SIP access trunk has been deleted |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
404 | No SIP trunk found for the specified subscription and tenant |
500 | Uncatched error on server side |
Success
Body
N/A