phpAx / Support API / Redact Chat Comment
Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
$http->BasicAuth = 1;
$http->Login = 'login';
$http->Password = 'password';
$http->SetRequestHeader('Accept','application/json');
// resp is a Chilkat.HttpResponse
$resp = $http->QuickRequest('PUT','https://example.zendesk.com/api/v2/chat_redactions/:ticket_id');
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "chat_event": {
// "id": "<integer>",
// "type": "<string>",
// "value": {
// "chat_id": "<string>",
// "history": [
// {
// "sunt_4": false,
// "laborum4": false,
// "tempor_2": true
// },
// {
// "laboris__b0": 51519808,
// "esse_6": "labore elit",
// "veniam_1": 65652007,
// "in_0b": 13721436,
// "exercitation164": 83149154.88991535
// }
// ],
// "visitor_id": "<string>"
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$Id = $jResp->stringOf('chat_event.id');
$v_Type = $jResp->stringOf('chat_event.type');
$Chat_id = $jResp->stringOf('chat_event.value.chat_id');
$Visitor_id = $jResp->stringOf('chat_event.value.visitor_id');
$i = 0;
$count_i = $jResp->SizeOfArray('chat_event.value.history');
while ($i < $count_i) {
$jResp->I = $i;
$sunt_4 = $jResp->BoolOf('chat_event.value.history[i].sunt_4');
$laborum4 = $jResp->BoolOf('chat_event.value.history[i].laborum4');
$tempor_2 = $jResp->BoolOf('chat_event.value.history[i].tempor_2');
$laboris__b0 = $jResp->IntOf('chat_event.value.history[i].laboris__b0');
$esse_6 = $jResp->stringOf('chat_event.value.history[i].esse_6');
$veniam_1 = $jResp->IntOf('chat_event.value.history[i].veniam_1');
$in_0b = $jResp->IntOf('chat_event.value.history[i].in_0b');
$exercitation164 = $jResp->stringOf('chat_event.value.history[i].exercitation164');
$i = $i + 1;
}
?>
Curl Command
curl -u login:password -X PUT
-H "Accept: application/json"
https://example.zendesk.com/api/v2/chat_redactions/:ticket_id
Postman Collection Item JSON
{
"name": "Redact Chat Comment",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/chat_redactions/:ticket_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"chat_redactions",
":ticket_id"
],
"variable": [
{
"key": "ticket_id",
"value": "<integer>"
}
]
},
"description": "Permanently removes words or strings from a chat ticket's comment. \n\nWrap `<redact>` tags around the content in the chat comment you want redacted. Example: \n\n```json\n{\n \"text\": \"My ID number is <redact>847564</redact>!\"\n}\n```\n\nThe characters contained in the tag will be replaced by the ▇ symbol.\n\n**Note**: This does not work on active chats. For chat tickets that predate March 2020, consider using [Redact Ticket Comment In Agent Workspace](#redact-ticket-comment-in-agent-workspace).\n\n#### Allowed For\n\n- Agents\n\n[Agent Workspace](https://support.zendesk.com/hc/en-us/articles/360024218473) must enabled for the account. Deleting tickets must be enabled for agents.\n\n#### Request Body Properties\n\n| Name | Type | Required | Description |\n| ------------------------ | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| chat_id | string | true | The `chat_id` in the `ChatStartedEvent` event in the ticket audit. See [Ticket Audits](/api-reference/ticketing/tickets/ticket_audits) |\n| chat_index | integer | true | The `chat_index` in the `ChatMessage` event in the ticket audit. See [Ticket Audits](/api-reference/ticketing/tickets/ticket_audits) |\n| text | string | true | The `message` in the `ChatMessage` event in the ticket audit. See [Ticket Audits](/api-reference/ticketing/tickets/ticket_audits). Wrap `message` with `<redact>` tags |\n\nTo get the required body properties, make a request to the [Ticket Audit](/api-reference/ticketing/tickets/ticket_audits) endpoint. Example response:\n\n```http\nStatus 200 OK\n{\n \"audits\": [\n \"events\": [\n {\n \"id\": 1932802680168,\n \"type\": \"ChatStartedEvent\",\n \"value\": {\n \"visitor_id\": \"10502823-16EkM3T6VNq7KMd\",\n \"chat_id\": \"2109.10502823.Sjuj2YrBpXwei\",\n \"history\": [\n {\n \"chat_index\": 0,\n \"type\": \"ChatMessage\",\n \"message\": \"My ID number is 847564!\"\n }\n ]\n }\n }\n ]\n ]\n}\n```\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/chat_redactions/:ticket_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"chat_redactions",
":ticket_id"
],
"variable": [
{
"key": "ticket_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"chat_event\": {\n \"id\": \"<integer>\",\n \"type\": \"<string>\",\n \"value\": {\n \"chat_id\": \"<string>\",\n \"history\": [\n {\n \"sunt_4\": false,\n \"laborum4\": false,\n \"tempor_2\": true\n },\n {\n \"laboris__b0\": 51519808,\n \"esse_6\": \"labore elit\",\n \"veniam_1\": 65652007,\n \"in_0b\": 13721436,\n \"exercitation164\": 83149154.88991535\n }\n ],\n \"visitor_id\": \"<string>\"\n }\n }\n}"
}
]
}
