All Products
Search
Document Center

Chat App Message Service:GetConversationalAutomation

Last Updated:Nov 18, 2024

Configures welcoming messages, opening remarks, and commands.

Operation description

QPS limit

You can call this operation up to five 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.

This operation will directly obtain data from Facebook, which sets an upper limit on the total number of calls for operations. 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

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
CustSpaceIdstringYes

The space ID of the RAM user within the independent software vendor (ISV) account or the instance ID of the customer of Alibaba Cloud.

cams-3ie***
PhoneNumberstringYes

The phone number of the enterprise.

86130000***

Response parameters

ParameterTypeDescriptionExample
object
AccessDeniedDetailstring

The details about the access denial.

None
Messagestring

The error message.

None
RequestIdstring

The request ID.

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

The returned data.

Promptsarray

The opening remarks.

promptsstring

The opening remark.

prompt1
Commandsarray<object>

The commands.

commandsobject

The command.

CommandDescriptionstring

The description of the command.

description
CommandNamestring

The name of the command.

common1
PhoneNumberstring

The phone number of the enterprise.

86138****
EnableWelcomeMessageboolean

Indicates whether the welcoming message is enabled.

true
Codestring

The response code.

  • The value OK indicates that the request was successful.
  • For more information about other response codes, see Error codes.
OK
Successboolean

Indicates whether the call was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Data": {
    "Prompts": [
      "prompt1"
    ],
    "Commands": [
      {
        "CommandDescription": "description",
        "CommandName": "common1"
      }
    ],
    "PhoneNumber": "86138****",
    "EnableWelcomeMessage": true
  },
  "Code": "OK",
  "Success": true
}

Error codes

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