Msg.route

From Yate Documentation
Jump to: navigation, search

msg.route message is used to route a chat message.
This message must be explicitly installed.
The message has been designed for synchronous processing.

Parameters

caller

The caller number.

called

The called number.

called_instance

The called instance that means the connection data of the called to the server also called resource.

caller_instance

The caller instance that means the connection data of the caller to the server.

How it works?

A Module (let's say jabberserver module) emits message msg.route and is cought by another module (let's say subscription module) then the destination is searched. If the destination is a unknown user false is returned. If the destination is a known user the resource is checked. If all requirements are fulfilled and the user is offline the server will try to store the chat. That means if the user is subscribed to presence, an error will be send saying the user is offline, or the item was not found. Else the error will be something like service unavailable.


See also

Personal tools
Namespaces

Variants
Actions
Preface
Configuration
Administrators
Developers