aiobearychat.openapi.p2p_api

P2P 会话相关 API.

auto generated by script at 2017-08-24 21:50:13.459796. don’t edit it.

class aiobearychat.openapi.p2p_api.P2pAPI(requester: aiobearychat.abc.Requester, token: str, *, base_url: str, **kwargs)[源代码]

P2P 会话相关 API.

create(user_id: str, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]

创建一个 P2P 聊天会话。

官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/p2p.create.md

参数:user_id (str) – P2P 聊天另外一方的用户 id (示例: =bw52O)
返回:response. 一个 aiobearychat.sansio.Response 实例
返回类型:aiobearychat.sansio.Response

response.body 返回值示例:

response.status 等于 201 :

    {
      "id": "=bw52O",
      "team_id": "=bw52O",
      "vchannel_id": "=bw52O",
      "type": "p2p",
      "is_active": true,
      "is_member": true,
      "member_uids": [
        "=bw52O",
        "=bw52P"
      ],
      "latest_ts": 1485238998284
    }
info(p2p_channel_id: str, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]

返回一个 P2P 聊天会话的完整信息。

官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/p2p.info.md

参数:p2p_channel_id (str) – P2P 聊天会话 id (示例: =bw52O)
返回:response. 一个 aiobearychat.sansio.Response 实例
返回类型:aiobearychat.sansio.Response

response.body 返回值示例:

response.status 等于 200 :

    {
      "id": "=bw52O",
      "team_id": "=bw52O",
      "vchannel_id": "=bw52O",
      "type": "p2p",
      "is_active": true,
      "is_member": true,
      "member_uids": [
        "=bw52O",
        "=bw52P"
      ],
      "latest_ts": 1485238998284
    }
list(**requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]

返回 P2P 聊天会话列表,获取某个 P2P 会话的完整信息,请使用 p2p.info.

官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/p2p.list.md

返回:response. 一个 aiobearychat.sansio.Response 实例
返回类型:aiobearychat.sansio.Response

response.body 返回值示例:

response.status 等于 200 :

    [
      {
        "id": "=bw52O",
        "team_id": "=bw52O",
        "vchannel_id": "=bw52O",
        "type": "p2p",
        "is_active": true,
        "is_member": true,
        "member_uids": [
          "=bw52O",
          "=bw52P"
        ],
        "latest_ts": 1485238998284
      }
    ]