Bind a mobile phone number

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on the https://api-explorer.genauth.ai V3 API, and is consistent with the API parameters and return results. If the document description is incorrect, please refer to the V3 API.

If the user has not yet bound a mobile phone number, this interface can be used for the user to self-bind a mobile phone number. If the user has already bound a mobile phone number and wants to modify the mobile phone number, please use the Modify mobile phone number interface. You need to call the Send SMS interface to send the SMS verification code first.

Method name

AuthenticationClient.bindPhone

Request parameters

Name	Type	Required	Default value	Description	Sample value
passCode	string	Yes	-	SMS verification code. Note that a SMS verification code can only be used once and has an expiration date.	123456
phoneNumber	string	Yes	-	Mobile number without area code. If it is a foreign mobile number, please specify the area code in the phoneCountryCode parameter.	188xxxx8888
phoneCountryCode	string	No	-	Mobile phone area code. This field is optional for mainland China mobile phone numbers. The GenAuth SMS service does not yet support international mobile phone numbers. You need to configure the corresponding international SMS service in the GenAuth console. For a complete list of mobile phone area codes, please refer to https://en.wikipedia.org/wiki/List_of_country_calling_codes.	+86

Sample code

import { AuthenticationClient, Models } from "authing-node-sdk";

const authenticationClient = new AuthenticationClient({
  // Need to be replaced with your GenAuth AppId, Secret and Host
  appId: "GEN_AUTH_APP_ID",
  appSecret: "GEN_AUTH_APP_SECRET",
  appHost: "GEN_AUTH_APP_HOST",
});

(async () => {
  // Please call the login interface to get access_token first, and call the setAccessToken method to set access_token
  authenticationClient.setAccessToken("REPLACE_ME_WITH_REAL_ACCESS_TOKEN");

  const result = await authenticationClient.bindPhone({
    phoneNumber: "188xxxx8888",
    passCode: "123456",
    phoneCountryCode: "+86",
  });

  console.log(JSON.stringify(result, null, 2));
})();

Request response

Type: CommonResponseDto

Name	Type	Description
statusCode	number	Business status code, which can be used to determine whether the operation is successful. 200 means success.
message	string	Description
apiCode	number	Segmented error code, which can be used to get the specific error type (successful request does not return). For a detailed list of error codes, see: API Code List
requestId	string	Request ID. Returned when the request fails.

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c"
}

Data structure