{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"78225e04-134e-4208-a224-db40add51de5","name":"Kiamo API v2","description":"# Operation Principles\n\n## API Tokens\n\nFor authentication purposes, the Kiamo APIs use an API token which must be transmitted when making each call so that the call is accepted by the system. This provides greater control over the use of Kiamo services.\n\n_Remark_ : The API token is string of 40 hexadecimal characters generated previously by Kiamo.\n\n**Token example**\n\n`68d27ac06e53fef962c49a4b0d18691019c3a31a`\n\n**Obtaining a token**\n\nYou can obtain an API token via the token generation page in the Kiamo administration interface (in the Developer > API > Tokens menu).\n\nFrom this interface, you can:\n\n- generate a token for one or more APIs: Agent, Contact Manager, Interaction, Supervision and/or Task.\n    \n- manage the existing tokens, modify their labels or disable them without deleting them, however.\n    \n- manage the various rights provided by the token. These rights concern the request types (GET, POST, PUT and DELETE).\n    \n\nBy allowing retrieval (GET) on an Interaction API token, for example, you can execute all the get requests of the associated API, but receive an error message 403 (Forbidden) if other verbs are used (PUT for a modification for example).\n\nFor more information on how to generate and manages API tokens, please refer to the \"Kiamo Developer” guide.\n\n**Using a token**\n\nTo use an API token, you have to send it in the request headers when making the request, in format :\n\n**`Kiamo-Api-Token:[API_token]`**\n\n_Example_ :\n\n`Kiamo-Api-Token:68d27ac06e53fef962c49a4b0d18691019c3a31a`\n\nIf the API token is not sent, the Web Service will return an error 401 \"The authentication token is not valid\". This error will also occur if a token is not recognized by the API (invalid, not active, etc.) or if a token does not the rights required.\n\n## Error messages\n\nGeneric errors can be returned by the API in the following cases :\n\n### Unvalid data (code 400)\n\nList of errors returned when the data sent is unvalid :\n\n| Error code | Message |\n| --- | --- |\n| ERR_1000 | The json supplied is invalid. Fix it before trying again |\n| ERR_1010 | Json attributes are missing. Please refer to the documentation for more information |\n| ERR_1020 | Invalid arguments. Please refer to the documentation for more information |\n| ERR_1030 | Json attribute contacts is missing. Please refer to the documentation for more information |\n| ERR_1040 | Json attribute name is missing. Please refer to the documentation for more information |\n| ERR_1050 | Name field contain special chars |\n| ERR_1060 | Json attribute fields is missing. Please refer to the documentation for more information |\n| ERR_1070 | Json attribute label is missing. Please refer to the documentation for more information |\n| ERR_1080 | Json attribute datatype is invalid. Please refer to the documentation for more information |\n| ERR_1090 | Json attribute batch is missing. Please refer to the documentation for more information |\n| ERR_1100 | Json attribute service is missing. Please refer to the documentation for more information |\n| ERR_1110 | Json attribute service is invalid, bad type. Please refer to the documentation for more information |\n| ERR_1120 | Json attribute association contain invalid elements. Please refer to the documentation for more information |\n| ERR_1130 | Json attribute command is missing. Please refer to the documentation for more information |\n| ERR_1140 | Json attribute field is missing. Please refer to the documentation for more information |\n| ERR_1150 | Invalid date supplied |\n| ERR_1160 | Json attribute id is missing. Please refer to the documentation for more information |\n| ERR_1170 | Invalid keyword length |\n| ERR_1180 | Destination is required |\n| ERR_1190 | Command parameters are not valid. |\n| ERR_1200 | Unknown library file |\n| ERR_1210 | AgentLogin is invalid |\n| ERR_1220 | AgentId is invalid |\n| ERR_1230 | Destination is invalid |\n| ERR_1240 | CallbackDate is invalid |\n| ERR_1250 | Agent id is missing |\n| ERR_1260 | Note content is empty |\n| ERR_1270 | Interaction with this taskref already exists |\n\n### Impossible action (code 400)\n\nList of errors returned when the requested action is impossible:\n\n| Error code | Message |\n| --- | --- |\n| ERR_2000 | Cannot delete a base containing unfinished batches |\n| ERR_2010 | Batch must be stopped before deletion |\n| ERR_2015 | Batch has no association configured, destination is required |\n| ERR_2020 | No contact to import. Please add contact(s) before trying again |\n| ERR_2030 | Contact exists in at least one batch. Cannot be deleted |\n| ERR_2040 | Cannot update a default field |\n| ERR_2050 | Cannot delete a default field |\n| ERR_2060 | Name already in use. Please enter a new name before trying again |\n| ERR_2070 | The batch is stopped |\n| ERR_2080 | Only new batches can be renamed |\n| ERR_2090 | Cannot change state of a stopped batch |\n| ERR_2100 | Cannot set batch to this state |\n| ERR_2110 | No connector configured |\n| ERR_2120 | Connector ID must be a string |\n| ERR_2130 | Connector cannot validate ID |\n| ERR_2140 | Cannot create interactions in this service |\n| ERR_2150 | No tasks to add |\n\n### Code type 403, 404 and 405 errors\n\n| Error code | Message |\n| --- | --- |\n| ERR_2500 | Incoming calls modification is forbidden |\n| ERR_3000 | Cannot retrieve this resource. Please check if it exists |\n| ERR_3001 | Cannot retrieve this service. Please check if it exists |\n| ERR_3002 | Directory synchronization not found. Please check if it exists |\n| ERR_3003 | Directory synchronization failed |\n| ERR_3004 | LDAP search failed |\n| ERR_3100 | Method not implemented |\n\n### Specific errors (codes 500 and 503)\n\n| Error code | Message |\n| --- | --- |\n| ERR_4000 | Cannot load the configuration file. Please check if the file exists before trying again |\n| ERR_4010 | Invalid char supplied. The string contains special chars |\n| ERR_4020 | Unknown Application. Please refer to the documentation for more information |\n| ERR_4030 | Unable to retrieve remote IP address |\n| ERR_4040 | No cluster available |\n| ERR_4050 | Bad cluster IP configuration |\n| ERR_4060 | No front-end server available |\n| ERR_4080 | Internal server error |\n| ERR_4090 | An error occurred with your third-party application |\n| ERR_4100 | Bad Gateway |\n\n### Deprecated method errors\n\n| Error code | Message |\n| --- | --- |\n| ERR_5000 | agentCloseChat is deprecated and not available in JSON format, use AGENT_CLOSE_TASK instead |\n| ERR_5001 | closeAgentTask is deprecated and not available in JSON format, use AGENT_CLOSE_TASK instead |\n\n### Errors when sending messages to the Kiamo modules\n\n| Error code | Message |\n| --- | --- |\n| ERR_6000 | An error occurred in the communication with the Kiamo modules |\n| ERR_6001 | An error occurred in the communication with KFRONT |\n| ERR_6002 | An error occurred in the communication with KATE |\n| ERR_6003 | An error occurred in the communication with KLIB |\n\n### Unknown error\n\n| Error code | Message |\n| --- | --- |\n| ERR_7000 | Unknown error |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"8283488","team":452091,"collectionId":"78225e04-134e-4208-a224-db40add51de5","publishedId":"2sBXijKC5r","public":true,"publicUrl":"https://apiv2.developer.mykiamo.com","privateUrl":"https://go.postman.co/documentation/8283488-78225e04-134e-4208-a224-db40add51de5","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2026-03-23T13:12:15.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"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/b6512039a04f8d0a6f698a7afe6bd179bbff0bea2823a01515e8133e60ef2fce","favicon":"https://mykiamo.com/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"}],"canonicalUrl":"https://apiv2.developer.mykiamo.com/view/metadata/2sBXijKC5r"}