Skip to content

Commit 970347d

Browse files
authored
Merge pull request #666 from CeeArEx/master
Update EXAMPLES.md
2 parents cc19b73 + bbf0bb2 commit 970347d

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

doc/EXAMPLES.md

+8
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
- Register a number (with SMS verification)
55

66
`curl -X POST -H "Content-Type: application/json" 'http://127.0.0.1:8080/v1/register/<number>'`
7+
> `number` is your cell phone number which you want to link to the docker container.
78
89
e.g:
910

@@ -75,11 +76,18 @@ e.g:
7576
Fetch all new messages in the inbox of the specified number.
7677

7778
`curl -X GET -H "Content-Type: application/json" 'http://127.0.0.1:8080/v1/receive/<number>'`
79+
> `number` is the registered phone number for which you want to retrieve incoming messages.
80+
81+
> 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.
7882
7983
e.g:
8084

8185
`curl -X GET -H "Content-Type: application/json" 'http://127.0.0.1:8080/v1/receive/+431212131491291'`
8286

87+
or with wscat:
88+
89+
`wscat -c ws://127.0.0.1:8080/v1/receive/+431212131491291 --show-ping-pong --slash`
90+
8391
- Create a new group
8492

8593
Create a new group with the specified name and members.

0 commit comments

Comments
 (0)