dinistavares / aircall

Unofficial Aircall API wrapper for Go

Aircall API wrapper for Go

This Go package provides a wrapper to interact with the Aircall API

How to install

go get -u github.com/leoht/aircall

Quick start

package main

import (
    "fmt"
    "github.com/leoht/aircall"
)

func main() {
    // Create the client with your API id and secret
    client := aircall.NewClient("<your app ID>", "<your app secret")

    // Get current company info
    // Returns a CompanyResponse struct
    res, err := client.Company()

    if err != nil {
      panic(err)
    }

    company = res.Company
    fmt.Println("Company name", company.Name)

    // Get users list
    res, err := client.Users(aircall.Paginate{
        PerPage: 10
    })

    if err != nil {
      panic(err)
    }

    for _, u := range res.Users {
        fmt.Println("User", u.ID, u.Name)

        // Get specific user
        userRes, err := client.User(user.ID)
    }
    
    // Get numbers
    res, err := client.Numbers(aircall.Paginate{
        PerPage: 10,
        Page: 2
    })

    if err != nil {
      panic(err)
    }

    for _, num := range res.Numbers {
        fmt.Println("Number", num.ID, num.Name, num.Digits)
    }
}

API Calls

Each API call function returns a specific struct type to hold the response data. See messages.go to view all possible response types, and types.go to view the possible entity types.

For all calls returning a lis of entities (e.g Users() or Contacts()), an attribute Meta will be present in the response struct. This attribute is a struct containing Count, Total, CurrentPage, PerPage, NextPageLink and PreviousPageLink.

Get Current Company

res, err := client.Company()
company := res.Company
fmt.Println("Company: ", company.Name)

List Users

// Default pagination parameters
res, err := client.Users(aircall.Paginate{})
for _, user := range res.Users {
    fmt.Println("User: ", user.ID)
}

// With pagination
res, err := client.Users(aircall.Paginate{
    Page: 1,
    PerPage: 5,
    Order: "asc"
})

Get User Info

res, err := client.User(123456)
user := res.User
fmt.Println("User: ", user.ID)

List Phone Numbers

res, err := client.Numbers(aircall.Paginate{})
for _, number := range res.Numbers {
    fmt.Println("Number: ", number.ID, number.Digits)
}

Get Phone Number Info

res, err := client.Number(153434)
number := res.Number
fmt.Println("Number: ", number.ID, number.Digits)

List Calls

res, err := client.Calls(aircall.Paginate{})
for _, call := range res.Calls {
    fmt.Println("Call: ", call.ID)
}

Get Call Info

res, err := client.Call(12345)
call := res.Call
fmt.Println("Call: ", call.ID, call)

Display Link In Call

link := "http://www.mycompany.com"
res, err := client.LinkCall(12345, link)

Transfer Call To User

userID := 16354
res, err := client.TransferCall(12345, userID)

Delete Call Recording

callID := 16354
_, err := client.DeleteRecording(callID)

Delete Call Voicemail

callID := 16354
_, err := client.DeleteVoicemail(callID)

List Contacts

// Default pagination parameters
res, err := client.Contacts(aircall.Paginate{})
for _, contact := range res.Contacts {
    fmt.Println("Contact: ", contact.ID)
}

Get Contact Info

res, err := client.Contact(12345)
contact := res.Contact
fmt.Println("Contact: ", contact.ID, contact.FirstName)

Create Contact

req = aircall.ContactRequest{
    FirstName:   "John",
    LastName:    "Doe",
    CompanyName: "Acme",
    PhoneNumbers: []aircall.ContactInfo{
        aircall.ContactInfo{
            Label: "Pro phone",
            Value: "[phone]",
        },
    },
}

res, err := client.CreateContact(req)
contact := res.Contact
fmt.Println("Contact created: ", contact.ID, contact.FirstName)

Update Contact

contactID := 15364
req = aircall.ContactRequest{
    CompanyName: "Acme 2.0",
}

res, err := client.UpdateContact(contactID, req)
contact := res.Contact
fmt.Println("Contact created: ", contact.ID, contact.FirstName)

Search Contacts

res, err := client.SearchContacts(
    aircall.Paginate{},
    aircall.Search{
        PhoneNumber: "[phone]",
    },
)

for _, contact := range res.Contacts {
    fmt.Println("Contact: ", contact.ID)
}

Delete Contact

contactID := 16354
_, err := client.DeleteContact(contactID)