From d21a04b09ccc1de67e1e8595c4c4790e87a7a0a1 Mon Sep 17 00:00:00 2001 From: Ivan Chesnov Date: Wed, 7 Sep 2022 20:56:41 +0300 Subject: [PATCH] e911, edgemanagement, sipauthentication settings api spec (#701) Co-authored-by: ichesnov --- site/specs-temp/numbers.json | 372 +++++++++++++++++++++++++++++++++++ 1 file changed, 372 insertions(+) diff --git a/site/specs-temp/numbers.json b/site/specs-temp/numbers.json index 0ff90c72f..054ade8e6 100644 --- a/site/specs-temp/numbers.json +++ b/site/specs-temp/numbers.json @@ -11851,6 +11851,102 @@ } } }, + "/accounts/{accountId}/products/e911/settings": { + "get": { + "tags": [ + "/accounts" + ], + "description": "Retrieve the current host and EVS credentials settings that are used only for e911 traffic. This includes host details, EVS account ID information (including accounts where the Dashboard ID differs from the EVS ID), and the EVS route type", + "operationId": "GetAccountE911ProductSettings", + "summary": "Retrieve e911 product settings on account", + "parameters": [ + { + "$ref": "#/components/parameters/AccountIdPathParam" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/E911SettingsResponse" + }, + "examples": { + "example": { + "value": "\n \n \n \n \n 12.34.56.78\n 0\n \n \n \n \n 1234567\n STANDARD\n \n \n 6123619\n AEUI\n \n \n \n " + } + } + } + } + } + } + } + }, + "/accounts/{accountId}/products/edgemanagement/settings": { + "get": { + "tags": [ + "/accounts" + ], + "description": "Retrieve settings that are provided as part of the Edge Management product: The SBC settings that are associated with the account, SipAuthentication that provide settings for SIP authentication and ProductSpecificAccessRestrictions that can restrict Termination traffic for sipCredendital.", + "operationId": "GetAccountEdgemanagementProductSettings", + "summary": "Retrieve edgemanagement product settings on account", + "parameters": [ + { + "$ref": "#/components/parameters/AccountIdPathParam" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/EdgeManagementSettingsResponse" + }, + "examples": { + "example": { + "value": "\n \n \n Trunkgroupidfortheaccounttraffic\n East Coast 01\n \n \n true/false\n COMPLETE/FAILED/PROCESSING\n \n \n 26001\n TGA database is not reachable.\n \n \n 27002\n Amazon route 53 is not reachable.\n \n \n \n \n \n Termination\n \n SipCredentials\n \n \n \n" + } + } + } + } + } + } + } + }, + "/accounts/{accountId}/products/edgemanagement/settings/sipauthentication": { + "get": { + "tags": [ + "/accounts" + ], + "description": "Retrieve existing SIP authentication configuration on account.", + "operationId": "GetAccountEdgemanagementProductSettingsSipauthentication", + "summary": "Retrieve sipauthentication settings on account", + "parameters": [ + { + "$ref": "#/components/parameters/AccountIdPathParam" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/SipAuthenticationResponse" + }, + "examples": { + "example": { + "value": "\n\n \n \n \n 1\n CUST27_10000105_ZONE\n \n 1\n 1\n \n \n \n \n \n cust27.auth.bandwidth.com\n 10000105_27\n \n \n A\n cust27.auth.bandwidth.com\n 235.152.100.100\n 300\n \n \n A\n cust27.auth.bandwidth.com\n 235.152.100.200\n 300\n \n \n SRV\n _sip._udp.cust27.auth.bandwidth.com\n 5 50 5000 test.host1\n 300\n \n \n SRV\n _sip._udp.cust27.auth.bandwidth.com\n 5 50 5000 test.host2\n 300\n \n \n \n \n \n" + } + } + } + } + } + } + } + }, "/accounts/{accountId}/realms": { "get": { "tags": [ @@ -32376,6 +32472,282 @@ "type": "integer" } } + }, + "E911SettingsResponse": { + "type": "object", + "properties": { + "E911Settings": { + "$ref": "#/components/schemas/E911Settings" + } + } + }, + "E911Settings": { + "type": "object", + "properties": { + "Hosts": { + "$ref": "#/components/schemas/Hosts" + }, + "EVSCredentials": { + "$ref": "#/components/schemas/EVSCredentials" + } + } + }, + "EVSCredentials": { + "type": "object", + "properties": { + "EVSCredentials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EVSCredential" + } + } + } + }, + "EVSCredential": { + "type": "object", + "properties": { + "EVSAccountId": { + "type": "integer" + }, + "RouteType": { + "type": "string" + } + } + }, + "EdgeManagementSettingsResponse": { + "type": "object", + "properties": { + "EdgeManagementSettings": { + "$ref": "#/components/schemas/EdgeManagementSettings" + } + } + }, + "EdgeManagementSettings": { + "type": "object", + "properties": { + "SbcSettings": { + "$ref": "#/components/schemas/SbcSettings" + }, + "SipAuthentication": { + "$ref": "#/components/schemas/SipAuthentication" + }, + "ProductSpecificAccessRestrictions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AccessRestriction" + } + }, + "HttpVoice": { + "$ref": "#/components/schemas/HttpVoice" + }, + "WebRtc": { + "$ref": "#/components/schemas/WebRtc" + }, + "TollFreePeeringPartner": { + "$ref": "#/components/schemas/TollFreePeeringPartner" + } + } + }, + "SbcSettings": { + "type": "object", + "properties": { + "TrunkGroupId": { + "type": "string" + }, + "NodeGroupName": { + "type": "string" + } + } + }, + "SipAuthentication": { + "type": "object", + "properties": { + "Enabled": { + "type": "boolean" + }, + "Status": { + "type": "string", + "enum": [ + "PROCESSING", + "COMPLETE", + "FAILED" + ] + }, + "Errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SipAuthError" + } + }, + "Type": { + "type": "string", + "enum": [ + "BRIDGE", + "REGISTRAR" + ] + } + } + }, + "SipAuthError": { + "type": "object", + "properties": { + "Code": { + "type": "integer" + }, + "Description": { + "type": "string" + } + } + }, + "AccessRestriction": { + "type": "object", + "properties": { + "RestrictedProduct": { + "type": "string" + }, + "RestrictedAccessTypes": { + "type": "array", + "items": { + "RestrictedAccessType": { + "type": "string" + } + } + } + } + }, + "HttpVoice": { + "type": "object", + "properties": { + "Enabled": { + "type": "boolean" + }, + "CallAdmissionControlSettings": { + "$ref": "#/components/schemas/CallAdmissionControlSettings" + } + } + }, + "CallAdmissionControlSettings": { + "type": "object", + "properties": { + "CPS": { + "type": "integer" + }, + "ConcurrentCalls": { + "type": "integer" + }, + "OutboundCallsDequeuedPerSecond": { + "type": "integer" + } + } + }, + "WebRtc": { + "type": "object", + "properties": { + "Enabled": { + "type": "boolean" + } + } + }, + "TollFreePeeringPartner": { + "type": "object", + "properties": { + "Enabled": { + "type": "boolean" + } + } + }, + "SipAuthenticationResponse": { + "type": "object", + "properties": { + "SipAuthentication": { + "$ref": "#/components/schemas/SipAuthSettings" + } + } + }, + "SipAuthSettings": { + "type": "object", + "properties": { + "SBC": { + "$ref": "#/components/schemas/SipAuthSbc" + }, + "RealmDnsList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RealmDns" + } + } + } + }, + "SipAuthSbc": { + "type": "object", + "properties": { + "Zone": { + "$ref": "#/components/schemas/Zone" + } + } + }, + "Zone": { + "type": "object", + "properties": { + "Id": { + "type": "integer" + }, + "Name": { + "type": "string" + }, + "SipSigPort": { + "$ref": "#/components/schemas/SipSigPort" + } + } + }, + "SipSigPort": { + "type": "object", + "properties": { + "Index": { + "type": "integer" + }, + "PortNumber": { + "type": "integer" + } + } + }, + "RealmDns": { + "type": "object", + "properties": { + "Realm": { + "type": "string" + }, + "DefaultGroupName": { + "type": "string" + }, + "DNSRecords": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DNSRecord" + } + } + } + }, + "DNSRecord": { + "type": "object", + "properties": { + "Type": { + "type": "string", + "enum": [ + "A", + "SRV" + ] + }, + "Name": { + "type": "string" + }, + "Data": { + "type": "string" + }, + "TTL": { + "type": "integer" + } + } } }, "parameters": {