赎回共享会话

POST

/keyApi/v1/redeemSharingSession

朋友手机设备厂商调用------>车厂OEM。
这是车辆 OEM 服务器提供的通用 API。朋友设备可以通过朋友设备OEM服务器联系车辆OEM服务器以兑换由所有者设备创建并发送到朋友设备的分享会话。

请求参数

Header 参数

x-requestId

string

可选

设备 OEM 服务器和车辆 OEM 服务器的所有请求都应具有 HTTP 标头“x-requestId”。该值应为包含连字符的长度为 36 的 UUID。

Body 参数application/json

sharingSession

object

分享会话

必需

sessionID

string

会话ID

必需

vehicleOEMUrl

string

分享URL

必需

friendDeviceHandle

string

好友设备句柄

必需

好友设备的句柄。好友设备OEM服务器需要此句柄在共享会话中稍后向好友设备发送Push

示例

{
    "sharingSession": {
        "sessionID": "533677a1c95bf11da052d7caead6e3bbf2e3609579966169fd",
        "vehicleOEMUrl": "UrlToRechOutToVehicleOem"
    },
    "friendDeviceHandle": "Friend-Device-Handle-For-Push-Notification"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/keyApi/v1/redeemSharingSession' \
--header 'x-requestId;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sharingSession": {
        "sessionID": "533677a1c95bf11da052d7caead6e3bbf2e3609579966169fd",
        "vehicleOEMUrl": "UrlToRechOutToVehicleOem"
    },
    "friendDeviceHandle": "Friend-Device-Handle-For-Push-Notification"
}'

返回响应

🟢201成功

application/json

Body

responseHeader

object

公共响应标头

必需

statusCode

string

状态码

必需

示例

{
    "responseHeader": {
        "statusCode": "200"
    }
}

修改于 2023-03-31 04:20:21

生成分享会话

取消分享会话