All Products
Search
Document Center

Chat App Message Service:GetCommerceSetting

Last Updated:Nov 18, 2024

Queries the business settings of a phone number.

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.

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:GetCommerceSettingupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CustSpaceIdstringYes

The space ID of the user within the independent software vendor (ISV) account.

293483938849493
PhoneNumberstringYes

The phone number.

1380000****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

AccessDeniedDetailstring

Access denied for detailed information.

None
Messagestring

The error message.

None
RequestIdstring

The request ID.

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

The returned data.

CartEnableboolean

Indicates whether the shopping cart button is displayed. Valid values:

  • true
  • false
false
CatalogVisibleboolean

Indicates whether the catalog button is displayed. Valid values:

  • true
  • false
false
Codestring

The response code.

  • The value OK indicates that the request was successful.
  • Other values indicate that the request failed. For more information, see Error codes.
OK
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Data": {
    "CartEnable": false,
    "CatalogVisible": false
  },
  "Code": "OK",
  "Success": true
}

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
No change history