Chilkat Online Tools

Ruby / Support API / Recover Suspended Ticket

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

http.put_BasicAuth(true)
http.put_Login("login")
http.put_Password("password")

http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/suspended_tickets/:id/recover")
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

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

# {
#   "ticket": [
#     {
#       "attachments": [
#         {
#           "content_type": "<string>",
#           "content_url": "<string>",
#           "deleted": "<boolean>",
#           "file_name": "<string>",
#           "height": "<string>",
#           "id": "<integer>",
#           "inline": "<boolean>",
#           "malware_access_override": "<boolean>",
#           "malware_scan_result": "<string>",
#           "mapped_content_url": "<string>",
#           "size": "<integer>",
#           "url": "<string>",
#           "width": "<string>",
#           "thumbnails": [
#             {
#               "content_type": "<string>",
#               "content_url": "<string>",
#               "deleted": "<boolean>",
#               "file_name": "<string>",
#               "height": "<string>",
#               "id": "<integer>",
#               "inline": "<boolean>",
#               "malware_access_override": "<boolean>",
#               "malware_scan_result": "<string>",
#               "mapped_content_url": "<string>",
#               "size": "<integer>",
#               "url": "<string>",
#               "width": "<string>"
#             },
#             {
#               "content_type": "<string>",
#               "content_url": "<string>",
#               "deleted": "<boolean>",
#               "file_name": "<string>",
#               "height": "<string>",
#               "id": "<integer>",
#               "inline": "<boolean>",
#               "malware_access_override": "<boolean>",
#               "malware_scan_result": "<string>",
#               "mapped_content_url": "<string>",
#               "size": "<integer>",
#               "url": "<string>",
#               "width": "<string>"
#             }
#           ]
#         },
#         {
#           "content_type": "<string>",
#           "content_url": "<string>",
#           "deleted": "<boolean>",
#           "file_name": "<string>",
#           "height": "<string>",
#           "id": "<integer>",
#           "inline": "<boolean>",
#           "malware_access_override": "<boolean>",
#           "malware_scan_result": "<string>",
#           "mapped_content_url": "<string>",
#           "size": "<integer>",
#           "url": "<string>",
#           "width": "<string>",
#           "thumbnails": [
#             {
#               "content_type": "<string>",
#               "content_url": "<string>",
#               "deleted": "<boolean>",
#               "file_name": "<string>",
#               "height": "<string>",
#               "id": "<integer>",
#               "inline": "<boolean>",
#               "malware_access_override": "<boolean>",
#               "malware_scan_result": "<string>",
#               "mapped_content_url": "<string>",
#               "size": "<integer>",
#               "url": "<string>",
#               "width": "<string>"
#             },
#             {
#               "content_type": "<string>",
#               "content_url": "<string>",
#               "deleted": "<boolean>",
#               "file_name": "<string>",
#               "height": "<string>",
#               "id": "<integer>",
#               "inline": "<boolean>",
#               "malware_access_override": "<boolean>",
#               "malware_scan_result": "<string>",
#               "mapped_content_url": "<string>",
#               "size": "<integer>",
#               "url": "<string>",
#               "width": "<string>"
#             }
#           ]
#         }
#       ],
#       "author": {
#         "email": "<string>",
#         "id": "<integer>",
#         "name": "<string>"
#       },
#       "brand_id": "<integer>",
#       "cause": "<string>",
#       "cause_id": "<integer>",
#       "content": "<string>",
#       "created_at": "<dateTime>",
#       "id": "<integer>",
#       "message_id": "<string>",
#       "recipient": "<string>",
#       "subject": "<string>",
#       "ticket_id": "<integer>",
#       "updated_at": "<dateTime>",
#       "url": "<string>",
#       "via": {
#         "channel": "<string>",
#         "source": {
#           "from": {
#             "address": "<string>",
#             "id": "<integer>",
#             "name": "<string>",
#             "title": "<string>"
#           },
#           "rel": "<string>",
#           "to": {
#             "address": "<string>",
#             "name": "<string>"
#           }
#         }
#       }
#     },
#     {
#       "attachments": [
#         {
#           "content_type": "<string>",
#           "content_url": "<string>",
#           "deleted": "<boolean>",
#           "file_name": "<string>",
#           "height": "<string>",
#           "id": "<integer>",
#           "inline": "<boolean>",
#           "malware_access_override": "<boolean>",
#           "malware_scan_result": "<string>",
#           "mapped_content_url": "<string>",
#           "size": "<integer>",
#           "url": "<string>",
#           "width": "<string>",
#           "thumbnails": [
#             {
#               "content_type": "<string>",
#               "content_url": "<string>",
#               "deleted": "<boolean>",
#               "file_name": "<string>",
#               "height": "<string>",
#               "id": "<integer>",
#               "inline": "<boolean>",
#               "malware_access_override": "<boolean>",
#               "malware_scan_result": "<string>",
#               "mapped_content_url": "<string>",
#               "size": "<integer>",
#               "url": "<string>",
#               "width": "<string>"
#             },
#             {
#               "content_type": "<string>",
#               "content_url": "<string>",
#               "deleted": "<boolean>",
#               "file_name": "<string>",
#               "height": "<string>",
#               "id": "<integer>",
#               "inline": "<boolean>",
#               "malware_access_override": "<boolean>",
#               "malware_scan_result": "<string>",
#               "mapped_content_url": "<string>",
#               "size": "<integer>",
#               "url": "<string>",
#               "width": "<string>"
#             }
#           ]
#         },
#         {
#           "content_type": "<string>",
#           "content_url": "<string>",
#           "deleted": "<boolean>",
#           "file_name": "<string>",
#           "height": "<string>",
#           "id": "<integer>",
#           "inline": "<boolean>",
#           "malware_access_override": "<boolean>",
#           "malware_scan_result": "<string>",
#           "mapped_content_url": "<string>",
#           "size": "<integer>",
#           "url": "<string>",
#           "width": "<string>",
#           "thumbnails": [
#             {
#               "content_type": "<string>",
#               "content_url": "<string>",
#               "deleted": "<boolean>",
#               "file_name": "<string>",
#               "height": "<string>",
#               "id": "<integer>",
#               "inline": "<boolean>",
#               "malware_access_override": "<boolean>",
#               "malware_scan_result": "<string>",
#               "mapped_content_url": "<string>",
#               "size": "<integer>",
#               "url": "<string>",
#               "width": "<string>"
#             },
#             {
#               "content_type": "<string>",
#               "content_url": "<string>",
#               "deleted": "<boolean>",
#               "file_name": "<string>",
#               "height": "<string>",
#               "id": "<integer>",
#               "inline": "<boolean>",
#               "malware_access_override": "<boolean>",
#               "malware_scan_result": "<string>",
#               "mapped_content_url": "<string>",
#               "size": "<integer>",
#               "url": "<string>",
#               "width": "<string>"
#             }
#           ]
#         }
#       ],
#       "author": {
#         "email": "<string>",
#         "id": "<integer>",
#         "name": "<string>"
#       },
#       "brand_id": "<integer>",
#       "cause": "<string>",
#       "cause_id": "<integer>",
#       "content": "<string>",
#       "created_at": "<dateTime>",
#       "id": "<integer>",
#       "message_id": "<string>",
#       "recipient": "<string>",
#       "subject": "<string>",
#       "ticket_id": "<integer>",
#       "updated_at": "<dateTime>",
#       "url": "<string>",
#       "via": {
#         "channel": "<string>",
#         "source": {
#           "from": {
#             "address": "<string>",
#             "id": "<integer>",
#             "name": "<string>",
#             "title": "<string>"
#           },
#           "rel": "<string>",
#           "to": {
#             "address": "<string>",
#             "name": "<string>"
#           },
#           "cupidatat__c": false,
#           "officiad": -60680586
#         }
#       }
#     }
#   ]
# }

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

i = 0
count_i = jResp.SizeOfArray("ticket")
while i < count_i
    jResp.put_I(i)
    v_Email = jResp.stringOf("ticket[i].author.email")
    Id = jResp.stringOf("ticket[i].author.id")
    Name = jResp.stringOf("ticket[i].author.name")
    brand_id = jResp.stringOf("ticket[i].brand_id")
    cause = jResp.stringOf("ticket[i].cause")
    cause_id = jResp.stringOf("ticket[i].cause_id")
    content = jResp.stringOf("ticket[i].content")
    created_at = jResp.stringOf("ticket[i].created_at")
    id = jResp.stringOf("ticket[i].id")
    message_id = jResp.stringOf("ticket[i].message_id")
    recipient = jResp.stringOf("ticket[i].recipient")
    subject = jResp.stringOf("ticket[i].subject")
    ticket_id = jResp.stringOf("ticket[i].ticket_id")
    updated_at = jResp.stringOf("ticket[i].updated_at")
    url = jResp.stringOf("ticket[i].url")
    Channel = jResp.stringOf("ticket[i].via.channel")
    Address = jResp.stringOf("ticket[i].via.source.from.address")
    FromId = jResp.stringOf("ticket[i].via.source.from.id")
    FromName = jResp.stringOf("ticket[i].via.source.from.name")
    Title = jResp.stringOf("ticket[i].via.source.from.title")
    Rel = jResp.stringOf("ticket[i].via.source.rel")
    ToAddress = jResp.stringOf("ticket[i].via.source.to.address")
    ToName = jResp.stringOf("ticket[i].via.source.to.name")
    Cupidatat__c = jResp.BoolOf("ticket[i].via.source.cupidatat__c")
    Officiad = jResp.IntOf("ticket[i].via.source.officiad")
    j = 0
    count_j = jResp.SizeOfArray("ticket[i].attachments")
    while j < count_j
        jResp.put_J(j)
        content_type = jResp.stringOf("ticket[i].attachments[j].content_type")
        content_url = jResp.stringOf("ticket[i].attachments[j].content_url")
        deleted = jResp.stringOf("ticket[i].attachments[j].deleted")
        file_name = jResp.stringOf("ticket[i].attachments[j].file_name")
        height = jResp.stringOf("ticket[i].attachments[j].height")
        id = jResp.stringOf("ticket[i].attachments[j].id")
        inline = jResp.stringOf("ticket[i].attachments[j].inline")
        malware_access_override = jResp.stringOf("ticket[i].attachments[j].malware_access_override")
        malware_scan_result = jResp.stringOf("ticket[i].attachments[j].malware_scan_result")
        mapped_content_url = jResp.stringOf("ticket[i].attachments[j].mapped_content_url")
        size = jResp.stringOf("ticket[i].attachments[j].size")
        url = jResp.stringOf("ticket[i].attachments[j].url")
        width = jResp.stringOf("ticket[i].attachments[j].width")
        k = 0
        count_k = jResp.SizeOfArray("ticket[i].attachments[j].thumbnails")
        while k < count_k
            jResp.put_K(k)
            content_type = jResp.stringOf("ticket[i].attachments[j].thumbnails[k].content_type")
            content_url = jResp.stringOf("ticket[i].attachments[j].thumbnails[k].content_url")
            deleted = jResp.stringOf("ticket[i].attachments[j].thumbnails[k].deleted")
            file_name = jResp.stringOf("ticket[i].attachments[j].thumbnails[k].file_name")
            height = jResp.stringOf("ticket[i].attachments[j].thumbnails[k].height")
            id = jResp.stringOf("ticket[i].attachments[j].thumbnails[k].id")
            inline = jResp.stringOf("ticket[i].attachments[j].thumbnails[k].inline")
            malware_access_override = jResp.stringOf("ticket[i].attachments[j].thumbnails[k].malware_access_override")
            malware_scan_result = jResp.stringOf("ticket[i].attachments[j].thumbnails[k].malware_scan_result")
            mapped_content_url = jResp.stringOf("ticket[i].attachments[j].thumbnails[k].mapped_content_url")
            size = jResp.stringOf("ticket[i].attachments[j].thumbnails[k].size")
            url = jResp.stringOf("ticket[i].attachments[j].thumbnails[k].url")
            width = jResp.stringOf("ticket[i].attachments[j].thumbnails[k].width")
            k = k + 1
        end
        j = j + 1
    end
    i = i + 1
end

Curl Command

curl  -u login:password -X PUT
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/suspended_tickets/:id/recover

Postman Collection Item JSON

{
  "name": "Recover Suspended Ticket",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/suspended_tickets/:id/recover",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "suspended_tickets",
        ":id",
        "recover"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<number>"
        }
      ]
    },
    "description": "**Note**: During recovery, the API sets the requester to the authenticated agent who called the API, not the original requester. This prevents the ticket from being re-suspended after recovery. To preserve the original requester, use the [Recover Multiple Suspended Tickets](#recover-multiple-suspended-tickets) endpoint with the single ticket.\n\n#### Allowed For\n\n* Unrestricted agents\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/suspended_tickets/:id/recover",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "suspended_tickets",
            ":id",
            "recover"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"ticket\": [\n    {\n      \"attachments\": [\n        {\n          \"content_type\": \"<string>\",\n          \"content_url\": \"<string>\",\n          \"deleted\": \"<boolean>\",\n          \"file_name\": \"<string>\",\n          \"height\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"inline\": \"<boolean>\",\n          \"malware_access_override\": \"<boolean>\",\n          \"malware_scan_result\": \"<string>\",\n          \"mapped_content_url\": \"<string>\",\n          \"size\": \"<integer>\",\n          \"url\": \"<string>\",\n          \"width\": \"<string>\",\n          \"thumbnails\": [\n            {\n              \"content_type\": \"<string>\",\n              \"content_url\": \"<string>\",\n              \"deleted\": \"<boolean>\",\n              \"file_name\": \"<string>\",\n              \"height\": \"<string>\",\n              \"id\": \"<integer>\",\n              \"inline\": \"<boolean>\",\n              \"malware_access_override\": \"<boolean>\",\n              \"malware_scan_result\": \"<string>\",\n              \"mapped_content_url\": \"<string>\",\n              \"size\": \"<integer>\",\n              \"url\": \"<string>\",\n              \"width\": \"<string>\"\n            },\n            {\n              \"content_type\": \"<string>\",\n              \"content_url\": \"<string>\",\n              \"deleted\": \"<boolean>\",\n              \"file_name\": \"<string>\",\n              \"height\": \"<string>\",\n              \"id\": \"<integer>\",\n              \"inline\": \"<boolean>\",\n              \"malware_access_override\": \"<boolean>\",\n              \"malware_scan_result\": \"<string>\",\n              \"mapped_content_url\": \"<string>\",\n              \"size\": \"<integer>\",\n              \"url\": \"<string>\",\n              \"width\": \"<string>\"\n            }\n          ]\n        },\n        {\n          \"content_type\": \"<string>\",\n          \"content_url\": \"<string>\",\n          \"deleted\": \"<boolean>\",\n          \"file_name\": \"<string>\",\n          \"height\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"inline\": \"<boolean>\",\n          \"malware_access_override\": \"<boolean>\",\n          \"malware_scan_result\": \"<string>\",\n          \"mapped_content_url\": \"<string>\",\n          \"size\": \"<integer>\",\n          \"url\": \"<string>\",\n          \"width\": \"<string>\",\n          \"thumbnails\": [\n            {\n              \"content_type\": \"<string>\",\n              \"content_url\": \"<string>\",\n              \"deleted\": \"<boolean>\",\n              \"file_name\": \"<string>\",\n              \"height\": \"<string>\",\n              \"id\": \"<integer>\",\n              \"inline\": \"<boolean>\",\n              \"malware_access_override\": \"<boolean>\",\n              \"malware_scan_result\": \"<string>\",\n              \"mapped_content_url\": \"<string>\",\n              \"size\": \"<integer>\",\n              \"url\": \"<string>\",\n              \"width\": \"<string>\"\n            },\n            {\n              \"content_type\": \"<string>\",\n              \"content_url\": \"<string>\",\n              \"deleted\": \"<boolean>\",\n              \"file_name\": \"<string>\",\n              \"height\": \"<string>\",\n              \"id\": \"<integer>\",\n              \"inline\": \"<boolean>\",\n              \"malware_access_override\": \"<boolean>\",\n              \"malware_scan_result\": \"<string>\",\n              \"mapped_content_url\": \"<string>\",\n              \"size\": \"<integer>\",\n              \"url\": \"<string>\",\n              \"width\": \"<string>\"\n            }\n          ]\n        }\n      ],\n      \"author\": {\n        \"email\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"name\": \"<string>\"\n      },\n      \"brand_id\": \"<integer>\",\n      \"cause\": \"<string>\",\n      \"cause_id\": \"<integer>\",\n      \"content\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"message_id\": \"<string>\",\n      \"recipient\": \"<string>\",\n      \"subject\": \"<string>\",\n      \"ticket_id\": \"<integer>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\",\n      \"via\": {\n        \"channel\": \"<string>\",\n        \"source\": {\n          \"from\": {\n            \"address\": \"<string>\",\n            \"id\": \"<integer>\",\n            \"name\": \"<string>\",\n            \"title\": \"<string>\"\n          },\n          \"rel\": \"<string>\",\n          \"to\": {\n            \"address\": \"<string>\",\n            \"name\": \"<string>\"\n          }\n        }\n      }\n    },\n    {\n      \"attachments\": [\n        {\n          \"content_type\": \"<string>\",\n          \"content_url\": \"<string>\",\n          \"deleted\": \"<boolean>\",\n          \"file_name\": \"<string>\",\n          \"height\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"inline\": \"<boolean>\",\n          \"malware_access_override\": \"<boolean>\",\n          \"malware_scan_result\": \"<string>\",\n          \"mapped_content_url\": \"<string>\",\n          \"size\": \"<integer>\",\n          \"url\": \"<string>\",\n          \"width\": \"<string>\",\n          \"thumbnails\": [\n            {\n              \"content_type\": \"<string>\",\n              \"content_url\": \"<string>\",\n              \"deleted\": \"<boolean>\",\n              \"file_name\": \"<string>\",\n              \"height\": \"<string>\",\n              \"id\": \"<integer>\",\n              \"inline\": \"<boolean>\",\n              \"malware_access_override\": \"<boolean>\",\n              \"malware_scan_result\": \"<string>\",\n              \"mapped_content_url\": \"<string>\",\n              \"size\": \"<integer>\",\n              \"url\": \"<string>\",\n              \"width\": \"<string>\"\n            },\n            {\n              \"content_type\": \"<string>\",\n              \"content_url\": \"<string>\",\n              \"deleted\": \"<boolean>\",\n              \"file_name\": \"<string>\",\n              \"height\": \"<string>\",\n              \"id\": \"<integer>\",\n              \"inline\": \"<boolean>\",\n              \"malware_access_override\": \"<boolean>\",\n              \"malware_scan_result\": \"<string>\",\n              \"mapped_content_url\": \"<string>\",\n              \"size\": \"<integer>\",\n              \"url\": \"<string>\",\n              \"width\": \"<string>\"\n            }\n          ]\n        },\n        {\n          \"content_type\": \"<string>\",\n          \"content_url\": \"<string>\",\n          \"deleted\": \"<boolean>\",\n          \"file_name\": \"<string>\",\n          \"height\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"inline\": \"<boolean>\",\n          \"malware_access_override\": \"<boolean>\",\n          \"malware_scan_result\": \"<string>\",\n          \"mapped_content_url\": \"<string>\",\n          \"size\": \"<integer>\",\n          \"url\": \"<string>\",\n          \"width\": \"<string>\",\n          \"thumbnails\": [\n            {\n              \"content_type\": \"<string>\",\n              \"content_url\": \"<string>\",\n              \"deleted\": \"<boolean>\",\n              \"file_name\": \"<string>\",\n              \"height\": \"<string>\",\n              \"id\": \"<integer>\",\n              \"inline\": \"<boolean>\",\n              \"malware_access_override\": \"<boolean>\",\n              \"malware_scan_result\": \"<string>\",\n              \"mapped_content_url\": \"<string>\",\n              \"size\": \"<integer>\",\n              \"url\": \"<string>\",\n              \"width\": \"<string>\"\n            },\n            {\n              \"content_type\": \"<string>\",\n              \"content_url\": \"<string>\",\n              \"deleted\": \"<boolean>\",\n              \"file_name\": \"<string>\",\n              \"height\": \"<string>\",\n              \"id\": \"<integer>\",\n              \"inline\": \"<boolean>\",\n              \"malware_access_override\": \"<boolean>\",\n              \"malware_scan_result\": \"<string>\",\n              \"mapped_content_url\": \"<string>\",\n              \"size\": \"<integer>\",\n              \"url\": \"<string>\",\n              \"width\": \"<string>\"\n            }\n          ]\n        }\n      ],\n      \"author\": {\n        \"email\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"name\": \"<string>\"\n      },\n      \"brand_id\": \"<integer>\",\n      \"cause\": \"<string>\",\n      \"cause_id\": \"<integer>\",\n      \"content\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"message_id\": \"<string>\",\n      \"recipient\": \"<string>\",\n      \"subject\": \"<string>\",\n      \"ticket_id\": \"<integer>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\",\n      \"via\": {\n        \"channel\": \"<string>\",\n        \"source\": {\n          \"from\": {\n            \"address\": \"<string>\",\n            \"id\": \"<integer>\",\n            \"name\": \"<string>\",\n            \"title\": \"<string>\"\n          },\n          \"rel\": \"<string>\",\n          \"to\": {\n            \"address\": \"<string>\",\n            \"name\": \"<string>\"\n          },\n          \"cupidatat__c\": false,\n          \"officiad\": -60680586\n        }\n      }\n    }\n  ]\n}"
    }
  ]
}