PHP Voice Quickstart

Build a simple PHP application that answers a call and plays a message to the caller.

👍

You're ready for this quickstart if you've got the following:

A free trial account
A registered application
A configured FreeClimb Number
Your tools and language installed

Install the FreeClimb PHP SDK

Before we begin, make sure to install the PHP SDK. You can do this by running the following command:

composer require freeclimbapi/php-sdk:dev-master

Add quickstart code to handle FreeClimb requests

Once you've installed the SDK, you can include the functionality for handling requests from FreeClimb with the following code:

<?php
require_once "vendor/autoload.php";

$response = new FreeClimb\Api\Model\PerclScript();

header("content-type: text/json");

$say = new FreeClimb\Api\Model\Say();
$say->setText(
    "Welcome to the FreeClimb SDK!"
);

$response->addCommand($say);

echo $response->toPerCLString();

Then, run your server:

php -S localhost:8000

Make your local server publicly accessible

The fastest way to start testing your FreeClimb application is to temporarily make your local server publicly accessible through a tunneling service. We'll use ngrok to do this. Start by downloading ngrok. Unzip the file to install, then open your terminal and navigate to the directory where you've unzipped ngrok. Use the following command to start a HTTP tunnel on port 80.

./ngrok http 8000

Once you run ngrok you should receive a response with a public URL, that looks something like this:

ngrok by @inconshreveable

Tunnel Status                 online
Version                       2.0/2.0
Web Interface                 http://127.0.0.1:4040
Forwarding                    http://92832de0.ngrok.io -> localhost:80
Forwarding                    https://92832de0.ngrok.io -> localhost:80

Connnections                  ttl     opn     rt1     rt5     p50     p90
                              0       0       0.00    0.00    0.00    0.00

The Forwarding URLs point to your local server. Save the URLs and go on to the next step.


Configure your application's endpoints

Now that you've got a public URL, you're ready to configure your application's endpoints. We'll be configuring the voiceUrl using your ngrok URL and the route reference /say_hello.php.

Go to the Apps page in your dashboard. You should see your registered FreeClimb app..

Your Apps pageYour Apps page

Your Apps page

Open its App Config, and you'll see its application ID, alias, and some options for URL configuration. Enter your ngrok URL into the voiceUrl field, and add the route /say_hello.php at the end of the URL.

https://URL_TO_TEST_APP:PORT_NUMBER/say_hello.php

When you're done the App Config should look something like this:

Example completed App Config.Example completed App Config.

Example completed App Config.


Experience your app

Once you've updated your App Config you're all ready to run your app! Run the quickstart application with the following command:

> curl localhost:8000/say_hello.php
[{"Say":{"text":"Hello, world!","language":"en-US"}}]

Once the app is running, dial your configured FreeClimb number. If everything is set up right, you should hear the message "Hello, world!" and then the call will end.

Congratulations! You've just made your first voice calling application!

Updated 3 months ago


PHP Voice Quickstart


Build a simple PHP application that answers a call and plays a message to the caller.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.