首页
/ Signal-CLI-REST-API 中回执功能的使用指南

Signal-CLI-REST-API 中回执功能的使用指南

2025-07-09 04:59:43作者:凤尚柏Louis

Signal-CLI-REST-API 是一个基于 Signal 协议的命令行工具 REST 封装,为用户提供了通过 HTTP API 与 Signal 服务交互的能力。本文将重点介绍其回执(receipt)功能的使用方法和注意事项。

回执功能概述

Signal 消息应用中的回执功能允许用户向发送方确认消息状态,主要包括两种类型:

  • 已读回执(read receipt):显示为两个灰色对勾
  • 已查看回执(viewed receipt):显示为两个白色对勾

在 Signal-CLI-REST-API 中,可以通过 /v1/receipts/ 端点发送这些回执。

功能启用与版本要求

需要注意的是,回执功能在标准发布版本中可能尚未包含。如需使用该功能,用户需要拉取特定的开发版本镜像:

docker pull bbernhard/signal-cli-rest-api:0.160-dev

API 使用详解

发送回执的基本请求格式如下:

POST /v1/receipts/{sender_number}

请求体需包含以下JSON参数:

  • receipt_type: 回执类型("read"或"viewed")
  • recipient: 接收方号码
  • timestamp: 消息时间戳(必须精确匹配原始消息的时间戳)

示例请求:

curl -X POST -H 'accept: application/json' \
-H "Content-Type: application/json" \
'http://localhost:8080/v1/receipts/+49XXXXXXX' \
-d '{"receipt_type": "read", "recipient": "+49XXXXXXX", "timestamp": 1717716743897}'

时间戳获取建议

为了确保回执能正确关联到特定消息,时间戳参数必须精确匹配原始消息的时间戳。最佳实践是通过以下方式获取时间戳:

  1. 使用 /receive 端点接收消息时,会返回包含时间戳的消息数据
  2. 从接收到的消息中提取时间戳字段
  3. 使用该时间戳发送回执

常见问题排查

如果回执发送后未在Signal客户端显示预期效果,建议检查以下方面:

  1. 版本兼容性:确认使用的是支持回执功能的版本
  2. 时间戳准确性:验证时间戳是否与原始消息完全匹配
  3. 日志分析:检查Docker容器日志确认请求是否被正确处理
  4. 权限配置:确保API有足够的权限执行回执操作

实现原理

在底层实现上,Signal-CLI-REST-API通过JSON-RPC协议与signal-cli交互。当收到回执请求时,会转换为如下格式的JSON-RPC命令:

{
  "jsonrpc": "2.0",
  "method": "sendReceipt",
  "id": "随机UUID",
  "params": {
    "recipient": "接收方号码",
    "receipt-type": "回执类型",
    "target-timestamp": 目标时间戳,
    "account": "发送方号码"
  }
}

成功的响应将包含操作结果和状态信息,开发者可以通过分析这些响应来确认操作是否成功执行。

通过合理使用回执功能,开发者可以构建更完善的Signal消息处理流程,实现消息状态跟踪等高级功能。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
149
1.95 K
kernelkernel
deepin linux kernel
C
22
6
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
980
395
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
931
555
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
190
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
65
518
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0