Modify SIP Connection

The Modify SIP Connection request lets you modify a SIP Connection for the customer.

URL

Copy 
{{baseUrl}}/api/v2/customer/{customerGuid}/sitelocation/

HTTP Method

PATCH

Request Parameter

Parameter

Type

Description

customerGuid

string($uuid)

CustomerGuid' 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: The unique Id created for the Hosted Essentials service Create Hosted Essentials Service.

Extract this value using Get Services Brief Details (V3) or Get Customers Brief Details (V2) searching for the matching Short Name of the service.

sbcSiteGuid

string($uuid)

The unique id for the SIP Connection (site location). Extract this value using Get Details for Specific Service request by searching in the response for the matching site name under the Site Location array 'id' value. See example below:

Copy 
"Id": "806664bf-5380-44b6-b7ee-ab9c443cc284",
"ShortName": "BradTest3",
"FullName": "BradTest3",
"LicenseType": 2,
"SiteLocation": [
{
"id": "0ce9ce2f-04e2-4746-b436-f68b8ad82a9a",
"name": "GSBGHDLVPZBSS",
"sbcId": 5,
"sbcDeploymentState": "Deployed"
},
{
"id": "548b7e8f-9a27-47f4-8c5b-382d4e4c5a3b",
"name": "Brad1010",
"sbcId": 5,
"sbcDeploymentState": "Deployed"
}
]

Request Body

Parameter

Type

Description

sbcId

integer

The SBC Id in the Live Platform database (see Get SBC Devices) for SBC devices added directly from UMP-365.

sbcSiteName

string

Name of the site location (equivalent to the 'name' field in the Location array (see example above) that is retrieved through the Get Details for Specific Service request.

CacProfile

string

Defines the desired number of Call Admission Control (CAC) call sessions. For example, "10 sessions". This value also represents the name of the CAC profile. See Get SBC Devices for retrieving CAC profiles.

enableCAC

boolean Default: true

Determines whether CAC profiles are configured.

flagConfigureSbc

boolean Default: true

Determines whether the SBC devices configuration is enabled. This includes the configuration of the following entities:

■ PSTN Gateway
■ Configuration Modes: 
✔ Unknown 0
✔ SIP Trunk 1
✔ IPPBX 2
✔ BYOC 3
■ Region/Carrier
■ Carrier Registration
■ CAC

flagCarrierRegistration

boolean Default: true

Determines whether Carrier Registration is enabled.

CarrierUserName

string

Defines the digest MD5 Authentication username. The valid value is a string of up to 60 characters. By default, no value is defined.

CarrierUserPassword

string

Defines the digest MD5 Authentication password. The valid value is a string of up to 50 characters. Note: The password cannot be configured with wide characters.

carrierPasswordDPI

string

-

CarrierMainLine

string

Defines the AOR username. This appears in REGISTER From/To headers as ContactUser@HostName.

CarrierHostName

string

Defines the Address of Record (AOR) host name. The host name appears in SIP REGISTER From/To headers as ContactUser@HostName.

phones

string

List of phone numbers to assign to the site location.

dialPlanPrefixes

array

List of dial plan prefixes.

dialPlanName

string

Name of the dial plan including the prefixes

index

integer

Index number for the phone prefix in the dial plan.

active

boolean

Indicates whether the DID is active.

sbcScripts

list array

SBC script configuration:

■ sbcOnboardingScript
■ sbcCleanupScript
■ customerVariables

sbcOnboardingScript

integer

The SBC Onboarding script value in the Live Platform database (see Get Script Templates).

sbcCleanupScript

integer

The SBC Cleanup script value in the Live Platform database (see Get Script Templates).

scriptParameters refers to:

CustomVar.Variable<VariableSequenceNumber>

dictionary

where <VariableSequenceNumber> is the sequence in database that the variable is defined in the 'Customer variables' column for the script properties (see Customer Variables).

For example, when the following IP-PBX variables are defined in the database in the order: IPPBX-ProxyAddress, IPPBX-ProxyAddress-SIPPort, SIP-HostName then Custom variables should be defined as follows:

■ CustomVar.Variable1: <: IPPBX-ProxyAddress>
■ CustomVar.Variable2: < IPPBX-ProxyAddress-SIPPort>
■ CustomVar.Variable3: <SIP-HostName>

 

Custom variables can be defined to update specific parameters on the SBC device. These variables must be predefined in the UMP-365 database (see Customer Variables). Also verify that the custom variables notation has been added to the script (see parameter 'sbcOnboardingScript' above) that you are applying to the request.

There are three fields displayed in the schema additionalProp1-3, however there is no limitation for the number of variables that can be added.

additionalProp1

CustomVar.Variable<VariableSequenceNumber>

string

Custom Script variable argument. For example IP-Network.

additionalProp2

CustomVar.Variable<VariableSequenceNumber>

string

Custom Script argument. For example, IP-SubnetBits.

additionalProp3

CustomVar.Variable<VariableSequenceNumber>

string

Custom Script argument. For example, Trusted-IP-Network.

m365Scripts

string

M365 script configuration:

■ flagConfigureM365Routing
■ OnboardingScript
■ CleanupScript

flagConfigureM365Routing

boolean Default: true

Indicates whether M365 Routing is enabled.

OnboardingScript

integer

The M365 Onboarding script value in the Live Platform database (see Get Script Templates).

CleanupScript

integer

The M365 Cleanup script value in the Live Platform database (see Get Script Templates).

OnlinePstnGateway

string

The name of the OnlinePSTN Gateway of the SBC device that is attached to the Calling Profile (see Get Online PSTN Gateway.

Example Body

Copy 
{ "siteLocationName": "SaraSite4",
  "ovocCustomerType": "IPGROUP_TYPE",  
  "sbcId": 5,
  "sbcOnboardingScript": 10007,
  "sbcCleanupScript": 10700,
  "SbcConfigurationType": 1,
  "scriptParameters": 
  {    
  "OnlinePstnGateway": "sandbox1.audiocodes.be",    
  "ProxySet": "SIPTrunk",    
  "CarrierUserName": "1000",    
  "CarrierUserPassword": "12345678",    
  "CarrierMainLine": "brad1",    
  "CarrierHostName": "brad.com",    
  "CacProfile": "5 sessions"
    }
}

Example Response

Copy 
{
    "customerGuid": "b38e5a04-6d32-4be8-95bb-53bf7d6fa95c",
    "siteGuid": "a344470f-e54e-4897-b28e-d1c2c0c404f0",
    "executionMessages": [
        {
            "level": "Information",
            "message": "Skipping SBC CheckIpGroupProgramming."
        },
        {
            "level": "Information",
            "message": "Starting SBC Programming."
        },
        {
            "level": "Information",
            "message": "Sbc is programmed"
        },
        {
            "level": "Information",
            "message": "Site location information saved."
        }
    ]
}

HTTP Responses

■ 200 OK
Parameter Type Description

Customer Id

string($uuid)

Unique Id generated for customer. Search for the customer Id by searching for your customer name using Get Services Brief Details (V3).

siteGuid

string($uuid)

Unique Id generated for the SIP Connection (site location).

executionMessages

list array

List array including the following parameters:

■ level
■ message

level

string

One of the following values:

■ Information
■ Error

message

string

Information message text includes the following strings:

■ Checking SBC IP Group Programming
■ SBC not programmed yet
■ Starting SBC Programming
■ Sbc is programmed
■ Site location information saved