GetConversationalAutomation - 获取号码欢迎消息、开场白和命令

获取欢迎消息、开场白和命令。

接口说明

QPS 限制

本接口的单用户 QPS 限制为 5 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

此接口会直接拉取 facebook 的数据,facebook 接口调用总量有限制,请合理使用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
CustSpaceIdstring

ISV 子客户的 SpaceId/直客客户的实例 ID。

cams-3ie***
PhoneNumberstring

商家号码。

86130000***

返回参数

名称类型描述示例值
object

返回数据。

AccessDeniedDetailstring

访问被拒绝详细信息。

Messagestring

错误提示信息。

RequestIdstring

请求 ID。

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

返回数据对象。

Promptsarray

开场白列表。

promptsstring

开场白信息。

prompt1
Commandsarray<object>

命令列表。

commandsobject

命令对象。

CommandDescriptionstring

命令描述。

description
CommandNamestring

命令名称。

common1
PhoneNumberstring

商家号码。

861380000****
EnableWelcomeMessageboolean

是否开启欢迎消息。

true
Codestring

请求状态码。

  • 返回 OK 代表请求成功。

  • 其他错误码,请参见错误码列表

OK
Successboolean

是否调用成功。

  • true:调用成功。
  • false:调用失败。
true

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。