Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

根据三方业务id获取消息id

应用可通过第三方业务id查询到WPS侧的message_id,方便做业务侧的映射管理。第三方业务id来源于:

  • 旧版发送消息接口时入参(即ctx_id)

请求说明

请求地址https://openapi.wps.cn/v7/messages/get_message_ids
请求方法POST
签名方式KSO-1
权限要求查询和管理会话消息(应用授权) kso.chat_message.readwrite

请求头(Header)

Header 名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

请求体(Body)

名称参数类型是否必填说明
ex_biz_id_list[]string第三方消息id,可用旧发送消息接口的ctx_id值来入参此参数

请求体示例

json
{
  "ex_biz_id_list": [
    "string"
  ]
}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
dataobject数据信息
∟ itemsarray消息id关系对
∟ ∟ ex_biz_idstring第三方业务id
∟ ∟ message_idstring消息id

响应体示例

json
{
  "data": {
    "items": [
      {
        "ex_biz_id": "string",
        "message_id": "string"
      }
    ]
  },
  "code": 0,
  "msg": "string"
}