@juzi/wechaty-grpc 1.0.101 → 1.0.102

package/dist/cjs/out/wechaty/puppet.swagger.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Wechaty Puppet Service OpenAPI Specification",
     "description": "Wechaty is a Conversational RPA SDK for chatbot makers. With only 6 lines of code, you can create a bot on the most popular IMs like WeChat, Whatsapp, WeCom, Gitter, etc.\n\nWechaty Puppet Service is the RESTful API for Wechaty API, which is build on top of the Wechaty Puppet Abstraction and the gRPC proto definition.",
-    "version": "1.0.101",
+    "version": "1.0.102",
     "contact": {
       "name": "Wechaty",
       "url": "https://github.com/wechaty/openapi",
@@ -26,6 +26,304 @@
     "application/json"
   ],
   "paths": {
+    "/call/invite": {
+      "post": {
+        "operationId": "Puppet_CallInvite",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetCallInviteResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/puppetCallInviteRequest"
+            }
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/call/{callId}/accept": {
+      "post": {
+        "operationId": "Puppet_CallAccept",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetCallAcceptResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "callId",
+            "description": "由 CallInvite 响应获得；协议端持有会话状态，凭此即可定位会话（无需 peer/media）",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/PuppetCallAcceptBody"
+            }
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/call/{callId}/add": {
+      "post": {
+        "operationId": "Puppet_CallAdd",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetCallAddResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "callId",
+            "description": "由 CallInvite 响应获得",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/PuppetCallAddBody"
+            }
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/call/{callId}/cancel": {
+      "post": {
+        "operationId": "Puppet_CallCancel",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetCallCancelResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "callId",
+            "description": "由 CallInvite 响应获得；协议端持有会话状态，凭此即可定位会话（无需 peer/media）",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/PuppetCallCancelBody"
+            }
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/call/{callId}/hangup": {
+      "post": {
+        "operationId": "Puppet_CallHangup",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetCallHangupResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "callId",
+            "description": "由 CallInvite 响应获得；协议端持有会话状态，凭此即可定位会话（无需 peer/media）",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/PuppetCallHangupBody"
+            }
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/call/{callId}/media-endpoint": {
+      "post": {
+        "summary": "POST：签发可能在网关侧预分配媒体会话（有副作用），非幂等读取。",
+        "operationId": "Puppet_CallMediaEndpoint",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetCallMediaEndpointResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "callId",
+            "description": "由 CallInvite 响应获得",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/PuppetCallMediaEndpointBody"
+            }
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/call/{callId}/reject": {
+      "post": {
+        "operationId": "Puppet_CallReject",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetCallRejectResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "callId",
+            "description": "由 CallInvite 响应获得；协议端持有会话状态，凭此即可定位会话（无需 peer/media）",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/PuppetCallRejectBody"
+            }
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/call/{id}": {
+      "get": {
+        "operationId": "Puppet_CallPayload",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetCallPayloadResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "id",
+            "description": "call_id",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
     "/cancel_verify_code": {
       "post": {
         "operationId": "Puppet_CancelVerifyCode",
@@ -658,7 +956,10 @@
               "PAYLOAD_TYPE_FRIENDSHIP",
               "PAYLOAD_TYPE_POST",
               "PAYLOAD_TYPE_TAG",
-              "PAYLOAD_TYPE_TAG_GROUP"
+              "PAYLOAD_TYPE_TAG_GROUP",
+              "PAYLOAD_TYPE_WXXD_PRODUCT",
+              "PAYLOAD_TYPE_WXXD_ORDER",
+              "PAYLOAD_TYPE_CALL"
             ],
             "pattern": "PAYLOAD_TYPE_CONTACT"
           }
@@ -1813,7 +2114,10 @@
               "PAYLOAD_TYPE_FRIENDSHIP",
               "PAYLOAD_TYPE_POST",
               "PAYLOAD_TYPE_TAG",
-              "PAYLOAD_TYPE_TAG_GROUP"
+              "PAYLOAD_TYPE_TAG_GROUP",
+              "PAYLOAD_TYPE_WXXD_PRODUCT",
+              "PAYLOAD_TYPE_WXXD_ORDER",
+              "PAYLOAD_TYPE_CALL"
             ],
             "pattern": "PAYLOAD_TYPE_FRIENDSHIP"
           }
@@ -2147,7 +2451,10 @@
               "PAYLOAD_TYPE_FRIENDSHIP",
               "PAYLOAD_TYPE_POST",
               "PAYLOAD_TYPE_TAG",
-              "PAYLOAD_TYPE_TAG_GROUP"
+              "PAYLOAD_TYPE_TAG_GROUP",
+              "PAYLOAD_TYPE_WXXD_PRODUCT",
+              "PAYLOAD_TYPE_WXXD_ORDER",
+              "PAYLOAD_TYPE_CALL"
             ],
             "pattern": "PAYLOAD_TYPE_MESSAGE"
           }
@@ -3260,7 +3567,10 @@
               "PAYLOAD_TYPE_FRIENDSHIP",
               "PAYLOAD_TYPE_POST",
               "PAYLOAD_TYPE_TAG",
-              "PAYLOAD_TYPE_TAG_GROUP"
+              "PAYLOAD_TYPE_TAG_GROUP",
+              "PAYLOAD_TYPE_WXXD_PRODUCT",
+              "PAYLOAD_TYPE_WXXD_ORDER",
+              "PAYLOAD_TYPE_CALL"
             ],
             "pattern": "PAYLOAD_TYPE_ROOM_MEMBER"
           }
@@ -3308,7 +3618,10 @@
               "PAYLOAD_TYPE_FRIENDSHIP",
               "PAYLOAD_TYPE_POST",
               "PAYLOAD_TYPE_TAG",
-              "PAYLOAD_TYPE_TAG_GROUP"
+              "PAYLOAD_TYPE_TAG_GROUP",
+              "PAYLOAD_TYPE_WXXD_PRODUCT",
+              "PAYLOAD_TYPE_WXXD_ORDER",
+              "PAYLOAD_TYPE_CALL"
             ],
             "pattern": "PAYLOAD_TYPE_ROOM"
           }
@@ -4491,6 +4804,51 @@
         }
       }
     },
+    "PuppetCallAcceptBody": {
+      "type": "object",
+      "title": "被叫接听来电。"
+    },
+    "PuppetCallAddBody": {
+      "type": "object",
+      "properties": {
+        "contactIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "title": "新增受邀方 contactId 列表（不含已在通话中的参与者）"
+        }
+      },
+      "title": "通话中途拉人（errors-only 契约）：\n- 新参与者的应答回执（响铃/接听/拒接）一律经 EVENT_TYPE_CALL 事件上行，本响应恒为空；\n- 拉人特有的失败（通话不存在/已结束、人数上限等）经 gRPC status error 返回。"
+    },
+    "PuppetCallCancelBody": {
+      "type": "object",
+      "title": "接通前主叫取消呼叫。"
+    },
+    "PuppetCallHangupBody": {
+      "type": "object",
+      "properties": {
+        "reason": {
+          "type": "string",
+          "title": "可空，空串表示无"
+        }
+      },
+      "title": "接通后任一方挂断。"
+    },
+    "PuppetCallMediaEndpointBody": {
+      "type": "object",
+      "title": "媒体入场券：按 call_id 向协议端换取媒体网关协商入口。\n签发可能在网关侧预分配媒体会话（有副作用），故服务端不得缓存响应、客户端按需拉取。"
+    },
+    "PuppetCallRejectBody": {
+      "type": "object",
+      "properties": {
+        "reason": {
+          "type": "string",
+          "title": "可空，空串表示无"
+        }
+      },
+      "title": "被叫拒接来电。"
+    },
     "PuppetContactAliasBody": {
       "type": "object",
       "properties": {
@@ -4863,6 +5221,99 @@
       ],
       "default": "BROADCAST_TARGET_STATUS_UNSENT"
     },
+    "puppetCallAcceptResponse": {
+      "type": "object"
+    },
+    "puppetCallAddResponse": {
+      "type": "object"
+    },
+    "puppetCallCancelResponse": {
+      "type": "object"
+    },
+    "puppetCallHangupResponse": {
+      "type": "object"
+    },
+    "puppetCallInviteRequest": {
+      "type": "object",
+      "properties": {
+        "contactIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "title": "受邀方 contactId 列表（不含发起方）：单元素 = 1v1 通话，多元素 = 群通话；\n无论几人，一通通话只铸造一个 call_id。"
+        },
+        "media": {
+          "$ref": "#/definitions/puppetCallType",
+          "title": "必填：媒体类型（VOICE/VIDEO），复用既有 CallType；零值 CALL_TYPE_UNKNOWN 会被 server 拒绝"
+        }
+      },
+      "title": "发起呼叫请求：callId 不由主叫携带，而是由 puppet 实现侧生成并经 CallInviteResponse 返回。"
+    },
+    "puppetCallInviteResponse": {
+      "type": "object",
+      "properties": {
+        "callId": {
+          "type": "string"
+        }
+      },
+      "title": "CallInvite 响应：\n- call_id 由 puppet 实现侧（协议端）生成并经本响应返回，全链路以此关联控制面与媒体旁路；\n- 上行 EVENT_TYPE_CALL 事件可能先于本响应到达，客户端须容忍乱序；\n- 后续控制 RPC（CallAccept/CallReject/CallCancel/CallHangup）凭此 call_id 引用本通通话。"
+    },
+    "puppetCallMediaEndpointResponse": {
+      "type": "object",
+      "properties": {
+        "url": {
+          "type": "string",
+          "title": "媒体网关协商入口（非媒体流地址本身）"
+        },
+        "token": {
+          "type": "string",
+          "title": "短时效凭证，绑定 call_id + 本端身份"
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "title": "凭证过期时刻；不设置 = 不过期；过期后重新拉取本 RPC"
+        },
+        "protocol": {
+          "type": "string",
+          "title": "入口方言（如 whip / livekit / 自定义），由媒体 SDK 消费"
+        }
+      }
+    },
+    "puppetCallPayloadResponse": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "starter": {
+          "type": "string",
+          "title": "发起方 contactId；空串 = 协议端不可知（如中途被拉入者视角）"
+        },
+        "participants": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "title": "当前全量参与者名册"
+        },
+        "media": {
+          "$ref": "#/definitions/puppetCallType",
+          "title": "当前媒体类型（语音↔视频切换经 dirty 反映）"
+        },
+        "startTime": {
+          "type": "string",
+          "format": "date-time",
+          "title": "通话发起时刻；接通时刻不在此（等于上行 Accept 事件的 timestamp）"
+        },
+        "endTime": {
+          "type": "string",
+          "format": "date-time",
+          "title": "通话结束时刻；未设置 = 通话进行中"
+        }
+      }
+    },
     "puppetCallRecordPayload": {
       "type": "object",
       "properties": {
@@ -4887,6 +5338,9 @@
         }
       }
     },
+    "puppetCallRejectResponse": {
+      "type": "object"
+    },
     "puppetCallStatus": {
       "type": "string",
       "enum": [
@@ -4898,7 +5352,7 @@
         "CALL_STATUS_ENDED"
       ],
       "default": "CALL_STATUS_UNKNOWN",
-      "description": "- CALL_STATUS_UNKNOWN: 不明确\n - CALL_STATUS_CANCELED: 自己取消\n - CALL_STATUS_REJECTED: 对方拒接\n - CALL_STATUS_MISSED: 正在通话\n - CALL_STATUS_ONGOING: 正在通话\n - CALL_STATUS_ENDED: 已结束",
+      "description": "- CALL_STATUS_UNKNOWN: 不明确\n - CALL_STATUS_CANCELED: 自己取消\n - CALL_STATUS_REJECTED: 对方拒接\n - CALL_STATUS_MISSED: 未接\n - CALL_STATUS_ONGOING: 正在通话\n - CALL_STATUS_ENDED: 已结束",
       "title": "类型枚举"
     },
     "puppetCallType": {
@@ -5437,7 +5891,8 @@
         "EVENT_TYPE_POST_TAP",
         "EVENT_TYPE_ROOM_ANNOUNCE",
         "EVENT_TYPE_VERIFY_CODE",
-        "EVENT_TYPE_VERIFY_SLIDE"
+        "EVENT_TYPE_VERIFY_SLIDE",
+        "EVENT_TYPE_CALL"
       ],
       "default": "EVENT_TYPE_UNSPECIFIED"
     },
@@ -6548,9 +7003,13 @@
         "PAYLOAD_TYPE_FRIENDSHIP",
         "PAYLOAD_TYPE_POST",
         "PAYLOAD_TYPE_TAG",
-        "PAYLOAD_TYPE_TAG_GROUP"
+        "PAYLOAD_TYPE_TAG_GROUP",
+        "PAYLOAD_TYPE_WXXD_PRODUCT",
+        "PAYLOAD_TYPE_WXXD_ORDER",
+        "PAYLOAD_TYPE_CALL"
       ],
-      "default": "PAYLOAD_TYPE_UNSPECIFIED"
+      "default": "PAYLOAD_TYPE_UNSPECIFIED",
+      "title": "数值必须与 @juzi/wechaty-puppet 的 DirtyType 严格一致。"
     },
     "puppetPostPayloadClient": {
       "type": "object",