Chat Channel
概要
操作聊天频道所需的 API。
信息
关于游戏聊天的使用方法,请见这里的教程。
注意
- 1 个用户创建1 个聊天室,禁止只向特定用户发送信息(游戏通知)的行为。
- 1个应用软件可生成的频道最大条数为 1,000,000 条。
ChatChannel 对象字段
表示频道的对象。
| 值 | 说明 | 类型 | 满足 |
|---|---|---|---|
| id | 频道 ID | xs:string | 表示频道唯一性的标识符 |
| name | 频道名 | xs:string | 频道的名称 |
| shorName | 缩略频道名 | xs:string | 频道的缩略名 |
| owner | 频道所有者 | xs:string | ChatChannelOwner 对象 |
| published | 生成时间 | xs:date | 生成时间 (ISO8601, GMT格式) |
| updated | 更新时间 | xs:date | 更新时间 (ISO8601, GMT格式) |
ChatChannelOwner 对象字段
表示频道所有者的对象。
| 值 | 说明 | 类型 | 补充个 |
|---|---|---|---|
| id | ChatChannelOwner 对象的 ID | xs:string | 表示频道所有者的唯一性标识符 |
| objectType | ChatChannelOwner 对象的类型 | xs:string | 只能指定"application" |
API 请求
HTTP 方法
Authorization Code Grant
- GET 获取频道
- POST 创建频道
- PUT 更新频道
- DELETE 删除频道
Client Credentials Grant
-
GET 获取频道
-
POST 创建频道
-
PUT 更新频道
-
DELETE 删除频道
-
端点 URL
-
Sandbox 环境
https://sb-app.mobage.jp/social/api/restful/v2/chat/{appId}/channels/{-prefix|/|channelId} -
正式环境
https://app.mobage.jp/social/api/restful/v2/chat/{appId}/channels/{-prefix|/|channelId}
URI Template 参数
appId
在appId 参数中,指定下述任意一项的值。
| 值 | 说明 | 备注 |
|---|---|---|
| @app | 当前执行的应用软件 ID | 必须 |
channelId
在channelId 参数中,指定下述任意一项的值。
| 值 | 说明 | 备注 |
|---|---|---|
| {channelId} | 频道 ID | 任意 |
查询参数
可指定下述查询参数。
format
可指定响应格式。
| 值 | 说明 | 备注 |
|---|---|---|
| json | "application/json; charset=utf8" | 任意、默认值 |
fields
可指定想要获取的频道信息。关于可指定的字段名,请参见 ChatChannel 对象字段。
要指定多个时,使用不带空格的逗号 (,) 分隔指定。
省略fields 参数时,获取下述全部属性信息。
为提高性能,请尽量只获取必要的属性。
API响应
响应代码
API 的响应代码为以下中的任意一项。
| 请求 HTTP 方法 | 响应代码 | 响应信息 | 说明 |
|---|---|---|---|
| GET/PUT | 200 | OK | 获取频道成功时 |
| POST | 201 | Created | 添加频道成功时 |
| DELETE | 204 | No Content | 删除频道成功时 |
| GET/POST/DELETE/PUT | 400 | Bad Request | 数据格式不当时 |
| GET/POST/DELETE/PUT | 401 | Unauthorized | Authorization 报头不当时 |
| GET/POST/DELETE/PUT | 403 | Forbidden | 试图执行的操作无权限时 |
| GET/POST/DELETE/PUT | 404 | Not Found | 指定的appId, channelId, id 不存在时 |
| POST | 409 | Conflict | 试图更改不能更改的字段时 |
| GET/POST/DELETE/PUT | 500 | Internal Server Error | 服务器端的处理出错时 |
| GET/POST/DELETE/PUT | 503 | Service Unavailable | 服务器端暂停服务时 |
限制事项
- 1个应用软件可生成频道的最大条数为 1,000,000 条。
样例
频道获取
请求格式
GET /social/api/restful/v2/chat/@app/channels/100?fields=id%2Cname%2Cowner
响应格式
200 OK HTTP/1.1
Content-Type: application/json; charset=utf-8
{
"id" : "100",
"name" : "谈论Mobage 的帖子",
"owner" : {
"id" : "12000129",
"objectType" : "application"
}
}
获取多个频道
可获取多个频道的类集。
请求格式
GET /social/api/restful/v2/chat/12000129/channels/100,200
响应格式
200 OK
Content-Type: application/json; charset=utf-8
{
"entry" : [
{
"name" : "谈论Mobage的帖子1",
"id" : "100",
"shortName" : "Moba谈1"
},
{
"name" : "谈论Mobage的帖子2",
"id" : "200",
"shortName" : "Moba谈2"
}
],
"startIndex" : 1,
"sorted" : false,
"itemsPerPage" : 2,
"totalResults" : 2
}
创建频道
请求格式
POST /social/api/restful/v2/chat/@app/channels
Content-Type: application/json; charset=utf8
{
"name" : "comm 还行吧",
"shortName" : "comm"
}
响应格式
201 Created
Content-Type: application/json; charset=utf-8
{
"id" : "6550",
"name" : "comm 还行吧",
"shortName" : "comm",
"published" : "2013-03-24T09:36:40",
"updated" : "2013-03-24T09:36:40"
}
更新频道
请求格式
PUT /social/api/restful/v2/chat/@app/channels/344?fields=name,shortName
Content-Type: application/json; charset=utf8
{
"name" : "Gloovy fun room",
"shortName" : "gloovy"
}
响应格式
202 Accepted
Content-Type: application/json; charset=utf-8
{
"id" : "344",
"name" : "Gloovy fun room",
"shortName" : "gloovy",
"published" : "2013-03-30T15:14:47",
"updated" : "2013-03-30T15:24:47"
}
更新频道
请求格式
DELETE /social/api/restful/v2/chat/@app/channels/50
响应格式
204 No Content
信息
API生成的频道不能通过用户操作删除,因此请在事件终止等时机请求删除。