探马OpenAPI

推送注册接口

POST

/api/v2/push-register

信息

用于注册推送接收地址。调用成功后会向提供的地址回调一条测试消息。只有测试消息推送成功注册才会成功完成，并不是此接口返回ok就完成注册。

重复调用此接口会导致推送接收地址和订阅消息类型更新。

如果切换了新的appId，已注册推送将使用新 appId 进行推送。

注意

subscription订阅消息类型, 覆盖更新 而不是追加更新, 如果需要订阅多个消息事件类型, 逗号分割。

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

Body 参数application/json

receiveAddress

string

推送消息接收地址

必需

必须是有效的 http/https 地址

subscription

string

订阅的消息类型列表

必需

订阅消息类型, 覆盖更新而不是追加更新, 如果需要订阅多个消息事件类型, 逗号分割。如"register,new_qw_customer,edit_qw_customer"

示例

{"receiveAddress":"http://abc.com:20066/push-debug","subscription":"register,new_qw_customer,edit_qw_customer"}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v2/push-register' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'Content-Type: application/json' \
--data-raw '{"receiveAddress":"http://abc.com:20066/push-debug","subscription":"register,new_qw_customer,edit_qw_customer"}'

返回响应

🟢200成功

application/json

Body

code

integer

业务状态码

必需

成功状态为0。参见响应业务状态码表

message

string

业务状态说明。

必需

示例

{
    "code": 0,
    "message": "已收到注册消息，请注意接收确认回调"
}

🟢200异常

写跟进记录推送

高级筛选接口（新版）