停止应用会话,后续停止结果会通过消息返回。
接口说明
发起停止、程序主动停止或程序崩溃等原因导致应用程序停止后,会通过此消息通知。
事件类型为APP_STOP
。
注意 仅限 API 对接模式,不适用于 H5 SDK 对接模式。
名称 | 类型 | 是否必选 | 说明 |
---|---|---|---|
success | Boolean | 是 | 停止是否成功。 取值: true:停止成功。 false:停止失败。 |
eventType | String | 是 | 事件类型。 |
customSessionId | String | 是 | 自定义会话 ID。 |
platformSessionId | String | 是 | 平台会话 ID。 |
normal | Boolean | 是 | 是否正常停止。 取值: true:正常停止。 false:异常停止。 |
eventDetail | Object[EventDetail] | 否 | 事件详情,成功时返回。 |
errorMessage | Object | 否 | 错误详情,失败时返回。 |
EventDetail 数据结构如下所示。
名称 | 类型 | 是否必选 | 说明 |
---|---|---|---|
appId | String | 是 | 应用 ID。 |
appVersion | String | 是 | 应用版本 ID。 |
ErrorMessage 数据结构如下所示。
名称 | 类型 | 是否必选 | 说明 |
---|---|---|---|
code | String | 是 | 错误码。 |
msg | String | 是 | 错误详情。 |
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PlatformSessionId | string | 否 | 平台会话 ID,在平台中唯一标识一个会话。 注意:PlatformSessionId 和 CustomSessionId 必须二选一。 如果同时设置了两个参数,以 PlatformSessionId 为准。 | 100XXXX |
CustomSessionId | string | 否 | 自定义会话 ID。 注意:PlatformSessionId 和 CustomSessionId 必须二选一。 如果同时设置了两个参数,以 PlatformSessionId 为准。 | 1ADE0XXXX |
StopParam | object [] | 否 | 停止容器参数。此参数将透传到 Agent。 | |
Key | string | 否 | 目前支持的枚举值包括:
| reason |
Value | any | 否 | key 对应的取值。 | exampleValue |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0986",
"CustomSessionId": "1ADE0XXXX",
"PlatformSessionId": "100XXXX",
"AppId": "13027XXXX",
"AppVersion": "35067XXXX"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-03-03 | 新增 OpenAPI | 看变更集 |