Cyara API 3.0 Known Issues

• 

  Valery Topilin

  • July 12, 2021 18:07

  Cyara API 3.0 GET and PUT/POST JSON structures are different.

  For example GET request is returning Plan details:

      "plan": {
          "planId": 12,
          "type": "Velocity",
          "name": "Velocity 5",
          "startDate": "2017-11-09T04:32:00Z",
          "endDate": "2027-10-31T03:32:00Z"
      },

  This part of JSON is not required in the POST and PUT request, instead it only needs PlanID.

  "planId": 12,

  There are also some extra keys in the GET JSON, that can be surplus in the POST and PUT requests.

  0
• 

  Valery Topilin

  • July 13, 2021 21:04

  API 3.0 Update Campaign route suggestions.

  Some of users use GET to retrieve campaign parameters, then update some of them and then execute PUT request to update the campaign.

  That may cause some issues as not all of the GET elements are required and/or supported in the PUT request, that may cause campaign corruption (it is a known issue that is reported to the Cyara Engineering team).

  Below is the PUT JSON that will help to update the Campaign details:

  PUT https://cyaraportal.us/cyarawebapi/v3.0/accounts/[AccountID]/campaigns/[CampaignID]/
  

  {
    "synchronized": {
      "isActive": false
    },
    "maximumAps": 1.0,
    "concurrency": 1,
    "testCases": [
      {
        "testCaseId": [testcaseid],
        "probability": 100
      }
    ],
    "planId": [PlanID],
    "active": false,
    "channel": "Voice",
    "name": "Test Case Name",
    "description": "Test Case Description",
    "requestedRunDate": "2021-06-16T19:52:00Z",
    "scheduledRunDate": "2021-06-16T19:52:00Z",
    "testCaseDistributionProfile": "RoundRobin",
    "planType": "Velocity"
  }

  0
• 

  Christopher Ryan

  • August 05, 2021 21:56

  CX Model APIs lack the ability to create, modify, or delete elements without exporting the json, modifying, and reimporting. But doing that results in losing all the recording associated with each menu. Looking at the Javascript calls in Chrome's network trace, each element has a unique ID that gets references. We could use those same IDs in the API. If it's a menu element, we could update the transcription and remove bad recordings. If it's a decision element, we could create/modify/delete decisions.

  With those same IDs, we could use that as the parent for APIs to create modules, and have a set of APIs for modules.

  0
• 

  Christopher Ryan

  • August 09, 2021 15:37

  The Campaign Creation API when using Pulse doesn't let the user create multiple schedules for a single day. We have open hours 8-12 and 1-5. The API errors saying (paraphrasing) it doesn't more than one entry for a given day.

  0
• 

  Valery Topilin

  • August 12, 2021 18:36

  I agree that CX Models API needs to be improved - I reported this to the Cyara Product Management! Here is the idea number for your reference: POR-I-1328.

  0

Please sign in to leave a comment.