Introduction to Token-Initiated Calls

Arguably, one of the cooler things about the Voxeo platform is that we have put in place a testing environment where developers may construct and test HTTP initiated phone applications. At its simplest, a token application involves creating a call by the click of a button on a webpage, resulting in the outbound call to the destination that you specify. At its most complex, one can construct a dynamic application that schedules a series of calls to be placed automatically, which is the most common methodology of making a 'notification/broadcast' style application.

How To Get Started

In order to get on the road to token enlightenment, you will want to convince the Voxeo Support team that you are worthy of a dialing token, and outbound dialing rights. In order to get access to these features, check our how-to link that details the process:

Outbound dialing access, and Call tokens

Failing all else, you can also bribe the support staff with 2 pounds of cooked bacon, they eat that stuff like it is going out of style.

A Few Words about Token Blasting

More advanced coders will eventually want to set up complex token initiated broadcast applications. When doing so, keep in mind that it is always best practice to use a singular token to place however many calls that you need to send out. You do not, repeat, do not need multiple tokens to token blast, as this defeats the load balancing and failover systems that we have in place on our network. A simple loop structure that repeatedly hits your token initiation string is the best methodology for such an application.

Start URL's

Note that there is a significant difference in the primary start URLs for a token initiated call depending on whether you are working on the Community site or on the Tech Preview site. Also note that the URLs are case sensitive, so be careful when typing them in. If you are using a CallXML token on the Community site, then your start URL should be:



http://api.voxeo.net/SessionControl/CallXML.start

Ready for more?

ANNOTATIONS: EXISTING POSTS

arruda

9/23/2009 5:56 AM (EDT)

What is my tokenid if i'm using voxeo locally and how can i put my callxml application into voxeo?

voxeoJeffK

9/23/2009 7:03 AM (EDT)

Hello,

I have created this as documentation of our Live Support chat for our mutual records. Please let us know if we can help with any other questions.

regards,
Jeff Kustermann
Voxeo Support

===============

[6:05:18 AM] Jeff: Hello. How may I assist you?
[6:05:24 AM] Arruda: Hi
[6:05:35 AM] Arruda: I'm a beginer with voxeo
[6:05:41 AM] Arruda: And i'm using it locally
[6:06:05 AM] Arruda: Can you explain me what is a tokenid?
[6:06:13 AM] Arruda: I'm reading the documentation for days...
[6:09:18 AM] Jeff: The tokenid is used in a HTTP request to the Prophecy server to initiate an application. The tokenID lets Prophecy know which application to start. The tokenID to use is the Route you have configured for that application.
[6:09:53 AM] Jeff: Say if you have an application called myApp, and the route attached to it is myRoute....
[6:11:22 AM] Arruda: Hum... I'm integrating voxeo with connexall and I need to have something like this http://api.voxeo.net/callxml.start?tokenid=abc123&numbertodial=12223334444
[6:11:52 AM] Arruda: But how can I create a xml and upload it to voxeo to say what i want when it calls?
[6:13:39 AM] Arruda: It's for local matter
[6:14:03 AM] Jeff: Sure, the docs have details here:
[6:14:09 AM] Jeff: http://docs.voxeo.com/prophecy/9.0/managementconsole.htm
[6:14:31 AM] Jeff: but you just save your XML file to voxeo/webapps/www/
[6:14:54 AM] Jeff: configure the application to point to that file at
[6:15:13 AM] Jeff: http://127.0.0.1:9990/myFile.xml
[6:19:50 AM] Arruda: Hum...And if I put the name of the file in the link he will automatically search for my file in voxeo/webapps/www?
[6:20:34 AM] Jeff: Yes
[6:20:50 AM] Arruda: Sorry asking so many questions, but i'm portuguese and i don't have a very good english, and sometimes i don't understand the language in the documentation
[6:21:05 AM] Jeff: Prophecy has a built-in webserver to do that
[6:21:27 AM] Jeff: That is fine, we understand
[6:22:30 AM] Arruda:
[HTTPPOSTTOURL=http://127.0.0.1:5078/SessionControl/VoiceXML.start?tokenid=entregas&numbertodial=sip:encomendas@127.0.0.1&callerid=sip:notification@127.0.0.1]
[6:22:51 AM] Arruda: I have to put this, of course with my data in connexall
[6:23:15 AM] Arruda: what is the meaning of the parameter ".start?"
[6:24:08 AM] Arruda: I saw it many times on the documentation
[6:26:10 AM] Jeff: That is part of the filename "VoiceXML.start"
[6:26:24 AM] Jeff: It is a CCXML file that is part of the process.
[6:27:29 AM] Jeff: I see you are using port 5078 there. That will not work
[6:27:54 AM] Jeff: the Prophecy webserver is at port 9990
[6:28:12 AM] Arruda: So, my data will be http://127.0.0.1:9990/myFile.xml?tokenid=myroute&numbertodial=sip:...
[6:28:16 AM] Arruda: Am I right?
[6:32:07 AM] Jeff: I'm sorry, my mistake. The webserver is indeed at 9990, and you will configure that in the application settings, but for sending in a token you hit 9998 for VoiceXML, so:
[6:32:17 AM] Jeff: http://127.0.0.1:9998/myFile.xml?tokenid=myroute&numbertodial=sip:...
[6:33:10 AM] Arruda: Last question lol
[6:33:35 AM] Arruda: what sip can i use so voxeo sip phone can ring?
[6:33:50 AM] Arruda: *prophecy sip phone
[6:34:52 AM] Jeff: Calling it from another computer, you mean?
[6:35:02 AM] Arruda: No
[6:35:05 AM] Arruda: From the same computer
[6:35:17 AM] Arruda: Normally we pute sip:route@127.0.0.1
[6:35:19 AM] Arruda: Right?
[6:36:08 AM] Arruda: It's because I have all the servers running on the same computer
[6:36:13 AM] Arruda: Voxeo and Connexall
[6:36:52 AM] Arruda: *put
[6:39:03 AM] Jeff: Prophecy is going to answer calls on that computer, as it has bound to the SIP ports.
[6:40:45 AM] Jeff: You can install a separate softphone like X-Lite perhaps to where you can configure an account name against the same computer, and call it at port 5070
[6:41:23 AM] Arruda: But what it going to be my sip?Is it generated by x-lite?
[6:41:42 AM] Arruda: *my destiny sip
[6:42:27 AM] Jeff: If for example you configured X-Lite to have an account "myAccount" you can call
[6:42:40 AM] Jeff: sip:myAccount@127.0.0.1:5070
[6:43:05 AM] Arruda: Hum...
[6:43:08 AM] Arruda: Ok
[6:43:22 AM] Arruda: It's all
[6:43:45 AM] Arruda: Thank you very much for your time
[6:43:55 AM] Jeff: ok. You're very welcome.
[6:44:04 AM] Jeff: Let us know whenever you have a question!
[6:44:09 AM] Jeff: It looks like we might have addressed all of your questions. Can you help us understand if this chat was valuable for you? Please click here to exit this chat and tell us how it went.

Call Bridging

| TOC

Outbound CallXML Applications via HTTP