status-im/status-console-client
2
0
Fork 0
mirror of https://github.com/status-im/status-console-client.git synced 2025-02-24 08:38:15 +00:00
Code Issues Projects Releases Wiki Activity
status-console-client/API.md
Dmitry d46665edc9 Add simple API to send and read messages 
Prepare docker image for tests

Use make build in dockerfile

Add mailservers to transport object

Add readme with example how to use API

Forgot to add a stream for contact

Rewrite correct variable

Apply suggestions
2019-06-23 09:30:48 +03:00

1.3 KiB
Raw Blame History

RPC API

Start service with configuration file that enables API:

./bin/status-term-client -node-config ./_assets/api.conf -no-ui --keyhex=0x123

Configuration example:

{
  "HTTPHost": "localhost",
  "HTTPPort": 8777,
  "HTTPEnabled": true,
  "APIModules": "ssm"
}

Add contact

curl -H "Content-Type: application/json" -X POST --data '{"jsonrpc":"2.0","method":"ssm_addContact","params":[{"name": "222"}],"id":1}' http://localhost:8777

Returns error if failed otherwise null.

Send to contact

curl -H "Content-Type: application/json" -X POST --data '{"jsonrpc":"2.0","method":"ssm_sendToContact","params":[{"name": "222"}, "plain text"],"id":1}' http://localhost:8777

Returns error if failed otherwise null.

Read all (including ours) from contact

To read all messages use 0 as offset:

curl -H "Content-Type: application/json" -X POST --data '{"jsonrpc":"2.0","method":"ssm_readContactMessages","params":[{"name": "222"}, 0],"id":1}' http://localhost:8777

To read new messages use last known offset:

curl -H "Content-Type: application/json" -X POST --data '{"jsonrpc":"2.0","method":"ssm_readContactMessages","params":[{"name": "222"}, 2],"id":1}' http://localhost:8777