PureBasic / Support API / Create Ticket or Voicemail Ticket
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "login")
CkHttp::setCkPassword(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.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"display_to_agent","<integer>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].content_type","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].content_url","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].deleted","<boolean>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].file_name","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].height","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].id","<integer>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].inline","<boolean>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].malware_access_override","<boolean>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].malware_scan_result","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].mapped_content_url","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].size","<integer>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].url","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].width","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[0].content_type","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[0].content_url","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[0].deleted","<boolean>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[0].file_name","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[0].height","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[0].id","<integer>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[0].inline","<boolean>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[0].malware_access_override","<boolean>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[0].malware_scan_result","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[0].mapped_content_url","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[0].size","<integer>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[0].url","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[0].width","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[1].content_type","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[1].content_url","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[1].deleted","<boolean>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[1].file_name","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[1].height","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[1].id","<integer>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[1].inline","<boolean>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[1].malware_access_override","<boolean>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[1].malware_scan_result","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[1].mapped_content_url","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[1].size","<integer>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[1].url","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[0].thumbnails[1].width","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].content_type","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].content_url","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].deleted","<boolean>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].file_name","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].height","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].id","<integer>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].inline","<boolean>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].malware_access_override","<boolean>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].malware_scan_result","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].mapped_content_url","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].size","<integer>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].url","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].width","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[0].content_type","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[0].content_url","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[0].deleted","<boolean>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[0].file_name","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[0].height","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[0].id","<integer>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[0].inline","<boolean>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[0].malware_access_override","<boolean>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[0].malware_scan_result","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[0].mapped_content_url","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[0].size","<integer>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[0].url","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[0].width","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[1].content_type","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[1].content_url","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[1].deleted","<boolean>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[1].file_name","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[1].height","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[1].id","<integer>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[1].inline","<boolean>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[1].malware_access_override","<boolean>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[1].malware_scan_result","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[1].mapped_content_url","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[1].size","<integer>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[1].url","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.attachments[1].thumbnails[1].width","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.audit_id","<integer>")
CkJsonObject::ckUpdateString(json,"ticket.comment.author_id","<integer>")
CkJsonObject::ckUpdateString(json,"ticket.comment.body","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.created_at","<dateTime>")
CkJsonObject::ckUpdateString(json,"ticket.comment.html_body","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.id","<integer>")
CkJsonObject::ckUpdateInt(json,"ticket.comment.metadata.sed_f",-35238092)
CkJsonObject::ckUpdateString(json,"ticket.comment.metadata.amet_d89","sint")
CkJsonObject::ckUpdateString(json,"ticket.comment.plain_body","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.public","<boolean>")
CkJsonObject::ckUpdateString(json,"ticket.comment.type","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.uploads[0]","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.uploads[1]","<string>")
CkJsonObject::ckUpdateString(json,"ticket.comment.via.channel","<string>")
CkJsonObject::ckUpdateBool(json,"ticket.comment.via.source.culpa_b8_",0)
CkJsonObject::ckUpdateString(json,"ticket.comment.via.source.exercitation87","in incididunt commodo")
CkJsonObject::ckUpdateString(json,"ticket.priority","urgent")
CkJsonObject::ckUpdateInt(json,"ticket.via_id",46)
CkJsonObject::ckUpdateString(json,"ticket.voice_comment.answered_by_id","<integer>")
CkJsonObject::ckUpdateString(json,"ticket.voice_comment.call_duration","<integer>")
CkJsonObject::ckUpdateString(json,"ticket.voice_comment.from","<string>")
CkJsonObject::ckUpdateString(json,"ticket.voice_comment.location","<string>")
CkJsonObject::ckUpdateString(json,"ticket.voice_comment.recording_url","<string>")
CkJsonObject::ckUpdateString(json,"ticket.voice_comment.started_at","<dateTime>")
CkJsonObject::ckUpdateString(json,"ticket.voice_comment.to","<string>")
CkJsonObject::ckUpdateString(json,"ticket.voice_comment.transcription_text","<string>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://example.zendesk.com/api/v2/channels/voice/tickets","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
email.s
name.s
Requester_id.s = CkJsonObject::ckStringOf(jResp,"ticket.requester_id")
Allow_attachments.s = CkJsonObject::ckStringOf(jResp,"ticket.allow_attachments")
Allow_channelback.s = CkJsonObject::ckStringOf(jResp,"ticket.allow_channelback")
Assignee_email.s = CkJsonObject::ckStringOf(jResp,"ticket.assignee_email")
Assignee_id.s = CkJsonObject::ckStringOf(jResp,"ticket.assignee_id")
Attribute_value_ids.s = CkJsonObject::ckStringOf(jResp,"ticket.attribute_value_ids")
Brand_id.s = CkJsonObject::ckStringOf(jResp,"ticket.brand_id")
Collaborator_ids.s = CkJsonObject::ckStringOf(jResp,"ticket.collaborator_ids")
Created_at.s = CkJsonObject::ckStringOf(jResp,"ticket.created_at")
Custom_fields.s = CkJsonObject::ckStringOf(jResp,"ticket.custom_fields")
Custom_status_id.s = CkJsonObject::ckStringOf(jResp,"ticket.custom_status_id")
Description.s = CkJsonObject::ckStringOf(jResp,"ticket.description")
Due_at.s = CkJsonObject::ckStringOf(jResp,"ticket.due_at")
Email_cc_ids.s = CkJsonObject::ckStringOf(jResp,"ticket.email_cc_ids")
External_id.s = CkJsonObject::ckStringOf(jResp,"ticket.external_id")
Follower_ids.s = CkJsonObject::ckStringOf(jResp,"ticket.follower_ids")
Followup_ids.s = CkJsonObject::ckStringOf(jResp,"ticket.followup_ids")
Forum_topic_id.s = CkJsonObject::ckStringOf(jResp,"ticket.forum_topic_id")
From_messaging_channel.s = CkJsonObject::ckStringOf(jResp,"ticket.from_messaging_channel")
Group_id.s = CkJsonObject::ckStringOf(jResp,"ticket.group_id")
Has_incidents.s = CkJsonObject::ckStringOf(jResp,"ticket.has_incidents")
Id.s = CkJsonObject::ckStringOf(jResp,"ticket.id")
Is_public.s = CkJsonObject::ckStringOf(jResp,"ticket.is_public")
Macro_id.s = CkJsonObject::ckStringOf(jResp,"ticket.macro_id")
Macro_ids.s = CkJsonObject::ckStringOf(jResp,"ticket.macro_ids")
Organization_id.s = CkJsonObject::ckStringOf(jResp,"ticket.organization_id")
Priority.s = CkJsonObject::ckStringOf(jResp,"ticket.priority")
Problem_id.s = CkJsonObject::ckStringOf(jResp,"ticket.problem_id")
Raw_subject.s = CkJsonObject::ckStringOf(jResp,"ticket.raw_subject")
Recipient.s = CkJsonObject::ckStringOf(jResp,"ticket.recipient")
Safe_update.s = CkJsonObject::ckStringOf(jResp,"ticket.safe_update")
In_11.s = CkJsonObject::ckStringOf(jResp,"ticket.satisfaction_rating.in_11")
Sharing_agreement_ids.s = CkJsonObject::ckStringOf(jResp,"ticket.sharing_agreement_ids")
Status.s = CkJsonObject::ckStringOf(jResp,"ticket.status")
Subject.s = CkJsonObject::ckStringOf(jResp,"ticket.subject")
Submitter_id.s = CkJsonObject::ckStringOf(jResp,"ticket.submitter_id")
Tags.s = CkJsonObject::ckStringOf(jResp,"ticket.tags")
Ticket_form_id.s = CkJsonObject::ckStringOf(jResp,"ticket.ticket_form_id")
v_Type.s = CkJsonObject::ckStringOf(jResp,"ticket.type")
Updated_at.s = CkJsonObject::ckStringOf(jResp,"ticket.updated_at")
Updated_stamp.s = CkJsonObject::ckStringOf(jResp,"ticket.updated_stamp")
v_Url.s = CkJsonObject::ckStringOf(jResp,"ticket.url")
Channel.s = CkJsonObject::ckStringOf(jResp,"ticket.via.channel")
Ut__a.s = CkJsonObject::ckStringOf(jResp,"ticket.via.source.Ut__a")
Dolored2b.i = CkJsonObject::ckIntOf(jResp,"ticket.via.source.dolored2b")
Mollit1a6.i = CkJsonObject::ckBoolOf(jResp,"ticket.via.source.mollit1a6")
Via_followup_source_id.s = CkJsonObject::ckStringOf(jResp,"ticket.via_followup_source_id")
Via_id.s = CkJsonObject::ckStringOf(jResp,"ticket.via_id")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"ticket.collaborators")
While i < count_i
CkJsonObject::setCkI(jResp, i)
email = CkJsonObject::ckStringOf(jResp,"ticket.collaborators[i].email")
name = CkJsonObject::ckStringOf(jResp,"ticket.collaborators[i].name")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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>"
}
]
}
