文档

StopAppSession - 停止应用会话

更新时间:

停止应用会话,后续停止结果会通过消息返回。

接口说明

发起停止、程序主动停止或程序崩溃等原因导致应用程序停止后,会通过此消息通知。

事件类型为APP_STOP

注意 仅限 API 对接模式,不适用于 H5 SDK 对接模式。

名称类型是否必选说明
successBoolean停止是否成功。
取值:
true:停止成功。
false:停止失败。
eventTypeString事件类型。
customSessionIdString自定义会话 ID。
platformSessionIdString平台会话 ID。
normalBoolean是否正常停止。
取值:
true:正常停止。
false:异常停止。
eventDetailObject[EventDetail]事件详情,成功时返回。
errorMessageObject错误详情,失败时返回。

EventDetail 数据结构如下所示。

名称类型是否必选说明
appIdString应用 ID。
appVersionString应用版本 ID。

ErrorMessage 数据结构如下所示。

名称类型是否必选说明
codeString错误码。
msgString错误详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
PlatformSessionIdstring

平台会话 ID,在平台中唯一标识一个会话。

注意:PlatformSessionId 和 CustomSessionId 必须二选一。 如果同时设置了两个参数,以 PlatformSessionId 为准。

100XXXX
CustomSessionIdstring

自定义会话 ID。

注意:PlatformSessionId 和 CustomSessionId 必须二选一。 如果同时设置了两个参数,以 PlatformSessionId 为准。

1ADE0XXXX
StopParamobject []

停止容器参数。此参数将透传到 Agent。

Keystring

目前支持的枚举值包括:

  • reason:停止原因。
reason
Valueany

key 对应的取值。

exampleValue

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

46329898-489C-4E63-9BA1-C1DA5C5D0986
CustomSessionIdstring

自定义会话 ID。

1ADE0XXXX
PlatformSessionIdstring

平台会话 ID 。

100XXXX
AppIdstring

应用 ID。

13027XXXX
AppVersionstring

应用版本 ID。

35067XXXX

示例

正常返回示例

JSON格式

{
  "RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0986",
  "CustomSessionId": "1ADE0XXXX",
  "PlatformSessionId": "100XXXX",
  "AppId": "13027XXXX",
  "AppVersion": "35067XXXX"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-03-03新增 OpenAPI看变更集
  • 本页导读 (0)
文档反馈