Delete Dial plan
The Delete Dial plan request allows deletes a specific dial plan for a SIP Connection.
URI
{{baseUrl}}/api/v2/customer/{customerGuid}/sitelocation/{sitelocationGuid}/dialplan/{dialplanId}HTTP Method
DELETE
Request Headers
You can alternatively specify either of the following headers, both of which return identical output.
|
Attribute |
Type |
Description |
|---|---|---|
|
X-Ovoc-Channel-Id |
integer |
The Live Platform channel id. When specified, data is scoped to only customers belonging to the specified channel. See Get List of Channels to extract this value. |
|
X-IAM-Account-Id |
string |
The Live Platform iamAccountId of the channel. When specified, data is scoped to only customers belonging to the specified channel. See Get List of Channels to extract this value. |
Request Parameters
|
Parameter |
Type |
Mandatory |
Description |
|---|---|---|---|
|
customerGuid |
string($uuid) |
Ö |
Unique customer 'Id' created when customer is added. Extract this value from Get Services Brief Details (V3) request. |
|
sitelocationId |
string($uuid) |
Ö |
Unique Id for SIP Connection (Site Location). For services with a single site, this value is identical to Customer 'Id' above. Extract this value from Get Services Brief Details (V3) request. |
|
dialplanId |
string($uuid) |
Ö |
The dial plan name. For example, CustDialPlan. |
HTTP Responses
| ■ | 200 OK |
Example Response
The initial response displays the Task Id.
|
Parameter |
Type |
Description |
|---|---|---|
|
taskId |
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 tsk_ms_job string in the prefix is unique for this endpoint. |
{
"tsk_msjob_0a57213a-351a-42cc-92db-c00eb29fb465"
}The execution of the request may take a few minutes. The status will progress from 'In Progress' to 'Completed Success'.
| ■ | 204 No content to delete: This error is raised when the dial plan exists, however there are has no rules to remove. |
| ■ | 400 Bad Request: |
|
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" |
| ■ | 403 Forbidden: This error is raised when the Request parameters are not associated with the channel specified in the Request header. |
|
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 Dial plan not found: The specified dial plan does not exist for a specific customer and SIP Connection. |
| ■ | 409 Conflict Detected: Duplicate telephone numbers are detected in pending operations . |
| ■ | 500 Internal Server Error |
|
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" |