提示

如果您需要专业团队为您和您的企业订制全网互通的协作工具可以通过 cube#spap.com 或者 xujiangwei#spap.com （将“#”替换为“@”）邮箱联系我们。

通信报文

目录


授权服务

信令操作

申请信令

  • 用于终端向服务器申请可用的访问令牌。

  • Action applyToken

  • C -> S

    字段

    类型

    必填

    描述

    domain

    string

    Y

    App 的访问域

    appKey

    string

    Y

    App 的 Key 串
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    授权服务状态码

    data

    JSON

    Y

    申请到的令牌数据，参看 Auth Token

获取指定令牌码的令牌

  • 用于通过令牌编码查找其对应的令牌信息。

  • Action getToken

  • C -> S

    字段

    类型

    必填

    描述

    code

    string

    Y

    令牌编码
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    授权服务状态码

    data

    JSON

    Y

    令牌数据，参看 Auth Token

联系人服务

终端操作

终端签入

  • 用于终端将指定联系人及其当前设备签入到服务器。签入操作是客户端获得一切服务操作的前提，服务器将签入的联系人及其提供的合法令牌进行绑定，从而授权签入联系人进行相关操作。

  • Action signIn

  • C -> S
    使用联系人和令牌签入

    字段

    类型

    必填

    描述

    self

    JSON

    Y

    当前终端的联系人描述，参看 Contact

    token

    JSON

    Y

    当前使用的令牌，参看 Auth Token
    使用令牌码签入

    字段

    类型

    必填

    描述

    code

    string

    Y

    当前有效令牌的令牌码，参看 Auth Token
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    签入的联系人数据，参看 Contact

终端签出

  • 用于将已签入的联系人及其设备签出。签出表示服务器不再为其提供服务，该联系人不再活跃。签出后的联系人可再次签入。

  • Action signOut

  • C -> S

    包负载

    描述

    当前终端的联系人

    参看 Contact
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    签出的联系人数据，参看 Contact

终端恢复

  • 对于暂时离线的终端，可以使用该操作恢复自身在服务器内的数据，不需要提供令牌数据，服务器会自动匹配之前使用的合法令牌。

  • Action comeback

  • C -> S

    包负载

    描述

    当前终端的联系人

    参看 Contact
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    恢复的联系人数据，参看 Contact

联系人操作

获取联系人数据

  • 通过联系人的 ID 查找对应联系人的数据。

  • Action getContact

  • C -> S

    字段

    类型

    必填

    描述

    id

    long

    Y

    联系人 ID

    domain

    string

    Y

    联系人所属的域
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    联系人数据，参看 Contact

获取联系人附录数据

  • 获取指定联系人对应的附录数据。

  • Action getAppendix

  • C -> S

    字段

    类型

    必填

    描述

    contactId

    long

    Y

    联系人 ID
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    联系人附录数据，参看 Contact Appendix

修改联系人数据

  • 用于客户端修改当前签入的联系人的数据，即修改“自己”的数据。

  • Action modifyContact

  • C -> S

    字段

    类型

    必填

    描述

    name

    string

    N

    联系人的名称。
    如果不设置该字段将不修改联系人名称。

    context

    JSON

    N

    联系人的上下文数据。
    如果不设置该字段将不修改上下文数据。
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    联系人数据，参看 Contact

更新联系人附录

  • 更新联系人关联的附录数据。

  • Action updateAppendix

  • C -> S

    字段

    类型

    必填

    描述

    contactId

    long

    Y

    附录的联系人 ID

    remarkName

    string

    N

    指定该联系人的新的备注名
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    联系人附录数据，参看 Contact Appendix

群组操作

获取群组数据

  • 通过群组的 ID 查找对应的群组数据。

  • Action getGroup

  • C -> S

    字段

    类型

    必填

    描述

    id

    long

    Y

    群组的 ID

    domain

    string

    Y

    群组所属的域
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    群组数据，参看 Group 。
    返回数据包含 members 数据。

获取群组附录数据

  • 获取指定群组对应的附录数据。

  • Action getAppendix

  • C -> S

    字段

    类型

    必填

    描述

    groupId

    long

    Y

    群组 ID
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    群组附录数据，参看 Group Appendix

按照最近活跃时间查找联系人的群组

  • 用于客户单列出所有当前签入的联系人所在的群组。查询条件为该群组的最近一次活跃时间。

  • Action listGroups

  • C -> S

    字段

    类型

    必填

    描述

    beginning

    long

    Y

    查询起始的最近一次活跃时间戳

    ending

    long

    N

    查询截止的最近一次活跃时间戳。
    如果不填写，使用当前实时时间戳。

    state

    int

    N

    查询 群组的状态 。
    如果不填写，默认使用 Normal 状态。

    pageSize

    int

    N

    指定返回数据时每个数据包内包含的群组数量。
    如果不填写，默认指定为 4 。
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    查找到的群组列表数据。JSON 字段包括：

    list - Array< Group > ： 每页的群组列表。

    total - int ： 满足查询条件的群组总数量。

    注解

    以上数据包服务器会按照 pageSize 指定的规则发送给客户端，因此客户端需要多次处理 listGroups 数据包。

创建群组

  • 创建新的群组。

  • Action createGroup

  • C -> S

    字段

    类型

    必填

    描述

    group

    JSON

    Y

    群组数据，参看 Group

    members

    Array<long>

    Y

    群组的成员 ID 的数组
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    群组数据，参看 Group

解散群组

  • 解散指定的群组，只有该群组的群主才能解散该群。

  • Action dismissGroup

  • C -> S

    包负载

    描述

    请求解散的群组

    参看 Group
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    被解散的群组数据，参看 Group

添加联系人到群组

  • 向指定的群组添加联系人。

  • Action addGroupMember

  • C -> S

    字段

    类型

    必填

    描述

    groupId

    long

    Y

    群组的 ID

    memberIdList

    Array<long>

    Y

    加入群组的联系人 ID

    operator

    JSON

    Y

    执行该操作的操作员，参看 Contact
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    群组的变化数据，参看 Group Bundle

移除群组里的联系人

  • 从指定群组移除联系人。

  • Action removeGroupMember

  • C -> S

    字段

    类型

    必填

    描述

    groupId

    long

    Y

    群组的 ID

    memberIdList

    Array<long>

    Y

    加入群组的联系人 ID

    operator

    JSON

    Y

    执行该操作的操作员，参看 Contact
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    群组的变化数据，参看 Group Bundle

修改群组基础数据

  • 修改群组的基础数据，包括群组名称、群主（群组所有者）和上下文数据等。

  • Action modifyGroup

  • C -> S

    字段

    类型

    必填

    描述

    groupId

    OR

    id

    long

    Y

    群组的 ID

    ownerId

    long

    N

    群组新的群主 ID

    owner

    JSON

    N

    群组新的群主，参看 Contact

    name

    string

    N

    新的群组名称

    context

    JSON

    N

    新的群组的上下文数据
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    新的群组数据，参看 Group

更新群组附录

  • 更新群组关联的附录数据。

  • Action updateAppendix

  • C -> S

    字段

    类型

    必填

    描述

    groupId

    long

    Y

    附录的群组 ID

    notice

    string

    N

    群组公告内容

    memberRemark

    JSON

    N

    指定群成员备注名。JSON 结构：

    id - long ：成员的 ID

    name - string ： 成员的备注名

    remark

    string

    N

    指定对该群的备注

    following

    boolean

    N

    指定是否关注该群组

    memberNameDisplayed

    boolean

    N

    指定群组是否显示群成员名称

    commId

    long

    N

    指定群组当前的通讯 ID
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    群组附录数据，参看 Group Appendix

联系人分区操作

创建分区

  • 创建指定名称的新分区。

  • Action createContactZone

  • C -> S

    字段

    类型

    必填

    描述

    name

    string

    Y

    分区名称

    participants

    Array<JSON>

    N

    分区参与人列表。
    列表里存储参与人的 JSON 数据，
    参看 Contact Zone Participant

    displayName

    string

    N

    指定分区的显示名

    peerMode

    boolean

    N

    指定是否使用对等模式。
    默认值： false
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    新的分区，参看 Contact Zone

删除分区

  • 删除指定名称的分区。

  • Action deleteContactZone

  • C -> S

    字段

    类型

    必填

    描述

    name

    string

    Y

    分区名称
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    客户端发送的数据，JSON 结构：

    name - string ： 被删除的分区名称。

获取分区数据

  • 获取指定名称的分区数据。

  • Action getContactZone

  • C -> S

    字段

    类型

    必填

    描述

    name

    string

    Y

    分区名称

    compact

    boolean

    N

    是否返回紧凑结构，紧凑结构不包括参与人列表
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    分区数据，参看 Contact Zone 。
    如果请求数据设置 compact 为 true ，
    则 Contact Zone 数据没有 participants 字段。

添加参与人到指定分区

  • 向指定分区添加参与人。

  • Action addParticipantToZone

  • C -> S

    字段

    类型

    必填

    描述

    name

    string

    Y

    分区名称

    participant

    JSON

    Y

    待添加的分区参与人，参看 Contact Zone Participant
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    JSON 结构：

    name - string ： 分区名称

    participant - JSON ： 添加的参与人 Contact Zone Participant

    timestamp - long ： 新的分区时间戳

从指定分区删除参与人

  • 将指定的参与人从分区移除。

  • Action removeParticipantFromZone

  • C -> S

    字段

    类型

    必填

    描述

    name

    string

    Y

    分区名称

    participant

    JSON

    Y

    待删除的分区参与人，参看 Contact Zone Participant
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    JSON 结构：

    name - string ： 分区名称

    participant - JSON ： 删除的参与人 Contact Zone Participant

    timestamp - long ： 新的分区时间戳

修改分区参与人数据

分区是否包含指定参与人

  • 判断指定的参与人是否已经在指定分区里。

  • Action containsParticipantInZone

  • C -> S

    字段

    类型

    必填

    描述

    name

    string

    Y

    分区名称

    participantId

    long

    Y

    指定参与人 ID
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    参看 联系人服务状态码

    data

    JSON

    Y

    JSON 结构：
    contained - boolean ： 是否包含指定的参与人
    name - string ： 分区名称
    participantId - long ： 参与人 ID

文件存储服务

文件数据流操作

数据上传

  • 使用 HTTP 协议分块上传文件数据。

  • URI : /filestorage/file/

  • Content-Type : application/octet-stream

  • Form fields :

    字段

    类型

    必填

    描述

    cid

    long

    Y

    当前上传数据的联系人 ID

    domain

    string

    Y

    当前工作域

    fileSize

    long

    Y

    文件大小，单位：字节

    lastModified

    long

    Y

    文件最近一次修改时间

    cursor

    long

    Y

    当前文件区块游标

    size

    int

    Y

    当前文件区块大小，单位：字节
  • HTTP Response
    • FormatJSON

      字段

      类型

      必填

      描述

      code

      int

      Y

      状态码，参看 文件存储服务状态码

      data

      JSON

      Y

      负载数据
    • data 格式 :

      字段

      类型

      必填

      描述

      fileName

      string

      Y

      文件名

      fileSize

      long

      Y

      文件大小，单位：字节

      fileCode

      string

      Y

      文件码

      lastModified

      long

      Y

      文件修改时间

      position

      long

      Y

      当前上传块所在文件的结束位置

数据下载

  • 使用 HTTP/HTTPS 协议载入文件数据。参看 File Label 的 fileURL 和 fileSecureURL 字段。


文件/目录操作

获取文件信息

  • 通过指定文件码获取文件信息。

  • Action getFile

  • C -> S

    字段

    类型

    必填

    描述

    fileCode

    string

    Y

    文件码
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 文件存储服务状态码

    data

    JSON

    Y

    参看 File Label

获取指定实体的根目录

  • 用于客户端获取签入联系人和相关群组的根文件目录。 魔方会为每个联系人和群组生成默认的根存储目录。

  • Action getRoot

  • C -> S

    字段

    类型

    必填

    描述

    id

    long

    Y

    联系人 ID 或群组 ID
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 文件存储服务状态码

    data

    JSON

    Y

    参看 Directory

获取目录下的子目录列表

  • 获取指定目录下的所有子目录。

  • Action listDirs

  • C -> S

    字段

    类型

    必填

    描述

    root

    long

    Y

    根目录 ID

    id

    long

    Y

    指定目录的 ID
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 文件存储服务状态码

    data

    JSON

    Y

    JSON 字段：

    root - long ： 根目录 ID

    id - long ： 目录 ID

    list - Array< Directory > ：目录列表

获取目录下的文件列表

  • 获取指定目录下的满足条件的文件。

  • Action listFiles

  • C -> S

    字段

    类型

    必填

    描述

    root

    long

    Y

    根目录 ID

    id

    long

    Y

    指定目录的 ID

    begin

    int

    Y

    查询的起始索引

    end

    int

    Y

    查询的结束索引
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 文件存储服务状态码

    data

    JSON

    Y

    JSON 字段：

    root - long ： 根目录 ID

    id - long ： 目录 ID

    begin - int ： 起始索引

    end - int ： 结束索引

    list - Array< File Label > ：文件标签列表

创建新目录

  • 在指定目录下创建新目录。

  • Action newDir

  • C -> S

    字段

    类型

    必填

    描述

    root

    long

    Y

    根目录 ID

    workingId

    long

    Y

    工作目录的 ID

    dirName

    string

    Y

    新目录名
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 文件存储服务状态码

    data

    JSON

    Y

    参看 Directory

删除子目录

  • 删除指定目录下的子目录，可以进行批量删除或者递归删除。

  • Action deleteDir

  • C -> S

    字段

    类型

    必填

    描述

    root

    long

    Y

    根目录 ID

    workingId

    long

    Y

    工作目录的 ID

    dirList

    Array<long>

    Y

    待删除目录的 ID 列表

    recursive

    boolean

    Y

    是否递归删除

    注解

    当 recursive 设置为 false 时，待删除目录不为空目录时则无法删除该目录。

  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 文件存储服务状态码

    data

    JSON

    Y

    JSON 字段：

    workingId - long ：工作目录 ID

    workingDir - Directory ：工作目录

    deletedList - Array< Directory > ：被删除的目录清单

重命名目录

  • 重新命名指定的目录。

  • Action renameDir

  • C -> S

    字段

    类型

    必填

    描述

    root

    long

    Y

    根目录 ID

    workingId

    long

    Y

    工作目录的 ID

    dirName

    string

    Y

    新的目录名
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 文件存储服务状态码

    data

    JSON

    Y

    参看 Directory

将文件插入到目录

  • 将文件插入到指定的目录。

  • Action insertFile

  • C -> S

    字段

    类型

    必填

    描述

    root

    long

    Y

    根目录 ID

    dirId

    long

    Y

    目标目录的 ID

    fileCode

    string

    Y

    指定待插入的文件的文件码
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 文件存储服务状态码

    data

    JSON

    Y

    JSON 结构：

    directory - Directory ：操作的目录数据。

    file - File Label ：插入文件的文件标签。

将文件从目录删除

  • 将指定文件从指定目录删除。支持批量操作。

  • Action deleteFile

  • C -> S

    字段

    类型

    必填

    描述

    root

    long

    Y

    根目录 ID

    workingId

    long

    Y

    工作目录的 ID

    fileList

    Array<string>

    Y

    待删除的文件的文件码。
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 文件存储服务状态码

    data

    JSON

    Y

    JSON 结构：

    workingId - long ：工作目录 ID

    workingDir - Directory ：工作的目录数据。

    deletedList - Array< File Label > ：已删除的文件标签。

即时消息服务

会话操作

获取会话列表

  • 获取最近有消息记录的会话列表。

  • Action getConversations

  • C -> S

    字段

    类型

    必填

    描述

    limit

    int

    Y

    获取会话的最大数量
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 即时消息服务状态码

    data

    JSON

    Y

    JSON 结构：

    total - int ：会话总数。

    list - Array< Conversation > ：会话列表。

更新会话

  • 用于客户端更新指定的会话数据

  • Action updateConversation

  • C -> S

    包负载

    描述

    会话数据

    参看 Conversation
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 即时消息服务状态码

    data

    JSON

    Y

    会话数据，参看 Conversation

消息操作

拉取消息

  • 从服务器拉取消息。

  • Action pull

  • C -> S

    字段

    类型

    必填

    描述

    id

    long

    Y

    签入的联系人的 ID

    domain

    string

    Y

    签入的联系人的域

    device

    JSON

    Y

    当前拉取消息的设备，参看 Device

    beginning

    long

    Y

    消息时间戳的起始时间

    ending

    long

    Y

    消息时间戳的结束时间
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 即时消息服务状态码

    data

    JSON

    Y

    JSON 结构：

    total - int ：总数量。

    beginning - long ：消息拉取的起始时间戳。

    ending - long ：消息拉取的结束时间戳。

    messages - Array< Message > ：消息列表。

    小技巧

    服务器将最多 10 条消息数据打包在一个应答包里发送给客户端，因此客户端需要多次处理 pull 数据包。

发送消息

  • 将指定消息推送到服务器，服务器将即时投送消息到指定收件人。

  • Action push

  • C -> S

    包负载

    描述

    消息数据

    参看 Message
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 即时消息服务状态码

    data

    JSON

    Y

    消息数据，参看 Message

消息通知

  • 终端在线时收到服务器推送的消息数据。

  • Action notify

  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 即时消息服务状态码

    data

    JSON

    Y

    消息数据，参看 Message

标记消息已读

  • 将指定消息标记为已读。服务器会实时将已读状态发送给相关联系人。

  • Action read

  • C -> S
    对单条消息进行标记

    字段

    类型

    必填

    描述

    contactId

    long

    Y

    当前签入的联系人 ID

    messageId

    long

    Y

    消息 ID
    对消息进行批量标记

    字段

    类型

    必填

    描述

    contactId

    long

    Y

    当前签入的联系人 ID

    messageIdList

    Array<long>

    Y

    消息 ID 列表

    messageFrom

    long

    Y

    该次操作的消息发件人 ID
    对消息进行批量标记

    字段

    类型

    必填

    描述

    contactId

    long

    Y

    当前签入的联系人 ID

    messageIdList

    Array<long>

    Y

    消息 ID 列表

    messageSource

    long

    Y

    该次操作的消息的群组
  • S -> C [仅应答]

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 即时消息服务状态码

    data

    JSON

    Y

    客户端发送的请求数据
  • S -> C [仅通知]

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 即时消息服务状态码

    data

    JSON

    Y

    被标记的消息，参看 Message

撤回消息

  • 在有效时间内撤回已发送的消息。

  • Action recall

  • C -> S

    字段

    类型

    必填

    描述

    contactId

    long

    Y

    消息所属的联系人 ID

    messageId

    long

    Y

    撤回消息的 ID
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 即时消息服务状态码

    data

    JSON

    Y

    JSON 结构：

    contactId - long ：联系人 ID

    messageId - long ：消息 ID

    注解

    客户端需要多次处理该数据报文。服务器会实时将被撤回的消息发送给客户端。

删除消息

  • 删除消息。该操作会联动联系人的所有终端删除指定消息。

  • Action delete

  • C -> S

    字段

    类型

    必填

    描述

    contactId

    long

    Y

    消息所属的联系人 ID

    messageId

    long

    Y

    删除消息的 ID
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 即时消息服务状态码

    data

    JSON

    Y

    JSON 结构：

    contactId - long ：联系人 ID

    messageId - long ：消息 ID

查询消息状态

  • 查询指定消息的状态。消息的管理通过消息的状态进行体现。

  • Action queryState

  • C -> S

    字段

    类型

    必填

    描述

    contactId

    long

    Y

    消息所属的联系人 ID

    messageId

    long

    Y

    消息的 ID
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 即时消息服务状态码

    data

    JSON

    Y

    消息数据，参看 Message

多方通讯服务

通讯场域操作

获取场域数据

  • 获取场域的数据。

  • Action getField

  • C -> S

    字段

    类型

    必填

    描述

    commFieldId

    long

    Y

    场域 ID
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 多方通讯服务状态码

    data

    JSON

    Y

    场域数据，参看 Comm Field

创建场域数据

  • 创建新的场域。

  • Action createField

  • C -> S

    包负载

    描述

    场域的数据

    参看 Comm Field
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 多方通讯服务状态码

    data

    JSON

    Y

    场域数据，参看 Comm Field

销毁场域数据

  • 销毁指定的场域。

  • Action destroyField

  • C -> S

    字段

    类型

    必填

    描述

    commFieldId

    long

    Y

    场域 ID
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 多方通讯服务状态码

    data

    JSON

    Y

    场域数据，参看 Comm Field

通话操作

申请发起通话

  • 用于客户端申请在指定场域内通话。

  • Action applyCall

  • C -> S

    字段

    类型

    必填

    描述

    field

    JSON

    Y

    场域数据，参看 Comm Field

    participant

    JSON

    Y

    参与人，参看 Contact

    device

    JSON

    Y

    参与人使用的设备，参看 Device
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 多方通讯服务状态码

    data

    JSON

    Y

    场域数据，参看 Comm Field

申请加入场域

  • 用于客户端申请加入场域进行通话。

  • Action applyJoin

  • C -> S

    字段

    类型

    必填

    描述

    field

    JSON

    Y

    场域数据，参看 Comm Field

    participant

    JSON

    Y

    参与人，参看 Contact

    device

    JSON

    Y

    参与人使用的设备，参看 Device
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 多方通讯服务状态码

    data

    JSON

    Y

    场域数据，参看 Comm Field

申请终止在场域内的通话

  • 用于客户端申请终止通话。

  • Action applyTerminate

  • C -> S

    字段

    类型

    必填

    描述

    field

    JSON

    Y

    场域数据，参看 Comm Field

    participant

    JSON

    Y

    参与人，参看 Contact

    device

    JSON

    Y

    参与人使用的设备，参看 Device
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 多方通讯服务状态码

    data

    JSON

    Y

    场域数据，参看 Comm Field

媒体数据信令

进行 Offer

  • Action offer

  • C -> S

    包负载

    描述

    信令数据

    参看 Signaling
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 多方通讯服务状态码

    data

    JSON

    Y

    信令数据，参看 Signaling

    小技巧

    客户端需要处理来自服务器的 offer 动作，以提示用户有新的通话请求。

  • Response Action offerAck

  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 多方通讯服务状态码

    data

    JSON

    Y

    信令数据，参看 Signaling

    注解

    客户端的请求 offer 动作服务器应答动作为 offerAck 。

进行 Answer

  • Action answer

  • C -> S

    包负载

    描述

    信令数据

    参看 Signaling
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 多方通讯服务状态码

    data

    JSON

    Y

    信令数据，参看 Signaling

    小技巧

    客户端需要处理来自服务器的 answer 动作，以提示用户对方已经应答了通话。

  • Response Action answerAck

  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 多方通讯服务状态码

    data

    JSON

    Y

    信令数据，参看 Signaling

    注解

    客户端的请求 answer 动作服务器应答动作为 answerAck 。

进行 Bye

  • Action bye

  • C -> S

    包负载

    描述

    信令数据

    参看 Signaling
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 多方通讯服务状态码

    data

    JSON

    Y

    信令数据，参看 Signaling

    小技巧

    客户端需要处理来自服务器的 bye 动作，以提示用户对方已退出通话。

  • Response Action byeAck

  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 多方通讯服务状态码

    data

    JSON

    Y

    信令数据，参看 Signaling

    注解

    客户端的请求 bye 动作服务器应答动作为 byeAck 。

进行 Busy

  • Action busy

  • C -> S

    包负载

    描述

    信令数据

    参看 Signaling
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 多方通讯服务状态码

    data

    JSON

    Y

    信令数据，参看 Signaling

    小技巧

    客户端需要处理来自服务器的 busy 动作，以提示用户对方拒绝接通通话。

  • Response Action busyAck

  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 多方通讯服务状态码

    data

    JSON

    Y

    信令数据，参看 Signaling

    注解

    客户端的请求 busy 动作服务器应答动作为 busyAck 。

进行 Candidate

  • Action candidate

  • C -> S

    包负载

    描述

    信令数据

    参看 Signaling
  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 多方通讯服务状态码

    data

    JSON

    Y

    信令数据，参看 Signaling

    小技巧

    客户端需要处理来自服务器的 candidate 动作。

  • Response Action candidateAck

  • S -> C

    字段

    类型

    必填

    描述

    code

    int

    Y

    状态码，参看 多方通讯服务状态码

    data

    JSON

    Y

    信令数据，参看 Signaling

    注解

    客户端的请求 candidate 动作服务器应答动作为 candidateAck 。

发出多方邀请

参与终端已进入场域

参与终端已退出场域