Skip to content

Latest commit

 

History

History
183 lines (127 loc) · 6.66 KB

README.md

File metadata and controls

183 lines (127 loc) · 6.66 KB
Raw

Call API

Call API

The Call API is a front-end for SIP Proxies (such as OpenSIPS), aiming to simplify the management of more advanced SIP call flows. Combining built-in SIP scenarios (such as the ones from RFC 5359) with real-time notifications as the call commands take place, the API is meant to help VoIP system developers build complex SIP services with ease, altogether while providing live reporting for such services.

The API listens for WebSocket connections on ws://localhost:5059/call-api and talks JSON-RPC 2.0 over them.

Requirements

Go version

The Call API tool is using go modules, introduced in go 1.13, but the tool was developed based on go version 1.14. We recommend you install at least go 1.14 using your distribution's repositories, or from the official Golang repository.

SIP Proxy

In order to be able to start and control calls, you need to have a running SIP proxy instance that is able to communicate with the Call API daemon through a supported communication mechanisms, and that is able to perform the required logic. Current supported SIP proxies and their requirements are:

Please read more about each project's requirements on their website.

Installation

Download the sources

You can either use git or go to download the Call API sources

  • Git
    • go to your sources directory (such as /usr/local/src) and clone the repository
    git clone https://github.com/OpenSIPS/call-api.git
    cd call-api

    go get github.com/OpenSIPS/call-api
    cd ${GOPATH:-$HOME/go}/src/github.com/OpenSIPS/call-api

Download dependencies

    go get -d ./...

Manual run

You can run the tools directly from the source code using the go run command:

    go run cmd/call-api/main.go

Build packages

The following command will build all tools and place them in the bin/ folder of the project.

    make build

After this command you can find all the binaries in the bin/ directory.

Install packages

The following command install all tools in the $GOBIN directory, and all their configuration files in /etc/call-api directory. The default value of $GOBIN is $GOPATH/bin which defaults to $HOME/go/bin. Make sure to properly tune your $GOBIN variable if you want to install your binaries in a different place (for example set GOBIN=/usr/bin to install them in /usr/bin).

    make install
    export PATH=$PATH:${GOBIN:-${GOPATH:-$HOME/go}/bin}
    call-api

Note that you can also use the go-flavor install go install ./..., but this will not install the configuration files.

In order to install the binaries in a standard path (such as /usr/bin), make sure to overwrite the $GOBIN variable:

    GOBIN=/usr/bin make install
    call-api

After the install is complete, you can find the configuration files in the /etc/call-api directory if you are running as root, or in $HOME/.<tool-name>.yml otherwise.

Tools

The project builds and installs the following tools:

  • call-api - a WebSocket Server that listens for JSON-RPC requests
  • call-cmd - a command line tool that runs the command without having the call-api server running
  • call-api-client - a command line tool that sends JSON-RPC requests to the call-api daemon and prints the notifications at stdout

Configuration

Each tool uses a configuration file that defaults to <tool-name>.yml (ex: call-api.yml or call-cmd.yml). This file is automatically searched in the following places: $HOME/.<tool-name>.yml, config/<tool-name>.yml, /etc/<tool-name>.yml and /etc/call-api/<tool-name>.yml, in this specific order. A custom path can be specified using the -config cfg_file.yml parameter when starting the tool (ex: call-api -config /etc/custom-config.yml).

Examples of configuration files can be found in the config directory.

API Call Commands

Below are the API's commands available for building your JSON-RPC requests. Read the documentation of each command for a listing of its input parameters and their accepted values:

Interacting with the API

By default, the API listens on ws://localhost:5059/call-api. Below is an example way of launching a CallStart command using an API client written in Go:

go run cmd/call-api-client/main.go \
  -method CallStart \
  -params '{"caller": "sip:alice@localhost", "callee": "sip:bob@localhost"}'

The same behavior can be done using the Call cmd tool:

go run cmd/call-cmd/main.go CallStart caller=sip:alice@localhost callee=sip:bob@localhost

Documentation

The docs folder contains the documentation for this project.

Build and run docker containers

You can build and run the three tools under a docker container.

docker build -t opensips-call-api:latest .

By default the call-api will be run:

> docker run opensips-call-api:latest
time="2023-10-10T21:42:48Z" level=info msg="Listening for JSON-RPC over WebSocket on localhost:5059/call-api ..."

But, you can specify the call-cmd and call-api-client tools:

docker run opensips-call-api:latest call-api-client \
  -method CallStart \
  -params '{"caller": "sip:alice@localhost", "callee": "sip:bob@localhost"}'
docker run opensips-call-api:latest call-cmd CallStart caller=sip:alice@localhost callee=sip:bob@localhost