Tropo WebAPI Development Guide Home  |  Frameset Home


{"redirect":}  object


This is used to deflect the call to a third party SIP address. This function must be called before the call is answered; for active calls, consider using transfer.


usage

{ "redirect": {
    "to": Object,
    "name": String,
    "required": Boolean } }


fields

to Data Type: Object Default: (none) Required
The SIP destination for the incoming call, as a URL. An example:

sip:9991436228@sip.trpop.com
name Data Type: String Default: "" (undefined) Optional
This is the key used to identify the result of an operation, so you can differentiate between multiple results. As an example, if you asked the user for their favorite color, you could set the name value as 'color' while the returned value might be 'blue'. Not particularly useful if there's only one result returned, but if there are multiple results it helps to determine which result belonged to which operation.
required Data Type: Boolean Default: true Optional
This determines whether Tropo should move on to the next verb; if required is set to 'true', Tropo will only move on to the next verb if the current operation completely successfully.



code samples

Example showing redirect to a SIP address/application
{
   "tropo":[
      {
         "redirect":{
            "to":"sip:9991427589@sip.tropo.com"
         },
         "name":"foo"
      }
   ]
}



additional links

none


  ANNOTATIONS: EXISTING POSTS
0 posts - click the button below to add a note to this page

login



© 2012 Voxeo Corporation  |  Voxeo IVR  |  VoiceXML & CCXML IVR Developer Site