Go SDK

    The Plivo Go SDK makes it simpler to integrate communications into your Go applications using the Plivo REST API. Using the SDK, you will be able to make voice calls, send SMS and generate Plivo XML to control your call flows.

    Prerequisites

    • Go >= 1.7.x

    Installation

    To Install Stable release

    You can use the Stable release using the go command.

    $ go get github.com/plivo/plivo-go
    

    You can also install by cloning this repository into your GOPATH.

    To Install Beta release

    1. In terminal, using the following command, create a new folder called test-plivo-beta.

       $ mkdir test-plivo-beta
      

      Note: Make sure the new folder is outside your GOPATH.

    2. Change your directory to the new folder.
    3. Using the following command, initialize a new module:

       $ go mod init github.com/plivo/beta
      

      You will see the following return:

       $ go mod init github.com/plivo/beta
      
    4. Next, create a new go file with the following code:

       package main
      
       import (
       "fmt"
       "github.com/plivo/plivo-go"
       )
      
       const authId  = "auth_id"
       const authToken = "auth_token"
      
       func main() {
       	testPhloGetter()
       }
      
       func testPhloGetter() {
       	phloClient,err := plivo.NewPhloClient(authId, authToken, &plivo.ClientOptions{})
       	if err != nil {
       		panic(err)
       	}
       	response, err := phloClient.Phlos.Get("phlo_id")
       	if err != nil {
       		panic(err)
       	}
       	fmt.Printf("Response: %#v\n", response)
       }
      

      Note: Make sure you enter your auth_id and auth_token before you initialize the code.

    5. Run the following command to build the packages:

       $ go build
      

      payload_defined

      A file named go.mod will be generated.

    6. Open go.mod using the command vim go.mod and edit the plivo-go version to the beta version you want to download.

      payload_defined

      Note: You can see the full list of releases here.

      For example, change

       github.com/plivo/plivo-go v4.0.5+incompatible
      

      to

       github.com/plivo/plivo-go v4.0.6-beta1
      
    7. Once done, save the go.mod.
    8. Run go build to build the packages.

      go.mod will be updated with the beta version.

    You can now use the features available in the Beta branch.

    Getting started

    Authentication

    To make the API requests, you need to create a Client and provide it with authentication credentials (which can be found at https://manage.plivo.com/dashboard/).

    We recommend that you store your credentials in the PLIVO_AUTH_ID and the PLIVO_AUTH_TOKEN environment variables, so as to avoid the possibility of accidentally committing them to source control. If you do this, you can initialise the client with no arguments and it will automatically fetch them from the environment variables:

    package main
    
    import "github.com/plivo/plivo-go"
    
    func main()  {
      client, err := plivo.NewClient("", "", &plivo.ClientOptions{})
      if err != nil {
        panic(err)
      }
    }
    

    Alternatively, you can specify the authentication credentials while initializing the Client.

    package main
    
    import "github.com/plivo/plivo-go"
    
    func main()  {
     client, err := plivo.NewClient("your_auth_id", "your_auth_token", &plivo.ClientOptions{})
     if err != nil {
       panic(err)
     }
    }
    

    The Basics

    The SDK uses consistent interfaces to create, retrieve, update, delete and list resources. The pattern followed is as follows:

    client.Resources.Create(Params{}) // Create
    client.Resources.Get(Id) // Get
    client.Resources.Update(Id, Params{}) // Update
    client.Resources.Delete(Id) // Delete
    client.Resources.List() // List all resources, max 20 at a time
    

    Using client.Resources.List() would list the first 20 resources by default (which is the first page, with limit as 20, and offset as 0). To get more, you will have to use limit and offset to get the second page of resources.

    Examples

    Send a message

    package main
    
    import "github.com/plivo/plivo-go"
    
    func main()  {
      client, err := plivo.NewClient("", "", &plivo.ClientOptions{})
      if err != nil {
        panic(err)
      }
      client.Messages.Create(plivo.MessageCreateParams{
        Src: "the_source_number",
        Dst: "the_destination_number",
        Text: "Hello, world!",
      })
    }
    

    Make a call

    package main
    
    import "github.com/plivo/plivo-go"
    
    func main()  {
      client, err := plivo.NewClient("", "", &plivo.ClientOptions{})
      if err != nil {
        panic(err)
      }
      client.Calls.Create(plivo.CallCreateParams{
        From: "the_source_number",
        To: "the_destination_number",
        AnswerURL: "http://answer.url",
      })
    }
    

    Generate Plivo XML

    package main
    
    import "github.com/plivo/plivo-go/plivo/xml"
    
    func main()  {
      println(xml.ResponseElement{
        Contents: []interface{}{
          new(xml.SpeakElement).SetContents("Hello, world!"),
        },
        }.String())
    }
    

    This generates the following XML:

    <Response>
      <Speak>Hello, world!</Speak>
    </Response>
    

    Run a PHLO

    package main
    
    import (
    	"fmt"
    	"plivo-go"
    )
    
    // Initialize the following params with corresponding values to trigger resources
    
    const authId  = "auth_id"
    const authToken = "auth_token"
    const phloId = "phlo_id"
    
    // with payload in request
    
    func main() {
    	testPhloRunWithParams()
    }
    
    func testPhloRunWithParams() {
    	phloClient,err := plivo.NewPhloClient(authId, authToken, &plivo.ClientOptions{})
    	if err != nil {
    		panic(err)
    	}
    	phloGet, err := phloClient.Phlos.Get(phloId)
    	if err != nil {
    		panic(err)
    	}
    	//pass corresponding from and to values
    	type params map[string]interface{}
    	response, err := phloGet.Run(params{
    		"from": "111111111",
    		"to": "2222222222",
    	})
    
    	if (err != nil) {
    		println(err)
    	}
    	fmt.Printf("Response: %#v\n", response)
    }
    

    More examples

    Refer to the Plivo API Reference for more examples. Also refer to the guide to setting up dev environment to setup a simple Go server & use it to test out your integration in under 5 minutes.

    Reporting issues

    Report any feedback or problems with this version by opening an issue on Github.