Call.execute
From Yate Documentation
(Difference between revisions)
(Created page with "Message sent to connect channels. There are two forms: one for incoming and one for outgoing channels. === Incoming === Sent by incoming channel with its CallEndPoint in use...") |
|||
| (4 intermediate revisions by one user not shown) | |||
| Line 30: | Line 30: | ||
:::the maximum duration for this call expressed in miliseconds. use this parameter for the prepaid applications. | :::the maximum duration for this call expressed in miliseconds. use this parameter for the prepaid applications. | ||
'''copyparams''' | '''copyparams''' | ||
| − | :::comma separated list of parameters that will be copied from this message to the chan.startup generated by the outgoing call leg. only channels derived from the Channel class implement this behaviour by default, external scripts have to copy the parameters themselves. | + | :::comma separated list of parameters that will be copied from this message to the [[chan.startup]] generated by the outgoing call leg. only channels derived from the '''Channel''' class implement this behaviour by default, external scripts have to copy the parameters themselves. |
'''autoanswer''', '''autoring''', '''autoprogress''' | '''autoanswer''', '''autoring''', '''autoprogress''' | ||
:::Auto append Answered, Ringing and Progress _signalling_ messages to Accept after successfull routing | :::Auto append Answered, Ringing and Progress _signalling_ messages to Accept after successfull routing | ||
| Line 40: | Line 40: | ||
Sent to have some module make an outgoing call to destination given in target parameter from source given in callto. | Sent to have some module make an outgoing call to destination given in target parameter from source given in callto. | ||
| − | To handle this message module sends call.route with target as called parameter and then call.execute with result of call.route message. | + | To handle this message module sends [[call.route]] with target as called parameter and then '''call.execute''' with result of [[call.route]] message. |
| − | It is understood by at least wavefile and tonegen modules. | + | It is understood by at least [[wavefile]] and [[tonegen]] modules. |
==== Parameters ==== | ==== Parameters ==== | ||
| Line 50: | Line 50: | ||
'''callto''' | '''callto''' | ||
:::Called protocol/address description, bypasses routing | :::Called protocol/address description, bypasses routing | ||
| + | |||
| + | |||
| + | '''See also''' | ||
| + | |||
| + | *[[call.progress]] | ||
Latest revision as of 15:18, 22 January 2013
Message sent to connect channels. There are two forms: one for incoming and one for outgoing channels.
Contents |
[edit] Incoming
Sent by incoming channel with its CallEndPoint in userData field. In response, recipient should connect its CallEndPoint to CallEndPoint given in userData.
[edit] Parameters
userData
- CallEndPoint of calling channel
driver
- Driver of incoming channel
id
- channel id.
callername
- module-specific caller name
called
- the number that was originally called
callto
- the module and module-specific address that is expected (by means of the routing decision) to service the call
caller
- the number of the caller
context
- the routing context selected by the current call
status
- direction of the message, module-wise (i.e. the module that emits the message will set it to 'outgoing' and the module receiving it will see it as 'incoming')
maxcall
- the maximum pre-answer time for this call expressed in miliseconds. use this parameter to fail the call with a "noanswer" error that can be diverted later.
timeout
- the maximum duration for this call expressed in miliseconds. use this parameter for the prepaid applications.
copyparams
- comma separated list of parameters that will be copied from this message to the chan.startup generated by the outgoing call leg. only channels derived from the Channel class implement this behaviour by default, external scripts have to copy the parameters themselves.
autoanswer, autoring, autoprogress
- Auto append Answered, Ringing and Progress _signalling_ messages to Accept after successfull routing
At least for Yate-0.9-CVS, driver has been renamed to module.
[edit] Outgoing
Sent to have some module make an outgoing call to destination given in target parameter from source given in callto.
To handle this message module sends call.route with target as called parameter and then call.execute with result of call.route message.
It is understood by at least wavefile and tonegen modules.
[edit] Parameters
target
- Number to call, requests routing
callto
- Called protocol/address description, bypasses routing
See also
