REST API 接入指南

Arkme REST API 面向服务端、脚本和桌面程序。本文包含连接方式、字段合同、调用示例和全部接口参考。

开始调用

API Key 应保存在服务端 Secret 中。浏览器页面应通过开发者自己的 Backend 或 BFF 调用，不应把 API Key 写入前端代码。

curl -X POST 'https://openapi.jotmo.cc/api/v1/profile/get' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{}'

所有成功响应使用同一结构：code 为 200，data 的字段由具体接口定义。调用失败时使用 HTTP 状态码和 message 判断原因；request_id 可用于问题排查。

{
  "code": 200,
  "message": "请求成功",
  "request_id": "request-example-1",
  "data": {}
}

能力目录

账号

• getCurrentUserProfile — POST /api/v1/profile/get — 获取当前用户资料
• getCurrentUserAccountBindings — POST /api/v1/account-bindings/get — 获取账号绑定状态

人物

• resolvePeople — POST /api/v1/people/resolve — 解析人物

聊天

• listChatConversations — POST /api/v1/chat/conversations/list — 列出可读会话
• queryChatConversations — POST /api/v1/chat/conversations/query — 查询聊天会话
• resolveChatConversations — POST /api/v1/chat/conversations/resolve — 解析可读会话
• listChatMembers — POST /api/v1/chat/members/list — 列出会话成员
• searchChatMessages — POST /api/v1/chat/messages/search — 搜索聊天消息
• queryChatMessages — POST /api/v1/chat/messages/query — 查询聊天消息
• batchGetChatMessages — POST /api/v1/chat/messages/batch-get — 批量读取聊天消息
• readChatMessageContext — POST /api/v1/chat/messages/context — 读取消息上下文
• resolveChatTargets — POST /api/v1/chat/targets/resolve — 解析消息发送目标
• createPrivateChats — POST /api/v1/chat/conversations/create-private — 创建真人私聊
• sendChatMessages — POST /api/v1/chat/messages/send — 批量发送聊天消息
• queryGroupMessageModerationTargets — POST /api/v1/chat/messages/moderation/query — 查询群消息治理对象
• withdrawGroupMessages — POST /api/v1/chat/messages/withdraw — 批量撤回群消息
• batchGetGroupMembers — POST /api/v1/chat/members/batch-get — 批量读取群成员状态
• removeGroupMembers — POST /api/v1/chat/members/remove — 批量移出群成员
• setGroupJoinRestrictions — POST /api/v1/chat/join-restrictions/set — 批量设置入群限制
• listGroupJoinRestrictions — POST /api/v1/chat/join-restrictions/list — 列出群入群限制

微信导入

• queryWechatImportConversations — POST /api/v1/wechat-import/conversations/query — 查询微信导入会话
• resolveWechatImportConversations — POST /api/v1/wechat-import/conversations/resolve — 解析微信导入会话
• batchGetWechatImportConversations — POST /api/v1/wechat-import/conversations/batch-get — 批量读取微信导入会话
• queryWechatImportMessages — POST /api/v1/wechat-import/messages/query — 查询微信导入消息
• batchGetWechatImportMessages — POST /api/v1/wechat-import/messages/batch-get — 批量读取微信导入消息
• listWechatImportGroupMembers — POST /api/v1/wechat-import/group-members/list — 列出微信导入群成员

录音

• queryRecordings — POST /api/v1/recordings/query — 查询录音
• resolveRecordingSpeakers — POST /api/v1/recordings/speakers/resolve — 解析录音说话人
• batchGetRecordings — POST /api/v1/recordings/batch-get — 批量读取录音
• queryRecordingTranscript — POST /api/v1/recordings/transcript/query — 查询录音转写
• queryRecordingSummaries — POST /api/v1/recordings/summaries/query — 查询录音总结与时间线
• readRecordingSummary — POST /api/v1/recordings/summaries/read — 读取录音总结与时间线

通话

• queryCalls — POST /api/v1/calls/query — 查询通话
• batchGetCalls — POST /api/v1/calls/batch-get — 批量读取通话
• queryCallTranscript — POST /api/v1/calls/transcript/query — 查询通话转写

记录

• listRecordContainers — POST /api/v1/record/containers/list — 列出记录主题
• resolveRecordContainers — POST /api/v1/record/containers/resolve — 解析记录主题
• queryRecordTimeline — POST /api/v1/record/timeline/query — 查询记录时间线
• searchRecords — POST /api/v1/record/search — 搜索记录
• batchGetRecords — POST /api/v1/record/records/batch-get — 批量读取记录
• createRecords — POST /api/v1/record/records/create — 批量创建记录
• updateRecords — POST /api/v1/record/records/update — 批量更新记录
• moveRecords — POST /api/v1/record/records/move — 批量移动记录
• deleteRecords — POST /api/v1/record/records/delete — 批量删除记录

安排

• queryArrangements — POST /api/v1/arrangement/query — 查询安排
• batchGetArrangements — POST /api/v1/arrangement/batch-get — 批量读取安排
• createArrangements — POST /api/v1/arrangement/create — 批量创建安排
• updateArrangements — POST /api/v1/arrangement/update — 批量更新安排
• transitionArrangements — POST /api/v1/arrangement/transition — 批量流转安排状态
• deleteArrangements — POST /api/v1/arrangement/delete — 批量删除安排

团队

• removeTeamMembers — POST /api/v1/teams/members/remove — 移除团队成员
• listMyTeams — POST /api/v1/teams/list — 列出我的团队
• resolveMyTeams — POST /api/v1/teams/resolve — 解析我的团队
• listTeamMembers — POST /api/v1/teams/members/list — 列出团队成员
• createTeams — POST /api/v1/teams/create — 创建团队
• joinTeamsByPublicID — POST /api/v1/teams/join-by-jotmo-id — 按即我号加入团队

世界

• queryWorldRecords — POST /api/v1/world/records/query — 查询世界动态
• batchGetWorldRecords — POST /api/v1/world/records/batch-get — 读取世界发布快照
• queryWorldReplies — POST /api/v1/world/replies/query — 查询世界评论
• publishWorldRecords — POST /api/v1/world/records/publish — 发布快记到世界
• unpublishWorldRecords — POST /api/v1/world/records/unpublish — 撤回世界发布
• queryWorldCandidates — POST /api/v1/world/candidates/query — 查询已有世界候选
• getWorldInteractionSummary — POST /api/v1/world/interactions/summary — 读取世界互动摘要
• markWorldInteractionsViewed — POST /api/v1/world/interactions/mark-viewed — 标记世界互动已查看

机器人

• queryBots — POST /api/v1/bots/query — 查询本人机器人
• batchGetBots — POST /api/v1/bots/batch-get — 读取机器人资料
• createBots — POST /api/v1/bots/create — 创建机器人
• updateBotProfiles — POST /api/v1/bots/profile/update — 更新机器人资料
• deleteBots — POST /api/v1/bots/delete — 删除机器人
• listGroupBotBindings — POST /api/v1/bots/group-bindings/list — 列举机器人群绑定
• installGroupBots — POST /api/v1/bots/group-bindings/install — 安装群机器人
• removeGroupBots — POST /api/v1/bots/group-bindings/remove — 移除群机器人
• setGroupBotContextPermissions — POST /api/v1/bots/group-bindings/context-permissions/set — 设置机器人群读取授权
• resolveBotConversations — POST /api/v1/bots/conversations/resolve — 定位机器人专属会话
• queryBotConversationMessages — POST /api/v1/bots/conversations/messages/query — 查询机器人会话历史
• queryBotRequestResult — POST /api/v1/bots/requests/result/query — 查询机器人请求结果
• sendBotRequests — POST /api/v1/bots/requests/send — 向机器人发送用户请求
• publishBotMessages — POST /api/v1/bots/messages/publish — 以机器人身份发布消息
• getBotWebhookSecurity — POST /api/v1/bots/webhook-security/get — 读取机器人 Webhook 安全设置
• setBotWebhookSecurity — POST /api/v1/bots/webhook-security/set — 设置机器人 Webhook 安全规则

标识与组合规则

不同标识不可互换。topic_uid 只表示个人主题；即我聊天使用 chat_session_uid，微信导入会话使用 conversation_uid。团队与群的成员关系独立；user_ref 可跨能力复用，成员权限由目标团队或群分别判断。持有标识不代表拥有读取权限。

speaker_index 和 sender_index 分别是本页 speakers 和 senders 的零基索引，不是人物标识，不可跨页或跨业务复用。只有返回了 user_ref 才可将该引用用于人物关联；不能仅按显示名合并身份，通话的 participant_side 也不代表参与人本人。微信导入群成员是导入快照中的当前名单，不是历史发言人集合或微信实时成员。

读取范围与完整性

录音查询的 order 缺省 asc，desc 从最新录音开始；最新指录音开始时间，不是上传或修改时间。时间条件按录音重叠范围筛选，有人物条件时要求该人物在范围内有有效话语。转写查询不继承列表筛选；省略时间窗时读取整条录音，显式传入 start_at/end_at 时，按重叠选择完整原句话语，不做字级时间裁剪。

已有稳定标识时可直接读取所需正文，无须先读取概览。录音和通话的批量读取返回概览或状态，转写正文由各自的转写查询分页返回。

已确认的即我账号使用 user_ref：录音对应 speaker_user_refs，通话对应 participant_user_refs，微信导入会话对应 participant_user_ref。录音与通话多目标取并集。微信无已绑定私聊时返回空，不代表没有相关微信数据；可按用户给出的微信名称解析候选，不推断账号绑定。录音标记名称使用说话人解析，微信备注名、昵称或群名使用微信导入会话解析；名称不自动合并身份。

解析与人物筛选均读取当前可见状态，不创建人物、会话或绑定。页间标记或绑定变化可能改变结果，需要一致重读时从第一页重新查询。空页仍应检查 has_more，扫描未结束不能断言不存在目标。

时间字段的单位、上下界是否包含、默认范围和排序以各能力字段合同为准，不跨业务套用。微信导入会话按最新消息时间筛选，消息按发送时间筛选；分析某段时间内的全部历史消息时，不要用同一时间窗预先排除会话，应不带时间条件枚举会话，再逐个查询目标时间范围内的消息。

需要覆盖整个查询范围时，按该能力的分页字段逐页读取，直到 has_more=false，不能按本页条数判断是否结束。使用不透明游标时，将返回的 next_page_cursor 原样传回 page_cursor，保持账号、能力、对象和筛选条件不变；limit 只控制单页大小，可以调整。每页处理后累计中间结果，需要引用时保留业务标识与原文定位信息。

分页结束只表示本次可读结果已读完，不保证业务数据完整。返回 found=false 表示当前不可读，不能推断对象不存在或已删除；转写还需判断 transcript_state，群成员还需判断 roster_state。媒体元数据也不等于可下载的媒体正文。

录音转写的 bounded 模式不通过继续分页补回截断句尾；需完整原话时改用 text_mode=full，从首页重新读取。full 模式按 utterance_index 和字符坐标拼接同一句的续片，不跨录音或结果快照复用话语序号；坐标以 Unicode code point 计数。truncated=true 表示当前项不是整句，不等于续读后仍缺正文。确认片段连续覆盖 text_total_length，并检查 transcript_state。通话转写及其他正文或名单仍按各自的截断合同处理，不能套用录音 full 模式或假定分页能补回截断内容。

录音总结是自动生成的参考内容；核对原话时读取转写，不必先读取或等待总结。已有 summary_uid 可直接读正文；需要选择版本时按覆盖时间查询。读取时先检查 found 和 content_state，仅 ready 返回正文，JSON 分片须拼齐后解析。查询和读取均不触发生成。

错误处理

写请求结果未知时，应使用完全相同的业务参数重试。接口包含 idempotency_key 时，同一业务意图必须复用原值，新的业务意图必须使用新值。批量结果按各接口的关联合同处理：包含 item_id 时逐项匹配；UID 数组精确读取按输入顺序与返回 UID 对应，并逐项检查可读状态。

字段表中的嵌套字段仅在其父对象存在时适用。

账号

获取当前用户资料

POST /api/v1/profile/get

返回当前 API Key 对应账号的昵称、即我号和创建时间，不返回登录凭据或联系方式。

Operation ID：getCurrentUserProfile

请求字段

无字段，请求体使用 {}。

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/profile/get' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{}'

返回字段

成功响应示例

{
  "code": 200,
  "data": {
    "created_at": 1700000000000,
    "jotmo_id": "xiaoming",
    "nickname": "小明",
    "user_ref": "usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

获取账号绑定状态

POST /api/v1/account-bindings/get

返回当前账号六种登录方式的绑定状态，不返回手机号、邮箱或第三方账号标识。

Operation ID：getCurrentUserAccountBindings

请求字段

无字段，请求体使用 {}。

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/account-bindings/get' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "items": [
      {
        "bound": true,
        "provider": "phone"
      },
      {
        "bound": false,
        "provider": "email"
      },
      {
        "bound": true,
        "provider": "wechat"
      },
      {
        "bound": false,
        "provider": "apple"
      },
      {
        "bound": false,
        "provider": "google"
      },
      {
        "bound": false,
        "provider": "huawei"
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

人物

解析人物

POST /api/v1/people/resolve

按昵称、联系人备注、即我号或“我/本人”分页查找当前账号具有真实业务关系的可见人物。

Operation ID：resolvePeople

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/people/resolve' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"item_id":"person-1","query":"小明","limit":5}]}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "items": [
      {
        "candidates": [
          {
            "display_name": "小明",
            "jotmo_id": "xiaoming",
            "relationships": [
              "contact",
              "private_chat"
            ],
            "user_ref": "usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
          }
        ],
        "has_more": false,
        "item_id": "person-1"
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

聊天

列出可读会话

POST /api/v1/chat/conversations/list

分页返回当前账号可读取的联系人、私聊和群聊会话，可按一个人物的参与关系筛选。该接口用于浏览会话，不保证每个结果都可作为消息发送目标。

Operation ID：listChatConversations

请求字段

枚举值说明

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/chat/conversations/list' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"scopes":["private_chat","group_chat"],"limit":50}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "has_more": false,
    "items": [
      {
        "chat_session_uid": "chat-session-1",
        "display_name": "小明",
        "kind": "direct",
        "scopes": [
          "private_chat"
        ]
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

查询聊天会话

POST /api/v1/chat/conversations/query

按会话当前最新可见消息时间范围查询联系人、私聊和群聊，可按一个人物的参与关系筛选；结果按最新消息时间稳定分页。

Operation ID：queryChatConversations

请求字段

枚举值说明

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/chat/conversations/query' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"scopes":["private_chat","group_chat"],"last_message_from":1700000000000,"limit":20}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "has_more": false,
    "items": [
      {
        "chat_session_uid": "chat-session-1",
        "display_name": "小明",
        "kind": "direct",
        "last_message_at": 1700001000000,
        "scopes": [
          "private_chat"
        ]
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

解析可读会话

POST /api/v1/chat/conversations/resolve

按名称或自然语言批量查找可读取的联系人、私聊和群聊会话，并分页返回稳定候选。

Operation ID：resolveChatConversations

请求字段

枚举值说明

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/chat/conversations/resolve' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"item_id":"conversation-1","query":"项目讨论群","scopes":["group_chat"],"limit":5}]}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "items": [
      {
        "candidates": [
          {
            "chat_session_uid": "chat-session-2",
            "display_name": "项目讨论群",
            "kind": "group",
            "scopes": [
              "group_chat"
            ]
          }
        ],
        "has_more": false,
        "item_id": "conversation-1"
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

列出会话成员

POST /api/v1/chat/members/list

分页列出一个当前可读会话中的有效真人成员，返回可跨能力复用的用户引用。

Operation ID：listChatMembers

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/chat/members/list' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"chat_session_uid":"chat-session-1","limit":50}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "has_more": false,
    "items": [
      {
        "display_name": "小明",
        "joined_at": 1699990000000,
        "role": "participant",
        "user_ref": "usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

搜索聊天消息

POST /api/v1/chat/messages/search

在一个或多个已知可读会话中按关键词搜索消息，可按发送人和消息时间筛选。

Operation ID：searchChatMessages

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/chat/messages/search' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"keyword":"同步进度","chat_session_uids":["chat-session-1"],"limit":20}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "has_more": false,
    "items": [
      {
        "chat_session_uid": "chat-session-1",
        "matched_fields": [
          "body"
        ],
        "message_at": 1700001000000,
        "sender_kind": "user",
        "sender_name": "小明",
        "sender_user_ref": "usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
        "sequence": 42,
        "snippet": "周五下午三点同步进度"
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

查询聊天消息

POST /api/v1/chat/messages/query

在指定会话和时间范围内查询可见消息，可按发送人筛选并通过游标继续读取；结果按会话分组，消息通过 sender_index 引用组内去重的发送者事实。

Operation ID：queryChatMessages

请求字段

枚举值说明

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/chat/messages/query' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"chat_session_uids":["chat-session-1"],"start_at":1700000000000,"end_at":1700086400000,"order":"session_time_asc","limit":100}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "has_more": false,
    "items": [
      {
        "chat_session_uid": "chat-session-1",
        "messages": [
          {
            "message_at": 1700001000000,
            "record_state": "available",
            "sender_index": 0,
            "sequence": 42,
            "text_content": "周五下午三点同步进度"
          }
        ],
        "senders": [
          {
            "sender_kind": "user",
            "sender_name": "小明",
            "sender_user_ref": "usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
          }
        ]
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

批量读取聊天消息

POST /api/v1/chat/messages/batch-get

按会话 UID 与会话内消息顺序号精确读取当前消息事实；适合在搜索或分析后取得完整当前文本。

Operation ID：batchGetChatMessages

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/chat/messages/batch-get' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"item_id":"message-1","chat_session_uid":"chat-session-1","sequence":42}]}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "items": [
      {
        "item_id": "message-1",
        "lookup_status": "found",
        "message": {
          "chat_session_uid": "chat-session-1",
          "message_at": 1700001000000,
          "mutable": true,
          "record_state": "available",
          "record_uid": "record-1",
          "record_version": 1,
          "sender_kind": "user",
          "sender_name": "小明",
          "sender_user_ref": "usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
          "sequence": 42,
          "text_content": "周五下午三点同步进度"
        }
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

读取消息上下文

POST /api/v1/chat/messages/context

围绕同一会话内的指定消息顺序号读取有界上下文；消息通过 sender_index 引用去重的发送者事实。

Operation ID：readChatMessageContext

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/chat/messages/context' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"chat_session_uid":"chat-session-1","sequences":[42]}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "anchor_sequences": [
      42
    ],
    "chat_session_uid": "chat-session-1",
    "messages": [
      {
        "message_at": 1700001000000,
        "record_state": "available",
        "sender_index": 0,
        "sequence": 42,
        "text_content": "周五下午三点同步进度"
      }
    ],
    "senders": [
      {
        "sender_kind": "user",
        "sender_name": "小明",
        "sender_user_ref": "usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

解析消息发送目标

POST /api/v1/chat/targets/resolve

按名称或人物引用批量解析允许发送消息的私聊或群聊目标。发送消息前使用该接口取得目标会话 UID。

Operation ID：resolveChatTargets

请求字段

枚举值说明

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/chat/targets/resolve' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"item_id":"target-1","target_user_ref":"usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA","scopes":["private_chat"],"limit":5}]}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "items": [
      {
        "candidates": [
          {
            "chat_session_uid": "chat-session-1",
            "display_name": "小明",
            "kind": "direct",
            "participant_user_ref": "usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
            "scopes": [
              "private_chat"
            ]
          }
        ],
        "has_more": false,
        "item_id": "target-1"
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

创建真人私聊

POST /api/v1/chat/conversations/create-private

用户明确要求联系指定真人时，创建或取得双方唯一私聊。输入公开用户引用；不加联系人、不发送消息、不打开 UI。Bot 专属会话由 Bot 工具定位。

Operation ID：createPrivateChats

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/chat/conversations/create-private' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"item_id":"one","target_user_ref":"usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA","idempotency_key":"private-1"}]}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "items": [
      {
        "chat_session_uid": "chat-1",
        "item_id": "one",
        "status": "succeeded",
        "target_user_ref": "usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

批量发送聊天消息

POST /api/v1/chat/messages/send

向已解析的私聊或群聊目标批量发送纯文本消息。每一项使用稳定幂等键，结果与输入项关联。

Operation ID：sendChatMessages

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/chat/messages/send' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"item_id":"message-1","idempotency_key":"send.project-sync.001","chat_session_uid":"chat-session-1","text_content":"周五下午三点同步进度","send_at":1700001000000}]}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "items": [
      {
        "chat_session_uid": "chat-session-1",
        "item_id": "message-1",
        "record_uid": "record-1",
        "sequence": 42,
        "target_kind": "direct",
        "target_name": "小明"
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

查询群消息治理对象

POST /api/v1/chat/messages/moderation/query

当前有效群主按真人发送者和可选时间分页读取消息坐标与治理状态，不返回正文；空页仍检查 has_more。upper_sequence 是扫描上界，不是快照。

Operation ID：queryGroupMessageModerationTargets

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/chat/messages/moderation/query' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"chat_session_uid":"019d8590-ebb4-7232-90f2-000000000481","sender_user_refs":["usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"],"limit":100}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "has_more": false,
    "items": [
      {
        "eligible": true,
        "message_at": 1700000000000,
        "sender_user_ref": "usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
        "sequence": 1201,
        "withdrawal_state": "active"
      }
    ],
    "upper_sequence": 1201
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

批量撤回群消息

POST /api/v1/chat/messages/withdraw

用户明确要求撤回他人群消息时，直接传 chat_session_uid 与 sequence；不要求额外解析。原群时间线与群内搜索不再展示；本人个人搜索保留记录且不展示该群来源。不删除原始记录，不移出发送者。结果未知时同参数重试；原群时间线与群内搜索不再展示，本人个人搜索保留记录且不展示该群来源。

Operation ID：withdrawGroupMessages

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/chat/messages/withdraw' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"item_id":"message-1","chat_session_uid":"019d8590-ebb4-7232-90f2-000000000481","sequence":1201}]}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "items": [
      {
        "changed": true,
        "chat_session_uid": "019d8590-ebb4-7232-90f2-000000000481",
        "item_id": "message-1",
        "sequence": 1201,
        "status": "succeeded",
        "withdrawn_at": 1700000100000
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

批量读取群成员状态

POST /api/v1/chat/members/batch-get

当前有效群主按已知 user_ref 精确读取当前或历史成员状态；已知必要事实时无需重复读取。

Operation ID：batchGetGroupMembers

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/chat/members/batch-get' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"item_id":"member-1","chat_session_uid":"019d8590-ebb4-7232-90f2-000000000481","target_user_ref":"usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"}]}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "items": [
      {
        "chat_session_uid": "019d8590-ebb4-7232-90f2-000000000481",
        "found": true,
        "item_id": "member-1",
        "member": {
          "join_restricted": true,
          "joined_at": 1700000000000,
          "membership_status": "removed",
          "role": "participant"
        },
        "target_user_ref": "usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

批量移出群成员

POST /api/v1/chat/members/remove

用户明确要求移出时使用；prevent_rejoin=true 原子移出并限制，false 不解除已有限制。结果未知时先核对当前成员状态；重新入群后需重新确认操作意图。

Operation ID：removeGroupMembers

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/chat/members/remove' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"item_id":"member-1","chat_session_uid":"019d8590-ebb4-7232-90f2-000000000481","target_user_ref":"usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA","prevent_rejoin":true}]}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "items": [
      {
        "chat_session_uid": "019d8590-ebb4-7232-90f2-000000000481",
        "item_id": "member-1",
        "member": {
          "join_restricted": true,
          "joined_at": 1700000000000,
          "membership_status": "removed",
          "role": "participant"
        },
        "status": "succeeded",
        "target_user_ref": "usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

批量设置入群限制

POST /api/v1/chat/join-restrictions/set

用户明确要求时设置 restricted=true 或解除 false；既不移出当前成员，也不自动拉人入群。结果未知时核对当前限制状态。

Operation ID：setGroupJoinRestrictions

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/chat/join-restrictions/set' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"item_id":"member-1","chat_session_uid":"019d8590-ebb4-7232-90f2-000000000481","target_user_ref":"usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA","restricted":true}]}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "items": [
      {
        "chat_session_uid": "019d8590-ebb4-7232-90f2-000000000481",
        "item_id": "member-1",
        "member": {
          "join_restricted": true,
          "joined_at": 1700000000000,
          "membership_status": "removed",
          "role": "participant"
        },
        "status": "succeeded",
        "target_user_ref": "usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

列出群入群限制

POST /api/v1/chat/join-restrictions/list

当前有效群主分页读取受限制人物的 user_ref 和限制设置时间。已知目标时可直接调用设置能力。

Operation ID：listGroupJoinRestrictions

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/chat/join-restrictions/list' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"chat_session_uid":"019d8590-ebb4-7232-90f2-000000000481","limit":30}'

返回字段

成功响应示例

{
  "code": 200,
  "data": {
    "has_more": false,
    "items": [
      {
        "display_name": "群内小王",
        "restricted_at": 1700000100000,
        "user_ref": "usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

微信导入

查询微信导入会话

POST /api/v1/wechat-import/conversations/query

按最新消息时间分页读取微信导入会话；participant_user_ref 仅筛选当前账号已绑定该人的私聊，没有绑定返回空。不返回 wxid、外部会话 ID 或内部绑定字段。

Operation ID：queryWechatImportConversations

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/wechat-import/conversations/query' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"start_at":1700000000000,"end_at":1700086400000,"limit":20}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "has_more": false,
    "items": [
      {
        "conversation_uid": "wechat-session-1",
        "display_name": "项目讨论群",
        "emoji_count": 8,
        "first_sent_at": 1699000000000,
        "image_count": 24,
        "imported_at": 1700080000000,
        "kind": "group",
        "last_sent_at": 1700001000000,
        "message_count": 328,
        "version": 1700080000000,
        "video_count": 2,
        "voice_count": 12
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

解析微信导入会话

POST /api/v1/wechat-import/conversations/resolve

按导入快照中的备注名、昵称或群名分页返回候选。名称不是账号绑定；取得 conversation_uid 后按消息时间读取消息。has_more 为 true 时继续翻页，空页不代表没有候选。

Operation ID：resolveWechatImportConversations

请求字段

枚举值说明

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/wechat-import/conversations/resolve' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"item_id":"wechat-1","query":"项目群","kind":"group","limit":5}]}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "items": [
      {
        "candidates": [
          {
            "conversation_uid": "wechat-conversation-1",
            "display_name": "项目群",
            "kind": "group"
          }
        ],
        "has_more": false,
        "item_id": "wechat-1"
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

批量读取微信导入会话

POST /api/v1/wechat-import/conversations/batch-get

按输入 UID 顺序精确读取微信导入会话快照。

Operation ID：batchGetWechatImportConversations

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/wechat-import/conversations/batch-get' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"conversation_uids":["wechat-session-1"]}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "items": [
      {
        "conversation": {
          "conversation_uid": "wechat-session-1",
          "display_name": "项目讨论群",
          "emoji_count": 8,
          "first_sent_at": 1699000000000,
          "image_count": 24,
          "imported_at": 1700080000000,
          "kind": "group",
          "last_sent_at": 1700001000000,
          "message_count": 328,
          "version": 1700080000000,
          "video_count": 2,
          "voice_count": 12
        },
        "conversation_uid": "wechat-session-1",
        "found": true
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

查询微信导入消息

POST /api/v1/wechat-import/messages/query

在一个微信导入会话内按时间和消息类型稳定分页；消息通过 sender_index 引用本页发送人。

Operation ID：queryWechatImportMessages

请求字段

枚举值说明

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/wechat-import/messages/query' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"conversation_uid":"wechat-session-1","kinds":["text","voice"],"limit":20}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "conversation_uid": "wechat-session-1",
    "found": true,
    "has_more": false,
    "items": [
      {
        "content_truncated": false,
        "has_media": false,
        "kind": "text",
        "message_uid": "64b64c2f9b8c1a2d3e4f5679",
        "sender_index": 0,
        "sent_at": 1700001000000,
        "text_content": "周五同步项目进度"
      }
    ],
    "senders": [
      {
        "display_name": "小明",
        "is_self": false
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

批量读取微信导入消息

POST /api/v1/wechat-import/messages/batch-get

按输入 UID 顺序精确读取微信导入消息和自包含发送人事实。

Operation ID：batchGetWechatImportMessages

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/wechat-import/messages/batch-get' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"message_uids":["64b64c2f9b8c1a2d3e4f5679"]}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "items": [
      {
        "found": true,
        "message": {
          "content_truncated": false,
          "conversation_uid": "wechat-session-1",
          "has_media": false,
          "kind": "text",
          "message_uid": "64b64c2f9b8c1a2d3e4f5679",
          "sender": {
            "display_name": "小明",
            "is_self": false
          },
          "sent_at": 1700001000000,
          "text_content": "周五同步项目进度"
        },
        "message_uid": "64b64c2f9b8c1a2d3e4f5679"
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

列出微信导入群成员

POST /api/v1/wechat-import/group-members/list

稳定分页读取导入快照中的当前群成员，先判断 roster_state；不是微信实时成员或历史发言人集合。

Operation ID：listWechatImportGroupMembers

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/wechat-import/group-members/list' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"conversation_uid":"wechat-session-1","limit":20}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "conversation_uid": "wechat-session-1",
    "has_more": false,
    "items": [
      {
        "display_name": "小明",
        "is_friend": true,
        "is_self": false
      }
    ],
    "roster_state": "available"
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

录音

查询录音

POST /api/v1/recordings/query

按时间及可选的 speaker_user_refs、speaker_uids 读取当前账号录音元数据；人物条件取并集；时间按录音重叠范围筛选，有人物条件时需该人物在范围内有有效话语。order 缺省 asc，desc 从最新录音开始，不按关键词搜索。

Operation ID：queryRecordings

请求字段

枚举值说明

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/recordings/query' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"start_at":1700000000000,"end_at":1700086400000,"limit":20}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "has_more": false,
    "items": [
      {
        "duration_ms": 1800000,
        "end_at": 1700002800000,
        "ingest_origin": "user_client",
        "name": "项目访谈",
        "recording_uid": "64b64c2f9b8c1a2d3e4f5678",
        "sealed": true,
        "source": "long",
        "start_at": 1700001000000,
        "transcript_state": "ready",
        "version": 2
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

解析录音说话人

POST /api/v1/recordings/speakers/resolve

按当前账号的说话人标记名称分页返回候选，不搜索正文；选择 speaker_uid 后查询录音。has_more 为 true 时继续翻页，空页不代表没有候选。

Operation ID：resolveRecordingSpeakers

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/recordings/speakers/resolve' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"item_id":"speaker-1","query":"张三","limit":5}]}'

返回字段

成功响应示例

{
  "code": 200,
  "data": {
    "items": [
      {
        "candidates": [
          {
            "display_name": "张三",
            "speaker_uid": "64b64c2f9b8c1a2d3e4f5679"
          }
        ],
        "has_more": false,
        "item_id": "speaker-1"
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

批量读取录音

POST /api/v1/recordings/batch-get

按输入 UID 顺序精确读取当前账号可见的录音元数据和转写状态。

Operation ID：batchGetRecordings

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/recordings/batch-get' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"recording_uids":["64b64c2f9b8c1a2d3e4f5678"]}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "items": [
      {
        "found": true,
        "recording": {
          "duration_ms": 1800000,
          "end_at": 1700002800000,
          "ingest_origin": "user_client",
          "name": "项目访谈",
          "recording_uid": "64b64c2f9b8c1a2d3e4f5678",
          "sealed": true,
          "source": "long",
          "start_at": 1700001000000,
          "transcript_state": "ready",
          "version": 2
        },
        "recording_uid": "64b64c2f9b8c1a2d3e4f5678"
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

查询录音转写

POST /api/v1/recordings/transcript/query

分页读取一条录音的规范转写；话语通过 speaker_index 引用本页说话人，正文完整性需结合 transcript_state 和 truncated 判断。

Operation ID：queryRecordingTranscript

请求字段

枚举值说明

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/recordings/transcript/query' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"recording_uid":"64b64c2f9b8c1a2d3e4f5678","start_at":1700001000000,"end_at":1700002800000,"text_mode":"full","limit":100}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "found": true,
    "has_more": false,
    "recording_uid": "64b64c2f9b8c1a2d3e4f5678",
    "speakers": [
      {
        "display_name": "我",
        "kind": "user",
        "user_ref": "usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "transcript_state": "ready",
    "utterances": [
      {
        "end_offset_ms": 3200,
        "speaker_index": 0,
        "start_offset_ms": 1000,
        "text": "我们先确认下周的计划",
        "text_end_offset": 10,
        "text_start_offset": 0,
        "text_total_length": 10,
        "truncated": false,
        "utterance_index": 0
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

查询录音总结与时间线

POST /api/v1/recordings/summaries/query

按覆盖时间查询当前账号已保存的录音日总结和时间线版本元信息，不含正文，不触发生成。

Operation ID：queryRecordingSummaries

请求字段

枚举值说明

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/recordings/summaries/query' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"start_at":1699977600000,"end_at":1700064000000,"limit":20}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "has_more": false,
    "items": [
      {
        "content_origin": "business_recording_summary",
        "created_at": 1700064000000,
        "day_start_at": 1699977600000,
        "end_at": 1700064000000,
        "generation_state": "completed",
        "kind": "daily_summary",
        "start_at": 1699977600000,
        "summary_uid": "64b64c2f9b8c1a2d3e4f5681",
        "updated_at": 1700064100000
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

读取录音总结与时间线

POST /api/v1/recordings/summaries/read

按 summary_uid 分页读取指定版本的原文和可读状态；不触发生成或修改内容。

Operation ID：readRecordingSummary

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/recordings/summaries/read' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"summary_uid":"64b64c2f9b8c1a2d3e4f5681","limit":10000}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "content_state": "ready",
    "format": "markdown",
    "found": true,
    "has_more": false,
    "summary": {
      "content_origin": "business_recording_summary",
      "created_at": 1700064000000,
      "day_start_at": 1699977600000,
      "end_at": 1700064000000,
      "generation_state": "completed",
      "kind": "daily_summary",
      "start_at": 1699977600000,
      "summary_uid": "64b64c2f9b8c1a2d3e4f5681",
      "updated_at": 1700064100000
    },
    "summary_uid": "64b64c2f9b8c1a2d3e4f5681",
    "text": "确认下周计划",
    "text_end_offset": 6,
    "text_start_offset": 0,
    "text_total_length": 6
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

通话

查询通话

POST /api/v1/calls/query

按时间、方向、接通状态、媒体、结果、聊天会话或参与人稳定分页查询当前账号可见的通话。

Operation ID：queryCalls

请求字段

枚举值说明

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/calls/query' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"start_at":1700000000000,"end_at":1700086400000,"directions":["outgoing"],"limit":20}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "has_more": false,
    "items": [
      {
        "call_uid": "64b64c2f9b8c1a2d3e4f5680",
        "connection_state": "connected",
        "direction": "outgoing",
        "duration_ms": 600000,
        "media_type": "audio",
        "participants": [
          {
            "connected": true,
            "display_name": "我",
            "is_self": true,
            "role": "caller",
            "user_ref": "usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
          }
        ],
        "participants_truncated": false,
        "result": "normal_end",
        "started_at": "2023-11-14T22:30:00Z",
        "summary": {
          "source": "template",
          "text": "确认了下周计划",
          "truncated": false
        },
        "summary_state": "ready",
        "transcript_state": "ready"
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

批量读取通话

POST /api/v1/calls/batch-get

按输入 UID 顺序精确读取通话概览、参与人、摘要和处理状态。

Operation ID：batchGetCalls

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/calls/batch-get' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"call_uids":["64b64c2f9b8c1a2d3e4f5680"]}'

返回字段

枚举值说明

成功响应示例

{
  "code": 200,
  "data": {
    "items": [
      {
        "call": {
          "call_uid": "64b64c2f9b8c1a2d3e4f5680",
          "connection_state": "connected",
          "direction": "outgoing",
          "duration_ms": 600000,
          "media_type": "audio",
          "participants": [
            {
              "connected": true,
              "display_name": "我",
              "is_self": true,
              "role": "caller",
              "user_ref": "usr_v1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
            }
          ],
          "participants_truncated": false,
          "result": "normal_end",
          "started_at": "2023-11-14T22:30:00Z",
          "summary_state": "unavailable",
          "transcript_state": "ready"
        },
        "call_uid": "64b64c2f9b8c1a2d3e4f5680",
        "found": true
      }
    ]
  },
  "message": "请求成功",
  "request_id": "request-example-1"
}

查询通话转写

POST /api/v1/calls/transcript/query

分页读取通话的规范转写；participant_side 不代表参与人本人，正文完整性需结合 transcript_state 和 truncated 判断。

Operation ID：queryCallTranscript

请求字段

请求示例

curl -X POST 'https://openapi.jotmo.cc/api/v1/calls/transcript/query' \
  -H 'Authorization: Bearer arkme_<key-id>_<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"call_uid":"64b64c2f9b8c1a2d3e4f5680","limit":100}'

返回字段