All Products
Search
Document Center

ChatAPP:GetMigrationVerifyCode

Last Updated:Mar 16, 2023

Obtains the verification code of a phone number for migration.

Operation Description

You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
CustSpaceIdstringYes

The space ID of the user under the ISV account.

293483938849493
PhoneNumberstringYes

The phone number.

8613800001234
LocalestringYes

The language.

zh_CN
MethodstringYes

The method to obtain the verification code. Valid values: sms and voice.

sms

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

90E63D28-E31D-1EB2-8939-A94866411B2O
Codestring

The HTTP status code returned.

  • A value of OK indicates that the call is successful.
  • Other values indicate that the call fails. For more information, see Error codes.
OK
Messagestring

The message returned.

None
Dataobject

The data returned.

PhoneNumberstring

The phone number.

8613800001234
Idstring

The ID of the phone number.

82828893332

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400Product.UnsubscriptYou have not subscribed to the specified product.
400Ram.PermissionDenyYou are not authorized to perform the operation.
400System.LimitControlThe system is under flow control.
400Unknown.ResourceOwnerIdThe resource does not belong to the current user.

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