{"info":{"_postman_id":"20bdb2af-fe9b-4c4e-9d63-81170ee78665","name":"Cisco Webex Experience Management","description":"

Cisco Webex Experience management (referred as ‘Experience management’ here after) was architected and designed leveraging the best practices of efficient cloud computing, the platform is architected to be open(OpenStandards/OpenData/OpenAPI), to perform (see benchmarks), to be secure (PCI-DSS Level 1) and long lasting (based upon rock solid enterprise grade Microsoft’s Azure Platform).

\n

The platforms open philosophy of implementing Open Standards and Open API allows businesses full control to own their data. The open APIs can also be leveraged to extend the capabilities of the platform based on your needs as well. For example, the open APIs can be consumed to create your own survey and push data into Experience Management for advanced analytics.

\n

This collection is designed to help organizations set-up their own custom survey. To achieve this, you need to make use of the following two APIs.

\n
    \n

  1. Login Token API

    \n

    To access Experience Management APIs, first you will need to obtain Bearer token by providing the \"username\" and \"password\" in this API. \"grant_type\" is always set as \"password\".

    \n
    2. \n

  2. Survey Token API

    \n

    Create a New Survey Token For Collecting Surveys Linked to a Questionnaire.

    \n
    3. \n
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"10586263","collectionId":"20bdb2af-fe9b-4c4e-9d63-81170ee78665","publishedId":"U16gPmj2","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-09-06T05:24:50.000Z"},"item":[{"name":"Login Token API","event":[{"listen":"prerequest","script":{"exec":["\r","pm.globals.set(\"access_token\", pm.variables.get(\"access_token\"));"],"type":"text/javascript","id":"e7c072c0-7fb6-4def-b6bc-d4d1c85eb97f"}},{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," var jsonData = JSON.parse(responseBody);\r"," pm.collectionVariables.set(\"access_token\", jsonData.access_token);\r","});"],"type":"text/javascript","id":"e73c2477-a174-4f9a-9b02-0ecc4b58cd95"}}],"id":"be845b59-55c1-460e-9cb3-3e9b9f11bcbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text"},{"key":"username","value":"{WXM Username}","type":"text"},{"key":"password","value":"{WXM Password}","type":"text"}]},"url":"https://api.getcloudcherry.com/api/LoginToken","description":"

Use this API to obtain the bearer token. \nRequired input parameters are:

\n\n","urlObject":{"protocol":"https","path":["api","LoginToken"],"host":["api","getcloudcherry","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"be845b59-55c1-460e-9cb3-3e9b9f11bcbf"},{"name":"Survey Token with Prefills","id":"97159d0a-bb77-4806-b851-953c95d6481b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"uiIOYN25DEBwBIv8dhiNGMNxzV19r2PBb2VhO6OMMpMdG9nhtkoPXWi4NPHdZPhYbdT3BfaaWtLJZzX7yJ_pXBQqxARQS3CtU0cF9LoYdY5EpBf1Tjs3uQuUg2tvN4Ddb_PJ63iL1k4nffcNbBtpj1fIQ7eE5rhVGyk1m63mLhSAgc142KVN8xgQ6AOeEpbLENgw8ZqNpvP6BHLS8z1BpddujzrfCoomvqFeZ_xO26YffrH6KkzVBc9lICzGke8Y6zinYSBG_5J9BXT-rxBHBAelx9c9vmOLiEYZ11_1AIn1sZzhblcNjzpFrag5iO0w7lKHiKk35-_m3WjWX39Q0kNBXQDtI59t3HWA-UOoMkt_ICAkLrwjkx8cZ9ZpCqYlVeD5ZjJwBpYuXMrQx93lu4Jy_N2NtTCFCtsTnnGVSJlAOcmue6Z4yBJjU_F2TA-IGtueVeKSXA6PWiwS9q_e16DTXslBZ1NC4YFele_HwIkYaetG38QMOs2fMl20tGDfGCoHSBi4EXrQBFyCOnqxWvHEKVCdbOLwvOeW8ONgW3t8fyRuEVMQMxLh5CwTY5YFXwAPkQ"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user\": \"\",\n \"note\": \"Created using the API from Postman\",\n \"validTill\": \"null\",\n \"validUses\": -1,\n \"location\": \"\",\n \"restrictBySignature\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.getcloudcherry.com/api/SurveyToken","description":"

Create a New Survey Token For Collecting Surveys Linked to a Questionnaire. To access this API, you need to pass Bearer token in the 'Authorization 'header which is already handled in the postman script. For Request body, required input parameters are:

\n
    \n
  • user - Pass the WXM account username here
    • \n
  • note - Provide any specific note such as 'Created using the API from Postman'
    • \n
  • validTill - This is a DateTime field and requires the value to be in UTC format. Once the set time elapses, token will be expired and can't be used further for survey collection. For BYOS, same token will be used for survey collection for all customers. So this will be set as to never expire. For this case, Pass as \"null\" always since the token shouldn't be expired
    • \n
  • validUses - This field allows the token to be used for survey collection as many times as its set here. For example, if its set as 1, it can be used only once and after that this token will be expired. For BYOS, same token will be used for survey collection for all customers. So this will be set as multi-use token. Pass as -1 always for the token to set as multi-use
    • \n
  • location - This field refers to a WXM questionnaire. Pass the Questionnaire ID here for which survey token is created.
    • \n
  • prefill - This field contains all the prefills which should be linked with created survey token. It consists of QuesitonID, QuestionText, NumberInput and TextInout.
    • \n
\n

In the response, \"id\" field represent the Survey Token. Copy this value and use it in BYOS reference solution for submission of customer survey responses.

\n

To try out Survey in Web browser, append the survey token in following URL and hit on the browser.\nhttps://nps.bz/

\n","urlObject":{"protocol":"https","path":["api","SurveyToken"],"host":["api","getcloudcherry","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"97159d0a-bb77-4806-b851-953c95d6481b"},{"name":"Request Invitations for SMS","id":"b0fa902c-bce7-4a1e-8a4d-c6e884be721b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"uiIOYN25DEBwBIv8dhiNGMNxzV19r2PBb2VhO6OMMpMdG9nhtkoPXWi4NPHdZPhYbdT3BfaaWtLJZzX7yJ_pXBQqxARQS3CtU0cF9LoYdY5EpBf1Tjs3uQuUg2tvN4Ddb_PJ63iL1k4nffcNbBtpj1fIQ7eE5rhVGyk1m63mLhSAgc142KVN8xgQ6AOeEpbLENgw8ZqNpvP6BHLS8z1BpddujzrfCoomvqFeZ_xO26YffrH6KkzVBc9lICzGke8Y6zinYSBG_5J9BXT-rxBHBAelx9c9vmOLiEYZ11_1AIn1sZzhblcNjzpFrag5iO0w7lKHiKk35-_m3WjWX39Q0kNBXQDtI59t3HWA-UOoMkt_ICAkLrwjkx8cZ9ZpCqYlVeD5ZjJwBpYuXMrQx93lu4Jy_N2NtTCFCtsTnnGVSJlAOcmue6Z4yBJjU_F2TA-IGtueVeKSXA6PWiwS9q_e16DTXslBZ1NC4YFele_HwIkYaetG38QMOs2fMl20tGDfGCoHSBi4EXrQBFyCOnqxWvHEKVCdbOLwvOeW8ONgW3t8fyRuEVMQMxLh5CwTY5YFXwAPkQ"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerPhone\": \"\",\n \"customerName\": \"\",\n \"preFillByQuestionTag\": {\n \"mobile\": \"\"\n },\n \"template\": \"https://?username=&password=&to=&senderid=YYYY&text=Dear Customer, Thank you for renewing your life insurance policy. We would love to hear about your experience. Click here to share now.*|Survey URL|*\",\n \"tokenDetails\": {\n \"id\": \"\",\n \"user\": \"\",\n \"note\": \"Test survey\",\n \"preFill\": [\n {\n \"questionId\": \"\",\n \"questionText\": \"\",\n \"textInput\": \"\",\n \"numberInput\": 0\n }\n ],\n \"location\": \"\",\n \"validUses\": 1,\n \"validTill\": \"2020-12-10T07:32:11.912Z\" // Validity to be passed in UTC time format.\n },\n \"isSMS\": true,\n \"nonRepeatByUniquieQuestionTag\": \"mobile\",\n \"nonRepeatWithinLastDays\": 1,\n \"preFillByQuestionId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.getcloudcherry.com/api/SurveyToken","urlObject":{"protocol":"https","path":["api","SurveyToken"],"host":["api","getcloudcherry","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b0fa902c-bce7-4a1e-8a4d-c6e884be721b"},{"name":"Request Invitations for Email","id":"3729f2b2-1485-4197-b0cf-4582e9ffc8a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"uiIOYN25DEBwBIv8dhiNGMNxzV19r2PBb2VhO6OMMpMdG9nhtkoPXWi4NPHdZPhYbdT3BfaaWtLJZzX7yJ_pXBQqxARQS3CtU0cF9LoYdY5EpBf1Tjs3uQuUg2tvN4Ddb_PJ63iL1k4nffcNbBtpj1fIQ7eE5rhVGyk1m63mLhSAgc142KVN8xgQ6AOeEpbLENgw8ZqNpvP6BHLS8z1BpddujzrfCoomvqFeZ_xO26YffrH6KkzVBc9lICzGke8Y6zinYSBG_5J9BXT-rxBHBAelx9c9vmOLiEYZ11_1AIn1sZzhblcNjzpFrag5iO0w7lKHiKk35-_m3WjWX39Q0kNBXQDtI59t3HWA-UOoMkt_ICAkLrwjkx8cZ9ZpCqYlVeD5ZjJwBpYuXMrQx93lu4Jy_N2NtTCFCtsTnnGVSJlAOcmue6Z4yBJjU_F2TA-IGtueVeKSXA6PWiwS9q_e16DTXslBZ1NC4YFele_HwIkYaetG38QMOs2fMl20tGDfGCoHSBi4EXrQBFyCOnqxWvHEKVCdbOLwvOeW8ONgW3t8fyRuEVMQMxLh5CwTY5YFXwAPkQ"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerPhone\": \"\",\n \"customerName\": \"\",\n \"subject\": \"\",\n \"customerEmail\": \"\",\n \"preFillByQuestionTag\": {\n \"email\": \"\"\n },\n \"template\": \"\",\n \"tokenDetails\": {\n \"id\": \"\",\n \"user\": \"\",\n \"note\": \"This is a test survey token\",\n \"preFill\": [\n {\n \"questionId\": \"5dba93383b518609807f8eb0\",\n \"questionText\": \"Touchpoint\",\n \"textInput\": \"New Onboarding\",\n \"numberInput\": 0\n },\n {\n \"questionId\": \"5db68b06c76a0119487d8607\",\n \"questionText\": \"Email\",\n \"textInput\": \"EmailID of Customer\",\n \"numberInput\": 0\n },\n {\n \"questionId\": \"5dc5a1792dca541f7ceb7bd4\",\n \"questionText\": \"Policy Number\",\n \"textInput\": \"Policy Number\",\n \"numberInput\": 0\n }\n ],\n \"location\": \"\",\n \"validUses\": 1, // No of times survey can be submitted \n \"validTill\": \"2020-12-10T07:32:11.912Z\" // Expiry time to be passed in UTC time format. \n },\n \"isSMS\": false, // For email, this field should be false\n \"nonRepeatByUniquieQuestionTag\": \"email\", // Throttling to be done on this question tag\n \"nonRepeatWithinLastDays\": 1, // If sent in last days, dont send the survey again\n \"preFillByQuestionId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.getcloudcherry.com/api/SurveyToken","urlObject":{"protocol":"https","path":["api","SurveyToken"],"host":["api","getcloudcherry","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3729f2b2-1485-4197-b0cf-4582e9ffc8a0"},{"name":"Survey Token API","id":"ed2f8797-0bd8-403c-9b28-de8b293f81f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"uiIOYN25DEBwBIv8dhiNGMNxzV19r2PBb2VhO6OMMpMdG9nhtkoPXWi4NPHdZPhYbdT3BfaaWtLJZzX7yJ_pXBQqxARQS3CtU0cF9LoYdY5EpBf1Tjs3uQuUg2tvN4Ddb_PJ63iL1k4nffcNbBtpj1fIQ7eE5rhVGyk1m63mLhSAgc142KVN8xgQ6AOeEpbLENgw8ZqNpvP6BHLS8z1BpddujzrfCoomvqFeZ_xO26YffrH6KkzVBc9lICzGke8Y6zinYSBG_5J9BXT-rxBHBAelx9c9vmOLiEYZ11_1AIn1sZzhblcNjzpFrag5iO0w7lKHiKk35-_m3WjWX39Q0kNBXQDtI59t3HWA-UOoMkt_ICAkLrwjkx8cZ9ZpCqYlVeD5ZjJwBpYuXMrQx93lu4Jy_N2NtTCFCtsTnnGVSJlAOcmue6Z4yBJjU_F2TA-IGtueVeKSXA6PWiwS9q_e16DTXslBZ1NC4YFele_HwIkYaetG38QMOs2fMl20tGDfGCoHSBi4EXrQBFyCOnqxWvHEKVCdbOLwvOeW8ONgW3t8fyRuEVMQMxLh5CwTY5YFXwAPkQ"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user\": \"\",\n \"note\": \"Created using the API from Postman\",\n \"validTill\": \"null\", // Expiry time to be passed in UTC time format. null means unlimited expiry\n \"validUses\": -1,\n \"location\": \"\",\n \"restrictBySignature\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.getcloudcherry.com/api/SurveyToken","description":"

Create a New Survey Token For Collecting Surveys Linked to a Questionnaire. To access this API, you need to pass Bearer token in the 'Authorization 'header which is already handled in the postman script. For Request body, required input parameters are:

\n
    \n
  • user - Pass the WXM account username here
    • \n
  • note - Provide any specific note such as 'Created using the API from Postman'
    • \n
  • validTill - This is a DateTime field and requires the value to be in UTC format. Once the set time elapses, token will be expired and can't be used further for survey collection. For BYOS, same token will be used for survey collection for all customers. So this will be set as to never expire. For this case, Pass as \"null\" always since the token shouldn't be expired
    • \n
  • validUses - This field allows the token to be used for survey collection as many times as its set here. For example, if its set as 1, it can be used only once and after that this token will be expired. For BYOS, same token will be used for survey collection for all customers. So this will be set as multi-use token. Pass as -1 always for the token to set as multi-use
    • \n
  • location - This field refers to a WXM questionnaire. Pass the Questionnaire ID here for which survey token is created.
    • \n
  • restrictBySignature - This is an optional additional security measure while using a multi-use survey token. Set any string passphrase and pass in this field. The same passphrase should be used while submitting the response using the BYOS reference implementation.
    • \n
\n

In the response, \"id\" field represent the Survey Token. Copy this value and use it in BYOS reference solution for submission of customer survey responses.

\n

To try out Survey in Web browser, append the survey token in following URL and hit on the browser.\nhttps://nps.bz/

\n","urlObject":{"protocol":"https","path":["api","SurveyToken"],"host":["api","getcloudcherry","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ed2f8797-0bd8-403c-9b28-de8b293f81f9"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"dbb65739-516d-42b4-9273-bf44f6b6cdd2"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"4356303e-6358-401c-8e3e-f7cee6a1b757"}}],"variable":[{"key":"access_token","value":"uiIOYN25DEBwBIv8dhiNGMNxzV19r2PBb2VhO6OMMpMdG9nhtkoPXWi4NPHdZPhYbdT3BfaaWtLJZzX7yJ_pXBQqxARQS3CtU0cF9LoYdY5EpBf1Tjs3uQuUg2tvN4Ddb_PJ63iL1k4nffcNbBtpj1fIQ7eE5rhVGyk1m63mLhSAgc142KVN8xgQ6AOeEpbLENgw8ZqNpvP6BHLS8z1BpddujzrfCoomvqFeZ_xO26YffrH6KkzVBc9lICzGke8Y6zinYSBG_5J9BXT-rxBHBAelx9c9vmOLiEYZ11_1AIn1sZzhblcNjzpFrag5iO0w7lKHiKk35-_m3WjWX39Q0kNBXQDtI59t3HWA-UOoMkt_ICAkLrwjkx8cZ9ZpCqYlVeD5ZjJwBpYuXMrQx93lu4Jy_N2NtTCFCtsTnnGVSJlAOcmue6Z4yBJjU_F2TA-IGtueVeKSXA6PWiwS9q_e16DTXslBZ1NC4YFele_HwIkYaetG38QMOs2fMl20tGDfGCoHSBi4EXrQBFyCOnqxWvHEKVCdbOLwvOeW8ONgW3t8fyRuEVMQMxLh5CwTY5YFXwAPkQ"}]}