Chilkat Online Tools

autoit / Sunshine Conversations API / Delete Attachment

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "username"
$oHttp.Password = "password"

; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

; The following JSON is sent in the request body.

; {
;   "mediaUrl": "https://s3.amazonaws.com/document.pdf"
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("mediaUrl","https://s3.amazonaws.com/document.pdf")

$oHttp.SetRequestHeader "Content-Type","application/json"

Local $oResp = $oHttp.PostJson3("https://domain.com/","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

Curl Command

curl -X POST
	-u 'username:password'
	-H "Content-Type: application/json"
	-d '{
    "mediaUrl": "https://s3.amazonaws.com/document.pdf"
}'
https://domain.com/

Postman Collection Item JSON

{
  "name": "Delete Attachment",
  "_postman_id": "46024506-b016-4206-b9fa-5208798d421f",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"mediaUrl\": \"https://s3.amazonaws.com/document.pdf\"\n}"
    },
    "url": "{{url}}/v2/apps/{{appId}}/attachments/remove",
    "description": "Remove an attachment uploaded to Sunshine Conversations through the Upload attachment API.\nSee [Attachments for Messages](#section/Attachments-for-Messages) to have attachments automatically deleted when deleting messages, conversations or users.\n<aside class=\"notice\">Note that deleted attachments can remain available on our CDN’s cache up to 15 minutes after the delete call.</aside>\n"
  },
  "response": [
    {
      "id": "550832e9-182a-450a-a633-2f219789933c",
      "name": "Ok",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"mediaUrl\": \"https://s3.amazonaws.com/document.pdf\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/attachments/remove",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "attachments",
            "remove"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{}"
    },
    {
      "id": "e22cc0b8-099b-4a31-a7b2-f4fbc970b05d",
      "name": "Attachment not found",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"mediaUrl\": \"https://s3.amazonaws.com/document.pdf\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/attachments/remove",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "attachments",
            "remove"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}