All Products
Search
Document Center

Chat App Message Service:BeeBotAssociate

Last Updated:Nov 18, 2024

Associates FAQs in the knowledge base.

Operation description

You can call this operation up to 100 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:BeeBotAssociateupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ChatBotInstanceIdstringYes

The ID of a bot instance.

1
IsvCodestringNo

The ISV verification code, which is used to verify whether the user is authorized by ISV.

ksiekdki39ksks93939
SessionIdstringNo

The ID of the session, which is used to identify the session and store context information in the session.

2334324234
PerspectivearrayNo

The list of codes for answers from different perspectives.

stringNo

The code for invoking answers from different perspectives under the same knowledge title.

vEJnjV37Ae
RecommendNumintegerNo

The number of recommended questions. The value ranges from 1 to 10.

3
UtterancestringNo

The input of the visitor.

hello
CustSpaceIdstringNo

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

293483938849493

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

If OK is returned, the request is successful.

OK
Messagestring

The error message returned.

None
Dataobject

The data returned.

MessageIdstring

The ID of the response message.

1eb47d7a1706429081e90c83c62c2f00
SessionIdstring

The ID of the session.

93f11165a2a24289a6f869760e8cb3f3
Associatearray<object>

The list of associated recommendations.

object

The data returned.

Metastring

The metadata.

{}
Titlestring

The title of the related question.

Policy on Withdrawal of Housing Provident Fund
AccessDeniedDetailstring

The access denied for detailed information.

None

Examples

Sample success responses

JSONformat

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "None",
  "Data": {
    "MessageId": "1eb47d7a1706429081e90c83c62c2f00",
    "SessionId": "93f11165a2a24289a6f869760e8cb3f3",
    "Associate": [
      {
        "Meta": "{}",
        "Title": "Policy on Withdrawal of Housing Provident Fund"
      }
    ]
  },
  "AccessDeniedDetail": "None"
}

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
2023-07-04The Error code has changed. The response structure of the API has changedView Change Details
2022-10-12The Error code has changed. The request parameters of the API has changedView Change Details