Delivery Agent to Customer

This example shows how to make a call from a delivery agent to a customer using a call masking number with the Piopiy package.

Node.js

Steps to run the code

1. Prerequisites

Before you start, ensure you have the following:

• node.js (>= v20.12.0 required)
• npm
• git
• express
• piopiy

2. Clone Repository

First, clone the repository by running the following command:

git clone https://github.com/telecmi/piopiy_node_example.git

Next, navigate to the call_masking directory:

cd call_masking

And open the delivery_agent_to_customer.js file:

delivery_agent_to_customer.js

3. Configure the call parameters

Replace the value in the Delivery agent to customer code with your actual values for

• app_id & app_secret

• delivery_agent_number

• call_masking_number

• customer_number

Replace the placeholders in the code with your actual values:

const { Piopiy } = require("piopiy");
const piopiy = new Piopiy("app_id", "app_secret");

const delivery_agent_number = "Your delivery agent number"; // Example delivery agent phone number
const call_masking_number = "Your call masking number"; // Example call masking number
const customer_number = "Your customer number"; // Example customer phone number
const options = { duration: 15, timeout: 25, loop: 2 };

const pcmo_call = async () =>{

  const res = await piopiy.voice.call( 'delivery_agent_number', 'call_masking_number', 'customer_number', options )

}

pcmo_call()

Parameters type and description

These are the list of parameters and its description

Main parameters

parameter	Type	Description
app_id	number	Your app Id provided by Piopiy TeleCMI platform.
app_secret	string	Your app secret provided by Piopiy TeleCMI platform.
delivery_agent_number	number	The phone number of the agent receiving the call, including the country code.
call_masking_number	number	The call masking number provided by the Piopiy TeleCMI platform.
customer_number	number	The phone number of the customer being called, including the country code.
options	object	An object containing optional parameters (duration, timeout & loop).

Options parameters

parameter	Type	Description
duration	number	The maximum duration of the call in seconds,By default 5400 seconds.
timeout	number	Time to wait for the call to be answered in seconds,By default 40 seconds.
loop	number	The number of retry attempts if the call is not answered,By default 1.

4. Run the code

Execute the code using Node.js:

node call_masking/delivery_agent_to_customer.js

5. Expected call flow

When the code is executed, the call will follow these steps:

1. Initial call to Delivery agent: The call is initiated to the delivery agent's number first.

2. Delivery agent answers call: Once the agent answers the call, the call will automatically connect to the customer's number.

You can handle these steps programmatically using the Piopiy package. Ensure that your app_id & app_secret are correctly configured, and the delivery_agent_number, call_masking_number, and customer_number provided are valid.

Python

Steps to run the code

1. Prerequisites

Before you start, ensure you have the following:

• Python (>= 3.6 required)
• pip
• git
• piopiy

2. Clone Repository

First, clone the repository by running the following command:

git clone https://github.com/telecmi/piopiy_python_example.git

Next, navigate to the call_masking directory:

cd call_masking

And open the delivery_agent_to_customer.py file:

delivery_agent_to_customer.py

3. Configure the call parameters

Replace the value in the Delivery agent to customer code with your actual values for

• app_id & app_secret

• delivery_agent_number

• call_masking_number

• customer_number

4. Run the code

Execute the code using Python:

python call_masking/delivery_agent_to_customer.py

5. Expected call flow

When the code is executed, the call will follow these steps:

1. Initial call to Delivery agent: The call is initiated to the delivery agent's number first.

2. Delivery agent answers call: Once the agent answers the call, the call will automatically connect to the customer's number.

You can handle these steps programmatically using the Piopiy package. Ensure that your app_id & app_secret are correctly configured, and the delivery_agent_number, call_masking_number, and customer_number provided are valid.

Example usage

from piopiy import RestClient

def make_call():
    # Initialize RestClient with your API Key and Secret
    piopiy = RestClient("your_app_id", "your_app_secret")

    delivery_agent_number = "Your delivery agent phone number"  # Your delivery agent phone number with country code
    call_masking_number = "Your call masking number"  # Your call masking number provided by the Piopiy TeleCMI platform
    customer_number = "Your customer number"  # Your customer phone number with country code

    options = {
        'duration': 10,     # (Optional) Maximum duration of the call in seconds
        'timeout': 20,      # (Optional) Time to wait for the call to be answered
        'loop': 1           # (Optional) Number of retry attempts if the call is not answered
    }

    try:
        # Make the call
        response = piopiy.voice.call(delivery_agent_number, call_masking_number, customer_number, options)
        print("Call connected, answer URL:", response)
    except Exception as error:
        print("Error:", error)

if __name__ == '__main__':
    make_call()

Sample response

Below is the following sample call response.

{
  "data": { "status": 'progress' },
  "status": 'progress',
  "request_id": 'X0uoi5LT5vCMOG6CZGEdMMYD5RL9raaEFa1p1IQ9EVm',
  "cmi_code": 200
}

Properties

These are the list of properties and its description

Property	Type	Description
status	string	The Status of the call.
request_id	string	The Unique ID for this call.

HTTP status codes

cmi_code	cmi_code type	Description
200	Success	We received the request.
401	Error	Authentication failed.