Category:DSI 3.0 - XML Scripting Skype Events

From Skip2PBX-WIKI

Contents 1 Skype Events 2 Events variables 3 Action arguments 4 Hidden Action arguments

Skype Events

A Skype Event is one event raised by the Skype client. One event can be for example one incoming call or one incoming chat message or even one user that becomes visible on-line.

Each raised event is defined by an event name and a set of events variables.

Here a small example:

<event name="chatmessage-incoming-received">

  <action to="skype" name="chatmessage-send">
    <arg name="message-body">Hello ${user-dispname}, chat is not allowed here. Goodbye.</arg>
  </action>	

  <action to="skype" name="chat-leave" />

</event>

As you can see the event name is chatmessage-incoming-received and when it is raised, Skip2PBX is asked to run two actions:

1. Send a chat message
2. Leave the chat

Events variables

You can refer an event variable with the syntax ${variablename} where "variablename" is the name of the variable you want to use.
Each event has a specific variables set depending on its structure.

Action arguments

On the other hand each action has zero or more arguments defined by the XML tag <arg>.
As said with events, each action has its specific arguments set depending on its structure.

Hidden Action arguments

If an argument value is not defined, its value is inherited from the event variables set. In this example we have two inherited variables:

• user-name that defines the Skype username to send the message to
• chat-name that defines the chat to close