Get Specific Dial plan Contents

The Get Specific Dial plan Contents request retrieves a list of numbers (dial plan rules) contained in a specific dial plan for a specific SIP Connection.

URI

Copy

{{baseUrl}}/api/v2/customer/{customerGuid}/sitelocation/{{siteLocationId}}/dialplan/{dialplanId}

HTTP Method

GET

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

Parameters	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.

Example Response

Copy

{
    "dialPlanId": "CustDialPlan",
    "ruleDTO": [
        {
            "name": "TobiEssentCAC",
            "prefix": "+31235556123",
            "tag": "sbctest.nl"
        },
        {
            "name": "TobiEssentCAC",
            "prefix": "+972542566110",
            "tag": "audiocodesru.sbc.com"
        },
        {
            "name": "TobiEssentCAC",
            "prefix": "+972542566111",
            "tag": "audiocodesru.sbc.com"
        }
    ]
}

HTTP Responses

■

200 OK

Parameter	Type	Description
dialPlanId	string	The Dial plan name.
RuleDTO
name	string	The name of the SIP Connection according to 'sitelocationGuid' above.
prefix	string	The calling prefixes to add for users for this SIP Connection. For example "{{+019123854567}}".
tag	string	The Derived Trunk FQDN of the SBC device used to manage calls for this site location. For example, sandbox1.audiocodes.be If a number is added with a tag that is not an AudioCodes SBC PSTN gateway, then for the purpose of User licensing calculations, its counted as a Service Number license factor. For more information, see User Licenses.

■

400 Bad Request

The table below shows the full list of fields returned in this response. The actual fields returned may differ according to the request.

Parameter	Type	Description
type	string	Error type
title	string	Email title
status	integer	StatusCodes.Status400BadRequest
detail	string	Additional error details.
instance	string	HttpContext.Request.Path
errorTicket	string	errId.ToString()
errorCode	string	Error code output in the request
traceId	string	HttpContext.TraceIdentifier
additionalProp1	string	Error related to Custom script parameter
additionalProp2	string	Error related to Custom script parameter
additionalProp3	string	Error related to Custom script parameter

■

403 Forbidden: This error is raised when the specified Request parameters are not associated with the channel specified in the Header 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"

■

404 Not Found

The table below shows the full list of fields returned in this response. The actual fields returned may differ according to the request.

Parameter	Type	Description
type	string	Error type
title	string	Email title
status	integer	StatusCodes.Status400BadRequest
detail	string	Additional error details.
instance	string	HttpContext.Request.Path
errorTicket	string	errId.ToString()
errorCode	string	Error code output in the request
traceId	string	HttpContext.TraceIdentifier
additionalProp1	string	Error related to Custom script parameter
additionalProp2	string	Error related to Custom script parameter
additionalProp3	string	Error related to Custom script parameter

■

500 Internal Server Error