Resolve the Effective Domain

Resolves the effective domain of an account in a specified region. This interface is designed for service-to-service calls.

Request URL

POST {base_url}/uc-user/rpc/v1/domains/effective-resolve

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code No String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Body parameters
Parameter Required Type Description
ownerUcId Yes String The UC ID of the domain owner. You can obtain the ID using the Get the Current User interface.
parentUcId No String The UC ID of the parent administrator. This parameter is required in a reseller scenario.
regionCode Yes String The code of the region where the domain is resolved. You can obtain the code using the Get Available Regions interface.
endpointTypes Yes Array<String>

The types of endpoints to resolve.

Valid value:

  • WEB
  • API
  • SIP
  • ACCOUNT

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Effective_Domain_Response> The resolved effective domain.
Effective_Domain_Response
Parameter Type Description
regionCode String The region code of the resolved domain.
baseDomain String The base domain name, such as example.com.
source String

The source of the effective domain.

  • SELF: The domain of the account itself. (inferred)
  • PARENT: The domain inherited from the parent administrator. (inferred)
  • OFFICIAL: The official domain of the region. (inferred)
effective Boolean

Whether the domain is effective.

  • true: The domain is effective.
  • false: The domain is not effective.
endpoints Object The endpoint mapping. The key is the endpoint type (WEB, API, SIP, ACCOUNT), and the value is the full domain name of the endpoint.