1. 接口描述
接口请求域名： wav.tencentcloudapi.com 。
新增渠道活码接口
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateChannelCode。 |
| Version | 是 | String | 公共参数，本接口取值：2021-01-29。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Type | 是 | Integer | 欢迎语类型:0普通欢迎语,1渠道欢迎语 示例值：1 |
| UseUserId.N | 是 | Array of Integer | 使用成员用户id集 示例值：[ 1386218784692961300 ] |
| UseUserOpenId.N | 是 | Array of String | 使用成员企微账号id集 示例值：[ "544064e019b53e4791115020ffc68f33" ] |
| AppIds | 是 | String | 应用ID,字典表中的APP_TYPE值,多个已逗号分隔 示例值：DEFAULT |
| Source | 否 | String | 渠道来源 示例值：1 |
| SourceName | 否 | String | 渠道来源名称 示例值：自然到店 |
| Name | 否 | String | 二维码名称 示例值：测试企业标签的活码 |
| Tag.N | 否 | Array of WeComTagDetail | 标签 |
| SkipVerify | 否 | Integer | 自动通过好友：0开启 1关闭, 默认开启 示例值：0 |
| MsgId | 否 | Integer | 欢迎语id（通过欢迎语新增返回的id） 示例值：1397103192673538050 |
| Remark | 否 | String | 备注 示例值：如图 |
| SourceType | 否 | Integer | 渠道类型 0 未知 1 公域 2私域 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 渠道活码创建实例
输入示例
POST / HTTP/1.1
Host: wav.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateChannelCode
<公共请求参数>
{
"Remark": "如图",
"AppIds": "DEFAULT",
"Name": "测试企业标签的活码",
"UseUserId": [
1386218784692961300
],
"SourceName": "自然到店",
"MsgId": 1397103192673538050,
"Source": "1",
"Tag": [
{
"BizTagIdStr": "1394843909254754300",
"BizTagId": 1394843909254754300,
"BizGroupId": 1394843720913727500,
"TagId": "etQIM2CwAA_dZ7TUzES2iRRIGXJrWY8w",
"GroupName": "测试111",
"TagName": "额嗡嗡嗡",
"Type": 1
}
],
"SkipVerify": 0,
"UseUserOpenId": [
"544064e019b53e4791115020ffc68f33"
],
"Type": 1,
"SourceType": 1
}输出示例
{
"Response": {
"RequestId": "fea177dd-9fa6-4e76-9c8f-67f5a21f20bb"
}
}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
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。