Download OpenAPI specification:Download
This is the Configuration API definition for the Avaya Session Border Controller for Enterprise.
Each supported endpoint is defined in this file along with a description of the endpoint, any required parameters, permissions, and the expected responses with examples. Detailed information on how to fully configure a system from start to finish can be found in the Administering Avaya Session Border Controller for Enterprise document available on the Avaya Support site (see https://support.avaya.com/products/P0997/avaya-session-border-controller-for-enterprise/).
Note that each endpoint definition also includes an embedded x-required-capability
property which contains the
required permissions for the endpoint (this is also included in the description).
Get the current Maintenance Mode configuration.
User must have the maintenance-mode:read
capability to perform this action.
{- "enabled": true,
- "startTime": "2023-09-27T00:00:00Z",
- "endTime": "2023-09-28T06:00:00Z",
- "terminateCallsAfter": "PT5M"
}
Update the current Maintenance Mode configuration.
User must have the maintenance-mode:update
capability to perform this action.
Updated maintenance mode configuration.
enabled | boolean Enable/disable maintenance window. |
startTime | string Time the maintenance window will start. Note: If provided as Accepted formats:
Output format: ISO-8601 Date/Time |
endTime | string Time the maintenance window will end. Note: If provided as null (or omitted), the maintenance window will never stop and must be manually stopped (by setting a time or disabling the maintenance window). Accepted formats:
Output format: ISO-8601 Date/Time |
terminateCallsAfter | string Interval after which existing calls will be terminated. Note: If provided as null (or omitted), calls will be terminated immediately when the maintenance window starts. Accepted formats:
Output format: ISO-8601 Duration |
{- "enabled": true,
- "startTime": "2023-09-27T00:00:00Z",
- "endTime": "2023-09-28T06:00:00Z",
- "terminateCallsAfter": "PT5M"
}
{- "enabled": true,
- "startTime": "2023-09-27T00:00:00Z",
- "endTime": "2023-09-28T06:00:00Z",
- "terminateCallsAfter": "PT5M"
}
Set the status of a network interface to the UP
or DOWN
state for this system.
Note: This operation is not supported for VLANs.
User must have the network-interface:update
capability.
interfaceName required | string The name of the interface to modify |
status required | string Enum: "UP" "DOWN" The state to set the interface to |
{- "A1": "UP",
- "A2": "UP",
- "B1": "UP",
- "B2": "UP"
}
Retrieve a mapping of network interfaces to their current state for this system.
Note: This operation is not supported for VLANs.
User must have the network-interface:read
capability.
{- "A1": "UP",
- "A2": "UP",
- "B1": "UP",
- "B2": "UP"
}
Create a new network for this system.
User must have the network-configuration:create
capability.
networkName | string Name for the network |
gatewayIp | string Gateway IP of the network |
subnetMask | string Subnet Mask of the network |
interface | string Enum: "A1" "A2" "B1" "B2" Select interface of the network |
Array of objects (NetworkAddress) >= 1 |
{- "networkName": "Private",
- "gatewayIp": "192.168.5.1",
- "subnetMask": "255.255.255.0",
- "interface": "A1",
- "networkAddresses": [
- {
- "ipAddress": "192.168.5.157",
- "publicIp": "",
- "gatewayOverride": ""
}
]
}
{- "resourcePath": "api/config/v1/network-management/networks/1",
- "networkId": 1,
- "networkName": "Private",
- "gatewayIp": "192.168.5.1",
- "subnetMask": "255.255.255.0",
- "interface": "A1",
- "networkAddresses": [
- {
- "networkAddressId": 2,
- "ipAddress": "192.168.5.157",
- "publicIp": "",
- "gatewayOverride": ""
}
]
}
Retrieve a list of all configured networks from this system.
User must have the network-configuration:read
capability.
[- {
- "resourcePath": "api/config/v1/network-management/networks/1",
- "networkId": 1,
- "networkName": "Private",
- "gatewayIp": "192.168.5.1",
- "subnetMask": "255.255.255.0",
- "interface": "A1",
- "networkAddresses": [
- {
- "networkAddressId": 2,
- "ipAddress": "192.168.5.157",
- "publicIp": "",
- "gatewayOverride": ""
}
]
}
]
Retrieve an existing network from this system.
User must have the network-configuration:read
capability.
networkId required | integer ID of the network |
{- "resourcePath": "api/config/v1/network-management/networks/1",
- "networkId": 1,
- "networkName": "Private",
- "gatewayIp": "192.168.5.1",
- "subnetMask": "255.255.255.0",
- "interface": "A1",
- "networkAddresses": [
- {
- "networkAddressId": 2,
- "ipAddress": "192.168.5.157",
- "publicIp": "",
- "gatewayOverride": ""
}
]
}
Delete an existing network from this system.
User must have the network-configuration:delete
capability.
networkId required | integer ID of the network |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Retrieve all network addresses from existing network.
User must have the network-configuration:read
capability.
networkId required | integer Example: 3 ID of the network |
[- {
- "networkAddressId": 2,
- "ipAddress": "192.168.5.157",
- "publicIp": "",
- "gatewayOverride": ""
}
]
Add a new network address to network.
User must have the network-configuration:update
capability.
networkId required | integer Example: 3 ID of the network |
ipAddress | string IP address given to the network |
publicIp | string Public IP of the network |
gatewayOverride | string Gateway override IP of the network |
{- "ipAddress": "192.168.5.157",
- "publicIp": "",
- "gatewayOverride": ""
}
{- "resourcePath": "/api/config/v1/network-management/networks/3/network-addresses/2",
- "networkAddressId": 2,
- "ipAddress": "192.168.5.157",
- "publicIp": "",
- "gatewayOverride": ""
}
Get the network address details from network
User must have the network-configuration:read
capability.
networkId required | integer Example: 3 ID of the network |
networkAddressId required | integer Example: 2 ID of the network address |
{- "networkAddressId": 2,
- "ipAddress": "192.168.5.157",
- "publicIp": "",
- "gatewayOverride": ""
}
Modify the network address details in the network.
User must have the network-configuration:update
capability.
networkId required | integer Example: 3 ID of the network |
networkAddressId required | integer Example: 2 ID of the network address |
ipAddress | string IP address given to the network |
publicIp | string Public IP of the network |
gatewayOverride | string Gateway override IP of the network |
{- "ipAddress": "192.168.5.157",
- "publicIp": "",
- "gatewayOverride": ""
}
{- "networkAddressId": 2,
- "ipAddress": "192.168.5.157",
- "publicIp": "",
- "gatewayOverride": ""
}
Delete the network address details from the network
User must have the network-configuration:delete
capability.
networkId required | integer Example: 3 ID of the network |
networkAddressId required | integer Example: 2 ID of the network address |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
List all installed certificates of a particular type.
User must have the certificate:read
capability to perform this action.
certificateType required | string (CertificateType) Enum: "cert" "ca" "crl" "key" "csr" The type of the certificate to list. |
[- "string"
]
Install a new certificate.
Note: Only certificates of type cert
, ca
, or crl
can be installed via the API.
User must have the certificate:install
capability to perform this action.
certificateType required | string (CertificateTypeRestricted) Enum: "cert" "ca" "crl" The type of the certificate to list. |
certificatePayload | string <base64> The primary certificate payload. This part is always required. For a certificate or CA certificate, this should be a PEM encoded X.509 certificate. For a CRL, this should be a PEM encoded X.509 CRL. Private key or CSR uploads are not supported. Note: This part MUST contain a Content-Disposition header with a filename parameter. Any requests missing this parameter will be rejected. |
allowWeakPayload | string Specify if weak certificate or keys are allowed. This part should be a string of either true or false. Omitting this part will default to false. |
existingPrivateKey | string The existing private key to use. This part is only used if
certificateType is If specified, this part should contain the name of a private key that is already installed on the system. |
privateKeyPayload | string <base64> The private key payload. This part is only used if
certificateType is If specified, this part should be an unencrypted, PEM encoded RSA private key. Note: If a Content-Disposition header is included and contains a filename parameter, it will be ignored. |
trustChainPayload | string <base64> The trust chain payload. This part is only used if certificateType is If specified, this part should be one or more this PEM encoded X.509 certificates concatenated together. Note: If a Content-Disposition header is included and contains a filename parameter, it will be ignored. |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Get an existing certificate's contents.
Note: Only certificates of type cert
, ca
, or crl
can be read via the API.
User must have the certificate:read
capability to perform this action.
certificateType required | string (CertificateTypeRestricted) Enum: "cert" "ca" "crl" The type of the certificate to list. |
certificateName required | string The name of the certificate. |
{- "payload": "string"
}
Overwrite an existing certificate.
Note: Only certificates of type cert
, ca
, or crl
can be installed via the API.
User must have the certificate:install
capability to perform this action.
certificateType required | string (CertificateTypeRestricted) Enum: "cert" "ca" "crl" The type of the certificate to list. |
certificateName required | string The name of the certificate. |
certificatePayload | string <base64> The primary certificate payload. This part is always required. For a certificate or CA certificate, this should be a PEM encoded X.509 certificate. For a CRL, this should be a PEM encoded X.509 CRL. Private key or CSR uploads are not supported. Note: If a Content-Disposition header is included and contains a filename parameter, it will be ignored. |
allowWeakPayload | string Specify if weak certificate or keys are allowed. This part should be a string of either true or false. Omitting this part will default to false. |
existingPrivateKey | string The existing private key to use. This part is only used if
certificateType is If specified, this part should contain the name of a private key that is already installed on the system. |
privateKeyPayload | string <base64> The private key payload. This part is only used if
certificateType is If specified, this part should be an unencrypted, PEM encoded RSA private key. Note: If a Content-Disposition header is included and contains a filename parameter, it will be ignored. |
trustChainPayload | string <base64> The trust chain payload. This part is only used if certificateType is If specified, this part should be one or more this PEM encoded X.509 certificates concatenated together. Note: If a Content-Disposition header is included and contains a filename parameter, it will be ignored. |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
certificateType required | string (CertificateType) Enum: "cert" "ca" "crl" "key" "csr" The type of the certificate to list. |
certificateName required | string The name of the certificate. |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Create certificate signing request (CSR) for the requested data.
User must have the certificate:create
capability to perform this action.
country required | string = 2 characters The name of the country within which the certificate is being created. This value should be the two-letter ISO code for the country. |
state required | string <= 64 characters This value should be the state/province where the certificate is being created. |
locality required | string <= 64 characters This value should be the locality (city) where the certificate is being created. |
organization required | string <= 128 characters This value should be the name of the company or organization creating the certificate. |
organizationalUnit required | string <= 128 characters This value should be the group within the company or organization creating the certificate. |
commonName required | string <= 64 characters This value should be the name used to refer to or identify the company or group creating the certificate. You cannot provide wildcard (*) characters in this field. This value will be used as part of the file name. |
keySize required | number Enum: 2048 4096 This value should be the certificate key length The hash algorithms |
keyUsageExtensionList required | Array of strings Items Enum: "KEY_ENCIPHERMENT" "NON_REPUDIATION" "DIGITAL_SIGNATURE" The purpose for which the public key might be used: |
extendedKeyUsageExtensionList required | Array of strings Items Enum: "SERVER_AUTH" "CLIENT_AUTH" The purpose for which the public key might be used in addition to keyUsageExtensionList |
subjectAltNameList required | Array of strings [ 1 .. 10 ] items An optional text field that can be used to further identify this certificate. You can make maximum of 10 Subject Alt Name entries. Wildcard characters (*) are not supported in this field. Avaya SBCE supports DNS hostname, IP address and SIP domain name as the valid entries for Subject Alt Name field. Avaya SBCE does not support SIP URI as a valid value for the Subject Alt Name field. |
passphrase required | string <= 32 characters The passphrase used when encrypting the private key. |
contactName required | string <= 128 characters The name of the individual within the issuing organization acting as the point-of-contact for issues relating to this certificate. |
contactEmail required | string <= 256 characters The e-mail address of the contact. |
{- "country": "st",
- "state": "string",
- "locality": "string",
- "organization": "string",
- "organizationalUnit": "string",
- "commonName": "string",
- "keySize": 2048,
- "keyUsageExtensionList": [
- "KEY_ENCIPHERMENT"
], - "extendedKeyUsageExtensionList": [
- "SERVER_AUTH"
], - "subjectAltNameList": [
- "string"
], - "passphrase": "string",
- "contactName": "string",
- "contactEmail": "string"
}
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new TLS client profile in SBCE
User must have the tls-client-profile:create
capability to perform this action.
profileName | string |
certificateFileName | string |
object or object or object Cipher suite to use when negotiating a TLS handshake. | |
peerCaList | Array of strings |
peerCrlList | Array of strings |
verificationDepth | integer The maximum depth in which a peer certificate can deviate from a trusted CA certificate. Must be specified. |
renegotiationTimeInSeconds | integer Number of seconds before a TLS connection should be renegotiated, if the connection allows renegotiation. Omit or set to 0 to disable. |
renegotiationByteCount | integer Number of bytes to process before a TLS connection should be renegotiated, if the connection allows renegotiation. Omit or set to 0 to disable. |
tlsProtocol | Array of strings (TLSProfileProtocols) Items Enum: "TLS_1_2" "TLS_1_1" "TLS_1_0" |
sni | boolean |
extendedHostnameVerification | boolean |
hostOverride | string |
{- "profileName": "test",
- "certificateFileName": "avaya.crt",
- "cipherSuite": {
- "default": true
}, - "peerCaList": [
- "avayaDeviceEnrollmentCAChain.crt"
], - "peerCrlList": [ ],
- "verificationDepth": 5,
- "renegotiationTimeInSeconds": 30,
- "renegotiationByteCount": 0,
- "tlsProtocol": "TLS_1_2"
}
{- "resourcePath": "api/config/v1/tls-client-profiles/1",
- "profileId": 1,
- "profileName": "test",
- "certificateFileName": "avaya.crt",
- "cipherSuite": {
- "default": true
}, - "peerCaList": [
- "avayaDeviceEnrollmentCAChain.crt"
], - "peerCrlList": [ ],
- "verificationDepth": 5,
- "renegotiationTimeInSeconds": 30,
- "renegotiationByteCount": 0,
- "tlsProtocol": "TLS_1_2"
}
Get all TLS client profiles
User must have the tls-client-profile:read
capability to perform this action.
[- {
- "profileId": 1,
- "profileName": "test",
- "certificateFileName": "avaya.crt",
- "cipherSuite": {
- "default": true
}, - "peerCaList": [
- "avayaDeviceEnrollmentCAChain.crt"
], - "peerCrlList": [ ],
- "verificationDepth": 5,
- "renegotiationTimeInSeconds": 30,
- "renegotiationByteCount": 0,
- "tlsProtocol": "TLS_1_2"
}, - {
- "profileId": 2,
- "profileName": "test",
- "certificateFileName": "avaya.crt",
- "cipherSuite": {
- "custom": "HIGH:!DH:!ADH:!MD5"
}, - "peerCaList": [
- "avayaDeviceEnrollmentCAChain.crt"
], - "peerCrlList": [ ],
- "verificationDepth": 5,
- "renegotiationTimeInSeconds": 30,
- "renegotiationByteCount": 0,
- "tlsProtocol": "TLS_1_2"
}
]
Edits existing TLS client profile in SBCE
User must have the tls-client-profile:update
capability to perform this action.
profileId required | integer >= 1 |
profileId | integer |
profileName | string |
certificateFileName | string |
object or object or object Cipher suite to use when negotiating a TLS handshake. | |
peerCaList | Array of strings |
peerCrlList | Array of strings |
verificationDepth | integer The maximum depth in which a peer certificate can deviate from a trusted CA certificate. Must be specified. |
renegotiationTimeInSeconds | integer Number of seconds before a TLS connection should be renegotiated, if the connection allows renegotiation. Omit or set to 0 to disable. |
renegotiationByteCount | integer Number of bytes to process before a TLS connection should be renegotiated, if the connection allows renegotiation. Omit or set to 0 to disable. |
tlsProtocol | Array of strings (TLSProfileProtocols) Items Enum: "TLS_1_2" "TLS_1_1" "TLS_1_0" |
sni | boolean |
extendedHostnameVerification | boolean |
hostOverride | string |
{- "profileId": 1,
- "profileName": "test",
- "certificateFileName": "avaya.crt",
- "cipherSuite": {
- "default": true
}, - "peerCaList": [
- "avayaDeviceEnrollmentCAChain.crt"
], - "peerCrlList": [ ],
- "verificationDepth": 5,
- "renegotiationTimeInSeconds": 30,
- "renegotiationByteCount": 0,
- "tlsProtocol": "TLS_1_2"
}
{- "profileId": 1,
- "profileName": "test",
- "certificateFileName": "avaya.crt",
- "cipherSuite": {
- "default": true
}, - "peerCaList": [
- "avayaDeviceEnrollmentCAChain.crt"
], - "peerCrlList": [ ],
- "verificationDepth": 5,
- "renegotiationTimeInSeconds": 30,
- "renegotiationByteCount": 0,
- "tlsProtocol": "TLS_1_2"
}
Get the TLS client Profile for given ID
User must have the tls-client-profile:read
capability to perform this action.
profileId required | integer >= 1 |
{- "profileId": 1,
- "profileName": "test",
- "certificateFileName": "avaya.crt",
- "cipherSuite": {
- "default": true
}, - "peerCaList": [
- "avayaDeviceEnrollmentCAChain.crt"
], - "peerCrlList": [ ],
- "verificationDepth": 5,
- "renegotiationTimeInSeconds": 30,
- "renegotiationByteCount": 0,
- "tlsProtocol": "TLS_1_2"
}
Delete the TLS client profile for given ID
User must have the tls-client-profile:delete
capability to perform this action.
profileId required | integer >= 1 |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new TLS server profile in SBCE
User must have the tls-server-profile:create
capability to perform this action.
profileName | string |
certificateFileName | string |
object or object or object Cipher suite to use when negotiating a TLS handshake. | |
peerVerification | string Enum: "NONE" "OPTIONAL" "REQUIRED" Determine if the peer certificate requires verification. |
peerCaList | Array of strings |
peerCrlList | Array of strings |
verificationDepth | integer The maximum depth in which a peer certificate can deviate from a trusted CA certificate. Must be specified if peerVerification is not NONE. |
renegotiationTimeInSeconds | integer Number of seconds before a TLS connection should be renegotiated, if the connection allows renegotiation. Omit or set to 0 to disable. |
renegotiationByteCount | integer Number of bytes to process before a TLS connection should be renegotiated, if the connection allows renegotiation. Omit or set to 0 to disable. |
tlsProtocol | Array of strings (TLSProfileProtocols) Items Enum: "TLS_1_2" "TLS_1_1" "TLS_1_0" |
object |
{- "profileName": "test",
- "certificateFileName": "avaya.crt",
- "cipherSuite": {
- "default": true
}, - "peerVerification": "NONE",
- "peerCaList": [ ],
- "peerCrlList": [ ],
- "verificationDepth": 5,
- "renegotiationTimeInSeconds": 30,
- "renegotiationByteCount": 0,
- "tlsProtocol": "TLS_1_2"
}
{- "resourcePath": "api/config/v1/tls-server-profiles/1",
- "profileId": 1,
- "profileName": "test",
- "certificateFileName": "avaya.crt",
- "cipherSuite": {
- "default": true
}, - "peerVerification": "NONE",
- "peerCaList": [ ],
- "peerCrlList": [ ],
- "verificationDepth": 5,
- "renegotiationTimeInSeconds": 30,
- "renegotiationByteCount": 0,
- "tlsProtocol": "TLS_1_2"
}
Get all TLS server profiles
User must have the tls-server-profile:read
capability to perform this action.
[- {
- "profileId": 1,
- "profileName": "test",
- "certificateFileName": "avaya.crt",
- "cipherSuite": {
- "default": true
}, - "peerVerification": "REQUIRED",
- "peerCaList": [
- "avayaDeviceEnrollmentCAChain.crt"
], - "peerCrlList": [ ],
- "verificationDepth": 5,
- "renegotiationTimeInSeconds": 30,
- "renegotiationByteCount": 0,
- "tlsProtocol": "TLS_1_2"
}, - {
- "profileId": 2,
- "profileName": "test",
- "certificateFileName": "avaya.crt",
- "cipherSuite": {
- "custom": "HIGH:!DH:!ADH:!MD5"
}, - "peerVerification": "NONE",
- "peerCaList": [ ],
- "peerCrlList": [ ],
- "verificationDepth": 0,
- "renegotiationTimeInSeconds": 0,
- "renegotiationByteCount": 0,
- "tlsProtocol": "TLS_1_2"
}
]
Edit an existing TLS server profile in SBCE
User must have the tls-server-profile:update
capability to perform this action.
profileId required | integer >= 1 |
profileId | integer |
profileName | string |
certificateFileName | string |
object or object or object Cipher suite to use when negotiating a TLS handshake. | |
peerVerification | string Enum: "NONE" "OPTIONAL" "REQUIRED" Determine if the peer certificate requires verification. |
peerCaList | Array of strings |
peerCrlList | Array of strings |
verificationDepth | integer The maximum depth in which a peer certificate can deviate from a trusted CA certificate. Must be specified if peerVerification is not NONE. |
renegotiationTimeInSeconds | integer Number of seconds before a TLS connection should be renegotiated, if the connection allows renegotiation. Omit or set to 0 to disable. |
renegotiationByteCount | integer Number of bytes to process before a TLS connection should be renegotiated, if the connection allows renegotiation. Omit or set to 0 to disable. |
tlsProtocol | Array of strings (TLSProfileProtocols) Items Enum: "TLS_1_2" "TLS_1_1" "TLS_1_0" |
object |
{- "profileId": 1,
- "profileName": "test",
- "certificateFileName": "avaya.crt",
- "cipherSuite": {
- "default": true
}, - "peerVerification": "NONE",
- "peerCaList": [ ],
- "peerCrlList": [ ],
- "verificationDepth": 5,
- "renegotiationTimeInSeconds": 30,
- "renegotiationByteCount": 0,
- "tlsProtocol": "TLS_1_2"
}
{- "profileId": 1,
- "profileName": "test",
- "certificateFileName": "avaya.crt",
- "cipherSuite": {
- "default": true
}, - "peerVerification": "NONE",
- "peerCaList": [ ],
- "peerCrlList": [ ],
- "verificationDepth": 5,
- "renegotiationTimeInSeconds": 30,
- "renegotiationByteCount": 0,
- "tlsProtocol": "TLS_1_2"
}
Get the TLS server profile for given ID
User must have the tls-server-profile:read
capability to perform this action.
profileId required | integer >= 1 |
{- "profileId": 1,
- "profileName": "test",
- "certificateFileName": "avaya.crt",
- "cipherSuite": {
- "default": true
}, - "peerVerification": "NONE",
- "peerCaList": [ ],
- "peerCrlList": [ ],
- "verificationDepth": 5,
- "renegotiationTimeInSeconds": 30,
- "renegotiationByteCount": 0,
- "tlsProtocol": "TLS_1_2"
}
Delete the TLS server profile for given ID
User must have the tls-server-profile:delete
capability to perform this action.
profileId required | integer >= 1 |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new signaling interface in SBCE
User must have the signaling-interface:delete
capability to perform this action.
signalingName | string Name of Signaling Interface |
networkId | integer ID of IP Address to listen on |
udpPort | integer UDP port to listen on |
tcpPort | integer TCP port to listen on |
tlsPort | integer TLS port to listen on |
tlsProfileId | integer ID of TLS Server Profile if TLS Port is provided. |
{- "signalingName": "Sig_int",
- "networkId": 1,
- "udpPort": 5060,
- "tcpPort": 5060,
- "tlsPort": 5061,
- "tlsProfileId": 1
}
{- "resourcePath": "api/config/v1/signaling-interfaces/1",
- "signalingId": 1,
- "signalingName": "Sig_int",
- "networkId": 1,
- "udpPort": 5060,
- "tcpPort": 5060,
- "tlsPort": 5061,
- "tlsProfileId": 1
}
Get all signaling interfaces
User must have the signaling-interface:read
capability to perform this action.
[- {
- "signalingId": 1,
- "signalingName": "Sig_int",
- "networkId": 1,
- "udpPort": 5060,
- "tcpPort": 5060,
- "tlsPort": 5061,
- "tlsProfileId": 1
}
]
Edit signaling interface in SBCE
User must have the signaling-interface:update
capability to perform this action.
signalingId required | integer ID of the profile |
signalingId | integer <int64> ID of signaling interface |
signalingName | string Name of Signaling Interface |
networkId | integer ID of IP Address to listen on |
udpPort | integer UDP port to listen on |
tcpPort | integer TCP port to listen on |
tlsPort | integer TLS port to listen on |
tlsProfileId | integer ID of TLS Server Profile if TLS Port is provided. |
{- "signalingId": 1,
- "signalingName": "Sig_int",
- "networkId": 1,
- "udpPort": 5060,
- "tcpPort": 5060,
- "tlsPort": 5061,
- "tlsProfileId": 1
}
{- "signalingId": 1,
- "signalingName": "Sig_int",
- "networkId": 1,
- "udpPort": 5060,
- "tcpPort": 5060,
- "tlsPort": 5061,
- "tlsProfileId": 1
}
Get signaling interface for given ID
User must have the signaling-interface:read
capability to perform this action.
signalingId required | integer ID of the profile |
{- "signalingId": 1,
- "signalingName": "Sig_int",
- "networkId": 1,
- "udpPort": 5060,
- "tcpPort": 5060,
- "tlsPort": 5061,
- "tlsProfileId": 1
}
Delete signaling interface for given ID
User must have the signaling-interface:delete
capability to perform this action.
signalingId required | integer ID of the profile |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new media interface in SBCE
User must have the media-interface:create
capability to perform this action.
mediaName | string Name of the media interface |
networkId | integer ID of IP address to listen on |
startPortRange | integer Start port of the media interface port range |
endPortRange | integer End port of the media interface port range |
tlsProfileId | integer TLS Profile ID used to listen for incoming requests |
bufferSize | integer Buffer Size of the buffer |
{- "mediaName": "Med_int",
- "networkId": 1,
- "startPortRange": 35000,
- "endPortRange": 40000,
- "tlsProfileId": 1,
- "bufferSize": 500
}
{- "resourcePath": "api/config/v1/media-interfaces/1",
- "mediaId": 1,
- "mediaName": "Med_int",
- "networkId": 1,
- "startPortRange": 35000,
- "endPortRange": 40000,
- "tlsProfileId": 1,
- "bufferSize": 500
}
Get all media interfaces
User must have the media-interface:read
capability to perform this action.
[- {
- "mediaId": 1,
- "mediaName": "Med_int",
- "networkId": 1,
- "startPortRange": 35000,
- "endPortRange": 40000,
- "tlsProfileId": 1,
- "bufferSize": 500
}
]
Edit media interface in SBCE
User must have the media-interface:update
capability to perform this action.
mediaId required | integer ID of the profile |
mediaId | integer <int64> ID of media interface |
mediaName | string Name of the media interface |
networkId | integer ID of IP address to listen on |
startPortRange | integer Start port of the media interface port range |
endPortRange | integer End port of the media interface port range |
tlsProfileId | integer TLS Profile ID used to listen for incoming requests |
bufferSize | integer Buffer Size of the buffer |
{- "mediaId": 1,
- "mediaName": "Med_int",
- "networkId": 1,
- "startPortRange": 35000,
- "endPortRange": 40000,
- "tlsProfileId": 1,
- "bufferSize": 500
}
{- "mediaId": 1,
- "mediaName": "Med_int",
- "networkId": 1,
- "startPortRange": 35000,
- "endPortRange": 40000,
- "tlsProfileId": 1,
- "bufferSize": 500
}
Get media interface for given ID
User must have the media-interface:read
capability to perform this action.
mediaId required | integer ID of the profile |
{- "mediaId": 1,
- "mediaName": "Med_int",
- "networkId": 1,
- "startPortRange": 35000,
- "endPortRange": 40000,
- "tlsProfileId": 1,
- "bufferSize": 500
}
Delete media interface for given ID
User must have the media-interface:delete
capability to perform this action.
mediaId required | integer ID of the profile |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new SIP server profile in SBCE
User must have the sip-server-profile:create
capability to perform this action.
SIP Server Profile object that needs to be added in SBCE.
serverName | string Name for the server |
sipDomain | string Domain of the SIP server |
serverType | string Enum: "CALL_SERVER" "TRUNK_SERVER" "MEDIA_SERVER" "REMOTE_BRANCH_OFFICE" "RECORDING_SERVER" Type of Sip Server |
tlsClientProfileId | integer Valid Tls client profile |
dnsQueryType | string Enum: "NONE/A" "SRV" "NAPTR" This value is valid when |
inboundConnectionReusePolicy | string Enum: "NONE" "DEFAULT" "RFC_5923" This value is considered valid when serverType is either CALL_SERVER, TRUNK_SERVER, or RECORDING_SERVER. The default setting is |
Array of objects (SipServerAddress) >= 1 | |
object (SipServerProfile_authentication) enable or disable | |
object (SipServerProfile_heartbeat) enable or disable | |
object (SipServerProfile_registration) registration options | |
object (SipServerProfile_ping) ping option | |
object (SipServerProfile_advanced) | |
object (SipServerProfile_dos) |
{- "serverName": "SM",
- "sipDomain": "sbcdev4.com",
- "serverType": "CALL_SERVER",
- "tlsClientProfileId": 1,
- "serverAddresses": [
- {
- "ipAddress": "192.168.5.4",
- "port": 5060,
- "transport": "TLS"
}
]
}
{- "resourcePath": "api/config/v1/sip-server-profiles/1",
- "serverId": 1,
- "serverName": "SM",
- "sipDomain": "sbcdev4.com",
- "serverType": "CALL_SERVER",
- "tlsClientProfileId": 1,
- "dnsQueryType": "NONE/A",
- "inboundConnectionReusePolicy": "NONE",
- "serverAddresses": [
- {
- "ipAddress": "192.168.5.4",
- "port": 5060,
- "transport": "TLS",
- "whitelist": false,
- "serverAddressId": 2
}
], - "authentication": {
- "enabled": true,
- "userName": "test-user",
- "password": "string",
- "realm": "string"
}, - "heartbeat": {
- "enabled": true,
- "method": "OPTIONS",
- "retryTimeoutOnConnectionFailure": 2,
- "description": null,
- "frequency": 30,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "registration": {
- "registerWithAllServers": true,
- "registerWithPriorityServer": false,
- "refreshInterval": 0,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "ping": {
- "enabled": true,
- "pingInterval": 100,
- "responseTime": 100
}, - "advanced": {
- "enableGrooming": true,
- "interworkingProfileId": 0,
- "securable": false,
- "tolerant": false,
- "uriGroupId": 0,
- "ng911Support": false,
- "fgdn": {
- "enabled": true,
- "tcpFailoverPort": 1010,
- "tlsFailoverPort": 1011
}
}, - "dos": {
- "enabled": true,
- "dosProtection": {
- "trafficType": "REMOTE_USERS",
- "maximumConcurrentSessions": 1000,
- "noOfRemoteUsers": 100
}
}
}
Get all SIP server profiles
User must have the sip-server-profile:read
capability to perform this action.
[- {
- "serverId": 1,
- "serverName": "SM",
- "sipDomain": "sbcdev4.com",
- "serverType": "CALL_SERVER",
- "tlsClientProfileId": 1,
- "dnsQueryType": "NONE/A",
- "inboundConnectionReusePolicy": "NONE",
- "serverAddresses": [
- {
- "ipAddress": "192.168.5.4",
- "port": 5060,
- "transport": "TLS",
- "whitelist": false,
- "serverAddressId": 2
}
], - "authentication": {
- "enabled": true,
- "userName": "test-user",
- "password": "string",
- "realm": "string"
}, - "heartbeat": {
- "enabled": true,
- "method": "OPTIONS",
- "retryTimeoutOnConnectionFailure": 2,
- "description": null,
- "frequency": 30,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "registration": {
- "registerWithAllServers": true,
- "registerWithPriorityServer": false,
- "refreshInterval": 0,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "ping": {
- "enabled": true,
- "pingInterval": 100,
- "responseTime": 100
}, - "advanced": {
- "enableGrooming": true,
- "interworkingProfileId": 0,
- "securable": false,
- "tolerant": false,
- "uriGroupId": 0,
- "ng911Support": false,
- "fgdn": {
- "enabled": true,
- "tcpFailoverPort": 1010,
- "tlsFailoverPort": 1011
}
}, - "dos": {
- "enabled": true,
- "dosProtection": {
- "trafficType": "REMOTE_USERS",
- "maximumConcurrentSessions": 1000,
- "noOfRemoteUsers": 100
}
}
}
]
Edit SIP server profile in SBCE
User must have the sip-server-profile:update
capability to perform this action.
serverId required | integer ID of the server |
SIP Server Profile object that needs to be added in SBCE.
serverName | string Name for the server |
sipDomain | string Domain of the SIP server |
serverType | string Enum: "CALL_SERVER" "TRUNK_SERVER" "MEDIA_SERVER" "REMOTE_BRANCH_OFFICE" "RECORDING_SERVER" Type of Sip Server |
tlsClientProfileId | integer Valid Tls client profile |
dnsQueryType | string Enum: "NONE/A" "SRV" "NAPTR" This value is valid when |
inboundConnectionReusePolicy | string Enum: "NONE" "DEFAULT" "RFC_5923" This value is considered valid when serverType is either CALL_SERVER, TRUNK_SERVER, or RECORDING_SERVER. The default setting is |
{- "serverName": "SM",
- "sipDomain": "sbcdev4.com",
- "serverType": "CALL_SERVER",
- "tlsClientProfileId": 1,
- "dnsQueryType": "NONE/A",
- "inboundConnectionReusePolicy": "NONE"
}
{- "serverId": 1,
- "serverName": "SM",
- "sipDomain": "sbcdev4.com",
- "serverType": "CALL_SERVER",
- "tlsClientProfileId": 1,
- "dnsQueryType": "NONE/A",
- "inboundConnectionReusePolicy": "NONE",
- "serverAddresses": [
- {
- "ipAddress": "192.168.5.4",
- "port": 5060,
- "transport": "TLS",
- "whitelist": false,
- "serverAddressId": 2
}
], - "authentication": {
- "enabled": true,
- "userName": "test-user",
- "password": "string",
- "realm": "string"
}, - "heartbeat": {
- "enabled": true,
- "method": "OPTIONS",
- "retryTimeoutOnConnectionFailure": 2,
- "description": null,
- "frequency": 30,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "registration": {
- "registerWithAllServers": true,
- "registerWithPriorityServer": false,
- "refreshInterval": 0,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "ping": {
- "enabled": true,
- "pingInterval": 100,
- "responseTime": 100
}, - "advanced": {
- "enableGrooming": true,
- "interworkingProfileId": 0,
- "securable": false,
- "tolerant": false,
- "uriGroupId": 0,
- "ng911Support": false,
- "fgdn": {
- "enabled": true,
- "tcpFailoverPort": 1010,
- "tlsFailoverPort": 1011
}
}, - "dos": {
- "enabled": true,
- "dosProtection": {
- "trafficType": "REMOTE_USERS",
- "maximumConcurrentSessions": 1000,
- "noOfRemoteUsers": 100
}
}
}
Get the SIP server profile for given ID
User must have the sip-server-profile:read
capability to perform this action.
serverId required | integer ID of the server |
{- "serverId": 1,
- "serverName": "SM",
- "sipDomain": "sbcdev4.com",
- "serverType": "CALL_SERVER",
- "tlsClientProfileId": 1,
- "dnsQueryType": "NONE/A",
- "inboundConnectionReusePolicy": "NONE",
- "serverAddresses": [
- {
- "ipAddress": "192.168.5.4",
- "port": 5060,
- "transport": "TLS",
- "whitelist": false,
- "serverAddressId": 2
}
], - "authentication": {
- "enabled": true,
- "userName": "test-user",
- "password": "string",
- "realm": "string"
}, - "heartbeat": {
- "enabled": true,
- "method": "OPTIONS",
- "retryTimeoutOnConnectionFailure": 2,
- "description": null,
- "frequency": 30,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "registration": {
- "registerWithAllServers": true,
- "registerWithPriorityServer": false,
- "refreshInterval": 0,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "ping": {
- "enabled": true,
- "pingInterval": 100,
- "responseTime": 100
}, - "advanced": {
- "enableGrooming": true,
- "interworkingProfileId": 0,
- "securable": false,
- "tolerant": false,
- "uriGroupId": 0,
- "ng911Support": false,
- "fgdn": {
- "enabled": true,
- "tcpFailoverPort": 1010,
- "tlsFailoverPort": 1011
}
}, - "dos": {
- "enabled": true,
- "dosProtection": {
- "trafficType": "REMOTE_USERS",
- "maximumConcurrentSessions": 1000,
- "noOfRemoteUsers": 100
}
}
}
Delete the SIP server profile for given ID
User must have the sip-server-profile:delete
capability to perform this action.
serverId required | integer ID of the server |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new SIP server address to SIP server profile with serverId in SBCE.
User must have the sip-server-profile:update
capability to perform this action.
serverId required | integer ID of the SIP Server |
SIP Server Address object that needs to be added to SIP Server in SBCE.
ipAddress | string IP address for the server |
port | integer <int64> Port of the server |
transport | string Enum: "TCP" "TLS" "UDP" Transport type of the server |
whitelist | boolean Default: false The call is not blocked if the call originator exists in the Whitelist. |
{- "ipAddress": "192.168.5.4",
- "port": 5060,
- "transport": "TLS",
- "whitelist": false
}
{- "serverId": 1,
- "serverName": "SM",
- "sipDomain": "sbcdev4.com",
- "serverType": "CALL_SERVER",
- "tlsClientProfileId": 1,
- "dnsQueryType": "NONE/A",
- "inboundConnectionReusePolicy": "NONE",
- "serverAddresses": [
- {
- "ipAddress": "192.168.5.4",
- "port": 5060,
- "transport": "TLS",
- "whitelist": false,
- "serverAddressId": 2
}
], - "authentication": {
- "enabled": true,
- "userName": "test-user",
- "password": "string",
- "realm": "string"
}, - "heartbeat": {
- "enabled": true,
- "method": "OPTIONS",
- "retryTimeoutOnConnectionFailure": 2,
- "description": null,
- "frequency": 30,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "registration": {
- "registerWithAllServers": true,
- "registerWithPriorityServer": false,
- "refreshInterval": 0,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "ping": {
- "enabled": true,
- "pingInterval": 100,
- "responseTime": 100
}, - "advanced": {
- "enableGrooming": true,
- "interworkingProfileId": 0,
- "securable": false,
- "tolerant": false,
- "uriGroupId": 0,
- "ng911Support": false,
- "fgdn": {
- "enabled": true,
- "tcpFailoverPort": 1010,
- "tlsFailoverPort": 1011
}
}, - "dos": {
- "enabled": true,
- "dosProtection": {
- "trafficType": "REMOTE_USERS",
- "maximumConcurrentSessions": 1000,
- "noOfRemoteUsers": 100
}
}
}
Get the SIP Server Addresses associated to SIP server profile for given ID
User must have the sip-server-profile:read
capability to perform this action.
serverId required | integer ID of the server |
[- {
- "ipAddress": "192.168.5.4",
- "port": 5060,
- "transport": "TLS",
- "whitelist": false
}
]
Edit SIP server Address associated to SIP Server profile in SBCE
User must have the sip-server-profile:update
capability to perform this action.
serverId required | integer ID of the server |
serverAddressId required | integer ID of the serverAddress |
SIP Server Address object that needs to be added to SIP Server Profile in SBCE.
ipAddress | string IP address for the server |
port | integer <int64> Port of the server |
transport | string Enum: "TCP" "TLS" "UDP" Transport type of the server |
whitelist | boolean Default: false The call is not blocked if the call originator exists in the Whitelist. |
{- "ipAddress": "192.168.5.4",
- "port": 5060,
- "transport": "TLS",
- "whitelist": false
}
{- "serverId": 1,
- "serverName": "SM",
- "sipDomain": "sbcdev4.com",
- "serverType": "CALL_SERVER",
- "tlsClientProfileId": 1,
- "dnsQueryType": "NONE/A",
- "inboundConnectionReusePolicy": "NONE",
- "serverAddresses": [
- {
- "ipAddress": "192.168.5.4",
- "port": 5060,
- "transport": "TLS",
- "whitelist": false,
- "serverAddressId": 2
}
], - "authentication": {
- "enabled": true,
- "userName": "test-user",
- "password": "string",
- "realm": "string"
}, - "heartbeat": {
- "enabled": true,
- "method": "OPTIONS",
- "retryTimeoutOnConnectionFailure": 2,
- "description": null,
- "frequency": 30,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "registration": {
- "registerWithAllServers": true,
- "registerWithPriorityServer": false,
- "refreshInterval": 0,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "ping": {
- "enabled": true,
- "pingInterval": 100,
- "responseTime": 100
}, - "advanced": {
- "enableGrooming": true,
- "interworkingProfileId": 0,
- "securable": false,
- "tolerant": false,
- "uriGroupId": 0,
- "ng911Support": false,
- "fgdn": {
- "enabled": true,
- "tcpFailoverPort": 1010,
- "tlsFailoverPort": 1011
}
}, - "dos": {
- "enabled": true,
- "dosProtection": {
- "trafficType": "REMOTE_USERS",
- "maximumConcurrentSessions": 1000,
- "noOfRemoteUsers": 100
}
}
}
Delete the SIP server Address associated to SIP Server profile for given ID
User must have the sip-server-profile:update
capability to perform this action.
serverId required | integer ID of the server |
serverAddressId required | integer ID of the serverAddress |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Edit authentication details of SIP server profile with serverId in SBCE.
User must have the sip-server-profile:update
capability to perform this action.
serverId required | integer ID of the SIP Server |
SIP Server Authentication object that needs to be edit to SIP Server in SBCE.
enabled | boolean enable or disable |
userName | string |
password | string |
realm | string |
{- "enabled": true,
- "userName": "test-user",
- "password": "string",
- "realm": "string"
}
{- "serverId": 1,
- "serverName": "SM",
- "sipDomain": "sbcdev4.com",
- "serverType": "CALL_SERVER",
- "tlsClientProfileId": 1,
- "dnsQueryType": "NONE/A",
- "inboundConnectionReusePolicy": "NONE",
- "serverAddresses": [
- {
- "ipAddress": "192.168.5.4",
- "port": 5060,
- "transport": "TLS",
- "whitelist": false,
- "serverAddressId": 2
}
], - "authentication": {
- "enabled": true,
- "userName": "test-user",
- "password": "string",
- "realm": "string"
}, - "heartbeat": {
- "enabled": true,
- "method": "OPTIONS",
- "retryTimeoutOnConnectionFailure": 2,
- "description": null,
- "frequency": 30,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "registration": {
- "registerWithAllServers": true,
- "registerWithPriorityServer": false,
- "refreshInterval": 0,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "ping": {
- "enabled": true,
- "pingInterval": 100,
- "responseTime": 100
}, - "advanced": {
- "enableGrooming": true,
- "interworkingProfileId": 0,
- "securable": false,
- "tolerant": false,
- "uriGroupId": 0,
- "ng911Support": false,
- "fgdn": {
- "enabled": true,
- "tcpFailoverPort": 1010,
- "tlsFailoverPort": 1011
}
}, - "dos": {
- "enabled": true,
- "dosProtection": {
- "trafficType": "REMOTE_USERS",
- "maximumConcurrentSessions": 1000,
- "noOfRemoteUsers": 100
}
}
}
Edit heartbeat details of SIP server profile with serverId in SBCE.
User must have the sip-server-profile:update
capability to perform this action.
serverId required | integer ID of the SIP Server |
SIP Server Heartbeat object that needs to be edit to SIP Server in SBCE.
enabled | boolean |
method | string Enum: "OPTIONS" "PING" |
retryTimeoutOnConnectionFailure | integer [ 2 .. 7200 ] |
description | any |
frequency | integer [ 30 .. 7200 ] |
fromUri | string |
toUri | string |
{- "enabled": true,
- "method": "OPTIONS",
- "retryTimeoutOnConnectionFailure": 2,
- "description": null,
- "frequency": 30,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}
{- "serverId": 1,
- "serverName": "SM",
- "sipDomain": "sbcdev4.com",
- "serverType": "CALL_SERVER",
- "tlsClientProfileId": 1,
- "dnsQueryType": "NONE/A",
- "inboundConnectionReusePolicy": "NONE",
- "serverAddresses": [
- {
- "ipAddress": "192.168.5.4",
- "port": 5060,
- "transport": "TLS",
- "whitelist": false,
- "serverAddressId": 2
}
], - "authentication": {
- "enabled": true,
- "userName": "test-user",
- "password": "string",
- "realm": "string"
}, - "heartbeat": {
- "enabled": true,
- "method": "OPTIONS",
- "retryTimeoutOnConnectionFailure": 2,
- "description": null,
- "frequency": 30,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "registration": {
- "registerWithAllServers": true,
- "registerWithPriorityServer": false,
- "refreshInterval": 0,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "ping": {
- "enabled": true,
- "pingInterval": 100,
- "responseTime": 100
}, - "advanced": {
- "enableGrooming": true,
- "interworkingProfileId": 0,
- "securable": false,
- "tolerant": false,
- "uriGroupId": 0,
- "ng911Support": false,
- "fgdn": {
- "enabled": true,
- "tcpFailoverPort": 1010,
- "tlsFailoverPort": 1011
}
}, - "dos": {
- "enabled": true,
- "dosProtection": {
- "trafficType": "REMOTE_USERS",
- "maximumConcurrentSessions": 1000,
- "noOfRemoteUsers": 100
}
}
}
Edit registration details of SIP server profile with serverId in SBCE.
User must have the sip-server-profile:update
capability to perform this action.
serverId required | integer ID of the SIP Server |
SIP Server Registration object that needs to be edit to SIP Server in SBCE.
registerWithAllServers | boolean |
registerWithPriorityServer | boolean this option is allowed when serverType is |
refreshInterval | integer |
fromUri | string |
toUri | string |
{- "registerWithAllServers": true,
- "registerWithPriorityServer": false,
- "refreshInterval": 0,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}
{- "serverId": 1,
- "serverName": "SM",
- "sipDomain": "sbcdev4.com",
- "serverType": "CALL_SERVER",
- "tlsClientProfileId": 1,
- "dnsQueryType": "NONE/A",
- "inboundConnectionReusePolicy": "NONE",
- "serverAddresses": [
- {
- "ipAddress": "192.168.5.4",
- "port": 5060,
- "transport": "TLS",
- "whitelist": false,
- "serverAddressId": 2
}
], - "authentication": {
- "enabled": true,
- "userName": "test-user",
- "password": "string",
- "realm": "string"
}, - "heartbeat": {
- "enabled": true,
- "method": "OPTIONS",
- "retryTimeoutOnConnectionFailure": 2,
- "description": null,
- "frequency": 30,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "registration": {
- "registerWithAllServers": true,
- "registerWithPriorityServer": false,
- "refreshInterval": 0,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "ping": {
- "enabled": true,
- "pingInterval": 100,
- "responseTime": 100
}, - "advanced": {
- "enableGrooming": true,
- "interworkingProfileId": 0,
- "securable": false,
- "tolerant": false,
- "uriGroupId": 0,
- "ng911Support": false,
- "fgdn": {
- "enabled": true,
- "tcpFailoverPort": 1010,
- "tlsFailoverPort": 1011
}
}, - "dos": {
- "enabled": true,
- "dosProtection": {
- "trafficType": "REMOTE_USERS",
- "maximumConcurrentSessions": 1000,
- "noOfRemoteUsers": 100
}
}
}
Edit ping details of SIP server profile with serverId in SBCE.
User must have the sip-server-profile:update
capability to perform this action.
serverId required | integer ID of the SIP Server |
SIP Server Ping object that needs to be edit to SIP Server in SBCE.
enabled | boolean |
pingInterval | integer [ 1 .. 99999 ] |
responseTime | integer [ 1 .. 99999 ] |
{- "enabled": true,
- "pingInterval": 100,
- "responseTime": 100
}
{- "serverId": 1,
- "serverName": "SM",
- "sipDomain": "sbcdev4.com",
- "serverType": "CALL_SERVER",
- "tlsClientProfileId": 1,
- "dnsQueryType": "NONE/A",
- "inboundConnectionReusePolicy": "NONE",
- "serverAddresses": [
- {
- "ipAddress": "192.168.5.4",
- "port": 5060,
- "transport": "TLS",
- "whitelist": false,
- "serverAddressId": 2
}
], - "authentication": {
- "enabled": true,
- "userName": "test-user",
- "password": "string",
- "realm": "string"
}, - "heartbeat": {
- "enabled": true,
- "method": "OPTIONS",
- "retryTimeoutOnConnectionFailure": 2,
- "description": null,
- "frequency": 30,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "registration": {
- "registerWithAllServers": true,
- "registerWithPriorityServer": false,
- "refreshInterval": 0,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "ping": {
- "enabled": true,
- "pingInterval": 100,
- "responseTime": 100
}, - "advanced": {
- "enableGrooming": true,
- "interworkingProfileId": 0,
- "securable": false,
- "tolerant": false,
- "uriGroupId": 0,
- "ng911Support": false,
- "fgdn": {
- "enabled": true,
- "tcpFailoverPort": 1010,
- "tlsFailoverPort": 1011
}
}, - "dos": {
- "enabled": true,
- "dosProtection": {
- "trafficType": "REMOTE_USERS",
- "maximumConcurrentSessions": 1000,
- "noOfRemoteUsers": 100
}
}
}
Edit advanced details of SIP server profile with serverId in SBCE.
User must have the sip-server-profile:update
capability to perform this action.
serverId required | integer ID of the SIP Server |
SIP Server Advanced object that needs to be edit to SIP Server in SBCE.
enableGrooming | boolean This value must be set to |
interworkingProfileId | integer |
securable | boolean |
tolerant | boolean |
uriGroupId | integer |
ng911Support | boolean |
object |
{- "enableGrooming": true,
- "interworkingProfileId": 0,
- "securable": false,
- "tolerant": false,
- "uriGroupId": 0,
- "ng911Support": false,
- "fgdn": {
- "enabled": true,
- "tcpFailoverPort": 1010,
- "tlsFailoverPort": 1011
}
}
{- "serverId": 1,
- "serverName": "SM",
- "sipDomain": "sbcdev4.com",
- "serverType": "CALL_SERVER",
- "tlsClientProfileId": 1,
- "dnsQueryType": "NONE/A",
- "inboundConnectionReusePolicy": "NONE",
- "serverAddresses": [
- {
- "ipAddress": "192.168.5.4",
- "port": 5060,
- "transport": "TLS",
- "whitelist": false,
- "serverAddressId": 2
}
], - "authentication": {
- "enabled": true,
- "userName": "test-user",
- "password": "string",
- "realm": "string"
}, - "heartbeat": {
- "enabled": true,
- "method": "OPTIONS",
- "retryTimeoutOnConnectionFailure": 2,
- "description": null,
- "frequency": 30,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "registration": {
- "registerWithAllServers": true,
- "registerWithPriorityServer": false,
- "refreshInterval": 0,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "ping": {
- "enabled": true,
- "pingInterval": 100,
- "responseTime": 100
}, - "advanced": {
- "enableGrooming": true,
- "interworkingProfileId": 0,
- "securable": false,
- "tolerant": false,
- "uriGroupId": 0,
- "ng911Support": false,
- "fgdn": {
- "enabled": true,
- "tcpFailoverPort": 1010,
- "tlsFailoverPort": 1011
}
}, - "dos": {
- "enabled": true,
- "dosProtection": {
- "trafficType": "REMOTE_USERS",
- "maximumConcurrentSessions": 1000,
- "noOfRemoteUsers": 100
}
}
}
Edit the DoS protection settings for the specified a SIP server.
User must have the sip-server-profile:update
capability to perform this action.
serverId required | integer ID of the SIP Server |
SIP Server dos object that needs to be edit to SIP Server in SBCE.
enabled | boolean |
object |
{- "enabled": true,
- "dosProtection": {
- "trafficType": "REMOTE_USERS",
- "maximumConcurrentSessions": 1000,
- "noOfRemoteUsers": 100
}
}
{- "serverId": 1,
- "serverName": "SM",
- "sipDomain": "sbcdev4.com",
- "serverType": "CALL_SERVER",
- "tlsClientProfileId": 1,
- "dnsQueryType": "NONE/A",
- "inboundConnectionReusePolicy": "NONE",
- "serverAddresses": [
- {
- "ipAddress": "192.168.5.4",
- "port": 5060,
- "transport": "TLS",
- "whitelist": false,
- "serverAddressId": 2
}
], - "authentication": {
- "enabled": true,
- "userName": "test-user",
- "password": "string",
- "realm": "string"
}, - "heartbeat": {
- "enabled": true,
- "method": "OPTIONS",
- "retryTimeoutOnConnectionFailure": 2,
- "description": null,
- "frequency": 30,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "registration": {
- "registerWithAllServers": true,
- "registerWithPriorityServer": false,
- "refreshInterval": 0,
- "fromUri": "abc@def.com",
- "toUri": "bcd@def.com"
}, - "ping": {
- "enabled": true,
- "pingInterval": 100,
- "responseTime": 100
}, - "advanced": {
- "enableGrooming": true,
- "interworkingProfileId": 0,
- "securable": false,
- "tolerant": false,
- "uriGroupId": 0,
- "ng911Support": false,
- "fgdn": {
- "enabled": true,
- "tcpFailoverPort": 1010,
- "tlsFailoverPort": 1011
}
}, - "dos": {
- "enabled": true,
- "dosProtection": {
- "trafficType": "REMOTE_USERS",
- "maximumConcurrentSessions": 1000,
- "noOfRemoteUsers": 100
}
}
}
Add new server flow in SBCE
flowName | string Name for the server flow |
sipServerProfileId | integer SIP server profile |
transport | string Enum: "ANY" "TCP" "TLS" "UDP" Transport type |
receivedInterfaceId | integer id of Received Interface |
signalingInterfaceId | integer id of signaling Interface |
mediaInterfaceId | integer id of Media Interface |
endPointPolicyGroupId | integer Id of Endpoint Policy group |
topologyHidingProfileId | integer Id of Topology Hiding profile |
routingProfileId | integer Id of Routing profile |
fqdnSupport | boolean Default: false value should be |
fqdn | string <fqdn> Default: null The value should be present when |
uriGroupId | integer Default: 1 Profile id of the Uri Group. Below are the list of default profiles.
|
{- "flowName": "Server_flow1",
- "sipServerProfileId": 1,
- "transport": "TCP",
- "receivedInterfaceId": 1,
- "signalingInterfaceId": 1,
- "mediaInterfaceId": 1,
- "endPointPolicyGroupId": 1,
- "topologyHidingProfileId": 1,
- "routingProfileId": 1,
- "fqdnSupport": true,
- "fqdn": "some-fqdn.com",
- "uriGroupId": 1
}
{- "resourcePath": "/api/config/v1/sip-server-flows/2/priorities/1",
- "priority": 1,
- "flowName": "Server_flow1",
- "sipServerProfileId": 1,
- "transport": "TCP",
- "receivedInterfaceId": 1,
- "signalingInterfaceId": 1,
- "mediaInterfaceId": 1,
- "endPointPolicyGroupId": 1,
- "topologyHidingProfileId": 1,
- "routingProfileId": 1,
- "fqdnSupport": true,
- "fqdn": "some-fqdn.com",
- "uriGroupId": 1
}
Get all server flows
User must have the server-interworking:read
capability to perform this action.
Note: This is a bug and will be changed to server-flow:read
in a future release.
[- {
- "priority": 1,
- "flowName": "Server_flow1",
- "sipServerProfileId": 1,
- "transport": "TCP",
- "receivedInterfaceId": 1,
- "signalingInterfaceId": 1,
- "mediaInterfaceId": 1,
- "endPointPolicyGroupId": 1,
- "topologyHidingProfileId": 1,
- "routingProfileId": 1,
- "fqdnSupport": true,
- "fqdn": "some-fqdn.com",
- "uriGroupId": 1
}
]
Get all server flows
User must have the server-interworking:read
capability to perform this action.
Note: This is a bug and will be changed to server-flow:read
in a future release.
sipServerProfileId required | integer ID of sip server profile. |
[- {
- "priority": 1,
- "flowName": "Server_flow1",
- "sipServerProfileId": 1,
- "transport": "TCP",
- "receivedInterfaceId": 1,
- "signalingInterfaceId": 1,
- "mediaInterfaceId": 1,
- "endPointPolicyGroupId": 1,
- "topologyHidingProfileId": 1,
- "routingProfileId": 1,
- "fqdnSupport": true,
- "fqdn": "some-fqdn.com",
- "uriGroupId": 1
}
]
Edit server flow in SBCE
User must have the server-interworking:update
capability to perform this action.
Note: This is a bug and will be changed to server-flow:update
in a future release.
sipServerProfileId required | integer ID of the Sip server profile associated to flow |
priority required | integer priority of flow |
priority | integer <int64> The new priority to update. This value can be negative priority. that means that the priority value -1 will be the least priority, and -2 will be the second least priority. The negative priority starts from where the priorities ends. This means that the last priority of the server flows is the first element in the negative indexing which is -1. For Example, if there are 5 sip server flows associated with sip server profile. and the least priority is 5. So -1 priority indicates priority 5 and -5 indicates priority 1. |
flowName | string Name for the server flow |
sipServerProfileId | integer SIP server profile |
transport | string Enum: "ANY" "TCP" "TLS" "UDP" Transport type |
receivedInterfaceId | integer id of Received Interface |
signalingInterfaceId | integer id of signaling Interface |
mediaInterfaceId | integer id of Media Interface |
endPointPolicyGroupId | integer Id of Endpoint Policy group |
topologyHidingProfileId | integer Id of Topology Hiding profile |
routingProfileId | integer Id of Routing profile |
fqdnSupport | boolean Default: false value should be |
fqdn | string <fqdn> Default: null The value should be present when |
uriGroupId | integer Default: 1 Profile id of the Uri Group. Below are the list of default profiles.
|
{- "priority": 1,
- "flowName": "Server_flow1",
- "sipServerProfileId": 1,
- "transport": "TCP",
- "receivedInterfaceId": 1,
- "signalingInterfaceId": 1,
- "mediaInterfaceId": 1,
- "endPointPolicyGroupId": 1,
- "topologyHidingProfileId": 1,
- "routingProfileId": 1,
- "fqdnSupport": true,
- "fqdn": "some-fqdn.com",
- "uriGroupId": 1
}
[- {
- "priority": 1,
- "flowName": "Server_flow1",
- "sipServerProfileId": 1,
- "transport": "TCP",
- "receivedInterfaceId": 1,
- "signalingInterfaceId": 1,
- "mediaInterfaceId": 1,
- "endPointPolicyGroupId": 1,
- "topologyHidingProfileId": 1,
- "routingProfileId": 1,
- "fqdnSupport": true,
- "fqdn": "some-fqdn.com",
- "uriGroupId": 1
}
]
Get server flow for given ID
User must have the server-interworking:read
capability to perform this action.
Note: This is a bug and will be changed to server-flow:read
in a future release.
sipServerProfileId required | integer ID of the Sip server profile associated to flow |
priority required | integer priority of flow |
{- "priority": 1,
- "flowName": "Server_flow1",
- "sipServerProfileId": 1,
- "transport": "TCP",
- "receivedInterfaceId": 1,
- "signalingInterfaceId": 1,
- "mediaInterfaceId": 1,
- "endPointPolicyGroupId": 1,
- "topologyHidingProfileId": 1,
- "routingProfileId": 1,
- "fqdnSupport": true,
- "fqdn": "some-fqdn.com",
- "uriGroupId": 1
}
Delete server flow for given ID
User must have the server-interworking:delete
capability to perform this action.
Note: This is a bug and will be changed to server-flow:delete
in a future release.
sipServerProfileId required | integer ID of the Sip server profile associated to flow |
priority required | integer priority of flow |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new subscriber flow in SBCE
User must have the sip-subscriber-flow:create
capability to perform this action.
flowName | string Name for the subscriber flow |
uriGroupId | integer URI group |
userAgentId | integer User agent |
viaHost | string Default: "*" |
contactHost | string Default: "*" |
sourceSubnet | string Default: "*" |
signalingInterfaceId | integer Signaling interface |
source | string Default: "SUBSCRIBER" Enum: "SUBSCRIBER" "CLICK2CALL" |
methodsAllowed | Array of strings Items Enum: "INFO" "MESSAGE" "NOTIFY" "OPTIONS" "PING" "PUBLISH" "SUBSCRIBE" This field is accepted when the |
mediaInterfaceId | integer Media interface |
receivingInterfaceId | integer Receiving interface - This field is accepted when the |
endPointPolicyGroupId | integer Endpoint policy group |
routingProfileId | integer Routing profile |
tlsClientProfileId | integer TLS client profile |
sigmaProfileId | integer Sigma Profile |
fqdnSupport | boolean Default: false value should be |
fqdn | string <fqdn> Default: null The value should be present when |
ipUriBlocklistProfileId | integer Default: 0 Control IP / URI Blocklist feature for this flow. Using the default value will disable this feature for this flow. |
ipUriBlocklistTrustedAddress | string Trusted IP address for IP / URI Blocklist Profile (will not be blocked) |
{- "flowName": "Sig_int",
- "uriGroupId": 1,
- "userAgentId": 1,
- "viaHost": "*",
- "contactHost": "*",
- "sourceSubnet": "*",
- "signalingInterfaceId": 1,
- "source": "SUBSCRIBER",
- "methodsAllowed": [
- "INFO"
], - "mediaInterfaceId": 2,
- "receivingInterfaceId": -1,
- "endPointPolicyGroupId": 1,
- "routingProfileId": 1,
- "tlsClientProfileId": 1,
- "sigmaProfileId": 1,
- "fqdnSupport": true,
- "fqdn": "some-fqdn.com",
- "ipUriBlocklistProfileId": 1,
- "ipUriBlocklistTrustedAddress": "10.0.0.1"
}
{- "resourcePath": "api/config/v1/sip-subscriber-flows/1",
- "flowId": 1,
- "flowName": "Sig_int",
- "uriGroupId": 1,
- "userAgentId": 1,
- "viaHost": "*",
- "contactHost": "*",
- "sourceSubnet": "*",
- "signalingInterfaceId": 1,
- "source": "SUBSCRIBER",
- "methodsAllowed": [
- "INFO"
], - "mediaInterfaceId": 2,
- "receivingInterfaceId": -1,
- "endPointPolicyGroupId": 1,
- "routingProfileId": 1,
- "tlsClientProfileId": 1,
- "sigmaProfileId": 1,
- "fqdnSupport": true,
- "fqdn": "some-fqdn.com",
- "ipUriBlocklistProfileId": 1,
- "ipUriBlocklistTrustedAddress": "10.0.0.1"
}
Get all subscriber flows
User must have the sip-subscriber-flow:read
capability to perform this action.
[- {
- "flowId": 1,
- "flowName": "Sig_int",
- "uriGroupId": 1,
- "userAgentId": 1,
- "viaHost": "*",
- "contactHost": "*",
- "sourceSubnet": "*",
- "signalingInterfaceId": 1,
- "source": "SUBSCRIBER",
- "methodsAllowed": [
- "INFO"
], - "mediaInterfaceId": 2,
- "receivingInterfaceId": -1,
- "endPointPolicyGroupId": 1,
- "routingProfileId": 1,
- "tlsClientProfileId": 1,
- "sigmaProfileId": 1,
- "fqdnSupport": true,
- "fqdn": "some-fqdn.com",
- "ipUriBlocklistProfileId": 1,
- "ipUriBlocklistTrustedAddress": "10.0.0.1"
}
]
Edit subscriber flow in SBCE
User must have the sip-subscriber-flow:update
capability to perform this action.
flowId required | integer ID of the flow |
flowId | integer <int64> ID of the flow |
flowName | string Name for the subscriber flow |
uriGroupId | integer URI group |
userAgentId | integer User agent |
viaHost | string Default: "*" |
contactHost | string Default: "*" |
sourceSubnet | string Default: "*" |
signalingInterfaceId | integer Signaling interface |
source | string Default: "SUBSCRIBER" Enum: "SUBSCRIBER" "CLICK2CALL" |
methodsAllowed | Array of strings Items Enum: "INFO" "MESSAGE" "NOTIFY" "OPTIONS" "PING" "PUBLISH" "SUBSCRIBE" This field is accepted when the |
mediaInterfaceId | integer Media interface |
receivingInterfaceId | integer Receiving interface - This field is accepted when the |
endPointPolicyGroupId | integer Endpoint policy group |
routingProfileId | integer Routing profile |
tlsClientProfileId | integer TLS client profile |
sigmaProfileId | integer Sigma Profile |
fqdnSupport | boolean Default: false value should be |
fqdn | string <fqdn> Default: null The value should be present when |
ipUriBlocklistProfileId | integer Default: 0 Control IP / URI Blocklist feature for this flow. Using the default value will disable this feature for this flow. |
ipUriBlocklistTrustedAddress | string Trusted IP address for IP / URI Blocklist Profile (will not be blocked) |
{- "flowId": 1,
- "flowName": "Sig_int",
- "uriGroupId": 1,
- "userAgentId": 1,
- "viaHost": "*",
- "contactHost": "*",
- "sourceSubnet": "*",
- "signalingInterfaceId": 1,
- "source": "SUBSCRIBER",
- "methodsAllowed": [
- "INFO"
], - "mediaInterfaceId": 2,
- "receivingInterfaceId": -1,
- "endPointPolicyGroupId": 1,
- "routingProfileId": 1,
- "tlsClientProfileId": 1,
- "sigmaProfileId": 1,
- "fqdnSupport": true,
- "fqdn": "some-fqdn.com",
- "ipUriBlocklistProfileId": 1,
- "ipUriBlocklistTrustedAddress": "10.0.0.1"
}
{- "flowId": 1,
- "flowName": "Sig_int",
- "uriGroupId": 1,
- "userAgentId": 1,
- "viaHost": "*",
- "contactHost": "*",
- "sourceSubnet": "*",
- "signalingInterfaceId": 1,
- "source": "SUBSCRIBER",
- "methodsAllowed": [
- "INFO"
], - "mediaInterfaceId": 2,
- "receivingInterfaceId": -1,
- "endPointPolicyGroupId": 1,
- "routingProfileId": 1,
- "tlsClientProfileId": 1,
- "sigmaProfileId": 1,
- "fqdnSupport": true,
- "fqdn": "some-fqdn.com",
- "ipUriBlocklistProfileId": 1,
- "ipUriBlocklistTrustedAddress": "10.0.0.1"
}
Get subscriber flow for given ID
User must have the sip-subscriber-flow:read
capability to perform this action.
flowId required | integer ID of the flow |
{- "flowId": 1,
- "flowName": "Sig_int",
- "uriGroupId": 1,
- "userAgentId": 1,
- "viaHost": "*",
- "contactHost": "*",
- "sourceSubnet": "*",
- "signalingInterfaceId": 1,
- "source": "SUBSCRIBER",
- "methodsAllowed": [
- "INFO"
], - "mediaInterfaceId": 2,
- "receivingInterfaceId": -1,
- "endPointPolicyGroupId": 1,
- "routingProfileId": 1,
- "tlsClientProfileId": 1,
- "sigmaProfileId": 1,
- "fqdnSupport": true,
- "fqdn": "some-fqdn.com",
- "ipUriBlocklistProfileId": 1,
- "ipUriBlocklistTrustedAddress": "10.0.0.1"
}
Delete subscriber flow for given ID
User must have the sip-subscriber-flow:delete
capability to perform this action.
flowId required | integer ID of the flow |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new reverse proxy profile data in SBCE
User must have the reverse-proxy-profile:create
capability to perform this action.
profileName | string Name of the reverse proxy profile |
allowWebSocket | boolean Enable/Disable web socket |
httpVersion | string Default: "HTTP_1" Value: "HTTP_1" HTTP version to use |
clientMaxBodySizeInMB | integer Request max body size |
clientBodyTimeoutInSeconds | integer Client body timeout |
clientHeaderTimeoutInSeconds | integer Client header timeout |
dnsResolverTimeoutInSeconds | integer DNS resolver timeout |
sslSessionTimeoutInSeconds | integer TLS/SSL session timeout |
serverReadTimeoutInSeconds | integer Server read timeout |
enableRateLimiting | boolean Enable/Disable rate limiting |
totalClientCount | integer Total number of clients |
maxConnPerClient | integer Max simultaneous connections |
avgRequestRate | integer Average request rate |
rateUnitPerClient | string Default: "SECONDS" Enum: "SECONDS" "MINUTES" Rate unit |
burstPerClient | integer Burst per client |
{- "profileName": "test",
- "allowWebSocket": true,
- "httpVersion": "HTTP_1",
- "clientMaxBodySizeInMB": 10,
- "clientBodyTimeoutInSeconds": 30,
- "clientHeaderTimeoutInSeconds": 30,
- "dnsResolverTimeoutInSeconds": 30,
- "sslSessionTimeoutInSeconds": 300,
- "serverReadTimeoutInSeconds": 300,
- "enableRateLimiting": true,
- "totalClientCount": 30,
- "maxConnPerClient": 5,
- "avgRequestRate": 20,
- "rateUnitPerClient": "SECONDS",
- "burstPerClient": 20
}
{- "resourcePath": "api/config/v1/reverse-proxy-profiles/1",
- "profileId": 1,
- "profileName": "test",
- "allowWebSocket": true,
- "httpVersion": "HTTP_1",
- "clientMaxBodySizeInMB": 10,
- "clientBodyTimeoutInSeconds": 30,
- "clientHeaderTimeoutInSeconds": 30,
- "dnsResolverTimeoutInSeconds": 30,
- "sslSessionTimeoutInSeconds": 300,
- "serverReadTimeoutInSeconds": 300,
- "enableRateLimiting": true,
- "totalClientCount": 30,
- "maxConnPerClient": 5,
- "avgRequestRate": 20,
- "rateUnitPerClient": "SECONDS",
- "burstPerClient": 20
}
Get all reverse proxy profiles
User must have the reverse-proxy-profile:read
capability to perform this action.
[- {
- "profileId": 1,
- "profileName": "test",
- "allowWebSocket": true,
- "httpVersion": "HTTP_1",
- "clientMaxBodySizeInMB": 10,
- "clientBodyTimeoutInSeconds": 30,
- "clientHeaderTimeoutInSeconds": 30,
- "dnsResolverTimeoutInSeconds": 30,
- "sslSessionTimeoutInSeconds": 300,
- "serverReadTimeoutInSeconds": 300,
- "enableRateLimiting": true,
- "totalClientCount": 30,
- "maxConnPerClient": 5,
- "avgRequestRate": 20,
- "rateUnitPerClient": "SECONDS",
- "burstPerClient": 20
}
]
Edit reverse proxy profile for given ID
User must have the reverse-proxy-profile:update
capability to perform this action.
profileId required | integer >= 1 ID of the profile |
profileId | integer ID of the reverse proxy profile |
profileName | string Name of the reverse proxy profile |
allowWebSocket | boolean Enable/Disable web socket |
httpVersion | string Default: "HTTP_1" Value: "HTTP_1" HTTP version to use |
clientMaxBodySizeInMB | integer Request max body size |
clientBodyTimeoutInSeconds | integer Client body timeout |
clientHeaderTimeoutInSeconds | integer Client header timeout |
dnsResolverTimeoutInSeconds | integer DNS resolver timeout |
sslSessionTimeoutInSeconds | integer TLS/SSL session timeout |
serverReadTimeoutInSeconds | integer Server read timeout |
enableRateLimiting | boolean Enable/Disable rate limiting |
totalClientCount | integer Total number of clients |
maxConnPerClient | integer Max simultaneous connections |
avgRequestRate | integer Average request rate |
rateUnitPerClient | string Default: "SECONDS" Enum: "SECONDS" "MINUTES" Rate unit |
burstPerClient | integer Burst per client |
{- "profileId": 1,
- "profileName": "test",
- "allowWebSocket": true,
- "httpVersion": "HTTP_1",
- "clientMaxBodySizeInMB": 10,
- "clientBodyTimeoutInSeconds": 30,
- "clientHeaderTimeoutInSeconds": 30,
- "dnsResolverTimeoutInSeconds": 30,
- "sslSessionTimeoutInSeconds": 300,
- "serverReadTimeoutInSeconds": 300,
- "enableRateLimiting": true,
- "totalClientCount": 30,
- "maxConnPerClient": 5,
- "avgRequestRate": 20,
- "rateUnitPerClient": "SECONDS",
- "burstPerClient": 20
}
{- "profileId": 1,
- "profileName": "test",
- "allowWebSocket": true,
- "httpVersion": "HTTP_1",
- "clientMaxBodySizeInMB": 10,
- "clientBodyTimeoutInSeconds": 30,
- "clientHeaderTimeoutInSeconds": 30,
- "dnsResolverTimeoutInSeconds": 30,
- "sslSessionTimeoutInSeconds": 300,
- "serverReadTimeoutInSeconds": 300,
- "enableRateLimiting": true,
- "totalClientCount": 30,
- "maxConnPerClient": 5,
- "avgRequestRate": 20,
- "rateUnitPerClient": "SECONDS",
- "burstPerClient": 20
}
Get reverse proxy profile for given ID
User must have the reverse-proxy-profile:read
capability to perform this action.
profileId required | integer >= 1 ID of the profile |
{- "profileId": 1,
- "profileName": "test",
- "allowWebSocket": true,
- "httpVersion": "HTTP_1",
- "clientMaxBodySizeInMB": 10,
- "clientBodyTimeoutInSeconds": 30,
- "clientHeaderTimeoutInSeconds": 30,
- "dnsResolverTimeoutInSeconds": 30,
- "sslSessionTimeoutInSeconds": 300,
- "serverReadTimeoutInSeconds": 300,
- "enableRateLimiting": true,
- "totalClientCount": 30,
- "maxConnPerClient": 5,
- "avgRequestRate": 20,
- "rateUnitPerClient": "SECONDS",
- "burstPerClient": 20
}
Delete reverse proxy profile for given ID
User must have the reverse-proxy-profile:delete
capability to perform this action.
profileId required | integer >= 1 ID of the profile |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Adds new PPM Mapping Profile in SBCE.
User must have the ppm-mapping-profile:create
capability to perform this action.
ppmName | string |
Array of objects (PostPPMEntry) |
{- "ppmName": "ppm-profile-1",
- "ppmEntryList": [
- {
- "serverType": "PRESENCE",
- "customValues": false,
- "serverAddress": "1.1.1.1",
- "signalingInterfaceId": 2
}, - {
- "serverType": "SM",
- "customValues": false,
- "signalingInterfaceId": 2,
- "serverAddressId": 3,
- "mappedTransport": "TCP"
}, - {
- "serverType": "BRANCH_SM",
- "customValues": true,
- "serverAddress": "4.4.4.4",
- "mappedIp": "a.com",
- "serverPort": 1222,
- "serverTransport": "TCP",
- "mappedPort": 2121,
- "mappedTransport": "TCP"
}, - {
- "serverType": "BRANCH_SM",
- "customValues": true,
- "serverAddress": "3.3.3.3",
- "mappedIp": "2.2.2.2",
- "serverPort": 1212,
- "serverTransport": "TCP",
- "mappedPort": 1212,
- "mappedTransport": "TCP"
}, - {
- "serverType": "PRESENCE",
- "customValues": true,
- "serverAddress": "www.test.com",
- "mappedIp": "www.test2.com"
}
]
}
{- "ppmProfileId": 1,
- "ppmName": "ppm-profile-1",
- "resourcePath": "/api/config/v1/ppm-mapping-profiles/1",
- "ppmEntryList": [
- {
- "ppmEntryId": 10,
- "serverType": "PRESENCE",
- "customValues": false,
- "serverAddress": "1.1.1.1",
- "signalingInterfaceId": 2
}, - {
- "ppmEntryId": 11,
- "serverType": "SM",
- "customValues": false,
- "signalingInterfaceId": 2,
- "serverAddressId": 3,
- "mappedTransport": "TCP"
}, - {
- "ppmEntryId": 12,
- "serverType": "BRANCH_SM",
- "customValues": true,
- "serverAddress": "4.4.4.4",
- "mappedIp": "a.com",
- "serverPort": 1222,
- "serverTransport": "TCP",
- "mappedPort": 2121,
- "mappedTransport": "TCP"
}, - {
- "ppmEntryId": 13,
- "serverType": "BRANCH_SM",
- "customValues": true,
- "serverAddress": "3.3.3.3",
- "mappedIp": "2.2.2.2",
- "serverPort": 1212,
- "serverTransport": "TCP",
- "mappedPort": 1212,
- "mappedTransport": "TCP"
}, - {
- "ppmEntryId": 14,
- "serverType": "PRESENCE",
- "customValues": true,
- "serverAddress": "www.test.com",
- "mappedIp": "www.test2.com"
}
]
}
Retrieve all PPM Mapping Profiles configured in SBCE.
User must have the ppm-mapping-profile:read
capability to perform this action.
[- {
- "ppmProfileId": 1,
- "ppmName": "ppm-profile-1",
- "ppmEntryList": [
- {
- "ppmEntryId": 10,
- "serverType": "PRESENCE",
- "customValues": false,
- "serverAddress": "1.1.1.1",
- "signalingInterfaceId": 2
}, - {
- "ppmEntryId": 11,
- "serverType": "SM",
- "customValues": false,
- "signalingInterfaceId": 2,
- "serverAddressId": 3,
- "mappedTransport": "TCP"
}, - {
- "ppmEntryId": 12,
- "serverType": "BRANCH_SM",
- "customValues": true,
- "serverAddress": "4.4.4.4",
- "mappedIp": "a.com",
- "serverPort": 1222,
- "serverTransport": "TCP",
- "mappedPort": 2121,
- "mappedTransport": "TCP"
}, - {
- "ppmEntryId": 13,
- "serverType": "BRANCH_SM",
- "customValues": true,
- "serverAddress": "3.3.3.3",
- "mappedIp": "2.2.2.2",
- "serverPort": 1212,
- "serverTransport": "TCP",
- "mappedPort": 1212,
- "mappedTransport": "TCP"
}, - {
- "ppmEntryId": 14,
- "serverType": "PRESENCE",
- "customValues": true,
- "serverAddress": "www.test.com",
- "mappedIp": "www.test2.com"
}
]
}
]
Get PPM Mapping Profile by ppmProfileId configured in SBCE.
User must have the ppm-mapping-profile:read
capability to perform this action.
ppmProfileId required | integer ID of the PPM Mapping Profile |
{- "ppmProfileId": 1,
- "ppmName": "ppm-profile-1",
- "ppmEntryList": [
- {
- "ppmEntryId": 10,
- "serverType": "PRESENCE",
- "customValues": false,
- "serverAddress": "1.1.1.1",
- "signalingInterfaceId": 2
}, - {
- "ppmEntryId": 11,
- "serverType": "SM",
- "customValues": false,
- "signalingInterfaceId": 2,
- "serverAddressId": 3,
- "mappedTransport": "TCP"
}, - {
- "ppmEntryId": 12,
- "serverType": "BRANCH_SM",
- "customValues": true,
- "serverAddress": "4.4.4.4",
- "mappedIp": "a.com",
- "serverPort": 1222,
- "serverTransport": "TCP",
- "mappedPort": 2121,
- "mappedTransport": "TCP"
}, - {
- "ppmEntryId": 13,
- "serverType": "BRANCH_SM",
- "customValues": true,
- "serverAddress": "3.3.3.3",
- "mappedIp": "2.2.2.2",
- "serverPort": 1212,
- "serverTransport": "TCP",
- "mappedPort": 1212,
- "mappedTransport": "TCP"
}, - {
- "ppmEntryId": 14,
- "serverType": "PRESENCE",
- "customValues": true,
- "serverAddress": "www.test.com",
- "mappedIp": "www.test2.com"
}
]
}
Delete PPM Mapping Profile by ppmProfileId in SBCE
User must have the ppm-mapping-profile:delete
capability to perform this action.
ppmProfileId required | integer ID of the profile |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new PPM Entry to PPM Mapping Profile by ppmProfileId in SBCE
User must have the ppm-mapping-profile:create
capability to perform this action.
ppmProfileId required | integer ID of the PPM Mapping Profile |
serverType | string Enum: "PRESENCE" "SM" "BRANCH_SM" |
customValues | boolean |
serverAddressId | integer |
serverAddress | string |
serverPort | number [ 1 .. 65534 ] |
serverTransport | string Enum: "TCP" "UDP" "TLS" |
signalingInterfaceId | number |
mappedIp | string |
mappedPort | number [ 1 .. 65534 ] |
mappedTransport | string Enum: "TCP" "UDP" "TLS" |
{- "serverType": "PRESENCE",
- "customValues": true,
- "serverAddress": "www.test.com",
- "mappedIp": "www.test2.com"
}
{- "resourcePath": "/api/config/v1/ppm-mapping-profiles/1/ppm-entries/14",
- "ppmEntryId": 14,
- "serverType": "PRESENCE",
- "customValues": true,
- "serverAddress": "www.test.com",
- "mappedIp": "www.test2.com"
}
Get all PPM Entries associated to PPM Mapping Profile by ppmProfileId in SBCE
User must have the ppm-mapping-profile:read
capability to perform this action.
ppmProfileId required | integer ID of the PPM Mapping Profile |
[- {
- "ppmEntryId": 10,
- "serverType": "PRESENCE",
- "customValues": false,
- "serverAddress": "1.1.1.1",
- "signalingInterfaceId": 2
}, - {
- "ppmEntryId": 11,
- "serverType": "SM",
- "customValues": false,
- "signalingInterfaceId": 2,
- "serverAddressId": 3,
- "mappedTransport": "TCP"
}, - {
- "ppmEntryId": 12,
- "serverType": "BRANCH_SM",
- "customValues": true,
- "serverAddress": "4.4.4.4",
- "mappedIp": "a.com",
- "serverPort": 1222,
- "serverTransport": "TCP",
- "mappedPort": 2121,
- "mappedTransport": "TCP"
}, - {
- "ppmEntryId": 13,
- "serverType": "BRANCH_SM",
- "customValues": true,
- "serverAddress": "3.3.3.3",
- "mappedIp": "2.2.2.2",
- "serverPort": 1212,
- "serverTransport": "TCP",
- "mappedPort": 1212,
- "mappedTransport": "TCP"
}, - {
- "ppmEntryId": 14,
- "serverType": "PRESENCE",
- "customValues": true,
- "serverAddress": "www.test.com",
- "mappedIp": "www.test2.com"
}
]
Edit PPMEntry with ppmEntryId in PPM Mapping Profile by ppmProfileId in SBCE
User must have the ppm-mapping-profile:update
capability to perform this action.
ppmProfileId required | integer ID of the PPM Mapping Profile |
ppmEntryId required | integer ID of the PPM Entry |
serverType | string Enum: "PRESENCE" "SM" "BRANCH_SM" |
customValues | boolean |
serverAddressId | integer |
serverAddress | string |
serverPort | number [ 1 .. 65534 ] |
serverTransport | string Enum: "TCP" "UDP" "TLS" |
signalingInterfaceId | number |
mappedIp | string |
mappedPort | number [ 1 .. 65534 ] |
mappedTransport | string Enum: "TCP" "UDP" "TLS" |
{- "serverType": "PRESENCE",
- "customValues": true,
- "serverAddress": "www.test.com",
- "mappedIp": "www.test2.com"
}
{- "ppmEntryId": 14,
- "serverType": "PRESENCE",
- "customValues": true,
- "serverAddress": "www.test.com",
- "mappedIp": "www.test2.com"
}
Get PPM Entry with ppmEntryId in PPM Mapping Profile by ppmProfileId in SBCE
User must have the ppm-mapping-profile:read
capability to perform this action.
ppmProfileId required | integer ID of the PPM Mapping Profile |
ppmEntryId required | integer ID of the PPM Entry |
{- "ppmEntryId": 14,
- "serverType": "PRESENCE",
- "customValues": true,
- "serverAddress": "www.test.com",
- "mappedIp": "www.test2.com"
}
Delete PPM Entry with ppmEntryId in PPM Mapping Profile by ppmProfileId in SBCE
User must have the ppm-mapping-profile:delete
capability to perform this action.
ppmProfileId required | integer ID of the PPM Mapping Profile |
ppmEntryId required | integer ID of the PPM Entry |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new reverse proxy relay in SBCE
User must have the reverse-proxy-relay:create
capability to perform this action.
relayName | string Name of the reverse proxy relay |
listenIp | string Listen IP |
listenPort | integer Listen port |
connectIp | string Connect IP |
serverTlsProfile | string TLS profile |
listenDomain | string Listen domain |
rewriteUrl | boolean Rewrite URLs |
ppmMappingProfileId | integer ID of PPM Mapping profile |
reverseProxyProfileId | integer |
ipUriBlocklistProfileId | integer Default: 0 Control IP / URI Blocklist feature for this flow. Using the default value will disable this feature for this flow. |
ipUriBlocklistTrustedAddress | string Trusted IP address for IP / URI Blocklist Profile (will not be blocked) |
whitelistedIps | Array of strings Whitelisted IPs (comma separated) |
Array of objects (ReverseProxyServerAddress) |
{- "relayName": "test",
- "listenIp": "10.133.39.171",
- "listenPort": 1235,
- "connectIp": "10.133.73.46",
- "serverTlsProfile": "None",
- "listenDomain": "abc.com",
- "rewriteUrl": true,
- "ppmMappingProfileId": 1,
- "reverseProxyProfileId": 1,
- "ipUriBlocklistProfileId": 1,
- "ipUriBlocklistTrustedAddress": "10.0.0.1",
- "whitelistedIps": [
- "10.133.39.1",
- "10.133.39.2"
], - "serverAddresses": [
- {
- "serverAddress": "1.1.1.1",
- "port": 111,
- "url": "/",
- "urlReplace": "/"
}
]
}
{- "resourcePath": "api/config/v1/reverse-proxy-relays/1",
- "relayId": 1,
- "relayName": "test",
- "listenIp": "10.133.39.171",
- "listenPort": 1235,
- "connectIp": "10.133.73.46",
- "serverTlsProfile": "None",
- "listenDomain": "abc.com",
- "rewriteUrl": true,
- "ppmMappingProfileId": 1,
- "reverseProxyProfileId": 1,
- "ipUriBlocklistProfileId": 1,
- "ipUriBlocklistTrustedAddress": "10.0.0.1",
- "whitelistedIps": [
- "10.133.39.1",
- "10.133.39.2"
], - "serverAddresses": [
- {
- "serverAddress": "1.1.1.1",
- "port": 111,
- "url": "/",
- "urlReplace": "/"
}
]
}
Get all reverse proxy relay services
User must have the reverse-proxy-relay:read
capability to perform this action.
[- {
- "relayId": 1,
- "relayName": "test",
- "listenIp": "10.133.39.171",
- "listenPort": 1235,
- "connectIp": "10.133.73.46",
- "serverTlsProfile": "None",
- "listenDomain": "abc.com",
- "rewriteUrl": true,
- "ppmMappingProfileId": 1,
- "reverseProxyProfileId": 1,
- "ipUriBlocklistProfileId": 1,
- "ipUriBlocklistTrustedAddress": "10.0.0.1",
- "whitelistedIps": [
- "10.133.39.1",
- "10.133.39.2"
], - "serverAddresses": [
- {
- "serverAddress": "1.1.1.1",
- "port": 111,
- "url": "/",
- "urlReplace": "/"
}
]
}
]
Edit reverse proxy relay in SBCE
User must have the reverse-proxy-relay:update
capability to perform this action.
relayId required | integer >= 1 ID of the server |
relayId | integer ID of the reverse proxy relay |
relayName | string Name of the reverse proxy relay |
listenIp | string Listen IP |
listenPort | integer Listen port |
connectIp | string Connect IP |
serverTlsProfile | string TLS profile |
listenDomain | string Listen domain |
rewriteUrl | boolean Rewrite URLs |
ppmMappingProfileId | integer ID of PPM Mapping profile |
reverseProxyProfileId | integer |
ipUriBlocklistProfileId | integer Default: 0 Control IP / URI Blocklist feature for this flow. Using the default value will disable this feature for this flow. |
ipUriBlocklistTrustedAddress | string Trusted IP address for IP / URI Blocklist Profile (will not be blocked) |
whitelistedIps | Array of strings Whitelisted IPs (comma separated) |
Array of objects (ReverseProxyServerAddress) |
{- "relayId": 1,
- "relayName": "test",
- "listenIp": "10.133.39.171",
- "listenPort": 1235,
- "connectIp": "10.133.73.46",
- "serverTlsProfile": "None",
- "listenDomain": "abc.com",
- "rewriteUrl": true,
- "ppmMappingProfileId": 1,
- "reverseProxyProfileId": 1,
- "ipUriBlocklistProfileId": 1,
- "ipUriBlocklistTrustedAddress": "10.0.0.1",
- "whitelistedIps": [
- "10.133.39.1",
- "10.133.39.2"
], - "serverAddresses": [
- {
- "serverAddress": "1.1.1.1",
- "port": 111,
- "url": "/",
- "urlReplace": "/"
}
]
}
{- "relayId": 1,
- "relayName": "test",
- "listenIp": "10.133.39.171",
- "listenPort": 1235,
- "connectIp": "10.133.73.46",
- "serverTlsProfile": "None",
- "listenDomain": "abc.com",
- "rewriteUrl": true,
- "ppmMappingProfileId": 1,
- "reverseProxyProfileId": 1,
- "ipUriBlocklistProfileId": 1,
- "ipUriBlocklistTrustedAddress": "10.0.0.1",
- "whitelistedIps": [
- "10.133.39.1",
- "10.133.39.2"
], - "serverAddresses": [
- {
- "serverAddress": "1.1.1.1",
- "port": 111,
- "url": "/",
- "urlReplace": "/"
}
]
}
Get reverse proxy relay for given ID
User must have the reverse-proxy-relay:read
capability to perform this action.
relayId required | integer >= 1 ID of the server |
{- "relayId": 1,
- "relayName": "test",
- "listenIp": "10.133.39.171",
- "listenPort": 1235,
- "connectIp": "10.133.73.46",
- "serverTlsProfile": "None",
- "listenDomain": "abc.com",
- "rewriteUrl": true,
- "ppmMappingProfileId": 1,
- "reverseProxyProfileId": 1,
- "ipUriBlocklistProfileId": 1,
- "ipUriBlocklistTrustedAddress": "10.0.0.1",
- "whitelistedIps": [
- "10.133.39.1",
- "10.133.39.2"
], - "serverAddresses": [
- {
- "serverAddress": "1.1.1.1",
- "port": 111,
- "url": "/",
- "urlReplace": "/"
}
]
}
Delete the reverse proxy relay for given ID
User must have the reverse-proxy-relay:delete
capability to perform this action.
relayId required | integer >= 1 ID of the server |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Retrieve a list of all application relays for this system.
User must have the application-relay:read
capability.
[- {
- "relayId": 0,
- "relayName": "LDAPS Relay",
- "serviceType": "LDAP",
- "listenIpId": 1,
- "listenPort": 636,
- "listenTransport": "TLS",
- "listenTlsProfileId": 2,
- "listenConnectIpId": 2,
- "remoteAddress": "ldaps.test.com",
- "remotePort": 636,
- "remoteTransport": "TLS",
- "remoteTlsProfileId": 3,
- "whitelistedFlows": false
}
]
Create a new application relay for this system.
User must have the application-relay:create
capability.
relayName | string The name of this application relay. |
serviceType | string Enum: "XMPP" "RTCP" "LDAP" "SCEP" "HTTP" "CES_PROXY" "OTHER" The type of service that will be relayed. Notes:
|
listenIpId | integer The ID of the IP address that will be used to listen for incoming connections. This cannot be the same ID as the connect IP ID. |
listenPort | integer The port to listen on. |
listenTransport | string Enum: "TCP" "UDP" "TLS" |
listenTlsProfileId | integer This field must be specified if The ID of the TLS server profile to use when establishing TLS connections while listening for traffic on for this relay. |
listenConnectIpId | integer The ID of the IP address that will be used to connect to the remote address. This cannot be the same ID as the listen IP ID. |
remoteAddress | string The remote IP address or FQDN to send relayed traffic to. |
remotePort | integer The remote port to send relayed traffic to. |
remoteTransport | string Enum: "TCP" "UDP" "TLS" The transport to use when determining how to send traffic to the remote address. |
remoteTlsProfileId | integer This field must be specified if The ID of the TLS client profile to use when establishing TLS connections to the remote address. |
whitelistedFlows | boolean Whitelist flows for CES_PROXY. |
{- "relayName": "LDAPS Relay",
- "serviceType": "LDAP",
- "listenIpId": 1,
- "listenPort": 636,
- "listenTransport": "TLS",
- "listenTlsProfileId": 2,
- "listenConnectIpId": 2,
- "remoteAddress": "ldaps.test.com",
- "remotePort": 636,
- "remoteTransport": "TLS",
- "remoteTlsProfileId": 3,
- "whitelistedFlows": false
}
{- "resourcePath": "string",
- "relayName": "LDAPS Relay",
- "serviceType": "LDAP",
- "listenIpId": 1,
- "listenPort": 636,
- "listenTransport": "TLS",
- "listenTlsProfileId": 2,
- "listenConnectIpId": 2,
- "remoteAddress": "ldaps.test.com",
- "remotePort": 636,
- "remoteTransport": "TLS",
- "remoteTlsProfileId": 3,
- "whitelistedFlows": false
}
Retrieve an application relay for this system.
User must have the application-relay:read
capability.
id required | integer |
{- "relayId": 0,
- "relayName": "LDAPS Relay",
- "serviceType": "LDAP",
- "listenIpId": 1,
- "listenPort": 636,
- "listenTransport": "TLS",
- "listenTlsProfileId": 2,
- "listenConnectIpId": 2,
- "remoteAddress": "ldaps.test.com",
- "remotePort": 636,
- "remoteTransport": "TLS",
- "remoteTlsProfileId": 3,
- "whitelistedFlows": false
}
Modify an application relay for this system.
User must have the application-relay:update
capability.
id required | integer |
relayName | string The name of this application relay. |
serviceType | string Enum: "XMPP" "RTCP" "LDAP" "SCEP" "HTTP" "CES_PROXY" "OTHER" The type of service that will be relayed. Notes:
|
listenIpId | integer The ID of the IP address that will be used to listen for incoming connections. This cannot be the same ID as the connect IP ID. |
listenPort | integer The port to listen on. |
listenTransport | string Enum: "TCP" "UDP" "TLS" |
listenTlsProfileId | integer This field must be specified if The ID of the TLS server profile to use when establishing TLS connections while listening for traffic on for this relay. |
listenConnectIpId | integer The ID of the IP address that will be used to connect to the remote address. This cannot be the same ID as the listen IP ID. |
remoteAddress | string The remote IP address or FQDN to send relayed traffic to. |
remotePort | integer The remote port to send relayed traffic to. |
remoteTransport | string Enum: "TCP" "UDP" "TLS" The transport to use when determining how to send traffic to the remote address. |
remoteTlsProfileId | integer This field must be specified if The ID of the TLS client profile to use when establishing TLS connections to the remote address. |
whitelistedFlows | boolean Whitelist flows for CES_PROXY. |
{- "relayName": "LDAPS Relay",
- "serviceType": "LDAP",
- "listenIpId": 1,
- "listenPort": 636,
- "listenTransport": "TLS",
- "listenTlsProfileId": 2,
- "listenConnectIpId": 2,
- "remoteAddress": "ldaps.test.com",
- "remotePort": 636,
- "remoteTransport": "TLS",
- "remoteTlsProfileId": 3,
- "whitelistedFlows": false
}
{- "relayName": "LDAPS Relay",
- "serviceType": "LDAP",
- "listenIpId": 1,
- "listenPort": 636,
- "listenTransport": "TLS",
- "listenTlsProfileId": 2,
- "listenConnectIpId": 2,
- "remoteAddress": "ldaps.test.com",
- "remotePort": 636,
- "remoteTransport": "TLS",
- "remoteTlsProfileId": 3,
- "whitelistedFlows": false
}
Delete an application relay for this system.
User must have the application-relay:delete
capability.
id required | integer |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
APIs for managing Traversal Using Relays around NAT (TURN) / Session Traversal Utilities for NAT (STUN) profiles.
Add new turn stun profile data in SBCE
User must have the turn-stun-profile:create
capability to perform this action.
profileName | string Name of the turn stun profile |
udpListenPort | integer UDP listen port |
tcpTlsListenPort | integer TCP/TLS listen port |
tlsServerProfileName | string TLS server profile |
mediaRelayMinPort | integer Media relay minimum port |
mediaRelayMaxPort | integer Media relay maximum port |
object or object | |
fingerPrint | boolean Fingerprint enabled/disabled |
tcpRelay | boolean TCP relay enabled/disabled |
udpRelay | boolean UDP Relay enabled/disabled |
dtls | boolean DTLS enabled/disabled |
mediaLearning | boolean Media learning enabled/disabled |
alternateServer1 | string <ipv4> |
alternateServer2 | string <ipv4> |
alternateServer3 | string <ipv4> |
{- "profileName": "test",
- "udpListenPort": 5060,
- "tcpTlsListenPort": 1111,
- "tlsServerProfileName": null,
- "mediaRelayMinPort": 50000,
- "mediaRelayMaxPort": 55000,
- "authentication": {
- "enabled": false,
- "clientAuthentication": true,
- "nonceExpiryInSeconds": 600
}, - "fingerPrint": "Y",
- "tcpRelay": "Y",
- "udpRelay": "Y",
- "dtls": "N",
- "mediaLearning": "Y",
- "alternateServer1": "1.1.1.1",
- "alternateServer2": "1.1.1.1",
- "alternateServer3": "1.1.1.1"
}
{- "resourcePath": "api/config/v1/turn-stun-profiles/1",
- "profileId": 1,
- "profileName": "test",
- "udpListenPort": 5060,
- "tcpTlsListenPort": 1111,
- "tlsServerProfileName": null,
- "mediaRelayMinPort": 50000,
- "mediaRelayMaxPort": 55000,
- "authentication": {
- "enabled": false,
- "clientAuthentication": true,
- "nonceExpiryInSeconds": 600
}, - "fingerPrint": "Y",
- "tcpRelay": "Y",
- "udpRelay": "Y",
- "dtls": "N",
- "mediaLearning": "Y",
- "alternateServer1": "1.1.1.1",
- "alternateServer2": "1.1.1.1",
- "alternateServer3": "1.1.1.1"
}
Get all turn stun profiles
User must have the turn-stun-profile:read
capability to perform this action.
[- {
- "profileId": 1,
- "profileName": "ServerAuth",
- "udpListenPort": 3478,
- "tlsServerProfileId": 0,
- "mediaRelayMinPort": 50000,
- "mediaRelayMaxPort": 55000,
- "authentication": {
- "enable": true
}, - "clientAuthentication": {
- "clientAuthentication": false,
- "nonceExpiryInSeconds": 600
}, - "serverAuthentication": {
- "serverAuthentication": true,
- "userName": "sbcsv",
- "realm": "avaya.com"
}, - "fingerPrint": true,
- "tcpRelay": true,
- "udpRelay": false,
- "dtls": false,
- "mediaLearning": true,
- "alternateServer1": "",
- "alternateServer2": "",
- "alternateServer3": ""
}, - {
- "profileId": 2,
- "profileName": "ClientAuth",
- "udpListenPort": 3478,
- "tcpTlsListenPort": 443,
- "tlsServerProfileId": -1,
- "mediaRelayMinPort": 50000,
- "mediaRelayMaxPort": 55000,
- "authentication": {
- "enable": true
}, - "clientAuthentication": {
- "clientAuthentication": true,
- "nonceExpiryInSeconds": 600
}, - "serverAuthentication": {
- "serverAuthentication": false,
- "userName": "",
- "realm": ""
}, - "fingerPrint": false,
- "tcpRelay": false,
- "udpRelay": true,
- "dtls": true,
- "mediaLearning": false,
- "alternateServer1": "",
- "alternateServer2": "",
- "alternateServer3": ""
}
]
Edit new turn stun profile data in SBCE
User must have the turn-stun-profile:update
capability to perform this action.
profileId required | integer >= 1 ID of the profile |
profileId | integer ID of turn stun profile |
profileName | string Name of the turn stun profile |
udpListenPort | integer UDP listen port |
tcpTlsListenPort | integer TCP/TLS listen port |
tlsServerProfileName | string TLS server profile |
mediaRelayMinPort | integer Media relay minimum port |
mediaRelayMaxPort | integer Media relay maximum port |
object or object | |
fingerPrint | boolean Fingerprint enabled/disabled |
tcpRelay | boolean TCP relay enabled/disabled |
udpRelay | boolean UDP Relay enabled/disabled |
dtls | boolean DTLS enabled/disabled |
mediaLearning | boolean Media learning enabled/disabled |
alternateServer1 | string <ipv4> |
alternateServer2 | string <ipv4> |
alternateServer3 | string <ipv4> |
{- "profileId": 1,
- "profileName": "test",
- "udpListenPort": 5060,
- "tcpTlsListenPort": 1111,
- "tlsServerProfileName": null,
- "mediaRelayMinPort": 50000,
- "mediaRelayMaxPort": 55000,
- "authentication": {
- "enabled": false,
- "clientAuthentication": true,
- "nonceExpiryInSeconds": 600
}, - "fingerPrint": "Y",
- "tcpRelay": "Y",
- "udpRelay": "Y",
- "dtls": "N",
- "mediaLearning": "Y",
- "alternateServer1": "1.1.1.1",
- "alternateServer2": "1.1.1.1",
- "alternateServer3": "1.1.1.1"
}
{- "profileId": 1,
- "profileName": "test",
- "udpListenPort": 5060,
- "tcpTlsListenPort": 1111,
- "tlsServerProfileName": null,
- "mediaRelayMinPort": 50000,
- "mediaRelayMaxPort": 55000,
- "authentication": {
- "enabled": false,
- "clientAuthentication": true,
- "nonceExpiryInSeconds": 600
}, - "fingerPrint": "Y",
- "tcpRelay": "Y",
- "udpRelay": "Y",
- "dtls": "N",
- "mediaLearning": "Y",
- "alternateServer1": "1.1.1.1",
- "alternateServer2": "1.1.1.1",
- "alternateServer3": "1.1.1.1"
}
Get stun turn profile for given ID
User must have the turn-stun-profile:read
capability to perform this action.
profileId required | integer >= 1 ID of the profile |
{- "profileId": 1,
- "profileName": "test",
- "udpListenPort": 5060,
- "tcpTlsListenPort": 1111,
- "tlsServerProfileName": null,
- "mediaRelayMinPort": 50000,
- "mediaRelayMaxPort": 55000,
- "authentication": {
- "enabled": false,
- "clientAuthentication": true,
- "nonceExpiryInSeconds": 600
}, - "fingerPrint": "Y",
- "tcpRelay": "Y",
- "udpRelay": "Y",
- "dtls": "N",
- "mediaLearning": "Y",
- "alternateServer1": "1.1.1.1",
- "alternateServer2": "1.1.1.1",
- "alternateServer3": "1.1.1.1"
}
Delete the turn stun profile for given ID
User must have the turn-stun-profile:delete
capability to perform this action.
profileId required | integer >= 1 ID of the profile |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new turn stun relay data in SBCE
User must have the turn-stun-relay:create
capability to perform this action.
listenIpId | string <ipv4> |
mediaRelayIpId | string <ipv4> |
serviceFqdn | string <fqdn> |
{- "listenIpId": 1,
- "mediaRelayIpId": 2,
- "serviceFqdn": "test.com"
}
{- "resourcePath": "api/config/v1/turn-stun-relays/1",
- "turnStunProfileId": 1,
- "listenIpId": 1,
- "mediaRelayIpId": 2,
- "serviceFqdn": "test.com"
}
Edit turn stun relay data in SBCE
User must have the turn-stun-relay:update
capability to perform this action.
relayId required | integer >= 1 ID of the Turn Stun Relay |
turnStunProfileId | integer |
listenIpId | string <ipv4> |
mediaRelayIpId | string <ipv4> |
serviceFqdn | string <fqdn> |
{- "turnStunProfileId": 1,
- "listenIpId": 1,
- "mediaRelayIpId": 2,
- "serviceFqdn": "test.com"
}
{- "turnStunProfileId": 1,
- "listenIpId": 1,
- "mediaRelayIpId": 2,
- "serviceFqdn": "test.com"
}
Get turn stun relay service for given ID
User must have the turn-stun-relay:read
capability to perform this action.
relayId required | integer >= 1 ID of the Turn Stun Relay |
{- "turnStunProfileId": 1,
- "listenIpId": 1,
- "mediaRelayIpId": 2,
- "serviceFqdn": "test.com"
}
Delete the turn stun relay service for given ID
User must have the turn-stun-relay:delete
capability to perform this action.
relayId required | integer >= 1 |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new load monitoring profile in SBCE
User must have the load-monitoring-profile:create
capability to perform this action.
loadBalancerType | string Enum: "INTERNAL" "EXTERNAL" Load Balancer Type |
listenIpId | string Listen IP |
listenProtocol | string Enum: "TCP" "TLS" Transport type |
listenTlsProfileId | integer TLS profile if transport selected is TLS |
serviceType | string Enum: "TURN" "MEDIA TYPE" Service type |
{- "loadBalancerType": "INTERNAL",
- "listenIpId": 1,
- "listenProtocol": "TCP",
- "listenTlsProfileId": 0,
- "serviceType": "TURN"
}
{- "resourcePath": "api/config/v1/load-monitoring-profiles/1",
- "profileId": 1,
- "loadBalancerType": "INTERNAL",
- "listenIpId": 1,
- "listenProtocol": "TCP",
- "listenTlsProfileId": 0,
- "serviceType": "TURN"
}
Get all load monitoring profiles
User must have the load-monitoring-profile:read
capability to perform this action.
[- {
- "profileId": 1,
- "loadBalancerType": "INTERNAL",
- "listenIpId": 1,
- "listenProtocol": "TCP",
- "listenTlsProfileId": 0,
- "serviceType": "TURN"
}
]
Edit existing load monitoring profile for given ID
User must have the load-monitoring-profile:update
capability to perform this action.
profileId required | integer ID of the profile |
profileId | integer <int64> ID of the profile |
loadBalancerType | string Enum: "INTERNAL" "EXTERNAL" Load Balancer Type |
listenIpId | string Listen IP |
listenProtocol | string Enum: "TCP" "TLS" Transport type |
listenTlsProfileId | integer TLS profile if transport selected is TLS |
serviceType | string Enum: "TURN" "MEDIA TYPE" Service type |
{- "profileId": 1,
- "loadBalancerType": "INTERNAL",
- "listenIpId": 1,
- "listenProtocol": "TCP",
- "listenTlsProfileId": 0,
- "serviceType": "TURN"
}
{- "profileId": 1,
- "loadBalancerType": "INTERNAL",
- "listenIpId": 1,
- "listenProtocol": "TCP",
- "listenTlsProfileId": 0,
- "serviceType": "TURN"
}
Get load monitoring profile for given ID
User must have the load-monitoring-profile:read
capability to perform this action.
profileId required | integer ID of the profile |
{- "profileId": 1,
- "loadBalancerType": "INTERNAL",
- "listenIpId": 1,
- "listenProtocol": "TCP",
- "listenTlsProfileId": 0,
- "serviceType": "TURN"
}
Delete load monitoring profile for given ID
User must have the load-monitoring-profile:delete
capability to perform this action.
profileId required | integer ID of the profile |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new routing profile in SBCE
User must have the routing-profile:create
capability to perform this action.
profileName | string Name for the profile |
Array of objects (PostRoutingRule) |
{- "profileName": "sm-route",
- "profileRules": [
- {
- "priority": 0,
- "uriGroupId": 1,
- "timeOfDayId": 1,
- "outgoingTransport": "TCP",
- "loadBalancing": "PRIORITY",
- "nextHopInDialog": true,
- "sniServerName": "string",
- "sniEnabled": true,
- "nextHopAddresses": [
- {
- "priority": 1,
- "serverConfigAddressId": 1,
- "nextHopIpAddress": "192.168.5.4",
- "port": 111,
- "transport": "TCP"
}
]
}
]
}
{- "resourcePath": "api/config/v1/routing-profiles/1",
- "profileId": 1,
- "profileName": "sm-route",
- "profileRules": [
- {
- "ruleId": 1,
- "nextHopAddresses": [
- {
- "priority": 1,
- "serverConfigAddressId": 1,
- "nextHopIpAddress": "192.168.5.4",
- "port": 111,
- "transport": "TCP"
}
], - "priority": 0,
- "uriGroupId": 1,
- "timeOfDayId": 1,
- "outgoingTransport": "TCP",
- "loadBalancing": "PRIORITY",
- "nextHopInDialog": true,
- "sniServerName": "string",
- "sniEnabled": true
}
]
}
Get all routing profiles configured in SBCE
User must have the routing-profile:read
capability to perform this action.
[- {
- "profileId": 1,
- "profileName": "sm-route",
- "profileRules": [
- {
- "ruleId": 1,
- "nextHopAddresses": [
- {
- "priority": 1,
- "serverConfigAddressId": 1,
- "nextHopIpAddress": "192.168.5.4",
- "port": 111,
- "transport": "TCP"
}
], - "priority": 0,
- "uriGroupId": 1,
- "timeOfDayId": 1,
- "outgoingTransport": "TCP",
- "loadBalancing": "PRIORITY",
- "nextHopInDialog": true,
- "sniServerName": "string",
- "sniEnabled": true
}
]
}
]
Get routing profile for given ID
User must have the routing-profile:read
capability to perform this action.
profileId required | integer ID of the profile |
{- "profileId": 1,
- "profileName": "sm-route",
- "profileRules": [
- {
- "ruleId": 1,
- "nextHopAddresses": [
- {
- "priority": 1,
- "serverConfigAddressId": 1,
- "nextHopIpAddress": "192.168.5.4",
- "port": 111,
- "transport": "TCP"
}
], - "priority": 0,
- "uriGroupId": 1,
- "timeOfDayId": 1,
- "outgoingTransport": "TCP",
- "loadBalancing": "PRIORITY",
- "nextHopInDialog": true,
- "sniServerName": "string",
- "sniEnabled": true
}
]
}
Delete routing profile for given ID
User must have the routing-profile:delete
capability to perform this action.
profileId required | integer ID of the profile |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new routing rule in SBCE
User must have the routing-profile:update
capability to perform this action.
profileId required | integer ID of the profile |
priority | integer |
uriGroupId | integer ID of the URI Group to be used |
timeOfDayId | integer |
outgoingTransport | string Enum: "TCP" "TLS" "UDP" |
loadBalancing | string Enum: "PRIORITY" "DNS_SRV" "LOAD_FACTOR" "WEIGHTED_ROUND_ROBIN" "ROUND_ROBIN" Load balancing selection:
|
nextHopInDialog | boolean Default: false |
sniServerName | string |
sniEnabled | boolean |
Array of objects (BaseNextHopAddress) |
{- "priority": 0,
- "uriGroupId": 1,
- "timeOfDayId": 1,
- "outgoingTransport": "TCP",
- "loadBalancing": "PRIORITY",
- "nextHopInDialog": true,
- "sniServerName": "string",
- "sniEnabled": true,
- "nextHopAddresses": [
- {
- "priority": 1,
- "serverConfigAddressId": 1,
- "nextHopIpAddress": "192.168.5.4",
- "port": 111,
- "transport": "TCP"
}
]
}
{- "resourcePath": "api/config/v1/routing-profiles/1/routing-rules/1",
- "ruleId": 1,
- "nextHopAddresses": [
- {
- "priority": 1,
- "serverConfigAddressId": 1,
- "nextHopIpAddress": "192.168.5.4",
- "port": 111,
- "transport": "TCP"
}
], - "priority": 0,
- "uriGroupId": 1,
- "timeOfDayId": 1,
- "outgoingTransport": "TCP",
- "loadBalancing": "PRIORITY",
- "nextHopInDialog": true,
- "sniServerName": "string",
- "sniEnabled": true
}
Get all routing rules configured in a routing profile
User must have the routing-profile:read
capability to perform this action.
profileId required | integer ID of the profile |
[- {
- "ruleId": 1,
- "nextHopAddresses": [
- {
- "priority": 1,
- "serverConfigAddressId": 1,
- "nextHopIpAddress": "192.168.5.4",
- "port": 111,
- "transport": "TCP"
}
], - "priority": 0,
- "uriGroupId": 1,
- "timeOfDayId": 1,
- "outgoingTransport": "TCP",
- "loadBalancing": "PRIORITY",
- "nextHopInDialog": true,
- "sniServerName": "string",
- "sniEnabled": true
}
]
Edit existing routing rule in routing profile
User must have the routing-profile:update
capability to perform this action.
profileId required | integer ID of the profile |
ruleId required | integer ID of the rule |
ruleId | integer ID of the rule generated by system |
Array of objects (BaseNextHopAddress) | |
priority | integer |
uriGroupId | integer ID of the URI Group to be used |
timeOfDayId | integer |
outgoingTransport | string Enum: "TCP" "TLS" "UDP" |
loadBalancing | string Enum: "PRIORITY" "DNS_SRV" "LOAD_FACTOR" "WEIGHTED_ROUND_ROBIN" "ROUND_ROBIN" Load balancing selection:
|
nextHopInDialog | boolean Default: false |
sniServerName | string |
sniEnabled | boolean |
{- "ruleId": 1,
- "nextHopAddresses": [
- {
- "priority": 1,
- "serverConfigAddressId": 1,
- "nextHopIpAddress": "192.168.5.4",
- "port": 111,
- "transport": "TCP"
}
], - "priority": 0,
- "uriGroupId": 1,
- "timeOfDayId": 1,
- "outgoingTransport": "TCP",
- "loadBalancing": "PRIORITY",
- "nextHopInDialog": true,
- "sniServerName": "string",
- "sniEnabled": true
}
{- "ruleId": 1,
- "nextHopAddresses": [
- {
- "priority": 1,
- "serverConfigAddressId": 1,
- "nextHopIpAddress": "192.168.5.4",
- "port": 111,
- "transport": "TCP"
}
], - "priority": 0,
- "uriGroupId": 1,
- "timeOfDayId": 1,
- "outgoingTransport": "TCP",
- "loadBalancing": "PRIORITY",
- "nextHopInDialog": true,
- "sniServerName": "string",
- "sniEnabled": true
}
Get routing rule for given ID
User must have the routing-profile:read
capability to perform this action.
profileId required | integer ID of the profile |
ruleId required | integer ID of the rule |
{- "ruleId": 1,
- "nextHopAddresses": [
- {
- "priority": 1,
- "serverConfigAddressId": 1,
- "nextHopIpAddress": "192.168.5.4",
- "port": 111,
- "transport": "TCP"
}
], - "priority": 0,
- "uriGroupId": 1,
- "timeOfDayId": 1,
- "outgoingTransport": "TCP",
- "loadBalancing": "PRIORITY",
- "nextHopInDialog": true,
- "sniServerName": "string",
- "sniEnabled": true
}
Delete routing rule for given ID
User must have the routing-profile:update
capability to perform this action.
profileId required | integer ID of the profile |
ruleId required | integer ID of the rule |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new next hop address in routing rule on SBCE
User must have the routing-profile:update
capability to perform this action.
profileId required | integer ID of the profile |
ruleId required | integer ID of the rule |
priority | integer Required for load balancing |
serverConfigAddressId | integer |
nextHopIpAddress | string <ipv4> |
port | integer |
transport | string Enum: "TCP" "UDP" "TLS" Transport type of the next-hop address |
{- "priority": 1,
- "serverConfigAddressId": 1,
- "nextHopIpAddress": "192.168.5.4",
- "port": 111,
- "transport": "TCP"
}
{- "resourcePath": "api/config/v1/routing-profiles/1/routing-rules/1/next-hop-addresses/1",
- "nextHopId": 1,
- "priority": 1,
- "serverConfigAddressId": 1,
- "nextHopIpAddress": "192.168.5.4",
- "port": 111,
- "transport": "TCP"
}
Get all next hop addresses for a specific routing rule
User must have the routing-profile:read
capability to perform this action.
profileId required | integer ID of the profile |
ruleId required | integer ID of the rule |
[- {
- "nextHopId": 1,
- "priority": 1,
- "serverConfigAddressId": 1,
- "nextHopIpAddress": "192.168.5.4",
- "port": 111,
- "transport": "TCP"
}
]
Edit next hop address to existing routing rule in SBCE
User must have the routing-profile:update
capability to perform this action.
profileId required | integer ID of the profile |
ruleId required | integer ID of the rule |
nextHopId required | integer ID of the next hop address |
nextHopId | integer <int64> |
priority | integer Required for load balancing |
serverConfigAddressId | integer |
nextHopIpAddress | string <ipv4> |
port | integer |
transport | string Enum: "TCP" "UDP" "TLS" Transport type of the next-hop address |
{- "nextHopId": 1,
- "priority": 1,
- "serverConfigAddressId": 1,
- "nextHopIpAddress": "192.168.5.4",
- "port": 111,
- "transport": "TCP"
}
{- "nextHopId": 1,
- "priority": 1,
- "serverConfigAddressId": 1,
- "nextHopIpAddress": "192.168.5.4",
- "port": 111,
- "transport": "TCP"
}
Get next hop address for given ID
User must have the routing-profile:read
capability to perform this action.
profileId required | integer ID of the profile |
ruleId required | integer ID of the rule |
nextHopId required | integer ID of the next hop address |
{- "nextHopId": 1,
- "priority": 1,
- "serverConfigAddressId": 1,
- "nextHopIpAddress": "192.168.5.4",
- "port": 111,
- "transport": "TCP"
}
Delete the next hop address of routing rule for given ID
User must have the routing-profile:delete
capability to perform this action.
profileId required | integer ID of the profile |
ruleId required | integer ID of the rule |
nextHopId required | integer ID of the next hop address |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Retrieve a list of all configured recording profiles for this system.
User must have the recording-profile:read
capability to perform this action.
[- {
- "profileId": 0,
- "recordingTerminationOnCallFailure": false,
- "playRecordingTone": false,
- "routeMappings": [
- {
- "mappingId": 0,
- "routingProfileId": 0,
- "recordingType": "FULL_TIME",
- "videoRecording": false
}
]
}
]
Create a new recording profile for this system.
User must have the recording-profile:create
capability to perform this action.
recordingTerminationOnCallFailure | boolean Terminate the call if recording can not be set up. |
playRecordingTone | boolean Play a tone if the call is being recorded. |
Array of objects (RecordingProfileRouteMapping) Apply a recording rule to a specific route. |
{- "recordingTerminationOnCallFailure": false,
- "playRecordingTone": false,
- "routeMappings": [
- {
- "mappingId": 0,
- "routingProfileId": 0,
- "recordingType": "FULL_TIME",
- "videoRecording": false
}
]
}
{- "resourcePath": "string",
- "profileId": 0,
- "recordingTerminationOnCallFailure": false,
- "playRecordingTone": false,
- "routeMappings": [
- {
- "mappingId": 0,
- "routingProfileId": 0,
- "recordingType": "FULL_TIME",
- "videoRecording": false
}
]
}
Retrieve an existing recording profile from this system.
User must have the recording-profile:read
capability to perform this action.
id required | integer |
{- "profileId": 0,
- "recordingTerminationOnCallFailure": false,
- "playRecordingTone": false,
- "routeMappings": [
- {
- "mappingId": 0,
- "routingProfileId": 0,
- "recordingType": "FULL_TIME",
- "videoRecording": false
}
]
}
Modify an existing recording profile for this system. All fields are optional and any omitted field will use the value from the existing profile.
User must have the recording-profile:update
capability to perform this action.
id required | integer |
recordingTerminationOnCallFailure | boolean Terminate the call if recording can not be set up. |
playRecordingTone | boolean Play a tone if the call is being recorded. |
{- "recordingTerminationOnCallFailure": false,
- "playRecordingTone": false
}
{- "profileId": 0,
- "recordingTerminationOnCallFailure": false,
- "playRecordingTone": false,
- "routeMappings": [
- {
- "mappingId": 0,
- "routingProfileId": 0,
- "recordingType": "FULL_TIME",
- "videoRecording": false
}
]
}
Delete an existing recording profile from this system.
User must have the recording-profile:delete
capability to perform this action.
id required | integer |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Create a route mapping on an existing recording profile on this system.
User must have the recording-profile:create
capability to perform this action.
id required | integer |
mappingId | integer ID for the route mapping. This value will not be read during recording profile creation and will only be returned on a response. |
routingProfileId | integer The routing policy use for this mapping. |
recordingType | string Enum: "FULL_TIME" "SELECTIVE" The type of the recording. |
videoRecording | boolean |
{- "mappingId": 0,
- "routingProfileId": 0,
- "recordingType": "FULL_TIME",
- "videoRecording": false
}
{- "resourcePath": "string",
- "mappingId": 0,
- "routingProfileId": 0,
- "recordingType": "FULL_TIME",
- "videoRecording": false
}
Update a route mapping on an existing recording profile on this system.
User must have the recording-profile:update
capability to perform this action.
id required | integer |
mappingId required | integer |
mappingId | integer ID for the route mapping. This value will not be read during recording profile creation and will only be returned on a response. |
routingProfileId | integer The routing policy use for this mapping. |
recordingType | string Enum: "FULL_TIME" "SELECTIVE" The type of the recording. |
videoRecording | boolean |
{- "mappingId": 0,
- "routingProfileId": 0,
- "recordingType": "FULL_TIME",
- "videoRecording": false
}
{- "mappingId": 0,
- "routingProfileId": 0,
- "recordingType": "FULL_TIME",
- "videoRecording": false
}
Remove a route mapping from an existing recording profile on this system.
User must have the recording-profile:delete
capability to perform this action.
id required | integer |
mappingId required | integer |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new endpoint policy group flow in SBCE
User must have the endpoint-policy-group:create
capability to perform this action.
policyName | string |
applicationRuleId | integer Default: 1 ID for the application rule associated with this policy group. Defaults to the built-in |
mediaRuleId | integer Default: 1 ID for the media rule associated with this policy group. Defaults to the built-in |
signalingRuleId | integer Default: 1 ID for the signaling rule associated with this policy group. Defaults to the built-in |
securityRuleId | integer Default: 1 ID for the security rule associated with this policy group. Defaults to the built-in |
chargingPolicyId | integer Default: -1 ID for the charging policy associated with this policy group. Use |
rtcpMonitoringGeneration | string Default: "OFF" Enum: "OFF" "RTP" "RTP_WITH_RTCP" Specifies the method of generating RTCP monitoring report for a specific policy group. The options are:
|
{- "policyName": "test",
- "applicationRuleId": 1,
- "mediaRuleId": 1,
- "signalingRuleId": 2,
- "securityRuleId": 3,
- "chargingPolicyId": 4,
- "rtcpMonitoringGeneration": "OFF"
}
{- "resourcePath": "api/config/v1/endpoint-policy-groups/1",
- "policyId": 1,
- "policyName": "test",
- "applicationRuleId": 1,
- "mediaRuleId": 1,
- "signalingRuleId": 2,
- "securityRuleId": 3,
- "chargingPolicyId": 4,
- "rtcpMonitoringGeneration": "OFF"
}
Get all endpoint group policies
User must have the endpoint-policy-group:read
capability to perform this action.
[- {
- "policyId": 1,
- "policyName": "test",
- "applicationRuleId": 1,
- "mediaRuleId": 1,
- "signalingRuleId": 2,
- "securityRuleId": 3,
- "chargingPolicyId": 4,
- "rtcpMonitoringGeneration": "OFF"
}
]
Edit endpoint policy group flow in SBCE
User must have the endpoint-policy-group:update
capability to perform this action.
policyId required | integer ID of the policy |
policyId | integer |
policyName | string |
applicationRuleId | integer Default: 1 ID for the application rule associated with this policy group. Defaults to the built-in |
mediaRuleId | integer Default: 1 ID for the media rule associated with this policy group. Defaults to the built-in |
signalingRuleId | integer Default: 1 ID for the signaling rule associated with this policy group. Defaults to the built-in |
securityRuleId | integer Default: 1 ID for the security rule associated with this policy group. Defaults to the built-in |
chargingPolicyId | integer Default: -1 ID for the charging policy associated with this policy group. Use |
rtcpMonitoringGeneration | string Default: "OFF" Enum: "OFF" "RTP" "RTP_WITH_RTCP" Specifies the method of generating RTCP monitoring report for a specific policy group. The options are:
|
{- "policyId": 1,
- "policyName": "test",
- "applicationRuleId": 1,
- "mediaRuleId": 1,
- "signalingRuleId": 2,
- "securityRuleId": 3,
- "chargingPolicyId": 4,
- "rtcpMonitoringGeneration": "OFF"
}
{- "policyId": 1,
- "policyName": "test",
- "applicationRuleId": 1,
- "mediaRuleId": 1,
- "signalingRuleId": 2,
- "securityRuleId": 3,
- "chargingPolicyId": 4,
- "rtcpMonitoringGeneration": "OFF"
}
Get the endpoint policy group details for given ID
User must have the endpoint-policy-group:read
capability to perform this action.
policyId required | integer ID of the policy |
{- "policyId": 1,
- "policyName": "test",
- "applicationRuleId": 1,
- "mediaRuleId": 1,
- "signalingRuleId": 2,
- "securityRuleId": 3,
- "chargingPolicyId": 4,
- "rtcpMonitoringGeneration": "OFF"
}
Delete the endpoint group policy for given ID
User must have the endpoint-policy-group:delete
capability to perform this action.
policyId required | integer ID of the policy |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new application rule in SBCE
User must have the application-rule:create
capability to perform this action.
ruleName | string |
videoIn | boolean Default: false Denote this rule applies to video traffic entering the enterprise network. |
videoOut | boolean Default: false Denote this rule applies to video traffic originating from within the enterprise network. |
maxVideoSessionsPerEndpoint | integer Default: null The maximum number of application sessions that can be active for an endpoint. Additional application requests are blocked when this threshold is exceeded. |
maxVideoConcurrentSessions | integer Default: null The maximum number of concurrent application sessions that can be active for the selected application type. Additional application requests are blocked when this threshold is exceeded. |
audioIn | boolean Default: false Denote this rule applies to audio traffic entering the enterprise network. |
audioOut | boolean Default: false Denote this rule applies to audio traffic originating from within the enterprise network. |
maxAudioSessionPerEndpoint | integer Default: null The maximum number of application sessions that can be active for an endpoint. Additional application requests are blocked when this threshold is exceeded. |
maxAudioConcurrentSessions | integer Default: null The maximum number of concurrent application sessions that can be active for the selected application type. Additional application requests are blocked when this threshold is exceeded. |
radiusProfileId | integer Default: null |
cdrSupport | string Default: "NONE" Enum: "NONE" "RADIUS" "CDR_ADJUNCT" CDR option type applicable for the application rule.
|
callDuration | string Default: null Enum: "SETUP" "CONNECT" The options for call duration are:
|
mediaStatisticsReport | boolean Default: false If |
rtcpKeepAlive | boolean Default: false If |
{- "ruleName": "test",
- "videoIn": true,
- "videoOut": false,
- "maxVideoSessionsPerEndpoint": 1,
- "maxVideoConcurrentSessions": 1,
- "audioIn": true,
- "audioOut": false,
- "maxAudioSessionPerEndpoint": 1,
- "maxAudioConcurrentSessions": 1,
- "radiusProfileId": 1,
- "cdrSupport": "CDR_ADJUNCT",
- "callDuration": "SETUP",
- "mediaStatisticsReport": true,
- "rtcpKeepAlive": false
}
{- "resourcePath": "api/config/v1/application-rules/1",
- "ruleId": 1,
- "ruleName": "test",
- "videoIn": true,
- "videoOut": false,
- "maxVideoSessionsPerEndpoint": 1,
- "maxVideoConcurrentSessions": 1,
- "audioIn": true,
- "audioOut": false,
- "maxAudioSessionPerEndpoint": 1,
- "maxAudioConcurrentSessions": 1,
- "radiusProfileId": 1,
- "cdrSupport": "CDR_ADJUNCT",
- "callDuration": "SETUP",
- "mediaStatisticsReport": true,
- "rtcpKeepAlive": false
}
Get all application rules
User must have the application-rule:read
capability to perform this action.
[- {
- "ruleId": 1,
- "ruleName": "test",
- "videoIn": true,
- "videoOut": false,
- "maxVideoSessionsPerEndpoint": 1,
- "maxVideoConcurrentSessions": 1,
- "audioIn": true,
- "audioOut": false,
- "maxAudioSessionPerEndpoint": 1,
- "maxAudioConcurrentSessions": 1,
- "radiusProfileId": 1,
- "cdrSupport": "CDR_ADJUNCT",
- "callDuration": "SETUP",
- "mediaStatisticsReport": true,
- "rtcpKeepAlive": false
}
]
Edit application rule in SBCE
User must have the application-rule:update
capability to perform this action.
ruleId required | integer ID of the rule |
ruleId | integer |
ruleName | string |
videoIn | boolean Default: false Denote this rule applies to video traffic entering the enterprise network. |
videoOut | boolean Default: false Denote this rule applies to video traffic originating from within the enterprise network. |
maxVideoSessionsPerEndpoint | integer Default: null The maximum number of application sessions that can be active for an endpoint. Additional application requests are blocked when this threshold is exceeded. |
maxVideoConcurrentSessions | integer Default: null The maximum number of concurrent application sessions that can be active for the selected application type. Additional application requests are blocked when this threshold is exceeded. |
audioIn | boolean Default: false Denote this rule applies to audio traffic entering the enterprise network. |
audioOut | boolean Default: false Denote this rule applies to audio traffic originating from within the enterprise network. |
maxAudioSessionPerEndpoint | integer Default: null The maximum number of application sessions that can be active for an endpoint. Additional application requests are blocked when this threshold is exceeded. |
maxAudioConcurrentSessions | integer Default: null The maximum number of concurrent application sessions that can be active for the selected application type. Additional application requests are blocked when this threshold is exceeded. |
radiusProfileId | integer Default: null |
cdrSupport | string Default: "NONE" Enum: "NONE" "RADIUS" "CDR_ADJUNCT" CDR option type applicable for the application rule.
|
callDuration | string Default: null Enum: "SETUP" "CONNECT" The options for call duration are:
|
mediaStatisticsReport | boolean Default: false If |
rtcpKeepAlive | boolean Default: false If |
{- "ruleId": 1,
- "ruleName": "test",
- "videoIn": true,
- "videoOut": false,
- "maxVideoSessionsPerEndpoint": 1,
- "maxVideoConcurrentSessions": 1,
- "audioIn": true,
- "audioOut": false,
- "maxAudioSessionPerEndpoint": 1,
- "maxAudioConcurrentSessions": 1,
- "radiusProfileId": 1,
- "cdrSupport": "CDR_ADJUNCT",
- "callDuration": "SETUP",
- "mediaStatisticsReport": true,
- "rtcpKeepAlive": false
}
{- "ruleId": 1,
- "ruleName": "test",
- "videoIn": true,
- "videoOut": false,
- "maxVideoSessionsPerEndpoint": 1,
- "maxVideoConcurrentSessions": 1,
- "audioIn": true,
- "audioOut": false,
- "maxAudioSessionPerEndpoint": 1,
- "maxAudioConcurrentSessions": 1,
- "radiusProfileId": 1,
- "cdrSupport": "CDR_ADJUNCT",
- "callDuration": "SETUP",
- "mediaStatisticsReport": true,
- "rtcpKeepAlive": false
}
Get the application rule for given ID
User must have the application-rule:read
capability to perform this action.
ruleId required | integer ID of the rule |
{- "ruleId": 1,
- "ruleName": "test",
- "videoIn": true,
- "videoOut": false,
- "maxVideoSessionsPerEndpoint": 1,
- "maxVideoConcurrentSessions": 1,
- "audioIn": true,
- "audioOut": false,
- "maxAudioSessionPerEndpoint": 1,
- "maxAudioConcurrentSessions": 1,
- "radiusProfileId": 1,
- "cdrSupport": "CDR_ADJUNCT",
- "callDuration": "SETUP",
- "mediaStatisticsReport": true,
- "rtcpKeepAlive": false
}
Delete the application rule for given ID
User must have the application-rule:delete
capability to perform this action.
ruleId required | integer ID of the rule |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new session policy in SBCE
User must have the session-policy:create
capability to perform this action.
policyName | string |
mediaAnchoringEnabled | boolean |
mediaForkingProfileId | integer |
callTypeMediaAnchoring | string Enum: "ALL" "TROMBONE_ONLY" |
recordingServerEnabled | boolean |
recordingServerId | integer |
optimizeHairpinCalls | boolean |
convergedConferencingEnabled | boolean |
mediaServerEnabled | boolean |
mediaRoutingProfileId | integer |
urnEnabled | boolean |
urnProfileId | integer |
{- "policyName": "test",
- "mediaAnchoringEnabled": true,
- "mediaForkingProfileId": 1,
- "callTypeMediaAnchoring": false,
- "recordingServerEnabled": false,
- "recordingServerId": 1,
- "optimizeHairpinCalls": true,
- "convergedConferencingEnabled": false,
- "mediaServerEnabled": true,
- "mediaRoutingProfileId": 1,
- "urnEnabled": true,
- "urnProfileId": 1
}
{- "resourcePath": "api/config/v1/session-policies/1",
- "policyId": 1,
- "policyName": "test",
- "mediaAnchoringEnabled": true,
- "mediaForkingProfileId": 1,
- "callTypeMediaAnchoring": false,
- "recordingServerEnabled": false,
- "recordingServerId": 1,
- "optimizeHairpinCalls": true,
- "convergedConferencingEnabled": false,
- "mediaServerEnabled": true,
- "mediaRoutingProfileId": 1,
- "urnEnabled": true,
- "urnProfileId": 1
}
Get all session policies
User must have the session-policy:read
capability to perform this action.
[- {
- "policyId": 1,
- "policyName": "test",
- "mediaAnchoringEnabled": true,
- "mediaForkingProfileId": 1,
- "callTypeMediaAnchoring": false,
- "recordingServerEnabled": false,
- "recordingServerId": 1,
- "optimizeHairpinCalls": true,
- "convergedConferencingEnabled": false,
- "mediaServerEnabled": true,
- "mediaRoutingProfileId": 1,
- "urnEnabled": true,
- "urnProfileId": 1
}
]
Edit session policy in SBCE
User must have the session-policy:update
capability to perform this action.
policyId required | integer ID of the policy |
policyId | integer |
policyName | string |
mediaAnchoringEnabled | boolean |
mediaForkingProfileId | integer |
callTypeMediaAnchoring | string Enum: "ALL" "TROMBONE_ONLY" |
recordingServerEnabled | boolean |
recordingServerId | integer |
optimizeHairpinCalls | boolean |
convergedConferencingEnabled | boolean |
mediaServerEnabled | boolean |
mediaRoutingProfileId | integer |
urnEnabled | boolean |
urnProfileId | integer |
{- "policyId": 1,
- "policyName": "test",
- "mediaAnchoringEnabled": true,
- "mediaForkingProfileId": 1,
- "callTypeMediaAnchoring": false,
- "recordingServerEnabled": false,
- "recordingServerId": 1,
- "optimizeHairpinCalls": true,
- "convergedConferencingEnabled": false,
- "mediaServerEnabled": true,
- "mediaRoutingProfileId": 1,
- "urnEnabled": true,
- "urnProfileId": 1
}
{- "policyId": 1,
- "policyName": "test",
- "mediaAnchoringEnabled": true,
- "mediaForkingProfileId": 1,
- "callTypeMediaAnchoring": false,
- "recordingServerEnabled": false,
- "recordingServerId": 1,
- "optimizeHairpinCalls": true,
- "convergedConferencingEnabled": false,
- "mediaServerEnabled": true,
- "mediaRoutingProfileId": 1,
- "urnEnabled": true,
- "urnProfileId": 1
}
Get the session policy for given ID
User must have the session-policy:read
capability to perform this action.
policyId required | integer ID of the policy |
{- "policyId": 1,
- "policyName": "test",
- "mediaAnchoringEnabled": true,
- "mediaForkingProfileId": 1,
- "callTypeMediaAnchoring": false,
- "recordingServerEnabled": false,
- "recordingServerId": 1,
- "optimizeHairpinCalls": true,
- "convergedConferencingEnabled": false,
- "mediaServerEnabled": true,
- "mediaRoutingProfileId": 1,
- "urnEnabled": true,
- "urnProfileId": 1
}
Delete the session policy for given ID
User must have the session-policy:delete
capability to perform this action.
policyId required | integer ID of the policy |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new session flow in SBCE
User must have the session-flow:create
capability to perform this action.
flowName | string |
fromUriGroupId | integer |
toUriGroupId | integer |
signalingSourceIpSubnet | string |
signalingDestinationIpSubnet | string |
sessionPolicyId | integer |
sourceSignalingIpId | integer |
destinationSignalingIpId | integer |
hasRemoteSbc | boolean |
{- "flowName": "test",
- "fromUriGroupId": 1,
- "toUriGroupId": 1,
- "signalingSourceIpSubnet": "*",
- "signalingDestinationIpSubnet": "*",
- "sessionPolicyId": 1,
- "sourceSignalingIpId": 1,
- "destinationSignalingIpId": 1,
- "hasRemoteSbc": false
}
{- "resourcePath": "api/config/v1/session-flows/1",
- "flowId": 1,
- "flowName": "test",
- "fromUriGroupId": 1,
- "toUriGroupId": 1,
- "signalingSourceIpSubnet": "*",
- "signalingDestinationIpSubnet": "*",
- "sessionPolicyId": 1,
- "sourceSignalingIpId": 1,
- "destinationSignalingIpId": 1,
- "hasRemoteSbc": false
}
Get all session flows
User must have the session-flow:read
capability to perform this action.
[- {
- "flowId": 1,
- "flowName": "test",
- "fromUriGroupId": 1,
- "toUriGroupId": 1,
- "signalingSourceIpSubnet": "*",
- "signalingDestinationIpSubnet": "*",
- "sessionPolicyId": 1,
- "sourceSignalingIpId": 1,
- "destinationSignalingIpId": 1,
- "hasRemoteSbc": false
}
]
Edit session flow in SBCE
User must have the session-flow:update
capability to perform this action.
flowId required | integer ID of the flow |
flowId | integer <int64> The new priority to update. This value can be negative priority. that means that the priority value -1 will be the least priority, and -2 will be the second least priority. The negative priority starts from where the priorities ends. This means that the last priority of the session flows is the first element in the negative indexing which is -1. For Example, if there are 5 session flows and the least priority is 5, then -1 priority indicates priority 5 and -5 indicates priority 1. |
flowName | string |
fromUriGroupId | integer |
toUriGroupId | integer |
signalingSourceIpSubnet | string |
signalingDestinationIpSubnet | string |
sessionPolicyId | integer |
sourceSignalingIpId | integer |
destinationSignalingIpId | integer |
hasRemoteSbc | boolean |
{- "flowId": 1,
- "flowName": "test",
- "fromUriGroupId": 1,
- "toUriGroupId": 1,
- "signalingSourceIpSubnet": "*",
- "signalingDestinationIpSubnet": "*",
- "sessionPolicyId": 1,
- "sourceSignalingIpId": 1,
- "destinationSignalingIpId": 1,
- "hasRemoteSbc": false
}
[- {
- "flowId": 1,
- "flowName": "test",
- "fromUriGroupId": 1,
- "toUriGroupId": 1,
- "signalingSourceIpSubnet": "*",
- "signalingDestinationIpSubnet": "*",
- "sessionPolicyId": 1,
- "sourceSignalingIpId": 1,
- "destinationSignalingIpId": 1,
- "hasRemoteSbc": false
}
]
Get the session flow for given ID
User must have the session-flow:read
capability to perform this action.
flowId required | integer ID of the flow |
{- "flowId": 1,
- "flowName": "test",
- "fromUriGroupId": 1,
- "toUriGroupId": 1,
- "signalingSourceIpSubnet": "*",
- "signalingDestinationIpSubnet": "*",
- "sessionPolicyId": 1,
- "sourceSignalingIpId": 1,
- "destinationSignalingIpId": 1,
- "hasRemoteSbc": false
}
Delete the session flow for given ID
User must have the session-flow:delete
capability to perform this action.
flowId required | integer ID of the flow |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add or Edit CDR server in SBCE
User must have the cdr-server:create
capability to perform this action.
address | string <address:port> |
username | string |
password | string |
location | string The location path where CDRs will be copied on the server. |
timeIntervalInHours | integer Time interval to send CDR to server in 24hr format. |
{- "address": "1.1.1.1:111",
- "username": "test",
- "password": "SIPera_123",
- "location": "/home",
- "timeIntervalInHours": 1
}
{- "address": "1.1.1.1:111",
- "username": "test",
- "password": "SIPera_123",
- "location": "/home",
- "timeIntervalInHours": 1
}
Get CDR server details
User must have the cdr-server:read
capability to perform this action.
{- "address": "1.1.1.1:111",
- "username": "test",
- "password": "SIPera_123",
- "location": "/home",
- "timeIntervalInHours": 1
}
Adds new radius profile in SBCE.
User must have the radius-profile:create
capability to perform this action.
profileName | string |
serverAddress | string <ip> |
serverPort | integer <port> |
alternateServerAddress | string <ip> |
alternateServerPort | integer <port> |
sharedSecret | string |
maxRetry | integer |
retryTimeoutInSeconds | integer |
connectPort | integer <port> |
healthCheckIntervalInSeconds | integer |
{- "profileName": "radius-profile-1",
- "serverAddress": "1.1.1.1",
- "serverPort": 22,
- "alternateServerAddress": "2.2.2.2",
- "alternateServerPort": 44,
- "sharedSecret": "SIPera_123",
- "maxRetry": 5,
- "retryTimeoutInSeconds": 44,
- "connectPort": 34,
- "healthCheckIntervalInSeconds": 5
}
{- "resourcePath": "/api/config/v1/radius-profiles/1",
- "profileId": 1,
- "profileName": "radius-profile-1",
- "serverAddress": "1.1.1.1",
- "serverPort": 22,
- "alternateServerAddress": "2.2.2.2",
- "alternateServerPort": 44,
- "sharedSecret": "SIPera_123",
- "maxRetry": 5,
- "retryTimeoutInSeconds": 44,
- "connectPort": 34,
- "healthCheckIntervalInSeconds": 5
}
Retrieve all radius profiles configured in SBCE.
User must have the radius-profile:read
capability to perform this action.
[- {
- "profileId": 1,
- "profileName": "radius-profile-1",
- "serverAddress": "1.1.1.1",
- "serverPort": 22,
- "alternateServerAddress": "2.2.2.2",
- "alternateServerPort": 44,
- "sharedSecret": "SIPera_123",
- "maxRetry": 5,
- "retryTimeoutInSeconds": 44,
- "connectPort": 34,
- "healthCheckIntervalInSeconds": 5
}
]
Edit radius profile for given profileId in SBCE.
User must have the radius-profile:update
capability to perform this action.
profileId required | integer ID of the profile |
profileName | string |
serverAddress | string <ip> |
serverPort | integer <port> |
alternateServerAddress | string <ip> |
alternateServerPort | integer <port> |
sharedSecret | string |
maxRetry | integer |
retryTimeoutInSeconds | integer |
connectPort | integer <port> |
healthCheckIntervalInSeconds | integer |
{- "profileName": "radius-profile-1",
- "serverAddress": "1.1.1.1",
- "serverPort": 22,
- "alternateServerAddress": "2.2.2.2",
- "alternateServerPort": 44,
- "sharedSecret": "SIPera_123",
- "maxRetry": 5,
- "retryTimeoutInSeconds": 44,
- "connectPort": 34,
- "healthCheckIntervalInSeconds": 5
}
{- "profileId": 1,
- "profileName": "radius-profile-1",
- "serverAddress": "1.1.1.1",
- "serverPort": 22,
- "alternateServerAddress": "2.2.2.2",
- "alternateServerPort": 44,
- "sharedSecret": "SIPera_123",
- "maxRetry": 5,
- "retryTimeoutInSeconds": 44,
- "connectPort": 34,
- "healthCheckIntervalInSeconds": 5
}
Get radius profile by profileId configured in SBCE.
User must have the radius-profile:read
capability to perform this action.
profileId required | integer ID of the profile |
{- "profileId": 1,
- "profileName": "radius-profile-1",
- "serverAddress": "1.1.1.1",
- "serverPort": 22,
- "alternateServerAddress": "2.2.2.2",
- "alternateServerPort": 44,
- "sharedSecret": "SIPera_123",
- "maxRetry": 5,
- "retryTimeoutInSeconds": 44,
- "connectPort": 34,
- "healthCheckIntervalInSeconds": 5
}
Delete radius profile by profileId in SBCE
User must have the radius-profile:delete
capability to perform this action.
profileId required | integer ID of the profile |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Adds new URN profile in SBCE.
User must have the urn-profile:create
capability to perform this action.
profileName | string |
Array of objects (PostURNMapping) |
{- "profileName": "test",
- "urnConfigs": [
- {
- "urnMap": "urn:nena:service:sos.ambulance",
- "urnDialDigitString": "1234"
}
]
}
{- "resourcePath": "api/config/v1/urn-profiles/1",
- "profileId": 1,
- "profileName": "test",
- "urnConfigs": [
- {
- "configId": 1,
- "urnMap": "urn:nena:service:sos.ambulance",
- "urnDialDigitString": "1234"
}
]
}
Retrieve all URN profiles configured in SBCE.
User must have the urn-profile:read
capability to perform this action.
[- {
- "profileId": 1,
- "profileName": "test",
- "urnConfigs": [
- {
- "configId": 1,
- "urnMap": "urn:nena:service:sos.ambulance",
- "urnDialDigitString": "1234"
}
]
}
]
Get URN profile by profileId configured in SBCE.
User must have the urn-profile:read
capability to perform this action.
profileId required | integer ID of the profile |
{- "profileId": 1,
- "profileName": "test",
- "urnConfigs": [
- {
- "configId": 1,
- "urnMap": "urn:nena:service:sos.ambulance",
- "urnDialDigitString": "1234"
}
]
}
Delete URN profile by profileId in SBCE
User must have the urn-profile:delete
capability to perform this action.
profileId required | integer ID of the profile |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Adds new URN mapping in SBCE.
User must have the urn-profile:create
capability to perform this action.
profileId required | integer ID of the profile |
urnMap | string |
urnDialDigitString | string |
{- "urnMap": "urn:nena:service:sos.ambulance",
- "urnDialDigitString": "1234"
}
{- "profileId": 1,
- "profileName": "test",
- "urnConfigs": [
- {
- "configId": 1,
- "urnMap": "urn:nena:service:sos.ambulance",
- "urnDialDigitString": "1234"
}
]
}
Edit URN mapping in SBCE.
User must have the urn-profile:update
capability to perform this action.
profileId required | integer ID of the profile |
configId required | integer ID of the mapping |
configId | integer |
urnMap | string |
urnDialDigitString | string |
{- "configId": 1,
- "urnMap": "urn:nena:service:sos.ambulance",
- "urnDialDigitString": "1234"
}
{- "profileId": 1,
- "profileName": "test",
- "urnConfigs": [
- {
- "configId": 1,
- "urnMap": "urn:nena:service:sos.ambulance",
- "urnDialDigitString": "1234"
}
]
}
Delete URN mapping by configId in SBCE
User must have the urn-profile:delete
capability to perform this action.
profileId required | integer ID of the profile |
configId required | integer ID of the mapping |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Adds new URI group in SBCE.
User must have the uri-group:create
capability to perform this action.
groupName | string |
Array of objects (URIMember) |
{- "groupName": "test",
- "userMembers": [
- {
- "scheme": "SIP",
- "type": "REGULAR_EXPRESSION",
- "uri": "*"
}
]
}
{- "resourcePath": "api/config/v1/uri-groups/1",
- "groupId": 1,
- "groupName": "test",
- "userMembers": [
- {
- "scheme": "SIP",
- "type": "REGULAR_EXPRESSION",
- "uri": "*"
}
]
}
Retrieve all URI groups configured in SBCE.
User must have the uri-group:read
capability to perform this action.
[- {
- "groupId": 1,
- "groupName": "test",
- "userMembers": [
- {
- "scheme": "SIP",
- "type": "REGULAR_EXPRESSION",
- "uri": "*"
}
]
}
]
Get URI group by groupId configured in SBCE.
User must have the uri-group:read
capability to perform this action.
groupId required | integer ID of the group |
{- "groupId": 1,
- "groupName": "test",
- "userMembers": [
- {
- "scheme": "SIP",
- "type": "REGULAR_EXPRESSION",
- "uri": "*"
}
]
}
Delete URI group by groupId in SBCE
User must have the uri-group:delete
capability to perform this action.
groupId required | integer ID of the group |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Adds new URI member in SBCE.
User must have the uri-group:create
capability to perform this action.
groupId required | integer ID of the group |
scheme | string Enum: "ANY" "SIP" "TEL" |
type | string Enum: "PLAIN" "DIAL_PLAN" "REGULAR_EXPRESSION" |
uri | string |
{- "scheme": "SIP",
- "type": "REGULAR_EXPRESSION",
- "uri": "*"
}
{- "resourcePath": "api/config/v1/uri-groups/1",
- "groupId": 1,
- "groupName": "test",
- "userMembers": [
- {
- "scheme": "SIP",
- "type": "REGULAR_EXPRESSION",
- "uri": "*"
}
]
}
Edit URI member in SBCE.
User must have the uri-group:update
capability to perform this action.
groupId required | integer ID of the group |
memberName required | string Name of the URI member. Encode with Base 64 if the value have the unsupported url characters and
pass the query parameters |
base64 | boolean Default: false This query parameter is required when the |
scheme | string Enum: "ANY" "SIP" "TEL" |
type | string Enum: "PLAIN" "DIAL_PLAN" "REGULAR_EXPRESSION" |
uri | string |
{- "scheme": "SIP",
- "type": "REGULAR_EXPRESSION",
- "uri": "*"
}
{- "resourcePath": "api/config/v1/uri-groups/1",
- "groupId": 1,
- "groupName": "test",
- "userMembers": [
- {
- "scheme": "SIP",
- "type": "REGULAR_EXPRESSION",
- "uri": "*"
}
]
}
Delete URI member by memberName in SBCE
User must have the uri-group:delete
capability to perform this action.
groupId required | integer ID of the group |
memberName required | string Name of the URI member. Encode with Base 64 if the value have the unsupported url characters and
pass the query parameters |
base64 | boolean Default: false This query parameter is required when the |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Adds new LDAP Server in SBCE.
User must have the ldap-server:create
capability to perform this action.
profileName | string |
primaryAddress | string <fqdn> |
primaryPort | integer <port> |
secondaryAddress | string <fqdn> |
secondaryPort | integer <port> |
object (SecureLdap) | |
bindDn | string |
bindPassphrase | string |
baseDnList | string |
timeoutInSeconds | integer |
object (Caching) |
{- "profileName": "test",
- "primaryAddress": "1.1.1.1",
- "primaryPort": 1134,
- "secondaryAddress": "1.1.1.1",
- "secondaryPort": 1134,
- "secureLdap": {
- "secureLdap": true,
- "tlsProfileId": 1
}, - "bindDn": "dc=mydomain",
- "bindPassphrase": "qwerty",
- "baseDnList": [
- "dc=avery",
- "dc=long",
- "dc=list",
- "dc=of",
- "dc=domains"
], - "timeoutInSeconds": 10,
- "caching": {
- "cachingEnabledDisabled": true,
- "cacheSize": 10,
- "cacheExpiryTimeInMinutes": 3
}
}
{- "resourcePath": "api/config/v1/ldap-servers/1",
- "profileId": 1,
- "profileName": "test",
- "primaryAddress": "1.1.1.1",
- "primaryPort": 1134,
- "secondaryAddress": "1.1.1.1",
- "secondaryPort": 1134,
- "secureLdap": {
- "secureLdap": true,
- "tlsProfileId": 1
}, - "bindDn": "dc=mydomain",
- "bindPassphrase": "qwerty",
- "baseDnList": [
- "dc=avery",
- "dc=long",
- "dc=list",
- "dc=of",
- "dc=domains"
], - "timeoutInSeconds": 10,
- "caching": {
- "cachingEnabledDisabled": true,
- "cacheSize": 10,
- "cacheExpiryTimeInMinutes": 3
}
}
Get all LDAP Servers configured in SBCE.
User must have the ldap-server:read
capability to perform this action.
[- {
- "profileId": 1,
- "profileName": "test",
- "primaryAddress": "1.1.1.1",
- "primaryPort": 1134,
- "secondaryAddress": "1.1.1.1",
- "secondaryPort": 1134,
- "secureLdap": {
- "secureLdap": true,
- "tlsProfileId": 1
}, - "bindDn": "dc=mydomain",
- "bindPassphrase": "qwerty",
- "baseDnList": [
- "dc=avery",
- "dc=long",
- "dc=list",
- "dc=of",
- "dc=domains"
], - "timeoutInSeconds": 10,
- "caching": {
- "cachingEnabledDisabled": true,
- "cacheSize": 10,
- "cacheExpiryTimeInMinutes": 3
}
}
]
Modify an existing LDAP Server for this system.
User must have the ldap-server:update
capability to perform this action.
profileId required | integer ID of the server |
profileName | string |
primaryAddress | string <fqdn> |
primaryPort | integer <port> |
secondaryAddress | string <fqdn> |
secondaryPort | integer <port> |
object (SecureLdap) | |
bindDn | string |
bindPassphrase | string |
baseDnList | string |
timeoutInSeconds | integer |
object (Caching) |
{- "profileName": "test",
- "primaryAddress": "1.1.1.1",
- "primaryPort": 1134,
- "secondaryAddress": "1.1.1.1",
- "secondaryPort": 1134,
- "secureLdap": {
- "secureLdap": true,
- "tlsProfileId": 1
}, - "bindDn": "dc=mydomain",
- "bindPassphrase": "qwerty",
- "baseDnList": [
- "dc=avery",
- "dc=long",
- "dc=list",
- "dc=of",
- "dc=domains"
], - "timeoutInSeconds": 10,
- "caching": {
- "cachingEnabledDisabled": true,
- "cacheSize": 10,
- "cacheExpiryTimeInMinutes": 3
}
}
{- "profileId": 1,
- "profileName": "test",
- "primaryAddress": "1.1.1.1",
- "primaryPort": 1134,
- "secondaryAddress": "1.1.1.1",
- "secondaryPort": 1134,
- "secureLdap": {
- "secureLdap": true,
- "tlsProfileId": 1
}, - "bindDn": "dc=mydomain",
- "bindPassphrase": "qwerty",
- "baseDnList": [
- "dc=avery",
- "dc=long",
- "dc=list",
- "dc=of",
- "dc=domains"
], - "timeoutInSeconds": 10,
- "caching": {
- "cachingEnabledDisabled": true,
- "cacheSize": 10,
- "cacheExpiryTimeInMinutes": 3
}
}
Get LDAP Server by profileId configured in SBCE.
User must have the ldap-server:read
capability to perform this action.
profileId required | integer ID of the server |
{- "profileId": 1,
- "profileName": "test",
- "primaryAddress": "1.1.1.1",
- "primaryPort": 1134,
- "secondaryAddress": "1.1.1.1",
- "secondaryPort": 1134,
- "secureLdap": {
- "secureLdap": true,
- "tlsProfileId": 1
}, - "bindDn": "dc=mydomain",
- "bindPassphrase": "qwerty",
- "baseDnList": [
- "dc=avery",
- "dc=long",
- "dc=list",
- "dc=of",
- "dc=domains"
], - "timeoutInSeconds": 10,
- "caching": {
- "cachingEnabledDisabled": true,
- "cacheSize": 10,
- "cacheExpiryTimeInMinutes": 3
}
}
Delete LDAP Server by profileId in SBCE
User must have the ldap-server:delete
capability to perform this action.
profileId required | integer ID of the profile |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Adds new User agent in SBCE.
User must have the user-agent:create
capability to perform this action.
agentName | string |
userAgentRegex | string |
{- "agentName": "test",
- "userAgentRegex": "*"
}
{- "resourcePath": "api/config/v1/user-agents/1",
- "agentId": 1,
- "agentName": "test",
- "userAgentRegex": "*"
}
Modify an existing user agent for this system.
User must have the user-agent:update
capability to perform this action.
agentId required | integer ID of the user agent |
agentName | string |
userAgentRegex | string |
{- "agentName": "test",
- "userAgentRegex": "*"
}
{- "agentId": 1,
- "agentName": "test",
- "userAgentRegex": "*"
}
Get User agent by profileId configured in SBCE.
User must have the user-agent:read
capability to perform this action.
agentId required | integer ID of the user agent |
{- "agentId": 1,
- "agentName": "test",
- "userAgentRegex": "*"
}
Delete User agent by profileId in SBCE
User must have the user-agent:delete
capability to perform this action.
agentId required | integer ID of the user agent |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Adds new FGDN Groups in SBCE.
User must have the fgdn-group:create
capability to perform this action.
groupName | string |
fgdnGroupMembersList | string |
{- "groupName": "test",
- "fgdnGroupMembersList": [
- "abc.abc.com",
- "abc.com"
]
}
{- "resourcePath": "api/config/v1/fgdn-groups/1",
- "groupId": 1,
- "groupName": "test",
- "fgdnGroupMembersList": [
- "abc.abc.com",
- "abc.com"
]
}
Get FGDN Group by groupId configured in SBCE.
User must have the fgdn-group:read
capability to perform this action.
groupId required | integer ID of the FGDN Group |
{- "groupId": 1,
- "groupName": "test",
- "fgdnGroupMembersList": [
- "abc.abc.com",
- "abc.com"
]
}
Delete FGDN Group by groupId in SBCE
User must have the fgdn-group:delete
capability to perform this action.
groupId required | integer ID of the FGDN Group |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Adds new FGDN Member in SBCE.
User must have the fgdn-group:create
capability to perform this action.
groupId required | integer ID of the FGDN Group |
[- "sbc1.com",
- "sbc2.com"
]
{- "resourcePath": "api/config/v1/fgdn-groups/1",
- "groupId": 1,
- "groupName": "test",
- "fgdnGroupMembersList": [
- "abc.abc.com",
- "abc.com"
]
}
Edit existing FGDN Member in SBCE.
User must have the fgdn-group:create
capability to perform this action.
groupId required | integer ID of the FGDN Group |
oldFgdnMember required | string Old FGDN Member |
newFgdnMember required | string Update FGDN Member |
{- "resourcePath": "api/config/v1/fgdn-groups/1",
- "groupId": 1,
- "groupName": "test",
- "fgdnGroupMembersList": [
- "abc.abc.com",
- "abc.com"
]
}
Delete FGDN Member of groupId in SBCE
User must have the fgdn-group:delete
capability to perform this action.
groupId required | integer ID of the FGDN Group |
fgdnMember required | string Name of the FGDN Member |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Adds new Time of Day Rule in SBCE.
User must have the tod-rule:create
capability to perform this action.
ruleName | string |
startDate | string <date> |
endDate | string <date> |
startTime | string <time> |
endTime | string <time> |
days | string Select the days of the weeks |
weeks | string |
day | integer |
recurrence | string Enum: "DAILY_EVERYDAY" "DAILY_WEEKDAY" "DAILY_WEEKEND" "WEEKLY_WEEKLY" "MONTHLY_ON_X_EVERY_MONTH" |
{- "ruleName": "test",
- "startDate": "23-03-2020",
- "endDate": "23-03-2020",
- "startTime": "00:00",
- "endTime": "23:59",
- "days": [
- "Monday",
- "Tuesday"
], - "weeks": [
- 1,
- 4
], - "day": 3,
- "recurrence": "DAILY_EVERYDAY"
}
{- "resourcePath": "api/config/v1/tod-rules/1",
- "ruleId": 1,
- "ruleName": "test",
- "startDate": "23-03-2020",
- "endDate": "23-03-2020",
- "startTime": "00:00",
- "endTime": "23:59",
- "days": [
- "Monday",
- "Tuesday"
], - "weeks": [
- 1,
- 4
], - "day": 3,
- "recurrence": "DAILY_EVERYDAY"
}
Get all FGDN Groups configured in SBCE.
User must have the tod-rule:read
capability to perform this action.
[- {
- "ruleId": 1,
- "ruleName": "test",
- "startDate": "23-03-2020",
- "endDate": "23-03-2020",
- "startTime": "00:00",
- "endTime": "23:59",
- "days": [
- "Monday",
- "Tuesday"
], - "weeks": [
- 1,
- 4
], - "day": 3,
- "recurrence": "DAILY_EVERYDAY"
}
]
Modify an existing Time of Day rule for this system.
User must have the tod-rule:update
capability to perform this action.
ruleId required | integer ID of the rule |
ruleName | string |
startDate | string <date> |
endDate | string <date> |
startTime | string <time> |
endTime | string <time> |
days | string Select the days of the weeks |
weeks | string |
day | integer |
recurrence | string Enum: "DAILY_EVERYDAY" "DAILY_WEEKDAY" "DAILY_WEEKEND" "WEEKLY_WEEKLY" "MONTHLY_ON_X_EVERY_MONTH" |
{- "ruleName": "test",
- "startDate": "23-03-2020",
- "endDate": "23-03-2020",
- "startTime": "00:00",
- "endTime": "23:59",
- "days": [
- "Monday",
- "Tuesday"
], - "weeks": [
- 1,
- 4
], - "day": 3,
- "recurrence": "DAILY_EVERYDAY"
}
{- "ruleId": 1,
- "ruleName": "test",
- "startDate": "23-03-2020",
- "endDate": "23-03-2020",
- "startTime": "00:00",
- "endTime": "23:59",
- "days": [
- "Monday",
- "Tuesday"
], - "weeks": [
- 1,
- 4
], - "day": 3,
- "recurrence": "DAILY_EVERYDAY"
}
Get Time Of Day Rule by ruleId configured in SBCE.
User must have the tod-rule:read
capability to perform this action.
ruleId required | integer ID of the rule |
{- "ruleId": 1,
- "ruleName": "test",
- "startDate": "23-03-2020",
- "endDate": "23-03-2020",
- "startTime": "00:00",
- "endTime": "23:59",
- "days": [
- "Monday",
- "Tuesday"
], - "weeks": [
- 1,
- 4
], - "day": 3,
- "recurrence": "DAILY_EVERYDAY"
}
Delete Time of Day Rule by ruleId in SBCE
User must have the tod-rule:delete
capability to perform this action.
ruleId required | integer ID of the rule |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Copy logs for this system to a specified SFTP server.
User must have the logging:update
capability to perform this action.
fromDateTime | string <date-time> |
toDateTime | string <date-time> |
serverAddress | string |
serverPort | integer |
userName | string |
password | string |
location | string |
{- "fromDateTime": "2019-11-21T19:15:55",
- "toDateTime": "2019-11-21T19:15:55",
- "serverAddress": "1.1.1.1",
- "serverPort": 1212,
- "userName": "testuser",
- "password": "12asdf",
- "location": "/temp"
}
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Retrieve a list of all alarm events for this system.
User must have the alarm:read
capability to perform this action.
{- "error": {
- "code": 401,
- "message": "Request has expired credentials or the credentials are invalid",
- "status": "UNAUTHORIZED"
}
}
Acknowledge and delete a specific alarm event from this system based on the alarm ID.
User must have the alarm:delete
capability to perform this action.
id required | integer ID of the alarm |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Adds new Domain DoS profile in SBCE.
User must have the domain-dos-profile:create
capability to perform this action.
profileName | string |
trafficType | string Enum: "TRUNK_TRAFFIC" "REMOTE_USERS" "BOTH" |
maximumConcurrentSessions | integer [ 100 .. 5000 ] |
noOfRemoteUsers | integer [ 100 .. 5000 ] |
{- "profileName": "domainDos-profile-1",
- "trafficType": "TRUNK_TRAFFIC",
- "maximumConcurrentSessions": 1000,
- "noOfRemoteUsers": 1000
}
{- "resourcePath": "/api/config/v1/domain-dos-profiles/8",
- "profileId": 1,
- "profileName": "domainDos-profile-1",
- "trafficType": "TRUNK_TRAFFIC",
- "maximumConcurrentSessions": 1000,
- "noOfRemoteUsers": 1000
}
Retrieve all Domain DoS profiles configured in SBCE.
User must have the domain-dos-profile:read
capability to perform this action.
[- {
- "profileId": 1,
- "profileName": "domainDos-profile-1",
- "trafficType": "TRUNK_TRAFFIC",
- "maximumConcurrentSessions": 1000,
- "noOfRemoteUsers": 1000
}
]
Edit Domain DoS profile for given profileId in SBCE.
User must have the domain-dos-profile:update
capability to perform this action.
profileId required | integer ID of the profile |
profileName | string |
trafficType | string Enum: "TRUNK_TRAFFIC" "REMOTE_USERS" "BOTH" |
maximumConcurrentSessions | integer [ 100 .. 5000 ] |
noOfRemoteUsers | integer [ 100 .. 5000 ] |
{- "profileName": "domainDos-profile-1",
- "trafficType": "TRUNK_TRAFFIC",
- "maximumConcurrentSessions": 1000,
- "noOfRemoteUsers": 1000
}
{- "profileId": 1,
- "profileName": "domainDos-profile-1",
- "trafficType": "TRUNK_TRAFFIC",
- "maximumConcurrentSessions": 1000,
- "noOfRemoteUsers": 1000
}
Get Domain DoS profile by profileId configured in SBCE.
User must have the domain-dos-profile:read
capability to perform this action.
profileId required | integer ID of the profile |
{- "profileId": 1,
- "profileName": "domainDos-profile-1",
- "trafficType": "TRUNK_TRAFFIC",
- "maximumConcurrentSessions": 1000,
- "noOfRemoteUsers": 1000
}
Delete Domain DoS profile by profileId in SBCE
User must have the domain-dos-profile:delete
capability to perform this action.
profileId required | integer ID of the profile |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Adds new Security Rule in SBCE.
User must have the security-rule:create
capability to perform this action.
name | string |
object | |
object | |
object |
{- "name": "security-rule-1",
- "compliance": {
- "fromURIBlackList": 1
}, - "domainDos": {
- "enabled": true,
- "domainDosProfileId": 1
}, - "authentication": {
- "enableMacBasedLDAPAuth": true,
- "ldapServerProfileId": 1,
- "ldapBaseDN": "UID=jsmith,DC=example,DC=net"
}
}
{- "resourcePath": "/api/config/v1/domain-dos-profiles/8",
- "profileId": 1,
- "name": "security-rule-1",
- "compliance": {
- "fromURIBlackList": 1
}, - "domainDos": {
- "enabled": true,
- "domainDosProfileId": 1
}, - "authentication": {
- "enableMacBasedLDAPAuth": true,
- "ldapServerProfileId": 1,
- "ldapBaseDN": "UID=jsmith,DC=example,DC=net"
}
}
Retrieve all Security Rules configured in SBCE.
User must have the security-rule:read
capability to perform this action.
[- {
- "profileId": 1,
- "name": "security-rule-1",
- "compliance": {
- "fromURIBlackList": 1
}, - "domainDos": {
- "enabled": true,
- "domainDosProfileId": 1
}, - "authentication": {
- "enableMacBasedLDAPAuth": true,
- "ldapServerProfileId": 1,
- "ldapBaseDN": "UID=jsmith,DC=example,DC=net"
}
}
]
Edit Domain Security Rule for given ruleId in SBCE.
User must have the security-rule:update
capability to perform this action.
ruleId required | integer ID of the Security rule |
name | string |
object | |
object | |
object |
{- "name": "security-rule-1",
- "compliance": {
- "fromURIBlackList": 1
}, - "domainDos": {
- "enabled": true,
- "domainDosProfileId": 1
}, - "authentication": {
- "enableMacBasedLDAPAuth": true,
- "ldapServerProfileId": 1,
- "ldapBaseDN": "UID=jsmith,DC=example,DC=net"
}
}
{- "profileId": 1,
- "name": "security-rule-1",
- "compliance": {
- "fromURIBlackList": 1
}, - "domainDos": {
- "enabled": true,
- "domainDosProfileId": 1
}, - "authentication": {
- "enableMacBasedLDAPAuth": true,
- "ldapServerProfileId": 1,
- "ldapBaseDN": "UID=jsmith,DC=example,DC=net"
}
}
Get Security Rule by ruleId configured in SBCE.
User must have the security-rule:read
capability to perform this action.
ruleId required | integer ID of the Security Rule |
[- {
- "profileId": 1,
- "name": "security-rule-1",
- "compliance": {
- "fromURIBlackList": 1
}, - "domainDos": {
- "enabled": true,
- "domainDosProfileId": 1
}, - "authentication": {
- "enableMacBasedLDAPAuth": true,
- "ldapServerProfileId": 1,
- "ldapBaseDN": "UID=jsmith,DC=example,DC=net"
}
}
]
Delete Security Rule by ruleId in SBCE
User must have the security-rule:delete
capability to perform this action.
ruleId required | integer ID of the profile |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Retrieve a list of all configured firewall blacklist rules for this system.
User must have the firewall:read
capability to perform this action.
[- {
- "ruleId": 0,
- "ruleName": "string",
- "interfaceName": "ANY",
- "sourceAddress": "string",
- "sourcePortOrSequence": "80,443,8080-8090",
- "protocol": "TCP",
- "destinationAddress": "string",
- "destinationPortOrSequence": "80,443,8080-8090"
}
]
Create a new firewall blacklist rules for this system.
User must have the firewall:create
capability to perform this action.
ruleName | string |
interfaceName | string Enum: "ANY" "A1" "A2" "B1" "B2" The interface to apply this rule to. (Note: B2 may not be available on this system) |
sourceAddress | string An IP address or subnet represented in CIDR notation (integer notation only). |
sourcePortOrSequence | string A comma separated list of ports or port ranges. |
protocol | string Enum: "TCP" "UDP" "ICMP" |
destinationAddress | string An IP address or subnet represented in CIDR notation (integer notation only). |
destinationPortOrSequence | string A comma separated list of ports or port ranges. |
{- "ruleName": "string",
- "interfaceName": "ANY",
- "sourceAddress": "string",
- "sourcePortOrSequence": "80,443,8080-8090",
- "protocol": "TCP",
- "destinationAddress": "string",
- "destinationPortOrSequence": "80,443,8080-8090"
}
{- "resourcePath": "string",
- "ruleId": 0,
- "ruleName": "string",
- "interfaceName": "ANY",
- "sourceAddress": "string",
- "sourcePortOrSequence": "80,443,8080-8090",
- "protocol": "TCP",
- "destinationAddress": "string",
- "destinationPortOrSequence": "80,443,8080-8090"
}
Retrieve a list of firewall blacklist rules for this system.
User must have the firewall:read
capability to perform this action.
id required | integer |
{- "ruleId": 0,
- "ruleName": "string",
- "interfaceName": "ANY",
- "sourceAddress": "string",
- "sourcePortOrSequence": "80,443,8080-8090",
- "protocol": "TCP",
- "destinationAddress": "string",
- "destinationPortOrSequence": "80,443,8080-8090"
}
Modify an existing firewall blacklist rule for this system.
User must have the firewall:update
capability to perform this action.
id required | integer |
ruleName | string |
interfaceName | string Enum: "ANY" "A1" "A2" "B1" "B2" The interface to apply this rule to. (Note: B2 may not be available on this system) |
sourceAddress | string An IP address or subnet represented in CIDR notation (integer notation only). |
sourcePortOrSequence | string A comma separated list of ports or port ranges. |
protocol | string Enum: "TCP" "UDP" "ICMP" |
destinationAddress | string An IP address or subnet represented in CIDR notation (integer notation only). |
destinationPortOrSequence | string A comma separated list of ports or port ranges. |
{- "ruleName": "string",
- "interfaceName": "ANY",
- "sourceAddress": "string",
- "sourcePortOrSequence": "80,443,8080-8090",
- "protocol": "TCP",
- "destinationAddress": "string",
- "destinationPortOrSequence": "80,443,8080-8090"
}
{- "resourcePath": "string",
- "ruleId": 0,
- "ruleName": "string",
- "interfaceName": "ANY",
- "sourceAddress": "string",
- "sourcePortOrSequence": "80,443,8080-8090",
- "protocol": "TCP",
- "destinationAddress": "string",
- "destinationPortOrSequence": "80,443,8080-8090"
}
Delete an existing firewall blacklist rule for this system.
User must have the firewall:delete
capability to perform this action.
id required | integer |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Retrieve a list of all configured firewall whitelist rules for this system.
User must have the firewall:read
capability to perform this action.
{- "ruleId": 0,
- "ruleName": "string",
- "interfaceName": "ANY",
- "sourceAddress": "string",
- "sourcePortOrSequence": "80,443,8080-8090",
- "protocol": "TCP",
- "destinationAddress": "string",
- "destinationPortOrSequence": "80,443,8080-8090"
}
Create a new firewall whitelist rules for this system.
User must have the firewall:create
capability to perform this action.
ruleName | string |
interfaceName | string Enum: "ANY" "A1" "A2" "B1" "B2" The interface to apply this rule to. (Note: B2 may not be available on this system) |
sourceAddress | string An IP address or subnet represented in CIDR notation (integer notation only). |
sourcePortOrSequence | string A comma separated list of ports or port ranges. |
protocol | string Enum: "TCP" "UDP" "ICMP" |
destinationAddress | string An IP address or subnet represented in CIDR notation (integer notation only). |
destinationPortOrSequence | string A comma separated list of ports or port ranges. |
{- "ruleName": "string",
- "interfaceName": "ANY",
- "sourceAddress": "string",
- "sourcePortOrSequence": "80,443,8080-8090",
- "protocol": "TCP",
- "destinationAddress": "string",
- "destinationPortOrSequence": "80,443,8080-8090"
}
{- "resourcePath": "string",
- "ruleId": 0,
- "ruleName": "string",
- "interfaceName": "ANY",
- "sourceAddress": "string",
- "sourcePortOrSequence": "80,443,8080-8090",
- "protocol": "TCP",
- "destinationAddress": "string",
- "destinationPortOrSequence": "80,443,8080-8090"
}
Retrieve a list of firewall whitelist rules for this system.
User must have the firewall:read
capability to perform this action.
id required | integer |
[- {
- "ruleId": 0,
- "ruleName": "string",
- "interfaceName": "ANY",
- "sourceAddress": "string",
- "sourcePortOrSequence": "80,443,8080-8090",
- "protocol": "TCP",
- "destinationAddress": "string",
- "destinationPortOrSequence": "80,443,8080-8090"
}
]
Modify an existing firewall whitelist rule for this system.
User must have the firewall:update
capability to perform this action.
id required | integer |
ruleName | string |
interfaceName | string Enum: "ANY" "A1" "A2" "B1" "B2" The interface to apply this rule to. (Note: B2 may not be available on this system) |
sourceAddress | string An IP address or subnet represented in CIDR notation (integer notation only). |
sourcePortOrSequence | string A comma separated list of ports or port ranges. |
protocol | string Enum: "TCP" "UDP" "ICMP" |
destinationAddress | string An IP address or subnet represented in CIDR notation (integer notation only). |
destinationPortOrSequence | string A comma separated list of ports or port ranges. |
{- "ruleName": "string",
- "interfaceName": "ANY",
- "sourceAddress": "string",
- "sourcePortOrSequence": "80,443,8080-8090",
- "protocol": "TCP",
- "destinationAddress": "string",
- "destinationPortOrSequence": "80,443,8080-8090"
}
{- "resourcePath": "string",
- "ruleId": 0,
- "ruleName": "string",
- "interfaceName": "ANY",
- "sourceAddress": "string",
- "sourcePortOrSequence": "80,443,8080-8090",
- "protocol": "TCP",
- "destinationAddress": "string",
- "destinationPortOrSequence": "80,443,8080-8090"
}
Delete an existing firewall whitelist rule for this system.
User must have the firewall:delete
capability to perform this action.
id required | integer |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Manage settings for a service which can be acted upon by the firewall.
User must have the firewall:update
capability to perform this action.
id required | integer |
action | string Enum: "ACCEPT" "REJECT" "DROP" |
{- "action": "ACCEPT"
}
{- "id": 0,
- "name": "string",
- "action": "ACCEPT"
}
Manage rate-limiting settings for the firewall for this system.
User must have the firewall:update
capability to perform this action.
id required | integer |
dropThreshold | integer |
{- "dropThreshold": 0
}
{- "id": 0,
- "name": "string",
- "dropThreshold": 0
}
Adds new Media Rule in SBCE.
User must have the media-rule:create
capability to perform this action.
ruleName | string |
object (MediaRuleEncryption) | |
object (MediaRuleCodecPrioritization) | |
object (MediaRuleAdvanced) | |
object (MediaRuleQos) |
{- "ruleName": "media-rule-1",
- "encryption": {
- "audio": {
- "preferredFormats": [
- "RTP",
- "SRTP_AES_CM_128_HMAC_SHA1_32"
], - "encryptedRTCP": true,
- "mki": true,
- "interWorking": false,
- "lifetime": 32
}, - "video": {
- "preferredFormats": [
- "RTP",
- "SRTP_AES_CM_128_HMAC_SHA1_32"
], - "encryptedRTCP": true,
- "mki": true,
- "interWorking": false,
- "lifetime": 32
}, - "capabilityNegotiation": true
}, - "codecPrioritization": {
- "audio": {
- "codecPrioritizationEnabled": true,
- "codecs": [
- "PCMU_0",
- "RESERVED_1"
], - "transcode": true,
- "transrating": false
}, - "video": {
- "codecPrioritizationEnabled": true,
- "codecs": [
- "CELB"
]
}
}, - "advanced": {
- "silencing": {
- "enable": true,
- "timeout": 60
}, - "anat": {
- "enable": true,
- "localPreference": "IPV4",
- "useRemotePreference": true
}, - "enableBFCP": false,
- "enableFECC": false,
- "enableMediaLineCompliance": false,
- "iceGatewaySupport": false,
- "localMediaOptimization": {
- "siteName": "New York, NY, USA",
- "siteDomain": "ny.ny.us.example.com",
- "action": "MEDIA_BYPASS"
}, - "enableRTCPMux": false,
- "enableAudioPortChangeOnNewOffer": false,
- "enableVideoPortChangeOnNewOffer": false,
- "enableAudioPortChangeOnAnswer": false,
- "enableVideoPortChangeOnAnswer": false
}, - "qos": {
- "enable": true,
- "tos": {
- "audioPrecedence": "ROUTINE",
- "audioPrecedenceValue": "string",
- "videoPrecedence": "ROUTINE",
- "videoPrecedenceValue": "string",
- "audioTos": "MINIMIZE_DELAY",
- "audioTosValue": "string",
- "videoTos": "MINIMIZE_DELAY",
- "videoTosValue": "string"
}, - "dscp": {
- "audio": "EF",
- "audioValue": "string",
- "video": "EF",
- "videoValue": "string"
}
}
}
{- "resourcePath": "/api/config/v1/media-rules/1",
- "ruleId": 1,
- "ruleName": "media-rule-1",
- "encryption": {
- "audio": {
- "preferredFormats": [
- "RTP",
- "SRTP_AES_CM_128_HMAC_SHA1_32"
], - "encryptedRTCP": true,
- "mki": true,
- "interWorking": false,
- "lifetime": 32
}, - "video": {
- "preferredFormats": [
- "RTP",
- "SRTP_AES_CM_128_HMAC_SHA1_32"
], - "encryptedRTCP": true,
- "mki": true,
- "interWorking": false,
- "lifetime": 32
}, - "capabilityNegotiation": true
}, - "codecPrioritization": {
- "audio": {
- "codecPrioritizationEnabled": true,
- "codecs": [
- "PCMU_0",
- "RESERVED_1"
], - "transcode": true,
- "transrating": false
}, - "video": {
- "codecPrioritizationEnabled": true,
- "codecs": [
- "CELB"
]
}
}, - "advanced": {
- "silencing": {
- "enable": true,
- "timeout": 60
}, - "anat": {
- "enable": true,
- "localPreference": "IPV4",
- "useRemotePreference": true
}, - "enableBFCP": false,
- "enableFECC": false,
- "enableMediaLineCompliance": false,
- "iceGatewaySupport": false,
- "localMediaOptimization": {
- "siteName": "New York, NY, USA",
- "siteDomain": "ny.ny.us.example.com",
- "action": "MEDIA_BYPASS"
}, - "enableRTCPMux": false,
- "enableAudioPortChangeOnNewOffer": false,
- "enableVideoPortChangeOnNewOffer": false,
- "enableAudioPortChangeOnAnswer": false,
- "enableVideoPortChangeOnAnswer": false
}, - "qos": {
- "enable": true,
- "tos": {
- "audioPrecedence": "ROUTINE",
- "audioPrecedenceValue": "string",
- "videoPrecedence": "ROUTINE",
- "videoPrecedenceValue": "string",
- "audioTos": "MINIMIZE_DELAY",
- "audioTosValue": "string",
- "videoTos": "MINIMIZE_DELAY",
- "videoTosValue": "string"
}, - "dscp": {
- "audio": "EF",
- "audioValue": "string",
- "video": "EF",
- "videoValue": "string"
}
}
}
Retrieve all Media Rules configured in SBCE.
User must have the media-rule:read
capability to perform this action.
[- {
- "ruleId": 1,
- "ruleName": "media-rule-1",
- "encryption": {
- "audio": {
- "preferredFormats": [
- "RTP",
- "SRTP_AES_CM_128_HMAC_SHA1_32"
], - "encryptedRTCP": true,
- "mki": true,
- "interWorking": false,
- "lifetime": 32
}, - "video": {
- "preferredFormats": [
- "RTP",
- "SRTP_AES_CM_128_HMAC_SHA1_32"
], - "encryptedRTCP": true,
- "mki": true,
- "interWorking": false,
- "lifetime": 32
}, - "capabilityNegotiation": true
}, - "codecPrioritization": {
- "audio": {
- "codecPrioritizationEnabled": true,
- "codecs": [
- "PCMU_0",
- "RESERVED_1"
], - "transcode": true,
- "transrating": false
}, - "video": {
- "codecPrioritizationEnabled": true,
- "codecs": [
- "CELB"
]
}
}, - "advanced": {
- "silencing": {
- "enable": true,
- "timeout": 60
}, - "anat": {
- "enable": true,
- "localPreference": "IPV4",
- "useRemotePreference": true
}, - "enableBFCP": false,
- "enableFECC": false,
- "enableMediaLineCompliance": false,
- "iceGatewaySupport": false,
- "localMediaOptimization": {
- "siteName": "New York, NY, USA",
- "siteDomain": "ny.ny.us.example.com",
- "action": "MEDIA_BYPASS"
}, - "enableRTCPMux": false,
- "enableAudioPortChangeOnNewOffer": false,
- "enableVideoPortChangeOnNewOffer": false,
- "enableAudioPortChangeOnAnswer": false,
- "enableVideoPortChangeOnAnswer": false
}, - "qos": {
- "enable": true,
- "tos": {
- "audioPrecedence": "ROUTINE",
- "audioPrecedenceValue": "string",
- "videoPrecedence": "ROUTINE",
- "videoPrecedenceValue": "string",
- "audioTos": "MINIMIZE_DELAY",
- "audioTosValue": "string",
- "videoTos": "MINIMIZE_DELAY",
- "videoTosValue": "string"
}, - "dscp": {
- "audio": "EF",
- "audioValue": "string",
- "video": "EF",
- "videoValue": "string"
}
}
}
]
Get Media Rule by ruleId configured in SBCE.
User must have the media-rule:read
capability to perform this action.
ruleId required | integer ID of the Media Rule |
{- "ruleId": 1,
- "ruleName": "media-rule-1",
- "encryption": {
- "audio": {
- "preferredFormats": [
- "RTP",
- "SRTP_AES_CM_128_HMAC_SHA1_32"
], - "encryptedRTCP": true,
- "mki": true,
- "interWorking": false,
- "lifetime": 32
}, - "video": {
- "preferredFormats": [
- "RTP",
- "SRTP_AES_CM_128_HMAC_SHA1_32"
], - "encryptedRTCP": true,
- "mki": true,
- "interWorking": false,
- "lifetime": 32
}, - "capabilityNegotiation": true
}, - "codecPrioritization": {
- "audio": {
- "codecPrioritizationEnabled": true,
- "codecs": [
- "PCMU_0",
- "RESERVED_1"
], - "transcode": true,
- "transrating": false
}, - "video": {
- "codecPrioritizationEnabled": true,
- "codecs": [
- "CELB"
]
}
}, - "advanced": {
- "silencing": {
- "enable": true,
- "timeout": 60
}, - "anat": {
- "enable": true,
- "localPreference": "IPV4",
- "useRemotePreference": true
}, - "enableBFCP": false,
- "enableFECC": false,
- "enableMediaLineCompliance": false,
- "iceGatewaySupport": false,
- "localMediaOptimization": {
- "siteName": "New York, NY, USA",
- "siteDomain": "ny.ny.us.example.com",
- "action": "MEDIA_BYPASS"
}, - "enableRTCPMux": false,
- "enableAudioPortChangeOnNewOffer": false,
- "enableVideoPortChangeOnNewOffer": false,
- "enableAudioPortChangeOnAnswer": false,
- "enableVideoPortChangeOnAnswer": false
}, - "qos": {
- "enable": true,
- "tos": {
- "audioPrecedence": "ROUTINE",
- "audioPrecedenceValue": "string",
- "videoPrecedence": "ROUTINE",
- "videoPrecedenceValue": "string",
- "audioTos": "MINIMIZE_DELAY",
- "audioTosValue": "string",
- "videoTos": "MINIMIZE_DELAY",
- "videoTosValue": "string"
}, - "dscp": {
- "audio": "EF",
- "audioValue": "string",
- "video": "EF",
- "videoValue": "string"
}
}
}
Delete Media Rule by ruleId in SBCE
User must have the media-rule:delete
capability to perform this action.
ruleId required | integer ID of the profile |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Edit Encryption fields of Media Rule for given ruleId in SBCE.
User must have the media-rule:update
capability to perform this action.
ruleId required | integer ID of the Media rule |
object (MediaRuleEncryptionData) | |
object (MediaRuleEncryptionData) | |
capabilityNegotiation | boolean |
{- "audio": {
- "preferredFormats": [
- "RTP",
- "SRTP_AES_CM_128_HMAC_SHA1_32"
], - "encryptedRTCP": true,
- "mki": true,
- "interWorking": false,
- "lifetime": 32
}, - "video": {
- "preferredFormats": [
- "RTP",
- "SRTP_AES_CM_128_HMAC_SHA1_32"
], - "encryptedRTCP": true,
- "mki": true,
- "interWorking": false,
- "lifetime": 32
}, - "capabilityNegotiation": true
}
{- "ruleId": 1,
- "ruleName": "media-rule-1",
- "encryption": {
- "audio": {
- "preferredFormats": [
- "RTP",
- "SRTP_AES_CM_128_HMAC_SHA1_32"
], - "encryptedRTCP": true,
- "mki": true,
- "interWorking": false,
- "lifetime": 32
}, - "video": {
- "preferredFormats": [
- "RTP",
- "SRTP_AES_CM_128_HMAC_SHA1_32"
], - "encryptedRTCP": true,
- "mki": true,
- "interWorking": false,
- "lifetime": 32
}, - "capabilityNegotiation": true
}, - "codecPrioritization": {
- "audio": {
- "codecPrioritizationEnabled": true,
- "codecs": [
- "PCMU_0",
- "RESERVED_1"
], - "transcode": true,
- "transrating": false
}, - "video": {
- "codecPrioritizationEnabled": true,
- "codecs": [
- "CELB"
]
}
}, - "advanced": {
- "silencing": {
- "enable": true,
- "timeout": 60
}, - "anat": {
- "enable": true,
- "localPreference": "IPV4",
- "useRemotePreference": true
}, - "enableBFCP": false,
- "enableFECC": false,
- "enableMediaLineCompliance": false,
- "iceGatewaySupport": false,
- "localMediaOptimization": {
- "siteName": "New York, NY, USA",
- "siteDomain": "ny.ny.us.example.com",
- "action": "MEDIA_BYPASS"
}, - "enableRTCPMux": false,
- "enableAudioPortChangeOnNewOffer": false,
- "enableVideoPortChangeOnNewOffer": false,
- "enableAudioPortChangeOnAnswer": false,
- "enableVideoPortChangeOnAnswer": false
}, - "qos": {
- "enable": true,
- "tos": {
- "audioPrecedence": "ROUTINE",
- "audioPrecedenceValue": "string",
- "videoPrecedence": "ROUTINE",
- "videoPrecedenceValue": "string",
- "audioTos": "MINIMIZE_DELAY",
- "audioTosValue": "string",
- "videoTos": "MINIMIZE_DELAY",
- "videoTosValue": "string"
}, - "dscp": {
- "audio": "EF",
- "audioValue": "string",
- "video": "EF",
- "videoValue": "string"
}
}
}
Edit codec prioritization fields of Media Rule for given ruleId in SBCE.
User must have the media-rule:update
capability to perform this action.
ruleId required | integer ID of the Media rule |
object | |
object |
{- "audio": {
- "codecPrioritizationEnabled": true,
- "codecs": [
- "PCMU_0",
- "RESERVED_1"
], - "transcode": true,
- "transrating": false
}, - "video": {
- "codecPrioritizationEnabled": true,
- "codecs": [
- "CELB"
]
}
}
{- "ruleId": 1,
- "ruleName": "media-rule-1",
- "encryption": {
- "audio": {
- "preferredFormats": [
- "RTP",
- "SRTP_AES_CM_128_HMAC_SHA1_32"
], - "encryptedRTCP": true,
- "mki": true,
- "interWorking": false,
- "lifetime": 32
}, - "video": {
- "preferredFormats": [
- "RTP",
- "SRTP_AES_CM_128_HMAC_SHA1_32"
], - "encryptedRTCP": true,
- "mki": true,
- "interWorking": false,
- "lifetime": 32
}, - "capabilityNegotiation": true
}, - "codecPrioritization": {
- "audio": {
- "codecPrioritizationEnabled": true,
- "codecs": [
- "PCMU_0",
- "RESERVED_1"
], - "transcode": true,
- "transrating": false
}, - "video": {
- "codecPrioritizationEnabled": true,
- "codecs": [
- "CELB"
]
}
}, - "advanced": {
- "silencing": {
- "enable": true,
- "timeout": 60
}, - "anat": {
- "enable": true,
- "localPreference": "IPV4",
- "useRemotePreference": true
}, - "enableBFCP": false,
- "enableFECC": false,
- "enableMediaLineCompliance": false,
- "iceGatewaySupport": false,
- "localMediaOptimization": {
- "siteName": "New York, NY, USA",
- "siteDomain": "ny.ny.us.example.com",
- "action": "MEDIA_BYPASS"
}, - "enableRTCPMux": false,
- "enableAudioPortChangeOnNewOffer": false,
- "enableVideoPortChangeOnNewOffer": false,
- "enableAudioPortChangeOnAnswer": false,
- "enableVideoPortChangeOnAnswer": false
}, - "qos": {
- "enable": true,
- "tos": {
- "audioPrecedence": "ROUTINE",
- "audioPrecedenceValue": "string",
- "videoPrecedence": "ROUTINE",
- "videoPrecedenceValue": "string",
- "audioTos": "MINIMIZE_DELAY",
- "audioTosValue": "string",
- "videoTos": "MINIMIZE_DELAY",
- "videoTosValue": "string"
}, - "dscp": {
- "audio": "EF",
- "audioValue": "string",
- "video": "EF",
- "videoValue": "string"
}
}
}
Edit advanced fields of Media Rule for given ruleId in SBCE.
User must have the media-rule:update
capability to perform this action.
ruleId required | integer ID of the Media rule |
object | |
object | |
enableBFCP | boolean Indicates whether Binary Floor Control Protocol (BFCP) is used in a people and content telepresence scenario to control the content channel. Content information is passed as a video stream and is controlled by the BFCP channel. It enables the moderator to release floor control to participants and vice versa to give control of the content channel to various participants. The system works on sending a token on the BFCP control signaling. The moderator allows or denies the access to the token. Avaya SBCE can support one BFCP channel for multiple video content channels. |
enableFECC | boolean Indicates whether Far End Camera Control (FECC) is enabled. It provides mixed encryption support for audio, main video, and FECC . In the media path, using an RTP payload type sends control signaling to control the far end camera. The FECC channel facilitates setting up the signaling for the media path, and control signals are sent on this path using the RTP payload type of a particular codec type (H.224). |
enableMediaLineCompliance | boolean |
iceGatewaySupport | boolean Default: false Enables support for Interactive Connectivity Establishment (ICE) used when connecting with Microsoft Teams. When enabled, you can administer the Local Media Optimization options. |
object | |
enableRTCPMux | boolean Default: false System supports for RTCP multiplexing (RTCP-MUX) when it is enabled. |
enableAudioPortChangeOnNewOffer | boolean Default: false Specifies whether Avaya SBC generates new ports when a new OFFER message is received. By default, this option is disabled, meaning Avaya SBC will not generate new ports. |
enableVideoPortChangeOnNewOffer | boolean Default: false Specifies whether Avaya SBC generates new ports when a new OFFER message is received. By default, this option is disabled, meaning Avaya SBC will not generate new ports. |
enableAudioPortChangeOnAnswer | boolean Default: false |
enableVideoPortChangeOnAnswer | boolean Default: false |
{- "silencing": {
- "enable": true,
- "timeout": 60
}, - "anat": {
- "enable": true,
- "localPreference": "IPV4",
- "useRemotePreference": true
}, - "enableBFCP": false,
- "enableFECC": false,
- "enableMediaLineCompliance": false,
- "iceGatewaySupport": false,
- "localMediaOptimization": {
- "siteName": "New York, NY, USA",
- "siteDomain": "ny.ny.us.example.com",
- "action": "MEDIA_BYPASS"
}, - "enableRTCPMux": false,
- "enableAudioPortChangeOnNewOffer": false,
- "enableVideoPortChangeOnNewOffer": false,
- "enableAudioPortChangeOnAnswer": false,
- "enableVideoPortChangeOnAnswer": false
}
{- "ruleId": 1,
- "ruleName": "media-rule-1",
- "encryption": {
- "audio": {
- "preferredFormats": [
- "RTP",
- "SRTP_AES_CM_128_HMAC_SHA1_32"
], - "encryptedRTCP": true,
- "mki": true,
- "interWorking": false,
- "lifetime": 32
}, - "video": {
- "preferredFormats": [
- "RTP",
- "SRTP_AES_CM_128_HMAC_SHA1_32"
], - "encryptedRTCP": true,
- "mki": true,
- "interWorking": false,
- "lifetime": 32
}, - "capabilityNegotiation": true
}, - "codecPrioritization": {
- "audio": {
- "codecPrioritizationEnabled": true,
- "codecs": [
- "PCMU_0",
- "RESERVED_1"
], - "transcode": true,
- "transrating": false
}, - "video": {
- "codecPrioritizationEnabled": true,
- "codecs": [
- "CELB"
]
}
}, - "advanced": {
- "silencing": {
- "enable": true,
- "timeout": 60
}, - "anat": {
- "enable": true,
- "localPreference": "IPV4",
- "useRemotePreference": true
}, - "enableBFCP": false,
- "enableFECC": false,
- "enableMediaLineCompliance": false,
- "iceGatewaySupport": false,
- "localMediaOptimization": {
- "siteName": "New York, NY, USA",
- "siteDomain": "ny.ny.us.example.com",
- "action": "MEDIA_BYPASS"
}, - "enableRTCPMux": false,
- "enableAudioPortChangeOnNewOffer": false,
- "enableVideoPortChangeOnNewOffer": false,
- "enableAudioPortChangeOnAnswer": false,
- "enableVideoPortChangeOnAnswer": false
}, - "qos": {
- "enable": true,
- "tos": {
- "audioPrecedence": "ROUTINE",
- "audioPrecedenceValue": "string",
- "videoPrecedence": "ROUTINE",
- "videoPrecedenceValue": "string",
- "audioTos": "MINIMIZE_DELAY",
- "audioTosValue": "string",
- "videoTos": "MINIMIZE_DELAY",
- "videoTosValue": "string"
}, - "dscp": {
- "audio": "EF",
- "audioValue": "string",
- "video": "EF",
- "videoValue": "string"
}
}
}
Edit qos fields of Media Rule for given ruleId in SBCE.
User must have the media-rule:update
capability to perform this action.
ruleId required | integer ID of the Media rule |
enable | boolean |
object | |
object |
{- "enable": true,
- "tos": {
- "audioPrecedence": "ROUTINE",
- "audioPrecedenceValue": "string",
- "videoPrecedence": "ROUTINE",
- "videoPrecedenceValue": "string",
- "audioTos": "MINIMIZE_DELAY",
- "audioTosValue": "string",
- "videoTos": "MINIMIZE_DELAY",
- "videoTosValue": "string"
}, - "dscp": {
- "audio": "EF",
- "audioValue": "string",
- "video": "EF",
- "videoValue": "string"
}
}
{- "ruleId": 1,
- "ruleName": "media-rule-1",
- "encryption": {
- "audio": {
- "preferredFormats": [
- "RTP",
- "SRTP_AES_CM_128_HMAC_SHA1_32"
], - "encryptedRTCP": true,
- "mki": true,
- "interWorking": false,
- "lifetime": 32
}, - "video": {
- "preferredFormats": [
- "RTP",
- "SRTP_AES_CM_128_HMAC_SHA1_32"
], - "encryptedRTCP": true,
- "mki": true,
- "interWorking": false,
- "lifetime": 32
}, - "capabilityNegotiation": true
}, - "codecPrioritization": {
- "audio": {
- "codecPrioritizationEnabled": true,
- "codecs": [
- "PCMU_0",
- "RESERVED_1"
], - "transcode": true,
- "transrating": false
}, - "video": {
- "codecPrioritizationEnabled": true,
- "codecs": [
- "CELB"
]
}
}, - "advanced": {
- "silencing": {
- "enable": true,
- "timeout": 60
}, - "anat": {
- "enable": true,
- "localPreference": "IPV4",
- "useRemotePreference": true
}, - "enableBFCP": false,
- "enableFECC": false,
- "enableMediaLineCompliance": false,
- "iceGatewaySupport": false,
- "localMediaOptimization": {
- "siteName": "New York, NY, USA",
- "siteDomain": "ny.ny.us.example.com",
- "action": "MEDIA_BYPASS"
}, - "enableRTCPMux": false,
- "enableAudioPortChangeOnNewOffer": false,
- "enableVideoPortChangeOnNewOffer": false,
- "enableAudioPortChangeOnAnswer": false,
- "enableVideoPortChangeOnAnswer": false
}, - "qos": {
- "enable": true,
- "tos": {
- "audioPrecedence": "ROUTINE",
- "audioPrecedenceValue": "string",
- "videoPrecedence": "ROUTINE",
- "videoPrecedenceValue": "string",
- "audioTos": "MINIMIZE_DELAY",
- "audioTosValue": "string",
- "videoTos": "MINIMIZE_DELAY",
- "videoTosValue": "string"
}, - "dscp": {
- "audio": "EF",
- "audioValue": "string",
- "video": "EF",
- "videoValue": "string"
}
}
}
Adds and edits advanced SIP options in SBCE.
User must have the sip-option:create
capability to perform this action.
dnsCaching | boolean |
asSipMode | boolean |
e911UriGroupId | integer |
maxConcurrentSessions | integer |
{- "dnsCaching": false,
- "asSipMode": true,
- "e911UriGroupId": 2,
- "maxConcurrentSessions": 20
}
{- "dnsCaching": false,
- "asSipMode": true,
- "e911UriGroupId": 2,
- "maxConcurrentSessions": 20
}
Retrieve advanced SIP Options configured in SBCE.
User must have the sip-option:read
capability to perform this action.
{- "dnsCaching": false,
- "asSipMode": true,
- "e911UriGroupId": 2,
- "maxConcurrentSessions": 20
}
Add or edit periodic stats in SBCE.
User must have the periodic-stat:create
capability to perform this action.
collectPeriodicStat | boolean |
collectionIntervalInSeconds | integer |
{- "collectPeriodicStat": true,
- "collectionIntervalInSeconds": 60
}
{- "collectPeriodicStat": true,
- "collectionIntervalInSeconds": 60
}
Adds and edits advanced RTCP Monitoring in SBCE.
User must have the rtcp-monitoring:create
capability to perform this action.
object (RTCPMonitoringRelay) | |
object (RTCPMonitoringReportGeneration) |
{- "rtcpMonitoringRelay": {
- "enable": true,
- "nodeType": "DMZ",
- "relayIpId": 12
}, - "rtcpMonitoringReportGeneration": {
- "enable": true,
- "rtcpGenNetworkId": 15,
- "rtcpGenNetworkPort": 113,
- "monitoringServerIp": "1.1.1.1",
- "monitoringServerPort": 225,
- "monitoringFrequency": 1,
- "monitoringIntervalInSeconds": 10
}
}
{- "rtcpMonitoringRelay": {
- "enable": true,
- "nodeType": "DMZ",
- "relayIpId": 12
}, - "rtcpMonitoringReportGeneration": {
- "enable": true,
- "rtcpGenNetworkId": 15,
- "rtcpGenNetworkPort": 113,
- "monitoringServerIp": "1.1.1.1",
- "monitoringServerPort": 225,
- "monitoringFrequency": 1,
- "monitoringIntervalInSeconds": 10
}
}
Retrieve advanced RTCP Monitoring configured in SBCE.
User must have the rtcp-monitoring:read
capability to perform this action.
{- "rtcpMonitoringRelay": {
- "enable": true,
- "nodeType": "DMZ",
- "relayIpId": 12
}, - "rtcpMonitoringReportGeneration": {
- "enable": true,
- "rtcpGenNetworkId": 15,
- "rtcpGenNetworkPort": 113,
- "monitoringServerIp": "1.1.1.1",
- "monitoringServerPort": 225,
- "monitoringFrequency": 1,
- "monitoringIntervalInSeconds": 10
}
}
Adds and edits advanced network options in SBCE.
User must have the network-option:create
capability to perform this action.
status required | string Enum: "ENABLED" "DISABLED" status of the network option Allow non unique IP |
{- "allowNonUniqueIp": "ENABLED"
}
Adds new Topology Hiding Profile in SBCE.
User must have the topology-hiding-profile:create
capability to perform this action.
profileName | string |
Array of objects (TopologyHidingProfile_headerRule) |
{- "profileName": "topology-hiding-profile-1",
- "headerRules": [
- {
- "header": "REQUEST_LINE",
- "criteria": "IP_DOMAIN",
- "action": "OVERWRITE",
- "overwriteValue": "a.com"
}
]
}
{- "resourcePath": "/api/config/v1/topology-hiding-profiles/1",
- "profileId": 1,
- "profileName": "topology-hiding-profile-1",
- "headerRules": [
- {
- "header": "REQUEST_LINE",
- "criteria": "IP_DOMAIN",
- "action": "OVERWRITE",
- "overwriteValue": "a.com"
}
]
}
Retrieve all Topology Hiding Profiles configured in SBCE.
User must have the topology-hiding-profile:read
capability to perform this action.
[- {
- "profileId": 1,
- "profileName": "topology-hiding-profile-1",
- "headerRules": [
- {
- "header": "REQUEST_LINE",
- "criteria": "IP_DOMAIN",
- "action": "OVERWRITE",
- "overwriteValue": "a.com"
}
]
}
]
Get Topology Hiding Profile by profileId configured in SBCE.
User must have the topology-hiding-profile:read
capability to perform this action.
profileId required | integer ID of the Topology Hiding Profile |
{- "profileId": 1,
- "profileName": "topology-hiding-profile-1",
- "headerRules": [
- {
- "header": "REQUEST_LINE",
- "criteria": "IP_DOMAIN",
- "action": "OVERWRITE",
- "overwriteValue": "a.com"
}
]
}
Delete Topology Hiding Profile by profileId in SBCE
User must have the topology-hiding-profile:delete
capability to perform this action.
profileId required | integer ID of the profile |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add or Edit Header rule of Topology Hiding Profile by profileId in SBCE
User must have the topology-hiding-profile:update
capability to perform this action.
profileId required | integer ID of the Topology Hiding Profile |
header required | string Enum: "REQUEST_LINE" "FROM" "TO" "RECORD_ROUTE" "VIA" "SDP" "REFER_TO" "REFER_BY" header required to add or update in Topology Hiding Profile |
header | string Enum: "REQUEST_LINE" "FROM" "TO" "RECORD_ROUTE" "VIA" "SDP" "REFER_TO" "REFER_BY" |
criteria | string Enum: "IP_DOMAIN" "IP" "DOMAIN" |
action | string Enum: "AUTO" "NEXT_HOP" "DESTINATION_IP" "SIGNALING_INTERFACE" "MEDIA_INTERFACE" "OVERWRITE" |
overwriteValue | string |
{- "header": "REQUEST_LINE",
- "criteria": "IP_DOMAIN",
- "action": "OVERWRITE",
- "overwriteValue": "a.com"
}
{- "profileId": 1,
- "profileName": "topology-hiding-profile-1",
- "headerRules": [
- {
- "header": "REQUEST_LINE",
- "criteria": "IP_DOMAIN",
- "action": "OVERWRITE",
- "overwriteValue": "a.com"
}
]
}
Delete Header Rule from Topology Hiding Profile by profileId in SBCE
User must have the topology-hiding-profile:update
capability to perform this action.
profileId required | integer ID of the Topology Hiding Profile |
header required | string Enum: "REQUEST_LINE" "FROM" "TO" "RECORD_ROUTE" "VIA" "SDP" "REFER_TO" "REFER_BY" header required to add or update in Topology Hiding Profile |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
APIs for managing Denial of Service (DoS) / Distributed Denial of Service (DDoS) settings.
Update the single source DoS settings on this system.
User must have the dos:update
capability to perform this action.
threshold | integer |
action | string (DosSettingsAction) Enum: "ALERT" "BLOCK" "CHALLENGE" |
blockDuration | integer Duration to block after threshold violations; Ignored if |
{- "threshold": 0,
- "action": "ALERT",
- "blockDuration": 0
}
{- "method": "string",
- "threshold": 0,
- "action": "ALERT",
- "blockDuration": 0
}
Update the phone DoS settings on this system.
User must have the dos:update
capability to perform this action.
threshold | integer |
action | string (DosSettingsActionWithLimit) Enum: "ALERT" "BLOCK" "CHALLENGE" "LIMIT" |
blockDuration | integer Duration to block after threshold violations; Ignored if |
{- "threshold": 0,
- "action": "ALERT",
- "blockDuration": 0
}
{- "service": "string",
- "method": "string",
- "threshold": 0,
- "action": "ALERT",
- "blockDuration": 0
}
Retrieve the stealth DoS settings from this system.
User must have the dos:read
capability to perform this action.
[- {
- "timeslot": "MORNING",
- "service": "string",
- "method": "string",
- "averageDurationThreshold": 0,
- "maxConsecutiveViolations": 0,
- "action": "ALERT",
- "blockDuration": 0
}
]
Retrieve the stealth DoS settings from this system by timeslot.
User must have the dos:read
capability to perform this action.
timeslot required | string (DosSettingsStealthTimeslot) Enum: "MORNING" "AFTERNOON" "EVENING" "NIGHT" This parameter is case-insensitive. |
{- "timeslot": "MORNING",
- "service": "string",
- "method": "string",
- "averageDurationThreshold": 0,
- "maxConsecutiveViolations": 0,
- "action": "ALERT",
- "blockDuration": 0
}
Update the stealth DoS settings on this system.
User must have the dos:update
capability to perform this action.
timeslot required | string (DosSettingsStealthTimeslot) Enum: "MORNING" "AFTERNOON" "EVENING" "NIGHT" This parameter is case-insensitive. |
averageDurationThreshold | integer |
maxConsecutiveViolations | integer |
action | string (DosSettingsAction) Enum: "ALERT" "BLOCK" "CHALLENGE" |
blockDuration | integer Duration to block after threshold violations; Ignored if |
{- "averageDurationThreshold": 0,
- "maxConsecutiveViolations": 0,
- "action": "ALERT",
- "blockDuration": 0
}
{- "timeslot": "MORNING",
- "service": "string",
- "method": "string",
- "averageDurationThreshold": 0,
- "maxConsecutiveViolations": 0,
- "action": "ALERT",
- "blockDuration": 0
}
Retrieve the call walking DoS settings from this system.
User must have the dos:read
capability to perform this action.
[- {
- "service": "string",
- "method": "ALL",
- "threshold": 0,
- "action": "ALERT",
- "blockDuration": 0
}
]
Retrieve the call walking DoS settings from this system.
User must have the dos:read
capability to perform this action.
method required | string (DosSettingsCallWalkingMethod) Enum: "ALL" "INVITE" "REGISTER" This parameter is case-insensitive. |
{- "service": "string",
- "method": "ALL",
- "threshold": 0,
- "action": "ALERT",
- "blockDuration": 0
}
Update the call walking DoS settings on this system.
User must have the dos:update
capability to perform this action.
method required | string (DosSettingsCallWalkingMethod) Enum: "ALL" "INVITE" "REGISTER" This parameter is case-insensitive. |
threshold | integer |
action | string (DosSettingsAction) Enum: "ALERT" "BLOCK" "CHALLENGE" |
blockDuration | integer Duration to block after threshold violations; Ignored if |
{- "threshold": 0,
- "action": "ALERT",
- "blockDuration": 0
}
{- "service": "string",
- "method": "ALL",
- "threshold": 0,
- "action": "ALERT",
- "blockDuration": 0
}
Update the DoS whitelist on this system.
User must have the dos:update
capability to perform this action.
uriGroup | integer |
{- "uriGroup": 0
}
{- "uriGroup": 0
}
Retrieve a list of all configured server interworking profiles for this system.
User must have the server-interworking:read
capability to perform this action.
[- {
- "profileId": 1,
- "profileName": "test",
- "general": {
- "holdSupport": "RFC3264",
- "handling180": "NO_SDP",
- "handling181": "NO_SDP",
- "handling182": "NO_SDP",
- "handling183": "SDP",
- "referHandling": {
- "enabled": true,
- "uriGroupId": 1,
- "options": [
- "SEND_HOLD",
- "DELAYED_OFFER"
]
}, - "handling3xx": {
- "enabled": true,
- "diversionHeaderSupport": true
}, - "delayedSdpHandling": false,
- "prackHandling": {
- "enabled": false,
- "allow18xSdp": false
}, - "t38Support": false,
- "uriScheme": "ANY",
- "viaHeaderFormat": "RFC3261",
- "sipsRequired": false,
- "mediasecHandling": false
}, - "privacy": {
- "enabled": false,
- "userName": "test",
- "pAssertedIdentity": false,
- "pPreferredIdentity": true,
- "privacyHeader": "None"
}, - "timers": {
- "minSe": 90,
- "initTimer": 50,
- "maxTimer": 200,
- "transExpire": 1,
- "inviteExpire": 180,
- "retryAfter": 2
}, - "advanced": {
- "recordRoutes": "NONE",
- "includeEndpointIpInCtxLookup": false,
- "extensions": "AVAYA",
- "diversionManipulation": {
- "enabled": false,
- "condition": "NONE",
- "headerUri": ""
}, - "hasRemoteSBC": true,
- "routeResponseOnViaPort": false,
- "mobxReinviteHandling": false,
- "natingFor301or302Redirection": false,
- "sipRecording": {
- "relayINVITEReplace": false,
- "conferenceUri": "string",
- "includeCalledParticipant": false
}, - "dtmfSupport": "NONE"
}
}
]
Create a new server interworking profile for this system.
User must have the server-interworking:create
capability to perform this action.
profileName | string |
object (ServerInterworkingGeneral) | |
object (ServerInterworkingPrivacy) | |
object (ServerInterworkingTimers) | |
object (ServerInterworkingAdvanced) |
{- "profileName": "test",
- "general": {
- "holdSupport": "RFC3264",
- "handling180": "NO_SDP",
- "handling181": "NO_SDP",
- "handling182": "NO_SDP",
- "handling183": "SDP",
- "referHandling": {
- "enabled": true,
- "uriGroupId": 1,
- "options": [
- "SEND_HOLD",
- "DELAYED_OFFER"
]
}, - "handling3xx": {
- "enabled": true,
- "diversionHeaderSupport": true
}, - "delayedSdpHandling": false,
- "prackHandling": {
- "enabled": false,
- "allow18xSdp": false
}, - "t38Support": false,
- "uriScheme": "ANY",
- "viaHeaderFormat": "RFC3261",
- "sipsRequired": false,
- "mediasecHandling": false
}, - "privacy": {
- "enabled": false,
- "userName": "test",
- "pAssertedIdentity": false,
- "pPreferredIdentity": true,
- "privacyHeader": "None"
}, - "timers": {
- "minSe": 90,
- "initTimer": 50,
- "maxTimer": 200,
- "transExpire": 1,
- "inviteExpire": 180,
- "retryAfter": 2
}, - "advanced": {
- "recordRoutes": "NONE",
- "includeEndpointIpInCtxLookup": false,
- "extensions": "AVAYA",
- "diversionManipulation": {
- "enabled": false,
- "condition": "NONE",
- "headerUri": ""
}, - "hasRemoteSBC": true,
- "routeResponseOnViaPort": false,
- "mobxReinviteHandling": false,
- "natingFor301or302Redirection": false,
- "sipRecording": {
- "relayINVITEReplace": false,
- "conferenceUri": "string",
- "includeCalledParticipant": false
}, - "dtmfSupport": "NONE"
}
}
{- "resourcePath": "api/config/v1/server-interworking/1",
- "profileId": 1,
- "profileName": "test",
- "general": {
- "holdSupport": "RFC3264",
- "handling180": "NO_SDP",
- "handling181": "NO_SDP",
- "handling182": "NO_SDP",
- "handling183": "SDP",
- "referHandling": {
- "enabled": true,
- "uriGroupId": 1,
- "options": [
- "SEND_HOLD",
- "DELAYED_OFFER"
]
}, - "handling3xx": {
- "enabled": true,
- "diversionHeaderSupport": true
}, - "delayedSdpHandling": false,
- "prackHandling": {
- "enabled": false,
- "allow18xSdp": false
}, - "t38Support": false,
- "uriScheme": "ANY",
- "viaHeaderFormat": "RFC3261",
- "sipsRequired": false,
- "mediasecHandling": false
}, - "privacy": {
- "enabled": false,
- "userName": "test",
- "pAssertedIdentity": false,
- "pPreferredIdentity": true,
- "privacyHeader": "None"
}, - "timers": {
- "minSe": 90,
- "initTimer": 50,
- "maxTimer": 200,
- "transExpire": 1,
- "inviteExpire": 180,
- "retryAfter": 2
}, - "advanced": {
- "recordRoutes": "NONE",
- "includeEndpointIpInCtxLookup": false,
- "extensions": "AVAYA",
- "diversionManipulation": {
- "enabled": false,
- "condition": "NONE",
- "headerUri": ""
}, - "hasRemoteSBC": true,
- "routeResponseOnViaPort": false,
- "mobxReinviteHandling": false,
- "natingFor301or302Redirection": false,
- "sipRecording": {
- "relayINVITEReplace": false,
- "conferenceUri": "string",
- "includeCalledParticipant": false
}, - "dtmfSupport": "NONE"
}
}
Retrieve an existing server interworking profile from this system.
User must have the server-interworking:read
capability to perform this action.
profileId required | integer |
{- "profileId": 1,
- "profileName": "test",
- "general": {
- "holdSupport": "RFC3264",
- "handling180": "NO_SDP",
- "handling181": "NO_SDP",
- "handling182": "NO_SDP",
- "handling183": "SDP",
- "referHandling": {
- "enabled": true,
- "uriGroupId": 1,
- "options": [
- "SEND_HOLD",
- "DELAYED_OFFER"
]
}, - "handling3xx": {
- "enabled": true,
- "diversionHeaderSupport": true
}, - "delayedSdpHandling": false,
- "prackHandling": {
- "enabled": false,
- "allow18xSdp": false
}, - "t38Support": false,
- "uriScheme": "ANY",
- "viaHeaderFormat": "RFC3261",
- "sipsRequired": false,
- "mediasecHandling": false
}, - "privacy": {
- "enabled": false,
- "userName": "test",
- "pAssertedIdentity": false,
- "pPreferredIdentity": true,
- "privacyHeader": "None"
}, - "timers": {
- "minSe": 90,
- "initTimer": 50,
- "maxTimer": 200,
- "transExpire": 1,
- "inviteExpire": 180,
- "retryAfter": 2
}, - "advanced": {
- "recordRoutes": "NONE",
- "includeEndpointIpInCtxLookup": false,
- "extensions": "AVAYA",
- "diversionManipulation": {
- "enabled": false,
- "condition": "NONE",
- "headerUri": ""
}, - "hasRemoteSBC": true,
- "routeResponseOnViaPort": false,
- "mobxReinviteHandling": false,
- "natingFor301or302Redirection": false,
- "sipRecording": {
- "relayINVITEReplace": false,
- "conferenceUri": "string",
- "includeCalledParticipant": false
}, - "dtmfSupport": "NONE"
}
}
Modify an existing server interworking profile for this system. All fields are optional and any omitted field will use the value from the existing profile.
User must have the server-interworking:update
capability to perform this action.
profileId required | integer |
profileName | string |
object (ServerInterworkingGeneral) | |
object (ServerInterworkingPrivacy) | |
object (ServerInterworkingTimers) | |
object (ServerInterworkingAdvanced) |
{- "profileName": "test",
- "general": {
- "holdSupport": "RFC3264",
- "handling180": "NO_SDP",
- "handling181": "NO_SDP",
- "handling182": "NO_SDP",
- "handling183": "SDP",
- "referHandling": {
- "enabled": true,
- "uriGroupId": 1,
- "options": [
- "SEND_HOLD",
- "DELAYED_OFFER"
]
}, - "handling3xx": {
- "enabled": true,
- "diversionHeaderSupport": true
}, - "delayedSdpHandling": false,
- "prackHandling": {
- "enabled": false,
- "allow18xSdp": false
}, - "t38Support": false,
- "uriScheme": "ANY",
- "viaHeaderFormat": "RFC3261",
- "sipsRequired": false,
- "mediasecHandling": false
}, - "privacy": {
- "enabled": false,
- "userName": "test",
- "pAssertedIdentity": false,
- "pPreferredIdentity": true,
- "privacyHeader": "None"
}, - "timers": {
- "minSe": 90,
- "initTimer": 50,
- "maxTimer": 200,
- "transExpire": 1,
- "inviteExpire": 180,
- "retryAfter": 2
}, - "advanced": {
- "recordRoutes": "NONE",
- "includeEndpointIpInCtxLookup": false,
- "extensions": "AVAYA",
- "diversionManipulation": {
- "enabled": false,
- "condition": "NONE",
- "headerUri": ""
}, - "hasRemoteSBC": true,
- "routeResponseOnViaPort": false,
- "mobxReinviteHandling": false,
- "natingFor301or302Redirection": false,
- "sipRecording": {
- "relayINVITEReplace": false,
- "conferenceUri": "string",
- "includeCalledParticipant": false
}, - "dtmfSupport": "NONE"
}
}
{- "profileId": 1,
- "profileName": "test",
- "general": {
- "holdSupport": "RFC3264",
- "handling180": "NO_SDP",
- "handling181": "NO_SDP",
- "handling182": "NO_SDP",
- "handling183": "SDP",
- "referHandling": {
- "enabled": true,
- "uriGroupId": 1,
- "options": [
- "SEND_HOLD",
- "DELAYED_OFFER"
]
}, - "handling3xx": {
- "enabled": true,
- "diversionHeaderSupport": true
}, - "delayedSdpHandling": false,
- "prackHandling": {
- "enabled": false,
- "allow18xSdp": false
}, - "t38Support": false,
- "uriScheme": "ANY",
- "viaHeaderFormat": "RFC3261",
- "sipsRequired": false,
- "mediasecHandling": false
}, - "privacy": {
- "enabled": false,
- "userName": "test",
- "pAssertedIdentity": false,
- "pPreferredIdentity": true,
- "privacyHeader": "None"
}, - "timers": {
- "minSe": 90,
- "initTimer": 50,
- "maxTimer": 200,
- "transExpire": 1,
- "inviteExpire": 180,
- "retryAfter": 2
}, - "advanced": {
- "recordRoutes": "NONE",
- "includeEndpointIpInCtxLookup": false,
- "extensions": "AVAYA",
- "diversionManipulation": {
- "enabled": false,
- "condition": "NONE",
- "headerUri": ""
}, - "hasRemoteSBC": true,
- "routeResponseOnViaPort": false,
- "mobxReinviteHandling": false,
- "natingFor301or302Redirection": false,
- "sipRecording": {
- "relayINVITEReplace": false,
- "conferenceUri": "string",
- "includeCalledParticipant": false
}, - "dtmfSupport": "NONE"
}
}
Delete an existing server interworking profile from this system.
User must have the server-interworking:delete
capability to perform this action.
profileId required | integer |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Adds new Signaling Rule in SBCE.
User must have the signaling-rule:create
capability to perform this action.
ruleName | string |
object (SignalingRule_general) | |
Array of objects (SignalingRule_requestRule) | |
Array of objects (SignalingRule_responseRule) | |
Array of objects (SignalingRule_requestHeaderRule) | |
Array of objects (SignalingRule_responseHeaderRule) | |
object (SignalingRule_signalingQos) | |
object (SignalingRule_ucid) |
{- "ruleName": "signaling-rule-1",
- "general": {
- "inbound": {
- "requests": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "non2XXFinalResponses": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalRequestHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalResponseHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}
}, - "outbound": {
- "requests": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "non2XXFinalResponses": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalRequestHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalResponseHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}
}, - "contentTypePolicy": {
- "enableContentTypeChecks": true,
- "action": "string",
- "multipartAction": "string",
- "actionExceptionList": [
- "string"
], - "multipartActionExceptionList": [
- "string"
]
}
}, - "requestRules": [
- {
- "proprietaryRequest": false,
- "methodName": "ACK",
- "inDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "outOfDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "responseRules": [
- {
- "proprietaryResponse": false,
- "responseCode": "3XX",
- "methodName": "ALL",
- "inDialogAction": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "string"
}
], - "requestHeaderRules": [
- {
- "proprietaryRequestHeader": true,
- "headerName": "Accept",
- "methodName": "ACK",
- "headerCriteria": "MANDATORY",
- "action": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "responseHeaderRules": [
- {
- "proprietaryResponseHeader": false,
- "headerName": "Accept",
- "methodName": "ALL",
- "responseCode": "1XX",
- "headerCriteria": "OPTIONAL",
- "action": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "signalingQos": {
- "enabled": true,
- "dscp": {
- "dscpValue": "CS3",
- "dscpCustomValue": "string"
}, - "tos": {
- "precedenceValue": "NETWORK_CONTROL",
- "precedenceCustomValue": "string",
- "tosValue": "MINIMIZE_DELAY",
- "tosCustomValue": "string"
}
}, - "ucid": {
- "enabled": true,
- "nodeId": 1,
- "protocolDiscriminator": "00"
}
}
{- "resourcePath": "/api/config/v1/signaling-rules/10",
- "ruleId": 10,
- "ruleName": "signaling-rule-1",
- "general": {
- "inbound": {
- "requests": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "non2XXFinalResponses": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalRequestHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalResponseHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}
}, - "outbound": {
- "requests": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "non2XXFinalResponses": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalRequestHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalResponseHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}
}, - "contentTypePolicy": {
- "enableContentTypeChecks": true,
- "action": "string",
- "multipartAction": "string",
- "actionExceptionList": [
- "string"
], - "multipartActionExceptionList": [
- "string"
]
}
}, - "requestRules": [
- {
- "proprietaryRequest": false,
- "methodName": "ACK",
- "inDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "outOfDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "responseRules": [
- {
- "proprietaryResponse": false,
- "responseCode": "3XX",
- "methodName": "ALL",
- "inDialogAction": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "string"
}
], - "requestHeaderRules": [
- {
- "proprietaryRequestHeader": true,
- "headerName": "Accept",
- "methodName": "ACK",
- "headerCriteria": "MANDATORY",
- "action": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "responseHeaderRules": [
- {
- "proprietaryResponseHeader": false,
- "headerName": "Accept",
- "methodName": "ALL",
- "responseCode": "1XX",
- "headerCriteria": "OPTIONAL",
- "action": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "signalingQos": {
- "enabled": true,
- "dscp": {
- "dscpValue": "CS3",
- "dscpCustomValue": "string"
}, - "tos": {
- "precedenceValue": "NETWORK_CONTROL",
- "precedenceCustomValue": "string",
- "tosValue": "MINIMIZE_DELAY",
- "tosCustomValue": "string"
}
}, - "ucid": {
- "enabled": true,
- "nodeId": 1,
- "protocolDiscriminator": "00"
}
}
Retrieve all Signaling Rules configured in SBCE.
User must have the signaling-rule:read
capability to perform this action.
[- {
- "ruleId": 10,
- "ruleName": "signaling-rule-1",
- "general": {
- "inbound": {
- "requests": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "non2XXFinalResponses": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalRequestHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalResponseHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}
}, - "outbound": {
- "requests": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "non2XXFinalResponses": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalRequestHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalResponseHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}
}, - "contentTypePolicy": {
- "enableContentTypeChecks": true,
- "action": "string",
- "multipartAction": "string",
- "actionExceptionList": [
- "string"
], - "multipartActionExceptionList": [
- "string"
]
}
}, - "requestRules": [
- {
- "proprietaryRequest": false,
- "methodName": "ACK",
- "inDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "outOfDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "responseRules": [
- {
- "proprietaryResponse": false,
- "responseCode": "3XX",
- "methodName": "ALL",
- "inDialogAction": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "string"
}
], - "requestHeaderRules": [
- {
- "proprietaryRequestHeader": true,
- "headerName": "Accept",
- "methodName": "ACK",
- "headerCriteria": "MANDATORY",
- "action": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "responseHeaderRules": [
- {
- "proprietaryResponseHeader": false,
- "headerName": "Accept",
- "methodName": "ALL",
- "responseCode": "1XX",
- "headerCriteria": "OPTIONAL",
- "action": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "signalingQos": {
- "enabled": true,
- "dscp": {
- "dscpValue": "CS3",
- "dscpCustomValue": "string"
}, - "tos": {
- "precedenceValue": "NETWORK_CONTROL",
- "precedenceCustomValue": "string",
- "tosValue": "MINIMIZE_DELAY",
- "tosCustomValue": "string"
}
}, - "ucid": {
- "enabled": true,
- "nodeId": 1,
- "protocolDiscriminator": "00"
}
}
]
Get Signaling Rule by ruleId configured in SBCE.
User must have the signaling-rule:read
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
{- "ruleId": 10,
- "ruleName": "signaling-rule-1",
- "general": {
- "inbound": {
- "requests": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "non2XXFinalResponses": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalRequestHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalResponseHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}
}, - "outbound": {
- "requests": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "non2XXFinalResponses": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalRequestHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalResponseHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}
}, - "contentTypePolicy": {
- "enableContentTypeChecks": true,
- "action": "string",
- "multipartAction": "string",
- "actionExceptionList": [
- "string"
], - "multipartActionExceptionList": [
- "string"
]
}
}, - "requestRules": [
- {
- "proprietaryRequest": false,
- "methodName": "ACK",
- "inDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "outOfDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "responseRules": [
- {
- "proprietaryResponse": false,
- "responseCode": "3XX",
- "methodName": "ALL",
- "inDialogAction": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "string"
}
], - "requestHeaderRules": [
- {
- "proprietaryRequestHeader": true,
- "headerName": "Accept",
- "methodName": "ACK",
- "headerCriteria": "MANDATORY",
- "action": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "responseHeaderRules": [
- {
- "proprietaryResponseHeader": false,
- "headerName": "Accept",
- "methodName": "ALL",
- "responseCode": "1XX",
- "headerCriteria": "OPTIONAL",
- "action": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "signalingQos": {
- "enabled": true,
- "dscp": {
- "dscpValue": "CS3",
- "dscpCustomValue": "string"
}, - "tos": {
- "precedenceValue": "NETWORK_CONTROL",
- "precedenceCustomValue": "string",
- "tosValue": "MINIMIZE_DELAY",
- "tosCustomValue": "string"
}
}, - "ucid": {
- "enabled": true,
- "nodeId": 1,
- "protocolDiscriminator": "00"
}
}
Delete Signaling Rule by ruleId in SBCE
User must have the signaling-rule:delete
capability to perform this action.
ruleId required | integer ID of the profile |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Edit General fields of Signaling Rule for given ruleId in SBCE.
User must have the signaling-rule:update
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
object (SignalingRule_general_boundDetails) | |
object (SignalingRule_general_boundDetails) | |
object |
{- "inbound": {
- "requests": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "non2XXFinalResponses": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalRequestHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalResponseHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}
}, - "outbound": {
- "requests": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "non2XXFinalResponses": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalRequestHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalResponseHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}
}, - "contentTypePolicy": {
- "enableContentTypeChecks": true,
- "action": "string",
- "multipartAction": "string",
- "actionExceptionList": [
- "string"
], - "multipartActionExceptionList": [
- "string"
]
}
}
{- "ruleId": 10,
- "ruleName": "signaling-rule-1",
- "general": {
- "inbound": {
- "requests": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "non2XXFinalResponses": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalRequestHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalResponseHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}
}, - "outbound": {
- "requests": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "non2XXFinalResponses": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalRequestHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalResponseHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}
}, - "contentTypePolicy": {
- "enableContentTypeChecks": true,
- "action": "string",
- "multipartAction": "string",
- "actionExceptionList": [
- "string"
], - "multipartActionExceptionList": [
- "string"
]
}
}, - "requestRules": [
- {
- "proprietaryRequest": false,
- "methodName": "ACK",
- "inDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "outOfDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "responseRules": [
- {
- "proprietaryResponse": false,
- "responseCode": "3XX",
- "methodName": "ALL",
- "inDialogAction": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "string"
}
], - "requestHeaderRules": [
- {
- "proprietaryRequestHeader": true,
- "headerName": "Accept",
- "methodName": "ACK",
- "headerCriteria": "MANDATORY",
- "action": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "responseHeaderRules": [
- {
- "proprietaryResponseHeader": false,
- "headerName": "Accept",
- "methodName": "ALL",
- "responseCode": "1XX",
- "headerCriteria": "OPTIONAL",
- "action": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "signalingQos": {
- "enabled": true,
- "dscp": {
- "dscpValue": "CS3",
- "dscpCustomValue": "string"
}, - "tos": {
- "precedenceValue": "NETWORK_CONTROL",
- "precedenceCustomValue": "string",
- "tosValue": "MINIMIZE_DELAY",
- "tosCustomValue": "string"
}
}, - "ucid": {
- "enabled": true,
- "nodeId": 1,
- "protocolDiscriminator": "00"
}
}
Edit UCID fields of Signaling Rule for given ruleId in SBCE.
User must have the signaling-rule:update
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
enabled | boolean |
nodeId | number [ 1 .. 32767 ] this values should be present when |
protocolDiscriminator | string Enum: "00" "04" |
{- "enabled": true,
- "nodeId": 1,
- "protocolDiscriminator": "00"
}
{- "ruleId": 10,
- "ruleName": "signaling-rule-1",
- "general": {
- "inbound": {
- "requests": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "non2XXFinalResponses": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalRequestHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalResponseHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}
}, - "outbound": {
- "requests": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "non2XXFinalResponses": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalRequestHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalResponseHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}
}, - "contentTypePolicy": {
- "enableContentTypeChecks": true,
- "action": "string",
- "multipartAction": "string",
- "actionExceptionList": [
- "string"
], - "multipartActionExceptionList": [
- "string"
]
}
}, - "requestRules": [
- {
- "proprietaryRequest": false,
- "methodName": "ACK",
- "inDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "outOfDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "responseRules": [
- {
- "proprietaryResponse": false,
- "responseCode": "3XX",
- "methodName": "ALL",
- "inDialogAction": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "string"
}
], - "requestHeaderRules": [
- {
- "proprietaryRequestHeader": true,
- "headerName": "Accept",
- "methodName": "ACK",
- "headerCriteria": "MANDATORY",
- "action": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "responseHeaderRules": [
- {
- "proprietaryResponseHeader": false,
- "headerName": "Accept",
- "methodName": "ALL",
- "responseCode": "1XX",
- "headerCriteria": "OPTIONAL",
- "action": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "signalingQos": {
- "enabled": true,
- "dscp": {
- "dscpValue": "CS3",
- "dscpCustomValue": "string"
}, - "tos": {
- "precedenceValue": "NETWORK_CONTROL",
- "precedenceCustomValue": "string",
- "tosValue": "MINIMIZE_DELAY",
- "tosCustomValue": "string"
}
}, - "ucid": {
- "enabled": true,
- "nodeId": 1,
- "protocolDiscriminator": "00"
}
}
Edit Signaling QoS fields of Signaling Rule for given ruleId in SBCE.
User must have the signaling-rule:update
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
enabled | boolean |
object | |
object |
{- "enabled": true,
- "dscp": {
- "dscpValue": "CS3",
- "dscpCustomValue": "string"
}, - "tos": {
- "precedenceValue": "NETWORK_CONTROL",
- "precedenceCustomValue": "string",
- "tosValue": "MINIMIZE_DELAY",
- "tosCustomValue": "string"
}
}
{- "ruleId": 10,
- "ruleName": "signaling-rule-1",
- "general": {
- "inbound": {
- "requests": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "non2XXFinalResponses": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalRequestHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalResponseHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}
}, - "outbound": {
- "requests": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "non2XXFinalResponses": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalRequestHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}, - "optionalResponseHeaders": {
- "action": "ALLOW",
- "code": 100,
- "value": "string"
}
}, - "contentTypePolicy": {
- "enableContentTypeChecks": true,
- "action": "string",
- "multipartAction": "string",
- "actionExceptionList": [
- "string"
], - "multipartActionExceptionList": [
- "string"
]
}
}, - "requestRules": [
- {
- "proprietaryRequest": false,
- "methodName": "ACK",
- "inDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "outOfDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "responseRules": [
- {
- "proprietaryResponse": false,
- "responseCode": "3XX",
- "methodName": "ALL",
- "inDialogAction": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "string"
}
], - "requestHeaderRules": [
- {
- "proprietaryRequestHeader": true,
- "headerName": "Accept",
- "methodName": "ACK",
- "headerCriteria": "MANDATORY",
- "action": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "responseHeaderRules": [
- {
- "proprietaryResponseHeader": false,
- "headerName": "Accept",
- "methodName": "ALL",
- "responseCode": "1XX",
- "headerCriteria": "OPTIONAL",
- "action": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
], - "signalingQos": {
- "enabled": true,
- "dscp": {
- "dscpValue": "CS3",
- "dscpCustomValue": "string"
}, - "tos": {
- "precedenceValue": "NETWORK_CONTROL",
- "precedenceCustomValue": "string",
- "tosValue": "MINIMIZE_DELAY",
- "tosCustomValue": "string"
}
}, - "ucid": {
- "enabled": true,
- "nodeId": 1,
- "protocolDiscriminator": "00"
}
}
Add new Request rule to Signaling Rule by ruleId in SBCE
User must have the signaling-rule:create
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
proprietaryRequest | boolean |
methodName | string Enum: "ACK" "BYE" "CANCEL" "INFO" "INVITE" "MESSAGE" "NOTIFY" "OPTIONS" "PRACK" "PUBLISH" "REFER" "REGISTER" "SUBSCRIBE" "UPDATE" if |
object | |
object | |
direction | string Enum: "IN" "OUT" |
{- "proprietaryRequest": false,
- "methodName": "ACK",
- "inDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "outOfDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
{- "resourcePath": "/api/config/v1/signaling-rules/10/request-rules/ACK/IN",
- "proprietaryRequest": false,
- "methodName": "ACK",
- "inDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "outOfDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
Get all Request rules associated to Signaling Rule by ruleId in SBCE
User must have the signaling-rule:read
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
[- {
- "proprietaryRequest": false,
- "methodName": "ACK",
- "inDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "outOfDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
]
Edit Request rule with method name direction in Signaling Rule by ruleId in SBCE
User must have the signaling-rule:update
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
methodName required | string methodName of the request rule |
direction required | string direction of the request rule |
proprietaryRequest | boolean |
methodName | string Enum: "ACK" "BYE" "CANCEL" "INFO" "INVITE" "MESSAGE" "NOTIFY" "OPTIONS" "PRACK" "PUBLISH" "REFER" "REGISTER" "SUBSCRIBE" "UPDATE" if |
object | |
object | |
direction | string Enum: "IN" "OUT" |
{- "proprietaryRequest": false,
- "methodName": "ACK",
- "inDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "outOfDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
{- "proprietaryRequest": false,
- "methodName": "ACK",
- "inDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "outOfDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
Get Request rule with method name direction in Signaling Rule by ruleId in SBCE
User must have the signaling-rule:read
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
methodName required | string methodName of the request rule |
direction required | string direction of the request rule |
[- {
- "proprietaryRequest": false,
- "methodName": "ACK",
- "inDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "outOfDialogAction": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
]
Delete Request rule with method name direction in Signaling Rule by ruleId in SBCE
User must have the signaling-rule:delete
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
methodName required | string methodName of the request rule |
direction required | string direction of the request rule |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new Response rule to Signaling Rule by ruleId in SBCE
User must have the signaling-rule:create
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
proprietaryResponse | boolean |
responseCode | string Enum: "3XX" "300" "301" "302" "305" "380" "400" "401" "402" "403" "404" "405" "406" "407" "408" "410" "412" "413" "414" "415" "416" "420" "421" "422" "423" "428" "429" "436" "437" "438" "480" "481" "482" "483" "484" "486" "487" "488" "489" "491" "493" "494" "500" "501" "502" "503" "504" "505" "513" "580" "600" "603" "604" "606" if |
methodName | string Enum: "ALL" "BYE" "CANCEL" "INFO" "INVITE" "MESSAGE" "NOTIFY" "OPTIONS" "PUBLISH" "REFER" "REGISTER" "SUBSCRIBE" "UPDATE" |
object | |
direction | string |
{- "proprietaryResponse": false,
- "responseCode": "3XX",
- "methodName": "ALL",
- "inDialogAction": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "string"
}
{- "resourcePath": "/api/config/v1/signaling-rules/10/response-rules/3XX/ALL/IN",
- "proprietaryResponse": false,
- "responseCode": "3XX",
- "methodName": "ALL",
- "inDialogAction": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "string"
}
Get all Response rules associated to Signaling Rule by ruleId in SBCE
User must have the signaling-rule:read
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
[- {
- "proprietaryResponse": false,
- "responseCode": "3XX",
- "methodName": "ALL",
- "inDialogAction": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "string"
}
]
Edit Response rule with response code, method name direction in Signaling Rule by ruleId in SBCE
User must have the signaling-rule:update
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
methodName required | string methodName of the response rule |
direction required | string direction of the response rule |
responseCode required | string responseCode of the response rule |
proprietaryResponse | boolean |
responseCode | string Enum: "3XX" "300" "301" "302" "305" "380" "400" "401" "402" "403" "404" "405" "406" "407" "408" "410" "412" "413" "414" "415" "416" "420" "421" "422" "423" "428" "429" "436" "437" "438" "480" "481" "482" "483" "484" "486" "487" "488" "489" "491" "493" "494" "500" "501" "502" "503" "504" "505" "513" "580" "600" "603" "604" "606" if |
methodName | string Enum: "ALL" "BYE" "CANCEL" "INFO" "INVITE" "MESSAGE" "NOTIFY" "OPTIONS" "PUBLISH" "REFER" "REGISTER" "SUBSCRIBE" "UPDATE" |
object | |
direction | string |
{- "proprietaryResponse": false,
- "responseCode": "3XX",
- "methodName": "ALL",
- "inDialogAction": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "string"
}
{- "proprietaryResponse": false,
- "responseCode": "3XX",
- "methodName": "ALL",
- "inDialogAction": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "string"
}
Get Response rule with response code, method name direction in Signaling Rule by ruleId in SBCE
User must have the signaling-rule:read
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
methodName required | string methodName of the response rule |
direction required | string direction of the response rule |
responseCode required | string responseCode of the response rule |
[- {
- "proprietaryResponse": false,
- "responseCode": "3XX",
- "methodName": "ALL",
- "inDialogAction": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "string"
}
]
Delete Response rule with response code, method name direction in Signaling Rule by ruleId in SBCE
User must have the signaling-rule:delete
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
methodName required | string methodName of the response rule |
direction required | string direction of the response rule |
responseCode required | string responseCode of the response rule |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new Request header rule to Signaling Rule by ruleId in SBCE
User must have the signaling-rule:create
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
proprietaryRequestHeader | boolean |
headerName | string Enum: "Accept" "Accept-Contact" "Accept-Encoding" "Accept-Language" "Accept-Resource-Priority" "Alert-Info" "Allow" "Allow-Events" "Authentication-Info" "Authorization" "Call-Info" "Contact" "Content-Disposition" "Content-Encoding" "Content-Language" "Content-Type" "Date" "Error-Info" "Event" "Expires" "History-Info" "Identity" "Identity-Info" "In-Reply-To" "Join" "MIME-Version" "Min-Expires" "Min-SE" "Organization" "Path" "Priority" "Privacy" "P-Asserted-Identity" "Proxy-Authenticate" "Proxy-Authorization" "Proxy-Require" "RAck" "Reason" "Record-Route" "Refer-Sub" "Refer-To" "Referred-By" "Reject-Contact" "Remote-Party-ID" "Replaces" "Reply-To" "Request-Disposition" "Require" "Resource-Priority" "Response-Key (Deprecated)" "Retry-After" "Route" "RSeq" "Security-Client" "Security-Server" "Security-Verify" "Server" "Service-Route" "Session-Expires" "Subject" "Subscription-State" "Supported" "Timestamp" "Unsupported" "User-Agent" "Warning" "WWW-Authenticate" if |
methodName | string Enum: "ALL" "ACK" "BYE" "CANCEL" "INFO" "INVITE" "MESSAGE" "NOTIFY" "OPTIONS" "PRACK" "PUBLISH" "REFER" "REGISTER" "SUBSCRIBE" "UPDATE" |
headerCriteria | string Enum: "OPTIONAL" "MANDATORY" "FORBIDDEN" |
object | |
direction | string Enum: "IN" "OUT" |
{- "proprietaryRequestHeader": true,
- "headerName": "Accept",
- "methodName": "ACK",
- "headerCriteria": "MANDATORY",
- "action": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
{- "resourcePath": "/api/config/v1/signaling-rules/10/request-header-rules/Accept/ACK/IN",
- "proprietaryRequestHeader": true,
- "headerName": "Accept",
- "methodName": "ACK",
- "headerCriteria": "MANDATORY",
- "action": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
Get all Request header rules associated to Signaling Rule by ruleId in SBCE
User must have the signaling-rule:read
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
[- {
- "proprietaryRequestHeader": true,
- "headerName": "Accept",
- "methodName": "ACK",
- "headerCriteria": "MANDATORY",
- "action": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
]
Edit Request header rule with method name direction in Signaling Rule by ruleId in SBCE
User must have the signaling-rule:update
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
headerName required | string headerName of the request header rule |
methodName required | string methodName of the request header rule |
direction required | string direction of the request header rule |
proprietaryRequestHeader | boolean |
headerName | string Enum: "Accept" "Accept-Contact" "Accept-Encoding" "Accept-Language" "Accept-Resource-Priority" "Alert-Info" "Allow" "Allow-Events" "Authentication-Info" "Authorization" "Call-Info" "Contact" "Content-Disposition" "Content-Encoding" "Content-Language" "Content-Type" "Date" "Error-Info" "Event" "Expires" "History-Info" "Identity" "Identity-Info" "In-Reply-To" "Join" "MIME-Version" "Min-Expires" "Min-SE" "Organization" "Path" "Priority" "Privacy" "P-Asserted-Identity" "Proxy-Authenticate" "Proxy-Authorization" "Proxy-Require" "RAck" "Reason" "Record-Route" "Refer-Sub" "Refer-To" "Referred-By" "Reject-Contact" "Remote-Party-ID" "Replaces" "Reply-To" "Request-Disposition" "Require" "Resource-Priority" "Response-Key (Deprecated)" "Retry-After" "Route" "RSeq" "Security-Client" "Security-Server" "Security-Verify" "Server" "Service-Route" "Session-Expires" "Subject" "Subscription-State" "Supported" "Timestamp" "Unsupported" "User-Agent" "Warning" "WWW-Authenticate" if |
methodName | string Enum: "ALL" "ACK" "BYE" "CANCEL" "INFO" "INVITE" "MESSAGE" "NOTIFY" "OPTIONS" "PRACK" "PUBLISH" "REFER" "REGISTER" "SUBSCRIBE" "UPDATE" |
headerCriteria | string Enum: "OPTIONAL" "MANDATORY" "FORBIDDEN" |
object | |
direction | string Enum: "IN" "OUT" |
{- "proprietaryRequestHeader": true,
- "headerName": "Accept",
- "methodName": "ACK",
- "headerCriteria": "MANDATORY",
- "action": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
{- "proprietaryRequestHeader": true,
- "headerName": "Accept",
- "methodName": "ACK",
- "headerCriteria": "MANDATORY",
- "action": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
Get Request header rule with method name direction in Signaling Rule by ruleId in SBCE
User must have the signaling-rule:read
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
headerName required | string headerName of the request header rule |
methodName required | string methodName of the request header rule |
direction required | string direction of the request header rule |
[- {
- "proprietaryRequestHeader": true,
- "headerName": "Accept",
- "methodName": "ACK",
- "headerCriteria": "MANDATORY",
- "action": {
- "action": "BLOCK",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
]
Delete Request header rule with method name direction in Signaling Rule by ruleId in SBCE
User must have the signaling-rule:delete
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
headerName required | string headerName of the request header rule |
methodName required | string methodName of the request header rule |
direction required | string direction of the request header rule |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new Response header rule to Signaling Rule by ruleId in SBCE
User must have the signaling-rule:create
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
proprietaryResponseHeader | boolean |
headerName | string Enum: "Accept" "Accept-Contact" "Accept-Encoding" "Accept-Language" "Accept-Resource-Priority" "Alert-Info" "Allow" "Allow-Events" "Authentication-Info" "Authorization" "Call-Info" "Contact" "Content-Disposition" "Content-Encoding" "Content-Language" "Content-Type" "Date" "Error-Info" "Event" "Expires" "History-Info" "Identity" "Identity-Info" "In-Reply-To" "Join" "MIME-Version" "Min-Expires" "Min-SE" "Organization" "Path" "Priority" "Privacy" "P-Asserted-Identity" "Proxy-Authenticate" "Proxy-Authorization" "Proxy-Require" "RAck" "Reason" "Record-Route" "Refer-Sub" "Refer-To" "Referred-By" "Reject-Contact" "Remote-Party-ID" "Replaces" "Reply-To" "Request-Disposition" "Require" "Resource-Priority" "Response-Key (Deprecated)" "Retry-After" "Route" "RSeq" "Security-Client" "Security-Server" "Security-Verify" "Server" "Service-Route" "Session-Expires" "Subject" "Subscription-State" "Supported" "Timestamp" "Unsupported" "User-Agent" "Warning" "WWW-Authenticate" if |
methodName | string Enum: "ALL" "ACK" "BYE" "CANCEL" "INFO" "INVITE" "MESSAGE" "NOTIFY" "OPTIONS" "PRACK" "PUBLISH" "REFER" "REGISTER" "SUBSCRIBE" "UPDATE" |
responseCode | string Enum: "1XX" "100" "180" "181" "182" "183" "2XX" "200" "202" "3XX" "300" "301" "302" "305" "380" "4XX" "400" "401" "402" "403" "404" "405" "406" "407" "408" "410" "412" "413" "414" "415" "416" "420" "421" "422" "423" "428" "429" "436" "437" "438" "480" "481" "482" "483" "484" "486" "487" "488" "489" "491" "493" "494" "5XX" "500" "501" "502" "503" "504" "505" "513" "580" "6XX" "600" "603" "604" "606" |
headerCriteria | string Enum: "OPTIONAL" "MANDATORY" "FORBIDDEN" |
object | |
direction | string Enum: "IN" "OUT" |
{- "proprietaryResponseHeader": false,
- "headerName": "Accept",
- "methodName": "ALL",
- "responseCode": "1XX",
- "headerCriteria": "OPTIONAL",
- "action": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
{- "resourcePath": "/api/config/v1/signaling-rules/10/response-header-rules/Accept/1XX/ALL/IN",
- "proprietaryResponseHeader": false,
- "headerName": "Accept",
- "methodName": "ALL",
- "responseCode": "1XX",
- "headerCriteria": "OPTIONAL",
- "action": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
Get all Response header rules associated to Signaling Rule by ruleId in SBCE
User must have the signaling-rule:read
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
[- {
- "proprietaryResponseHeader": false,
- "headerName": "Accept",
- "methodName": "ALL",
- "responseCode": "1XX",
- "headerCriteria": "OPTIONAL",
- "action": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
]
Edit Response header rule with header name, response code, method name direction in Signaling Rule by ruleId in SBCE
User must have the signaling-rule:update
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
headerName required | string headerName of the response header rule |
methodName required | string methodName of the response header rule |
direction required | string direction of the response header rule |
responseCode required | string responseCode of the response header rule |
proprietaryResponseHeader | boolean |
headerName | string Enum: "Accept" "Accept-Contact" "Accept-Encoding" "Accept-Language" "Accept-Resource-Priority" "Alert-Info" "Allow" "Allow-Events" "Authentication-Info" "Authorization" "Call-Info" "Contact" "Content-Disposition" "Content-Encoding" "Content-Language" "Content-Type" "Date" "Error-Info" "Event" "Expires" "History-Info" "Identity" "Identity-Info" "In-Reply-To" "Join" "MIME-Version" "Min-Expires" "Min-SE" "Organization" "Path" "Priority" "Privacy" "P-Asserted-Identity" "Proxy-Authenticate" "Proxy-Authorization" "Proxy-Require" "RAck" "Reason" "Record-Route" "Refer-Sub" "Refer-To" "Referred-By" "Reject-Contact" "Remote-Party-ID" "Replaces" "Reply-To" "Request-Disposition" "Require" "Resource-Priority" "Response-Key (Deprecated)" "Retry-After" "Route" "RSeq" "Security-Client" "Security-Server" "Security-Verify" "Server" "Service-Route" "Session-Expires" "Subject" "Subscription-State" "Supported" "Timestamp" "Unsupported" "User-Agent" "Warning" "WWW-Authenticate" if |
methodName | string Enum: "ALL" "ACK" "BYE" "CANCEL" "INFO" "INVITE" "MESSAGE" "NOTIFY" "OPTIONS" "PRACK" "PUBLISH" "REFER" "REGISTER" "SUBSCRIBE" "UPDATE" |
responseCode | string Enum: "1XX" "100" "180" "181" "182" "183" "2XX" "200" "202" "3XX" "300" "301" "302" "305" "380" "4XX" "400" "401" "402" "403" "404" "405" "406" "407" "408" "410" "412" "413" "414" "415" "416" "420" "421" "422" "423" "428" "429" "436" "437" "438" "480" "481" "482" "483" "484" "486" "487" "488" "489" "491" "493" "494" "5XX" "500" "501" "502" "503" "504" "505" "513" "580" "6XX" "600" "603" "604" "606" |
headerCriteria | string Enum: "OPTIONAL" "MANDATORY" "FORBIDDEN" |
object | |
direction | string Enum: "IN" "OUT" |
{- "proprietaryResponseHeader": false,
- "headerName": "Accept",
- "methodName": "ALL",
- "responseCode": "1XX",
- "headerCriteria": "OPTIONAL",
- "action": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
{- "proprietaryResponse": false,
- "responseCode": "3XX",
- "methodName": "ALL",
- "inDialogAction": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "string"
}
Get Response header rule with response code, method name direction in Signaling Rule by ruleId in SBCE
User must have the signaling-rule:read
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
headerName required | string headerName of the response header rule |
methodName required | string methodName of the response header rule |
direction required | string direction of the response header rule |
responseCode required | string responseCode of the response header rule |
[- {
- "proprietaryResponseHeader": false,
- "headerName": "Accept",
- "methodName": "ALL",
- "responseCode": "1XX",
- "headerCriteria": "OPTIONAL",
- "action": {
- "action": "CHNG_RESP",
- "code": 486,
- "value": "Busy Here"
}, - "direction": "IN"
}
]
Delete Response rule with response code, method name direction in Signaling Rule by ruleId in SBCE
User must have the signaling-rule:delete
capability to perform this action.
ruleId required | integer ID of the Signaling Rule |
headerName required | string headerName of the response header rule |
methodName required | string methodName of the response header rule |
direction required | string direction of the response header rule |
responseCode required | string responseCode of the response header rule |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Create a new SNI group for this system.
User must have the sni-group:create
capability to perform this action.
name | string |
profileList | Array of integers |
{- "name": "string",
- "profileList": [
- 0
]
}
{- "resourcePath": "string",
- "id": 0,
- "name": "string",
- "profileList": [
- 0
]
}
Modify an existing SNI group for this system.
User must have the sni-group:update
capability to perform this action.
id required | integer |
name | string |
profileList | Array of integers |
{- "name": "string",
- "profileList": [
- 0
]
}
{- "id": 0,
- "name": "string",
- "profileList": [
- 0
]
}
Delete an existing SNI group from this system.
User must have the sni-group:delete
capability to perform this action.
id required | integer |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new H.248 profile profile in SBCE
User must have the h248-profile:create
capability to perform this action.
H.248 Profile object that needs to be added in SBCE.
profileName | string <= 32 |
Array of objects (PostH248ProfileAddress) |
{- "profileName": "H248-profile-1",
- "profileAddresses": [
- {
- "ipAddress": "1.1.1.1",
- "type": "SNMP"
}
]
}
{- "resourcePath": "/api/config/v1/h248-profiles/1",
- "profileId": 1,
- "profileName": "H248-profile-1",
- "profileAddresses": [
- {
- "addressId": 10,
- "ipAddress": "1.1.1.1",
- "type": "SNMP"
}
]
}
Get all H.248 profiles
User must have the h248-profile:read
capability to perform this action.
[- {
- "profileId": 1,
- "profileName": "H248-profile-1",
- "profileAddresses": [
- {
- "addressId": 10,
- "ipAddress": "1.1.1.1",
- "type": "SNMP"
}
]
}
]
Get the H.248 profile for given ID
User must have the h248-profile:read
capability to perform this action.
profileId required | integer ID of the Profile |
{- "profileId": 1,
- "profileName": "H248-profile-1",
- "profileAddresses": [
- {
- "addressId": 10,
- "ipAddress": "1.1.1.1",
- "type": "SNMP"
}
]
}
Delete the H.248 profile for given ID
User must have the h248-profile:delete
capability to perform this action.
profileId required | integer ID of the Profile |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new H.248 profile address to H.248 profile with profileId in SBCE.
User must have the h248-profile:update
capability to perform this action.
profileId required | integer ID of the H.248 Profile |
H.248 profile address object that needs to be added to H.248 Profile in SBCE.
ipAddress | string |
type | string Value: "SNMP" |
{- "ipAddress": "1.1.1.1",
- "type": "SNMP"
}
{- "resourcePath": "/api/config/v1/h248-profiles/1/profile-addresses/10",
- "addressId": 10,
- "ipAddress": "1.1.1.1",
- "type": "SNMP"
}
Get the H.248 profile addresses associated to H.248 profile for given ID
User must have the h248-profile:read
capability to perform this action.
profileId required | integer ID of the profile |
[- {
- "addressId": 10,
- "ipAddress": "1.1.1.1",
- "type": "SNMP"
}
]
Edit H.248 profile address associated to H.248 profile in SBCE
User must have the h248-profile:update
capability to perform this action.
profileId required | integer ID of H.248 Profile |
addressId required | integer ID of the profile address |
H.248 profile address object that needs to be edited for H.248 profile in SBCE.
ipAddress | string |
type | string Value: "SNMP" |
{- "ipAddress": "1.1.1.1",
- "type": "SNMP"
}
{- "addressId": 10,
- "ipAddress": "1.1.1.1",
- "type": "SNMP"
}
Delete the H.248 profile address associated to H.248 profile for given ID.
H.248 Relay
.User must have the h248-profile:update
capability to perform this action.
profileId required | integer ID of the Profile |
addressId required | integer ID of the profile address |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new H.248 Server profile in SBCE
User must have the h248-server:create
capability to perform this action.
H.248 Server object that needs to be added in SBCE.
serverName | string <= 32 characters |
serverType | string Enum: "MEDIA_GATEWAY" "MEDIA_GATEWAY_CONTROLLER" |
ipAddress | string This is allowed when server type is 'MEDIA_GATEWAY_CONTROLLER' |
serialId | string = 12 characters This is allowed when server type is 'MEDIA_GATEWAY' |
{- "serverName": "H248-server-1",
- "serverType": "MEDIA_GATEWAY",
- "ipAddress": "1.1.1.1",
- "serialId": "azdvdsdvaswd"
}
{- "resourcePath": "/api/config/v1/h248-servers/1",
- "serverName": "H248-server-1",
- "serverType": "MEDIA_GATEWAY",
- "ipAddress": "1.1.1.1",
- "serialId": "azdvdsdvaswd",
- "serverId": 1
}
Get all H.248 Servers.
User must have the h248-server:read
capability to perform this action.
[- {
- "serverName": "H248-server-1",
- "serverType": "MEDIA_GATEWAY",
- "ipAddress": "1.1.1.1",
- "serialId": "azdvdsdvaswd",
- "serverId": 1
}
]
Edit H.248 Server in SBCE.
User must have the h248-server:update
capability to perform this action.
serverId required | integer ID of the H.248 Server. |
H.248 Server object that needs to be edited.
serverName | string <= 32 characters |
serverType | string Enum: "MEDIA_GATEWAY" "MEDIA_GATEWAY_CONTROLLER" |
ipAddress | string This is allowed when server type is 'MEDIA_GATEWAY_CONTROLLER' |
serialId | string = 12 characters This is allowed when server type is 'MEDIA_GATEWAY' |
{- "serverName": "H248-server-1",
- "serverType": "MEDIA_GATEWAY",
- "ipAddress": "1.1.1.1",
- "serialId": "azdvdsdvaswd"
}
{- "serverName": "H248-server-1",
- "serverType": "MEDIA_GATEWAY",
- "ipAddress": "1.1.1.1",
- "serialId": "azdvdsdvaswd",
- "serverId": 1
}
Get the H.248 Server for given ID
User must have the h248-server:read
capability to perform this action.
serverId required | integer ID of the H.248 Server. |
{- "serverName": "H248-server-1",
- "serverType": "MEDIA_GATEWAY",
- "ipAddress": "1.1.1.1",
- "serialId": "azdvdsdvaswd",
- "serverId": 1
}
Delete the H.248 Server for given ID
H.248 Relay
.User must have the h248-server:delete
capability to perform this action.
serverId required | integer ID of the H.248 Server |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Add new H.248 Relay in SBCE.
User must have the h248-relay:create
capability to perform this action.
H.248 Relay object that should to be added to the SBCE.
relayName | string <= 32 |
listenIpId | integer This value must be a valid reference to a valid IP address. |
listenPort | integer |
listenTransport | string Enum: "TCP" "UDP" "TLS" |
listenTlsProfileId | integer Default: 0 This value must be a valid reference to a Tls server profile when the |
connectIpId | integer This value must be a valid reference to a valid IP address. |
connectPort | integer |
connectTransport | string Enum: "TCP" "UDP" "TLS" |
connectTlsProfileId | integer Default: 0 This value must be a valid reference to a Tls client profile when the |
mediaGatewayId | integer This value must be a valid reference to a H248 server with server type is |
mediaGatewayControllerId | integer This value must be a valid reference to a H248 server with server type is |
listenMediaInterfaceId | integer This value must be valid reference to the Media Interface. |
connectMediaInterfaceId | integer This value must be valid reference to the Media Interface. |
h248ProfileId | integer This value must be valid reference to the H248 Profile. |
{- "relayName": "H248-relay-1",
- "listenIpId": 1,
- "listenPort": 1111,
- "listenTransport": "TCP",
- "listenTlsProfileId": 0,
- "connectIpId": 2,
- "connectPort": 1111,
- "connectTransport": "TCP",
- "connectTlsProfileId": 0,
- "mediaGatewayId": 1,
- "mediaGatewayControllerId": 2,
- "listenMediaInterfaceId": 1,
- "connectMediaInterfaceId": 2,
- "h248ProfileId": 1
}
{- "resourcePath": "/api/config/v1/h248-relay/1",
- "relayId": 1,
- "relayName": "H248-relay-1",
- "listenIpId": 1,
- "listenPort": 1111,
- "listenTransport": "TCP",
- "listenTlsProfileId": 0,
- "connectIpId": 2,
- "connectPort": 1111,
- "connectTransport": "TCP",
- "connectTlsProfileId": 0,
- "mediaGatewayId": 1,
- "mediaGatewayControllerId": 2,
- "listenMediaInterfaceId": 1,
- "connectMediaInterfaceId": 2,
- "h248ProfileId": 1
}
Get all H.248 Relays.
User must have the h248-relay:read
capability to perform this action.
[- {
- "relayId": 1,
- "relayName": "H248-relay-1",
- "listenIpId": 1,
- "listenPort": 1111,
- "listenTransport": "TCP",
- "listenTlsProfileId": 0,
- "connectIpId": 2,
- "connectPort": 1111,
- "connectTransport": "TCP",
- "connectTlsProfileId": 0,
- "mediaGatewayId": 1,
- "mediaGatewayControllerId": 2,
- "listenMediaInterfaceId": 1,
- "connectMediaInterfaceId": 2,
- "h248ProfileId": 1
}
]
Edit H.248 Relay in SBCE.
User must have the h248-relay:update
capability to perform this action.
relayId required | integer ID of the H.248 relay. |
H.248 relay object that needs to be edited.
relayName | string <= 32 |
listenIpId | integer This value must be a valid reference to a valid IP address. |
listenPort | integer |
listenTransport | string Enum: "TCP" "UDP" "TLS" |
listenTlsProfileId | integer Default: 0 This value must be a valid reference to a Tls server profile when the |
connectIpId | integer This value must be a valid reference to a valid IP address. |
connectPort | integer |
connectTransport | string Enum: "TCP" "UDP" "TLS" |
connectTlsProfileId | integer Default: 0 This value must be a valid reference to a Tls client profile when the |
mediaGatewayId | integer This value must be a valid reference to a H248 server with server type is |
mediaGatewayControllerId | integer This value must be a valid reference to a H248 server with server type is |
listenMediaInterfaceId | integer This value must be valid reference to the Media Interface. |
connectMediaInterfaceId | integer This value must be valid reference to the Media Interface. |
h248ProfileId | integer This value must be valid reference to the H248 Profile. |
{- "relayName": "H248-relay-1",
- "listenIpId": 1,
- "listenPort": 1111,
- "listenTransport": "TCP",
- "listenTlsProfileId": 0,
- "connectIpId": 2,
- "connectPort": 1111,
- "connectTransport": "TCP",
- "connectTlsProfileId": 0,
- "mediaGatewayId": 1,
- "mediaGatewayControllerId": 2,
- "listenMediaInterfaceId": 1,
- "connectMediaInterfaceId": 2,
- "h248ProfileId": 1
}
{- "relayId": 1,
- "relayName": "H248-relay-1",
- "listenIpId": 1,
- "listenPort": 1111,
- "listenTransport": "TCP",
- "listenTlsProfileId": 0,
- "connectIpId": 2,
- "connectPort": 1111,
- "connectTransport": "TCP",
- "connectTlsProfileId": 0,
- "mediaGatewayId": 1,
- "mediaGatewayControllerId": 2,
- "listenMediaInterfaceId": 1,
- "connectMediaInterfaceId": 2,
- "h248ProfileId": 1
}
Get the H.248 Relay for given ID
User must have the h248-relay:read
capability to perform this action.
relayId required | integer ID of the H.248 Relay. |
{- "relayId": 1,
- "relayName": "H248-relay-1",
- "listenIpId": 1,
- "listenPort": 1111,
- "listenTransport": "TCP",
- "listenTlsProfileId": 0,
- "connectIpId": 2,
- "connectPort": 1111,
- "connectTransport": "TCP",
- "connectTlsProfileId": 0,
- "mediaGatewayId": 1,
- "mediaGatewayControllerId": 2,
- "listenMediaInterfaceId": 1,
- "connectMediaInterfaceId": 2,
- "h248ProfileId": 1
}
Delete the H.248 Relay for given ID
User must have the h248-relay:delete
capability to perform this action.
relayId required | integer ID of the H.248 Relay. |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Retrieve all IP / URI Blocklist entries from this system.
User must have the ip-uri-blocklist:read
capability to perform this action.
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "uri": "string",
- "address": "string",
- "blockTime": "string",
- "expireTime": "string"
}
]
Add a new IP / URI Blocklist entry to this system.
User must have the ip-uri-blocklist:create
capability to perform this action.
address required | string <IP> An IPv4 address, IPv4 CIDR address, IPv6 address, or IPv6 CIDR address to block. |
durationInMinutes | integer The block duration, in minutes. If unspecified, the block will be permanent. |
{- "address": "10.0.0.1",
- "durationInMinutes": 1440
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "uri": "string",
- "address": "string",
- "blockTime": "string",
- "expireTime": "string",
- "resourcePath": "/api/config/v1/ip-uri-blocklist/00000000-0000-0000-0000-000000000000"
}
Get an existing IP / URI Blocklist entry from this system.
User must have the ip-uri-blocklist:read
capability to perform this action.
uuid required | string <uuid> |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "uri": "string",
- "address": "string",
- "blockTime": "string",
- "expireTime": "string"
}
Delete an existing IP / URI Blocklist entry from this system.
User must have the ip-uri-blocklist:delete
capability to perform this action.
uuid required | string <uuid> |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Get all IP / URI Blocklist profiles from this system.
User must have the ip-uri-blocklist-profile:read
capability to perform this action.
[- {
- "name": "string",
- "ipUsernameBlockThreshold": 0,
- "ipPasswordBlockThreshold": 0,
- "uriUsernameBlockThreshold": 0,
- "uriPasswordBlockThreshold": 0,
- "blockTimer": 0,
- "id": 0
}
]
Add a new IP / URI Blocklist profile to this system.
User must have the ip-uri-blocklist-profile:create
capability to perform this action.
name | string |
ipUsernameBlockThreshold | integer |
ipPasswordBlockThreshold | integer |
uriUsernameBlockThreshold | integer |
uriPasswordBlockThreshold | integer |
blockTimer | integer |
{- "name": "string",
- "ipUsernameBlockThreshold": 0,
- "ipPasswordBlockThreshold": 0,
- "uriUsernameBlockThreshold": 0,
- "uriPasswordBlockThreshold": 0,
- "blockTimer": 0
}
{- "name": "string",
- "ipUsernameBlockThreshold": 0,
- "ipPasswordBlockThreshold": 0,
- "uriUsernameBlockThreshold": 0,
- "uriPasswordBlockThreshold": 0,
- "blockTimer": 0,
- "id": 0,
- "resourcePath": "/api/config/v1/ip-uri-blocklist-profiles/1"
}
Get a specific IP / URI Blocklist profile from this system.
User must have the ip-uri-blocklist-profile:read
capability to perform this action.
id required | integer |
{- "name": "string",
- "ipUsernameBlockThreshold": 0,
- "ipPasswordBlockThreshold": 0,
- "uriUsernameBlockThreshold": 0,
- "uriPasswordBlockThreshold": 0,
- "blockTimer": 0,
- "id": 0
}
Modify an existing IP / URI Blocklist profile on this system.
User must have the ip-uri-blocklist-profile:update
capability to perform this action.
id required | number |
name | string |
ipUsernameBlockThreshold | integer |
ipPasswordBlockThreshold | integer |
uriUsernameBlockThreshold | integer |
uriPasswordBlockThreshold | integer |
blockTimer | integer |
{- "name": "string",
- "ipUsernameBlockThreshold": 0,
- "ipPasswordBlockThreshold": 0,
- "uriUsernameBlockThreshold": 0,
- "uriPasswordBlockThreshold": 0,
- "blockTimer": 0
}
{- "name": "string",
- "ipUsernameBlockThreshold": 0,
- "ipPasswordBlockThreshold": 0,
- "uriUsernameBlockThreshold": 0,
- "uriPasswordBlockThreshold": 0,
- "blockTimer": 0,
- "id": 0
}
Delete an existing IP / URI Blocklist profile from this system.
User must have the ip-uri-blocklist-profile:delete
capability to perform this action.
id required | integer |
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Show the status of all configurable optional features on this system.
User must have the feature-control:read
capability to perform this action.
{- "transrating": true,
- "mediaTunneling": true,
- "transcoding": true,
- "amsOffloading": true
}
Toggle the status of any configurable optional features on this system.
User must have the feature-control:update
capability to perform this action.
transrating | boolean |
mediaTunneling | boolean |
transcoding | boolean |
amsOffloading | boolean |
{- "transrating": true,
- "mediaTunneling": true,
- "transcoding": true,
- "amsOffloading": true
}
{- "transrating": true,
- "mediaTunneling": true,
- "transcoding": true,
- "amsOffloading": true
}