what is phone number migration, how to implement it - Chat App Message Service

Migrate phone numbers registered with other Business Solution Providers (BSPs) to Alibaba Cloud. Migrated phone numbers retain their display name, quality rating, message sending limits, Official Business Account (OBA) status, and all previously approved message templates.

Procedure

Create a phone number for migration - CreateChatappMigrationInitiate

For details about the migration process, see Phone number migration. After you complete the first half of the embedded signup flow and attach the WhatsApp Business Account (WABA) by using the embedded APIs, call this API to start the migration.

Important

Before you start the migration, disable two-step verification for the phone number. Your business verification must be completed and approved. The review status of the WABA must also be Approved.

API reference

Create a phone number for migration

Example

Sample success response (in JSON format):

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "SUCCESS",
  "Data": {
    "PhoneNumber": "8613900001234",
    "Id": "82828893332",
    "Status": "MIGRATING"
  }
}

Get a verification code for the migration - GetMigrationVerifyCode

Call this API to obtain a verification code.

A one-time verification for a phone number is valid for 14 days. Before you call this API, call the Query phone number verification status API to check whether the number is already verified. If the number is not yet verified, call this API to obtain a verification code for the migration.

API reference

Get a verification code for the migration

Example

Sample success response (in JSON format):

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A948664****",
  "Code": "OK",
  "Message": "None",
  "Data": {
    "PhoneNumber": "8613800001234",
    "Id": "82828893332"
  }
}

Verify the phone number migration - ChatappMigrationVerified

Call this API to verify the phone number for migration.

API reference

Verify the phone number migration

Example

Sample success response (in JSON format):

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "SUCCESS",
  "Data": {
    "PhoneNumber": "8613800001234",
    "Id": "82828893332"
  }
}

Register the migrated phone number - ChatappMigrationRegister

Call this API to register the migrated phone number.

After registration, the phone number and all previously approved templates are migrated from the original WABA to the current WABA.

API reference

Example

Sample success response (in JSON format):

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