Skip to content
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.

Commit

Permalink
e911, edgemanagement, sipauthentication settings api spec (#701)
Browse files Browse the repository at this point in the history 
Co-authored-by: ichesnov <[email protected]>
  • Loading branch information
@xxlaykxx
xxlaykxx and ichesnov authored Sep 7, 2022
1 parent 3464afd commit d21a04b
Showing 1 changed file with 372 additions and 0 deletions.
372 changes: 372 additions & 0 deletions site/specs-temp/numbers.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n <E911SettingsResponse>\n <E911Settings>\n <Hosts>\n <Host>\n <HostName>12.34.56.78</HostName>\n <Port>0</Port>\n </Host>\n </Hosts>\n <EVSCredentials>\n <EVSCredential>\n <EVSAccountId>1234567</EVSAccountId>\n <RouteType>STANDARD</RouteType>\n </EVSCredential>\n <EVSCredential>\n <EVSAccountId>6123619</EVSAccountId>\n <RouteType>AEUI</RouteType>\n </EVSCredential>\n </EVSCredentials>\n </E911Settings>\n </E911SettingsResponse>"
}
}
}
}
}
}
}
},
"/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": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n <EdgeManagementSettings>\n <SbcSettings>\n <TrunkGroupId>Trunkgroupidfortheaccounttraffic</TrunkGroupId>\n <NodeGroupName>East Coast 01</NodeGroupName>\n </SbcSettings>\n <SipAuthentication>\n <Enabled>true/false</Enabled>\n <Status>COMPLETE/FAILED/PROCESSING</Status>\n <Errors>\n <Error>\n <Code>26001</Code>\n <Description>TGA database is not reachable.</Description>\n </Error>\n <Error>\n <Code>27002</Code>\n <Description>Amazon route 53 is not reachable.</Description>\n </Error>\n </Errors>\n </SipAuthentication>\n <ProductSpecificAccessRestrictions>\n <AccessRestriction>\n <RestrictedProduct>Termination</RestrictedProduct>\n <RestrictedAccessTypes>\n <RestrictedAccessType>SipCredentials</RestrictedAccessType>\n </RestrictedAccessTypes>\n </AccessRestriction>\n </ProductSpecificAccessRestrictions>\n</EdgeManagementSettings>"
}
}
}
}
}
}
}
},
"/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": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<SipAuthenticationResponse>\n <SipAuthentication>\n <SBC>\n <Zone>\n <Id>1</Id>\n <Name>CUST27_10000105_ZONE</Name>\n <SipSigPort>\n <Index>1</Index>\n <PortNumber>1</PortNumber>\n </SipSigPort>\n </Zone>\n </SBC>\n <RealmDnsList>\n <RealmDns>\n <Realm>cust27.auth.bandwidth.com</Realm>\n <DefaultGroupName>10000105_27</DefaultGroupName>\n <DNSRecords>\n <DNSRecord>\n <Type>A</Type>\n <Name>cust27.auth.bandwidth.com</Name>\n <Data>235.152.100.100</Data>\n <TTL>300</TTL>\n </DNSRecord>\n <DNSRecord>\n <Type>A</Type>\n <Name>cust27.auth.bandwidth.com</Name>\n <Data>235.152.100.200</Data>\n <TTL>300</TTL>\n </DNSRecord>\n <DNSRecord>\n <Type>SRV</Type>\n <Name>_sip._udp.cust27.auth.bandwidth.com</Name>\n <Data>5 50 5000 test.host1</Data>\n <TTL>300</TTL>\n </DNSRecord>\n <DNSRecord>\n <Type>SRV</Type>\n <Name>_sip._udp.cust27.auth.bandwidth.com</Name>\n <Data>5 50 5000 test.host2</Data>\n <TTL>300</TTL>\n </DNSRecord>\n </DNSRecords>\n </RealmDns>\n </RealmDnsList>\n </SipAuthentication>\n</SipAuthenticationResponse>"
}
}
}
}
}
}
}
},
"/accounts/{accountId}/realms": {
"get": {
"tags": [
Expand Down Expand Up @@ -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": {
Expand Down

0 comments on commit d21a04b

Please sign in to comment.