跳到主要内容

Chat Message

概要​

操作聊天信息所需的 API。

信息

关于游戏聊天的使用方法,请见这里的教程。

注意
  • 1 个用户创建1 个聊天室,禁止只向特定用户发送信息(游戏通知)的行为。
  • 1个应用软件可生成的通道最大条数为 1,000,000 条。

ChatMessage 对象字段

表示信息的对象。

值说明类型补充
id信息 IDxs:string–
actor发送人带有下述参数的对象
actor.id全球对象 IDxs:string格式为 id = objectType + ':' + localId
actor.objectTypeChatMember 对象的类型xs:stringPOST 时,只能指定 "application"
actor.localId本地 IDxs:string按objectType 分配的唯一性标识符(与People 的 userId 的 localId 同义)
payload有效载荷带有下述参数的对象
payload.message信息xs:string–
payload.stamp表情带有下述参数的对象,POST时不能指定
payload.stamp.id表情 IDxs:string–
payload.stamp.imageUrl表情图片的 URLxs:string–
payload.stamp.localId本地 IDxs:string按objectType 分配的唯一性标识符(与People 的 userId 的 localId 同义)
published发送时间xs:date发送时间 (ISO8601, GMT格式)

API 请求​

HTTP 方法​

Authorization Code Grant

  • GET 获取信息列表,获取信息
  • DELETE 删除信息列表,删除信息

Client Credentials Grant

  • GET 获取信息列表,获取信息
  • POST 创建信息列表,创建信息
  • DELETE 删除信息列表,删除信息
备注

聊天信息的保存期限约 30 日

端点 URL​

  • Sandbox 环境

    https://sb-app.mobage.jp/social/api/restful/v2/chat/{appId}/channels/{channelId}/messages/{-prefix|/|id}
  • 正式环境

    https://app.mobage.jp/social/api/restful/v2/chat/{appId}/channels/{channelId}/messages/{-prefix|/|id}

     

    URI Template 参数​

    appId​

    在appId 参数中,指定下述任意一项的值。

    值说明备注
    @app当前执行的应用软件 ID必须
channelId​

在channelId 参数中,指定下述任意一项的值。

值说明备注
{channelId}通道 ID必须
id​

在id 参数中,指定下述任意一项的值。

值说明备注
{id}ChatMessage 对象的信息 ID任意

查询参数​

可指定下述查询参数。

format​

可指定响应格式。

值说明备注
json"application/json; charset=utf8"任意、默认值

fields​

可指定想要获取的通道信息。关于可指定的字段名,请参见 ChatMember 对象字段。
要指定多个时,使用不带空格的逗号 (,) 分隔指定。
省略fields 参数时,获取下述全部属性信息。

为提高性能,请尽量只获取必要的属性。

count​

获取类集资源的响应时,可指定最多可获取的条目资源条数。

默认值为 50 条,最多可指定1000条。

为提高性能,请尽量只获取必要的条数。

startIndex​

指定类集资源的开始值。省略时,自动指定 1。

sortBy​

只有在获取ChatMember 类集时,可使用sortBy。

指定sortBy 和 sortOrder 后,可对响应反馈的 ChatMember 对象类集添加排序条件。可在sortBy 值中指定排序的关键字段。

目前可指定的 sortBy 值如下表所示。

sortBy说明
publishedChatMessage 的发送时间

要指定sortBy ,需要已指定sortOrder。。

sortOrder​

只有在获取 Channel 类集时,可使用sortOrder。

指定sortBy 和 sortOrder 后,可对响应反馈的 ChatMember 对象类集添加排序条件。可在sortOrder 值中指定排序时的升序和降序。

目前可指定的 sortOrder 值如下表所示。

sortOrder说明
ascending升序
descending降序

要指定sortOrder ,需要已指定sortBy 。

API 响应​

响应代码​

API 的响应代码为以下中的任意一项。

请求 HTTP 方法响应代码响应信息说明
GET200OK获取信息成功时
POST201Created信息发帖成功时
GET/POST400Bad Request数据格式不当时
GET/POST401UnauthorizedAuthorization 报头不当时
GET/POST403Forbidden试图执行的操作无权限时
GET/POST404Not Found指定的appId, channelId, id 不存在时
GET/POST500Internal Server Error服务器端的处理出错时
GET/POST503Service Unavailable服务器端暂停服务时
备注

对未注册出生年月日的用户,会反馈错误 403

样例

获取信息列表​

请求格式​

GET /social/api/restful/v2/chat/@app/channels/100/messages?count=50&fields=id%2Cactor%2Cpayload%2Cpublished&sortBy=published&sortOrder=descending&startIndex=1

响应格式

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"entry" : [
{
"id" : "10234123",
"actor" : {
"id" : "person:11241",
"objectType" : "person",
"localId" : "11241"
},
"payload" : {
"message" : "ぉぅぃぇーぃ"
},
"published" : "2013-04-04T15:22:43"
},
{
"id" : "10212981",
"actor" : {
"id" : "person:11241",
"objectType" : "person",
"localId" : "11241"
},
"payload" : {
"message" : "哟"
},
"published" : "2013-04-04T16:46:03"
}
],
"itemsPerPage" : 50,
"startIndex" : 1,
"totalResults" : 2
}

获取信息​

请求格式​

GET /social/api/restful/v2/chat/@app/channels/100/messages/12345612?fields=id%2Cactor%2Cpayload%2Cpublished

响应格式

200 OK HTTP/1.1
Content-Type: application/json; charset=utf-8

{
"id" : "100",
"actor" : {
"id" : "person:12345",
"objectType" : "person",
"localId" : "12345"
},
"payload" : {
"message" : "dollar underscore"
},
"published" : "2013-04-04T09:03:21"
}