GoAMI2 - Golang Asterisk PBX AMI v2 协议库使用指南

GoAMI2 是一个用于与 Asterisk PBX 管理接口(AMI) v2 协议交互的 Golang 库。下面我将详细介绍如何使用这个库。

安装

首先安装 goami2 库：

go get github.com/ivahaev/goami2

基本连接

package main

import (
	"log"
	"github.com/ivahaev/goami2"
)

func main() {
	// 创建AMI客户端
	client := goami2.NewClient("127.0.0.1:5038", "admin", "password")
	
	// 设置事件处理器
	client.On("connect", func(message *goami2.Message) {
		log.Println("Connected to AMI")
	})
	
	// 连接AMI
	err := client.Connect()
	if err != nil {
		log.Fatal("Connection error:", err)
	}
	defer client.Close()
	
	// 保持连接
	select {}
}

发送命令

// 发送Ping命令
msg := goami2.NewMessage("Ping")
response, err := client.Send(msg)
if err != nil {
    log.Println("Error sending Ping:", err)
} else {
    log.Println("Ping response:", response)
}

// 获取SIP对等端状态
peersMsg := goami2.NewMessage("SIPpeers")
peersResponse, err := client.Send(peersMsg)
if err != nil {
    log.Println("Error getting SIP peers:", err)
} else {
    log.Println("SIP peers:", peersResponse)
}

事件监听

// 监听所有事件
client.On("event", func(msg *goami2.Message) {
    event := msg.Get("Event")
    log.Printf("Received event: %s", event)
})

// 监听特定事件
client.On("Newchannel", func(msg *goami2.Message) {
    channel := msg.Get("Channel")
    log.Printf("New channel created: %s", channel)
})

client.On("Hangup", func(msg *goami2.Message) {
    channel := msg.Get("Channel")
    cause := msg.Get("Cause")
    log.Printf("Channel %s hung up. Cause: %s", channel, cause)
})

发起呼叫

func originateCall(client *goami2.Client, from, to string) {
    msg := goami2.NewMessage("Originate")
    msg.Set("Channel", "SIP/"+from)
    msg.Set("Exten", to)
    msg.Set("Context", "from-internal")
    msg.Set("Priority", "1")
    msg.Set("CallerID", "Call from "+from)
    msg.Set("Timeout", "30000")
    msg.Set("Async", "true")

    response, err := client.Send(msg)
    if err != nil {
        log.Println("Error originating call:", err)
    } else {
        log.Println("Originate response:", response)
    }
}

完整示例

package main

import (
	"log"
	"time"
	"github.com/ivahaev/goami2"
)

func main() {
	client := goami2.NewClient("127.0.0.1:5038", "admin", "password")
	
	// 设置事件处理器
	client.On("connect", func(msg *goami2.Message) {
		log.Println("Connected to AMI")
		
		// 连接后发送Ping
		pingMsg := goami2.NewMessage("Ping")
		response, err := client.Send(pingMsg)
		if err != nil {
			log.Println("Ping error:", err)
		} else {
			log.Println("Ping response:", response)
		}
	})
	
	client.On("event", func(msg *goami2.Message) {
		event := msg.Get("Event")
		if event != "" {
			log.Printf("Event: %s", event)
		}
	})
	
	client.On("Newchannel", func(msg *goami2.Message) {
		log.Printf("New channel: %s", msg.Get("Channel"))
	})
	
	// 连接AMI
	err := client.Connect()
	if err != nil {
		log.Fatal("Connection error:", err)
	}
	defer client.Close()
	
	// 5秒后发起测试呼叫
	time.AfterFunc(5*time.Second, func() {
		originateCall(client, "1001", "1002")
	})
	
	// 保持程序运行
	select {}
}

func originateCall(client *goami2.Client, from, to string) {
	msg := goami2.NewMessage("Originate")
	msg.Set("Channel", "SIP/"+from)
	msg.Set("Exten", to)
	msg.Set("Context", "from-internal")
	msg.Set("Priority", "1")
	msg.Set("CallerID", "Call from "+from)
	msg.Set("Timeout", "30000")
	msg.Set("Async", "true")

	response, err := client.Send(msg)
	if err != nil {
		log.Println("Error originating call:", err)
	} else {
		log.Println("Originate response:", response)
	}
}

高级用法

自定义超时

client := goami2.NewClient("127.0.0.1:5038", "admin", "password")
client.Timeout = 10 * time.Second // 设置10秒超时

处理错误

client.On("error", func(err error) {
    log.Println("AMI error:", err)
    // 可以在这里实现重连逻辑
})

重连机制

func connectWithRetry(client *goami2.Client, maxRetries int) {
    var retries int
    for {
        err := client.Connect()
        if err == nil {
            return
        }
        
        retries++
        if retries >= maxRetries {
            log.Fatal("Max retries reached")
        }
        
        log.Printf("Connection failed, retrying in 5 seconds (attempt %d/%d)", retries, maxRetries)
        time.Sleep(5 * time.Second)
    }
}

GoAMI2 提供了简洁的 API 来与 Asterisk AMI 接口交互，支持命令发送和事件监听。通过合理使用这个库，可以构建强大的 Asterisk 管理工具和集成应用。