Querying Verified Lists

Updated on 2025-02-10 GMT+08:00

View PDF

Function

Query verified lists.

URI

GET /v2/servicerequest/verifycodes/has-verified

**Table 1** Query parameters
Parameter	Mandatory	Type	Description
contact_way	No	Integer	Indicates the contact method type. Minimum value: 0 Maximum value: 1
customer_id	No	String	Specifies the customer ID. Minimum length: 0 Maximum length: 64
sub_customer_id	No	String	Specifies the sub-user ID. Minimum length: 0 Maximum length: 64
expired_time	No	String	Indicates the expiration time. Minimum length: 0 Maximum length: 32
verified_id	No	String	Indicates the verification serial number. Minimum length: 0 Maximum length: 64
contact_value	No	String	Indicates the contact method value. Minimum length: 0 Maximum length: 256
area_code	No	String	Specifies the country/region code. Minimum length: 0 Maximum length: 16
offset	No	Integer	Specifies the query offset. Minimum value: 0 Maximum value: 65535 Default value: 1
limit	No	Integer	Specifies the number of records to be queried. Minimum value: 0 Maximum value: 100 Default value: 10

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
count	Integer	Specifies the total number. Minimum value: 0 Maximum value: 65535
contact_list	Array of ContactV2 objects	Specifies the contact method list.

**Table 4** ContactV2
Parameter	Type	Description
contact_way	Integer	Indicates the contact method type. Minimum value: 0 Maximum value: 1
contact_value	String	Indicates the contact method value. Minimum length: 0 Maximum length: 256
area_code	String	Specifies the country/region code. Minimum length: 1 Maximum length: 16
verified_id	String	Indicates the verification serial number. Minimum length: 1 Maximum length: 64

Request Example

None

Example Response

Status code: 200

Response of status code 200

{
  "count" : 1,
  "contact_list" : [ {
    "contact_way" : 0,
    "contact_value" : "test",
    "area_code" : "86",
    "verified_id" : "test"
  } ]
}