探马OpenAPI

应用通知

POST

/api/v3/inform

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

Body 参数application/json

touser

string

接收消息的员工id

必需

员工企微id

text

string

消息内容

必需

customerId

string

客户企微externalUserId

可选

跳转客户详情，customerId必填

isJump

integer

否跳转客户详情

必需

0不跳转 1跳转

title

string

标题

可选

跳转客户详情，title必填（不超过36字符）

示例

{
    "touser": "tanma",
    "text": "您好，欢迎使用探马SCRM",
    "customerId": "wmKNsKDAAAeEFdGL-snWNlM-ywfYIpMA",
    "isJump": 0,
    "title": "标题"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v3/inform' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'appKey: {{appKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "touser": "tanma",
    "text": "您好，欢迎使用探马SCRM",
    "customerId": "wmKNsKDAAAeEFdGL-snWNlM-ywfYIpMA",
    "isJump": 0,
    "title": "标题"
}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

成功示例异常示例

{
    "code": 0,
    "message": "success"
}

修改于 2023-02-02 07:08:52

文件上传

全局参考文档