SIP SIMPLE Client SDK

= Description =

[[Image(htdocs:SIPSIMPLE-client.png, align=right, nolink)]]

SIP SIMPLE client is Python software library built on top of PJSIP that
together with middleware allows for easy development of Internet
communications end-points based on SIP and related protocols for voice,
rich presence, instant messaging (IM) and file transfers. Other session
types can be easily added by using an extensible API.

The software is provided under the [source:LICENSE GPL LICENSE]

Background

SIP stands for 'Sessions Initiation Protocol', an IETF standard described by
[http://tools.ietf.org/html/rfc3261 RFC 3261]. SIP is an application-layer control protocol that can establish,
modify and terminate multimedia sessions such as Internet telephony calls
(VoIP). Media can be added to (and removed from) an existing session.

SIP transparently supports name mapping and redirection services, which
supports personal mobility, users can maintain a single externally visible
address identifier, which can be in the form of a standard email address or
E.164 telephone number regardless of their physical network location.

SIP allows the endpoints to negotiate and combine any type of session they
mutually understand like video, instant messaging (IM), file transfer,
desktop sharing and provides a generic event notification system with
real-time publications and subscriptions about state changes that can be
used for asynchronous services like presence, message waiting indicator and
busy line appearance.

Features

The software allows you to create elegant real-time communications applications without having to read [http://www.rfc3261.net the +1200 RFC documents] behind it. As a library with a high-level [wiki:SipApiDocumentation API], the toolkit can be used to add voice, IM and Presence functionality to any network devices as long as Python/C environment is supported by such platform.

Additional to the SIP standards implemented by the underlying PJSIP library and exposes through a Python API, this project implements session based instant messaging (IM), file transfer and multi-party chat sessions using MSRP protocol and its relay extension, publication and subscription for rich presence information such as availability, moods, activities and geo-location, management for presence rules, resource lists, RLS services documents using XCAP protocol.

• Locating SIP services [http://tools.ietf.org/html/rfc3263 RFC3263]
• Rich Presence Information Data model and Format (RPIDF) [http://tools.ietf.org/html/rfc3856 RFC3856], [http://tools.ietf.org/html/rfc3863 RFC3863 ], [http://tools.ietf.org/html/rfc4479 RFC4479], [http://tools.ietf.org/html/rfc4481 RFC4481], [http://tools.ietf.org/html/rfc4482 RFC4482], [http://tools.ietf.org/html/rfc5196 RFC5196]
• Watcher-info event package [http://tools.ietf.org/html/rfc3857 RFC3857], [http://tools.ietf.org/html/rfc3858 RFC3858]
• XCAP protocol [http://www.tools.ietf.org/html/rfc4825 RFC4825]
• XCAP presence rules [http://www.tools.ietf.org/html/rfc5025 RFC5025]
• XCAP resource-lists and RLS-services [http://www.tools.ietf.org/html/rfc4826 RFC4826]
• XCAP PIDF manipulation [http://www.tools.ietf.org/html/rfc4827 RFC4827]
• XCAP-diff event package [http://www.ietf.org/internet-drafts/draft-ietf-simple-xcap-diff-09.txt draft-ietf-simple-xcap-diff-09]
• Conference event package [http://tools.ietf.org/html/rfc4575 RFC4575]
• MSRP protocol [http://tools.ietf.org/html/rfc4975 RFC4975]
• MSRP protocol relay extension [http://tools.ietf.org/html/rfc4976 RFC4976]
• MSRP ad-hoc multi-party chat sessions [http://tools.ietf.org/html/draft-ietf-simple-chat-03 draft-ietf-simple-chat-03]
• Message summary event package [http://tools.ietf.org/html/rfc3842 RFC3842]
• Bonjour multicast DNS [http://www.ietf.org/internet-drafts/draft-lee-sip-dns-sd-uri-03.txt draft-lee-sip-dns-sd-uri-03]

Documentation

For download and installation instructions, API description and other
documentation see the files under docs/ directory.

• [wiki:SipInstallation Installation guide]
• [wiki:SipApiDocumentation API documentation]
• [wiki:SipMiddleware Middleware design]
• [wiki:SipTesting Testing the client]
• Current [source:TODO TODO] list
• Past and future [/roadmap?show=all Roadmap]

Support

The project is developed and supported by [http://ag-projects.com AG Projects] via the wiki collaboration system available at http://sipsimpleclient.com. To request support you must open a ticket. To open ticket please [/register Register] first. The source browser and ticketing system are available only for registered users.

If you wish to contribute and become an active developer of this project, send your request by email to pypjua-devel@ag-projects.com.