SearchVerification - Query verification results - Phone Number Verification Service

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dypns:SearchVerification

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ServiceSid	string	No	The ServiceID configured in the console.	FA00000000000001
To	string	No	The phone number that receives the SMS message. Format: country code + phone number.	6212345****01
Code	string	No	The verification code.	1234
VerificationId	string	No	The unique verification ID returned by the send verification code operation.	rJXlaR2q5LpKfREtpRPMBfDVQvELZwmBbK5yVR7gr3nLbNAcolLGPYCJaVHt/i+I
SendDate	integer	No	The date when the SMS message was sent, in millisecond-precision timestamp format. You can query records from the last 30 days.	1677600000000,
PageSize	integer	No	The page size.	10
CurrentPage	integer	No	The current page number. The value starts from 1.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. A unique identifier generated by Alibaba Cloud for the request.	HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62
Message	string	The description.	OK
Model	object	The data of the request result.	{ "records": [ { "sendDate":, "channel": "", "serviceSid": "", "to": "", "updatedDate":, "verificationId": "", "status": "" } ], "pageNo": , "totalPage": 1, "pageSize": 20, "totalCount": 1, }
Code	string	The response code.	OK
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true

Examples

Success response

JSON format

{
  "RequestId": "HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62\n",
  "Message": "OK",
  "Model": {
    "test": "test",
    "test2": 1
  },
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.