Delete Specific SIP Connections

The Delete Specific SIP Connections request removes a SIP Connection from Live Platform .

URI

Copy

{{baseUrl}}/api/v2/sitelocation/{sbcSiteGuid}

HTTP Method

DELETE

Request Parameter

Parameter	Type	Description
sbcSiteGuid	string $uuid	The Unique Id for the SIP Connection (Site Location). Retrieve value "Id" using the Get Details for Specific Service Get Details for Specific Service request; search for the SIP Connection that you wish to remove and then copy the respective 'Id".

Parameter

Type

Description

sbcSiteGuid

string $uuid

The Unique Id for the SIP Connection (Site Location). Retrieve value "Id" using the Get Details for Specific Service

Get Details for Specific Service request; search for the SIP Connection that you wish to remove and then copy the respective 'Id".

Example Response

The initial response displays the Task Id.

Parameter	Type	Description
sbcCleanupTaskId	string	The queued task Id that is generated for this action. You must run the Task request to retrieve the status of the action. See Task Status. Note that the wup string in the prefix is unique for this request.

Copy

{
    "status": true,
    "msg": "queued",
    "sbcCleanupTaskId": "tsk_841026",
    "o365CleanupTask": "tsk_0"
}

Once the request has been executed, the "Completed Success" status is displayed. You can run the Get Details for Specific Service request to confirm that the SIP Connection has been removed.

Copy

{
    "id": "tsk_841026",
    "status": "CompletedSuccess",
    "details": [
        null
    ],
    "executionMessages": [],
    "outputData": {}
}

HTTP Responses

■

200 OK

■

403 Forbidden:

Parameter	Type	Description/Examples
errors	string	Text description of the error.
type	string	"https://tools.ietf.org/html/rfc7231#section-6.5.1"
title	string	Email title. For example "One or more validation errors occurred."
status	error code	HTML error code i.e. 400
detail	string	Additional error details.
traceId	string	Error trace Id
instance	string	Error instance
errorTicket	string	This field may not appear for all return codes.
errorCode	string	This field may not appear for all return codes.
additionalProp1	string	Custom Script variable argument. For example "CacProfile": "5 sessions"
additionalProp2	string	Custom Script argument. For example, ProxySet": "SIPTrunk",
additionalProp3	string	Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be"

■

404 Not Found

Parameter	Type	Description/Examples
errors	string	Text description of the error.
type	string	"https://tools.ietf.org/html/rfc7231#section-6.5.1"
title	string	Email title. For example "One or more validation errors occurred."
status	error code	HTML error code i.e. 400
detail	string	Additional error details.
traceId	string	Error trace Id
instance	string	Error instance
errorTicket	string	This field may not appear for all return codes.
errorCode	string	This field may not appear for all return codes.
additionalProp1	string	Custom Script variable argument. For example "CacProfile": "5 sessions"
additionalProp2	string	Custom Script argument. For example, ProxySet": "SIPTrunk",
additionalProp3	string	Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be"