Loop Server API v1.0

Loop server allows firefox users to call each others via WebRTC. It is a rendezvous API built on top of an external service provider for NAT traversal and supplementary services.

This document is based on the current status of the server. All the examples had been done with real calls. It doesn’t reflect any future implementation and tries to stick with the currently deployed version.

These documents describes the HTTP APIs and the Websockets APIs.

• HTTP APIs
  • Versioning
  • Authentication
  • Derive hawk credentials from the hawk session token
  • HTTP API - Reference
    • GET /
    • GET /push-server-config
    • POST /registration
    • DELETE /registration
    • POST /call-url
    • PUT /call-url/{token}
    • DELETE /call-url/{token}
    • GET /calls/{token}
    • POST /calls/{token}
    • POST /calls
    • GET /calls?version=<version>
    • DELETE /account
  • Integration with Firefox Accounts using OAuth
    • POST /fxa-oauth/params
    • GET /fxa-oauth/token
    • POST /fxa-oauth/token
  • Error Responses
• Websockets APIs
  • Call Setup States
  • Call Progress Protocol
    • Initial Connection (hello)
    • Call Progress State Change (progress)
    • Client Action (action)
  • Termination Reasons
  • Timer Supervision
    • Server Timers
    • Client Timers

You can also find the user flow in the wiki, at https://wiki.mozilla.org/Loop/Architecture and the server source code at https://github.com/mozilla-services/loop-server.