Install Go, Gin, and the Plivo Go SDK
You must set up and install Go, Gin, and Plivo’s Go SDK before you make your first call.Install Go
Download and install Go from its official site.Install Gin and the Plivo Go SDK
Create a projects directory and change into it.$ mkdir mygoapp
$ cd mygoapp
go command.$ go get github.com/plivo/plivo-go/v7
$ go get github.com/gin-gonic/gin
GOPATH.Once you’ve set up your development environment, you can start making and receiving calls using our APIs and XML documents. Here are three common use cases to get you started.Make your first outbound call
Plivo requests an answer URL when the call is answered (step 4) and expects the file at that address to hold a valid XML response from the application with instructions on how to handle the call. To see how this works, you can use https://s3.amazonaws.com/static.plivo.com/answer.xml as an answer URL to test your first outgoing call. The file contains this XML code:<Response>
<Speak>Congratulations! You've made your first outbound call!</Speak>
</Response>
Code
Create a file called MakeCall.go and paste into it this code.package main
import (
"fmt"
"github.com/gin-gonic/gin"
"github.com/plivo/plivo-go/v7"
)
func main() {
r := gin.Default()
r.GET("/outbound-call", func(c *gin.Context) {
c.Header("Content-Type", "application/JSON")
client, err := plivo.NewClient("<auth_id>", "<auth_token>", &plivo.ClientOptions{})
if err != nil {
fmt.Print("Error", err.Error())
return
}
response, err := client.Calls.Create(
plivo.CallCreateParams{
From: "<caller_id>",
To: "<destination_number>",
AnswerURL: "https://s3.amazonaws.com/static.plivo.com/answer.xml",
AnswerMethod: "GET",
},
)
if err != nil {
fmt.Print("Error", err.Error())
return
}
fmt.Printf("Response: %#v\n", response)
c.JSON(200, response)
})
r.Run() // listen and serve on 0.0.0.0:8080 (for windows "localhost:8080")
}
Note:
We recommend that you store your credentials in the auth_id and auth_token environment variables to avoid the possibility of accidentally committing them to source control. If you do this, you can initialize the client with no arguments and Plivo will automatically fetch the values from the environment variables. You can use os.Setenv and os.Getenv functions to store environment variables and fetch them when initializing the client.
Test
Save the file and run it.Receive your first inbound call
Plivo requests an answer URL when it answers the call (step 2) and expects the file at that address to hold a valid XML response from the application with instructions on how to handle the call. In this example, when an incoming call is received, Plivo’s text-to-speech engine plays a message using the Speak XML element.To be able to host answer and callback URLs and to be able to provide valid XML and accept notifications on these URLs, you need to host a web server.You must have a voice-enabled Plivo phone number to receive incoming calls; you can rent numbers from the Numbers page of the Plivo console, or by using the Numbers API.Set up a Go Gin server to handle incoming calls
Create a file called receive_call.go and paste into it this code.package main
import (
"github.com/gin-gonic/gin"
"github.com/plivo/plivo-go/v7/xml"
)
func main() {
r := gin.Default()
r.GET("/receive_call", func(c *gin.Context) {
c.Header("Content-Type", "application/xml")
response := xml.ResponseElement{
Contents: []interface{}{
new(xml.SpeakElement).
AddSpeak("Hello, you just received your first call", "MAN", "en-US", 1),
},
}
c.String(200, response.String())
})
r.Run() // listen and serve on 0.0.0.0:8080 (for windows "localhost:8080")
}
Expose your local server to the internet
To receive incoming calls, your local server must connect with Plivo API services. For that, we recommend using ngrok, which exposes local servers running behind NATs and firewalls to the public internet over secure tunnels. Using ngrok, you can set webhooks that can talk to the Plivo server.Install ngrok and run it on the command line, specifying the port that hosts the application on which you want to receive calls (8080 in this case):This starts the ngrok server on your local server. Ngrok will display a forwarding link that you can use as a webhook to access your local server over the public network.Create a Plivo application to receive calls
Associate the controller you created with Plivo by creating a Plivo application. Visit Voice > Applications and click Add New Application. You can also use Plivo’s Application API.Give your application a name — we called ours Receive_call. Enter the server URL you want to use (for example https://<yourdomain>.com/receivecall/) in the Primary Answer URL field and set the method to POST. Click Create Application to save your application.Assign a Plivo number to your application
Navigate to the Numbers page and select the phone number you want to use for this application.From the Application Type drop-down, select XML Application.From the Plivo Application drop-down, select Receive Call (the name we gave the application).Click Update Number to save.Test
Make a call to your Plivo number using any phone.Forward an incoming call
Plivo requests an answer URL when the call is answered (step 4) and expects the file at that address to hold a valid XML response from the application with instructions on how to handle the call. In this example, when an incoming call is received, Plivo forwards the call using the Dial XML element.You must have a voice-enabled Plivo phone number to receive incoming calls; you can rent numbers from the Numbers page of the Plivo console, or by using the Numbers API.Set up a Go Gin server to forward calls
Create a file called forward_call.go and paste into it this code.package main
import (
"github.com/gin-gonic/gin"
"github.com/plivo/plivo-go/v7/xml"
)
func main() {
r := gin.Default()
r.GET("/forward_call", func(c *gin.Context) {
c.Header("Content-Type", "application/xml")
response := xml.ResponseElement{
Contents: []interface{}{
new(xml.DialElement).
SetContents(
[]interface{}{
new(xml.NumberElement).
SetContents("<destination_number>"),
},
),
},
}
c.String(200, response.String())
})
r.Run() // listen and serve on 0.0.0.0:8080 (for windows "localhost:8080")
}
Create a Plivo application to forward calls
Associate the Go application you created with Plivo by creating a Plivo application. Visit Voice > Applications in the Plivo console and click on Add New Application, or use Plivo’s Application API.Give your application a name — we called ours Forward Call. Enter the server URL you want to use (for example https://<yourdomain>.com/forward_call/) in the Answer URL field and set the method to POST. Click Create Application to save your application.Assign a Plivo number to your application
Navigate to the Numbers page and select the phone number you want to use for this application.From the Application Type drop-down, select XML Application.From the Plivo Application drop-down, select Forward Call (the name we gave the application).Click Update Number to save.Test
Make a call to your Plivo number using any phone. Plivo will send a request to the answer URL you provided requesting an XML response and then forward the call according to the instructions in the XML document the server provides.More use cases
We illustrate more than 20 use cases with code for both API/XML and PHLO on our documentation pages.
