Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/staskobzar/goagi
AGI library for Go
https://github.com/staskobzar/goagi
agi asterisk fastagi go golang library
Last synced: 14 days ago
JSON representation
AGI library for Go
- Host: GitHub
- URL: https://github.com/staskobzar/goagi
- Owner: staskobzar
- License: mit
- Created: 2019-07-15T02:32:56.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-21T00:29:59.000Z (5 months ago)
- Last Synced: 2024-07-31T20:53:19.985Z (3 months ago)
- Topics: agi, asterisk, fastagi, go, golang, library
- Language: Go
- Homepage:
- Size: 159 KB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-go - goagi - Go library to build Asterisk PBX agi/fastagi applications. (Third-party APIs / Utility/Miscellaneous)
- awesome-go-extra - goagi - 07-15T02:32:56Z|2022-06-24T15:17:20Z| (Third-party APIs / Fail injection)
README
# goagi: Golang library to build agi/fastagi applications
[](https://github.com/staskobzar/goagi/actions/workflows/ci.yml)
[](https://codecov.io/gh/staskobzar/goagi)
[](https://www.codefactor.io/repository/github/staskobzar/goagi)
[](https://scrutinizer-ci.com/g/staskobzar/goagi/?branch=master)
[](https://goreportcard.com/report/github.com/staskobzar/goagi)
Simple library that helps to build AGI scripts or FastAGI servers with Go.
```go
import "github.com/staskobzar/goagi"
```
API local documentation [link is here](docs/api.md) or
[go.dev generated](https://pkg.go.dev/github.com/staskobzar/goagi) documentation.
## Usage FastAGI
AGI object is created with ```New``` [method](docs/api.md#func-new) with three arguments:
- Reader [interface](docs/api.md#type-reader)
- Writer [interface](docs/api.md#type-response)
- Debugger [interface](docs/api.md#type-debugger)
Debugger interface is required only for debugging and usually ```nil```. See below for more details.
Reader and Writer are interfaces are any objects that implement ```Read```/```Write``` methods
and can be ```net.Conn```, ```tls.Conn```, ```os.Stdin```, ```os.Stdout``` or any other,
for example from packages ```strings```, ```bufio```, ```bytes```.
```New``` method will read AGI session setup environment variables and provides interface
to AGI commands. AGI environment variables and arguments can be accessed with
methods [```Env```](docs/api.md#func-agi-env) and [```EnvArgs```](docs/api.md#func-agi-envargs).
If AGI channel receives HANGUP message, the session will be marked as hungup. Hangup status
can be checked by method [```IsHungup```](docs/api.md#func-agi-ishungup).
### Usage example for AGI:
```go
import (
"github.com/staskobzar/goagi"
"os"
)
agi, err := goagi.New(os.Stdin, os.Stdout, nil)
if err != nil {
panic(err)
}
agi.Verbose("Hello World!")
```
### Fast AGI example:
```go
ln, err := net.Listen("tcp", "127.0.0.1:4573")
if err != nil {
panic(err)
}
for {
conn, err := ln.Accept()
if err != nil {
panic(err)
}
go func(conn net.Conn) {
agi, err := goagi.New(conn, conn, nil)
if err != nil {
panic(err)
}
agi.Verbose("Hello World!")
}(conn)
}
```
See working examples in [examples/] folder.
Index of methods that implements AGI commands [see here.](docs/api.md)
## Commands Response interface
Every AGI command method return interface [```Response```](docs/api.md#type-response).
This is interface that provides access to AGI response values.
Success response example:
```
200 result=1 (speech) endpos=9834523 results=5
```
Fail response example:
```
511 Command Not Permitted on a dead channel or intercept routine
```
There are success and error responses.
Response interface implements following methods:
* ```Code() int```: response code: 200, 510 etc.
* ```RawResponse() string```: returns full text of AGI response.
* ```Result() int```: returns value of result= field.
* ```Value() string```: returns response value field that comes in parentheses. For exmpale "(timeout)" in response "200 result=1 (timeout)".
* ```Data() string```: returns text for error responses and dtmf values for command like GetData.
* ```EndPos() int64```: returns value for endpos= field.
* ```Digit() string```: return digit from digit= field.
* ```SResults() int```: return value for results= field.
## Debugger
Interface that provides debugging capabilities with configurable output.
Example of usage:
```go
dbg := logger.New(os.Stdout, "myagi:", log.Lmicroseconds)
r, w := net.Pipe()
agi, err := goagi.New(r, w, dbg)
```