Unicode C++ / Support API / List Comments
Back to Collection Items
void ChilkatSample(void)
{
http.put_BasicAuth(true); http.put_Login(L"login"); http.put_Password(L"password"); queryParams.UpdateString(L"include_inline_images",L"<boolean>"); queryParams.UpdateString(L"include",L"<string>"); resp->GetBodySb(sbResponseBody); jResp.LoadSb(sbResponseBody); jResp.put_EmitCompact(false); jResp.put_I(i); audit_id = jResp.stringOf(L"comments[i].audit_id"); author_id = jResp.stringOf(L"comments[i].author_id"); body = jResp.stringOf(L"comments[i].body"); created_at = jResp.stringOf(L"comments[i].created_at"); html_body = jResp.stringOf(L"comments[i].html_body"); id = jResp.stringOf(L"comments[i].id"); Cillum_7ae = jResp.stringOf(L"comments[i].metadata.cillum_7ae"); Sunt2 = jResp.stringOf(L"comments[i].metadata.sunt2"); Laboris__ = jResp.BoolOf(L"comments[i].metadata.laboris__"); plain_body = jResp.stringOf(L"comments[i].plain_body"); v_public = jResp.stringOf(L"comments[i].public"); v_type = jResp.stringOf(L"comments[i].type"); Channel = jResp.stringOf(L"comments[i].via.channel"); Incididunt03e = jResp.BoolOf(L"comments[i].via.source.incididunt03e"); Eiusmod_4 = jResp.IntOf(L"comments[i].via.source.eiusmod_4"); Esse7 = jResp.IntOf(L"comments[i].via.source.esse7"); Nisi04 = jResp.BoolOf(L"comments[i].metadata.nisi04"); Amet__ = jResp.IntOf(L"comments[i].via.source.amet__"); j = 0; count_j = jResp.SizeOfArray(L"comments[i].attachments"); jResp.put_J(j); content_type = jResp.stringOf(L"comments[i].attachments[j].content_type"); content_url = jResp.stringOf(L"comments[i].attachments[j].content_url"); deleted = jResp.stringOf(L"comments[i].attachments[j].deleted"); file_name = jResp.stringOf(L"comments[i].attachments[j].file_name"); height = jResp.stringOf(L"comments[i].attachments[j].height"); id = jResp.stringOf(L"comments[i].attachments[j].id"); inline = jResp.stringOf(L"comments[i].attachments[j].inline"); malware_access_override = jResp.stringOf(L"comments[i].attachments[j].malware_access_override"); malware_scan_result = jResp.stringOf(L"comments[i].attachments[j].malware_scan_result"); mapped_content_url = jResp.stringOf(L"comments[i].attachments[j].mapped_content_url"); size = jResp.stringOf(L"comments[i].attachments[j].size"); url = jResp.stringOf(L"comments[i].attachments[j].url"); width = jResp.stringOf(L"comments[i].attachments[j].width"); k = 0; count_k = jResp.SizeOfArray(L"comments[i].attachments[j].thumbnails"); jResp.put_K(k); content_type = jResp.stringOf(L"comments[i].attachments[j].thumbnails[k].content_type"); content_url = jResp.stringOf(L"comments[i].attachments[j].thumbnails[k].content_url"); deleted = jResp.stringOf(L"comments[i].attachments[j].thumbnails[k].deleted"); file_name = jResp.stringOf(L"comments[i].attachments[j].thumbnails[k].file_name"); height = jResp.stringOf(L"comments[i].attachments[j].thumbnails[k].height"); id = jResp.stringOf(L"comments[i].attachments[j].thumbnails[k].id"); inline = jResp.stringOf(L"comments[i].attachments[j].thumbnails[k].inline"); malware_access_override = jResp.stringOf(L"comments[i].attachments[j].thumbnails[k].malware_access_override"); malware_scan_result = jResp.stringOf(L"comments[i].attachments[j].thumbnails[k].malware_scan_result"); mapped_content_url = jResp.stringOf(L"comments[i].attachments[j].thumbnails[k].mapped_content_url"); size = jResp.stringOf(L"comments[i].attachments[j].thumbnails[k].size"); url = jResp.stringOf(L"comments[i].attachments[j].thumbnails[k].url"); width = jResp.stringOf(L"comments[i].attachments[j].thumbnails[k].width"); k = k + 1; j = j + 1; j = 0; count_j = jResp.SizeOfArray(L"comments[i].uploads"); jResp.put_J(j); strVal = jResp.stringOf(L"comments[i].uploads[j]"); j = j + 1; i = i + 1;
}
Curl Command
curl -u login:password -G -d "include_inline_images=%3Cboolean%3E"
-d "include=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/tickets/:ticket_id/comments
Postman Collection Item JSON
{
"name": "List Comments",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/comments?include_inline_images=<boolean>&include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets",
":ticket_id",
"comments"
],
"query": [
{
"key": "include_inline_images",
"value": "<boolean>",
"description": "Default is false. When true, inline images are also listed as attachments in the response"
},
{
"key": "include",
"value": "<string>",
"description": "Accepts \"users\". Use this parameter to list email CCs by side-loading users. Example: `?include=users`. **Note**: If the comment source is email, a deleted user will be represented as the CCd email address. If the comment source is anything else, a deleted user will be represented as the user name."
}
],
"variable": [
{
"key": "ticket_id",
"value": "<integer>"
}
]
},
"description": "Returns the comments added to the ticket.\n\nEach comment may include a `content_url` for an attachment or a `recording_url` for a voice comment that points to a file that may be hosted externally. For security reasons, take care not to inadvertently send Zendesk authentication credentials to third parties when attempting to access these files. See [Working with url properties](/documentation/ticketing/managing-tickets/working-with-url-properties).\n\n#### Pagination\n\n- Cursor pagination (recommended)\n- Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n#### Sorting\n\nBy default, comments are sorted by creation date in ascending order.\n\nWhen using cursor pagination, use the following parameter to change the sort order:\n\n| Name | Type | Required | Comments\n| ------ | ------ | -------- | --------\n| `sort` | string | no | Possible values are \"created_at\" (ascending order) or \"-created_at\" (descending order)\n\nWhen using offset pagination, use the following parameters to change the sort order:\n\n| Name | Type | Required | Comments\n| ------------ | ------ | -------- | --------\n| `sort_order` | string | no | One of `asc`, `desc`. Defaults to `asc`\n\n#### Allowed For\n\n* Agents\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/tickets/:ticket_id/comments?include_inline_images=<boolean>&include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets",
":ticket_id",
"comments"
],
"query": [
{
"key": "include_inline_images",
"value": "<boolean>",
"description": "Default is false. When true, inline images are also listed as attachments in the response"
},
{
"key": "include",
"value": "<string>",
"description": "Accepts \"users\". Use this parameter to list email CCs by side-loading users. Example: `?include=users`. **Note**: If the comment source is email, a deleted user will be represented as the CCd email address. If the comment source is anything else, a deleted user will be represented as the user name."
}
],
"variable": [
{
"key": "ticket_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"comments\": [\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 \"audit_id\": \"<integer>\",\n \"author_id\": \"<integer>\",\n \"body\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"html_body\": \"<string>\",\n \"id\": \"<integer>\",\n \"metadata\": {\n \"cillum_7ae\": \"laboris nulla fugiat\",\n \"sunt2\": 25522168.26328881,\n \"laboris__\": true\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 \"incididunt03e\": false,\n \"eiusmod_4\": -36679297,\n \"esse7\": 87176441\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 \"audit_id\": \"<integer>\",\n \"author_id\": \"<integer>\",\n \"body\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"html_body\": \"<string>\",\n \"id\": \"<integer>\",\n \"metadata\": {\n \"nisi04\": false\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 \"amet__\": 87553399\n }\n }\n }\n ]\n}"
}
]
}
