文档首页/ 云客服/ API参考/ 网页客户端接入/ 集成开发/ 点击通话场景中使用的接口/ 获取点击通话事件 (getClickToCallEvents)
更新时间：2025-03-07 GMT+08:00
查看PDF
分享

获取点击通话事件 (getClickToCallEvents)

描述

用户创建点通话后，第三方轮询该接口获取点击通话事件。通话事件类型有呼叫建立成功事件、呼叫排队事件、呼叫排队超时事件、呼叫释放事件和呼叫失败事件。只有获取到呼叫建立成功事件时表示座席与用户连接正常，可以拉起通话；呼叫排队事件表示当前仍处于呼叫中；呼叫超时事件和呼叫失败事件表示本次点击通话呼叫失败；呼叫释放事件表示当前呼叫已结束。

接口方法

GET

接口URI

https://域名/apiaccess/ccmessaging/v1/getClickToCallEvents，例如域名是service.besclouds.com

请求说明

表1 查询参数

序号

名称

参数类型

是否必选

说明

1

channel

string

True

接收者渠道类型（WEB）
表2 请求头参数

序号

名称

参数类型

是否必选

说明

1

ccmessaging-token

string

True

applyToken接口生成的ccmessagign-token

2

x-app-key

string

True

appKey字段，用户标识，在API Fabric上配置

3

Authorization

string

True

鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）

响应说明

  • 响应状态码: 200
表3 响应体参数

序号

名称

参数类型

说明

1.1

resultCode

string

响应结果码

1.2

resultDesc

string

响应结果描述。

如果resultCode返回0：Call in queue或Call connected或Call disconnected或Call queued timeout或Call failed或Call continue to poll events with unknown events或ClickToCall polled without any events

1.3

eventId

string

事件编号

1.4

content

object

事件内容

1.4.1

causeDesc

string

原因描述

1.4.2

causeId

string

原因 id

1.4.3

accessCode

string

点击通话被叫

1.4.4

domain

string

WebRTC Gateway域名

1.4.5

gwAddresses

array

WebRTC Gateway通信地址和端口

1.4.6

clickToCallCaller

string

点击通话主叫
  • 响应状态码: 400

    错误的请求：请检查请求路径及参数。

  • 响应状态码: 401

    未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。

  • 响应状态码: 404

    请求的内容未找到：请检查请求的路径。

  • 响应状态码: 500

    业务失败：请依次确认您请求中各参数的取值。

错误码

无。

报文样例

  • 请求头: 
    ccmessaging-token:  
x-app-key:  
Authorization:
  • 请求参数:

    无

  • 响应参数: 
    {
    resultCode: "0",
	resultDesc: "Call connected",
	"eventId": 168101,
	"content": {
		"domain": "xxx",
		"gwAddresses": ["xx1", "xx2"],
		"accessCode": "179080000537636",
		"clickToCallCaller": "AnonymousCard"
	}
}