summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 839d6a7312806cef7a0fc5de1e6f21473b4fb74c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# 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*                       |
| online              | Connected status of Handsfree Profile   | {"connected": true}                         |

### 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              |