mirror of
https://github.com/AsamK/signal-cli
synced 2025-09-02 04:20:38 +00:00
added some more text
This commit is contained in:
parent
d1a00d5101
commit
3e5dcc14b1
1 changed files with 77 additions and 4 deletions
|
@ -1,10 +1,26 @@
|
|||
|
||||
------------------------------
|
||||
Description of the JSON schema
|
||||
------------------------------
|
||||
-----------------------------------------
|
||||
Description of the jsonevtloop and schema
|
||||
-----------------------------------------
|
||||
|
||||
Purpose: JSON-based asynchronous API for signal-cli.
|
||||
|
||||
This mode is not intended to be used directly from the command line, but to
|
||||
provide an easy use API for other scripting languages.
|
||||
|
||||
signal-cli listens for JSON requests on stdin. Each JSON request must be
|
||||
a single valid JSON object (enclosed in {}), followed by LF. The JSON text
|
||||
itself hence must not contain linefeeds (only escaped as \n and no pretty
|
||||
printing enabled).
|
||||
|
||||
When incoming messages are received from the signal back-end, they are
|
||||
in turned JSON encoded and sent out on stdout.
|
||||
|
||||
Any error messages or debug information is sent out on stderr as expected.
|
||||
|
||||
|
||||
Version 2
|
||||
|
||||
JSON Schema Version 2
|
||||
|
||||
|
||||
JSON Requests are read from STDIN in "jsonevtloop" mode and the Reponses are
|
||||
|
@ -35,6 +51,63 @@ Version 2
|
|||
"attachments": [ "<file-name1>", ... ]
|
||||
}
|
||||
|
||||
|
||||
Message Envelope Received, sent to group chat with some attachements present
|
||||
{
|
||||
"apiVer": 2,
|
||||
"respType": "envelope",
|
||||
"reqID": null,
|
||||
"status": "ok",
|
||||
"envelope": {
|
||||
"source": "+46123456",
|
||||
"sourceDevice": 1,
|
||||
"relay": null,
|
||||
"timestamp": 1581272926239,
|
||||
"isReceipt": false,
|
||||
"dataMessage": {
|
||||
"timestamp": 1581272926239,
|
||||
"message": "😋😋😋",
|
||||
"expiresInSeconds": 0,
|
||||
"attachments": [
|
||||
{
|
||||
"contentType": "image/jpeg",
|
||||
"filename": "signal-2020-02-09-122846.jpeg",
|
||||
"id": "8983570171695764643",
|
||||
"size": 569218
|
||||
},
|
||||
{
|
||||
"contentType": "image/jpeg",
|
||||
"filename": "signal-2020-02-09-122846.jpeg",
|
||||
"id": "4282268489503632431",
|
||||
"size": 629080
|
||||
},
|
||||
{
|
||||
"contentType": "image/jpeg",
|
||||
"filename": "signal-2020-02-09-122846.jpeg",
|
||||
"id": "1780607521773749056",
|
||||
"size": 595515
|
||||
},
|
||||
{
|
||||
"contentType": "image/jpeg",
|
||||
"filename": "signal-2020-02-09-122846.jpeg",
|
||||
"id": "119656560176959856",
|
||||
"size": 311650
|
||||
}
|
||||
],
|
||||
"groupInfo": {
|
||||
"groupId": "FRasdb6mSVwHwetHSX8mkjQ==",
|
||||
"members": null,
|
||||
"name": null,
|
||||
"type": "DELIVER"
|
||||
}
|
||||
},
|
||||
"syncMessage": null,
|
||||
"callMessage": null,
|
||||
"receiptMessage": null
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
Alive Request
|
||||
Test if signal-cli is still responding
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue