Pass Custom SIP Headers

You can create and deploy a PHLO to make an outbound call with custom SIP headers with a few clicks on the PHLO canvas.

How it works

Prerequisites

To get started, you need a Plivo account — sign up with your work email address if you don’t have one already. If this is your first PHLO, follow our instructions to set up a Python development environment.

Create the PHLO

To create a PHLO, visit the PHLO page of the Plivo console. If this is your first PHLO, the PHLO page will be empty.

• Click Create New PHLO.
• In the Choose your use case pop-up, click Build my own. The PHLO canvas will appear with the Start node.
  Note: The Start node is the starting point of any PHLO. It lets you trigger a PHLO to start upon one of three actions: incoming SMS message, incoming call, or API request.
• From the list of components on the left side, drag and drop the Initiate Call component onto the canvas. When a component is placed on the canvas it becomes a node.
• Draw a line to connect the Start node’s API Request trigger state to the Initiate Call node.
• In the Configuration pane at the right of the canvas, configure the Initiate Call node with a caller ID in the From field. Enter the destination number you want to call in the To field. Enter the custom SIP headers you want to add in the Custom Headers field.
• Once you’ve configured the node, click Validate to save the configuration.
• Similarly, create a node from the Play Audio component. Connect the Initiate Call node to the Play Audio node using the Answered trigger state.
• Configure the Play Audio node to play a message to the user by entering text in the Speak Text box in the Prompt section of the Configuration pane — for example, “Hello, you just received your first call.”
• Connect the Initiate Call node’s Answered trigger state to the Play Audio node.
• After you complete the configuration, give the PHLO a name by clicking in the upper left, then click Save.

Your PHLO is now ready to test.

Trigger the PHLO

You integrate a PHLO into your application workflow by making an API request to trigger the PHLO with the required payload — the set of parameters you pass to the PHLO. You can define a static payload by specifying values when you create the PHLO, or define a dynamic payload by passing values through parameters when you trigger the PHLO from your application.

In either case, you need your Auth ID and Auth Token, which you can get from the overview page of the Plivo console.

With a static payload

When you configure values when creating the PHLO, they act as a static payload.

Code

Create a file called trigger_phlo.py and paste into it this code.

1
2
3
4
5
6
7
8
9
import plivo

auth_id = '<auth_id>'
auth_token = '<auth_token>'
phlo_id = '<phlo_id>'
phlo_client = plivo.phlo.RestClient(auth_id=auth_id, auth_token=auth_token)
phlo = phlo_client.phlo.get(phlo_id)
response = phlo.run()
print str(response)

Replace the auth placeholders with your authentication credentials from the Plivo console. Replace the phlo_id placeholder with your PHLO ID from the Plivo console.

With a dynamic payload

To use dynamic values for the parameters, use Liquid templating parameters when you create the PHLO and pass the values from your code when you trigger it.

Code

Create a file called trigger_phlo.py and paste into it this code.

1
2
3
4
5
6
7
8
9
10
import plivo

auth_id = '<auth_id>'
auth_token = '<auth_token>'
phlo_id = '<phlo_id>'
payload = {"from" : "<caller_id>","to" : "<destination_number>"}
phlo_client = plivo.phlo.RestClient(auth_id=auth_id, auth_token=auth_token)
phlo = phlo_client.phlo.get(phlo_id)
response = phlo.run(**payload)
print str(response)

Replace the auth placeholders with your authentication credentials from the Plivo console. Replace the phlo_id placeholder with your PHLO ID from the Plivo console. Replace the phone number placeholders with actual phone numbers in E.164 format (for example, +12025551234).

Test

Save the file and run it.

$ python trigger_phlo.py