Skip to content

Update EXAMPLES.md #666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 4, 2025
Merged

Update EXAMPLES.md #666

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions doc/EXAMPLES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
- Register a number (with SMS verification)

`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:

Expand Down Expand Up @@ -75,11 +76,18 @@ e.g:
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>'`
> `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:

`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 with the specified name and members.
Expand Down