Chilkat Online Tools

Swift / Sunshine Conversations API / Upload Attachment

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

    http.BasicAuth = true
    http.Login = "username"
    http.Password = "password"

    let req = CkoHttpRequest()
    req.HttpVerb = "POST"
    req.Path = "/v2/apps/{{appId}}/attachments?access=public&for=message&conversationId=c616a583e4c240a871818541"
    req.ContentType = "multipart/form-data"
    req.AddParam("source", value: "amet officia cons")

    var resp: CkoHttpResponse? = http.SynchronousRequest("domain.com", port: 443, ssl: true, req: req)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "attachment": {
    //     "mediaUrl": "http://smooch.io/rocks.smooch.media-dev/apps/5ec41c54fe13cc5ac404bedc/conversations/c616a583e4c240a871818541/TmYMVQUBNsQRItX4fKf4aC-T/Screen%20Shot%202020-09-02%20at%204.04.41%20PM.png",
    //     "mediaType": "image/png"
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var MediaUrl: String? = jResp.StringOf("attachment.mediaUrl")
    var MediaType: String? = jResp.StringOf("attachment.mediaType")

}

Curl Command

curl -X POST
	-u 'username:password'
	-H "Content-Type: multipart/form-data"
	--form 'source=amet officia cons'
https://domain.com/v2/apps/{{appId}}/attachments?access=public&for=message&conversationId=c616a583e4c240a871818541

Postman Collection Item JSON

{
  "name": "Upload Attachment",
  "_postman_id": "7ce74c14-487b-4d62-aeb1-7d1ab9d98568",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "multipart/form-data"
      }
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "source",
          "value": "amet officia cons",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{url}}/v2/apps/{{appId}}/attachments?access=public&for=message&conversationId=c616a583e4c240a871818541",
      "host": [
        "{{url}}"
      ],
      "path": [
        "v2",
        "apps",
        "{{appId}}",
        "attachments"
      ],
      "query": [
        {
          "key": "access",
          "value": "public",
          "description": "(Required) The access level for the attachment. Currently the available access levels are public and private."
        },
        {
          "key": "for",
          "value": "message",
          "description": "Specifies the intended container for the attachment, to enable automatic attachment deletion (on deletion of associated message, conversation or user). For now, only message is supported. See [Attachments for Messages](#section/Attachments-for-Messages) for details."
        },
        {
          "key": "conversationId",
          "value": "c616a583e4c240a871818541",
          "description": "Links the attachment getting uploaded to the conversation ID."
        }
      ]
    },
    "description": "Upload an attachment to Sunshine Conversations to use in future messages. Files are uploaded using the multipart/form-data content type. Use the returned mediaUrl to send a file, image or carousel message.\n<aside class=\"notice\">Note that Sunshine Conversations limits the size and type of file you can upload to the platform. See the <a href=\"https://docs.smooch.io/guide/validating-files\">file validation</a> guide for more details.</aside>\n"
  },
  "response": [
    {
      "id": "7fd2235e-ca63-4848-b2cd-9e12ac4c8d35",
      "name": "Bad request",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "source",
              "value": "amet officia cons",
              "description": {
                "content": "",
                "type": "text/plain"
              },
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/attachments?access=public&for=message&conversationId=c616a583e4c240a871818541",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "attachments"
          ],
          "query": [
            {
              "key": "access",
              "value": "public"
            },
            {
              "key": "for",
              "value": "message"
            },
            {
              "key": "conversationId",
              "value": "c616a583e4c240a871818541"
            }
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "id": "e96c5e0e-c349-4158-8835-ec9268391da7",
      "name": "Created",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "source",
              "value": "amet officia cons",
              "description": {
                "content": "",
                "type": "text/plain"
              },
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/attachments?access=public&for=message&conversationId=c616a583e4c240a871818541",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "attachments"
          ],
          "query": [
            {
              "key": "access",
              "value": "public"
            },
            {
              "key": "for",
              "value": "message"
            },
            {
              "key": "conversationId",
              "value": "c616a583e4c240a871818541"
            }
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"attachment\": {\n  \"mediaUrl\": \"http://smooch.io/rocks.smooch.media-dev/apps/5ec41c54fe13cc5ac404bedc/conversations/c616a583e4c240a871818541/TmYMVQUBNsQRItX4fKf4aC-T/Screen%20Shot%202020-09-02%20at%204.04.41%20PM.png\",\n  \"mediaType\": \"image/png\"\n }\n}"
    }
  ]
}