Perl / Support API / Getting Comments
Back to Collection Items
use 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(1);
$http->put_Login("login");
$http->put_Password("password");
$http->SetRequestHeader("Accept","application/json");
$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $http->QuickGetSb("https://example.zendesk.com/api/v2/requests/:request_id/comments/:ticket_comment_id",$sbResponseBody);
if ($success == 0) {
print $http->lastErrorText() . "\r\n";
exit;
}
$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);
print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";
$respStatusCode = $http->get_LastStatus();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
print "Response Header:" . "\r\n";
print $http->lastHeader() . "\r\n";
print "Failed." . "\r\n";
exit;
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "comment": {
# "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>"
# }
# ]
# }
# ],
# "audit_id": "<integer>",
# "author_id": "<integer>",
# "body": "<string>",
# "created_at": "<dateTime>",
# "html_body": "<string>",
# "id": "<integer>",
# "metadata": {
# "aliquipf9_": 29396975.17451787
# },
# "plain_body": "<string>",
# "public": "<boolean>",
# "type": "<string>",
# "uploads": [
# "<string>",
# "<string>"
# ],
# "via": {
# "channel": "<string>",
# "source": {
# "mollit8": -84219258
# }
# }
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$Audit_id = $jResp->stringOf("comment.audit_id");
$Author_id = $jResp->stringOf("comment.author_id");
$Body = $jResp->stringOf("comment.body");
$Created_at = $jResp->stringOf("comment.created_at");
$Html_body = $jResp->stringOf("comment.html_body");
$Id = $jResp->stringOf("comment.id");
$Aliquipf9_ = $jResp->stringOf("comment.metadata.aliquipf9_");
$Plain_body = $jResp->stringOf("comment.plain_body");
$v_Public = $jResp->stringOf("comment.public");
$v_Type = $jResp->stringOf("comment.type");
$Channel = $jResp->stringOf("comment.via.channel");
$Mollit8 = $jResp->IntOf("comment.via.source.mollit8");
$i = 0;
$count_i = $jResp->SizeOfArray("comment.attachments");
while ($i < $count_i) {
$jResp->put_I($i);
$content_type = $jResp->stringOf("comment.attachments[i].content_type");
$content_url = $jResp->stringOf("comment.attachments[i].content_url");
$deleted = $jResp->stringOf("comment.attachments[i].deleted");
$file_name = $jResp->stringOf("comment.attachments[i].file_name");
$height = $jResp->stringOf("comment.attachments[i].height");
$id = $jResp->stringOf("comment.attachments[i].id");
$inline = $jResp->stringOf("comment.attachments[i].inline");
$malware_access_override = $jResp->stringOf("comment.attachments[i].malware_access_override");
$malware_scan_result = $jResp->stringOf("comment.attachments[i].malware_scan_result");
$mapped_content_url = $jResp->stringOf("comment.attachments[i].mapped_content_url");
$size = $jResp->stringOf("comment.attachments[i].size");
$url = $jResp->stringOf("comment.attachments[i].url");
$width = $jResp->stringOf("comment.attachments[i].width");
$j = 0;
$count_j = $jResp->SizeOfArray("comment.attachments[i].thumbnails");
while ($j < $count_j) {
$jResp->put_J($j);
$content_type = $jResp->stringOf("comment.attachments[i].thumbnails[j].content_type");
$content_url = $jResp->stringOf("comment.attachments[i].thumbnails[j].content_url");
$deleted = $jResp->stringOf("comment.attachments[i].thumbnails[j].deleted");
$file_name = $jResp->stringOf("comment.attachments[i].thumbnails[j].file_name");
$height = $jResp->stringOf("comment.attachments[i].thumbnails[j].height");
$id = $jResp->stringOf("comment.attachments[i].thumbnails[j].id");
$inline = $jResp->stringOf("comment.attachments[i].thumbnails[j].inline");
$malware_access_override = $jResp->stringOf("comment.attachments[i].thumbnails[j].malware_access_override");
$malware_scan_result = $jResp->stringOf("comment.attachments[i].thumbnails[j].malware_scan_result");
$mapped_content_url = $jResp->stringOf("comment.attachments[i].thumbnails[j].mapped_content_url");
$size = $jResp->stringOf("comment.attachments[i].thumbnails[j].size");
$url = $jResp->stringOf("comment.attachments[i].thumbnails[j].url");
$width = $jResp->stringOf("comment.attachments[i].thumbnails[j].width");
$j = $j + 1;
}
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray("comment.uploads");
while ($i < $count_i) {
$jResp->put_I($i);
$strVal = $jResp->stringOf("comment.uploads[i]");
$i = $i + 1;
}
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/requests/:request_id/comments/:ticket_comment_id
Postman Collection Item JSON
{
"name": "Getting Comments",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/requests/:request_id/comments/:ticket_comment_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"requests",
":request_id",
"comments",
":ticket_comment_id"
],
"variable": [
{
"key": "request_id",
"value": "<integer>"
},
{
"key": "ticket_comment_id",
"value": "<integer>"
}
]
},
"description": "#### Allowed For\n\n* End Users\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/requests/:request_id/comments/:ticket_comment_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"requests",
":request_id",
"comments",
":ticket_comment_id"
],
"variable": [
{
"key": "request_id"
},
{
"key": "ticket_comment_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"comment\": {\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 \"audit_id\": \"<integer>\",\n \"author_id\": \"<integer>\",\n \"body\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"html_body\": \"<string>\",\n \"id\": \"<integer>\",\n \"metadata\": {\n \"aliquipf9_\": 29396975.17451787\n },\n \"plain_body\": \"<string>\",\n \"public\": \"<boolean>\",\n \"type\": \"<string>\",\n \"uploads\": [\n \"<string>\",\n \"<string>\"\n ],\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"mollit8\": -84219258\n }\n }\n }\n}"
}
]
}
