aljaz/signal-cli-rest-api
1
0
Fork 0
mirror of https://github.com/aljazceru/signal-cli-rest-api.git synced 2025-12-19 23:54:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update EXAMPLES.md

Browse Source 
Updated documentation to clarify WebSocket connection usage.
This commit is contained in:
CeeArEx
2025-03-04 17:37:29 +01:00
committed by GitHub
parent cc19b73370
commit bbf0bb293d
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/EXAMPLES.md
View File

@@ -4,6 +4,7 @@
- Register a number (with SMS verification) - Register a number (with SMS verification)
`curl -X POST -H "Content-Type: application/json" 'http://127.0.0.1:8080/v1/register/<number>'` `curl -X POST -H "Content-Type: application/json" 'http://127.0.0.1:8080/v1/register/<number>'`
> `number` is your cell phone number which you want to link to the docker container.
e.g: e.g:
@@ -75,11 +76,18 @@ e.g:
Fetch all new messages in the inbox of the specified number. Fetch all new messages in the inbox of the specified number.
`curl -X GET -H "Content-Type: application/json" 'http://127.0.0.1:8080/v1/receive/<number>'` `curl -X GET -H "Content-Type: application/json" 'http://127.0.0.1:8080/v1/receive/<number>'`
> `number` is the registered phone number for which you want to retrieve incoming messages.
> This is a WebSocket connection that remains subscribed to live events. Through this connection, you can observe real-time actions, such as when someone is typing or sending a message.
e.g: e.g:
`curl -X GET -H "Content-Type: application/json" 'http://127.0.0.1:8080/v1/receive/+431212131491291'` `curl -X GET -H "Content-Type: application/json" 'http://127.0.0.1:8080/v1/receive/+431212131491291'`
or with wscat:
`wscat -c ws://127.0.0.1:8080/v1/receive/+431212131491291 --show-ping-pong --slash`
- Create a new group - Create a new group
Create a new group with the specified name and members. Create a new group with the specified name and members.