收号

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CollectedNumber

系统规定参数。取值：CollectedNumber。
ConversationId String 是 0099b75d-60fd-4c63-8541-7fbba0ae6bb0

会话id
InstanceId String 是 0099b75d-60fd-4c63-8541-7fbba0ae6bb0

示例id
Number String 否 123

收号内容

返回数据

名称 类型 示例值 描述
Action String Broadcast

动作
ActionParams String {}

动作参数
Interruptible Boolean false

是否可打断ivr的播报
RequestId String 14C39896-AE6D-4643-9C9A-E0566B2C2DDD

请求内容
TextResponse String 收号内容是123

ivr 播报的内容

示例

请求示例

http(s)://[Endpoint]/?Action=CollectedNumber
&ConversationId=0099b75d-60fd-4c63-8541-7fbba0ae6bb0
&InstanceId=0099b75d-60fd-4c63-8541-7fbba0ae6bb0
&<公共请求参数>

正常返回示例

XML 格式 

<RequestId>14C39896-AE6D-4643-9C9A-E0566B2C2DDD</RequestId>
<TextResponse>收号内容是123</TextResponse>
<Interruptible>false</Interruptible>
<Action>Broadcast</Action>

JSON 格式 

{
    "RequestId": "14C39896-AE6D-4643-9C9A-E0566B2C2DDD",
    "TextResponse" : "收号内容是123",
    "Interruptible" : false,
    "Action" : "Broadcast"
}

错误码

HttpCode 错误码 错误信息 描述
500 InternalError An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. 内部错误。建议重试，如果多次重试报错请提交工单。
404 InvalidInstanceId.NotFound The specified InstanceId does not exist. 指定的实例ID不存在。

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

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