Next generation of Kiamo APIs, delivered in seperate packages, totally independent from Kiamo.
\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.
\nNote: The API token is string of 40 hexadecimal characters generated previously by Kiamo.
\nToken example
\n68d27ac06e53fef962c49a4b0d18691019c3a31a
Obtaining a token
\nYou can obtain an API token via the token generation page in the Kiamo administration interface (in the Development > API tokens menu).
\nFrom this interface, you can:
\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).
\nUsing a token
\nTo use an API token, you have to send it in the request headers when making the request, in format :
\nKiamo-Api-Token:[API_token]
Example:
\nKiamo-Api-Token:68d27ac06e53fef962c49a4b0d18691019c3a31a
If 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","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8283488","collectionId":"491cd74a-157e-4d74-a405-2b8c382b91b2","publishedId":"TzefB3oo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6633"},"publishDate":"2025-03-19T13:54:44.000Z"},"item":[{"name":"activities","item":[{"name":"planning","item":[{"name":"Create Activity Planning","id":"c3823875-bba0-45e9-ba66-c5f062434b65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Kiamo-Api-Token","type":"text","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"periods\": [ \r\n {\r\n \"startTime\": \"2020-11-19T10:00:00Z\",\r\n \"endTime\": \"2020-11-19T11:00:00Z\"\r\n }\r\n ],\r\n \"activities\": [ 2, 3 ],\r\n \"agents\": [ 1, 4 ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{kiamoUrl}}/api/{{apiVersion}}/activities/planning","description":"The body of an activity planning contains:
\n{\n \"periods\": [\n (...)\n ],\n \"activities\": [ \n ,\n (...)\n ],\n \"agents\": [\n ,\n (...)\n ]\n}\n\nperiods is a non-empty (mandatory) array of activity periods,
\nA period is described as a dictionary of 2 dates where:
\ndates are ISO 8601 standard UTC date strings (\"YYYY-MM-DDTHH:MM:SSZ\"),
\nminutes for these dates can only be:'00', '15', '30' ou '45',
\nseconds are ignored,
\nthe startTime field indicates the quarter of an hour used to start,
\nthe endTime indicates the last minute of the period,
\n {\n \"startTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"endTime\": \"YYYY-MM-DDTHH:MM:SSZ\"\n }\n\nExample : period of 60 minutes, from 10:00 to 11:00 UTC :
\n {\n \"startTime\": \"2020-11-19T10:00:00Z\",\n \"endTime\": \"2020-11-19T11:00:00Z\"\n }\n\nactivities is a non-empty (mandatory) array of activity IDs,
\nagents is a non-empty (mandatory) array of agent IDs.
\nIf the query is successful, the list of plannings created, period by period, activity by activity, agent by agent, is returned.
\n[\n {\n \"period\": {\n \"startTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"endTime\": \"YYYY-MM-DDTHH:MM:SSZ\"\n },\n \"activity\": , \n \"agent\": \n },\n (...)\n]\n\nExample:
\n{\n \"code\": \"ERR_1010\",\n \"info\": \"Json attributes are missing periods\"\n}\n\nYou can read the planned activities for a list of agents, a team or a group.
\nAn activity planning reading is described as:
\n{\n \"periods\": [ (...) ],\n \"activities\": [ , (...) ],\n \"agents\": [ , (...) ]\n}\n\nor
\n{\n \"periods\": [ (...) ],\n \"activities\": [ , (...) ],\n \"team\": \n}\n\nor
\n{\n \"periods\": [ (...) ],\n \"activities\": [ , (...) ],\n \"group\": \n}\n\nperiods is a non-empty (mandatory) array of activity periods,
\nA period is described as a dictionary of two dates where:
\nactivities is an array that can be empty (if so, all activities matching the reading criteria will be returned),
\nthe target can be a list of agents, a team or a group with:
\nIf the query is successful, the list of all activity plannings matching the search criteria, period by period, activity by activity, agent by agent, is returned (empty list if no match).
\n[\n {\n \"period\": {\n \"startTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"endTime\": \"YYYY-MM-DDTHH:MM:SSZ\"\n },\n \"activity\": , \n \"agent\": \n },\n (...)\n]\n\nExample:
\n{\n \"code\": \"ERR_1010\",\n \"info\": \"Json attributes are missing periods\"\n}\n\nYou can delete planned activities for a list of agents, a team or a group.
\nDeletion of a planned activity is described as:
\n{\n \"periods\": [ (...) ],\n \"activities\": [ , (...) ],\n \"agents\": [ , (...) ]\n}\n\nor
\n{\n \"periods\": [ (...) ],\n \"activities\": [ , (...) ],\n \"team\": \n}\n\nor
\n{\n \"periods\": [ (...) ],\n \"activities\": [ , (...) ],\n \"group\": \n}\n\nperiods is a non-empty (mandatory) array of activity periods,
\na period is described as a dictionary of two dates where:
\ndates are ISO 8601 standard UTC date strings (\"YYYY-MM-DDTHH:MM:SSZ\"),
\nminutes for these dates can only be:'00', '15', '30' ou '45',
\nseconds are ignored,
\nthe startTime field indicates the quarter of hour to start,
\nthe endTime indicates the last minute of the period,
\n {\n \"startTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"endTime\": \"YYYY-MM-DDTHH:MM:SSZ\"\n }\n\nactivities is an array that can be empty (if so, all activities matching the reading criteria will be returned),
\ntarget can be a list of agents, a team or a group with:
\nIf the query is successful, the return code is 204 - No Contents.
\nExample:
\n{\n \"code\": \"ERR_1010\",\n \"info\": \"Json attributes are missing periods\"\n}\n\nPlanning of agents' activities
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"ee2b965d-5202-4e80-b8d8-f1f6194ce4ea"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"18fbfeaa-c3fe-4d16-a389-7ad331bd148e"}}],"_postman_id":"b61e9c4e-37ab-4a77-8536-fbea34fd4954"}],"id":"9344ca1a-c458-40da-8f84-a41e0b595ae4","description":"Management of agents' activities
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"7559c11c-1439-4c92-8a83-1ea362a3ad26"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"9d7e2ffd-e7bc-4adc-8eb6-e93398bd9bd0"}}],"_postman_id":"9344ca1a-c458-40da-8f84-a41e0b595ae4"},{"name":"load balancing","item":[{"name":"Get Host","id":"fcc28ba0-1917-4c57-beeb-8e2d714768a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{kiamoUrl}}/api/{{apiVersion}}/load-balancing/{{app}}","description":"* app: application for which you want to request a host (e.g.: \"kiwi\", \"supervision\", \"supervision-api'\" \"agent-api\")
\n* agent's last name;
* agent's login: this login must be unique.
* agent's group: ID of a group that is available in Kiamo.
* password. It must be in clear text. It will be coded when saved.
\n* must_update_password. It must be a boolean. False by default.
\n* email address.
\n* team: ID of a team that is available in Kiamo.
\n*language. If it is not specified then the default language will be used.
\n* timezone. If it is not specified then the default timezone will be used: it is the timezone of the agent's group.
\nThis verb is used to change one or more of the following agent attributes:
\nThis API can be used starting with Kiamo 8.2.0.
\nAgent creation, modification or deletion.
\n","_postman_id":"95c9ff23-2351-4eb7-9422-5fa1a5529bc2"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"a0b828cb-d55b-4199-979c-47e277e4f739"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"abe25e26-a114-49cd-9110-c2d64c469889"}}]}