{"info":{"_postman_id":"b569ab9c-3919-430b-949e-1afc7d825c8c","name":"Sedric Public API","description":"

Getting Started

To ensure the security of our data and services, all Sedric API requests require a valid API Key.

Missing a key? Please contact support@sedric.ai to request access. Our team will provide you with the necessary credentials to begin your integration.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"18938433","collectionId":"b569ab9c-3919-430b-949e-1afc7d825c8c","publishedId":"UVXknv4S","public":true,"customColor":{"top-bar":"7149FD","right-sidebar":"303030","highlight":"FF7F6F"},"publishDate":"2022-08-01T07:34:15.000Z"},"item":[{"name":"Communication Compliance","item":[{"name":"Upload Interactions","item":[{"name":"Voice interactions","item":[{"name":"Upload by pull","item":[{"name":"Recording - Upload Pull","event":[{"listen":"test","script":{"id":"c3752914-8c41-462c-8e0f-9e48eb542450","exec":["pm.test(\"Status code is 202\", function () {"," pm.response.to.have.status(202);","});","","pm.test(\"Set URL\", function () {"," const jsonData = pm.response.json();"," const url = jsonData.url;"," pm.collectionVariables.set(\"storageUploadPUTUrl\", url);","","});","","pm.test(\"Validate Get URL\", function () {"," console.log(pm.collectionVariables.get(\"storageUploadPUTUrl\"));","});","","","pm.test(\"Set PUT request params\", function () {"," const jsonData = pm.response.json();"," for (let k in jsonData.headers) {"," console.log(k)"," pm.collectionVariables.set(k, jsonData.headers[k]);"," } ","});","",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"e89f90ce-0e6f-4c22-8786-ce18c8aab81f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\": \"user_id\",\n \"prospect_id\": \"prospect_id\",\n \"unit_id\": \"unit_id\",\n \"organization_id\": \"organization_id\",\n \"source\": \"SOURCE\",\n \"external_interaction_id\": \"aaa-2021-12-19T10:47:55Z\",\n \"topic\": \"topic\",\n \"recording_type\": \"mp3\",\n \"timestamp\": \"2021-12-19T10:47:55Z\",\n \"metadata\": {},\n \"api_key\": \"api key\",\n \"download_url\": \"\",\n \"download_token\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_recording_uri","description":"

this method of uploading calls pulls the calls from the provided costumer download_url

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

Variable	Type	Description	Example	mandatory
user_id	string	User id		yes
prospect_id	string	The ID of the customer/prospect with whom the call took place.		yes
unit_id*	string	The unit ID in the organization		conditional *(mandatory if no organization_id)
organization_id*	string	The organization ID		conditional *(mandatory if no unit_id)
source	string	The source of the recording		no
external_interaction_id	string	The interaction ID as it is saved in the customers DB. This is an optional debugging aid for the customer's developers to have a shared language with		no
download_url	string($url)			yes
download_token	string			yes
recording_type	Enum	Type of file to be uploaded	mp3, mp4, wav	yes
timestamp	string($datetime)		2020-08-12T19:12:56Z	yes
topic	string	The way the call will be displayed		yes
metadata	{}	Optional - Additional metadata to be attached to the recording.		no
discardable_timespans	positive intager	Timespans that would be removed from the conversation (e.g. usefull for IVR removal).		no
api_key	string	Unit api key		yes

","urlObject":{"protocol":"https","path":["api_recording_uri"],"host":["us-central1-sedric-prod","cloudfunctions","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"e89f90ce-0e6f-4c22-8786-ce18c8aab81f"},{"name":"Recording - Upload Pull - Async","event":[{"listen":"test","script":{"id":"c3752914-8c41-462c-8e0f-9e48eb542450","exec":["pm.test(\"Status code is 202\", function () {"," pm.response.to.have.status(202);","});","","pm.test(\"Set URL\", function () {"," const jsonData = pm.response.json();"," const url = jsonData.url;"," pm.collectionVariables.set(\"storageUploadPUTUrl\", url);","","});","","pm.test(\"Validate Get URL\", function () {"," console.log(pm.collectionVariables.get(\"storageUploadPUTUrl\"));","});","","","pm.test(\"Set PUT request params\", function () {"," const jsonData = pm.response.json();"," for (let k in jsonData.headers) {"," console.log(k)"," pm.collectionVariables.set(k, jsonData.headers[k]);"," } ","});","",""],"type":"text/javascript","packages":{}}}],"id":"14ddb575-79bc-4e46-8166-2eba85790dc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\": \"user_id\",\n \"prospect_id\": \"prospect_id\",\n \"unit_id\": \"unit_id\",\n \"organization_id\": \"organization_id\",\n \"source\": \"SOURCE\",\n \"external_interaction_id\": \"aaa-2021-12-19T10:47:55Z\",\n \"topic\": \"topic\",\n \"recording_type\": \"mp3\",\n \"timestamp\": \"2021-12-19T10:47:55Z\",\n \"metadata\": {},\n \"api_key\": \"api key\",\n \"download_url\": \"\",\n \"download_token\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/async_recording_v2","description":"

This endpoint serves as an asynchronous alternative to the Upload Pull

Calling this endpoint is best recommended when the audio file might not be immediately available in the provided url, but rather after a delay period.

The response will be returned immediately and regardless to the download phase.

Variable	Type	Description	Example	mandatory
user_id	string	User id		yes
prospect_id	string	The ID of the customer/prospect with whom the call took place.		yes
*unit_id	string	The unit ID in the organization		conditional *(mandatory if no organization_id)
*organization_id	string	The organization ID		no *(mandatory if no unit_id)
source	string	The source of the recording		no
external_interaction_id	string	The interaction ID as it is saved in the customers DB. This is an optional debugging aid for the customer's developers to have a shared language with		no
download_url	string($url)			yes
download_token	string			yes
recording_type	Enum	Type of file to be uploaded	mp3, mp4, wav	yes
timestamp	string($datetime)		2020-08-12T19:12:56Z	yes
topic	string	The way the call will be displayed		yes
metadata	{}	Optional - Additional metadata to be attached to the recording.		no
discardable_timespans	positive intager	Timespans that would be removed from the conversation (e.g. usefull for IVR removal).		no
api_key	string	Unit api key		yes

","urlObject":{"protocol":"https","path":["async_recording_v2"],"host":["us-central1-sedric-prod","cloudfunctions","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"14ddb575-79bc-4e46-8166-2eba85790dc0"}],"id":"8b91747c-d85d-4077-9b4c-4b7ebc7b2a39","_postman_id":"8b91747c-d85d-4077-9b4c-4b7ebc7b2a39","description":""},{"name":"Upload by push","item":[{"name":"Recording - Upload Push Stage 1","event":[{"listen":"test","script":{"id":"fa656c1a-c1b2-440f-be79-4dc130738d90","exec":["pm.test(\"Status code is 202\", function () {"," pm.response.to.have.status(202);","});","","pm.test(\"Set URL\", function () {"," const jsonData = pm.response.json();"," const url = jsonData.url;"," pm.collectionVariables.set(\"storageUploadPUTUrl\", url);","","});","","pm.test(\"Validate Get URL\", function () {"," console.log(pm.collectionVariables.get(\"storageUploadPUTUrl\"));","});","","","pm.test(\"Set PUT request params\", function () {"," const jsonData = pm.response.json();"," for (let k in jsonData.headers) {"," console.log(k)"," pm.collectionVariables.set(k, jsonData.headers[k]);"," } ","});","",""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"b83cf971-bbd7-432d-a982-26c6ffb042b3","exec":[""],"type":"text/javascript","packages":{}}}],"id":"9ef13f3b-c6c6-4b18-87c6-4f09b1354b10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_recording_uri","description":"

Upload push method

in this method of uploading calls to Sedric there are 2 steps or 2 separate api calls, the first one is to generate url for uploading the calls, the second api call is to upload the calls itself to the generated url, this is the first step in this method.

Types

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

Variable	Type	Description	Example	mandatory
user_id	string	User id		yes
prospect_id	string	The ID of the customer/prospect with whom the call took place.		yes
*unit_id	string	The unit ID in the organization		conditional *(mandatory if no organiztion_id)
*organization_id	string	The organization ID		conditional *(mandatory if no unit_id)
source	string	The source of the recording		no
external_interaction_id	string	The interaction ID as it is saved in the customers DB. This is an optional debugging aid for the customer's developers to have a shared language with		no
recording_type	Enum	Type of file to be uploaded	mp3, mp4, wav	yes
timestamp	string($datetime)		2020-08-12T19:12:56Z	yes
topic	string	The way the call will be displayed		yes
metadata	{}	Optional - Additional metadata to be attached to the recording.		no
discardable_timespans	positive intager	Timespans that would be removed from the conversation (e.g. usefull for IVR removal).		no
api_key	string	Unit api key		yes

","urlObject":{"protocol":"https","path":["api_recording_uri"],"host":["us-central1-sedric-prod","cloudfunctions","net"],"query":[],"variable":[]}},"response":[{"id":"acde4bd0-3e0a-493e-802c-323090a3ca21","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\": \"user_id\",\n \"prospect_id\": \"prospect_id\",\n \"unit_id\": \"unit_id\",\n \"organization_id\": \"organization_id\",,\n \"source\": \"SOURCE\",\n \"external_interaction_id\": \"1aaa-2021-12-19T10:47:55Z\",\n \"topic\": \"call's topic\",\n \"recording_type\": \"mp3/wav\",\n \"timestamp\": \"2021-12-19T10:47:55Z\",\n \"metadata\": {},\n \"api_key\": \"api_key\"\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_recording_uri"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Function-Execution-Id","value":"2e7be6u0eekr"},{"key":"X-Cloud-Trace-Context","value":"70349281dae2bbde64f2d9969f56681b"},{"key":"Date","value":"Wed, 05 Jan 2022 15:34:42 GMT"},{"key":"Server","value":"Google Frontend"},{"key":"Content-Length","value":"1680"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""}],"cookie":[],"responseTime":null,"body":"{\n \"url\": \"url\",\n \"headers\": {\n \"content-type\": \"audio/mpeg\",\n \"x-goog-meta-id\": \"\",\n \"x-goog-meta-topic\": \"new call from customer-of- \",\n \"x-goog-meta-timestamp\": \"2021-12-19T10:47:55Z\",\n \"x-goog-meta-user_id\": \"user_id\",\n \"x-goog-meta-prospect_id\": \"prospect_id\",\n \"x-goog-meta-recording_type\": \"mp3\",\n \"x-goog-meta-organization_id\": \"org id\",\n \"x-goog-meta-external_interaction_id\": \"\",\n \"x-goog-meta-unit_id\": \"\",\n \"x-goog-meta-language\": \"en-US\",\n \"x-goog-meta-audit\": \"{'api': {'start_time': '2022-01-05 15:34:42.786334'}}\",\n \"x-goog-meta-tasks\": \"{'exists': False}\",\n \"x-goog-meta-metadata\": \"{}\",\n \"x-goog-meta-kind\": \"{\\\"channel\\\": \\\"VOICE\\\", \\\"degree\\\": \\\"STANDALONE\\\"}\",\n \"x-goog-meta-status\": \"{\\\"primary\\\": \\\"ACCEPTED\\\", \\\"secondary\\\": \\\"\\\"}\"\n },\n \"data\": {\n \"user_id\": \"\",\n \"unit_id\": \"\",\n \"interaction_id\": \"\",\n \"external_interaction_id\": \"\",\n \"prospect_id\": \"\"\n }\n}"},{"id":"6cb2c701-1c57-4884-a541-6e1a9797f095","name":"409 Conflict","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\": \"{{user_id}}\",\n \"prospect_id\": \"customer-of-{{user_id}}\",\n \"unit_id\": \"{{unit_id}}\",\n \"organization_id\": \"{{organization_id}}\",\n \"source\": \"{{source}}\",\n \"external_interaction_id\": \"1aaa-2021-12-19T10:47:55Z\",\n \"topic\": \"new call from customer-of-{{user_id}}\",\n \"recording_type\": \"mp3\",\n \"timestamp\": \"2021-12-19T10:47:55Z\",\n \"metadata\": {},\n \"api_key\": \"{{api_key}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_recording_uri"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Function-Execution-Id","value":"7uqj8dkv8kdq"},{"key":"X-Cloud-Trace-Context","value":"db27a75535ec0b4403cc52148ac25fba;o=1"},{"key":"Date","value":"Sat, 08 Jan 2022 14:50:50 GMT"},{"key":"Server","value":"Google Frontend"},{"key":"Content-Length","value":"282"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""}],"cookie":[],"responseTime":null,"body":"{'msg': 'Duplicate interaction', 'error': \"DuplicateInteraction({'msg': 'Duplicate interaction', 'data': {'user_id': 'example', 'unit_id': 'example', 'interaction id': 'example', 'external_interaction_id': 'example'}})\"}"}],"_postman_id":"9ef13f3b-c6c6-4b18-87c6-4f09b1354b10"},{"name":"Recording - Upload Push Stage 2","event":[{"listen":"prerequest","script":{"id":"a78552ec-c54d-4ca9-8d12-dbc8ee2f2ba9","exec":["pm.environment.get(\"variable_key\");"],"type":"text/javascript"}},{"listen":"test","script":{"id":"7dcdd0fa-84c8-40c7-b168-592d6c2fdf2a","exec":[""],"type":"text/javascript"}}],"id":"0b6de5c7-6e57-4a3b-90db-1336cc73d909","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-goog-meta-id","value":"{{x-goog-meta-id}}","type":"text"},{"key":"content-type","value":"{{content-type}}","type":"text"},{"key":"x-goog-meta-topic","value":"{{x-goog-meta-topic}}","type":"text"},{"key":"x-goog-meta-user_id","value":"{{x-goog-meta-user_id}}","type":"text"},{"key":"x-goog-meta-timestamp","value":"{{x-goog-meta-timestamp}}","type":"text"},{"key":"x-goog-meta-audit","value":"{{x-goog-meta-audit}}","type":"text"},{"key":"x-goog-meta-language","value":"{{x-goog-meta-language}}","type":"text"},{"key":"x-goog-meta-organization_id","value":"{{x-goog-meta-organization_id}}","type":"text"},{"key":"x-goog-meta-recording_type","value":"{{x-goog-meta-recording_type}}","type":"text"},{"key":"x-goog-meta-prospect_id","value":"{{x-goog-meta-prospect_id}}","type":"text"},{"key":"x-goog-meta-unit_id","value":"{{x-goog-meta-unit_id}}","type":"text"},{"key":"x-goog-meta-status","value":"{{x-goog-meta-status}}","type":"text"},{"key":"x-goog-meta-kind","value":"{{x-goog-meta-kind}}","type":"text"},{"key":"x-goog-meta-metadata","value":"{{x-goog-meta-metadata}}","type":"text"},{"key":"x-goog-meta-tasks","value":"{{x-goog-meta-tasks}}","type":"text"},{"key":"x-goog-meta-external_interaction_id","value":"{{x-goog-meta-external_interaction_id}}","type":"text"}],"body":{"mode":"file","file":{"src":""}},"url":"","description":"

Second step of uploading calls to Sedric by uploading them to our generated url.

the headers are provided in the previous step.

\n","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[{"id":"7d42a8bb-a343-4b5a-bbdd-3ca1b91a0e45","name":"Upload Success","originalRequest":{"method":"PUT","header":[{"key":"x-goog-meta-id","value":"{{x-goog-meta-id}}","type":"text"},{"key":"content-type","value":"{{content-type}}","type":"text"},{"key":"x-goog-meta-topic","value":"{{x-goog-meta-topic}}","type":"text"},{"key":"x-goog-meta-user_id","value":"{{x-goog-meta-user_id}}","type":"text"},{"key":"x-goog-meta-timestamp","value":"{{x-goog-meta-timestamp}}","type":"text"},{"key":"x-goog-meta-audit","value":"{{x-goog-meta-audit}}","type":"text"},{"key":"x-goog-meta-language","value":"lang code","type":"text"},{"key":"x-goog-meta-organization_id","value":"org id","type":"text"},{"key":"x-goog-meta-recording_type","value":"mp3/wav","type":"text"},{"key":"x-goog-meta-prospect_id","value":"prospect id","type":"text"},{"key":"x-goog-meta-unit_id","value":"unit id","type":"text"},{"key":"x-goog-meta-status","value":"{{x-goog-meta-status}}","type":"text"},{"key":"x-goog-meta-kind","value":"{{x-goog-meta-kind}}","type":"text"},{"key":"x-goog-meta-metadata","value":"{{x-goog-meta-metadata}}","type":"text"},{"key":"x-goog-meta-tasks","value":"{{x-goog-meta-tasks}}","type":"text"},{"key":"x-goog-meta-external_interaction_id","value":"{{x-goog-meta-external_interaction_id}}","type":"text"}],"body":{"mode":"file","file":{},"options":{"raw":{"language":"json"}}},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"X-GUploader-UploadID","value":"ADPycduNrsdwaQ2k0j32IxbEqewUrIksG5pTHA4U_Wu9KOEyE8nR5o4wciY0W-aSfGt_Qk8QPa2QUQQ1lI5YbFf2Ark"},{"key":"ETag","value":"\"4588c4b7000ef6893e445fa8759279e5\""},{"key":"x-goog-generation","value":"1641654767643089"},{"key":"x-goog-metageneration","value":"1"},{"key":"x-goog-hash","value":"crc32c=8PSQng=="},{"key":"x-goog-hash","value":"md5=RYjEtwAO9ok+RF+odZJ55Q=="},{"key":"x-goog-stored-content-length","value":"4401561"},{"key":"x-goog-stored-content-encoding","value":"identity"},{"key":"Vary","value":"Origin"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Sat, 08 Jan 2022 15:12:47 GMT"},{"key":"Server","value":"UploadServer"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0b6de5c7-6e57-4a3b-90db-1336cc73d909"}],"id":"cfa952b1-3aec-4f37-b1bc-24ea1d1851d2","_postman_id":"cfa952b1-3aec-4f37-b1bc-24ea1d1851d2","description":""},{"name":"Upload with pre-merge","item":[{"name":"minimal data","id":"e34c49e4-2874-4285-9fd6-cb4b07070aa5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":" {\n \"user_id\": \"user@example.com\",\n \"audio_segments\": [\n {\n \"download_url\": \"https://storage.example.com/segment1.mp3\",\n \"order\": 1\n },\n {\n \"download_url\": \"https://storage.example.com/segment2.mp3\",\n \"order\": 2\n }\n ],\n \"recording_type\": \"mp3\",\n \"timestamp\": \"2024-01-15T14:30:00Z\",\n \"topic\": \"Sales Call with Client\",\n \"api_key\": \"your-api-key-here\",\n \"unit_id\": \"sales-unit-001\"\n }\n","options":{"raw":{"language":"json"}}},"url":"https://api.sedric.ai/api_recording_multiple_audio","urlObject":{"protocol":"https","path":["api_recording_multiple_audio"],"host":["api","sedric","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"e34c49e4-2874-4285-9fd6-cb4b07070aa5"},{"name":"all fields sent","id":"910c851d-391d-41a3-b77a-38f63afd94cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\": \"sales.rep@company.com\",\n \"audio_segments\": [\n {\n \"download_url\": \"https://storage.example.com/recording_part1.mp3\",\n \"download_token\": \"auth-token-123\",\n \"order\": 1\n },\n {\n \"download_url\": \"https://storage.example.com/recording_part2.mp3\",\n \"download_token\": \"auth-token-456\",\n \"order\": 2\n },\n {\n \"download_url\": \"https://storage.example.com/recording_part3.mp3\",\n \"order\": 3\n }\n ],\n \"recording_type\": \"mp3\",\n \"timestamp\": \"2024-01-15T14:30:00Z\",\n \"topic\": \"Product Demo Call\",\n \"api_key\": \"your-api-key-here\",\n \"unit_id\": \"sales-unit-001\",\n \"organization_id\": \"org-12345\",\n \"prospect_id\": \"prospect@clientcompany.com\",\n \"metadata\": {\n \"call_duration\": 1800,\n \"call_outcome\": \"qualified\",\n \"product_interest\": \"enterprise_plan\"\n },\n \"external_interaction_id\": \"crm-call-id-789\"\n }\n","options":{"raw":{"language":"json"}}},"url":"https://api.sedric.ai/api_recording_multiple_audio","urlObject":{"protocol":"https","path":["api_recording_multiple_audio"],"host":["api","sedric","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"910c851d-391d-41a3-b77a-38f63afd94cb"}],"id":"b28a03de-4397-49d0-bfe1-b3ee024eba30","description":"

This method of uploading calls accepts multiple audio segments that will be merged into one interaction according to provided order. Each segment will be pulled from the provided customer download_url.

Variable	Type	Description	Example	mandatory
user_id	string	User id		yes
prospect_id	string	The ID of the customer/prospect with whom the call took place.		yes
unit_id*	string	The unit ID in the organization		conditional *(mandatory if no organization_id)
organization_id*	string	The organization ID		conditional *(mandatory if no unit_id)
source	string	The source of the recording		no
external_interaction_id	string	The interaction ID as it is saved in the customers DB. This is an optional debugging aid for the customer's developers to have a shared language with		no
audio_segments	array	Array of audio segment objects. Each segment must contain: download_url (string, required), order (integer ≥1, required), and optionally download_token (string). Segments are processed in order specified by the order field.	See AudioSegment structure	yes
recording_type	Enum	Type of file to be uploaded	mp3, mp4, wav	yes
timestamp	string($datetime)		2020-08-12T19:12:56Z	yes
topic	string	The way the call will be displayed		yes
metadata	{}	Optional - Additional metadata to be attached to the recording.		no
discardable_timespans	positive intager	Timespans that would be removed from the conversation (e.g. usefull for IVR removal).		no
api_key	string	Unit api key		yes

AudioSegment Structure

Each object in the audio_segments array must contain:

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

Field	Type	Description	Example	Required
download_url	string($url)	URL to download the audio file (must be non-empty)	\"https://storage.example.com/segment1.mp3\"	yes
order	integer	Segment order number (must be ≥ 1). Segments are processed in this order.	1, 2, 3	yes
download_token	string	Authentication token for protected URLs	\"auth-token-123\"	no

","_postman_id":"b28a03de-4397-49d0-bfe1-b3ee024eba30"},{"name":"Upload Files - Voice","id":"1fab06cb-7e26-42d3-bb09-30bfa838994b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"SFTP","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\": \"user_id\",\n \"client_id\": \"client_id\",\n \"id\": \"1aaa-2021-12-19T10:47:55Z\",\n \"topic\": \"call's topic\",\n \"timestamp\": \"2021-12-19T10:47:55Z\",\n \"metadata\": {}\n}"},"url":"s-56e9685100234bc4a.server.transfer.us-east-1.amazonaws.com","description":"

You will be given username and password to log into the SFTP server (via port 22).

For each call, there should be 2 files uploaded

CSV file containing the metadata of the call. Schema in the body below (the json fields represent column headers).
\n
MP3 file containing the audio of the recorded call.
\n

Notice: The name of both files should be the same as the id in the csv file.

For example:

1aaa-2021-12-19T10:47:55Z.mp3

1aaa-2021-12-19T10:47:55Z.csv

\n","urlObject":{"host":["s-56e9685100234bc4a","server","transfer","us-east-1","amazonaws","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1fab06cb-7e26-42d3-bb09-30bfa838994b"}],"id":"b896d826-807e-4e69-8f75-beee7736522d","_postman_id":"b896d826-807e-4e69-8f75-beee7736522d","description":""},{"name":"Textual interactions","item":[{"name":"Sms","item":[{"name":"upload sms","id":"812635e5-d94c-45be-b8b3-3e59dd0677e7","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"api_key1234\",\n \"timestamp\": \"%Y-%m-%d%H:%M:%S%z\",\n \"user_id\": \"user_id\",\n \"unit_id\": \"unit_id\",\n \"messages\": [\n {\n \"body\": \"Hey! what's up?\",\n \"date_sent\": \"%Y-%m-%d%H:%M:%S%z\",\n \"media_url\": [\"https://some_url.com\"]\n }\n ],\n \"language\": \"en\",\n \"topic\": \"Conversation with Jack\",\n \"prospect_id\": \"Jack\",\n \"organization_id\": \"organization_id\",\n \"external_interaction_id\": \"some_external_interaction_id\"\n}","options":{"raw":{"language":"json"}}},"url":"","description":"

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

Parameter	Description	Mandatory
api_key	`api_key` that generated by Sedric for user identification	Yes
timestamp	datetime represents the first message timestamp	Yes
user_id	string represents the agent id	Yes
unit_id	string represents the agent's department	Yes
messages	List of messages objects represent the messages	Yes
language	string represents the messages language	Yes
topic	string represents the messages general topic	No
prospect_id	string represents the customer id	Yes
organization_id	string represents the organization id	Yes
external_interaction_id	string represent additional id for the messages	Yes

","urlObject":{"query":[],"variable":[]}},"response":[{"id":"6dd1c034-83c9-44c2-ba44-1f970e35f0bc","name":"upload sms","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"timestamp\": \"2023-03-14T13:56:42+00:00\",\n \"user_id\": \"+19298008447\",\n \"unit_id\": \"integration-test\",\n \"messages\": [\n {\n \"direction\": \"INBOUND/OUTBOUND\",\n \"body\": \"hello how are you\",\n \"date_sent\": \"2023-03-14T13:56:42+00:00\",\n \"media_url\": [\"https://images.theconversation.com/files/393213/original/file-20210401-13-1w9xb24.jpg?ixlib=rb-1.1.0&q=30&auto=format&w=600&h=400&fit=crop&dpr=2\"]\n }\n ],\n \"language\": \"en-US\",\n \"topic\": \"Hello world\",\n \"prospect_id\": \"+972526571111\",\n \"organization_id\": \"Sedric ai\",\n \"external_interaction_id\": \"123455\"\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_sms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"65"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Mon, 10 Apr 2023 10:12:35 GMT"},{"key":"Ngrok-Trace-Id","value":"9012cdb7d7a54c2a6ac248a4309d1c48"},{"key":"Server","value":"Werkzeug/2.2.3 Python/3.8.16"}],"cookie":[],"responseTime":null,"body":"{\n \"interaction_id\": \"39011d78-d13f-40d1-98a4-ffe2b5955e19\"\n}"}],"_postman_id":"812635e5-d94c-45be-b8b3-3e59dd0677e7"}],"id":"2754af28-4008-4feb-a3e0-758804e9a02b","description":"

Introduction

Sedric’s Programmable SMS API helps you to connect your sms service with Sedric application.

This API allows developers to easily add messaging capabilities to Sedric web applications with minimal effort.

It also supports a variety of message formats, including text, images, and audio. Additionally, the API includes features for user management, user authentication, message delivery and tracking, and more.

\n","_postman_id":"2754af28-4008-4feb-a3e0-758804e9a02b"},{"name":"messaging applications","id":"d746cb2c-7c6d-4c60-958a-cd08d922f7c4","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"sint pariatur do\",\n \"unit_id\": \"in qui ut elit velit\",\n \"user_id\": \"dolore Lorem\",\n \"prospect_id\": \"ea irure pariatur\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"adipisicing amet \",\n \"external_interaction_id\": \"do nisi\",\n \"message\": {\n \"participant\": \"non proident tempor\",\n \"message\": \"incididunt\",\n \"messageId\": \"in qui\",\n \"timestamp\": \"adipisicing\"\n },\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_messaging_apps","description":"

Allowing seamless integrations with the most common textual messaging apps, such as: WhatsApp, Telegram, Teams, etc.

\n","urlObject":{"path":["api_messaging_apps"],"host":["https://us-central1-sedric-prod.cloudfunctions.net"],"query":[],"variable":[]}},"response":[{"id":"d845267f-c32d-4440-afe3-4adc6d1a80df","name":"Messages added to the processesing queue.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"sint pariatur do\",\n \"unit_id\": \"in qui ut elit velit\",\n \"user_id\": \"dolore Lorem\",\n \"prospect_id\": \"ea irure pariatur\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"adipisicing amet \",\n \"external_interaction_id\": \"do nisi\",\n \"message\": {\n \"participant\": \"non proident tempor\",\n \"message\": \"incididunt\",\n \"messageId\": \"in qui\",\n \"timestamp\": \"adipisicing\"\n },\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_messaging_apps"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"26a222b2-72e4-4bb4-8ac9-961eb91e766a","name":"Unauthorized user.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"sint pariatur do\",\n \"unit_id\": \"in qui ut elit velit\",\n \"user_id\": \"dolore Lorem\",\n \"prospect_id\": \"ea irure pariatur\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"adipisicing amet \",\n \"external_interaction_id\": \"do nisi\",\n \"message\": {\n \"participant\": \"non proident tempor\",\n \"message\": \"incididunt\",\n \"messageId\": \"in qui\",\n \"timestamp\": \"adipisicing\"\n },\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_messaging_apps"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"2bdb71af-a28f-457e-901a-7e403d4c589c","name":"Forbidden request.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"sint pariatur do\",\n \"unit_id\": \"in qui ut elit velit\",\n \"user_id\": \"dolore Lorem\",\n \"prospect_id\": \"ea irure pariatur\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"adipisicing amet \",\n \"external_interaction_id\": \"do nisi\",\n \"message\": {\n \"participant\": \"non proident tempor\",\n \"message\": \"incididunt\",\n \"messageId\": \"in qui\",\n \"timestamp\": \"adipisicing\"\n },\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_messaging_apps"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"20ffec37-8b90-413c-8166-fdfb81157e08","name":"An interaction record already exists.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"sint pariatur do\",\n \"unit_id\": \"in qui ut elit velit\",\n \"user_id\": \"dolore Lorem\",\n \"prospect_id\": \"ea irure pariatur\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"adipisicing amet \",\n \"external_interaction_id\": \"do nisi\",\n \"message\": {\n \"participant\": \"non proident tempor\",\n \"message\": \"incididunt\",\n \"messageId\": \"in qui\",\n \"timestamp\": \"adipisicing\"\n },\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_messaging_apps"},"status":"Conflict","code":409,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"1d86ebbc-3181-4800-a710-bf3b158a6033","name":"Unprocessable entity - invalid request details.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"sint pariatur do\",\n \"unit_id\": \"in qui ut elit velit\",\n \"user_id\": \"dolore Lorem\",\n \"prospect_id\": \"ea irure pariatur\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"adipisicing amet \",\n \"external_interaction_id\": \"do nisi\",\n \"message\": {\n \"participant\": \"non proident tempor\",\n \"message\": \"incididunt\",\n \"messageId\": \"in qui\",\n \"timestamp\": \"adipisicing\"\n },\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_messaging_apps"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"7adbaddb-e86d-41ee-ac26-7dcac836bada","name":"Internal server error.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"sint pariatur do\",\n \"unit_id\": \"in qui ut elit velit\",\n \"user_id\": \"dolore Lorem\",\n \"prospect_id\": \"ea irure pariatur\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"adipisicing amet \",\n \"external_interaction_id\": \"do nisi\",\n \"message\": {\n \"participant\": \"non proident tempor\",\n \"message\": \"incididunt\",\n \"messageId\": \"in qui\",\n \"timestamp\": \"adipisicing\"\n },\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_messaging_apps"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d746cb2c-7c6d-4c60-958a-cd08d922f7c4"},{"name":"upload general text","id":"0b794cba-85d2-40a2-9fe9-73d0f2936df5","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"eu non\",\n \"unit_id\": \"est in u\",\n \"user_id\": \"sunt adipisicing aute pariatur\",\n \"prospect_id\": \"in ullamco consequat incididunt Lorem\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"tempor anim labore Excepteur consectetur\",\n \"external_interaction_id\": \"veniam dolore repr\",\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_general","urlObject":{"path":["api_general"],"host":["https://us-central1-sedric-prod.cloudfunctions.net"],"query":[],"variable":[]}},"response":[{"id":"96fec573-74f5-4372-a9eb-ad3b76a4c7c4","name":"general text is added to the processesing queue.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"eu non\",\n \"unit_id\": \"est in u\",\n \"user_id\": \"sunt adipisicing aute pariatur\",\n \"prospect_id\": \"in ullamco consequat incididunt Lorem\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"tempor anim labore Excepteur consectetur\",\n \"external_interaction_id\": \"veniam dolore repr\",\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_general"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"09d5f445-4862-4e4c-848e-93473e2bfcef","name":"Unauthorized user.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"eu non\",\n \"unit_id\": \"est in u\",\n \"user_id\": \"sunt adipisicing aute pariatur\",\n \"prospect_id\": \"in ullamco consequat incididunt Lorem\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"tempor anim labore Excepteur consectetur\",\n \"external_interaction_id\": \"veniam dolore repr\",\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_general"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"bbe6ea9e-bacb-4dd9-93ef-a3f076be33ad","name":"Forbidden request.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"eu non\",\n \"unit_id\": \"est in u\",\n \"user_id\": \"sunt adipisicing aute pariatur\",\n \"prospect_id\": \"in ullamco consequat incididunt Lorem\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"tempor anim labore Excepteur consectetur\",\n \"external_interaction_id\": \"veniam dolore repr\",\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_general"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"94b2d6d9-ba76-40f2-8b89-97c288fd56b4","name":"An interaction record already exists.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"eu non\",\n \"unit_id\": \"est in u\",\n \"user_id\": \"sunt adipisicing aute pariatur\",\n \"prospect_id\": \"in ullamco consequat incididunt Lorem\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"tempor anim labore Excepteur consectetur\",\n \"external_interaction_id\": \"veniam dolore repr\",\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_general"},"status":"Conflict","code":409,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"971d519f-a119-447a-a3f5-2eba0972d64d","name":"Unprocessable entity - invalid request details.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"eu non\",\n \"unit_id\": \"est in u\",\n \"user_id\": \"sunt adipisicing aute pariatur\",\n \"prospect_id\": \"in ullamco consequat incididunt Lorem\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"tempor anim labore Excepteur consectetur\",\n \"external_interaction_id\": \"veniam dolore repr\",\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_general"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"3d6a9f01-d2c4-4b54-91ab-e265b494a8af","name":"Internal server error.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"eu non\",\n \"unit_id\": \"est in u\",\n \"user_id\": \"sunt adipisicing aute pariatur\",\n \"prospect_id\": \"in ullamco consequat incididunt Lorem\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"tempor anim labore Excepteur consectetur\",\n \"external_interaction_id\": \"veniam dolore repr\",\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_general"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"0b794cba-85d2-40a2-9fe9-73d0f2936df5"},{"name":"upload chat","id":"e0ff0249-dafa-409d-bbd9-26cecb61aa8b","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"sunt nisi\",\n \"unit_id\": \"enim ali\",\n \"user_id\": \"mollit qui\",\n \"prospect_id\": \"sint exercitation et\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"non consequat\",\n \"external_interaction_id\": \"quis ut culpa\",\n \"messages\": [\n {\n \"participant\": \"qui adipisicing Ut voluptate ad\",\n \"message\": \"enim proident id\",\n \"timestamp\": \"eu sit incididunt tempor\"\n },\n {\n \"participant\": \"dolore Ut amet quis pariatur\",\n \"message\": \"labore est\",\n \"timestamp\": \"laboris incididunt consectetur elit ea\"\n }\n ],\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_chat","urlObject":{"path":["api_chat"],"host":["https://us-central1-sedric-prod.cloudfunctions.net"],"query":[],"variable":[]}},"response":[{"id":"9ccb74cd-ee7f-4f7b-adc9-820c7c38301d","name":"Chat is added to the processesing queue.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"con\",\n \"unit_id\": \"voluptate dolore exercitation Duis\",\n \"user_id\": \"aliquip dolore id\",\n \"prospect_id\": \"tempor Excepteur officia dolore\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"cillum velit esse sunt\",\n \"external_interaction_id\": \"Ut ullamco commodo\",\n \"messages\": [\n {\n \"participant\": \"nostrud\",\n \"message\": \"amet ipsum ea Lorem nostrud\",\n \"timestamp\": \"et nulla Excepteur incididunt\"\n },\n {\n \"participant\": \"magna est deserunt c\",\n \"message\": \"dolor deserunt Excepteur Lorem\",\n \"timestamp\": \"in Lorem magna\"\n }\n ],\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_chat"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"53d4aefc-0ef4-487c-ad21-1e44dbce0c45","name":"Unauthorized user.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"con\",\n \"unit_id\": \"voluptate dolore exercitation Duis\",\n \"user_id\": \"aliquip dolore id\",\n \"prospect_id\": \"tempor Excepteur officia dolore\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"cillum velit esse sunt\",\n \"external_interaction_id\": \"Ut ullamco commodo\",\n \"messages\": [\n {\n \"participant\": \"nostrud\",\n \"message\": \"amet ipsum ea Lorem nostrud\",\n \"timestamp\": \"et nulla Excepteur incididunt\"\n },\n {\n \"participant\": \"magna est deserunt c\",\n \"message\": \"dolor deserunt Excepteur Lorem\",\n \"timestamp\": \"in Lorem magna\"\n }\n ],\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_chat"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"8885b2db-2712-48e1-9c7e-7ba0165c2e70","name":"Forbidden request.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"con\",\n \"unit_id\": \"voluptate dolore exercitation Duis\",\n \"user_id\": \"aliquip dolore id\",\n \"prospect_id\": \"tempor Excepteur officia dolore\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"cillum velit esse sunt\",\n \"external_interaction_id\": \"Ut ullamco commodo\",\n \"messages\": [\n {\n \"participant\": \"nostrud\",\n \"message\": \"amet ipsum ea Lorem nostrud\",\n \"timestamp\": \"et nulla Excepteur incididunt\"\n },\n {\n \"participant\": \"magna est deserunt c\",\n \"message\": \"dolor deserunt Excepteur Lorem\",\n \"timestamp\": \"in Lorem magna\"\n }\n ],\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_chat"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"d2fcd741-0893-457e-907d-c05c72f75e8f","name":"An interaction record already exists.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"con\",\n \"unit_id\": \"voluptate dolore exercitation Duis\",\n \"user_id\": \"aliquip dolore id\",\n \"prospect_id\": \"tempor Excepteur officia dolore\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"cillum velit esse sunt\",\n \"external_interaction_id\": \"Ut ullamco commodo\",\n \"messages\": [\n {\n \"participant\": \"nostrud\",\n \"message\": \"amet ipsum ea Lorem nostrud\",\n \"timestamp\": \"et nulla Excepteur incididunt\"\n },\n {\n \"participant\": \"magna est deserunt c\",\n \"message\": \"dolor deserunt Excepteur Lorem\",\n \"timestamp\": \"in Lorem magna\"\n }\n ],\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_chat"},"status":"Conflict","code":409,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"9a7540ea-d19f-4dad-99a9-41f6b11f325c","name":"Unprocessable entity - invalid request details.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"con\",\n \"unit_id\": \"voluptate dolore exercitation Duis\",\n \"user_id\": \"aliquip dolore id\",\n \"prospect_id\": \"tempor Excepteur officia dolore\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"cillum velit esse sunt\",\n \"external_interaction_id\": \"Ut ullamco commodo\",\n \"messages\": [\n {\n \"participant\": \"nostrud\",\n \"message\": \"amet ipsum ea Lorem nostrud\",\n \"timestamp\": \"et nulla Excepteur incididunt\"\n },\n {\n \"participant\": \"magna est deserunt c\",\n \"message\": \"dolor deserunt Excepteur Lorem\",\n \"timestamp\": \"in Lorem magna\"\n }\n ],\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_chat"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"561fec21-9f2a-4685-956e-36ac5dca7531","name":"Internal server error.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"con\",\n \"unit_id\": \"voluptate dolore exercitation Duis\",\n \"user_id\": \"aliquip dolore id\",\n \"prospect_id\": \"tempor Excepteur officia dolore\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"topic\": \"cillum velit esse sunt\",\n \"external_interaction_id\": \"Ut ullamco commodo\",\n \"messages\": [\n {\n \"participant\": \"nostrud\",\n \"message\": \"amet ipsum ea Lorem nostrud\",\n \"timestamp\": \"et nulla Excepteur incididunt\"\n },\n {\n \"participant\": \"magna est deserunt c\",\n \"message\": \"dolor deserunt Excepteur Lorem\",\n \"timestamp\": \"in Lorem magna\"\n }\n ],\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_chat"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e0ff0249-dafa-409d-bbd9-26cecb61aa8b"},{"name":"upload chat v2","id":"f0d1cfa5-b6d3-4ed5-aec9-180f95801cc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"api_key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"id\",\n \"unit_id\": \"unit_id\",\n \"agent_id\": \"agent_id\",\n \"client_id\": \"client_id\",\n \"organization_id\": \"organization_id\",\n \"source\": \"SOURCE\",\n \"language\": \"language\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"subject\": \"subject\",\n \"messages\": [\n {\n \"author\": \"agent_id\",\n \"text\": \"text\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"is_inbound\": false\n },\n {\n \"author\": \"client_id\",\n \"text\": \"text\",\n \"timestamp\": \"2020-08-13T19:12:56Z\",\n \"is_inbound\": true\n }\n ],\n \"metadata\": {\n \"key\": \"value\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://d1xwrao5d9.execute-api.us-east-1.amazonaws.com/prod/chats/new","urlObject":{"protocol":"https","path":["prod","chats","new"],"host":["d1xwrao5d9","execute-api","us-east-1","amazonaws","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f0d1cfa5-b6d3-4ed5-aec9-180f95801cc0"},{"name":"Upload Files - chat","id":"00065e09-1867-489e-bc04-b07fc0be29f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"SFTP","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"id\",\n \"unit_id\": \"unit_id\",\n \"agent_id\": \"agent_id\",\n \"client_id\": \"client_id\",\n \"organization_id\": \"organization_id\",\n \"language\": \"language\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"subject\": \"subject\",\n \"message\": {\n \"author\": \"agent_id\",\n \"text\": \"text\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"is_inbound\": false\n },\n {\n \"author\": \"client_id\",\n \"text\": \"text\",\n \"timestamp\": \"2020-08-13T19:12:56Z\",\n \"is_inbound\": true\n },\n \"metadata\": {\n \"key\": \"value\"\n }\n}","options":{"raw":{"language":"text"}}},"url":"s-56e9685100234bc4a.server.transfer.us-east-1.amazonaws.com","description":"

You will be given username and password to log into the SFTP server (via port 22).

For each call, upload the following file:

CSV file containing both the data and the metadata of the call. Schema in the body below.
Make sure each row is a different message in the correspondence. For example a chat with 3 messages will be represented as 3 rows in the csv with the same metadata and a different \"message\".

\n","urlObject":{"host":["s-56e9685100234bc4a","server","transfer","us-east-1","amazonaws","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"00065e09-1867-489e-bc04-b07fc0be29f9"}],"id":"3010f66b-297a-41ef-9c6e-e4257a9b802c","_postman_id":"3010f66b-297a-41ef-9c6e-e4257a9b802c","description":""},{"name":"Video Interactions","item":[{"name":"Upload Push Stage 1","event":[{"listen":"test","script":{"id":"fa656c1a-c1b2-440f-be79-4dc130738d90","exec":["pm.test(\"Status code is 202\", function () {"," pm.response.to.have.status(202);","});","","pm.test(\"Set URL\", function () {"," const jsonData = pm.response.json();"," const url = jsonData.url;"," pm.collectionVariables.set(\"storageUploadPUTUrl\", url);","","});","","pm.test(\"Validate Get URL\", function () {"," console.log(pm.collectionVariables.get(\"storageUploadPUTUrl\"));","});","","","pm.test(\"Set PUT request params\", function () {"," const jsonData = pm.response.json();"," for (let k in jsonData.headers) {"," console.log(k)"," pm.collectionVariables.set(k, jsonData.headers[k]);"," } ","});","",""],"type":"text/javascript"}}],"id":"97c2c468-8b76-4a95-aab2-aa7ed71168d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/video","description":"

Upload push method

in this method of uploading video to Sedric there are 2 steps or 2 separate api calls, the first one is to generate url for uploading the video, the second api call is to upload the video itself to the generated url, this is the first step in this method.

Types

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

Variable	Type	Description	Example	mandatory
user_id	string	User id		yes
unit_id	string	The unit ID in the organization		yes
external_interaction_id	string	The interaction ID as it is saved in the customers DB. This is an optional debugging aid for the customer's developers to have a shared language with		no
timestamp	string($datetime)		2020-08-12T19:12:56Z	yes
topic	string	The way the call will be displayed		yes
metadata	{}	Optional - Additional metadata to be attached to the recording.		no
api_key	string	Unit api key		yes

","urlObject":{"protocol":"https","path":["video"],"host":["us-central1-sedric-prod","cloudfunctions","net"],"query":[],"variable":[]}},"response":[{"id":"c5c5ba84-f822-44ec-9009-5d15516fe1bd","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"unit_id\": \"unit_id\",\n \"topic\": \"video's topic\",\n \"timestamp\": \"2021-12-19T10:47:55Z\",\n \"metadata\": {},\n \"api_key\": \"api_key\"\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/video"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Function-Execution-Id","value":"2e7be6u0eekr"},{"key":"X-Cloud-Trace-Context","value":"70349281dae2bbde64f2d9969f56681b"},{"key":"Date","value":"Wed, 05 Jan 2022 15:34:42 GMT"},{"key":"Server","value":"Google Frontend"},{"key":"Content-Length","value":"1680"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""}],"cookie":[],"responseTime":null,"body":"{\n \"url\": \"url\",\n \"headers\": {\n \"x-goog-video-id\": \"\"\n },\n \"data\": {\n \"user_id\": \"\",\n \"unit_id\": \"\",\n \"interaction_id\": \"\",\n \"external_interaction_id\": \"\",\n }\n}"},{"id":"f06d3435-6795-4706-bbd5-177bb64922f5","name":"409 Conflict","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"unit_id\": \"unit_id\",\n \"topic\": \"video's topic\",\n \"timestamp\": \"2021-12-19T10:47:55Z\",\n \"metadata\": {},\n \"api_key\": \"api_key\"\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/video"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Function-Execution-Id","value":"7uqj8dkv8kdq"},{"key":"X-Cloud-Trace-Context","value":"db27a75535ec0b4403cc52148ac25fba;o=1"},{"key":"Date","value":"Sat, 08 Jan 2022 14:50:50 GMT"},{"key":"Server","value":"Google Frontend"},{"key":"Content-Length","value":"282"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""}],"cookie":[],"responseTime":null,"body":"{'msg': 'Duplicate interaction', 'error': \"DuplicateInteraction({'msg': 'Duplicate interaction', 'data': {'user_id': 'example', 'unit_id': 'example', 'interaction id': 'example', 'external_interaction_id': 'example'}})\"}"}],"_postman_id":"97c2c468-8b76-4a95-aab2-aa7ed71168d0"},{"name":"Upload Push Stage 2","event":[{"listen":"prerequest","script":{"id":"a78552ec-c54d-4ca9-8d12-dbc8ee2f2ba9","exec":["pm.environment.get(\"variable_key\");"],"type":"text/javascript"}},{"listen":"test","script":{"id":"7dcdd0fa-84c8-40c7-b168-592d6c2fdf2a","exec":[""],"type":"text/javascript"}}],"id":"e8a080cb-b34b-44c1-8270-55674ee6d32a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-goog-video-id","value":"{{x-goog-video-id}}","type":"text"}],"body":{"mode":"file","file":{"src":""}},"url":"","description":"

Second step of uploading video to Sedric by uploading them to our generated url.

the headers are provided in the previous step.

\n","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[{"id":"06ca1a9b-07e4-4704-9eea-3171d7a0ea26","name":"Upload Success","originalRequest":{"method":"PUT","header":[{"key":"x-goog-video-id","value":"{{x-goog-video-id}}","type":"text"}],"body":{"mode":"file","file":{"src":"/Users/yuval/Desktop/ops/sedric_uploader/Active/call1.mp3"},"options":{"raw":{"language":"json"}}},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"X-GUploader-UploadID","value":"ADPycduNrsdwaQ2k0j32IxbEqewUrIksG5pTHA4U_Wu9KOEyE8nR5o4wciY0W-aSfGt_Qk8QPa2QUQQ1lI5YbFf2Ark"},{"key":"ETag","value":"\"4588c4b7000ef6893e445fa8759279e5\""},{"key":"x-goog-generation","value":"1641654767643089"},{"key":"x-goog-metageneration","value":"1"},{"key":"x-goog-hash","value":"crc32c=8PSQng=="},{"key":"x-goog-hash","value":"md5=RYjEtwAO9ok+RF+odZJ55Q=="},{"key":"x-goog-stored-content-length","value":"4401561"},{"key":"x-goog-stored-content-encoding","value":"identity"},{"key":"Vary","value":"Origin"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Sat, 08 Jan 2022 15:12:47 GMT"},{"key":"Server","value":"UploadServer"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e8a080cb-b34b-44c1-8270-55674ee6d32a"}],"id":"53b97d5c-0b0d-467f-ad5d-8f0d595fd135","_postman_id":"53b97d5c-0b0d-467f-ad5d-8f0d595fd135","description":""},{"name":"Realtime Interactions","item":[],"id":"96e69a75-72fe-4071-9ac5-e63c28656cf2","description":"

Introduction

Sedric offers real-time analysis for live phone calls.

The purpose of this guide is to provide step-by-step instructions on how to transmit raw audio streams from a live phone call to Sedric using WebSockets.

By following these instructions, you will be able to integrate Sedric's advanced analysis capabilities seamlessly into your live call system.

Background

Websocket Server Connection

To open a reliable and encrypted websocket connection, we need to create connection using the wss protocol.

To learn more about WebSocket communication please visit

https://www.tutorialspoint.com/websockets/websockets_communicating_server.htm

After the connection has established, start the call analysis by providing the server with connect, start, media and stop messages.

Authentication

The authentication mechanism we use in Sedric is ticket based.

To learn more about this mechanism please visit https://www.perforce.com/manuals/p4sag/Content/P4SAG/superuser.basic.auth.tickets.html

Integration

Prerequisites

Api key - in order to obtain an API key for your organization, it is necessary to contact Sedric's Integration Team (support@sedric.ai).

Communication

\n $\"Stream%20call%20diagram\"$ \n\n

`Connect`

This message initializes the client-server communication.

URL

wss://sedric-engineering-prod.services

`Start`

This message contains metadata about the stream and is sent immediately after the connection has established. It is only sent once at the start of the stream.

The response of this request contains the ticket you should use to authenticate your upcoming requests. Pleae notice that this ticket expires after 3 hours.

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

Parameter	Description	Mandatory
ticket	The `ticket` provided by the `connect` response.	Yes
api_key	The `api_key` provided by Sedric.	Yes
event	The event type, use `start`.	Yes
start	An object that contains stream metadata.	Yes
start.custom_parameters	An object that passes the custom parameters.	Yes
start.custom_parameters.timestamp	The timestamp at which the interaction took place. If not provided, the streaming timestamp will be set.	No
start.custom_parameters.external_interaction_id	The call ID you use to represent the interaction in your systems - should be unique for every call.	No
start.custom_parameters.user_id	The user id the executed the call.	Yes
start.custom_parameters.type	`inbound`/`outbound`	Yes
start.media_format	The media format of the media messages	Yes
start.media_format.encoding	The encoding of the audio. Value will always be `audio/x-mulaw`	Yes
start.media_format.sample_rate	The sample rate of the audio data in Hertz. The value is always 8000.	Yes
start.media_format.channels	The number of channels in the call.	Yes
start.media_format.agent_channel	The agent's channel (usually 0 or 1)	Yes

{\n  \"event\": \"start\",\n  \"api_key\": \"12345\",\n  \"start\": {\n    \"custom_parameters\": {\n      \"timestamp\": \"2018-11-12 01:02:03\",\n      \"external_interaction_id\": \"39011d78-d13f-40d1-98a4-ffe2b5955e17\",\n      \"user_id\": \"+972504246004\",\n      \"type\":\"inbound\"\n    },\n    \"media_format\": { \n     \"encoding\": \"audio/x-mulaw\", \n     \"sample_rate\": 8000, \n     \"channels\": 1,\n     \"agent_channel\": 0\n   } \n  }\n}\n\n

Response

{\n  \"interaction_id\": \"42dfa06e-12a0-49f6-aa19-cbc7c28be4a7\"\n  \"ticket\": \"ea510a81-026c-49c9-92d2-f19ca2a1322d\"\n}\n\n

`Media`

This message type encapsulates the raw audio data.

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

Parameter	Description	Mandatory
ticket	The `ticket` provided by the `connect` response	Yes
api_key	The `api_key` provided by Sedric	Yes
event	The event type, use `media`.	Yes
media	An object that contains the call media.	Yes
media.payload	Audio bytes encoded in base64	Yes
interaction_id	The unique identifier of the inteaction generated by Sedric.	Yes

{ \n \"event\": \"media\",\n \"api_key\": \"123456\",\n \"ticket\": \"ticket123456\",\n \"media\": { \n   \"payload\": \"no+JhoaJjpzSHxAKBgYJDhtEopGKh4aIjZm7JhILBwYIDRg1qZSLh4aIjJevLBUMBwYHDBUsr5eMiIaHi5SpNRgNCAYHCxImu5mNiIaHipGiRBsOCQYGChAf0pyOiYaGiY+e/x4PCQYGCQ4cUp+QioaGiY6bxCIRCgcGCA0ZO6aSi4eGiI2YtSkUCwcGCAwXL6yVjIeGh4yVrC8XDAgGBwsUKbWYjYiGh4uSpjsZDQgGBwoRIsSbjomGhoqQn1IcDgkGBgkPHv+ej4mGhomOnNIfEAoGBgkOG0SikYqHhoiNmbsmEgsHBggNGDWplIuHhoiMl68sFQwHBgcMFSyvl4yIhoeLlKk1GA0IBgcLEia7mY2IhoeKkaJEGw4JBgYKEB/SnI6JhoaJj57/Hg8JBgYJDhxSn5CKhoaJjpvEIhEKBwYIDRk7ppKLh4aIjZi1KRQLBwYIDBcvrJWMh4aHjJWsLxcMCAYHCxQptZiNiIaHi5KmOxkNCAYHChEixJuOiYaGipCfUhwOCQYGCQ8e/56PiYaGiY6c0h8QCgYGCQ4bRKKRioeGiI2ZuyYSCwcGCA0YNamUi4eGiIyXrywVDAcGBwwVLK+XjIiGh4uUqTUYDQgGBwsSJruZjYiGh4qRokQbDgkGBgoQH9KcjomGhomPnv8eDwkGBgkOHFKfkIqGhomOm8QiEQoHBggNGTumkouHhoiNmLUpFAsHBggMFy+slYyHhoeMlawvFwwIBgcLFCm1mI2IhoeLkqY7GQ0IBgcKESLEm46JhoaKkJ9SHA4JBgYJDx7/no+JhoaJjpzSHxAKBgYJDhtEopGKh4aIjZm7JhILBwYIDRg1qZSLh4aIjJevLBUMBwYHDBUsr5eMiIaHi5SpNRgNCAYHCxImu5mNiIaHipGiRBsOCQYGChAf0pyOiYaGiY+e/x4PCQYGCQ4cUp+QioaGiY6bxCIRCgcGCA0ZO6aSi4eGiI2YtSkUCwcGCAwXL6yVjIeGh4yVrC8XDAgGBwsUKbWYjYiGh4uSpjsZDQgGBwoRIsSbjomGhoqQn1IcDgkGBgkPHv+ej4mGhomOnNIfEAoGBgkOG0SikYqHhoiNmbsmEgsHBggNGDWplIuHhoiMl68sFQwHBgcMFSyvl4yIhoeLlKk1GA0IBgcLEia7mY2IhoeKkaJEGw4JBgYKEB/SnI6JhoaJj57/Hg8JBgYJDhxSn5CKhoaJjpvEIhEKBwYIDRk7ppKLh4aIjZi1KRQLBwYIDBcvrJWMh4aHjJWsLxcMCAYHCxQptZiNiIaHi5KmOxkNCAYHChEixJuOiYaGipCfUhwOCQYGCQ8e/56PiYaGiY6c0h8QCgYGCQ4bRKKRioeGiA==\"\n } ,\n \"interaction_id\": \"39011d78-d13f-40d1-98a4-ffe2b5955e17\"\n}\n\n

`Stop`

A stop message will be sent when the call has ended.

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

Prameter	Description	Mandatory
ticket	The `ticket` provided by the `connect` response.	Yes
event	The event type, use `stop`.	Yes
api_key	The `api_key` .	Yes
interaction_Id	The `interaction_id` to stop.	Yes

{ \n \"ticket\": \"ticket123456\",\n \"event\": \"stop\",\n \"api_key\": \"123456\",\n \"interaction_id\": \"39011d78-d13f-40d1-98a4-ffe2b5955e17\" \n}\n\n

\n","_postman_id":"96e69a75-72fe-4071-9ac5-e63c28656cf2"},{"name":"Email","item":[{"name":"Post Email","id":"edfdb503-e8ea-4a3c-b421-0fe38ed3032d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\": \"sender_email@sedric.ai\",\n \"prospect_id\": \"target_email@sedric.ai\",\n \"unit_id\": \"unit_id\",\n \"api_key\": \"apikey12345\",\n \"language\": \"en\",\n \"message_id\": \"some_email_message_id_1\",\n \"in_reply_to\": \"some_email_message_id\",\n \"references\": [\n \"some_email_message_id\"\n ],\n \"sender\": \"sender_email@sedric.ai\",\n \"sent_to\": [\n \"target_email@sedric.ai\"\n ],\n \"subject\": \"Subject\",\n \"segment\": {\n \"body\": \"Hello! This is a segment body\",\n \"html\": \"

This is a segment body

\",\n },\n \"email\": {\n \"body\": \"Previous Mail This is a segment body\",\n \"html\": \"

Previous Mail

This is a segment body

Pameter	Description	Mandatory
user_id	The agent that took part in this thread.	Yes
prospect_id	The prospect that took part in this thread.	Yes
unit_id	The unit_id that the agent belongs to.	Yes
api_key	The `api_key` provided by Sedric.	Yes
language	The main language of the email message.	Yes
message_id	The message id of the email (should be provided by the email vendor).	Yes
in_reply_to	The last message id that the email was in reply to, if any.	No
references	All the messages apeared in this thread, if any.	No
sender	The sender's email.	Yes
sent_to	The addressee's email.	Yes
subject	.The email's subject	Yes
segment	The current message's body.	Yes
segment.body	A string representation of the segment.	Yes
segment.html	A HTML representation of the segment.	Yes
email	The whole email body.	Yes
email.body	A string representation of the email.	Yes
email.html	A HTML representation of the email.	Yes
timestamp	The timestamp of the message. Format: \"%Y-%m-%d%H:%M:%S%z\"	Yes
mime_type	Message mimetype.	Yes
attachments	List of the message's attachments.	No
attachments.id	The attachment_id.	Yes
attachments.url	The attachment URL.	No
cc	List of ccs.	No
bcc	List of bccs.	No

This call allows you to post email messages and includes attributes for references and in_reply_to, allowing for the conclusion of original email threads.

Please be advised that this API is asynchronous, and as such, the analyzed interaction may not be immediately available following the request.

To check the status of the interaction, users may utilize the GetInteractionStatus.

\n","urlObject":{"protocol":"https","path":["interactions","emails"],"host":["sedric-engineering-prod","services"],"query":[],"variable":[]}},"response":[{"id":"22c26aad-829d-4943-9523-31c76ac101d3","name":"Post Email","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\": \"sender_email@sedric.ai\",\n \"prospect_id\": \"target_email@sedric.ai\",\n \"unit_id\": \"unit_id\",\n \"api_key\": \"apikey12345\",\n \"language\": \"en\",\n \"message_id\": \"some_email_message_id_1\",\n \"in_reply_to\": \"some_email_message_id\",\n \"references\": [\n \"some_email_message_id\"\n ],\n \"sender\": \"sender_email@sedric.ai\",\n \"sent_to\": [\n \"target_email@sedric.ai\"\n ],\n \"subject\": \"Subject\",\n \"segment\": {\n \"body\": \"Hello! This is a segment body\",\n \"html\": \"

This is a segment body

\",\n },\n \"email\": {\n \"body\": \"Previous Mail This is a segment body\",\n \"html\": \"

Previous Mail

This is a segment body

\",\n },\n \"date\": \"%Y-%m-%d%H:%M:%S%z\",\n \"mime_type\": \"MimeType\",\n \"attachments\": [\n {\n \"id\": \"some_attachment_id\",\n \"url\": \"https://url_to_the_attachment.com\"\n }\n ],\n \"cc\": [\n \"cc_email@sedric.ai\"\n ],\n \"bcc\": [\n \"bcc_email@sedric.ai\"\n ],\n}","options":{"raw":{"language":"json"}}},"url":"https://sedric-engineering-prod.services/interactions/emails"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"57"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Mon, 10 Apr 2023 11:56:57 GMT"},{"key":"Ngrok-Trace-Id","value":"450223b48963559e10ff1e52c16ffc7e"},{"key":"Server","value":"Werkzeug/2.2.3 Python/3.8.16"}],"cookie":[],"responseTime":null,"body":"{\n \"interaction_id\": \"39011d78-d13f-40d1-98a4-ffe2b5955e5\"\n}"}],"_postman_id":"edfdb503-e8ea-4a3c-b421-0fe38ed3032d"},{"name":"Post Email V2","id":"11d69a5a-2dcf-4adf-af6d-79ee5382f5f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"api_key (provided by Sedric)","type":"text"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"organization_id\",\n \"source\": \"GMAIL\",\n \"unit_id\": \"unit_id\",\n \"user_id\": \"user_id\",\n \"user_name\": \"user_name\",\n \"prospect_id\": \"prospect_id\",\n \"prospect_name\": \"prospect_name\",\n \"conversation_id\": \"conversation_id\",\n \"conversation_subject\": \"conversation_subject\",\n \"created_timestamp\": \"created_timestamp\",\n \"body_html\": \"body_html\",\n \"inbox\": \"inbox\",\n \"messages\": [{\n \"id\": \"id\",\n \"created_timestamp\": \"created_timestamp\",\n \"text\": \"text\", \n \"is_inbound\": true,\n \"author_email\": \"author_email\",\n \"signature_html\": \"signature_html\",\n \"author_name\": \"author_name\",\n \"recipients\": [\n \"recipient\"\n ]\n }],\n \"metadata\": {\n \"key\": \"value\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://zc07og1ku4.execute-api.us-east-1.amazonaws.com/prod/emails/new","description":"

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

Parameter	Description	Type	Mandatory
organization_id	The account id (provided by sedric).	String	Yes
unit_id	The unit_id that the agent belongs to (provided by sedric).	String	Yes
user_id	The agent that took part in this thread.	String	Yes
user_name	The full name of the agent.	String	Yes
prospect_id	The prospect that took part in this thread.	String	Yes
prospect_name	The full name of the prospect.	String	Yes
conversation_id	Original id of conversation	String	Yes
conversation_subject	The subject of the conversation	String	Yes
created_timestamp	The time the conversation begun	String (%Y-%m-%dT%H:%M:%SZ)	Yes
body_html	HTML of the conversation	String	No
inbox	Email address of the inbox	String	No
messages	The messages in the email correspondence	Object	Yes
metadata	Any additional metadata in key,pair values	Object	No
source	The source of the email	String	No

Use existing conversation_id to append new emails to a thread.

\n","urlObject":{"protocol":"https","path":["prod","emails","new"],"host":["zc07og1ku4","execute-api","us-east-1","amazonaws","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"11d69a5a-2dcf-4adf-af6d-79ee5382f5f0"},{"name":"Upload Files - Email","id":"c84a3860-484e-4a3e-843c-054ca328f9d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"SFTP","header":[],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"organization_id\",\n \"unit_id\": \"unit_id\",\n \"user_id\": \"user_id\",\n \"user_name\": \"user_name\",\n \"prospect_id\": \"prospect_id\",\n \"prospect_name\": \"prospect_name\",\n \"conversation_id\": \"conversation_id\",\n \"conversation_subject\": \"conversation_subject\",\n \"created_timestamp\": \"created_timestamp\",\n \"body_html\": \"body_html\",\n \"inbox\": \"inbox\",\n \"message\": {\n \"id\": \"id\",\n \"created_timestamp\": \"created_timestamp\",\n \"text\": \"text\",\n \"recipients\": [\n \"recipient\"\n ],\n \"is_inbound\": true,\n \"author_email\": \"author_email\",\n \"signature_html\": \"signature_html\",\n \"author_name\": \"author_name\"\n },\n \"metadata\": {\n \"key\": \"value\"\n }\n}","options":{"raw":{"language":"text"}}},"url":"s-56e9685100234bc4a.server.transfer.us-east-1.amazonaws.com","description":"

You will be given username and password to log into the SFTP server (via port 22).

For each call, upload the following file:

CSV file containing both the data and the metadata of the call. Schema in the body below.
Make sure each row is a different email message in the correspondence. For example an email chain with 3 messages will be represented as 3 rows in the csv with the same metadata and a different \"message\".

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

Parameter	Description	Type	Mandatory
organization_id	The account id (provided by sedric).	String	Yes
unit_id	The unit_id that the agent belongs to (provided by sedric).	String	Yes
user_id	The agent that took part in this thread.	String	Yes
user_name	The full name of the agent.	String	Yes
prospect_id	The prospect that took part in this thread.	String	Yes
prospect_name	The full name of the prospect.	String	Yes
conversation_id	Original id of conversation	String	Yes
conversation_subject	The subject of the conversation	String	Yes
created_timestamp	The time the conversation begun	String (%Y-%m-%dT%H:%M:%SZ)	Yes
body_html	HTML of the conversation	String	No
inbox	Email address of the inbox	String	No
message	The text of the email message	Object	Yes
metadata	Any additional metadata in key,pair values	Object	No

","urlObject":{"host":["s-56e9685100234bc4a","server","transfer","us-east-1","amazonaws","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c84a3860-484e-4a3e-843c-054ca328f9d6"}],"id":"6f070b6d-8776-4b38-b65d-fa9524cb5712","description":"

Introduction

Sedric offers an asynchronous API that exposes its email analysis capabilities. This documentation has been created to assist you in integrating these capabilities into your own systems.

Integration

\n","_postman_id":"6f070b6d-8776-4b38-b65d-fa9524cb5712"}],"id":"e66ff123-449b-4e15-850e-5cf382a273ca","_postman_id":"e66ff123-449b-4e15-850e-5cf382a273ca","description":""},{"name":"Retrieve Data","item":[{"name":"Retrieve Interactions - Preview","item":[{"name":"Request for multiple interactions by interaction time (preview)","id":"3c1e78fd-8011-4f80-97f9-b2b146d277d4","request":{"method":"GET","header":[],"url":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_v2/?from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=api_key&unit_ids=[unit1,unit2]&min_duration=0&max_duration=10&channels&user_ids&prospect_ids","description":"

🧪 PREVIEW

This method is in early access and may change.

Retrieve interactions with additional metadata.
The time is based on the actual time the interaction occurred, in UTC

\n","urlObject":{"path":["interactions_v2",""],"host":["https://us-central1-sedric-prod.cloudfunctions.net"],"query":[{"description":{"content":"

Required - ISO8601 DateTime format - from which to pull interactions. This is the time the actual time of the interaction

\n","type":"text/plain"},"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"description":{"content":"

Required - ISO8601 DateTime format - to which to pull interactions. This is theactual time of the interaction.

\n","type":"text/plain"},"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"description":{"content":"

Required - api_key

\n","type":"text/plain"},"key":"api_key","value":"api_key"},{"description":{"content":"

Optional - List.

\n","type":"text/plain"},"key":"unit_ids","value":"[unit1,unit2]"},{"description":{"content":"

Optional - minimum interaction duration

\n","type":"text/plain"},"key":"min_duration","value":"0"},{"description":{"content":"

Optional - maximal interaction duration

\n","type":"text/plain"},"key":"max_duration","value":"10"},{"description":{"content":"

Optional: VOICE, CHAT, EMAIL, VIDEO

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

Optional - List of agents as shown in Sedric

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

Optional - List of prospects as shown in Sedric

\n","type":"text/plain"},"key":"prospect_ids","value":null}],"variable":[]}},"response":[{"id":"d3dd5c76-774d-4e64-afbf-0ed396e640bd","name":"Succefully returns interactions","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_v2/?to_date_time=2024-06-13T08:57:06Z&from_date_time=2024-06-13T08:00:06Z&api_key=example-api-key&unit_ids=[example-unit-id]&min_duration=0&max_duration=10","protocol":"https","host":["us-central1-sedric-prod","cloudfunctions","net"],"path":["interactions_v2",""],"query":[{"key":"to_date_time","value":"2024-06-13T08:57:06Z","description":"Required - ISO8601 DateTime format - to which to pull interactions"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z","description":"Required - ISO8601 DateTime format - from which to pull interactions"},{"key":"api_key","value":"example-api-key","description":"Required - api_key of the Client's team/unit"},{"key":"unit_ids","value":"[example-unit-id]","description":"Optional - Client's team or unit id"},{"key":"min_duration","value":"0","description":"Optional - minimum interaction duration","type":"text"},{"key":"max_duration","value":"10","description":"Optional - maximal interaction duration","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"interactions\": [\r\n {\r\n \"id\": \"0598b6a9-b0a4-4d90-b32c-dbb07c6c1462\",\r\n \"unit_id\": \"integration-test\",\r\n \"user_id\": \"integration-test-dCHjhA@sedric.me\",\r\n \"prospect_id\": \"prospect_id-BRqMIo\",\r\n \"title\": \"topic-PNfbXj\",\r\n \"external_interaction_id\": \"external_interaction_id-YitCxe\",\r\n \"channel\": \"VOICE\",\r\n \"duration\": 10.0,\r\n \"score\": 9,\r\n \"assignee\": \"John Doe\",\r\n \"metadata_sedric_ai\": {},\r\n \"metadata_integration\": {},\r\n \"last_reviewer\": \"example-another-user-id\",\r\n \"review_status\": \"reviewed\",\r\n \"detections\": [\r\n {\r\n \"tracker\": \"example-tracker-name\",\r\n \"transcription_value\": \"example-transcription-value\",\r\n \"timestamp\": 1012 \r\n }\r\n ],\r\n \"failed_criteria\": [\"failed-criteria-1\", \"failed-criteria-2\"],\r\n \"upload_timestamp\": \"2024-06-13 08:00:00.089888+00:00\",\r\n \"interaction_timestamp\": \"2024-06-13 07:00:00.089888+00:00\"\r\n },\r\n {\r\n \"id\": \"0e6a3254-6ed4-4fae-8f10-6dab108bd4fa\",\r\n \"unit_id\": \"integration-test\",\r\n \"user_id\": \"integration-test-aQsEMt@sedric.me\",\r\n \"prospect_id\": \"prospect_id-NNeLUp\",\r\n \"title\": \"topic-bLZOwT\",\r\n \"external_interaction_id\": \"external_interaction_id-CyVilM\",\r\n \"channel\": \"VOICE\",\r\n \"duration\": 5.0,\r\n \"score\": 9,\r\n \"assignee\": \"John Doe\",\r\n \"metadata_sedric_ai\": {},\r\n \"metadata_integration\": {},\r\n \"last_reviewer\": \"example-another-user-id\",\r\n \"review_status\": \"reviewed\",\r\n \"detections\": [\r\n {\r\n \"tracker\": \"example-tracker-name\",\r\n \"transcription_value\": \"example-transcription-value\",\r\n \"timestamp\": 1012 \r\n }\r\n ],\r\n \"failed_criteria\": [\"failed-criteria-1\", \"failed-criteria-2\"],\r\n \"upload_timestamp\": \"2024-06-13 08:00:00.089888+00:00\",\r\n \"interaction_timestamp\": \"2024-06-13 07:00:00.089888+00:00\"\r\n },\r\n {\r\n \"id\": \"4c86598b-f0d8-440a-8fb1-0dd9ad9d7c36\",\r\n \"unit_id\": \"integration-test\",\r\n \"user_id\": \"integration-test-yjAzuq@sedric.me\",\r\n \"prospect_id\": \"prospect_id-xYwujf\",\r\n \"title\": \"topic-WopZEn\",\r\n \"external_interaction_id\": \"external_interaction_id-BMXQCw\",\r\n \"channel\": \"VOICE\",\r\n \"duration\": 20.5,\r\n \"score\": 9,\r\n \"assignee\": \"John Doe\",\r\n \"metadata_sedric_ai\": {},\r\n \"metadata_integration\": {},\r\n \"last_reviewer\": null,\r\n \"review_status\": \"not reviewed\",\r\n \"detections\": [\r\n {\r\n \"tracker\": \"example-tracker-name\",\r\n \"transcription_value\": \"example-transcription-value\",\r\n \"timestamp\": 1012 \r\n }\r\n ],\r\n \"failed_criteria\": [\"failed-criteria-1\", \"failed-criteria-2\"],\r\n \"upload_timestamp\": \"2024-06-13 08:00:00.089888+00:00\",\r\n \"interaction_timestamp\": \"2024-06-13 07:00:00.089888+00:00\"\r\n ]\r\n}"},{"id":"60f5df2f-78e2-4cf2-b94b-ff73c4eb423a","name":"Unauthorized user.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_v2/?unit_ids=[example-unit-id]&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=incorrect-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions_v2",""],"query":[{"key":"unit_ids","value":"[example-unit-id]"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"key":"api_key","value":"incorrect-api-key"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"a4ec2f17-9984-4838-bb4c-9967cc1650fd","name":"Forbidden request.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_v2/?unit_ids=[example-unit-id]&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=incorrect-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions_v2",""],"query":[{"key":"unit_ids","value":"[example-unit-id]"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"key":"api_key","value":"incorrect-api-key"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"7b9c9b55-0ef9-431e-af76-baa5b75be6cd","name":"Unprocessable entity - invalid request details.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_v2/?unit_ids=[example-unit-id]&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=example-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions_v2",""],"query":[{"key":"unit_ids","value":"[example-unit-id]"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"key":"api_key","value":"example-api-key"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"0c339dc2-d4ad-44d3-971a-48609a1d645e","name":"Internal server error.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_v2/?unit_ids=[example-unit-id]&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=example-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions_v2",""],"query":[{"key":"unit_ids","value":"[example-unit-id]"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"key":"api_key","value":"example-api-key"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3c1e78fd-8011-4f80-97f9-b2b146d277d4"},{"name":"Request for multiple interactions by interaction upload time (preview)","id":"d0c7e054-8de4-449e-a62e-17e919f96a46","request":{"method":"GET","header":[],"url":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_by_upload_time_v2/?from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=api_key&unit_ids=[unit1,unit2]&min_duration=0&max_duration=10&channels&user_ids&prospect_ids","description":"

🧪 PREVIEW

This method is in early access and may change.

Retrieve interactions with additional metadata.
The time is based on the upload time of the interaction to Sedric, in UTC

\n","urlObject":{"path":["interactions_by_upload_time_v2",""],"host":["https://us-central1-sedric-prod.cloudfunctions.net"],"query":[{"description":{"content":"

Required - ISO8601 DateTime format - from which to pull interactions. This is the time the actual time of the interaction

\n","type":"text/plain"},"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"description":{"content":"

Required - ISO8601 DateTime format - to which to pull interactions. This is theactual time of the interaction.

\n","type":"text/plain"},"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"description":{"content":"

Required - api_key

\n","type":"text/plain"},"key":"api_key","value":"api_key"},{"description":{"content":"

Optional - List.

\n","type":"text/plain"},"key":"unit_ids","value":"[unit1,unit2]"},{"description":{"content":"

Optional - minimum interaction duration

\n","type":"text/plain"},"key":"min_duration","value":"0"},{"description":{"content":"

Optional - maximal interaction duration

\n","type":"text/plain"},"key":"max_duration","value":"10"},{"description":{"content":"

Optional: VOICE, CHAT, EMAIL, VIDEO

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

Optional - List of agents as shown in Sedric

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

Optional - List of prospects as shown in Sedric

\n","type":"text/plain"},"key":"prospect_ids","value":null}],"variable":[]}},"response":[{"id":"aec2bce7-85ea-4ed8-8803-298f3ee3f09c","name":"Succefully returns interactions","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_by_upload_time_v2/?to_date_time=2024-06-13T08:57:06Z&from_date_time=2024-06-13T08:00:06Z&api_key=example-api-key&unit_ids=[example-unit-id]&min_duration=0&max_duration=10","protocol":"https","host":["us-central1-sedric-prod","cloudfunctions","net"],"path":["interactions_by_upload_time_v2",""],"query":[{"key":"to_date_time","value":"2024-06-13T08:57:06Z","description":"Required - ISO8601 DateTime format - to which to pull interactions"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z","description":"Required - ISO8601 DateTime format - from which to pull interactions"},{"key":"api_key","value":"example-api-key","description":"Required - api_key of the Client's team/unit"},{"key":"unit_ids","value":"[example-unit-id]","description":"Optional - Client's team or unit id"},{"key":"min_duration","value":"0","description":"Optional - minimum interaction duration"},{"key":"max_duration","value":"10","description":"Optional - maximal interaction duration"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"interactions\": [\r\n {\r\n \"id\": \"0598b6a9-b0a4-4d90-b32c-dbb07c6c1462\",\r\n \"unit_id\": \"integration-test\",\r\n \"user_id\": \"integration-test-dCHjhA@sedric.me\",\r\n \"prospect_id\": \"prospect_id-BRqMIo\",\r\n \"title\": \"topic-PNfbXj\",\r\n \"external_interaction_id\": \"external_interaction_id-YitCxe\",\r\n \"channel\": \"VOICE\",\r\n \"duration\": 10.0,\r\n \"score\": 9,\r\n \"assignee\": \"John Doe\",\r\n \"metadata_sedric_ai\": {},\r\n \"metadata_integration\": {},\r\n \"last_reviewer\": \"example-another-user-id\",\r\n \"review_status\": \"reviewed\",\r\n \"detections\": [\r\n {\r\n \"tracker\": \"example-tracker-name\",\r\n \"transcription_value\": \"example-transcription-value\",\r\n \"timestamp\": 1012 \r\n }\r\n ],\r\n \"failed_criteria\": [\"failed-criteria-1\", \"failed-criteria-2\"],\r\n \"upload_timestamp\": \"2024-06-13 08:00:00.089888+00:00\",\r\n \"interaction_timestamp\": \"2024-06-13 07:00:00.089888+00:00\"\r\n },\r\n {\r\n \"id\": \"0e6a3254-6ed4-4fae-8f10-6dab108bd4fa\",\r\n \"unit_id\": \"integration-test\",\r\n \"user_id\": \"integration-test-aQsEMt@sedric.me\",\r\n \"prospect_id\": \"prospect_id-NNeLUp\",\r\n \"title\": \"topic-bLZOwT\",\r\n \"external_interaction_id\": \"external_interaction_id-CyVilM\",\r\n \"channel\": \"VOICE\",\r\n \"duration\": 5.0,\r\n \"score\": 9,\r\n \"assignee\": \"John Doe\",\r\n \"metadata_sedric_ai\": {},\r\n \"metadata_integration\": {},\r\n \"last_reviewer\": \"example-another-user-id\",\r\n \"review_status\": \"reviewed\",\r\n \"detections\": [\r\n {\r\n \"tracker\": \"example-tracker-name\",\r\n \"transcription_value\": \"example-transcription-value\",\r\n \"timestamp\": 1012 \r\n }\r\n ],\r\n \"failed_criteria\": [\"failed-criteria-1\", \"failed-criteria-2\"],\r\n \"upload_timestamp\": \"2024-06-13 08:00:00.089888+00:00\",\r\n \"interaction_timestamp\": \"2024-06-13 07:00:00.089888+00:00\"\r\n },\r\n {\r\n \"id\": \"4c86598b-f0d8-440a-8fb1-0dd9ad9d7c36\",\r\n \"unit_id\": \"integration-test\",\r\n \"user_id\": \"integration-test-yjAzuq@sedric.me\",\r\n \"prospect_id\": \"prospect_id-xYwujf\",\r\n \"title\": \"topic-WopZEn\",\r\n \"external_interaction_id\": \"external_interaction_id-BMXQCw\",\r\n \"channel\": \"VOICE\",\r\n \"duration\": 20.5,\r\n \"score\": 9,\r\n \"assignee\": \"John Doe\",\r\n \"metadata_sedric_ai\": {},\r\n \"metadata_integration\": {},\r\n \"last_reviewer\": null,\r\n \"review_status\": \"not reviewed\",\r\n \"detections\": [\r\n {\r\n \"tracker\": \"example-tracker-name\",\r\n \"transcription_value\": \"example-transcription-value\",\r\n \"timestamp\": 1012 \r\n }\r\n ],\r\n \"failed_criteria\": [\"failed-criteria-1\", \"failed-criteria-2\"],\r\n \"upload_timestamp\": \"2024-06-13 08:00:00.089888+00:00\",\r\n \"interaction_timestamp\": \"2024-06-13 07:00:00.089888+00:00\"\r\n ]\r\n}"},{"id":"67e57bc3-9850-4b58-aad1-844e3207a747","name":"Unauthorized user.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_by_upload_time_v2/?unit_id=example-unit-id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=incorrect-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions_by_upload_time_v2",""],"query":[{"key":"unit_id","value":"example-unit-id"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"key":"api_key","value":"incorrect-api-key"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"b8d3fcff-3587-4da5-897d-aec6db6359b7","name":"Forbidden request.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_by_upload_time_v2/?unit_id=example-unit-id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=incorrect-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions_by_upload_time_v2",""],"query":[{"key":"unit_id","value":"example-unit-id"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"key":"api_key","value":"incorrect-api-key"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"a1a6cf66-670a-4166-9982-60db81e8c0e4","name":"Unprocessable entity - invalid request details.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_by_upload_time_v2/?unit_id=example-unit-id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=example-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions_by_upload_time_v2",""],"query":[{"key":"unit_id","value":"example-unit-id"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"key":"api_key","value":"example-api-key"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"6381ebd9-0a64-4a41-87b0-b46f4df7fb6a","name":"Internal server error.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_by_upload_time_v2/?unit_id=example-unit-id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=example-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions_by_upload_time_v2",""],"query":[{"key":"unit_id","value":"example-unit-id"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"key":"api_key","value":"example-api-key"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d0c7e054-8de4-449e-a62e-17e919f96a46"}],"id":"7aa4373b-15ec-4f09-b1fa-a10b3d77e862","_postman_id":"7aa4373b-15ec-4f09-b1fa-a10b3d77e862","description":""},{"name":"Retrieve Interactions Summaries","item":[{"name":"Retrieve Interactions Summaries","id":"1621364a-2b99-4a7c-971a-f324079cfa76","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"integration-test-org\",\n \"api_key\": \"api-key-integration-test-org\",\n \"external_ids\": [\n \"external_interaction_id-1\",\n \"external_interaction_id-2\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/interaction_summaries","urlObject":{"path":["interaction_summaries"],"host":["https://us-central1-sedric-prod.cloudfunctions.net"],"query":[],"variable":[]}},"response":[{"id":"f36fa364-98f9-475b-aec3-a2c53ec4cf65","name":"Retrieve Interactions Summaries","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"integration-test-org\",\n \"api_key\": \"api-key-integration-test-org\",\n \"external_ids\": [\n \"external_interaction_id-1\",\n \"external_interaction_id-2\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/interaction_summaries"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"summaries\": [\n {\n \"external_id\": \"external_interaction_id-1\",\n \"summary\": {\n \"key_points\": [\n {\n \"label\": \"Label 1\",\n \"value\": \"label text\"\n },\n {\n \"label\": \"Label 2\",\n \"value\": \"label text 2\"\n } \n ],\n \"text\": \"- This is the summary text.\\n- Discussed many issues.\\n- Follow-up arranged for the next morning if the customer does not call back.\",\n \"next_actions\": \"\"\n },\n \"error\": null\n },\n {\n \"external_id\": \"external_interaction_id-2\",\n \"summary\": {\n \"key_points\": [\n {\n \"label\": \"Label 1\",\n \"value\": \"label text\"\n },\n {\n \"label\": \"Label 2\",\n \"value\": \"label text 2\"\n } \n ],\n \"text\": \"- This is the summary text.\\n- Discussed many issues.\\n- Follow-up arranged for the next week if the customer does not call back.\",\n \"next_actions\": \"\"\n },\n \"error\": null\n }\n ]\n}"}],"_postman_id":"1621364a-2b99-4a7c-971a-f324079cfa76"}],"id":"a83fd468-e433-4395-91d6-9ad99ac85c17","_postman_id":"a83fd468-e433-4395-91d6-9ad99ac85c17","description":""},{"name":"Retrieve Evaluations - Preview","item":[{"name":"Request for Interactions Evaluations","id":"8cb18a0e-5167-4650-b7ec-ddd63440a852","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_evaluations/?api_key=api_key&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:20:00Z&review_status","description":"

🧪 PREVIEW

This method is in early access and may change.

Retrieve interactions evaluations.
The time is based on the upload time of the interaction to Sedric, in UTC

\n","urlObject":{"path":["interactions_evaluations",""],"host":["https://us-central1-sedric-prod.cloudfunctions.net"],"query":[{"description":{"content":"

Required - api_key

\n","type":"text/plain"},"key":"api_key","value":"api_key"},{"description":{"content":"

Required - ISO8601 DateTime format - from which to pull interactions. This is the time the time interaction was uploaded to Sedric (UTC)

\n","type":"text/plain"},"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"description":{"content":"

Required - ISO8601 DateTime format - to which to pull interactions. This is the time the time interaction was uploaded to Sedric (UTC)

\n","type":"text/plain"},"key":"to_date_time","value":"2024-06-13T08:20:00Z"},{"description":{"content":"

Optional - \"Reviewed\" / \"Not Reviewed\"

\n","type":"text/plain"},"key":"review_status","value":null}],"variable":[]}},"response":[{"id":"716ce541-8944-4e25-bf75-bd075adfdac3","name":"Request for Interactions Evaluations","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_evaluations/?api_key=example-api-key&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:20:00Z&review_status","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions_evaluations",""],"query":[{"key":"api_key","value":"example-api-key","description":"Required"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z","description":"Required - ISO8601 DateTime format - from which to pull interactions. This is the time the time interaction was uploaded to Sedric (UTC)"},{"key":"to_date_time","value":"2024-06-13T08:20:00Z","description":"Required - ISO8601 DateTime format - to which to pull interactions. This is the time the time interaction was uploaded to Sedric (UTC)"},{"key":"review_status","value":null,"description":"Optional - \"reviewed\" / \"not reviewed\""}]}},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"interaction_id\": \"int-8829-sedric\",\n \"interaction_timestamp\": \"2024-06-13T08:20:00Z\",\n \"review_status\": \"Reviewed\",\n \"reviewed_at\": \"2024-06-13T14:30:00Z\",\n \"reviewed_by\": \"qa.manager@sedric.ai\",\n \"evaluations\": [\n {\n \"criterion_name\": \"Risk Disclosure\",\n \"criterion_description\": \"Agent must disclose financial risks before proceeding.\",\n \"sedric_ai_applicability\": \"Applicable\",\n \"sedric_ai_criteria_result\": \"Passed\",\n \"criterion_reason\": \"Disclaimer read at 02:15 timestamp.\",\n \"comment\": \"Perfect compliance.\"\n }\n ]\n },\n {\n \"interaction_id\": \"int-9930-sedric\",\n \"interaction_timestamp\": \"2024-06-13T09:45:10Z\",\n \"review_status\": \"Reviewed\",\n \"reviewed_at\": \"2024-06-13T16:15:00Z\",\n \"reviewed_by\": \"compliance.lead@sedric.ai\",\n \"evaluations\": [\n {\n \"criterion_name\": \"Professionalism\",\n \"criterion_description\": \"Maintaining a professional tone throughout the call.\",\n \"sedric_ai_applicability\": \"Applicable\",\n \"sedric_ai_criteria_result\": \"Failed\",\n \"criterion_reason\": \"Agent used informal slang during the closing.\",\n \"comment\": \"Agent needs coaching on professional terminology.\"\n },\n {\n \"criterion_name\": \"Call Recording Disclosure\",\n \"criterion_description\": \"Notify user that call is being recorded.\",\n \"sedric_ai_applicability\": \"Not Applicable\",\n \"sedric_ai_criteria_result\": \"Empty\",\n \"criterion_reason\": \"Inbound call with automated pre-roll disclosure.\",\n \"comment\": \"System-handled disclosure.\"\n }\n ]\n }\n]"}],"_postman_id":"8cb18a0e-5167-4650-b7ec-ddd63440a852"}],"id":"e126629c-065c-4fbe-b5af-fedf99b0cd39","_postman_id":"e126629c-065c-4fbe-b5af-fedf99b0cd39","description":""},{"name":"Retrieve Interactions - Deprecated","item":[{"name":"Request for an interaction (deprecated)","id":"0d33cde3-8317-405b-8a10-ccfd0aab0bdb","request":{"method":"GET","header":[],"url":"https://us-central1-sedric-prod.cloudfunctions.net/interactions?interaction_id=NULL&external_interaction_id=NULL&api_key","description":"

⚠️ DEPRECATED

This method is no longer maintained.

\n","urlObject":{"path":["interactions"],"host":["https://us-central1-sedric-prod.cloudfunctions.net"],"query":[{"description":{"content":"

(Optional) If external_interaction_id is provided

\n","type":"text/plain"},"key":"interaction_id","value":"NULL"},{"description":{"content":"

(Optional) If interaction_id is provided

\n","type":"text/plain"},"key":"external_interaction_id","value":"NULL"},{"description":{"content":"

Required

\n","type":"text/plain"},"key":"api_key","value":null}],"variable":[]}},"response":[{"id":"c6d83545-ca5a-4e97-a04d-eb4c31f7e935","name":"Request for an interaction.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions?interaction_id=NULL&external_interaction_id=NULL&api_key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions"],"query":[{"key":"interaction_id","value":"NULL","description":"(Optional) If external_interaction_id is provided"},{"key":"external_interaction_id","value":"NULL","description":"(Optional) If interaction_id is provided"},{"key":"api_key","value":null,"description":"Required"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"0bb517cc-ecf9-43d6-a6ce-14434ff02786\",\r\n \"unit_id\": \"integration-test\",\r\n \"user_id\": \"example-user-id\",\r\n \"prospect_id\": \"example-user@gmail.com\",\r\n \"topic\": \"test_email_9a30ff6f-19a5-439f-91e6-e04a7ee8bb33\",\r\n \"external_interaction_id\": \"9a30ff6f-19a5-439f-91e6-e04a7ee8bb33\",\r\n \"status\": {\r\n \"primary\": \"ARCHIVED\"\r\n },\r\n \"metadata\": null\r\n}"},{"id":"d67e9ddb-02c8-436e-b6aa-881dbace39c0","name":"Succefully returns an interaction with external_interaction_id","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions/?external_interaction_id=example-interaction-id&api_key=example-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions",""],"query":[{"key":"external_interaction_id","value":"example-interaction-id","description":"(Required) Interaction unique identifier provided by the Client when the interaction was created."},{"key":"api_key","value":"example-api-key","description":"(Required) API Key of the unit/team this interaction is a part of"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"0bb517cc-ecf9-43d6-a6ce-14434ff02786\",\n \"unit_id\": \"integration-test\",\n \"user_id\": \"example-user-id\",\n \"prospect_id\": \"example-user@gmail.com\",\n \"topic\": \"test_email_9a30ff6f-19a5-439f-91e6-e04a7ee8bb33\",\n \"external_interaction_id\": \"9a30ff6f-19a5-439f-91e6-e04a7ee8bb33\",\n \"status\": {\n \"primary\": \"ARCHIVED\"\n },\n \"metadata\": null,\n \"reviewed_by\": \"example-another-user-id\",\n \"tracker_results\": [\n {\n \"tracker_name\": \"example-tracker-name\",\n \"tracker_value\": \"example-tracker-value\",\n \"moment_from\": 1012,\n \"moment_to\": 1357\n }\n ]\n}"},{"id":"199611cc-c3c3-4497-a400-079556fc6441","name":"Succefully returns an interaction with interaction_id","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions/?interaction_id=example-interaction-id&api_key=example-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions",""],"query":[{"key":"interaction_id","value":"example-interaction-id","description":"(Required) Interaction unique identifier."},{"key":"api_key","value":"example-api-key","description":"(Required) API Key of the unit/team this interaction is a part of","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"interactions_id\": \"commodo\",\n \"unit_id\": \"labore id\",\n \"timestamp\": \"2020-08-12T19:12:56Z\"\n}"},{"id":"6e7fdcfd-4c0b-4208-acdb-ebfd38d6244b","name":"Unauthorized user.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions?interaction_id=NULL&external_interaction_id=NULL&api_key=incorrect-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions"],"query":[{"key":"interaction_id","value":"NULL"},{"key":"external_interaction_id","value":"NULL"},{"key":"api_key","value":"incorrect-api-key"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"85e0134d-c26d-4045-90c3-3d63decb73c5","name":"Forbidden request.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions?interaction_id=NULL&external_interaction_id=NULL&api_key=incorrect-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions"],"query":[{"key":"interaction_id","value":"NULL"},{"key":"external_interaction_id","value":"NULL"},{"key":"api_key","value":"incorrect-api-key"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"d5d70f69-cebd-405f-ac0d-f9560804c35c","name":"Unprocessable entity - invalid request details.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions?interaction_id=NULL&external_interaction_id=NULL&api_key=example-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions"],"query":[{"key":"interaction_id","value":"NULL"},{"key":"external_interaction_id","value":"NULL"},{"key":"api_key","value":"example-api-key"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"7c0d3e28-9d39-4681-bc2b-fa83cb0da50b","name":"Internal server error.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions?interaction_id=NULL&external_interaction_id=NULL&api_key=example-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions"],"query":[{"key":"interaction_id","value":"NULL"},{"key":"external_interaction_id","value":"NULL"},{"key":"api_key","value":"example-api-key"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"0d33cde3-8317-405b-8a10-ccfd0aab0bdb"},{"name":"Request for multiple interactions by interaction time (deprecated)","id":"857716d4-f8b6-464a-a9a7-d256c70edc88","request":{"method":"GET","header":[],"url":"https://us-central1-sedric-prod.cloudfunctions.net/interactions/?unit_id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key","description":"

⚠️ DEPRECATED

This method is no longer maintained.

Retrieve interactions with additional metadata.
The time is based on the actual time the interaction occurred.

\n","urlObject":{"path":["interactions",""],"host":["https://us-central1-sedric-prod.cloudfunctions.net"],"query":[{"description":{"content":"

Required - Client's team or unit id

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

Required - ISO8601 DateTime format - from which to pull interactions. This is the time the actual time of the interaction

\n","type":"text/plain"},"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"description":{"content":"

Required - ISO8601 DateTime format - to which to pull interactions. This is theactual time of the interaction.

\n","type":"text/plain"},"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"description":{"content":"

Required - api_key of the Client's team/unit

\n","type":"text/plain"},"key":"api_key","value":null}],"variable":[]}},"response":[{"id":"fe92b448-7d0c-4cc2-a6a9-9ea8131ba1bb","name":"Succefully returns interactions","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions/?unit_id=example-unit-id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=example-api-key","protocol":"https","host":["us-central1-sedric-prod","cloudfunctions","net"],"path":["interactions",""],"query":[{"key":"unit_id","value":"example-unit-id","description":"Required - Client's team or unit id"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z","description":"Required - ISO8601 DateTime format - from which to pull interactions"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z","description":"Required - ISO8601 DateTime format - to which to pull interactions"},{"key":"api_key","value":"example-api-key","description":"Required - api_key of the Client's team/unit"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"interactions\": [\r\n {\r\n \"id\": \"0598b6a9-b0a4-4d90-b32c-dbb07c6c1462\",\r\n \"unit_id\": \"integration-test\",\r\n \"user_id\": \"integration-test-dCHjhA@sedric.me\",\r\n \"prospect_id\": \"prospect_id-BRqMIo\",\r\n \"topic\": \"topic-PNfbXj\",\r\n \"external_interaction_id\": \"external_interaction_id-YitCxe\",\r\n \"status\": {\r\n \"primary\": \"DONE\"\r\n },\r\n \"metadata\": {},\r\n \"reviewed_by\": \"example-another-user-id\",\r\n \"tracker_results\": [\r\n {\r\n \"tracker_name\": \"example-tracker-name\",\r\n \"tracker_value\": \"example-tracker-value\",\r\n \"moment_from\": 1012,\r\n \"moment_to\": 1357\r\n }\r\n ],\r\n \"created_timestamp\": \"2024-06-13 08:00:00.089888+00:00\",\r\n \"review_start_timestamp\": \"2024-06-13 08:10:00.089888+00:00\",\r\n \"review_end_timestamp\": \"2024-06-13 08:11:00.089888+00:00\",\r\n \"processed_timestamp\": \"2024-06-13 08:01:00.089888+00:00\"\r\n },\r\n {\r\n \"id\": \"0e6a3254-6ed4-4fae-8f10-6dab108bd4fa\",\r\n \"unit_id\": \"integration-test\",\r\n \"user_id\": \"integration-test-aQsEMt@sedric.me\",\r\n \"prospect_id\": \"prospect_id-NNeLUp\",\r\n \"topic\": \"topic-bLZOwT\",\r\n \"external_interaction_id\": \"external_interaction_id-CyVilM\",\r\n \"status\": {\r\n \"primary\": \"DONE\"\r\n },\r\n \"metadata\": {},\r\n \"reviewed_by\": \"example-another-user-id\",\r\n \"tracker_results\": [\r\n {\r\n \"tracker_name\": \"example-tracker-name\",\r\n \"tracker_value\": \"example-tracker-value\",\r\n \"moment_from\": 1012,\r\n \"moment_to\": 1357\r\n }\r\n ],\r\n \"created_timestamp\": \"2024-06-13 08:00:00.089888+00:00\",\r\n \"review_start_timestamp\": \"2024-06-13 08:10:00.089888+00:00\",\r\n \"review_end_timestamp\": \"2024-06-13 08:11:00.089888+00:00\",\r\n \"processed_timestamp\": \"2024-06-13 08:01:00.089888+00:00\"\r\n },\r\n {\r\n \"id\": \"4c86598b-f0d8-440a-8fb1-0dd9ad9d7c36\",\r\n \"unit_id\": \"integration-test\",\r\n \"user_id\": \"integration-test-yjAzuq@sedric.me\",\r\n \"prospect_id\": \"prospect_id-xYwujf\",\r\n \"topic\": \"topic-WopZEn\",\r\n \"external_interaction_id\": \"external_interaction_id-BMXQCw\",\r\n \"status\": {\r\n \"primary\": \"DONE\"\r\n },\r\n \"metadata\": {},\r\n \"reviewed_by\": \"example-another-user-id\",\r\n \"tracker_results\": [\r\n {\r\n \"tracker_name\": \"example-tracker-name\",\r\n \"tracker_value\": \"example-tracker-value\",\r\n \"moment_from\": 1012,\r\n \"moment_to\": 1357\r\n }\r\n ],\r\n \"created_timestamp\": \"2024-06-13 08:00:00.089888+00:00\",\r\n \"review_start_timestamp\": \"2024-06-13 08:10:00.089888+00:00\",\r\n \"review_end_timestamp\": \"2024-06-13 08:11:00.089888+00:00\",\r\n \"processed_timestamp\": \"2024-06-13 08:01:00.089888+00:00\"\r\n }\r\n ]\r\n}"},{"id":"1c319250-4f11-43bf-93e8-36daa7b56038","name":"Unauthorized user.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions/?unit_id=example-unit-id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=incorrect-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions",""],"query":[{"key":"unit_id","value":"example-unit-id"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"key":"api_key","value":"incorrect-api-key"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"a4a86ba9-a279-45c5-9978-2dd10876a0f2","name":"Forbidden request.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions/?unit_id=example-unit-id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=incorrect-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions",""],"query":[{"key":"unit_id","value":"example-unit-id"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"key":"api_key","value":"incorrect-api-key"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"2c25820f-d7b4-4fea-aeff-f91daff9bd6e","name":"Unprocessable entity - invalid request details.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions/?unit_id=example-unit-id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=example-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions",""],"query":[{"key":"unit_id","value":"example-unit-id"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"key":"api_key","value":"example-api-key"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"bbba6f06-498d-4f0d-84c8-4b41f724991e","name":"Internal server error.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions/?unit_id=example-unit-id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=example-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions",""],"query":[{"key":"unit_id","value":"example-unit-id"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"key":"api_key","value":"example-api-key"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"857716d4-f8b6-464a-a9a7-d256c70edc88"},{"name":"Request for multiple interactions by processing time (deprecated)","id":"e05c335d-48f0-4764-b342-8320328f6836","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_by_processed_time/?unit_id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key","description":"

⚠️ DEPRECATED

This method is no longer maintained.

Retrieve interactions with additional metadata.
The time is based on the time the interaction successfully finished processing in Sedric.

\n","urlObject":{"path":["interactions_by_processed_time",""],"host":["https://us-central1-sedric-prod.cloudfunctions.net"],"query":[{"description":{"content":"

Required - Client's team or unit id

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

Required - ISO8601 DateTime format - from which to pull interactions. This is the time the interaction successfully finished processing in Sedric

\n","type":"text/plain"},"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"description":{"content":"

Required - ISO8601 DateTime format - to which to pull interactions. This is the time the interaction successfully finished processing in Sedric

\n","type":"text/plain"},"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"description":{"content":"

Required - api_key of the Client's team/unit

\n","type":"text/plain"},"key":"api_key","value":null}],"variable":[]}},"response":[{"id":"2894dbb7-b82c-4895-a47a-161412442487","name":"Succefully returns interactions","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_by_processed_time/?unit_id=example-unit-id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=example-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions_by_processed_time",""],"query":[{"key":"unit_id","value":"example-unit-id","description":"Required - Client's team or unit id"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z","description":"Required - ISO8601 DateTime format - from which to pull interactions"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z","description":"Required - ISO8601 DateTime format - to which to pull interactions"},{"key":"api_key","value":"example-api-key","description":"Required - api_key of the Client's team/unit"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"interactions\": [\r\n {\r\n \"id\": \"0598b6a9-b0a4-4d90-b32c-dbb07c6c1462\",\r\n \"unit_id\": \"integration-test\",\r\n \"user_id\": \"integration-test-dCHjhA@sedric.me\",\r\n \"prospect_id\": \"prospect_id-BRqMIo\",\r\n \"topic\": \"topic-PNfbXj\",\r\n \"external_interaction_id\": \"external_interaction_id-YitCxe\",\r\n \"status\": {\r\n \"primary\": \"DONE\"\r\n },\r\n \"metadata\": {},\r\n \"reviewed_by\": \"example-another-user-id\",\r\n \"tracker_results\": [\r\n {\r\n \"tracker_name\": \"example-tracker-name\",\r\n \"tracker_value\": \"example-tracker-value\",\r\n \"moment_from\": 1012,\r\n \"moment_to\": 1357\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"0e6a3254-6ed4-4fae-8f10-6dab108bd4fa\",\r\n \"unit_id\": \"integration-test\",\r\n \"user_id\": \"integration-test-aQsEMt@sedric.me\",\r\n \"prospect_id\": \"prospect_id-NNeLUp\",\r\n \"topic\": \"topic-bLZOwT\",\r\n \"external_interaction_id\": \"external_interaction_id-CyVilM\",\r\n \"status\": {\r\n \"primary\": \"DONE\"\r\n },\r\n \"metadata\": {},\r\n \"reviewed_by\": \"example-another-user-id\",\r\n \"tracker_results\": [\r\n {\r\n \"tracker_name\": \"example-tracker-name\",\r\n \"tracker_value\": \"example-tracker-value\",\r\n \"moment_from\": 1012,\r\n \"moment_to\": 1357\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"4c86598b-f0d8-440a-8fb1-0dd9ad9d7c36\",\r\n \"unit_id\": \"integration-test\",\r\n \"user_id\": \"integration-test-yjAzuq@sedric.me\",\r\n \"prospect_id\": \"prospect_id-xYwujf\",\r\n \"topic\": \"topic-WopZEn\",\r\n \"external_interaction_id\": \"external_interaction_id-BMXQCw\",\r\n \"status\": {\r\n \"primary\": \"DONE\"\r\n },\r\n \"metadata\": {},\r\n \"reviewed_by\": \"example-another-user-id\",\r\n \"tracker_results\": [\r\n {\r\n \"tracker_name\": \"example-tracker-name\",\r\n \"tracker_value\": \"example-tracker-value\",\r\n \"moment_from\": 1012,\r\n \"moment_to\": 1357\r\n }\r\n ]\r\n }\r\n ]\r\n}"},{"id":"e1908c2f-ffa2-4eb1-a87f-71019554293c","name":"Unauthorized user.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_by_processed_time/?unit_id=example-unit-id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=incorrect-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions_by_processed_time",""],"query":[{"key":"unit_id","value":"example-unit-id"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"key":"api_key","value":"incorrect-api-key"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"a22cd8ec-bf69-4a58-9170-4a43003a6556","name":"Forbidden request.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_by_processed_time/?unit_id=example-unit-id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=incorrect-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions_by_processed_time",""],"query":[{"key":"unit_id","value":"example-unit-id"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"key":"api_key","value":"incorrect-api-key"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"1456b2ea-f3c8-44bb-8d03-950ace2a821b","name":"Unprocessable entity - invalid request details.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_by_processed_time/?unit_id=example-unit-id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=example-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions_by_processed_time",""],"query":[{"key":"unit_id","value":"example-unit-id"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"key":"api_key","value":"example-api-key"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"ef0411d7-9b61-4419-a373-80c3cf145fdc","name":"Internal server error.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_by_processed_time/?unit_id=example-unit-id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=example-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions_by_processed_time",""],"query":[{"key":"unit_id","value":"example-unit-id"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"key":"api_key","value":"example-api-key"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e05c335d-48f0-4764-b342-8320328f6836"},{"name":"Request for multiple interactions by upload time (deprecated)","id":"0ee8f505-fe8c-40a2-b985-dc26ecd2dba4","request":{"method":"GET","header":[],"url":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_by_upload_time/?unit_id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key","description":"

⚠️ DEPRECATED

This method is no longer maintained.

Retrieve interactions with additional metadata.
The time is based on the time the interaction successfully sent for processing in Sedric.

\n","urlObject":{"path":["interactions_by_upload_time",""],"host":["https://us-central1-sedric-prod.cloudfunctions.net"],"query":[{"description":{"content":"

Required - Client's team or unit id

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

Required - ISO8601 DateTime format - from which to pull interactions. This is the time the interaction was accepted for processing in Sedric

\n","type":"text/plain"},"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"description":{"content":"

Required - ISO8601 DateTime format - to which to pull interactions. This is the time the interaction was accepted for processing in Sedric

\n","type":"text/plain"},"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"description":{"content":"

Required - api_key of the Client's team/unit

\n","type":"text/plain"},"key":"api_key","value":null}],"variable":[]}},"response":[{"id":"b6c885d1-b6d6-45d3-98f2-daa442627f46","name":"Succefully returns interactions","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_by_upload_time/?unit_id=example-unit-id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=example-api-key","protocol":"https","host":["us-central1-sedric-prod","cloudfunctions","net"],"path":["interactions_by_upload_time",""],"query":[{"key":"unit_id","value":"example-unit-id","description":"Required - Client's team or unit id"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z","description":"Required - ISO8601 DateTime format - from which to pull interactions"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z","description":"Required - ISO8601 DateTime format - to which to pull interactions"},{"key":"api_key","value":"example-api-key","description":"Required - api_key of the Client's team/unit"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"interactions\": [\r\n {\r\n \"id\": \"0598b6a9-b0a4-4d90-b32c-dbb07c6c1462\",\r\n \"unit_id\": \"integration-test\",\r\n \"user_id\": \"integration-test-dCHjhA@sedric.me\",\r\n \"prospect_id\": \"prospect_id-BRqMIo\",\r\n \"topic\": \"topic-PNfbXj\",\r\n \"external_interaction_id\": \"external_interaction_id-YitCxe\",\r\n \"status\": {\r\n \"primary\": \"DONE\"\r\n },\r\n \"metadata\": {},\r\n \"reviewed_by\": \"example-another-user-id\",\r\n \"tracker_results\": [\r\n {\r\n \"tracker_name\": \"example-tracker-name\",\r\n \"tracker_value\": \"example-tracker-value\",\r\n \"moment_from\": 1012,\r\n \"moment_to\": 1357\r\n }\r\n ],\r\n \"created_timestamp\": \"2024-06-13 08:00:00.089888+00:00\",\r\n \"review_start_timestamp\": \"2024-06-13 08:10:00.089888+00:00\",\r\n \"review_end_timestamp\": \"2024-06-13 08:11:00.089888+00:00\",\r\n \"processed_timestamp\": \"2024-06-13 08:01:00.089888+00:00\"\r\n },\r\n {\r\n \"id\": \"0e6a3254-6ed4-4fae-8f10-6dab108bd4fa\",\r\n \"unit_id\": \"integration-test\",\r\n \"user_id\": \"integration-test-aQsEMt@sedric.me\",\r\n \"prospect_id\": \"prospect_id-NNeLUp\",\r\n \"topic\": \"topic-bLZOwT\",\r\n \"external_interaction_id\": \"external_interaction_id-CyVilM\",\r\n \"status\": {\r\n \"primary\": \"DONE\"\r\n },\r\n \"metadata\": {},\r\n \"reviewed_by\": \"example-another-user-id\",\r\n \"tracker_results\": [\r\n {\r\n \"tracker_name\": \"example-tracker-name\",\r\n \"tracker_value\": \"example-tracker-value\",\r\n \"moment_from\": 1012,\r\n \"moment_to\": 1357\r\n }\r\n ],\r\n \"created_timestamp\": \"2024-06-13 08:00:00.089888+00:00\",\r\n \"review_start_timestamp\": \"2024-06-13 08:10:00.089888+00:00\",\r\n \"review_end_timestamp\": \"2024-06-13 08:11:00.089888+00:00\",\r\n \"processed_timestamp\": \"2024-06-13 08:01:00.089888+00:00\"\r\n },\r\n {\r\n \"id\": \"4c86598b-f0d8-440a-8fb1-0dd9ad9d7c36\",\r\n \"unit_id\": \"integration-test\",\r\n \"user_id\": \"integration-test-yjAzuq@sedric.me\",\r\n \"prospect_id\": \"prospect_id-xYwujf\",\r\n \"topic\": \"topic-WopZEn\",\r\n \"external_interaction_id\": \"external_interaction_id-BMXQCw\",\r\n \"status\": {\r\n \"primary\": \"DONE\"\r\n },\r\n \"metadata\": {},\r\n \"reviewed_by\": \"example-another-user-id\",\r\n \"tracker_results\": [\r\n {\r\n \"tracker_name\": \"example-tracker-name\",\r\n \"tracker_value\": \"example-tracker-value\",\r\n \"moment_from\": 1012,\r\n \"moment_to\": 1357\r\n }\r\n ],\r\n \"created_timestamp\": \"2024-06-13 08:00:00.089888+00:00\",\r\n \"review_start_timestamp\": \"2024-06-13 08:10:00.089888+00:00\",\r\n \"review_end_timestamp\": \"2024-06-13 08:11:00.089888+00:00\",\r\n \"processed_timestamp\": \"2024-06-13 08:01:00.089888+00:00\"\r\n }\r\n ]\r\n}"},{"id":"9fb93a37-3413-454c-9748-3d40e102ade0","name":"Unauthorized user.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_by_upload_time/?unit_id=example-unit-id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=incorrect-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions_by_upload_time",""],"query":[{"key":"unit_id","value":"example-unit-id"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"key":"api_key","value":"incorrect-api-key"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"aa748cab-7fcf-4b24-9cee-d99212c3123e","name":"Forbidden request.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_by_upload_time/?unit_id=example-unit-id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=incorrect-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions_by_upload_time",""],"query":[{"key":"unit_id","value":"example-unit-id"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"key":"api_key","value":"incorrect-api-key"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"8d48bb7f-c10c-4045-858a-3811c62544fa","name":"Unprocessable entity - invalid request details.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_by_upload_time/?unit_id=example-unit-id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=example-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions_by_upload_time",""],"query":[{"key":"unit_id","value":"example-unit-id"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"key":"api_key","value":"example-api-key"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"34c8ad28-44bd-41fa-936e-003bebf10df3","name":"Internal server error.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://us-central1-sedric-prod.cloudfunctions.net/interactions_by_upload_time/?unit_id=example-unit-id&from_date_time=2024-06-13T08:00:06Z&to_date_time=2024-06-13T08:57:06Z&api_key=example-api-key","host":["https://us-central1-sedric-prod.cloudfunctions.net"],"path":["interactions_by_upload_time",""],"query":[{"key":"unit_id","value":"example-unit-id"},{"key":"from_date_time","value":"2024-06-13T08:00:06Z"},{"key":"to_date_time","value":"2024-06-13T08:57:06Z"},{"key":"api_key","value":"example-api-key"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"0ee8f505-fe8c-40a2-b985-dc26ecd2dba4"}],"id":"de6fed73-adc5-4a70-b759-16d15dc23294","_postman_id":"de6fed73-adc5-4a70-b759-16d15dc23294","description":""}],"id":"6cc3db3e-b0a1-42dc-aa92-f84f4d9047d8","_postman_id":"6cc3db3e-b0a1-42dc-aa92-f84f4d9047d8","description":""},{"name":"Operations","item":[{"name":"Merge","item":[{"name":"Merge several interactions (deprecated)","id":"06707a73-680c-4213-bb3c-9fce8f47e5b1","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"culpa exercitation incididunt ad\",\n \"user_id\": \"cillum laborum sunt\",\n \"prospect_id\": \"ex id Duis sit dolor\",\n \"unit_id\": \"minim\",\n \"interaction_deps\": [\n {\n \"user_id\": \"nisi amet\",\n \"interaction_id\": \"occaecat est\"\n },\n {\n \"user_id\": \"exercitation fugiat\",\n \"interaction_id\": \"est\"\n }\n ],\n \"topic\": \"culpa sint eiusmod\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_merge_shallow","description":"

⚠️ DEPRECATED

This method is no longer maintained.

\n","urlObject":{"path":["api_merge_shallow"],"host":["https://us-central1-sedric-prod.cloudfunctions.net"],"query":[],"variable":[]}},"response":[{"id":"7075b000-4430-4b28-8a7c-facae3a7535f","name":"Interaction has been merged successfully.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"deserunt eiusmod ipsum\",\n \"user_id\": \"laboris esse\",\n \"prospect_id\": \"incididunt exercitation anim magna\",\n \"unit_id\": \"tempor id ad\",\n \"interaction_deps\": [\n {\n \"user_id\": \"Excepteur nisi dolor dolore veniam\",\n \"interaction_id\": \"nisi ea non\"\n },\n {\n \"user_id\": \"esse aute ad proident\",\n \"interaction_id\": \"sint ad\"\n }\n ],\n \"topic\": \"sed\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_merge_shallow"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"d3fa8c77-ab1c-4aba-9983-128067875661","name":"Forbidden request.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"deserunt eiusmod ipsum\",\n \"user_id\": \"laboris esse\",\n \"prospect_id\": \"incididunt exercitation anim magna\",\n \"unit_id\": \"tempor id ad\",\n \"interaction_deps\": [\n {\n \"user_id\": \"Excepteur nisi dolor dolore veniam\",\n \"interaction_id\": \"nisi ea non\"\n },\n {\n \"user_id\": \"esse aute ad proident\",\n \"interaction_id\": \"sint ad\"\n }\n ],\n \"topic\": \"sed\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_merge_shallow"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"bc0c7a0f-6280-4350-a75a-cfe155475085","name":"Unprocessable entity - invalid request details.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"deserunt eiusmod ipsum\",\n \"user_id\": \"laboris esse\",\n \"prospect_id\": \"incididunt exercitation anim magna\",\n \"unit_id\": \"tempor id ad\",\n \"interaction_deps\": [\n {\n \"user_id\": \"Excepteur nisi dolor dolore veniam\",\n \"interaction_id\": \"nisi ea non\"\n },\n {\n \"user_id\": \"esse aute ad proident\",\n \"interaction_id\": \"sint ad\"\n }\n ],\n \"topic\": \"sed\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_merge_shallow"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"501c3882-edd8-4720-b7a0-36ec57186a92","name":"Internal server error.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"deserunt eiusmod ipsum\",\n \"user_id\": \"laboris esse\",\n \"prospect_id\": \"incididunt exercitation anim magna\",\n \"unit_id\": \"tempor id ad\",\n \"interaction_deps\": [\n {\n \"user_id\": \"Excepteur nisi dolor dolore veniam\",\n \"interaction_id\": \"nisi ea non\"\n },\n {\n \"user_id\": \"esse aute ad proident\",\n \"interaction_id\": \"sint ad\"\n }\n ],\n \"topic\": \"sed\",\n \"timestamp\": \"2020-08-12T19:12:56Z\",\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_merge_shallow"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"06707a73-680c-4213-bb3c-9fce8f47e5b1"},{"name":"Unmerge interactions (deprecated)","id":"518f2150-c5ba-49f5-9e16-377aa7a3276b","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"ut aliqua\",\n \"user_id\": \"nulla cupidatat labore amet\",\n \"interaction_id\": \"anim cillum\"\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_unmerge","description":"

⚠️ DEPRECATED

This method is no longer maintained.

\n","urlObject":{"path":["api_unmerge"],"host":["https://us-central1-sedric-prod.cloudfunctions.net"],"query":[],"variable":[]}},"response":[{"id":"89c3ef9c-807d-4bc4-ae96-75958fb3d896","name":"Interaction has been unmerged successfully.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"ut aliqua\",\n \"user_id\": \"nulla cupidatat labore amet\",\n \"interaction_id\": \"anim cillum\"\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_unmerge"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"b224cedf-1c0b-4388-856d-2f49aaf07d5f","name":"Forbidden request.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"ut aliqua\",\n \"user_id\": \"nulla cupidatat labore amet\",\n \"interaction_id\": \"anim cillum\"\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_unmerge"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"34138457-52a2-4bc2-a143-4d74b299368c","name":"Unprocessable entity - invalid request details.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"ut aliqua\",\n \"user_id\": \"nulla cupidatat labore amet\",\n \"interaction_id\": \"anim cillum\"\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_unmerge"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"3d214c15-b626-4a8e-92a5-97f9eeef87d4","name":"Internal server error.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"ut aliqua\",\n \"user_id\": \"nulla cupidatat labore amet\",\n \"interaction_id\": \"anim cillum\"\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/api_unmerge"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"518f2150-c5ba-49f5-9e16-377aa7a3276b"}],"id":"8e541b9c-5e8f-4b30-9669-6f3fa0935ff5","_postman_id":"8e541b9c-5e8f-4b30-9669-6f3fa0935ff5","description":""},{"name":"Update Interactions","item":[{"name":"Update Interactions","id":"b2a10aa3-87e2-4669-aa19-dc4490aa85e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"api_key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"interaction_id\":\"interaction_id\",\n \"unit_id\":\"unit_id\",\n \"topic\":\"topic\",\n \"prospect_id\":\"prospect_id\"\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/update_interaction","urlObject":{"protocol":"https","path":["update_interaction"],"host":["us-central1-sedric-prod","cloudfunctions","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"b2a10aa3-87e2-4669-aa19-dc4490aa85e9"}],"id":"bbb45732-e9cc-4b2e-a393-477ae738b466","_postman_id":"bbb45732-e9cc-4b2e-a393-477ae738b466","description":""}],"id":"96ec9bc5-71a0-468b-be7d-50720c897acf","_postman_id":"96ec9bc5-71a0-468b-be7d-50720c897acf","description":""}],"id":"ec76b4c4-8be7-4e15-a1be-b9f2e9e98e37","_postman_id":"ec76b4c4-8be7-4e15-a1be-b9f2e9e98e37","description":""},{"name":"Marketing Compliance","item":[{"name":"Assets","item":[{"name":"Scraping","item":[{"name":"Upload url","event":[{"listen":"test","script":{"id":"fa656c1a-c1b2-440f-be79-4dc130738d90","exec":["pm.test(\"Status code is 202\", function () {"," pm.response.to.have.status(202);","});","","pm.test(\"Set URL\", function () {"," const jsonData = pm.response.json();"," const url = jsonData.url;"," pm.collectionVariables.set(\"storageUploadPUTUrl\", url);","","});","","pm.test(\"Validate Get URL\", function () {"," console.log(pm.collectionVariables.get(\"storageUploadPUTUrl\"));","});","","","pm.test(\"Set PUT request params\", function () {"," const jsonData = pm.response.json();"," for (let k in jsonData.headers) {"," console.log(k)"," pm.collectionVariables.set(k, jsonData.headers[k]);"," } ","});","",""],"type":"text/javascript"}}],"id":"2ccf0fb5-823d-4025-b432-08fc1a2a6b14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/asset_scraping","description":"

Upload push method

Upload social posts to Sedric such as Facebook, Twitter , and Linkedin.

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

Variable	Type	Description	Example	mandatory
user_id	string	User id		yes
unit_id	string	The unit ID in the organization		yes
external_interaction_id	string	The interaction ID as it is saved in the customers DB. This is an optional debugging aid for the customer's developers to have a shared language with		no
timestamp	string($datetime)		2020-08-12T19:12:56Z	yes
topic	string	The way the call will be displayed		yes
metadata	{}	Optional - Additional metadata to be attached to the recording.		no
api_key	string	Unit api key		yes
body_html	string	HTML body of the social post		no
body_string	string	Textual representation of the social post key		no

","urlObject":{"protocol":"https","path":["asset_scraping"],"host":["us-central1-sedric-prod","cloudfunctions","net"],"query":[],"variable":[]}},"response":[{"id":"43893fa0-9869-45cd-a5d8-6316538f3117","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\": \"user_id\",\n \"unit_id\": \"unit_id\",\n \"topic\": \"post's topic\",\n \"timestamp\": \"2021-12-19T10:47:55Z\",\n \"metadata\": {},\n \"api_key\": \"api_key\",\n \"body_html\" : \"..\",\n \"body_string\": \"Post body\" \n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/asset_scraping"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Function-Execution-Id","value":"2e7be6u0eekr"},{"key":"X-Cloud-Trace-Context","value":"70349281dae2bbde64f2d9969f56681b"},{"key":"Date","value":"Wed, 05 Jan 2022 15:34:42 GMT"},{"key":"Server","value":"Google Frontend"},{"key":"Content-Length","value":"1680"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""}],"cookie":[],"responseTime":null,"body":"{\n \"url\": \"url\",\n \"headers\": {\n \"x-goog-post-id\": \"\"\n },\n \"data\": {\n \"user_id\": \"\",\n \"unit_id\": \"\",\n \"interaction_id\": \"\"\n }\n}"},{"id":"2bb38778-1806-43e3-8abf-10b06837c2d0","name":"409 Conflict","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\": \"user_id\",\n \"unit_id\": \"unit_id\",\n \"topic\": \"post's topic\",\n \"timestamp\": \"2021-12-19T10:47:55Z\",\n \"metadata\": {},\n \"api_key\": \"api_key\",\n \"bytes\" : []\n}","options":{"raw":{"language":"json"}}},"url":"https://us-central1-sedric-prod.cloudfunctions.net/asset_scraping"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Function-Execution-Id","value":"7uqj8dkv8kdq"},{"key":"X-Cloud-Trace-Context","value":"db27a75535ec0b4403cc52148ac25fba;o=1"},{"key":"Date","value":"Sat, 08 Jan 2022 14:50:50 GMT"},{"key":"Server","value":"Google Frontend"},{"key":"Content-Length","value":"282"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""}],"cookie":[],"responseTime":null,"body":"{\"msg\": \"Duplicate post\", \"error\": \"DuplicateInteraction({'msg': 'Duplicate interaction', 'data': {'user_id': 'example', 'unit_id': 'example', 'interaction id': 'example', 'external_interaction_id': 'example'}})\"}"}],"_postman_id":"2ccf0fb5-823d-4025-b432-08fc1a2a6b14"}],"id":"aad6f188-c277-42a2-bab4-3b4e1aa8ac18","_postman_id":"aad6f188-c277-42a2-bab4-3b4e1aa8ac18","description":""}],"id":"09dc387e-283e-4061-bac5-44a7072a9f2e","_postman_id":"09dc387e-283e-4061-bac5-44a7072a9f2e","description":""},{"name":"Affiliate Monitoring","item":[],"id":"cf62bfd3-6eb2-4206-884a-3ea818f8b46e","description":"

Marketing Compliance - SFTP Integration

This is an overview of the Secure File Transfer Protocol (SFPT) integration for managing Affiliates and Properties within Sedric. Sedric enforces a daily pulling policy ensuring a seamless, secure, and up-to-date exchange of crucial information between your company and our platform.

A dedicated Solution Engineer will be assigned to oversee the SFTP integration. Our experienced engineer will work closely with your team to understand specific requirements, address concerns, and guide you through each step of the integration process.

Error Resolution

In the event of an error during the SFTP integration, we have designated a main focal point for error resolution. Our dedicated Solution Engineer will take the lead in identifying, troubleshooting, and resolving any integration issues.

Communication Channel - Slack

We have created a dedicated Slack channel for real-time communication related to the SFTP integration. This channel will serve as a centralized hub where you and our team, can promptly share information, collaborate on resolving issues and discuss solutions.

The integration will be done through two JSON files, one dedicated to Affiliates and the other to Properties.

Please view the following integration process and follow the instructions.

Affiliates JSON Structure:

{\n\"external_affiliate_id\": string,\n\"affiliate_name\": string,\n\"affiliate_manager\": string,\n\"registration_date\": YYYY-MM-DD,\n\"registration_country\": string,\n\"regulations\": string[],\n\"scanning_frequency\": string\n}\n\n

Legend:

external_affiliate_id:
- Purpose: Unique identifier for the affiliate.
- Description: A numerical or alphanumeric code assigned by you to each affiliate for easy identification.
\n
affiliate_name:
- Purpose: Name of the affiliate.
- Description: The official or commonly used name of the affiliate.
\n
affiliate_manager:
- Purpose: Designates the manager responsible for the affiliate.
- Description: The person overseeing the affiliate's account or operations.
\n
registration_date (optional):
- Purpose: Indicates the date of affiliate registration.
- Format: YYYY-MM-DD
- Description: The date when the affiliate officially started working with your company.
\n
registration_country (optional):
- Purpose: Records the country in which the affiliate is registered.
- Description: The country where the affiliate is based or registered.
\n
regulations:
- Purpose: Lists the regulatory bodies associated with the affiliate.
- Description: An array containing regulatory bodies that govern the affiliate's operations.
\n
scanning_frequency:
- Purpose: Specifies the frequency of scanning for affiliate-related updates in each of their properties.
- Description: Indicates how often the system should check for changes or updates related to the affiliate (daily, weekly, monthly, etc.).
\n

Example Affiliates JSON:

{\n\"external_affiliate_id\": \"1234\",\n\"affiliate_name\": \"Forex Inc\",\n\"affiliate_manager\": \"Kara Stevens\",\n\"registration_date\": \"2023-11-03\",\n\"registration_country\": \"France\",\n\"regulations\": [\"Cysec\", \"FCA\"],\n\"scanning_frequency\": \"@monthly\"\n}\n\n

Properties JSON Structure:

{\n\"url\": string,\n\"channel\": string,\n\"scanning_frequency\": string,\n\"external_affiliate_id_reference\": string,\n\"external_property_id\": string\n}\n\n

Legend:

url:

Purpose: Represents the URL associated with the property.
Description: The web address or link corresponding to the property.

channel:

Purpose: Identifies the channel through which the property is accessible.
Description: Specifies the medium or platform where the property is available, e.g., \"Website\", “Instagram”, “Youtube”

scanning_frequency:

Purpose: Specifies the frequency of scanning for property-related updates.
Description: Indicates how often the system should check for changes or updates related to the property (if different from the affiliate’s scanning frequency, the most specific frequency will be chosen).

external_affiliate_id_reference:

Purpose: Links the property to a specific affiliate through their external ID.
Description: Associates the property with a particular affiliate using their unique identifier.

external_property_id (Optional):

Purpose: Provides an optional external identifier for the property.
Description: An optional field that can be used for additional tracking or identification purposes.

Example Properties JSON:

{\n\"url\": \"https://www.wikijob.co.uk\",\n\"channel\": \"Website\",\n\"scanning_frequency\": \"@weekly\",\n\"external_affiliate_id_reference\": \"1234\",\n\"external_property_id\": \"567\"\n}\n\n

","_postman_id":"cf62bfd3-6eb2-4206-884a-3ea818f8b46e"}],"id":"6cd06f1c-fe85-4656-afe2-e109c9743b86","_postman_id":"6cd06f1c-fe85-4656-afe2-e109c9743b86","description":""}],"variable":[{"key":"baseUrl","value":"https://us-central1-sedric-prod.cloudfunctions.net"},{"key":"API Key","value":"API Key"},{"key":"storageUploadPUTUrl","value":""}]}