```
@Path("/")
public interface SignalsApi
```
Agent API
This document refers to Symphony API calls to send and receive messages and content. They need the on-premise Agent installed to perform decryption/encryption of content. - sessionToken and keyManagerToken can be obtained by calling the authenticationAPI on the symphony back end and the key manager respectively. Refer to the methods described in authenticatorAPI.yaml. - Actions are defined to be atomic, ie will succeed in their entirety or fail and have changed nothing. - If it returns a 40X status then it will have sent no message to any stream even if a request to aome subset of the requested streams would have succeeded. - If this contract cannot be met for any reason then this is an error and the response code will be 50X. - MessageML is a markup language for messages. See reference here: https://rest-api.symphony.com/docs/messagemlv2

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`AgentInfo`	`v1InfoGet()`	Get information about the Agent
`Signal`	`v1SignalsCreatePost(BaseSignal body, String sessionToken, String keyManagerToken)`	Create a signal.
`SuccessResponse`	`v1SignalsIdDeletePost(String sessionToken, String id, String keyManagerToken)`	Delete a signal.
`Signal`	`v1SignalsIdGetGet(String sessionToken, String id, String keyManagerToken)`	Get details of the requested signal.
`ChannelSubscriptionResponse`	`v1SignalsIdSubscribePost(String sessionToken, String id, List<Long> body, String keyManagerToken, Boolean pushed)`	Subscribe to a Signal.
`ChannelSubscriberResponse`	`v1SignalsIdSubscribersGet(String sessionToken, String id, String keyManagerToken, Integer skip, Integer limit)`	Get the subscribers of a signal
`ChannelSubscriptionResponse`	`v1SignalsIdUnsubscribePost(String sessionToken, String id, List<Long> body, String keyManagerToken)`	Unsubscribe to a Signal.
`Signal`	`v1SignalsIdUpdatePost(BaseSignal body, String sessionToken, String id, String keyManagerToken)`	Update a signal.
`SignalList`	`v1SignalsListGet(String sessionToken, String keyManagerToken, Integer skip, Integer limit)`	List signals for the requesting user.

Method Detail

v1InfoGet

@GET
@Path("/v1/info")
@Produces("application/json")
AgentInfo v1InfoGet()

Get information about the Agent

v1SignalsCreatePost

@POST
@Path("/v1/signals/create")
@Consumes("application/json")
@Produces("application/json")
Signal v1SignalsCreatePost(BaseSignal body,
                           @HeaderParam("sessionToken")
                           String sessionToken,
                           @HeaderParam("keyManagerToken")
                           String keyManagerToken)

Create a signal.

v1SignalsIdDeletePost

@POST
@Path("/v1/signals/{id}/delete")
@Produces("application/json")
SuccessResponse v1SignalsIdDeletePost(@HeaderParam("sessionToken")
                                      String sessionToken,
                                      @PathParam("id")
                                      String id,
                                      @HeaderParam("keyManagerToken")
                                      String keyManagerToken)

Delete a signal.

v1SignalsIdGetGet

@GET
@Path("/v1/signals/{id}/get")
@Produces("application/json")
Signal v1SignalsIdGetGet(@HeaderParam("sessionToken")
                         String sessionToken,
                         @PathParam("id")
                         String id,
                         @HeaderParam("keyManagerToken")
                         String keyManagerToken)

Get details of the requested signal.

v1SignalsIdSubscribePost

@POST
@Path("/v1/signals/{id}/subscribe")
@Consumes("application/json")
@Produces("application/json")
ChannelSubscriptionResponse v1SignalsIdSubscribePost(@HeaderParam("sessionToken")
                                                     String sessionToken,
                                                     @PathParam("id")
                                                     String id,
                                                     List<Long> body,
                                                     @HeaderParam("keyManagerToken")
                                                     String keyManagerToken,
                                                     @QueryParam("pushed")
                                                     Boolean pushed)

Subscribe to a Signal.

v1SignalsIdSubscribersGet

@GET
@Path("/v1/signals/{id}/subscribers")
@Produces("application/json")
ChannelSubscriberResponse v1SignalsIdSubscribersGet(@HeaderParam("sessionToken")
                                                    String sessionToken,
                                                    @PathParam("id")
                                                    String id,
                                                    @HeaderParam("keyManagerToken")
                                                    String keyManagerToken,
                                                    @QueryParam("skip")
                                                    Integer skip,
                                                    @QueryParam("limit")
                                                    Integer limit)

Get the subscribers of a signal

v1SignalsIdUnsubscribePost

@POST
@Path("/v1/signals/{id}/unsubscribe")
@Consumes("application/json")
@Produces("application/json")
ChannelSubscriptionResponse v1SignalsIdUnsubscribePost(@HeaderParam("sessionToken")
                                                       String sessionToken,
                                                       @PathParam("id")
                                                       String id,
                                                       List<Long> body,
                                                       @HeaderParam("keyManagerToken")
                                                       String keyManagerToken)

Unsubscribe to a Signal.

v1SignalsIdUpdatePost

@POST
@Path("/v1/signals/{id}/update")
@Consumes("application/json")
@Produces("application/json")
Signal v1SignalsIdUpdatePost(BaseSignal body,
                             @HeaderParam("sessionToken")
                             String sessionToken,
                             @PathParam("id")
                             String id,
                             @HeaderParam("keyManagerToken")
                             String keyManagerToken)

Update a signal.

v1SignalsListGet

@GET
@Path("/v1/signals/list")
@Produces("application/json")
SignalList v1SignalsListGet(@HeaderParam("sessionToken")
                            String sessionToken,
                            @HeaderParam("keyManagerToken")
                            String keyManagerToken,
                            @QueryParam("skip")
                            Integer skip,
                            @QueryParam("limit")
                            Integer limit)

List signals for the requesting user. This includes signals that the user has created and public signals to which they subscribed.

Interface SignalsApi