tencent cloud

文档反馈

创建回调配置

最后更新时间:2024-10-29 17:23:23

    功能说明

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

    接口说明

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

    请求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 开头
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持