Description

Retrieve countries and regions.

Request Specification

Method: POST + application/json

Endpoint: https://${Cloud Domain}/cgi/crm/countryAreaOptions/get?thirdTraceId=${Random String}

Headers: Refer to Common Parameters

Request Parameters

Parameter	Type	Required	Description
isIncludeDeleted	Boolean	Yes	Whether to include deleted provinces/cities/districts. Default true (include), false (exclude)
locale	String	No	Language: zh_CN (Simplified Chinese), zh_TW (Traditional Chinese), en (English)

Request Example

{
  "isIncludeDeleted": true,
  "locale": "zh_CN"
}

Response Parameters

Parameter	Type	Description
traceId	string	Unique request ID
errorDescription	string	Error description
errorMessage	string	Error message
errorCode	Int	Error codes reference

Response Example

{
  "traceId": "E-O.827xxxxxx",
  "errorDescription": "success",
  "errorMessage": "OK",
  "errorCode": 0,
  "countryAreaOptions": {
    "country": {
      "is_index": false,
      "is_need_convert": false,
      "is_required": false,
      "api_name": "country",
      "options": [
        {
          "child_options": [
            {
              "province": [
                "249",
                "250",
                "251"
              ]
            }
          ],
          "label": "China",
          "value": "248"
        },
        {
          "label": "Albania",
          "value": "0"
        },
        {
          "label": "Algeria",
          "value": "1"
        },
        {
          "label": "Afghanistan",
          "value": "2"
        }
      ]
    }
  }
}

Notes

• Do not use the message field in the response for logical judgments as errorMessage may change;