All Products
Search

This Product

    Cell Phone Number Service:GetPhoneNumberIdentificationResult

    Document Center

    Cell Phone Number Service:GetPhoneNumberIdentificationResult

    Last Updated:Apr 01, 2024

    Obtains the verification result 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.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    SessionIdstringYes

    The session ID.

    		8636b75e2fcb40c53ffecc2b5947115c.149b03d2a7494e6e8f5b34c915245815.707c7f0d93f4409db0761aa5da94ce01.1686******041
    SessionPayloadstringYes

    The session payload.

    		uQne0vsuNywXVvI4VP5taHsgDNsd3BwcbmrhjXi58WbxBGFW+e8ufMEi9j89YonphV6NZ1PIeKvboHtU1nsSjZMTcoFPfkjqaORIHdSlPb6vmIzqOnJMsP1KPQ8K1JLXSaAKsB2lQ5A9HCkX2HzDEwje14HYQsnPd/Ka2YWgXuL0N8GE9oYi25d4DdlU0XR52YjSj8GMLSgbW7yNxEPvUCOQG83FZfQqmIWG2+0C/fQ3gdG9WI7AeeHZo4IRKGtQnpjKGtZZl8VoLPNIswDqZeeyjCyZlKUXKrAt4Co9c4I4q8G1jZm53COQJ+DuTiWH7w+tois3WJwFV/HmdlAKt8SqpiVrEv47VQ9V+8FYsdKz3A3CRyBVgNj6wYKKbwaI9BdQoOkbYzzA8CfAKO5w1oYVD2nOcYS/AffbPbE31PJj7SdVvKghwPL56OVdjS9Hd0iW0SMBWD0F1iRNCUNHL3ffHcFjJLdhTrMt8VHSRn0nOlvO1ZaWqMQ0yE0q*************************kXTpoQLo0+0h+CEcf90hTg8XdMhj9B0A3SOINceLlmoZb3czvYl00+CC0075DjOX41YtnuAUfaNYPgLIZkjYyq+JopBQFAkxPUbJHC0oCzB9dQahUthWY38OPBs=
    OutIdstringYes

    The external ID.

    		149b03d2-a749-4e6e-8f5b-34******5815
    AuthCodestringYes

    The authorization code.

    		K***9i7CIe
    PhoneNumberstringYes

    The phone number of the subscriber. The phone number to be verified must be in the Mobile Station International Subscriber Directory Number (MSISDN) format.

    		628211****113

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		68A40250-50CD-034C-B728-0BD******177
    Messagestring

    The description of the return code.

    		OK
    Dataobject

    The returned data.

    IsIdentifiedstring

    Indicates whether the phone number passed the verification.

    		true
    Codestring

    The return code. Valid values:

    • OK: The request is successful.
    • NoIdentificationResult: No verification result is available or the verification failed.
    • SessionNotValid: The session is invalid or expired.
    • 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": {
    "IsIdentified": "true"
  },
  "Code": "OK"
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    No change history