![]() |
Openscape Voice V10 - SOAP Interface Documentation
|
Domain Code Definitions and Methods. More...
Classes | |
| struct | unsp__DomainCodeIdentification |
| Domain Code Identification. More... | |
| struct | unsp__DomainCodeData |
| Domain Code Data. More... | |
| struct | unsp__CreateDomainCodeRequest |
| Create Domain Code request. More... | |
| struct | unsp__CreateDomainCodeResult |
| Create Domain Code result. More... | |
| struct | unsp__ModifyDomainCodeRequest |
| Modify Domain Code request. More... | |
| struct | unsp__ModifyDomainCodeResult |
| Modify Domain Code result. More... | |
| struct | unsp__DeleteDomainCodeRequest |
| Delete Domain Code request. More... | |
| struct | unsp__DeleteDomainCodeResult |
| Delete Domain Code result. More... | |
| struct | unsp__DomainCodeInfo |
| Domain Code Information. More... | |
| struct | unsp__DomainCodeList |
| Domain Code List. More... | |
| struct | unsp__QueryDomainCodeRequest |
| Query Domain Code request. More... | |
| struct | unsp__QueryDomainCodeResult |
| Query Domain Code result. More... | |
| struct | unsp__QueryResponsibleDomainsRequest |
| Query Responsible Domains request. More... | |
| struct | unsp__ResponsibleDomain |
| Responsible Domain. More... | |
| struct | unsp__ResponsibleDomainsList |
| Responsible Domains List. More... | |
| struct | unsp__QueryResponsibleDomainsResult |
| Query Responsible Domains result. More... | |
Enumerations | |
| enum | unsp__DomainCodePrefixType { DCPrefixTypeOnNetAccess, DCPrefixTypeOffNetAccess } |
| Domain Code Prefix Type. More... | |
| enum | unsp__DomainCodeRedirectTo { DCRedirectToNone, DCRedirectToCommonNP, DCRedirectToGlobalNP } |
| Indicates whether the Domain Code supports delegating the translation from a BG's private numbering plan to the BG's common numbering plan or the global numbering plan. More... | |
| enum | unsp__DomainCodeDestinationType { DCDestTypeNone, DCDestTypeDestination, DCDestTypeIntercept, DCDestTypeRestrictedCode, DCDestTypeFallbackToLocalNP } |
| Domain Code Destination Type. More... | |
| enum | unsp__ResponsibleDomainType { RespDomainTypeIP, RespDomainTypeIPv6, RespDomainTypeFQDN, RespDomainTypeDNSSrv } |
| Responsible Domain Type. More... | |
Functions | |
| int | unsp__CreateDomainCode (struct unsp__CreateDomainCodeRequest CreateDomainCodeRequest, struct unsp__CreateDomainCodeResult *CreateDomainCodeResult) |
| This method creates a Domain Code. More... | |
| int | unsp__ModifyDomainCode (struct unsp__ModifyDomainCodeRequest ModifyDomainCodeRequest, struct unsp__ModifyDomainCodeResult *ModifyDomainCodeResult) |
| This method modifies a Domain Code. More... | |
| int | unsp__DeleteDomainCode (struct unsp__DeleteDomainCodeRequest DeleteDomainCodeRequest, struct unsp__DeleteDomainCodeResult *DeleteDomainCodeResult) |
| This method deletes a Domain Code. More... | |
| int | unsp__QueryDomainCode (struct unsp__QueryDomainCodeRequest QueryDomainCodeRequest, struct unsp__QueryDomainCodeResult *QueryDomainCodeResult) |
| This method retreives the list of Domain Codes. More... | |
| int | unsp__QueryResponsibleDomains (struct unsp__QueryResponsibleDomainsRequest QueryResponsibleDomainsRequest, struct unsp__QueryResponsibleDomainsResult *QueryResponsibleDomainsResult) |
| This method retrieves the list of the domains that Openscape Voice is configured to be responsible for. More... | |
Domain Code Definitions and Methods.
Domain Codes allow an administrator to link a code (alphanumeric SIP URI, domain name or partial domain name) with a Destination, an Intercept, an Invalid Code or Fallback to Local Numbering Plan. Configuring Fallback to Local Numbering Plan allows an administrator to purposely fail translation in the common or global numbering plan in order to invoke the fallback destination of a private numbering plan domain code. The Domain Codes are supported by the BG private numbering plans, the BG common numbering plans and the global numbering plan.
Allowed codes within the Domain Code table are:
Hostnames, IPv4 Addresses or IPv6 Addresses/References of codes entered by the administrator are always normalized prior to storage in shared memory. It is not allowed to enter different formats of the same hostname, IPv4 address, IPv6 address/reference, routing area and class of service combination. Hostname normalization consists of converting the uppercase characters to lowercase characters. All code matches within the domain codes table are therefore case-insensitive. Any of the hostnames, addresses or alphanumeric SIP URIs may be followed by a specific port. If no port is specified then the entry applies to all 65535 ports.
Indicates whether the Domain Code supports delegating the translation from a BG's private numbering plan to the BG's common numbering plan or the global numbering plan.
| Enumerator | |
|---|---|
| DCRedirectToNone |
None. |
| DCRedirectToCommonNP |
Redirect to Common Number Plan. |
| DCRedirectToGlobalNP |
Redirect to Global Number Plan. |
| unsp__CreateDomainCode | ( | struct unsp__CreateDomainCodeRequest | CreateDomainCodeRequest, |
| struct unsp__CreateDomainCodeResult * | CreateDomainCodeResult | ||
| ) |
This method creates a Domain Code.
| CreateDomainCodeRequest | API request |
| CreateDomainCodeResult | API result |
MP2 command: CDomainCode [Attributes]
| unsp__DeleteDomainCode | ( | struct unsp__DeleteDomainCodeRequest | DeleteDomainCodeRequest, |
| struct unsp__DeleteDomainCodeResult * | DeleteDomainCodeResult | ||
| ) |
This method deletes a Domain Code.
| DeleteDomainCodeRequest | API request |
| DeleteDomainCodeResult | API result |
MP2 command: DDomainCode [Attributes]
| unsp__ModifyDomainCode | ( | struct unsp__ModifyDomainCodeRequest | ModifyDomainCodeRequest, |
| struct unsp__ModifyDomainCodeResult * | ModifyDomainCodeResult | ||
| ) |
This method modifies a Domain Code.
| ModifyDomainCodeRequest | API request |
| ModifyDomainCodeResult | API result |
MP2 command: MDomainCode [Attributes]
| unsp__QueryDomainCode | ( | struct unsp__QueryDomainCodeRequest | QueryDomainCodeRequest, |
| struct unsp__QueryDomainCodeResult * | QueryDomainCodeResult | ||
| ) |
This method retreives the list of Domain Codes.
| QueryDomainCodeRequest | API request |
| QueryDomainCodeResult | API result |
| unsp__QueryResponsibleDomains | ( | struct unsp__QueryResponsibleDomainsRequest | QueryResponsibleDomainsRequest, |
| struct unsp__QueryResponsibleDomainsResult * | QueryResponsibleDomainsResult | ||
| ) |
This method retrieves the list of the domains that Openscape Voice is configured to be responsible for.
| QueryResponsibleDomainsRequest | API request |
| QueryResponsibleDomainsResult | API result |
1.8.6