功能说明
App 管理员可以通过该接口获取指定礼物分类信息。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/live_engine_http_srv/get_gift_category?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名： 中国： console.tim.qq.com新加坡： adminapisgp.im.qcloud.com美国： adminapiusa.im.qcloud.com |
v4/live_engine_http_srv/get_gift_category | 请求接口。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数，取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json。 |
最高调用频率
1次/秒。
请求包示例
基础形式
{"CategoryId":"CId2"}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
CategoryId | String | 必填 | 需要查询的礼物分类 ID。 |
应答包体示例
基础形式
{"ErrorCode": 0,"ErrorInfo": "","ActionStatus": "OK","RequestId": "Id-205381db557a47bc93d6faa14d17dfeb-O-Seq-316720","GiftCategoryInfo": {"CategoryId": "CId2","ExtensionInfo": "{\\"key\\": \\"value\\"}","DefaultName": "name1","DefaultDesc": "desc1"}}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果，OK 表示处理成功，FAIL 表示失败。 |
ErrorCode | Integer | 错误码，0表示成功，非0表示失败。 |
ErrorInfo | String | 错误信息。 |
RequestId | String | 唯一请求 ID，每次请求都会返回，定位问题时需要提供该次请求的 RequestId。 |
CategoryId | String | 礼物分类 ID。 |
ExtensionInfo | String | 自定义扩展信息。 |
DefaultName | String | 默认礼物名称。 |
DefaultDesc | String | 默认礼物描述。 |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下：
错误码 | 含义说明 |
100001 | 服务器内部错误，请重试。 |
100002 | 请求参数非法，请根据错误描述检查请求是否正确。 |
100006 | 操作权限不足，需要管理员账号操作。 |
100012 | 调用次数频繁，调用频率最大1次/s。 |
102001 | 无付费信息，需要在控制台购买套餐包。 |
