{"info":{"_postman_id":"78225e04-134e-4208-a224-db40add51de5","name":"Kiamo API v2","description":"

Operation Principles

API Tokens

For 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.

Remark : The API token is string of 40 hexadecimal characters generated previously by Kiamo.

Token example

68d27ac06e53fef962c49a4b0d18691019c3a31a

Obtaining a token

You can obtain an API token via the token generation page in the Kiamo administration interface (in the Developer > API > Tokens menu).

From this interface, you can:

generate a token for one or more APIs: Agent, Contact Manager, Interaction, Supervision and/or Task.
\n
manage the existing tokens, modify their labels or disable them without deleting them, however.
\n
manage the various rights provided by the token. These rights concern the request types (GET, POST, PUT and DELETE).
\n

By 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).

For more information on how to generate and manages API tokens, please refer to the \"Kiamo Developer” guide.

Using a token

To use an API token, you have to send it in the request headers when making the request, in format :

Kiamo-Api-Token:[API_token]

Example :

Kiamo-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.

Error messages

Generic errors can be returned by the API in the following cases :

Unvalid data (code 400)

List of errors returned when the data sent is unvalid :

Error code	Message
ERR_1000	The json supplied is invalid. Fix it before trying again
ERR_1010	Json attributes are missing. Please refer to the documentation for more information
ERR_1020	Invalid arguments. Please refer to the documentation for more information
ERR_1030	Json attribute contacts is missing. Please refer to the documentation for more information
ERR_1040	Json attribute name is missing. Please refer to the documentation for more information
ERR_1050	Name field contain special chars
ERR_1060	Json attribute fields is missing. Please refer to the documentation for more information
ERR_1070	Json attribute label is missing. Please refer to the documentation for more information
ERR_1080	Json attribute datatype is invalid. Please refer to the documentation for more information
ERR_1090	Json attribute batch is missing. Please refer to the documentation for more information
ERR_1100	Json attribute service is missing. Please refer to the documentation for more information
ERR_1110	Json attribute service is invalid, bad type. Please refer to the documentation for more information
ERR_1120	Json attribute association contain invalid elements. Please refer to the documentation for more information
ERR_1130	Json attribute command is missing. Please refer to the documentation for more information
ERR_1140	Json attribute field is missing. Please refer to the documentation for more information
ERR_1150	Invalid date supplied
ERR_1160	Json attribute id is missing. Please refer to the documentation for more information
ERR_1170	Invalid keyword length
ERR_1180	Destination is required
ERR_1190	Command parameters are not valid.
ERR_1200	Unknown library file
ERR_1210	AgentLogin is invalid
ERR_1220	AgentId is invalid
ERR_1230	Destination is invalid
ERR_1240	CallbackDate is invalid
ERR_1250	Agent id is missing
ERR_1260	Note content is empty
ERR_1270	Interaction with this taskref already exists

Impossible action (code 400)

List of errors returned when the requested action is impossible:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error code	Message
ERR_2000	Cannot delete a base containing unfinished batches
ERR_2010	Batch must be stopped before deletion
ERR_2015	Batch has no association configured, destination is required
ERR_2020	No contact to import. Please add contact(s) before trying again
ERR_2030	Contact exists in at least one batch. Cannot be deleted
ERR_2040	Cannot update a default field
ERR_2050	Cannot delete a default field
ERR_2060	Name already in use. Please enter a new name before trying again
ERR_2070	The batch is stopped
ERR_2080	Only new batches can be renamed
ERR_2090	Cannot change state of a stopped batch
ERR_2100	Cannot set batch to this state
ERR_2110	No connector configured
ERR_2120	Connector ID must be a string
ERR_2130	Connector cannot validate ID
ERR_2140	Cannot create interactions in this service
ERR_2150	No tasks to add

Code type 403, 404 and 405 errors

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error code	Message
ERR_2500	Incoming calls modification is forbidden
ERR_3000	Cannot retrieve this resource. Please check if it exists
ERR_3001	Cannot retrieve this service. Please check if it exists
ERR_3002	Directory synchronization not found. Please check if it exists
ERR_3003	Directory synchronization failed
ERR_3004	LDAP search failed
ERR_3100	Method not implemented

Specific errors (codes 500 and 503)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error code	Message
ERR_4000	Cannot load the configuration file. Please check if the file exists before trying again
ERR_4010	Invalid char supplied. The string contains special chars
ERR_4020	Unknown Application. Please refer to the documentation for more information
ERR_4030	Unable to retrieve remote IP address
ERR_4040	No cluster available
ERR_4050	Bad cluster IP configuration
ERR_4060	No front-end server available
ERR_4080	Internal server error
ERR_4090	An error occurred with your third-party application
ERR_4100	Bad Gateway

Deprecated method errors

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error code	Message
ERR_5000	agentCloseChat is deprecated and not available in JSON format, use AGENT_CLOSE_TASK instead
ERR_5001	closeAgentTask is deprecated and not available in JSON format, use AGENT_CLOSE_TASK instead

Errors when sending messages to the Kiamo modules

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error code	Message
ERR_6000	An error occurred in the communication with the Kiamo modules
ERR_6001	An error occurred in the communication with KFRONT
ERR_6002	An error occurred in the communication with KATE
ERR_6003	An error occurred in the communication with KLIB

Unknown error

\n\n\n\n\n\n\n\n\n\n\n\n\n

Error code	Message
ERR_7000	Unknown error

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Operation Principles","slug":"operation-principles"}],"owner":"8283488","collectionId":"78225e04-134e-4208-a224-db40add51de5","publishedId":"2sBXijKC5r","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-03-23T13:12:15.000Z"},"item":[{"name":"agents","item":[{"name":"state","item":[{"name":"Update Agent State","id":"dcaee8f7-8304-411b-946a-71037fd06b21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_STATE_REQUEST\",\n\t\"params\": {\n\t\t\"state_id\": 20\n\t}\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Change the status of an agent

The possible call parameters in the \"params\" object are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Required?	Description
state_id	number	Yes	ID of the status to which you want to switch the agent. Remark : You can switch agent to one of the following statuses : Break, Ready, customized work and break states.

","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"1284eea1-1494-478f-951d-df71712b3456","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"b73ffb1e-7b31-42ca-8e52-993709146bd2","name":"Update Agent State","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_STATE_REQUEST\",\n\t\"params\": {\n\t\t\"state_id\": 20\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"dcaee8f7-8304-411b-946a-71037fd06b21"},{"name":"Logout Agent","id":"7caa4792-04b0-46c1-80e0-fd314cda10d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_LOGOUT\"\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Disconnect an agent

\n","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"ecbf873e-be18-435b-b5e6-1ccfdcc5995e","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"43da8e2b-eabe-416e-a1d5-ec35c67a95ba","name":"Logout Agent","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_LOGOUT\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7caa4792-04b0-46c1-80e0-fd314cda10d1"}],"id":"6165421b-a3d9-4ed9-8422-0c27dd0bd3ae","_postman_id":"6165421b-a3d9-4ed9-8422-0c27dd0bd3ae","description":""},{"name":"calls","item":[{"name":"customer","item":[{"name":"Dial Agent Call","id":"179a110c-c236-4635-b662-43826adc24d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_DIAL\",\n\t\"params\": {\n\t\t\"called_number\": \"3351\",\n\t\t\"service_id\": 4\n\t}\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Make a call

The possible call parameters in the \"params\" (REST) object are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Required?	Description
called_number	number	Yes	Phone number of the person to be called. Remark : If the phone number contains prohibited characters (e.g. special characters, letters, etc.), they will be deleted automatically.
service_id	number	No	ID of the service in which the phone call must be triggered. Caution : If several agent out call services are available, this parameter must be entered.

","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"30996480-30a8-4bf4-b5f0-4bc13da2751c","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"843b4537-3109-4635-a9e8-9d1ecca4d811","name":"Dial Agent Call","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_DIAL\",\n\t\"params\": {\n\t\t\"called_number\": \"055657892526\",\n\t\t\"service_id\": 4\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f1410283-faa2-4e14-9cdd-e6b0de3efb5f","name":"Error : call license","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_DIAL\",\n\t\"params\": {\n\t\t\"called_number\": \"3351\",\n\t\t\"service_id\": 4\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{ \r\n \"api\":\"AGENT\", \r\n \"event\":\"AGENT_ERROR_MESSAGE\", \r\n \"ref\":23, \r\n \"data\":{ \r\n \"error_message\":\"you_dont_have_call_license\"\r\n }\r\n}"},{"id":"11ac4d2c-fb55-4c8e-9fb1-08dcfbdcc3f0","name":"Error : customer line busy","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_DIAL\",\n\t\"params\": {\n\t\t\"called_number\": \"055657892526\",\n\t\t\"service_id\": 4\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"api\": \"AGENT\",\n \"event\": \"AGENT_CALL_RESULT\",\n \"ref\": 23,\n \"data\": {\n \"task_ref\":100053, \n \"result\":\"cust_busy\"\n }\n}"}],"_postman_id":"179a110c-c236-4635-b662-43826adc24d2"},{"name":"Hold Customer Call","id":"e57a7cf0-f0af-4ae3-bb65-39835d3a9f35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_HOLD\"\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Put a call on hold

This command is used to put the customer call on hold while the customer is talking to an agent.

\n","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"a6beeddb-50e2-4e4b-a6b5-146848f86c42","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"cb4fcc2a-005f-405b-a138-cd63060f263c","name":"Hold Customer Call","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_HOLD\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e57a7cf0-f0af-4ae3-bb65-39835d3a9f35"},{"name":"Resume Customer Call","id":"23df2c61-4c7c-4f8c-903b-71abbf54471d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_RETRIEVE\"\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Resume a call

This command is used to resume the call between the caller and an agent, after a consultation call.

\n","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"a3b36933-6b1e-4322-b149-653e80ea74c1","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"b3049c33-7364-414e-9a11-ac552325bd5e","name":"Resume Customer Call","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_RETRIEVE\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"23df2c61-4c7c-4f8c-903b-71abbf54471d"},{"name":"Transfer Number Agent Call","id":"537e106a-8f92-4bc1-b3c3-384ec2313791","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_TRANSFER_NUMBER\",\n\t\"params\": {\n\t\t\"called_number\": \"3351\"\n\t}\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Blindly transfer a call to a number

This command allows an agent making a call to transfer a call to a number without previously consulting the number.

Remark : If it is an external number, the conversations are no longer managed by Kiamo.

The possible call parameters in the \"params\" object are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Required?	Description
called_number	number	Yes	Phone number to which the call must be transferred. Remark : If the phone number contains prohibited characters (e.g. special characters, letters, etc.), they will be deleted automatically.

","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"519a61a6-d4d2-4571-a8b6-6a49262a57cc","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"7d329c05-8c03-4753-9cce-b2799b27d388","name":"Transfer Number Agent Call","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_TRANSFER_NUMBER\",\n\t\"params\": {\n\t\t\"called_number\": \"0123456789\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"537e106a-8f92-4bc1-b3c3-384ec2313791"},{"name":"Transfer Service Agent Call","id":"7bc5497c-2a0a-438d-9b12-8efccdf1bd06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_TRANSFER_SERVICE\",\n\t\"params\": {\n\t\t\"service_id\": 2, \n\t\t\"required_agent_id\": 2\n\t}\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Transfer a call to a service

This command is used to transfer an agent's call to an inbound call campaign type service, internal service or inbound call IVR.

The possible call parameters in the \"params\" object are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Required?	Description
service_id	number	Yes	ID of the service to which the call must be transferred. Caution : A call can only be transferred to an inbound call campaign type service, internal service or inbound call IVR.
required_agent_id	number	No	ID of the agent required to handle the transferred call.

","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"a033ad60-a711-444d-a3c8-e4eb020ff6c9","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"9a7a864f-739e-43b6-bf6f-dcd2fa852ef8","name":"Transfer Service Agent Call","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_TRANSFER_SERVICE\",\n\t\"params\": {\n\t\t\"service_id\": 5, \n\t\t\"required_agent_id\": 15\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7bc5497c-2a0a-438d-9b12-8efccdf1bd06"},{"name":"Disconnect Customer Call","id":"c4cbc42f-2cdf-4361-889e-cf00a937d592","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_DISCONNECT\"\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Hang up a customer call

This command is used, during a call between a customer and an agent, to hang up the customer's set.

\n","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"ef84753f-cdf9-4d28-bef3-d41027621340","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"cd6cc471-a1ea-4af1-8ea6-e6c512655fea","name":"Disconnect Customer Call","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_DISCONNECT\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c4cbc42f-2cdf-4361-889e-cf00a937d592"},{"name":"Disconnect Agent Call","id":"bb6a6eb1-cb81-46bc-a866-f0ea8957b67d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_DISCONNECT\"\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Hang up an agent call

This command is used, during a call between a customer and an agent, to hang up the agent's set.

\n","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"e7d5b06a-27a8-410f-985d-a0509346aaf2","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"ab5d461e-fd3f-477c-801a-2b478bc6036e","name":"Disconnect Agent Call","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_DISCONNECT\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"bb6a6eb1-cb81-46bc-a866-f0ea8957b67d"},{"name":"Answer Preview","id":"4308e48d-568a-400e-8c28-f395d6f4f6a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_ANSWER_PREVIEW\",\n\t\"params\": {\n\t\t\"answer\": \"REFUSED\"\n\t}\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Answer a preview

During an outbound call campaign, this command is used to accept or refuse a preview offered to an agent.

The possible call parameters in the \"params\" object are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Required?	Description
answer	string	Yes	Possible values of the answer to the preview : ✓ ACCEPTED ✓ REFUSED ✓ TIMEOUT: to be answered if the duration allocated to the agent to answer the preview is exceeded.

","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"1328a78d-6674-4b1e-84d9-cea6edf8191e","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"529efe77-a2fb-4715-9f31-b68070954461","name":"Answer Preview","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_ANSWER_PREVIEW\",\n\t\"params\": {\n\t\t\"answer\": \"REFUSED\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4308e48d-568a-400e-8c28-f395d6f4f6a5"}],"id":"98a3c28f-5cd1-40a0-88ac-e608fc929e9e","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"5f046dc9-9397-43b4-b28f-bf75ed224949"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"40f2d3dc-0edc-462a-9ebd-30420fc732da"}}],"_postman_id":"98a3c28f-5cd1-40a0-88ac-e608fc929e9e","description":""},{"name":"consult","item":[{"name":"Dial Consult Call","id":"7c262c30-fd05-45aa-95fe-20d05b7105e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CONSULT_DIAL\",\n\t\"params\": {\n\t\t\"called_number\": \"3351\"\n\t}\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Consult a number

This command allows an agent who is already talking to consult an external number or an agent.

The possible call parameters in the \"params\" object are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Required?	Description
called_number	number	Yes	Phone number that the agent wants to consult. Remark : If the phone number contains prohibited characters (e.g. special characters, letters, etc.), they will be deleted automatically.

","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"2e409650-35e6-4e6a-8ed2-ab8b677e2dcf","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"ecd076f1-3f70-4e59-a8f0-9a946d0af2cd","name":"Dial Consult Call","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CONSULT_DIAL\",\n\t\"params\": {\n\t\t\"called_number\": \"0542132456\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7c262c30-fd05-45aa-95fe-20d05b7105e3"},{"name":"Hold Consult Call","id":"1135fda1-4f14-48a1-996a-e3eadcd476a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CONSULT_CALL_HOLD\"\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Put the consulted call on hold

During a consultation call between an agent and another agent/consulted number, this command is used to put the consulted set on hold.

\n","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"7f1ab5dd-b3eb-410e-8913-3bae2c81aef6","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"f1584618-8642-48c3-a64d-23455a9e44ad","name":"Hold Consult Call","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CONSULT_CALL_HOLD\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1135fda1-4f14-48a1-996a-e3eadcd476a6"},{"name":"Resume Consult Call","id":"aa854b74-52f0-45c5-ad2b-c2852cbb3049","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CONSULT_CALL_RETRIEVE\"\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Resume the consulted call

This command is used to return to an agent the consulted call previously put on hold.

\n","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"fcf5b647-1e64-4a25-81a3-6ec4fc5ba7f9","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"e5338918-61e4-4f77-9bc5-18b1cd075a58","name":"Resume Consult Call","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CONSULT_CALL_RETRIEVE\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"aa854b74-52f0-45c5-ad2b-c2852cbb3049"},{"name":"Transfer Consult Call","id":"0c86f5d7-f27c-4ef7-98d8-3cc40fd71489","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_TRANSFER\"\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Transfer a call

This command is used to transfer the agent-customer call to an external number or to another agent.

Remark : The agent must have previously made a consultation call :

if consulting an external number, the command is used to transfer the call to this number;
if consulting another agent, the command is used to transfer the call to this agent.

\n","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"2247089f-b235-4c1c-989f-c09592b2a795","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"7f6ed9e1-336c-482c-b141-5a77d75519b0","name":"Transfer Consult Call","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_TRANSFER\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"0c86f5d7-f27c-4ef7-98d8-3cc40fd71489"},{"name":"Conference Consult Call","id":"cfb056c6-9803-4fed-9851-759256a25f3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CONFERENCE\"\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Set up a conference call

This command is used to set up a conference call between the caller, the agent called and the consulted set.

Remark : The agent must have previously made a consultation call in order to set up a conference call between these 3 persons.

\n","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"5ab55ec0-a14f-4f5a-bc56-11a54a264347","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"cf906560-b885-49b9-afeb-4efb228bc567","name":"Conference Consult Call","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CONFERENCE\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"cfb056c6-9803-4fed-9851-759256a25f3c"},{"name":"Disconnect Consult Call","id":"02fc71fd-1f63-4ff7-a956-030c3020b9cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CONSULT_CALL_DISC\"\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Hang up a consultation call

During a consultation call between an agent and another agent/consulted number, this command is used to hang up the consulted set.

\n","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"8c2ced07-1f47-4bc0-babe-6ffeab0a0509","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"3ac846fb-c739-4d87-a4a4-15880c2c8380","name":"Disconnect Consult Call","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CONSULT_CALL_DISC\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"02fc71fd-1f63-4ff7-a956-030c3020b9cf"}],"id":"3ec48be7-31f5-4227-8a6e-4e1fd0d74de2","_postman_id":"3ec48be7-31f5-4227-8a6e-4e1fd0d74de2","description":""},{"name":"record","item":[{"name":"Record Agent Call","id":"eae95afc-f296-42d4-9282-f458109ece51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_RECORD\"\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Record a call

This command is used to start the recording of an agent's current call.

\n","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"45f5ee7f-5fdb-4d91-ae63-7049cd36b681","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"5c380994-442d-4aca-b82e-fff5424f412a","name":"Record Agent Call","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_RECORD\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"eae95afc-f296-42d4-9282-f458109ece51"},{"name":"Pause Agent Call Record","id":"78984973-1cf2-4b86-b64c-0610f12fa9de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_PAUSE_RECORD\"\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Pause a recording

This command is used to pause the recording of an agent's current call.

\n","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"ad9db0f1-18ec-47f3-9d4e-1e7f5df2cd5b","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"ca1818d7-c74d-418e-b6d7-53f126927e62","name":"Pause Agent Call Record","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_PAUSE_RECORD\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"78984973-1cf2-4b86-b64c-0610f12fa9de"},{"name":"Keep Agent Call Record","id":"600ceb1f-62be-46fa-92a9-b6d995a63f35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_KEEP_RECORD\"\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Keep a recording

This command is used to force the keeping of a recording.

\n","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"cdb012cf-3339-41d3-97b3-abdf005cce07","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"2253d3ff-c3a2-4004-8e4b-e0eee815bfff","name":"Keep Agent Call Record","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_KEEP_RECORD\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"600ceb1f-62be-46fa-92a9-b6d995a63f35"},{"name":"Delete Agent Call Record","id":"3b89566d-fe64-47de-ac76-abe0ecf55a3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_DELETE_RECORD\"\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Cancel a recording

This command is used to cancel the recording of an agent's current call.

\n","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"dbb7a4c4-d6de-4883-b5e0-29edb7c58f36","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"b29eef08-202b-46cc-9ce3-c2fd317541bb","name":"Delete Agent Call Record","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CALL_DELETE_RECORD\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3b89566d-fe64-47de-ac76-abe0ecf55a3c"}],"id":"c51effe1-b10d-4996-ae53-9102298b71b5","_postman_id":"c51effe1-b10d-4996-ae53-9102298b71b5","description":""}],"id":"e3ea86f4-8f1f-4fad-9cb8-1b27a16d4d76","_postman_id":"e3ea86f4-8f1f-4fad-9cb8-1b27a16d4d76","description":""},{"name":"emails","item":[{"name":"Create Agent Mail","id":"ebc2ebb4-e749-4057-90f9-808ce87c1140","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_MAIL_REQUEST\",\n\t\"params\": {\n\t\t\"mail_address\": \"asoulard@kiamo.fr\",\n\t\t\"service_id\": 7\n\t}\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Request a new agent out email

This command is used to open a new agent out email or create a new draft on the agent's computer.

The possible call parameters in the \"params\" object are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Required?	Description
mail_address	string	Yes	Recipient's email address.
service_id	number	No	Agent out email service to be used.

","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"9b4340cb-ee7d-4532-b7e2-0d368c03b2bc","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"90d0f747-de1a-40b8-b138-f37391af03d1","name":"Create Agent Mail","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_MAIL_REQUEST\",\n\t\"params\": {\n\t\t\"mail_address\": \"recipient_name@company.com\",\n\t\t\"service_id\": 18\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ebc2ebb4-e749-4057-90f9-808ce87c1140"}],"id":"199a4cca-fb78-496e-a821-370d8ab98e7d","_postman_id":"199a4cca-fb78-496e-a821-370d8ab98e7d","description":""},{"name":"tasks","item":[{"name":"Reopen Agent Task","id":"c4392752-89ff-4f08-a563-b96c8ca7b630","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_REOPEN_TASK\",\n\t\"params\": {\n\t\t\"task_ref\": 100007,\n\t\t\"service_id\": 7\n\t}\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Reopen a closed email

This command is used to reopen a closed inbound email.

The possible call parameters in the \"params\" object are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Required?	Description
task_ref	number	Yes	Interaction ID.
service_id	number	Yes	Inbound email service in which the email to be reopened had been closed.

","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"93b5034b-0f94-4f9f-830b-7e01e82bab86","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"7f5a9bc0-93de-4081-b2d3-26c0cdbf1281","name":"Reopen Agent Task","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_REOPEN_TASK\",\n\t\"params\": {\n\t\t\"task_ref\": 100007,\n\t\t\"service_id\": 7\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c4392752-89ff-4f08-a563-b96c8ca7b630"},{"name":"Transfer Agent Task","id":"7d4a1b9d-8435-40b3-9c97-abcd1b6284e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_TRANSFER_SERVICE\",\n\t\"params\": {\n\t\t\"task_ref\": 100200,\n\t\t\"service_id\": 5\n\t}\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Transfer a Messaging-type interaction

This command is used to transfer a Messaging-type interaction to an Inbound message-type service.

The possible call parameters in the \"params\" object are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Required?	Description
task_ref	number	Yes	Interaction ID.
service_id	number	Yes	ID of the service to which the Messaging-type interaction should be transferred. Caution : Messaging-type interactions can only be transferred to Inbound message-type services.

","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"6431afa5-e4bc-46e6-bcc6-ca46beca089b","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"6eca64c6-1473-455e-9ba8-43e15a7a03e2","name":"Transfer Agent Task","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_TRANSFER_SERVICE\",\n\t\"params\": {\n\t\t\"task_ref\": 100200,\n\t\t\"service_id\": 5\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7d4a1b9d-8435-40b3-9c97-abcd1b6284e4"},{"name":"Postpone Agent Task","id":"7b73c6b2-cf54-402c-b6a7-b9bd64f82f5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_POSTPONE_TASK\",\n\t\"params\": {\n\t\t\"required_agent_id\": 1\n\t}\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Postpone an interaction

This command is used to postpone the interaction currently presented to an agent: call, email, Messaging-type interaction, customized task, etc.

The possible call parameters in the \"params\" object are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Required?	Description
required_agent_id	number	Yes	ID of the agent required to process the postponed task. Remark : If no agent is required, use NONE.

","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"dd548090-f10b-463a-9ed5-cde92eab09ce","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"807fe362-91b6-4aa6-8555-7442aee176f4","name":"Postpone Agent Task","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_POSTPONE_TASK\",\n\t\"params\": {\n\t\t\"required_agent_id\": 32\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7b73c6b2-cf54-402c-b6a7-b9bd64f82f5c"},{"name":"Close Agent Task","id":"05b72610-bcd7-45a5-a8df-b77eef5cd0e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CLOSE_TASK\",\n\t\"params\": {\n\t\t\"task_ref\": 100051\n\t}\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Close an interaction

This command is used to close the interaction (call, email, Messaging-type interaction, customized task, chat session, etc.) currently handled by the agent.

The possible call parameters in the \"params\" object are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Required?	Description
task_ref	number	Yes	Interaction ID.

","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"68a5bc78-a6f6-4bf3-a6f4-2e85f359f43c","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"cbddaa26-cbd3-4f3a-b143-22a21bb95571","name":"Close Agent Task","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_CLOSE_TASK\",\n\t\"params\": {\n\t\t\"task_ref\": 101256\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"05b72610-bcd7-45a5-a8df-b77eef5cd0e1"}],"id":"06fb1e4e-3b71-45aa-8d22-cfecf04942ce","_postman_id":"06fb1e4e-3b71-45aa-8d22-cfecf04942ce","description":""},{"name":"popup","item":[{"name":"Create Manual Popup","id":"f6545373-0ac2-4d17-9e58-08712d01df39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_MANUAL_POPUP_REQUEST\",\n\t\"params\": {\n\t\t\"popup_id\": 2\n\t}\n}"},"url":"{{api_base_url}}/agents/:id","description":"

Request a manual screen pop-up

This command is used to trigger the opening of a manual screen pop-up in the agent's Kiwi application.

The possible call parameters in the \"params\" object are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Required?	Description
popup_id	number	Yes	ID of the manual screen pop-up.

","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"30759e90-4b97-4210-bca5-bf4eb4d917c4","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"d35ff43f-3698-48c7-b3c2-cbe0bbb48a6d","name":"Create Manual Popup","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_MANUAL_POPUP_REQUEST\",\n\t\"params\": {\n\t\t\"popup_id\": 15\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f6545373-0ac2-4d17-9e58-08712d01df39"}],"id":"7617d1b1-a090-47d6-b15a-4b3a7160fc24","_postman_id":"7617d1b1-a090-47d6-b15a-4b3a7160fc24","description":""},{"name":"messaging","item":[{"name":"ouverture d'un slot","id":"18c01f04-d158-431d-9542-7d3a7694a6e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_OPEN_SLOT\"\n}"},"url":"{{api_base_url}}/agents/:id","description":"

permettre à l’agent de se rendre disponible pour la distribution d’une conversation supplémentaire (ouverture d’un nouveau “slot”)

\n","urlObject":{"path":["agents",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"a3427c6f-02da-4bbd-911c-aa95fc435084","description":{"content":"

Agent Id

\n","type":"text/plain"},"type":"any","value":"{{agent_id}}","key":"id"}]}},"response":[{"id":"44f8ca98-7c47-4bd3-9b87-ae2fb1bd888e","name":"ouverture d'un slot ","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_agents}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"command\": \"AGENT_OPEN_SLOT\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/agents/:id","host":["{{api_base_url}}"],"path":["agents",":id"],"variable":[{"key":"id","value":"{{agent_id}}","description":"Agent Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"18c01f04-d158-431d-9542-7d3a7694a6e1"}],"id":"cfbeaf71-752e-4e35-95ef-a0c1917894b6","_postman_id":"cfbeaf71-752e-4e35-95ef-a0c1917894b6","description":""}],"id":"6e5a347b-74c2-4b27-b3cf-3044ea146b21","description":"

AGENTS API

The following commands are the verbs composing the Kiamo Agents API in REST / JSON format.

Remark : a more complete ansynchronous Agent API exists, based on events and TCP socket connection to the Kiamo Front component. The related documentation is available on demand.

JSON format of REST commands

Commands are sent to the server in TCP with a POST HTTP header.

POST HTTP://kiamo_address/api/v2/agents/{agentId}

The message body contains the commands to be sent.
Once the request has been sent, the API returns a JSON flow containing the answer.

Commands have the following format:

{ \n  \"command\":\"<command to be sent>\", \n  \"params\":{ \n    \"a_param\":\"<parameter1>\", \n    etc. \n  } \n}\n\n

The list of possible call parameters is as follows :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data Type	Required?	Description
command	string	Yes	Command to be sent to the server.
params	object	No	Object containing the list of request parameters. This variable part of the request depends on each command. Several \"params\" objects are allowed, in order to make a series of commands with different parameters.

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"ce91e651-8021-4612-8f09-30b214a847e3"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"eacba4dc-bf68-4f5c-b150-583056bf844b"}}],"_postman_id":"6e5a347b-74c2-4b27-b3cf-3044ea146b21"},{"name":"build","item":[{"name":"activity planning","item":[{"name":"Plan Agent Activities","id":"2932530d-95e4-4e4f-b512-5b3256a3d1b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_activity_planning}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"periods\": [{\r\n \"startTime\": \"2021-03-01T12:00:00+00:00\",\r\n \"endTime\": \"2021-03-31T12:00:00+00:00\"\r\n }],\r\n \"activities\": [1,2,3],\r\n \"agents\": [1]\r\n}"},"url":"{{api_base_url_v3}}/activities/planning","description":"

Plan agent activities.

The JSON body is composed of the following parameters :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Required?	Data type	Description
period	Yes	Period	Activity period (see upper)
activities	Yes	string (non empty)	List of activity IDs ex : activities=1,2,3
agents	Yes	string (non empty)	List of agent IDs ex : agents=1,2,3

In case of success, the response contains the complete list of planifications as shown below, sorted first by agent ID, second by activity ID.

Response example :

[\n    {\n        \"period\": <Period>,\n        \"activity\": {\n            \"id\": <activity_id>\n        }, \n        \"agent\": {\n            \"id\": <agent_id>\n        }\n    },\n    (...)\n]\n

\n","urlObject":{"path":["activities","planning"],"host":["{{api_base_url_v3}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2932530d-95e4-4e4f-b512-5b3256a3d1b6"},{"name":"Get Activity Planning","id":"c59531d9-aa4e-4863-b1d6-984018dd18ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_activity_planning}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"periods\": [{\r\n \"startTime\": \"2021-03-01T12:00:00+00:00\",\r\n \"endTime\": \"2021-03-31T12:00:00+00:00\"\r\n }],\r\n \"activities\": [1,2,3],\r\n \"group\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_base_url_v3}}/activities/planning","description":"

Get existing activity planning.

As it is a GET request, the parameters must be set in the request URL. The parameters are the following :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Required?	Data type	Description
period	Yes	Period	Activity period (see upper)
activities	No	string	Acts as a filter. List of target activity IDs ex : activities=1,2,3 Remark: if the parameter is not present or if the list is empty, all the related activities will be returned.
agents	No	string	Acts as a filter. List of target agent IDs ex : agents=1,2,3 Remark: if the parameter is not present or if the list is empty, all the related agents will be returned.
team	No	int	Acts as a filter. Target team ID Remark: if this parameter is present, all the related agents will be returned.
group	No	int	Acts as a filter. Target group ID Remark: if this parameter is present, all the related agents will be returned.

Caution :

only one of the 3 parameters \"agents\", or \"team\", or \"group\" can be present in the request. Otherwise, the error code HTTP 400 \"Bad Request\" will be returned.
only the activity planning that are fully included by the requested period will be returned. Ex.: if the period is 10h00 to 11h00 and an existing activity is planned between 10h30 and 11h30, this specific activity will not be returned.

Response example:

[\n    {\n        \"period\": <Period>,\n        \"activity\": {\n            \"id\": <activity_id>\n        }, \n        \"agent\": {\n            \"id\": <agent_id>\n        }\n    },\n    (...)\n]\n

Remark: the response array can be empty if no activity planning matches the request parameters.

\n","urlObject":{"path":["activities","planning"],"host":["{{api_base_url_v3}}"],"query":[{"disabled":true,"key":"activities","value":null},{"disabled":true,"key":"team","value":"1"},{"disabled":true,"key":"group","value":"2"}],"variable":[]}},"response":[],"_postman_id":"c59531d9-aa4e-4863-b1d6-984018dd18ee"},{"name":"Delete Activity Planning","id":"7cb0f792-c951-478f-886a-911afba6c79d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Kiamo-Api-Token","value":"{{token_activity_planning}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"periods\": [{\r\n \"startTime\": \"2021-03-01T12:00:00+00:00\",\r\n \"endTime\": \"2021-03-31T12:00:00+00:00\"\r\n }],\r\n \"activities\": [1,2,3],\r\n \"group\": 1\r\n}"},"url":"{{api_base_url_v3}}/activities/planning","description":"

Delete existing activity planning.

The JSON body is composed of the following parameters :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Required?	Data type	Description
period	Yes	Period	Activity period (see upper)
activities	No	string	Acts as a filter. List of target activity IDs ex : activities=1,2,3 Remark: if the parameter is not present or if the list is empty, all the related activities will be returned.
agents	No	string	Acts as a filter. List of target agent IDs ex : agents=1,2,3 Remark: if the parameter is not present or if the list is empty, all the related agents will be returned.
team	No	int	Acts as a filter. Target team ID Remark: if this parameter is present, all the related agents will be returned.
group	No	int	Acts as a filter. Target group ID Remark: if this parameter is present, all the related agents will be returned.

Caution : only one of the 3 parameters \"agents\", or \"team\", or \"group\" can be present in the request. Otherwise, the error code HTTP 400 \"Bad Request\" will be returned.

In case of success, the result is the HTTP code 204 - \"No content\".

\n","urlObject":{"path":["activities","planning"],"host":["{{api_base_url_v3}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7cb0f792-c951-478f-886a-911afba6c79d"}],"id":"ba621bd4-17c5-4a17-9092-34d1ad9ef934","description":"

Activity Planing Operations

Common Objects

Period

A Period object is composed of a start time and an end time, with the following constraints :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Required?	Description
startTime	string	Yes	Start quarter
endTime	string	Yes	End quarter (excluded)

where :

dates are UTC ISO 8601 date strings (\"YYYY-MM-DDTHH:MM:SSZ\"),
minutes can only be '00', '15', '30', '45' (the activity planing granularity is the quarter hour),
seconds are ignored,
startTime is the initial quarter (included),
endTime is the final quarter (excluded).

Example : 60 minutes period, from 10h00 to 11h00 UTC :

\"period\": {\n        \"startTime\": \"2021-01-18T10:00:00Z\",\n        \"endTime\": \"2021-01-18T11:00:00Z\"\n      }\n

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"4f605eef-de1c-44b9-aa04-d44658ed3fc7"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"290d1fc8-80b3-44ff-97a6-41f996e8a356"}}],"_postman_id":"ba621bd4-17c5-4a17-9092-34d1ad9ef934"}],"id":"a3270e70-2070-41b7-8a17-1fef1a28f6b6","description":"

BUILD DOMAIN APIs

The APIs regrouped under the BUILD domain are dedicated to build and configure a Kiamo instance.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"1a68993a-a273-4752-87bf-3b08e993cf70"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a7bb0701-e579-49a6-bf7e-2979263e6289"}}],"_postman_id":"a3270e70-2070-41b7-8a17-1fef1a28f6b6"},{"name":"contact_manager","item":[{"name":"bases","item":[{"name":"Get Contact Manager Bases","id":"6e7e90e8-71b6-4c26-bcda-3ca6e89719af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":"{{api_base_url}}/contact_manager/bases","description":"

List of contacts databases

The “bases” resource is used to create and retrieve a list of contact databases.\nThese databases contain the same data than the ones available for the Base resource.

Query parameters

Query parameters are a set of parameters placed in the URL in order to refine the results of your request.

The possible query parameters are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Possible values	Required?	Description
synchronization	N/A	N/A	No	Automatic synchronization To get the list of contact databases with an automatic synchronization `/contact_manager/bases?synchronization`

","urlObject":{"path":["contact_manager","bases"],"host":["{{api_base_url}}"],"query":[{"disabled":true,"key":"synchronization","value":null}],"variable":[]}},"response":[{"id":"fc0acea2-0006-42af-896f-ee9ee1477a3c","name":"Get bases with an automatic synchronization","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":{"raw":"{{api_base_url}}/contact_manager/bases?synchronisation","host":["{{api_base_url}}"],"path":["contact_manager","bases"],"query":[{"key":"synchronisation","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Oct 2018 12:32:47 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"31"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5bbca09836a3372c50006143\",\n \"name\": \"Base with synchro\",\n \"contacts\": {\n \"count\": 10\n },\n \"created_at\": \"2018-10-09T12:35:35+0000\"\n }\n ]\n}"},{"id":"17f7bfbc-16d5-44ed-b0a4-29b9d20d1e30","name":"Get All Bases","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":"{{api_base_url}}/contact_manager/bases"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Oct 2018 12:31:27 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"131"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5bbc9eb236a3373a34000fa2\",\n \"name\": \"CM Customer service\",\n \"contacts\": {\n \"count\": 11\n },\n \"created_at\": \"2018-10-09T12:27:30+0000\"\n }\n ]\n}"}],"_postman_id":"6e7e90e8-71b6-4c26-bcda-3ca6e89719af"},{"name":"Create Contact Manager Base","id":"aa1d429f-2e1c-4f58-a094-a8a3435f783b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Test Base\"\n}"},"url":"{{api_base_url}}/contact_manager/bases","description":"

Create a contacts database

The JSON body is composed of the following parameters :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Required?	Description
name	string	Yes	The contacts database name

","urlObject":{"path":["contact_manager","bases"],"host":["{{api_base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5bac774d-fe9b-4ea0-ba1d-d6f8ecc11016","name":"Base creation","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Test Base\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api_base_url}}/contact_manager/bases"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Oct 2018 12:27:29 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"123"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5bbc9eb236a3373a34000fa2\",\n \"name\": \"Test Base\",\n \"contacts\": {\n \"count\": 0\n },\n \"created_at\": \"2018-10-09T12:27:30+0000\"\n}"},{"id":"a8389039-19a9-487b-b010-6888eb313939","name":"Error : No \"name\" property","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"thename\": \"Test Base\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api_base_url}}/contact_manager/bases"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Oct 2018 12:30:02 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"149"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"status\": 400,\n \"code\": \"ERR_1040\",\n \"title\": \"Bad request\",\n \"detail\": \"Json attribute name is missing. Please refer to the documentation for more informations\"\n }\n}"}],"_postman_id":"aa1d429f-2e1c-4f58-a094-a8a3435f783b"},{"name":"Get Contact Manager Base","id":"49e4052a-fa6a-4445-930c-4908b286f647","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":"{{api_base_url}}/contact_manager/bases/:id","description":"

Get a contacts database

Remark : To get the IDs of databases, run a GET query on the /contact_manager/bases resource.

\n","urlObject":{"path":["contact_manager","bases",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"da145eed-1afa-4f80-b8f1-0b7da0b57cd5","description":{"content":"

Base Id

\n","type":"text/plain"},"type":"any","value":"{{cm_base_id}}","key":"id"}]}},"response":[{"id":"f2c62c48-8e9e-49b4-ab5a-d3e9bb0a3ce2","name":"Get a contact base by ID","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":"{{api_base_url}}/contact_manager/bases/5bbc9eb236a3373a34000fa2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Oct 2018 12:37:59 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"124"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5bbc9eb236a3373a34000fa2\",\n \"name\": \"Test Base\",\n \"contacts\": {\n \"count\": 20\n },\n \"created_at\": \"2018-10-09T12:27:30+0000\"\n}"},{"id":"219fb049-c8b2-407b-bbb4-3940860093e7","name":"Error : base not found","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":"{{api_base_url}}/contact_manager/bases/12345"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Oct 2018 12:38:44 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"143"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"status\": 404,\n \"code\": \"ERR_3000\",\n \"title\": \"The requested resource was not found\",\n \"detail\": \"Cannot retrieve this resource. Please check if it exists\"\n }\n}"}],"_postman_id":"49e4052a-fa6a-4445-930c-4908b286f647"},{"name":"Update Contact Manager Base","id":"805d34fb-efb0-4a7c-8a3e-2c64c3840867","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Renamed base\"\n}"},"url":"{{api_base_url}}/contact_manager/bases/:id","description":"

Update a contact database

Remark : only the database name can be modified.

Caution : The database name must be unique : if the name sent already exists, a 400 error will be displayed (ERR_2060).

\n","urlObject":{"path":["contact_manager","bases",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"c8cd97fb-3da1-4c0c-9bb2-22d7f11400c1","description":{"content":"

Base Id

\n","type":"text/plain"},"type":"any","value":"{{cm_base_id}}","key":"id"}]}},"response":[{"id":"deaa1f5b-807f-472c-ae16-b4e4abbaa4aa","name":"Contact database name update","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Renamed Base\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api_base_url}}/contact_manager/bases/5bbc9eb236a3373a34000fa2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Oct 2018 12:59:21 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"129"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5bbc9eb236a3373a34000fa2\",\n \"name\": \"Renamed Base\",\n \"contacts\": {\n \"count\": 20\n },\n \"created_at\": \"2018-10-09T12:27:30+0000\"\n}"},{"id":"cbadd190-2121-417e-8734-4c224663122d","name":"Error : no \"name\" property","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"thename\": \"Renamed Base\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api_base_url}}/contact_manager/bases"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Oct 2018 12:30:02 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"149"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"status\": 400,\n \"code\": \"ERR_1040\",\n \"title\": \"Bad request\",\n \"detail\": \"Json attribute name is missing. Please refer to the documentation for more informations\"\n }\n}"}],"_postman_id":"805d34fb-efb0-4a7c-8a3e-2c64c3840867"},{"name":"Delete Contact Manager Base","id":"8881fe83-6eff-4ea2-874c-8a5c311780c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"body":{"mode":"raw","raw":""},"url":"{{api_base_url}}/contact_manager/bases/:id","description":"

Delete a contacts database

Remark : the code \"204 No Content\" is returned when there is no problem.

\n","urlObject":{"path":["contact_manager","bases",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"ee4a85c8-9a17-4088-af0d-601453ecb441","description":{"content":"

Base Id

\n","type":"text/plain"},"type":"any","value":"{{cm_base_id}}","key":"id"}]}},"response":[{"id":"faa98ec8-54d0-4f83-a306-0bf009d739ce","name":"Base deletion","originalRequest":{"method":"DELETE","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"body":{"mode":"raw","raw":""},"url":"{{api_base_url}}/contact_manager/bases/5bbca6ae36a3372c5000617d"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 09 Oct 2018 13:01:59 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8881fe83-6eff-4ea2-874c-8a5c311780c2"},{"name":"Create Base Batches","id":"b4cc11ac-875a-4cd8-939e-3390426891bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"New Batch\",\n\t\"service\": 1,\n\t\"association\": {\n\t\t\"destination\": \"5bbc9eb236a3373a34000fad\",\n\t\t\"reference\": \"5bbc9eb236a3373a34000fa3\"\n\t}\n}"},"url":"{{api_base_url}}/contact_manager/bases/:id/batches?include=association","description":"

Create a batch and insert it into a specific database

It's also possible to add an association when the batch is created.

Remark : When a new batch is created, if an association is sent, the batch will be directly enabled. If not, its status will be : \"new\".

\n","urlObject":{"path":["contact_manager","bases",":id","batches"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

(optional) Association

\n","type":"text/plain"},"key":"include","value":"association"}],"variable":[{"id":"55597520-d9ea-4baa-a8f4-ff53e327cb0a","description":{"content":"

Base Id

\n","type":"text/plain"},"type":"any","value":"{{cm_base_id}}","key":"id"}]}},"response":[{"id":"904a4fe0-19d5-4109-8a18-969e9219408b","name":"Batch creation in a Base with Association","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"New Batch with Association\",\n\t\"service\": 1,\n\t\"association\": {\n\t\t\"destination\": \"5bbc9eb236a3373a34000fad\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/contact_manager/bases/:id/batches?include=association","host":["{{api_base_url}}"],"path":["contact_manager","bases",":id","batches"],"query":[{"key":"include","value":"association"}],"variable":[{"key":"id","value":"{{cm_base_id}}","description":"Base Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Oct 2018 10:02:17 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"181"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5bbdce2a36a3371038004f7b\",\n \"name\": \"New Batch with Association\",\n \"base_id\": \"5bbc9eb236a3373a34000fa2\",\n \"service_id\": 1,\n \"state\": \"active\",\n \"contacts\": {\n \"count\": \"0\"\n },\n \"association\": {\n \"destination\": \"5bbc9eb236a3373a34000fad\"\n },\n \"created_at\": \"2018-10-10T10:02:18+0000\"\n}"},{"id":"afa905ea-8ce1-4666-bf4d-9be300e54781","name":"Error : Unknown Service","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"New batch\",\n\t\"service\": 2000\n}","options":{"raw":{"language":"json"}}},"url":"{{api_base_url}}/contact_manager/bases/5bbc9eb236a3373a34000fa2/batches"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Oct 2018 15:16:38 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"159"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"status\": 400,\n \"code\": \"ERR_1110\",\n \"title\": \"Bad request\",\n \"detail\": \"Json attribute service is invalid, bad type. Please refer to the documentation for more informations\"\n }\n}"},{"id":"c2f78fca-8ddf-43be-addf-d8e291309f83","name":"Batch creation in a Base","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"New name\",\n\t\"service\": 1\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/contact_manager/bases/:id/batches","host":["{{api_base_url}}"],"path":["contact_manager","bases",":id","batches"],"variable":[{"key":"id","value":"{{cm_base_id}}","description":"Base Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Oct 2018 08:29:31 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"172"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5bbdb86f36a3372c5000619c\",\n \"name\": \"New name\",\n \"base_id\": \"5bbc9eb236a3373a34000fa2\",\n \"service_id\": 1,\n \"state\": \"new\",\n \"contacts\": {\n \"count\": \"0\"\n },\n \"created_at\": \"2018-10-10T08:29:35+0000\"\n}"}],"_postman_id":"b4cc11ac-875a-4cd8-939e-3390426891bd"},{"name":"Get Base Batches","id":"12706b43-5c8b-472f-8901-0fa60959c325","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":"{{api_base_url}}/contact_manager/bases/:id/batches","description":"

Retrieve all the batches in a specific contacts database

\n","urlObject":{"path":["contact_manager","bases",":id","batches"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"108562f0-3ab8-4664-93b9-6553d0cbb4f9","description":{"content":"

Base Id

\n","type":"text/plain"},"type":"any","value":"{{cm_base_id}}","key":"id"}]}},"response":[{"id":"53aa3041-e04d-4330-9c15-e6738c5498a5","name":"Retrieve all the batches in a specific contacts database","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":"{{api_base_url}}/contact_manager/bases/5bbc9eb236a3373a34000fa2/batches"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Oct 2018 08:30:13 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"177"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5c811aa32017590fec005b0b\", \n \"name\": \"CM API Batch\", \n \"base\": \"5c81114220175916f4005d5c\", \n \"service\": \"8\", \n \"state\": \"new\", \n \"contacts\": { \n \"count\": 2 \n },\n \"created_at\": \"2019-03-07T13:20:35+0000\"\n }\n ]\n}"}],"_postman_id":"12706b43-5c8b-472f-8901-0fa60959c325"},{"name":"Add Base Contacts","id":"ebe0e7d0-0555-474b-897d-d498672e4579","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n\t \"fields\": {\n\t\t \"5bbc9eb236a3373a34000fa4\": \"API\"\n \t}\n }\n]"},"url":"{{api_base_url}}/contact_manager/bases/:id/contacts","description":"

Add contacts to a base

The JSON body is an array of contacts (see Contact object description bellow).

Each contact is described by a list of fields (see Fields Contact sub-object description bellow), the field ID and it value.

\n","urlObject":{"path":["contact_manager","bases",":id","contacts"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"fa44080f-4f2e-4e4a-8092-1c1c99ebd257","description":{"content":"

Base Id

\n","type":"text/plain"},"type":"any","value":"{{cm_base_id}}","key":"id"}]}},"response":[{"id":"bae501a0-1448-40ab-9862-86b6fc05ead1","name":"Create contacts","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n\t \"fields\": {\n\t\t \"5bbc9eb236a3373a34000fa4\": \"Contact name\"\n\t }\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/contact_manager/bases/:id/contacts","host":["{{api_base_url}}"],"path":["contact_manager","bases",":id","contacts"],"variable":[{"key":"id","value":"{{cm_base_id}}","description":"Base Id"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Oct 2018 14:44:31 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"159"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": {\n \"message\": \"Resource has been created\",\n \"code\": \"\",\n \"location\": \"http://127.0.0.1/api/contact_manager/base/5bbc9eb236a3373a34000fa2/contacts?include=fields\"\n }\n}"}],"_postman_id":"ebe0e7d0-0555-474b-897d-d498672e4579"},{"name":"Get Base Contacts","id":"34c69cd4-dce3-4544-9394-42fb86641f6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":"{{api_base_url}}/contact_manager/bases/:id/contacts","description":"

Retrieve the list of contacts of a base

Query parameters

The possible query parameters are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Possible values	Required?	Description
include	string	fields tasks	No	To retrieve the contact fields, `include=fields` must be added to the query If the contact is attached to several batches, it's possible to get this information by adding `include=tasks` to the query Both values are possible by adding `include=fields,tasks` to the query

","urlObject":{"path":["contact_manager","bases",":id","contacts"],"host":["{{api_base_url}}"],"query":[{"disabled":true,"description":{"content":"

(optional) List of values in [fields|tasks]

\n","type":"text/plain"},"key":"include","value":""}],"variable":[{"id":"4a05c12c-2d42-4b1a-8c56-344f89da9fba","description":{"content":"

Base Id

\n","type":"text/plain"},"type":"any","value":"{{cm_base_id}}","key":"id"}]}},"response":[{"id":"a9b2941f-2f9a-453f-b692-d6aa3c4c61d7","name":"Retrive base contact list with their associated tasks","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":{"raw":"{{api_base_url}}/contact_manager/bases/:id/contacts?include=tasks","host":["{{api_base_url}}"],"path":["contact_manager","bases",":id","contacts"],"query":[{"key":"include","value":"tasks"}],"variable":[{"key":"id","value":"{{cm_base_id}}","description":"Base Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Oct 2018 13:16:36 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"221"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5bbca10e36a3372c50006168\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006169\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000616a\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000616b\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000616c\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000616d\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000616e\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000616f\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006170\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"tasks\": {\n \"data\": [\n {\n \"batch\": \"5bbdce2a36a3371038004f7b\",\n \"state\": \"PENDING\",\n \"qualif\": 0\n },\n {\n \"batch\": \"5bbdf80636a3372c5000619d\",\n \"state\": \"PENDING\",\n \"qualif\": 0\n }\n ]\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006171\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006172\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006173\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006174\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006175\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006176\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006177\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006178\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006179\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000617a\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000617b\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n }\n ]\n}"},{"id":"32dd8443-a981-451c-84ff-ecfdf254698f","name":"Retrieve base contact list with their related fields","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":{"raw":"{{api_base_url}}/contact_manager/bases/:id/contacts?include=fields","host":["{{api_base_url}}"],"path":["contact_manager","bases",":id","contacts"],"query":[{"key":"include","value":"fields"}],"variable":[{"key":"id","value":"{{cm_base_id}}","description":"Base Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Oct 2018 10:28:43 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"862"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5bbca10e36a3372c50006168\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Pierre\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"ornare.facilisis@acmetusvitae.net\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006169\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Thibault\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"Sed.congue@magna.ca\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000616a\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Lamia\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"Integer@liberomauris.edu\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000616b\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Cédric\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"tortor.nibh.sit@imperdietnon.co.uk\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000616c\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Élisa\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"ultricies.dignissim@tempor.org\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000616d\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Titouan\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"molestie.in.tempus@eutelluseu.edu\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000616e\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Fanny\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"ac@vulputatelacusCras.org\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000616f\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Jeanne\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"commodo@etliberoProin.ca\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006170\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Alexis\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"cursus@maurisaliquameu.edu\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006171\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Solene\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"facilisis.lorem@Cras.com\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006172\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Florentin\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"tristique.ac.eleifend@ligulaconsectetuerrhoncus.edu\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006173\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Gabriel\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"rhoncus.Donec@magnaet.ca\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006174\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Zacharis\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"Vestibulum.accumsan.neque@non.co.uk\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006175\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Mathis\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"dictum.augue.malesuada@ornare.com\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006176\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Valentin\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"lectus.Nullam@amet.ca\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006177\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Benjamin\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"In.condimentum@magnis.edu\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006178\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Françoise\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"vulputate@vitaeerat.ca\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006179\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Anaël\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"augue.id.ante@magnaNam.edu\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000617a\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Élisa\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"primis.in@Phasellus.edu\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000617b\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Célia\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"parturient.montes@mauris.ca\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n }\n ]\n}"},{"id":"449b1ec8-6097-484b-93f2-91f67ae30c05","name":"Retrive base contact list","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":{"raw":"{{api_base_url}}/contact_manager/bases/:id/contacts","host":["{{api_base_url}}"],"path":["contact_manager","bases",":id","contacts"],"variable":[{"key":"id","value":"{{cm_base_id}}","description":"Base Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Oct 2018 10:27:59 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"147"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5bbca10e36a3372c50006168\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006169\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000616a\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000616b\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000616c\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000616d\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000616e\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000616f\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006170\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006171\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006172\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006173\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006174\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006175\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006176\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006177\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006178\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c50006179\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000617a\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n },\n {\n \"id\": \"5bbca10e36a3372c5000617b\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n }\n ]\n}"}],"_postman_id":"34c69cd4-dce3-4544-9394-42fb86641f6b"},{"name":"Add Base Fields","id":"8f2e75dc-053e-4ed4-99b6-5dcd84c07c96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n\t \"name\": \"fix_phone\",\n\t \"label\": \"Fix phone\",\n\t \"datatype\": \"phone\"\n },\n {\n\t \"name\": \"mobile_phone\",\n\t \"label\": \"Mobile phone\",\n\t \"datatype\": \"phone\"\n }\n]"},"url":"{{api_base_url}}/contact_manager/bases/:id/fields","description":"

Add fiedls to a contacts database

The JSON body is an array of fields (see Field object description bellow).

Remark : Here is the list of \"datatypes\" available :
\n✓ int
\n✓ phone
\n✓ email
\n✓ string
\n✓ date

\n","urlObject":{"path":["contact_manager","bases",":id","fields"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"36e5d03f-95a8-4f5e-a8c4-4dd4e70402fe","description":{"content":"

Base Id

\n","type":"text/plain"},"type":"any","value":"{{cm_base_id}}","key":"id"}]}},"response":[{"id":"6efe4299-9dea-4b7c-91c9-1640e5c17f7b","name":"Error : wrong \"datatype\"","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"name\": \"address\",\n \"label\": \"Adresse\",\n \"datatype\": \"unknown\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{api_base_url}}/contact_manager/bases/5bbc9eb236a3373a34000fa2/fields"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Oct 2018 13:41:04 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"153"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"status\": 400,\n \"code\": \"ERR_1080\",\n \"title\": \"Bad request\",\n \"detail\": \"Json attribute datatype is invalid. Please refer to the documentation for more informations\"\n }\n}"},{"id":"f70a0752-0c5e-4c61-bef5-53fcbe88e20b","name":"Error : empty \"name\"","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n\t\"name\": \"\",\n\t\"label\": \"Label\",\n\t\"datatype\": \"string\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{api_base_url}}/contact_manager/bases/5bbc9eb236a3373a34000fa2/fields"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Oct 2018 13:42:26 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"149"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"status\": 400,\n \"code\": \"ERR_1040\",\n \"title\": \"Bad request\",\n \"detail\": \"Json attribute name is missing. Please refer to the documentation for more informations\"\n }\n}"},{"id":"919ee16c-0068-4a79-a204-369b57fbf2b8","name":"Error : empty \"label\" vide","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n\t \"name\": \"address\",\n\t \"label\": \"\",\n\t \"datatype\": \"string\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{api_base_url}}/contact_manager/bases/5bbc9eb236a3373a34000fa2/fields"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Oct 2018 13:41:54 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"151"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"status\": 400,\n \"code\": \"ERR_1070\",\n \"title\": \"Bad request\",\n \"detail\": \"Json attribute label is missing. Please refer to the documentation for more informations\"\n }\n}"},{"id":"a5087138-13db-4b2b-86f0-20fa6a675be5","name":"Create fields in a contacts database (email and phone-type)","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n { \n \"name\": \"Home_phone\", \n \"label\": \"Home\", \n \"datatype\": \"phone\" \n },\n { \n \"name\": \"Email2\", \n \"label\": \"Email 2\", \n \"datatype\": \"email\" \n }\n]","options":{"raw":{"language":"json"}}},"url":"{{api_base_url}}/contact_manager/bases/5bbc9eb236a3373a34000fa2/fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Oct 2018 13:40:10 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"460"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5bbc9eb236a3373a34000fa3\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactTitle\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 1\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactLastName\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 2\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fa5\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactFirstName\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 3\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fa6\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactSex\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 4\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fa7\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactBirthday\",\n \"datatype\": \"date\",\n \"type\": \"default\",\n \"position\": 5\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fa8\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactPrimaryAddress\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 6\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fa9\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactSecondaryAddress\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 7\n },\n {\n \"id\": \"5bbc9eb236a3373a34000faa\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactZipCode\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 8\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fab\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactCity\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 9\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fac\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactCountry\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 10\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactPhoneNumber\",\n \"datatype\": \"phone\",\n \"type\": \"default\",\n \"position\": 11\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fae\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactMobilePhoneNumber\",\n \"datatype\": \"phone\",\n \"type\": \"default\",\n \"position\": 12\n },\n {\n \"id\": \"5bbc9eb236a3373a34000faf\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactWorkPhoneNumber\",\n \"datatype\": \"phone\",\n \"type\": \"default\",\n \"position\": 13\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactEmail\",\n \"datatype\": \"email\",\n \"type\": \"default\",\n \"position\": 14\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fb1\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactReference\",\n \"datatype\": \"reference\",\n \"type\": \"default\",\n \"position\": 15\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fb2\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactNote\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 16\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fb3\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactFacebookId\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 17\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fb4\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactTwitterId\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 18\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactCreatedAt\",\n \"datatype\": \"date\",\n \"type\": \"default\",\n \"position\": 19\n },\n {\n \"id\": \"5bbcafbc36a3371038004f76\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"Home_phone\",\n \"label\": \"Home\",\n \"datatype\": \"phone\",\n \"type\": \"user\"\n },\n {\n \"id\": \"5bbcafbc36a3371038004f77\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"Email2\",\n \"label\": \"Email 2\",\n \"datatype\": \"email\",\n \"type\": \"user\"\n }\n ]\n}"}],"_postman_id":"8f2e75dc-053e-4ed4-99b6-5dcd84c07c96"},{"name":"Get Base Fields","id":"afa7b3a5-73b3-4040-9c97-a97ec256b7df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":"{{api_base_url}}/contact_manager/bases/:id/fields","description":"

Retrieve the list of fields of a contacts database

\n","urlObject":{"path":["contact_manager","bases",":id","fields"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"44c7b286-d8b6-4800-a908-9234144742cf","description":{"content":"

Base Id

\n","type":"text/plain"},"type":"any","value":"{{cm_base_id}}","key":"id"}]}},"response":[{"id":"6cb9601d-1528-49c1-a19d-9306e63df229","name":"Retrieve the list of fields of a contacts database","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":"{{api_base_url}}/contact_manager/bases/5bbc9eb236a3373a34000fa2/fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Oct 2018 13:07:54 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"391"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5bbc9eb236a3373a34000fa3\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactTitle\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 1\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactLastName\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 2\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fa5\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactFirstName\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 3\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fa6\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactSex\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 4\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fa7\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactBirthday\",\n \"datatype\": \"date\",\n \"type\": \"default\",\n \"position\": 5\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fa8\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactPrimaryAddress\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 6\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fa9\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactSecondaryAddress\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 7\n },\n {\n \"id\": \"5bbc9eb236a3373a34000faa\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactZipCode\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 8\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fab\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactCity\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 9\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fac\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactCountry\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 10\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactPhoneNumber\",\n \"datatype\": \"phone\",\n \"type\": \"default\",\n \"position\": 11\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fae\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactMobilePhoneNumber\",\n \"datatype\": \"phone\",\n \"type\": \"default\",\n \"position\": 12\n },\n {\n \"id\": \"5bbc9eb236a3373a34000faf\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactWorkPhoneNumber\",\n \"datatype\": \"phone\",\n \"type\": \"default\",\n \"position\": 13\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactEmail\",\n \"datatype\": \"email\",\n \"type\": \"default\",\n \"position\": 14\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fb1\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactReference\",\n \"datatype\": \"reference\",\n \"type\": \"default\",\n \"position\": 15\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fb2\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactNote\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 16\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fb3\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactFacebookId\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 17\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fb4\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactTwitterId\",\n \"datatype\": \"string\",\n \"type\": \"default\",\n \"position\": 18\n },\n {\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"name\": \"contactCreatedAt\",\n \"datatype\": \"date\",\n \"type\": \"default\",\n \"position\": 19\n }\n ]\n}"}],"_postman_id":"afa7b3a5-73b3-4040-9c97-a97ec256b7df"}],"id":"f5224d16-d320-4db9-a013-a8006f31516e","description":"

Operations on the Contact Manager Bases

Elements of the \"Base\" object

“Base” object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data type	Required?	Read Only?	Description
id	string	No	Yes	Database ID.
name	string	Yes	No	Unique name of the database.
synchro	object (Synchro)	No	No	Status of the database synchronization. (This node will not be included if synchronization is null)
contacts.count	number	No	Yes	Number of contacts in the database.
created_at	dateTime	No	Yes	Date of creation of the contact database (ISO8601 format). Example: 2030 10 24T16:00:00+0000.

“Synchro” sub-object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data type	Required?	Read Only?	Description
type	string	No	No	Type of synchronization applied to the database. The only type available is “phpscript” used to execute a PHP script to provide data to the database.
hour	number	No	No	Full hour: Time the PHP script will be called by the KLIB module.
code	string	No	No	PHP code that will be executed to provide data to the contact database.

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"c3be8b53-b3fe-41f6-bb36-1a122ac3409b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"37ac9c74-9867-4e5d-a258-a85162e2a727"}}],"_postman_id":"f5224d16-d320-4db9-a013-a8006f31516e"},{"name":"batches","item":[{"name":"Get Contact Manager Batches","id":"49b94798-17a4-401b-9712-ba43334cc7f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":"{{api_base_url}}/contact_manager/batches","description":"

Retrieve all the batches in all the databases

\n","urlObject":{"path":["contact_manager","batches"],"host":["{{api_base_url}}"],"query":[],"variable":[]}},"response":[{"id":"00b2d627-cf66-431c-b2c1-3995b4420488","name":"Retrieve all the batches in all the databases","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":"{{api_base_url}}/contact_manager/batches"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Oct 2018 08:37:20 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"178"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5c811aa32017590fec005b0b\",\n \"name\": \"CM API Batch\",\n \"base_id\": \"5c81114220175916f4005d5c\",\n \"service_id\": 8,\n \"state\": \"new\",\n \"contacts\": {\n \"count\": \"2\"\n },\n \"created_at\": \"2019-03-07T13:20:35+0000\"\n },\n {\n \"id\": \"5c811f5120175916f4005d8e\",\n \"name\": \"Help desk CM batch\",\n \"base_id\": \"5c811ee420175910e0002321\",\n \"service_id\": 5,\n \"state\": \"new\",\n \"contacts\": {\n \"count\": \"4\"\n },\n \"created_at\": \"2019-03-07T13:40:33+0000\"\n }\n ]\n}"}],"_postman_id":"49b94798-17a4-401b-9712-ba43334cc7f4"},{"name":"Get Contact Manager Batch","id":"4e403f3b-6a73-4083-8135-3d2028d5a350","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":"{{api_base_url}}/contact_manager/batches/:id","description":"

Retrieve the content of a batch

Query parameters

The possible query parameters are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Possible values	Required?	Description
include	string	association	No	By default, the batch association is not included in the answer. If you want to get this piece of information, you have to include the following parameter in the query: `include=association`

","urlObject":{"path":["contact_manager","batches",":id"],"host":["{{api_base_url}}"],"query":[{"disabled":true,"description":{"content":"

(optional) Association

\n","type":"text/plain"},"key":"include","value":"association"}],"variable":[{"id":"e27ffdab-bef6-474e-a44a-4f9133da629f","description":{"content":"

Batch Id

\n","type":"text/plain"},"type":"any","value":"{{cm_batch_id}}","key":"id"}]}},"response":[{"id":"0fe90d42-54bb-447d-bc60-266268dcafaf","name":"Retrieve the content of a batch with association","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":{"raw":"{{api_base_url}}/contact_manager/batches/:id?include=association","host":["{{api_base_url}}"],"path":["contact_manager","batches",":id"],"query":[{"key":"include","value":"association"}],"variable":[{"key":"id","value":"{{cm_batch_id}}","description":"Batch Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Oct 2018 15:20:26 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"214"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5bbdce2a36a3371038004f7b\",\n \"name\": \"Help Desk CM batch\",\n \"base_id\": \"5bbc9eb236a3373a34000fa2\",\n \"service_id\": 5,\n \"state\": \"active\",\n \"contacts\": {\n \"count\": \"4\"\n },\n \"created_at\": \"2018-10-10T10:02:18+0000\",\n \"association\": {\n \"agent_id\": \"\",\n \"agent_login\": \"\",\n \"destination\": \"5bbc9eb236a3373a34000fad\",\n \"callback\": \"\",\n \"reference\": \"\"\n }\n}"},{"id":"c19154a0-80ee-4e06-91ec-f21c0fb16903","name":"Retrieve the content of a batch","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":{"raw":"{{api_base_url}}/contact_manager/batches/:id","host":["{{api_base_url}}"],"path":["contact_manager","batches",":id"],"variable":[{"key":"id","value":"{{cm_batch_id}}","description":"Batch Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Oct 2018 15:20:13 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"164"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5bbdce2a36a3371038004f7b\",\n \"name\": \"Help Desk CM batch\",\n \"base_id\": \"5bbc9eb236a3373a34000fa2\",\n \"service_id\": 5,\n \"state\": \"active\",\n \"contacts\": {\n \"count\": \"4\"\n },\n \"created_at\": \"2018-10-10T10:02:18+0000\"\n}"}],"_postman_id":"4e403f3b-6a73-4083-8135-3d2028d5a350"},{"name":"Update Contact Manager Batch","id":"e3aa1561-55c7-4eae-bbbd-8cd1474c78d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"state\": \"active\"\n}"},"url":"{{api_base_url}}/contact_manager/batches/:id?include=association","description":"

Update a Batch

Remark : see details and specificities about the state and the association items in the Batch and Association object definitions.

\n","urlObject":{"path":["contact_manager","batches",":id"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

(optional) Association

\n","type":"text/plain"},"key":"include","value":"association"}],"variable":[{"id":"7d708f93-69db-4a93-91d1-dc576ae28f94","description":{"content":"

Batch Id

\n","type":"text/plain"},"type":"any","value":"{{cm_batch_id}}","key":"id"}]}},"response":[{"id":"4e91ffaa-4c82-4df9-aee1-ad568045aa58","name":"Association creation / update","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"association\": {\n\t\t\"destination\": \"5bbc9eb236a3373a34000fad\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/contact_manager/batches/:id","host":["{{api_base_url}}"],"path":["contact_manager","batches",":id"],"variable":[{"key":"id","value":"{{cm_batch_id}}","description":"Batch Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Oct 2018 16:22:16 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"166"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5bbe249936a3371038004f80\",\n \"name\": \"Batch name\",\n \"base_id\": \"5bbc9eb236a3373a34000fa2\",\n \"service_id\": 1,\n \"state\": \"active\",\n \"contacts\": {\n \"count\": \"0\"\n },\n \"created_at\": \"2018-10-10T16:11:05+0000\"\n}"},{"id":"ea194822-25c5-4e33-8ff3-bff1faceed48","name":"Update the name of a batch","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Updated name\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api_base_url}}/contact_manager/batches/5bbe1b0e36a3371038004f7f"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Oct 2018 15:30:43 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"158"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5bbe1b0e36a3371038004f7f\",\n \"name\": \"Updated name\",\n \"base_id\": \"5bbc9eb236a3373a34000fa2\",\n \"service_id\": 1,\n \"state\": \"new\",\n \"contacts\": {\n \"count\": \"0\"\n },\n \"created_at\": \"2018-10-10T15:30:22+0000\"\n}"},{"id":"c25328b6-ad9a-49e9-905d-b804d2a5fa2b","name":"Enable a Batch","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"state\": \"active\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/contact_manager/batches/:id","host":["{{api_base_url}}"],"path":["contact_manager","batches",":id"],"variable":[{"key":"id","value":"{{cm_batch_id}}","description":"Batch Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Oct 2018 16:19:19 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"167"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5bbdf80636a3372c5000619d\",\n \"name\": \"Batch name\",\n \"base_id\": \"5bbc9eb236a3373a34000fa2\",\n \"service_id\": 1,\n \"state\": \"active\",\n \"contacts\": {\n \"count\": \"1\"\n },\n \"created_at\": \"2018-10-10T13:00:54+0000\"\n}"},{"id":"25a9d03e-1e8e-460d-b72f-f0d3f57e6805","name":"Error : enable a batch with no association","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"state\": \"active\",\n \"association\": { \n \"destination\": \"5bbc9eb236a3373a34000fad\" \n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/contact_manager/batches/:id?include=association","host":["{{api_base_url}}"],"path":["contact_manager","batches",":id"],"query":[{"key":"include","value":"association","description":"(optional) Association"}],"variable":[{"key":"id","value":"{{cm_batch_id}}","description":"Batch Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{ \r\n \"error\": { \r\n \"status\": 400, \r\n \"code\": \"ERR_2015\", \r\n \"title\": \"Bad request\", \r\n \"detail\": \"Batch has no association configured, destination is required\" \r\n } \r\n}"}],"_postman_id":"e3aa1561-55c7-4eae-bbbd-8cd1474c78d0"},{"name":"Delete Contact Manager Batch","id":"77951f7b-30da-4fa6-b502-3411efbac862","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"body":{"mode":"raw","raw":""},"url":"{{api_base_url}}/contact_manager/batches/:id","description":"

Delete a batch

Remark : only the Batches with state new or stopped can be deleted.

\n","urlObject":{"path":["contact_manager","batches",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"1220bb34-dc3b-40d9-982f-ff500f66e7d3","description":{"content":"

Batch Id

\n","type":"text/plain"},"type":"any","value":"{{cm_batch_id}}","key":"id"}]}},"response":[{"id":"53908e73-26d3-4107-bf1a-4c1b136bea9b","name":"Delete a batch","originalRequest":{"method":"DELETE","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{api_base_url}}/contact_manager/batches/:id","host":["{{api_base_url}}"],"path":["contact_manager","batches",":id"],"variable":[{"key":"id","value":"{{cm_batch_id}}","description":"Batch Id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 10 Oct 2018 16:25:58 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"77951f7b-30da-4fa6-b502-3411efbac862"},{"name":"Get Batch Contacts","id":"02ae5600-644e-4d9a-9b99-3eb3beec25ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":"{{api_base_url}}/contact_manager/batches/:id/contacts","description":"

Retrieve the list of contacts of a batch

Specificity

This operation returns the list of contacts which have the same specificities :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data type	Required?	Read Only?	Description
batch	string	No	Yes	Batch ID.
state	string	Yes	No	Contact status in the batch. Remark : Values: “DONE”, “MAX_TRIES”, “PENDING”, “PENDING_ERROR”, and “POSTPONE”.
qualif	number	No	No	Contact qualification ID.

Query parameters

The possible query parameters are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Possible values	Required?	Description
include	string	fields tasks	No	To retrieve the contact fields, `include=fields` must be added to the query If the contact is attached to several batches, it's possible to get this information by adding `include=tasks` to the query Both values are possible by adding `include=fields,tasks` to the query

","urlObject":{"path":["contact_manager","batches",":id","contacts"],"host":["{{api_base_url}}"],"query":[{"disabled":true,"description":{"content":"

(optional) List of values in [fields|tasks]

\n","type":"text/plain"},"key":"include","value":null}],"variable":[{"id":"ba362efe-8ef2-4a8c-8f00-351a9bf52274","type":"any","value":"{{cm_batch_id}}","key":"id"}]}},"response":[{"id":"9ecb124b-9aa2-4360-8d8f-4e11179b5eb9","name":"Retrieve batch contacts with their fields and tasks","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":{"raw":"{{api_base_url}}/contact_manager/batches/:id/contacts?include=fields,tasks","host":["{{api_base_url}}"],"path":["contact_manager","batches",":id","contacts"],"query":[{"key":"include","value":"fields,tasks"}],"variable":[{"key":"id","value":"{{cm_batch_id}}","description":"Batch Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Oct 2018 09:14:41 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"349"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5bbca10e36a3372c50006170\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Alexis\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"cursus@maurisaliquameu.edu\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n },\n \"tasks\": {\n \"data\": [\n {\n \"batch\": \"5bbdce2a36a3371038004f7b\",\n \"state\": \"PENDING\",\n \"qualif\": 0\n },\n {\n \"batch\": \"5bbdf80636a3372c5000619d\",\n \"state\": \"PENDING\",\n \"qualif\": 0\n }\n ]\n }\n }\n ]\n}"},{"id":"0a88c486-5db3-496e-8a5d-823018f11786","name":"Retrive batch contacts","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":{"raw":"{{api_base_url}}/contact_manager/batches/:id/contacts","host":["{{api_base_url}}"],"path":["contact_manager","batches",":id","contacts"],"variable":[{"key":"id","value":"{{cm_batch_id}}","description":"Batch Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Oct 2018 09:14:18 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"90"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5bbca10e36a3372c50006170\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n }\n ]\n}"}],"_postman_id":"02ae5600-644e-4d9a-9b99-3eb3beec25ca"},{"name":"Add Batch Contacts","id":"62ce5a1b-efd5-47c5-8a2d-3d80c93d94f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n\t\"5bbca10e36a3372c50006179\", \"5bbca10e36a3372c50006177\", \"5bbca10e36a3372c5000616b\"\n]"},"url":"{{api_base_url}}/contact_manager/batches/:id/contacts","description":"

Add contacts to a batch

Remark : To add contacts to a batch, these contacts must exist in the associated database.

Answer codes :

\"204 No content\" when there is no problem.
\"400 Bad Request\" if the content is invalid (e.g.: invalid JSON), if there is no contact to import, if contacts are already included in the batch...

\n","urlObject":{"path":["contact_manager","batches",":id","contacts"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"55a01a8d-2b4b-4af8-80a4-e449fe0a5ad5","description":{"content":"

Batch Id

\n","type":"text/plain"},"type":"any","value":"{{cm_batch_id}}","key":"id"}]}},"response":[{"id":"9567155f-1c1c-4bb9-a04d-f6aae79ed3ab","name":"Error : No contact to add","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n\t\"5bbca10e36a3372c50006179\", \"5bbca10e36a3372c50006177\", \"5bbca10e36a3372c5000616b\"\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/contact_manager/batches/:id/contacts","host":["{{api_base_url}}"],"path":["contact_manager","batches",":id","contacts"],"variable":[{"key":"id","value":"{{cm_batch_id}}","description":"Batch Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Oct 2018 12:57:55 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"136"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"status\": 400,\n \"code\": \"ERR_2020\",\n \"title\": \"Bad request\",\n \"detail\": \"No contact to import. Please add contact(s) before trying again\"\n }\n}"},{"id":"d74c2283-c725-4f82-a0ea-19b3f44aedab","name":"Add contacts to a batch","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n\t\"5bbca10e36a3372c50006179\", \"5bbca10e36a3372c50006177\", \"5bbca10e36a3372c5000616b\"\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/contact_manager/batches/:id/contacts","host":["{{api_base_url}}"],"path":["contact_manager","batches",":id","contacts"],"variable":[{"key":"id","value":"{{cm_batch_id}}","description":"Batch Id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Thu, 11 Oct 2018 12:37:19 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Keep-Alive","value":"timeout=5, max=499"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"62ce5a1b-efd5-47c5-8a2d-3d80c93d94f1"}],"id":"2b211853-0446-48b8-a1ad-1226ba73e8ba","description":"

Operations on the Contact Manager Batches

Elements of the \"Batch\" object

“Batch” object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data type	Required?	Read Only?	Description
id	string	No	Yes	Batch ID.
service.id	string	Yes	Yes	ID of the service associated with the batch.
name	string	Yes	No	Batch name. Remark : It is unique.
contacts.count	number	No	Yes	Number of contacts in the batch.
created_at	dateTime	No	Yes	Date of creation of the batch (ISO8601 format). Example : 2030 10 24T16:00:00+0000.
association	object (Association)	No	No	Association used to insert tasks in Kiamo.
state	string	No	No	Batch status : ✓ \"new\", ✓ \"active\", ✓ \"inactive\", ✓ \"stop \". Remarks : - you cannot edit a batch with the status : ”closed”. - a batch in the \"new\" status cannot be changed to “stop” or “inactive”. - if an association is provided, the batch directly changes status to “active”.

“Association” sub-object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data type	Required?	Read Only?	Description
destination	string	No	No	Filed ID in the Contact Manager associated with the \"destination” of the task.
reference	string	No	No	Filed ID in the Contact Manager associated with the \"reference” of the task.
callback_date	string	No	No	Filed ID in the Contact Manager associated with the \"callback date” of the task (ISO8601 format).
agent_id	string	No	No	Filed ID in the Contact Manager associated with the ID of the agent to whom the task has been assigned.
agent_login	string	No	No	Filed ID in the Contact Manager associated with the login of the agent to whom the task has been assigned. Remark : If the “agent_id” is completed, this field will not be used.

Specificities of the \"Association\" sub-object

Associating a batch consists in mapping the fields available in the Contact Manager with the fields of a Kiamo task. This association is mandatory to enable a batch.

It is made of several properties (“destination”, “agent_id”, etc.) used differently depending on the type of service.

Outbound call campaigns

For batches associated with an outbound call campaign in which the multi dialing option has not been configured, the \"destination” property is mandatory.

For batches associated with an outbound call campaign in which the multi dialing option has been configured, the \"destination” property is optional.

The other properties are optional.

Automatic processing

In the case of a batch associated with an automatic processing service, all properties are optional.

Task distribution

In the case of a batch associated with a task distribution service, the “destination” property is not available and should not be sent.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"59fb8b05-d191-4793-a6a5-efcfd78d98b7"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"3804a1dd-8ff8-4e62-8f42-e8c1ad1cd021"}}],"_postman_id":"2b211853-0446-48b8-a1ad-1226ba73e8ba"},{"name":"contacts","item":[{"name":"Get Contact Manager Contact","id":"1a8accae-24cd-4715-85e0-8aedc2cf7719","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}","type":"text"}],"url":"{{api_base_url}}/contact_manager/contacts/:id","description":"

Retrieve contact data

Query parameters

The possible query parameters are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Possible values	Required?	Description
include	string	fields tasks	No	To retrieve the contact fields, `include=fields` must be added to the query If the contact is attached to several batches, it's possible to get this information by adding `include=tasks` to the query Both values are possible by adding `include=fields,tasks` to the query

","urlObject":{"path":["contact_manager","contacts",":id"],"host":["{{api_base_url}}"],"query":[{"disabled":true,"description":{"content":"

(optional) List of values in [fields|tasks]

\n","type":"text/plain"},"key":"include","value":null}],"variable":[{"id":"4ada3dee-f6cb-40b0-a00a-1c013f1486da","description":{"content":"

Contact Id

\n","type":"text/plain"},"type":"any","value":"{{cm_contact_id}}","key":"id"}]}},"response":[{"id":"14ab3b12-e2bb-45af-9ddc-d0e17d4a30e3","name":"Retrieve a contact with its tasks","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}","type":"text"}],"url":{"raw":"{{api_base_url}}/contact_manager/contacts/:id?include=tasks","host":["{{api_base_url}}"],"path":["contact_manager","contacts",":id"],"query":[{"key":"include","value":"tasks"}],"variable":[{"key":"id","value":"{{cm_contact_id}}","description":"Contact Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Oct 2018 13:13:52 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"142"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5bbca10e36a3372c50006177\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"tasks\": {\n \"data\": [\n {\n \"batch\": \"5bbdce2a36a3371038004f7b\",\n \"state\": \"PENDING\",\n \"qualif\": 0\n }\n ]\n }\n}"},{"id":"bf09f479-812d-4544-b21f-063c19d1360d","name":"Retrieve a contact","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}","type":"text"}],"url":{"raw":"{{api_base_url}}/contact_manager/contacts/:id","host":["{{api_base_url}}"],"path":["contact_manager","contacts",":id"],"variable":[{"key":"id","value":"{{cm_contact_id}}","description":"Contact Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Oct 2018 13:13:14 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"81"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5bbca10e36a3372c50006177\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n }\n}"},{"id":"8b39fccd-fe5b-4469-a56c-b8cdfdd7a70c","name":"Retrieve a contact with its fields and tasks","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}","type":"text"}],"url":{"raw":"{{api_base_url}}/contact_manager/contacts/:id?include=fields,tasks","host":["{{api_base_url}}"],"path":["contact_manager","contacts",":id"],"query":[{"key":"include","value":"fields,tasks"}],"variable":[{"key":"id","value":"{{cm_contact_id}}","description":"Contact Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Oct 2018 13:14:10 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"334"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5bbca10e36a3372c50006177\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Benjamin\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"In.condimentum@magnis.edu\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n },\n \"tasks\": {\n \"data\": [\n {\n \"batch\": \"5bbdce2a36a3371038004f7b\",\n \"state\": \"PENDING\",\n \"qualif\": 0\n }\n ]\n }\n}"},{"id":"b3cadc9e-51e8-4014-b7b9-1374aa2a773d","name":"Retrieve a contact with its fields","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}","type":"text"}],"url":{"raw":"{{api_base_url}}/contact_manager/contacts/:id?include=fields","host":["{{api_base_url}}"],"path":["contact_manager","contacts",":id"],"query":[{"key":"include","value":"fields"}],"variable":[{"key":"id","value":"{{cm_contact_id}}","description":"Contact Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Oct 2018 13:13:36 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"286"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5bbca10e36a3372c50006177\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"Benjamin\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"In.condimentum@magnis.edu\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"3708\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n }\n ]\n }\n}"}],"_postman_id":"1a8accae-24cd-4715-85e0-8aedc2cf7719"},{"name":"Update Contact Manager Contact","id":"82ff1f3a-7135-4b97-be3b-2d3cbe0003b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"fields\": [{\n\t\t\"name\": \"contactTitle\",\n\t\t\"value\" : \"Mr\"\n\t},\n\t{\n\t\t\"name\": \"contactFirstName\",\n\t\t\"value\" : \"John\"\n\t},\n\t{\n\t\t\"name\": \"contactLastName\",\n\t\t\"value\" : \"Doo\"\n\t}]\n}"},"url":"{{api_base_url}}/contact_manager/contacts/:id?include=fields","description":"

Update a contact

\n","urlObject":{"path":["contact_manager","contacts",":id"],"host":["{{api_base_url}}"],"query":[{"key":"include","value":"fields"}],"variable":[{"id":"4eafffa5-4c52-4585-b018-7906b858240c","description":{"content":"

Contact Id

\n","type":"text/plain"},"type":"any","value":"{{cm_contact_id}}","key":"id"}]}},"response":[{"id":"2d916078-546d-43bc-8f82-be780ce88d8d","name":"Update a contact's field","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"fields\": [{\n\t\t\"name\": \"contactTitle\",\n\t\t\"value\" : \"Mr\"\n\t}]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/contact_manager/contacts/:id?include=fields","host":["{{api_base_url}}"],"path":["contact_manager","contacts",":id"],"query":[{"key":"include","value":"fields"}],"variable":[{"key":"id","value":"{{cm_contact_id}}","description":"Contact Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Oct 2018 14:11:08 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"305"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5bbca10e36a3372c50006177\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"John\",\n \"id\": \"5bbc9eb236a3373a34000fa5\",\n \"name\": \"contactFirstName\",\n \"label\": \"Prenom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"Doo\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"In.condimentum@magnis.edu\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"0123456789\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n },\n {\n \"value\": \"Mr\",\n \"id\": \"5bbc9eb236a3373a34000fa3\",\n \"name\": \"contactTitle\",\n \"label\": \"Titre\",\n \"type\": \"string\"\n }\n ]\n }\n}"},{"id":"3d0d32fe-698c-49fa-9bc1-bced34c67b00","name":"Update of several contact's fields","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"fields\": [{\n\t\t\"name\": \"contactTitle\",\n\t\t\"value\" : \"Mr\"\n\t},\n\t{\n\t\t\"name\": \"contactFirstName\",\n\t\t\"value\" : \"John\"\n\t},\n\t{\n\t\t\"name\": \"contactLastName\",\n\t\t\"value\" : \"Doo\"\n\t}]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/contact_manager/contacts/:id?include=fields","host":["{{api_base_url}}"],"path":["contact_manager","contacts",":id"],"query":[{"key":"include","value":"fields"}],"variable":[{"key":"id","value":"{{cm_contact_id}}","description":"Contact Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Oct 2018 14:12:19 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"304"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5bbca10e36a3372c50006177\",\n \"base\": {\n \"id\": \"5bbc9eb236a3373a34000fa2\"\n },\n \"fields\": {\n \"data\": [\n {\n \"value\": \"2018-10-09T12:37:34+0000\",\n \"id\": \"5bbc9eb236a3373a34000fb5\",\n \"name\": \"contactCreatedAt\",\n \"label\": \"Date de création\",\n \"type\": \"date\"\n },\n {\n \"value\": \"John\",\n \"id\": \"5bbc9eb236a3373a34000fa5\",\n \"name\": \"contactFirstName\",\n \"label\": \"Prenom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"Doo\",\n \"id\": \"5bbc9eb236a3373a34000fa4\",\n \"name\": \"contactLastName\",\n \"label\": \"Nom\",\n \"type\": \"string\"\n },\n {\n \"value\": \"In.condimentum@magnis.edu\",\n \"id\": \"5bbc9eb236a3373a34000fb0\",\n \"name\": \"contactEmail\",\n \"label\": \"Email\",\n \"type\": \"email\"\n },\n {\n \"value\": \"0123456789\",\n \"id\": \"5bbc9eb236a3373a34000fad\",\n \"name\": \"contactPhoneNumber\",\n \"label\": \"Fixe\",\n \"type\": \"phone\"\n },\n {\n \"value\": \"Mr\",\n \"id\": \"5bbc9eb236a3373a34000fa3\",\n \"name\": \"contactTitle\",\n \"label\": \"Titre\",\n \"type\": \"string\"\n }\n ]\n }\n}"}],"_postman_id":"82ff1f3a-7135-4b97-be3b-2d3cbe0003b1"},{"name":"Delete Contact Manager Contact","id":"c9891e60-1308-44ef-85e8-0c648be20284","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{api_base_url}}/contact_manager/contacts/:id","description":"

Delete a contact

Answer codes

✓ \"204 No Content\" when there is no problem.

\n","urlObject":{"path":["contact_manager","contacts",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"a54327f3-fd84-47f1-ab21-29cf8cacd18f","description":{"content":"

Contact Id

\n","type":"text/plain"},"type":"any","value":"{{cm_contact_id}}","key":"id"}]}},"response":[{"id":"74b43328-364e-46c0-828f-d269734c8e9b","name":"Delete a contact","originalRequest":{"method":"DELETE","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{api_base_url}}/contact_manager/contacts/:id","host":["{{api_base_url}}"],"path":["contact_manager","contacts",":id"],"variable":[{"key":"id","value":"{{cm_contact_id}}","description":"Contact Id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Thu, 11 Oct 2018 14:20:55 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":""},{"id":"f9f76532-e935-44ef-9721-dac1d963aee1","name":"Error : contact belongs to a batch","originalRequest":{"method":"DELETE","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{api_base_url}}/contact_manager/contacts/:id","host":["{{api_base_url}}"],"path":["contact_manager","contacts",":id"],"variable":[{"key":"id","value":"{{cm_contact_id}}","description":"Contact Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Oct 2018 14:21:26 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"135"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"status\": 400,\n \"code\": \"ERR_2030\",\n \"title\": \"Bad request\",\n \"detail\": \"Contact exists in at least one batch. Impossible to delete him\"\n }\n}"}],"_postman_id":"c9891e60-1308-44ef-85e8-0c648be20284"}],"id":"28766674-0f8f-40fb-bff3-d47fbe1536f5","description":"

Operations on the Contact Manager Contacts

Elements of the \"Contact\" object

“Contact” object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data type	Required?	Read Only?	Description
id	string	No	Yes	Contact ID.
base.id	string	Yes	No	Contacts database ID.
fields	object (Field)	Yes	No	List of the fields for the contact

“Field” sub-object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data type	Required?	Read Only?	Description
name	string	Yes	No	Field name. Remark : It is unique.
value	string	Tes	No	Field value.

Remark : only the fields with a non empty value are stored in the Contacts Database and thus returned by a query request.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"108a6fd2-a602-459b-b363-0f0bdb33e689"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"ea5798c6-18f1-4680-80da-8b1a5e5ad9d9"}}],"_postman_id":"28766674-0f8f-40fb-bff3-d47fbe1536f5"},{"name":"fields","item":[{"name":"Get Contact Manager Field","id":"fcdf9d6d-c1e6-44a3-aca5-487745aa931b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":"{{api_base_url}}/contact_manager/fields/:id","description":"

Retrieve the content of a field

\n","urlObject":{"path":["contact_manager","fields",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"5f9c1cf2-a637-46a5-b1f6-5d44140f702c","description":{"content":"

Field Id

\n","type":"text/plain"},"type":"any","value":"{{cm_field_id}}","key":"id"}]}},"response":[{"id":"ca3d9910-029c-4fd8-b058-ef53f590411f","name":"Retrieve the content of a field","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"url":{"raw":"{{api_base_url}}/contact_manager/fields/:id","host":["{{api_base_url}}"],"path":["contact_manager","fields",":id"],"variable":[{"key":"id","value":"{{cm_field_id}}","description":"Field Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{ \r\n \"id\": \"5c81117620175910e0002314\", \r\n \"base\": { \r\n \"id\": \"5c81114220175916f4005d5c\" \r\n }, \r\n \"name\": \"Contract\", \r\n \"label\": \"Contract\", \r\n \"datatype\": \"string\", \r\n \"type\": \"user\" \r\n}"}],"_postman_id":"fcdf9d6d-c1e6-44a3-aca5-487745aa931b"},{"name":"Update Contact Manager Field","id":"3c52e740-e283-4c71-9eaf-4e8e0c22c7cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"name\",\n \"label\": \"label\",\n \"datatype\": \"string\" \n}"},"url":"{{api_base_url}}/contact_manager/fields/:id","description":"

Edit a user-type field

Remark : You can only edit user type fields. Default type fields cannot be edited.

\n","urlObject":{"path":["contact_manager","fields",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"cdaa47e6-f24e-4fdd-be47-8e8f85a654b0","description":{"content":"

Field Id

\n","type":"text/plain"},"type":"any","value":"{{cm_field_id}}","key":"id"}]}},"response":[{"id":"553ccb42-6db4-485d-8bdf-f862b44db455","name":"Update a user-type field","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"New_Name\", \n \"label\": \"New name\", \n \"datatype\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/contact_manager/fields/:id","host":["{{api_base_url}}"],"path":["contact_manager","fields",":id"],"variable":[{"key":"id","value":"{{cm_field_id}}","description":"Field Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{ \r\n \"id\": \"5c81364a20175910e0002339\", \r\n \"base\": { \r\n \"id\": \"5c81114220175916f4005d5c\" \r\n }, \r\n \"name\": \"New_Name\", \r\n \"label\": \"New name\", \r\n \"datatype\": \"string\", \r\n \"type\": \"user\" \r\n}"}],"_postman_id":"3c52e740-e283-4c71-9eaf-4e8e0c22c7cc"},{"name":"Delete Contact Manager Field","id":"abd23021-6e8b-4efb-a34c-c0815d951a0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"body":{"mode":"raw","raw":""},"url":"{{api_base_url}}/contact_manager/fields/:id","description":"

Delete a user-type field

Remark : You can only delete user type fields. Default type fields cannot be deleted.

Answer codes

✓ \"204 No Content\" when there is no problem.

\n","urlObject":{"path":["contact_manager","fields",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"364763ce-9e55-4311-a83b-a3f0de363946","description":{"content":"

Field Id

\n","type":"text/plain"},"type":"any","value":"{{cm_field_id}}","key":"id"}]}},"response":[{"id":"4440697e-5ab9-4ec4-8969-2dca7fbe957d","name":"Delete a user-type field","originalRequest":{"method":"DELETE","header":[{"key":"Kiamo-Api-Token","value":"{{token_cm}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{api_base_url}}/contact_manager/fields/:id","host":["{{api_base_url}}"],"path":["contact_manager","fields",":id"],"variable":[{"key":"id","value":"{{cm_field_id}}","description":"Field Id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"abd23021-6e8b-4efb-a34c-c0815d951a0a"}],"id":"8db83373-9564-4bcd-b5c8-3ac9b6aa59cb","description":"

Operations on the fields

Elements of the \"Field\" object

“Field” object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data type	Required?	Read Only?	Description
id	string	No	Yes	Field ID.
base.id	string	Yes	No	ID of the database containing the field.
name	string	No	No	Field name. Remark : This name cannot contain accented or special characters.
label	string	No	No	Field label.
type	string	No	No	Field type: \"User\" or \"Default\". Remark : Default fields cannot be edited or deleted. You can only add user fields.
datatype	string	Yes	No	Field format : ✓ \"int\" ✓ \"date\" ✓ \"phone\" ✓ \"email\" ✓ \"string\"

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"cdc744e0-c40b-4982-9e8c-b77455b49c5b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"822598d4-4f27-4552-bca1-42b199448f18"}}],"_postman_id":"8db83373-9564-4bcd-b5c8-3ac9b6aa59cb"}],"id":"f717e568-bd37-484d-bfba-731701605075","description":"

API CONTACT MANAGER

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"5adff9e3-c363-484c-ad57-1b1b9e2878b9"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a913f49c-49f7-4c4b-9d99-886b09cba99f"}}],"_postman_id":"f717e568-bd37-484d-bfba-731701605075"},{"name":"interactions","item":[{"name":"interactions","item":[{"name":"Get Interactions","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"f85f033b-2686-4d09-a80e-f3eea9ce2898"}}],"id":"4a7e9ff5-6e60-4eed-b5cc-b43d153cb1ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Kiamo-Api-Token","value":"{{token_interactions}}"}],"url":"{{api_base_url}}/interactions?include=media","description":"

Retrieve all the interactions, whatever the media or the interaction status

Query parameters

Query parameters are a set of parameters placed in the URL in order to refine the results of your request.

The possible query parameters are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Description
include	string	To retrieve specific information about a media, you have to include the following parameter: include=media
contact_email	string	Contact’s email address.
contact_phone	number	Contact’s phone number.
contact_reference	string	Contact’s reference.
in_date_start	date	Date of start of entry of the interaction in Kiamo (yyyy mm dd [hh:mm] format or ISO8601 format).
in_date_end	date	Date of end of entry of the interaction in Kiamo (yyyy mm dd [hh:mm] format or ISO8601 format).
media	string	Type of media: ✓ call ✓ email ✓ messaging ✓ custom ✓ chat
attached_ref	number	Interaction AttachedRef.
interaction_ref	number	Interaction ID.
states	string	Status of the interaction. Remark: This element can have the following values: ✓ wait, ✓ work, ✓ done. Remark: To insert a list, use commas (e.g.: “wait,work”)
agent_ids	number	IDs of the agents to whom the interaction has been assigned or who processed the interaction.
service_ids	string	IDs of the services in which the interaction has been processed. Comma separated list (e.g.: 1,3,5).
next_id	string	ID of the interaction after which the next interactions will be returned.
tags	string	ID of the qualifications given to the interaction. Example: tags=1+7 to retrieve the interactions that have been qualified with the qualifications that have the ID 1 and 7.

Elements of the “Interactions” collection

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data type	Description
meta	object	Information about the result (e.g.: number of results, link to the following results...).
data	N Interaction Objects	Interaction table.

Example details

Here are some details about the provided examples.

1st example: Retrieve an email-type list of interactions
\n
Request example
\n
GET http://{{api_base_url}}/interactions/emails?include=media
\n
Answer
\n
This request returns a list of interactions with shared elements whatever the interaction type, and with specific elements depending on the type of media and the status of the interaction.
\n
Caution: This example only contains shared elements. Elements specific to each media type are detailed in the next chapters.
\n
Answer code
\n
The API returns code \"200 Ok\" when there is no problem.
\n
2nd example: Retrieve a list of processed interactions for a contact using his phone number
\n
Request example
\n
GET http://{{api_base_url}}/interactions?include=media&contact_phone=0556572020&states=done
\n
Answer
\n
This request returns the list of interactions that have been processed for the same contact, whatever the type of media.
\n
3rd example: Retrieve a list of interactions using the contact’s email address
\n
Request example
\n
GET http://{{api_base_url}}/interactions?include=media&contact_email=didier.martin@mycompany.com
\n
Answer
\n
This request returns the list of interactions for this contact, whatever the status of the interaction (See previous example).
\n
4th example: Retrieve a list of interactions using the contact’s reference
\n
Request example
\n
GET http://{{api_base_url}}/interactions?include=media&contact_reference=CDS784
\n
Answer
\n
This request returns the list of interactions for this contact, whatever the status of the interaction (See: 2nd example).
\n
5th example: Retrieve contact using several criteria (phone & email)
\n
Request example
\n
GET http://{{api_base_url}}/interactions?include=media&contact_email=didier.martin@mycompany.com&contact_phone=0175235698
\n
Answer
\n
This query request returns the list of interactions for contacts matching at least one of the defined criteria, whatever the status of the interaction.
\n
6th example: Retrieve a contact using several parameters of the same type
\n
You can combine several parameters of the same type: contact_email, contact_phone, contact_reference.
\n
You just have to add brackets after the parameter (e.g.: contact_reference[]).
\n
Request example
\n
GET http://{{api_base_url}}/interactions?include=media&contact_email[]=didier.martin@mycompany.com&contact_email[]=d.martin@myprivateemail.com
\n
Answer
\n
This request returns the list of interactions for contacts matching at least one of the defined parameters, whatever the status of the interaction.
\n
7th example: Retrieve a contact using several criteria and several parameters of the same type
\n
Request example
\n
GET http://{{api_base_url}}/interactions?include=media&contact_email[]=john.martin@mycompany.com&contact_email[]=d.martin@myprivateemail.com&contact_phone[]=0175235698&contact_reference[]=100153
\n
Remark: If a type of parameter is unique, brackets are not mandatory. Thus, you can also send the following request:
\n
GET http://{{api_base_url}}/interactions?include=media&contact_email[]=john.martin@mycompany.com&contact_email[]=d.martin@myprivateemail.com&contact_phone=0175235698&contact_reference[]=100153
\n
However, we recommend using brackets so as to avoid mistakes.
\n
Answer
\n
This request returns the list of interactions for contacts matching at least one of the defined criteria and/or one of the defined parameters, whatever the status of the interaction.
\n

\n","urlObject":{"path":["interactions"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

(optional) Include related media data

\n","type":"text/plain"},"key":"include","value":"media"},{"disabled":true,"key":"per_page","value":null},{"disabled":true,"key":"contact_phone","value":null},{"disabled":true,"key":"contact_email","value":null},{"disabled":true,"key":"contact_reference","value":null},{"disabled":true,"key":"company_reference","value":null},{"disabled":true,"key":"file_reference","value":null},{"disabled":true,"key":"ticket_reference","value":null},{"disabled":true,"key":"in_date_start","value":null},{"disabled":true,"key":"in_date_end","value":null},{"disabled":true,"key":"media","value":null},{"disabled":true,"key":"next_id","value":null},{"disabled":true,"key":"sort","value":null},{"disabled":true,"key":"task_ref","value":null},{"disabled":true,"key":"attached_ref","value":null},{"disabled":true,"key":"reference","value":null},{"disabled":true,"key":"states","value":null},{"disabled":true,"key":"service_ids","value":null},{"disabled":true,"key":"agent_ids","value":null},{"disabled":true,"key":"include_drafts","value":null}],"variable":[]}},"response":[{"id":"fffbc62c-0e76-4460-a576-deac2a6c266b","name":"Retrieve a contact using several parameters of the same type","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Kiamo-Api-Token","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions?contact_email[]=didier.martin@mycompa\nny.com&contact_email[]=d.martin@myprivateemail.com&include=media","host":["{{api_base_url}}"],"path":["interactions"],"query":[{"key":"per_page","value":null,"disabled":true},{"key":"contact_phone","value":null,"disabled":true},{"key":"contact_email","value":null,"disabled":true},{"key":"contact_reference","value":null,"disabled":true},{"key":"company_reference","value":null,"disabled":true},{"key":"file_reference","value":null,"disabled":true},{"key":"ticket_reference","value":null,"disabled":true},{"key":"in_date_start","value":null,"disabled":true},{"key":"in_date_end","value":null,"disabled":true},{"key":"media","value":null,"disabled":true},{"key":"next_id","value":null,"disabled":true},{"key":"sort","value":null,"disabled":true},{"key":"task_ref","value":null,"disabled":true},{"key":"attached_ref","value":null,"disabled":true},{"key":"reference","value":null,"disabled":true},{"key":"states","value":null,"disabled":true},{"key":"service_ids","value":null,"disabled":true},{"key":"agent_ids","value":null,"disabled":true},{"key":"include_drafts","value":null,"disabled":true},{"key":"contact_email[]","value":"didier.martin@mycompa\nny.com"},{"key":"contact_email[]","value":"d.martin@myprivateemail.com"},{"key":"include","value":"media"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"id\": \"5c7e9a6c49bfc6be58f99b1c\",\r\n \"task_ref\": 100051,\r\n \"interaction_ref\": null,\r\n \"attached_ref\": null,\r\n \"kiamo_in_date\": \"2019-03-05T15:49:00+0000\",\r\n \"batch_id\": \"\",\r\n \"duration\": {\r\n \"wait\": 0,\r\n \"work\": 0\r\n },\r\n \"label\": \"\",\r\n \"userdata\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100051/userdata\"\r\n }\r\n },\r\n \"state\": \"done\",\r\n \"reference\": \"\",\r\n \"notes\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100051/notes\"\r\n },\r\n \"count\": 0\r\n },\r\n \"tags\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100051/tags\"\r\n }\r\n },\r\n \"current_service\": {\r\n \"id\": 4,\r\n \"name\": \"CS Out calls\",\r\n \"distribution_mode\": \"stop\",\r\n \"type\": \"MCO\"\r\n },\r\n \"current_agent\": {\r\n \"id\": null,\r\n \"name\": \"\"\r\n },\r\n \"kiamo_out_date\": \"2019-03-05T15:49:01+0000\",\r\n \"scheduled_date\": null,\r\n \"media\": {\r\n \"type\": \"call\",\r\n \"cust_number\": \"0556572020\",\r\n \"cust_name\": \"\",\r\n \"cust_call_id\": null,\r\n \"telco_name\": \"\",\r\n \"sys_number\": \"\",\r\n \"used_sda\": \"\",\r\n \"result\": null\r\n }\r\n },\r\n {\r\n \"id\": \"5c7e9a1849bfc6be58f99af8\",\r\n \"task_ref\": 100050,\r\n \"interaction_ref\": null,\r\n \"attached_ref\": null,\r\n \"kiamo_in_date\": \"2019-03-05T15:47:36+0000\",\r\n \"batch_id\": \"\",\r\n \"duration\": {\r\n \"wait\": 0,\r\n \"work\": 0\r\n },\r\n \"label\": \"\",\r\n \"userdata\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100050/userdata\"\r\n }\r\n },\r\n \"state\": \"done\",\r\n \"reference\": \"\",\r\n \"notes\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100050/notes\"\r\n },\r\n \"count\": 0\r\n },\r\n \"tags\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100050/tags\"\r\n }\r\n },\r\n \"current_service\": {\r\n \"id\": 4,\r\n \"name\": \"CS Out calls\",\r\n \"distribution_mode\": \"stop\",\r\n \"type\": \"MCO\"\r\n },\r\n \"current_agent\": {\r\n \"id\": null,\r\n \"name\": \"\"\r\n },\r\n \"kiamo_out_date\": \"2019-03-05T15:47:36+0000\",\r\n \"scheduled_date\": null,\r\n \"media\": {\r\n \"type\": \"call\",\r\n \"cust_number\": \"0556572020\",\r\n \"cust_name\": \"\",\r\n \"cust_call_id\": null,\r\n \"telco_name\": \"\",\r\n \"sys_number\": \"\",\r\n \"used_sda\": \"\",\r\n \"result\": null\r\n }\r\n }\r\n ],\r\n \"meta\": {\r\n \"cursor\": {\r\n \"current\": \"5c7e9a6c49bfc6be58f99b1c\",\r\n \"prev\": null,\r\n \"next\": null,\r\n \"count\": 2\r\n }\r\n }\r\n}"},{"id":"0d6771be-c876-4ff0-95e8-f2c33c261e9b","name":"Retrieve all interactions with media info","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Kiamo-Api-Token","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions?include=media","host":["{{api_base_url}}"],"path":["interactions"],"query":[{"key":"include","value":"media"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 15 Oct 2018 15:26:56 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"4030"},{"key":"Keep-Alive","value":"timeout=5, max=499"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5bc4aa8b36a3372f6c002bd6\",\n \"task_ref\": 100060,\n \"interaction_ref\": null,\n \"attached_ref\": null,\n \"kiamo_in_date\": \"2018-10-15T14:56:11+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100060/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100060/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100060/tags\"\n }\n },\n \"current_service\": {\n \"id\": 3,\n \"name\": \"Messages entrants\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MESSAGINGIN\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"followup\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100060/followup\"\n }\n },\n \"media\": {\n \"type\": \"messaging\",\n \"messages\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/api/interactions/messaging/100060/messages\"\n },\n \"count\": 1\n },\n \"connectors\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/api/interactions/messaging/100060/connectors\"\n }\n }\n }\n },\n {\n \"id\": \"5bc4a6a036a3372a3400342c\",\n \"task_ref\": 100055,\n \"interaction_ref\": null,\n \"attached_ref\": 100055,\n \"kiamo_in_date\": \"2018-10-15T14:39:28+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100055/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100055/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100055/tags\"\n }\n },\n \"current_service\": {\n \"id\": 2,\n \"name\": \"Emails entrants\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MAILIN\"\n },\n \"current_agent\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"followup\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100055/followup\"\n }\n },\n \"media\": {\n \"type\": \"email\",\n \"object\": \"PJ\",\n \"is_draft\": false,\n \"studio\": {\n \"id\": null,\n \"tabId\": null,\n \"versionId\": null\n },\n \"content\": {\n \"html\": \"\\r\\n

Riad Chebel
Développeur WEB
T. +33 5 47 48 33 20
rchebel@conecteo.fr | www.conecteo.fr
Conecteo - 03 Allée Jacques Latrille - 33650 Martillac

\\r\\n

\\r\\n\",\n \"text\": \"\\r\\n-- \\r\\n*Riad Chebel*\\r\\n*Développeur WEB*\\r\\nT. +33 5 47 48 33 20\\r\\nrchebel@conecteo.fr | www.conecteo.fr\\r\\n*Conecteo* - 03 Allée Jacques Latrille - 33650 Martillac\\r\\n\",\n \"css\": \"\"\n },\n \"sent_at\": \"2015-10-08T10:42:40+0000\",\n \"from\": {\n \"name\": \"Riad Chebel\",\n \"address\": \"rchebel@conecteo.fr\"\n },\n \"to\": [\n {\n \"name\": \"\",\n \"address\": \"kiamodev_10@connecteo.fr\"\n }\n ],\n \"cc\": null,\n \"bcc\": null,\n \"replyTo\": [\n {\n \"name\": \"\",\n \"address\": \"rchebel@conecteo.fr\"\n }\n ],\n \"attachments\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/emails/100055/attachments?include=metadata\"\n },\n \"list\": [\n \"LicencesPHPStorm.pdf\",\n \"Rapport-TR0473SAN001 - DEVENIR TUTEUR ENTREPRISE_CLEFS DE LA REUSSITE-Riad-Chebel.pdf\",\n \"revocation-mandat-prelevement.pdf\"\n ]\n }\n }\n },\n {\n \"id\": \"5bc4a6a036a3372a3400342d\",\n \"task_ref\": 100057,\n \"interaction_ref\": null,\n \"attached_ref\": 100057,\n \"kiamo_in_date\": \"2018-10-15T14:39:28+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100057/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100057/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100057/tags\"\n }\n },\n \"current_service\": {\n \"id\": 2,\n \"name\": \"Emails entrants\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MAILIN\"\n },\n \"current_agent\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"followup\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100057/followup\"\n }\n },\n \"media\": {\n \"type\": \"email\",\n \"object\": \"Email simple\",\n \"is_draft\": false,\n \"studio\": {\n \"id\": null,\n \"tabId\": null,\n \"versionId\": null\n },\n \"content\": {\n \"html\": \"\\r\\n

Maecenas cursus arcu dui, eget rutrum est rutrum commodo. Aenean id tristique erat. Curabitur porttitor urna sit amet sagittis commodo. Etiam vestibulum metus nec metus commodo congue. Integer sodales mi libero, eget laoreet ipsum interdum et. Nullam sit amet eros neque. Ut neque diam, tincidunt vel accumsan ac, posuere placerat massa. Suspendisse malesuada lacus non nulla bibendum efficitur. Cras ac pretium neque. Morbi arcu ante, aliquam ac nisi vitae, molestie ullamcorper ex. Praesent maximus, mi blandit finibus suscipit, mi velit dapibus lacus, et rutrum neque eros vel arcu. Maecenas vitae accumsan mauris, sed euismod ante. Pellentesque tristique nunc in lorem viverra porta.

Riad Chebel
Développeur WEB
T. +33 5 47 48 33 20
rchebel@conecteo.fr | www.conecteo.fr
Conecteo - 03 Allée Jacques Latrille - 33650 Martillac

\\r\\n

\\r\\n\",\n \"text\": \"\\r\\nMaecenas cursus arcu dui, eget rutrum est rutrum commodo. Aenean id\\r\\ntristique erat. Curabitur porttitor urna sit amet sagittis commodo. Etiam\\r\\nvestibulum metus nec metus commodo congue. Integer sodales mi libero, eget\\r\\nlaoreet ipsum interdum et. Nullam sit amet eros neque. Ut neque diam,\\r\\ntincidunt vel accumsan ac, posuere placerat massa. Suspendisse malesuada\\r\\nlacus non nulla bibendum efficitur. Cras ac pretium neque. Morbi arcu ante,\\r\\naliquam ac nisi vitae, molestie ullamcorper ex. Praesent maximus, mi\\r\\nblandit finibus suscipit, mi velit dapibus lacus, et rutrum neque eros vel\\r\\narcu. Maecenas vitae accumsan mauris, sed euismod ante. Pellentesque\\r\\ntristique nunc in lorem viverra porta.\\r\\n\\r\\n-- \\r\\n*Riad Chebel*\\r\\n*Développeur WEB*\\r\\nT. +33 5 47 48 33 20\\r\\nrchebel@conecteo.fr | www.conecteo.fr\\r\\n*Conecteo* - 03 Allée Jacques Latrille - 33650 Martillac\\r\\n\",\n \"css\": \"\"\n },\n \"sent_at\": \"2015-11-27T16:25:02+0000\",\n \"from\": {\n \"name\": \"Riad Chebel\",\n \"address\": \"rchebel@conecteo.fr\"\n },\n \"to\": [\n {\n \"name\": \"\",\n \"address\": \"kiamodev_10@connecteo.fr\"\n }\n ],\n \"cc\": null,\n \"bcc\": null,\n \"replyTo\": [\n {\n \"name\": \"\",\n \"address\": \"rchebel@conecteo.fr\"\n }\n ],\n \"attachments\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/emails/100057/attachments?include=metadata\"\n },\n \"list\": []\n }\n }\n },\n {\n \"id\": \"5bc4a6a036a3372a3400342e\",\n \"task_ref\": 100056,\n \"interaction_ref\": null,\n \"attached_ref\": 100056,\n \"kiamo_in_date\": \"2018-10-15T14:39:28+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100056/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100056/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100056/tags\"\n }\n },\n \"current_service\": {\n \"id\": 2,\n \"name\": \"Emails entrants\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MAILIN\"\n },\n \"current_agent\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"followup\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100056/followup\"\n }\n },\n \"media\": {\n \"type\": \"email\",\n \"object\": \"Sans pièces jointes\",\n \"is_draft\": false,\n \"studio\": {\n \"id\": null,\n \"tabId\": null,\n \"versionId\": null\n },\n \"content\": {\n \"html\": \"\\r\\n

Test

\\r\\n

\\r\\n\",\n \"text\": \"\\r\\nTest\\r\\n\",\n \"css\": \"\"\n },\n \"sent_at\": \"2015-11-17T17:48:58+0000\",\n \"from\": {\n \"name\": \"Riad Chebel\",\n \"address\": \"rchebel@conecteo.fr\"\n },\n \"to\": [\n {\n \"name\": \"\",\n \"address\": \"kiamodev_10@connecteo.fr\"\n }\n ],\n \"cc\": null,\n \"bcc\": null,\n \"replyTo\": [\n {\n \"name\": \"\",\n \"address\": \"rchebel@conecteo.fr\"\n }\n ],\n \"attachments\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/emails/100056/attachments?include=metadata\"\n },\n \"list\": []\n }\n }\n },\n {\n \"id\": \"5bc4a6a036a3372a3400342f\",\n \"task_ref\": 100058,\n \"interaction_ref\": null,\n \"attached_ref\": 100008,\n \"kiamo_in_date\": \"2018-10-15T14:39:28+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100058/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100058/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100058/tags\"\n }\n },\n \"current_service\": {\n \"id\": 2,\n \"name\": \"Emails entrants\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MAILIN\"\n },\n \"current_agent\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"followup\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100058/followup\"\n }\n },\n \"media\": {\n \"type\": \"email\",\n \"object\": \"Re: [#100008] Email simple\",\n \"is_draft\": false,\n \"studio\": {\n \"id\": null,\n \"tabId\": null,\n \"versionId\": null\n },\n \"content\": {\n \"html\": \"\\r\\n

Client qui répond une nouvelle fois à l'agent

Le ven. 22 sept. 2017 à 10:32, kiamodev_10@connecteo.fr <kiamodev_10@connecteo.fr> a écrit :

Réponse de l'agent au client
\\r\\n

Riad Chebel
Lead développeur WEB
	rchebel@conecteo.fr
	+33 5 47 48 33 20
\\t

\\r\\n\",\n \"text\": \"\\r\\nClient qui répond une nouvelle fois à l'agent\\r\\n\\r\\nLe ven. 22 sept. 2017 à 10:32, kiamodev_10@connecteo.fr <\\r\\nkiamodev_10@connecteo.fr> a écrit :\\r\\n\\r\\n> Réponse de l'agent au client\\r\\n>\\r\\n-- \\r\\n\\r\\nRiad Chebel\\r\\nLead développeur WEB\\r\\nrchebel@conecteo.fr\\r\\n+33 5 47 48 33 20 <+33%205%2047%2048%2033%2020>\\r\\n \\r\\n \\r\\n\",\n \"css\": \"\"\n },\n \"sent_at\": \"2017-09-22T10:36:11+0000\",\n \"from\": {\n \"name\": \"Riad Chebel\",\n \"address\": \"rchebel@kiamo.fr\"\n },\n \"to\": [\n {\n \"name\": \"\",\n \"address\": \"kiamodev_10@connecteo.fr\"\n },\n {\n \"name\": \"\",\n \"address\": \"rchebel@conecteo.fr\"\n }\n ],\n \"cc\": null,\n \"bcc\": null,\n \"replyTo\": [\n {\n \"name\": \"\",\n \"address\": \"rchebel@kiamo.fr\"\n }\n ],\n \"attachments\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/emails/100058/attachments?include=metadata\"\n },\n \"list\": []\n }\n }\n },\n {\n \"id\": \"5bc4a6a036a3372a34003432\",\n \"task_ref\": 100059,\n \"interaction_ref\": null,\n \"attached_ref\": 100059,\n \"kiamo_in_date\": \"2018-10-15T14:39:28+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100059/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100059/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100059/tags\"\n }\n },\n \"current_service\": {\n \"id\": 2,\n \"name\": \"Emails entrants\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MAILIN\"\n },\n \"current_agent\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"followup\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100059/followup\"\n }\n },\n \"media\": {\n \"type\": \"email\",\n \"object\": \"Image imbriquée\",\n \"is_draft\": false,\n \"studio\": {\n \"id\": null,\n \"tabId\": null,\n \"versionId\": null\n },\n \"content\": {\n \"html\": \"\\r\\n

$\\\"Images$

Riad Chebel
Lead Web Développeur
	rchebel@conecteo.fr
	+33 5 47 48 33 20
$\\\"\\\"$ \\t $\\\"\\\"$ $\\\"\\\"$

\\r\\n

\\r\\n\",\n \"text\": \"\\r\\n[image: Images intégrées 1]\\r\\n\\r\\n-- \\r\\nRiad Chebel\\r\\nLead Web Développeur\\r\\nrchebel@conecteo.fr\\r\\n+33 5 47 48 33 20 <+33%205%2047%2048%2033%2020>\\r\\n \\r\\n\\r\\n\\r\\n\",\n \"css\": \"\"\n },\n \"sent_at\": \"2017-12-19T17:23:36+0000\",\n \"from\": {\n \"name\": \"Riad Chebel\",\n \"address\": \"rchebel@kiamo.fr\"\n },\n \"to\": [\n {\n \"name\": \"\",\n \"address\": \"kiamodev_10@connecteo.fr\"\n }\n ],\n \"cc\": null,\n \"bcc\": null,\n \"replyTo\": [\n {\n \"name\": \"\",\n \"address\": \"rchebel@kiamo.fr\"\n }\n ],\n \"attachments\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/emails/100059/attachments?include=metadata\"\n },\n \"list\": [\n \"apps.64129.9007199266525906.acce8029-3eaa-4e54-8be0-8cab962ba1c9.png\"\n ]\n }\n }\n },\n {\n \"id\": \"5bc4a69f36a3372a34003417\",\n \"task_ref\": 100053,\n \"interaction_ref\": null,\n \"attached_ref\": 100053,\n \"kiamo_in_date\": \"2018-10-15T14:39:27+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100053/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100053/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100053/tags\"\n }\n },\n \"current_service\": {\n \"id\": 2,\n \"name\": \"Emails entrants\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MAILIN\"\n },\n \"current_agent\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"followup\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100053/followup\"\n }\n },\n \"media\": {\n \"type\": \"email\",\n \"object\": \"Factures\",\n \"is_draft\": false,\n \"studio\": {\n \"id\": null,\n \"tabId\": null,\n \"versionId\": null\n },\n \"content\": {\n \"html\": \"\\r\\n

Bonjour,

Pouvez-vous me renvoyer la facture n°2254936 ?

Merci.

Riad Chebel
Responsable Technique
T. +33 5 47 48 33 20
rchebel@conecteo.fr | www.conecteo.fr
Conecteo - 03 Allée Jacques Latrille - 33650 Martillac

\\r\\n

\\r\\n\",\n \"text\": \"\\r\\nBonjour,\\r\\n\\r\\nPouvez-vous me renvoyer la facture n°2254936 ?\\r\\n\\r\\nMerci.\\r\\n\\r\\n-- \\r\\n*Riad Chebel*\\r\\n*Responsable Technique*\\r\\nT. +33 5 47 48 33 20\\r\\nrchebel@conecteo.fr | www.conecteo.fr\\r\\n*Conecteo* - 03 Allée Jacques Latrille - 33650 Martillac\\r\\n\",\n \"css\": \"\"\n },\n \"sent_at\": \"2014-12-29T16:24:16+0000\",\n \"from\": {\n \"name\": \"Riad Chebel\",\n \"address\": \"rchebel@conecteo.fr\"\n },\n \"to\": [\n {\n \"name\": \"\",\n \"address\": \"kiamodev_10@connecteo.fr\"\n }\n ],\n \"cc\": null,\n \"bcc\": null,\n \"replyTo\": [\n {\n \"name\": \"\",\n \"address\": \"rchebel@conecteo.fr\"\n }\n ],\n \"attachments\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/emails/100053/attachments?include=metadata\"\n },\n \"list\": [\n \"2-fiches.xls\"\n ]\n }\n }\n },\n {\n \"id\": \"5bc4a6a036a3372a3400341a\",\n \"task_ref\": 100054,\n \"interaction_ref\": null,\n \"attached_ref\": 100054,\n \"kiamo_in_date\": \"2018-10-15T14:39:27+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100054/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100054/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100054/tags\"\n }\n },\n \"current_service\": {\n \"id\": 2,\n \"name\": \"Emails entrants\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MAILIN\"\n },\n \"current_agent\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"followup\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100054/followup\"\n }\n },\n \"media\": {\n \"type\": \"email\",\n \"object\": \"Email avec des pièces jointes\",\n \"is_draft\": false,\n \"studio\": {\n \"id\": null,\n \"tabId\": null,\n \"versionId\": null\n },\n \"content\": {\n \"html\": \"\\r\\n

Bonjour...

Riad Chebel
Développeur WEB
T. +33 5 47 48 33 20
rchebel@conecteo.fr | www.conecteo.fr
Conecteo - 03 Allée Jacques Latrille - 33650 Martillac

\\r\\n

\\r\\n\",\n \"text\": \"\\r\\nBonjour...\\r\\n\\r\\n-- \\r\\n*Riad Chebel*\\r\\n*Développeur WEB*\\r\\nT. +33 5 47 48 33 20\\r\\nrchebel@conecteo.fr | www.conecteo.fr\\r\\n*Conecteo* - 03 Allée Jacques Latrille - 33650 Martillac\\r\\n\",\n \"css\": \"\"\n },\n \"sent_at\": \"2015-09-25T16:03:36+0000\",\n \"from\": {\n \"name\": \"Riad Chebel\",\n \"address\": \"rchebel@conecteo.fr\"\n },\n \"to\": [\n {\n \"name\": \"\",\n \"address\": \"kiamodev_10@connecteo.fr\"\n }\n ],\n \"cc\": null,\n \"bcc\": null,\n \"replyTo\": [\n {\n \"name\": \"\",\n \"address\": \"rchebel@conecteo.fr\"\n }\n ],\n \"attachments\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/emails/100054/attachments?include=metadata\"\n },\n \"list\": [\n \"setup-log-1.txt\",\n \"readonomy_export_team_459.html\",\n \"Webservice_gestion_erreur.zip\",\n \"Migration Redmine Flyspray.zip\",\n \"Ports Reseau Kiamo.xls\",\n \"error.log\"\n ]\n }\n }\n },\n {\n \"id\": \"5bbf424c57399e12bef7e0b9\",\n \"task_ref\": 100050,\n \"interaction_ref\": null,\n \"attached_ref\": 100050,\n \"kiamo_in_date\": \"2018-10-11T12:30:03+0000\",\n \"batch_id\": \"5bbdce2a36a3371038004f7b\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100050/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100050/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100050/tags\"\n }\n },\n \"current_service\": {\n \"id\": 1,\n \"name\": \"Campagne_sortante_1\",\n \"distribution_mode\": \"stop\",\n \"type\": \"CAMPOUT\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"followup\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100050/followup\"\n }\n },\n \"media\": {\n \"type\": \"call\",\n \"cust_number\": \"3708\",\n \"cust_call_id\": null,\n \"telco_name\": \"\",\n \"sys_number\": \"\",\n \"used_sda\": \"\"\n }\n }\n ],\n \"meta\": {\n \"cursor\": {\n \"current\": \"5bc4aa8b36a3372f6c002bd6\",\n \"prev\": null,\n \"next\": null,\n \"count\": 9\n }\n }\n}"},{"id":"985d5557-b043-4aa5-b18c-79cbc99070c2","name":"Retrieve contact using several criteria (phone & email)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Kiamo-Api-Token","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions?include=media&contact_phone=0123456789&contact_email=john.doo@mycompany.com","host":["{{api_base_url}}"],"path":["interactions"],"query":[{"key":"include","value":"media","description":"(optional) Include related media data"},{"key":"per_page","value":null,"disabled":true},{"key":"contact_phone","value":"0123456789"},{"key":"contact_email","value":"john.doo@mycompany.com"},{"key":"contact_reference","value":null,"disabled":true},{"key":"company_reference","value":null,"disabled":true},{"key":"file_reference","value":null,"disabled":true},{"key":"ticket_reference","value":null,"disabled":true},{"key":"in_date_start","value":null,"disabled":true},{"key":"in_date_end","value":null,"disabled":true},{"key":"media","value":null,"disabled":true},{"key":"next_id","value":null,"disabled":true},{"key":"sort","value":null,"disabled":true},{"key":"task_ref","value":null,"disabled":true},{"key":"attached_ref","value":null,"disabled":true},{"key":"reference","value":null,"disabled":true},{"key":"states","value":null,"disabled":true},{"key":"service_ids","value":null,"disabled":true},{"key":"agent_ids","value":null,"disabled":true},{"key":"include_drafts","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"id\": \"5c7e9a6c49bfc6be58f99b1c\",\r\n \"task_ref\": 100051,\r\n \"interaction_ref\": null,\r\n \"attached_ref\": null,\r\n \"kiamo_in_date\": \"2019-03-05T15:49:00+0000\",\r\n \"batch_id\": \"\",\r\n \"duration\": {\r\n \"wait\": 0,\r\n \"work\": 0\r\n },\r\n \"label\": \"\",\r\n \"userdata\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100051/userdata\"\r\n }\r\n },\r\n \"state\": \"done\",\r\n \"reference\": \"\",\r\n \"notes\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100051/notes\"\r\n },\r\n \"count\": 0\r\n },\r\n \"tags\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100051/tags\"\r\n }\r\n },\r\n \"current_service\": {\r\n \"id\": 4,\r\n \"name\": \"CS Out calls\",\r\n \"distribution_mode\": \"stop\",\r\n \"type\": \"MCO\"\r\n },\r\n \"current_agent\": {\r\n \"id\": null,\r\n \"name\": \"\"\r\n },\r\n \"kiamo_out_date\": \"2019-03-05T15:49:01+0000\",\r\n \"scheduled_date\": null,\r\n \"media\": {\r\n \"type\": \"call\",\r\n \"cust_number\": \"0556572020\",\r\n \"cust_name\": \"\",\r\n \"cust_call_id\": null,\r\n \"telco_name\": \"\",\r\n \"sys_number\": \"\",\r\n \"used_sda\": \"\",\r\n \"result\": null\r\n }\r\n },\r\n {\r\n \"id\": \"5c7e9a1849bfc6be58f99af8\",\r\n \"task_ref\": 100050,\r\n \"interaction_ref\": null,\r\n \"attached_ref\": null,\r\n \"kiamo_in_date\": \"2019-03-05T15:47:36+0000\",\r\n \"batch_id\": \"\",\r\n \"duration\": {\r\n \"wait\": 0,\r\n \"work\": 0\r\n },\r\n \"label\": \"\",\r\n \"userdata\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100050/userdata\"\r\n }\r\n },\r\n \"state\": \"done\",\r\n \"reference\": \"\",\r\n \"notes\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100050/notes\"\r\n },\r\n \"count\": 0\r\n },\r\n \"tags\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100050/tags\"\r\n }\r\n },\r\n \"current_service\": {\r\n \"id\": 4,\r\n \"name\": \"CS Out calls\",\r\n \"distribution_mode\": \"stop\",\r\n \"type\": \"MCO\"\r\n },\r\n \"current_agent\": {\r\n \"id\": null,\r\n \"name\": \"\"\r\n },\r\n \"kiamo_out_date\": \"2019-03-05T15:47:36+0000\",\r\n \"scheduled_date\": null,\r\n \"media\": {\r\n \"type\": \"call\",\r\n \"cust_number\": \"0556572020\",\r\n \"cust_name\": \"\",\r\n \"cust_call_id\": null,\r\n \"telco_name\": \"\",\r\n \"sys_number\": \"\",\r\n \"used_sda\": \"\",\r\n \"result\": null\r\n }\r\n }\r\n ],\r\n \"meta\": {\r\n \"cursor\": {\r\n \"current\": \"5c7e9a6c49bfc6be58f99b1c\",\r\n \"prev\": null,\r\n \"next\": null,\r\n \"count\": 2\r\n }\r\n }\r\n}"},{"id":"b53bb797-cf24-4b41-80dd-2c1b409883f4","name":"Retrieve all interactions","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Kiamo-Api-Token","value":"{{token_interactions}}"}],"url":"{{api_base_url}}/interactions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 15 Oct 2018 15:14:53 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"724"},{"key":"Keep-Alive","value":"timeout=5, max=499"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5bc4aa8b36a3372f6c002bd6\",\n \"task_ref\": 100060,\n \"interaction_ref\": null,\n \"attached_ref\": null,\n \"kiamo_in_date\": \"2018-10-15T14:56:11+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100060/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100060/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100060/tags\"\n }\n },\n \"current_service\": {\n \"id\": 3,\n \"name\": \"Messages entrants\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MESSAGINGIN\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"followup\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100060/followup\"\n }\n }\n },\n {\n \"id\": \"5bc4a6a036a3372a3400342c\",\n \"task_ref\": 100055,\n \"interaction_ref\": null,\n \"attached_ref\": 100055,\n \"kiamo_in_date\": \"2018-10-15T14:39:28+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100055/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100055/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100055/tags\"\n }\n },\n \"current_service\": {\n \"id\": 2,\n \"name\": \"Emails entrants\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MAILIN\"\n },\n \"current_agent\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"followup\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100055/followup\"\n }\n }\n },\n {\n \"id\": \"5bc4a6a036a3372a3400342d\",\n \"task_ref\": 100057,\n \"interaction_ref\": null,\n \"attached_ref\": 100057,\n \"kiamo_in_date\": \"2018-10-15T14:39:28+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100057/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100057/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100057/tags\"\n }\n },\n \"current_service\": {\n \"id\": 2,\n \"name\": \"Emails entrants\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MAILIN\"\n },\n \"current_agent\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"followup\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100057/followup\"\n }\n }\n },\n {\n \"id\": \"5bc4a6a036a3372a3400342e\",\n \"task_ref\": 100056,\n \"interaction_ref\": null,\n \"attached_ref\": 100056,\n \"kiamo_in_date\": \"2018-10-15T14:39:28+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100056/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100056/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100056/tags\"\n }\n },\n \"current_service\": {\n \"id\": 2,\n \"name\": \"Emails entrants\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MAILIN\"\n },\n \"current_agent\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"followup\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100056/followup\"\n }\n }\n },\n {\n \"id\": \"5bc4a6a036a3372a3400342f\",\n \"task_ref\": 100058,\n \"interaction_ref\": null,\n \"attached_ref\": 100008,\n \"kiamo_in_date\": \"2018-10-15T14:39:28+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100058/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100058/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100058/tags\"\n }\n },\n \"current_service\": {\n \"id\": 2,\n \"name\": \"Emails entrants\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MAILIN\"\n },\n \"current_agent\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"followup\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100058/followup\"\n }\n }\n },\n {\n \"id\": \"5bc4a6a036a3372a34003432\",\n \"task_ref\": 100059,\n \"interaction_ref\": null,\n \"attached_ref\": 100059,\n \"kiamo_in_date\": \"2018-10-15T14:39:28+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100059/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100059/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100059/tags\"\n }\n },\n \"current_service\": {\n \"id\": 2,\n \"name\": \"Emails entrants\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MAILIN\"\n },\n \"current_agent\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"followup\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100059/followup\"\n }\n }\n },\n {\n \"id\": \"5bc4a69f36a3372a34003417\",\n \"task_ref\": 100053,\n \"interaction_ref\": null,\n \"attached_ref\": 100053,\n \"kiamo_in_date\": \"2018-10-15T14:39:27+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100053/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100053/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100053/tags\"\n }\n },\n \"current_service\": {\n \"id\": 2,\n \"name\": \"Emails entrants\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MAILIN\"\n },\n \"current_agent\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"followup\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100053/followup\"\n }\n }\n },\n {\n \"id\": \"5bc4a6a036a3372a3400341a\",\n \"task_ref\": 100054,\n \"interaction_ref\": null,\n \"attached_ref\": 100054,\n \"kiamo_in_date\": \"2018-10-15T14:39:27+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100054/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100054/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100054/tags\"\n }\n },\n \"current_service\": {\n \"id\": 2,\n \"name\": \"Emails entrants\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MAILIN\"\n },\n \"current_agent\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"followup\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100054/followup\"\n }\n }\n },\n {\n \"id\": \"5bbf424c57399e12bef7e0b9\",\n \"task_ref\": 100050,\n \"interaction_ref\": null,\n \"attached_ref\": 100050,\n \"kiamo_in_date\": \"2018-10-11T12:30:03+0000\",\n \"batch_id\": \"5bbdce2a36a3371038004f7b\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100050/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100050/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100050/tags\"\n }\n },\n \"current_service\": {\n \"id\": 1,\n \"name\": \"Campagne_sortante_1\",\n \"distribution_mode\": \"stop\",\n \"type\": \"CAMPOUT\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"followup\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100050/followup\"\n }\n }\n }\n ],\n \"meta\": {\n \"cursor\": {\n \"current\": \"5bc4aa8b36a3372f6c002bd6\",\n \"prev\": null,\n \"next\": null,\n \"count\": 9\n }\n }\n}"},{"id":"585ee6de-8d10-44ea-a11b-c210d334af4f","name":"Retrieve a contact using several criteria and several parameters of the same type","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Kiamo-Api-Token","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions?contact_email[]=john.martin@mycompany\n.com&contact_email[]=d.martin@myprivateemail.com&contact_phone[]=0175235698&contact_referenc\ne[]=100153&include=media","host":["{{api_base_url}}"],"path":["interactions"],"query":[{"key":"per_page","value":null,"disabled":true},{"key":"contact_phone","value":null,"disabled":true},{"key":"contact_email","value":null,"disabled":true},{"key":"contact_reference","value":null,"disabled":true},{"key":"company_reference","value":null,"disabled":true},{"key":"file_reference","value":null,"disabled":true},{"key":"ticket_reference","value":null,"disabled":true},{"key":"in_date_start","value":null,"disabled":true},{"key":"in_date_end","value":null,"disabled":true},{"key":"media","value":null,"disabled":true},{"key":"next_id","value":null,"disabled":true},{"key":"sort","value":null,"disabled":true},{"key":"task_ref","value":null,"disabled":true},{"key":"attached_ref","value":null,"disabled":true},{"key":"reference","value":null,"disabled":true},{"key":"states","value":null,"disabled":true},{"key":"service_ids","value":null,"disabled":true},{"key":"agent_ids","value":null,"disabled":true},{"key":"include_drafts","value":null,"disabled":true},{"key":"contact_email[]","value":"john.martin@mycompany\n.com"},{"key":"contact_email[]","value":"d.martin@myprivateemail.com"},{"key":"contact_phone[]","value":"0175235698"},{"key":"contact_referenc\ne[]","value":"100153"},{"key":"include","value":"media"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5c7e9a6c49bfc6be58f99b1c\",\n \"task_ref\": 100051,\n \"interaction_ref\": null,\n \"attached_ref\": null,\n \"kiamo_in_date\": \"2019-03-05T15:49:00+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/api/v2/interactions/100051/userdata\"\n }\n },\n \"state\": \"done\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/api/v2/interactions/100051/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/api/v2/interactions/100051/tags\"\n }\n },\n \"current_service\": {\n \"id\": 4,\n \"name\": \"CS Out calls\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MCO\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": \"2019-03-05T15:49:01+0000\",\n \"scheduled_date\": null,\n \"media\": {\n \"type\": \"call\",\n \"cust_number\": \"0556572020\",\n \"cust_name\": \"\",\n \"cust_call_id\": null,\n \"telco_name\": \"\",\n \"sys_number\": \"\",\n \"used_sda\": \"\",\n \"result\": null\n }\n },\n {\n \"id\": \"5c7e9a1849bfc6be58f99af8\",\n \"task_ref\": 100050,\n \"interaction_ref\": null,\n \"attached_ref\": null,\n \"kiamo_in_date\": \"2019-03-05T15:47:36+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/api/v2/interactions/100050/userdata\"\n }\n },\n \"state\": \"done\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/api/v2/interactions/100050/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/api/v2/interactions/100050/tags\"\n }\n },\n \"current_service\": {\n \"id\": 4,\n \"name\": \"CS Out calls\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MCO\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": \"2019-03-05T15:47:36+0000\",\n \"scheduled_date\": null,\n \"media\": {\n \"type\": \"call\",\n \"cust_number\": \"0556572020\",\n \"cust_name\": \"\",\n \"cust_call_id\": null,\n \"telco_name\": \"\",\n \"sys_number\": \"\",\n \"used_sda\": \"\",\n \"result\": null\n }\n }\n ],\n \"meta\": {\n \"cursor\": {\n \"current\": \"5c7e9a6c49bfc6be58f99b1c\",\n \"prev\": null,\n \"next\": null,\n \"count\": 2\n }\n }\n}"},{"id":"c43cd29d-2502-4150-b3bf-a22298971102","name":"Retrieve a list of processed interactions for a contact using his phone number","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Kiamo-Api-Token","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions?include=media&contact_phone=0123456789&states=done","host":["{{api_base_url}}"],"path":["interactions"],"query":[{"key":"include","value":"media","description":"(optional) Include related media data"},{"key":"per_page","value":null,"disabled":true},{"key":"contact_phone","value":"0123456789"},{"key":"contact_email","value":null,"disabled":true},{"key":"contact_reference","value":null,"disabled":true},{"key":"company_reference","value":null,"disabled":true},{"key":"file_reference","value":null,"disabled":true},{"key":"ticket_reference","value":null,"disabled":true},{"key":"in_date_start","value":null,"disabled":true},{"key":"in_date_end","value":null,"disabled":true},{"key":"media","value":null,"disabled":true},{"key":"next_id","value":null,"disabled":true},{"key":"sort","value":null,"disabled":true},{"key":"task_ref","value":null,"disabled":true},{"key":"attached_ref","value":null,"disabled":true},{"key":"reference","value":null,"disabled":true},{"key":"states","value":"done"},{"key":"service_ids","value":null,"disabled":true},{"key":"agent_ids","value":null,"disabled":true},{"key":"include_drafts","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{ \r\n \"data\": [ \r\n { \r\n \"id\": \"5c7e9a6c49bfc6be58f99b1c\", \r\n \"task_ref\": 100051, \r\n \"interaction_ref\": null, \r\n \"attached_ref\": null, \r\n \"kiamo_in_date\": \"2019-03-05T15:49:00+0000\", \r\n \"batch_id\": \"\", \r\n \"duration\": { \r\n \"wait\": 0, \r\n \"work\": 0 \r\n }, \r\n \"label\": \"\",\r\n \"userdata\": { \r\n \"link\": { \r\n \"rel\": \"related\", \r\n \"href\": \"/api/v2/interactions/100051/userdata\" \r\n } \r\n }, \r\n \"state\": \"done\", \r\n \"reference\": \"\", \r\n \"notes\": { \r\n \"link\": { \r\n \"rel\": \"related\", \r\n \"href\": \"/api/v2/interactions/100051/notes\" \r\n }, \r\n \"count\": 0 \r\n },\r\n \"tags\": { \r\n \"link\": { \r\n \"rel\": \"related\", \r\n \"href\": \"/api/v2/interactions/100051/tags\" \r\n } \r\n }, \r\n \"current_service\": { \r\n \"id\": 4, \r\n \"name\": \"CS Out calls\", \r\n \"distribution_mode\": \"stop\", \r\n \"type\": \"MCO\" \r\n }, \r\n \"current_agent\": { \r\n \"id\": null, \r\n \"name\": \"\" \r\n }, \r\n \"kiamo_out_date\": \"2019-03-05T15:49:01+0000\", \r\n \"scheduled_date\": null, \r\n \"media\": { \r\n \"type\": \"call\", \r\n \"cust_number\": \"0556572020\", \r\n \"cust_name\": \"\", \r\n \"cust_call_id\": null, \r\n \"telco_name\": \"\", \r\n \"sys_number\": \"\", \r\n \"used_sda\": \"\", \r\n \"result\": null \r\n } \r\n },\r\n { \r\n \"id\": \"5c7e9a1849bfc6be58f99af8\", \r\n \"task_ref\": 100050, \r\n \"interaction_ref\": null, \r\n \"attached_ref\": null, \r\n \"kiamo_in_date\": \"2019-03-05T15:47:36+0000\", \r\n \"batch_id\": \"\", \r\n \"duration\": { \r\n \"wait\": 0, \r\n \"work\": 0 \r\n }, \r\n \"label\": \"\", \r\n \"userdata\": { \r\n \"link\": { \r\n \"rel\": \"related\", \r\n \"href\": \"/api/v2/interactions/100050/userdata\" \r\n } \r\n },\r\n \"state\": \"done\", \r\n \"reference\": \"\", \r\n \"notes\": { \r\n \"link\": { \r\n \"rel\": \"related\", \r\n \"href\": \"/api/v2/interactions/100050/notes\" \r\n }, \r\n \"count\": 0 \r\n }, \r\n \"tags\": { \r\n \"link\": { \r\n \"rel\": \"related\", \r\n \"href\": \"/api/v2/interactions/100050/tags\" \r\n } \r\n }, \r\n \"current_service\": { \r\n \"id\": 4, \r\n \"name\": \"CS Out calls\", \r\n \"distribution_mode\": \"stop\", \r\n \"type\": \"MCO\" \r\n }, \r\n \"current_agent\": { \r\n \"id\": null, \r\n \"name\": \"\" \r\n }, \r\n \"kiamo_out_date\": \"2019-03-05T15:47:36+0000\", \r\n \"scheduled_date\": null, \r\n \"media\": { \r\n \"type\": \"call\", \r\n \"cust_number\": \"0556572020\", \r\n \"cust_name\": \"\", \r\n \"cust_call_id\": null, \r\n \"telco_name\": \"\", \r\n \"sys_number\": \"\", \r\n \"used_sda\": \"\", \r\n \"result\": null \r\n } \r\n } \r\n ], \r\n \"meta\": { \r\n \"cursor\": { \r\n \"current\": \"5c7e9a6c49bfc6be58f99b1c\", \r\n \"prev\": null, \r\n \"next\": null, \r\n \"count\": 2 \r\n } \r\n } \r\n}"},{"id":"7b8da853-8db8-44c5-a8bf-81aad53c1765","name":"Retrieve a list of interactions using the contact’s reference","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Kiamo-Api-Token","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions?include=media&contact_reference=CDS784","host":["{{api_base_url}}"],"path":["interactions"],"query":[{"key":"include","value":"media","description":"(optional) Include related media data"},{"key":"per_page","value":null,"disabled":true},{"key":"contact_phone","value":null,"disabled":true},{"key":"contact_email","value":null,"disabled":true},{"key":"contact_reference","value":"CDS784"},{"key":"company_reference","value":null,"disabled":true},{"key":"file_reference","value":null,"disabled":true},{"key":"ticket_reference","value":null,"disabled":true},{"key":"in_date_start","value":null,"disabled":true},{"key":"in_date_end","value":null,"disabled":true},{"key":"media","value":null,"disabled":true},{"key":"next_id","value":null,"disabled":true},{"key":"sort","value":null,"disabled":true},{"key":"task_ref","value":null,"disabled":true},{"key":"attached_ref","value":null,"disabled":true},{"key":"reference","value":null,"disabled":true},{"key":"states","value":null,"disabled":true},{"key":"service_ids","value":null,"disabled":true},{"key":"agent_ids","value":null,"disabled":true},{"key":"include_drafts","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"id\": \"5c7e9a6c49bfc6be58f99b1c\",\r\n \"task_ref\": 100051,\r\n \"interaction_ref\": null,\r\n \"attached_ref\": null,\r\n \"kiamo_in_date\": \"2019-03-05T15:49:00+0000\",\r\n \"batch_id\": \"\",\r\n \"duration\": {\r\n \"wait\": 0,\r\n \"work\": 0\r\n },\r\n \"label\": \"\",\r\n \"userdata\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100051/userdata\"\r\n }\r\n },\r\n \"state\": \"done\",\r\n \"reference\": \"\",\r\n \"notes\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100051/notes\"\r\n },\r\n \"count\": 0\r\n },\r\n \"tags\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100051/tags\"\r\n }\r\n },\r\n \"current_service\": {\r\n \"id\": 4,\r\n \"name\": \"CS Out calls\",\r\n \"distribution_mode\": \"stop\",\r\n \"type\": \"MCO\"\r\n },\r\n \"current_agent\": {\r\n \"id\": null,\r\n \"name\": \"\"\r\n },\r\n \"kiamo_out_date\": \"2019-03-05T15:49:01+0000\",\r\n \"scheduled_date\": null,\r\n \"media\": {\r\n \"type\": \"call\",\r\n \"cust_number\": \"0556572020\",\r\n \"cust_name\": \"\",\r\n \"cust_call_id\": null,\r\n \"telco_name\": \"\",\r\n \"sys_number\": \"\",\r\n \"used_sda\": \"\",\r\n \"result\": null\r\n }\r\n },\r\n {\r\n \"id\": \"5c7e9a1849bfc6be58f99af8\",\r\n \"task_ref\": 100050,\r\n \"interaction_ref\": null,\r\n \"attached_ref\": null,\r\n \"kiamo_in_date\": \"2019-03-05T15:47:36+0000\",\r\n \"batch_id\": \"\",\r\n \"duration\": {\r\n \"wait\": 0,\r\n \"work\": 0\r\n },\r\n \"label\": \"\",\r\n \"userdata\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100050/userdata\"\r\n }\r\n },\r\n \"state\": \"done\",\r\n \"reference\": \"\",\r\n \"notes\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100050/notes\"\r\n },\r\n \"count\": 0\r\n },\r\n \"tags\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100050/tags\"\r\n }\r\n },\r\n \"current_service\": {\r\n \"id\": 4,\r\n \"name\": \"CS Out calls\",\r\n \"distribution_mode\": \"stop\",\r\n \"type\": \"MCO\"\r\n },\r\n \"current_agent\": {\r\n \"id\": null,\r\n \"name\": \"\"\r\n },\r\n \"kiamo_out_date\": \"2019-03-05T15:47:36+0000\",\r\n \"scheduled_date\": null,\r\n \"media\": {\r\n \"type\": \"call\",\r\n \"cust_number\": \"0556572020\",\r\n \"cust_name\": \"\",\r\n \"cust_call_id\": null,\r\n \"telco_name\": \"\",\r\n \"sys_number\": \"\",\r\n \"used_sda\": \"\",\r\n \"result\": null\r\n }\r\n }\r\n ],\r\n \"meta\": {\r\n \"cursor\": {\r\n \"current\": \"5c7e9a6c49bfc6be58f99b1c\",\r\n \"prev\": null,\r\n \"next\": null,\r\n \"count\": 2\r\n }\r\n }\r\n}"},{"id":"277d0ed3-637b-4c0c-9947-8450784025b2","name":"Retrieve a list of interactions using the contact’s email address","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Kiamo-Api-Token","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions?include=media&contact_email=didier.martin@mycompany.com","host":["{{api_base_url}}"],"path":["interactions"],"query":[{"key":"include","value":"media","description":"(optional) Include related media data"},{"key":"per_page","value":null,"disabled":true},{"key":"contact_phone","value":null,"disabled":true},{"key":"contact_email","value":"didier.martin@mycompany.com"},{"key":"contact_reference","value":null,"disabled":true},{"key":"company_reference","value":null,"disabled":true},{"key":"file_reference","value":null,"disabled":true},{"key":"ticket_reference","value":null,"disabled":true},{"key":"in_date_start","value":null,"disabled":true},{"key":"in_date_end","value":null,"disabled":true},{"key":"media","value":null,"disabled":true},{"key":"next_id","value":null,"disabled":true},{"key":"sort","value":null,"disabled":true},{"key":"task_ref","value":null,"disabled":true},{"key":"attached_ref","value":null,"disabled":true},{"key":"reference","value":null,"disabled":true},{"key":"states","value":null,"disabled":true},{"key":"service_ids","value":null,"disabled":true},{"key":"agent_ids","value":null,"disabled":true},{"key":"include_drafts","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"id\": \"5c7e9a6c49bfc6be58f99b1c\",\r\n \"task_ref\": 100051,\r\n \"interaction_ref\": null,\r\n \"attached_ref\": null,\r\n \"kiamo_in_date\": \"2019-03-05T15:49:00+0000\",\r\n \"batch_id\": \"\",\r\n \"duration\": {\r\n \"wait\": 0,\r\n \"work\": 0\r\n },\r\n \"label\": \"\",\r\n \"userdata\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100051/userdata\"\r\n }\r\n },\r\n \"state\": \"done\",\r\n \"reference\": \"\",\r\n \"notes\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100051/notes\"\r\n },\r\n \"count\": 0\r\n },\r\n \"tags\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100051/tags\"\r\n }\r\n },\r\n \"current_service\": {\r\n \"id\": 4,\r\n \"name\": \"CS Out calls\",\r\n \"distribution_mode\": \"stop\",\r\n \"type\": \"MCO\"\r\n },\r\n \"current_agent\": {\r\n \"id\": null,\r\n \"name\": \"\"\r\n },\r\n \"kiamo_out_date\": \"2019-03-05T15:49:01+0000\",\r\n \"scheduled_date\": null,\r\n \"media\": {\r\n \"type\": \"call\",\r\n \"cust_number\": \"0556572020\",\r\n \"cust_name\": \"\",\r\n \"cust_call_id\": null,\r\n \"telco_name\": \"\",\r\n \"sys_number\": \"\",\r\n \"used_sda\": \"\",\r\n \"result\": null\r\n }\r\n },\r\n {\r\n \"id\": \"5c7e9a1849bfc6be58f99af8\",\r\n \"task_ref\": 100050,\r\n \"interaction_ref\": null,\r\n \"attached_ref\": null,\r\n \"kiamo_in_date\": \"2019-03-05T15:47:36+0000\",\r\n \"batch_id\": \"\",\r\n \"duration\": {\r\n \"wait\": 0,\r\n \"work\": 0\r\n },\r\n \"label\": \"\",\r\n \"userdata\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100050/userdata\"\r\n }\r\n },\r\n \"state\": \"done\",\r\n \"reference\": \"\",\r\n \"notes\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100050/notes\"\r\n },\r\n \"count\": 0\r\n },\r\n \"tags\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100050/tags\"\r\n }\r\n },\r\n \"current_service\": {\r\n \"id\": 4,\r\n \"name\": \"CS Out calls\",\r\n \"distribution_mode\": \"stop\",\r\n \"type\": \"MCO\"\r\n },\r\n \"current_agent\": {\r\n \"id\": null,\r\n \"name\": \"\"\r\n },\r\n \"kiamo_out_date\": \"2019-03-05T15:47:36+0000\",\r\n \"scheduled_date\": null,\r\n \"media\": {\r\n \"type\": \"call\",\r\n \"cust_number\": \"0556572020\",\r\n \"cust_name\": \"\",\r\n \"cust_call_id\": null,\r\n \"telco_name\": \"\",\r\n \"sys_number\": \"\",\r\n \"used_sda\": \"\",\r\n \"result\": null\r\n }\r\n }\r\n ],\r\n \"meta\": {\r\n \"cursor\": {\r\n \"current\": \"5c7e9a6c49bfc6be58f99b1c\",\r\n \"prev\": null,\r\n \"next\": null,\r\n \"count\": 2\r\n }\r\n }\r\n}"}],"_postman_id":"4a7e9ff5-6e60-4eed-b5cc-b43d153cb1ae"},{"name":"Get Interaction","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"e016024e-cf5d-4397-bcfd-3b368485cfaf"}}],"id":"2ebfac1b-6531-43b9-9a63-1cbda03126e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Kiamo-Api-Token","value":"{{token_interactions}}"}],"url":"{{api_base_url}}/interactions/:ref","description":"

Retrieve an interaction

Query parameters

The possible query parameters are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Description
include	string	To retrieve specific information about a media, you have to include the following parameter: include=media

Remark : For outbound call campaigns, the \"media\" object includes a \"result\" parameter used to know why a task has been closed. The possible values are available in the Interaction object description (see upper).

Answer codes

✓ “200 Ok” when there is no problem.

✓ “404 Not Found” if the interaction could not be found.

\n","urlObject":{"path":["interactions",":ref"],"host":["{{api_base_url}}"],"query":[{"disabled":true,"description":{"content":"

(optional) Include related media data

\n","type":"text/plain"},"key":"include","value":"media"}],"variable":[{"id":"292841b3-e334-45fd-b9ed-8eef1a1af351","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[{"id":"05e3d5be-9923-491a-92af-2e6d7336f813","name":"Answer example for an outbound call campaign (media object includes result)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Kiamo-Api-Token","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions/:ref","host":["{{api_base_url}}"],"path":["interactions",":ref"],"query":[{"key":"include","value":"media","description":"(optional) Include related media data","disabled":true}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{ \r\n \"id\": \"5c826c743f3a302386346a4e\", \r\n \"task_ref\": 100150, \r\n \"interaction_ref\": null, \r\n \"attached_ref\": 100150, \r\n \"kiamo_in_date\": \"2019-03-08T13:21:56+0000\", \r\n \"batch_id\": \"0\", \r\n \"duration\": { \r\n \"wait\": 0, \r\n \"work\": 0 \r\n }, \r\n \"label\": \"\", \r\n \"userdata\": { \r\n \"link\": { \r\n \"rel\": \"related\", \r\n \"href\": \"/api/v2/interactions/100150/userdata\" \r\n } \r\n }, \r\n \"state\": \"done\", \r\n \"reference\": \"\", \r\n \"notes\": { \r\n \"link\": { \r\n \"rel\": \"related\", \r\n \"href\": \"/api/v2/interactions/100150/notes\" \r\n }, \r\n \"count\": 0 \r\n }, \r\n \"tags\": { \r\n \"link\": { \r\n \"rel\": \"related\", \r\n \"href\": \"/api/v2/interactions/100150/tags\" \r\n }\r\n }, \r\n \"current_service\": { \r\n \"id\": 17, \r\n \"name\": \"Customer service outbound campaign\", \r\n \"distribution_mode\": \"manual\", \r\n \"type\": \"CAMPOUT\" \r\n }, \r\n \"current_agent\": { \r\n \"id\": null, \r\n \"name\": \"\" \r\n }, \r\n \"kiamo_out_date\": \"2019-03-08T13:22:29+0000\", \r\n \"scheduled_date\": null, \r\n \"media\": { \r\n \"type\": \"call\", \r\n \"cust_number\": \"0123456789\", \r\n \"cust_name\": \"\", \r\n \"cust_call_id\": null, \r\n \"telco_name\": \"TELCOCSCSTEST\", \r\n \"sys_number\": \"\", \r\n \"used_sda\": \"\", \r\n \"result\": \"ANOMALY\" \r\n } \r\n}"},{"id":"a4f8559e-a412-44a7-bc6d-376a44ea11d3","name":"Retrieve information about a specific interaction","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Kiamo-Api-Token","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions/:ref","host":["{{api_base_url}}"],"path":["interactions",":ref"],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 15 Oct 2018 15:32:21 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"359"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c7ea3d949bfc6be58f99c92\", \n \"task_ref\": 100054, \n \"interaction_ref\": null, \n \"attached_ref\": 100054, \n \"kiamo_in_date\": \"2019-03-05T16:29:13+0000\", \n \"batch_id\": \"0\", \n \"duration\": { \n \"wait\": 0, \n \"work\": 0 \n }, \n \"label\": \"\", \n \"userdata\": { \n \"link\": { \n \"rel\": \"related\", \n \"href\": \"/api/v2/interactions/100054/userdata\" \n } \n }, \n \"state\": \"wait\", \n \"reference\": \"\", \n \"notes\": { \n \"link\": { \n \"rel\": \"related\", \n \"href\": \"/api/v2/interactions/100054/notes\" \n }, \n \"count\": 0 \n }, \n \"tags\": { \n \"link\": { \n \"rel\": \"related\", \n \"href\": \"/api/v2/interactions/100054/tags\" \n } \n }, \n \"current_service\": { \n \"id\": 5, \n \"name\": \"Task distribution SC\", \n \"distribution_mode\": \"manual\", \n \"type\": \"MRA\" \n }, \n \"current_agent\": { \n \"id\": null, \n \"name\": \"\" \n }, \n \"kiamo_out_date\": null, \n \"scheduled_date\": null, \n \"media\": { \n \"type\": \"custom\" \n }\n}"}],"_postman_id":"2ebfac1b-6531-43b9-9a63-1cbda03126e5"},{"name":"Search Interactions","id":"07d63ee0-3ceb-43a2-b3dd-a850dfc24976","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Kiamo-Api-Token","value":"{{token_interactions}}"}],"url":"{{api_base_url}}/interactions/search?include=media","description":"

Search for interactions

Query parameters

Remark: The default pagination value is 50. This value can be modified by using the per_page query parameter. See the pagination mechanism and parameters description upper.

The possible query parameters are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Description
include	string	To retrieve specific information about a media, you have to include the following parameter: include=media
in_date_start	date	Date of start of entry of the interaction in Kiamo (yyyy mm dd [hh:mm] format or ISO8601 format).
in_date_end	date	Date of end of entry of the interaction in Kiamo (yyyy mm dd [hh:mm] format or ISO8601 format).
media	string	Type of media: ✓ call ✓ email ✓ messaging ✓ custom ✓ chat
attached_ref	number	Interaction AttachedRef.
interaction_ref	number	Interaction ID.
states	string	Status of the interaction. Remark: This element can have the following values: ✓ wait, ✓ work, ✓ done. Remark: To insert a list, use commas (e.g.: “wait,work”)
agent_ids	number	IDs of the agents to whom the interaction has been assigned or who processed the interaction.
service_ids	string	IDs of the services in which the interaction has been processed. Comma separated list (e.g.: 1,3,5).

","urlObject":{"path":["interactions","search"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

(optional) Include related media data

\n","type":"text/plain"},"key":"include","value":"media"},{"disabled":true,"key":"per_page","value":null},{"disabled":true,"key":"query","value":null},{"disabled":true,"key":"in_date_start","value":null},{"disabled":true,"key":"in_date_end","value":null},{"disabled":true,"key":"media","value":null},{"disabled":true,"key":"next_id","value":null},{"disabled":true,"key":"sort","value":null},{"disabled":true,"key":"task_ref","value":null},{"disabled":true,"key":"attached_ref","value":null},{"disabled":true,"key":"reference","value":null},{"disabled":true,"key":"states","value":null},{"disabled":true,"key":"service_ids","value":null},{"disabled":true,"key":"agent_ids","value":null},{"disabled":true,"key":"include_drafts","value":null}],"variable":[]}},"response":[{"id":"ae9b8da5-58ff-486e-976b-24d2be433aff","name":"Retrieve all the interactions in the \"To process\" status","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Kiamo-Api-Token","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions/search?include=media&states=wait","host":["{{api_base_url}}"],"path":["interactions","search"],"query":[{"key":"include","value":"media","description":"(optional) Include related media data"},{"key":"per_page","value":null,"disabled":true},{"key":"query","value":null,"disabled":true},{"key":"in_date_start","value":null,"disabled":true},{"key":"in_date_end","value":null,"disabled":true},{"key":"media","value":null,"disabled":true},{"key":"next_id","value":null,"disabled":true},{"key":"sort","value":null,"disabled":true},{"key":"task_ref","value":null,"disabled":true},{"key":"attached_ref","value":null,"disabled":true},{"key":"reference","value":null,"disabled":true},{"key":"states","value":"wait"},{"key":"service_ids","value":null,"disabled":true},{"key":"agent_ids","value":null,"disabled":true},{"key":"include_drafts","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{ \r\n \"data\": [ \r\n { \r\n \"id\": \"5c7ea3d949bfc6be58f99c97\", \r\n \"task_ref\": 100055, \r\n \"interaction_ref\": null, \r\n \"attached_ref\": 100055, \r\n \"kiamo_in_date\": \"2019-03-05T16:29:13+0000\", \r\n \"batch_id\": \"0\", \r\n \"duration\": { \r\n \"wait\": 0, \r\n \"work\": 20 \r\n }, \r\n \"label\": \"\", \r\n \"userdata\": { \r\n \"link\": { \r\n \"rel\": \"related\", \r\n \"href\": \"/api/v2/interactions/100055/userdata\" \r\n } \r\n }, \r\n \"state\": \"wait\", \r\n \"reference\": \"\", \r\n \"notes\": { \r\n \"link\": { \r\n \"rel\": \"related\", \r\n \"href\": \"/api/v2/interactions/100055/notes\" \r\n }, \r\n \"count\": 0 \r\n }, \r\n \"tags\": { \r\n \"link\": { \r\n \"rel\": \"related\", \r\n \"href\": \"/api/v2/interactions/100055/tags\" \r\n } \r\n }, \r\n \"current_service\": { \r\n \"id\": 5, \r\n \"name\": \"Task distribution SC\", \r\n \"distribution_mode\": \"manual\", \r\n \"type\": \"MRA\" \r\n }, \r\n \"current_agent\": { \r\n \"id\": null, \r\n \"name\": \"\" \r\n }, \r\n \"kiamo_out_date\": null, \r\n \"scheduled_date\": \"2019-03-05T16:29:41+0000\", \r\n \"media\": { \r\n \"type\": \"custom\" \r\n } \r\n }, \r\n { \r\n \"id\": \"5c7e5b432017591a480017bd\", \r\n \"task_ref\": 100047, \r\n \"interaction_ref\": null, \r\n \"attached_ref\": 100039, \r\n \"kiamo_in_date\": \"2019-03-05T11:19:31+0000\", \r\n \"batch_id\": \"\", \r\n \"duration\": { \r\n \"wait\": 0, \r\n \"work\": 40 \r\n }, \r\n \"label\": \"\", \r\n \"userdata\": { \r\n \"link\": { \r\n \"rel\": \"related\", \r\n \"href\": \"/api/v2/interactions/100047/userdata\" \r\n } \r\n }, \r\n \"state\": \"wait\", \r\n \"reference\": \"\", \r\n \"notes\": { \r\n \"link\": { \r\n \"rel\": \"related\", \r\n \"href\": \"/api/v2/interactions/100047/notes\" \r\n }, \r\n \"count\": 0 \r\n }, \r\n \"tags\": { \r\n \"link\": { \r\n \"rel\": \"related\", \r\n \"href\": \"/api/v2/interactions/100047/tags\" \r\n } \r\n }, \r\n \"current_service\": { \r\n \"id\": 2, \r\n \"name\": \"Customer service emails\", \r\n \"distribution_mode\": \"manual\", \r\n \"type\": \"MAILIN\"\r\n }, \r\n \"current_agent\": { \r\n \"id\": null, \r\n \"name\": \"\" \r\n }, \r\n \"kiamo_out_date\": null, \r\n \"scheduled_date\": \"2019-03-05T11:22:40+0000\", \r\n \"media\": { \r\n \"type\": \"email\", \r\n \"object\": \"[#100039] Home insurance\", \r\n \"is_draft\": false, \r\n \"studio\": { \r\n \"id\": null, \r\n \"tabId\": null, \r\n \"versionId\": null \r\n }, \r\n \"content\": {}, \r\n \"sent_at\": \"2019-03-05T11:10:14+0000\", \r\n \"from\": { \r\n \"name\": \"vbe\", \r\n \"address\": \"vbe@connecteo.com\" \r\n }, \r\n \"to\": [ \r\n { \r\n \"name\": \"\", \r\n \"address\": \"vbe@connecteo.com\" \r\n } \r\n ], \r\n \"cc\": null, \r\n \"bcc\": null, \r\n \"replyTo\": [ \r\n { \r\n \"name\": \"\", \r\n \"address\": \"vbe@connecteo.com\" \r\n } \r\n ], \r\n \"direction\": \"in\", \r\n \"attachments\": { \r\n \"link\": { \r\n \"rel\": \"related\", \r\n \"href\": \"/api/v2/interactions/emails/100047/attachments?include=metadata\" \r\n }, \r\n \"list\": [] \r\n }, \r\n \"draft\": { \r\n \"ref\": \"100049\", \r\n \"link\": { \r\n \"rel\": \"related\", \r\n \"href\": \"/api/v2/interactions/emails/100049\" \r\n } \r\n } \r\n } \r\n },\r\n ],\r\n \"meta\": { \r\n \"cursor\": { \r\n \"current\": \"5c7ea3d949bfc6be58f99c97\", \r\n \"prev\": null, \r\n \"next\": null, \r\n \"count\": 11 \r\n } \r\n } \r\n}"}],"_postman_id":"07d63ee0-3ceb-43a2-b3dd-a850dfc24976"},{"name":"Create Interaction Notes","id":"65ac79ba-df7b-4c38-a609-5812a2598247","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n\t{\n\t\t\"content\" : \"Note 1\",\n\t\t\"agent\": {\n\t\t\t\"id\" : 1\n\t\t}\n\t},\n\t{\n\t\t\"content\" : \"Note 2\",\n\t\t\"agent\": {\n\t\t\t\"id\" : 1\n\t\t}\n\t}\n]"},"url":"{{api_base_url}}/interactions/:ref/notes","description":"

Add notes to an interaction

Remark: the JSON body is composed of an array of notes.

Caution: the agent's ID is mandatory.

Answer codes

✓ “201 Created” when there is no problem.

✓ “400 Bad request” if the content is not valid (e.g.: Invalid JSON).

\n","urlObject":{"path":["interactions",":ref","notes"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"bb4592ac-d526-428b-82e0-d18065e7408e","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[{"id":"0eb214cc-fb0d-4d55-9e9d-bbafe89cefe8","name":"Add several notes to an interaction","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"content\": \"My first add with the API\",\n \"agent\": {\n \"id\": 4\n }\n },\n {\n \"content\": \"My second note using the API\",\n \"agent\": {\n \"id\": 1\n }\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/:ref/notes","host":["{{api_base_url}}"],"path":["interactions",":ref","notes"],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 15:53:53 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"168"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5c80e9212017590fec005af4\",\n \"agent\": {\n \"id\": \"4\",\n \"name\": \"Aileen\"\n },\n \"content\": \"My note for this interaction\",\n \"created_at\": \"2019-03-07T09:49:21+0000\",\n \"updated_at\": \"2019-03-07T09:49:21+0000\"\n },\n {\n \"id\": \"5c80ea2f20175916f4005d58\",\n \"agent\": {\n \"id\": 4,\n \"name\": \"Aileen\"\n },\n \"content\": \"My first add with the API\",\n \"created_at\": \"2019-03-07T09:53:51+0000\",\n \"updated_at\": \"2019-03-07T09:53:51+0000\"\n },\n {\n \"id\": \"5c80ea2f20175916f4005d5a\",\n \"agent\": {\n \"id\": 1,\n \"name\": \"David\"\n },\n \"content\": \"My second note using the API\",\n \"created_at\": \"2019-03-07T09:53:51+0000\",\n \"updated_at\": \"2019-03-07T09:53:51+0000\"\n }\n ]\n}"}],"_postman_id":"65ac79ba-df7b-4c38-a609-5812a2598247"},{"name":"Get Interaction Notes","id":"f1d0b521-8095-4f51-b2fc-6e004350c5b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/:ref/notes","description":"

Retrieve all the notes associated with a specific interaction

Answer codes

✓ “200 Ok” when there is no problem.

✓ “404 Not Found” if the interaction or service does not exist.

\n","urlObject":{"path":["interactions",":ref","notes"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"8b8ccfd9-9d34-452e-9ed5-8561f83bfa7a","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[{"id":"ca3116a0-6e1b-4364-8cea-09a0687f5b8b","name":"Retrieve all the notes associated with a specific interaction","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions/:ref/notes","host":["{{api_base_url}}"],"path":["interactions",":ref","notes"],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5c80e9212017590fec005af4\",\n \"agent\": {\n \"id\": \"4\",\n \"name\": \"Aileen\"\n },\n \"content\": \"My note about this interaction\",\n \"created_at\": \"2019-03-07T09:49:21+0000\",\n \"updated_at\": \"2019-03-07T09:49:21+0000\"\n }\n ]\n}"}],"_postman_id":"f1d0b521-8095-4f51-b2fc-6e004350c5b8"},{"name":"Update Interaction Note","id":"8ad666d6-0995-456a-9d43-c34b30947de2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"content\": \"Edited note content\",\n \"agent\": {\n \"id\": 4\n }\n}"},"url":"{{api_base_url}}/interactions/:ref/notes/:id","description":"

Edit a note for a specific interaction

Remark: To get the ID of a note, use a GET request on the “Notes” resource.

Answer codes

✓ “200 OK” when there is no problem.

✓ “400 Bad Request” if the “agent” node is provided but the “id” parameter is missing or the agent does not exist in the Kiamo configuration.

\n","urlObject":{"path":["interactions",":ref","notes",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"18a97e53-76a5-407c-8f2b-0a7994703f46","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"},{"id":"3c985766-de3b-49ed-8a25-c73a17e51693","description":{"content":"

Note Id

\n","type":"text/plain"},"type":"any","value":"{{note_id}}","key":"id"}]}},"response":[{"id":"09ff52b5-2a46-481a-ae1d-cc8f02d1a301","name":"Update the agent assigned to a note","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"agent\" : {\n\t\t\"id\": 2\n\t},\n\t\"content\": \"Note 2 updated\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/:ref/notes/:id","host":["{{api_base_url}}"],"path":["interactions",":ref","notes",":id"],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"},{"key":"id","value":"{{note_id}}","description":"Note Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 16:21:59 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"183"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5c1bbb118fa13445bd0063e7\",\n \"agent\": {\n \"id\": 2,\n \"name\": \"New_Agent_2\"\n },\n \"content\": \"Note 2 updated\",\n \"created_at\": \"2018-12-20T15:53:53+0000\",\n \"updated_at\": \"2018-12-20T16:22:01+0000\"\n },\n {\n \"id\": \"5c1bbb128fa13445bd0063e9\",\n \"agent\": {\n \"id\": \"1\",\n \"name\": \"New_Agent_1\"\n },\n \"content\": \"Note 2\",\n \"created_at\": \"2018-12-20T15:53:54+0000\",\n \"updated_at\": \"2018-12-20T15:53:54+0000\"\n }\n ]\n}"},{"id":"4c48104d-80ec-4e7f-bccb-b56be14c868e","name":"Update a note content","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"content\" : \"Note 2 updated\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/:ref/notes/:id","host":["{{api_base_url}}"],"path":["interactions",":ref","notes",":id"],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"},{"key":"id","value":"{{note_id}}","description":"Note Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 16:06:56 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"178"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5c1bbb118fa13445bd0063e7\",\n \"agent\": {\n \"id\": \"1\",\n \"name\": \"New_Agent_1\"\n },\n \"content\": \"Note 2 updated\",\n \"created_at\": \"2018-12-20T15:53:53+0000\",\n \"updated_at\": \"2018-12-20T16:07:02+0000\"\n },\n {\n \"id\": \"5c1bbb128fa13445bd0063e9\",\n \"agent\": {\n \"id\": \"1\",\n \"name\": \"New_Agent_1\"\n },\n \"content\": \"Note 2\",\n \"created_at\": \"2018-12-20T15:53:54+0000\",\n \"updated_at\": \"2018-12-20T15:53:54+0000\"\n }\n ]\n}"}],"_postman_id":"8ad666d6-0995-456a-9d43-c34b30947de2"},{"name":"Delete Interaction Note","id":"217f34d2-bdaf-478a-9773-b6e9003c0a46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{api_base_url}}/interactions/:ref/notes/:id","description":"

Delete an interaction note

Answer codes

✓ “204 No Content” when there is no problem.

\n","urlObject":{"path":["interactions",":ref","notes",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"f149aeec-da03-430e-945c-0fda10f4d30d","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"},{"id":"4fb98c25-39fc-49a6-9588-7592d537ad65","description":{"content":"

Note Id

\n","type":"text/plain"},"type":"any","value":"{{note_id}}","key":"id"}]}},"response":[{"id":"13e94f06-6d25-4610-85b4-e97356f63492","name":"Delete a note","originalRequest":{"method":"DELETE","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{api_base_url}}/interactions/:ref/notes/:id","host":["{{api_base_url}}"],"path":["interactions",":ref","notes",":id"],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"},{"key":"id","value":"{{note_id}}","description":"Note Id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Thu, 20 Dec 2018 16:26:43 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"217f34d2-bdaf-478a-9773-b6e9003c0a46"},{"name":"Create Interaction Tags","id":"b7770f32-1f18-42e5-89ec-8ef683e723ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": 1,\n \"service_id\": 3,\n \"agent_id\": 1,\n \"level\": \"primary\"\n}"},"url":"{{api_base_url}}/interactions/:ref/tags","description":"

Create an interaction tag

Caution: If you want to add qualifications to an interaction, you have to send the request before the end of wrap up time for a call or before the end of processing time for the other types of tasks. If not done in time, the added qualifications will not be taken into account in the Kiamo statistical reports.

Remark: The level propriety is optional and can have the following values:

✓ primary (default value, if nothing is specified): main qualification,

✓ secondary: Additional qualification.

Answer codes

✓ “200 Ok” when there is no problem.

✓ “400 Bad Request” if the content is not valid (e.g.: Invalid JSON), if an attribute is missing or if the service, the agent or the qualification provided does not exist in the Kiamo configuration.

✓ “404 Not Found” if the interaction or service does not exist.

\n","urlObject":{"path":["interactions",":ref","tags"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"c9bcfd9b-c299-4b22-a127-f4819560ab17","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[{"id":"44771c2b-7de2-4f92-9d8b-88b1e8e76ab2","name":"Add a qualification to an interaction","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": 1,\n \"service_id\": 3,\n \"agent_id\": 1,\n \"level\": \"primary\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/:ref/tags","host":["{{api_base_url}}"],"path":["interactions",":ref","tags"],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Dec 2018 08:41:26 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"125"},{"key":"Keep-Alive","value":"timeout=5, max=499"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"label\": \"Qualification A\",\n \"services\": {\n \"id\": 3,\n \"name\": \"Tasks Distribution 1\",\n \"agent\": {\n \"id\": 1,\n \"name\": \"New_Agent_1\"\n }\n }\n }\n ]\n}"}],"_postman_id":"b7770f32-1f18-42e5-89ec-8ef683e723ce"},{"name":"Get Interaction Tags","id":"9362b997-d48c-48a7-9a70-acab225a5ab3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/:ref/tags?service_id=3","description":"

Retrieve interaction tags

Query parameters

The possible query parameters are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Description
service_id	number	ID of the service.
agent_id	number	Agent’s ID.

Result

Remark: The “agent” property can be null when the interaction is qualified automatically.

\n","urlObject":{"path":["interactions",":ref","tags"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

Service Id

\n","type":"text/plain"},"key":"service_id","value":"3"},{"disabled":true,"description":{"content":"

Agent Id

\n","type":"text/plain"},"key":"agent_id","value":null}],"variable":[{"id":"0e3845e4-2493-4e72-96f1-be988132eb4a","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[{"id":"c9dc12fc-0415-40a8-9db0-e56f28f6f309","name":"Retrieve the qualifications given by a specific agent to an interaction","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions/:ref/tags?agent_id=2","host":["{{api_base_url}}"],"path":["interactions",":ref","tags"],"query":[{"key":"agent_id","value":"2"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 16:51:32 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"125"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 2,\n \"label\": \"B\",\n \"services\": {\n \"id\": 3,\n \"name\": \"Tasks distribution 1\",\n \"agent\": {\n \"id\": 2,\n \"name\": \"New_Agent_2\"\n }\n }\n }\n ]\n}"},{"id":"638a84e5-6b88-480f-a4af-764ac9f60b86","name":"Retrieve all the tags of an interaction","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions/:ref/tags","host":["{{api_base_url}}"],"path":["interactions",":ref","tags"],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 16:50:38 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"142"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"label\": \"A\",\n \"services\": {\n \"id\": 3,\n \"name\": \"Tasks distribution 1\",\n \"agent\": {\n \"id\": 1,\n \"name\": \"New_Agent_1\"\n }\n }\n },\n {\n \"id\": 2,\n \"label\": \"B\",\n \"services\": {\n \"id\": 3,\n \"name\": \"Tasks distribution 1\",\n \"agent\": {\n \"id\": 2,\n \"name\": \"New_Agent_2\"\n }\n }\n }\n ]\n}"},{"id":"323e4a2d-8230-4b4a-818c-a71fb88ef7d2","name":"Retrieve the qualifications given on a specific service","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions/:ref/tags?service_id=3","host":["{{api_base_url}}"],"path":["interactions",":ref","tags"],"query":[{"key":"service_id","value":"3"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 16:52:07 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"142"},{"key":"Keep-Alive","value":"timeout=5, max=498"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"label\": \"A\",\n \"services\": {\n \"id\": 3,\n \"name\": \"Tasks distribution 1\",\n \"agent\": {\n \"id\": 1,\n \"name\": \"New_Agent_1\"\n }\n }\n },\n {\n \"id\": 2,\n \"label\": \"B\",\n \"services\": {\n \"id\": 3,\n \"name\": \"Tasks distribution 1\",\n \"agent\": {\n \"id\": 2,\n \"name\": \"New_Agent_2\"\n }\n }\n }\n ]\n}"}],"_postman_id":"9362b997-d48c-48a7-9a70-acab225a5ab3"},{"name":"Delete Interaction Tags","id":"c0037742-75c2-424a-8133-9801d87525c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{api_base_url}}/interactions/:ref/tags","description":"

Delete interaction tags

Query parameters

The possible query parameters are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Description
service_id	number	(Optional) ID of the service.
agent_id	number	(Optional) Agent’s ID.

Outcome

Depending on the parameters, the outcome is:

No parameter : deletion of all the tags linked to the related inteaction,
agent_id : deletion of all the tags given by a specific agent to the related interaction,
service_id : deletion of all the tags given while processing on a specific service,
agent_id et service_id : deletion of all the tags of an interaction given by a specific agent while processing the interaction in a specific service.

Answer codes

✓ “204 No Content” when there is no problem.

✓ “400” if the content is not valid (e.g.: Invalid JSON), if an attribute is missing or if the service, the agent or the qualification provided does not exist in the Kiamo configuration.

✓ “404” if the interaction does not exist.

\n","urlObject":{"path":["interactions",":ref","tags"],"host":["{{api_base_url}}"],"query":[{"disabled":true,"description":{"content":"

(optional) Service Id

\n","type":"text/plain"},"key":"service_id","value":null},{"disabled":true,"description":{"content":"

(optional) Agent Id

\n","type":"text/plain"},"key":"agent_id","value":null}],"variable":[{"id":"5455354c-5695-4a7e-958b-d7358e4434c0","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[{"id":"a2fac476-1566-4a62-be3e-443d1868e937","name":"Delete all the qualifications of an interaction","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{api_base_url}}/interactions/:ref/tags","host":["{{api_base_url}}"],"path":["interactions",":ref","tags"],"query":[{"key":"service_id","value":null,"description":"(optional) Service Id","disabled":true},{"key":"agent_id","value":null,"description":"(optional) Agent Id","disabled":true}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"60d2eec8-5862-46b1-9611-aef3085a7720","name":"Delete all the qualifications of an interaction given by a specific agent while processing the interaction in a specific service","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{api_base_url}}/interactions/:ref/tags?service_id=8&agent_id=4","host":["{{api_base_url}}"],"path":["interactions",":ref","tags"],"query":[{"key":"service_id","value":"8","description":"(optional) Service Id"},{"key":"agent_id","value":"4","description":"(optional) Agent Id"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c0037742-75c2-424a-8133-9801d87525c3"},{"name":"Get Interactions Drafts","id":"5b131287-a9a1-4ab0-ba73-e84e18418b9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Kiamo-Api-Token","value":"{{token_interactions}}"}],"url":"{{api_base_url}}/interactions/drafts?include=media","description":"

Retrieve interaction drafts

Query parameters

The possible query parameters are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Description
include	media
per_page	number
state	wait,work,done
in_date_start	start date
in_date_end	end date
media	media
next_id	`#FIXME` next id
sort	ascending / descending sort of a field
task_ref	taskRef
attached_ref	taskRef
reference	taskRef
states	states
service_ids	ID of the services
agent_ids	ID of the agents
include_drafts	drafts included

Remark: To retrieve the data specific to the media, the parameter include=media must be set.

\n","urlObject":{"path":["interactions","drafts"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

(optional) Include related media data

\n","type":"text/plain"},"key":"include","value":"media"},{"disabled":true,"key":"per_page","value":null},{"disabled":true,"key":"state","value":null},{"disabled":true,"key":"in_date_start","value":null},{"disabled":true,"key":"in_date_end","value":null},{"disabled":true,"key":"media","value":null},{"disabled":true,"key":"next_id","value":null},{"disabled":true,"key":"sort","value":null},{"disabled":true,"key":"task_ref","value":null},{"disabled":true,"key":"attached_ref","value":null},{"disabled":true,"key":"reference","value":null},{"disabled":true,"key":"states","value":null},{"disabled":true,"key":"service_ids","value":null},{"disabled":true,"key":"agent_ids","value":null},{"disabled":true,"key":"include_drafts","value":null}],"variable":[]}},"response":[],"_postman_id":"5b131287-a9a1-4ab0-ba73-e84e18418b9b"},{"name":"Get Interaction Userdata","id":"9a159496-3e78-4eea-9ae5-d3c80ea0d15b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/:ref/userdata","description":"

Retrieve interaction userdata

\n","urlObject":{"path":["interactions",":ref","userdata"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"a75dca69-aa92-407b-84a2-f01eb7aece51","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[{"id":"bbad29dc-d2c8-4b0e-9a29-6d94b27969cd","name":"Retrieve interaction userdata","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":{"raw":"{{api_base_url}}/interactions/:ref/userdata","host":["{{api_base_url}}"],"path":["interactions",":ref","userdata"],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Dec 2018 08:46:48 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"57"},{"key":"Keep-Alive","value":"timeout=5, max=499"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"name\": \"Qualification A\",\n \"value\": \"my_value\"\n }\n ]\n}"}],"_postman_id":"9a159496-3e78-4eea-9ae5-d3c80ea0d15b"},{"name":"Get Interaction Followup","id":"8dba0a31-664d-42c6-bd86-cfe11223a66e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/:ref/followup","description":"

Retrieve interaction followup

\n","urlObject":{"path":["interactions",":ref","followup"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"5009c2ac-ac87-4b2a-beb7-4de93b46a9ff","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[],"_postman_id":"8dba0a31-664d-42c6-bd86-cfe11223a66e"}],"id":"83a743e3-c984-41e5-a868-cce46b08d4d3","description":"

Operations on the interactions

Elements of the \"Interaction\" object

“Interaction” object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data type	Description
id	string	Unique interaction ID.
taskref	number	Kiamo interaction ID.
attached_ref	number	Interaction AttachedRef.
interaction_ref	number	Unique interaction ID.
states	string	Status of the interaction. Remark: This element can have the following values: ✓ wait, ✓ work, ✓ done, ✓ draft. Remark: The “done” value is the only value accepted when editing.
current_agent	object	Name and ID of the agent: ✓ To whom the interaction has been assigned, ✓ Who is processing/ who processed the interaction.
current_service	object	Name and ID of the service: ✓ In which is the interaction to process, ✓ In which the interaction has been processed.
services	array	Table with the list of services through which went the interaction. Each entry has the following pieces of information: ✓ service (name, ID, entry/end date in the service) ✓ agent ( agent’s name and ID) ✓ exit_reason (reason why the interaction left the service) ✓ wait (waiting time in the service) ✓ work (time spent processing the interaction in the service)
kiamo_in_date	dateTime	Date of entry of the interaction in Kiamo. Date provided in ISO8601 format.
kiamo_out_date	dateTime	Date of closure of the interaction in Kiamo. Date provided in ISO8601 format.
media	object	Interaction media type: ✓ call ✓ email ✓ messaging ✓ chat ✓ custom Remark: For outbound call campaigns, the \"media\" object includes a \"result\" element, which details the reason why a call is closed: ✓ ANOMALY: The agent who processed the call changed status to “Anomaly”. ✓ ANSWERINGMACHINE: Answering machine detection. ✓ BUSY: busy. ✓ CANCELED: task closed before being distributed to an agent. ✓ DONE: successful call. ✓ FAXMACHINE: Fax detection. ✓ NOANSWER : No customer answer. ✓ NOCHANNEL : No channel available. ✓ NUISANCE_AGENTDISCONRING: Agent hung up while on the phone with the customer. ✓ NUISANCE_CUSTDISCONRING: Customer hung up while the agent’s phone was ringing, when customers are called before agents. ✓ NUISANCE_WQCUSTDISC: Call has reached the maximum wait time, when customers are called before agents and when the agent does not answer within the given time. ✓ PREVIEWREFUSED: Preview rejected by the agent, when the Preview mode and the Allow agent to reject call option have been selected in the campaign. ✓ SCENARIOFAILURE: Multi dialing scenario. ✓ SCENARIO_FAILURE: Multi dialing scenario has failed, when the multi dialing option has been selected. ✓ WRONGNUMBER: Wrong number. Each type of media is detailed in the next chapters.
notes	object	Number of notes and link to the interaction notes.
tags	object	Link to the interaction tags/qualifications.
userdata or userdatas	object	Link to the userdata of this interaction.

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"8849c476-0011-448f-b533-8416a5c2ddb4"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"ca69be22-cc06-4dc9-bee2-8c5ad4a97c1a"}}],"_postman_id":"83a743e3-c984-41e5-a868-cce46b08d4d3"},{"name":"calls","item":[{"name":"Get Call Interactions","id":"c9d54157-bdbf-448f-9203-bb1f9b1d7a85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/calls?include=media","description":"

Retrieve the list of call type interactions

Query parameters

Remark: The default pagination value is 50. This value can be modified by using the per_page query parameter. See the pagination mechanism and parameters description upper.

The possible query parameters are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Description
include	string	To retrieve specific information about a media, you have to include the following parameter: include=media
phone_number	number	Customer’s phone number.
in_date_start	date	Date of start of entry of the interaction in Kiamo (yyyy mm dd [hh:mm] format or ISO8601 format).
in_date_end	date	Date of end of entry of the interaction in Kiamo (yyyy mm dd [hh:mm] format or ISO8601 format).
media	string	Type of media: ✓ call ✓ email ✓ messaging ✓ custom ✓ chat Remark: the only applicable value is the value related to the current media. Here, call.
attached_ref	number	Interaction AttachedRef.
reference	number	Interaction ID.
states	string	Status of the interaction. Remark: This element can have the following values: ✓ wait, ✓ work, ✓ done. Remark: To insert a list, use commas (e.g.: “wait,work”)
service_ids	string	IDs of the services in which the interaction has been processed. Comma separated list (e.g.: 1,3,5).
agent_ids	number	IDs of the agents to whom the interaction has been assigned or who processed the interaction.

","urlObject":{"path":["interactions","calls"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

(optional) To get related media data

\n","type":"text/plain"},"key":"include","value":"media"},{"disabled":true,"description":{"content":"

(optional) Number of results per page. Default : 50

\n","type":"text/plain"},"key":"per_page","value":""},{"disabled":true,"description":{"content":"

(optional) Phone number

\n","type":"text/plain"},"key":"phone_number","value":""},{"disabled":true,"description":{"content":"

(optional) Start date

\n","type":"text/plain"},"key":"in_date_start","value":""},{"disabled":true,"description":{"content":"

(optional) Media

\n","type":"text/plain"},"key":"media","value":""},{"disabled":true,"description":{"content":"

(optional) #FIXME Next Id

\n","type":"text/plain"},"key":"next_id","value":""},{"disabled":true,"description":{"content":"

(optional) Increasing/decreasing fields sorting order

\n","type":"text/plain"},"key":"sort","value":""},{"disabled":true,"description":{"content":"

(optional) taskRef

\n","type":"text/plain"},"key":"task_ref","value":""},{"disabled":true,"description":{"content":"

(optional) Attached taskRef

\n","type":"text/plain"},"key":"attached_ref","value":""},{"disabled":true,"description":{"content":"

(optional) Reference taskRef

\n","type":"text/plain"},"key":"reference","value":""},{"disabled":true,"description":{"content":"

(optional) States

\n","type":"text/plain"},"key":"states","value":""},{"disabled":true,"description":{"content":"

(optional) Service Ids

\n","type":"text/plain"},"key":"service_ids","value":""},{"disabled":true,"description":{"content":"

(optional) Agent Ids

\n","type":"text/plain"},"key":"agent_ids","value":""},{"disabled":true,"description":{"content":"

(optional) Include drafts

\n","type":"text/plain"},"key":"include_drafts","value":""}],"variable":[]}},"response":[{"id":"fba98094-1e9a-4d9f-966c-f83676561954","name":"Retrieve the list of calls waiting to be processed","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":{"raw":"{{api_base_url}}/interactions/calls?include=media&states=wait","host":["{{api_base_url}}"],"path":["interactions","calls"],"query":[{"key":"include","value":"media","description":"(optional) To get related media data"},{"key":"per_page","value":"","description":"(optional) Number of results per page. Default : 50","disabled":true},{"key":"phone_number","value":"","description":"(optional) Phone number","disabled":true},{"key":"in_date_start","value":"","description":"(optional) Start date","disabled":true},{"key":"media","value":"","description":"(optional) Media","disabled":true},{"key":"next_id","value":"","description":"(optional) #FIXME Next Id","disabled":true},{"key":"sort","value":"","description":"(optional) Increasing/decreasing fields sorting order","disabled":true},{"key":"task_ref","value":"","description":"(optional) taskRef","disabled":true},{"key":"attached_ref","value":"","description":"(optional) Attached taskRef","disabled":true},{"key":"reference","value":"","description":"(optional) Reference taskRef","disabled":true},{"key":"states","value":"wait","description":"(optional) States"},{"key":"service_ids","value":"","description":"(optional) Service Ids","disabled":true},{"key":"agent_ids","value":"","description":"(optional) Agent Ids","disabled":true},{"key":"include_drafts","value":"","description":"(optional) Include drafts","disabled":true}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"id\": \"5c7ffc6749bfc6be58f9ccc5\",\r\n \"task_ref\": 100066,\r\n \"interaction_ref\": null,\r\n \"attached_ref\": 100066,\r\n \"kiamo_in_date\": \"2019-03-06T16:59:19+0000\",\r\n \"batch_id\": \"0\",\r\n \"duration\": {\r\n \"wait\": 0,\r\n \"work\": 0\r\n },\r\n \"label\": \"\",\r\n \"userdata\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100066/userdata\"\r\n }\r\n },\r\n \"state\": \"wait\",\r\n \"reference\": \"EV4199\",\r\n \"notes\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100066/notes\"\r\n },\r\n \"count\": 0\r\n },\r\n \"tags\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100066/tags\"\r\n }\r\n },\r\n \"current_service\": {\r\n \"id\": 8,\r\n \"name\": \"Outbound campaign CS\",\r\n \"distribution_mode\": \"manual\",\r\n \"type\": \"CAMPOUT\"\r\n },\r\n \"current_agent\": {\r\n \"id\": null,\r\n \"name\": \"\"\r\n },\r\n \"kiamo_out_date\": null,\r\n \"scheduled_date\": null,\r\n \"media\": {\r\n \"type\": \"call\",\r\n \"cust_number\": \"078963153256\",\r\n \"cust_name\": \"\",\r\n \"cust_call_id\": null,\r\n \"telco_name\": \"\",\r\n \"sys_number\": \"\",\r\n \"used_sda\": \"\",\r\n \"result\": null\r\n }\r\n },\r\n {\r\n \"id\": \"5c7ffc6749bfc6be58f9ccc0\",\r\n \"task_ref\": 100065,\r\n \"interaction_ref\": null,\r\n \"attached_ref\": 100065,\r\n \"kiamo_in_date\": \"2019-03-06T16:59:19+0000\",\r\n \"batch_id\": \"0\",\r\n \"duration\": {\r\n \"wait\": 0,\r\n \"work\": 0\r\n },\r\n \"label\": \"\",\r\n \"userdata\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100065/userdata\"\r\n }\r\n },\r\n \"state\": \"wait\",\r\n \"reference\": \"WX2226\",\r\n \"notes\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100065/notes\"\r\n },\r\n \"count\": 0\r\n },\r\n \"tags\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100065/tags\"\r\n }\r\n },\r\n \"current_service\": {\r\n \"id\": 8,\r\n \"name\": \"Outbound campaign CS\",\r\n \"distribution_mode\": \"manual\",\r\n \"type\": \"CAMPOUT\"\r\n },\r\n \"current_agent\": {\r\n \"id\": null,\r\n \"name\": \"\"\r\n },\r\n \"kiamo_out_date\": null,\r\n \"scheduled_date\": null,\r\n \"media\": {\r\n \"type\": \"call\",\r\n \"cust_number\": \"01600170335\",\r\n \"cust_name\": \"\",\r\n \"cust_call_id\": null,\r\n \"telco_name\": \"\",\r\n \"sys_number\": \"\",\r\n \"used_sda\": \"\",\r\n \"result\": null\r\n }\r\n },\r\n ],\r\n \"meta\": {\r\n \"cursor\": {\r\n \"current\": \"5c7ffc6749bfc6be58f9ccc5\",\r\n \"prev\": null,\r\n \"next\": null,\r\n \"count\": 11\r\n }\r\n }\r\n}"},{"id":"aa5b4b42-4139-4789-9d76-75f30c625052","name":"Retrieve the list of call interactions","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":{"raw":"{{api_base_url}}/interactions/calls?include=media","host":["{{api_base_url}}"],"path":["interactions","calls"],"query":[{"key":"include","value":"media"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 12:46:40 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"523"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5c1b7dc5f9a39a0e951fbb5a\",\n \"task_ref\": 100017,\n \"interaction_ref\": null,\n \"attached_ref\": null,\n \"kiamo_in_date\": \"2018-12-20T11:32:21+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 3,\n \"work\": 3\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100017/userdata\"\n }\n },\n \"state\": \"done\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100017/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100017/tags\"\n }\n },\n \"current_service\": {\n \"id\": 1,\n \"name\": \"Appels_entrants_1\",\n \"distribution_mode\": \"stop\",\n \"type\": \"CAMPIN\"\n },\n \"current_agent\": {\n \"id\": 1,\n \"name\": \"Nouvel_Agent_1\"\n },\n \"kiamo_out_date\": \"2018-12-20T11:32:27+0000\",\n \"scheduled_date\": null,\n \"media\": {\n \"type\": \"call\",\n \"cust_number\": \"3734\",\n \"cust_call_id\": 10005,\n \"telco_name\": \"TELCO1\",\n \"sys_number\": \"8345\",\n \"used_sda\": \"DEFAULT\"\n }\n },\n {\n \"id\": \"5c1b7cbff9a39a0e951fbb1e\",\n \"task_ref\": 100016,\n \"interaction_ref\": null,\n \"attached_ref\": null,\n \"kiamo_in_date\": \"2018-12-20T11:27:59+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 5,\n \"work\": 4\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100016/userdata\"\n }\n },\n \"state\": \"done\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100016/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100016/tags\"\n }\n },\n \"current_service\": {\n \"id\": 1,\n \"name\": \"Appels_entrants_1\",\n \"distribution_mode\": \"stop\",\n \"type\": \"CAMPIN\"\n },\n \"current_agent\": {\n \"id\": 1,\n \"name\": \"Nouvel_Agent_1\"\n },\n \"kiamo_out_date\": \"2018-12-20T11:28:09+0000\",\n \"scheduled_date\": null,\n \"media\": {\n \"type\": \"call\",\n \"cust_number\": \"3734\",\n \"cust_call_id\": 10003,\n \"telco_name\": \"TELCO1\",\n \"sys_number\": \"8345\",\n \"used_sda\": \"DEFAULT\"\n }\n }\n ],\n \"meta\": {\n \"cursor\": {\n \"current\": \"5c1b7dc5f9a39a0e951fbb5a\",\n \"prev\": null,\n \"next\": null,\n \"count\": 2\n }\n }\n}"}],"_postman_id":"c9d54157-bdbf-448f-9203-bb1f9b1d7a85"},{"name":"Get Call Interaction","id":"ca62080a-dd3c-41f4-af53-6e139064827a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/calls/:ref?include=media","description":"

Retrieve a call type interaction

Remark: To retrieve specific information about a media, you have to include the following parameter in the query: include=media (see example).

\n","urlObject":{"path":["interactions","calls",":ref"],"host":["{{api_base_url}}"],"query":[{"key":"include","value":"media"}],"variable":[{"id":"be808b1f-d1bf-4087-8df9-722dedd64638","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[{"id":"8ca97c7c-c81f-46a8-b9a4-ca66e972f970","name":"Retrieve a call type interaction","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions/calls/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","calls",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 12:54:55 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"430"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c1b7cbff9a39a0e951fbb1e\",\n \"task_ref\": 100016,\n \"interaction_ref\": null,\n \"attached_ref\": null,\n \"kiamo_in_date\": \"2018-12-20T11:27:59+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 5,\n \"work\": 4\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100016/userdata\"\n }\n },\n \"state\": \"done\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100016/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100016/tags\"\n }\n },\n \"current_service\": {\n \"id\": 1,\n \"name\": \"Appels_entrants_1\",\n \"distribution_mode\": \"stop\",\n \"type\": \"CAMPIN\"\n },\n \"current_agent\": {\n \"id\": 1,\n \"name\": \"Nouvel_Agent_1\"\n },\n \"kiamo_out_date\": \"2018-12-20T11:28:09+0000\",\n \"scheduled_date\": null,\n \"media\": {\n \"type\": \"call\",\n \"cust_number\": \"3734\",\n \"cust_call_id\": 10003,\n \"telco_name\": \"TELCO1\",\n \"sys_number\": \"8345\",\n \"used_sda\": \"DEFAULT\"\n }\n}"}],"_postman_id":"ca62080a-dd3c-41f4-af53-6e139064827a"},{"name":"Update Call Interactions","id":"3d4cec3a-7dd2-4e92-9fa5-1b84a832798e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"current_service\": {\n \"id\" : 3\n },\n \"current_agent\": {\n \"id\" : 3\n },\n \"state\": \"done\",\n \"reference\": \"custom reference\",\n \"destination\": \"9999\",\n \"scheduled_date\": \"2018-12-27 16:00:00\",\n \"user_data\": {\n \"variable A\": \"value\"\n }\n}"},"url":"{{api_base_url}}/interactions/calls/:ref?include=media","description":"

Update of a call type interaction

Caution: can only used with outbound calls

Body parameters

The possible body parameters (editable elements) are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Description
current_agent.id	number	ID of the agent to whom the call has been assigned or who processed the call.
current_service.id	number	ID of the service in which is the call at the moment.
destination	string	Customer’s phone number. Remark: This property is optional for a call included in an outbound call campaign with the multi dialing option selected.
scheduled_date	dateTime	Call processing scheduled date (yyyy mm dd [hh:mm] format or ISO8601 format).
state	string	Status of the call. Remark: You can only change status to done.

Answer codes

✓ “200 OK” when there is no problem.

✓ “400 Bad request” if the “current_agent” or “current_service” node is provided but the “id” parameter is missing or the agent does not exist in Kiamo.

\n","urlObject":{"path":["interactions","calls",":ref"],"host":["{{api_base_url}}"],"query":[{"key":"include","value":"media"}],"variable":[{"id":"7341da70-f34b-42fa-9f98-3368d29c58fc","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[{"id":"c717c0f9-6bb2-4f9d-a2b7-af3f7c403dd8","name":"Update several elements of a call interactions","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"current_service\": {\n \"id\" : 2\n },\n \"current_agent\": {\n \"id\" : 4\n },\n \"state\": \"done\",\n \"destination\": \"3344\",\n \"scheduled_date\": \"2018-12-27 16:00:00\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/calls/:ref","host":["{{api_base_url}}"],"path":["interactions","calls",":ref"],"query":[{"key":"include","value":"media","disabled":true}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"5c7ffc6749bfc6be58f9ccb6\",\r\n \"task_ref\": 100063,\r\n \"interaction_ref\": null,\r\n \"attached_ref\": 100063,\r\n \"kiamo_in_date\": \"2019-03-06T16:59:19+0000\",\r\n \"batch_id\": \"0\",\r\n \"duration\": {\r\n \"wait\": 0,\r\n \"work\": 0\r\n },\r\n \"label\": \"\",\r\n \"userdata\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100063/userdata\"\r\n }\r\n },\r\n \"state\": \"wait\",\r\n \"reference\": \"AS0357\",\r\n \"notes\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100063/notes\"\r\n },\r\n \"count\": 0\r\n },\r\n \"tags\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100063/tags\"\r\n }\r\n },\r\n \"current_service\": {\r\n \"id\": 8,\r\n \"name\": \"Outbound campaign CS\",\r\n \"distribution_mode\": \"manual\",\r\n \"type\": \"CAMPOUT\"\r\n },\r\n \"current_agent\": {\r\n \"id\": null,\r\n \"name\": \"\"\r\n },\r\n \"kiamo_out_date\": null,\r\n \"scheduled_date\": null,\r\n \"media\": {\r\n \"type\": \"call\",\r\n \"cust_number\": \"07764639466\",\r\n \"cust_name\": \"\",\r\n \"cust_call_id\": null,\r\n \"telco_name\": \"\",\r\n \"sys_number\": \"\",\r\n \"used_sda\": \"\",\r\n \"result\": null\r\n }\r\n}"},{"id":"9292f93e-42f9-4e20-bfbc-5ca9778ac22a","name":"Update the interaction current agent","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"current_agent\" : {\n\t\t\"id\": 1\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/calls/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","calls",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 14:27:52 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"416"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c1ba1a7f9a39a0e951fc2fb\",\n \"task_ref\": 100018,\n \"interaction_ref\": null,\n \"attached_ref\": 100018,\n \"kiamo_in_date\": \"2018-12-20T14:05:26+0000\",\n \"batch_id\": \"0\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100018/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"my reference\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100018/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100018/tags\"\n }\n },\n \"current_service\": {\n \"id\": 7,\n \"name\": \"Campagne_sortante_1\",\n \"distribution_mode\": \"manual\",\n \"type\": \"CAMPOUT\"\n },\n \"current_agent\": {\n \"id\": 1,\n \"name\": \"Nouvel_Agent_1\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": \"2018-12-20T10:10:10+0000\",\n \"media\": {\n \"type\": \"call\",\n \"cust_number\": \"6666\",\n \"cust_call_id\": null,\n \"telco_name\": \"\",\n \"sys_number\": \"\",\n \"used_sda\": \"\"\n }\n}"},{"id":"c0e5faa1-85d2-4ef7-869d-09dbd438c630","name":"Update the interaction reference","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"reference\" : \"my reference\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/calls/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","calls",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 14:22:39 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"397"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c1ba1a7f9a39a0e951fc2fb\",\n \"task_ref\": 100018,\n \"interaction_ref\": null,\n \"attached_ref\": 100018,\n \"kiamo_in_date\": \"2018-12-20T14:05:26+0000\",\n \"batch_id\": \"0\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100018/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"my reference\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100018/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100018/tags\"\n }\n },\n \"current_service\": {\n \"id\": 7,\n \"name\": \"Campagne_sortante_1\",\n \"distribution_mode\": \"manual\",\n \"type\": \"CAMPOUT\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"media\": {\n \"type\": \"call\",\n \"cust_number\": \"6666\",\n \"cust_call_id\": null,\n \"telco_name\": \"\",\n \"sys_number\": \"\",\n \"used_sda\": \"\"\n }\n}"},{"id":"ca49b3ae-b2ff-45e3-9aa1-5ac10ecffb4b","name":"Add user variables to the interaction","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"userdata\" : {\n\t\t\"MyVariable\" : \"My variable value\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/calls/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","calls",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 14:49:16 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"394"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c1ba1a7f9a39a0e951fc300\",\n \"task_ref\": 100019,\n \"interaction_ref\": null,\n \"attached_ref\": 100019,\n \"kiamo_in_date\": \"2018-12-20T14:05:26+0000\",\n \"batch_id\": \"0\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100019/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100019/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100019/tags\"\n }\n },\n \"current_service\": {\n \"id\": 7,\n \"name\": \"Campagne_sortante_1\",\n \"distribution_mode\": \"manual\",\n \"type\": \"CAMPOUT\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"media\": {\n \"type\": \"call\",\n \"cust_number\": \"3334\",\n \"cust_call_id\": null,\n \"telco_name\": \"\",\n \"sys_number\": \"\",\n \"used_sda\": \"\"\n }\n}"},{"id":"cd9f3b09-daa2-48d1-b2fe-54dc3cf837c6","name":"Update the interaction scheduled date","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"scheduled_date\" : \"2018-12-20 16:00:00\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/calls/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","calls",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 14:26:17 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"406"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c1ba1a7f9a39a0e951fc2fb\",\n \"task_ref\": 100018,\n \"interaction_ref\": null,\n \"attached_ref\": 100018,\n \"kiamo_in_date\": \"2018-12-20T14:05:26+0000\",\n \"batch_id\": \"0\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100018/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"my reference\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100018/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100018/tags\"\n }\n },\n \"current_service\": {\n \"id\": 7,\n \"name\": \"Campagne_sortante_1\",\n \"distribution_mode\": \"manual\",\n \"type\": \"CAMPOUT\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": \"2018-12-20T10:10:10+0000\",\n \"media\": {\n \"type\": \"call\",\n \"cust_number\": \"6666\",\n \"cust_call_id\": null,\n \"telco_name\": \"\",\n \"sys_number\": \"\",\n \"used_sda\": \"\"\n }\n}"},{"id":"04eb3e3c-0f3d-4334-b59f-8d12797ea202","name":"Update the interaction state (close)","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"state\" : \"done\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/calls/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","calls",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 14:37:30 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"411"},{"key":"Keep-Alive","value":"timeout=5, max=499"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c1ba1a7f9a39a0e951fc2fb\",\n \"task_ref\": 100018,\n \"interaction_ref\": null,\n \"attached_ref\": 100018,\n \"kiamo_in_date\": \"2018-12-20T14:05:26+0000\",\n \"batch_id\": \"0\",\n \"duration\": {\n \"wait\": 67,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100018/userdata\"\n }\n },\n \"state\": \"done\",\n \"reference\": \"my reference\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100018/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100018/tags\"\n }\n },\n \"current_service\": {\n \"id\": 8,\n \"name\": \"Campagne_sortante_2\",\n \"distribution_mode\": \"stop\",\n \"type\": \"CAMPOUT\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": \"2018-12-20T14:37:27+0000\",\n \"scheduled_date\": \"2018-12-20T10:10:10+0000\",\n \"media\": {\n \"type\": \"call\",\n \"cust_number\": \"6666\",\n \"cust_call_id\": null,\n \"telco_name\": \"\",\n \"sys_number\": \"\",\n \"used_sda\": \"\"\n }\n}"},{"id":"cfdf1921-9c8a-4b53-8ee9-427e42725f81","name":"Update the interaction service","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"current_service\" : {\n\t\t\"id\": 8\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/calls/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","calls",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 14:36:19 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"405"},{"key":"Keep-Alive","value":"timeout=5, max=499"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c1ba1a7f9a39a0e951fc2fb\",\n \"task_ref\": 100018,\n \"interaction_ref\": null,\n \"attached_ref\": 100018,\n \"kiamo_in_date\": \"2018-12-20T14:05:26+0000\",\n \"batch_id\": \"0\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100018/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"my reference\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100018/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100018/tags\"\n }\n },\n \"current_service\": {\n \"id\": 8,\n \"name\": \"Campagne_sortante_2\",\n \"distribution_mode\": \"stop\",\n \"type\": \"CAMPOUT\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": \"2018-12-20T10:10:10+0000\",\n \"media\": {\n \"type\": \"call\",\n \"cust_number\": \"6666\",\n \"cust_call_id\": null,\n \"telco_name\": \"\",\n \"sys_number\": \"\",\n \"used_sda\": \"\"\n }\n}"},{"id":"860f4702-0d9e-47dc-acc1-27f14ee1ce47","name":"Update the interaction destination","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"destination\" : \"3334\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/calls/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","calls",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 14:08:10 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"393"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c1ba1a7f9a39a0e951fc2fb\",\n \"task_ref\": 100018,\n \"interaction_ref\": null,\n \"attached_ref\": 100018,\n \"kiamo_in_date\": \"2018-12-20T14:05:26+0000\",\n \"batch_id\": \"0\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100018/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"3334\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100018/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100018/tags\"\n }\n },\n \"current_service\": {\n \"id\": 7,\n \"name\": \"Campagne_sortante_1\",\n \"distribution_mode\": \"manual\",\n \"type\": \"CAMPOUT\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"media\": {\n \"type\": \"call\",\n \"cust_number\": \"3334\",\n \"cust_call_id\": null,\n \"telco_name\": \"\",\n \"sys_number\": \"\",\n \"used_sda\": \"\"\n }\n}"}],"_postman_id":"3d4cec3a-7dd2-4e92-9fa5-1b84a832798e"}],"id":"a979becd-86dd-4380-acfe-4d805b4d7c2c","_postman_id":"a979becd-86dd-4380-acfe-4d805b4d7c2c","description":""},{"name":"emails","item":[{"name":"Get Email Interactions","id":"dd10cf49-4b83-46b1-80bf-6a48e3c43fce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/emails?include=media","description":"

Retrieve the list of call type interactions

Query parameters

Remark: The default pagination value is 50. This value can be modified by using the per_page query parameter. See the pagination mechanism and parameters description upper.

The possible query parameters are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Description
include	string	To retrieve specific information about a media, you have to include the following parameter: include=media
email_address	string	Customer’s email address.
in_date_start	date	Date of start of entry of the interaction in Kiamo (yyyy mm dd [hh:mm] format or ISO8601 format).
in_date_end	date	Date of end of entry of the interaction in Kiamo (yyyy mm dd [hh:mm] format or ISO8601 format).
media	string	Type of media: ✓ call ✓ email ✓ messaging ✓ custom ✓ chat Remark: the only applicable value is the value related to the current media. Here, email.
attached_ref	number	Interaction AttachedRef.
reference	number	Interaction ID.
states	string	Status of the interaction. Remark: This element can have the following values: ✓ wait, ✓ work, ✓ done. Remark: To insert a list, use commas (e.g.: “wait,work”)
service_ids	string	IDs of the services in which the interaction has been processed. Comma separated list (e.g.: 1,3,5).
agent_ids	number	IDs of the agents to whom the interaction has been assigned or who processed the interaction.

","urlObject":{"path":["interactions","emails"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

(optional) Include related media data

\n","type":"text/plain"},"key":"include","value":"media"}],"variable":[]}},"response":[{"id":"c17a5da6-c534-49fd-aebf-8f2eca69d331","name":"Retrieve the list of emails waiting to be processed using an email address","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions/emails?include=media&states=wait&email_address=email@domain.com","host":["{{api_base_url}}"],"path":["interactions","emails"],"query":[{"key":"include","value":"media","description":"(optional) Include related media data"},{"key":"states","value":"wait"},{"key":"email_address","value":"email@domain.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"id\": \"5c7e5b432017591a480017bd\",\r\n \"task_ref\": 100047,\r\n \"interaction_ref\": null,\r\n \"attached_ref\": 100039,\r\n \"kiamo_in_date\": \"2019-03-05T11:19:31+0000\",\r\n \"batch_id\": \"\",\r\n \"duration\": {\r\n \"wait\": 0,\r\n \"work\": 40\r\n },\r\n \"label\": \"\",\r\n \"userdata\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100047/userdata\"\r\n }\r\n },\r\n \"state\": \"wait\",\r\n \"reference\": \"\",\r\n \"notes\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100047/notes\"\r\n },\r\n \"count\": 0\r\n },\r\n \"tags\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100047/tags\"\r\n }\r\n },\r\n \"current_service\": {\r\n \"id\": 2,\r\n \"name\": \"Customer service emails\",\r\n \"distribution_mode\": \"manual\",\r\n \"type\": \"MAILIN\"\r\n },\r\n \"current_agent\": {\r\n \"id\": null,\r\n \"name\": \"\"\r\n },\r\n \"kiamo_out_date\": null,\r\n \"scheduled_date\": \"2019-03-05T11:22:40+0000\",\r\n \"media\": {\r\n \"type\": \"email\",\r\n \"object\": \"[#100039] Disaster\",\r\n \"is_draft\": false,\r\n \"studio\": {\r\n \"id\": null,\r\n \"tabId\": null,\r\n \"versionId\": null\r\n },\r\n \"content\": {\r\n \"html\": \"\",\r\n \"text\": \"\",\r\n \"css\": \"\"\r\n },\r\n \"sent_at\": \"2019-03-05T11:10:14+0000\",\r\n \"from\": {\r\n \"name\": \"vbe\",\r\n \"address\": \"vbe@connecteo.com\"\r\n },\r\n \"to\": [\r\n {\r\n \"name\": \"\",\r\n \"address\": \"customer_service@mycompany.com\"\r\n }\r\n ],\r\n \"cc\": null,\r\n \"bcc\": null,\r\n \"replyTo\": [\r\n {\r\n \"name\": \"\",\r\n \"address\": \"vbe@connecteo.com\"\r\n }\r\n ],\r\n \"direction\": \"in\",\r\n \"attachments\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/emails/100047/attachments?include=metadata\"\r\n },\r\n \"list\": []\r\n },\r\n \"draft\": {\r\n \"ref\": \"100049\",\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/emails/100049\"\r\n }\r\n }\r\n }\r\n },\r\n {\r\n \"id\": \"5c7e58eb2017591a480017bc\",\r\n \"task_ref\": 100045,\r\n \"interaction_ref\": null,\r\n \"attached_ref\": 100165,\r\n \"kiamo_in_date\": \"2019-03-05T11:09:30+0000\",\r\n \"batch_id\": \"\",\r\n \"duration\": {\r\n \"wait\": 0,\r\n \"work\": 40\r\n },\r\n \"label\": \"\",\r\n \"userdata\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100045/userdata\"\r\n }\r\n },\r\n \"state\": \"wait\",\r\n \"reference\": \"\",\r\n \"notes\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100045/notes\"\r\n },\r\n \"count\": 0\r\n },\r\n \"tags\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100045/tags\"\r\n }\r\n },\r\n \"current_service\": {\r\n \"id\": 2,\r\n \"name\": \"Customer service emails\",\r\n \"distribution_mode\": \"manual\",\r\n \"type\": \"MAILIN\"\r\n },\r\n \"current_agent\": {\r\n \"id\": null,\r\n \"name\": \"\"\r\n },\r\n \"kiamo_out_date\": null,\r\n \"scheduled_date\": \"2019-03-05T11:10:21+0000\",\r\n \"media\": {\r\n \"type\": \"email\",\r\n \"object\": \"[#100165] Car insurance\",\r\n \"is_draft\": false,\r\n \"studio\": {\r\n \"id\": null,\r\n \"tabId\": null,\r\n \"versionId\": null\r\n },\r\n \"content\": {\r\n \"html\": \"\",\r\n \"text\": \"\",\r\n \"css\": \"\"\r\n },\r\n \"sent_at\": \"2019-02-25T15:02:22+0000\",\r\n \"from\": {\r\n \"name\": \"Address 1\",\r\n \"address\": \"vbe@connecteo.com\"\r\n },\r\n \"to\": [\r\n {\r\n \"name\": \"\",\r\n \"address\": \"service_clients@mycompany.com\"\r\n }\r\n ],\r\n \"cc\": null,\r\n \"bcc\": null,\r\n \"replyTo\": [\r\n {\r\n \"name\": \"\",\r\n \"address\": \"vbe@connecteo.com\"\r\n }\r\n ],\r\n \"direction\": \"in\",\r\n \"attachments\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/emails/100045/attachments?include=metadata\"\r\n },\r\n \"list\": []\r\n },\r\n \"draft\": {\r\n \"ref\": \"100046\",\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/emails/100046\"\r\n }\r\n }\r\n }\r\n }\r\n ],\r\n \"meta\": {\r\n \"cursor\": {\r\n \"current\": \"5c7e5b432017591a480017bd\",\r\n \"prev\": null,\r\n \"next\": null,\r\n \"count\": 6\r\n }\r\n }\r\n}"}],"_postman_id":"dd10cf49-4b83-46b1-80bf-6a48e3c43fce"},{"name":"Get Email Interaction","id":"bfee3bf8-c611-40aa-8257-822eaa171a85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/emails/:ref?include=media","description":"

Retrieve an email type interaction

Remark: To retrieve specific information about a media, you have to include the following parameter in the query: include=media (see example).

\n","urlObject":{"path":["interactions","emails",":ref"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

(optional) Include related media data

\n","type":"text/plain"},"key":"include","value":"media"}],"variable":[{"id":"59938974-e0f4-469a-93ea-8bb1683a5122","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[],"_postman_id":"bfee3bf8-c611-40aa-8257-822eaa171a85"},{"name":"Update Email Interaction","id":"9980fdd9-473e-4525-80f2-016f8884aa5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"current_service\": {\n\t\t\"id\" : 3\n\t},\n\t\"current_agent\": {\n\t\t\"id\" : 3\n\t},\n\t\"state\": \"done\",\n\t\"scheduled_date\": \"2018-12-27 16:00:00\",\n\t\"media\": {\n\t\t\"content\": {\n\t\t\t\"html\": \"Bold content\",\n\t\t\t\"text\": \"email text\",\n\t\t\t\"css\": \"strong{background-color:red;}\"\n\t\t}\n\t}\n}\n"},"url":"{{api_base_url}}/interactions/emails/:ref?include=media","description":"

Update of a call type interaction

Body parameters

The possible body parameters (editable elements) are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Description
current_agent.id	number	ID of the agent to whom the call has been assigned or who processed the call.
current_service.id	number	ID of the service in which is the call at the moment.
scheduled_date	dateTime	Call processing scheduled date (yyyy mm dd [hh:mm] format or ISO8601 format).
state	string	Status of the call. Remark: You can only change status to done.

Answer codes

✓ “200 OK” when there is no problem.

✓ “400 Bad request” if the “current_agent” or “current_service” node is provided but the “id” parameter is missing or the agent does not exist in Kiamo.

\n","urlObject":{"path":["interactions","emails",":ref"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

(optional) Include related media data

\n","type":"text/plain"},"key":"include","value":"media"}],"variable":[{"id":"2951305e-e01a-4cc2-98f5-f959f2625a32","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[{"id":"37675ad3-9126-462a-aaa4-5fe23e11a882","name":"Edit the processing date scheduled for an email","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"scheduled_date\": \"2018-12-24 16:00:00\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/emails/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","emails",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Dec 2018 11:24:58 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"499"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c20bf728fa1349fa70014f3\",\n \"task_ref\": 100031,\n \"interaction_ref\": null,\n \"attached_ref\": 100031,\n \"kiamo_in_date\": \"2018-12-24T11:13:53+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 655\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100031/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100031/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100031/tags\"\n }\n },\n \"current_service\": {\n \"id\": 10,\n \"name\": \"Emails_manuels_10\",\n \"distribution_mode\": \"manual\",\n \"type\": \"MANUALMAILOUT\"\n },\n \"current_agent\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": \"2018-12-24T16:00:00+0000\",\n \"media\": {\n \"type\": \"email\",\n \"object\": \"\",\n \"is_draft\": true,\n \"studio\": {\n \"id\": 0,\n \"versionId\": 0,\n \"tabId\": 1\n },\n \"content\": {\n \"html\": \"\",\n \"text\": \"\",\n \"css\": \"\"\n },\n \"sent_at\": null,\n \"from\": null,\n \"to\": null,\n \"cc\": null,\n \"bcc\": null,\n \"replyTo\": null,\n \"direction\": \"out\",\n \"attachments\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/emails/100031/attachments?include=metadata\"\n },\n \"list\": []\n }\n }\n}"},{"id":"3dcae0da-e909-43fb-a36c-1fbbe1b330be","name":"Update the content and the CSS style of an email","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"media\": {\n\t\t\"content\": {\n\t\t\t\"html\": \"Bold content\",\n\t\t\t\"text\": \"email text\",\n\t\t\t\"css\": \"strong{background-color:red;}\"\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/emails/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","emails",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Dec 2018 09:27:16 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"534"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c20a1528fa1340a5c004a82\",\n \"task_ref\": 100029,\n \"interaction_ref\": null,\n \"attached_ref\": 100029,\n \"kiamo_in_date\": \"2018-12-24T09:05:18+0000\",\n \"batch_id\": null,\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100029/userdata\"\n }\n },\n \"state\": \"work\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100029/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100029/tags\"\n }\n },\n \"current_service\": {\n \"id\": 10,\n \"name\": \"Emails_manuels_10\",\n \"distribution_mode\": \"manual\",\n \"type\": \"MANUALMAILOUT\"\n },\n \"current_agent\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"media\": {\n \"type\": \"email\",\n \"object\": \"\",\n \"is_draft\": true,\n \"studio\": {\n \"id\": 0,\n \"versionId\": 0,\n \"tabId\": 1\n },\n \"content\": {\n \"html\": \"Bold content\",\n \"text\": \"email text\",\n \"css\": \"strong{background-color:red;}\"\n },\n \"sent_at\": null,\n \"from\": null,\n \"to\": null,\n \"cc\": null,\n \"bcc\": null,\n \"replyTo\": null,\n \"direction\": \"out\",\n \"attachments\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/emails/100029/attachments?include=metadata\"\n },\n \"list\": []\n }\n }\n}"},{"id":"23457a8a-f644-4ccb-b877-c42f6675bc9b","name":"Close an email interaction","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"state\": \"done\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/emails/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","emails",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Dec 2018 11:03:19 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"485"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c20bc648fa1349fa70014f2\",\n \"task_ref\": 100030,\n \"interaction_ref\": null,\n \"attached_ref\": 100030,\n \"kiamo_in_date\": \"2018-12-24T11:00:49+0000\",\n \"batch_id\": null,\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100030/userdata\"\n }\n },\n \"state\": \"work\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100030/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100030/tags\"\n }\n },\n \"current_service\": {\n \"id\": 10,\n \"name\": \"Emails_manuels_10\",\n \"distribution_mode\": \"manual\",\n \"type\": \"MANUALMAILOUT\"\n },\n \"current_agent\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"media\": {\n \"type\": \"email\",\n \"object\": \"\",\n \"is_draft\": true,\n \"studio\": {\n \"id\": 0,\n \"versionId\": 0,\n \"tabId\": 1\n },\n \"content\": {\n \"html\": \"\",\n \"text\": \"\",\n \"css\": \"\"\n },\n \"sent_at\": null,\n \"from\": null,\n \"to\": null,\n \"cc\": null,\n \"bcc\": null,\n \"replyTo\": null,\n \"direction\": \"out\",\n \"attachments\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/emails/100030/attachments?include=metadata\"\n },\n \"list\": []\n }\n }\n}"},{"id":"65d030d6-0639-40a8-802c-9137c725cb6f","name":"Change service (Forward email)","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"current_service\": {\n\t\t\"id\" : 11\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/emails/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","emails",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Dec 2018 10:54:09 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"522"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c20a1528fa1340a5c004a82\",\n \"task_ref\": 100029,\n \"interaction_ref\": null,\n \"attached_ref\": 100029,\n \"kiamo_in_date\": \"2018-12-24T09:05:18+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100029/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100029/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100029/tags\"\n }\n },\n \"current_service\": {\n \"id\": 11,\n \"name\": \"Emails_manuels_11\",\n \"distribution_mode\": \"manual\",\n \"type\": \"MANUALMAILOUT\"\n },\n \"current_agent\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"media\": {\n \"type\": \"email\",\n \"object\": \"\",\n \"is_draft\": true,\n \"studio\": {\n \"id\": 0,\n \"versionId\": 0,\n \"tabId\": 1\n },\n \"content\": {\n \"html\": \"

Bold content

\",\n \"text\": \"Bold content\\n\",\n \"css\": \"\"\n },\n \"sent_at\": null,\n \"from\": null,\n \"to\": null,\n \"cc\": null,\n \"bcc\": null,\n \"replyTo\": null,\n \"direction\": \"out\",\n \"attachments\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/emails/100029/attachments?include=metadata\"\n },\n \"list\": []\n }\n }\n}"},{"id":"28dbbdc3-8982-4c95-b035-e136e940d4f3","name":"Assign an email interaction to an agent","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"current_agent\": {\n\t\t\"id\" : 2\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/emails/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","emails",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Dec 2018 10:24:36 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"537"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c20a1528fa1340a5c004a82\",\n \"task_ref\": 100029,\n \"interaction_ref\": null,\n \"attached_ref\": 100029,\n \"kiamo_in_date\": \"2018-12-24T09:05:18+0000\",\n \"batch_id\": null,\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100029/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100029/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100029/tags\"\n }\n },\n \"current_service\": {\n \"id\": 10,\n \"name\": \"Emails_manuels_10\",\n \"distribution_mode\": \"manual\",\n \"type\": \"MANUALMAILOUT\"\n },\n \"current_agent\": {\n \"id\": 2,\n \"name\": \"Nouvel_Agent_2\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"media\": {\n \"type\": \"email\",\n \"object\": \"\",\n \"is_draft\": true,\n \"studio\": {\n \"id\": 0,\n \"versionId\": 0,\n \"tabId\": 1\n },\n \"content\": {\n \"html\": \"

Bold content

Send an email again

Answer codes

✓ \"204 No Content\" when there is no problem.

\n","urlObject":{"path":["interactions","emails",":ref","resend"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"81a0b1aa-c624-406d-9a3c-24bb56bec6b8","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[{"id":"f0847203-c744-414d-bab3-c4bad29d4977","name":"Send an email again","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{api_base_url}}/interactions/emails/:ref/resend","host":["{{api_base_url}}"],"path":["interactions","emails",":ref","resend"],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a57382e9-3e82-465d-b5c8-8a40b0e0769b"},{"name":"Get Email Interaction Attachments","id":"4b9ce123-36b5-44b3-8193-1f9c4e1029b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/emails/:ref/attachments","description":"

Retrieve all the attachments of an email interaction

\n","urlObject":{"path":["interactions","emails",":ref","attachments"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"abef7f23-ee51-439f-a9a5-3b14cbf61c36","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[],"_postman_id":"4b9ce123-36b5-44b3-8193-1f9c4e1029b1"},{"name":"Get Email Interaction Attachment","id":"4b4c7b1a-59cd-4c53-b0a3-49e3f052010a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/emails/:ref/attachments/:id","description":"

Retrieve a specific attachment of an email interaction

\n","urlObject":{"path":["interactions","emails",":ref","attachments",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"36e79b2d-60a8-40b6-ac4d-fd363b02216a","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"},{"id":"6cf53003-a0d2-4d3e-b177-e94a128b72c2","description":{"content":"

Attachment Id

\n","type":"text/plain"},"type":"any","value":"{{attachment_id}}","key":"id"}]}},"response":[],"_postman_id":"4b4c7b1a-59cd-4c53-b0a3-49e3f052010a"},{"name":"Update Email Interaction Attachment","id":"64c2cd7b-37e0-42ad-ac38-7f1476527ad3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/emails/:ref/attachments/:id","description":"

Update a specific attachment of an email interaction

\n","urlObject":{"path":["interactions","emails",":ref","attachments",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"a1b6c3a5-fd81-4a9a-b15b-aee4b98da044","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"},{"id":"102181f6-9ac4-4986-b2bc-12e52bb95c9a","description":{"content":"

Attachment Id

\n","type":"text/plain"},"type":"any","value":"{{attachment_id}}","key":"id"}]}},"response":[],"_postman_id":"64c2cd7b-37e0-42ad-ac38-7f1476527ad3"},{"name":"Delete Email Interaction Attachment","id":"a4c0a2de-4cd2-4a0b-87b9-b6bc4efb5cb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{api_base_url}}/interactions/emails/:ref/attachments/:id","description":"

Delete a specific attachment of an email interaction

\n","urlObject":{"path":["interactions","emails",":ref","attachments",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"60d08450-fab7-432b-a1c8-a53c66c37258","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"},{"id":"1283bb9a-6f57-408d-9f56-3a295440373c","description":{"content":"

Attachment Id

\n","type":"text/plain"},"type":"any","value":"{{attachment_id}}","key":"id"}]}},"response":[],"_postman_id":"a4c0a2de-4cd2-4a0b-87b9-b6bc4efb5cb7"},{"name":"Get Email Interaction Drafts","id":"3167be2d-59ed-47cf-9eca-80e6e0deb783","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/emails/drafts?include=media","description":"

Retrieve all the email drafts

Query parameters

The possible query parameters are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Description
include	media
per_page	number
only_drafts	only retrieve drafts
in_date_start	start date
in_date_end	end date
media	media
next_id	`#FIXME` next id
sort	ascending / descending sort of a field
task_ref	taskRef
attached_ref	taskRef
reference	taskRef
states	states
service_ids	service IDs
agent_ids	agent IDs
include_drafts	include drafts

Remark: to retrieve the data specific to the media, the parameter include=media has to be present.

\n","urlObject":{"path":["interactions","emails","drafts"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

(optional) Include related media data

\n","type":"text/plain"},"key":"include","value":"media"}],"variable":[]}},"response":[],"_postman_id":"3167be2d-59ed-47cf-9eca-80e6e0deb783"},{"name":"Create Email Interaction Draft","id":"a3438da0-82e4-4ff8-baa3-f61ce72c8a4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\n}"},"url":"{{api_base_url}}/interactions/emails/:ref/draft?include=media","description":"

Create the draft of an email interaction

\n","urlObject":{"path":["interactions","emails",":ref","draft"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

(optional) Include related media data

\n","type":"text/plain"},"key":"include","value":"media"}],"variable":[{"id":"31af1cdb-0a67-4a0f-a8b2-f26367de715f","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[],"_postman_id":"a3438da0-82e4-4ff8-baa3-f61ce72c8a4c"},{"name":"Get Email Interaction Draft","id":"71468939-7839-4b88-90c7-6436ee84cd17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/emails/:ref/draft?include=media","description":"

Retrieve the draft of an email interaction

\n","urlObject":{"path":["interactions","emails",":ref","draft"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

(optional) Include related media data

\n","type":"text/plain"},"key":"include","value":"media"}],"variable":[{"id":"f68955d4-bdc3-4333-9f8b-a41dc623a79e","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[],"_postman_id":"71468939-7839-4b88-90c7-6436ee84cd17"},{"name":"Delete Email Interaction Draft","id":"99624c87-a6d8-4a97-86ce-3488f09784e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{api_base_url}}/interactions/emails/:ref/draft","description":"

Delete the draft of an email interaction

\n","urlObject":{"path":["interactions","emails",":ref","draft"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"9c5dabe5-8108-42a6-aaa5-47c4477a690e","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[],"_postman_id":"99624c87-a6d8-4a97-86ce-3488f09784e0"}],"id":"4a7bec8d-0bf8-4933-a829-e67a3891f708","_postman_id":"4a7bec8d-0bf8-4933-a829-e67a3891f708","description":""},{"name":"messaging","item":[{"name":"Get Messaging Interactions","id":"26086a30-7add-4f6a-a925-d4713e75f43b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/messaging?include=media","description":"

Retrieve the list of messaging type interactions

Query parameters

Remark: The default pagination value is 50. This value can be modified by using the per_page query parameter. See the pagination mechanism and parameters description upper.

The possible query parameters are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Description
include	string	To retrieve specific information about a media, you have to include the following parameter: include=media
in_date_start	date	Date of start of entry of the interaction in Kiamo (yyyy mm dd [hh:mm] format or ISO8601 format).
in_date_end	date	Date of end of entry of the interaction in Kiamo (yyyy mm dd [hh:mm] format or ISO8601 format).
media	string	Type of media: ✓ call ✓ email ✓ messaging ✓ custom ✓ chat Remark: the only applicable value is the value related to the current media. Here, messaging.
attached_ref	number	Interaction AttachedRef.
reference	number	Interaction ID.
states	string	Status of the interaction. Remark: This element can have the following values: ✓ wait, ✓ work, ✓ done. Remark: To insert a list, use commas (e.g.: “wait,work”)
service_ids	string	IDs of the services in which the interaction has been processed. Comma separated list (e.g.: 1,3,5).
agent_ids	number	IDs of the agents to whom the interaction has been assigned or who processed the interaction.

Response

Remark: Every Messaging type interaction returned by the request contains its media node:

A messages node, containing :
- A count node: it indicates the total number of messages currently associated with the interaction.
- A link node: it contains the URL of the API to use to retrieve the entire list of associated messages.
\n
A connectors node with a unique link node, containing the URL of the API to use to retrieve the list of Messaging connectors used to associate messages with this interaction.

\n","urlObject":{"path":["interactions","messaging"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

(optional) Include related media data

\n","type":"text/plain"},"key":"include","value":"media"}],"variable":[]}},"response":[{"id":"e7794c29-feaa-432b-a270-4026c1dd25b8","name":"Retrieve all the messaging type interactions","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions/messaging?include=media","host":["{{api_base_url}}"],"path":["interactions","messaging"],"query":[{"key":"include","value":"media"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 09:05:03 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"483"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5c1b5b008fa13493e8007c97\",\n \"task_ref\": 100008,\n \"interaction_ref\": null,\n \"attached_ref\": null,\n \"kiamo_in_date\": \"2018-12-20T09:04:00+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100008/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100008/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100008/tags\"\n }\n },\n \"current_service\": {\n \"id\": 4,\n \"name\": \"Message entrant 1\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MESSAGINGIN\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"media\": {\n \"type\": \"messaging\",\n \"messages\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/messaging/100008/messages\"\n },\n \"count\": 1\n },\n \"connectors\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/messaging/100008/connectors\"\n }\n }\n }\n },\n {\n \"id\": \"5c1b591b8fa13493e8007c96\",\n \"task_ref\": 100006,\n \"interaction_ref\": null,\n \"attached_ref\": null,\n \"kiamo_in_date\": \"2018-12-20T08:55:55+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100006/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100006/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100006/tags\"\n }\n },\n \"current_service\": {\n \"id\": 4,\n \"name\": \"Message entrant 1\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MESSAGINGIN\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"media\": {\n \"type\": \"messaging\",\n \"messages\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/messaging/100006/messages\"\n },\n \"count\": 2\n },\n \"connectors\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/messaging/100006/connectors\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"cursor\": {\n \"current\": \"5c1b5b008fa13493e8007c97\",\n \"prev\": null,\n \"next\": null,\n \"count\": 2\n }\n }\n}"},{"id":"4df06445-0c1d-463a-ae3c-ab09e04b093a","name":"Retrieve a list of closed Messaging-type interactions","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions/messaging?include=media&states=done","host":["{{api_base_url}}"],"path":["interactions","messaging"],"query":[{"key":"include","value":"media","description":"(optional) Include related media data"},{"key":"states","value":"done"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n { \r\n ... \r\n \"media\": {\r\n \"type\": \"messaging\",\r\n \"messages\": [\r\n \"count\": 34,\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"http://127.0.0.1/api/v2/interactions/messaging/{taskref}/messages\"\r\n }\r\n ],\r\n \"connectors\": [\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"http://127.0.0.1/api/v2/interactions/messaging/{taskref}/connectors\"\r\n }\r\n ],\r\n } \r\n ...\r\n },\r\n ] \r\n \"meta\": {\r\n \"cursor\": {\r\n \"current\": null,\r\n \"prev\": null,\r\n \"next\": null,\r\n \"count\": 0\r\n }\r\n }\r\n}"}],"_postman_id":"26086a30-7add-4f6a-a925-d4713e75f43b"},{"name":"Get Messaging Interaction","id":"acc04a32-e413-43cd-a861-161dba706751","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/messaging/:ref?include=media","description":"

Retrieve a messaging type interaction

Remark: To retrieve specific information about a media, you have to include the following parameter in the query: “include=media” (see example).

\n","urlObject":{"path":["interactions","messaging",":ref"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

(optional) Include related media data

\n","type":"text/plain"},"key":"include","value":"media"}],"variable":[{"id":"899635ca-8708-4028-91cd-41cd6ae95093","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[{"id":"4c9ea8d3-4926-4471-8f50-d74f42947aae","name":"Retrieve a Messaging-type interaction","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":{"raw":"{{api_base_url}}/interactions/messaging/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","messaging",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 09:08:28 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"385"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c1b591b8fa13493e8007c96\",\n \"task_ref\": 100006,\n \"interaction_ref\": null,\n \"attached_ref\": null,\n \"kiamo_in_date\": \"2018-12-20T08:55:55+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100006/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100006/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100006/tags\"\n }\n },\n \"current_service\": {\n \"id\": 4,\n \"name\": \"Message entrant 1\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MESSAGINGIN\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"media\": {\n \"type\": \"messaging\",\n \"messages\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/messaging/100006/messages\"\n },\n \"count\": 2\n },\n \"connectors\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/messaging/100006/connectors\"\n }\n }\n }\n}"}],"_postman_id":"acc04a32-e413-43cd-a861-161dba706751"},{"name":"Update Messaging Interaction","id":"fa1a46d3-da53-42be-9ed7-ccde5981f32c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"current_service\": {\r\n \"id\" : 3\r\n },\r\n \"current_agent\": {\r\n \"id\" : 3\r\n },\r\n \"state\": \"done\"\r\n}"},"url":"{{api_base_url}}/interactions/messaging/:ref?include=media","description":"

Update a Messaging-type interaction

Body parameters

The possible body parameters (editable elements) are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Description
current_agent.id	number	ID of the agent to whom the call has been assigned or who processed the call.
current_service.id	number	ID of the service in which is the call at the moment.
scheduled_date	dateTime	Call processing scheduled date (yyyy mm dd [hh:mm] format or ISO8601 format).
state	string	Status of the call. Remark: You can only change status to done.

Answer codes

✓ “200 OK” when there is no problem.

✓ “400 Bad request” if the “current_agent” or “current_service” node is provided but the “id” parameter is missing or the agent does not exist in Kiamo.

\n","urlObject":{"path":["interactions","messaging",":ref"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

(optional) Include related media data

\n","type":"text/plain"},"key":"include","value":"media"}],"variable":[{"id":"80a1e13b-c16e-4aa0-b7a9-a0aedae24394","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[{"id":"be34d1f4-7335-4930-acc0-5b89c13af86c","name":"Close a Messaging-type interaction","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"state\":\"done\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/messaging/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","messaging",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 09:40:14 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"395"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c1b591b8fa13493e8007c96\",\n \"task_ref\": 100006,\n \"interaction_ref\": null,\n \"attached_ref\": null,\n \"kiamo_in_date\": \"2018-12-20T08:55:55+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100006/userdata\"\n }\n },\n \"state\": \"done\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100006/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100006/tags\"\n }\n },\n \"current_service\": {\n \"id\": 4,\n \"name\": \"Message entrant 1\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MESSAGINGIN\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": \"2018-12-20T09:40:03+0000\",\n \"scheduled_date\": null,\n \"media\": {\n \"type\": \"messaging\",\n \"messages\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/messaging/100006/messages\"\n },\n \"count\": 2\n },\n \"connectors\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/messaging/100006/connectors\"\n }\n }\n }\n}"},{"id":"28bd2d67-386c-4f46-a8d9-af25a146a8fc","name":"Change service (Messaging-type interaction transfer)","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"current_service\": {\n\t\t\"id\" : 6\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/messaging/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","messaging",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 11:07:39 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"400"},{"key":"Keep-Alive","value":"timeout=5, max=499"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c1b591b8fa13493e8007c96\",\n \"task_ref\": 100006,\n \"interaction_ref\": null,\n \"attached_ref\": null,\n \"kiamo_in_date\": \"2018-12-20T08:55:55+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 291\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100006/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100006/notes\"\n },\n \"count\": 1\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100006/tags\"\n }\n },\n \"current_service\": {\n \"id\": 6,\n \"name\": \"Message entrant 2\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MESSAGINGIN\"\n },\n \"current_agent\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"kiamo_out_date\": \"2018-12-20T09:40:03+0000\",\n \"scheduled_date\": null,\n \"media\": {\n \"type\": \"messaging\",\n \"messages\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/messaging/100006/messages\"\n },\n \"count\": 10\n },\n \"connectors\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/messaging/100006/connectors\"\n }\n }\n }\n}"},{"id":"79218fbf-fc1c-4082-ad63-7683bde5f2b4","name":"Assign a Messaging-type interaction to an agent","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"current_agent\": {\n\t\t\"id\" : 1\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/messaging/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","messaging",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 09:49:53 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"393"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c1b5b008fa13493e8007c97\",\n \"task_ref\": 100008,\n \"interaction_ref\": null,\n \"attached_ref\": null,\n \"kiamo_in_date\": \"2018-12-20T09:04:00+0000\",\n \"batch_id\": \"\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100008/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100008/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100008/tags\"\n }\n },\n \"current_service\": {\n \"id\": 4,\n \"name\": \"Message entrant 1\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MESSAGINGIN\"\n },\n \"current_agent\": {\n \"id\": 1,\n \"name\": \"Agent 1\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"media\": {\n \"type\": \"messaging\",\n \"messages\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/messaging/100008/messages\"\n },\n \"count\": 1\n },\n \"connectors\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/messaging/100008/connectors\"\n }\n }\n }\n}"}],"_postman_id":"fa1a46d3-da53-42be-9ed7-ccde5981f32c"},{"name":"Get Messaging Interaction Messages","id":"7e7fe668-1bcd-448e-a52c-9f932d218eab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/messaging/:ref/messages","description":"

Retrieve the content of messages included in a Messaging interaction

\n","urlObject":{"path":["interactions","messaging",":ref","messages"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"119bf7d7-7402-46a9-b9d4-1ef069a20e0a","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[{"id":"0d6a0e23-e0d9-4056-acae-7b698420ed6e","name":"Retrieve all the messages of a Messaging interaction","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions/messaging/:ref/messages","host":["{{api_base_url}}"],"path":["interactions","messaging",":ref","messages"],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 09:11:40 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"287"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"1075675826950193156\",\n \"content\": \"Hello there !\",\n \"richContent\": \"\",\n \"type\": \"facebook\",\n \"status\": \"RECEIVED\",\n \"from\": {\n \"id\": \"926042659575214082\",\n \"name\": \"Tibo___test\",\n \"senderScreenName\": \"TestTibo\"\n },\n \"received_at\": \"2021-11-20T08:55:55+0000\",\n \"sent_at\": \"2021-11-20T08:54:36+0000\",\n \"connector_id\": 1,\n \"to\": null,\n \"deleted_at\": null\n },\n {\n \"id\": \"1075676758266036229\",\n \"content\": \"Hello, i have à problem ..\",\n \"richContent\": {\n \"location\": {\n \"longitude\": \"-0.5831603\",\n \"latitude\": \"44.7074364\"\n }\n },\n \"type\": \"facebook\",\n \"status\": \"RECEIVED\",\n \"from\": {\n \"id\": \"926042659575214082\",\n \"name\": \"Tibo___test\",\n \"senderScreenName\": \"TestTibo\"\n },\n \"received_at\": \"2021-11-20T08:59:58+0000\",\n \"sent_at\": \"2021-11-20T08:58:18+0000\",\n \"connector_id\": 1,\n \"to\": null,\n \"deleted_at\": null\n },\n {\n \"id\": \"1075676758266665229\",\n \"content\": \"Hello, i actually fixed it. Thanks.\",\n \"richContent\": {\n \"unknown\": {\n \"content\": {\n \"error\" : \"There was a problem when sending your location.\"\n }\n }\n },\n \"type\": \"facebook\",\n \"status\": \"RECEIVED\",\n \"from\": {\n \"id\": \"926042659575214082\",\n \"name\": \"Tibo___test\",\n \"senderScreenName\": \"TestTibo\"\n },\n \"received_at\": \"2021-11-20T08:59:58+0000\",\n \"sent_at\": \"2021-11-20T08:58:18+0000\",\n \"connector_id\": 1,\n \"to\": null,\n \"deleted_at\": null\n }\n ]\n}"}],"_postman_id":"7e7fe668-1bcd-448e-a52c-9f932d218eab"},{"name":"Get Messaging Interaction Message","id":"a7a5f42b-2314-4807-afbd-a3a1e9db2e3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/messaging/:ref/messages/:id","description":"

Retrieve a messaging type interaction

\n","urlObject":{"path":["interactions","messaging",":ref","messages",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"9a723b32-b41a-417c-8b9e-5cb13c6b2c4e","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"},{"id":"da4a6f6b-b2bc-435e-b484-91e9670e9244","description":{"content":"

Message Id

\n","type":"text/plain"},"type":"any","value":"{{message_id}}","key":"id"}]}},"response":[{"id":"03ef8856-8d8b-4949-9c1f-61ffb5a7ec0f","name":"Récupérer un message d'une interaction messaging","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions/messaging/:ref/message?id={{message_id}}","host":["{{api_base_url}}"],"path":["interactions","messaging",":ref","message"],"query":[{"key":"id","value":"{{message_id}}"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Dec 2018 09:09:10 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"228"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1075675826950193156\",\n \"content\": \"Hello there !\",\n \"richContent\": {\n \"fallback\": {\n \"content\":\"Fallback content\", \n \"url\":\"http://www.papipapo.org\"\n }\n },\n \"type\": \"TWITTER\",\n \"status\": \"RECEIVED\",\n \"from\": {\n \"id\": \"926042659575214082\",\n \"name\": \"Tibo___test\",\n \"senderScreenName\": \"TestTibo\"\n },\n \"received_at\": \"2018-12-20T08:55:55+0000\",\n \"sent_at\": \"2018-12-20T08:54:36+0000\",\n \"connector_id\": 1,\n \"to\": null,\n \"deleted_at\": null\n}"}],"_postman_id":"a7a5f42b-2314-4807-afbd-a3a1e9db2e3e"},{"name":"Delete Messaging Interaction Message","id":"cc1d8dbb-c211-4311-a83b-addc0ff8b251","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{api_base_url}}/interactions/messaging/:ref/messages/:id","description":"

Delete a messaging type interaction

\n","urlObject":{"path":["interactions","messaging",":ref","messages",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"2915ea1b-59f8-4a41-83e0-f55183e0409e","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"},{"id":"dc2184dd-3c10-4725-9d20-acbae9636124","description":{"content":"

Message Id

\n","type":"text/plain"},"type":"any","value":"{{message_id}}","key":"id"}]}},"response":[{"id":"9e6597b2-a7e8-42a4-ac82-2b46d17c03d5","name":"Suppression d'un message d'une interaction messaging","originalRequest":{"method":"DELETE","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{api_base_url}}/api/interactions/messaging/:ref/message?id={{message_id}}","host":["{{api_base_url}}"],"path":["api","interactions","messaging",":ref","message"],"query":[{"key":"id","value":"{{message_id}}"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Thu, 20 Dec 2018 09:15:20 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"cc1d8dbb-c211-4311-a83b-addc0ff8b251"},{"name":"Retry Messaging Interaction Message","id":"9930e278-ae23-42ac-b1e0-a3bb1636ee7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/messaging/:ref/messages/:id/retry","description":"

Try to send again a messaging message

\n","urlObject":{"path":["interactions","messaging",":ref","messages",":id","retry"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"a4b737c1-bd67-4504-8412-bb96557068f4","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"},{"id":"5871853d-99f5-41bb-82dc-aa7441cfec91","description":{"content":"

Message Id

\n","type":"text/plain"},"type":"any","value":"{{message_id}}","key":"id"}]}},"response":[],"_postman_id":"9930e278-ae23-42ac-b1e0-a3bb1636ee7c"},{"name":"Get Messaging Interaction Attachments","id":"8035a7a6-568e-4896-bf49-b5c60c7a53a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/messaging/:ref/attachments","description":"

Retrieve the list of the attachment of a messaging type interaction

\n","urlObject":{"path":["interactions","messaging",":ref","attachments"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"84c9713c-87c9-4a9e-8ca0-6ddf249c18e3","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[],"_postman_id":"8035a7a6-568e-4896-bf49-b5c60c7a53a0"},{"name":"Get Messaging Interaction Attachment","id":"884f4678-1af1-4995-a112-6d65659fef5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/messaging/:ref/attachments/:id","description":"

Retrieve a specific attachment of a messaging type interaction

\n","urlObject":{"path":["interactions","messaging",":ref","attachments",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"dafb55b7-9588-4f0d-b8cf-58147b479895","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"},{"id":"37bbe97d-53de-42ed-ade4-c775d365077e","description":{"content":"

Attachment Id

\n","type":"text/plain"},"type":"any","value":"{{attachment_id}}","key":"id"}]}},"response":[],"_postman_id":"884f4678-1af1-4995-a112-6d65659fef5f"},{"name":"Get Messaging Interaction Connectors","id":"5b1b75d1-6b99-439d-9705-9945c0fee191","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/messaging/:ref/connectors","description":"

Retrieve the list of connectors used with a Messaging-type interaction

\n","urlObject":{"path":["interactions","messaging",":ref","connectors"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"e4f1e47d-3cfd-4d19-91a4-f6e4002ce6e7","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[{"id":"5f7043cf-722c-4d5d-b186-1fbf4108efb4","name":"Retrieve the list of connectors used with a Messaging-type interaction","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions/messaging/:ref/connectors","host":["{{api_base_url}}"],"path":["interactions","messaging",":ref","connectors"],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"icon\": \"fa-adjust\" \"id\": 10,\r\n \"name\": \"My Facebook DirectMessages\",\r\n \"type\": \"FACEBOOK Generic Connector\"\r\n },\r\n {\r\n \"icon\": \"fas fa-sms\" \"id\": 14,\r\n \"name\": \"My SMS Connector\",\r\n \"type\": \"SMS Generic Connector\"\r\n }, \r\n ...\r\n ]\r\n}"}],"_postman_id":"5b1b75d1-6b99-439d-9705-9945c0fee191"}],"id":"8daec5c0-979c-4219-9655-c3955d8ac831","_postman_id":"8daec5c0-979c-4219-9655-c3955d8ac831","description":""},{"name":"chats","item":[{"name":"Get Chat Interactions","id":"97d1fc9d-784d-466b-ba3a-eb7fad07901a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/chats?include=media","description":"

Retrieve the list of Chat-type interactions

Query parameters

Remark: The default pagination value is 50. This value can be modified by using the per_page query parameter. See the pagination mechanism and parameters description upper.

The possible query parameters are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Description
include	string	To retrieve specific information about a media, you have to include the following parameter: include=media
in_date_start	date	Date of start of entry of the interaction in Kiamo (yyyy mm dd [hh:mm] format or ISO8601 format).
in_date_end	date	Date of end of entry of the interaction in Kiamo (yyyy mm dd [hh:mm] format or ISO8601 format).
media	string	Type of media: ✓ call ✓ email ✓ messaging ✓ custom ✓ chat Remark: the only applicable value is the value related to the current media. Here, chat.
attached_ref	number	Interaction AttachedRef.
reference	number	Interaction ID.
states	string	Status of the interaction. Remark: This element can have the following values: ✓ wait, ✓ work, ✓ done. Remark: To insert a list, use commas (e.g.: “wait,work”)
service_ids	string	IDs of the services in which the interaction has been processed. Comma separated list (e.g.: 1,3,5).
agent_ids	number	IDs of the agents to whom the interaction has been assigned or who processed the interaction.

","urlObject":{"path":["interactions","chats"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

(optional) Include related media data

\n","type":"text/plain"},"key":"include","value":"media"}],"variable":[]}},"response":[{"id":"7ec04cee-39b8-45c7-9848-fbf2b6857b85","name":"Retrieve the list of closed chat conversations","originalRequest":{"method":"GET","header":[{"key":"Kiamo-api-Token","value":"{{token_interactions}}","type":"text"}],"url":{"raw":"{{api_base_url}/interactions/chats?include=media&states=done","host":["{{api_base_url}"],"path":["interactions","chats"],"query":[{"key":"include","value":"media"},{"key":"states","value":"done"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n { \r\n ... \r\n \"media\": {\r\n \"type\": \"chat\",\r\n \"messages\": [\r\n \"count\": 34,\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"http://127.0.0.1/api/v2/interactions/chats/{taskref}/messages\"\r\n }\r\n ]\r\n }\r\n }\r\n ],\r\n \"meta\": {\r\n \"cursor\": {\r\n \"current\": null,\r\n \"prev\": null,\r\n \"next\": null,\r\n \"count\": 0\r\n }\r\n }\r\n}"}],"_postman_id":"97d1fc9d-784d-466b-ba3a-eb7fad07901a"},{"name":"Get Chat Interaction","id":"95d549ab-af23-4e91-aa9d-251f73b4b2ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/chats/:ref?include=media","description":"

Retrieve a Chat-type interaction

\n","urlObject":{"path":["interactions","chats",":ref"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

(optional) Include related media data

\n","type":"text/plain"},"key":"include","value":"media"}],"variable":[{"id":"52e2dcb0-6a9a-43fb-8ba9-4328983b8499","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[{"id":"ae8ad88c-52c3-4b6f-bf1d-0b05c4dc3894","name":"Retrieve a Chat-type interaction","originalRequest":{"method":"GET","header":[{"key":"Kiamo-api-Token","type":"text","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions/chats/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","chats",":ref"],"query":[{"key":"include","value":"media","description":"(optional) Include related media data"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"id\": \"5a9416b0e86181a1e787ea0a\",\r\n \"task_ref\": 100001,\r\n \"interaction_ref\": null,\r\n \"attached_ref\": null,\r\n \"kiamo_in_date\": \"2018-02-26T15:16:16+01:00\",\r\n \"kiamo_out_date\": \"2018-02-26T15:18:01+01:00\",\r\n \"batch_id\": \"\",\r\n \"duration\": {\r\n \"wait\": 105,\r\n \"work\": 0\r\n },\r\n \"notes\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"https://kiamo.conecteo.fr/api/v2/interactions/100001/notes\"\r\n },\r\n \"count\": 0\r\n },\r\n \"tags\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"https://kiamo.conecteo.fr/api/v2/interactions/100001/tags\"\r\n }\r\n },\r\n \"media\": {\r\n \"type\": \"chat\",\r\n \"messages\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"https://kiamo.conecteo.fr/api/v2/interactions/chats/100001/messages\"\r\n },\r\n \"count\": 4\r\n }\r\n },\r\n \"current_service\": {\r\n \"id\": 1,\r\n \"name\": \"Service chat 1\",\r\n \"distribution_mode\": \"stop\",\r\n \"type\": \"CHAT\"\r\n },\r\n \"current_agent\": {\r\n \"id\": null,\r\n \"name\": \"\"\r\n },\r\n \"state\": \"done\",\r\n \"reference\": \"\",\r\n \"scheduled_date\": null,\r\n \"services\": [\r\n {\r\n \"service\": {\r\n \"id\": 1,\r\n \"name\": \"Service chat 1\",\r\n \"in_date\": \"2018-02-26T15:16:16+01:00\",\r\n \"out_date\": \"2018-02-26T15:18:01+01:00\"\r\n },\r\n \"exit_reason\": \"Cancelled\",\r\n \"wait\": 0,\r\n \"work\": 0,\r\n \"agent\": null\r\n }\r\n ],\r\n \"userdata\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"https://kiamo.conecteo.fr/api/v2/interactions/100001/userdata\"\r\n }\r\n },\r\n \"label\": \"\"\r\n }\r\n ],\r\n \"meta\": {\r\n \"cursor\": {\r\n \"current\": null,\r\n \"prev\": null,\r\n \"next\": null,\r\n \"count\": 0\r\n }\r\n }\r\n}"}],"_postman_id":"95d549ab-af23-4e91-aa9d-251f73b4b2ef"},{"name":"Get Chat Interaction Messages","id":"00337d17-a0ec-4f45-a427-85b1da405634","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/chats/:ref/messages","description":"

Retrieve the content of a chat conversation

Remark: To retrieve specific information about a media, you have to include the following parameter in the query: include=media (see example).

Answer codes

✓ “200 Ok” when there is no problem.

✓ “404 Not Found” if the interaction does not exist.

\n","urlObject":{"path":["interactions","chats",":ref","messages"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"c5bef573-fd46-48bf-874d-1a9390b64d46","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[{"id":"45fd6c2c-7228-40b6-8da9-18d10e42d0c8","name":"Retrieve the content of a chat conversation","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions/chats/:ref/messages","host":["{{api_base_url}}"],"path":["interactions","chats",":ref","messages"],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\r\n \"data\": {\r\n \"date\": \"2015-09-29T12:20:52+02:00\",\r\n \"type\": \"auto\",\r\n \"author\": \"\",\r\n \"content\": \"Hello and welcome! Please ask your question...\"\r\n },\r\n {\r\n \"date\": \"2015-09-29T12:20:59+02:00\",\r\n \"type\": \"client\",\r\n \"author\": \"client100420\",\r\n \"content\": \"I need information about\"\r\n } \r\n …\r\n]"}],"_postman_id":"00337d17-a0ec-4f45-a427-85b1da405634"}],"id":"51b4f98d-7a9c-4734-875b-bab4aacf1fb1","_postman_id":"51b4f98d-7a9c-4734-875b-bab4aacf1fb1","description":""},{"name":"customs","item":[{"name":"Get Custom Interactions","id":"8402e025-5908-4482-883e-e2738300206b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/customs?include=media","description":"

Retrieve the list of custom type interactions

Query parameters

Remark: The default pagination value is 50. This value can be modified by using the per_page query parameter. See the pagination mechanism and parameters description upper.

The possible query parameters are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Description
include	string	To retrieve specific information about a media, you have to include the following parameter: include=media
phone_number	number	Customer’s phone number.
in_date_start	date	Date of start of entry of the interaction in Kiamo (yyyy mm dd [hh:mm] format or ISO8601 format).
in_date_end	date	Date of end of entry of the interaction in Kiamo (yyyy mm dd [hh:mm] format or ISO8601 format).
media	string	Type of media: ✓ call ✓ email ✓ messaging ✓ custom ✓ chat Remark: the only applicable value is the value related to the current media. Here, custom.
attached_ref	number	Interaction AttachedRef.
reference	number	Interaction ID.
states	string	Status of the interaction. Remark: This element can have the following values: ✓ wait, ✓ work, ✓ done. Remark: To insert a list, use commas (e.g.: “wait,work”)
service_ids	string	IDs of the services in which the interaction has been processed. Comma separated list (e.g.: 1,3,5).
agent_ids	number	IDs of the agents to whom the interaction has been assigned or who processed the interaction.

","urlObject":{"path":["interactions","customs"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

(optional) Include related media data

\n","type":"text/plain"},"key":"include","value":"media"}],"variable":[]}},"response":[{"id":"c4cb949f-3cf6-43c2-b964-5c0d63f9f79c","name":"Retrieve all the custom type interactions","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":{"raw":"{{api_base_url}}/interactions/customs?include=media","host":["{{api_base_url}}"],"path":["interactions","customs"],"query":[{"key":"include","value":"media"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Dec 2018 09:26:32 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"518"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5c1a4d2cf9a39a0e951f7939\",\n \"task_ref\": 100003,\n \"interaction_ref\": null,\n \"attached_ref\": 100003,\n \"kiamo_in_date\": \"2018-12-19T13:52:43+0000\",\n \"batch_id\": \"0\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100003/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100003/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100003/tags\"\n }\n },\n \"current_service\": {\n \"id\": 3,\n \"name\": \"Distribution de tâches 1\",\n \"distribution_mode\": \"manual\",\n \"type\": \"MRA\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"media\": {\n \"type\": \"custom\"\n }\n },\n {\n \"id\": \"5c1a4d2cf9a39a0e951f793e\",\n \"task_ref\": 100004,\n \"interaction_ref\": null,\n \"attached_ref\": 100004,\n \"kiamo_in_date\": \"2018-12-19T13:52:43+0000\",\n \"batch_id\": \"0\",\n \"duration\": {\n \"wait\": 97012,\n \"work\": 14\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/tags\"\n }\n },\n \"current_service\": {\n \"id\": 3,\n \"name\": \"Distribution de tâches 1\",\n \"distribution_mode\": \"manual\",\n \"type\": \"MRA\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": \"2018-12-20T16:51:08+0000\",\n \"media\": {\n \"type\": \"custom\"\n }\n },\n {\n \"id\": \"5c1a4d2cf9a39a0e951f7943\",\n \"task_ref\": 100005,\n \"interaction_ref\": null,\n \"attached_ref\": 100005,\n \"kiamo_in_date\": \"2018-12-19T13:52:43+0000\",\n \"batch_id\": \"0\",\n \"duration\": {\n \"wait\": 0,\n \"work\": 0\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100005/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100005/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100005/tags\"\n }\n },\n \"current_service\": {\n \"id\": 3,\n \"name\": \"Distribution de tâches 1\",\n \"distribution_mode\": \"manual\",\n \"type\": \"MRA\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": null,\n \"media\": {\n \"type\": \"custom\"\n }\n },\n {\n \"id\": \"5c1a4d2cf9a39a0e951f7934\",\n \"task_ref\": 100002,\n \"interaction_ref\": null,\n \"attached_ref\": 100002,\n \"kiamo_in_date\": \"2018-12-19T13:52:43+0000\",\n \"batch_id\": \"0\",\n \"duration\": {\n \"wait\": 96970,\n \"work\": 10\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100002/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100002/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100002/tags\"\n }\n },\n \"current_service\": {\n \"id\": 3,\n \"name\": \"Distribution de tâches 1\",\n \"distribution_mode\": \"manual\",\n \"type\": \"MRA\"\n },\n \"current_agent\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": \"2018-12-20T16:50:05+0000\",\n \"media\": {\n \"type\": \"custom\"\n }\n }\n ],\n \"meta\": {\n \"cursor\": {\n \"current\": \"5c1a4d2cf9a39a0e951f7939\",\n \"prev\": null,\n \"next\": null,\n \"count\": 4\n }\n }\n}"},{"id":"e1cbfefc-4295-4c4f-8452-828dc81e0510","name":"Retrieve the list of custom tasks to process in a specific service","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":{"raw":"{{api_base_url}}/interactions/customs?include=media&states=wait&service_ids=7","host":["{{api_base_url}}"],"path":["interactions","customs"],"query":[{"key":"include","value":"media","description":"(optional) Include related media data"},{"key":"states","value":"wait"},{"key":"service_ids","value":"7"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"id\": \"5c7ea3d949bfc6be58f99c97\",\r\n \"task_ref\": 100055,\r\n \"interaction_ref\": null,\r\n \"attached_ref\": 100055,\r\n \"kiamo_in_date\": \"2019-03-05T16:29:13+0000\",\r\n \"batch_id\": \"0\",\r\n \"duration\": {\r\n \"wait\": 0,\r\n \"work\": 20\r\n },\r\n \"label\": \"\",\r\n \"userdata\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100055/userdata\"\r\n }\r\n },\r\n \"state\": \"wait\",\r\n \"reference\": \"\",\r\n \"notes\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100055/notes\"\r\n },\r\n \"count\": 0\r\n },\r\n \"tags\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100055/tags\"\r\n }\r\n },\r\n \"current_service\": {\r\n \"id\": 5,\r\n \"name\": \"Task distribution SC\",\r\n \"distribution_mode\": \"manual\",\r\n \"type\": \"MRA\"\r\n },\r\n \"current_agent\": {\r\n \"id\": null,\r\n \"name\": \"\"\r\n },\r\n \"kiamo_out_date\": null,\r\n \"scheduled_date\": \"2019-03-05T16:29:41+0000\",\r\n \"media\": {\r\n \"type\": \"custom\"\r\n }\r\n },\r\n {\r\n \"id\": \"5c7ea3d949bfc6be58f99c83\",\r\n \"task_ref\": 100052,\r\n \"interaction_ref\": null,\r\n \"attached_ref\": 100052,\r\n \"kiamo_in_date\": \"2019-03-05T16:29:13+0000\",\r\n \"batch_id\": \"0\",\r\n \"duration\": {\r\n \"wait\": 0,\r\n \"work\": 0\r\n },\r\n \"label\": \"\",\r\n \"userdata\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100052/userdata\"\r\n }\r\n },\r\n \"state\": \"wait\",\r\n \"reference\": \"\",\r\n \"notes\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100052/notes\"\r\n },\r\n \"count\": 0\r\n },\r\n \"tags\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100052/tags\"\r\n }\r\n },\r\n \"current_service\": {\r\n \"id\": 5,\r\n \"name\": \"Task distribution SC\",\r\n \"distribution_mode\": \"manual\",\r\n \"type\": \"MRA\"\r\n },\r\n \"current_agent\": {\r\n \"id\": null,\r\n \"name\": \"\"\r\n },\r\n \"kiamo_out_date\": null,\r\n \"scheduled_date\": null,\r\n \"media\": {\r\n \"type\": \"custom\"\r\n }\r\n }\r\n ],\r\n \"meta\": {\r\n \"cursor\": {\r\n \"current\": \"5c7ea3d949bfc6be58f99c97\",\r\n \"prev\": null,\r\n \"next\": null,\r\n \"count\": 4\r\n }\r\n }\r\n}"}],"_postman_id":"8402e025-5908-4482-883e-e2738300206b"},{"name":"Get Custom Interaction","id":"a49d6ab8-f966-4594-8fb2-1c4ac7fba026","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"url":"{{api_base_url}}/interactions/customs/:ref?include=media","description":"

Retrieve a Custom-type interaction

\n","urlObject":{"path":["interactions","customs",":ref"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

(optional) Include related media data

\n","type":"text/plain"},"key":"include","value":"media"}],"variable":[{"id":"740037fe-5c1b-4b7c-aa97-93fedf3b3f10","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[{"id":"dbeb456f-3cf4-4622-bb01-3ed86eae68c4","name":"Retrieve a Custom-type interaction","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"}],"url":{"raw":"{{api_base_url}}/interactions/customs/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","customs",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Dec 2018 10:33:45 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"378"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c1a4d2cf9a39a0e951f793e\",\n \"task_ref\": 100004,\n \"interaction_ref\": null,\n \"attached_ref\": 100004,\n \"kiamo_in_date\": \"2018-12-19T13:52:43+0000\",\n \"batch_id\": \"0\",\n \"duration\": {\n \"wait\": 97012,\n \"work\": 14\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"reference value\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/tags\"\n }\n },\n \"current_service\": {\n \"id\": 9,\n \"name\": \"Distribution de tâches 2\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MRA\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": \"2018-12-21T16:00:00+0000\",\n \"media\": {\n \"type\": \"custom\"\n }\n}"}],"_postman_id":"a49d6ab8-f966-4594-8fb2-1c4ac7fba026"},{"name":"Update Custom Interaction","id":"2be85665-f3cf-442a-add4-596412ff1b1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"current_service\": {\n\t\t\"id\" : 3\n\t},\n\t\"current_agent\": {\n\t\t\"id\" : 3\n\t},\n\t\"state\": \"done\",\n\t\"reference\": \"custom reference\",\n\t\"destination\": 9999,\n\t\"scheduled_date\": \"2018-12-27 16:00:00\",\n\t\"user_data\": {\n\t\t\"variableA\": \"value\"\n\t}\n}"},"url":"{{api_base_url}}/interactions/customs/:ref?include=media","description":"

Update of a Custom-type interaction

Body parameters

The possible body parameters (editable elements) are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Description
current_agent.id	number	ID of the agent to whom the call has been assigned or who processed the call.
current_service.id	number	ID of the service in which is the call at the moment.
destination	string	Customer’s phone number. Remark: This property is optional for a call included in an outbound call campaign with the multi dialing option selected.
scheduled_date	dateTime	Call processing scheduled date (yyyy mm dd [hh:mm] format or ISO8601 format).
state	string	Status of the call. Remark: You can only change status to done.
reference	string	Interaction reference.
userdata	object	Interaction user data.

Answer codes

✓ “200 OK” when there is no problem.

✓ “400 Bad request” if the “current_agent” or “current_service” node is provided but the “id” parameter is missing or the agent does not exist in Kiamo.

\n","urlObject":{"path":["interactions","customs",":ref"],"host":["{{api_base_url}}"],"query":[{"description":{"content":"

(optional) Include related media data

\n","type":"text/plain"},"key":"include","value":"media"}],"variable":[{"id":"c0fa62fb-59c1-4fe7-9a0f-1d9ae78a6858","description":{"content":"

Interaction reference

\n","type":"text/plain"},"type":"any","value":"{{interaction_ref}}","key":"ref"}]}},"response":[{"id":"2e40e2e7-5f84-4a02-953d-3bf230ec504b","name":"Update the interaction reference","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"reference\": \"reference value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/customs/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","customs",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Dec 2018 10:09:29 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"379"},{"key":"Keep-Alive","value":"timeout=5, max=499"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c1a4d2cf9a39a0e951f793e\",\n \"task_ref\": 100004,\n \"interaction_ref\": null,\n \"attached_ref\": 100004,\n \"kiamo_in_date\": \"2018-12-19T13:52:43+0000\",\n \"batch_id\": \"0\",\n \"duration\": {\n \"wait\": 97012,\n \"work\": 14\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"reference value\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/tags\"\n }\n },\n \"current_service\": {\n \"id\": 9,\n \"name\": \"Distribution de tâches 2\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MRA\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": \"2018-12-20T16:51:08+0000\",\n \"media\": {\n \"type\": \"custom\"\n }\n}"},{"id":"90f52e56-d189-4588-a8a8-658e7153fbfd","name":"Update a Custom-type Interaction","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"current_service\": {\n\t\t\"id\" : 2\n\t},\n\t\"current_agent\": {\n\t\t\"id\" : 4\n\t},\n\t\"state\": \"done\",\n\t\"destination\": 3344,\n\t\"scheduled_date\": \"2016-02-02 10:30:00\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/customs/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","customs",":ref"],"query":[{"key":"include","value":"media","description":"(optional) Include related media data"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"5c7ea3d949bfc6be58f99c92\",\r\n \"task_ref\": 100054,\r\n \"interaction_ref\": null,\r\n \"attached_ref\": 100054,\r\n \"kiamo_in_date\": \"2019-03-05T16:29:13+0000\",\r\n \"batch_id\": \"0\",\r\n \"duration\": {\r\n \"wait\": 0,\r\n \"work\": 0\r\n },\r\n \"label\": \"\",\r\n \"userdata\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100054/userdata\"\r\n }\r\n },\r\n \"state\": \"wait\",\r\n \"reference\": \"\",\r\n \"notes\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100054/notes\"\r\n },\r\n \"count\": 0\r\n },\r\n \"tags\": {\r\n \"link\": {\r\n \"rel\": \"related\",\r\n \"href\": \"/api/v2/interactions/100054/tags\"\r\n }\r\n },\r\n \"current_service\": {\r\n \"id\": 5,\r\n \"name\": \"Task distribution SC\",\r\n \"distribution_mode\": \"manual\",\r\n \"type\": \"MRA\"\r\n },\r\n \"current_agent\": {\r\n \"id\": null,\r\n \"name\": \"\"\r\n },\r\n \"kiamo_out_date\": null,\r\n \"scheduled_date\": null,\r\n \"media\": {\r\n \"type\": \"custom\"\r\n }\r\n}"},{"id":"d46ddb7d-2364-4727-8e43-a24c50982a7d","name":"Assign an agent to the interaction","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"current_agent\": {\n\t\t\"id\": 2\n\t}\t\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/customs/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","customs",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Dec 2018 10:00:20 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"384"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c1a4d2cf9a39a0e951f793e\",\n \"task_ref\": 100004,\n \"interaction_ref\": null,\n \"attached_ref\": 100004,\n \"kiamo_in_date\": \"2018-12-19T13:52:43+0000\",\n \"batch_id\": \"0\",\n \"duration\": {\n \"wait\": 97012,\n \"work\": 14\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/tags\"\n }\n },\n \"current_service\": {\n \"id\": 3,\n \"name\": \"Distribution de tâches 1\",\n \"distribution_mode\": \"manual\",\n \"type\": \"MRA\"\n },\n \"current_agent\": {\n \"id\": 2,\n \"name\": \"Nouvel_Agent_2\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": \"2018-12-20T16:51:08+0000\",\n \"media\": {\n \"type\": \"custom\"\n }\n}"},{"id":"a017234b-832e-40d3-bc48-50a951df2b94","name":"Transfer the interaction to another service","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"current_service\": {\n\t\t\"id\": 9\n\t}\t\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/customs/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","customs",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Dec 2018 10:04:25 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"373"},{"key":"Keep-Alive","value":"timeout=5, max=499"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c1a4d2cf9a39a0e951f793e\",\n \"task_ref\": 100004,\n \"interaction_ref\": null,\n \"attached_ref\": 100004,\n \"kiamo_in_date\": \"2018-12-19T13:52:43+0000\",\n \"batch_id\": \"0\",\n \"duration\": {\n \"wait\": 97012,\n \"work\": 14\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/tags\"\n }\n },\n \"current_service\": {\n \"id\": 9,\n \"name\": \"Distribution de tâches 2\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MRA\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": \"2018-12-20T16:51:08+0000\",\n \"media\": {\n \"type\": \"custom\"\n }\n}"},{"id":"9940bc1c-e3a8-49ff-8096-9e64303a4672","name":"Add a scheduled date to the interaction","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"scheduled_date\": \"2018-12-21 16:00:00\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/customs/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","customs",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Dec 2018 10:12:33 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"378"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c1a4d2cf9a39a0e951f793e\",\n \"task_ref\": 100004,\n \"interaction_ref\": null,\n \"attached_ref\": 100004,\n \"kiamo_in_date\": \"2018-12-19T13:52:43+0000\",\n \"batch_id\": \"0\",\n \"duration\": {\n \"wait\": 97012,\n \"work\": 14\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"reference value\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/tags\"\n }\n },\n \"current_service\": {\n \"id\": 9,\n \"name\": \"Distribution de tâches 2\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MRA\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": \"2018-12-21T16:00:00+0000\",\n \"media\": {\n \"type\": \"custom\"\n }\n}"},{"id":"50118fca-4a92-446a-a2f2-df0c0921b5a0","name":"Add userdata to the interaction","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"userdata\": {\n\t\t\"VariableA\" : \"value\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/customs/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","customs",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Dec 2018 10:10:53 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"379"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c1a4d2cf9a39a0e951f793e\",\n \"task_ref\": 100004,\n \"interaction_ref\": null,\n \"attached_ref\": 100004,\n \"kiamo_in_date\": \"2018-12-19T13:52:43+0000\",\n \"batch_id\": \"0\",\n \"duration\": {\n \"wait\": 97012,\n \"work\": 14\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"reference value\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/tags\"\n }\n },\n \"current_service\": {\n \"id\": 9,\n \"name\": \"Distribution de tâches 2\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MRA\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": \"2018-12-20T16:51:08+0000\",\n \"media\": {\n \"type\": \"custom\"\n }\n}"},{"id":"0780ff77-7610-425a-a49c-a38cf3158f7f","name":"Update the interaction destination","originalRequest":{"method":"PUT","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"destination\": 9999\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/interactions/customs/:ref?include=media","host":["{{api_base_url}}"],"path":["interactions","customs",":ref"],"query":[{"key":"include","value":"media"}],"variable":[{"key":"ref","value":"{{interaction_ref}}","description":"Interaction reference"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Dec 2018 10:08:06 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"379"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5c1a4d2cf9a39a0e951f793e\",\n \"task_ref\": 100004,\n \"interaction_ref\": null,\n \"attached_ref\": 100004,\n \"kiamo_in_date\": \"2018-12-19T13:52:43+0000\",\n \"batch_id\": \"0\",\n \"duration\": {\n \"wait\": 97012,\n \"work\": 14\n },\n \"label\": \"\",\n \"userdata\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/userdata\"\n }\n },\n \"state\": \"wait\",\n \"reference\": \"custom ref\",\n \"notes\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/notes\"\n },\n \"count\": 0\n },\n \"tags\": {\n \"link\": {\n \"rel\": \"related\",\n \"href\": \"/interactions/100004/tags\"\n }\n },\n \"current_service\": {\n \"id\": 9,\n \"name\": \"Distribution de tâches 2\",\n \"distribution_mode\": \"stop\",\n \"type\": \"MRA\"\n },\n \"current_agent\": {\n \"id\": null,\n \"name\": \"\"\n },\n \"kiamo_out_date\": null,\n \"scheduled_date\": \"2018-12-20T16:51:08+0000\",\n \"media\": {\n \"type\": \"custom\"\n }\n}"}],"_postman_id":"2be85665-f3cf-442a-add4-596412ff1b1e"}],"id":"e4b3b9f2-ff87-4e9a-949d-4fb08afae304","_postman_id":"e4b3b9f2-ff87-4e9a-949d-4fb08afae304","description":""},{"name":"services","item":[{"name":"Create Service Interactions","id":"4da9c5df-0ec8-4f8f-9890-b2706123a931","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"agent_id\": 1,\n \"reference\": \"my_ref\",\n \"destination\": 9999,\n \"scheduled_date\": \"2018-12-27 16:00:00\",\n \"userdata\": {\n \"variable\": \"value\"\n }\n }\n]"},"url":"{{api_base_url}}/services/:id/interactions","description":"

Creation of one or more interactions linked to a specific service

Body parameters

The possible body parameters are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Description
agent_id	number	Unique ID of the agent to whom the interaction has been assigned or who processed the interaction. Remark: This parameter is optional.
destination	string	Phone number to call. Remark: This element is mandatory with outbound call campaigns.
reference	string	Interaction reference. Remark: This parameter is optional.
scheduled_date	dateTime	Interaction processing scheduled date (yyyy mm dd [hh:mm] format or ISO8601 format). Remark: This parameter is optional.
userdata or userdatas	object	Interaction user data. Remark: This parameter is optional.

Caution : Before inserting interactions, you have to create all the user variables (userdata) that will be used in the query and to enable the storage of these variables in the Kiamo administration interface, Developer </> > List of variables menu > User variables tab; otherwise, userdata will not be available in the interactions database. For more information, please refer to the “Kiamo Developer guide”.

Answer codes

✓ “201 Created” when there is no problem.

✓ “400 Bad Request” if no interaction has been sent in the query, if the destination has not been provided or if the scheduled_date is not in the right format.

\n","urlObject":{"path":["services",":id","interactions"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"cc3014bd-b7c0-4126-9975-6420d76e3ce8","description":{"content":"

Service Id

\n","type":"text/plain"},"type":"any","value":"{{service_id}}","key":"id"}]}},"response":[{"id":"52dfbfd9-85e2-4ca4-ab96-a70badc4af20","name":"Insertion of several tasks","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[ \n { \n \"agent_id\":4,\n \"destination\": \"1425696823\", \n \"reference\": \"azertyuiop\", \n \"scheduled_date\": \"2019-06-20 15:00:00\", \n \"userdata\": { \n \"name\": \"Smith\", \n \"first_name\": \"John\", \n \"company\": \"Kiamo\" \n } \n }, \n { \n \"destination\": \"1896254872\", \n \"scheduled_date\": \"2019-06-20 15:03:00\", \n \"userdata\": { \n \"name\": \"Farrell\", \n \"first_name\": \"Jack\", \n \"company\": \"MyCompany\" \n } \n } \n]","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/services/:id/interactions","host":["{{api_base_url}}"],"path":["services",":id","interactions"],"variable":[{"key":"id","value":"{{service_id}}","description":"Service Id"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 201,\r\n \"title\": \"Resource has been created\",\r\n \"detail\": \"Follow location to get created resources\",\r\n \"location\": \"http://ctotestvbe/api/v2/interactions?in_date_start=2019-03-11+10%3A44%3A57\"\r\n}"},{"id":"47e531ab-aaa7-4a6d-b848-a773d96d813e","name":"Insertion of a task in a type MRA service","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n\t{\n\t\t\"agent_id\": 1,\n\t\t\"reference\": \"my_ref\",\n\t\t\"destination\": 9999,\n\t\t\"scheduled_date\": \"2018-12-27 16:00:00\",\n\t\t\"userdata\": {\n\t\t\t\"variable\": \"value\"\n\t\t}\n\t}\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_base_url}}/services/:id/interactions","host":["{{api_base_url}}"],"path":["services",":id","interactions"],"variable":[{"key":"id","value":"{{service_id}}","description":"Service Id"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 27 Dec 2018 10:50:20 GMT"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Location","value":"http://127.0.0.1/interactions?in_date_start=2018-12-27+10%3A50%3A21"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"172"},{"key":"Keep-Alive","value":"timeout=5, max=500"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"title\": \"Resource has been created\",\n \"detail\": \"Follow location to get created resources\",\n \"location\": \"http://127.0.0.1/interactions?in_date_start=2018-12-27+10%3A50%3A21\"\n}"}],"_postman_id":"4da9c5df-0ec8-4f8f-9890-b2706123a931"},{"name":"Delete Service Interactions","id":"76159ba9-2138-4003-a421-c67d0c671ef6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Kiamo-Api-Token","value":"{{token_interactions}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{api_base_url}}/services/:id/interactions","description":"

Delete all the interactions in a specific service

Answer codes

✓ \"204 No Content\" when there is no problem.

\n","urlObject":{"path":["services",":id","interactions"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"2ad91e92-cc30-43ff-b35e-43bb1d15cc93","description":{"content":"

Service Id

\n","type":"text/plain"},"type":"any","value":"{{service_id}}","key":"id"}]}},"response":[{"id":"c284a449-e8fb-4bb3-9115-cd51171b0e2f","name":"Delete all the interactions in a specific service","originalRequest":{"method":"DELETE","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_interactions}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{api_base_url}}/services/:id/interactions","host":["{{api_base_url}}"],"path":["services",":id","interactions"],"variable":[{"key":"id","value":"{{service_id}}","description":"Service Id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"76159ba9-2138-4003-a421-c67d0c671ef6"}],"id":"ccda2c6f-3ec8-4c20-a7b8-293c55459287","_postman_id":"ccda2c6f-3ec8-4c20-a7b8-293c55459287","description":""}],"id":"3aa83e04-9919-496b-a0c7-0a50245a52f9","description":"

INTERACTION API

Common query parameters

The following query parameters are available for GET requests:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
sort		Ascending / descending sort of a field
include_drafts		Only available if the media is mail

Pagination

Presentation

To manage a large number of results without degrading the performance of the software, the Interaction API uses a pagination system for list-type resources.

This pagination is easy to use: it is based on Cursor type pagination (Cursor Based Pagination).
Thus, all the list type resources return a shared structure:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data Type	Description
meta.cursor	Object	Information about the result
data	N Interaction Objects	Interaction table

Example of a JSON answer

\"meta\": { \n    \"cursor\": { \n        \"current\": \"5b1139767265e44aa4003b2e\", \n        \"prev\": null, \n        \"next\": \"5b1139747265e44aa4003ade\", \n        \"count\": 50 \n    }\n}, \n\"data\" : []\n\n

The “cursor” object contains the following elements:

✓ current: ID of the interaction where the cursor is.

✓ prev: ID of the interaction previous to the interaction where the cursor is.

✓ next: ID of the interaction following the interaction where the cursor is.

✓ count: total number of results.

Parameters

The following query parameters are available to refine/ browse the list of results:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
per_page	number	Number of results to return. Remark: The default value is: 50.
next_id	string	ID of the last result returned. It is the ID that you will have to provide to get the next results. Remark: Mandatory parameter.

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"e4d12d07-2571-41f1-99f4-d1cbedb21180"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"36ccf04b-283f-452b-b8b2-92ca150e1914"}}],"_postman_id":"3aa83e04-9919-496b-a0c7-0a50245a52f9"},{"name":"supervision","item":[{"name":"Create Supervision View","id":"0415bd27-fd0e-4d2b-b49e-b3783c4bd7a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Kiamo-Api-Token","value":"{{token_supervision}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n\t{\r\n\t\t\"type\": \"histo\",\r\n\t\t\"entity\": \"service\",\r\n\t\t\"ref\": \"5dcd32d8b2cf740d50005b58\",\r\n\t\t\"range\": 2,\r\n\t\t\"step\": \"cumul\",\r\n\t\t\"entities_ids\": [\r\n\t\t\t3\r\n\t\t],\r\n\t\t\"indicator\": {\r\n\t\t\t\"type\": \"HISTO-RCVCALL\",\r\n\t\t\t\"label\": \"Reçus\",\r\n\t\t\t\"alarms\": []\r\n\t\t}\r\n\t},\r\n\t{\r\n\t\t\"type\": \"interaction\",\r\n\t\t\"entity\": \"service\",\r\n\t\t\"ref\": \"5dcd357bb2cf743f70002848\",\r\n\t\t\"entities_ids\": [\r\n\t\t\t3\r\n\t\t]\r\n\t},\r\n\t{\r\n\t\t\"type\": \"cumul\",\r\n\t\t\"entity\": \"service\",\r\n\t\t\"ref\": \"5dcd3e54b2cf743f70002849\",\r\n\t\t\"entities_ids\": [\r\n\t\t\t3,\r\n\t\t\t9\r\n\t\t],\r\n\t\t\"indicators\": [\r\n\t\t\t{\r\n\t\t\t\t\"type\": \"CLWAIT\",\r\n\t\t\t\t\"label\": \"App.en ATT\",\r\n\t\t\t\t\"alarms\": []\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"type\": \"CLRCV_DAY\",\r\n\t\t\t\t\"label\": \"Reçus(j)\",\r\n\t\t\t\t\"alarms\": [\r\n\t\t\t\t\t{\r\n\t\t\t\t\t\t\"from\": 0,\r\n\t\t\t\t\t\t\"to\": 0,\r\n\t\t\t\t\t\t\"color\": \"#000000\"\r\n\t\t\t\t\t},\r\n\t\t\t\t\t{\r\n\t\t\t\t\t\t\"greater_than\": 50,\r\n\t\t\t\t\t\t\"color\": \"#FF0000\"\r\n\t\t\t\t\t}\r\n\t\t\t\t]\r\n\t\t\t}\r\n\t\t]\r\n\t},\r\n\t{\r\n\t\t\"type\": \"detail\",\r\n\t\t\"entity\": \"agent\",\r\n\t\t\"ref\": \"5dcd3ebab2cf743f7000284b\",\r\n\t\t\"filter\": {\r\n\t\t\t\"type\": \"group\",\r\n\t\t\t\"id\": 1\r\n\t\t},\r\n\t\t\"entities_ids\": [\r\n\t\t\t2,\r\n\t\t\t1\r\n\t\t],\r\n\t\t\"indicators\": [\r\n\t\t\t{\r\n\t\t\t\t\"type\": \"SVCCLANS\",\r\n\t\t\t\t\"label\": \"App.Traités\",\r\n\t\t\t\t\"alarms\": []\r\n\t\t\t}\r\n\t\t],\r\n\t\t\"states\": [\r\n\t\t\t{\r\n\t\t\t\t\"id\": 3,\r\n\t\t\t\t\"alarms\": [\r\n\t\t\t\t\t{\r\n\t\t\t\t\t\t\"from\": 0,\r\n\t\t\t\t\t\t\"to\": 500,\r\n\t\t\t\t\t\t\"color\": \"#008000\"\r\n\t\t\t\t\t},\r\n\t\t\t\t\t{\r\n\t\t\t\t\t\t\"greater_than\": 30,\r\n\t\t\t\t\t\t\"color\": \"#FF0000\"\r\n\t\t\t\t\t}\r\n\t\t\t\t]\r\n\t\t\t}\r\n\t\t]\r\n\t},\r\n\t{\r\n\t\t\"type\": \"detail\",\r\n\t\t\"entity\": \"service\",\r\n\t\t\"ref\": \"5dcd3ee1b2cf743f7000284c\",\r\n\t\t\"entities_ids\": [\r\n\t\t\t3,\r\n\t\t\t9\r\n\t\t],\r\n\t\t\"indicators\": [\r\n\t\t\t{\r\n\t\t\t\t\"type\": \"CLRIGHTNOW\",\r\n\t\t\t\t\"label\": \"App.en cours\",\r\n\t\t\t\t\"alarms\": []\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"type\": \"CLWAIT\",\r\n\t\t\t\t\"label\": \"App.en ATT\",\r\n\t\t\t\t\"alarms\": []\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"type\": \"NBAGTACTIVE\",\r\n\t\t\t\t\"label\": \"Actifs\",\r\n\t\t\t\t\"alarms\": []\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"type\": \"SVCQUAL_15\",\r\n\t\t\t\t\"label\": \"QOS(15)\",\r\n\t\t\t\t\"alarms\": []\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"type\": \"WAITMAX\",\r\n\t\t\t\t\"label\": \"Att.Max\",\r\n\t\t\t\t\"alarms\": []\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"type\": \"CLRCV_DAY\",\r\n\t\t\t\t\"label\": \"Reçus(j)\",\r\n\t\t\t\t\"alarms\": []\r\n\t\t\t}\r\n\t\t]\r\n\t},\r\n\t{\r\n\t\t\"type\": \"cumul\",\r\n\t\t\"entity\": \"group\",\r\n\t\t\"ref\": \"5dcd9616b2cf7427bc0062a5\",\r\n\t\t\"entities_ids\": [\r\n\t\t\t1,\r\n\t\t\t3\r\n\t\t],\r\n\t\t\"indicators\": [\r\n\t\t\t{\r\n\t\t\t\t\"type\": \"NBAGTLOG\",\r\n\t\t\t\t\"label\": \"Logués\",\r\n\t\t\t\t\"alarms\": []\r\n\t\t\t}\r\n\t\t]\r\n\t},\r\n\t{\r\n\t\t\"type\": \"cumul\",\r\n\t\t\"entity\": \"service\",\r\n\t\t\"ref\": \"5dcd9943b2cf7427bc0062a6\",\r\n\t\t\"entities_ids\": [\r\n\t\t\t3,\r\n\t\t\t9\r\n\t\t],\r\n\t\t\"indicators\": [\r\n\t\t\t{\r\n\t\t\t\t\"type\": \"CLRCV_DAY\",\r\n\t\t\t\t\"label\": \"Reçus(j)\",\r\n\t\t\t\t\"alarms\": [\r\n\t\t\t\t\t{\r\n\t\t\t\t\t\t\"from\": 0,\r\n\t\t\t\t\t\t\"to\": 3000,\r\n\t\t\t\t\t\t\"color\": \"#008000\"\r\n\t\t\t\t\t},\r\n\t\t\t\t\t{\r\n\t\t\t\t\t\t\"from\": 3000,\r\n\t\t\t\t\t\t\"to\": 5000,\r\n\t\t\t\t\t\t\"color\": \"#ffa900\"\r\n\t\t\t\t\t},\r\n\t\t\t\t\t{\r\n\t\t\t\t\t\t\"greater_than\": 5000,\r\n\t\t\t\t\t\t\"color\": \"#FF0000\"\r\n\t\t\t\t\t}\r\n\t\t\t\t]\r\n\t\t\t}\r\n\t\t]\r\n\t},\r\n\t{\r\n\t\t\"type\": \"list\",\r\n\t\t\"entity\": {\r\n\t\t\t\"type\": \"group\",\r\n\t\t\t\"id\": 1\r\n\t\t},\r\n\t\t\"ref\": \"5dce5abcb2cf74041c002866\",\r\n\t\t\"indicators\": [\r\n\t\t\t{\r\n\t\t\t\t\"type\": \"NBAGTLOG\",\r\n\t\t\t\t\"label\": \"Logués\",\r\n\t\t\t\t\"alarms\": []\r\n\t\t\t}\r\n\t\t]\r\n\t},\r\n\t{\r\n\t\t\"type\": \"list\",\r\n\t\t\"entity\": {\r\n\t\t\t\"type\": \"team\",\r\n\t\t\t\"id\": 1\r\n\t\t},\r\n\t\t\"ref\": \"5dce5accb2cf741b34002194\",\r\n\t\t\"indicators\": [\r\n\t\t\t{\r\n\t\t\t\t\"type\": \"NBAGTLOG\",\r\n\t\t\t\t\"label\": \"Logués\",\r\n\t\t\t\t\"alarms\": []\r\n\t\t\t}\r\n\t\t]\r\n\t},\r\n\t{\r\n\t\t\"type\": \"cumul\",\r\n\t\t\"entity\": \"service\",\r\n\t\t\"ref\": \"5dce5ae2b2cf7418c4002df9\",\r\n\t\t\"entities_ids\": [\r\n\t\t\t3,\r\n\t\t\t9\r\n\t\t],\r\n\t\t\"indicators\": [\r\n\t\t\t{\r\n\t\t\t\t\"type\": \"CLWAIT\",\r\n\t\t\t\t\"label\": \"App.en ATT\",\r\n\t\t\t\t\"alarms\": []\r\n\t\t\t}\r\n\t\t]\r\n\t},\r\n\t{ \r\n\t\t\"type\": \"list\",\r\n\t\t\"entity\": {\r\n\t\t\t\"type\": \"service\",\r\n\t\t\t\"id\": 3\r\n\t\t},\r\n\t\t\"ref\": \"5dce610bb2cf7418c4002dfb\",\r\n\t\t\"indicators\": [\r\n\t\t\t{\r\n\t\t\t\t\"type\": \"QUALIFICATION\",\r\n\t\t\t\t\"list\": [\r\n\t\t\t\t\t1\r\n\t\t\t\t],\r\n\t\t\t\t\"label\": \"Qualification\",\r\n\t\t\t\t\"alarms\": []\r\n\t\t\t}\r\n\t\t]\r\n\t},\r\n\t{\r\n\t\t\"type\": \"histo\",\r\n\t\t\"entity\": \"group\",\r\n\t\t\"ref\": \"5dce626bb2cf743a34006065\",\r\n\t\t\"range\": 2,\r\n\t\t\"step\": \"cumul\",\r\n\t\t\"entities_ids\": [\r\n\t\t\t1\r\n\t\t],\r\n\t\t\"indicator\": {\r\n\t\t\t\"type\": \"CUSTOM_1\",\r\n\t\t\t\"label\": \"Sinusoïde\",\r\n\t\t\t\"alarms\": [\r\n\t\t\t\t{\r\n\t\t\t\t\t\"from\": 0,\r\n\t\t\t\t\t\"to\": 0,\r\n\t\t\t\t\t\"color\": \"#008000\"\r\n\t\t\t\t},\r\n\t\t\t\t{\r\n\t\t\t\t\t\"greater_than\": 0,\r\n\t\t\t\t\t\"color\": \"#FF0000\"\r\n\t\t\t\t}\r\n\t\t\t]\r\n\t\t}\r\n\t}\r\n]"},"url":"{{api_base_url}}/supervision/views","description":"

Create a supervision view

Query parameters

The possible query parameters are listed below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data type	Description
return	N/A	This parameter is used to directly obtain the valorized View object, instead of retrieving the View ID. Caution: If you send a POST request with a return of the view, you cannot obtain the ID of the generated view.

JSON body

The JSON body is composed by an array of Block objects.

Remark: see the provided example of supervision view creation with different configurations.

\n","urlObject":{"path":["supervision","views"],"host":["{{api_base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e0f36182-556b-4e9a-976d-5a8fb29edd97","name":"Create a view with a List of Agents configuration","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_supervision}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n\t{\r\n\t\t\"type\": \"detail\",\r\n\t\t\"entity\": \"agent\",\r\n\t\t\"ref\": \"5dcd3ebab2cf743f7000284b\",\r\n\t\t\"filter\": {\r\n\t\t\t\"type\": \"group\",\r\n\t\t\t\"id\": 1\r\n\t\t},\r\n\t\t\"entities_ids\": [\r\n\t\t\t2,\r\n1\r\n\t\t],\r\n\t\t\"indicators\": [\r\n\t\t\t{\r\n\t\t\t\t\"type\": \"SVCCLANS\",\r\n\t\t\t\t\"label\": \"Handled Calls\",\r\n\t\t\t\t\"alarms\": []\r\n\t\t\t}\r\n\t\t],\r\n\t\t\"states\": [\r\n\t\t\t{\r\n\t\t\t\t\"id\": 3,\r\n\t\t\t\t\"alarms\": [\r\n\t\t\t\t\t{\r\n\t\t\t\t\t\t\"from\": 0,\r\n\t\t\t\t\t\t\"to\": 500,\r\n\t\t\t\t\t\t\"color\": \"#008000\"\r\n\t\t\t\t\t},\r\n\t\t\t\t\t{\r\n\t\t\t\t\t\t\"greater_than\": 30,\r\n\t\t\t\t\t\t\"color\": \"#FF0000\"\r\n\t\t\t\t\t}\r\n\t\t\t\t]\r\n\t\t\t}\r\n\t\t]\r\n\t}\r\n]\r\n","options":{"raw":{"language":"json"}}},"url":"{{api_base_url}}/supervision/views"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": {\n \"message\": \"Resource has been created\",\n \"code\": \"\",\n \"location\": \"http://ctotestvbe/api/v2/supervision/views/3\",\n \"view\": {\n \"id\": \"3\"\n }\n }\n}"},{"id":"59051013-ff3f-42ef-bc5b-f44e4dce3e2b","name":"Create a view with a List of Services configuration","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_supervision}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"type\": \"detail\",\r\n \"entity\": \"service\",\r\n \"ref\": \"5dcd3ee1b2cf743f7000284c\",\r\n \"entities_ids\": [\r\n 3,\r\n 9\r\n ],\r\n \"indicators\": [\r\n {\r\n \"type\": \"CLRIGHTNOW\",\r\n \"label\": \"OnGoingCalls\",\r\n \"alarms\": []\r\n },\r\n {\r\n \"type\": \"CLWAIT\",\r\n \"label\": \"Queued\",\r\n \"alarms\": []\r\n },\r\n {\r\n \"type\": \"NBAGTACTIVE\",\r\n \"label\": \"Active\",\r\n \"alarms\": []\r\n },\r\n {\r\n \"type\": \"SVCQUAL_15\",\r\n \"label\": \"QOS(15)\",\r\n \"alarms\": []\r\n },\r\n {\r\n \"type\": \"WAITMAX\",\r\n \"label\": \"Max.Wait\",\r\n \"alarms\": []\r\n },\r\n {\r\n \"type\": \"CLRCV_DAY\",\r\n \"label\": \"Received(d)\",\r\n \"alarms\": []\r\n }\r\n ]\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"{{api_base_url}}/supervision/views"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": {\n \"message\": \"Resource has been created\",\n \"code\": \"\",\n \"location\": \"http://ctotestvbe/api/v2/supervision/views/3\",\n \"view\": {\n \"id\": \"3\"\n }\n }\n}"},{"id":"9516c4c9-a8a5-4c7b-8ae8-c2382b9dc24e","name":"Create a view with a Team / Group / Service configuration","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_supervision}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"type\": \"list\",\r\n \"entity\": {\r\n \"type\": \"group\",\r\n \"id\": 1\r\n },\r\n \"ref\": \"5dce5abcb2cf74041c002866\",\r\n \"indicators\": [\r\n {\r\n \"type\": \"NBAGTLOG\",\r\n \"label\": \"Connected\",\r\n \"alarms\": []\r\n }\r\n ]\r\n },\r\n {\r\n \"type\": \"list\",\r\n \"entity\": {\r\n \"type\": \"team\",\r\n \"id\": 1\r\n },\r\n \"ref\": \"5dce5accb2cf741b34002194\",\r\n \"indicators\": [\r\n {\r\n \"type\": \"NBAGTLOG\",\r\n \"label\": \"Connected\",\r\n \"alarms\": []\r\n }\r\n ]\r\n },\r\n {\r\n \"type\": \"list\",\r\n \"entity\": {\r\n \"type\": \"service\",\r\n \"id\": 3\r\n },\r\n \"ref\": \"5dce610bb2cf7418c4002dfb\",\r\n \"indicators\": [\r\n {\r\n \"type\": \"QUALIFICATION\",\r\n \"list\": [\r\n 1\r\n ],\r\n \"label\": \"Qualification\",\r\n \"alarms\": []\r\n }\r\n ]\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"{{api_base_url}}/supervision/views"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": {\n \"message\": \"Resource has been created\",\n \"code\": \"\",\n \"location\": \"http://ctotestvbe/api/v2/supervision/views/3\",\n \"view\": {\n \"id\": \"3\"\n }\n }\n}"},{"id":"7a9dc1bc-2120-40fb-8670-816febdbe0b8","name":"Create a view with a Combined Services configuration","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_supervision}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"type\": \"cumul\",\r\n \"entity\": \"service\",\r\n \"ref\": \"5dce5ae2b2cf7418c4002df9\",\r\n \"entities_ids\": [\r\n 3,\r\n 9\r\n ],\r\n \"indicators\": [\r\n {\r\n \"type\": \"CLWAIT\",\r\n \"label\": \"QueuedCalls\",\r\n \"alarms\": []\r\n }\r\n ]\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"{{api_base_url}}/supervision/views"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": {\n \"message\": \"Resource has been created\",\n \"code\": \"\",\n \"location\": \"http://ctotestvbe/api/v2/supervision/views/3\",\n \"view\": {\n \"id\": \"3\"\n }\n }\n}"},{"id":"9b6d73a8-f7d9-4f09-adf2-759df74c7fe7","name":"Create a view with a Combined Groups configuration","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_supervision}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"type\": \"cumul\",\r\n \"entity\": \"group\",\r\n \"ref\": \"5dcd9616b2cf7427bc0062a5\",\r\n \"entities_ids\": [\r\n 1,\r\n 3\r\n ],\r\n \"indicators\": [\r\n {\r\n \"type\": \"NBAGTLOG\",\r\n \"label\": \"Connected\",\r\n \"alarms\": []\r\n }\r\n ]\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"{{api_base_url}}/supervision/views"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": {\n \"message\": \"Resource has been created\",\n \"code\": \"\",\n \"location\": \"http://ctotestvbe/api/v2/supervision/views/3\",\n \"view\": {\n \"id\": \"3\"\n }\n }\n}"},{"id":"fe969a94-a2d4-417f-ab30-ec335170447d","name":"Create a view with a Curve configuration","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_supervision}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"type\": \"histo\",\r\n \"entity\": \"group\",\r\n \"ref\": \"5dce626bb2cf743a34006065\",\r\n \"range\": 2,\r\n \"step\": \"cumul\",\r\n \"entities_ids\": [\r\n 1\r\n ],\r\n \"indicator\": {\r\n \"type\": \"Backoffice tasks\",\r\n \"label\": \"Sinusoïde\",\r\n \"alarms\": [\r\n {\r\n \"from\": 0,\r\n \"to\": 0,\r\n \"color\": \"#008000\"\r\n },\r\n {\r\n \"greater_than\": 0,\r\n \"color\": \"#FF0000\"\r\n }\r\n ]\r\n }\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"{{api_base_url}}/supervision/views"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": {\n \"message\": \"Resource has been created\",\n \"code\": \"\",\n \"location\": \"http://ctotestvbe/api/v2/supervision/views/3\",\n \"view\": {\n \"id\": \"3\"\n }\n }\n}"},{"id":"6f573ecd-5635-45df-9968-f101c1aff0da","name":"Create a view with a List of Calls configuration","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_supervision}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n\t{\r\n\t\t\"type\": \"detail\",\r\n\t\t\"entity\": \"service\",\r\n\t\t\"ref\": \"5dcd3ee1b2cf743f7000284c\",\r\n\t\t\"filter\": {\r\n\t\t\t\"type\": \"group\",\r\n\t\t\t\"id\": 15\r\n\t\t},\r\n\t\t\"entities_ids\": [\r\n\t\t\t2,\r\n\t\t\t4\r\n\t\t]\r\n\t}\r\n]\r\n","options":{"raw":{"language":"json"}}},"url":"{{api_base_url}}/supervision/views"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": {\n \"message\": \"Resource has been created\",\n \"code\": \"\",\n \"location\": \"http://ctotestvbe/api/v2/supervision/views/3\",\n \"view\": {\n \"id\": \"3\"\n }\n }\n}"},{"id":"a0ccd3bb-e812-4b89-b1fb-6e1fc5e89fc9","name":"Create a supervision view","originalRequest":{"method":"POST","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_supervision}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"type\": \"list\",\r\n \"entity\": {\r\n \"type\": \"team\",\r\n \"id\": 1\r\n },\r\n \"ref\": \"5dce5accb2cf741b34002194\",\r\n \"indicators\": [\r\n {\r\n \"type\": \"NBAGTLOG\",\r\n \"label\": \"Logged\",\r\n \"alarms\": []\r\n }\r\n ]\r\n },\r\n {\r\n \"type\": \"list\",\r\n \"entity\": {\r\n \"type\": \"service\",\r\n \"id\": 3\r\n },\r\n \"ref\": \"5dce610bb2cf7418c4002dfb\",\r\n \"indicators\": [\r\n {\r\n \"type\": \"QUALIFICATION\",\r\n \"list\": [\r\n 1\r\n ],\r\n \"label\": \"Qualification\",\r\n \"alarms\": []\r\n }\r\n ]\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"{{api_base_url}}/supervision/views"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": {\n \"message\": \"Resource has been created\",\n \"code\": \"\",\n \"location\": \"http://ctotestvbe/api/v2/supervision/views/3\",\n \"view\": {\n \"id\": \"3\"\n }\n }\n}"}],"_postman_id":"0415bd27-fd0e-4d2b-b49e-b3783c4bd7a0"},{"name":"Get Supervision View","id":"ce2de58f-f08a-4b4f-be74-ff1b2ae0c33f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Kiamo-Api-Token","value":"{{token_supervision}}","type":"text"}],"url":"{{api_base_url}}/supervision/views/:id","description":"

Retrieve a supervision view

Remark: see the provided example of supervision view retrieved with different configurations.

\n","urlObject":{"path":["supervision","views",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"id":"e5aee635-4637-44f0-a12a-71226211bd32","description":{"content":"

View Id

\n","type":"text/plain"},"type":"any","value":"{{view_id}}","key":"id"}]}},"response":[{"id":"b2a4dfb9-42c3-444f-94af-faaedee87f30","name":"Retrieve a Team / Group / Service configuration view","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_supervision}}"}],"url":{"raw":"{{api_base_url}}/supervision/views/:id","host":["{{api_base_url}}"],"path":["supervision","views",":id"],"variable":[{"key":"id","value":"{{view_id}}","description":"View Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"list\",\n \"ref\": \"5C0935F1D7AE7412F0002CD2\",\n \"entity\": {\n \"type\": \"group\",\n \"id\": \"3\",\n \"name\": \"Customer service\"\n },\n \"indicators\": [\n {\n \"key\": \"NBAGTLOG\",\n \"label\": \"Connected\",\n \"format\": \"number\",\n \"value\": 15\n },\n {\n \"key\": \"NBAGTREADY\",\n \"label\": \"Ready\",\n \"format\": \"number\",\n \"value\": 0\n },\n {\n \"key\": \"NBAGTPAUSE\",\n \"label\": \"Break\",\n \"format\": \"number\",\n \"value\": 1\n },\n {\n \"key\": \"AGTSTATERR\",\n \"label\": \"No.Anomalies\",\n \"format\": \"number\",\n \"value\": 0\n }\n ]\n }\n ]\n}"},{"id":"ebb5f8b1-7cc9-4079-acf9-b728830440ee","name":"Retrieve a List of Calls configuration view","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_supervision}}"}],"url":{"raw":"{{api_base_url}}/supervision/views/:id","host":["{{api_base_url}}"],"path":["supervision","views",":id"],"variable":[{"key":"id","value":"{{view_id}}","description":"View Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"type\": \"interaction\",\n \"entity\": \"service\",\n \"ref\": \"1234\",\n \"interactions\": [\n {\n \"type\": \"call\",\n \"ref\": \"{interaction reference}\",\n \"position\": {\n \"value\": \"…\",\n \"type\": \" number\"\n },\n \"waitduration\": {\n \"value\": \"…\",\n \"type\": \"duration\"\n },\n \"priority\": {\n \"value\": \"…\",\n \"type\": \"number\"\n },\n \"custnumber\": {\n \"value\": \"…\",\n \"type\": \"number\"\n },\n \"callednumber\": {\n \"value\": \"…\",\n \"type\": \"number\"\n },\n \"syscallinfo\": {\n \"value\": \"…\",\n \"type\": \"text\"\n },\n \"service\": {\n \"id\": \"{service ID}\",\n \"name\": \"{service name}\"\n }\n }\n ]\n }\n]"},{"id":"ef58986c-1acb-45f3-bd97-fddb34dcc82d","name":"Retrieve a supervision view","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_supervision}}"}],"url":{"raw":"{{api_base_url}}/supervision/views/:id","host":["{{api_base_url}}"],"path":["supervision","views",":id"],"variable":[{"key":"id","value":"{{view_id}}","description":"View Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"list\",\n \"ref\": \"5C0935F1D7AE7412F0002CD2\",\n \"entity\": {\n \"type\": \"group\",\n \"id\": \"3\",\n \"name\": \"Group 1\"\n },\n \"indicators\": [\n {\n \"key\": \"NBAGTLOG\",\n \"label\": \"Connected\",\n \"format\": \"number\",\n \"value\": 0\n },\n {\n \"key\": \"NBAGTREADY\",\n \"label\": \"Ready\",\n \"format\": \"number\",\n \"value\": 0\n },\n {\n \"key\": \"NBAGTPAUSE\",\n \"label\": \"Break\",\n \"format\": \"number\",\n \"value\": 0\n },\n {\n \"key\": \"AGTSTATERR\",\n \"label\": \"Numb. Anomalies\",\n \"format\": \"number\",\n \"value\": 0\n }\n ]\n },\n {\n \"type\": \"list\",\n \"ref\": \"5C09364CD7AE7412F0002CD3\",\n \"entity\": {\n \"type\": \"service\",\n \"id\": \"3\",\n \"name\": \"Customer service Out emails\"\n },\n \"indicators\": [\n {\n \"key\": \"CLRIGHTNOW\",\n \"label\": \"Calls\",\n \"format\": \"number\",\n \"value\": 0\n },\n {\n \"key\": \"CALLNOTCLOSED\",\n \"label\": \"To process\",\n \"format\": \"number\",\n \"value\": 0\n },\n {\n \"key\": \"FILEPROCESSED\",\n \"label\": \"I.Processed\",\n \"format\": \"number\",\n \"value\": 0\n },\n {\n \"key\": \"COMMAVG\",\n \"label\": \"Avg.Com\",\n \"format\": \"duration\",\n \"value\": 0\n }\n ]\n },\n {\n \"type\": \"list\",\n \"ref\": \"5C093663D7AE741978000F33\",\n \"entity\": {\n \"type\": \"service\",\n \"id\": \"4\",\n \"name\": \"CS Out calls\"\n },\n \"indicators\": [\n {\n \"key\": \"CLRIGHTNOW\",\n \"label\": \"Calls\",\n \"format\": \"number\",\n \"value\": 0\n },\n {\n \"key\": \"CLWAIT\",\n \"label\": \"Queued\",\n \"format\": \"number\",\n \"value\": 0\n },\n {\n \"key\": \"CLRCV_DAY\",\n \"label\": \"Received(d)\",\n \"format\": \"number\",\n \"value\": 0\n },\n {\n \"key\": \"COMMAVG\",\n \"label\": \"Avg.Com(W)\",\n \"format\": \"duration\",\n \"value\": 0\n }\n ]\n },\n {\n \"type\": \"interaction\",\n \"entity\": \"service\",\n \"ref\": \"5C093843D7AE741978000F34\",\n \"interactions\": []\n }\n ]\n}"},{"id":"7b46d4a3-ce45-40a4-9ce8-983dc727e61c","name":"Retrieve a List of Agents configuration view","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_supervision}}"}],"url":{"raw":"{{api_base_url}}/supervision/views/:id","host":["{{api_base_url}}"],"path":["supervision","views",":id"],"variable":[{"key":"id","value":"{{view_id}}","description":"View Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"type\": \"detail\",\r\n \"entity\": \"agent\",\r\n \"ref\": \"#list-agents\",\r\n \"agents\": [\r\n {\r\n \"id\": \"{agent’s ID}\",\r\n \"name\": \"{agent’s name}\",\r\n \"state\": {\r\n \"id\": \"\",\r\n \"type\": \"ready/pause/working/error\",\r\n \"label\": \"Break\",\r\n \"duration\": 8,\r\n \"alarm\": {}\r\n },\r\n \"record\": {\r\n \"state\": \"active/ active-conditioned /manual/unavail/none\"\r\n },\r\n // AVAILABLE IF DURING PROCESSING\r\n \"services\": [\r\n {\r\n \"id\": \"\",\r\n \"name\": \"\"\r\n }\r\n ],\r\n \"indicators\": []\r\n }\r\n ]\r\n }\r\n]"},{"id":"357947f6-ad22-4b4e-9b5e-53621bacadbc","name":"Retrieve a Conbined Group configuration view","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_supervision}}"}],"url":{"raw":"{{api_base_url}}/supervision/views/:id","host":["{{api_base_url}}"],"path":["supervision","views",":id"],"variable":[{"key":"id","value":"{{view_id}}","description":"View Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"cumul\",\n \"entity\": \"group\",\n \"ref\": \"5dcd9616b2cf7427bc0062a5\",\n \"entities\": [\n {\n \"id\": \"1\",\n \"name\": \"Customer service\"\n },\n {\n \"id\": \"9\",\n \"name\": \"Helpdesk group\"\n }\n ],\n \"indicators\": [\n {\n \"key\": \"NBAGTLOG\",\n \"label\": \"Connected\",\n \"format\": \"number\",\n \"value\": 22\n }\n ]\n }\n ]\n}"},{"id":"893b5c5f-b32b-47f5-b148-b7590881a864","name":"Retrieve a Curve configuration view (2-hour period)","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_supervision}}"}],"url":{"raw":"{{api_base_url}}/supervision/views/:id","host":["{{api_base_url}}"],"path":["supervision","views",":id"],"variable":[{"key":"id","value":"{{view_id}}","description":"View Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"type\": \"histo\",\r\n \"entity\": \"group/team/service\",\r\n \"ref\": \"1234\",\r\n \"indicator\": \r\n {\r\n \"key\": \"{indicator key}\",\r\n \"values\": [[0,9]...,[4,5],[5,7],[6,3],[7,9],[8,10],[9,2],..[119,4]] \r\n } \r\n}\r\n"},{"id":"1b0d850b-305d-44e1-a978-716a93ba51da","name":"Retrieve a Combined Services configuration view","originalRequest":{"method":"GET","header":[{"key":"Kiamo-Api-Token","type":"text","value":"{{token_supervision}}"}],"url":{"raw":"{{api_base_url}}/supervision/views/:id","host":["{{api_base_url}}"],"path":["supervision","views",":id"],"variable":[{"key":"id","value":"{{view_id}}","description":"View Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"type\": \"cumul\",\r\n \"entity\": \"service\",\r\n \"ref\": \"5C0935F1D7AE7412F0002CD2\",\r\n \"entities\": [\r\n {\r\n \"id\": \"3\",\r\n \"name\": \"Customer service calls\"\r\n },\r\n {\r\n \"id\": \"9\",\r\n \"name\": \"Helpdesk calls\"\r\n }\r\n ],\r\n \"indicators\": [\r\n {\r\n \"key\": \"CLWAIT\",\r\n \"label\": \"Queued Calls\",\r\n \"format\": \"number\",\r\n \"value\": 4\r\n }\r\n ]\r\n }\r\n ]\r\n}"}],"_postman_id":"ce2de58f-f08a-4b4f-be74-ff1b2ae0c33f"}],"id":"14fa319d-cd0b-48be-bf9e-7889ecb34302","description":"

SUPERVISION API

View

A view always contains a list of blocks. A Block objects is a complex object, which may contain other types of entities (depending on the types of indicators, the alarms defined, the type of display wanted, etc.) as well as many forms (list type, combined type, etc.).

Block object

Block values are described in the different Configurations section (see below).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data Type	Description
type	string	Defines how indicators are calculated: \"list\", \"combined\", \"detail\", \"interaction\" or \"histo\"
entity	string	Defines the type of resource (service, group, etc.) whose indicators are wanted. Values : \"service\", \"group\", \"team\"
entity.id	number	ID of the resource (e.g.: Service ID)
ref	string	(Optional) Block unique reference
indicators	n Objects	Collection of Indicator objects.

Indicator sub-object

Please refer to the Indicators & Alarms section below for more information about the Indicator sub-object.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data Type	Description
type	string	Indicator key.
label	string	(Optional) Indicator label.

Configurations

The different configurations

7 types of configurations are available to retrieve indicators:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Configuration type	Object / Sub-object type	Description of the answers sent by the Supervision API after a GET request
Team / Group / Service	_list_-type Block object	The API returns the indicator values for a single service, a single team or a single group.
Combined services	_cumul_-type Block object	The API returns the added value of each indicator for a list of services.
Combined groups	_cumul_-type Block object	The API returns the added value of each indicator for a list of groups.
List of agents	_detail_-type Block object	The API returns the indicator values for each agent.
List of services	_detail_-type Block object	The API returns the indicator values for each service.
List of calls	_interaction_-type Block object	The API returns the list of queued calls.
Curve	histo-type Block* object	The API returns the 120 last values of a specific indicator over a defined time-frame.

Team / Group / Service

Block configuration enables you to retrieve the values of indicators configured in a view for a specific entity: service, team or group.

See the related POST example for further details.

Combined services

The Combined services configuration is used to retrieve the added values of indicators for a list of services.

Caution: You have to combine services of the same type.

Remark: Inbound calls-type and internal-type services share the same indicators and can be combined.

See the related POST example for further details.

Combined groups

The “Combined groups” configuration is used to retrieve the added values of indicators for a list of groups.

See the related POST example for further details.

List of agents

The “list of agents” configuration is used to retrieve the indicator values for each agent, as configured in the view.

Remark: This section covers the specific elements of the Block object. Please refer to Block object section upper for an overview of this object.

Specific elements of the Block object for a list of agents

POST requests

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data Type	Description
filter.by	string	Is used to define a filter on agents (all the agents of a team or a group, for example). Values: group or team Optional: no filter sub-object = All agents
filter.id	number	Filter ID (Id of group or team).
states	Collection of Alarm objects	Is used to configure an alarm on agents’ statuses. Remark : Please refer to the Alarms section for more information.

GET requests

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data Type	Description
agent.record.state	string	Status of a recording for an agent. Values: active, active-conditioned, manual, or unavail.
agent.state	State sub-object	State sub-object that defines the agent’s status.
agent.services	Collection of Service sub-object	*Service sub-object that defines the services for which the agent is currently handling a task. This sub-object only appears if the agent is currently handling a task.

The State sub-object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data Type	Description
id	number	ID of the agent’s status. Remark: Status IDs are available in the Kiamo main interface, Resources > Groups menu > Agents’ statuses tab.
type	string	Agent’s status. Possible values: ready, pause, working or error.
label	string	Label of the agent’s status.
duration	number	Time spent in the current status.
alarm	string	Color of the alarm configured on the status.

The Service sub-object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data Type	Description
id	number	Service identifier.
name	string	Service name.

Specificities of the filter element

It can have several values:

✓ group: is used to get all the indicators of all the agents belonging to a specific group.

✓ team: is used to get all the indicators of all the agents belonging to a specific team.

For the group and team filters, you can use an additional filter: entities_ids. It can be used to filter the list of agents on one or more groups, or one or more teams.

✓ service: is used to get all the indicators of all the agents associated with a specific group. With this tag, you can use an additional filter: group_id. It is used to filter the list of agents on one of the groups associated with this service, whether this group is the main distribution group or one of the additional groups.

If the group_id is empty, is not in the requested format or contains a group that is not associated with the defined group, the full list of agents associated with this group will be returned.

Example:

[{\n    \"type\": \"detail\",\n    \"entity\": \"agent\",\n    \"ref\": \"5dcd3ebab2cf743f7000284b\",\n    \"filter\": {\n    \"type\": \"service\",\n    \"id\": 5\n    \"group_id\": 8\n    },\n    \"indicators\": [],\n    \"states\": [\n    {\n        \"id\": 4,\n        \"alarms\": []\n     }\n    ]\n]}\n\n

See the related GET example for further details.

List of services

The list of services configuration is used to retrieve the indicator values for each service, as configured in the view.

Caution: The list of services must contain services of the same type.

Remark: Inbound calls-type and internal-type services share the same indicators and can be included in the same list.

See the related POST example for further details.

List of calls

The list of calls configuration is used to retrieve the queued calls for a list of services.

Remark: This section covers the specific elements of the Block object. Please refer to Block object section above for an overview of this object.

Specific elements of the Block object for a list of calls

POST requests

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data Type	Description
filter.by	string	Is used to define a filter on call services (all the services of a group, for example). Value: group Optional: no filter sub-object = All services
filter.id	number	Group identifier.

GET requests

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data Type	Description
interaction	List of Interaction sub-objects	List of tasks available in the service.

The \"Iteraction sub-object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data Type	Description
type	string	Type of interaction. Value: call.
ref	number	Unique reference of the task.
service	Service sub-object	Service sub-object in which the task is included. (see above)
position.value	string	Call position in the queue.
waitduration.value	string	Time spent in the queue.
priority.value	string	Call priority.
custnumber.value	string	Caller’s phone number.
callednumber.value	string	Phone number called.
syscallinfo.value	string	Value contained in the SysCallInfo variable.

As with a list of agents, you can:

✓ Retrieve all the services of a group using the “filter” tag,

✓ Or define a list of IDs using the “entities” tag.

Remark: For this type of list, you do not have to define indicators: they are default indicators that cannot be edited.

See the related GET example for further details.

Curve

This configuration is used to retrieve the last 120 values of an indicator.

Remarks:

You can only define 1 indicator per curve.
\n
Values are updated according to the Last hours displayed parameter defined.
The calculation rule for this update frequency is: (Last hours Number x 60)/ 120
Examples: If you decide to display:
\n
- the last 2 hours, the values will be updated every minute,
  \n
- the last 8 hours, the values will be updated every 4 minutes,
  \n
- the last 10 hours, the values will be updated every 5 minutes.
  \n
\n
This section covers the specific elements of the Block object. Please refer to Block object section above for an overview of this object.
\n

Specific elements of the Block object for a curve

POST requests

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data Type	Description
step	string	Remark: This element is useful only if you want to retrieve the value of a statistical indicator. Two possible values: ✓ cumul: is used to retrieve the indicator value for the day (values added every 15 minutes). Remark: This is the default value. ✓ period: is used to retrieve the indicator value every 15 minutes.
range	string	Is used to define the sliding period (expressed in hours) to capture the indicator values. Possible values: 2, 4, 6, 8 or 10 Remark: The default value is 2. Examples: if you select a 2-hour sliding period, 1 point in the chart represents 1 minute. If you select a 4-hour sliding period, 1 point represents 2 minutes. And so on...

GET requests

No specific elements of the Block object for the GET requests.

See the related GET and POST examples for further details.

INDICATORS & ALARMS

Overview of indicators

Type of indicators

Default indicators

3 types of default indicators are available in Kiamo:

✓ If the name of the indicator starts with “ACTUAL -”, it is a real-time indicator: the values displayed are updated in real-time.

✓ If the name of the indicator starts with “STAT -”, it is a statistical indicator: values are updated regularly, every 15 minutes (as soon as new Kiamo statistics are available).

✓ If the name of the indicator starts with “HISTO -”, it is an historical indicator. This type of indicator is only available for curve-type charts.

Caution: The values you see in the supervision windows only relate to the current day. The same is true of the reports you can access from the supervision windows.

These values are reset every day at midnight.

Custom indicators

To best answer the needs of contact centers, Kiamo enables you to create your own business indicators: custom indicators (e.g.: sales number, sales increase, etc.).

Under the main Kiamo interface, go to the Developer > Custom indicators menu to define these custom indicators.

Once they have been created and put into production, they can be displayed to supervisors and agents.

Please refer to the Kiamo Developer guide for more information on how to define custom indicators.

Indicator format: Time/ Number/ Percentage

Different formats of indicators are available:

✓ Time indicators: it can be a total time or an average time (e.g.: Connection time, Average talk time).

✓ Number indicators (e.g. : Number of received calls, Number of closed emails),

✓ Percentage indicators (e.g.: Percentage of time spent in the Ready status).

Each type of block or list (service, combined services, group…) has its own list of indicators (e.g.: the Average processing time in the script indicator for an IVR-type service) but some indicators are available for several types of blocks (e.g.: Number of calls in progress).

Caution: Group and Team share the same indicators. The same is true for inbound call and internal services.

Elements of the \"Indicator\" object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data Type	Description
type	string	Indicator key. Remark: Please refer to the Kiamo Supervision user documentation to have the list and a detailed description of indicators.
label	string	(Optional) Indicator label.

Syntax

POST request example

{\n  \"type\": \"NBMLOUT\",\n  \"label\": \" AgentOut E.\" \n  \"list\": [3,4], // only if the indicator.(type = QUALIFICATION) is the qualification IDs\n  \"alarms\":[]\n}\n\n

Example of JSON answer to a GET request

{\n    \"key\": \" NBMLOUT \",\n    \"type\": \" stat \",\n    \"label\": \" AgentOut E.\",\n    \" value\": \"0\"\n}\n\n

Special cases of indicators

Qualification indicator

Specific element in the “qualification”-type “indicator” object (POST)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data Type	Description
list	string	List of the identifiers of qualifications. Remark: If the list contains 2 or more elements, the values will be added. Remark: All the qualification identifiers are available in Kiamo, in the Reporting > List of qualifications menu.

Qualification indicator syntax

POST request

For a qualification indicator, you have to indicate the IDs of the indicators whose added values you want to retrieve.

\"indicator\": [ {\n  \"type\": \"QUALIFICATION\", \n  \"list\": [3,4],\n  \"label\": \"Qualification\",\n  \"alarms\":[]\n} ]\n\n

Remark: Answers for qualification indicators and other indicators are identical.

Custom indicators

To request a custom indicator you just have to use the CUSTOM_{id} key.

Remark: Custom indicator identifiers are available in the main Kiamo interface, in the Developer > Custom indicators menu.

Syntax

\"indicator\": {\n    \"type\": \"CUSTOM_1\",\n    \"label\": \"My Custom Indic.\",\n    \"alarms\": [\n        {\n            \"from\": 0,\n            \"to\": 50,\n            \"color\": \"#008000\"\n        },\n        {\n            \"greater_than\": 50,\n            \"color\": \"#FF0000\"\n        }\n    ]\n}\n\n

Remarks:

Calculation starts as soon as the request is sent.
\n
Answers for qualification indicators and other indicators are identical.
\n

Alarms

Configure an alarm

You can configure several alarm thresholds.

Elements of the Alarm sub-object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Data Type	Description
from	string	Less than or equal to.
to	string	Strictly greater than.
color	string	Color of the alarm code (hexadecimal).

Syntax

POST request example

\"indicator\": {\n    \"type\": \"NBAGTLOG\",\n    \"label\": \" Numb.Agts.log.\",\n    \"alarms\": [\n        {\n            \"from\": 0,\n            \"to\": 17,\n            \"color\": \"#125\"\n        },\n        {\n            \"from\": 17,\n            \"to\": 60,\n            \"color\": \"#900002\"\n        },\n        {\n            \"greater_than\": 60,\n            \"color\": \"#900003\"\n        }\n    ]\n}\n\n

Configuring alarms is similar to defining rules. These rules will be ordered using the “from” attribute. The first valid rule will be applied.

Remark: A single “greater_than”-type alarm can be used in each alarm table.

In this example:

✓ If the indicator’s value is 15, the color will be #125,

✓ If the indicator’s value is 50, the color will be #900002,

✓ If the indicator’s value is 80, the color will be #900003.

Special case: Alarm on the \"Agent status” indicator

Configuring alarms on agent statuses is very similar to configuring other alarms, except that these alarms apply to specific statuses. Threshold values are the different time intervals spent in this status (expressed in seconds).

Syntax

POST request example

\"states\": [\n    {\n        \"id\": 1,\n        \"alarms\": [\n            {\n                \"from\": 0,\n                \"to\": 50,\n                \"color\": \"#125001\"\n            },\n            {\n                \"from\": 50,\n                \"to\": 100,\n                \"color\": \"#fff000\"\n            }\n        ]\n    }\n]\n\n

POST request example

{\n    \"from\": \"10\",\n    \"to\": \"20\",\n    \"color\": \"#fff000\"\n}\n\n

LIST OF AVAILABLE INDICATORS

Group & Team

Shared indicators

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Label	Description
NBAGTACTIVE	ACTUAL - Number of active agents	Number of connected agents who may be assigned tasks: ✓ either straight away because they are Ready ✓ either when they go back to the Ready status after being in one of the following system statuses: reserved, talking to a customer, wrap up, mandatory break, task handling, consultation, conference call, or inter nal call; ✓ or when they go back to the Ready status if they are in an available personalized status (with the Available status option enabled).
NBAGTPAUSE	ACTUAL - Number of agents in Break statuses	Number of agents who are in one of the personalized break statuses, in the standard break status and in the Anomaly system status
NBAGTLOG	ACTUAL - Number of logged agents	Number of connected agents, whatever their status.
NBAGTREADY	ACTUAL - Number of ready agents	Number of agents in the Ready status who may be assigned tasks straight away
LOGDUR	STAT - Connection time	Total connection time, whatever the agents’ status: anomaly, standard or specific breaks, standard or specific work status, ready status
AGTSTATERR	STAT - Number of times in Anomaly status	Number of times agents of a group or a team have switched to the Anomaly system status, for one of the following reasons: agent did not answer, wrong phone number, agent’s phone busy, or no available channel to establish communication
ST30RAT	STAT - Percentage of time spent in Anomaly status	Total time spent by the agent(s) of the selected group or the team in the Anomaly status, in relation with the total connection time. Percentage of time spent in Anomaly status = ( Total time in ANOMALY status / Total CONNECTION time ) x 100
ST07RAT	STAT - Percentage of time spent in Call hold status	Total time spent by customer calls on hold, in relation to the total connection time. Percentage of time spent in Call hold status = ( Time spent in the CALL HOLD status / CONNECTION time ) x 100 Caution : A consultation call on hold does not impact this indicator
ST10RAT	STAT - Percentage of time spent in Internal Call status	Time spent by one or more agents of the selected group or team in the Internal call system status, in relation to the total connection time Percentage of time spent in Internal call status = ( Time spent in the INTERNAL CALL status / CONNECTION time ) x 100 Caution : The agent who starts the call will be in the Internal call system status, but the agent called will be in the Consultation system status
ST03RAT	STAT - Percentage of time spent in Talk status	Time spent by one or more agents of the selected group or team in the Talk system status, in relation to the total connection time Percentage of time spent in Talk status = ( Time spent in the TALK status / CONNECTION* time ) x 100
ST09RAT	STAT - Percentage of time spent in Conference call status	Time spent by one or more agents of the selected group or team in the Conference call system status, in relation to the total connection time Percentage of time spent in Conference call status = ( Time spent in the CONFERENCE CALL status / CONNECTION time ) x 100
ST08RAT	STAT - Percentage of time spent in Consultation call status	Time spent by one or more agents of the selected group or team in the Consultation call system status, in relation to the total connection time. Percentage of time spent in Consultation call status = ( Time spent in the CONSULTATION status / CONNECTION time ) x 100
ST21RAT ST22RAT ST23RAT ST24RAT ST25RAT ST26RAT ST27RAT ST28RAT ST29RAT	STAT - Percentage of time spent in Specific Break status 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9	You may have defined, for the group, personalized break statuses ( e.g.: Lunch break). In this case, you have an indicator that will give you the time spent in each of these specific statuses, in relation to the total connection time. Percentage of time spent in Specific Break N status = ( Time spent in SPECIFIC BREAK N status / CONNECTION time ) x 100
ST11RAT ST12RAT ST13RAT ST14RAT ST15RAT ST16RAT ST17RAT ST18RAT ST19RAT	STAT - Percentage of time spent in Specific Work status 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9	You may have defined, for the group, personalized work statuses ( e.g.: Meeting). In this case, you have an indicator that will give you the time spent in each of these specific statuses, in relation to the total connection time. Percentage of time spent in Specific Work Nstatus* = ( Time spent in SPECIFIC WORK N status / CONNECTION time ) x 100
ST20RAT	STAT - Percentage of time spent in Break status	Time spent by one or more agents of the selected group or team in the Standard break system status, in relation to the total connection time. Percentage of time spent in Standard Break status = ( Time spent in the STANDARD BREAK status / CONNECTION time ) x 100 Caution : This indicator only takes into account the time spent in the Standard break status, not the specific break statuses that may have been defined for a group.
ST05RAT	STAT - Percentage of time spent in Mandatory Break status	Time spent by one or more agents of the selected group or team in the Mandatory break system status, in relation to the total connection time. Percentage of time spent in Mandatory Break status = ( Time spent in the MANDATORY BREAK status / CONNECTION time ) x 100 Caution : This indicator only takes into account the time spent in the Mandatory break status, not the specific break statuses that may have been defined for a group.
ST04RAT	STAT - Percentage of time spent in Wrap up status	Time spent by one or more agents of the selected group or team in the Wrap up system status, in relation to the total connection time. Percentage of time spent in Wrap up status = ( Time spent in the WRAP-UP status / CONNECTION time ) x 100
RATSTREADY	STAT - Percentage of time spent in Ready status	Time spent by one or more agents of the selected group or team in the Ready system status, in relation to the total connection time. Percentage of time spent in Ready status = ( Time spent in the READY status / CONNECTION time ) x 100
ST06RAT	STAT - Percentage of time spent in Task handling status	Time spent by one or more agents of the selected group or team in the Task handling system status, in relation to the total connection time. Percentage of time spent in Task handling status = ( Time spent in the TASK HANDLING status / CONNECTION time ) x 100
RATSTPAUSE	STAT - Percentage of time spent in Break statuses	To calculate this indicator, are taken into account the time spent by one or more agents of the selected group or team in the standard break status and in the personalized break statuses that may have been defined for the group (see: Percentage of time spent in specific break status). Percentage of time spent in Break status = ( Time spent in the BREAK statuses / CONNECTION time ) x 100
RATSTWORKING	STAT - Percentage of time spent in Work statuses	To calculate this indicator, are taken into account the time spent in the standard work status (that is to say the time spent in another status than: ready, standard break, specific break(s) and anomaly), but also the time spent in the personalized work statuses that may have been defined for the selected group (see: Percentage of time spent in Specific Work status).__Percentage of time spent in Work statuses* = ( Time spent in the WORK statuses / CONNECTION* time ) x 100
CLRIGHTNOW	ACTUAL - Number of calls in progress	Number of agents, of a group or a team, who are currently talking to customers. Remark: Calls put on hold by agents, after talking to the customer, are included in this total. Caution: Calls made while working on an email, a Messaging-type interaction or a custom task are not included in this total. This type of call is counted in the Number of calls in progress in an email service, Number of calls in progress in a message service or Number of calls in progress in a custom task service
WUPAVG	STAT - Average time in Wrap-up status	Average time spent by agents of the selected group or team in the Wrap-up system status. Average wrap-up time = Total of all WRAP-UP time / Number of ANSWERED calls
COMMAVG	STAT - Average talk time	Average agent/customer talk time, for the agents of the selected group or team. Average talk time = Total of all TALK time / Number of PHONE CALLS
ANSRAVG	STAT - Average agent ringing time for handled calls	Average ringing time on agents’ phones for all answered calls. Average agent ringing time for handled calls = Total of all ringing time of HANDLED calls / Number of HANDLED calls
SVCCLABD	STAT - Number of calls abandoned while ringing	Number of calls hung up by customers while agents’ phones were ringing
CONSDONE	STAT - Number of consultation calls made	Number of consultations calls made by agent(s), as opposed to the Number of consultations calls received indicator
CONSRCV	STAT - Number of consultation calls received	Number of consultations calls received by agent(s), as opposed to the previous Number of consultations calls made indicator
SVCCLREF	STAT - Number of rejected calls	Number of calls that have been rejected by the agents of the selected group or team
MANCLCANC	STAT - Number of cancelled outbound calls	Number of calls abandoned by the agents of the selected group or team before being put through to customers
MANCLFAIL	STAT - Number of failed outbound call attempts	Number of outbound call attempts that did not result in the agent talking to the customer, but that were not cancelled by the agent
MANCLDONE	STAT - Number of successful outbound calls	Number of successful outbound calls, that is to say the number of calls that ended with the agents talking to customers
SVCCLANS	STAT - Number of handled calls	Total of all the calls processed by the agents of the selected group or team: it includes the different types of calls, that is to say inbound, outbound or agent out calls. Caution: All calls made while working on a task (email, Messaging type interaction, custo m task or chat session are not included in this total , whether agents used the service to which belongs the task or an agent out call service.
APPUTILES	STAT - Number of useful calls	Number of calls which lasted more than the Threshold for relevance of customer communications parameter that can be defined in the Media > Voice/Video menu, Statistics tab of the service
CONFDONE	STAT - Number of conference calls made	Number of conference calls started by the agents of the selected group or team
MANCLTRY	STAT - Number of outbound call attempts	Addition of successful outbound calls, cancelled outbound calls and failed outbound calls. Number of outbound call attempts = Number of SUCCESSFUL outbound calls + Number of CANCELLED outbound calls + Number of FAILED outbound calls
TRSFAGTDONE	STAT - Number of transfers to an agent made	Number of calls transferred by means of a consultation
TRSFAGTRCV	STAT - Number of transfers to an agent received	Number of transferred calls received by means of a consultation
TRSFNUMDONE	STAT - Number of transfers to phone number made	Number of calls transferred using the Transfer to a number option
TRSFSVCDONE	STAT - Number of transfers to a service made	Number of calls transferred using the Transfer to a service option
AGTWORKMLAVG	STAT - Average work time (emails)	Total time spent working on offered emails, divided by the number of emails offered to the agents of the selected group or team. Average work time = Total time spent WORKING on offered emails / Number of OFFERED emails Caution : All calls made while working on emails using the service to which belong these emails are included in the total email work time
MLCLRIGHTNOW	ACTUAL - Number of calls in progress in an email service	Number of on-going phone calls made by the agents of the selected group or team while working on emails
MLRIGHTNOW	ACTUAL - Number of emails being processed	Number of emails being offered to the agents of the selected group or team, whether it is inbound emails or emails to validate
NBAGTMLREPR	STAT - Number of postponed emails	Caution: This indicator includes all postponed emails from inbound email services and email validation services It is the number of emails that have been postponed by the agents of the selected group or team because: ✓ The agent has used the postponement function, ✓ The agent has used the transfer function, ✓ The email window has been closed using another means, ✓ The email window remained open more than 2 hours
NBAGTMLCLOSED	STAT - Number of closed emails	Number of emails that have been closed by the agents of the selected group or team
NBAGTMLSENT	STAT - Number of sent emails	Number of emails sent by the agents of the selected group or team. Remark: It include s transferred emails.
NBAGTMLSUBM	STAT - Number of offered emails	This indicator includes all the emails closed, postponed and validated by the agents of the selected group or team. Number of offered emails = Number of CLOSED emails + Number of POSTPONED emails + Number of VALIDATED emails
NBAGTMLWITHOUTANS	STAT - Number of emails without answer	Number of offered emails, which resulted in no answer being given to the customer.
NBMLOUT STAT	Number of Agent out emails	Number of agent out emails sent by the agents of the selected group or team
NBAGTMLTRANS	STAT - Number of emails transferred to a service	Number of inbound emails offered to the agents of the selected group or team, which resulted in a transfer of the email to another Kiamo service . Caution: Outbound emails with a Kiamo service as recipient are considered as transferred.
NBAGTMLVALIDATED	STAT - Number of validated emails	Number of emails that have been validated by the agents of the selected group or team
MGCLRIGHTNOW	ACTUAL - Number of calls in progress	Number of calls in progress, made by the agents of the selected group or team while working on Messaging type interactions. Remark: A Messaging type interaction is a message thread sent by the same contact and containing the answers sent via the Kiwi application by one or more agents. Whatever the type of message sent by the contact, all his/her messages will be grouped together in th e same interaction if the contact has been identified in Kiamo (for instance, by using his/her Facebook ID, Twitter ID, LinkedIn ID, phone number, etc.). If the contact has not been identified in Kiamo, an interaction per message type will be displayed for this contact (e.g.: an interaction for text messages, an interaction for Facebook type messages).
MGRIGHTNOW	ACTUAL - Number of interactions being processed	Number of Messaging-type interactions being offered to the agents of the selected group or team in order to be processed.
WORKMGAVG	STAT - Average work time	Total time spent by the agents of the selected group or team working on the Messaging type interactions offered to them, divided by the number of interactions offered. Average work time = Total time spent WORKING on offered interactions / Number of OFFERED interactions Caution: All calls made while working on Messaging type interactions using the service to which belong these interactions are included in this total.
MGOUTCLDONE	STAT - Number of outbound calls	Number of outbound calls made by the agents of the selected group or the team using the service to which belong these interactions, while working on Messaging type interactions. Remark: Outbound calls made using an agent out call service are not included in this total.
NBMGSENT	STAT - Number of sent messages	Number of messages offered to the agents of the selected group or team which resulted in a message being sent as answer. Remark: This total includes transferred messages.
NBMGREPR	STAT - Number of postponed interactions	Number of Messaging-type interactions offered to the agents of the selected group or team that have been postponed because: ✓ The agent used the postponement function, ✓ The interaction remained open more than 2 hours. Remark: Postponed Messaging-type interactions are not closed.
NBMGSUBMIT	STAT - Number of interactions offered	Number of Messaging-type interactions offered to the agents of the selected group or team, whatever the work result: closing or postponement. Number of interactions offered = Number of HANDLED interactions + Number of POSTPONED interactions
NBMGCLOSED	STAT - Number of handled interactions	Number of Messaging-type interactions that have been handled and closed by the agents of the selected group or team.
RNBCHATAGENTDISC	ACTUAL - Number of agent logouts	Number of Chat sessions closed by the agents of the selected group or team
RNBCHATCUSTDISC	ACTUAL - Number of customer logouts	Number of Chat sessions of the selected service closed by customers
RNBCHATHANDLED	ACTUAL - Number of Chat sessions handled	Number of Chat sessions offered to the agents of the selected group or team, handled and closed
TOTALCHATDUR	STAT - Total time working on Chat	Total time spent by the agents of the selected group or team in the Task handling system status for Chat services
NBCHATAGENTDISC	STAT - Number of agent logouts	Number of Chat sessions closed by the agents of the selected group or team
NBCHATCUSTDISC	STAT - Number of customer logouts	Number of Chat sessions of the selected service closed by customers
NBCHATHANDLED	STAT - Number of Chat sessions handled	Number of Chat sessions offered to the agents of the selected group or team, handled and closed
MAXCHATSESSDUR	STAT - Maximum Chat session time	It is the longest Chat session, among all the Chat sessions handled and closed by the agents of the selected group or team
MINCHATSESSDUR	STAT - Minimum Chat session time	It is the shortest Chat session, among all the Chat sessions handled and closed by the agents of the selected group or team
MOYCHATSESSDUR	STAT - Average Chat session time	Total time spent by the agents of the selected group or team handling Chat sessions, divided by the number of Chat sessions handled. Average work time = Total time spent WORKING on handled Chat sessions / Number of HANDLED Chat sessions
TOTALCHATSESSDUR	STAT - Total Chat time	Total time spent handling the Chat sessions offered and closed. Remark: This total may be greater than the Total time working on Chat sessions indicator depending on the start and end of each Chat session.
TASKCALLRIGHTNOW	ACTUAL - Number of calls in progress in a Custom service	Number of on-going phone calls made by the agents of the selected group or team while working on custom tasks
CURRENTFILES	ACTUAL - Number of tasks being processed	Number of custom tasks being offered to and processed by the agents of the selected group or team.
AGTWORKFILEAVG	STAT - Average work time Custom media	Total time spent by the agents of the selected group or team working on closed and postponed custom tasks, divided by the number of processed custom tasks Caution: Calls made using an agent out call service are not included in this work time Average work time = ( Total time spent WORKING on CLOSED tasks + Total time spent WORKING on POSTPONED tasks ) / Number of PROCESSED tasks
AGTNBFILESDELAYED	STAT - Number of postponed tasks	Number of custom tasks that have been postponed because: ✓ The agent has used the postponement function, ✓ The agent rejected the task, provided that the Preview mode has been enabled (in the Agent tab of the service), ✓ The task remained open more than 2 hours.
NBFILECLOSED	STAT - Number of closed tasks	Number of custom tasks processed by the agents of the selected group or team and closed with the result: Handled task.
AGTNBFILESOFFERED	STAT - Number of offered tasks	Number of custom tasks offered to the agents of the selected group or team, whatever the work result, closure or postponement. Number of offered tasks = Number of CLOSED tasks + Number of POSTPONED tasks
HISTO-ARGCALL	HISTO - Number of completed contacts	Number of successful outbound calls that have been given a qualification with the Completed contact performance indicator enabled, by the agents of the selected group or team, during the time slot defined. Caution: This type of indicator is only used with curve type charts.
HISTO-POSARGCALL	HISTO - Number of positive contacts	Number of successful outbound calls that have been given a qualification with the Positive contact performance indicator enabled, by the agents of the selected group or team, during the time slot defined. Caution: This type of indicator is only used with curve type charts.
REELCONTACTARG	ACTUAL - Number of completed contacts (daily total)	Number of successful outbound calls that have been given a qualification with the Completed contact performance indicator enabled, by the agents of the selected group or team
CALASTHOUR	ACTUAL - Number of completed contacts last hour	Number of successful outbound calls that have been given a qualification with the Completed contact performance indicator enabled, in the last 60 minutes, by the agents of the selected group or team
REELCONTACTPOS	ACTUAL - Number of positive contacts (daily total)	Number of successful outbound calls that have been given a qualification with the Positive contact performance indicator enabled, by the agents of the selected group or team
CPLASTHOUR	ACTUAL - Number of positive contacts last hour	Number of successful outbound calls that have been given a qualification with the Positive contact performance indicator enabled, in the last 60 minutes, by the agents of the selected group or team
REELPOSVSARG	ACTUAL - Percentage of positive contacts out of completed contacts (daily total)	Number of successful outbound calls that have been given a qualification with the Positive contact performance indicator enabled, divided by the number of successful out bound calls that have been given a qualification with the Completed contact performance indicator enabled. Percentage of positive contacts out of completed contacts = ( Number of POSITIVE CONTACT outbound calls / Number of COMPLETED CONTACT outbound calls ) x 100
REELRATCONTACTARG	ACTUAL - Percentage of completed contacts (daily total)	Percentage of successful outbound calls that have been given a qualification with the Completed contact performance indicator enabled, by the agents of the se lected group or team. Percentage of completed contacts = ( Number of COMPLETED CONTACT outbound calls / Number of SUCCESSFUL outbound calls ) x 100
REELRATCONTACTPOS	ACTUAL - Percentage of positive contacts (daily total)	Percentage of successful outbound calls that have been given a qualification with the Positive contact performance indicator enabled, by the agents of the selected group or team. Percentage of positive contacts = ( Number of POSITIVE CONTACT outbound calls / Number of SUCCESSFUL outbound calls ) x 100
MOYCOMARG	STAT - Average talk time for completed contacts	Average talk time for all the outbound calls have been given a qualification with the Completed contact performance indicator enabled. Average talk time for completed contacts = Total of all the COMPLETED CONTACT talk time / Number of SUCCESSFUL COMPLETED CONTACT OUTBOUND calls
MOYCOMPOS	STAT - Average talk time for positive contacts	Average talk time for all the outbound calls have been given a qualification with the Positive contact performance indicator enabled. Average talk time for positive contacts = Total of all the POSITIVE CONTACT talk time / Number of SUCCESSFUL POSITIVE CONTACT OUTBOUND calls
MOYWRAPUPARG	STAT - Average wrap-up time for completed contacts	Average time spent by agents in the Wrap-up system status, for all the outbound calls that have been given a qualification with the Completed contact performance indicator enabled. Average wrap-up time for completed contacts = Total of all WRAP-UP time / Number of SUCCESSFUL COMPLETED CONTACT OUTBOUND calls
MOYWRAPUPPOS	STAT - Average wrap-up time for positive contacts	Average time spent by agents in the Wrap-up system status, for all the outbound calls that have been given a qualification with the Positive contact performance indicator enabled. Average wrap-up time for positive contacts = Total of all WRAP-UP time / Number of SUCCESSFUL POSITIVE CONTACT OUTBOUND calls
MOYTRAVARG	STAT - Average work time for completed contacts	Addition of the Average talk time and the Average wrap-up time, for all the outbound calls that have been given a qualification with the Completed contact performance indicator enabled. Average work time = Average COMPLETED CONTACT TALK time + Average WRAP-UP time
MOYTRAVPOS	STAT - Average work time for positive contacts	Addition of the Average talk time and the Average wrap-up time, for all the outbound calls that have been given a qualification with the Positive contact performance indicator enabled. Average work time = Average POSITIVE CONTACT TALK time + Average WRAP-UP time
QUALIFICATION	STAT - Number of qualifications	Number of times the main and/or automatic type qualification(s) selected in the supervision block have been given.

Group specific indicators

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Label	Description
WAITMAX	ACTUAL - Maximum wait time (calls)	In an inbound call service, it is the longest wait time of a call among all the calls currently in the queue.
WAITAVG	ACTUAL - Average wait time calls	This average wait time is the total time spent by queued calls waiting in the service queue, divided by the number of queued calls. Average net wait time = Sum of all wait time of QUEUED calls / Number of QUEUED calls
CLWAIT	ACTUAL - Number of queued calls	Number of calls currently in the queue. Remark: This total includes all the calls for which agents’ phones are ringing.
MLRTWAITMAXBRUT	ACTUAL - Maximum gross wait time (emails)	Longest gross time spent waiting by an inbound email, among all the time spent waiting by inbound emails to process. The gross wait time is the time spent by the task waiting in the service, whatever the distribution mode defined for the service ( automatic, manual, mixed or no distribution) and whatever the status of the schedule associated with the service (open or closed).
MLNOTCLOSED	ACTUAL - Number of emails to process	Number of emails to process whether or not they are in the “task queue”. It includes emails from inbound email services and validation services.
MLWAIT	ACTUAL - Number of queued emails	Remark: This indicator includes emails from inbound email services and validation services Number of emails that are in the service queue. Emails are included in the “queue” when the service is started in automatic or mixed mode, and: ✓ If a schedule is associated with the selected service, during the opening hours of the schedule; ✓ If no schedule is associated with the service, they will always be included in the service queue. Caution: This indicator is not completed if the distribution mode defined for the service is: manual.
MGRTWAITMAXBRUT	ACTUAL - Maximum gross wait time (Messaging)	Longest gross time spent waiting by a Messaging-type interaction, among all the time spent waiting by Messaging-type interactions to process. Remark: The gross wait time is the time spent by the task waiting in the service, whatever the distribution mode defined for the service (automatic, manual, mixed or no distribution) and whatever the status of the schedule associated with the service (open or closed).
MGNOTCLOSED	ACTUAL - Number of interactions to process	Number of Messaging-type interactions to process whether or not they are in the “task queue”.
MGWAIT	ACTUAL - Number of queued interactions	Number of Messaging-type interactions that are in the service queue. Messaging type interactions are included in the “queue” when the service is started in automatic or mixed mode, and: ✓ If a schedule is associated with the selected service, during the opening hours of the schedule; ✓ If no schedule is associat ed with the service, they will always be included in the service queue. Caution: This indicator is not completed if the distribution mode defined for the service is: manual. Remark: Interactions with a processing date scheduled in the past are included in the service queue whereas interactions with a processing date scheduled in the future are not. These are counted in this total as soon as the processing date and time are reached.
FILERTWAITMAXBRUT	ACTUAL - Maximum gross wait time (Custom media)	Longest gross time spent waiting by a custom task, among all the time spent waiting by custom tasks to process. Remark: The gross wait time is the time spent by the task waiting in the service, whatever the distribution mode defined for the service (automatic, manual, mixed or no distribution) and whatever the status of the schedule associated with the service (open or closed)
TASKNOTCLOSED	ACTUAL - Number of tasks to process	Number of custom tasks to process, whether or not they are in the task queue
TASKWAIT	ACTUAL - Number of queued tasks	Number of custom tasks that are in the task queue. Custom tasks are included in the “queue” when the service is started in automatic or mixed mode, and: ✓ If a schedule is associated with the selected service, during the opening hours of the schedule; ✓ If no schedule is associated with the service, they will always be included in the service queue. Caution: This indicator is not completed if the di stribution mode defined for the service is: manual. Remark: Custom tasks with a processing date scheduled in the past are included in the service queue whereas Custom tasks with a processing date scheduled in the future are not. These are counted in this total as soon as the processing date and time are reached.

Agent

Key	Label	Description
SVCCLANS	STAT - Number of handled calls	Number of calls handled by the agent, including inbound, outbound or agent out calls. Remark: Calls made while on a task (email, Messaging-type interaction, custom task or chat session) using the service to which belongs this task are not included in this total.
STPAUSE	STAT - Total time in break statuses	Time spent by the agent in personalized break statuses (see: Time in specific Break status), in the standard break status and in the Anomaly system status
STWORKING	STAT - Total time in work statuses	Time spent by the agent in personalized work statuses (see: Time in specific Work status) and in the standard work status (that is to say statuses other than: ready, standard break, specific break(s) and anomaly.
ST30DUR	STAT - Total time in Anomaly status	Time spent by the agent in the Anomaly system status, for one of the following reasons: no answer, wrong phone number, agent’s phone busy or no available channel to establish communication
ST07DUR	STAT - Total time in Call hold status	Total time the agent has put a customer’s call on hold. Caution: A consultation call on hold does not impact this indicator.
ST10DUR	STAT - Time in Internal Call status	Time spent by the agent in the Internal call system status Caution: The agent who receives the internal call will be in the Consultation system status
ST03DUR	STAT - Time in Talking status	Time spent by the agent talking to a customer
ST09DUR	STAT - Time in Conference status	Time spent by the agent in the Conference call system status Caution: Contrary to the Number of conference calls made indicator that is incremented for the agent who started the conference call, the Time spent in Conference call status is added to the agent who received the consultation call and then was put in a conference call.
ST08DUR	STAT - Time in Consultation status	Time spent by the agent in the Consultation call system status Caution: It is the agent who receives the consultation call who sees his time in Consultation status increase; not the agent who starts the consultation call.
ST21DUR ST22DUR ST23DUR ST24DUR ST25DUR ST26DUR ST27DUR ST28DUR ST29DUR	STAT - Time in Specific Break status (1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9)	You may have defined, for the group to which belongs the agent, personalized break statuses. In this case, an indicator giving you the time spent by the agent in each of these specific statuses is available
ST11DUR ST12DUR ST13DUR ST14DUR ST15DUR ST16DUR ST17DUR ST18DUR ST19DUR	STAT - Time in Specific Work status (1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9)	You may have defined, for the group to which belongs the agent, personalized work statuses (Ex: Meeting). In this case, an indicator giving you the time spent by the agent in each of these specific statuses is available.
ST20DUR	STAT - Time in Break status	Time spent by the agent in the standard break system status.
ST05DUR	STAT - Time in Mandatory Break status	Time spent by the agent in the mandatory break system status.
ST04DUR	STAT - Time in Wrap-up status	Time spent by the agent in the Wrap-up system status.
STREADY	STAT - Time in Ready status	Total time spent by the agent in the Ready system status.
ST02DUR	STAT - Time in Reserved status	Total time spent by the agent in the Reserved system status. The agent is reserved by Kiamo: ✓ when an inbound or outbound call is offered to him (including when he is making an agent out call); ✓ or when a custom task is offered to him (provided that the Preview option has been enabled for the service).
ST06DUR	STAT - Time in Task handling status	Time spent by the agent in the Task handling system status
LOGDUR	STAT - Connection time	Total connection time, whatever the agent’s status: anomaly, standard or specific breaks, standard or specific work status, ready status.
AGTSTATERR	STAT - Number of times in Anomaly status	Number of times the agent’s status changed to Anomaly for one of the following reasons: agent did not answer, wrong phone number, agent’s phone busy, or no available channel to establish communication. Number of times in Anomaly = Number of times in “_NO ANSWER” error + Number of times in “WRONG NUMBER” error* + Number of times in “*LINE BUSY” error* + Number of times in \"*NO AVAILABLE CHANNEL_” error
AGTERRWRG	STAT - Number of time in “wrong number” error	Number of failed calls because the agent’s phone number was wrong.
AGTERRNOCH	STAT - Number of times in “no available channel” error	Number of failed calls because no phone channel was available to establish communication between the agent and the customer.
AGTERRNOANS	STAT - Number of times in “no answer” error	Number of times the agent did not answer while his phone was ringing.
AGTERRBUSY	STAT - Number of times in “line busy” error	Number of failed calls because the agent’s phone was busy.
RATSTREADY	STAT - Percentage of time spent in Ready status	Time spent by the agent in the Ready system status, in relation to the total connection time. Percentage of time spent in Ready status = ( Time spent in the READY status / CONNECTION time ) x 100
RATSTPAUSE	STAT - Percentage of time spent in Break statuses	To calculate this indicator, are taken into account the time spent by the agent in the standard break status and in the personalized break statuses that may have been defined for the group (see: Percentage of time spent in specific break status). Percentage of time spent in Break status = ( Time spent in the BREAK status / CONNECTION time ) x 100
RATSTWORKING	STAT - Percentage of time spent in Work statuses	To calculate this indicator, are taken into account the time spent in the standard work status (that is to say the time spent in another status than: ready, standard break, specific break(s) and anomaly), but also the time spent in the personalized work statuses that may have been defined for the selected group (see: Percentage of time spent in Specific Work status). Percentage of time spent in Work statuses = ( Time spent in the WORK statuses / CONNECTION time ) x 100
NBCALLSWAIT	ACTUAL - Number of queued calls	Number of queued calls for which the agent has been assigned as required agent or preferred agent. Remark: A required agent may be assigned: ✓ when calls go through an IVR script, ✓ or when tasks are imported into an outbound call campaign. Remark: Preferred agents are required agents who have become preferred agents while the call was in the service queue.
WUPAVG	STAT - Average time in Wrap-up status	Time spent by the agent in the Wrap-up system status. Average wrap-up time = Total of all WRAP-UP time / Number of HANDLED calls
COMMAVG	STAT - Average talk time	Average agent/customer talk time. Average talk time = Total of all TALK time / Number of HANDLED calls
ANSRAVG	STAT - Average agent ringing time for handled calls	Average ringing time on the agent’s phones for all answered calls. Average agent ringing time for handled calls = Total of all ringing time of HANDLED calls / Number of HANDLED calls
SVCCLABD	STAT - Number of calls abandoned while ringing	Number of calls hung up by customers while the agent’s phones were ringing.
CONSDONE	STAT - Number of consultation calls made	Number of consultations calls made by the agent, as opposed to the Number of consultations calls received indicator.
CONSRCV	STAT - Number of consultation calls received	Number of consultations calls received by the agent, as opposed to the previous Number of consultations calls made indicator
SVCCLREF	STAT - Number of rejected calls	Number of calls that have been rejected by the agent.
MANCLCANC	STAT - Number of cancelled outbound calls	Number of outbound calls abandoned by the agent before being put through to customers.
MANCLFAIL	STAT - Number of failed (FLD) outbound call attempts	Number of outbound call attempts that did not result in the agent talking to the customer, but that were not cancelled by the agent.
MANCLDONE	STAT - Number of successful outbound calls	Number of successful outbound calls, that is to say the number of calls that ended with the agent talking to customers.
APPUTILES	STAT - Number of useful calls	Number of calls which lasted more than the Threshold for relevance of customer communications setting that can be defined in the Media > Voice/Video menu, Statistics tab of the service.
CONFDONE	STAT - Number of conference calls made	Number of conference calls started by the agent.
MANCLTRY	STAT - Number of outbound call attempts	Addition of successful outbound calls, cancelled outbound calls and failed outbound calls. Number of outbound call attempts = Number of SUCCESSFUL outbound calls + Number of CANCELLED outbound calls + Number of FAILED outbound calls
TRSFAGTDONE	STAT - Number of transfers to an agent made	Number of calls transferred by means of a consultation.
TRSFAGTRCV	STAT - Number of transfers to an agent received	Number of transferred calls received by means of a consultation.
TRSFNUMDONE	STAT - Number of transfers to phone number made	Number of calls transferred using the Transfer to a number option.
TRSFSVCDONE	STAT - Number of transfers to a service made	Number of calls transferred using the Transfer to a service option.
AGTWORKMLAVG	STAT - Average work time (emails)	Total time spent working on offered emails, divided by the number of emails offered to the agents of the selected group or team. Average work time = Total time spent WORKING on offered emails / Number of OFFERED emails Caution: All calls made while working on emails using the service to which belong these emails are included in this work time.
NBAGTMLREPR	STAT - Number of postponed emails	This indicator includes all postponed emails from inbound email services and email validation services. Number of emails that have been postponed by the agents of the selected group or team because: ✓ The agent has used the postponement function, ✓ The email has been forwarded using the Send or Action button available in the email template used, ✓ The email window has been closed using another means, ✓ The email window remained open more than 2 hours.
NBAGTMLCLOSED	STAT - Number of closed emails	Number of emails that have been closed by the agent.
NBAGTMLSENT	STAT - Number of sent emails	Number of emails sent by the agent. Remark: It includes transferred emails.
NBAGTMLSUBM	STAT - Number of offered emails	This indicator includes all the emails closed, postponed and validated by the agents of the selected group or team. Number of offered emails = Number of CLOSED emails + Number of POSTPONED emails + Number of VALIDATED emails
NBAGTMLWITHOUTANS	STAT - Number of emails without answer	Number of emails offered to the agent, which resulted in no answer being given to the customer.
NBAGTMLTRANS	STAT - Number of emails transferred to a service	Number of inbound emails offered to the agent, which resulted in a transfer of the email to another Kiamo service.
NBAGTMLVALIDATED	STAT - Number of validated emails	Number of emails that have been validated by the agent.
AGTWORKMGAVG	STAT - Average work time messaging	Total time spent by the agent working on Messaging-type interactions, divided by the number of Messaging-type interactions offered to the agent. Average work time = Total WORK time / Number of OFFERED interactions Caution: All calls made while working on interactions using the service to which belong these interactions are included in this work time. Remark: A Messaging-type interaction is a message thread sent by the same contact and containing the answers sent via the Kiwi application by one or more agents. Whatever the type of message sent by the contact, all his/her messages will be grouped together in the same interaction if the contact has been identified in Kiamo (for instance, by using his/her Facebook ID, Twitter ID, LinkedIn ID, phone number, etc.). If the contact has not been identified in Kiamo, an interaction per message type will be displayed for this contact (e.g.: an interaction for text messages, an interaction for Facebook type messages).
MGOUTCLDONE	STAT - Number of outbound calls	Number of outbound calls made by the agent using the service to which belong these interactions, while working on Messaging type interactions. Remark: Outbound calls made using an agent out call service are not included in this total.
NBAGTMGSENT	STAT - Number of sent messages	Number of messages offered to the agent which resulted in a message being sent by the agent as answer. Remark: This total includes transferred interactions.
NBAGTMGREPR	STAT - Number of postponed interactions	Number of Messaging-type interactions offered to the agent that have been postponed because: ✓ The agent used the postponement function, ✓ The interaction remained open more than 2 hours. Remark: Postponed Messaging-type interactions are not closed.
NBAGTMGSUBM	STAT - Number of interactions offered	Number of Messaging-type interactions offered to the agent, whatever the work result: closing or postponement. Number of interactions offered = Number of HANDLED interactions + Number of POSTPONED interactions
NBAGTMGCLOSED	STAT - Number of handled interactions	Number of Messaging-type interactions that have been handled and closed by the agent.
RNBCHATAGENTDISC	ACTUAL - Number of agent logouts	Number of Chat sessions closed by the agent.
RNBCHATCUSTDISC	ACTUAL - Number of customer logouts	Number of Chat sessions handled by the agent that have been closed by customers.
RNBCHATHANDLED	ACTUAL - Number of Chat sessions handled	Number of Chat sessions offered to the agent, handled and closed.
TOTALCHATDUR	STAT - Total time working on Chat	Total time spent by the agent in the Task handling system status for Chat services.
NBCHATAGENTDISC	STAT - Number of agent logouts	Number of Chat sessions closed by the agent.
NBCHATCUSTDISC	STAT - Number of customer logouts	Number of Chat sessions handled by the agent that have been closed by customers.
NBCHATHANDLED	STAT - Number of Chat sessions handled	Number of Chat sessions offered to the agent, handled and closed.
MAXCHATSESSDUR	STAT - Maximum Chat session time	Longest Chat session, among all the Chat sessions handled and closed by the agent.
MINCHATSESSDUR	STAT - Minimum Chat session time	Shortest Chat session, among all the Chat sessions handled and closed by the agent.
MOYCHATSESSDUR	STAT - Average Chat session time	Total time spent by the agent handling Chat sessions, divided by the number of Chat sessions he handled. Average work time = Total time spent WORKING on handled Chat sessions / Number of HANDLED Chat sessions
TOTALCHATSESSDUR	STAT - Total Chat time	Total time spent by the agent handling the Chat sessions offered and closed. Remark: This total may be greater than the Total time working on Chat sessions indicator depending on the start and end of each Chat session.
AGTWORKFILEAVG	STAT - Average work time custom task	Total time spent by the agent working on closed and postponed custom tasks, divided by the number of custom tasks handled by the agent. Caution: Calls made by the agent while working on a custom task are included in this total only if the agent used the service to which belongs the task. Average work time = ( Total time spent WORKING on CLOSED tasks + Total time spent WORKING on POSTPONED tasks ) / Number of PROCESSED tasks
AGTNBFILESDELAYED	STAT - Number of postponed tasks	It is the number of custom tasks that have been postponed because: ✓ The agent has used the postponement function, ✓ The agent rejected the task, provided that the Preview mode has been enabled (in the Agent tab of the service), ✓ The task remained open more than 2 hours.
NBFILECLOSED	STAT - Number of closed tasks	Number of custom tasks handled by the agent closed with the result: Handled task.
AGTNBFILESOFFERED	STAT - Number of offered tasks	Number of custom tasks offered to the agent, whatever the work result, closure or postponement. Number of offered tasks = Number of CLOSED tasks + Number of POSTPONED tasks
REELCONTACTARG	ACTUAL - Number of completed contacts (daily total)	Number of successful outbound calls that have been given a qualification with the Completed contact performance indicator enabled, by the agent.
CALASTHOUR	ACTUAL - Number of completed contacts (last hour)	Number of successful outbound calls that have been given a qualification with the Completed contact performance indicator enabled, in the last 60 minutes, by the agent.
REELCONTACTPOS	ACTUAL - Number of positive contacts (daily total)	Number of successful outbound calls that have been given a qualification with the Positive contact performance indicator enabled, by the agent.
CPLASTHOUR	ACTUAL - Number of positive contacts (last hour)	Number of successful outbound calls that have been given a qualification with the Positive contact performance indicator enabled, in the last 60 minutes, by the agent.
REELPOSVSARG	ACTUAL - Percentage of positive contacts out of completed contacts (daily total)	Number of successful outbound calls that have been given a qualification with the Positive contact performance indicator enabled, divided by the number of successful outbound calls that have been given a qualification with the Completed contact performance indicator enabled, by the agent. Percentage of positive contacts out of completed contacts = ( Number of POSITIVE CONTACT outbound calls / Number of COMPLETED CONTACT outbound calls ) x 100
REELRATCONTACTARG	ACTUAL - Percentage of completed contacts (daily total)	Percentage of successful outbound calls that have been given a qualification with the Completed contact performance indicator enabled, by the agent. Percentage of completed contacts = ( Number of COMPLETED CONTACT outbound calls / Number of SUCCESSFUL outbound calls ) x 100
REELRATCONTACTPOS	ACTUAL - Percentage of positive contacts (daily total)	Percentage of successful outbound calls that have been given a qualification with the Positive contact performance indicator enabled, by the agent. Percentage of positive contacts = ( Number of POSITIVE CONTACT outbound calls / Number of SUCCESSFUL outbound calls ) x 100
MOYCOMARG	STAT - Average talk time for completed contacts	Average talk time for all the outbound calls have been given a qualification with the Completed contact performance indicator enabled. Average talk time for completed contacts = Total of all the COMPLETED CONTACT talk time / Number of SUCCESSFUL COMPLETED CONTACT OUTBOUND calls
MOYCOMPOS	STAT - Average talk time for positive contacts	Average talk time for all the outbound calls have been given a qualification with the Positive contact performance indicator enabled. Average talk time for positive contacts = Total of all the POSITIVE CONTACT talk time / Number of SUCCESSFUL POSITIVE CONTACT OUTBOUND calls
MOYWRAPUPARG	STAT - Average wrap-up time for completed contacts	Average time spent by the agent in the Wrap-up system status, for all the outbound calls that have been given a qualification with the Completed contact performance indicator enabled. Average wrap-up time for completed contacts = Total of all WRAP-UP time / Number of SUCCESSFUL COMPLETED CONTACT OUTBOUND calls
MOYWRAPUPPOS	STAT - Average wrap-up time for positive contacts	Average time spent by the agent in the Wrap-up system status, for all the outbound calls that have been given a qualification with the Positive contact performance indicator enabled. Average wrap-up time for positive contacts = Total of all WRAP-UP time / Number of SUCCESSFUL POSITIVE CONTACT OUTBOUND calls
MOYTRAVARG	STAT - Average work time for completed contacts	Addition of the Average talk time and the Average wrap-up time, for all the outbound calls that have been given a qualification with the Completed contact performance indicator enabled, by the agent. Average work time = Average COMPLETED CONTACT TALK time + Average WRAP-UP time
MOYTRAVPOS	STAT - Average work time for positive contacts	Addition of the Average talk time and the Average wrap-up time, for all the outbound calls that have been given a qualification with the Positive c contact performance indicator enabled, by the agent. Average work time = Average POSITIVE CONTACT TALK time + Average WRAP-UP time
QUALIFICATION	STAT - Number of qualifications	Number of times the qualification(s) selected in the supervision block has(ve) been given by the agent. Remark: You can associate this indicator with one or more qualifications: to calculate its value, all the qualifications selected will be added.

Service

IVR Scripts

Key	Label	Description
HISTO-ABDCALL	HISTO - Number of abandoned calls	Number of Voice and Video inbound calls abandoned by customers before being processed by the IVR script, during the time slot defined. Caution: This type of indicator is only used with _curve_-type charts.
HISTO-RCDCALL	HISTO - Number of received calls	Number of Voice and Video inbound calls received in the IVR script, during the time slot defined, whether these calls are considered as successful, abandoned or non-distributed. Number of received calls = Number of SUCCESSFUL calls + Number of ABANDONED calls + Number of NON-DISTRIBUTED ND calls Caution: This type of indicator is only used with _curve_-type charts.
CLRIGHTNOW	ACTUAL - Number of calls in progress	Number of Voice and Video inbound calls in progress in the selected IVR service.
CONSCRIPTDUR	STAT - Average processing time in the script	This average time takes into account the duration of all received calls, including non distributed and abandoned calls. Average processing time in the script = Total duration of all received calls / Number of received calls
CLABD	STAT - Number of abandoned calls	Number of Voice and Video inbound calls abandoned by customers before being processed by the IVR script.
CLND_NOAGT	STAT - Number of ND calls -- No agent	Reason why calls are not distributed, used in the IVR script block: “No agent\".
CLND_OTHER	STAT - Number of ND calls -- Other condition	Reason why calls are not distributed, used in the IVR script block: “Other condition\".
CLND_WQSAT	STAT - Number of ND calls -- Saturated queue	Reason why calls are not distributed, used in the IVR script block: “Saturated queue\".
CLND_LIMCALL	STAT - Number of ND calls -- Call limit reached	Reason why calls are not distributed, used in the IVR script block: “Call limit reached\".
CLOVERPLAN	STAT - Number of ND calls -- Hours closed	Reason why calls are not distributed, used in the IVR script block: “Hours closed\".
CLND_ONDTMF	STAT - Number of ND calls -- Voluntary removal	Reason why calls are not distributed, used in the IVR script block: “Voluntary removal\".
CLND_MAXWAIT	STAT - Number of ND calls -- Max time reached	Reason why calls are not distributed, used in the IVR script block: “Maximum wait time reached\".
SVIND	STAT - Number of non distributed (ND) calls	Addition of the _Number of ND calls_-type indicators. These indicators correspond to the different reasons why calls are not distributed, available in IVR studio scripts: not enough agents, saturated queue, maximum wait time reached, hours closed, call limit reached, voluntary removal and other condition. Number of non distributed ND calls = Number of ND calls - NO AGENT + Number of ND calls - SATURATED QUEUE + Number of ND calls - MAX TIME REACHED + Number of ND calls - HOURS CLOSED + Number of ND calls - CALL LIMIT REACHED + Number of ND calls - VOLUNTARY REMOVAL + Number of ND calls - OTHER CONDITION
CLRCV	STAT - Number of received calls	Number of Voice and Video inbound calls received in the IVR script, whether they are considered as successful, abandoned or non-distributed.
CLSVISUC	STAT - Number of successful calls	Number of Voice and Video inbound calls received in the service, to which are subtracted the number of calls abandoned by customers before being processed by the IVR script and the number of calls qualified as “non-distributed” in the IVR script. Number of successful calls = Number of RECEIVED calls - ( Number of ABANDONED calls + Number of NON-DISTRIBUTED ND calls )
NBTASKSCLOSEDHOUR	STAT - Number of tasks processed in an hour	Number of successful inbound calls in the service during the last hour (rolling hour).
TRSFSVCDONE	STAT - Number of transfers to service	Number of Voice and Video inbound calls transferred to a Kiamo service. Remark: These calls are considered as “successful” calls.
SVISUCRATIO	STAT - Percentage of successful calls	Percentage of successful Voice and Video inbound calls in relation to the number of received calls. Percentage of successful calls = ( Number of SUCCESSFUL calls / Number of RECEIVED calls ) x 100
SVIABDRATIO	STAT - Percentage of abandoned calls	Percentage of Voice and Video inbound calls abandoned before being processed by the IVR script, in relation to the number of received calls. Percentage of abandoned calls = ( Number of ABANDONED calls / Number of RECEIVED calls ) x 100
ABDTHRG1RATIO ABDTHRG2RATIO ABDTHRG3RATIO	STAT - Percentage of abandoned calls after threshold (1 / 2 / 3)	Percentage of Voice and Video inbound calls that have been abandoned after the different thresholds defined for the selected IVR service in the main Kiamo interface (Call duration before abandonment thresholds setting in the Statistics tab of the service). Percentage of calls abandoned after the N threshold = ( Number of calls abandoned AFTER THRESHOLD N / Number of ABANDONED calls ) x 100
ABDTHRL1RATIO ABDTHRL2RATIO ABDTHRL3RATIO	STAT - Percentage of abandoned calls before threshold (1 /2 / 3)	Percentage of Voice and Video inbound calls that have been abandoned before the different thresholds defined for the selected IVR service in the main Kiamo interface (Call duration before abandonment thresholds setting in the Statistics tab of the service). Percentage of calls abandoned before the N threshold = ( Number of calls abandoned BEFORE THRESHOLD N / Number of ABANDONED calls ) x 100
QUALIFICATION	STAT - Number of qualifications	Number of times the main and/or automatic-type qualification(s) selected in the supervision block have been given.

Inbound calls & Internal Services

Key	Label	Description
HISTO-ABDCALL	HISTO - Number of abandoned calls	Number of Voice and Video inbound calls abandoned by customers before talking to an agent, during the time slot defined. Caution: This type of indicator is only used with curve type charts.
HISTO-RCVCALL	HISTO	Number of received calls
HISTO-ASWCALL	HISTO - Number of answered calls	Number of Voice and Video inbound calls that have been answered. This total includes all the calls answered by the agents of the group associated with the selected service, during the time slot defined. Caution: This type of indicator is only used with curve type charts.
CLWAIT	ACTUAL - Number of queued calls	Number of Voice and Video inbound calls in the service queue. Remark: This total includes all the calls for which agents’ phones are ringing.
WAITMAX	ACTUAL - Maximum wait time	Longest wait time of a call among all the calls currently in the queue.
WAITAVG	ACTUAL - Average wait time	This average wait time is the total of all the wait time of queued calls divided by the number of queued calls. Average wait time = Total of all the wait time of QUEUED calls / Number of QUEUED calls
WAITAVGANSWERED_5 WAITAVGANSWERED_15 WAITAVGANSWERED_30 WAITAVGANSWERED_60	ACTUAL - Average wait time for answered calls (last 5 / 15 / 30 / 60 minutes)	This average wait time only applies to answered calls. Remark: For this real time indicator, the value is calculated and updated in real time. This calculation is based on the last time interval selected, not on the full day. Average wait time for answered calls = Total of all wait time for ANSWERED calls / Number of ANSWERED calls
NBAGTACTIVE	ACTUAL - Number of active agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are logged in and who may be assigned tasks: ✓ either straight away because they are Ready ✓ either when they go back to the Ready status after being in one of the following system statuses: reserved, talking to a customer, wrap up, mandatory break, task handling, consultation, conference call, or internal call; ✓ or when they go back to the Ready status if they are in an available personalized status (with the Available status option enabled).
NBAGTPAUSE	ACTUAL - Number of agents in Break statuses	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are in one of the personalized break statuses, in the standard break status and in the _Anomaly_-system status
NBAGTLOG	ACTUAL - Number of logged agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are logged in, whatever their status.
NBAGTREADY	ACTUAL - Number of ready agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are in the Ready status who may be assigned task straight away.
CLABD_5 CLABD_15 CLABD_30 CLABD_60 CLABD_DAY	ACTUAL - Number of abandoned calls (last 5 / 15 / 30 / 60 minutes / daily total )	Number of Voice and Video inbound calls abandoned by customers before being put through to an agent. Remark: For this real time indicator, not only can you have the value for the full day, but also the value calculated and updated in real time for the last 5, 15, 30 or 60 minutes. This calculation is based on the last time interval selected, not on the full day.
CLRIGHTNOW	ACTUAL - Number of calls in progress	Number of on going phone calls between agents & customers.
CLRCV_5 CLRCV_15 CLRCV_30 CLRCV_60 CLRCV_DAY	ACTUAL - Number of received calls last 5 / 15 / 30 / 60 minutes / daily total	Number of Voice and Video inbound calls received in the selected service, including answered, abandoned and non-distributed calls. Remark: For this real-time indicator, not only can you have the value for the full day, but also the value calculated and updated in real-time for the last 5, 15, 30 or 60 minutes. This calculation is based on the last time interval selected, not on the full day. Caution: Off hours calls are not included in this total.
CLAGTANS_5 CLAGTANS_15 CLAGTANS_30 CLAGTANS_60 CLAGTANS_DAY	ACTUAL - Number of calls answered by an agent last 5 / 15 / 30 /60 minutes / daily total	Number of Voice and Video inbound calls that have been answered. This total includes all the calls answered by the agents belonging to the main and additional distribution groups associated with the supervised service. Remark: For this real time indicator, not only can you have the value for the full day, but also the value calculated and updated in real time for the last 5, 15, 30 or 60 minutes. This calculation is based on the last time interval selected, not on the full day.
SVCQUAL_5 SVCQUAL_15 SVCQUAL_30 SVCQUAL_60 SVCQUAL_DAY	ACTUAL - Quality of service last 5 / 15 / 30 / 60 minutes / daily total	Percentage of Voice and Video inbound calls answered in relation to the number of received calls. Quality of service = ( Number of calls ANSWERED by an agent / Number of RECEIVED calls ) x 100 Remark: For this real time ind icator, not only can you have the value for the full day, but also the value calculated and updated in real time for the last 5, 15, 30 or 60 minutes. This calculation is based on the last time interval selected, not on the full day.
WAITABDMAX	STAT - Maximum wait time for abandoned calls	Longest wait time of an abandoned call, among all the wait time of abandoned calls.
WAITANSMAX	STAT - Maximum wait time for answered calls	Longest wait time of an answered call, among all the wait time of answered calls.
WAITABDMIN	STAT - Minimum wait time for abandoned calls	Shortest wait time of an abandoned call, among all the wait time of abandoned calls.
WAITANSMIN	STAT - Minimum wait time for answered calls	Shortest wait time of an answered call, among all the wait time of answered calls.
WAITABDAVG	STAT - Average wait time for abandoned calls	Average wait time of all the calls that have been abandoned by customers before talking to an agent. Average wait time for abandoned calls = Total of the wait time of ABANDONED calls / Number of ABANDONED calls
WAITANSAVG	STAT - Average wait time for answered calls	Average wait time of all the calls that have been answered. Average wait time for answered calls = Total of all wait time for ANSWERED calls / Number of ANSWERED calls
COMMAVG	STAT - Average talk time	Average time spent by customers talking to agents. Average talk time = Total of all the talk time / Number of ANSWERED calls
ANSRAVG	STAT - Average agent ringing time for answered calls	Average ringing time before the agent answers the phone call. Average agent ringing time for answered calls = Total of all the ringing time for ANSWERED calls / Number of ANSWERED calls
AVGWORKST	STAT - Average work time	Total of Average talk time and the Average wrap-up time Average handling time = Average TALK time + Average WRAP-UP time
AVGWRAPUPST	STAT - Average wrap-up time	Average time spent by agents in the Wrap-up system status.__Average wrap-up time* = Total of all the WRAP-UP time / Number of ANSWERED calls
SVCNIVEAU	STAT - Service level	The service level is the percentage of Voice and Video inbound calls answered before the first wait time threshold, in relation to the number of answered calls (Wait time thresholds for answered calls setting in the Statistics tab of the service). Service level = ( Number of ANSWERED calls BEFORE THE FIRST THRESHOLD ) / Number of ANSWERED calls ) x 100
CLABD	STAT - Number of abandoned calls	Number of Voice and Video inbound calls abandoned by customers before being put through to an agent.
APPTOOLNG	STAT - Number of long calls (above threshold)	Number of Voice and Video inbound calls with a talk time superior to the maximum recommended talk time setting, which can be edited in the Statistics tab of the service.
CLND_NOAGT CLND_WQSAT CLND_MAXWAIT	STAT - Number of ND calls -- No agent STAT - Number of ND calls -- Saturated queue STAT - Number of ND calls -- Max time reached	Number of Voice and Video inbound calls matching the different test cases carried out in the Script tab of the service. This total does not include off hours calls because they are not considered as not distributed. Thus, for each of these indicators, the calculation is done taking into account: ✓ All non-distributed calls because no agent was connected, ✓ All non-distributed calls because the queue was saturated, ✓ All non-distributed calls because the maximum wait time has been reached.
CLND	STAT - Number of non-distributed ND calls	Addition of all the values of the Number of ND calls_-type indicators, which correspond to the different test cases carried out in the Script tab of the service. Caution_: Off hours calls are not included in this total. Number of non-distributed ND calls = Number of ND calls - NO AGENT + Number of ND calls - SATURATED QUEUE + Number of ND calls - MAX TIME REACHED
APPNONPER	STAT - Number of irrelevant calls	To calculate this indicator, Kiamo takes into account all the Voice and Video inbound calls with a talk time inferior to the threshold for relevance of customer communications parameter. This threshold can be edited in the Statistics tab of the service.
CLACDRCV	STAT - Number of received calls	Number of Voice and Video inbound calls received in the service, including answered, abandoned and non-distributed calls. Number of RECEIVED calls = Number of SUCCESSFUL calls + Number of ABANDONED calls + Number of NON-DISTRIBUTED (ND) calls
CLOVERPLAN	STAT - Number of off hours calls received	Number of Voice and Video inbound received in the service while the schedule associated with this service is closed.
CLAGTREF	STAT - Number of calls rejected by an agent	Number of Voice and Video inbound for which the agent’s phone rang but he did not answer.
CLAGTANS	STAT - Number of calls answered by an agent	Number of Voice and Video inbound calls answered by agents belonging to the main and additional distribution groups associated with the supervised service who. This total includes all the calls answered by the agents of the group associated with the selected service.
CONFDONE	STAT - Number of conference calls made	Numbers of conference calls made while the agents of the group associated with the selected service were talking to a customer.
CONSDONE	STAT - Number of consultation calls made	Numbers of consultation calls made while the agents of the group associated with the selected service were talking to a customer.
NBTASKSCLOSEDHOUR	STAT - Number of tasks processed in an hour	Number of Voice and Video inbound calls answered in the service during the last hour (rolling hour).
TRSFAGTDONE	STAT - Number of transfers to an agent	Number of calls transferred after a consultation call.
TRSFNUMDONE	STAT - Number of transfers to phone number	Number of calls transferred using the Transfer to a number option.
TRSFSVCDONE	STAT - Number of transfers to a service	Number of calls transferred using the Transfer to a service option.
ABDCLRATIO	STAT - Percentage of abandoned calls	Percentage of Voice and Video inbound calls abandoned by customers in relation to the number of received calls. Percentage of abandoned calls = ( Number of ABANDONED calls / Number of RECEIVED calls ) x 100
ABDTHRG1RATIO ABDTHRG2RATIO ABDTHRG3RATIO	STAT - Percentage of abandoned calls after threshold (1 / 2 / 3)	Percentage of Voice and Video inbound calls that have been abandoned after the different thresholds defined for the selected service (Wait time thresholds for abandoned calls setting in the Statistics tab of the service). Percentage of calls abandoned after the N threshold = ( Number of calls abandoned AFTER THRESHOLD N / Number of ABANDONED calls ) x 100
ABDTHRL1RATIO ABDTHRL2RATIO ABDTHRL3RATIO	STAT - Percentage of abandoned calls before threshold (1 / 2 / 3)	Percentage of Voice and Video inbound calls that have been abandoned before the different thresholds defined for the selected service (Wait time thresholds for abandoned calls setting in the Statistics tab of the service). Percentage of calls abandoned before the N threshold * ( Number of calls abandoned BEFORE THRESHOLD N / Number of ABANDONED calls ) x 100
ANSTHRG1RATIO ANSTHRG2RATIO ANSTHRG3RATIO	STAT - Percentage of calls answered after threshold (1 / 2 / 3)	Percentage of Voice and Video inbound calls answered after one of the thresholds defined for the selected service (Wait time thresholds for answered calls setting in the Statistics tab of the service). Percentage of calls answered after the N threshold = ( Number of calls answered AFTER THE THRESHOLD N / Number of ANSWERED calls ) x 100
ANSTHRL1RATIO ANSTHRL2RATIO ANSTHRL3RATIO	STAT - Percentage of calls answered before threshold (1 / 2/ 3)	Percentage of Voice and Video inbound calls answered before one of the thresholds defined for the selected service (Wait time thresholds for answered calls setting in the Statistics tab of the service). Percentage of calls answered before the N threshold = ( Number of calls answered BEFORE THE THRESHOLD N / Number of ANSWERED calls ) x 100
SVCQUAL	STAT - Quality of Service	Percentage of Voice and Video inbound calls that have been answered in relation to the number of received calls. Quality of service = ( Number of calls ANSWERED by an agent / Number of RECEIVED calls ) x 100 Remark: This total included queued calls.
QUALIFICATION	STAT - Number of qualifications	Number of times the main and/or automatic type qualification(s) selected in the supervision block have been given.

Outbound call campaigns

Key	Label	Description
HISTO-ABDCALL	HISTO - Number of successful outbound calls	Number of tasks of the campaign that have been closed with the following result - Successful call - during the time slot defined. Caution: This type of indicator is only used with curve type charts.
HISTO-RCVCALL	HISTO - Number of outbound call attempts	Total of successful outbound calls, failed outbound calls and nuisance calls, during the time slot defined. Total of outbound call attempts = Number of SUCCESSFUL outbound calls + Number of FAILED outbound calls + NUISANCE calls Remark : Nuisance calls are the number of calls corresponding to: ✓ Customer calls cancelled by an agent. ✓ Calls hung up by customers while the agent’s phone was ringing, if customers are called before agents. ✓ Non distributed customer calls, if customers are called before agents. Caution: This type of indicator is only used with curve type charts.
CLRIGHTNOW	ACTUAL - Number of calls in progress	Number of on-going phone calls between agents & customers for the outbound call campaign selected.
NBAGTACTIVE	ACTUAL - Number of active agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are logged in and who may be assigned tasks: ✓ either straight away because they are Ready ✓ either when they go back to the Ready status after being in one of the following system statuses: reserved, talking to a customer, wrap-up, mandatory break, task handling, consultation, conference call, or internal call; ✓ or when they go back to the Ready status if they are in an available personalized status (with the Available status option enabled).
NBAGTPAUSE	ACTUAL - Number of agents in Break statuses	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are in one of the personalized break statuses, in the standard break status and in the _Anomaly_-system status.
NBAGTLOG	ACTUAL - Number of logged agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are logged in, whatever their status.
NBAGTREADY	ACTUAL - Number of ready agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are in the Ready status who may be assigned tasks straight away.
CALLNOTCLOSED	ACTUAL - Number of tasks to process	Number of tasks in the selected campaign waiting to be processed, whether or not they are in the service queue.
TASKINWQ	ACTUAL - Number of queued tasks	Number of tasks in the service queue. Tasks are included in the service queue when the campaign is started in automatic or mixed mode, and: ✓ If a schedule is associated with the selected service, during the opening hours of the schedule; ✓ If no schedule is associated with the service, they will always be included in the service queue. Caution: This indicator is not completed if the distribution mode defined for the service is: manual. Remark: Tasks with a scheduled date set in the past are included in the service queue whereas tasks with a scheduled date in the future are not. They will be included as soon as the date and time scheduled are reached.
COMMAVG	STAT - Average talk time	Average time spent by agents belonging to the main and additional distribution groups associated with the supervised service who are talking to customers. Average talk time = Total of all TALK time / Number of SUCCESSFUL outbound calls
AVGWORKST	STAT - Average work time	Total Average talk time and the Average wrap-up time. Average work time = Average TALK time + Average WRAP-UP time
AVGWRAPUPST	STAT - Average wrap-up time	Average time spent by agents in the _Wrap-up_-system status. Average wrap-up time = Total of all WRAP-UP time / Number of SUCCESSFUL outbound calls
CLABD	STAT - Number of abandoned calls	Addition of all the calls abandoned by customers (when the customer is called before the agent and he hangs up while the agent’s phone is ringing), and those abandoned by agents (when the agent hangs up while the customer’s phone is ringing, or when the agent does not answer if the customer is called first).
APPTOOLNG	STAT - Number of long calls (above threshold)	Number of calls with a talk time superior to the maximum recommended talk time setting defined in the Statistics tab of the service.
APPNONPER	STAT - Number of irrelevant calls	Number of calls with a talk time inferior to the threshold for relevance of customer communications setting in the Statistics tab of the service.
CLAGTREF	STAT - Number of calls rejected by an agent	Number of times the agent has not answered a call while his phone was ringing, when the customer is called before the agent.
OUTCLCANC	STAT - Number of cancelled outbound calls	Number of times the agent has hung up while the customer’s phone was ringing, as well as the number of times the agent has not answered, when the agent is called before the customer.
OUTCLBUSY OUTCLNOANSW OUTCLWRGNUM OUTCLNOCHAN OUTCLFAX OUTCLANSWMA	STAT - Number of FLD outbound call attempts -- Busy number STAT - Number of FLD outbound call attempts -- No answer STAT - Number of FLD outbound call attempts -- Wrong number STAT - Number of FLD outbound call attempts -- No available channel STAT - Number of FLD outbound call attempts -- Fax STAT - Number of FLD outbound call attempts -- Answering machine	These indicators are used to specify the reason why calls have failed: wrong customer’s phone number, busy, no answer, fax detection, answering machine detection or no available channel to establish communication.
OUTCLFAIL	STAT - Number of failed (FLD) outbound call attempts	Addition of all failed outbound calls. This total is divided between the different indicators corresponding to the cases encountered: no channel available to establish communication, wrong customer’s phone number, busy, no answer, fax or answering machine detected. Number of failed FLD outbound calls = Number of FLD outbound calls - NO AVAILABLE CHANNEL + Number of FLD outbound call attempts - WRONG NUMBER + Number of FLD outbound calls - FAX + Number of FLD outbound call attempts - BUSY NUMBER + Number of FLD outbound call attempts - NO ANSWER + Number of FLD outbound calls - ANSWERING MACHINE
OUTCLDONE	STAT - Number of successful outbound calls	Number of tasks of the campaign that have been closed with the following result: Successful call.
CONFDONE	STAT - Number of conference calls made	Number of conference calls made while the agent was talking to a customer.
CONSDONE	STAT - Number of consultation calls made	Number of consultation calls made while the agent was talking to a customer.
PREVIEWOFF	STAT - Number of previews offered	Number of previews offered to agents, if the Preview mode has been activated for the campaign. This total is automatically incremented, whether the call is accepted or rejected by the agent.
PREVIEWREF	STAT - Number of rejected previews	Number of previews offered to agents that have been rejected, if the Preview mode has been activated for the campaign.
OUTCLDONEANS	STAT - Number of answering machines distributed	Number of answering machines distributed to agents, if the Transfer answering machine to agent option has been selected for the outbound campaign (in the Telephony tab, Answering machine & fax detection section).
NBFILECLDSUC	STAT - Number of tasks successfully completed	Number of tasks of the campaign that have been closed with the following result: Successful call.
NBFILECLDMAX	STAT - Number of failed tasks	Number of tasks of the campaign that have been closed because the maximum number of call attempts has been reached.
FILEPROCESSED	STAT - Number of processed tasks	Number of tasks processed in the campaign, whatever the work result.
NBTASKSCLOSEDHOUR	STAT - Number of tasks processed in an hour	Number of tasks successfully completed in the campaign, during the last hour (rolling hour).
OUTCLTRY	STAT - Number of outbound call attempts	Addition of successful outbound calls, failed outbound calls and nuisance calls. Total of outbound call attempts = Number of SUCCESSFUL outbound calls + Number of FAILED outbound calls + NUISANCE calls Remark: Nuisance calls are the number of calls corresponding to: ✓ Customer calls cancelled by an agent, ✓ Calls hung up by customers while the agent’s phone was ringing, if customers are called before agents. ✓ Non-distributed customer calls, if customers are called before agents.
TRSFAGTDONE	STAT - Number of transfers to agent	Number of calls transferred after a consultation call.
TRSFNUMDONE	STAT - Number of transfers to phone number	Number of calls transferred using the Transfer to a number option.
TRSFSVCDONE	STAT - Number of transfers to a service	Number of calls transferred using the Transfer to a service option.
HISTO-ARGCALL	HISTO - Number of completed contacts	Number of successful outbound calls that have been given a qualification with the Completed contact performance indicator enabled, during the time slot defined. Caution: This type of indicator is only used with curve type charts.
HISTO-POSARGCALL	HISTO - Number of positive contacts	Number of successful outbound calls that have been given a qualification with the Positive contact performance indicator enabled, during the time slot defined. Caution: This type of indicator is only used with curve type charts.
REELCONTACTARG	ACTUAL - Number of completed contacts (daily total)	Number of successful outbound calls that have been given a qualification with the Completed contact performance indicator enabled.
CALASTHOUR	ACTUAL - Number of completed contacts (last hour)	Number of successful outbound calls that have been given a qualification with the Completed contact performance indicator enabled, in the last 60 minutes.
REELCONTACTPOS	ACTUAL - Number of positive contacts (daily total)	Number of successful outbound calls that have been given a qualification with the Positive contact performance indicator enabled.
CPLASTHOUR	ACTUAL - Number of positive contacts (last hour)	Number of successful outbound calls that have been given a qualification with the Positive contact performance indicator enabled, in the last 60 minutes.
REELPOSVSARG	ACTUAL - Percentage of positive contacts out of completed contacts (daily total)	Number of successful outbound calls that have been given a qualification with the Positive contact performance indicator enabled, divided by the number of successful outbound calls that have been given a qualification with the Completed contact performance indicator enabled. Percentage of positive contacts out of completed contacts = ( Number of POSITIVE CONTACT outbound calls / Number of COMPLETED CONTACT outbound calls ) x 100
REELRATCONTACTARG	ACTUAL - Percentage of completed contacts (daily total)	Percentage of successful outbound calls that have been given a qualification with the Completed contact performance indicator enabled. Percentage of completed contacts = ( Number of COMPLETED CONTACT outbound calls / Number of SUCCESSFUL outbound calls ) x 100
REELRATCONTACTPOS	ACTUAL - Percentage of positive contacts (daily total)	Percentage of successful outbound calls that have been given a qualification with the Positive contact performance indicator enabled. Percentage of positive contacts = ( Number of POSITIVE CONTACT outbound calls / Number of SUCCESSFUL outbound calls ) x 100
MOYCOMARG	STAT - Average talk time for completed contacts	Average talk time for all the outbound calls have been given a qualification with the Completed contact performance indicator enabled. Average talk time for completed contacts = Total of all the COMPLETED CONTACT talk time / Number of SUCCESSFUL COMPLETED CONTACT OUTBOUND calls
MOYCOMPOS	STAT - Average talk time for positive contacts	Average talk time for all the outbound calls have been given a qualification with the Positive contact performance indicator enabled. Average talk time for positive contacts = Total of all the POSITIVE CONTACT talk time / Number of SUCCESSFUL POSITIVE CONTACT OUTBOUND calls
MOYWRAPUPARG	STAT - Average wrap-up time for completed contacts	Average time spent by agents in the _Wrap-up_-system status, for all the outbound calls that have been given a qualification with the Completed contact performance indicator enabled. Average wrap-up time for completed contacts = Total of all WRAP-UP time / Number of SUCCESSFUL COMPLETED CONTACT OUTBOUND calls
MOYWRAPUPPOS	STAT - Average wrap-up time for positive contacts	Average time spent by agents in the _Wrap-up_-system status, for all the outbound calls that have been given a qualification with the Positive contact performance indicator enabled. Average wrap-up time for positive contacts = Total of all WRAP-UP time / Number of SUCCESSFUL POSITIVE CONTACT OUTBOUND calls
MOYTRAVARG	STAT - Average work time for completed contacts	Addition of the Average talk time and the Average wrap-up time, for all the outbound calls that have been given a qualification with the Completed contact performance indicator enabled. Average work time = Average COMPLETED CONTACT TALK time + Average WRAP-UP time
MOYTRAVPOS	STAT - Average work time for positive contacts	Addition of the Average talk time and the Average wrap-up time, for all the outbound calls that have been given a qualification with the Positive contact performance indicator enabled. Average work time = Average POSITIVE CONTACT TALK time + Average WRAP-UP time
QUALIFICATION	STAT - Number of qualifications	Number of times the qualification(s) selected in the Number of times the main and/or automatic type qualification(s) selected in the supervision block have been given.

Agent out calls

Key	Label	Description
CLRIGHTNOW	ACTUAL - Number of calls in progress	Number of on-going phone calls between agents & customers for the selected agent out call service.
NBAGTACTIVE	ACTUAL - Number of active agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are logged in and who may be assigned tasks: ✓ either straight away because they are Ready ✓ either when they go back to the Ready status after being in one of the following system statuses: reserved, talking to a customer, wrap-up, mandatory break, task handling, consultation, conference call, or internal call; ✓ or when they go back to the Ready status if they are in an available personalized status (with the Available status option enabled).
NBAGTPAUSE	ACTUAL - Number of agents in Break statuses	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are in one of the personalized break statuses, in the standard break status and in the _Anomaly_-system status.
NBAGTLOG	ACTUAL - Number of logged agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are logged in, whatever their status.
NBAGTREADY	ACTUAL - Number of ready agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are in the Ready status who may be assigned tasks straight away.
COMMAVG	STAT - Average talk time	Average time spent by agents belonging to the main and additional distribution groups associated with the supervised service talking to customers. Average talk time = Total of all TALK time / Number of SUCCESSFUL outbound calls
AVGWORKST	STAT - Average work time	Addition of the Average talk time and the Average wrap-up time. Average work time = Average TALK time + Average WRAP-UP time
AVGWRAPUPST	STAT - Average wrap-up time	Average time spent by agents in the _Wrap-up_-system status. Average wrap-up time = Total of all WRAP-UP time / Number of SUCCESSFUL outbound calls
APPTOOLNG	STAT - Number of long calls (above threshold)	Number of calls with a talk time superior to the maximum recommended talk time setting defined in the Statistics tab of the service.
APPNONPER	STAT - Number of irrelevant calls	Number of calls with a talk time inferior to the threshold for relevance of customer communications setting in the Statistics tab of the service.
OUTCLCANC	STAT - Number of cancelled outbound calls	Number of calls cancelled by the agent before the customer answered.
OUTCLWRGNUM OUTCLBUSY OUTCLNOCHAN OUTCLNOANSW	STAT - Number of FLD outbound call attempts -- Wrong number STAT - Number of FLD outbound call attempts -- Busy number STAT - Number of FLD outbound calls -- No available channel STAT - Number of FLD outbound call attempts -- No answer	These indicators give the reasons why agent out calls failed: wrong customer’s phone number, busy number, no answer or no channel to establish communication.
OUTCLFAIL	STAT - Number of failed FLD outbound calls	Addition of all failed agent out calls. This total is divided between the different indicators corresponding to the cases encountered: no channel available to establish communication, wrong customer’s phone number, busy or no answer. Number of failed FLD outbound calls = Number of FLD outbound call attempts - WRONG NUMBER + Number of FLD outbound call attempts - BUSY NUMBER + Number of FLD outbound call attempts - NO ANSWER + Number of FLD outbound calls - NO AVAILABLE CHANNEL
OUTCLDONE	STAT - Number of successful outbound calls	Number of calls that ended in the agent talking to the customer.
CONFDONE	STAT - Number of conference calls made	Number of conference calls made by agents during agent out calls.
CONSDONE	STAT - Number of consultation calls made	Number of consultation calls made by agents during agent out calls.
OUTCLTRY	STAT - Number of outbound call attempts	Addition of successful, failed and cancelled outbound calls. Number of outbound call attempts = Number of SUCCESSFUL outbound calls + Number of FAILED outbound calls + Number of CANCELLED outbound calls
TRSFAGTDONE	STAT - Number of transfers to agent	Number of calls transferred after a consultation call.
TRSFNUMDONE	STAT - Number of transfers to phone number	Number of calls transferred using the Transfer to a number option.
TRSFSVCDONE	STAT - Number of transfers to a service	Number of calls transferred using the Transfer to a service option.
QUALIFICATION	STAT - Number of qualifications	Number of times the main and/or automatic-type qualification(s) selected in the supervision block have been given.

Email Scripts

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Label	Description
NBMLRECV	STAT - Number of received emails	Number of emails that have been received in the service, whatever the email processing result, closing or transfer.
NBMLCLOSED	STAT - Number of closed emails	Number of emails that have been processed and closed by the script without being transferred to another Kiamo service.
NBMLSENT	STAT - Number of sent emails	Number of emails sent by the script associated with the service. Caution: Emails transferred to another Kiamo service are not included in this indicator.
NBMLTRFSVC	STAT - Number of emails transferred to a service	Number of received emails, which have been transferred to another Kiamo service.
QUALIFICATION	STAT - Number of qualifications	Number of times the main and/or automatic-type qualification(s) selected in the supervision block have been given.

Inbound emails

Key	Label	Description
MLNOTCLOSED	ACTUAL - Number of emails to process	Number of emails to process in the selected service, whether or not they are in the service queue.
MLRTWAITMAXBRUT	ACTUAL - Maximum gross wait time	Longest gross time spent waiting by an inbound email, among all the time spent waiting by inbound emails to process. Remark: The gross wait time is the time spent by the task waiting in the service, whatever the distribution mode defined for the service (automatic, manual, mixed or no distribution) and whatever the status of the schedule associated with the service (open or closed).
NBAGTACTIVE	ACTUAL - Number of active agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are logged in and who may be assigned tasks: ✓ either straight away because they are Ready ✓ either when they go back to the Ready status after being in one of the following system statuses: reserved, talking to a customer, wrap-up, mandatory break, task handling, consultation, conference call, or internal call; ✓ or when they go back to the Ready status if they are in an available personalized status (with the Available status option enabled).
NBAGTLOG	ACTUAL - Number of logged-in agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who logged-in, whatever their status.
NBAGTREADY	ACTUAL - Number of ready agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are in the Ready status who may be assigned tasks straight away.
CLRIGHTNOW	ACTUAL - Number of calls in progress	Number of on-going phone calls while working on emails from this service.
MLRIGHTNOW	ACTUAL - Number of emails being processed	Number of inbound emails being offered to and processed by agents belonging to the main and additional distribution groups associated with the supervised service.
MLWAIT	ACTUAL - Number of queued emails	Number of inbound emails to be processed that are in the service queue. Emails to be processed are included in the “queue” when the service is started in automatic or mixed mode, and: ✓ If a schedule is associated with the selected service, during the opening hours of the schedule; ✓ If no schedule is associated with the service, they will always be included in the service queue. Caution: This indicator is not completed if the distribution mode defined for the service is: manual.
MLCLOSEDAVG	STAT - Average closing time (gross wait + agent work)	The average closing time is the total time spent processing and closing inbound emails, divided by the number of closed inbound emails. Average closing time = Total of ALL CLOSING TIME / Number of CLOSED emails Remark: The closing time is the gross wait time, to which is added all the time spent by agent(s) working on this email. Remark: The gross wait time is the time spent by the task waiting in the service, whatever the distribution mode defined for the service (automatic, manual, mixed or no distribution) and whatever the status of the schedule associated with the service (open or closed).
MLWAITMAX	ACTUAL - Maximum net wait time	Longest net time spent waiting by an inbound email, among all the time spent waiting by inbound e mails offered to the agents belonging to the main and additional distribution groups associated with the supervised service. Remark: The net wait time is the time spent by the task waiting in the service, while the schedule associated with the service is open and while the service is started in automatic or mixed mode. Caution: This indicator is not completed if the distribution mode defined for the service is: manual.
MLWAITMIN	STAT - Minimum net wait time	Shortest net time spent waiting by an inbound email, among all the time spent waiting by inbound emails offered to agents. Remark: The net wait time is the time spent by the task waiting in the service, while the schedule associated with the service is open and while the service is started in automatic or mixed mode. Caution: This indicator is not completed if the distribution mode defined for the service is: manual.
MLWAITAVG	STAT - Average net wait time	Total net wait time of inbound emails offered to agents, divided by the number of inbound emails offered to the agents belonging to the main and additional distribution groups associated with the supervised service. Average wait time = Total of all NET WAIT TIME OF OFFERED EMAILS / Number of OFFERED emails Remark: The net wait time is the time spent by the task waiting in the service, while the schedule associated with the service is open and while the service is started in automatic or mixed mode. Caution: This indicator is not completed if the distribution mode defined for the service is: manual.
WORKMLAVG	STAT - Average work time	Total time spent working on the inbound emails offered to agents, divided by the number of inbound emails offered to the agents belonging to the main and additional distribution groups asso ciated with the supervised service. Average work time = Total time spent WORKING on offered emails / Number of OFFERED emails Caution: Calls made while working on emails using the service to which belong these emails are included in this work time.
MLSVCLVL	STAT - Service level	The service level is the percentage of inbound emails closed before the first wait time threshold, in relation to the total number of inbound emails closed (Email closing time thresholds setting in the Statistics tab of the service). Service level = ( Number of emails CLOSED BEFORE THRESHOLD 1 ) / Number of CLOSED emails ) x 100
OUTCLDONE	STAT - Number of outbound calls	Number of outbound calls made by the agents belonging to the main and additional distribution groups associated with the supervised service while working on the emails from this service. Caution: Outbound calls made using an agent out call service are not included in this total.
NBNEWMRCV	STAT - Number of new emails received	Number of new emails received in the service, whatever the work result, closing or postponement. This total includes inbound emails closed and then returned to the queue, as well as inbound emails that were first closed without sending an answer and then were reopened.
NBTASKSCLOSEDHOUR	STAT - Number of tasks processed in an hour	Number of inbound emails handled and closed in the selected service during the last hour (rolling period).
MLWITHANS	STAT - Number of emails with answer	Number of inbound emails offered to the agents belonging to the main and additional distribution groups associated with the supervised service, which resulted in an answer being given to the customer, whether this answer is given by email or by phone. Caution: Transferred emails are not answers.
MLWITHCL	STAT - Number of emails that generated an outbound call	Number of inbound emails offered to the agents belonging to the main and additional distribution groups associated with the supervised service, during which a call was made.
MLWITHML	STAT - Number of emails that generated an outbound email	Number of inbound emails offered to the agents belonging to the main and additional distribution groups associated with the supervised service, which resulted in an email being sent as answer. Caution: Transferred emails are not included in this indicator. Outbound emails with a Kiamo service as recipient are considered as transferred.
MLWITHTRANS	STAT - Number of emails that generated an internal email	Caution: This indicator does not work since Kiamo 6. Number of inbound emails offered to the agents, which resulted in a transfer of the email to another Kiamo service.
MLNONPER	STAT - Number of emails with work time inferior to the short threshold	Number of inbound emails with a work time inferior to the Short threshold setting, which can be defined in the Statistics tab of the service, Work time thresholds section.
MLTOOLNG	STAT - Number of emails with work time superior to the long threshold	Number of inbound emails with a work time superior to the Long threshold setting, which can be defined in the Statistics tab of the service, Work time thresholds section.
NBMLREPR	STAT - Number of postponed emails	Number of inbound emails that have been postponed because: ✓ The agent has used the postponement function, ✓ The email has been forwarded using the Send or Action button available in the email template used, ✓ The email window has been closed using another means, ✓ The email window remained open more than 2 hours.
NBMLCLOSED	STAT - Number of closed emails	Number of inbound emails that have been closed. An email can be closed for one of the following reasons: ✓ The agent has used the Close button and then the Finalize function available in the email template used, ✓ The email automatic closing has been configured on the Send button or on an Action button available in the email template used.
MLCLOSEDGTH1 MLCLOSEDGTH2 MLCLOSEDGTH3	STAT - Number of emails closed after threshold (1/2/3)	Number of inbound emails closed after one of the three thresholds defined for the service selected in the Statistics tab of the service, Email closing time thresholds section. Remark: The closing time is the gross wait time, to which is added all the time spent by agent(s) working on this email. Remark: The gross wait time is the time spent by the task waiting in the service, whatever the distribution mode defined for the service (automatic, manual, mixed or no distribution) and whatever the status of the schedule associated with the service (open or closed).
MLCLOSEDLTH1 MLCLOSEDLTH2 MLCLOSEDLTH3	STAT - Number of emails closed before threshold (1 / 2 / 3)	Number of inbound emails closed before one of the three thresholds defined for the service selected in the Statistics tab of the service, Email closing time thresholds section. Remark: The closing time is the gross wait time, to which is added all the time spent by agent(s) working on this email. Remark: The gross wait time is the time spent by the task waiting in the service, whatever the distribution mode defined for the service (automatic, manual, mixed or no distribution) and whatever the status of the schedule associated with the service (open or closed).
NBMLSENT	STAT - Number of sent emails	Number of inbound emails offered to agents, which resulted in an email being sent as answer.
NBMLTRFSVC	STAT - Number of internal emails	Caution: This indicator does not work since Kiamo 6. Number of inbound emails offered to agents, which were transferred to another Kiamo service.
NBMLNODIST	STAT - Number of non-distributed emails	Number of non-distributed inbound emails because: ✓ The email has been automatically transferred, once the maximum wait time has been reached (Maximum wait time and Transfer to a service settings, in the Script tab of the service), ✓ The email has been transferred or directly deleted from the list of emails (Monitoring > Supervision view menu > Start button > List of emails), ✓ The email has been deleted from the list of email addresses (Administration > Integration > POP / SMTP menu).
NBMLSUBMIT	STAT - Number of offered emails	Number of inbound emails that have been offered, whatever the work result, closing or postponement. Number of offered emails = Number of CLOSED emails + Number of POSTPONED emails
NBMLRECV	STAT - Number of received emails	Number of emails received in the service. This total includes inbound emails closed and then returned to the queue, as well as inbound emails that were first closed without sending an answer and then were reopened. Caution: An email can only be received once in a service, but can be offered several times, when the postponement function is used. This explains why the number of received emails can be inferior to the number of offered emails.
NBMLATRECV	STAT - Number of emails received with a known tracking reference	Number of received emails with a known Kiamo tracking reference. Caution: When email tracking is activated in Kiamo, a tracking number is automatically inserted in the email object: this unique number is attributed to the email as soon as it is received in Kiamo.
MLWITHOUTANS	STAT - Number of emails without answer	Number of inbound emails offered to the agents belonging to the main and additional distribution groups associated with the supervised service , which resulted in no answer being given to the customer.
MLTOVALID	STAT - Number of outbound emails sent to validation	Number of sent emails by the agents belonging to the main and additional distribution groups associated with the supervised service , which have been directed to an email validation service.
QUALIFICATION	STAT - Number of qualifications	Number of times the main and/or automatic-type qualification(s) selected in the supervision block have been given.

Email validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Label	Description
MLNOTCLOSED	ACTUAL - Number of emails to validate	Number of emails to validate, whether or not they are in the service queue.
MLRTWAITMAXBRUT	ACTUAL - Maximum gross wait time	Longest gross time spent waiting by an email to validate, among all the gross time spent waiting by emails to validate. Remark: The gross wait time is the time spent by the task waiting in the service, whatever the distribution mode defined for the service (automatic, manual, mixed or no distribution) and whatever the status of the schedule associated with the service (open or closed).
NBAGTACTIVE	ACTUAL - Number of active agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are logged in and who may be assigned tasks: ✓ either straight away because they are Ready ✓ either when they go back to the Ready status after being in one of the following system statuses: reserved, talking to a customer, wrap-up, mandatory break, task handling, consultation, conference call, or internal call; ✓ or when they go back to the Ready status if they are in an available per sonalized status (with the Available status option enabled).
NBAGTLOG	ACTUAL - Number of logged agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are logged in, whatever their status.
NBAGTREADY	ACTUAL - Number of ready agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are in the Ready status who may be assigned tasks straight away.
CLRIGHTNOW	ACTUAL - Number of calls in progress	Number of on-going phone calls while working on emails from this service.
MLRIGHTNOW	ACTUAL - Number of emails being validated	Number of emails being offered to and being handled by the agents belonging to the main and additional distribution groups associated with the supervised service who in order to be validated.
MLWAIT	ACTUAL - Number of queued emails	Number of emails to validate in the service queue. Emails to validate are included in the \"queue\" when the service is started in automatic or mixed mode, and: ✓ If a schedule is associated with the selected service, during the opening hours of the schedule; ✓ If no schedule is associated with the service, they will always be included in the service queue. Caution: This indicator is not completed if the distribution mode defined for the service is: manual.
MLCLOSEDAVG	STAT - Average validation time (gross wait + agent work)	The average validation time is the total of all validation time, divided by the number of validated emails. Average validation time = Total of ALL VALIDATION TIME / Number of VALIDATED emails Remark: The validation time is the gross wait, to which is added the time spent by agent(s) working on this email. Remark: The gross wait time is the time spent by the task waiting in the service, whatever the distribution mode defined for the service (automatic, manual, mixed or no distribution) and whatever the status of the schedule associated with the service (open or closed).
MLWAITMAX	STAT - Maximum net wait time	Longest net time spent waiting by an email to validate, among all the net time spent waiting by emails to validate offered to the agents belonging to the main and additional distribution groups associa ted with the supervised service. Remark: The net wait time is the time spent by the task waiting in the service, while the schedule associated with the service is open and while the service is started in automatic or mixed mode. Caution: This indicator is not completed if the distribution mode defined for the service is: manual.
MLWAITMIN	STAT - Minimum net wait time	Shortest net time spent waiting by an email to validate, among all the net time spent waiting by emails to validate offered to the agents belonging to the main and additional distribution groups associated with the supervised service. Remark: The net wait time is the time spent by the task waiting in the service, while the schedule associated with the service is open and while the service is started in automatic or mixed mode. Caution: This indicator is not completed if the distribution mode defined for the service is: manual.
MLWAITAVG	STAT - Average net wait time	Total of all net wait time of emails to validate, divided by the number of emails to validate. Average net wait time = Total of all NET WAIT TIME OF EMAILS TO VALIDATE / Number of emails TO VALIDATE Remark: The net wait time is the time spent by the task waiting in the service, while the schedule associated with the service is open and while the service is started in automatic or mixed mode. Caution: This indicator is not completed if the distribution mode defined for the service is: manual.
WORKMLAVG	STAT - Average work time	Total time spent by agents working on emails to validate, divided by the number of emails to validate offered to the agents belonging to the main and additional distribution groups associated with the supervised service. Average work time = Total time spent WORKING on offered emails / Number of OFFERED emails Caution: Calls made while working on emails using the service to which belong these emails are included in this work time.
NBTASKSCLOSEDHOUR	STAT - Number of tasks processed in an hour	Number of emails to validate handled and closed in the service during the last hour (rolling hour).
NBMLNODIST	STAT - Number of non-distributed emails	Number of emails to validate, that have not been distributed because: ✓ The email has been automatically transferred, once the maximum wait time has been reached (Maximum wait time and Transfer to a service settings, in the Script tab of the service), ✓ The email has been transferred or directly deleted from the list of emails (Monitoring > Supervision view menu > Start button > List of emails).
NBMLSUBMIT	STAT - Number of offered emails	Number of emails to validate offered to agents, whatever the work result, validation or postponement. Number of offered emails = Number of VALIDATED emails + Number of POSTPONED emails Remark: In a validation service, an offered email can be postponed because: ✓ The postponement function has been used, ✓ The email window has been closed, ✓ Or because this email has remained open more than 2 hours.
NBMLCLOSED	STAT - Number of validated emails	Number of emails that have been validated.

Agent out emails

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Label	Description
CLRIGHTNOW	ACTUAL - Number of calls in progress	Number of on going phone calls while working on agent out emails.
MLRIGHTNOW	ACTUAL - Number of emails being processed	Number of agent out emails currently being handled by the agents belonging to the main and additional distribution groups associated with the supervised service.
WORKMLAVG	STAT - Average work time	Total time spent working on generated agent out emails, divided by the number of generated agent out emails. Average work time = Total time spent WORKING on GENERATED agent out emails / Number of GENERATED agent out emails Caution: Calls made while working on emails using the service to which belong these emails are included in this work time.
OUTCLDONE	STAT - Number of outbound calls	Number of outbound calls made by the agents belonging to the main and additional distribution groups associated with the supervised service while working on agent out emails from this service. Caution: Outbound calls made using an agent out call service are not included in this total.
CONFDONE	STAT - Number of conference calls made	Number of conference calls made by the agents belonging to the main and additional distribution groups associated with the supervised service while working on an agent out email.
CONSDONE	STAT - Number of consultation calls made	Number of consultation calls made the agents belonging to the main and additional distribution groups associated with the supervised service while working on agent out emails.
TRSFAGTDONE	STAT - Number of transfers to agent	Number of calls transferred after a consultation call.
TRSFNUMDONE	STAT - Number of transfers to number	Number of calls transferred using the Transfer to a number option.
TRSFSVCDONE	STAT - Number of transfers to a service	Number of calls transferred using the Transfer to a service option.
MLWITHCL	STAT - Number of emails that generated an outbound call	Number of agent out emails, during which a call was made by the agents belonging to the main and additional distribution groups associated with the supervised service.
MLWITHTRANS	STAT - Number of emails that generated a service transfer	Number of agent out emails transferred to another Kiamo service.
NBMLSENT	STAT - Number of sent emails	Number of agent out emails that have been sent by the agents belonging to the main and additional distribution groups associated with the supervised service. This number includes agent out emails that have been sent again and internal emails.
EGENERETATED	STAT - Number of generated emails	Number of agent out emails generated whatever the work result: sending, saving or cancelling the email.
NBMLTRFSVC	STAT - Number of agent out internal emails	Number of agent out emails sent with a Kiamo service as recipient.
MLTOVALID	STAT - Number of outbound emails sent to validation	Number of agent out emails sent, which have been directed to an email validation service.
QUALIFICATION	STAT - Number of qualifications	Number of times the main and/or automatic-type qualification(s) selected in the supervision block have been given.

Inbound messages

Remark: A Messaging type interaction is a message thread sent by the same contact and containing the answers sent via the Kiwi application by one or more agents. Whatever the type of message sent by the contact, all his/her messages will be grouped together in th e same interaction if the contact has been identified in Kiamo (for instance, by using his/her Facebook ID, Twitter ID, LinkedIn ID, phone number, etc.).
If the contact has not been identified in Kiamo, an interaction per message type will be displayed for this contact (e.g.: an interaction for text messages, an interaction for Facebook type messages).

Key	Label	Description
MGRTWAITMAXBRUT	ACTUAL - Maximum gross wait time	Longest gross time spent waiting by a Messaging-type interaction, among all the time spent waiting by Messaging-type interactions to process. Remark: The gross wait time is the time spent waiting by the task in the service, whatever the distribution mode defined for the service (automatic, manual, mixed or no distribution) and whatever the status of the schedule associated with the service (open or closed).
NBAGTACTIVE	ACTUAL - Number of active agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are logged in and who may be assigned tasks. ✓ either straight away because they are Ready ✓ either when they go back to the Ready status after being in one of the following system statuses: reserved, talking to a customer, wrap-up, mandatory break, task handling, consultation, conference call, or internal call; ✓ or when they go back to the Ready status if they are in an available personalized status (with the Available status option enabled).
NBAGTPAUSE	ACTUAL - Number of agents in Break status	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are in one of the personalized break statuses, in the standard break status and in the _Anomaly_-system status.
NBAGTLOG	ACTUAL - Number of logged-in agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are logged in, whatever their status.
NBAGTREADY	ACTUAL - Number of ready agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are in the Ready status who may be assigned tasks straight away.
MGCLRIGHTNOW	ACTUAL - Number of calls in progress in a Messaging service	Number of calls in progress made by the agents belonging to the main and additional distribution groups associated with the supervised service while working on the Messaging-type interactions of the service, using the service to which belong these interactions. Remark: Outbound calls made using an Agent out call service are not included.
MGNOTCLOSED	ACTUAL - Number of interactions to process	Number of Messaging-type interactions to process in the service whether or not they are in the “task queue”.
MGRIGHTNOW	ACTUAL - Number of interactions being processed	Number of Messaging-type interactions of the service being offered to the agents belonging to the main and additional distribution groups associated with the supervised service.
MGWAIT	ACTUAL - Number of queued interactions	Number of Messaging-type interactions that are in the service queue. Messaging-type interactions are included in the “queue” when the service is started in automatic or mixed mode, and: ✓ If a schedule is associated with the selected service, during the opening hours of the schedule; ✓ If no schedule is associated with the service, they will always be included in the service queue. Caution: This indicator is not completed if the distribution mode defined for the service is: manual. Remark: Interactions with a processing date scheduled in the past are included in the service queue whereas interactions with a processing date scheduled in the future are not. These are counted in this total as soon as the processing date and time are reached.
MGCLOSEDAVG	STAT - Average closing time (gross wait + agent work)	The average closing time is the total time spent processing and closing Messaging-type interactions, divided by the number of closed Messaging-type interactions. Average closing time = Total of ALL CLOSING TIME / Number of CLOSED interactions Remark : The closing time is the gross wait time, to which is added all the time spent by agent(s) working on this interaction. Remark: The gross wait time is the time spent by the task waiting in the service, whatever the distribution mode defined for the service (automatic, manual, mixed or no distribution) and whatever the status of the schedule associated with the service (open or closed).
MGWAITMAX	STAT - Maximum net wait time	Longest net time spent waiting by a Messaging-type interaction, among all the net time spent waiting by offered interactions. Remark: The net waiting time is the waiting time while the schedule associated with the service is open and while the service is “started” in automatic or mixed mode. Caution: This indicator is not completed if the distribution mode defined for the service is: manual.
MGWAITMIN	STAT - Minimum net wait time	Shortest net time spent waiting by a Messaging-type interaction, among all the time spent waiting by offered interactions. Remark: The net waiting time is the waiting time while the schedule associated with the service is open and while the service is “started” in automatic or mixed mode. Caution: This indicator is not completed if the distribution mode defined for the service is: manual.
MGWAITAVG	STAT - Average net wait time	Total net time spent waiting by offered a Messaging-type interaction, divided by the number of offered interactions. Average wait time = Total NET TIME SPENT WAITING BY OFFERED INTERACTIONS / Number of OFFERED interactions Remark: The net waiting time is the waiting time while the schedule associated with the service is open and while the service is “started” in automatic or mixed mode. Caution: This indicator is not completed if the distribution mode defined for the service is: manual.
WORKMGAVG	STAT - Average work time	Total time spent working on offered Messaging-type interactions, divided by the number of interactions offered. Average work time = Total time spent WORKING on offered interactions / Number of OFFERED interactions Caution: All calls made while working on Messaging-type interactions using the service to which belong these interactions are included in this total.
MGOUTCLDONE	STAT - Number of outbound calls	Number of outbound calls made using the service to which belong these interactions, while working on Messaging-type interactions. Remark: Outbound calls made using an agent out call service are not included in this total.
NBMGSENT	STAT - Number of sent messages	Number of messages offered to the agents belonging to the main and additional distribution groups associated with the supervised service that resulted in a message being sent as answer.
NBMGRECV	STAT - Number of messages received	Number of messages received in the supervised service. Caution: A message can only be received once in a service, but can be offered several times, when the postponement function is used. This explains why the number of received messages can be inferior to the number of offered messages.
NBTASKSCLOSEDHOUR	STAT - Number of tasks processed in an hour	Number of Messaging-type interactions processed and closed in the service, during the last hour (rolling hour).
NBMGREPR	STAT - Number of postponed interactions	Number of Messaging-type interactions that have been postponed because: ✓ The agent used the postponement function, ✓ The interaction remained open more than 2 hours. Caution: Postponed interactions are not closed.
NBMGNEWINTERACTION	STAT - Number of created interactions	Number of new Messaging-type interactions created in the service for a new contact, whatever the work result: closing or postponement. Remark: A new contact is a contact that has not been identified in the Kiamo software. See the definition of an interaction above.
NBMGNODIST	STAT - Number of non-distributed interactions	Number of Messaging-type interactions in the service that could not be distributed because: ✓ The queued interaction has been automatically transferred, once the maximum waiting time has been reached (Maximum wait time and Transfer to a service settings, in the Script tab of the service). ✓ The queued interaction has been transferred to another service after going through a _Transfer to a service_-type processing function (Script tab, Duration in the queue section - Transfer to a service processing function). ✓ The interaction has been closed in the Search or Messages to process menu of the Kiwi application (use of the Close button).
NBMGNSUBMIT	STAT - Number of interactions offered	Number of Messaging-type interactions that have been offered to the agents belonging to the main and additional distribution groups associated with the supervised service (automatically or opened manually), whatever the work result: closing or postponement. Number of interactions offered = Number of HANDLED interactions + Number of POSTPONED interactions
NBMGCLOSED	STAT - Number of handled interactions	Number of Messaging-type interactions that have been handed and closed by the agents belonging to the main and additional distribution groups associated with the supervised service.
MGCLOSEDLTH3	STAT - Number of interactions processed after threshold 3	Number of Messaging-type interactions that have been handled after the third threshold. Remark: These thresholds cannot be configured in the Kiamo main interface. Threshold 3 value: 86400 seconds (= 24 hours).
MGCLOSEDLTH1	STAT - Number of interactions processed before threshold 1	Number of Messaging-type interactions that have been handled before the first threshold Remark: These thresholds cannot be configured in the Kiamo main interface. Threshold 1 value: 3600 seconds (= 1 hour).
MGCLOSEDLTH1TH2	STAT - Number of interactions handled between threshold 1 and threshold 2	Number of Messaging-type interactions that have been handled between the first and second thresholds. Remark: These thresholds cannot be configured in the Kiamo main interface . Value: ✓ Threshold 1: 3600 seconds (= 1 hour). ✓ Threshold 2: 14400 seconds (= 4 hours).
MGCLOSEDLTH2TH3	STAT - Number of interactions handled between threshold 2 and threshold 3	Number of Messaging-type interactions that have been handled between the second and third thresholds Remark: These thresholds cannot be configured in the Kiamo main interface. Value: ✓ Threshold 2: 14400 seconds (= 4 hours). ✓ Threshold 3: 86400 seconds (= 24 hours).
QUALIFICATION	STAT - Number of qualifications	Number of times the main and/or automatic-type qualification(s) selected in the supervision block have been given.

Chat Scripts

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Label	Description
HNBSESSABANDONED	HISTO - Number of abandoned sessions	Number of chat sessions received in the script that have ended the customer ended the session or the chat script came to an end) without being processed by a Success, Service transfer or Reason for non-distribution block.
HNBSESSRECEIVED	HISTO - Number of received sessions	Number of chat sessions received in the script, whether they are considered as successful, abandoned or non-distributed.
RNBCHATNODISTRIB	ACTUAL - Number of non-distributed chat sessions	Number of chat sessions that have ended in the script, after being processed by a Reason for non-distribution block. Non-distribution reasons available in chat scripts are: hours closed, not enough agents, saturated queue, maximum wait time reached, voluntary removal and other condition. Number of non-distributed chat sessions = Number of sessions - NO AGENT + Number of sessions - SATURATED QUEUE + Number of sessions - MAX TIME REACHED + Number of sessions - HOURS CLOSED + Number of ND sessions - VOLUNTARY REMOVAL + Number of ND sessions - OTHER CONDITION
RNBCHATSESSWORK	ACTUAL - Number of chat sessions in progress	Number of chat sessions currently being processed in the selected Chat script service.
RNBCHATRECEIVED	ACTUAL - Number of received chat sessions	Number of chat sessions received in the script, whether they are considered as successful, abandoned or non-distributed.
RNBTRANSFER	ACTUAL - Number of service transfers	Number of chat sessions received in the script that have been transferred to an Agent chat- or a Chat script-type service using a Service transfer block. Remark: These sessions are automatically qualified as successful, without having to use a Success type block to qualify the session processing in the script.
RPERCHATABANDONED	ACTUAL - Percentage of abandoned sessions	Percentage of chat sessions received in the script in relation to the number of chat sessions received in the selected service that have ended (the customer ended the session or the chat script came to an end) without being processed by a Success, Service transfer or Reason for non-distribution block. Percentage of abandoned chat sessions = ( Number of ABANDONED sessions / Number of RECEIVED sessions ) x 100
RPERCHATSUCCESS	ACTUAL - Percentage of success	Percentage of chat sessions received in the chat script that have been qualified as successful. It includes the chat sessions that have been qualified as successful in a _Success_-type block available in the chat script and the sessions transferred to another Kiamo service, without having to use a _Success_-type block to qualify the session processing in the script. Percentage of success = ( ( Number of received chat sessions qualified as SUCCESSFUL + Number of chat sessions received and transferred ) / ( Number of RECEIVED chat sessions ) ) X 100
NBCHATNODISTRIB	STAT - Number of non-distributed chat sessions	See the ACTUAL-type definition.
NBCHATRECEIVED	STAT - Number of received sessions	See the ACTUAL-type definition.
NBTRANSFER	STAT - Number of service transfers	See the ACTUAL-type definition.
PERCHATABANDONED	STAT - Percentage of abandoned sessions	See the ACTUAL-type definition.
PERCHATSUCCESS	STAT - Percentage of success	See the ACTUAL-type definition.
MAXCHATSESSDUR	STAT - Maximum chat session time	Longest chat session, among all the chat sessions processed in the selected chat script.
MOYCHATSESSDUR	STAT - Average chat session time	This average time takes into account the processing time of all the chat sessions received in the selected Chat script service, including abandoned and non-distributed sessions. Average processing time = Total time spent processing RECEIVED chat sessions / Number of RECEIVED chat sessions
QUALIFICATION	STAT - Number of qualifications	Number of times the main and/or automatic-type qualification(s) selected in the supervision block have been given.

Agent Chat

Key	Label	Description
NBAGTACTIVE	ACTUAL - Number of active agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are logged in and who may be assigned tasks: ✓ either straight away because they are Ready ✓ either when they go back to the Ready status after being in one of the following system statuses: reserved, talking to a customer, wrap-up, mandatory break, task handling, consultation, conference call, or internal call; ✓ or when they go back to the Ready status if they are in an available personalized status (with the Available status option enabled).
NBAGTPAUSE	ACTUAL - Number of agents in Break statuses	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are in one of the personalized break statuses, in the standard break status and in the _Anomaly_-system status.
NBAGTLOG	ACTUAL - Number of logged in agents	Number of agents belonging to the main and additional distribution groups as sociated with the supervised service who are logged in, whatever their status.
NBAGTREADY	ACTUAL - Number of ready agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are in the Ready status who may be assigned a task straight away.
RNBCHATAGENTDISC	ACTUAL - Number of agent logouts	Number of Chat sessions closed by the agents belonging to the main and additional distribution groups associated with the supervised service.
RNBCHATCUSTDISC	ACTUAL - Number of customer logouts	Number of Chat sessions in the selected service closed by customers.
RNBCHATABANDONED	ACTUAL - Number of abandoned Chat sessions	Number of Chat sessions closed by customers before being put in relation with an agent.
RNBCHATNODIST	ACTUAL - Number of non-distributed Chat sessions	Total of all the Chat sessions transferred and closed while they were in the service “queue”. A non-distributed Chat session is a queued session that has been closed after a deterrence message has been automatically sent to the customer or a queued session that has been transferred, which corresponds to the following processing options in the Script tab of the service: ✓ Closed schedule test with the Deterrence message action selected, ✓ Maximum wait time with the Deterrence message action selected, ✓ Deterrence message, ✓ Closed schedule test with the Transfer to a service action selected, ✓ Maximum wait time with the Transfer to a service action selected, ✓ and Transfer to a service.
RNBCHATSESSWAIT	ACTUAL - Number of queued Chat sessions	Number of Chat sessions waiting to be handled in the selected service.
RNBCHATSESSWORK	ACTUAL - Number of Chat sessions in progress	Number of on-going Chat sessions between customers and agents.
RNBCHATRECEIVED	ACTUAL - Number of Chat sessions received	Number of Chat sessions received in the selected service, including all Chat sessions offered to agents and all unprocessed Chat sessions (abandoned Chat sessions + non-distributed Chat sessions).
RNBCHATHANDLED	ACTUAL - Number of processed Chat sessions	Number of Chat sessions offered, handled and closed by the agents belonging to the main and additional distribution groups associated with the supervised service.
RMAXCHATSESSWAIT	ACTUAL - Number of Chat sessions handled	Number of Chat sessions offered, handled and closed by the agents belonging to the main and additional distribution groups associated with the supervised service.
RMOYCHATSESSWAIT	ACTUAL - Average wait time	Total wait time of all the Chat sessions handled by the agents belonging to the main and additional distribution groups associated with the supervised service , divided by the number of handled Chat sessions. Average wait time = Total WAIT TIME OF ALL HANDLED CHAT SESSIONS / Number of HANDLED Chat sessions
NBCHATAGENTDISC	STAT - Number of agent logouts	See the ACTUAL-type definition.
NBCHATCUSTDISC	STAT - Number of customer logouts	See the ACTUAL-type definition.
NBCHATABANDONED	STAT - Number of abandoned Chat sessions	See the ACTUAL-type definition.
NBCHATNODIST	STAT - Number of non distributed Chat sessions	See the ACTUAL-type definition.
NBCHATRECEIVED	STAT - Number of Chat sessions received	See the ACTUAL-type definition.
NBCHATHANDLED	STAT - Number of processed Chat sessions	See the ACTUAL-type definition.
NBTASKSCLOSEDHOUR	STAT - Number of tasks processed in an hour	Number of chat sessions handled and closed in the service during the last hour (rolling hour).
MAXCHATSESSWAIT	STAT - Maximum wait time	See the ACTUAL-type definition.
MAXCHATSESSWAITABAND	STAT - Maximum wait time before leaving the queue	Longest time spent waiting by a Chat session, among all the time spent waiting by Chat sessions that have been abandoned by customers.
MAXCHATSESSDUR	STAT - Maximum Chat session time	Longest Chat session, among all the Chat sessions handled and closed by the agents belonging to the main and additional distribution groups associated with the supervised service.
MINCHATSESSWAIT	STAT - Minimum wait time	Shortest time spent waiting by a Chat session, among all the time spent waiting by Chat sessions offered to the agents belonging to the main and additional distribution groups associated with the supervised service.
MINCHATSESSWAITABAND	STAT - Minimum wait time before abandonment	Shortest time spent waiting by a Chat session, among all the time spent waiting by Chat ses sions that have been abandoned by customers.
MINCHATSESSDUR	STAT - Minimum Chat session time	Shortest Chat session, among all the Chat sessions handled and closed by the agents belonging to the main and additional distribution groups associated with the supervised service.
MOYCHATSESSWAIT	STAT - Average wait time	See the ACTUAL-type definition.
MOYCHATSESSWAITABAND	STAT - Average wait time before leaving the queue	Total wait time of all the abandoned Chat sessions, divided by the number of abandoned Chat sessions. Average wait time = Total of all WAIT TIME OF ABANDONED CHAT SESSIONS / Number of ABANDONED Chat sessions
MOYCHATSESSDUR	STAT - Average Chat session time	Total time spent handling Chat sessions, divided by the number of Chat sessions handled. Average Chat session time = Total time WORKING on HANDLED chat sessions / Number of HANDLED chat sessions
TOTALCHATSESSDUR	STAT - Total Chat time	Total time spent handling the Chat sessions offered and closed by the agents belonging to the main and additional distribution groups associated with the supervised service.
QUALIFICATION	STAT - Number of qualifications	Number of times the main and/or automatic-type qualification(s) selected in the supervision block have been given.

Task distribution

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Label	Description
MLRTWAITMAXBRUT	ACTUAL - Maximum gross wait time	Longest gross time spent waiting by a custom task, among all the time spent waiting by custom tasks. Remark: The gross wait time is the time spent by the task waiting in the service, whatever the distribution mode defined for the service (automatic, manual, mixed or no distribution) and whatever the status of the schedule associated with the service (open or closed).
NBAGTACTIVE	ACTUAL - Number of active agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are logged in and who may be assigned tasks: ✓ either straight away because they are Ready ✓ either when they go back to the Ready status after being in one of the following system statuses: reserved, talking to a customer, wrap-up, mandatory break, task handling, consultation, conference call, or internal call; ✓ or when they go back to the Ready status if they are in an available personalized status (with the Available status option enabled).
NBAGTPAUSE	ACTUAL - Number of agents in Break statuses	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are in one of the personalized break statuses, in the standard break status and in the _Anomaly_-system status.
NBAGTLOG	ACTUAL - Number of logged in agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are logged in, whatever their status.
NBAGTREADY	ACTUAL - Number of ready agents	Number of agents belonging to the main and additional distribution groups associated with the supervised service who are in the Ready status who may be assigned tasks straight away.
CLRIGHTNOW	ACTUAL - Number of calls in progress	Number of on-going phone calls while working on custom tasks from this service.
FILENOTCLOSED	ACTUAL - Number of tasks to process	Number of custom tasks to process in the selected Task distribution service, whether they are or not in the service \"queue\".
CURRENTFILES	ACTUAL - Number of tasks being processed	Number of custom tasks of the service that are currently being offered to and handled by the agents belonging to the main and additional distribution groups associated with the supervised service.
FILEWAIT	ACTUAL - Number of queued tasks	Number of custom tasks in the service queue. Tasks are included in the “queue” when the service is started in automatic or mixed mode, and: ✓ If a schedule is associated with the selected service, during the opening hours of the schedule; ✓ If no schedule is associated with the service, they will always be included in the service queue. Caution: This indicator is not completed if the distribution mode defined for the service is: manual.
AVGWORKFILE	STAT - Average work time	Total time spent working on closed and postponed custom tasks, divided by the number of custom tasks processed by the agents belonging to the main and additional distribution groups associated with the supervised service. Average work time = Total time spent WORKING on CLOSED tasks + Total time spent WORKING on POSTPONED tasks / Number of PROCESSED tasks Caution: Calls made while working on custom tasks using the service to which belong these custom tasks are included in this work time.
CLOUTDONEFILE	STAT - Number of successful calls	Number of successful outbound calls while working on the custom tasks of the service. Caution: Calls made using an Agent out call service are not included in this total.
CLOUTTRYFILE	STAT - Number of call attempts	Number of outbound call attempts made while working on the custom tasks of the service. Caution: Calls made using an Agent out call service are not included in this total.
NBFILECLOSED	STAT - Number of closed tasks	Number of custom tasks closed with the result: \"Handled task\". Remark: Closing a custom task is the expected work result.
NBTASKSCLOSEDHOUR	STAT - Number of custom tasks processed in an hour	Number of custom tasks processed and closed in the service during the last hour (rolling hour).
QUALIFICATION	STAT - Number of qualifications	Number of times the main and/or automatic-type qualification(s) selected in the supervision block have been given.

Automatic processing

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Label	Description
NBAUTOMATEDTASKCLOSED	STAT - Number of closed tasks	Number of custom tasks processed by the script associated with the selected service without being transferred to another Kiamo service.
NBAUTOMATEDTASKRECEIVED	STAT - Number of received tasks	Number of custom tasks received in the automatic processing service selected, whatever the processing result, closing or transfer.
NBAUTOMATEDTASKTRANSFERED	STAT - Number of transferred tasks	Number of custom tasks transferred to another Kiamo service for processing.
QUALIFICATION	STAT - Number of qualifications	Number of times the main and/or automatic-type qualification(s) selected in the supervision block have been given.

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"acd03735-e732-486b-b655-db4693b4c22d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"9f29ef35-4a20-41a9-a848-219875f0c986"}}],"_postman_id":"14fa319d-cd0b-48be-bf9e-7889ecb34302"},{"name":"schedules","item":[{"name":"Get Schedule","id":"4fcaec0d-7f89-47c5-ac6c-2f7a0d0c0415","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Kiamo-Api-Token","value":"{{token-schedule}}","type":"text"}],"url":"{{api_base_url}}/schedules/:id","description":"

Retrieve the given schedule.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Data Type
id	integer

Response

If the query is successful, the schedule information is returned.

{\n    \"id\": integer,\n    \"label\": string,\n    \"description\": string,\n    \"timezone\": string,\n    \"group\": integer,\n    \"weeklyOpenings\": [\n        {\n            \"startWeekDay\": integer,\n            \"startHour\": string,\n            \"endWeekDay\": integer,\n            \"endHour\": string\n        }\n    ],\n    \"specialOpenings\": [\n        {\n            \"label\": string,\n            \"start\": string,\n            \"end\": string\n        }\n    ],\n    \"specialClosings\": [\n        {\n            \"label\": string,\n            \"start\": string,\n            \"end\": string\n        }\n    ]\n}\n\n

Example

{\n    \"id\": 1,\n    \"label\": \"New_Schedule_1\",\n    \"description\": \"Description\",\n    \"timezone\": \"Europe/Paris\",\n    \"group\": 1,\n    \"weeklyOpenings\": [\n        {\n            \"startWeekDay\": 2,\n            \"startHour\": \"08:00\",\n            \"endWeekDay\": 2,\n            \"endHour\": \"12:00\"\n        }\n    ],\n    \"specialOpenings\": [\n        {\n            \"label\": \"Opening\",\n            \"start\": \"2026-03-05 14:00\",\n            \"end\": \"2026-03-05 16:00\"\n        }\n    ],\n    \"specialClosings\": [\n        {\n            \"label\": \"Closing\",\n            \"start\": \"2026-03-05 14:30\",\n            \"end\": \"2026-03-05 18:30\"\n        }\n    ]\n}\n\n

\n","urlObject":{"path":["schedules",":id"],"host":["{{api_base_url}}"],"query":[],"variable":[{"description":{"content":"

Id of schedule

\n","type":"text/plain"},"type":"any","value":"{{schedule_id}}","key":"id"}]}},"response":[],"_postman_id":"4fcaec0d-7f89-47c5-ac6c-2f7a0d0c0415"},{"name":"Get Schedules","id":"e1909c02-4eb2-48a7-a00a-6e8dcc445029","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Kiamo-Api-Token","value":"{{token-schedule}}","type":"text"}],"url":"{{api_base_url}}/schedules","description":"

Retrieve all the schedules in a paginated format.

Response

If the query is successful, the list of all schedules is returned (empty list if no match).

{\n    \"data\": [\n        {\n            \"id\": integer,\n            \"label\": string,\n            \"description\": string,\n            \"group\": integer\n        },\n        {\n            \"id\": integer,\n            \"label\": string,\n            \"description\": string,\n            \"group\": integer\n        }\n    ],\n    \"meta\": {\n        \"cursor\": {\n            \"current\": integer,\n            \"prev\": integer,\n            \"next\": integer,\n            \"count\": integer\n        }\n    }\n}\n\n

Example

{\n    \"data\": [\n        {\n            \"id\": 1,\n            \"label\": \"New_Schedule_1\",\n            \"description\": null,\n            \"group\": 1\n        },\n        {\n            \"id\": 2,\n            \"label\": \"New_Schedule_2\",\n            \"description\": \"Description\",\n            \"group\": 2\n        },\n        {\n            \"id\": 3,\n            \"label\": \"New_Schedule_3\",\n            \"description\": \"Description 3\",\n            \"group\": 1\n        }\n    ],\n    \"meta\": {\n        \"cursor\": {\n            \"current\": 1,\n            \"prev\": null,\n            \"next\": 2,\n            \"count\": 20\n        }\n    }\n}\n\n

\n","urlObject":{"path":["schedules"],"host":["{{api_base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e1909c02-4eb2-48a7-a00a-6e8dcc445029"}],"id":"c869bc3c-9ab5-4bfd-96cc-750f2892d880","description":"

SCHEDULE API

The Schedule API is used to retrieve one or more schedules.

Please note: kiamopackage/admin 2.4.0 is required.

\n","_postman_id":"c869bc3c-9ab5-4bfd-96cc-750f2892d880"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"8b2a1082-9750-4857-8400-a875ba3ae9b3"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"9358fc03-ba14-4027-8f51-76e9e096d19e"}}]}