GetPhoneNumberIdentificationUrl - Cell Phone Number Service

Obtains the verification URL of your phone number.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Ip	string	Yes	The IP address of the subscriber's phone.	114.124.***.13
PhoneNumber	string	Yes	The phone number of the subscriber. The phone number is in the Mobile Station International Subscriber Directory Number (MSISDN) format.	628211****113
OutId	string	Yes	The external ID.	149b03d2-a749-4e6e-8f5b-34******5815
AuthCode	string	Yes	The authorization code.	K***9i7CIe
RememberPhoneNumber	boolean	No	Specifies whether to remember the phone number.	true

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	68A40250-50CD-034C-B728-0BD******177
Message	string	The description of the return code.	OK
Data	object	The returned data.
IdentificationUrl	string	The verification URL.	https://global-ip-auth.dycpaas.com/global/biz/ip_auth/start?ipa_s_c_c=IPF0000000000000****&ipa_s_i=8636b75e2fcb40c53ffecc2b59****
SessionId	string	The session ID.	8636b75e2fcb40c53ffecc2b5947115c.149b03d2a7494e6e8f5b34c915245815.707c7f0d93f4409db0761aa5da94ce01.1686******041
Code	string	The return code. Valid values: OK: The request is successful. IdentificationNotAvailable: The verification system does not support the phone number that corresponds to the IP address. MobileNumberIllegal: The format of the phone number is invalid.	OK

Examples

Sample success responses

JSONformat

{
  "RequestId": "68A40250-50CD-034C-B728-0BD******177",
  "Message": "OK",
  "Data": {
    "IdentificationUrl": "https://global-ip-auth.dycpaas.com/global/biz/ip_auth/start?ipa_s_c_c=IPF0000000000000******&ipa_s_i=8636b75e2fcb40c53ffecc2b59******",
    "SessionId": "8636b75e2fcb40c53ffecc2b5947115c.149b03d2a7494e6e8f5b34c915245815.707c7f0d93f4409db0761aa5da94ce01.1686******041"
  },
  "Code": "OK"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2024-03-12

The internal configuration of the API is changed, but the call is not affected

see changesets

Change item	Change content
	The internal configuration of the API is changed, but the call is not affected.