Package com.symphony.api.agent

Interface AttachmentsApi

  • @Path("/")
public interface AttachmentsApi
    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 Detail

      • v1StreamSidAttachmentCreatePost

        @POST
@Path("/v1/stream/{sid}/attachment/create")
@Consumes("multipart/form-data")
@Produces("application/json")
AttachmentInfo v1StreamSidAttachmentCreatePost​(Object fileDetail,
                                               @HeaderParam("sessionToken")
                                               String sessionToken,
                                               @HeaderParam("keyManagerToken")
                                               String keyManagerToken,
                                               @PathParam("sid")
                                               String sid)
        Upload an attachment. Upload an attachment to the given stream. The stream can be a chatroom, an IM or a multiparty IM. Once uploaded, you can use this attachment on a message you send in that stream. If the attachment is uploaded then 200 is returned.

      • v1StreamSidAttachmentGet

        @GET
@Path("/v1/stream/{sid}/attachment")
@Produces("application/octet-stream")
String v1StreamSidAttachmentGet​(@PathParam("sid")
                                String sid,
                                @QueryParam("fileId")
                                String fileId,
                                @QueryParam("messageId")
                                String messageId,
                                @HeaderParam("sessionToken")
                                String sessionToken,
                                @HeaderParam("keyManagerToken")
                                String keyManagerToken)
        Download an attachment. Downloads the attachment body by the attachment ID, stream ID, and message ID.

      • v3StreamSidAttachmentCreatePost

        @POST
@Path("/v3/stream/{sid}/attachment/create")
@Consumes("multipart/form-data")
@Produces("application/json")
AttachmentInfo v3StreamSidAttachmentCreatePost​(Object fileDetail,
                                               @HeaderParam("sessionToken")
                                               String sessionToken,
                                               @PathParam("sid")
                                               String sid,
                                               @HeaderParam("keyManagerToken")
                                               String keyManagerToken)
        PROVISIONAL - Upload an attachment. Upload an attachment to the given stream. The stream can be a chatroom, an IM or a multiparty IM. Once uploaded, you can use this attachment on a message you send in that stream. If the attachment is uploaded then 200 is returned.