Phone number registration and synchronization

Prerequisites

Before you register and synchronize phone numbers, you must complete the embedded registration process and associate the ID of your WhatsApp Business Account (WABA) with your Product ID (PID).

Procedure

Synchronize phone number information - ChatappSyncPhoneNumber

Synchronizes information for all phone numbers attached to the specified WABA.

API reference

Synchronize phone number information

Example

Sample success response (JSON format):

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A948664****",
  "Code": "OK",
  "Message": "None",
  "PhoneNumbers": [
    {
      "UpQueue": "alicom-09399200-queue",
      "PhoneNumber": "8613800001234",
      "StatusQueue": "alicom-09399200-queue",
      "VerifiedName": "Alibaba",
      "StatusCallbackUrl": "https://www.alibaba.com/status",
      "UpCallbackUrl": "https://www.alibaba.com/inbound\n",
      "QualityRating": "GREEN",
      "Status": "PENDING",
      "CodeVerificationStatus": "VERIFIED",
      "NameStatus": "Approval",
      "MessagingLimitTier": "TIER_10",
      "NewNameStatus": "Approval"
    }
  ]
}

​

Query the verification status of a phone number - GetPhoneNumberVerificationStatus

Retrieves the verification status of a phone number so you can determine whether a new verification code is needed during registration.

API reference

Query the verification status of a phone number

Example

Sample success response (JSON format):

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A948664****",
  "Code": "OK",
  "Message": "None",
  "Data": {
    "PhoneNumber": "8613900001234",
    "Id": "2224342624",
    "CodeVerificationStatus": "VERIFIED"
  }
}

Get a verification code for a phone number - GetChatappVerifyCode

Obtains a verification code for a phone number.

API reference

Get a verification code for a phone number

Example

Sample success response (JSON format):

{
  "RequestId": "1612C226-E271-4CFE-9F18-4066D55****",
  "Code": "OK",
  "Message": "None"
}

Verify and register a phone number - ChatappVerifyAndRegister

Submits a verification code and registers the phone number in one step. Use this operation when you have a verification code for a number that is not yet verified.

API reference

Verify and register a phone number

Example

Sample success response (JSON format):

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "None"
}

Register a phone number - ChatappPhoneNumberRegister

Registers a phone number that is already verified. Before calling this operation, call Query the verification status of a phone number to confirm the number is verified. If it is, you can register the number directly without a new verification code.

API reference

Register a phone number

Example

Sample success response (JSON format):

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "None"
}

Query the business profile of a phone number - QueryPhoneBusinessProfile

Queries the business profile of a registered phone number, including the information displayed to end users.

API reference

Query the business profile of a phone number

Example

Sample success response (JSON format):

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A948664****",
  "Code": "OK",
  "Message": "None",
  "Data": {
    "Address": "Changsha",
    "Description": "Description",
    "Vertical": "Retail",
    "Email": "aa@aliyun.com",
    "ProfilePictureUrl": "https://....img",
    "Websites": [
      "https://alibaba.com"
    ]
  }
}

Modify the business profile of a phone number - ModifyPhoneBusinessProfile

Modifies the business profile of a registered phone number.

API reference

Modify the business profile of a phone number

Example

Sample success response (JSON format):

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A948664****",
  "Code": "OK",
  "Message": "SUCCESS"
}