Foxpro / Support API / Create Ticket or Voicemail Ticket
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcEmail
LOCAL lcName
LOCAL lcRequester_id
LOCAL lcAllow_attachments
LOCAL lcAllow_channelback
LOCAL lcAssignee_email
LOCAL lcAssignee_id
LOCAL lcAttribute_value_ids
LOCAL lcBrand_id
LOCAL lcCollaborator_ids
LOCAL lcCreated_at
LOCAL lcCustom_fields
LOCAL lcCustom_status_id
LOCAL lcDescription
LOCAL lcDue_at
LOCAL lcEmail_cc_ids
LOCAL lcExternal_id
LOCAL lcFollower_ids
LOCAL lcFollowup_ids
LOCAL lcForum_topic_id
LOCAL lcFrom_messaging_channel
LOCAL lcGroup_id
LOCAL lcHas_incidents
LOCAL lcId
LOCAL lcIs_public
LOCAL lcMacro_id
LOCAL lcMacro_ids
LOCAL lcOrganization_id
LOCAL lcPriority
LOCAL lcProblem_id
LOCAL lcRaw_subject
LOCAL lcRecipient
LOCAL lcSafe_update
LOCAL lcIn_11
LOCAL lcSharing_agreement_ids
LOCAL lcStatus
LOCAL lcSubject
LOCAL lcSubmitter_id
LOCAL lcTags
LOCAL lcTicket_form_id
LOCAL lcV_Type
LOCAL lcUpdated_at
LOCAL lcUpdated_stamp
LOCAL lcV_Url
LOCAL lcChannel
LOCAL lcUt__a
LOCAL lnDolored2b
LOCAL lnMollit1a6
LOCAL lcVia_followup_source_id
LOCAL lcVia_id
LOCAL i
LOCAL lnCount_i
* 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 CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "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>"
* }
* }
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("display_to_agent","<integer>")
loJson.UpdateString("ticket.comment.attachments[0].content_type","<string>")
loJson.UpdateString("ticket.comment.attachments[0].content_url","<string>")
loJson.UpdateString("ticket.comment.attachments[0].deleted","<boolean>")
loJson.UpdateString("ticket.comment.attachments[0].file_name","<string>")
loJson.UpdateString("ticket.comment.attachments[0].height","<string>")
loJson.UpdateString("ticket.comment.attachments[0].id","<integer>")
loJson.UpdateString("ticket.comment.attachments[0].inline","<boolean>")
loJson.UpdateString("ticket.comment.attachments[0].malware_access_override","<boolean>")
loJson.UpdateString("ticket.comment.attachments[0].malware_scan_result","<string>")
loJson.UpdateString("ticket.comment.attachments[0].mapped_content_url","<string>")
loJson.UpdateString("ticket.comment.attachments[0].size","<integer>")
loJson.UpdateString("ticket.comment.attachments[0].url","<string>")
loJson.UpdateString("ticket.comment.attachments[0].width","<string>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[0].content_type","<string>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[0].content_url","<string>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[0].deleted","<boolean>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[0].file_name","<string>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[0].height","<string>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[0].id","<integer>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[0].inline","<boolean>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[0].malware_access_override","<boolean>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[0].malware_scan_result","<string>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[0].mapped_content_url","<string>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[0].size","<integer>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[0].url","<string>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[0].width","<string>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[1].content_type","<string>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[1].content_url","<string>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[1].deleted","<boolean>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[1].file_name","<string>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[1].height","<string>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[1].id","<integer>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[1].inline","<boolean>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[1].malware_access_override","<boolean>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[1].malware_scan_result","<string>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[1].mapped_content_url","<string>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[1].size","<integer>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[1].url","<string>")
loJson.UpdateString("ticket.comment.attachments[0].thumbnails[1].width","<string>")
loJson.UpdateString("ticket.comment.attachments[1].content_type","<string>")
loJson.UpdateString("ticket.comment.attachments[1].content_url","<string>")
loJson.UpdateString("ticket.comment.attachments[1].deleted","<boolean>")
loJson.UpdateString("ticket.comment.attachments[1].file_name","<string>")
loJson.UpdateString("ticket.comment.attachments[1].height","<string>")
loJson.UpdateString("ticket.comment.attachments[1].id","<integer>")
loJson.UpdateString("ticket.comment.attachments[1].inline","<boolean>")
loJson.UpdateString("ticket.comment.attachments[1].malware_access_override","<boolean>")
loJson.UpdateString("ticket.comment.attachments[1].malware_scan_result","<string>")
loJson.UpdateString("ticket.comment.attachments[1].mapped_content_url","<string>")
loJson.UpdateString("ticket.comment.attachments[1].size","<integer>")
loJson.UpdateString("ticket.comment.attachments[1].url","<string>")
loJson.UpdateString("ticket.comment.attachments[1].width","<string>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[0].content_type","<string>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[0].content_url","<string>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[0].deleted","<boolean>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[0].file_name","<string>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[0].height","<string>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[0].id","<integer>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[0].inline","<boolean>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[0].malware_access_override","<boolean>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[0].malware_scan_result","<string>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[0].mapped_content_url","<string>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[0].size","<integer>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[0].url","<string>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[0].width","<string>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[1].content_type","<string>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[1].content_url","<string>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[1].deleted","<boolean>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[1].file_name","<string>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[1].height","<string>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[1].id","<integer>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[1].inline","<boolean>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[1].malware_access_override","<boolean>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[1].malware_scan_result","<string>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[1].mapped_content_url","<string>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[1].size","<integer>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[1].url","<string>")
loJson.UpdateString("ticket.comment.attachments[1].thumbnails[1].width","<string>")
loJson.UpdateString("ticket.comment.audit_id","<integer>")
loJson.UpdateString("ticket.comment.author_id","<integer>")
loJson.UpdateString("ticket.comment.body","<string>")
loJson.UpdateString("ticket.comment.created_at","<dateTime>")
loJson.UpdateString("ticket.comment.html_body","<string>")
loJson.UpdateString("ticket.comment.id","<integer>")
loJson.UpdateInt("ticket.comment.metadata.sed_f",-35238092)
loJson.UpdateString("ticket.comment.metadata.amet_d89","sint")
loJson.UpdateString("ticket.comment.plain_body","<string>")
loJson.UpdateString("ticket.comment.public","<boolean>")
loJson.UpdateString("ticket.comment.type","<string>")
loJson.UpdateString("ticket.comment.uploads[0]","<string>")
loJson.UpdateString("ticket.comment.uploads[1]","<string>")
loJson.UpdateString("ticket.comment.via.channel","<string>")
loJson.UpdateBool("ticket.comment.via.source.culpa_b8_",0)
loJson.UpdateString("ticket.comment.via.source.exercitation87","in incididunt commodo")
loJson.UpdateString("ticket.priority","urgent")
loJson.UpdateInt("ticket.via_id",46)
loJson.UpdateString("ticket.voice_comment.answered_by_id","<integer>")
loJson.UpdateString("ticket.voice_comment.call_duration","<integer>")
loJson.UpdateString("ticket.voice_comment.from","<string>")
loJson.UpdateString("ticket.voice_comment.location","<string>")
loJson.UpdateString("ticket.voice_comment.recording_url","<string>")
loJson.UpdateString("ticket.voice_comment.started_at","<dateTime>")
loJson.UpdateString("ticket.voice_comment.to","<string>")
loJson.UpdateString("ticket.voice_comment.transcription_text","<string>")
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.PostJson3("https://example.zendesk.com/api/v2/channels/voice/tickets","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcRequester_id = loJResp.StringOf("ticket.requester_id")
lcAllow_attachments = loJResp.StringOf("ticket.allow_attachments")
lcAllow_channelback = loJResp.StringOf("ticket.allow_channelback")
lcAssignee_email = loJResp.StringOf("ticket.assignee_email")
lcAssignee_id = loJResp.StringOf("ticket.assignee_id")
lcAttribute_value_ids = loJResp.StringOf("ticket.attribute_value_ids")
lcBrand_id = loJResp.StringOf("ticket.brand_id")
lcCollaborator_ids = loJResp.StringOf("ticket.collaborator_ids")
lcCreated_at = loJResp.StringOf("ticket.created_at")
lcCustom_fields = loJResp.StringOf("ticket.custom_fields")
lcCustom_status_id = loJResp.StringOf("ticket.custom_status_id")
lcDescription = loJResp.StringOf("ticket.description")
lcDue_at = loJResp.StringOf("ticket.due_at")
lcEmail_cc_ids = loJResp.StringOf("ticket.email_cc_ids")
lcExternal_id = loJResp.StringOf("ticket.external_id")
lcFollower_ids = loJResp.StringOf("ticket.follower_ids")
lcFollowup_ids = loJResp.StringOf("ticket.followup_ids")
lcForum_topic_id = loJResp.StringOf("ticket.forum_topic_id")
lcFrom_messaging_channel = loJResp.StringOf("ticket.from_messaging_channel")
lcGroup_id = loJResp.StringOf("ticket.group_id")
lcHas_incidents = loJResp.StringOf("ticket.has_incidents")
lcId = loJResp.StringOf("ticket.id")
lcIs_public = loJResp.StringOf("ticket.is_public")
lcMacro_id = loJResp.StringOf("ticket.macro_id")
lcMacro_ids = loJResp.StringOf("ticket.macro_ids")
lcOrganization_id = loJResp.StringOf("ticket.organization_id")
lcPriority = loJResp.StringOf("ticket.priority")
lcProblem_id = loJResp.StringOf("ticket.problem_id")
lcRaw_subject = loJResp.StringOf("ticket.raw_subject")
lcRecipient = loJResp.StringOf("ticket.recipient")
lcSafe_update = loJResp.StringOf("ticket.safe_update")
lcIn_11 = loJResp.StringOf("ticket.satisfaction_rating.in_11")
lcSharing_agreement_ids = loJResp.StringOf("ticket.sharing_agreement_ids")
lcStatus = loJResp.StringOf("ticket.status")
lcSubject = loJResp.StringOf("ticket.subject")
lcSubmitter_id = loJResp.StringOf("ticket.submitter_id")
lcTags = loJResp.StringOf("ticket.tags")
lcTicket_form_id = loJResp.StringOf("ticket.ticket_form_id")
lcV_Type = loJResp.StringOf("ticket.type")
lcUpdated_at = loJResp.StringOf("ticket.updated_at")
lcUpdated_stamp = loJResp.StringOf("ticket.updated_stamp")
lcV_Url = loJResp.StringOf("ticket.url")
lcChannel = loJResp.StringOf("ticket.via.channel")
lcUt__a = loJResp.StringOf("ticket.via.source.Ut__a")
lnDolored2b = loJResp.IntOf("ticket.via.source.dolored2b")
lnMollit1a6 = loJResp.BoolOf("ticket.via.source.mollit1a6")
lcVia_followup_source_id = loJResp.StringOf("ticket.via_followup_source_id")
lcVia_id = loJResp.StringOf("ticket.via_id")
i = 0
lnCount_i = loJResp.SizeOfArray("ticket.collaborators")
DO WHILE i < lnCount_i
loJResp.I = i
lcEmail = loJResp.StringOf("ticket.collaborators[i].email")
lcName = loJResp.StringOf("ticket.collaborators[i].name")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
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>"
}
]
}
