{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e584d540-fb95-4a3d-811f-8d27c327131d","name":"CCC WebServices","description":"CCC WebServices (CCCWS) allows you to query metadata about your account, campaigns, lists, calls, etc. You can also create new records and customize the operation of your campaigns from your own application or CRM.\n\nCCC WebServices are RESTful and should point to the following URL:\n\n- **URL**  \n    `https://api.ccc.uno/ws/[Resource]/[Action]`\n    \n\n---\n\n# HTTP Request Format\n\nAll WebServices requests must be made using **HTTP POST** to the URL specified in each request's documentation.\n\nEach request must include the following parameters:\n\nAuthUsername = $AuthUsername  \nAuthToken = $AuthToken  \nRequestDateTime = YYYY-MM-DD HH:MM:SS  \nData = JSON String\n\nPlease read the _**Authentication Protocol**_ section below to know how the Authentication parameters work.\n\n---\n\n# HTTP Responses\n\n## HTTP General Response Codes\n\nCCC WebServices will respond with any of the following HTTP Response Codes:\n\n- _**200 OK**_  \n    The request was completed and executed succesfully.\n- _**400 Bad Request**_  \n    The request was not executed due to errors in the request format, headers or data.\n- _**401 Unauthorized**_  \n    The request was understood but was not executed due to errors with the provided Authentication parameters.\n- **500 Internal Server Error**  \n    The request was understood but was not executed due to unknown errors.\n    \n\n## Response Data Format\n\n- Each HTTP 200 OK response will include the following JSON object:\n    - _**ResponseCode**_ : Numeric : NNN\n    - _**Data**_ : Object : Each type of request will define the data to be returned.\n- Each HTTP 4XX or 5XX response will include the following data:\n    - _**Response Code**_ : Numeric : NNN\n    - _**Response Text**_ : String : Text describing the reason for the error.\n\n---\n\n# Authentication Protocol\n\nIn order to authenticate each request, CCC needs the following parameters to be included in the request:\n\n- **AuthUsername** : StringUsername provided to the Client.\n- **AuthToken** : StringDynamically generated Token for this request. Each request must calculate its own Token.The Token is calculated as follows:\n    1. `_$token1_ = sha256({Data})`\n        - _$token1_ : Is the sha256 hash of the **{Data}** to be sent in the request.\n    2. `_$SecretHash_ = sha256([SecretKey])`\n        - _\\[SecretKey\\]_ : Is the secret key provided to the Client.\n        - _$SecretHash_ : Is the sha256 hash of the _\\[SecretKey\\]_.\n    3. `_$token2_ = sha256(\"[ClientID]:[Username]:$SecretHash\")`\n        - _\\[ClientID\\]_ : Is a numeric value provided to the Client.\n        - _$token2_ : Is the sha256 hash of the string resulting in the concatenation of _\\[ClientID\\]_, _\\[AuthUsername\\]_ and _$SecretHash_, using `:` as separator.\n    4. `_$AuthToken_ = sha256(\"$token1:$token2:$RequestDateTime\")`\n        - _$AuthToken_ : Is the sha256 of the string resulting in the concatenation of _$token1_, _$token2_ and _\\[RequestDateTime\\]_, using `:` as separator.\n- **RequestDateTime** : String (YYYY-MM-DD HH:MM:SS)  \n    Request Date & Time in the Client's current time-zone.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"3673926","team":92582,"collectionId":"e584d540-fb95-4a3d-811f-8d27c327131d","publishedId":"RVu8iTAk","public":true,"publicUrl":"https://api-doc.ccc.uno","privateUrl":"https://go.postman.co/documentation/3673926-e584d540-fb95-4a3d-811f-8d27c327131d","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2018-04-13T20:19:25.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"CCC Live - Test Mode.template","id":"7b19cc87-74ab-7f6f-3ea2-30c37d5369f9","owner":"3673926","values":[{"enabled":true,"key":"URL","value":"https://api.ccc.uno","type":"text"},{"enabled":true,"key":"AuthenticationUsername","value":"CCCWebServicesTestMode","type":"text"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/567f67d54f4792abc8db979ccf0e13c4d297d161b55db5453205a31a7ee1e1c2","favicon":"https://ccc.uno/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"CCC Live - Test Mode.template","value":"3673926-7b19cc87-74ab-7f6f-3ea2-30c37d5369f9"}],"canonicalUrl":"https://api-doc.ccc.uno/view/metadata/RVu8iTAk"}