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

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消息处理流程，实现消息状态跟踪等高级功能。