/crm/external/v1/ticket

Case (AKA "Ticket") description information

Parameters

  • TenantID - How your specific customer instance is identified, this will be a number. Find this in the app Help (?) icon > MotionCX Voice > Tenant:
  • TicketID - Case number.
  • It is recommended advanced filter object be done outside of the API document for best results.

Responses available:

  • 200
  • 401
  • 403

Example return:

{
  "id": 2487847,
  "tenantId": 2,
  "statusId": 0,
  "statusName": "Open",
  "statusChangeAt": "2022-08-22T21:19:39.6687019",
  "priority": 1,
  "subject": "Phone Inquiry",
  "queueId": 2086,
  "queueName": "Voice Inbound",
  "fileStoreGuid": "c4cc0458-8237-42ba-adf3-06ca5173827f",
  "dispositionId": null,
  "dispositionName": null,
  "createdAt": "2022-05-05T14:04:28.4715397",
  "createdById": null,
  "createdByName": null,
  "createdByEmail": null,
  "createdQueueId": 2086,
  "updatedById": 13727,
  "updatedByName": "Guy Fiero",
  "updatedByEmail": "[email protected]",
  "updatedDate": "2022-08-23T13:22:47.9229784",
  "dueDate": null,
  "assignedAt": "2022-05-05T14:04:34.4904108",
  "assignedToId": 11441,
  "assignedToEmail": "[email protected]",
  "assignedToName": "Another Guy",
  "closedAt": "2022-08-22T20:33:47.2242368",
  "closedById": 13727,
  "closedByEmail": "[email protected]",
  "closedByName": "Guy Fiero",
  "source": 4,
  "lockedById": null,
  "lockedUntil": null,
  "irWorkItemInfoDetails": "{\"relatedInteractionId\":null,\"interactionId\":\"70790d4d-3a48-44b9-bdfa-7373fdfb1cb2\",\"interactions\":[],\"channelUniqueIdentifier\":\"CAbe82eb801c4b8fb2152d86e6d5919d21\",\"channelProvider\":\"Twilio_Voice\",\"channelType\":2,\"tenantId\":2,\"queueId\":2086,\"correlationId\":null,\"variables\":{\"callerstate\":\"OH\",\"from\":\"+16144186667\",\"fromcity\":\"GAHANNA\",\"fromzip\":\"43229\",\"called\":\"+16146183900\",\"calledcity\":\"GALLOWAY\",\"calltoken\":\"%7B%22parentCallInfoToken%22%3A%22eyJhbGciOiJFUzI1NiJ9.eyJjYWxsU2lkIjoiQ0FiZTgyZWI4MDFjNGI4ZmIyMTUyZDg2ZTZkNTkxOWQyMSIsImZyb20iOiIrMTYxNDQxODY2NjciLCJ0byI6IisxNjE0NjE4MzkwMCIsImlhdCI6IjE2NTE3NTk0NjcifQ.OTDXYGjRUrv1p6vwEWEfMUdKTnM756Kr7No1CnshTYFSg7BcrMOUSKOkKVrEMYhanch5hAC1sjzY-TG1zFUTdg%22%2C%22identityHeaderTokens%22%3A%5B%22eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9jci5jY2lkLm5ldXN0YXIuYml6L2NjaWQvYXV0aG4vdjIvY2VydHMvMTEwODIuMTAxMjYifQ.eyJhdHRlc3QiOiJDIiwiZGVzdCI6eyJ0biI6WyIxNjE0NjE4MzkwMCJdfSwiaWF0IjoxNjUxNzU5NDY3LCJvcmlnIjp7InRuIjoiMTYxNDQxODY2NjcifSwib3JpZ2lkIjoiOWM1NTg3MDYtMGFkNi0zM2M2LWJmNTYtZWUxYmIyNGM1MmYwIn0.kGX58Z2r3zisOSVunQnyl8VuPLLnWhyLXwVvpK6FbYKP1LW-plNqGuVXK5vSpj66r2WEjp8W66K7c4bS96SdlQ%3Binfo%3D%3Chttps%3A%2F%2Fcr.ccid.neustar.biz%2Fccid%2Fauthn%2Fv2%2Fcerts%2F11082.10126%3E%3Balg%3DES256%3Bppt%3Dshaken%22%5D%7D\",\"ani\":\"+16144186667\",\"accountsid\":\"ACa9a95429a35ce2335b5dccf8f635cd9e\",\"callerzip\":\"43229\",\"stirverstat\":\"TN-Validation-Passed-C\",\"caller\":\"+16144186667\",\"direction\":\"inbound\",\"tozip\":\"43204\",\"callsid\":\"CAbe82eb801c4b8fb2152d86e6d5919d21\",\"calledzip\":\"43204\",\"tocity\":\"GALLOWAY\",\"calledcountry\":\"US\",\"calledstate\":\"OH\",\"fromcountry\":\"US\",\"callstatus\":\"ringing\",\"callercity\":\"GAHANNA\",\"fromstate\":\"OH\",\"stirpassporttoken\":\"eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9jci5jY2lkLm5ldXN0YXIuYml6L2NjaWQvYXV0aG4vdjIvY2VydHMvMTEwODIuMTAxMjYifQ.eyJhdHRlc3QiOiJDIiwiZGVzdCI6eyJ0biI6WyIxNjE0NjE4MzkwMCJdfSwiaWF0IjoxNjUxNzU5NDY3LCJvcmlnIjp7InRuIjoiMTYxNDQxODY2NjcifSwib3JpZ2lkIjoiOWM1NTg3MDYtMGFkNi0zM2M2LWJmNTYtZWUxYmIyNGM1MmYwIn0.kGX58Z2r3zisOSVunQnyl8VuPLLnWhyLXwVvpK6FbYKP1LW-plNqGuVXK5vSpj66r2WEjp8W66K7c4bS96SdlQ\",\"to\":\"+16146183900\",\"tocountry\":\"US\",\"tostate\":\"OH\",\"dnis\":\"+16146183900\",\"apiversion\":\"2010-04-01\",\"callercountry\":\"US\"},\"token\":null,\"direction\":0,\"state\":1,\"workitemId\":2150607,\"agentId\":11441,\"workItemRequested\":{\"interactionId\":\"70790d4d-3a48-44b9-bdfa-7373fdfb1cb2\",\"ticketId\":2487847,\"editModeSettings\":{\"contactSettings\":null},\"workItemId\":2150607,\"createdAt\":\"2022-05-05T14:04:28.9779837Z\",\"lastStateChangeAt\":\"2022-05-05T14:04:33.8208334Z\",\"lastOffered\":\"2022-05-05T14:04:33.8208336\",\"offeredTimeout\":30,\"automaticAccept\":true,\"displayInBackground\":false,\"screenRecording\":false,\"channelProviderType\":2},\"startedAt\":\"2022-05-05T14:17:27.327Z\"}",
  "contactId": 1000859225,
  "contactEmail": null,
  "contactName": null,
  "relatedTickets": null,
  "participants": null,
  "contacts": null,
  "customData": [],
  "mergedInto": null,
  "isFavorite": false,
  "richDescription": {
    "originalContent": "<p>description body</p>",
    "replacedContent": "<p>description body</p>",
    "files": []
  },
  "parentTicketId": null,
  "contact": null,
  "assignedTo": null,
  "lockedBy": null,
  "updatedBy": null,
  "queue": {
    "id": 2086,
    "tenantId": 2,
    "name": "Voice Inbound",
    "description": "test description for voice inbound queue",
    "allowWebCreate": false,
    "allowPublicWebCreate": false,
    "allowEmailCreate": false,
    "emailInput": null,
    "suppressEmailAll": false,
    "suppressEmailInternal": false,
    "suppressEmailStatusChanged": false,
    "suppressEmailCreate": false,
    "suppressEmailInternalComment": false,
    "suppressEmailPublicComment": false,
    "suppressEmailClosed": false,
    "requireLock": false,
    "requireLockDuration": null,
    "allowQueueTransfer": true,
    "enableDispositions": true,
    "requireDispositionOnCaseClose": false,
    "requireCommentOnStatusChange": false,
    "acwTime": 5,
    "requireContactOnCaseSave": false,
    "commentParticipantSetting": 2
  },
  "disposition": null,
  "status": null,
  "emailAccount": null
}
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!