Event endpoints

One endpoint represents one client for the connecting user. A user may have many endpoints connected at once, for example a laptop, a phone, a tablet and so on. Each client and endpoint has its own availability status and event subscriptions.

POST https://client-s.gateway.messenger.live.com/v1/users/ME/endpoints/(string: endpoint)/active

Endpoints must be kept alive by regularly pinging them. Skype for Web does this roughly every 45 seconds, sending a timeout value of 12.

Parameters:

  • endpoint – UUID of an active endpoint

JSON Parameters:

  • timeout – length of time to keep the endpoint alive

Event subscriptions

Events provide real-time information for messages sent and received in conversations, as well as endpoint and presence changes.

POST https://client-s.gateway.messenger.live.com/v1/users/ME/endpoints/(string: endpoint)/subscriptions

The list of resources, requested by Skype for Web when subscribing, are:

/v1/threads/ALL
/v1/users/ME/contacts/ALL
/v1/users/ME/conversations/ALL/messages
/v1/users/ME/conversations/ALL/properties

Note that Skype for Web uses the special SELF endpoint, though this does not appear to be a requirement (the endpoint generated during registration token retrieval can also be used).

Parameters:

  • endpoint – UUID of an active endpoint

Request JSON Object:

  • interestedResources – list of endpoints to receive events for

  • template – raw

  • channelType – httpLongPoll (tcpSocket is also a valid option)

POST https://client-s.gateway.messenger.live.com/v1/users/ME/endpoints/(string: endpoint)/subscriptions/0/poll

This returns an array of events since the last poll, under the eventMessages key. If no events have occurred, the request will block (the connection will hang, waiting for the server) until an event occurs, at which point it is returned immediately. After about 30 seconds with no events, an empty array is returned.

Parameters:

  • endpoint – UUID of an active endpoint

{"eventMessages": [{"id": 1000,
                    "resource": {"availability": "Online",
                                 "capabilities": "",
                                 "endpointPresenceDocLinks": ["https://client-s.gateway.messenger.live.com/v1/users/8:joe.4/endpoints/{...}/presenceDocs/messagingService", ...],
                                 "id": "messagingService",
                                 "selfLink": "https://client-s.gateway.messenger.live.com/v1/users/8:joe.4/presenceDocs/messagingService",
                                 "status": "Online",
                                 "type": "UserPresenceDoc"},
                    "resourceLink": "https://client-s.gateway.messenger.live.com/v1/users/ME/contacts/8:joe.4/presenceDocs/messagingService",
                    "resourceType": "UserPresence",
                    "time": "2016-01-01T00:00:00Z",
                    "type": "EventMessage"},
                   {"id": 1001,
                    "resource": {"id": "messagingService",
                                 "privateInfo": {"epname": "Joe-Desktop"},
                                 "publicInfo": {"capabilities": "",
                                                "nodeInfo": "xx",
                                                "skypeNameVersion": "908/1.22.117/swx-skype.com",
                                                "typ": "1",
                                                "version": "908/1.22.117"},
                                 "selfLink": "https://client-s.gateway.messenger.live.com/v1/users/8:joe.4/endpoints/{...}/presenceDocs/messagingService",
                                 "type": "EndpointPresenceDoc"},
                    "resourceLink": "https://client-s.gateway.messenger.live.com/v1/users/8:joe.4/endpoints/{...}/presenceDocs/messagingService",
                    "resourceType": "EndpointPresence",
                    "time": "2016-01-01T00:00:00Z",
                    "type": "EventMessage"},
                   ...]}

Resource types

  • EndpointPresence: A user connects to Skype with a new endpoint.

    {"id": "messagingService",
 "privateInfo": {"epname": "Joe-Desktop"},
 "publicInfo": {"capabilities": "",
                "nodeInfo": "xx",
                "skypeNameVersion": "908/1.22.117/swx-skype.com",
                "typ": "1",
                "version": "908/1.22.117"},
 "selfLink": "https://client-s.gateway.messenger.live.com/v1/users/8:joe.4/endpoints/{...}/presenceDocs/messagingService",
 "type": "EndpointPresenceDoc"}

  • UserPresence: A user”s availability has changed.

    {"availability": "Online",
 "capabilities": "",
 "endpointPresenceDocLinks": ["https://client-s.gateway.messenger.live.com/v1/users/8:joe.4/endpoints/{...}/presenceDocs/messagingService", ...],
 "id": "messagingService",
 "selfLink": "https://client-s.gateway.messenger.live.com/v1/users/8:joe.4/presenceDocs/messagingService",
 "status": "Online",
 "type": "UserPresenceDoc"}

  • Message: A message of any kind within a conversation.

    {"ackrequired": "https://client-s.gateway.messenger.live.com/v1/users/ME/conversations/ALL/messages/1451606400000/ack",
 "clientmessageid": "1451606399999",
 "composetime": "2016-01-01T00:00:00.000Z",
 "content": "A message for the team.",
 "contenttype": "text",
 "conversationLink": "https://client-s.gateway.messenger.live.com/v1/users/ME/conversations/19:a0b1c2...d3e4f5@thread.skype",
 "from": "https://client-s.gateway.messenger.live.com/v1/users/ME/contacts/8:anna.7",
 "id": "1451606400000",
 "imdisplayname": "Anna Cooper",
 "isactive": True,
 "messagetype": "RichText",
 "originalarrivaltime": "22016-01-01T00:00:00.000Z",
 "threadtopic": "Team chat",
 "type": "Message",
 "version": "1451606400000"}

  • Conversation: Details about a conversation that has just been joined or updated.

    {"id": "19:a0b1c2...d3e4f5@thread.skype",
 "lastMessage": {...},
 "messages": "https://client-s.gateway.messenger.live.com/v1/users/ME/conversations/19:a0b1c2...d3e4f5@thread.skype/messages",
 "properties": {"consumptionhorizon": "..."},
 "targetLink": "https://client-s.gateway.messenger.live.com/v1/threads/19:a0b1c2...d3e4f5@thread.skype",
 "threadProperties": {"lastjoinat": "1451606400000",
                      "topic": "Team chat",
                      "version": "1451606400000"},
 "type": "Conversation",
 "version": 1451606400000}

Capabilities

  • Seamless

  • Video

  • Audio

  • IsMobile

  • SmsUpgrade