Table of Contents
List of Tables
List of Examples
This module offers support for instant message conference. It follows the architecture of IRC channels, you can send commands embedded in MESSAGE body, because there are no SIP UA clients which have GUI for IM conferencing.
You have to define an URI corresponding to im conferencing manager, where user can send commands to create a new conference room. Once the conference room is created, users can send commands directly to conferece's URI.
To ease the integration in the configuration file, the interpreter of the IMC commands are embeded in the module, from configuration poin of view, there is only one function which has to be executed for both messages and commands.
The database url.
The default value is “mysql://opensips:opensipsrw@localhost/opensips”.
Example 1.1. Set db_url parameter
...
modparam("imc", "db_url", "dbdriver://username:password@dbhost/dbname")
...
The name of the table storing IMC rooms.
The default value is "imc_rooms".
The name of the table storing IMC members.
The default value is "imc_members".
The power of 2 to get the size of the hash table used for storing members and rooms.
The default value is 4 (resultimg in hash size 16).
The character which indicates that the body of the message is a command.
The default value is "#".
The SIP address used as next hop when sending the message. Very useful when using OpenSIPS with a domain name not in DNS, or when using a separate OpenSIPS instance for imc processing. If not set, the message will be sent to the address in destination URI.
Default value is NULL.
Example 1.6. Set outbound_proxy parameter
...
modparam("imc", "outbound_proxy", "sip:opensips.org;transport=tcp")
...
Handles Message method.It detects if the body of the message is a conference command.If so it executes it, otherwise it sends the message to all the members in the room.
This function can be used from REQUEST_ROUTE.
Example 1.7. Usage of imc_manager() function
...
# the rooms will be named chat-xyz to avoid overlapping
# with usernames
if(is_method("MESSAGE)
&& ($ru=~ "sip:chat-[0-9]+@" || ($ru=~ "sip:chat-manager@")
imc_manager();
...
Lists of the IM Conferencing rooms.
Name: imc_list_rooms
Parameters: none
MI FIFO Command Format:
opensips-cli -x mi imc_list_rooms
A command is identified by the starting character. A command must be written in one line. By default, the starting character is '#'. You can change it via "imc_cmd_start_char" parameter.
Next picture presents the list of commands and their parameters.
Example 1.8. List of commands
...
1.create
-creates a conference room
-takes 2 parameters:
1) the name of the room
2)optional- "private" -if present the created room is private
and new members can be added only though invitations
-the user is added as the first member and owner of the room
-eg: #create chat-000 private
2.join
-makes the user member of a room
-takes one optional parameter - the address of the room -if not
present it will be considered to be the address in the To
header of the message
-if the room does not exist the command is treated as create
-eg:join sip:chat-000@opensips.org,
or just, #join, sent to sip:chat-000@opensips.org
3.invite
-invites a user to become a member of a room
-takes 2 parameters:
1)the complete address of the user
2)the address of the room -if not present it will be considered
to be the address in the To header of the message
-only certain users have the right to invite other user: the owner
and the administrators
-eg: #invite sip:john@opensips.org sip:chat-000@opensips.org
or #invite john@opensips.org sent to sip:chat-000@opensips.org
4.accept
-accepting an invitation
-takes one optional parameter - the address of the room - if not
present it will be considered to be the address in the To header
of the message
-eg: #accept sip:john@opensips.org
5.deny
-rejects an invitation
-the parameter is the same as for accept
6.remove
-deletes a member from a room
-takes 2 parameters:
1)the complete address of the member
2)the address of the room -if not present it will be considered
to be the address in the To header of the message
-only certain members have the right to remove other members
-eg: #remove sip:john@opensips.org, sent to sip:chat-000@opensips.org
7.exit
-leaving a room
-takes one optional parameter - the address of the room - if not
present it will be considered to be the address in the To header
of the message
-if the user is the owner of the room, the room will be destroyed
8.destroy
-removing a room
-the parameter is the same as for exit
-only the owner of a room has the right to destroy it
9.list
-list members in a room
...
Before running OpenSIPS with IMC, you have to setup the database tables where the module will store the data. For that, if the tables were not created by the installation script or you choose to install everything by yourself you can use the imc-create.sql SQL script in the database directories in the opensips/scripts folder as template. You can also find the complete database documentation on the project webpage, https://opensips.org/docs/db/db-schema-devel.html.
Table 2.1. Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
| Name | DevScore | Commits | Lines ++ | Lines -- | |
|---|---|---|---|---|---|
| 1. | Daniel-Constantin Mierla (@miconda) | 43 | 12 | 1604 | 1007 |
| 2. | Bogdan-Andrei Iancu (@bogdan-iancu) | 41 | 29 | 308 | 548 |
| 3. | Anca Vamanu | 32 | 5 | 3014 | 16 |
| 4. | Razvan Crainea (@razvancrainea) | 18 | 16 | 34 | 40 |
| 5. | Liviu Chircu (@liviuchircu) | 15 | 12 | 39 | 66 |
| 6. | Henning Westerholt (@henningw) | 10 | 7 | 76 | 105 |
| 7. | Vlad Patrascu (@rvlad-patrascu) | 9 | 6 | 75 | 80 |
| 8. | Elena-Ramona Modroiu | 4 | 2 | 68 | 5 |
| 9. | Maksym Sobolyev (@sobomax) | 4 | 2 | 5 | 6 |
| 10. | Alexandra Titoc | 4 | 2 | 4 | 2 |
All remaining contributors: John Riordan, Sergio Gutierrez, Konstantin Bokarius, Peter Lemenkov (@lemenkov), Edson Gellert Schubert, Walter Doekes (@wdoekes).
(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)
(2) including any documentation-related commits, excluding merge commits. Regarding imported patches/code, we do our best to count the work on behalf of the proper owner, as per the "fix_authors" and "mod_renames" arrays in opensips/doc/build-contrib.sh. If you identify any patches/commits which do not get properly attributed to you, please submit a pull request which extends "fix_authors" and/or "mod_renames".
(3) ignoring whitespace edits, renamed files and auto-generated files
Table 2.2. Most recently active contributors(1) to this module
| Name | Commit Activity | |
|---|---|---|
| 1. | Razvan Crainea (@razvancrainea) | Sep 2011 - Sep 2024 |
| 2. | Alexandra Titoc | Sep 2024 - Sep 2024 |
| 3. | Maksym Sobolyev (@sobomax) | Feb 2023 - Feb 2023 |
| 4. | Liviu Chircu (@liviuchircu) | Mar 2014 - Apr 2021 |
| 5. | Bogdan-Andrei Iancu (@bogdan-iancu) | Oct 2006 - Apr 2020 |
| 6. | Vlad Patrascu (@rvlad-patrascu) | May 2017 - Apr 2019 |
| 7. | Peter Lemenkov (@lemenkov) | Jun 2018 - Jun 2018 |
| 8. | Walter Doekes (@wdoekes) | May 2014 - May 2014 |
| 9. | John Riordan | May 2009 - May 2009 |
| 10. | Sergio Gutierrez | Nov 2008 - Nov 2008 |
All remaining contributors: Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Henning Westerholt (@henningw), Anca Vamanu, Elena-Ramona Modroiu.
(1) including any documentation-related commits, excluding merge commits
Last edited by: Liviu Chircu (@liviuchircu), Bogdan-Andrei Iancu (@bogdan-iancu), Razvan Crainea (@razvancrainea), Peter Lemenkov (@lemenkov), Vlad Patrascu (@rvlad-patrascu), Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Anca Vamanu, Henning Westerholt (@henningw), Elena-Ramona Modroiu.
Documentation Copyrights:
Copyright © 2006-2008 Voice Sistem SRL