Get Online PSTN Gateway for Specific Customer

The request retrieves a list of Online PSTN Gateways that are configured for a specific customer.

HTTP Method

GET

URI

Copy 
{{baseUrl}}/api/v3/customer/{CustomerGuid}/onlinepstngateway

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

Description

CustomerGuid

string($guid)

'umpCustomerGuid' value created in the Live Platform customer tenant SQL database directory:

■ Operator Connect: A new OC Essentials service is created when a license is applied to the lead using Create Service from Lead Overview). If this field is null, a license has not yet been applied to the lead.
■ Direct Routing: A new Hosted Essentials service is created by Create Hosted Essentials Service.

This value is also obtained in the 'Get Task' response when the customer service is created.

Example Response

The initial response displays the Task Id.

Parameter

Type

Description

Task Id

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 endpoint.
Copy 
{
    "taskId": "wup_c14a0a55-fcc5-4598-b405-c978e7da1af4"
}

The execution of the request may take a few minutes. The status will progress from "In Progress" to "Completed Success".

Copy
Copy 
[
    {
        "fqdn": "milano.sandbox3.audiocodes.be",
        "trunkModel": "DerivedTrunk"
    },
    {
        "fqdn": "m365x88141009.onmicrosoft.com",
        "trunkModel": "AzureAdDomainOnly"
    },
    {
        "fqdn": "brad444pro.sandbox3.audiocodes.be",
        "trunkModel": "AzureAdDomainOnly"
    },
    {
        "fqdn": "mikeservice.sandbox3.audiocodes.be",
        "trunkModel": "AzureAdDomainOnly"
    }
]

HTTP Responses

■ 200 OK

Attribute

Type

Description

FQDN

string

Sub domain of the customer SIP Connection in the following format <SIPConnectionName>.<SBCDomainName>

Where <SIPConnectionName> is the Live Platform SIP entity for the customer site used to connect to the SBC and <SBCDomainName> is the FQDN of the SBC device attached to the SIP Connection.

Trunk Model

string

The trunk type used in multi‑tenant Direct Routing hosting scenarios where the SBC (Session Border Controller) is managed by a carrier/hoster and services many customer tenants.

■ Derived Trunk: Customer user calls are routed directly through the Service Provider SBC generated-trunk Hosted Direct Routing infrastructure
■ AzureAdDomainOnly: Domain that is registered in Azure AD only and not enabled for SIP Voice. Calls for this SIP connection are routed through the Derived Trunk.
■ 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 CustomerGuid specified in the Request parameter does not belong to 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 No Found: For example, customers have been registered however have not yet been deployed.

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"
■ 500 Internal Server Error