AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

SendDtmfSignaling - 发送按键信息

更新时间：
复制为 MD 格式
产品详情
我的收藏

调用SendDtmfSignaling在通话过程中发送DTMF按键信息。

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值
InstanceId

string

是

实例 ID。

ccc-test
UserId

string

否

发送 DTMF 的坐席 ID。

agent@ccc-test
DeviceId

string

否

设备 ID，无意义，可以随便填写。

device
JobId

string

是

通话 ID。

job-6573574060089****
ChannelId

string

是

待发送 DTMF 的话务通道 ID。

ch:customer:0108989****->1318888****:1609234221870:job-6573574060089****
Dtmf

string

是

DTMF 按键信息，即拨号盘上的按键，包括 0-9、*、#。

5

返回参数

名称

类型

描述

示例值

object

Code

string

响应码。

OK
HttpStatusCode

integer

HTTP 状态码。

200
Message

string

响应信息。

无
RequestId

string

请求 ID。

842399EC-7D32-4472-AD08-9504C3F141FF
Params

array

响应参数列表。

string

响应参数。

无
Data

object

数据。

CallContext

object

话务上下文环境。

CallType

string

通话类型。

枚举值：

  • INBOUND :

    呼入

  • BARGE :

    强插

  • CONSULTANT :

    咨询

  • CONFERENCE :

    会议

  • MONITOR :

    监听

  • INTERNAL :

    内部通话

  • OUTBOUND :

    呼出

  • INTERCEPT :

    强拆

  • BACK2BACK :

    双呼

  • PREDICTIVE :

    预测式外呼

  • COACH :

    辅导

OUTBOUND
InstanceId

string

实例 ID。

ccc-test
JobId

string

通话 ID。

job-6573574060089****
ChannelContexts

array<object>

话务通道列表。

object

话务通道。

Index

integer

系统自增 ID，客户无需关心。

1
ReleaseInitiator

string

话务通道的挂断方，表示该话务通道是谁首先发起的挂断。

无
ChannelState

string

话务通道的状态。

枚举值：

  • CREATED :

    已创建

  • ANSWERED :

    已接通

  • RELEASED :

    已挂断

  • RETIRED :

    已失效

  • EARLY_MEDIA :

    早媒体阶段

  • NONE :

    初始状态

  • RINGING :

    振铃中

ANSWERED
Destination

string

话务通道的被叫方。

8001****
UserId

string

话务通道关联的坐席 ID，如果是客户的话务通道，该字段为空。

agent@ccc-test
ChannelFlags

string

话务通道标志。

枚举值：

  • COACHING :

    辅导中

  • MONITORING :

    监听中

  • MONITORED :

    被监听

  • COACHED :

    被辅导

  • HOLD :

    保持

  • MUTED :

    静音

MONITORING
SkillGroupId

string

话务通道关联的技能组 ID，呼入场景下，关联的技能组 ID 由 IVR 中转人工模块配置的技能组决定，呼出场景下，关联的技能组 ID 为座席签入的第一个技能组的 ID。

skillgroup@ccc-test
Timestamp

integer

话务通道最近一次状态变化的时间戳，格式是 Unix 时间戳，单位毫秒。

1609234222367
ReleaseReason

string

话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自 SIP 协议中定义的响应码，请客户参考 SIP 协议分析挂断原因。

无
CallType

string

话务通道的通话类型。

枚举值：

  • INBOUND :

    呼入

  • BARGE :

    强插

  • CONSULTANT :

    咨询

  • CONFERENCE :

    会议

  • MONITOR :

    监听

  • INTERNAL :

    内部通话

  • OUTBOUND :

    呼出

  • INTERCEPT :

    强拆

  • BACK2BACK :

    双呼

  • PREDICTIVE :

    预测式外呼

  • COACH :

    辅导

OUTBOUND
JobId

string

通话 ID。

job-6573574060089****
ChannelId

string

话务通道 ID。

ch:user:131888****->8001****:1609234221870:job-6573574060089****
UserExtension

string

话务通道关联的坐席的分机号。

8001****
Originator

string

话务通道的主叫方。

0101234****
UserContext

object

坐席上下文环境。

Extension

string

坐席分机号。

8001****
Heartbeat

integer

上次收到坐席心跳的时间，格式为 Unix 时间戳，单位毫秒。

1609234222375
WorkMode

string

工作模式。

枚举值：

  • ON_SITE :

    场内模式

  • OFF_SITE :

    场外模式

  • OFFICE_PHONE :

    办公电话模式

ON_SITE
DeviceId

string

设备 ID，浏览器 WebRTC 软电话或实体话机设备的标识 ID，同一时间只允许一种设备注册。

ACC-YUNBS-1.0.10-****
UserId

string

坐席 ID。

agent@ccc-test
Reserved

integer

坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为 Unix 时间戳，单位毫秒。

1609234221864
BreakCode

string

小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。

枚举值：

  • RingingTimeout :

    坐席振铃超时导致的小休

  • RejectCall :

    坐席拒接导致的小休

  • Warm-up :

    坐席上线后置闲前的临时小休状态

Warm-up
InstanceId

string

实例 ID。

ccc-test
OutboundScenario

boolean

坐席是否处于仅外呼模式。

false
Mobile

string

坐席的个人电话号码。

1390000****
JobId

string

通话 ID。

job-6573574060089****
UserState

string

座席状态。

枚举值：

  • READY :

    空闲

  • WORKING :

    话后处理中

  • DIALING :

    拨号中

  • BREAK :

    小休

  • OFFLINE :

    离线

  • TALKING :

    通话中

  • RINGING :

    振铃中

TALKING
SignedSkillGroupIdList

array

坐席签入的技能组 ID 列表。

string

技能组 ID。

skillgroup1@ccc-test

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "842399EC-7D32-4472-AD08-9504C3F141FF",
  "Params": [
    "无"
  ],
  "Data": {
    "CallContext": {
      "CallType": "OUTBOUND",
      "InstanceId": "ccc-test",
      "JobId": "job-6573574060089****",
      "ChannelContexts": [
        {
          "Index": 1,
          "ReleaseInitiator": "无",
          "ChannelState": "ANSWERED",
          "Destination": "8001****",
          "UserId": "agent@ccc-test",
          "ChannelFlags": "MONITORING",
          "SkillGroupId": "skillgroup@ccc-test",
          "Timestamp": 1609234222367,
          "ReleaseReason": "无",
          "CallType": "OUTBOUND",
          "JobId": "job-6573574060089****",
          "ChannelId": "ch:user:131888****->8001****:1609234221870:job-6573574060089****",
          "UserExtension": "8001****",
          "Originator": "0101234****"
        }
      ]
    },
    "UserContext": {
      "Extension": "8001****",
      "Heartbeat": 1609234222375,
      "WorkMode": "ON_SITE",
      "DeviceId": "ACC-YUNBS-1.0.10-****",
      "UserId": "agent@ccc-test",
      "Reserved": 1609234221864,
      "BreakCode": "Warm-up",
      "InstanceId": "ccc-test",
      "OutboundScenario": false,
      "Mobile": "1390000****",
      "JobId": "job-6573574060089****",
      "UserState": "TALKING",
      "SignedSkillGroupIdList": [
        "skillgroup1@ccc-test"
      ]
    }
  }
}

错误码

HTTP status code

错误码

错误信息

描述
400 InvalidOperation.ChannelState The operation is not allowed. Channel stats (%s) does not meet expectations (%s).
400 InvalidOperation.UserState The operation is not allowed. User state (%s) does not meet expectations (%s). 非法操作，用户状态不符合预期。
500 InternalService.CTI An internal CTI service error occurred. %s 内部CTI服务错误。
404 NotExists.ChannelId The specified channel %s does not exist in call %s. 通话中不存在指定的Channel信息。
404 NotExists.InstanceId The specified instance %s does not exist. 指定的呼叫中心实例不存在。
404 NotExists.JobId The call %s does not exist. 指定的通话信息不存在。

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

变更历史

更多信息，参考变更详情。

上一篇：SaveWebRTCStats - 上报坐席端WebRTC统计信息下一篇：SignInGroup - 签入技能组