云联络中心创建用户数据签名-服务端 API-文档中心-腾讯云

1. 接口描述

接口请求域名： ccc.tencentcloudapi.com 。

创建用户数据签名

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateUserSig。
Version	是	String	公共参数，本接口取值：2020-02-10。
Region	否	String	公共参数，此参数为可选参数。
SdkAppId	是	Integer	应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc 示例值：1400000000
Uid	是	String	用户 ID，该值必须与 ClientData 字段中 Uid 的值一致示例值：foo
ExpiredTime	是	Integer	有效期，单位秒，不超过 1 小时示例值：3600
ClientData	否	String	用户签名数据，必填字段，为标准 JSON 格式示例值：参考下文示例

3. 输出参数

参数名称	类型	描述
UserSig	String	签名结果示例值：eJw0jkFPwjAYQP-Ld9Wwfm2HtokHswhK9IBMBtw22uEHbpa1JRrjfzfZ5vW95OX9
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 生成用户数据签名

输入示例

POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateUserSig
<公共请求参数>

{
    "SdkAppId": 1400000000,
    "Uid": "staff1@xxx.com",
    "ClientData": "{\"peerSource\":\"腾讯科技\",\"nickName\":\"企鹅一号\",\"avatarUrl\":\"https://foo.tencent.com/qieyihao.jpeg\",\"uid\":1846526}",
    "ExpiredTime": 3600
}

输出示例

{
    "Response": {
        "RequestId": "48edd236-7ef1-45af-9e12-fc376ba355bf",
        "UserSig": "eJw0jkFPwjAYQP-Ld9Wwfm2HtokHswhK9IBMBtw22uEHbpa1JRrjfzfZ5vW95OX9QP68mtgvR50FrYRSQonrHpKxbaCabAcaEFGmMAhvTqVzZECjZIxPJUc5GjqAho1fJMlpnlfb9iYJx2WZZ*YqnLO1m9Wrh-uXeD48ZR9vkYrl3ZgM1FjQOOXyNkXJ2UCjt10Va9CwLRbH3Xzd7Pi7K5vgqyK97B9n33vxiqY10m4*-1OX-pdPGPz*BQAA--9b7kId"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InternalError.DBError	内部数据库访问失败。
InvalidParameter	参数错误。
InvalidParameterValue.InstanceNotExist	实例不存在。