Get Tone Region List (Platform-Level)

Retrieve the tone region list available when creating or editing tenants at the platform level.

Request URL

GET {base_url}/uc-tenant/api/v1/tone-region

Request parameters

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

Format: Bearer {access_token}.

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 Array<Tone_Region> The list of all tone regions.
Tone_Region
Parameter Type Description
code String The identifier of the tone region.
name String The display name of the tone region.

Example

Request example

GET /uc-tenant/api/v1/tone-region HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MDY4ODkzMSwiaWF0IjoxNzkwNjY3MzMxLCJqdGkiOiJiOTNlNTU3MC00ZmFiLTQ2ZGYtYTUwNi1jMmJkMGEzYjNjMmYiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.0yI_AGvYv443s_inqLFA3mEnCG7_2acIE3ELkczpg4OoMYSL7jzlmHh3YkP-HXa6vNzsz0O2Y_jtFawZZ34fRyofyYQ2siauKPWC1bpp8fv4VBOB9h1MNbNMCGH0ZSVDcBHaUo_MJJhWGCH0Na-KE287Gjiz-Q22IOGy6ouCYqA8ArAFQ8ZdbD1e3P4-pGHqEJi8U0GjcECPe8HaJZ7b97BcwzpXI9xCAR-1LOXeYv0dYsnnVCsL3C1cOP9QGIozgPTbotMuk_NNrpuGFlkDeRD67vudzUv30485MEvoybuzMgfsIsj5bRL2GbT-DF7Eubs_KYcdxziXSroFgMsEXQ

Response example

HTTP/1.1 200 OK
{
  "result": [
    {
      "code": "us",
      "name": "United States/North America"
    },
    {
      "code": "us-old",
      "name": "United States Circa 1950 / North America"
    },
    {
      "code": "ar",
      "name": "Argentina"
    },
    {
      "code": "au",
      "name": "Australia"
    }
  ],
  "requestId": "772b59d44e246ecebf0ffe3acaf61779",
  "code": "200",
  "message": "SUCCESS"
}