All Products
Search
Document Center

Chat App Message Service:CreateChatappMigrationInitiate

Last Updated:Nov 18, 2024

The ID of the number.

Operation description

The status of the phone number.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cams:CreateChatappMigrationInitiateupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CustSpaceIdstringYes

The space ID of the user within the ISV account.

293483938849493****
MobileNumberstringYes

The mobile number without the country code or region code.

13900001234
CountryCodestringYes

The code of the country or region.

86

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

90E63D28-E31D-1EB2-8939-A9486641****
Codestring

The response code.

  • A value of OK indicates that the request was successful.
  • For more information about other response codes, see API error codes.
OK
Messagestring

The error message returned.

SUCCESS
Dataobject

The response data.

PhoneNumberstring

The mobile number.

8613900001234
Idstring

The ID of the mobile number.

82828893332
Statusstring

The state of the mobile number. Only MIGRATING may be returned, which indicates that the mobile number is being migrated.

MIGRATING
AccessDeniedDetailstring

The information about the request denial..

None

Examples

Sample success responses

JSONformat

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

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.

Change history

Change timeSummary of changesOperation
2024-11-06The Error code has changedView Change Details
2023-07-04The Error code has changed. The response structure of the API has changedView Change Details