Chan Actions
From Skip2PBX-WIKI
Contents |
Call related actions
call-start
This action starts a new call directed to an PBX channel.
Action Variables
- from: The caller identifier
- to: The called destination
- display-name: The caller name (where available)
Returned variables
- call-id: The new call
get-call-info
This action returns all the available information of an existing call.
Its return variables are different depending on the channel type.
Action Variables
- call-id: The PBX call
Returned variables
- from: The caller party
- to: The called party
- dir: The call direction (in/out)
- ...: ...
get-call-status
This action returns the call status.
A call can be in the status of:
- start
- ringing
- remotehold
- localhold
- inprogress
- failed
Action Variables
- call-id: The PBX call
Returned variables
- status: The call status
call-answer
This action answers a call coming from the PBX.
Action Variables
- call-id: The PBX call
call-finished
This action closes an existing call.
Action Variables
- call-id: The PBX call
call-failed
This action closes an existing call and sends a failure signal to the PBX.
Action Variables
- call-id: The PBX call
call-hold
This action set a PBX call on hold.
Action Variables
- call-id: The PBX call
call-resume
This action resumes a PBX call previously set on hold.
Action Variables
- call-id: The PBX call
call-dtmf
This action sends a DTMF signal in an inprgoress call.
Action Variables
- call-id: The PBX call
- code: The DTMF code to send
call-mute
This action mutes an inprogress call for a certain period of seconds.
Action Variables
- call-id: The PBX call
- seconds: The time expressed in seconds
call-ringing
This action sends a signal to the PBX telling that the call is ringing.
Usually this function is useless in a standard application. It is automatically handled by the IGX actions route-in and route-out.
Action Variables
- call-id: The PBX call
call-inprogress
This action sends a signal to the PBX telling that the call is inprogress.
Usually this function is useless in a standard application. It is automatically handled by the IGX actions route-in and route-out.
Action Variables
- call-id: The PBX call
call-set-property
This action is useful to add user's data information to a call.
The information can be retrieved with the get-call-info action.
Action Variables
- call-id: The PBX call
- key: The property name
- value: The property value
SIP specific actions
show-registry
This action returns the registered SIP users in the Skip2PBX SIP registrar server.
If an AOR is specified in the arguments, the action returns the list of contacts in it, otherwise it returns the AOR's list
Action Variables
- aor: The AOR to check (facoltative)
Returned variables
- aor-...: List of AOR
Returned variables
- contact-...: List of contacts in the specified AOR
message
This action sends a SIP message to a SIP user.
Action Variables
- from: The sender's contact
- to: The message destination SIP URI
- text: The body of the message
