summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMatt Ranostay <matt.ranostay@konsulko.com>2019-01-09 16:06:47 -0800
committerMatt Ranostay <matt.ranostay@konsulko.com>2019-01-10 00:53:19 +0000
commit728f52173e367625f8c294173fb73337ffdbc0a7 (patch)
treec7f66a7f0b4d4c1545fc9c17bde8b81e3c8e01f4 /README.md
parentf812dd06ec66fe18b9c79b7afd7c6bf444335c1b (diff)
binding: telephony: add initial README.md documentation
Bug-AGL: SPEC-2104 Change-Id: If6f6d1b5cdf9a9956bc00170be766582365140fb Signed-off-by: Matt Ranostay <matt.ranostay@konsulko.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f4473c7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# Telephony Service
+
+## Overview
+
+Telephony service allows respective clients access to the Handsfree Profile via the oFono package
+
+## Verbs
+
+| Name | Description | JSON Response |
+|---------------------|-------------------------------------------------|---------------------------------------------|
+| subscribe | subscribe to telephony events | *Request:* {"value": "callStateChanged"} |
+| unsubscribe | unsubscribe to telephony events | *Request:* {"value": "callStateChanged"} |
+| dial | dial respective number | *Request:* {"value": "15035551212"} |
+| hangup | hangup an active call or reject incoming call | |
+| answer | answer incoming call | |
+
+## Events
+
+| Name | Description | JSON Event Data |
+|---------------------|--------------------------------------|---------------------------------------------|
+| callStateChanged | Call status change event | see callStateChanged event |
+| dialingCall | Outgoing call events | {"colp": "3305551212"} |
+| incomingCall | Incoming call events | {"clip": "3305551212"} |
+| terminatedCall | Terminated call event | *empty JSON response* |
+
+### callStateChanged Event
+
+This event has one field called *parameter* with one of the following states (see **doc/voicecall-api.txt** in oFono for further reference):
+
+| Name | Description |
+|----------------|-----------------------------------|
+| active | Call is active |
+| held | Call is on hold |
+| dialing | Call is being dialed |
+| alerting | Remote party is being alerted |
+| incoming | Incoming call in progress |
+| waiting | Call is waiting |
+| disconnected | Call is disconnected |
+