短信记录操作事件 - 尘锋SCRM开放平台

使用此推送需前往PC端管理后台配置推送数据地址链接, 当系统产生新的短信记录时, 将会向推送数据地址链接发送 POST 请求

推送请求格式
数据推送会以 POST 请求的形式向推送发出若干次请求, 具体请求格式如下:

POST  https://example.dustess.com/event_push_url/
Content-Type: application/json; charset=utf-8

{
	"event": "smsRecord",
	"body": {
		"type": "add",
		"ids": ["352961e6-1111-1111-1111-8ab72528b8e5",  "deb723bb-1111-1111-1111-d8985d371f45"]
	}
}

HTTP - Body 格式说明

字段名称	类型	说明
`event`	`String`	推送事件类型, 短信记录同步为`smsRecord`
`body`	`Object`	推送事件具体数据

body 字段格式说明

字段名称	类型	说明
`type`	`String`	事件操作类型
`ids`	`String[]`	短信ID列表

其中 type 可能出现的值有:

参数值	说明
`add`	新增了若干条短信记录

ids 为短信记录 ID 列表, 用户拿到此数据后, 可以根据 短信记录列表接口 进行查询详细的短信记录信息

当用户开启数据加密后, body 格式为:

参数名	类型	说明
event	`String`	事件名称, 公司推送为 `company`
body	`Object`	启加密则返回加密的数据结构，需要对body.encrypt进行解密，其中参数：msgSignature，timeStamp，nonce属于解密参数，详情见文档首页加解密SDK描述
body.encrypt	`String`	加密内容
body.msgSignature	`String`	解密参数
body.timeStamp	`String`	解密参数
body.nonce	`String`	解密参数

示例

{
    "event":"company",
    "body":{
        "encrypt": "ZcaBSTGyKGu5/MknLgXop/ZIe++db5OOqS19OLEytr9KZhUQsMONpQwmOo9ZfkEWbxvTRq8TFFSqnqdzSzuw==",
        "msgSignature": "fc3a056e34f6b9e1891a9d00841e27e1761test",
        "timeStamp": "1635302196",
        "nonce": "Kocpj4zdaBDZcWB2"
    }

成功响应

当用户收到推送事件后, 需要向服务器回复 接受成功响应; 若没有及时回复, 服务器将会一段时间后重试 (最多15次)

响应参数名	类型	说明
`code`	`Int`	状态码: 0: 失败, 1: 成功
`msg`	`String`	响应提示

成功响应示例

{
	"code": 1,
	"msg": "success"
}

特别注意 : 建议收到消息推送后⽴刻返回成功响应示例，避免⼀直占⽤请求连接而被判超时; 若连续响应超时、服务器⽆响应、响应失败，10分钟内达到100次，推送接⼝将降低所有推送事件频率为3⼩时⼀次, 并且每条事件最多重试推送3次。