Call
  • 概览
    • 产品介绍
    • 开通服务
    • 价格中心
      • 免费时长
      • Call 包月套餐
      • 订阅套餐时长计费说明
  • 开始集成
    • 跑通 Demo
    • 集成
      • Web&H5 (React)
      • Web&H5 (Vue3)
    • userSig 鉴权
  • 基础功能
    • Conversational Chat
      • Vue3
      • React
    • 自定义 UI
    • 设置昵称、头像
    • 群通话
    • 悬浮窗
    • 自定义铃声
    • 设置分辨率和填充模式
    • 监控通话状态
    • 设置语言
  • 高级功能
    • 虚拟背景
    • AI 降噪
    • 云端录制
  • 客户端 API
    • UIKit APIs
      • API Overview
      • TUICallKit
    • Engine APIs
      • TUICallEngine
      • TUICallEvent
  • 服务端 API
    • 通话状态回调
      • 通话状态回调
      • 通话事件回调
      • 回调配置
        • 回调配置接口列表
        • 创建回调配置
        • 查询回调配置
        • 更新回调配置
        • 删除回调配置
    • RESTful API
      • Call Records
        • REST 接口简介
        • 通过 callId 获取记录
        • 通过条件获取记录
      • End Calls
  • Solution
    • WhatsApp Clone
  • 常见问题
    • 全平台
    • Web
    • 错误码
    • 发布日志
Call

创建回调配置

功能说明

管理员可通过该接口创建回调。

接口说明

注意:
接口多次调用以最后一次的结果为准。

请求URL示列

https://xxxxxx/v1/callback/set?sdkappid=88888888&identifier=administrator&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参考 REST API 简介
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名:
callkit-intl.trtc.tencent-cloud.com
v1/callback/set
请求接口
sdkappid
创建应用时控制台分配的 sdkappid
identifier
必须为 Chat App 管理员账号
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围 0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

10次/秒。

请求包示例

{
"address":"http://www.example.com/callback",
"actions": [
"call_busy",
"normal_end",
"caller_start_call",
"invite_user",
"callee_reject_call"
]
}

请求字段说明

字段
类型
属性
说明
address
String
必填
回调的地址,需要以 http/https 开头,建议使用更为安全的 https
actions
Array
必填
需要触发回调的情景,列表请参见 回调命令字列表

应答包体示例

{
"errorCode": 0,
"errorMessage": "Success",
"requestId": "a1d8543a9b1daef5d0f0c21517a4bc0a",
"data": "http://www.example.com/callback"
}

应答包字段说明

字段
类型
说明
errorCode
Integer
错误码,0为成功
errorMessage
String
错误信息
requestId
String
请求的唯一 ID
data
String
配置成功的回调地址

错误码说明

错误码
含义说明
0
请求成功
50001
当前应用需要购买 TUICallKit 群组通话版套餐包方可使用
70001
回调地址必须 http 或 https 开头
向社区提问!
开始技术讨论并获取即时专家支持!