Updated on 2022-10-13 GMT+08:00

Checking Whether Verification Is Required

Function

Check whether verification is required.

URI

GET /v2/servicerequest/verifycodes/need-verify

Table 1 Query parameters

Parameter

Mandatory

Type

Description

contact_value

Yes

String

Indicates the contact method value.

Minimum length: 1

Maximum length: 64

contact_way

Yes

Integer

Indicates the contact method type.

Minimum value: 0

Maximum value: 1

area_code

No

String

Specifies the country/region code.

Minimum length: 0

Maximum length: 16

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum length: 1

Maximum length: 5000

X-Language

No

String

Specifies the language environment. The value is a common language description character string, for example, zh-cn. It is zh-cn by default.

Some internationalization information, such as the service ticket type and name, is displayed based on the language environment.

Minimum length: 1

Maximum length: 32

X-Time-Zone

No

String

Specifies the time zone. The value is a common time zone description character string, for example, GMT+8. It is GMT+8 by default.

Time-related data is processed based on the time zone of the environment.

Minimum length: 1

Maximum length: 32

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

need_verify_code

Integer

Indicates whether verification is required.

Minimum value: 0

Maximum value: 1

expire_time

String

Indicates the expiration time.

Minimum length: 1

Maximum length: 32

Request Example

None

Example Response

Status code: 200

Response of status code 200

{
  "need_verify_code" : 1,
  "expire_time" : "test"
}

Status Codes

Status Code

Description

200

Response of status code 200

Error Codes

See Error Codes.