To use this API with the help of a token, follow these steps:
- Generate the Token: Use the 'Generate Token' API to obtain an authentication token.
- Enter the Token ID: Navigate to the right section of this page, under the 'CREDENTIALS' tab. Here, input the generated token ID.
- With the token entered, pass the header and body parameters:
Rate LimitAPI allows 10 requests per minute.
Possible Responses
Scenario | Response |
|---|---|
Passing an Invalid apiKey | {"status": "false", "message": "Invalid User Details", "data": null} |
Missing apiKey | {"status": "false", "message": "Invalid User Details", "data": null} |
Passing Invalid userName | {"status": "false", "message": "Invalid User Details", "data": null} |
Passing Invalid Token Value | {""status"": ""false"",""message"": ""Invalid Token"", ""data"": null} |
Missing Token Value | {"status": "false","message": "Token Should Not be Null or Empty.","data": null} |
Passing expired Token | {"status": "false","message": "Token Expired","data": null} |
Missing userName | {"status": "false", "message": "Username Should Not be Null or Empty.", "data": null} |
Passing Invalid skillName | {"Message": { "skillName": "skillName must be at least 3 characters long" }, "Status": "Fail"} |
Missing skillName key | {"Message": { "skillName": "skillName is required" }, "Status": "Fail"} |
Passing Invalid skillDetail1 | {"Message": { "skillDetail1": "skillDetail1 must be greater than 2 characters long" }, "Status": "Fail"} |
Passing Invalid skillLocation | {"Message": { "skillLocation": "skillLocation not found" }, "Status": "Fail"} |
Missing skillLocation key | {"Message": { "skillLocation": "skillLocation is required" }, "Status": "Fail"} |
Passing Invalid record Value | {"Message": { "record": "record must be Record the call in Full, Record only the Conversation or Do not record calls" }, "Status": "Fail"} |
Missing record Value | {"Message": { "record": "record is required" }, "Status": "Fail"} |
Passing Invalid phoneNumbers Value | {"Message": { "phoneNumbers[0]": "phoneNumber not found" }, "Status": "Fail"} |
Missing agents key | {"Message": { "agents": "agents is required" }, "Status": "Fail"} |
Passing Invalid agentPriority Value | {"Message": { "agents[0].priority": "agent priority must be between 1 and 100" }, "Status": "Fail"} |
Missing agentPriority Value | {"status": "false", "message": "Invalid Json Pass Valid Json", "data": null} |
Passing Invalid agentId Value | {"Message": { "agents[2].agentId": "agentId not found" }, "Status": "Fail"} |
Missing agentId Value | {"Message": { "agents[0].agentId": "agentId is required" }, "Status": "Fail"} |
Passing Invalid queueSize Value | {"Message": { "queueSize": "queueSize must be between 1 and 999" }, "Status": "Fail"} |
Missing queueSize Value | {"status": "false", "message": "Invalid Json Pass Valid Json", "data": null} |
Passing Invalid queueTimeOut Value | {"Message": { "queueTimeOut": "queueTimeOut must be in the format HH:MM or it must between 00:00 and 30:59" }, "Status": "Fail"} |
Missing queueTimeOut Value | {"Message": { "queueTimeOut": "queueTimeOut is required" }, "Status": "Fail"} |
Passing Invalid fallBackRule Value | {"Message": { "fallBackRule": "fallBackRule must be DIALOUT, DISCONNECT, VOICEMAIL, SKILL, IVR, MULTISKILL or PARKING" }, "Status": "Fail"} |
Missing fallBackRule Value | {"Message": { "fallBackRule": "fallBackRule is required" }, "Status": "Fail"} |
Passing Invalid dialOutName Value | {"Message": { "dialOutName": "dialOutName not found" }, "Status": "Fail"} |
Missing dialOutName Value | {"Message": { "dialOutName": "dialOutName is required" }, "Status": "Fail"} |
Passing Invalid transferSkill Value | {"Message": { "transferSkill": "transferSkill not found" }, "Status": "Fail"} |
Missing transferSkill Value | {"Message": { "transferSkill": "transferSkill is required" }, "Status": "Fail"} |
Passing fallBackRule value as IVR and ivrFlowName as Blank | {"Message": { "ivrFlowName": "ivrFlowName or transferIvrUrl is required" }, "Status": "Fail"} |
Passing Invalid ivrFlowName Value | {"Message": { "ivrFlowName": "ivrFlowName not found" }, "Status": "Fail"} |
Missing ivrFlowName Value | {"Message": { "ivrFlowName": "ivrFlowName or transferIvrUrl is required" }, "Status": "Fail"} |
Passing fallBackRule value as Multiskill and skills as Blank | {"Message": { "fallBackRules.skills[0].skillName": "skillName is required", "fallBackRules.skills[1].skillName": "skillName is required" }, "Status": "Fail"} |
Missing url Value | {"Message": { "callDropActions[0].url": "url is required" }, "Status": "Fail"} |
Passing Invalid tries Value | {"Status": "Fail", "Message": { "callDropActions[0].tries": "tries must be between 1 and 99" }} |
Missing tries Value | {"Status": "Fail", "Message": { "callDropActions[0].tries": "tries is required" }} |
Creating New Skill | {"Status": "Success", "Message": "Skill Created Successfully"} |