LogoLogo
  • Go to Docs Center
  • Plum DEV Documentation
  • Overview
  • Developer Reference
    • Tutorial
    • How to...
      • Use Plum's Transcription API
    • Audio Formats and Prompts
    • Grammars and Speech Recognition
    • Available ASR Engines
    • TTS Engine Characteristics
      • Amazon Polly TTS Engine
        • Polly Voice Tag Attribute Details
      • AT&T Natural Voices
      • Cepstral Engine
      • RealSpeak Engine
      • Vocalizer 7
        • Vocalizer 7: <voice> tag and SSML Support
    • Data Exchange
    • Logging
    • Caching
    • Root Documents
  • VoiceXML
    • Tags
      • <assign>
      • <audio>
      • <block>
      • <break>
      • <catch>
      • <choice>
      • <clear>
      • <data>
      • <desc>
      • <disconnect>
      • <else>
      • <elseif>
      • <emphasis>
      • <enumerate>
      • <error>
      • <example>
      • <exit>
      • <field>
      • <filled>
      • <foreach>
      • <form>
      • <goto>
      • <grammar>
      • <help>
      • <if>
      • <initial>
      • <item>
      • <lexicon>
      • <link>
      • <log>
      • <mark>
      • <menu>
      • <meta>
      • <metadata>
      • <noinput>
      • <nomatch>
      • <one-of>
      • <option>
      • <paragraph>
      • <param>
      • <phoneme>
      • <prompt>
      • <property>
      • <prosody>
      • <record>
      • <reprompt>
      • <return>
      • <rule>
      • <ruleref>
      • <say-as>
      • <script>
      • <sentence>
      • <speak>
      • <sub>
      • <subdialog>
      • <submit>
      • <tag>
      • <throw>
      • <token>
      • <transfer>
      • <value>
      • <var>
      • <voice>
      • <vxml>
    • Properties
      • audiofetchhint
      • audiomaxage
      • audiomaxstale
      • bargein
      • bargeintype
      • certverifypeer
      • completetimeout
      • confidencelevel
      • datafetchhint
      • datamaxage
      • datamaxstale
      • documentfetchhint
      • documentmaxage
      • documentmaxstale
      • fetchaudio
      • fetchaudiodelay
      • fetchaudiominimum
      • fetchtimeout
      • grammarfetchhint
      • grammarmaxage
      • grammarmaxstale
      • incompletetimeout
      • inputmodes
      • interdigittimeout
      • logging
      • maxnbest
      • maxspeechtimeout
      • normalizeaudio
      • recordcall
      • recordcallappend
      • recordutterance
      • recordutterancetype
      • scriptfetchhint
      • scriptmaxage
      • scriptmaxstale
      • sensitivity
      • speedvsaccuracy
      • termchar
      • termmaxdigits
      • termtimeout
      • timeout
      • universals
      • voicegender
      • voicename
    • Application and Session Variables
      • application.lastresult$[i].confidence
      • application.lastresult$[i].inputmode
      • application.lastresult$[i].interpretation
      • application.lastresult$[i].recording
      • application.lastresult$[i].recordingduration
      • application.lastresult$[i].recordingsize
      • application.lastresult$[i].utterance
      • session.callrecording
      • session.id
      • session.telephone.ani
      • session.telephone.dnis
    • VoiceXML Resources
  • Plum DEV Guide
    • Using the Plum DEV site
    • Using the File Repository
    • Outbound Calling Guide
      • Using the Outbound Tools in the DEV web UI
      • DEV Outbound Programming Notes
      • Outbound FAQs and Tips
    • Call Reporting
    • Analytics
    • VoiceTrends
    • Debugging
    • Scratchpads
    • Saved URLs
    • Voice Biometrics
    • Call Routing
    • Data Security
      • 'Private' Tags
      • Managing Secure Phone Numbers
      • Sensitive Data Types
    • SMS Guide
      • Standard Short Codes
      • SMS Debugging/Error Logs
      • Additional SMS Info
    • Single Sign On
  • Plum DEV APIs
    • DEV Outbound APIs
      • Contacts CSV Formatting
      • Outbound API Parameter Notes
      • Legacy and Miscellaneous Notes
    • SMS API
    • Call Logs API
    • Call Scheduling and Pacing API
    • Transcription API
    • Application API
    • Blocklist API
Powered by GitBook
On this page
  • Overview
  • Authentication
  • Get ASR Value
  • Get TTS Value
  • Get URL Value
  • Get ASR Options
  • Get TTS Options
  • Set ASR Value
  • Set TTS Value
  • Set URL Value
  1. Plum DEV APIs

Application API

PreviousTranscription APINextBlocklist API

Last updated 2 years ago

- NEW! - Interactive API docs, now live!

Visit to read Plum API documentation, build and test requests in our interactive API sandbox, review the responses, and share it all with your team.

Overview

Plum offers eight services for its Application REST API:

Method

Service

Description

These API methods are designed to work with inbound phone numbers.

Authentication

All API requests authenticate using HTTP Basic Authentication. Use the same username and password that you use to login to your Dev account.

Most likely, users will be able to use built-in HTTP Basic Authentication, depending on the HTTP libraries available in the programming language they opt to use.

Examples of this for each Method are listed below.

Get ASR Value

GET https://hosting.plumvoice.com/ws/application/getASR/{phone_number}

Returns ASR value currently set to phone number provided.

Path Parameters

Name
Type
Description

phone_number

string

10 digit phone number Ex. 3332221111

Headers

Name
Type
Description

Accept

string

application/xml, application/json

{
    "status": "success",
    "error": "",
    "result": {
        "asr": "Nuance OSR 3.0"
    }
}

Sample Request:

<?php

$login = "<username>";
$password = "<password>";
$phone_number = "<phone number>";
$auth = $login . ":" . $password;
$url = "https://hosting.plumvoice.com/ws/application/getASR/$phone_number";

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_USERPWD, $auth);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

$response = curl_exec($ch);

curl_close($ch);
?>

Get TTS Value

GET https://hosting.plumvoice.com/ws/application/getTTS/{phone_number}

Returns TTS value currently set to phone number provided.

Path Parameters

Name
Type
Description

phone_number

string

10 digit phone number Ex. 3332221111

Headers

Name
Type
Description

Accept

string

application/xml, application/json

{
    "status": "success",
    "error": "",
    "result": {
        "tts": "AT&T Natural Voices 1.4"
    }
}

Sample Request:

<?php

$login = "<username>";
$password = "<password>";
$phone_number = "<phone number>";
$auth = $login . ":" . $password;
$url = "https://hosting.plumvoice.com/ws/application/getTTS/$phone_number";

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_USERPWD, $auth);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

$response = curl_exec($ch);

curl_close($ch);
?>

Get URL Value

GET https://hosting.plumvoice.com/ws/application/getURL/{phone_number}

Returns URL value currently set to phone number provided.

Path Parameters

Name
Type
Description

phone_number

string

10 digit phone number Ex. 3332221111

Headers

Name
Type
Description

Accept

string

application/xml, application/json

{
    "status": "success",
    "error": "",
    "result": {
        "url": "http://google.com"
    }
}

Sample Request:

<?php

$login = "<username>";
$password = "<password>";
$phone_number = "<phone number>";
$auth = $login . ":" . $password;
$url = "https://hosting.plumvoice.com/ws/application/getURL/$phone_number";

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_USERPWD, $auth);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

$response = curl_exec($ch);

curl_close($ch);
?>

Get ASR Options

GET https://hosting.plumvoice.com/ws/application/getOptionsASR

Returns all currently available ASR options.

Headers

Name
Type
Description

Accept

string

application/xml, application/json

{
    "status": "success",
    "error": "",
    "result": {
        "asr": [
            "Nuance OSR 3.0",
            "Nuance Recognizer 9",
            "Nuance Recognizer 11"
        ]
    }
}

Sample Request:

<?php

$login = "<username>";
$password = "<password>";
$auth = $login . ":" . $password;
$url = "https://hosting.plumvoice.com/ws/application/getOptionsASR";

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_USERPWD, $auth);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

$response = curl_exec($ch);

curl_close($ch);
?>

Get TTS Options

GET https://hosting.plumvoice.com/ws/application/getOptionsTTS

Returns all currently available TTS options.

Headers

Name
Type
Description

Accept

string

application/xml, application/json

{
    "status": "success",
    "error": "",
    "result": {
        "asr": [
            "Nuance RealSpeak 4.0",
            "Cepstral Swift 4.1",
            "AT&T Natural Voices 1.4",
            "Nuance Vocalizer 6.0 Alpha",
            "AWS Polly",
            "Nuance Vocalizer 7"
        ]
    }
}

Sample Request:

<?php

$login = "<username>";
$password = "<password>";
$auth = $login . ":" . $password;
$url = "https://hosting.plumvoice.com/ws/application/getOptionsTTS";

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_USERPWD, $auth);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

$response = curl_exec($ch);

curl_close($ch);
?>

Set ASR Value

POST https://hosting.plumvoice.com/ws/application/setASR/{phone_number}

Sets the ASR of the given phone number to the provided ASR value.

Path Parameters

Name
Type
Description

phone_number

string

10 digit phone number Ex. 3332221111

Headers

Name
Type
Description

Content-type

string

multipart/form-data

Accept

string

application/xml, applicaton/json

Request Body

Name
Type
Description

asr

string

ASR value to be set

{
    "status": "success",
    "error": "",
    "result": {
        "asr": "Record updated successfully"
    }
}

Sample Request:

<?php

$username = "<login>";
$password = "<password>";
$phone_number = "<phone number>";
$value = "<ASR to be set>";
$params = array("asr"=>$value);

$auth = $username . ":" . $password;
$url = "https://hosting.plumvoice.com/ws/application/setASR/$phone_number";

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_USERPWD, $auth);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HEADER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Accept: application/json", "Content-type: multipart/form-data"));
$result = curl_exec($ch);
curl_close($ch);
?>

Set TTS Value

POST https://hosting.plumvoice.com/ws/application/setTTS/{phone_number}

Sets the TTS of the given phone number to the TTS value provided.

Path Parameters

Name
Type
Description

phone_number

string

10 digit phone number Ex. 3332221111

Headers

Name
Type
Description

Content-type

string

multipart/form-data

Accept

string

application/xml, application/json

Request Body

Name
Type
Description

tts

string

TTS value to be set

{
    "status": "success",
    "error": "",
    "result": {
        "tts": "Record updated successfully"
    }
}

Sample Request:

<?php

$username = "<login>";
$password = "<password>";
$phone_number = "<phone number>";
$value = "<TTS to be set>";
$params = array("tts"=>$value);

$auth = $username . ":" . $password;
$url = "https://hosting.plumvoice.com/ws/application/setTTS/$phone_number";

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_USERPWD, $auth);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HEADER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Accept: application/json", "Content-type: multipart/form-data"));
$result = curl_exec($ch);
curl_close($ch);
?>

Set URL Value

POST https://hosting.plumvoice.com/ws/application/setURL/{phone_number}

Sets the URL of the given phone number to the provided URL value.

Path Parameters

Name
Type
Description

phone_number

string

10 digit phone number Ex. 3332221111

Headers

Name
Type
Description

Content-type

string

multipart/form-data

Accept

string

application/xml, application/json

Request Body

Name
Type
Description

url

string

URL value to be set

{
    "status": "success",
    "error": "",
    "result": {
        "url": "Record updated successfully"
    }
}

Sample Request:

<?php

$username = "<login>";
$password = "<password>";
$phone_number = "<phone number>";
$value = "<URL to be set>";
$params = array("url"=>$value);

$auth = $username . ":" . $password;
$url = "https://hosting.plumvoice.com/ws/application/setURL/$phone_number";

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_USERPWD, $auth);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HEADER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Accept: application/json", "Content-type: multipart/form-data"));
$result = curl_exec($ch);
curl_close($ch);
?>

api-docs.plumvoice.com
GET
application/getASR
Returns the ASR value of the given phone number
GET
application/getTTS
Returns the TTS value of the given phone number
GET
application/getURL
Returns the URL value of the given phone number
GET
application/getOptionsASR
Returns a list of ASR options
GET
application/getOptionsTTS
Returns a list of TTS options
POST
application/setASR
Sets the ASR value on the given phone number
POST
application/setTTS
Sets the TTS value on the given phone number
POST
application/setURL
Sets the URL value on the given phone number