跳到主要内容

消息推送

POSThttps://open.debox.pro/openapi/messages/group/send

向群组发文字消息,调用示例:

curl -X POST -H "Content-Type: application/json" \
-H "X-API-KEY: t2XAlEF6......" \
-d '{"to_user_id":"uvg2p6ho","group_id":"fxi3hqo5",\
"object_name":"text","content":"i am message sent by bot"}' \
"https://open.debox.pro/openapi/messages/group/send"

Parameters

app_id : String 应用唯一标识,DeBox开放平台申请

X-API-KEY : String 开发者 key,在开放平台可以获取

nonce : String 随机数字,长度 8 位

timestamp : String 时间戳,精确到毫秒

signature : String sha1 计算的签名,需严格按照 签名 计算规则

签名计算,需要用与 X-API-KEY 对应的 App Secret 对随机数和时间戳进行签名

// 顺序必须必须严格按:appsecret -> nonce -> timestamp
signature = SHA1({appsecret}{nonce}{timestamp})
Query

group_id : String 群组的group_id。代表往哪个群组发消息,非空

to_user_id : String 用户的userid。代表@群组的哪个用户,可为空

object_name : String 代表消息类型,文字消息,必须为text

content : String 文字消息字符串,非空

Responses

200: OK
{
"code":200,
"data":null,
"message":"success",
"success":false
}

POSThttps://open.debox.pro/openapi/messages/group/send

向群组发图片文字消息,从上到下排版顺序为图片、title、content、图片,其中content为富文本,可以插入任意超链接。调用示例:

  curl -X POST -H "Content-Type: application/json" \
-H "X-API-KEY: t2XJ........lEF6" \
-d '{"group_id":"l3ixp32y","object_name":"richtext","title":"我是标题","content":"i am 富文本 \
{\"uitag\":\"a\",\"text\":\"点击我\",\"href\":\"https://debox.pro/\"}将跳转"}' \
"https://open.debox.pro/openapi/messages/group/send"

Parameters

Header

app_id : String 应用唯一标识,DeBox开放平台申请

X-API-KEY : String 开发者 key,在开放平台可以获取

nonce : String 随机数字,长度 8 位

timestamp : String 时间戳,精确到毫秒

signature : String sha1 计算的签名,需严格按照 签名 计算规则

签名计算,需要用与 X-API-KEY 对应的 App Secret 对随机数和时间戳进行签名

// 顺序必须必须严格按:appsecret -> nonce -> timestamp
signature = SHA1({appsecret}{nonce}{timestamp})
Query

group_id : String 群组的group_id。代表往哪个群组发消息,非空

to_user_id : String 用户的userid。代表@群组的哪个用户,可为空

object_name : String 代表消息类型,图片文字消息,必须为richtext

title : String 代表图文消息的文字标题

content : String 代表图文消息的主体部分,为富文本,可以插入超链接和图片


1、超链接
示例: {"uitag":"a","text":"DeBox","href":"https://debox.pro/deswap"}
uitag为a时,表示一个超链接。
将以下 json 转成字符串,拼接到content里,界面上将显示一个热点区域"DeBox",点击后跳转至https://debox.pro/deswap
var uiA = {
uitag: "a",
text: "DeBox",
href: "https://debox.pro/deswap",
}


2、彩色文字
示例: {"uitag":"font","text":"15%","bold":"true","italic":"true","color":"#ff0000"}
uitag为font时,表示彩色文字,支持加粗(true/false)、斜体(true/false)、颜色(RGB格式)。
将以下 json 转成字符串,拼接到content里,界面上将显示加粗、斜体、蓝色的"15%"
var uiFont = {
Uitag: "font",
Text: "15%",
Color: "#0000ff",
Bold: "true",
Italic: "true",
}


3、图片
示例:{"uitag":"img","src":"https://domain.com/a.png","position":"foot","height":"500","href":""}
用法:将以下json转字符串后拼接到content里
var uiImg = UITagImg{
Uitag: "img",
Src: "<https://data.debox.space/dao/newpic/two.png>",
Position: "foot",
Href: "<https://www.baidu.com>",
Height: "500",
}
uitag=”img” ,则表示是一副图片
src:图片地址,为空时只显示占位
position: 显示位置
为head时,图片显示在顶部,在title的前面
为foot时,图片显示在底部
为其他时,隐藏图片不显示任何东西
href点击后的跳转页面
为DeBox白名单地址时,直接打开
为非白地址时,则弹提示警告框
为空、或者没有定义时,显示放大的图片
width、height表示图片的宽高
img的width,默认值为消息排版的最大宽度;
img的height,默认值也为消息排版的最大宽度;
width、height支持%, 参考系为消息排版的最大宽度。


3、一个 content 的例子:
项目名称 成交量
{"uitag":"a","text":"DeBox","href":"https://debox.pro/deswap"} 96.78k
{"uitag":"font","text":"15%","bold":"true","italic":"true","color":"#ff0000"}
{"uitag":"img","src":"https://domain.com/a.png","position":"foot","height":"500","href":""}

显示样例: 纯文字:
alt text
上图下文
alt text
上文下图:
alt text
上图中文下图:
alt text

Responses

200: OK
{
"code":200,
"data":null,
"message":"success",
"success":false
}

POSThttps://open.debox.pro/openapi/messages/private/send

向私人发消息,调用示例:


curl -X POST -H "Content-Type: application/json" \
-H "X-API-KEY: t2XAlEF6......" \
-d '{"to_user_id":"uvg2p6ho","object_name":"text","content":"i am message"}' \
"https://open.debox.pro/openapi/messages/private/send"

Parameters

Header

app_id : String 应用唯一标识,DeBox开放平台申请

X-API-KEY : String 开发者 key,在开放平台可以获取

nonce : String 随机数字,长度 8 位

timestamp : String 时间戳,精确到毫秒

signature : String sha1 计算的签名,需严格按照 签名 计算规则

签名计算,需要用与 X-API-KEY 对应的 App Secret 对随机数和时间戳进行签名

// 顺序必须必须严格按:appsecret -> nonce -> timestamp
signature = SHA1({appsecret}{nonce}{timestamp})
Query

to_user_id : String 用户的userid。代表消息的接受者,非空

object_name : String 代表消息类型,值可为text或richtext,具体参考上文

content : String 根据object_name值,同上文对应参数设定

Responses

200: OK
{
"code":200,
"data":null,
"message":"success",
"success":false
}