1. 接口描述
接口请求域名: cam.tencentcloudapi.com 。
创建消息接收人接口:仅允许已完成实名认证的用户访问消息接收人接口,并对每个用户限制每天最多请求10次。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateMessageReceiver。 |
Version | 是 | String | 公共参数,本接口取值:2019-01-16。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Name | 是 | String | 消息接收人的用户名 示例值:用户 |
CountryCode | 是 | String | 手机号国际区号,国内为86 示例值:86 |
PhoneNumber | 是 | String | 手机号码, 例如:1322492 示例值:1323769 |
是 | String | 邮箱,例如:57*****@qq.com 示例值:5732*****@qq.com |
|
Remark | 否 | String | 消息接收人的备注,选填 示例值:备注 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建消息接收人
创建消息接收人
输入示例
POST / HTTP/1.1
Host: cam.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateMessageReceiver
<公共请求参数>
{
"Name": "用户",
"Remark": "添加消息接收人",
"CountryCode": "86",
"PhoneNumber": "132****4539",
"Email": "57****@qq.com"
}
输出示例
{
"Response": {
"RequestId": "f709ad6e-991f-49bb-aaaa-c354e434343434"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter | 参数错误。 |
InvalidParameter.InterfaceNotExist | 接口不存在。 |
InvalidParameter.ReceiverOverLimit | 消息接收人超出限制。 |
InvalidParameter.SubUserNameInUse | 子用户名称重复。 |
InvalidParameter.UserNotAuth | 用户未实名。 |
LimitExceeded.Uin | 请求超出限制。 |
ResourceNotFound.UserNotExist | 用户不存在。 |