C / Support API / Create Ticket or Voicemail Ticket
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject json;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *email;
const char *name;
const char *Requester_id;
const char *Allow_attachments;
const char *Allow_channelback;
const char *Assignee_email;
const char *Assignee_id;
const char *Attribute_value_ids;
const char *Brand_id;
const char *Collaborator_ids;
const char *Created_at;
const char *Custom_fields;
const char *Custom_status_id;
const char *Description;
const char *Due_at;
const char *Email_cc_ids;
const char *External_id;
const char *Follower_ids;
const char *Followup_ids;
const char *Forum_topic_id;
const char *From_messaging_channel;
const char *Group_id;
const char *Has_incidents;
const char *Id;
const char *Is_public;
const char *Macro_id;
const char *Macro_ids;
const char *Organization_id;
const char *Priority;
const char *Problem_id;
const char *Raw_subject;
const char *Recipient;
const char *Safe_update;
const char *In_11;
const char *Sharing_agreement_ids;
const char *Status;
const char *Subject;
const char *Submitter_id;
const char *Tags;
const char *Ticket_form_id;
const char *v_Type;
const char *Updated_at;
const char *Updated_stamp;
const char *v_Url;
const char *Channel;
const char *Ut__a;
int Dolored2b;
BOOL Mollit1a6;
const char *Via_followup_source_id;
const char *Via_id;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
CkHttp_putBasicAuth(http,TRUE);
CkHttp_putLogin(http,"login");
CkHttp_putPassword(http,"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.
// {
// "display_to_agent": "<integer>",
// "ticket": {
// "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": {
// "sed_f": -35238092,
// "amet_d89": "sint"
// },
// "plain_body": "<string>",
// "public": "<boolean>",
// "type": "<string>",
// "uploads": [
// "<string>",
// "<string>"
// ],
// "via": {
// "channel": "<string>",
// "source": {
// "culpa_b8_": false,
// "exercitation87": "in incididunt commodo"
// }
// }
// },
// "priority": "urgent",
// "via_id": 46,
// "voice_comment": {
// "answered_by_id": "<integer>",
// "call_duration": "<integer>",
// "from": "<string>",
// "location": "<string>",
// "recording_url": "<string>",
// "started_at": "<dateTime>",
// "to": "<string>",
// "transcription_text": "<string>"
// }
// }
// }
json = CkJsonObject_Create();
CkJsonObject_UpdateString(json,"display_to_agent","<integer>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].content_type","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].content_url","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].deleted","<boolean>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].file_name","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].height","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].id","<integer>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].inline","<boolean>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].malware_access_override","<boolean>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].malware_scan_result","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].mapped_content_url","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].size","<integer>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].url","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].width","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[0].content_type","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[0].content_url","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[0].deleted","<boolean>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[0].file_name","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[0].height","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[0].id","<integer>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[0].inline","<boolean>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[0].malware_access_override","<boolean>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[0].malware_scan_result","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[0].mapped_content_url","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[0].size","<integer>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[0].url","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[0].width","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[1].content_type","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[1].content_url","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[1].deleted","<boolean>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[1].file_name","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[1].height","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[1].id","<integer>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[1].inline","<boolean>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[1].malware_access_override","<boolean>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[1].malware_scan_result","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[1].mapped_content_url","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[1].size","<integer>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[1].url","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[0].thumbnails[1].width","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].content_type","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].content_url","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].deleted","<boolean>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].file_name","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].height","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].id","<integer>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].inline","<boolean>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].malware_access_override","<boolean>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].malware_scan_result","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].mapped_content_url","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].size","<integer>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].url","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].width","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[0].content_type","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[0].content_url","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[0].deleted","<boolean>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[0].file_name","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[0].height","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[0].id","<integer>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[0].inline","<boolean>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[0].malware_access_override","<boolean>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[0].malware_scan_result","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[0].mapped_content_url","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[0].size","<integer>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[0].url","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[0].width","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[1].content_type","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[1].content_url","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[1].deleted","<boolean>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[1].file_name","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[1].height","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[1].id","<integer>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[1].inline","<boolean>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[1].malware_access_override","<boolean>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[1].malware_scan_result","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[1].mapped_content_url","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[1].size","<integer>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[1].url","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.attachments[1].thumbnails[1].width","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.audit_id","<integer>");
CkJsonObject_UpdateString(json,"ticket.comment.author_id","<integer>");
CkJsonObject_UpdateString(json,"ticket.comment.body","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.created_at","<dateTime>");
CkJsonObject_UpdateString(json,"ticket.comment.html_body","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.id","<integer>");
CkJsonObject_UpdateInt(json,"ticket.comment.metadata.sed_f",-35238092);
CkJsonObject_UpdateString(json,"ticket.comment.metadata.amet_d89","sint");
CkJsonObject_UpdateString(json,"ticket.comment.plain_body","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.public","<boolean>");
CkJsonObject_UpdateString(json,"ticket.comment.type","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.uploads[0]","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.uploads[1]","<string>");
CkJsonObject_UpdateString(json,"ticket.comment.via.channel","<string>");
CkJsonObject_UpdateBool(json,"ticket.comment.via.source.culpa_b8_",FALSE);
CkJsonObject_UpdateString(json,"ticket.comment.via.source.exercitation87","in incididunt commodo");
CkJsonObject_UpdateString(json,"ticket.priority","urgent");
CkJsonObject_UpdateInt(json,"ticket.via_id",46);
CkJsonObject_UpdateString(json,"ticket.voice_comment.answered_by_id","<integer>");
CkJsonObject_UpdateString(json,"ticket.voice_comment.call_duration","<integer>");
CkJsonObject_UpdateString(json,"ticket.voice_comment.from","<string>");
CkJsonObject_UpdateString(json,"ticket.voice_comment.location","<string>");
CkJsonObject_UpdateString(json,"ticket.voice_comment.recording_url","<string>");
CkJsonObject_UpdateString(json,"ticket.voice_comment.started_at","<dateTime>");
CkJsonObject_UpdateString(json,"ticket.voice_comment.to","<string>");
CkJsonObject_UpdateString(json,"ticket.voice_comment.transcription_text","<string>");
CkHttp_SetRequestHeader(http,"Content-Type","application/json");
CkHttp_SetRequestHeader(http,"Accept","application/json");
resp = CkHttp_PostJson3(http,"https://example.zendesk.com/api/v2/channels/voice/tickets","application/json",json);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "ticket": {
// "requester_id": "<integer>",
// "allow_attachments": "<boolean>",
// "allow_channelback": "<boolean>",
// "assignee_email": "<string>",
// "assignee_id": "<integer>",
// "attribute_value_ids": "<array>",
// "brand_id": "<integer>",
// "collaborator_ids": "<array>",
// "collaborators": [
// {
// "email": "<email>",
// "name": "<string>"
// },
// {
// "email": "<email>",
// "name": "<string>"
// }
// ],
// "comment": {},
// "created_at": "<dateTime>",
// "custom_fields": "<array>",
// "custom_status_id": "<integer>",
// "description": "<string>",
// "due_at": "<dateTime>",
// "email_cc_ids": "<array>",
// "email_ccs": {},
// "external_id": "<string>",
// "follower_ids": "<array>",
// "followers": {},
// "followup_ids": "<array>",
// "forum_topic_id": "<integer>",
// "from_messaging_channel": "<boolean>",
// "group_id": "<integer>",
// "has_incidents": "<boolean>",
// "id": "<integer>",
// "is_public": "<boolean>",
// "macro_id": "<integer>",
// "macro_ids": "<array>",
// "metadata": {},
// "organization_id": "<integer>",
// "priority": "normal",
// "problem_id": "<integer>",
// "raw_subject": "<string>",
// "recipient": "<string>",
// "requester": {},
// "safe_update": "<boolean>",
// "satisfaction_rating": {
// "in_11": -9796534.714120895
// },
// "sharing_agreement_ids": "<array>",
// "status": "hold",
// "subject": "<string>",
// "submitter_id": "<integer>",
// "tags": "<array>",
// "ticket_form_id": "<integer>",
// "type": "question",
// "updated_at": "<dateTime>",
// "updated_stamp": "<string>",
// "url": "<string>",
// "via": {
// "channel": "<string>",
// "source": {
// "Ut__a": -44750185.46031158,
// "dolored2b": 8252599,
// "mollit1a6": true
// }
// },
// "via_followup_source_id": "<integer>",
// "via_id": "<integer>",
// "voice_comment": {}
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
Requester_id = CkJsonObject_stringOf(jResp,"ticket.requester_id");
Allow_attachments = CkJsonObject_stringOf(jResp,"ticket.allow_attachments");
Allow_channelback = CkJsonObject_stringOf(jResp,"ticket.allow_channelback");
Assignee_email = CkJsonObject_stringOf(jResp,"ticket.assignee_email");
Assignee_id = CkJsonObject_stringOf(jResp,"ticket.assignee_id");
Attribute_value_ids = CkJsonObject_stringOf(jResp,"ticket.attribute_value_ids");
Brand_id = CkJsonObject_stringOf(jResp,"ticket.brand_id");
Collaborator_ids = CkJsonObject_stringOf(jResp,"ticket.collaborator_ids");
Created_at = CkJsonObject_stringOf(jResp,"ticket.created_at");
Custom_fields = CkJsonObject_stringOf(jResp,"ticket.custom_fields");
Custom_status_id = CkJsonObject_stringOf(jResp,"ticket.custom_status_id");
Description = CkJsonObject_stringOf(jResp,"ticket.description");
Due_at = CkJsonObject_stringOf(jResp,"ticket.due_at");
Email_cc_ids = CkJsonObject_stringOf(jResp,"ticket.email_cc_ids");
External_id = CkJsonObject_stringOf(jResp,"ticket.external_id");
Follower_ids = CkJsonObject_stringOf(jResp,"ticket.follower_ids");
Followup_ids = CkJsonObject_stringOf(jResp,"ticket.followup_ids");
Forum_topic_id = CkJsonObject_stringOf(jResp,"ticket.forum_topic_id");
From_messaging_channel = CkJsonObject_stringOf(jResp,"ticket.from_messaging_channel");
Group_id = CkJsonObject_stringOf(jResp,"ticket.group_id");
Has_incidents = CkJsonObject_stringOf(jResp,"ticket.has_incidents");
Id = CkJsonObject_stringOf(jResp,"ticket.id");
Is_public = CkJsonObject_stringOf(jResp,"ticket.is_public");
Macro_id = CkJsonObject_stringOf(jResp,"ticket.macro_id");
Macro_ids = CkJsonObject_stringOf(jResp,"ticket.macro_ids");
Organization_id = CkJsonObject_stringOf(jResp,"ticket.organization_id");
Priority = CkJsonObject_stringOf(jResp,"ticket.priority");
Problem_id = CkJsonObject_stringOf(jResp,"ticket.problem_id");
Raw_subject = CkJsonObject_stringOf(jResp,"ticket.raw_subject");
Recipient = CkJsonObject_stringOf(jResp,"ticket.recipient");
Safe_update = CkJsonObject_stringOf(jResp,"ticket.safe_update");
In_11 = CkJsonObject_stringOf(jResp,"ticket.satisfaction_rating.in_11");
Sharing_agreement_ids = CkJsonObject_stringOf(jResp,"ticket.sharing_agreement_ids");
Status = CkJsonObject_stringOf(jResp,"ticket.status");
Subject = CkJsonObject_stringOf(jResp,"ticket.subject");
Submitter_id = CkJsonObject_stringOf(jResp,"ticket.submitter_id");
Tags = CkJsonObject_stringOf(jResp,"ticket.tags");
Ticket_form_id = CkJsonObject_stringOf(jResp,"ticket.ticket_form_id");
v_Type = CkJsonObject_stringOf(jResp,"ticket.type");
Updated_at = CkJsonObject_stringOf(jResp,"ticket.updated_at");
Updated_stamp = CkJsonObject_stringOf(jResp,"ticket.updated_stamp");
v_Url = CkJsonObject_stringOf(jResp,"ticket.url");
Channel = CkJsonObject_stringOf(jResp,"ticket.via.channel");
Ut__a = CkJsonObject_stringOf(jResp,"ticket.via.source.Ut__a");
Dolored2b = CkJsonObject_IntOf(jResp,"ticket.via.source.dolored2b");
Mollit1a6 = CkJsonObject_BoolOf(jResp,"ticket.via.source.mollit1a6");
Via_followup_source_id = CkJsonObject_stringOf(jResp,"ticket.via_followup_source_id");
Via_id = CkJsonObject_stringOf(jResp,"ticket.via_id");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"ticket.collaborators");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
email = CkJsonObject_stringOf(jResp,"ticket.collaborators[i].email");
name = CkJsonObject_stringOf(jResp,"ticket.collaborators[i].name");
i = i + 1;
}
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -u login:password -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"display_to_agent": "<integer>",
"ticket": {
"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": {
"sed_f": -35238092,
"amet_d89": "sint"
},
"plain_body": "<string>",
"public": "<boolean>",
"type": "<string>",
"uploads": [
"<string>",
"<string>"
],
"via": {
"channel": "<string>",
"source": {
"culpa_b8_": false,
"exercitation87": "in incididunt commodo"
}
}
},
"priority": "urgent",
"via_id": 46,
"voice_comment": {
"answered_by_id": "<integer>",
"call_duration": "<integer>",
"from": "<string>",
"location": "<string>",
"recording_url": "<string>",
"started_at": "<dateTime>",
"to": "<string>",
"transcription_text": "<string>"
}
}
}'
https://example.zendesk.com/api/v2/channels/voice/tickets
Postman Collection Item JSON
{
"name": "Create Ticket or Voicemail Ticket",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"display_to_agent\": \"<integer>\",\n \"ticket\": {\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 \"sed_f\": -35238092,\n \"amet_d89\": \"sint\"\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 \"culpa_b8_\": false,\n \"exercitation87\": \"in incididunt commodo\"\n }\n }\n },\n \"priority\": \"urgent\",\n \"via_id\": 46,\n \"voice_comment\": {\n \"answered_by_id\": \"<integer>\",\n \"call_duration\": \"<integer>\",\n \"from\": \"<string>\",\n \"location\": \"<string>\",\n \"recording_url\": \"<string>\",\n \"started_at\": \"<dateTime>\",\n \"to\": \"<string>\",\n \"transcription_text\": \"<string>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/channels/voice/tickets",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"channels",
"voice",
"tickets"
],
"variable": [
{
"key": "agent_id",
"value": "<integer>",
"description": "(Required) ID of an agent"
},
{
"key": "ticket_id",
"value": "<integer>",
"description": "(Required) The ID of the ticket"
}
]
},
"description": "#### Allowed For\n* Agents\n\n### Creating tickets\n\n#### Introduction\n\nCreating tickets using Talk Partner Edition follows the same conventions as the Create Ticket endpoint. See [Create Ticket](/api-reference/ticketing/tickets/tickets/#create-ticket).\n\n#### Request parameters\n\nThe POST request takes a mandatory `ticket` object that lists the values to set when the ticket is created.\nYou may also include an optional `display_to_agent` value such as the ID of the agent that will see the newly created ticket.\n\nTickets created using this endpoint must have a `via_id` parameter. See the following\nsection for possible values.\n\n#### Zendesk Talk Integration Via IDs\n\nTickets created using this endpoint must have one of the following `via_id` parameters:\n\n| ID | Description\n| ---------| -------------\n| 44 | Voicemail\n| 45 | Phone call (inbound)\n| 46 | Phone call (outbound)\n\n### Creating voicemail tickets\n#### Request parameters\n\nThe POST request takes a mandatory `ticket` object that lists the values to set when the ticket is created.\nThe ticket must have a `voice_comment` with the following values:\n\n| Name | Type | Comment\n| ------------------ | ----------------------| -------\n| from | string | Incoming phone number\n| to | string | Dialed phone number\n| recording_url | string | URL of the recording\n| started_at | date | [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) timestamp of the call starting time\n| call_duration | integer | Duration in seconds of the call\n| answered_by_id | integer | The agent who answered the call\n| transcription_text | string | Transcription of the call (optional)\n| location | string | Location of the caller (optional)"
},
"response": [
{
"name": "Successful response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"display_to_agent\": \"<integer>\",\n \"ticket\": {\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 \"sed_f\": -35238092,\n \"amet_d89\": \"sint\"\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 \"culpa_b8_\": false,\n \"exercitation87\": \"in incididunt commodo\"\n }\n }\n },\n \"priority\": \"urgent\",\n \"via_id\": 46,\n \"voice_comment\": {\n \"answered_by_id\": \"<integer>\",\n \"call_duration\": \"<integer>\",\n \"from\": \"<string>\",\n \"location\": \"<string>\",\n \"recording_url\": \"<string>\",\n \"started_at\": \"<dateTime>\",\n \"to\": \"<string>\",\n \"transcription_text\": \"<string>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/channels/voice/tickets",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"channels",
"voice",
"tickets"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"ticket\": {\n \"requester_id\": \"<integer>\",\n \"allow_attachments\": \"<boolean>\",\n \"allow_channelback\": \"<boolean>\",\n \"assignee_email\": \"<string>\",\n \"assignee_id\": \"<integer>\",\n \"attribute_value_ids\": \"<array>\",\n \"brand_id\": \"<integer>\",\n \"collaborator_ids\": \"<array>\",\n \"collaborators\": [\n {\n \"email\": \"<email>\",\n \"name\": \"<string>\"\n },\n {\n \"email\": \"<email>\",\n \"name\": \"<string>\"\n }\n ],\n \"comment\": {},\n \"created_at\": \"<dateTime>\",\n \"custom_fields\": \"<array>\",\n \"custom_status_id\": \"<integer>\",\n \"description\": \"<string>\",\n \"due_at\": \"<dateTime>\",\n \"email_cc_ids\": \"<array>\",\n \"email_ccs\": {},\n \"external_id\": \"<string>\",\n \"follower_ids\": \"<array>\",\n \"followers\": {},\n \"followup_ids\": \"<array>\",\n \"forum_topic_id\": \"<integer>\",\n \"from_messaging_channel\": \"<boolean>\",\n \"group_id\": \"<integer>\",\n \"has_incidents\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"is_public\": \"<boolean>\",\n \"macro_id\": \"<integer>\",\n \"macro_ids\": \"<array>\",\n \"metadata\": {},\n \"organization_id\": \"<integer>\",\n \"priority\": \"normal\",\n \"problem_id\": \"<integer>\",\n \"raw_subject\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester\": {},\n \"safe_update\": \"<boolean>\",\n \"satisfaction_rating\": {\n \"in_11\": -9796534.714120895\n },\n \"sharing_agreement_ids\": \"<array>\",\n \"status\": \"hold\",\n \"subject\": \"<string>\",\n \"submitter_id\": \"<integer>\",\n \"tags\": \"<array>\",\n \"ticket_form_id\": \"<integer>\",\n \"type\": \"question\",\n \"updated_at\": \"<dateTime>\",\n \"updated_stamp\": \"<string>\",\n \"url\": \"<string>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"Ut__a\": -44750185.46031158,\n \"dolored2b\": 8252599,\n \"mollit1a6\": true\n }\n },\n \"via_followup_source_id\": \"<integer>\",\n \"via_id\": \"<integer>\",\n \"voice_comment\": {}\n }\n}"
},
{
"name": "When the `agent_id` or `ticket_id` is invalid",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"display_to_agent\": \"<integer>\",\n \"ticket\": {\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 \"sed_f\": -35238092,\n \"amet_d89\": \"sint\"\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 \"culpa_b8_\": false,\n \"exercitation87\": \"in incididunt commodo\"\n }\n }\n },\n \"priority\": \"urgent\",\n \"via_id\": 46,\n \"voice_comment\": {\n \"answered_by_id\": \"<integer>\",\n \"call_duration\": \"<integer>\",\n \"from\": \"<string>\",\n \"location\": \"<string>\",\n \"recording_url\": \"<string>\",\n \"started_at\": \"<dateTime>\",\n \"to\": \"<string>\",\n \"transcription_text\": \"<string>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/channels/voice/tickets",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"channels",
"voice",
"tickets"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "<string>"
}
]
}