你可以参照本文,了解调用 IM 服务端 OpenAPI 的基本步骤。对于具体的 OpenAPI,你仍须参考该 OpenAPI 的入参和响应信息。
我们强烈推荐您以主账号权限,创建用户(子账号),并使用用户的 AK/SK 发起 OpenAPI 调用。要创建用户,访问控制台-访问控制-用户管理 路径。
rtc.volcengineapi.com
你可以使用 HTTP 和 HTTPS 两种协议进行请求通信。我们强烈推荐你使用安全性更高的 HTTPS 方式发送请求。
根据各个接口的具体需求,选择 Get 或 Post 方式发起请求。
在发起请求时,需要包含两类参数:公共请求参数和接口特有的请求参数。
在发起所有 OpenAPI 请求时,请求中必须包含以下公共参数:
| 名称 | 类型 | 取值 | 位置 | 说明 |
|---|---|---|---|---|
| Host | string | rtc.volcengineapi.com | header | 同服务地址。 |
| Content-Type | string | application/x-www-form-urlencoded; charset=utf-8 | header | 资源的 MIME 类型。 |
| X-Date | string | / | header | 请求时间,UTC 时间,形如2006-01-02T15:04:05Z 。 |
| X-Content-Sha256 | string | / | header | 对请求体采用 SHA256 加密后的结果字符串。 |
| Authorization | string | / | header | 签名。关于如何获得这一签名,参看对 OpenAPI 请求进行签名。 |
| Action | string | / | Query String | 接口名称。参看接口详情文档。 |
| Version | string | / | Query String | 接口版本。参看接口详情文档。 |
对于接口特有请求参数,参看具体 OpenAPI 接口文档。
请求及返回结果使用 UTF-8 字符集进行编码。
参看签名机制。
当 HTTP 响应状态码 !=200 时,表示调用失败。
当 HTTP 响应状态码 ==200 时,你仍需解析响应结果中的 ResponseMetaData.Error 结构体。当 Error 为空时,调用成功。
你可以参考以下的响应结果示例:
调用成功:
{
"ResponseMetadata": {
"RequestId": "Your_RequestId",
"Action": "BatchAddConversationParticipant",
"Version": "2020-12-01",
"Service": "rtc",
"Region": "cn-north-1"
},
"Result":{
"Message": "success"
}
}
json调用失败:
{
"ResponseMetadata": {
"RequestId": "Your_RequestId",
"Action": "BatchAddConversationParticipant",
"Version": "2020-12-01",
"Service": "IM",
"Region": "cn-north-1"
"Error":{
"Code": "InvalidParameter.AccountIdMismatch",
"Message": "Check owner failed"
}
},
"Result": {}
}
json当调用失败后,响应结果中的 ResponseMetaData.Error 结构体会包含错误码和错误信息。关于有哪些错误码,以及发生错误后应如何处理,参看 OpenAPI 错误码。