Reschedule sent bulk.
\nThis method allows you to reschedule scheduled TTS bulk. Messages scheduled with the sendAt or Sending speed parameter can be paused, resumed or canceled by changing the message status, or rescheduled using the bulkId parameter as an identifier. Rescheduling is only possible if the bulk status is PAUSED.
\nUnique ID of the bulk.
\n","type":"text/plain"},"key":"bulkId","value":"{{voiceBulkId}}"}],"variable":[]}},"response":[{"id":"406dab9a-6359-4f4f-a512-2e141247b14a","name":"200 - Bulk response","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sendAt\": \"2023-09-26T14:07:35.000+0000\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/tts/3/bulks?bulkId={{voiceBulkId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["tts","3","bulks"],"query":[{"key":"bulkId","value":"{{voiceBulkId}}","description":"Unique ID of the bulk."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"5028e2d42f19-42f1-4656-351e-a42c191e5fd2\",\n \"sendAt\": \"2023-09-26T14:07:35.000+0000\"\n}"},{"id":"1d1619a3-fbfb-45c4-8abf-c93115f56f1f","name":"400 - Bad request","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sendAt\": \"2023-09-26T14:07:35.000+0000\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/tts/3/bulks?bulkId={{voiceBulkId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["tts","3","bulks"],"query":[{"key":"bulkId","value":"{{voiceBulkId}}","description":"Unique ID of the bulk."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Bad request\"\n }\n }\n}"},{"id":"f19bda76-4355-4442-b74a-452329971893","name":"401 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sendAt\": \"2023-09-26T14:07:35.000+0000\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/tts/3/bulks?bulkId={{voiceBulkId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["tts","3","bulks"],"query":[{"key":"bulkId","value":"{{voiceBulkId}}","description":"Unique ID of the bulk."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"e854c19a-fcd9-49da-a58e-1d2df0de696e","name":"403 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sendAt\": \"2023-09-26T14:07:35.000+0000\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/tts/3/bulks?bulkId={{voiceBulkId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["tts","3","bulks"],"query":[{"key":"bulkId","value":"{{voiceBulkId}}","description":"Unique ID of the bulk."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"6239b6a5-fb69-414f-98aa-e9294f115181","name":"429 - Too many requests response","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sendAt\": \"2023-09-26T14:07:35.000+0000\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/tts/3/bulks?bulkId={{voiceBulkId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["tts","3","bulks"],"query":[{"key":"bulkId","value":"{{voiceBulkId}}","description":"Unique ID of the bulk."}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"22d6d2ce-830d-437c-ab3d-fc60d83c8c9c","name":"500 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sendAt\": \"2023-09-26T14:07:35.000+0000\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/tts/3/bulks?bulkId={{voiceBulkId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["tts","3","bulks"],"query":[{"key":"bulkId","value":"{{voiceBulkId}}","description":"Unique ID of the bulk."}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"63f3eca2-3fc2-4b40-be2d-812c6df3b164"},{"name":"Cancel the scheduled voice message","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","if (!(pm.environment.get(\"voiceBulkId\") || \"\")) { skip(\"voiceBulkId is not set\"); }"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests for Cancel the scheduled voice message.","pm.test(\"Status code is 200\", function () { pm.expect(pm.response.code).to.eql(200); });","pm.test(\"The bulk is canceled, so no call is ever placed\", function () { pm.expect(pm.response.json().status).to.eql(\"CANCELED\"); });"],"type":"text/javascript","packages":{}}}],"id":"e92bb22f-bf6a-42af-baba-07e3366772a8","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"CANCELED\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/tts/3/bulks/status?bulkId={{voiceBulkId}}","description":"Cancel a scheduled voice bulk so the call is never placed.
\nManage sent bulk's status.
\nThis method allows you to manage statuses of scheduled TTS bulk. Messages scheduled with the sendAt or sending speed parameter can be paused, resumed or canceled by changing the message status, or rescheduled using the bulkId parameter as an identifier. Only voice messages that were not already sent can be canceled.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| bulkId | \nString | \nRequired. Unique ID of the bulk. | \n
\n\n
\n
Request body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| status | \nString | \nRequired. New status of the bulk. One of: PENDING, PAUSED, PROCESSING, CANCELED, FINISHED, FAILED. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| bulkId | \nString | \nUnique ID of the bulk. | \n
\n\n| status | \nString | \nRequired. New status of the bulk. One of: PENDING, PAUSED, PROCESSING, CANCELED, FINISHED, FAILED. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["tts","3","bulks","status"],"host":["go2","vhdmedia","se"],"query":[{"description":{"content":"Unique ID of the bulk.
\n","type":"text/plain"},"key":"bulkId","value":"{{voiceBulkId}}"}],"variable":[]}},"response":[],"_postman_id":"e92bb22f-bf6a-42af-baba-07e3366772a8"}],"id":"8bad8dba-0c59-4007-8f4b-e49db079c9fc","description":"Send voice messages (text to speech or an audio file), get logs and delivery reports, manage scheduled voice bulks, and list the available voices. Voice send requests place real calls to the recipients, so the examples use the sample number 46731234567, which is replaced by your testNumber when you run them.
\n","_postman_id":"8bad8dba-0c59-4007-8f4b-e49db079c9fc"},{"name":"INTERACTIVE VOICE RESPONSE","item":[{"name":"IVR variables and actions","item":[],"id":"e83e69e9-4cd9-427a-b5ff-a7d695524a91","description":"IVR Variables and Actions
\nLet's learn about IVR building blocks
\nVariables
\nDuring the scenario execution, some actions may write to or read from variables. All variables are strings and defined globally in the entire scope of the scenario. The system currently provides the following read-only variables that are populated for each call:
\nfrom - the caller ID, source address (E164)\nto - the callee ID, destination address (E164)\nstartTime - the start time of the call (YYYY-MM-DD hh:mm:ss)\nanswerTime - the time the user answered the call (YYYY-MM-DD hh:mm:ss)\n\n
Actions
\nLet's take a look at the available scenario actions:
\n\n- Say
\n- Collect
\n- Dial
\n- Play
\n- Call API
\n- Switch - Case
\n- Repeat - Until
\n- While do
\n- Hang up
\n
\nAlso, IVR use cases contain simple examples you can use for your own scenarios.
\nSay
\nA Say action performs the playback of TTS synthesized audio based on its parameters. Message text can be up to 1400 characters long.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| say | \nString | \nmessage text | \n
\n\n| options > language | \nString | \nMust be defined for correct pronunciation. In the Languages section, you can find the list of languages that we support. | \n
\n\n| options > speechRate | \nDouble | \nMust be within [0.5 - 2.0] range, default value is 1. | \n
\n\n
\n
JSON
\n{\n \"say\": \"Dear Customer, we will show you all actions in one example. If you want to perform dial action press one. If you press number two we will play message from a url. Number three in this case is reserved for call web api's POST method. If you want call web api's GET method press four. For web api's PUT method you will press five. Exit is your's choice, press asterisk.\"\n}\n\n
Collect
\nA Collect action performs DTMF input reading and saving from the user's phone.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| collectInto | \nString | \nthe name of the variable to set | \n
\n\n| options > maxInputLength | \nInteger | \nthe maximum number of DTMF tones to wait for, 0 for unlimited. | \n
\n\n
\n
The variable name cannot be one of the reserved ones, except for dtmf. A Collect is internally parameterized with two parameters: responseTimeout and digitTimeout. The responseTimeout is the time the IVR platform waits for the user to press the first key. After the first key is pressed, the platform waits for any additional keys for the digitTimeout. These variables are 5 and 2 seconds, respectively.
The # key cannot be collected, as it is reserved for user input termination (i.e. the IVR platform automatically stops reading user input after receiving #, without storing it).
\nJSON
\n{\n \"collectInto\": \"myVariable\",\n \"options\": {\n \"maxInputLength\": 1\n }\n}\n\n
Dial
\nA Dial action performs a call redirection, joining the user's call with another destination. This action is final, meaning that it cannot be followed by an action (it has to be the last action within its branch, not even followed by a Hangup).
\n\n\n\n| Property | \nType | \nNote | \n
\n\n\n\n| dial | \nString | \nmust be a valid E164 MSISDN; the parameter can be constructed using variables | \n
\n\n
\n
JSON
\n{\n \"dial\": \"41793026731\"\n}\n\n
Play
\nA Play action performs playback of audio provided by the client’s URL.
\n\n\n\n| Property | \nType | \nDefault | \nNote | \n
\n\n\n\n| playFromUrlString | \nstring | \n(required) | \n(required) | \n
\n\n
\n
JSON
\n{\n \"playFromUrl\": \"http://www.example.com/voice/sound.mp3\"\n}\n\n
Call API
\nA Call API Action performs an HTTP request to a client's endpoint, and (if told to) processes the response data.
\nIf collectResponse is set, the system will attempt to parse the response from the server. The parsing algorithm is quite naive: based on the Accept header (or Content-Type header, if Accept header is missing), it will attempt to parse the response into a simple one-level object, and save all its fields as variables. Any response property with a reserved name is ignored.
\nThe response payload is limited by size to 32kB. If exceeded, the scenario is aborted. Any I/O exception during the action will be raised, interrupting scenario execution. Currently, this is not applied for non-200 HTTP status codes received (such responses are ignored).
\n\n\n\n| Property | \nType | \nDefault | \nNote | \n
\n\n\n\n| request | \nString | \n(required) | \nthe URL to target | \n
\n\n| options > method | \nString | \n(required) | \nGET, POST, PUT, DELETE | \n
\n\n| options > headers | \nObject | \n(required, for content-type) | \n | \n
\n\n| options > body | \nString or Object | \n(required for body-enclosing methods) | \nthe request body to send | \n
\n\n| options > collectResponse | \nboolean | \nfalse | \nif set, will cause the system to process the response | \n
\n\n
\n
JSON
\n{\n \"request\": \"https://requestb.in/12345\",\n \"options\": {\n \"method\": \"POST\",\n \"headers\": {\n \"content-type\": \"application/json\"\n },\n \"body\": {\n \"payload\": \"${to} finished the IVR.\"\n }\n }\n}\n\n
JSON
\n{\n \"request\": \"https://requestb.in/12345\",\n \"options\": {\n \"method\": \"GET\",\n \"headers\": {\n \"accept\": \"application/xml\",\n \"authorization\": \"Basic dXNlcjpwYXNz\"\n },\n \"collectResponse\": true\n }\n}\n\n
JSON
\n{\n \"request\": \"https://requestb.in/12345\",\n \"options\": {\n \"method\": \"PUT\",\n \"headers\": {\n \"content-type\": \"application/xml\",\n \"accept\": \"application/xml\"\n },\n \"body\": \"${to} finished the IVR.\",\n \"collectResponse\": true\n }\n}\n\n
Switch - Case
\nA Switch - Case action takes a saved variable (obtained via either a Collect or a Call API action) and performs flow control based on it. It works similarly to the switch case block, using case-sensitive comparison.
\n\n\n\n| Property | \nType | \nDefault | \nNote | \n
\n\n\n\n| switch | \nString | \n(required) | \nname of the variable whose value to inspect | \n
\n\n| case | \nObject | \n(required) | \nobject whose keys are possible variable values, and values are arrays of actions | \n
\n\n| __default | \nArray | \n | \narray of actions to execute if none of the conditions above are met | \n
\n\n
\n
JSON
\n{\n \"switch\": \"myVariable\",\n \"case\": {\n \"1\": [\n {\n \"dial\": \"46701234567\"\n }\n ],\n \"2\": [\n {\n \"playFromUrl\": \"http://www.example.com/voice/advanced\"\n }\n ],\n \"3\": [\n {\n \"request\": \"https://requestb.in/12345\",\n \"options\": {\n \"method\": \"POST\",\n \"headers\": {\n \"content-type\": \"application/json\"\n },\n \"body\": {\n \"payload\": \"${to} finished the IVR.\"\n }\n }\n }\n ],\n \"4\": [\n {\n \"request\": \"https://requestb.in/12345\",\n \"options\": {\n \"method\": \"GET\",\n \"collectResponse\": true\n }\n }\n ],\n \"5\": [\n {\n \"request\": \"https://requestb.in/12345\",\n \"options\": {\n \"method\": \"PUT\",\n \"headers\": {\n \"content-type\": \"application/xml\",\n \"accept\": \"application/xml\"\n },\n \"body\": \"${to} finished the IVR.\",\n \"collectResponse\": true\n }\n }\n ],\n \"__default\": [\n {\n \"say\": \"Dear Customer, you pressed wrong number. Please, try again.\"\n },\n {\n \"collectInto\": \"myVariable\",\n \"options\": {\n \"maxInputLength\": 1\n }\n }\n ]\n }\n}\n\n
Repeat - Until
\nA Repeat - Until loop is a control flow statement that executes a block of code at least once, and then repeatedly executes the block, or not, depending on a given boolean condition in the until field.
Comparison is done using equal (==) or not equal (! =) operators.
\nJSON
\n{\n \"repeat\": [\n { \"say\": \"For exit you must press one.\" },\n { \"collectInto\": \"myVariable\" }\n ],\n \"until\": \"${myVariable} == 1\"\n}\n\n
While - Do
\nLoops can execute a do field block of code as long as a specified condition is true in the while field. As with Repeat - Until, comparison is done using equal (==) or not equal (! =) operators.
\nJSON
\n{\n \"while\": \"${myVariable} != 1\",\n \"do\": [\n { \"say\": \"For exit you must press one.\" },\n { \"collectInto\": \"myVariable\" }\n ]\n}\n\n
Hang up
\nA Hangup action is a pseudo-action marking the end of the IVR flow execution, leading to the call actually being hung up.
\nJSON
\n\"hangup\"\n\n
Languanges
\nList of languages available for Say action:
\n\n\n\n| Language | \nLanguage shortcut | \n
\n\n\n\n| English | \nen | \n
\n\n| English (British) | \nen-gb | \n
\n\n| English (Australian) | \nen-au | \n
\n\n| English (Indian) | \nen-in | \n
\n\n| English (Welsh) | \nen-gb-wls | \n
\n\n| Spanish | \nes | \n
\n\n| Catalan | \nca | \n
\n\n| Chinese-Simplified | \nzh-cn | \n
\n\n| Chinese-Traditional | \nzh-tw | \n
\n\n| Danish | \nda | \n
\n\n| Dutch | \nnl | \n
\n\n| French | \nfr | \n
\n\n| German | \nde | \n
\n\n| Italian | \nit | \n
\n\n| Japanese | \nja | \n
\n\n| Korean | \nko | \n
\n\n| Norwegian | \nno | \n
\n\n| Polish | \npl | \n
\n\n| Portuguese | \npt-pt | \n
\n\n| Portuguese - Brazilian | \npt-br | \n
\n\n| Russian | \nru | \n
\n\n| Swedish | \nsv | \n
\n\n| Finnish | \nfi | \n
\n\n| Turkish | \ntr | \n
\n\n| Welsh | \nwls | \n
\n\n
\n
Just a few sample scenarios to inspire but possibilities are endless
\nVarious IVR scenarios could be created by combining available actions. Here are just a few samples that you might check out before creating your own.
\nScheduling an appointment
Checking order/delivery status
Cart abandonment
\nScheduling an appointment
\nA simple use case to call a customer to schedule an appointment via IVR. The IVR workflow can offer the customer a range of appointment options. Here’s how this process would work.
\nThe client sets up a Scenario and uses the received ScenarioId to Launch Outbound IVR API. Our platform will initiate a call to each destination phone number specified. Once the call is answered, the IVR flow will start playing an audio message inviting the customer to pick one of the available appointment times using DTMF keys.
\nHere’s how the steps look. Code samples and a flow diagram are below:
\n\n- Call customer phone number
\n- Once the customer picks up the phone, the IVR message is played:
Dear client, we would like to schedule an appointment for you on October 14th. Available times__are 10:00 am, 11 am, and 2:00 pm. Please press 1 for 10 am, 2 for 11 am, or 3 for a 2 pm__appointment. If none of these work for you, we will send a new message suggesting different time__slots. \n- Collect action gathers the DTMF code entered by end user
\n- User input is analyzed and, based on the DTMF, one of the following responses is played::
\n
\n\n- 4a For DTMF 1, 2 or 3: Thank you. Your appointment is scheduled.
\n- 4b For any other DTMF or no DTMF: Thank you We will suggest another time slot once it’s available.
\n
\nExample
\nJSON
\n{\n \"name\": \"scenario\",\n \"script\": [\n {\n \"say\": \"Dear client, we would like to schedule an appointment on 14.10. Available time is 10:00 am, 11 am and 2:00 pm. Please press 1 for 10 am, 2 for 11 or 3 for a 2 pm meeting. If non of the above suits you, we will send new message suggesting different time frame.\"\n },\n {\n \"collectInto\": \"scheduleTime\"\n },\n {\n \"switch\": \"scheduleTime\",\n \"case\": {\n \"1\": [\n {\n \"say\": \"Thank you. Your appointment is scheduled for 10 am.\"\n }\n ],\n \"2\":[\n {\n \"say\": \"Thank you. Your appointment is scheduled for 11 am.\"\n }\n ],\n \"3\":[\n {\n \"say\": \"Thank you. Your appointment is scheduled for 2 pm.\"\n }\n ],\n \"__default\": [\n {\n \"say\": \"Thank you We will suggest another time slot once it’s available.\"\n },\n \"hangup\"\n ]\n }\n },\n { \"say\": \"Thank you. Your appointment is scheduled.\" },\n \"hangup\"\n ]\n}\n\n
Cart abandonment
\nClient has an online store and everyday notices customers clicking and checking out products, even adding them to their shopping carts. But one thing is missing and it is the most important one - checkout and conclusion of the buying process. In order to remind customers and ask them why they did not finish the process, client could send an IVR survey that should give some context on what is going on when users interact with your page. Maybe there is something that needs to be changed in the online buying process or at least to know that some customers are not serious buyers.
\nLet us break down this process in steps.
\n\n- Customer logs in to the web shop and stores a couple of products inside his shopping cart
\n- After some time he leaves the web shop without completing the buying process
\n- This is noticed by the client's back end system and this will trigger an IVR scenario ID towards that customer/destination
\n- Based on the scenario the customer can be asked the following question:
Dear customer we see that you have some goods in your cart. Would you like us to notify you__once the product in your basket becomes discounted? Press 1 for yes, press 2 for no, press 5 to__talk with an agent and get more information. \n- Customer response will be collected and call API action will enable client to receive it
\n- Based on the response codes (DTMFs) the customer pressed, client will do according actions on his side like updating the CRM, calling the customer with more info etc.
\n
\nExample
\nJSON
\n{\n \"name\": \"scenario\",\n \"script\": [\n {\n \"say\": \"Dear customer we see that you have some goods in your cart. Would you like us to notify you once the product in your basket becomes discounted? Press 1 for yes, press 2 for no, press 5 to talk with an agent and get more information.\"\n },\n {\n \"collectInto\": \"DTMFCode\"\n },\n {\n \"switch\": \"DTMFCode\",\n \"case\": {\n \"5\": [\n {\n \"dial\": \"46701234567\"\n }\n ]\n }\n },\n {\n \"say\": \"Thank you.\"\n },\n \"hangup\"\n ]\n}\n\n
","_postman_id":"d5a294ae-49b1-4b3e-8477-f0205fc23997"},{"name":"Create a Voice IVR Scenario","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","(function () {"," api(\"GET\", \"/voice/ivr/1/scenarios\", null, function (e, r) {"," var j = jsonOf(r); var list = (Array.isArray(j) ? j : []).filter(function (s) { return s.name === \"Sample scenario\"; });"," (function next(i) { if (i >= list.length) { return; } api(\"DELETE\", \"/voice/ivr/1/scenarios/\" + list[i].id, null, function () { next(i + 1); }); })(0);"," });","})();"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"id\", \"name\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});","","","","var j = pm.response.json();","pm.environment.set(\"id\", String(j.id));"],"type":"text/javascript","packages":{}}}],"id":"14dbb5aa-c1e5-4c06-bb32-5f9b0a133a73","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sample scenario\",\n \"description\": \"Say a message and hang up.\",\n \"script\": [\n {\n \"say\": \"Hello from the VHD API\"\n },\n \"hangup\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/voice/ivr/1/scenarios","description":"\nSpeech capture (capture with speechOptions) is not enabled on every account. On this account creating a scenario that uses it returns 400 Speech capture not enabled for the account. The example below therefore only says a message; ask support to enable speech capture if you need it.
\n
\nThis method allows you to create a Voice IVR Scenario.
\nRequest rate limit
\n1 requests / second (per account)
\nRequest body schema
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| name | \nstring | \nThe name of IVR scenario. | \n
\n\n| description | \nstring | \nDescription of IVR scenario. | \n
\n\nscript
| \n | \nRequired
Array of Call API (object) or Capture (object) or Collect (object) or Dial (object) or Dial to Many (object) or Dial to WebRTC (object) or Dial to SIP trunk (object) or Dial to Conversations (object) or For-Each (object) or Go-To (object) or Hang-up (string) or If-Then-Else (object) or Machine Detection (string) or Pause (object) or Play (object) or Play From Recording (object) or Record (object) or Repeat-Until (object) or Repeat-While (object) or Say (object) or Send SMS (object) or Set Variable (object) or Switch-Case (object) or While-Do (object)
Array of IVR actions defining scenario. NOTE: Answering Machine Detection, Call Recording and Speech Recognition (used for Capture action) are add-on features. To enable these add-ons, please contact our sales organisation. | \n
\n\n
\n
Array [
\nOne of
\nCall API
\nCall API Action performs an HTTP request to a client’s endpoint, and (if told to) processes the response data. If collectResponse is set, the system will attempt to parse the response from the server. Our platform needs to be able to make HTTP requests to the specified endpoint.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| request | \nstring | \nThe URL to target | \n
\n\noptions
{
method
headers
collectResponse
| \nobject
string
object
boolean | \nRequired
GET, POST, PUT, DELETE
HTTP headers
If this field is set, the system will parse the response and save all its fields as variables inside scenario. Note: Parser ignores non-primitive fields and does not go deeper than the first level. For example, if the response is {\"letters\": \"abcd\", \"numbers\": 12345}, the system will store variables letters and numbers, with values abcd and 12345 respectively. Check the example Say action with Call Api Responses. Response that is parsed can only be in JSON or XML.
| \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Capture
\nCapture action performs speech recognition of a specified duration. The recognized text can be used in other actions of the scenario.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| capture | \nstring | \nRequired.
Variable name. If speech recognition matches one of the specified keyPhrases, a variable with this name will be set to match the keyphrase. Otherwise, this variable will be an empty string. Together with this variable, an implicit variable that contains the full text of the captured speech will be created. The name of this variable is constructed by adding _Full suffix to the variable name.
| \n
\n\n| timeout | \ninteger | \nNumber of seconds used for capturing speech or digits failover. Minimum value is 1 and maximum value is 30. Can be overriden with speechOptions.maxSilence. | \n
\n\nspeechOptions
{
language
keyPhrases
maxSilence
} | \nobejct
string
array of strings
integer
| \nRequired.
Language used in speech that needs to be captured. For full list of supported languages see LINK.
Array of keyphrases used for matching capturing speech. If full captured text contains one of the specified phrases, that phrase will be set in variable specified in capture parameter. If keyphrases are not set or no matching is done, variable will be set to empty string. Every keyphrase can contain up to 5 words and number of keyphrases is not limited.
If used, this parameter defines the number of seconds of silence that will stop capturing. For example value of 3 defines that capturing stops as soon as 3 seconds of silence is detected or when timeout expires, whichever happens first. Minimum value is 1 and maximum value is 5. | \n
\n\ndtmfOptions
{
maxInputLength
mappedValues
} | \nobject
integer
object
| \n
Maximum acceptable number of digits. Capturing is stopped after this number of digits has been entered. Max accepted value is 255. If not set, maximum value will be used.
Map of expected collected DTMF values with some real meaning. (Example: if you have multilingual IVR, and option for users to press 1 to enter \"English\" menu, you can define {\"1\":\"English\"}, so the reporting and analysis will be easier). When this option is defined additional variable is present in the scenario. If you set your capture action variable name to myVar, then you will get additional variable myVar_Meaning containing the mapped value for a collected DTMF. | \n
\n\n| sendToReports | \nstring | \nChoose if you want to show DTMF inputs in Voice reports and logs. Options are: ALWAYS (always send - default value), MASKED (send masked - xxxx will be shown in reports and logs), NEVER (don't send - DTMF inputs will not be shown in reports and logs).
| \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Collect
\nCollect action reads the DTMF input from the user’s phone and saves it into a variable. Saved variable can be used within the IVR in any other action that allows variable usage. (e.g. switch/case).
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| collectInto | \nstring | \nRequired.
The name of the variable to set. | \n
\n\noptions
{
maxInputLength
timeout
sendToReports
mappedValues
} | \nobject
integer
integer
string
object | \nRequired
Maximum acceptable number of digits. Stops reading after maxdigits have been entered (without requiring the user to press '#' key). Max accepted value is 255. If set to 0 then max value is applied.
Timeout in seconds for user to press the digit(s). Default value is 5. Max value is 30.
Choose if you want to show DTMF inputs in Voice reports and logs. Options are: ALWAYS (always send - default value), MASKED (send masked - xxxx will be shown in reports and logs), NEVER (don't send - DTMF inputs will not be shown in reports and logs).
Map of expected collected DTMF values with some real meaning. (Example: if you have multilingual IVR, and option for users to press 1 to enter \"English\" menu, you can define {\"1\":\"English\"}, so the reporting and analysis will be easier). When this option is defined additional variable is present in the scenario. If you set your collect action variable name to myVar, then you will get additional variable myVar_Meaning containing the mapped value for a collected DTMF. | \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Dial
\nDial action performs a call redirection, joining the user's call with another destination. After Dial action the following actions are forbidden: Say, Collect, Dial, Dial to Many, Dial to WebRTC, Dial to SIP trunk, Dial to Conversations, Play, Record and Play from Recording.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| dial | \nstring | \nRequired.
must be a valid E164 MSISDN; the parameter can be constructed using variables | \n
\n\noptions
{
senderId
maxCallDuration
} | \nobject
string
integer
| \nRequired
must be a valid E164 MSISDN; the parameter can be constructed using variables
If set, call transfer will be limited by maxCallDuration seconds, must be a positive number, no upper bound.
| \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Dial to Many
\nDial to Many action performs a call redirection to multiple destinations, joining the user’s call only with the destination that answered the call first. After Dial to Many action the following actions are forbidden: Say, Collect, Dial, Dial to Many, Dial to WebRTC, Dial to SIP trunk, Dial to Conversations, Play, Record and Play from Recording.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\ndialToMany
[{
number
numbers
}] | \narry of objects
string
string | \nRequired.
must be a valid E164 MSISDN; the parameter can be constructed using variables.
must be a comma-separated list of valid E164 MSISDN numbers; the parameter can be constructed using variables | \n
\n\noptions
{
parallel
senderId
maxCallDuration
ringTimeout
| \nobect
boolean
string
integer
integer | \n
Flag indicating that parallel (true), or sequential (false) Dial to Many will be executed.
Must be a valid E164 MSISDN; the parameter can be constructed using variables.
If set, call transfer will be limited by maxCallDuration seconds; must be a positive number, no upper bound.
If set limits the duration of the ringing of transferred calls in seconds. The default value is 30 seconds. This parameter can be changed only for sequential calls. | \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Dial to WebRTC
\nDial to WebRTC action performs a call redirection to WebRTC application, joining the user’s call with the WebRTC application. After Dial to WebRTC action the following actions are forbidden: Say, Collect, Dial, Dial to Many, Dial to WebRTC, Dial to SIP trunk, Dial to Conversations, Play, Record and Play from Recording.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| dialToWebRTC | \nstring | \nRequired.
Web and in-app calls applicationId. Read more about Web and in-app calls here | \n
\n\n
\n
Dial to SIP trunk
\nDial to SIP trunk action performs a call to the specified SIP trunk. SIP trunk must be created on VHD platform before using this action. After Dial to SIP trunk action the following actions are forbidden: Say, Collect, Dial, Dial to Many, Dial to WebRTC, Dial to SIP trunk, Dial to Conversations, Play, Record and Play from Recording.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\ndialToSipTrunk
| \nobject | \nRequired.
Only one of these two properties (ipAddress, domainName) can be set. | \n
\n\noptions
{
from
to
headers
] | \nobject
string
string
object | \n
String identifying who is calling. The parameter can be constructed using variables.
String identifying who is called. The parameter can be constructed using variables.
Additional headers to be sent to SIP trunk. If header key or value contains \\n or \\r, these characters will be removed. Header size is limited to 256 bytes, which includes header key and value together. X- prefix will be added internally to all headers. The parameter can be constructed using variables. | \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Dial to Conversations
\nDial to Conversations action performs a call redirection to the VHD Conversations platform, joining the user’s call with an agent. After Dial to Conversations action the following actions are forbidden: Say, Collect, Dial, Dial to Many, Dial to WebRTC, Dial to SIP trunk, Dial to Conversations, Play, Record and Play from Recording.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\ndialToConversations
{
options
{
tags
}
} | \nobject
object
array of strings | \nRequired.
Only one of these two properties (ipAddress, domainName) can be set.
Required
Contains options to be associated to the dial to conversations action
An array of conversation tag names that are assigned to this conversation for better categorization of the topics or customer intent. Value can be an array of tag names, empty array, or null value. | \n
\n\n
\n
For-Each
\nFor-each action is a control statement that executes a block of code for each of the values within the supplied list. The Supplied list of values can be static or dynamic (defined as user variable).
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| for-each | \nstring | \nRequired.
Variable name that will be used inside the loop to represent single value from supplied list of values. | \n
\n\n| in | \nstring | \nRequired.
Delimited string representing list of values; the parameter can be constructed using variables. | \n
\n\n| delimiter | \nstring | \nDelimiter used for separating values in supplied list of values; the parameter can be constructed using variables. Default is comma. | \n
\n\n| do | \narry of objects | \nRequired. | \n
\n\n
\n
Go-To
\nGo-To action is used to go back to some specified action that was already executed in the scenario and continue the execution from that point.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| goTo | \ninteger | \nRequired.
The actionId of an action to which to jumpç | \n
\n\noptions
{
gotoLimit
countVariable
} | \nobject
integer
string | \n
Maximum number of times goto can jump to specified action. Valid values are from 1 to 100.
Name of the variable which counts passes through goto action. | \n
\n\n
\n
Hang-up
\nHangup action marks the end of the IVR flow execution, leading to the call actually being hung up.
\n\n\n\n
Property | \nType | \nDescription | \n
\n\n\n\n| Hang-up | \nstring | \nValue: \"hangup\" | \n
\n\n
\n
If-Then-Else
\nIf-Then-Else action provides simple branching based on a condition. If the condition evaluates to true, the then block is executed, otherwise the else block is executed. Only one of the blocks is required to be non-empty.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| If-Then-Else | \nstring | \nRequired.
The expression to evaluate | \n
\n\n| then | \narray of objects | \nThe actions to execute if condition is evaluated to true | \n
\n\n| else | \narry of objects | \nThe actions to execute if condition is evaluated to false | \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Machine Detection
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| Machine Detection | \nstring | \nRequired.
Value: \"machineDetection\"
Machine Detection action detects answering machines at the beginning of the call. This action sets machineAnswered variable upon completion to true or false. Machine Detection introduces a delay of approximately 4s. This is the minimum time needed for machine detection. Machine Detection action has to be followed by a condition action that uses the value of machineAnswered for branching into the 'human answered' block and the 'answering machine answered' block. The 'answering machine' block can have a Say/Play/PlayFromRecording action or a Hangup action. If answering machine is detected, and a Say/Play/Play from Recording action is up next - the voice message will start playing into the voice mail only after the answering machine is finished with its greeting. | \n
\n\n
\n
Pause
\nPause action pauses execution of the IVR scenario for the provided duration.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| pause | \nnumber | \nRequired.
the amount to wait in seconds, from 0 (exclusive) to 5 (inclusive) | \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Play
\nPlay action performs playback of audio provided by the client’s URL. Supported formats of the provided file are aac, aiff, m4a, mp2, mp3, mp4 (audio only), ogg, wav and wma. Our platform needs to have permission to make GET and HEAD HTTP requests on the provided URL. Standard http ports (like 80, 8080, etc.) are advised.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| playFromUrl | \nstring | \nRequired.
Audio file URL. | \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
playFromRecording
\nPlay from Recording Action plays audio recorded from the current or some other call.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| playFromRecording | \nstring | \nRequired.
Can be null (play last recorded audio from the current call), number (play the recording passed index) or text (play recording with identifier - current or previous call) | \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Record
\nRecord action records a portion of the call. The recording starts at the moment where the Record action is added in the IVR.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| record | \ninteger | \nRequired.
The duration to record for in seconds; null for unlimited. | \n
\n\noptions
{
escapeDigits
beep
maxSilence
identifier
} | \nobject
string
boolean
integer
string | \n
DTMF codes which should stop recording when input by the user.
Flag indicating a beep sound should be played at the start of the recording.
The amount of silence to wait for before stopping the recording.
The identifier for the recording. Identified recordings can be reused in Play from Recording. The parameter can be constructed using variables. | \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Rpeat-Until
\nThis action is deprecated and should not be used, as it leads to incorrect behaviour and it will not be supported in the future. Please, use repeat-while loop instead.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| repeat | \narray of objects | \nRequired. | \n
\n\n| until | \nstring | \nThe expression to evaluate. | \n
\n\n
\n
Repeat-While
\nRepeat-While action is a control flow statement that repeatedly executes a block of code, as long as the boolean condition in the while field is true. Comparison is done using equal (==) or not equal (!=) operators. Make sure not to provide a condition that causes an infinite loop.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| repeat | \narray of objects | \nRequired. | \n
\n\n| while | \nstring | \nThe expression to evaluate. | \n
\n\n
\n
Say
\nSay action converts provided text into an audio file which is played during the call based on the provided parameters. Message text can be up to 1400 characters long.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| say | \nstring | \nRequired.
Message text. Cannot contain only punctuation. | \n
\n\noptions
{
language
voice
{
name
gender
}
speechRate
}
| \nobject
string
object
string
string
number | \nThe expression to evaluate.
Must be defined for correct pronunciation.
Used to define the voice in which the text would be synthesized.
Name of the voice in which the text would be synthesized.
Gender in which the text would be synthesized.
Must be within [0.5 - 2.0] range, default value is 1. | \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Send SMS
\nSend SMS action creates and sends a text message from the scenario.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\nsendSms
{
text
from
to
} | \nobject
string
string
string | \nRequired.
Message text. Cannot contain only punctuation.
Required.
The text of the message that will be sent.
Represents sender ID and it can be alphanumeric or numeric; alphanumeric sender ID length should be between 3 and 11 characters; numeric sender ID length should be between 3 and 14 characters; the parameter can be constructed using variables.
Required.
Must be a valid E164 MSISDN; the parameter can be constructed using variables
| \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
]
\nSet Variable
\nSet variable action makes it possible to set a variable defined inside the IVR scenario to a specified value.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| setVariable | \nstring | \nRequired.
Name of a variable. | \n
\n\n| value | \nstring | \nValue to which the variable should be set. | \n
\n\n
\n
Switch-Case
\nSwitch-Case action takes a saved variable (obtained via either a Collect, Call API action or scenario parameters) and performs flow control based on it. It works similarly to the switch case block, using case-sensitive comparison.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| switch | \nstring | \nRequired.
Name of the variable whose value to inspect. | \n
\n\ncase
{
_default
} | \nobject
array of objects | \nObject whose keys are possible variable values, and values are arrays of actions.
Array of actions to execute if none of the conditions above are met. | \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
While-Do
\nWhile-Do action executes the do field block of code as long as a specified condition is true in the while field. As with Repeat-While, comparison is done using equal (==) or not equal (! =) operators. Make sure not to provide a condition that causes an infinite loop.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| while | \nstring | \nRequired.
The expression to evaluate. | \n
\n\n| do | \narry of objects | \nRequired.
| \n
\n\n
\n
Response
\nDefault sucessful response
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| createTime | \nobject | \nCreation timestamp. | \n
\n\n| description | \nobject | \nScenario description. | \n
\n\n| id | \nstring | \nScenario key. It is used for launching IVR scenario. | \n
\n\n| name | \n | \nScenario name. | \n
\n\n| script | \nobject | \nThe list of scenario actions. | \n
\n\n| updateTime | \nstring | \nUpdate timestamp | \n
\n\n
\n
Error response
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| notifyUrl | \nString | \nThe URL on your callback server on which the Delivery report will be sent. | \n
\n\n| notifyContentType | \nString | \nPreferred Delivery report content type. Can be application/json or application/xml. | \n
\n\n| script[].options.customRingback | \nObject | \nCustom ringback tones configuration. Allows specifying different audio files to play during ringing and when the call fails. | \n
\n\n| script[].options.customRingback.ringingAudio | \nObject | \nRequired. | \n
\n\n| script[].options.customRingback.ringingAudio.type | \nString | \nRequired. Type of audio content One of: FILE, URL. | \n
\n\n| script[].options.customRingback.failedAudio | \nObject | \n | \n
\n\n| script[].dialToConversations.options.tagIdentifierType | \nString | \nDefines which identifier will be provided in the tags field. Possible values are ID and NAME. If not provided, default value of NAME is used. One of: ID, NAME. | \n
\n\n| script[].options.goToLimit | \nInt | \nMaximum number of times goto can jump to specified action. Valid values are from 1 to 100. | \n
\n\n| script[].answeringMachineDetection | \nBoolean | \nRequired. Indicates whether machine detection should be performed. | \n
\n\n| script[].options.waitEndOfMessageDetection | \nString | \nIndicates whether end of the message detection is enabled for the call. ALWAYS specifies that after detection of MACHINE the script will always wait for the end of the message before executing actions defined in onMachineDetected. NEVER specifies that after detection of MACHINE actions defined in onMachineDetected will be executed immediately. ON_DETECTING specifies that end of the message will be respected as long as actions in onDetecting are in progress, once these actions finish the script jumps to onMachineDetected section immediately. One of: ALWAYS, NEVER, ON_DETECTING. | \n
\n\n| script[].options.endOfMessageDetectionTimeout | \nInt | \nSpecifies the timeout (in seconds) to wait for the end of the message after a machine is detected. If set, actions defined in onMachineDetected will be executed only after the end of the message is detected or the timeout is reached. If not set, onMachineDetected actions will be triggered immediately after machine detection. If the timeout is reached before the end of the message, actions defined in onTimeout will be executed instead. | \n
\n\n| script[].onDetecting | \nArray | \nArray of actions to execute while detection is in progress. A maximum of two actions of specific types (Play, Say, Collect) can be defined. | \n
\n\n| script[].onMachineDetected | \nArray | \nRequired. Array of actions to execute when a machine is detected, or when the end of the message is reached if endOfMessageDetectionTimeout is set. Actions defined in onDetecting are interrupted before these actions begin. If you do not intend to continue the scenario after onMachineDetected, include a Hangup action at the end of this section to terminate the call. | \n
\n\n| script[].onTimeout | \nArray | \nArray of actions to execute when a machine is detected and the endOfMessageDetectionTimeout is reached. If you do not intend to continue the scenario after onTimeout, include a Hangup action at the end of this section to terminate the call. | \n
\n\n| script[].onHumanDetected | \nArray | \nArray of actions to execute when a human is detected. Actions defined in onDetecting are interrupted before these actions begin. To avoid this interruption, omit this section and define the remaining scenario after this action. If you do not intend to continue the scenario after onHumanDetected, include a Hangup action at the end of this section to terminate the call. | \n
\n\n| script[].options.loopCount | \nInt | \nNumber of times the file will be played. | \n
\n\n| script[].playFromUpload | \nString | \nRequired. ID of uploaded file. The parameter can be constructed using variables. | \n
\n\n| script[].playTty | \nString | \nRequired. Text that will be played in Baudot tones. The parameter can be constructed using variables. | \n
\n\n| _script[].case._default | \nArray | \nArray of actions to execute if none of the conditions above are met. | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| notifyUrl | \nString | \nThe URL on the client's callback server on which the Delivery report will be sent. | \n
\n\n| notifyContentType | \nString | \nPreferred Delivery report content type. Can be application/json or application/xml. | \n
\n\n| script[].options.customRingback | \nObject | \nCustom ringback tones configuration. Allows specifying different audio files to play during ringing and when the call fails. | \n
\n\n| script[].options.customRingback.ringingAudio | \nObject | \nRequired. | \n
\n\n| script[].options.customRingback.ringingAudio.type | \nString | \nRequired. Type of audio content One of: FILE, URL. | \n
\n\n| script[].options.customRingback.failedAudio | \nObject | \n | \n
\n\n| script[].dialToConversations.options.tagIdentifierType | \nString | \nDefines which identifier will be provided in the tags field. Possible values are ID and NAME. If not provided, default value of NAME is used. One of: ID, NAME. | \n
\n\n| script[].options.goToLimit | \nInt | \nMaximum number of times goto can jump to specified action. Valid values are from 1 to 100. | \n
\n\n| script[].answeringMachineDetection | \nBoolean | \nRequired. Indicates whether machine detection should be performed. | \n
\n\n| script[].options.waitEndOfMessageDetection | \nString | \nIndicates whether end of the message detection is enabled for the call. ALWAYS specifies that after detection of MACHINE the script will always wait for the end of the message before executing actions defined in onMachineDetected. NEVER specifies that after detection of MACHINE actions defined in onMachineDetected will be executed immediately. ON_DETECTING specifies that end of the message will be respected as long as actions in onDetecting are in progress, once these actions finish the script jumps to onMachineDetected section immediately. One of: ALWAYS, NEVER, ON_DETECTING. | \n
\n\n| script[].options.endOfMessageDetectionTimeout | \nInt | \nSpecifies the timeout (in seconds) to wait for the end of the message after a machine is detected. If set, actions defined in onMachineDetected will be executed only after the end of the message is detected or the timeout is reached. If not set, onMachineDetected actions will be triggered immediately after machine detection. If the timeout is reached before the end of the message, actions defined in onTimeout will be executed instead. | \n
\n\n| script[].onDetecting | \nArray | \nArray of actions to execute while detection is in progress. A maximum of two actions of specific types (Play, Say, Collect) can be defined. | \n
\n\n| script[].onMachineDetected | \nArray | \nRequired. Array of actions to execute when a machine is detected, or when the end of the message is reached if endOfMessageDetectionTimeout is set. Actions defined in onDetecting are interrupted before these actions begin. If you do not intend to continue the scenario after onMachineDetected, include a Hangup action at the end of this section to terminate the call. | \n
\n\n| script[].onTimeout | \nArray | \nArray of actions to execute when a machine is detected and the endOfMessageDetectionTimeout is reached. If you do not intend to continue the scenario after onTimeout, include a Hangup action at the end of this section to terminate the call. | \n
\n\n| script[].onHumanDetected | \nArray | \nArray of actions to execute when a human is detected. Actions defined in onDetecting are interrupted before these actions begin. To avoid this interruption, omit this section and define the remaining scenario after this action. If you do not intend to continue the scenario after onHumanDetected, include a Hangup action at the end of this section to terminate the call. | \n
\n\n| script[].options.loopCount | \nInt | \nNumber of times the file will be played. | \n
\n\n| script[].playFromUpload | \nString | \nRequired. ID of uploaded file. The parameter can be constructed using variables. | \n
\n\n| script[].playTty | \nString | \nRequired. Text that will be played in Baudot tones. The parameter can be constructed using variables. | \n
\n\n| _script[].case._default | \nArray | \nArray of actions to execute if none of the conditions above are met. | \n
\n\n| lastUsageDate | \nString | \nLast usage date. null for scenarios that are used last time before 2024-01-01. | \n
\n\n
\n
Search your Voice IVR scenarios. Use the query parameters to filter them. To get one scenario by its ID, use Get IVR scenario.
\nQuery parameters
\nAll parameters are optional.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| page | \nInt | \nPage number you want to see. Default is 1. | \n
\n\n| pageSize | \nInt | \nSize of the page you want to see. Default is 50. | \n
\n\n| name | \nString | \nThe name to search by. | \n
\n\n| label | \nString | \nThe label of scenario to search by. | \n
\n\n| lastUsageDateSince | \nString | \nLower limit of last usage date in yyyy-MM-dd format. Note: For scenarios where lastUsageDate is null, filtering matches createTime. | \n
\n\n| lastUsageDateUntil | \nString | \nUpper limit of last usage date in yyyy-MM-dd format. Note: For scenarios where lastUsageDate is null, filtering matches createTime. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\nAdditional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| [].description | \nString | \nScenario description. | \n
\n\n| [].notifyUrl | \nString | \nThe URL on the client's callback server on which the Delivery report will be sent. | \n
\n\n| [].notifyContentType | \nString | \nPreferred Delivery report content type. Can be application/json or application/xml. | \n
\n\n| [].record | \nBoolean | \nIndicates if all calls using the scenario should be recorded. | \n
\n\n| [].script[].options | \nObject | \nRequired. | \n
\n\n| [].script[].options.method | \nString | \nRequired. Http method One of: GET, POST, PUT, DELETE, PATCH. | \n
\n\n| [].script[].options.headers | \nObject | \nHTTP headers | \n
\n\n| [].script[].options.body | \nString | \nRequired. HTTP body. The parameter can be constructed using variables. | \n
\n\n| [].script[].options.collectResponse | \nBoolean | \nIf this field is set, the system will parse the response and save all its fields as variables inside scenario. For example, if the response is {\"letters\": \"abcd\", \"numbers\": 12345}, the system will store variables letters and numbers, with values abcd and 12345 respectively. Nested JSON and XML objects are also supported; nested fields are resolved with underscore notation. For example, if the response is {\"a\": {\"b\": {\"c\": \"xyz\"}}}, the system will store a_b_c with value xyz. The response cannot contain duplicate keys or predefined words. Check the example Call Api with response. Response that is parsed can only be in JSON or XML. Predefined words: from, to, startTime, answerTime and machineAnswered. | \n
\n\n| [].script[].actionId | \nInt | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n| [].script[].capture | \nString | \nRequired. Variable name. If speech recognition matches one of the specified keyPhrases, a variable with this name will be set to match the keyphrase. Otherwise, this variable will be an empty string. Together with this variable, an implicit variable that contains the full text of the captured speech will be created. The name of this variable is constructed by adding _Full suffix to the variable name. | \n
\n\n| [].script[].timeout | \nInt | \nRequired. Number of seconds used for capturing speech or digits failover. Minimum value is 1 and maximum value is 30. Can be overriden with speechOptions.maxSilence. | \n
\n\n| [].script[].beep | \nBoolean | \nFlag indicating whether a beep sound should play at the start of capture. | \n
\n\n| [].script[].speechOptions | \nObject | \nRequired. | \n
\n\n| [].script[].speechOptions.language | \nString | \nRequired. Language used in speech that needs to be captured. For full list of supported languages see Supported languages. | \n
\n\n| [].script[].speechOptions.keyPhrases | \nArray | \nArray of keyphrases used for matching capturing speech. If full captured text contains one of the specified phrases, that phrase will be set in variable specified in capture parameter. If keyphrases are not set or no matching is done, variable will be set to empty string. Every keyphrase can contain up to 5 words and number of keyphrases is not limited. | \n
\n\n| [].script[].speechOptions.maxSilence | \nInt | \nRequired. If used, this parameter defines the number of seconds of silence that will stop capturing. For example value of 3 defines that capturing stops as soon as 3 seconds of silence is detected or when timeout expires, whichever happens first. Minimum value is 1 and maximum value is 5. The value must be lower than the timeout value. | \n
\n\n| [].script[].dtmfOptions | \nObject | \n | \n
\n\n| [].script[].dtmfOptions.maxInputLength | \nInt | \nRequired. Maximum acceptable number of digits. Capturing is stopped after this number of digits has been entered. If not set, maximum value will be used. | \n
\n\n| [].script[].dtmfOptions.mappedValues | \nObject | \nMap of expected collected DTMF values with some real meaning. (Example: if you have multilingual IVR, and option for users to press 1 to enter \"English\" menu, you can define {\"1\":\"English\"}, so the reporting and analysis will be easier). When this option is defined additional variable is present in the scenario. If you set your capture action variable name to myVar, then you will get additional variable myVar_Meaning containing the mapped value for a collected DTMF. Keys can contain only digits and asterisks. | \n
\n\n| [].script[].sendToReports | \nString | \nChoose if you want to show DTMF inputs in Voice reports and logs. Options are: ALWAYS (always send - default value), MASKED (send masked - xxxx will be shown in reports and logs), NEVER (don't send - DTMF inputs will not be shown in reports and logs). One of: ALWAYS, MASKED, NEVER. | \n
\n\n| [].script[].collectInto | \nString | \nRequired. The name of the variable to set. | \n
\n\n| [].script[].dial | \nString | \nRequired. must be a valid E164 MSISDN; the parameter can be constructed using variables | \n
\n\n| [].script[].options.senderId | \nString | \nmust be a valid E164 MSISDN; the parameter can be constructed using variables | \n
\n\n| [].script[].options.maxCallDuration | \nInt | \nIf set, call transfer will be limited by maxCallDuration seconds, must be a positive number, no upper bound. | \n
\n\n| [].script[].options.customRingback | \nObject | \nCustom ringback tones configuration. Allows specifying different audio files to play during ringing and when the call fails. | \n
\n\n| [].script[].options.customRingback.ringingAudio | \nObject | \nRequired. | \n
\n\n| [].script[].options.customRingback.ringingAudio.type | \nString | \nRequired. Type of audio content One of: FILE, URL. | \n
\n\n| [].script[].options.customRingback.failedAudio | \nObject | \n | \n
\n\n| [].script[].dialToMany | \nArray | \nRequired. | \n
\n\n| [].script[].options.parallel | \nBoolean | \nFlag indicating that parallel (true), or sequential (false) Dial to Many will be executed. | \n
\n\n| [].script[].dialToConversations | \nObject | \nRequired. | \n
\n\n| [].script[].dialToConversations.options.tagIdentifierType | \nString | \nDefines which identifier will be provided in the tags field. Possible values are ID and NAME. If not provided, default value of NAME is used. One of: ID, NAME. | \n
\n\n| [].script[].dialToConversations.options.tags | \nArray | \nRequired. An array of conversation tag names or ids that are assigned to this conversation for better categorization of the topics or customer intent. Value can be an array of tag names/ids, empty array, or null value. | \n
\n\n| [].script[].for-each | \nString | \nRequired. Variable name that will be used inside the loop to represent single value from supplied list of values. | \n
\n\n| [].script[].delimiter | \nString | \nDelimiter for separating values in the list of values. | \n
\n\n| [].script[].do | \nArray | \nRequired. Array of actions to execute. | \n
\n\n| [].script[].goTo | \nInt | \nRequired. The actionId of an action to which to jump | \n
\n\n| [].script[].options.goToLimit | \nInt | \nMaximum number of times goto can jump to specified action. Valid values are from 1 to 100. | \n
\n\n| [].script[].options.countVariable | \nString | \nName of the variable which counts passes through goto action | \n
\n\n| [].script[].if | \nString | \nRequired. The expression to evaluate | \n
\n\n| [].script[].then | \nArray | \nThe actions to execute if condition is evaluated to true. | \n
\n\n| [].script[].else | \nArray | \nThe actions to execute if condition is evaluated to false. | \n
\n\n| [].script[].answeringMachineDetection | \nBoolean | \nRequired. Indicates whether machine detection should be performed. | \n
\n\n| [].script[].options.waitEndOfMessageDetection | \nString | \nIndicates whether end of the message detection is enabled for the call. ALWAYS specifies that after detection of MACHINE the script will always wait for the end of the message before executing actions defined in onMachineDetected. NEVER specifies that after detection of MACHINE actions defined in onMachineDetected will be executed immediately. ON_DETECTING specifies that end of the message will be respected as long as actions in onDetecting are in progress, once these actions finish the script jumps to onMachineDetected section immediately. One of: ALWAYS, NEVER, ON_DETECTING. | \n
\n\n| [].script[].options.endOfMessageDetectionTimeout | \nInt | \nSpecifies the timeout (in seconds) to wait for the end of the message after a machine is detected. If set, actions defined in onMachineDetected will be executed only after the end of the message is detected or the timeout is reached. If not set, onMachineDetected actions will be triggered immediately after machine detection. If the timeout is reached before the end of the message, actions defined in onTimeout will be executed instead. | \n
\n\n| [].script[].onDetecting | \nArray | \nArray of actions to execute while detection is in progress. A maximum of two actions of specific types (Play, Say, Collect) can be defined. | \n
\n\n| [].script[].onMachineDetected | \nArray | \nRequired. Array of actions to execute when a machine is detected, or when the end of the message is reached if endOfMessageDetectionTimeout is set. Actions defined in onDetecting are interrupted before these actions begin. If you do not intend to continue the scenario after onMachineDetected, include a Hangup action at the end of this section to terminate the call. | \n
\n\n| [].script[].onTimeout | \nArray | \nArray of actions to execute when a machine is detected and the endOfMessageDetectionTimeout is reached. If you do not intend to continue the scenario after onTimeout, include a Hangup action at the end of this section to terminate the call. | \n
\n\n| [].script[].onHumanDetected | \nArray | \nArray of actions to execute when a human is detected. Actions defined in onDetecting are interrupted before these actions begin. To avoid this interruption, omit this section and define the remaining scenario after this action. If you do not intend to continue the scenario after onHumanDetected, include a Hangup action at the end of this section to terminate the call. | \n
\n\n| [].script[].pause | \nNumber | \nRequired. the amount to wait in seconds, from 0 (exclusive) to 5 (inclusive) | \n
\n\n| [].script[].playFromUrl | \nString | \nRequired. Audio file URL. The parameter can be constructed using variables. | \n
\n\n| [].script[].options.loopCount | \nInt | \nNumber of times the file will be played. | \n
\n\n| [].script[].playFromRecording | \nString | \nRequired. Identifier of the recorded file. The parameter can be constructed using variables. | \n
\n\n| [].script[].playFromUpload | \nString | \nRequired. ID of uploaded file. The parameter can be constructed using variables. | \n
\n\n| [].script[].playTty | \nString | \nRequired. Text that will be played in Baudot tones. The parameter can be constructed using variables. | \n
\n\n| [].script[].options.escapeDigits | \nString | \nDTMF codes which should stop recording when input by the user. | \n
\n\n| [].script[].options.identifier | \nString | \nThe identifier for the recording. Identified recordings can be reused in Play from Recording. The parameter can be constructed using variables. | \n
\n\n| [].script[].repeat | \nArray | \nRequired. Array of actions to execute. | \n
\n\n| [].script[].while | \nString | \nRequired. The expression to evaluate. | \n
\n\n| [].script[].say | \nString | \nRequired. Message text. SSML (Speech Synthesis Markup Language) is supported and can be used to fully customize pronunciation of the provided text. The parameter can be constructed using variables. | \n
\n\n| [].script[].options.voice | \nObject | \n | \n
\n\n| [].script[].options.voice.gender | \nString | \nGender in which the text would be synthesized. The parameter can be constructed using variables. | \n
\n\n| [].script[].options.speechRate | \nNumber | \nMust be within [0.5 - 2.0] range, default value is 1. | \n
\n\n| [].script[].sendSms | \nObject | \nRequired. | \n
\n\n| [].script[].sendSms.text | \nString | \nRequired. The text of the message that will be sent. | \n
\n\n| [].script[].sendSms.from | \nString | \nRequired. Represents sender ID and it can be alphanumeric or numeric; alphanumeric sender ID length should be between 3 and 11 characters; numeric sender ID length should be between 3 and 14 characters; the parameter can be constructed using variables | \n
\n\n| [].script[].setVariable | \nString | \nRequired. Name of a variable. | \n
\n\n| [].script[].value | \nString | \nRequired. Value to which the variable should be set. The parameter can be constructed using variables. | \n
\n\n| [].script[].switch | \nString | \nRequired. Name of the variable whose value to inspect. | \n
\n\n| [].script[].case | \nObject | \nRequired. | \n
\n\n| _[].script[].case._default | \nArray | \nArray of actions to execute if none of the conditions above are met. | \n
\n\n| [].updateTime | \nString | \nUpdate timestamp | \n
\n\n
\n
Page number you want to see. Default is 1.
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Size of the page you want to see. Default is 50.
\n","type":"text/plain"},"key":"pageSize","value":""},{"disabled":true,"description":{"content":"The name to search by.
\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"The label of scenario to search by.
\n","type":"text/plain"},"key":"label","value":""},{"disabled":true,"description":{"content":"Lower limit of last usage date in yyyy-MM-dd format. Note: For scenarios where lastUsageDate is null, filtering matches createTime.
\n","type":"text/plain"},"key":"lastUsageDateSince","value":""},{"disabled":true,"description":{"content":"Upper limit of last usage date in yyyy-MM-dd format. Note: For scenarios where lastUsageDate is null, filtering matches createTime.
\n","type":"text/plain"},"key":"lastUsageDateUntil","value":""}],"variable":[]}},"response":[{"id":"4163c0ed-2852-4110-84a1-f4b96b129b12","name":"Search Voice IVR Scenarios","originalRequest":{"method":"GET","header":[],"url":"https://go2.vhdmedia.se/voice/ivr/1/scenarios/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, PATCH, DELETE, COPY, HEAD, OPTIONS, LINK, UNLINK, PURGE"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, X-Enrollment-Token, Cache-Control, X-Requested-With"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"2400"},{"key":"Date","value":"Tue, 23 May 2023 15:41:17 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684856477618441228"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"5484CAA003789D634478D4456B717B78\",\n \"name\": \"Call API\",\n \"description\": \"Perform a POST request to provided URL with headers and payload.\",\n \"createTime\": \"2023-05-23T15:39:40.490+0000\",\n \"updateTime\": null,\n \"script\": [\n {\n \"request\": \"https://www.example.com/webhook\",\n \"options\": {\n \"method\": \"POST\",\n \"headers\": {\n \"content-type\": \"application/json\"\n },\n \"body\": {\n \"payload\": \"$ finished the IVR.\"\n }\n }\n }\n ]\n },\n {\n \"id\": \"BE658F4FF7F221CD6AC4D79180A86001\",\n \"name\": \"Call Api\",\n \"description\": \"Collect users input and submits it with a POST request to a url.\",\n \"createTime\": \"2023-04-25T08:31:00.680+0000\",\n \"updateTime\": null,\n \"script\": [\n {\n \"say\": \"Hello, please press 1 if you wish to subscribe to our newsletter.\"\n },\n {\n \"collectInto\": \"myCollectedVariable\",\n \"options\": {\n \"maxInputLength\": 1,\n \"timeout\": 5\n }\n },\n {\n \"request\": \"https://www.myUrl.com/subscription\",\n \"options\": {\n \"method\": \"POST\",\n \"headers\": {\n \"custom-header\": \"header-value\"\n },\n \"body\": {\n \"shouldSubscribe\": \"${myCollectedVariable}\"\n }\n }\n },\n {\n \"if\": \"${myCollectedVariable == 1}\",\n \"then\": [\n {\n \"say\": \"You subscribed successfully.\"\n }\n ]\n }\n ]\n },\n {\n \"id\": \"9FF925EACAEB88E5BC113A4E48085065\",\n \"name\": \"Call Api\",\n \"description\": \"Collect users input and submits it with a POST request to a url.\",\n \"createTime\": \"2023-04-25T08:28:22.540+0000\",\n \"updateTime\": null,\n \"script\": [\n {\n \"say\": \"Hello, please press 1 if you wish to subscribe to our newsletter.\"\n },\n {\n \"collectInto\": \"myCollectedVariable\",\n \"options\": {\n \"maxInputLength\": 1,\n \"timeout\": 5\n }\n },\n {\n \"request\": \"https://www.myUrl.com/subscription\",\n \"options\": {\n \"method\": \"POST\",\n \"headers\": {\n \"custom-header\": \"header-value\"\n },\n \"body\": {\n \"shouldSubscribe\": \"${myCollectedVariable}\"\n }\n }\n },\n {\n \"if\": \"${myCollectedVariable == 1}\",\n \"then\": [\n {\n \"say\": \"You subscribed successfully.\"\n }\n ]\n }\n ]\n },\n {\n \"id\": \"9350D08A12EE1DC76A626E06FA24CDFF\",\n \"name\": \"Call API\",\n \"description\": \"Perform a POST request to provided URL with headers and payload.\",\n \"createTime\": \"2023-04-25T08:23:30.033+0000\",\n \"updateTime\": null,\n \"script\": [\n {\n \"request\": \"https://requestb.in/12345\",\n \"options\": {\n \"method\": \"POST\",\n \"headers\": {\n \"content-type\": \"application/json\"\n },\n \"body\": {\n \"payload\": \"${to} finished the IVR.\"\n }\n }\n }\n ]\n },\n {\n \"id\": \"11389EE29DF6EB63CFE3172065D86543\",\n \"name\": \"Call API\",\n \"description\": \"Perform a POST request to provided URL with headers and payload.\",\n \"createTime\": \"2023-04-21T09:01:07.717+0000\",\n \"updateTime\": null,\n \"script\": [\n {\n \"request\": \"https://requestb.in/12345\",\n \"options\": {\n \"method\": \"POST\",\n \"headers\": {\n \"content-type\": \"application/json\"\n },\n \"body\": {\n \"payload\": \"${to} finished the IVR.\"\n }\n }\n }\n ]\n }\n]"}],"_postman_id":"bb69c545-201d-49ed-8b97-efcc8428ec17"},{"name":"Get IVR scenario","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"id\", \"name\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});","",""],"type":"text/javascript","packages":{}}}],"id":"5e0dcc9d-f719-4eb8-8123-0acbec29d25f","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://go2.vhdmedia.se/voice/ivr/1/scenarios/{{id}}","description":"Use this method to get the scenario using scenarioId in the API endpoint.
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nstring [ 0 .. 255 ] characters | \nRequired.
Scenario identifier. | \n
\n\n
\n
Responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| createTime | \nstring [ 0 .. 255 ] characters | \nCreation timestamp. | \n
\n\n| description | \nstring [ 0 .. 50 ] characters | \nScenario description. | \n
\n\n| id | \nstring | \nScenario key. It is used for launching IVR scenario. | \n
\n\n| name | \nstring | \nScenario name. | \n
\n\n| script | \nobject | \nThe list of scenario actions. | \n
\n\n| updateTime | \nstring | \nUpdate timestamp | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| notifyUrl | \nString | \nThe URL on the client's callback server on which the Delivery report will be sent. | \n
\n\n| notifyContentType | \nString | \nPreferred Delivery report content type. Can be application/json or application/xml. | \n
\n\n| record | \nBoolean | \nIndicates if all calls using the scenario should be recorded. | \n
\n\n| script[].options | \nObject | \nRequired. | \n
\n\n| script[].options.headers | \nObject | \nHTTP headers | \n
\n\n| script[].options.collectResponse | \nBoolean | \nIf this field is set, the system will parse the response and save all its fields as variables inside scenario. For example, if the response is {\"letters\": \"abcd\", \"numbers\": 12345}, the system will store variables letters and numbers, with values abcd and 12345 respectively. Nested JSON and XML objects are also supported; nested fields are resolved with underscore notation. For example, if the response is {\"a\": {\"b\": {\"c\": \"xyz\"}}}, the system will store a_b_c with value xyz. The response cannot contain duplicate keys or predefined words. Check the example Call Api with response. Response that is parsed can only be in JSON or XML. Predefined words: from, to, startTime, answerTime and machineAnswered. | \n
\n\n| script[].actionId | \nInt | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n| script[].capture | \nString | \nRequired. Variable name. If speech recognition matches one of the specified keyPhrases, a variable with this name will be set to match the keyphrase. Otherwise, this variable will be an empty string. Together with this variable, an implicit variable that contains the full text of the captured speech will be created. The name of this variable is constructed by adding _Full suffix to the variable name. | \n
\n\n| script[].timeout | \nInt | \nRequired. Number of seconds used for capturing speech or digits failover. Minimum value is 1 and maximum value is 30. Can be overriden with speechOptions.maxSilence. | \n
\n\n| script[].beep | \nBoolean | \nFlag indicating whether a beep sound should play at the start of capture. | \n
\n\n| script[].speechOptions | \nObject | \nRequired. | \n
\n\n| script[].speechOptions.language | \nString | \nRequired. Language used in speech that needs to be captured. For full list of supported languages see Supported languages. | \n
\n\n| script[].speechOptions.keyPhrases | \nArray | \nArray of keyphrases used for matching capturing speech. If full captured text contains one of the specified phrases, that phrase will be set in variable specified in capture parameter. If keyphrases are not set or no matching is done, variable will be set to empty string. Every keyphrase can contain up to 5 words and number of keyphrases is not limited. | \n
\n\n| script[].speechOptions.maxSilence | \nInt | \nRequired. If used, this parameter defines the number of seconds of silence that will stop capturing. For example value of 3 defines that capturing stops as soon as 3 seconds of silence is detected or when timeout expires, whichever happens first. Minimum value is 1 and maximum value is 5. The value must be lower than the timeout value. | \n
\n\n| script[].dtmfOptions | \nObject | \n | \n
\n\n| script[].dtmfOptions.maxInputLength | \nInt | \nRequired. Maximum acceptable number of digits. Capturing is stopped after this number of digits has been entered. If not set, maximum value will be used. | \n
\n\n| script[].dtmfOptions.mappedValues | \nObject | \nMap of expected collected DTMF values with some real meaning. (Example: if you have multilingual IVR, and option for users to press 1 to enter \"English\" menu, you can define {\"1\":\"English\"}, so the reporting and analysis will be easier). When this option is defined additional variable is present in the scenario. If you set your capture action variable name to myVar, then you will get additional variable myVar_Meaning containing the mapped value for a collected DTMF. Keys can contain only digits and asterisks. | \n
\n\n| script[].sendToReports | \nString | \nChoose if you want to show DTMF inputs in Voice reports and logs. Options are: ALWAYS (always send - default value), MASKED (send masked - xxxx will be shown in reports and logs), NEVER (don't send - DTMF inputs will not be shown in reports and logs). One of: ALWAYS, MASKED, NEVER. | \n
\n\n| script[].collectInto | \nString | \nRequired. The name of the variable to set. | \n
\n\n| script[].dial | \nString | \nRequired. must be a valid E164 MSISDN; the parameter can be constructed using variables | \n
\n\n| script[].options.senderId | \nString | \nmust be a valid E164 MSISDN; the parameter can be constructed using variables | \n
\n\n| script[].options.maxCallDuration | \nInt | \nIf set, call transfer will be limited by maxCallDuration seconds, must be a positive number, no upper bound. | \n
\n\n| script[].options.customRingback | \nObject | \nCustom ringback tones configuration. Allows specifying different audio files to play during ringing and when the call fails. | \n
\n\n| script[].options.customRingback.ringingAudio | \nObject | \nRequired. | \n
\n\n| script[].options.customRingback.ringingAudio.type | \nString | \nRequired. Type of audio content One of: FILE, URL. | \n
\n\n| script[].options.customRingback.failedAudio | \nObject | \n | \n
\n\n| script[].dialToMany | \nArray | \nRequired. | \n
\n\n| script[].dialToMany[].number | \nString | \nRequired. Must be a valid E.164 number; the parameter can be constructed using variables | \n
\n\n| script[].options.parallel | \nBoolean | \nFlag indicating that parallel (true), or sequential (false) Dial to Many will be executed. | \n
\n\n| script[].dialToConversations | \nObject | \nRequired. | \n
\n\n| script[].dialToConversations.options.tagIdentifierType | \nString | \nDefines which identifier will be provided in the tags field. Possible values are ID and NAME. If not provided, default value of NAME is used. One of: ID, NAME. | \n
\n\n| script[].dialToConversations.options.tags | \nArray | \nRequired. An array of conversation tag names or ids that are assigned to this conversation for better categorization of the topics or customer intent. Value can be an array of tag names/ids, empty array, or null value. | \n
\n\n| script[].for-each | \nString | \nRequired. Variable name that will be used inside the loop to represent single value from supplied list of values. | \n
\n\n| script[].delimiter | \nString | \nDelimiter for separating values in the list of values. | \n
\n\n| script[].do | \nArray | \nRequired. Array of actions to execute. | \n
\n\n| script[].goTo | \nInt | \nRequired. The actionId of an action to which to jump | \n
\n\n| script[].options.goToLimit | \nInt | \nMaximum number of times goto can jump to specified action. Valid values are from 1 to 100. | \n
\n\n| script[].options.countVariable | \nString | \nName of the variable which counts passes through goto action | \n
\n\n| script[].then | \nArray | \nThe actions to execute if condition is evaluated to true. | \n
\n\n| script[].else | \nArray | \nThe actions to execute if condition is evaluated to false. | \n
\n\n| script[].answeringMachineDetection | \nBoolean | \nRequired. Indicates whether machine detection should be performed. | \n
\n\n| script[].options.waitEndOfMessageDetection | \nString | \nIndicates whether end of the message detection is enabled for the call. ALWAYS specifies that after detection of MACHINE the script will always wait for the end of the message before executing actions defined in onMachineDetected. NEVER specifies that after detection of MACHINE actions defined in onMachineDetected will be executed immediately. ON_DETECTING specifies that end of the message will be respected as long as actions in onDetecting are in progress, once these actions finish the script jumps to onMachineDetected section immediately. One of: ALWAYS, NEVER, ON_DETECTING. | \n
\n\n| script[].options.endOfMessageDetectionTimeout | \nInt | \nSpecifies the timeout (in seconds) to wait for the end of the message after a machine is detected. If set, actions defined in onMachineDetected will be executed only after the end of the message is detected or the timeout is reached. If not set, onMachineDetected actions will be triggered immediately after machine detection. If the timeout is reached before the end of the message, actions defined in onTimeout will be executed instead. | \n
\n\n| script[].onDetecting | \nArray | \nArray of actions to execute while detection is in progress. A maximum of two actions of specific types (Play, Say, Collect) can be defined. | \n
\n\n| script[].onMachineDetected | \nArray | \nRequired. Array of actions to execute when a machine is detected, or when the end of the message is reached if endOfMessageDetectionTimeout is set. Actions defined in onDetecting are interrupted before these actions begin. If you do not intend to continue the scenario after onMachineDetected, include a Hangup action at the end of this section to terminate the call. | \n
\n\n| script[].onTimeout | \nArray | \nArray of actions to execute when a machine is detected and the endOfMessageDetectionTimeout is reached. If you do not intend to continue the scenario after onTimeout, include a Hangup action at the end of this section to terminate the call. | \n
\n\n| script[].onHumanDetected | \nArray | \nArray of actions to execute when a human is detected. Actions defined in onDetecting are interrupted before these actions begin. To avoid this interruption, omit this section and define the remaining scenario after this action. If you do not intend to continue the scenario after onHumanDetected, include a Hangup action at the end of this section to terminate the call. | \n
\n\n| script[].pause | \nNumber | \nRequired. the amount to wait in seconds, from 0 (exclusive) to 5 (inclusive) | \n
\n\n| script[].playFromUrl | \nString | \nRequired. Audio file URL. The parameter can be constructed using variables. | \n
\n\n| script[].options.loopCount | \nInt | \nNumber of times the file will be played. | \n
\n\n| script[].playFromRecording | \nString | \nRequired. Identifier of the recorded file. The parameter can be constructed using variables. | \n
\n\n| script[].playFromUpload | \nString | \nRequired. ID of uploaded file. The parameter can be constructed using variables. | \n
\n\n| script[].playTty | \nString | \nRequired. Text that will be played in Baudot tones. The parameter can be constructed using variables. | \n
\n\n| script[].options.escapeDigits | \nString | \nDTMF codes which should stop recording when input by the user. | \n
\n\n| script[].repeat | \nArray | \nRequired. Array of actions to execute. | \n
\n\n| script[].while | \nString | \nRequired. The expression to evaluate. | \n
\n\n| script[].say | \nString | \nRequired. Message text. SSML (Speech Synthesis Markup Language) is supported and can be used to fully customize pronunciation of the provided text. The parameter can be constructed using variables. | \n
\n\n| script[].options.voice | \nObject | \n | \n
\n\n| script[].options.voice.gender | \nString | \nGender in which the text would be synthesized. The parameter can be constructed using variables. | \n
\n\n| script[].options.speechRate | \nNumber | \nMust be within [0.5 - 2.0] range, default value is 1. | \n
\n\n| script[].sendSms | \nObject | \nRequired. | \n
\n\n| script[].sendSms.from | \nString | \nRequired. Represents sender ID and it can be alphanumeric or numeric; alphanumeric sender ID length should be between 3 and 11 characters; numeric sender ID length should be between 3 and 14 characters; the parameter can be constructed using variables | \n
\n\n| script[].setVariable | \nString | \nRequired. Name of a variable. | \n
\n\n| script[].value | \nString | \nRequired. Value to which the variable should be set. The parameter can be constructed using variables. | \n
\n\n| script[].switch | \nString | \nRequired. Name of the variable whose value to inspect. | \n
\n\n| script[].case | \nObject | \nRequired. | \n
\n\n| _script[].case._default | \nArray | \nArray of actions to execute if none of the conditions above are met. | \n
\n\n| lastUsageDate | \nString | \nLast usage date. null for scenarios that are used last time before 2024-01-01. | \n
\n\n
\n
This method allows you to update a Voice IVR Scenario.
\nREQUEST RATE LIMIT:
\n1 requests / minute (per account)
\nPath parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nRequired.
Scenario identifier. | \n
\n\n
\n
Request rate limit
\n1 requests / second (per account)
\nRequest body schema
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| name | \nstring | \nThe name of IVR scenario. | \n
\n\n| description | \nstring | \nDescription of IVR scenario. | \n
\n\nscript
| \n | \nRequired
Array of Call API (object) or Capture (object) or Collect (object) or Dial (object) or Dial to Many (object) or Dial to WebRTC (object) or Dial to SIP trunk (object) or Dial to Conversations (object) or For-Each (object) or Go-To (object) or Hang-up (string) or If-Then-Else (object) or Machine Detection (string) or Pause (object) or Play (object) or Play From Recording (object) or Record (object) or Repeat-Until (object) or Repeat-While (object) or Say (object) or Send SMS (object) or Set Variable (object) or Switch-Case (object) or While-Do (object)
Array of IVR actions defining scenario. NOTE: Answering Machine Detection, Call Recording and Speech Recognition (used for Capture action) are add-on features. To enable these add-ons, please contact our sales organisation. | \n
\n\n
\n
Array [
\nOne of
\nCall API
\nCall API Action performs an HTTP request to a client’s endpoint, and (if told to) processes the response data. If collectResponse is set, the system will attempt to parse the response from the server. Our platform needs to be able to make HTTP requests to the specified endpoint.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| request | \nstring | \nThe URL to target | \n
\n\noptions
{
method
headers
collectResponse
| \nobject
string
object
boolean | \nRequired
GET, POST, PUT, DELETE
HTTP headers
If this field is set, the system will parse the response and save all its fields as variables inside scenario. Note: Parser ignores non-primitive fields and does not go deeper than the first level. For example, if the response is {\"letters\": \"abcd\", \"numbers\": 12345}, the system will store variables letters and numbers, with values abcd and 12345 respectively. Check the example Say action with Call Api Responses. Response that is parsed can only be in JSON or XML.
| \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Capture
\nCapture action performs speech recognition of a specified duration. The recognized text can be used in other actions of the scenario.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| capture | \nstring | \nRequired.
Variable name. If speech recognition matches one of the specified keyPhrases, a variable with this name will be set to match the keyphrase. Otherwise, this variable will be an empty string. Together with this variable, an implicit variable that contains the full text of the captured speech will be created. The name of this variable is constructed by adding _Full suffix to the variable name.
| \n
\n\n| timeout | \ninteger | \nNumber of seconds used for capturing speech or digits failover. Minimum value is 1 and maximum value is 30. Can be overriden with speechOptions.maxSilence. | \n
\n\nspeechOptions
{
language
keyPhrases
maxSilence
} | \nobejct
string
array of strings
integer
| \nRequired.
Language used in speech that needs to be captured. For full list of supported languages see LINK.
Array of keyphrases used for matching capturing speech. If full captured text contains one of the specified phrases, that phrase will be set in variable specified in capture parameter. If keyphrases are not set or no matching is done, variable will be set to empty string. Every keyphrase can contain up to 5 words and number of keyphrases is not limited.
If used, this parameter defines the number of seconds of silence that will stop capturing. For example value of 3 defines that capturing stops as soon as 3 seconds of silence is detected or when timeout expires, whichever happens first. Minimum value is 1 and maximum value is 5. | \n
\n\ndtmfOptions
{
maxInputLength
mappedValues
} | \nobject
integer
object
| \n
Maximum acceptable number of digits. Capturing is stopped after this number of digits has been entered. Max accepted value is 255. If not set, maximum value will be used.
Map of expected collected DTMF values with some real meaning. (Example: if you have multilingual IVR, and option for users to press 1 to enter \"English\" menu, you can define {\"1\":\"English\"}, so the reporting and analysis will be easier). When this option is defined additional variable is present in the scenario. If you set your capture action variable name to myVar, then you will get additional variable myVar_Meaning containing the mapped value for a collected DTMF. | \n
\n\n| sendToReports | \nstring | \nChoose if you want to show DTMF inputs in Voice reports and logs. Options are: ALWAYS (always send - default value), MASKED (send masked - xxxx will be shown in reports and logs), NEVER (don't send - DTMF inputs will not be shown in reports and logs).
| \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Collect
\nCollect action reads the DTMF input from the user’s phone and saves it into a variable. Saved variable can be used within the IVR in any other action that allows variable usage. (e.g. switch/case).
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| collectInto | \nstring | \nRequired.
The name of the variable to set. | \n
\n\noptions
{
maxInputLength
timeout
sendToReports
mappedValues
} | \nobject
integer
integer
string
object | \nRequired
Maximum acceptable number of digits. Stops reading after maxdigits have been entered (without requiring the user to press '#' key). Max accepted value is 255. If set to 0 then max value is applied.
Timeout in seconds for user to press the digit(s). Default value is 5. Max value is 30.
Choose if you want to show DTMF inputs in Voice reports and logs. Options are: ALWAYS (always send - default value), MASKED (send masked - xxxx will be shown in reports and logs), NEVER (don't send - DTMF inputs will not be shown in reports and logs).
Map of expected collected DTMF values with some real meaning. (Example: if you have multilingual IVR, and option for users to press 1 to enter \"English\" menu, you can define {\"1\":\"English\"}, so the reporting and analysis will be easier). When this option is defined additional variable is present in the scenario. If you set your collect action variable name to myVar, then you will get additional variable myVar_Meaning containing the mapped value for a collected DTMF. | \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Dial
\nDial action performs a call redirection, joining the user's call with another destination. After Dial action the following actions are forbidden: Say, Collect, Dial, Dial to Many, Dial to WebRTC, Dial to SIP trunk, Dial to Conversations, Play, Record and Play from Recording.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| dial | \nstring | \nRequired.
must be a valid E164 MSISDN; the parameter can be constructed using variables | \n
\n\noptions
{
senderId
maxCallDuration
} | \nobject
string
integer
| \nRequired
must be a valid E164 MSISDN; the parameter can be constructed using variables
If set, call transfer will be limited by maxCallDuration seconds, must be a positive number, no upper bound.
| \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Dial to Many
\nDial to Many action performs a call redirection to multiple destinations, joining the user’s call only with the destination that answered the call first. After Dial to Many action the following actions are forbidden: Say, Collect, Dial, Dial to Many, Dial to WebRTC, Dial to SIP trunk, Dial to Conversations, Play, Record and Play from Recording.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\ndialToMany
[{
number
numbers
}] | \narry of objects
string
string | \nRequired.
must be a valid E164 MSISDN; the parameter can be constructed using variables.
must be a comma-separated list of valid E164 MSISDN numbers; the parameter can be constructed using variables | \n
\n\noptions
{
parallel
senderId
maxCallDuration
ringTimeout
| \nobect
boolean
string
integer
integer | \n
Flag indicating that parallel (true), or sequential (false) Dial to Many will be executed.
Must be a valid E164 MSISDN; the parameter can be constructed using variables.
If set, call transfer will be limited by maxCallDuration seconds; must be a positive number, no upper bound.
If set limits the duration of the ringing of transferred calls in seconds. The default value is 30 seconds. This parameter can be changed only for sequential calls. | \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Dial to WebRTC
\nDial to WebRTC action performs a call redirection to WebRTC application, joining the user’s call with the WebRTC application. After Dial to WebRTC action the following actions are forbidden: Say, Collect, Dial, Dial to Many, Dial to WebRTC, Dial to SIP trunk, Dial to Conversations, Play, Record and Play from Recording.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| dialToWebRTC | \nstring | \nRequired.
Web and in-app calls applicationId. Read more about Web and in-app calls here | \n
\n\n
\n
Dial to SIP trunk
\nDial to SIP trunk action performs a call to the specified SIP trunk. SIP trunk must be created on VHD platform before using this action. After Dial to SIP trunk action the following actions are forbidden: Say, Collect, Dial, Dial to Many, Dial to WebRTC, Dial to SIP trunk, Dial to Conversations, Play, Record and Play from Recording.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\ndialToSipTrunk
| \nobject | \nRequired.
Only one of these two properties (ipAddress, domainName) can be set. | \n
\n\noptions
{
from
to
headers
] | \nobject
string
string
object | \n
String identifying who is calling. The parameter can be constructed using variables.
String identifying who is called. The parameter can be constructed using variables.
Additional headers to be sent to SIP trunk. If header key or value contains \\n or \\r, these characters will be removed. Header size is limited to 256 bytes, which includes header key and value together. X- prefix will be added internally to all headers. The parameter can be constructed using variables. | \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Dial to Conversations
\nDial to Conversations action performs a call redirection to the VHD Conversations platform, joining the user’s call with an agent. After Dial to Conversations action the following actions are forbidden: Say, Collect, Dial, Dial to Many, Dial to WebRTC, Dial to SIP trunk, Dial to Conversations, Play, Record and Play from Recording.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\ndialToConversations
{
options
{
tags
}
} | \nobject
object
array of strings | \nRequired.
Only one of these two properties (ipAddress, domainName) can be set.
Required
Contains options to be associated to the dial to conversations action
An array of conversation tag names that are assigned to this conversation for better categorization of the topics or customer intent. Value can be an array of tag names, empty array, or null value. | \n
\n\n
\n
For-Each
\nFor-each action is a control statement that executes a block of code for each of the values within the supplied list. The Supplied list of values can be static or dynamic (defined as user variable).
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| for-each | \nstring | \nRequired.
Variable name that will be used inside the loop to represent single value from supplied list of values. | \n
\n\n| in | \nstring | \nRequired.
Delimited string representing list of values; the parameter can be constructed using variables. | \n
\n\n| delimiter | \nstring | \nDelimiter used for separating values in supplied list of values; the parameter can be constructed using variables. Default is comma. | \n
\n\n| do | \narry of objects | \nRequired. | \n
\n\n
\n
Go-To
\nGo-To action is used to go back to some specified action that was already executed in the scenario and continue the execution from that point.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| goTo | \ninteger | \nRequired.
The actionId of an action to which to jumpç | \n
\n\noptions
{
gotoLimit
countVariable
} | \nobject
integer
string | \n
Maximum number of times goto can jump to specified action. Valid values are from 1 to 100.
Name of the variable which counts passes through goto action. | \n
\n\n
\n
Hang-up
\nHangup action marks the end of the IVR flow execution, leading to the call actually being hung up.
\n\n\n\n
Property | \nType | \nDescription | \n
\n\n\n\n| Hang-up | \nstring | \nValue: \"hangup\" | \n
\n\n
\n
If-Then-Else
\nIf-Then-Else action provides simple branching based on a condition. If the condition evaluates to true, the then block is executed, otherwise the else block is executed. Only one of the blocks is required to be non-empty.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| If-Then-Else | \nstring | \nRequired.
The expression to evaluate | \n
\n\n| then | \narray of objects | \nThe actions to execute if condition is evaluated to true | \n
\n\n| else | \narry of objects | \nThe actions to execute if condition is evaluated to false | \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Machine Detection
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| Machine Detection | \nstring | \nRequired.
Value: \"machineDetection\"
Machine Detection action detects answering machines at the beginning of the call. This action sets machineAnswered variable upon completion to true or false. Machine Detection introduces a delay of approximately 4s. This is the minimum time needed for machine detection. Machine Detection action has to be followed by a condition action that uses the value of machineAnswered for branching into the 'human answered' block and the 'answering machine answered' block. The 'answering machine' block can have a Say/Play/PlayFromRecording action or a Hangup action. If answering machine is detected, and a Say/Play/Play from Recording action is up next - the voice message will start playing into the voice mail only after the answering machine is finished with its greeting. | \n
\n\n
\n
Pause
\nPause action pauses execution of the IVR scenario for the provided duration.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| pause | \nnumber | \nRequired.
the amount to wait in seconds, from 0 (exclusive) to 5 (inclusive) | \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Play
\nPlay action performs playback of audio provided by the client’s URL. Supported formats of the provided file are aac, aiff, m4a, mp2, mp3, mp4 (audio only), ogg, wav and wma. Our platform needs to have permission to make GET and HEAD HTTP requests on the provided URL. Standard http ports (like 80, 8080, etc.) are advised.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| playFromUrl | \nstring | \nRequired.
Audio file URL. | \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
playFromRecording
\nPlay from Recording Action plays audio recorded from the current or some other call.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| playFromRecording | \nstring | \nRequired.
Can be null (play last recorded audio from the current call), number (play the recording passed index) or text (play recording with identifier - current or previous call) | \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Record
\nRecord action records a portion of the call. The recording starts at the moment where the Record action is added in the IVR.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| record | \ninteger | \nRequired.
The duration to record for in seconds; null for unlimited. | \n
\n\noptions
{
escapeDigits
beep
maxSilence
identifier
} | \nobject
string
boolean
integer
string | \n
DTMF codes which should stop recording when input by the user.
Flag indicating a beep sound should be played at the start of the recording.
The amount of silence to wait for before stopping the recording.
The identifier for the recording. Identified recordings can be reused in Play from Recording. The parameter can be constructed using variables. | \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Rpeat-Until
\nThis action is deprecated and should not be used, as it leads to incorrect behaviour and it will not be supported in the future. Please, use repeat-while loop instead.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| repeat | \narray of objects | \nRequired. | \n
\n\n| until | \nstring | \nThe expression to evaluate. | \n
\n\n
\n
Repeat-While
\nRepeat-While action is a control flow statement that repeatedly executes a block of code, as long as the boolean condition in the while field is true. Comparison is done using equal (==) or not equal (!=) operators. Make sure not to provide a condition that causes an infinite loop.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| repeat | \narray of objects | \nRequired. | \n
\n\n| while | \nstring | \nThe expression to evaluate. | \n
\n\n
\n
Say
\nSay action converts provided text into an audio file which is played during the call based on the provided parameters. Message text can be up to 1400 characters long.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| say | \nstring | \nRequired.
Message text. Cannot contain only punctuation. | \n
\n\noptions
{
language
voice
{
name
gender
}
speechRate
}
| \nobject
string
object
string
string
number | \nThe expression to evaluate.
Must be defined for correct pronunciation.
Used to define the voice in which the text would be synthesized.
Name of the voice in which the text would be synthesized.
Gender in which the text would be synthesized.
Must be within [0.5 - 2.0] range, default value is 1. | \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
Send SMS
\nSend SMS action creates and sends a text message from the scenario.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\nsendSms
{
text
from
to
} | \nobject
string
string
string | \nRequired.
Message text. Cannot contain only punctuation.
Required.
The text of the message that will be sent.
Represents sender ID and it can be alphanumeric or numeric; alphanumeric sender ID length should be between 3 and 11 characters; numeric sender ID length should be between 3 and 14 characters; the parameter can be constructed using variables.
Required.
Must be a valid E164 MSISDN; the parameter can be constructed using variables
| \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
]
\nSet Variable
\nSet variable action makes it possible to set a variable defined inside the IVR scenario to a specified value.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| setVariable | \nstring | \nRequired.
Name of a variable. | \n
\n\n| value | \nstring | \nValue to which the variable should be set. | \n
\n\n
\n
Switch-Case
\nSwitch-Case action takes a saved variable (obtained via either a Collect, Call API action or scenario parameters) and performs flow control based on it. It works similarly to the switch case block, using case-sensitive comparison.
\nView More
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| switch | \nstring | \nRequired.
Name of the variable whose value to inspect. | \n
\n\ncase
{
_default
} | \nobject
array of objects | \nObject whose keys are possible variable values, and values are arrays of actions.
Array of actions to execute if none of the conditions above are met. | \n
\n\n| actionId | \ninteger | \nUser-defined ID of an action that can be used with go-to action. | \n
\n\n
\n
While-Do
\nWhile-Do action executes the do field block of code as long as a specified condition is true in the while field. As with Repeat-While, comparison is done using equal (==) or not equal (! =) operators. Make sure not to provide a condition that causes an infinite loop.
\n\n\n\n| Property | \nType | \nDescription | \n
\n\n\n\n| while | \nstring | \nRequired.
The expression to evaluate. | \n
\n\n| do | \narry of objects | \nRequired. | \n
\n\n
\n
]
\nResponse
\nDefault sucessful response
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| createTime | \nobject | \nCreation timestamp. | \n
\n\n| description | \nobject | \nScenario description. | \n
\n\n| id | \nstring | \nScenario key. It is used for launching IVR scenario. | \n
\n\n| name | \n | \nScenario name. | \n
\n\n| script | \nobject | \nThe list of scenario actions. | \n
\n\n| updateTime | \nstring | \nUpdate timestamp | \n
\n\n
\n
Error response
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| notifyUrl | \nString | \nThe URL on your callback server on which the Delivery report will be sent. | \n
\n\n| notifyContentType | \nString | \nPreferred Delivery report content type. Can be application/json or application/xml. | \n
\n\n| script[].options.customRingback | \nObject | \nCustom ringback tones configuration. Allows specifying different audio files to play during ringing and when the call fails. | \n
\n\n| script[].options.customRingback.ringingAudio | \nObject | \nRequired. | \n
\n\n| script[].options.customRingback.failedAudio | \nObject | \n | \n
\n\n| script[].dialToConversations.options.tagIdentifierType | \nString | \nDefines which identifier will be provided in the tags field. Possible values are ID and NAME. If not provided, default value of NAME is used. One of: ID, NAME. | \n
\n\n| script[].options.goToLimit | \nInt | \nMaximum number of times goto can jump to specified action. Valid values are from 1 to 100. | \n
\n\n| script[].answeringMachineDetection | \nBoolean | \nRequired. Indicates whether machine detection should be performed. | \n
\n\n| script[].options.waitEndOfMessageDetection | \nString | \nIndicates whether end of the message detection is enabled for the call. ALWAYS specifies that after detection of MACHINE the script will always wait for the end of the message before executing actions defined in onMachineDetected. NEVER specifies that after detection of MACHINE actions defined in onMachineDetected will be executed immediately. ON_DETECTING specifies that end of the message will be respected as long as actions in onDetecting are in progress, once these actions finish the script jumps to onMachineDetected section immediately. One of: ALWAYS, NEVER, ON_DETECTING. | \n
\n\n| script[].options.endOfMessageDetectionTimeout | \nInt | \nSpecifies the timeout (in seconds) to wait for the end of the message after a machine is detected. If set, actions defined in onMachineDetected will be executed only after the end of the message is detected or the timeout is reached. If not set, onMachineDetected actions will be triggered immediately after machine detection. If the timeout is reached before the end of the message, actions defined in onTimeout will be executed instead. | \n
\n\n| script[].onDetecting | \nArray | \nArray of actions to execute while detection is in progress. A maximum of two actions of specific types (Play, Say, Collect) can be defined. | \n
\n\n| script[].onMachineDetected | \nArray | \nRequired. Array of actions to execute when a machine is detected, or when the end of the message is reached if endOfMessageDetectionTimeout is set. Actions defined in onDetecting are interrupted before these actions begin. If you do not intend to continue the scenario after onMachineDetected, include a Hangup action at the end of this section to terminate the call. | \n
\n\n| script[].onTimeout | \nArray | \nArray of actions to execute when a machine is detected and the endOfMessageDetectionTimeout is reached. If you do not intend to continue the scenario after onTimeout, include a Hangup action at the end of this section to terminate the call. | \n
\n\n| script[].onHumanDetected | \nArray | \nArray of actions to execute when a human is detected. Actions defined in onDetecting are interrupted before these actions begin. To avoid this interruption, omit this section and define the remaining scenario after this action. If you do not intend to continue the scenario after onHumanDetected, include a Hangup action at the end of this section to terminate the call. | \n
\n\n| script[].options.loopCount | \nInt | \nNumber of times the file will be played. | \n
\n\n| script[].playFromUpload | \nString | \nRequired. ID of uploaded file. The parameter can be constructed using variables. | \n
\n\n| script[].playTty | \nString | \nRequired. Text that will be played in Baudot tones. The parameter can be constructed using variables. | \n
\n\n| _script[].case._default | \nArray | \nArray of actions to execute if none of the conditions above are met. | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| notifyUrl | \nString | \nThe URL on the client's callback server on which the Delivery report will be sent. | \n
\n\n| notifyContentType | \nString | \nPreferred Delivery report content type. Can be application/json or application/xml. | \n
\n\n| script[].options.customRingback | \nObject | \nCustom ringback tones configuration. Allows specifying different audio files to play during ringing and when the call fails. | \n
\n\n| script[].options.customRingback.ringingAudio | \nObject | \nRequired. | \n
\n\n| script[].options.customRingback.failedAudio | \nObject | \n | \n
\n\n| script[].dialToConversations.options.tagIdentifierType | \nString | \nDefines which identifier will be provided in the tags field. Possible values are ID and NAME. If not provided, default value of NAME is used. One of: ID, NAME. | \n
\n\n| script[].options.goToLimit | \nInt | \nMaximum number of times goto can jump to specified action. Valid values are from 1 to 100. | \n
\n\n| script[].answeringMachineDetection | \nBoolean | \nRequired. Indicates whether machine detection should be performed. | \n
\n\n| script[].options.waitEndOfMessageDetection | \nString | \nIndicates whether end of the message detection is enabled for the call. ALWAYS specifies that after detection of MACHINE the script will always wait for the end of the message before executing actions defined in onMachineDetected. NEVER specifies that after detection of MACHINE actions defined in onMachineDetected will be executed immediately. ON_DETECTING specifies that end of the message will be respected as long as actions in onDetecting are in progress, once these actions finish the script jumps to onMachineDetected section immediately. One of: ALWAYS, NEVER, ON_DETECTING. | \n
\n\n| script[].options.endOfMessageDetectionTimeout | \nInt | \nSpecifies the timeout (in seconds) to wait for the end of the message after a machine is detected. If set, actions defined in onMachineDetected will be executed only after the end of the message is detected or the timeout is reached. If not set, onMachineDetected actions will be triggered immediately after machine detection. If the timeout is reached before the end of the message, actions defined in onTimeout will be executed instead. | \n
\n\n| script[].onDetecting | \nArray | \nArray of actions to execute while detection is in progress. A maximum of two actions of specific types (Play, Say, Collect) can be defined. | \n
\n\n| script[].onMachineDetected | \nArray | \nRequired. Array of actions to execute when a machine is detected, or when the end of the message is reached if endOfMessageDetectionTimeout is set. Actions defined in onDetecting are interrupted before these actions begin. If you do not intend to continue the scenario after onMachineDetected, include a Hangup action at the end of this section to terminate the call. | \n
\n\n| script[].onTimeout | \nArray | \nArray of actions to execute when a machine is detected and the endOfMessageDetectionTimeout is reached. If you do not intend to continue the scenario after onTimeout, include a Hangup action at the end of this section to terminate the call. | \n
\n\n| script[].onHumanDetected | \nArray | \nArray of actions to execute when a human is detected. Actions defined in onDetecting are interrupted before these actions begin. To avoid this interruption, omit this section and define the remaining scenario after this action. If you do not intend to continue the scenario after onHumanDetected, include a Hangup action at the end of this section to terminate the call. | \n
\n\n| script[].options.loopCount | \nInt | \nNumber of times the file will be played. | \n
\n\n| script[].playFromUpload | \nString | \nRequired. ID of uploaded file. The parameter can be constructed using variables. | \n
\n\n| script[].playTty | \nString | \nRequired. Text that will be played in Baudot tones. The parameter can be constructed using variables. | \n
\n\n| _script[].case._default | \nArray | \nArray of actions to execute if none of the conditions above are met. | \n
\n\n| lastUsageDate | \nString | \nLast usage date. null for scenarios that are used last time before 2024-01-01. | \n
\n\n
\n
\nThis request places a real phone call to your testNumber. It runs only when the environment variable runVoiceCalls is true; otherwise it is skipped.
\n
\n\nA call can be accepted and still not be placed. The API answers 200 with status PENDING when it accepts the request. The final result appears later in the logs and delivery reports. For example REJECTED_DND means the number is on a do-not-disturb list, so the call was never connected. Check Voice message logs (filter with bulkId) to see what happened to the call.
\n
\nThis method allows you to start an outbound IVR toward a multiple destinations.
\nResponse format
\nIf successful, the response header HTTP status code will be 200 OK and the IVR flow will be sent.
\nIf you try to send the request without authorization, you will receive a 401 Unauthorized error.
\nVoice Response
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| bulkId | \nString | \nThe ID that uniquely identifies the request. Bulk ID will be received when a message is sent to more than one destination address. | \n
\n\n| messages | \nVoiceResponseDetails | \nArray of sent message objects, one object per message. | \n
\n\n
\n
Voice Response Details
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| to | \nString | \nThe message destination address. | \n
\n\n| status | \nStatus | \nIndicates whether the message has been sent successfully, not sent, delivered, not delivered, waiting for delivery, or other status. | \n
\n\n| messageId | \nString | \nThe ID that uniquely identifies the sent message. | \n
\n\n
\n
Status
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| groupId | \nInt | \nStatus group ID | \n
\n\n| groupName | \nString | \nStatus group name | \n
\n\n| id | \nInt | \nStatus ID | \n
\n\n| name | \nString | \nStatus name | \n
\n\n| description | \nString | \nHuman readable description of the status. | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| messages[].scenarioId | \nString | \nRequired. Scenario key. | \n
\n\n| messages[].from | \nString | \nNumeric sender ID length should be between 3 and 14 characters. | \n
\n\n| messages[].notifyUrl | \nString | \nThe URL on your callback server on which the Delivery report will be sent. | \n
\n\n| messages[].notifyContentType | \nString | \nPreferred Delivery report content type. Can be application/json or application/xml. | \n
\n\n| messages[].notifyContentVersion | \nInt | \nSpecifies the version of the report model to be sent. Can be 1 (deprecated version 1) or 2 (current version 2). The default is version 2. | \n
\n\n| messages[].callbackData | \nString | \nAdditional client's data that will be sent on the notifyUrl. The maximum value is 200 characters. | \n
\n\n| messages[].validityPeriod | \nInt | \nThe message validity period shown in minutes. When the period expires, it will not be allowed for the message to be sent. A validity period longer than 48h is not supported (in this case, it will be automatically set to 48h). | \n
\n\n| messages[].sendAt | \nString | \nUsed for scheduled Voice messages (message not to be sent immediately, but at scheduled time). | \n
\n\n| messages[].retry | \nObject | \nUsed to define if the delivery of the Voice messages should be retried in case the first try doesn't succeed. Additional retries will be made according to the schedule defined by minPeriod and maxPeriod parameters and platform's internal retry logic. If the minPeriod differs maxPeriod, delivery will be retried in the following manner: after 1 min, 2 min, 5 min, 10 min, 20 min, 30 min, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, 24 hours or until maxPeriod is reached. If the retry attempt for the maxPeriod is reached, the maxPeriod will be used for all subsequent retries. If the minPeriod and the maxPeriod are defined as equal values, the period of time between retries will be equal to this value. Message delivery will be retried until the successful delivery or message validity or maxCount value is reached. | \n
\n\n| messages[].retry.maxCount | \nInt | \nRequired. Specify the maximum number of retry attempts. Maximum value of the maxCount is 4. If the value is higher than 4, it will be set to 4. | \n
\n\n| messages[].retry.maxPeriod | \nInt | \nRequired. Defines the maximum waiting time (in minutes) after the previous failed attempt to try to deliver the message again. Supported values are 1 min, 2 min, 5 min, 10 min, 20 min, 30 min, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, 24 hours. If entered a value that isn't from the previous list but that's smaller than 24 hours, it is used the next bigger value from the list. If entered value that is bigger than 24 hours than it is used 24 hours. | \n
\n\n| messages[].retry.minPeriod | \nInt | \nRequired. Defines the minimal waiting time (in minutes) after the previous failed attempt to try to deliver the message again. Supported values are 1 min, 2 min, 5 min, 10 min, 20 min, 30 min, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, 24 hours. If entered a value that isn't from the previous list but that's smaller than 24 hours, it is used the next bigger value from the list. If entered value that is bigger than 24 hours than it is used 24 hours. | \n
\n\n| messages[].ringTimeout | \nInt | \nRinging duration, unless there are no operator limitations. Default value is 45. Note: There are no limitations on the Voice platform regarding this value, however, most of the operators have their own ring timeout limitations and it is advisable to keep the ringTimeout value up to 45 seconds. | \n
\n\n| messages[].sendingSpeed | \nObject | \nSending rate defined in number of messages sent per second, minute, hour or day. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic. Not setting a send speed limit can overwhelm your resources with incoming traffic. If this parameter is defined, validityPeriod is ignored. | \n
\n\n| messages[].sendingSpeed.speed | \nInt | \nDefines the number of messages that will be sent per specified time unit. | \n
\n\n| messages[].sendingSpeed.timeUnit | \nString | \nDefines time unit used for calculating sending speed. Possible values: second, minute, hour and day. | \n
\n\n| messages[].parameters | \nObject | \nThe parameters that should be passed to the scenario on execution. | \n
\n\n| messages[].pause | \nInt | \nIndicating period of time in seconds between end user answering the call and message starting to be played. Minimal value is 0 and maximum value is 10 seconds. Default value is 0. | \n
\n\n| messages[].deliveryTimeWindow | \nObject | \nScheduling object that allows setting up detailed time windows in which the message can be sent. Consists of from, to and days properties. Days property is mandatory. From and to properties should be either both included, to allow finer time window granulation or both omitted, to include whole days in the delivery time window. Note: delivery time window is set in UTC timezone. | \n
\n\n| messages[].deliveryTimeWindow.days | \nArray | \n | \n
\n\n| messages[].deliveryTimeWindow.from.hour | \nInt | \n | \n
\n\n| messages[].deliveryTimeWindow.from.minute | \nInt | \n | \n
\n\n| messages[].callTimeout | \nInt | \nMaximum possible duration of the call to be set, shown in seconds. | \n
\n\n
\n
This method allows you to delete a Voice IVR Scenario.
\nPath parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nRequired.
Scenario identifier. | \n
\n\n
\n
Get files.
\nGet files with pagination. Maximum number of pages is 100.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| page | \nInt | \nResults page to retrieve (0..N). Default: 0. | \n
\n\n| size | \nInt | \nNumber of records per page. Default: 20. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \nArray | \nThe list of the results for this page. | \n
\n\n| results[].id | \nString | \nRequired. Unique identifier of a route. | \n
\n\n| results[].name | \nString | \nRequired. Route name. | \n
\n\n| results[].criteria | \nArray | \nList of criteria that should match route. For a route to match, any criterion should be met. | \n
\n\n| results[].criteria[].to | \nString | \nPhone number or regular expression pattern representing the phone number. Applies to all search criteria types except WEBRTC. Examples: 41793026727, 41793(.+). | \n
\n\n| results[].criteria[].value | \nObject | \nCriteria type. | \n
\n\n| results[].criteria[].value.type | \nString | \nRequired. One of: PHONE, SIP, WEBRTC, APPLICATION, WHATSAPP. | \n
\n\n| results[].destinations | \nArray | \nRequired. List of destinations. First destination in the list is the first one to be executed. Subsequent destinations are executed only if the previous one fails. | \n
\n\n| results[].destinations[].priority | \nInt | \n | \n
\n\n| results[].destinations[].type | \nString | \nRequired. One of: APPLICATION, ENDPOINT, URL. | \n
\n\n| results[].destinations[].weight | \nInt | \n | \n
\n\n| results[].status | \nString | \nRequired. Indicates whether the route is enabled or not. One of: ENABLED, DISABLED. | \n
\n\n| results[].order | \nInt | \nIndicates priority index of the route. Routes with lower priority index are executed first. | \n
\n\n| results[].transferOnly | \nBoolean | \nIndicates whether this route should be used exclusively for call transfers initiated via the REFER SIP message. The to number value will be taken from the Refer-To header. | \n
\n\n| paging | \nObject | \nContains information about the page. | \n
\n\n| paging.page | \nInt | \nRequired. Requested page number. | \n
\n\n| paging.size | \nInt | \nRequired. Requested page size. | \n
\n\n| paging.totalPages | \nInt | \nRequired. The total number of pages of the results matching the requested parameters. | \n
\n\n| paging.totalResults | \nInt | \nRequired. The total number of the results matching the requested parameters. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["voice","ivr","1","uploads"],"host":["go2","vhdmedia","se"],"query":[{"disabled":true,"description":{"content":"Results page to retrieve (0..N). Default: 0.
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Number of records per page. Default: 20.
\n","type":"text/plain"},"key":"size","value":""}],"variable":[]}},"response":[{"id":"f5f8f4c6-b23c-4215-88d2-06769e3ec3fd","name":"200 - Route response page example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/voice/ivr/1/uploads","protocol":"https","host":["go2","vhdmedia","se"],"path":["voice","ivr","1","uploads"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"id\": \"f8fc8aca-786d-4943-9af2-e7ec01b5e80d\",\n \"name\": \"SIP endpoint route\",\n \"destinations\": [\n {\n \"value\": {\n \"username\": \"41793026834\",\n \"sipTrunkId\": \"string\",\n \"customHeaders\": {\n \"string\": \"string\"\n },\n \"type\": \"SIP\"\n },\n \"connectTimeout\": 30,\n \"recording\": {\n \"recordingType\": \"AUDIO\",\n \"recordingComposition\": {\n \"enabled\": true\n },\n \"customData\": {\n \"string\": \"string\"\n },\n \"filePrefix\": \"string\"\n },\n \"type\": \"ENDPOINT\"\n }\n ],\n \"transferOnly\": false\n },\n {\n \"id\": \"f8fc8aca-786d-4943-9af2-e7ec01b5e80d\",\n \"name\": \"Phone endpoint route\",\n \"destinations\": [\n {\n \"value\": {\n \"phoneNumber\": \"41793026834\",\n \"type\": \"PHONE\"\n },\n \"connectTimeout\": 30,\n \"recording\": {\n \"recordingType\": \"AUDIO\",\n \"recordingComposition\": {\n \"enabled\": true\n },\n \"customData\": {\n \"string\": \"string\"\n },\n \"filePrefix\": \"string\"\n },\n \"type\": \"ENDPOINT\"\n }\n ],\n \"transferOnly\": false\n }\n ],\n \"paging\": {\n \"page\": 0,\n \"size\": 20,\n \"totalPages\": 1,\n \"totalResults\": 2\n }\n}"},{"id":"1574646b-4e94-4f67-8090-c062c378e60e","name":"400 - Error responses","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/voice/ivr/1/uploads","protocol":"https","host":["go2","vhdmedia","se"],"path":["voice","ivr","1","uploads"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Bad request\",\n \"validationErrors\": {\n \"field\": [\n \"field must not be null\"\n ]\n }\n }\n }\n}"},{"id":"b0dc4baf-f48b-437d-9134-c7028d731485","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/voice/ivr/1/uploads","protocol":"https","host":["go2","vhdmedia","se"],"path":["voice","ivr","1","uploads"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"de402e89-c59a-4fe5-870d-3d4df5012f3f","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/voice/ivr/1/uploads","protocol":"https","host":["go2","vhdmedia","se"],"path":["voice","ivr","1","uploads"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"cd106cc2-7f2d-4072-a49f-f026da3c25e7","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/voice/ivr/1/uploads","protocol":"https","host":["go2","vhdmedia","se"],"path":["voice","ivr","1","uploads"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"1637fded-db44-48f0-8074-188f0dba6bab","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/voice/ivr/1/uploads","protocol":"https","host":["go2","vhdmedia","se"],"path":["voice","ivr","1","uploads"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"bd35f6ca-6540-41cb-a9f3-a5429341691c"},{"name":"Upload IVR file","event":[{"listen":"prerequest","script":{"exec":["// Choose an audio file in the \"file\" field of the Body tab. Without a file the request is skipped.","var f = pm.request.body && pm.request.body.formdata ? pm.request.body.formdata.one(\"file\") : null;","var hasFile = !!(f && f.src && (Array.isArray(f.src) ? f.src.length > 0 : String(f.src).length > 0));","if (!hasFile) {"," console.warn(\"No file selected in the Body tab - request not sent.\");"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/no-file-selected\"); }","}"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () { pm.response.to.have.status(200); });","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","pm.test(\"Response body is valid JSON\", function () { pm.response.json(); });"],"type":"text/javascript","packages":{}}}],"id":"567265de-75fd-4c96-8d72-2f98725edec8","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]}]},"url":"https://go2.vhdmedia.se/voice/ivr/1/uploads","description":"Upload file.
\nUpload an audio file to be played in IVR calls. The file will be removed if it is not used for 90 days. Supported formats: .wav and .mp3.
\nRequest body
\nSend the file as multipart/form-data with the file in the file field. JSON is not accepted (415 Unsupported Media Type).
\n\nOn success the response is 200 OK with details of the uploaded file.
\nStatus codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["voice","ivr","1","uploads"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[],"_postman_id":"567265de-75fd-4c96-8d72-2f98725edec8"},{"name":"Search Voice IVR Recorded Files","event":[{"listen":"test","script":{"exec":["// Tests for this request (no success example is documented, so only the basics are checked).","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","pm.test(\"Response body is valid JSON\", function () {"," pm.response.json();","});"],"type":"text/javascript","packages":{}}}],"id":"e9d6c64a-4ec6-4e94-a369-c54f0b02d7e0","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://go2.vhdmedia.se/voice/ivr/1/files","description":"Additional parameters
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| page | \nInt | \nPage number you want to see. | \n
\n\n| pageSize | \nInt | \nSize of the page you want to see. | \n
\n\n| messageId | \nString | \nThe message ID to search by. | \n
\n\n| number | \nString | \nThe called phone number to search by. | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| files | \nArray | \nArray of recorded files metadata, one for each recorded file. | \n
\n\n| files[].messageId | \nString | \nThe ID that uniquely identifies the sent message. | \n
\n\n| files[].from | \nString | \nNumeric sender ID. | \n
\n\n| files[].to | \nString | \nDestination address. | \n
\n\n| files[].scenarioId | \nString | \nScenario key. | \n
\n\n| files[].groupId | \nString | \nDifferentiates recordings made by separate Record actions. | \n
\n\n| files[].url | \nString | \nRelative URL path to the recorded file. To download the audio, just perform a GET request using the relative URL of a specific file. The returned audio data is encoded as PCM 16bit 8kHz WAVE audio. The files are available on VHD servers for 2 months. | \n
\n\n| files[].recordedAt | \nString | \nThe time the recording took place. | \n
\n\n
\n
\nThis request needs the ID of a recorded file in the environment variable ivrFileId (take it from Search Voice IVR Recorded Files). It is skipped when that variable is empty.
\n
\nThis method allows you to download Voice IVR Recorded Audio File. The returned audio data is encoded as PCM 16bit 8kHz WAVE audio. The files are available on VHD servers for 2 months
\nPath parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nRequired.
Scenario identifier. | \n
\n\n
\n
The IVR API enables the creation of inbound and outbound interactive call scenarios. For inbound calls, once your scenario is created you will need to link this scenario to the phone number you are renting.
\nIVR scenarios can use the Record action to record a portion of the call. These recordings can be retrieved using the Search Voice IVR Recorded Files and Download Voice IVR Recorded File. Alternatively, IVR recorded audio can also be found using the Search Recording method.
\nOur IVR solution is available in two flavours – inbound and outbound. IVR allows a great deal of flexibility and enables clients to create numerous scenarios:
\nOutbound IVR:
\n\n- Multiple questions and answers required for creating:
\n- Code verification and a subsequent action depending on the results
\n- Surveys with the recording of end users' opinion
\n
\n \n- Collecting DTMF/response codes from the end user and sending it to client’s API
\n
\nInbound IVR:
\n\n- Surveys done via DTMF
\n- Surveys recording customer opinions
\n- Polls
\n- Automation of processes like appointment bookings, appointment confirmations, and package tracking
\n
\nManage IVR Scenarios
\nPOST Create a Voice IVR Scenario
\nThis method allows you to create a Voice IVR Scenario.
\nGET Search Voice IVR Scenarios
\nThis method allows you to search Voice IVR Scenarios by name. To get a list of all IVR Scenarios, make a request without any parameters.
\nGET Get a Voice IVR Scenario
\nThis method allows you to get a Voice IVR Scenario.
\nPUT Update a Voice IVR Scenario
\nThis method allows you to update a Voice IVR Scenario.
\nDEL Delete a Voice IVR Scenario
\nThis method allows you to delete a Voice IVR Scenario.
\nPOST Launch IVR Scenario
\nThis method allows you to start an outbound IVR toward a multiple destinations.
\nRetrieve Recorded Files
\nGET Search Voice IVR Recorded Files
\nThis method allows you to search Voice IVR Recorded Audio Files.
\nGET Download Voice IVR Recorded File
\nThis method allows you to download Voice IVR Recorded Audio File. The returned audio data is encoded as PCM 16bit 8kHz WAVE audio. The files are available on VHD servers for 2 months.
\n","_postman_id":"7466e60b-d1d2-48bc-b395-7406e17c461f"},{"name":"CALLS API","item":[{"name":"1 Calls configurations","item":[{"name":"Create calls configuration","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","(function () {"," api(\"GET\", \"/calls/1/configurations\", null, function (e, r) {"," var list = ((jsonOf(r) || {}).results || []).filter(function (c) { return c.name === \"Sample calls configuration\"; });"," (function next(i) { if (i >= list.length) { return; } api(\"DELETE\", \"/calls/1/configurations/\" + list[i].id, null, function () { next(i + 1); }); })(0);"," });","})();"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 201\", function () {"," pm.expect(pm.response.code).to.be.oneOf([201]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"id\", \"name\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});","","pm.environment.set(\"callsConfigurationId\", pm.response.json().id);"],"type":"text/javascript","packages":{}}}],"id":"e8129195-e418-4b18-8756-b822d206180a","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sample calls configuration\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/calls/1/configurations","description":"Create calls configuration.
\nCreate calls configuration.
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nString | \nCalls configuration ID. If not provided, system will generate random ID, which will be returned in response. | \n
\n\n| name | \nString | \nCalls configuration name. | \n
\n\n
\n
On success the response is 201 Created.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nString | \nCalls configuration ID. | \n
\n\n| name | \nString | \nCalls configuration name. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["calls","1","configurations"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"38967a98-e5ef-40b2-a115-5c3449679020","name":"201 - Response example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"63467c6e2885a5389ba11d80\",\n \"name\": \"Calls configuration\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/calls/1/configurations"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"63467c6e2885a5389ba11d80\",\n \"name\": \"Calls configuration\"\n}"},{"id":"e28b40ef-aeba-4c82-8917-3426dd11dded","name":"400 - Error responses","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"63467c6e2885a5389ba11d80\",\n \"name\": \"Calls configuration\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/calls/1/configurations"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Request is invalid.\"\n }\n }\n}"},{"id":"62a32091-e9ae-4bbe-acfd-fad9440dd5fa","name":"401 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"63467c6e2885a5389ba11d80\",\n \"name\": \"Calls configuration\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/calls/1/configurations"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"bd723d09-ff17-404b-bb5e-b6a0ea2c1a4f","name":"403 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"63467c6e2885a5389ba11d80\",\n \"name\": \"Calls configuration\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/calls/1/configurations"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"80097034-f955-458e-b521-15a90f47f8f8","name":"429 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"63467c6e2885a5389ba11d80\",\n \"name\": \"Calls configuration\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/calls/1/configurations"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"4d92aa98-4ddb-4250-9b76-714a56405177","name":"500 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"63467c6e2885a5389ba11d80\",\n \"name\": \"Calls configuration\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/calls/1/configurations"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"e8129195-e418-4b18-8756-b822d206180a"},{"name":"Get calls configurations","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"results\", \"paging\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});","","pm.test(\"'results' is an array\", function () {"," pm.expect(responseBody[\"results\"]).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"d4431fe3-e67a-4023-86c2-f36500e8d610","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/configurations","description":"Get calls configurations.
\nGet calls configurations.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| page | \nInt | \nResults page to retrieve (0..N). Default: 0. | \n
\n\n| size | \nInt | \nNumber of records per page. Default: 20. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \nArray | \nThe list of the results for this page. | \n
\n\n| results[].id | \nString | \nCalls configuration ID. | \n
\n\n| results[].name | \nString | \nCalls configuration name. | \n
\n\n| paging | \nObject | \nContains information about the page. | \n
\n\n| paging.page | \nInt | \nRequired. Requested page number. | \n
\n\n| paging.size | \nInt | \nRequired. Requested page size. | \n
\n\n| paging.totalPages | \nInt | \nRequired. The total number of pages of the results matching the requested parameters. | \n
\n\n| paging.totalResults | \nInt | \nRequired. The total number of the results matching the requested parameters. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["calls","1","configurations"],"host":["go2","vhdmedia","se"],"query":[{"disabled":true,"description":{"content":"Results page to retrieve (0..N). Default: 0.
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Number of records per page. Default: 20.
\n","type":"text/plain"},"key":"size","value":""}],"variable":[]}},"response":[{"id":"3589e239-fc68-45e6-a029-e191ec1e7397","name":"200 - List of calls configurations","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/configurations","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","configurations"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"id\": \"63467c6e2885a5389ba11d80\",\n \"name\": \"Calls configuration\"\n }\n ],\n \"paging\": {\n \"page\": 0,\n \"size\": 1,\n \"totalPages\": 1,\n \"totalResults\": 1\n }\n}"},{"id":"630acfbd-a511-4a72-9119-ee854054d727","name":"400 - Error responses","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/configurations","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","configurations"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Request is invalid.\"\n }\n }\n}"},{"id":"bac1e74b-32dd-481a-a520-3e4488524df0","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/configurations","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","configurations"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"d602f441-b746-4e08-a202-662f73e9c807","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/configurations","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","configurations"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"c7eae601-7f35-4811-82c5-8fcceddb092d","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/configurations","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","configurations"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"15fd66d2-7987-4c69-91fc-bde67d794efb","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/configurations","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","configurations"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"d4431fe3-e67a-4023-86c2-f36500e8d610"},{"name":"Get calls configuration","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","if (!(pm.environment.get(\"callsConfigurationId\") || \"\")) { skip(\"callsConfigurationId is not set (an earlier request did not create it)\"); }"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"id\", \"name\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});"],"type":"text/javascript","packages":{}}}],"id":"2063f33f-cd6f-455d-8e38-4cc7f97f84fe","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}","description":"Get calls configuration.
\nGet a single calls configuration.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| callsConfigurationId | \nString | \nRequired. Calls configuration ID. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nString | \nCalls configuration ID. | \n
\n\n| name | \nString | \nCalls configuration name. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["calls","1","configurations","{{callsConfigurationId}}"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"eddf4f93-8db0-49ec-9b7d-1bd9badf308f","name":"200 - Response example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"63467c6e2885a5389ba11d80\",\n \"name\": \"Calls configuration\"\n}"},{"id":"5634548a-ca52-4e2a-8e6c-879e63273fca","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"6285361b-fa96-4fa4-9878-fffe2331ab84","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"bca8061c-95a9-4da4-852b-189902baccd7","name":"404 - Error responses","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"NOT_FOUND\",\n \"text\": \"Resource was not found.\"\n }\n }\n}"},{"id":"228f4093-593b-488b-9589-fed4c798a94a","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"0db65caf-862f-49f9-b702-7ad16bb16042","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"2063f33f-cd6f-455d-8e38-4cc7f97f84fe"},{"name":"Update calls configuration","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","if (!(pm.environment.get(\"callsConfigurationId\") || \"\")) { skip(\"callsConfigurationId is not set (an earlier request did not create it)\"); }"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"id\", \"name\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});"],"type":"text/javascript","packages":{}}}],"id":"10d27585-dfa7-42ed-a52c-4ef314d7055c","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sample calls configuration (updated)\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}","description":"Update calls configuration.
\nUpdate calls configuration.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| callsConfigurationId | \nString | \nRequired. Calls configuration ID. | \n
\n\n
\n
Request body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| name | \nString | \nCalls configuration name. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nString | \nCalls configuration ID. | \n
\n\n| name | \nString | \nCalls configuration name. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["calls","1","configurations","{{callsConfigurationId}}"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"badcb930-2c46-4461-b8e9-771b13d37abf","name":"200 - Update response example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Calls configuration\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"63467c6e2885a5389ba11d80\",\n \"name\": \"Calls configuration\"\n}"},{"id":"38383455-2047-46c6-8dc5-ffaf20cd41e8","name":"400 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Calls configuration\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Bad request\"\n }\n }\n}"},{"id":"7c882a38-2ef4-4457-86da-491741c7fb83","name":"401 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Calls configuration\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"2c98f3ff-2e68-43d8-ab29-32f744a8b136","name":"403 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Calls configuration\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"663d7c40-7417-4684-b310-8302c2bbbe5d","name":"404 - Error responses","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Calls configuration\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"NOT_FOUND\",\n \"text\": \"Resource was not found.\"\n }\n }\n}"},{"id":"5b70e072-f8f1-49ae-a26c-93b1af56976a","name":"429 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Calls configuration\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"cf1f3658-acf3-4ca4-99e3-4afe2e29ea20","name":"500 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Calls configuration\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"10d27585-dfa7-42ed-a52c-4ef314d7055c"}],"id":"0cd46a40-1540-478d-a315-be15eabffa1b","description":"A calls configuration is the setup that calls are placed under. Create one first.
\n","_postman_id":"0cd46a40-1540-478d-a315-be15eabffa1b"},{"name":"2 Calls","item":[{"name":"Get calls","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});"],"type":"text/javascript","packages":{}}}],"id":"5474c816-7057-49c9-b845-ee01e5de693b","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/calls","description":"Get calls.
\nGet calls with pagination.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| type | \nString | \nCall endpoint type. One of: PHONE, SIP, WEBRTC, VIBER, WHATSAPP, WEBSOCKET. | \n
\n\n| callsConfigurationId | \nString | \nCalls Configuration ID. | \n
\n\n| applicationId | \nString | \nApplication ID. | \n
\n\n| from | \nString | \nCaller identifier. | \n
\n\n| to | \nString | \nCallee identifier. | \n
\n\n| direction | \nString | \nCall direction. One of: INBOUND, OUTBOUND. | \n
\n\n| status | \nString | \nCall state. One of: CALLING, RINGING, PRE_ESTABLISHED, ESTABLISHED, FINISHED, FAILED, CANCELLED, NO_ANSWER, BUSY. | \n
\n\n| startTimeAfter | \nString | \nDate and time for when the call has been created. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ. | \n
\n\n| conferenceId | \nString | \nConference ID. | \n
\n\n| dialogId | \nString | \nDialog ID. | \n
\n\n| bulkId | \nString | \nBulk ID. | \n
\n\n| page | \nInt | \nResults page to retrieve (0..N). Default: 0. | \n
\n\n| size | \nInt | \nNumber of records per page. Default: 20. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \nArray | \nThe list of the results for this page. | \n
\n\n| results[].id | \nString | \nUnique call ID. | \n
\n\n| results[].endpoint | \nObject | \nRequired. Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls. | \n
\n\n| results[].endpoint.type | \nString | \nOne of: PHONE, SIP, WEBRTC, VIBER, WHATSAPP, WEBSOCKET. | \n
\n\n| results[].from | \nString | \nCaller ID. | \n
\n\n| results[].to | \nString | \nCallee ID. | \n
\n\n| results[].direction | \nString | \nCall direction. One of: INBOUND, OUTBOUND. | \n
\n\n| results[].state | \nString | \nCall state. One of: CALLING, RINGING, PRE_ESTABLISHED, ESTABLISHED, FINISHED, FAILED, CANCELLED, NO_ANSWER, BUSY. | \n
\n\n| results[].media | \nObject | \n | \n
\n\n| results[].media.audio | \nObject | \nAudio media properties. | \n
\n\n| results[].media.audio.muted | \nBoolean | \nIndicates whether the end user can speak. | \n
\n\n| results[].media.audio.userMuted | \nBoolean | \nIndicates whether the end user muted himself. | \n
\n\n| results[].media.audio.deaf | \nBoolean | \nIndicates whether the end user can hear. | \n
\n\n| results[].media.video | \nObject | \nVideo media properties. | \n
\n\n| results[].media.video.camera | \nBoolean | \nIndicates whether there is a video feed. | \n
\n\n| results[].media.video.screenShare | \nBoolean | \nIndicates whether the end user is sharing their screen. | \n
\n\n| results[].media.video.blind | \nBoolean | \nIndicates whether the end user can receive remote videos. | \n
\n\n| results[].startTime | \nString | \nDate and time for when the call has been created. | \n
\n\n| results[].answerTime | \nString | \nDate and time for when the call has been answered. | \n
\n\n| results[].endTime | \nString | \nDate and time for when the call has been finished. | \n
\n\n| results[].parentCallId | \nString | \nParent call ID. | \n
\n\n| results[].machineDetection | \nObject | \nProperties of the events that provide Answering Machine Detection result. | \n
\n\n| results[].machineDetection.detectionResult | \nString | \nDetected class during analysis of the call. Always returns either HUMAN or MACHINE. Use confidenceRating for a finer grained analysis result One of: HUMAN, MACHINE. | \n
\n\n| results[].machineDetection.confidenceRating | \nObject | \nA map representing the confidence rating for each detection class. The key is a tag indicating the detection class, and the value is a float between 0.0 and 1.0 representing the confidence rating. Possible classes are: HUMAN, MACHINE, MUSIC, RINGING, NOISE, SILENCE and OTHER. Each class confidence rating is independent from the other, thereby the sum of all confidence values may not equal 1.0. | \n
\n\n| results[].machineDetection.customData | \nObject | \nCustom data. | \n
\n\n| results[].ringDuration | \nInt | \nRinging duration in seconds. | \n
\n\n| results[].callsConfigurationId | \nString | \nCurrent calls configuration ID. | \n
\n\n| results[].platform | \nObject | \nPlatform options. For more details, see documentation. | \n
\n\n| results[].platform.entityId | \nString | \nRequired to use entity in a send request for outbound traffic. Returned in notification events. For more details, see documentation. | \n
\n\n| results[].platform.applicationId | \nString | \nRequired for application use in a send request for outbound traffic. Returned in notification events. For more details, see documentation. | \n
\n\n| results[].conferenceId | \nString | \nCurrent conference ID. | \n
\n\n| results[].customData | \nObject | \nCustom data. | \n
\n\n| results[].dialogId | \nString | \nDialog ID. | \n
\n\n| results[].externalId | \nString | \nClient defined call ID. | \n
\n\n| paging | \nObject | \nContains information about the page. | \n
\n\n| paging.page | \nInt | \nRequired. Requested page number. | \n
\n\n| paging.size | \nInt | \nRequired. Requested page size. | \n
\n\n| paging.totalPages | \nInt | \nRequired. The total number of pages of the results matching the requested parameters. | \n
\n\n| paging.totalResults | \nInt | \nRequired. The total number of the results matching the requested parameters. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["calls","1","calls"],"host":["go2","vhdmedia","se"],"query":[{"disabled":true,"description":{"content":"Call endpoint type.
\n","type":"text/plain"},"key":"type","value":"{{personIdentifierType}}"},{"disabled":true,"description":{"content":"Calls Configuration ID.
\n","type":"text/plain"},"key":"callsConfigurationId","value":"{{callsConfigurationId}}"},{"disabled":true,"description":{"content":"Application ID.
\n","type":"text/plain"},"key":"applicationId","value":""},{"disabled":true,"description":{"content":"Caller identifier.
\n","type":"text/plain"},"key":"from","value":""},{"disabled":true,"description":{"content":"Callee identifier.
\n","type":"text/plain"},"key":"to","value":""},{"disabled":true,"description":{"content":"Call direction.
\n","type":"text/plain"},"key":"direction","value":""},{"disabled":true,"description":{"content":"Call state.
\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"Date and time for when the call has been created. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ.
\n","type":"text/plain"},"key":"startTimeAfter","value":""},{"disabled":true,"description":{"content":"Conference ID.
\n","type":"text/plain"},"key":"conferenceId","value":""},{"disabled":true,"description":{"content":"Dialog ID.
\n","type":"text/plain"},"key":"dialogId","value":""},{"disabled":true,"description":{"content":"Bulk ID.
\n","type":"text/plain"},"key":"bulkId","value":""},{"disabled":true,"description":{"content":"Results page to retrieve (0..N). Default: 0.
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Number of records per page. Default: 20.
\n","type":"text/plain"},"key":"size","value":""}],"variable":[]}},"response":[{"id":"ff7fc3ac-8be8-4b1c-b5e4-6d819dda00d4","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/calls","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","calls"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Call endpoint type.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"from","value":"","description":"Caller identifier.","disabled":true},{"key":"to","value":"","description":"Callee identifier.","disabled":true},{"key":"direction","value":"","description":"Call direction.","disabled":true},{"key":"status","value":"","description":"Call state.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time for when the call has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"conferenceId","value":"","description":"Conference ID.","disabled":true},{"key":"dialogId","value":"","description":"Dialog ID.","disabled":true},{"key":"bulkId","value":"","description":"Bulk ID.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"55beeff9-dd09-4068-bbfc-be283b3f9760","name":"400 - Error responses","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/calls","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","calls"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Call endpoint type.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"from","value":"","description":"Caller identifier.","disabled":true},{"key":"to","value":"","description":"Callee identifier.","disabled":true},{"key":"direction","value":"","description":"Call direction.","disabled":true},{"key":"status","value":"","description":"Call state.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time for when the call has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"conferenceId","value":"","description":"Conference ID.","disabled":true},{"key":"dialogId","value":"","description":"Dialog ID.","disabled":true},{"key":"bulkId","value":"","description":"Bulk ID.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Request is invalid.\"\n }\n }\n}"},{"id":"54719e79-1755-47a2-b7ff-9ab6f9890ada","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/calls","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","calls"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Call endpoint type.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"from","value":"","description":"Caller identifier.","disabled":true},{"key":"to","value":"","description":"Callee identifier.","disabled":true},{"key":"direction","value":"","description":"Call direction.","disabled":true},{"key":"status","value":"","description":"Call state.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time for when the call has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"conferenceId","value":"","description":"Conference ID.","disabled":true},{"key":"dialogId","value":"","description":"Dialog ID.","disabled":true},{"key":"bulkId","value":"","description":"Bulk ID.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"eda25347-1e59-4507-adca-2e66d9d0e6f2","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/calls","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","calls"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Call endpoint type.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"from","value":"","description":"Caller identifier.","disabled":true},{"key":"to","value":"","description":"Callee identifier.","disabled":true},{"key":"direction","value":"","description":"Call direction.","disabled":true},{"key":"status","value":"","description":"Call state.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time for when the call has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"conferenceId","value":"","description":"Conference ID.","disabled":true},{"key":"dialogId","value":"","description":"Dialog ID.","disabled":true},{"key":"bulkId","value":"","description":"Bulk ID.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"a29a22ef-0c81-4a9f-8255-8d6607c34f93","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/calls","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","calls"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Call endpoint type.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"from","value":"","description":"Caller identifier.","disabled":true},{"key":"to","value":"","description":"Callee identifier.","disabled":true},{"key":"direction","value":"","description":"Call direction.","disabled":true},{"key":"status","value":"","description":"Call state.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time for when the call has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"conferenceId","value":"","description":"Conference ID.","disabled":true},{"key":"dialogId","value":"","description":"Dialog ID.","disabled":true},{"key":"bulkId","value":"","description":"Bulk ID.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"7c60ea57-a80c-4e57-ae91-ac3134f2b013","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/calls","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","calls"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Call endpoint type.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"from","value":"","description":"Caller identifier.","disabled":true},{"key":"to","value":"","description":"Callee identifier.","disabled":true},{"key":"direction","value":"","description":"Call direction.","disabled":true},{"key":"status","value":"","description":"Call state.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time for when the call has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"conferenceId","value":"","description":"Conference ID.","disabled":true},{"key":"dialogId","value":"","description":"Dialog ID.","disabled":true},{"key":"bulkId","value":"","description":"Bulk ID.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"5474c816-7057-49c9-b845-ee01e5de693b"},{"name":"Get calls history","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var j = pm.response.json();","if (j.results && j.results.length) { pm.environment.set(\"callId\", j.results[0].callId); }"],"type":"text/javascript","packages":{}}}],"id":"7e471288-a202-4e86-b561-9de40904321d","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/calls/history?size=5","description":"Get calls history.
\nGet calls history with pagination. Calls history retention period is 5 days.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| type | \nString | \nCall endpoint type. One of: PHONE, SIP, WEBRTC, VIBER, WHATSAPP, WEBSOCKET. | \n
\n\n| callsConfigurationId | \nString | \nCalls Configuration ID. | \n
\n\n| applicationId | \nString | \nApplication ID. | \n
\n\n| from | \nString | \nCaller identifier. | \n
\n\n| to | \nString | \nCallee identifier. | \n
\n\n| direction | \nString | \nCall direction. One of: INBOUND, OUTBOUND. | \n
\n\n| status | \nString | \nCall state. One of: CALLING, RINGING, PRE_ESTABLISHED, ESTABLISHED, FINISHED, FAILED, CANCELLED, NO_ANSWER, BUSY. | \n
\n\n| startTimeAfter | \nString | \nDate and time for when the call has been created. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ. | \n
\n\n| conferenceId | \nString | \nConference ID. | \n
\n\n| dialogId | \nString | \nDialog ID. | \n
\n\n| bulkId | \nString | \nBulk ID. | \n
\n\n| page | \nInt | \nResults page to retrieve (0..N). Default: 0. | \n
\n\n| size | \nInt | \nNumber of records per page. Default: 20. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \nArray | \nThe list of the results for this page. | \n
\n\n| results[].callId | \nString | \nUnique call ID. | \n
\n\n| results[].endpoint | \nObject | \nRequired. Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls. | \n
\n\n| results[].endpoint.type | \nString | \nOne of: PHONE, SIP, WEBRTC, VIBER, WHATSAPP, WEBSOCKET. | \n
\n\n| results[].from | \nString | \nCaller ID. | \n
\n\n| results[].to | \nString | \nCallee ID. | \n
\n\n| results[].direction | \nString | \nCall direction. One of: INBOUND, OUTBOUND. | \n
\n\n| results[].state | \nString | \nCall state. One of: CALLING, RINGING, PRE_ESTABLISHED, ESTABLISHED, FINISHED, FAILED, CANCELLED, NO_ANSWER, BUSY. | \n
\n\n| results[].startTime | \nString | \nDate and time for when the call has been created. | \n
\n\n| results[].answerTime | \nString | \nDate and time for when the call has been answered. | \n
\n\n| results[].endTime | \nString | \nDate and time for when the call has been finished. | \n
\n\n| results[].parentCallId | \nString | \nParent call ID. | \n
\n\n| results[].machineDetection | \nObject | \nProperties of the events that provide Answering Machine Detection result. | \n
\n\n| results[].machineDetection.detectionResult | \nString | \nDetected class during analysis of the call. Always returns either HUMAN or MACHINE. Use confidenceRating for a finer grained analysis result One of: HUMAN, MACHINE. | \n
\n\n| results[].machineDetection.confidenceRating | \nObject | \nA map representing the confidence rating for each detection class. The key is a tag indicating the detection class, and the value is a float between 0.0 and 1.0 representing the confidence rating. Possible classes are: HUMAN, MACHINE, MUSIC, RINGING, NOISE, SILENCE and OTHER. Each class confidence rating is independent from the other, thereby the sum of all confidence values may not equal 1.0. | \n
\n\n| results[].machineDetection.customData | \nObject | \nCustom data. | \n
\n\n| results[].ringDuration | \nInt | \nRinging duration in seconds. | \n
\n\n| results[].callsConfigurationIds | \nArray | \nIDs of the calls configurations used during the call. | \n
\n\n| results[].platform | \nObject | \nPlatform options. For more details, see documentation. | \n
\n\n| results[].platform.entityId | \nString | \nRequired to use entity in a send request for outbound traffic. Returned in notification events. For more details, see documentation. | \n
\n\n| results[].platform.applicationId | \nString | \nRequired for application use in a send request for outbound traffic. Returned in notification events. For more details, see documentation. | \n
\n\n| results[].conferenceIds | \nArray | \nIDs of the conferences where the call was a participant. | \n
\n\n| results[].duration | \nInt | \nCall duration in seconds. | \n
\n\n| results[].hasCameraVideo | \nBoolean | \nIndicates if camera was enabled during the call. | \n
\n\n| results[].hasScreenshareVideo | \nBoolean | \nIndicates if screen sharing was enabled during the call. | \n
\n\n| results[].errorCode | \nObject | \nReason why the call has finished. | \n
\n\n| results[].errorCode.id | \nInt | \nUnique ErrorCode ID. | \n
\n\n| results[].errorCode.name | \nString | \nUnique ErrorCode name in machine-readable format. | \n
\n\n| results[].errorCode.description | \nString | \nErrorCode description in human-readable format. | \n
\n\n| results[].customData | \nObject | \nCustom data. | \n
\n\n| results[].dialogId | \nString | \nDialog ID. | \n
\n\n| results[].sender | \nString | \nSender. | \n
\n\n| results[].hangupSource | \nString | \nHangup source. One of: ENDPOINT, API, PLATFORM. | \n
\n\n| results[].externalId | \nString | \nClient defined call ID. | \n
\n\n| paging | \nObject | \nContains information about the page. | \n
\n\n| paging.page | \nInt | \nRequired. Requested page number. | \n
\n\n| paging.size | \nInt | \nRequired. Requested page size. | \n
\n\n| paging.totalPages | \nInt | \nRequired. The total number of pages of the results matching the requested parameters. | \n
\n\n| paging.totalResults | \nInt | \nRequired. The total number of the results matching the requested parameters. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["calls","1","calls","history"],"host":["go2","vhdmedia","se"],"query":[{"key":"size","value":"5"}],"variable":[]}},"response":[{"id":"0b19a123-1280-45cf-928b-83fa56e11b88","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/calls/history?size=5","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","calls","history"],"query":[{"key":"size","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"e6083efb-bfc6-4e88-a9b1-12d1e94249e5","name":"400 - Error responses","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/calls/history?size=5","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","calls","history"],"query":[{"key":"size","value":"5"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Request is invalid.\"\n }\n }\n}"},{"id":"f8394e45-ce13-4ef7-85ab-d9a0b0e843d8","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/calls/history?size=5","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","calls","history"],"query":[{"key":"size","value":"5"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"b233423c-b382-4619-b3c1-0f98e8ae690b","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/calls/history?size=5","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","calls","history"],"query":[{"key":"size","value":"5"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"1a78d2e1-7d88-4e81-a9ca-dd8f22f7f513","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/calls/history?size=5","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","calls","history"],"query":[{"key":"size","value":"5"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"85ec5cc3-098f-4734-9de7-4b3843526d8e","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/calls/history?size=5","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","calls","history"],"query":[{"key":"size","value":"5"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"7e471288-a202-4e86-b561-9de40904321d"},{"name":"Get call history","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","if (!(pm.environment.get(\"callId\") || \"\")) { skip(\"callId is not set (an earlier request did not create it)\"); }"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests for Get call history.","pm.test(\"Status code is 200\", function () { pm.expect(pm.response.code).to.eql(200); });","pm.test(\"Response time is below 5000ms\", function () { pm.expect(pm.response.responseTime).to.be.below(5000); });","pm.test(\"The call history is returned with the documented fields\", function () {"," var j = pm.response.json();"," pm.expect(j).to.include.all.keys(\"callId\", \"from\", \"to\", \"direction\", \"state\", \"startTime\");"," pm.expect(j.direction).to.be.oneOf([\"INBOUND\", \"OUTBOUND\"]);","});"],"type":"text/javascript","packages":{}}}],"id":"f1effe35-afeb-4d56-9d1b-7642217be81d","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/calls/{{callId}}/history","description":"Get call history.
\nGet a single call history. Call history retention period is 5 days.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| callId | \nString | \nRequired. Call ID. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| callId | \nString | \nUnique call ID. | \n
\n\n| endpoint | \nObject | \nRequired. Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls. | \n
\n\n| endpoint.type | \nString | \nOne of: PHONE, SIP, WEBRTC, VIBER, WHATSAPP, WEBSOCKET. | \n
\n\n| from | \nString | \nCaller ID. | \n
\n\n| to | \nString | \nCallee ID. | \n
\n\n| direction | \nString | \nCall direction. One of: INBOUND, OUTBOUND. | \n
\n\n| state | \nString | \nCall state. One of: CALLING, RINGING, PRE_ESTABLISHED, ESTABLISHED, FINISHED, FAILED, CANCELLED, NO_ANSWER, BUSY. | \n
\n\n| startTime | \nString | \nDate and time for when the call has been created. | \n
\n\n| answerTime | \nString | \nDate and time for when the call has been answered. | \n
\n\n| endTime | \nString | \nDate and time for when the call has been finished. | \n
\n\n| parentCallId | \nString | \nParent call ID. | \n
\n\n| machineDetection | \nObject | \nProperties of the events that provide Answering Machine Detection result. | \n
\n\n| machineDetection.detectionResult | \nString | \nDetected class during analysis of the call. Always returns either HUMAN or MACHINE. Use confidenceRating for a finer grained analysis result One of: HUMAN, MACHINE. | \n
\n\n| machineDetection.confidenceRating | \nObject | \nA map representing the confidence rating for each detection class. The key is a tag indicating the detection class, and the value is a float between 0.0 and 1.0 representing the confidence rating. Possible classes are: HUMAN, MACHINE, MUSIC, RINGING, NOISE, SILENCE and OTHER. Each class confidence rating is independent from the other, thereby the sum of all confidence values may not equal 1.0. | \n
\n\n| machineDetection.customData | \nObject | \nCustom data. | \n
\n\n| ringDuration | \nInt | \nRinging duration in seconds. | \n
\n\n| callsConfigurationIds | \nArray | \nIDs of the calls configurations used during the call. | \n
\n\n| platform | \nObject | \nPlatform options. For more details, see documentation. | \n
\n\n| platform.entityId | \nString | \nRequired to use entity in a send request for outbound traffic. Returned in notification events. For more details, see documentation. | \n
\n\n| platform.applicationId | \nString | \nRequired for application use in a send request for outbound traffic. Returned in notification events. For more details, see documentation. | \n
\n\n| conferenceIds | \nArray | \nIDs of the conferences where the call was a participant. | \n
\n\n| duration | \nInt | \nCall duration in seconds. | \n
\n\n| hasCameraVideo | \nBoolean | \nIndicates if camera was enabled during the call. | \n
\n\n| hasScreenshareVideo | \nBoolean | \nIndicates if screen sharing was enabled during the call. | \n
\n\n| errorCode | \nObject | \nReason why the call has finished. | \n
\n\n| errorCode.id | \nInt | \nUnique ErrorCode ID. | \n
\n\n| errorCode.name | \nString | \nUnique ErrorCode name in machine-readable format. | \n
\n\n| errorCode.description | \nString | \nErrorCode description in human-readable format. | \n
\n\n| customData | \nObject | \nCustom data. | \n
\n\n| dialogId | \nString | \nDialog ID. | \n
\n\n| sender | \nString | \nSender. | \n
\n\n| hangupSource | \nString | \nHangup source. One of: ENDPOINT, API, PLATFORM. | \n
\n\n| externalId | \nString | \nClient defined call ID. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["calls","1","calls","{{callId}}","history"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"be401782-04ba-479d-aefe-32f11cb4d415","name":"200 - PHONE call response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/calls/{{callId}}/history"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"callId\": \"d8d84155-3831-43fb-91c9-10b5a8d628a0\",\n \"endpoint\": {\n \"type\": \"PHONE\",\n \"phoneNumber\": \"41792036727\"\n },\n \"from\": \"41793026834\",\n \"to\": \"41792036727\",\n \"direction\": \"OUTBOUND\",\n \"state\": \"FINISHED\",\n \"startTime\": \"2026-01-15T11:59:30.000+0000\",\n \"answerTime\": \"2026-01-15T11:59:35.000+0000\",\n \"endTime\": \"2026-01-15T12:00:00.000+0000\",\n \"ringDuration\": 5,\n \"callsConfigurationIds\": [\n \"dc5942707c704551a00cd2ea\"\n ],\n \"platform\": {\n \"applicationId\": \"61c060db2675060027d8c7a6\"\n },\n \"conferenceIds\": [\n \"e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001\"\n ],\n \"duration\": 25,\n \"customData\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n },\n \"dialogId\": \"034e622a-cc7e-456d-8a10-0ba43b11aa5e\"\n}"},{"id":"d8b43811-afdf-4489-87e5-2b1d4f44184a","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/calls/{{callId}}/history"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"4e8764dd-c245-407b-b69b-be3e462468c8","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/calls/{{callId}}/history"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"f4e877ca-b404-40ce-965a-63720e6cf1c9","name":"404 - Error responses","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/calls/{{callId}}/history"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"NOT_FOUND\",\n \"text\": \"Resource was not found.\"\n }\n }\n}"},{"id":"55b3a729-a420-4a28-8db3-facbeb455692","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/calls/{{callId}}/history"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"1a2e092e-0f48-4898-b48b-ed7b18ed4919","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/calls/{{callId}}/history"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"f1effe35-afeb-4d56-9d1b-7642217be81d"}],"id":"1d7ef243-8880-4360-b475-dd9112d94b82","description":"View active calls and call history.
\n","_postman_id":"1d7ef243-8880-4360-b475-dd9112d94b82"},{"name":"3 Conferences","item":[{"name":"Get conferences","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"results\", \"paging\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});","","pm.test(\"'results' is an array\", function () {"," pm.expect(responseBody[\"results\"]).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"8f416531-8641-48ba-a70d-ff570a2670fa","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/conferences","description":"Get conferences.
\nGet conferences with pagination.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| name | \nString | \nConference name. | \n
\n\n| callId | \nString | \nCall ID. | \n
\n\n| callsConfigurationId | \nString | \nCalls Configuration ID. | \n
\n\n| applicationId | \nString | \nApplication ID. | \n
\n\n| startTimeAfter | \nString | \nDate and time for when the conference has been created. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ. | \n
\n\n| page | \nInt | \nResults page to retrieve (0..N). Default: 0. | \n
\n\n| size | \nInt | \nNumber of records per page. Default: 20. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \nArray | \nThe list of the results for this page. | \n
\n\n| results[].id | \nString | \nUnique conference ID. | \n
\n\n| results[].name | \nString | \nConference name, requested or autogenerated on creation. | \n
\n\n| results[].participants | \nArray | \nThe list of conference participants. | \n
\n\n| results[].participants[].callId | \nString | \nParticipant call ID. | \n
\n\n| results[].participants[].endpoint | \nObject | \nRequired. Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls. | \n
\n\n| results[].participants[].endpoint.type | \nString | \nOne of: PHONE, SIP, WEBRTC, VIBER, WHATSAPP, WEBSOCKET. | \n
\n\n| results[].participants[].state | \nString | \nParticipant state. One of: JOINING, JOINED, LEFT. | \n
\n\n| results[].participants[].joinTime | \nString | \nDate and time when the participant has joined. | \n
\n\n| results[].participants[].leaveTime | \nString | \nDate and time when the participant has left. | \n
\n\n| results[].participants[].media | \nObject | \n | \n
\n\n| results[].participants[].media.audio | \nObject | \nAudio media properties. | \n
\n\n| results[].participants[].media.audio.muted | \nBoolean | \nIndicates whether the end user can speak. | \n
\n\n| results[].participants[].media.audio.userMuted | \nBoolean | \nIndicates whether the end user muted himself. | \n
\n\n| results[].participants[].media.audio.deaf | \nBoolean | \nIndicates whether the end user can hear. | \n
\n\n| results[].participants[].media.video | \nObject | \nVideo media properties. | \n
\n\n| results[].participants[].media.video.camera | \nBoolean | \nIndicates whether there is a video feed. | \n
\n\n| results[].participants[].media.video.screenShare | \nBoolean | \nIndicates whether the end user is sharing their screen. | \n
\n\n| results[].participants[].media.video.blind | \nBoolean | \nIndicates whether the end user can receive remote videos. | \n
\n\n| results[].participants[].role | \nObject | \nRepresents the role of the call inside the conference. | \n
\n\n| results[].participants[].role.type | \nString | \nOne of: DEFAULT, ADVISOR, MONITOR, LISTENER, AUDITOR. | \n
\n\n| results[].callsConfigurationId | \nString | \nCalls Configuration ID. | \n
\n\n| results[].platform | \nObject | \nPlatform options. For more details, see documentation. | \n
\n\n| results[].platform.entityId | \nString | \nRequired to use entity in a send request for outbound traffic. Returned in notification events. For more details, see documentation. | \n
\n\n| results[].platform.applicationId | \nString | \nRequired for application use in a send request for outbound traffic. Returned in notification events. For more details, see documentation. | \n
\n\n| paging | \nObject | \nContains information about the page. | \n
\n\n| paging.page | \nInt | \nRequired. Requested page number. | \n
\n\n| paging.size | \nInt | \nRequired. Requested page size. | \n
\n\n| paging.totalPages | \nInt | \nRequired. The total number of pages of the results matching the requested parameters. | \n
\n\n| paging.totalResults | \nInt | \nRequired. The total number of the results matching the requested parameters. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["calls","1","conferences"],"host":["go2","vhdmedia","se"],"query":[{"disabled":true,"description":{"content":"Conference name.
\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"Call ID.
\n","type":"text/plain"},"key":"callId","value":"{{callId}}"},{"disabled":true,"description":{"content":"Calls Configuration ID.
\n","type":"text/plain"},"key":"callsConfigurationId","value":"{{callsConfigurationId}}"},{"disabled":true,"description":{"content":"Application ID.
\n","type":"text/plain"},"key":"applicationId","value":""},{"disabled":true,"description":{"content":"Date and time for when the conference has been created. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ.
\n","type":"text/plain"},"key":"startTimeAfter","value":""},{"disabled":true,"description":{"content":"Results page to retrieve (0..N). Default: 0.
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Number of records per page. Default: 20.
\n","type":"text/plain"},"key":"size","value":""}],"variable":[]}},"response":[{"id":"f9a65c96-1118-4b9a-b57e-3283d69d1702","name":"200 - Conference page response.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/conferences","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","conferences"],"query":[{"key":"name","value":"","description":"Conference name.","disabled":true},{"key":"callId","value":"{{callId}}","description":"Call ID.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time for when the conference has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"id\": \"e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001\",\n \"name\": \"Example conference\",\n \"participants\": [],\n \"callsConfigurationId\": \"dc5942707c704551a00cd2ea\",\n \"platform\": {\n \"applicationId\": \"61c060db2675060027d8c7a6\"\n }\n }\n ],\n \"paging\": {\n \"page\": 0,\n \"size\": 1,\n \"totalPages\": 1,\n \"totalResults\": 1\n }\n}"},{"id":"524f66ef-a175-488b-9a26-365e24111923","name":"400 - Error responses","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/conferences","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","conferences"],"query":[{"key":"name","value":"","description":"Conference name.","disabled":true},{"key":"callId","value":"{{callId}}","description":"Call ID.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time for when the conference has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Request is invalid.\"\n }\n }\n}"},{"id":"7bcf2f59-de67-46fe-89d0-ffaf1717e002","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/conferences","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","conferences"],"query":[{"key":"name","value":"","description":"Conference name.","disabled":true},{"key":"callId","value":"{{callId}}","description":"Call ID.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time for when the conference has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"6bf16fd2-2357-4443-940e-d2d156bc0527","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/conferences","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","conferences"],"query":[{"key":"name","value":"","description":"Conference name.","disabled":true},{"key":"callId","value":"{{callId}}","description":"Call ID.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time for when the conference has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"097220aa-9d0d-4fdd-abd9-7d70b9906d22","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/conferences","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","conferences"],"query":[{"key":"name","value":"","description":"Conference name.","disabled":true},{"key":"callId","value":"{{callId}}","description":"Call ID.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time for when the conference has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"db81ba96-ad16-4975-a095-8825b48c6c69","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/conferences","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","conferences"],"query":[{"key":"name","value":"","description":"Conference name.","disabled":true},{"key":"callId","value":"{{callId}}","description":"Call ID.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time for when the conference has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"8f416531-8641-48ba-a70d-ff570a2670fa"},{"name":"Get conferences history","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"results\", \"paging\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});","","pm.test(\"'results' is an array\", function () {"," pm.expect(responseBody[\"results\"]).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"66386cc1-2f10-4d02-823a-2f5741651125","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/conferences/history","description":"Get conferences history.
\nGet conferences history with pagination. Conferences history retention period is 5 days.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| name | \nString | \nConference name. | \n
\n\n| callId | \nString | \nCall ID. | \n
\n\n| callsConfigurationId | \nString | \nCalls Configuration ID. | \n
\n\n| applicationId | \nString | \nApplication ID. | \n
\n\n| startTimeAfter | \nString | \nDate and time for when the conference has been created. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ. | \n
\n\n| endTimeBefore | \nString | \nDate and time for when the conference has been finished. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ. | \n
\n\n| page | \nInt | \nResults page to retrieve (0..N). Default: 0. | \n
\n\n| size | \nInt | \nNumber of records per page. Default: 20. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \nArray | \nThe list of the results for this page. | \n
\n\n| results[].conferenceId | \nString | \nUnique conference ID. | \n
\n\n| results[].name | \nString | \nConference name, requested or autogenerated on creation. | \n
\n\n| results[].platform | \nObject | \nPlatform options. For more details, see documentation. | \n
\n\n| results[].platform.entityId | \nString | \nRequired to use entity in a send request for outbound traffic. Returned in notification events. For more details, see documentation. | \n
\n\n| results[].platform.applicationId | \nString | \nRequired for application use in a send request for outbound traffic. Returned in notification events. For more details, see documentation. | \n
\n\n| results[].startTime | \nString | \nDate and time for when the conference has been created. | \n
\n\n| results[].endTime | \nString | \nDate and time for when the conference ended. | \n
\n\n| results[].duration | \nInt | \nConference duration in seconds. | \n
\n\n| results[].sessions | \nArray | \nList of participant sessions. | \n
\n\n| results[].sessions[].callId | \nString | \nUnique call ID. | \n
\n\n| results[].sessions[].joinTime | \nString | \nDate and time for when the participant joined the conference. | \n
\n\n| results[].sessions[].leaveTime | \nString | \nDate and time for when the participant left the conference. | \n
\n\n| results[].recording | \nObject | \nConference recordings. | \n
\n\n| results[].recording.composedFiles | \nArray | \nFile(s) with a recording of all conference participants. | \n
\n\n| results[].recording.composedFiles[].id | \nString | \nFile ID. | \n
\n\n| results[].recording.composedFiles[].name | \nString | \nRequired. File name. | \n
\n\n| results[].recording.composedFiles[].fileFormat | \nString | \nRequired. File format. One of: MP3, WAV, MP4. | \n
\n\n| results[].recording.composedFiles[].size | \nInt | \nFile size in bytes. | \n
\n\n| results[].recording.composedFiles[].creationTime | \nString | \nFile creation time. | \n
\n\n| results[].recording.composedFiles[].duration | \nInt | \nFile duration in seconds. | \n
\n\n| results[].recording.composedFiles[].startTime | \nString | \nDate and time when the recording started. | \n
\n\n| results[].recording.composedFiles[].endTime | \nString | \nDate and time when the recording ended. | \n
\n\n| results[].recording.composedFiles[].location | \nString | \nLocation of recording file after processing. One of: SFTP, HOSTED. | \n
\n\n| results[].recording.composedFiles[].sftpUploadStatus | \nString | \nIndicates current status of the recording file being uploaded via SFTP. One of: UPLOADING, UPLOADED, FAILED. | \n
\n\n| results[].recording.composedFiles[].customData | \nObject | \nCustom data. | \n
\n\n| results[].recording.callRecordings | \nArray | \nFile(s) with a recording of one conference participant. | \n
\n\n| results[].recording.callRecordings[].callId | \nString | \nCall ID. | \n
\n\n| results[].recording.callRecordings[].endpoint | \nObject | \nRequired. Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls. | \n
\n\n| results[].recording.callRecordings[].endpoint.type | \nString | \nOne of: PHONE, SIP, WEBRTC, VIBER, WHATSAPP, WEBSOCKET. | \n
\n\n| results[].recording.callRecordings[].direction | \nString | \nCall direction. One of: INBOUND, OUTBOUND. | \n
\n\n| results[].recording.callRecordings[].files | \nArray | \nCall recording files. | \n
\n\n| results[].recording.callRecordings[].files[].id | \nString | \nFile ID. | \n
\n\n| results[].recording.callRecordings[].files[].name | \nString | \nRequired. File name. | \n
\n\n| results[].recording.callRecordings[].files[].fileFormat | \nString | \nRequired. File format. One of: MP3, WAV, MP4. | \n
\n\n| results[].recording.callRecordings[].files[].size | \nInt | \nFile size in bytes. | \n
\n\n| results[].recording.callRecordings[].files[].creationTime | \nString | \nFile creation time. | \n
\n\n| results[].recording.callRecordings[].files[].duration | \nInt | \nFile duration in seconds. | \n
\n\n| results[].recording.callRecordings[].files[].startTime | \nString | \nDate and time when the recording started. | \n
\n\n| results[].recording.callRecordings[].files[].endTime | \nString | \nDate and time when the recording ended. | \n
\n\n| results[].recording.callRecordings[].files[].location | \nString | \nLocation of recording file after processing. One of: SFTP, HOSTED. | \n
\n\n| results[].recording.callRecordings[].files[].sftpUploadStatus | \nString | \nIndicates current status of the recording file being uploaded via SFTP. One of: UPLOADING, UPLOADED, FAILED. | \n
\n\n| results[].recording.callRecordings[].files[].customData | \nObject | \nCustom data. | \n
\n\n| results[].recording.callRecordings[].status | \nString | \nStatus of call recording. One of: SUCCESSFUL, PARTIALLY_FAILED, FAILED. | \n
\n\n| results[].recording.callRecordings[].reason | \nString | \nReason for recording failure. | \n
\n\n| results[].recording.callRecordings[].callsConfigurationId | \nString | \nCalls Configuration ID. | \n
\n\n| results[].recording.callRecordings[].platform | \nObject | \nPlatform options. For more details, see documentation. | \n
\n\n| results[].recording.callRecordings[].platform.entityId | \nString | \nRequired to use entity in a send request for outbound traffic. Returned in notification events. For more details, see documentation. | \n
\n\n| results[].recording.callRecordings[].platform.applicationId | \nString | \nRequired for application use in a send request for outbound traffic. Returned in notification events. For more details, see documentation. | \n
\n\n| results[].recording.callRecordings[].startTime | \nString | \nDate and time when the (first) call recording started. | \n
\n\n| results[].recording.callRecordings[].endTime | \nString | \nDate and time when the (last) call recording ended. | \n
\n\n| results[].errorCode | \nObject | \nReason why the call has finished. | \n
\n\n| results[].errorCode.id | \nInt | \nUnique ErrorCode ID. | \n
\n\n| results[].errorCode.name | \nString | \nUnique ErrorCode name in machine-readable format. | \n
\n\n| results[].errorCode.description | \nString | \nErrorCode description in human-readable format. | \n
\n\n| paging | \nObject | \nContains information about the page. | \n
\n\n| paging.page | \nInt | \nRequired. Requested page number. | \n
\n\n| paging.size | \nInt | \nRequired. Requested page size. | \n
\n\n| paging.totalPages | \nInt | \nRequired. The total number of pages of the results matching the requested parameters. | \n
\n\n| paging.totalResults | \nInt | \nRequired. The total number of the results matching the requested parameters. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["calls","1","conferences","history"],"host":["go2","vhdmedia","se"],"query":[{"disabled":true,"description":{"content":"Conference name.
\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"Call ID.
\n","type":"text/plain"},"key":"callId","value":"{{callId}}"},{"disabled":true,"description":{"content":"Calls Configuration ID.
\n","type":"text/plain"},"key":"callsConfigurationId","value":"{{callsConfigurationId}}"},{"disabled":true,"description":{"content":"Application ID.
\n","type":"text/plain"},"key":"applicationId","value":""},{"disabled":true,"description":{"content":"Date and time for when the conference has been created. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ.
\n","type":"text/plain"},"key":"startTimeAfter","value":""},{"disabled":true,"description":{"content":"Date and time for when the conference has been finished. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ.
\n","type":"text/plain"},"key":"endTimeBefore","value":""},{"disabled":true,"description":{"content":"Results page to retrieve (0..N). Default: 0.
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Number of records per page. Default: 20.
\n","type":"text/plain"},"key":"size","value":""}],"variable":[]}},"response":[{"id":"17875e7d-9f76-418a-9da4-ef864aa71c67","name":"200 - Conference log page response.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/conferences/history","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","conferences","history"],"query":[{"key":"name","value":"","description":"Conference name.","disabled":true},{"key":"callId","value":"{{callId}}","description":"Call ID.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time for when the conference has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"endTimeBefore","value":"","description":"Date and time for when the conference has been finished. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"conferenceId\": \"e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001\",\n \"name\": \"Example conference\",\n \"platform\": {\n \"applicationId\": \"61c060db2675060027d8c7a6\"\n },\n \"startTime\": \"2026-01-15T11:57:30.000+0000\",\n \"endTime\": \"2026-01-15T11:59:20.000+0000\",\n \"duration\": 110,\n \"sessions\": [\n {\n \"callId\": \"d8d84155-3831-43fb-91c9-10b5a8d628a0\",\n \"joinTime\": \"2026-01-15T11:58:00.000+0000\",\n \"leaveTime\": \"2026-01-15T11:59:00.000+0000\"\n },\n {\n \"callId\": \"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8\",\n \"joinTime\": \"2026-01-15T11:57:30.000+0000\",\n \"leaveTime\": \"2026-01-15T11:59:20.000+0000\"\n }\n ],\n \"recording\": {\n \"composedFiles\": [\n {\n \"id\": \"65f0b3d7c8b6a00001a2b3d5\",\n \"name\": \"example-recording.wav\",\n \"fileFormat\": \"WAV\",\n \"size\": 67564,\n \"creationTime\": \"2026-01-15T12:00:00.000+0000\",\n \"duration\": 10,\n \"startTime\": \"2026-01-15T11:57:30.000+0000\",\n \"endTime\": \"2026-01-15T11:59:20.000+0000\",\n \"location\": \"HOSTED\"\n }\n ],\n \"callRecordings\": [\n {\n \"callId\": \"d8d84155-3831-43fb-91c9-10b5a8d628a0\",\n \"endpoint\": {\n \"type\": \"PHONE\",\n \"phoneNumber\": \"41793026834\"\n },\n \"direction\": \"INBOUND\",\n \"files\": [\n {\n \"id\": \"d8d84155-3831-43fb-91c9-10b5a8d628a0\",\n \"name\": \"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav\",\n \"fileFormat\": \"WAV\",\n \"size\": 67564,\n \"creationTime\": \"2026-01-15T12:00:00.150+0000\",\n \"duration\": 10,\n \"startTime\": \"2026-01-15T11:59:50.000+0000\",\n \"endTime\": \"2026-01-15T12:00:00.000+0000\",\n \"location\": \"HOSTED\",\n \"customData\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n }\n ],\n \"status\": \"SUCCESSFUL\"\n },\n {\n \"callId\": \"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8\",\n \"endpoint\": {\n \"type\": \"PHONE\",\n \"phoneNumber\": \"41793026834\"\n },\n \"direction\": \"INBOUND\",\n \"files\": [\n {\n \"id\": \"d8d84155-3831-43fb-91c9-10b5a8d628a0\",\n \"name\": \"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav\",\n \"fileFormat\": \"WAV\",\n \"size\": 67564,\n \"creationTime\": \"2026-01-15T12:00:00.150+0000\",\n \"duration\": 10,\n \"startTime\": \"2026-01-15T11:59:50.000+0000\",\n \"endTime\": \"2026-01-15T12:00:00.000+0000\",\n \"location\": \"HOSTED\",\n \"customData\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n }\n ],\n \"status\": \"SUCCESSFUL\"\n }\n ]\n },\n \"errorCode\": {\n \"id\": 10000,\n \"name\": \"NORMAL_HANGUP\",\n \"description\": \"The call has ended with hangup initiated by caller, callee or API\"\n }\n }\n ],\n \"paging\": {\n \"page\": 0,\n \"size\": 1,\n \"totalPages\": 1,\n \"totalResults\": 1\n }\n}"},{"id":"759916ba-905b-4eb0-8505-2d35047a6952","name":"400 - Error responses","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/conferences/history","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","conferences","history"],"query":[{"key":"name","value":"","description":"Conference name.","disabled":true},{"key":"callId","value":"{{callId}}","description":"Call ID.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time for when the conference has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"endTimeBefore","value":"","description":"Date and time for when the conference has been finished. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Request is invalid.\"\n }\n }\n}"},{"id":"cfe5fc4e-18b0-4a24-b0bd-64e9b2c63a5e","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/conferences/history","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","conferences","history"],"query":[{"key":"name","value":"","description":"Conference name.","disabled":true},{"key":"callId","value":"{{callId}}","description":"Call ID.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time for when the conference has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"endTimeBefore","value":"","description":"Date and time for when the conference has been finished. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"d3f2e6a4-2ad4-4457-acf7-403fe6af5f60","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/conferences/history","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","conferences","history"],"query":[{"key":"name","value":"","description":"Conference name.","disabled":true},{"key":"callId","value":"{{callId}}","description":"Call ID.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time for when the conference has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"endTimeBefore","value":"","description":"Date and time for when the conference has been finished. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"08fcf652-c0e0-423d-8692-ddf2e0fb90ee","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/conferences/history","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","conferences","history"],"query":[{"key":"name","value":"","description":"Conference name.","disabled":true},{"key":"callId","value":"{{callId}}","description":"Call ID.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time for when the conference has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"endTimeBefore","value":"","description":"Date and time for when the conference has been finished. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"603b7cbc-5450-4754-be26-dc7c1e837056","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/conferences/history","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","conferences","history"],"query":[{"key":"name","value":"","description":"Conference name.","disabled":true},{"key":"callId","value":"{{callId}}","description":"Call ID.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time for when the conference has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"endTimeBefore","value":"","description":"Date and time for when the conference has been finished. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"66386cc1-2f10-4d02-823a-2f5741651125"}],"id":"2cef8a04-0a17-4283-9672-e01ed08c4503","description":"List conferences and their history.
\n","_postman_id":"2cef8a04-0a17-4283-9672-e01ed08c4503"},{"name":"4 Audio files","item":[{"name":"Get audio files (Calls API)","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var j = pm.response.json();","if (j.results && j.results.length) { pm.environment.set(\"callsFileId\", j.results[0].id); }"],"type":"text/javascript","packages":{}}}],"id":"394b34ee-0f64-4234-9596-1f8a7bfc3152","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/files","description":"Get files.
\nGet files with pagination. Maximum number of pages is 100.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| page | \nInt | \nResults page to retrieve (0..N). Default: 0. | \n
\n\n| size | \nInt | \nNumber of records per page. Default: 20. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \nArray | \nThe list of the results for this page. | \n
\n\n| results[].id | \nString | \nFile ID. | \n
\n\n| results[].name | \nString | \nRequired. File name. | \n
\n\n| results[].fileFormat | \nString | \nRequired. File format. One of: MP3, WAV, MP4. | \n
\n\n| results[].size | \nInt | \nFile size in bytes. | \n
\n\n| results[].creationTime | \nString | \nFile creation time. | \n
\n\n| results[].expirationTime | \nString | \nFile expiration time. | \n
\n\n| results[].duration | \nInt | \nFile duration in seconds. | \n
\n\n| paging | \nObject | \nContains information about the page. | \n
\n\n| paging.page | \nInt | \nRequired. Requested page number. | \n
\n\n| paging.size | \nInt | \nRequired. Requested page size. | \n
\n\n| paging.totalPages | \nInt | \nRequired. The total number of pages of the results matching the requested parameters. | \n
\n\n| paging.totalResults | \nInt | \nRequired. The total number of the results matching the requested parameters. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["calls","1","files"],"host":["go2","vhdmedia","se"],"query":[{"disabled":true,"description":{"content":"Results page to retrieve (0..N). Default: 0.
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Number of records per page. Default: 20.
\n","type":"text/plain"},"key":"size","value":""}],"variable":[]}},"response":[{"id":"5f173bc4-55b1-494a-8986-f86aa8ad5221","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/files","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","files"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"2260e933-8d35-4579-be5e-b63be01b1421","name":"400 - Error responses","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/files","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","files"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Request is invalid.\"\n }\n }\n}"},{"id":"ca736768-aa5b-4999-8c17-71fe1b3e4b08","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/files","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","files"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"0a4e98bf-b7eb-4376-b34a-e39067138dce","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/files","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","files"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"168762fe-53c3-4777-9c00-d7666526a785","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/files","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","files"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"a89075e2-a4b0-4981-9323-910bd27e3df4","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/files","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","files"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"394b34ee-0f64-4234-9596-1f8a7bfc3152"},{"name":"Get audio file (Calls API)","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","if (!(pm.environment.get(\"callsFileId\") || \"\")) { skip(\"callsFileId is not set (an earlier request did not create it)\"); }"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});"],"type":"text/javascript","packages":{}}}],"id":"4d574ea5-bce0-4169-9230-987fbb52d9ee","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/files/{{callsFileId}}","description":"Get file.
\nGet a single file.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| fileId | \nString | \nRequired. File ID. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nString | \nFile ID. | \n
\n\n| name | \nString | \nRequired. File name. | \n
\n\n| fileFormat | \nString | \nRequired. File format. One of: MP3, WAV, MP4. | \n
\n\n| size | \nInt | \nFile size in bytes. | \n
\n\n| creationTime | \nString | \nFile creation time. | \n
\n\n| expirationTime | \nString | \nFile expiration time. | \n
\n\n| duration | \nInt | \nFile duration in seconds. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["calls","1","files","{{callsFileId}}"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"60831374-aaf2-4492-ac68-6456fdbd9b6a","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/files/{{callsFileId}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"98b404fa-a300-48fe-b33a-6bb018a0414a","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/files/{{callsFileId}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"0bb5044c-3324-4482-9791-94da02384887","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/files/{{callsFileId}}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"6c930dc2-c73e-4240-ab75-66d215c3dfb7","name":"404 - Error responses","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/files/{{callsFileId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"NOT_FOUND\",\n \"text\": \"Resource was not found.\"\n }\n }\n}"},{"id":"fad72cbd-706a-4a3b-b697-6bc78fd33a3f","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/files/{{callsFileId}}"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"6535e72f-dc81-4e5c-8c28-fbda6ebdc2af","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/files/{{callsFileId}}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"4d574ea5-bce0-4169-9230-987fbb52d9ee"}],"id":"64d523bb-a7cf-4f5e-844f-c3bb985c1183","description":"Audio files that calls can play. This store is shared with the IVR uploads, so a file uploaded in Upload IVR file is listed here too.
\n","_postman_id":"64d523bb-a7cf-4f5e-844f-c3bb985c1183"},{"name":"5 Call recordings","item":[{"name":"Get calls recordings","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"results\", \"paging\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});","","pm.test(\"'results' is an array\", function () {"," pm.expect(responseBody[\"results\"]).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"47c6edab-0341-466d-a236-79862535569c","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/recordings/calls","description":"Get calls recordings.
\nGet the recordings of calls with pagination.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| callId | \nString | \nCall ID. | \n
\n\n| callsConfigurationId | \nString | \nCalls Configuration ID. | \n
\n\n| applicationId | \nString | \nApplication ID. | \n
\n\n| entityId | \nString | \nEntity ID. | \n
\n\n| endpointIdentifier | \nString | \nEndpoint identifier. | \n
\n\n| startTimeAfter | \nString | \nDate and time when the (first) call recording started. | \n
\n\n| endTimeBefore | \nString | \nDate and time when the (last) call recording ended. | \n
\n\n| direction | \nString | \nCall direction. One of: INBOUND, OUTBOUND. | \n
\n\n| endpointType | \nString | \nEndpoint type. One of: PHONE, SIP, WEBRTC, VIBER, WHATSAPP, WEBSOCKET. | \n
\n\n| location | \nString | \nRecording location. One of: SAO_PAULO, BOGOTA, FRANKFURT, JOHANNESBURG, NEW_YORK, PORTLAND, MOSCOW, SINGAPORE, ISTANBUL, KUALA_LUMPUR, JAKARTA, MUMBAI, HONG_KONG, RIYADH, CHENNAI. | \n
\n\n| page | \nInt | \nResults page to retrieve (0..N). Default: 0. | \n
\n\n| size | \nInt | \nNumber of records per page. Default: 20. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \nArray | \nThe list of the results for this page. | \n
\n\n| results[].callId | \nString | \nCall ID. | \n
\n\n| results[].endpoint | \nObject | \nRequired. Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls. | \n
\n\n| results[].endpoint.type | \nString | \nOne of: PHONE, SIP, WEBRTC, VIBER, WHATSAPP, WEBSOCKET. | \n
\n\n| results[].direction | \nString | \nCall direction. One of: INBOUND, OUTBOUND. | \n
\n\n| results[].files | \nArray | \nCall recording files. | \n
\n\n| results[].files[].id | \nString | \nFile ID. | \n
\n\n| results[].files[].name | \nString | \nRequired. File name. | \n
\n\n| results[].files[].fileFormat | \nString | \nRequired. File format. One of: MP3, WAV, MP4. | \n
\n\n| results[].files[].size | \nInt | \nFile size in bytes. | \n
\n\n| results[].files[].creationTime | \nString | \nFile creation time. | \n
\n\n| results[].files[].duration | \nInt | \nFile duration in seconds. | \n
\n\n| results[].files[].startTime | \nString | \nDate and time when the recording started. | \n
\n\n| results[].files[].endTime | \nString | \nDate and time when the recording ended. | \n
\n\n| results[].files[].location | \nString | \nLocation of recording file after processing. One of: SFTP, HOSTED. | \n
\n\n| results[].files[].sftpUploadStatus | \nString | \nIndicates current status of the recording file being uploaded via SFTP. One of: UPLOADING, UPLOADED, FAILED. | \n
\n\n| results[].files[].customData | \nObject | \nCustom data. | \n
\n\n| results[].status | \nString | \nStatus of call recording. One of: SUCCESSFUL, PARTIALLY_FAILED, FAILED. | \n
\n\n| results[].reason | \nString | \nReason for recording failure. | \n
\n\n| results[].callsConfigurationId | \nString | \nCalls Configuration ID. | \n
\n\n| results[].platform | \nObject | \nPlatform options. For more details, see documentation. | \n
\n\n| results[].platform.entityId | \nString | \nRequired to use entity in a send request for outbound traffic. Returned in notification events. For more details, see documentation. | \n
\n\n| results[].platform.applicationId | \nString | \nRequired for application use in a send request for outbound traffic. Returned in notification events. For more details, see documentation. | \n
\n\n| results[].startTime | \nString | \nDate and time when the (first) call recording started. | \n
\n\n| results[].endTime | \nString | \nDate and time when the (last) call recording ended. | \n
\n\n| paging | \nObject | \nContains information about the page. | \n
\n\n| paging.page | \nInt | \nRequired. Requested page number. | \n
\n\n| paging.size | \nInt | \nRequired. Requested page size. | \n
\n\n| paging.totalPages | \nInt | \nRequired. The total number of pages of the results matching the requested parameters. | \n
\n\n| paging.totalResults | \nInt | \nRequired. The total number of the results matching the requested parameters. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["calls","1","recordings","calls"],"host":["go2","vhdmedia","se"],"query":[{"disabled":true,"description":{"content":"Call ID.
\n","type":"text/plain"},"key":"callId","value":"{{callId}}"},{"disabled":true,"description":{"content":"Calls Configuration ID.
\n","type":"text/plain"},"key":"callsConfigurationId","value":"{{callsConfigurationId}}"},{"disabled":true,"description":{"content":"Application ID.
\n","type":"text/plain"},"key":"applicationId","value":""},{"disabled":true,"description":{"content":"Entity ID.
\n","type":"text/plain"},"key":"entityId","value":""},{"disabled":true,"description":{"content":"Endpoint identifier.
\n","type":"text/plain"},"key":"endpointIdentifier","value":""},{"disabled":true,"description":{"content":"Date and time when the (first) call recording started.
\n","type":"text/plain"},"key":"startTimeAfter","value":""},{"disabled":true,"description":{"content":"Date and time when the (last) call recording ended.
\n","type":"text/plain"},"key":"endTimeBefore","value":""},{"disabled":true,"description":{"content":"Call direction.
\n","type":"text/plain"},"key":"direction","value":""},{"disabled":true,"description":{"content":"Endpoint type.
\n","type":"text/plain"},"key":"endpointType","value":""},{"disabled":true,"description":{"content":"Recording location.
\n","type":"text/plain"},"key":"location","value":""},{"disabled":true,"description":{"content":"Results page to retrieve (0..N). Default: 0.
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Number of records per page. Default: 20.
\n","type":"text/plain"},"key":"size","value":""}],"variable":[]}},"response":[{"id":"8c735690-b279-4846-a285-907696ed9b04","name":"200 - Call recording page response.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/recordings/calls","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","recordings","calls"],"query":[{"key":"callId","value":"{{callId}}","description":"Call ID.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"entityId","value":"","description":"Entity ID.","disabled":true},{"key":"endpointIdentifier","value":"","description":"Endpoint identifier.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time when the (first) call recording started.","disabled":true},{"key":"endTimeBefore","value":"","description":"Date and time when the (last) call recording ended.","disabled":true},{"key":"direction","value":"","description":"Call direction.","disabled":true},{"key":"endpointType","value":"","description":"Endpoint type.","disabled":true},{"key":"location","value":"","description":"Recording location.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"callId\": \"d8d84155-3831-43fb-91c9-10b5a8d628a0\",\n \"endpoint\": {\n \"type\": \"PHONE\",\n \"phoneNumber\": \"41793026834\"\n },\n \"direction\": \"INBOUND\",\n \"files\": [\n {\n \"id\": \"d8d84155-3831-43fb-91c9-10b5a8d628a0\",\n \"name\": \"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav\",\n \"fileFormat\": \"WAV\",\n \"size\": 67564,\n \"creationTime\": \"2026-01-15T12:00:00.150+0000\",\n \"duration\": 10,\n \"startTime\": \"2026-01-15T11:59:50.000+0000\",\n \"endTime\": \"2026-01-15T12:00:00.000+0000\",\n \"location\": \"HOSTED\",\n \"customData\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n }\n ],\n \"status\": \"SUCCESSFUL\"\n },\n {\n \"callId\": \"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8\",\n \"endpoint\": {\n \"type\": \"PHONE\",\n \"phoneNumber\": \"41793026834\"\n },\n \"direction\": \"INBOUND\",\n \"files\": [\n {\n \"id\": \"d8d84155-3831-43fb-91c9-10b5a8d628a0\",\n \"name\": \"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav\",\n \"fileFormat\": \"WAV\",\n \"size\": 67564,\n \"creationTime\": \"2026-01-15T12:00:00.150+0000\",\n \"duration\": 10,\n \"startTime\": \"2026-01-15T11:59:50.000+0000\",\n \"endTime\": \"2026-01-15T12:00:00.000+0000\",\n \"location\": \"HOSTED\",\n \"customData\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n }\n ],\n \"status\": \"PARTIALLY_FAILED\",\n \"reason\": \"Recording postprocessing failed\"\n }\n ],\n \"paging\": {\n \"page\": 0,\n \"size\": 2,\n \"totalPages\": 1,\n \"totalResults\": 2\n }\n}"},{"id":"446dcb5b-0b1a-49ac-be89-7167f5b4fbdf","name":"400 - Error responses","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/recordings/calls","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","recordings","calls"],"query":[{"key":"callId","value":"{{callId}}","description":"Call ID.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"entityId","value":"","description":"Entity ID.","disabled":true},{"key":"endpointIdentifier","value":"","description":"Endpoint identifier.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time when the (first) call recording started.","disabled":true},{"key":"endTimeBefore","value":"","description":"Date and time when the (last) call recording ended.","disabled":true},{"key":"direction","value":"","description":"Call direction.","disabled":true},{"key":"endpointType","value":"","description":"Endpoint type.","disabled":true},{"key":"location","value":"","description":"Recording location.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Request is invalid.\"\n }\n }\n}"},{"id":"641ba28e-d448-41b7-955f-d3206ee6faa5","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/recordings/calls","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","recordings","calls"],"query":[{"key":"callId","value":"{{callId}}","description":"Call ID.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"entityId","value":"","description":"Entity ID.","disabled":true},{"key":"endpointIdentifier","value":"","description":"Endpoint identifier.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time when the (first) call recording started.","disabled":true},{"key":"endTimeBefore","value":"","description":"Date and time when the (last) call recording ended.","disabled":true},{"key":"direction","value":"","description":"Call direction.","disabled":true},{"key":"endpointType","value":"","description":"Endpoint type.","disabled":true},{"key":"location","value":"","description":"Recording location.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"1b7a5af9-715e-4189-b323-27285d58aaa8","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/recordings/calls","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","recordings","calls"],"query":[{"key":"callId","value":"{{callId}}","description":"Call ID.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"entityId","value":"","description":"Entity ID.","disabled":true},{"key":"endpointIdentifier","value":"","description":"Endpoint identifier.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time when the (first) call recording started.","disabled":true},{"key":"endTimeBefore","value":"","description":"Date and time when the (last) call recording ended.","disabled":true},{"key":"direction","value":"","description":"Call direction.","disabled":true},{"key":"endpointType","value":"","description":"Endpoint type.","disabled":true},{"key":"location","value":"","description":"Recording location.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"b9fb1424-7b1e-45dc-8d3a-94108351d1e0","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/recordings/calls","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","recordings","calls"],"query":[{"key":"callId","value":"{{callId}}","description":"Call ID.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"entityId","value":"","description":"Entity ID.","disabled":true},{"key":"endpointIdentifier","value":"","description":"Endpoint identifier.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time when the (first) call recording started.","disabled":true},{"key":"endTimeBefore","value":"","description":"Date and time when the (last) call recording ended.","disabled":true},{"key":"direction","value":"","description":"Call direction.","disabled":true},{"key":"endpointType","value":"","description":"Endpoint type.","disabled":true},{"key":"location","value":"","description":"Recording location.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"6228b3f6-d792-4242-bb08-2d469e93e5cc","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/calls/1/recordings/calls","protocol":"https","host":["go2","vhdmedia","se"],"path":["calls","1","recordings","calls"],"query":[{"key":"callId","value":"{{callId}}","description":"Call ID.","disabled":true},{"key":"callsConfigurationId","value":"{{callsConfigurationId}}","description":"Calls Configuration ID.","disabled":true},{"key":"applicationId","value":"","description":"Application ID.","disabled":true},{"key":"entityId","value":"","description":"Entity ID.","disabled":true},{"key":"endpointIdentifier","value":"","description":"Endpoint identifier.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time when the (first) call recording started.","disabled":true},{"key":"endTimeBefore","value":"","description":"Date and time when the (last) call recording ended.","disabled":true},{"key":"direction","value":"","description":"Call direction.","disabled":true},{"key":"endpointType","value":"","description":"Endpoint type.","disabled":true},{"key":"location","value":"","description":"Recording location.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"47c6edab-0341-466d-a236-79862535569c"}],"id":"3f5b984d-a8d1-4a84-90b4-49f356305706","description":"Recordings of calls made with the Calls API.
\n","_postman_id":"3f5b984d-a8d1-4a84-90b4-49f356305706"},{"name":"6 Cleanup","item":[{"name":"Delete calls configuration","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","if (!(pm.environment.get(\"callsConfigurationId\") || \"\")) { skip(\"callsConfigurationId is not set (an earlier request did not create it)\"); }"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"id\", \"name\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});"],"type":"text/javascript","packages":{}}}],"id":"ab07d01b-a229-44c7-a69b-fed6f7d0d1b7","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}","description":"Delete calls configuration.
\nDelete calls configuration.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| callsConfigurationId | \nString | \nRequired. Calls configuration ID. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nString | \nCalls configuration ID. | \n
\n\n| name | \nString | \nCalls configuration name. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["calls","1","configurations","{{callsConfigurationId}}"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"89ceba44-6f73-4d30-9941-78320fd6d18f","name":"200 - Delete response example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"63467c6e2885a5389ba11d80\",\n \"name\": \"Calls configuration\"\n}"},{"id":"c452d340-d049-4ee4-b58f-3bf7aec8c64e","name":"401 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"b65060f4-8bcb-474d-acca-84a529b57764","name":"403 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"3fc2e6bd-3d96-428b-9d32-be7c323327d8","name":"404 - Error responses","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"NOT_FOUND\",\n \"text\": \"Resource was not found.\"\n }\n }\n}"},{"id":"6132a8e3-21e9-4824-91f2-70c9b21e1489","name":"429 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"6ec21840-ee61-4462-9b49-cffc77dafb91","name":"500 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/calls/1/configurations/{{callsConfigurationId}}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"ab07d01b-a229-44c7-a69b-fed6f7d0d1b7"}],"id":"c672aa34-2390-44f1-a4d5-348fc72ca0f4","description":"Removes the sample configuration after the requests above have used it.
\n","_postman_id":"c672aa34-2390-44f1-a4d5-348fc72ca0f4"}],"id":"0734d5f9-ba9e-41bc-8a8f-81783b2139ea","description":"Calls configurations, active calls and call history, conferences, audio files and call recordings. The requests run in order: create a configuration, use it, and delete it at the end. Placing calls through the Calls API (creating calls and bulks of calls) is not included: it needs a subscription on the calls configuration that is not available on this account.
\n","_postman_id":"0734d5f9-ba9e-41bc-8a8f-81783b2139ea"},{"name":"CALL LINKS","item":[{"name":"Create call link configuration","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","(function () {"," api(\"GET\", \"/call-link/1/configs\", null, function (e, r) {"," var list = ((jsonOf(r) || {}).results || []).filter(function (c) { return c.name === \"Sample call link configuration\"; });"," (function next(i) { if (i >= list.length) { return; } api(\"DELETE\", \"/call-link/1/configs/\" + list[i].id, null, function () { next(i + 1); }); })(0);"," });","})();"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 201\", function () {"," pm.expect(pm.response.code).to.be.oneOf([201]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"id\", \"name\", \"isDefault\", \"initialOptions\", \"callOptions\", \"theme\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});","","pm.environment.set(\"callLinkConfigId\", pm.response.json().id);"],"type":"text/javascript","packages":{}}}],"id":"b28a8d65-976b-43d9-b780-fb2facab4527","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sample call link configuration\",\n \"initialOptions\": {\n \"audio\": true,\n \"video\": false,\n \"muted\": false,\n \"cameraFacingMode\": \"FRONT\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/configs","description":"Create configuration.
\nUse this method to add a new call link configuration.
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| name | \nString | \nRequired. Configuration name. | \n
\n\n| initialOptions | \nObject | \nUser options available when a user opens a call link page before initiating the call. Depending on the fields, certain options for the call will be shown to a user. | \n
\n\n| initialOptions.audio | \nBoolean | \nUser will be able to initiate the audio call. | \n
\n\n| initialOptions.video | \nBoolean | \nUser will be able to initiate the video call. | \n
\n\n| initialOptions.muted | \nBoolean | \nUser will be muted once the call is established. | \n
\n\n| initialOptions.settings | \nBoolean | \nUser will be able to configure settings before a call. | \n
\n\n| initialOptions.cameraFacingMode | \nString | \nIn the case of a video call on mobile phones camera will be back or front depending on this value. It is 'FRONT' by default. One of: FRONT, BACK. | \n
\n\n| callOptions | \nObject | \nUser options available during a call. Depending on the fields, certain options for a call will be shown to a user. | \n
\n\n| callOptions.mute | \nBoolean | \nUser will be able to mute themselves during the call. | \n
\n\n| callOptions.screenShare | \nBoolean | \nUser will be able to share the screen during the call. | \n
\n\n| callOptions.camera | \nBoolean | \nUser will be able to toggle the video during the call. | \n
\n\n| callOptions.switchCameraFacingMode | \nBoolean | \nUser will be able to switch between front-facing and back camera during the call. | \n
\n\n| callOptions.dialPad | \nBoolean | \nUser will be able to use dial pad for DTMF, during the call. | \n
\n\n| callOptions.chat | \nBoolean | \nUsers will be able to open the chat box and send and receive text messages that are visible to all the participants. This is applicable only for the ROOM call type. Messages sent before joining the room are not visible. | \n
\n\n| callOptions.settings | \nBoolean | \nUser will be able to access settings during the call. | \n
\n\n| callOptions.recordingIndicator | \nBoolean | \nUser will be able to see if the call is being recorded. | \n
\n\n| theme | \nObject | \nCall link theme-specific configuration settings. Use it to add image, color, and text selections to customize a call link page. | \n
\n\n| theme.images | \nObject | \nEnumerate images shown on a call link page. Once an image is uploaded (by using the image upload API) a unique ID returned in that response can be used to add a background image or a logo image. | \n
\n\n| theme.images.logoImageId | \nString | \nID of an image shown as a logo on a call link page. | \n
\n\n| theme.images.backgroundImageId | \nString | \nID of an image shown as a background on a call link page. | \n
\n\n| theme.messages | \nObject | \nCall link messaging settings. | \n
\n\n| theme.messages.welcomeText | \nString | \nMessage shown when a call link is opened. | \n
\n\n| theme.messages.inactiveText | \nString | \nMessage shown when a call link is not active. | \n
\n\n| theme.messages.expirationText | \nString | \nMessage shown when a call link is expired. | \n
\n\n| theme.colors | \nObject | \nColors settings. If not specified, the default colors will be used. | \n
\n\n| theme.colors.primary | \nString | \nPrimary color of a theme in the hexadecimal format. | \n
\n\n| theme.colors.primaryText | \nString | \nPrimary color of a text in the hexadecimal format. | \n
\n\n| theme.colors.background | \nString | \nBackground color in the hexadecimal format. | \n
\n\n| theme.layouts | \nArray | \nRepresents layout during the call.When GRID layout is selected, multiple video streams are displayed simultaneously and user can spotlight specific video stream.When SOLO layout is selected, an user can see only his video streams.If there are more than one layout in this list, the first one will be initially selected, and users can change it during the call.The default layout will be set to GRID. | \n
\n\n| theme.localization | \nObject | \nIf the localization object is not defined, English will be used. If the localization type is set to PRESET, the language code is mandatory to be defined to one of the predefined values.If the localization type is set to BROWSER_DETECTED and the browser language is one of the languages that could be set in PRESET type, then that language will be used. Otherwise, English will be used. | \n
\n\n| theme.localization.type | \nString | \nOne of: BROWSER_DETECTED, PRESET. | \n
\n\n| isDefault | \nBoolean | \nIndicates whether the specific call link configuration is the default one and used with any call link without a callLinkConfigId. Only one configuration can be default.If you don't have a configuration, the basic VHD theme with default values and minimal options will be used.If you want to use another configuration, set this value to true for the call link config you wish as default. | \n
\n\n| subdomainId | \nString | \nSubdomain to use for every call link generated for this configuration.If not defined, no subdomain will be used. | \n
\n\n| webhook | \nObject | \nWebhook triggered when there is a call event. | \n
\n\n| webhook.url | \nString | \nRequired. Your webhook URL. | \n
\n\n| webhook.securityConfig | \nObject | \nSecurity settings object holding the authentication settings necessary to access your webhook. | \n
\n\n| webhook.securityConfig.type | \nString | \nOne of: BASIC, HMAC. | \n
\n\n
\n
On success the response is 201 Created.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nString | \nConfiguration ID. Once a call link is created, this value might be sent in the request as one specific call link configuration to be used by the call link. | \n
\n\n| name | \nString | \nConfiguration name or description. It doesn't have to be unique. | \n
\n\n| isDefault | \nBoolean | \nWhen you create call link without callLinkConfigId, the one marked as default will be used. Only one configuration can be default.If you don't have a configuration, the basic VHD theme with default values and minimal options will be used.If you want to set another configuration as default, specify its value when adding or updating it. | \n
\n\n| initialOptions | \nObject | \nUser options available when a user opens a call link page before initiating the call. Depending on the fields, certain options for the call will be shown to a user. | \n
\n\n| initialOptions.audio | \nBoolean | \nUser will be able to initiate the audio call. | \n
\n\n| initialOptions.video | \nBoolean | \nUser will be able to initiate the video call. | \n
\n\n| initialOptions.muted | \nBoolean | \nUser will be muted once the call is established. | \n
\n\n| initialOptions.settings | \nBoolean | \nUser will be able to configure settings before a call. | \n
\n\n| initialOptions.cameraFacingMode | \nString | \nIn the case of a video call on mobile phones camera will be back or front depending on this value. It is 'FRONT' by default. One of: FRONT, BACK. | \n
\n\n| callOptions | \nObject | \nUser options available during a call. Depending on the fields, certain options for a call will be shown to a user. | \n
\n\n| callOptions.mute | \nBoolean | \nUser will be able to mute themselves during the call. | \n
\n\n| callOptions.screenShare | \nBoolean | \nUser will be able to share the screen during the call. | \n
\n\n| callOptions.camera | \nBoolean | \nUser will be able to toggle the video during the call. | \n
\n\n| callOptions.switchCameraFacingMode | \nBoolean | \nUser will be able to switch between front-facing and back camera during the call. | \n
\n\n| callOptions.dialPad | \nBoolean | \nUser will be able to use dial pad for DTMF, during the call. | \n
\n\n| callOptions.chat | \nBoolean | \nUsers will be able to open the chat box and send and receive text messages that are visible to all the participants. This is applicable only for the ROOM call type. Messages sent before joining the room are not visible. | \n
\n\n| callOptions.settings | \nBoolean | \nUser will be able to access settings during the call. | \n
\n\n| callOptions.recordingIndicator | \nBoolean | \nUser will be able to see if the call is being recorded. | \n
\n\n| theme | \nObject | \nCall link theme-specific configuration settings. Use it to add image, color, and text selections to customize a call link page. | \n
\n\n| theme.images | \nObject | \nEnumerate images shown on a call link page. Once an image is uploaded (by using the image upload API) a unique ID returned in that response can be used to add a background image or a logo image. | \n
\n\n| theme.images.logoImageId | \nString | \nID of an image shown as a logo on a call link page. | \n
\n\n| theme.images.backgroundImageId | \nString | \nID of an image shown as a background on a call link page. | \n
\n\n| theme.messages | \nObject | \nCall link messaging settings. | \n
\n\n| theme.messages.welcomeText | \nString | \nMessage shown when a call link is opened. | \n
\n\n| theme.messages.inactiveText | \nString | \nMessage shown when a call link is not active. | \n
\n\n| theme.messages.expirationText | \nString | \nMessage shown when a call link is expired. | \n
\n\n| theme.colors | \nObject | \nColors settings. If not specified, the default colors will be used. | \n
\n\n| theme.colors.primary | \nString | \nPrimary color of a theme in the hexadecimal format. | \n
\n\n| theme.colors.primaryText | \nString | \nPrimary color of a text in the hexadecimal format. | \n
\n\n| theme.colors.background | \nString | \nBackground color in the hexadecimal format. | \n
\n\n| theme.layouts | \nArray | \nRepresents layout during the call.When GRID layout is selected, multiple video streams are displayed simultaneously and user can spotlight specific video stream.When SOLO layout is selected, an user can see only his video streams.If there are more than one layout in this list, the first one will be initially selected, and users can change it during the call.The default layout will be set to GRID. | \n
\n\n| theme.localization | \nObject | \nIf the localization object is not defined, English will be used. If the localization type is set to PRESET, the language code is mandatory to be defined to one of the predefined values.If the localization type is set to BROWSER_DETECTED and the browser language is one of the languages that could be set in PRESET type, then that language will be used. Otherwise, English will be used. | \n
\n\n| theme.localization.type | \nString | \nOne of: BROWSER_DETECTED, PRESET. | \n
\n\n| subdomainId | \nString | \nId of the subdomain that will be set on every call link generated with this configuration. If undefined, call links will be generated without a subdomain. | \n
\n\n| webhook | \nObject | \nWebhook triggered when there is a call event. | \n
\n\n| webhook.url | \nString | \nRequired. Your webhook URL. | \n
\n\n| webhook.securityConfig | \nObject | \nSecurity settings object holding the authentication settings necessary to access your webhook. | \n
\n\n| webhook.securityConfig.type | \nString | \nOne of: BASIC, HMAC. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["call-link","1","configs"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"e08807e3-9acf-492b-8c83-1b18f6c348b3","name":"201 - Call Link Config Response","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Company name\",\n \"initialOptions\": {\n \"audio\": true,\n \"video\": false,\n \"muted\": false,\n \"cameraFacingMode\": \"FRONT\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/configs"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"638dbdc6ecede164c3799d04\",\n \"name\": \"Company name\",\n \"isDefault\": true,\n \"initialOptions\": {\n \"audio\": true,\n \"video\": false,\n \"muted\": false,\n \"cameraFacingMode\": \"FRONT\"\n },\n \"callOptions\": {\n \"mute\": true,\n \"screenShare\": true,\n \"switchCameraFacingMode\": true,\n \"dialPad\": true\n },\n \"theme\": {\n \"images\": {\n \"logoImageId\": \"638dbe28ecede164c3799d06\",\n \"backgroundImageId\": \"638dbe0cecede164c3799d05\"\n },\n \"messages\": {\n \"welcomeText\": \"Call link page\",\n \"inactiveText\": \"This link is no longer active.\",\n \"expirationText\": \"This link has expired\"\n },\n \"colors\": {\n \"primary\": \"D8D8D8\",\n \"primaryText\": \"242424\",\n \"background\": \"FFFFFF\"\n }\n }\n}"},{"id":"5a9e852d-3b6e-4f57-8879-9d6b978230ef","name":"400 - Error responses","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Company name\",\n \"initialOptions\": {\n \"audio\": true,\n \"video\": false,\n \"muted\": false,\n \"cameraFacingMode\": \"FRONT\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/configs"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Bad request\",\n \"validationErrors\": {\n \"field\": [\n \"field must not be null.\"\n ]\n }\n }\n }\n}"},{"id":"d46f8967-aef1-4cd1-a295-f8be7a480924","name":"401 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Company name\",\n \"initialOptions\": {\n \"audio\": true,\n \"video\": false,\n \"muted\": false,\n \"cameraFacingMode\": \"FRONT\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/configs"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"1c64ba73-5d7e-4bd8-a2cb-1e8d0c37b31b","name":"403 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Company name\",\n \"initialOptions\": {\n \"audio\": true,\n \"video\": false,\n \"muted\": false,\n \"cameraFacingMode\": \"FRONT\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/configs"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"6f8bc066-0c5d-4ba7-ab1b-ea7f71c66c53","name":"429 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Company name\",\n \"initialOptions\": {\n \"audio\": true,\n \"video\": false,\n \"muted\": false,\n \"cameraFacingMode\": \"FRONT\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/configs"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"98eb8938-acc5-4aed-837a-5d4da8253896","name":"500 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Company name\",\n \"initialOptions\": {\n \"audio\": true,\n \"video\": false,\n \"muted\": false,\n \"cameraFacingMode\": \"FRONT\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/configs"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"b28a8d65-976b-43d9-b780-fb2facab4527"},{"name":"Get call link configurations","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"results\", \"paging\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});","","pm.test(\"'results' is an array\", function () {"," pm.expect(responseBody[\"results\"]).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"1567151d-9afc-414c-82dc-e3faa9e06c5d","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/configs","description":"Get configurations.
\nUse this method to retrieve all call link configurations.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| page | \nInt | \nResults page to retrieve (0..N). Default: 0. | \n
\n\n| size | \nInt | \nNumber of records per page. Default: 20. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \nArray | \nThe list of the results for this page. | \n
\n\n| results[].id | \nString | \nConfiguration ID. Once a call link is created, this value might be sent in the request as one specific call link configuration to be used by the call link. | \n
\n\n| results[].name | \nString | \nConfiguration name or description. It doesn't have to be unique. | \n
\n\n| results[].isDefault | \nBoolean | \nWhen you create call link without callLinkConfigId, the one marked as default will be used. Only one configuration can be default.If you don't have a configuration, the basic VHD theme with default values and minimal options will be used.If you want to set another configuration as default, specify its value when adding or updating it. | \n
\n\n| results[].initialOptions | \nObject | \nUser options available when a user opens a call link page before initiating the call. Depending on the fields, certain options for the call will be shown to a user. | \n
\n\n| results[].initialOptions.audio | \nBoolean | \nUser will be able to initiate the audio call. | \n
\n\n| results[].initialOptions.video | \nBoolean | \nUser will be able to initiate the video call. | \n
\n\n| results[].initialOptions.muted | \nBoolean | \nUser will be muted once the call is established. | \n
\n\n| results[].initialOptions.settings | \nBoolean | \nUser will be able to configure settings before a call. | \n
\n\n| results[].initialOptions.cameraFacingMode | \nString | \nIn the case of a video call on mobile phones camera will be back or front depending on this value. It is 'FRONT' by default. One of: FRONT, BACK. | \n
\n\n| results[].callOptions | \nObject | \nUser options available during a call. Depending on the fields, certain options for a call will be shown to a user. | \n
\n\n| results[].callOptions.mute | \nBoolean | \nUser will be able to mute themselves during the call. | \n
\n\n| results[].callOptions.screenShare | \nBoolean | \nUser will be able to share the screen during the call. | \n
\n\n| results[].callOptions.camera | \nBoolean | \nUser will be able to toggle the video during the call. | \n
\n\n| results[].callOptions.switchCameraFacingMode | \nBoolean | \nUser will be able to switch between front-facing and back camera during the call. | \n
\n\n| results[].callOptions.dialPad | \nBoolean | \nUser will be able to use dial pad for DTMF, during the call. | \n
\n\n| results[].callOptions.chat | \nBoolean | \nUsers will be able to open the chat box and send and receive text messages that are visible to all the participants. This is applicable only for the ROOM call type. Messages sent before joining the room are not visible. | \n
\n\n| results[].callOptions.settings | \nBoolean | \nUser will be able to access settings during the call. | \n
\n\n| results[].callOptions.recordingIndicator | \nBoolean | \nUser will be able to see if the call is being recorded. | \n
\n\n| results[].theme | \nObject | \nCall link theme-specific configuration settings. Use it to add image, color, and text selections to customize a call link page. | \n
\n\n| results[].theme.images | \nObject | \nEnumerate images shown on a call link page. Once an image is uploaded (by using the image upload API) a unique ID returned in that response can be used to add a background image or a logo image. | \n
\n\n| results[].theme.images.logoImageId | \nString | \nID of an image shown as a logo on a call link page. | \n
\n\n| results[].theme.images.backgroundImageId | \nString | \nID of an image shown as a background on a call link page. | \n
\n\n| results[].theme.messages | \nObject | \nCall link messaging settings. | \n
\n\n| results[].theme.messages.welcomeText | \nString | \nMessage shown when a call link is opened. | \n
\n\n| results[].theme.messages.inactiveText | \nString | \nMessage shown when a call link is not active. | \n
\n\n| results[].theme.messages.expirationText | \nString | \nMessage shown when a call link is expired. | \n
\n\n| results[].theme.colors | \nObject | \nColors settings. If not specified, the default colors will be used. | \n
\n\n| results[].theme.colors.primary | \nString | \nPrimary color of a theme in the hexadecimal format. | \n
\n\n| results[].theme.colors.primaryText | \nString | \nPrimary color of a text in the hexadecimal format. | \n
\n\n| results[].theme.colors.background | \nString | \nBackground color in the hexadecimal format. | \n
\n\n| results[].theme.layouts | \nArray | \nRepresents layout during the call.When GRID layout is selected, multiple video streams are displayed simultaneously and user can spotlight specific video stream.When SOLO layout is selected, an user can see only his video streams.If there are more than one layout in this list, the first one will be initially selected, and users can change it during the call.The default layout will be set to GRID. | \n
\n\n| results[].theme.localization | \nObject | \nIf the localization object is not defined, English will be used. If the localization type is set to PRESET, the language code is mandatory to be defined to one of the predefined values.If the localization type is set to BROWSER_DETECTED and the browser language is one of the languages that could be set in PRESET type, then that language will be used. Otherwise, English will be used. | \n
\n\n| results[].theme.localization.type | \nString | \nOne of: BROWSER_DETECTED, PRESET. | \n
\n\n| results[].subdomainId | \nString | \nId of the subdomain that will be set on every call link generated with this configuration. If undefined, call links will be generated without a subdomain. | \n
\n\n| results[].webhook | \nObject | \nWebhook triggered when there is a call event. | \n
\n\n| results[].webhook.url | \nString | \nRequired. Your webhook URL. | \n
\n\n| results[].webhook.securityConfig | \nObject | \nSecurity settings object holding the authentication settings necessary to access your webhook. | \n
\n\n| results[].webhook.securityConfig.type | \nString | \nOne of: BASIC, HMAC. | \n
\n\n| paging | \nObject | \nContains information about the page. | \n
\n\n| paging.page | \nInt | \nRequired. Requested page number. | \n
\n\n| paging.size | \nInt | \nRequired. Requested page size. | \n
\n\n| paging.totalPages | \nInt | \nRequired. The total number of pages of the results matching the requested parameters. | \n
\n\n| paging.totalResults | \nInt | \nRequired. The total number of the results matching the requested parameters. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["call-link","1","configs"],"host":["go2","vhdmedia","se"],"query":[{"disabled":true,"description":{"content":"Results page to retrieve (0..N). Default: 0.
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Number of records per page. Default: 20.
\n","type":"text/plain"},"key":"size","value":""}],"variable":[]}},"response":[{"id":"184b5285-61a2-4747-8bd8-75a34807663a","name":"200 - Call Link Config Page Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/configs","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","configs"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"name\": \"Company name\",\n \"initialOptions\": {\n \"audio\": true,\n \"video\": false,\n \"muted\": false,\n \"cameraFacingMode\": \"FRONT\"\n },\n \"callOptions\": {\n \"mute\": true,\n \"screenShare\": true,\n \"switchCameraFacingMode\": true,\n \"dialPad\": true\n },\n \"theme\": {\n \"images\": {\n \"logoImageId\": \"638dbe28ecede164c3799d06\",\n \"backgroundImageId\": \"638dbe0cecede164c3799d05\"\n },\n \"messages\": {\n \"welcomeText\": \"Call link page\",\n \"inactiveText\": \"This link is no longer active.\",\n \"expirationText\": \"This link has expired\"\n },\n \"colors\": {\n \"primary\": \"D8D8D8\",\n \"primaryText\": \"242424\",\n \"background\": \"FFFFFF\"\n }\n }\n },\n {\n \"name\": \"Company name\",\n \"theme\": {\n \"images\": {\n \"logoImageId\": \"638dbe28ecede164c3799d06\",\n \"backgroundImageId\": \"638dbe0cecede164c3799d05\"\n },\n \"messages\": {\n \"welcomeText\": \"Call link page\",\n \"inactiveText\": \"This link is no longer active.\",\n \"expirationText\": \"This link has expired\"\n },\n \"colors\": {\n \"primary\": \"D8D8D8\",\n \"primaryText\": \"242424\",\n \"background\": \"FFFFFF\"\n }\n }\n }\n ],\n \"paging\": {\n \"page\": 0,\n \"size\": 10,\n \"totalPages\": 1,\n \"totalResults\": 2\n }\n}"},{"id":"837b8dec-7e48-45b7-b243-89619f5d154b","name":"400 - Error responses","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/configs","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","configs"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Bad request\",\n \"validationErrors\": {\n \"field\": [\n \"field must not be null.\"\n ]\n }\n }\n }\n}"},{"id":"35b20a47-4349-407e-bdc5-032cc5b76185","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/configs","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","configs"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"25994d13-a0c0-4bd5-8919-759be7e3ae13","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/configs","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","configs"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"5f4f95c4-486e-4f16-900c-e0d4d397fb54","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/configs","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","configs"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"65317132-1d05-410b-ac89-44485b1ffe38","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/configs","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","configs"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"1567151d-9afc-414c-82dc-e3faa9e06c5d"},{"name":"Get call link configuration","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","if (!(pm.environment.get(\"callLinkConfigId\") || \"\")) { skip(\"callLinkConfigId is not set (an earlier request did not create it)\"); }"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"id\", \"name\", \"isDefault\", \"initialOptions\", \"callOptions\", \"theme\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});"],"type":"text/javascript","packages":{}}}],"id":"3b86ce9b-4670-4fc8-923f-05f28639a578","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}","description":"Get configuration.
\nUse this method to retrieve a call link configuration by its ID.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nString | \nRequired. ID of a call link configuration to load. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nString | \nConfiguration ID. Once a call link is created, this value might be sent in the request as one specific call link configuration to be used by the call link. | \n
\n\n| name | \nString | \nConfiguration name or description. It doesn't have to be unique. | \n
\n\n| isDefault | \nBoolean | \nWhen you create call link without callLinkConfigId, the one marked as default will be used. Only one configuration can be default.If you don't have a configuration, the basic VHD theme with default values and minimal options will be used.If you want to set another configuration as default, specify its value when adding or updating it. | \n
\n\n| initialOptions | \nObject | \nUser options available when a user opens a call link page before initiating the call. Depending on the fields, certain options for the call will be shown to a user. | \n
\n\n| initialOptions.audio | \nBoolean | \nUser will be able to initiate the audio call. | \n
\n\n| initialOptions.video | \nBoolean | \nUser will be able to initiate the video call. | \n
\n\n| initialOptions.muted | \nBoolean | \nUser will be muted once the call is established. | \n
\n\n| initialOptions.settings | \nBoolean | \nUser will be able to configure settings before a call. | \n
\n\n| initialOptions.cameraFacingMode | \nString | \nIn the case of a video call on mobile phones camera will be back or front depending on this value. It is 'FRONT' by default. One of: FRONT, BACK. | \n
\n\n| callOptions | \nObject | \nUser options available during a call. Depending on the fields, certain options for a call will be shown to a user. | \n
\n\n| callOptions.mute | \nBoolean | \nUser will be able to mute themselves during the call. | \n
\n\n| callOptions.screenShare | \nBoolean | \nUser will be able to share the screen during the call. | \n
\n\n| callOptions.camera | \nBoolean | \nUser will be able to toggle the video during the call. | \n
\n\n| callOptions.switchCameraFacingMode | \nBoolean | \nUser will be able to switch between front-facing and back camera during the call. | \n
\n\n| callOptions.dialPad | \nBoolean | \nUser will be able to use dial pad for DTMF, during the call. | \n
\n\n| callOptions.chat | \nBoolean | \nUsers will be able to open the chat box and send and receive text messages that are visible to all the participants. This is applicable only for the ROOM call type. Messages sent before joining the room are not visible. | \n
\n\n| callOptions.settings | \nBoolean | \nUser will be able to access settings during the call. | \n
\n\n| callOptions.recordingIndicator | \nBoolean | \nUser will be able to see if the call is being recorded. | \n
\n\n| theme | \nObject | \nCall link theme-specific configuration settings. Use it to add image, color, and text selections to customize a call link page. | \n
\n\n| theme.images | \nObject | \nEnumerate images shown on a call link page. Once an image is uploaded (by using the image upload API) a unique ID returned in that response can be used to add a background image or a logo image. | \n
\n\n| theme.images.logoImageId | \nString | \nID of an image shown as a logo on a call link page. | \n
\n\n| theme.images.backgroundImageId | \nString | \nID of an image shown as a background on a call link page. | \n
\n\n| theme.messages | \nObject | \nCall link messaging settings. | \n
\n\n| theme.messages.welcomeText | \nString | \nMessage shown when a call link is opened. | \n
\n\n| theme.messages.inactiveText | \nString | \nMessage shown when a call link is not active. | \n
\n\n| theme.messages.expirationText | \nString | \nMessage shown when a call link is expired. | \n
\n\n| theme.colors | \nObject | \nColors settings. If not specified, the default colors will be used. | \n
\n\n| theme.colors.primary | \nString | \nPrimary color of a theme in the hexadecimal format. | \n
\n\n| theme.colors.primaryText | \nString | \nPrimary color of a text in the hexadecimal format. | \n
\n\n| theme.colors.background | \nString | \nBackground color in the hexadecimal format. | \n
\n\n| theme.layouts | \nArray | \nRepresents layout during the call.When GRID layout is selected, multiple video streams are displayed simultaneously and user can spotlight specific video stream.When SOLO layout is selected, an user can see only his video streams.If there are more than one layout in this list, the first one will be initially selected, and users can change it during the call.The default layout will be set to GRID. | \n
\n\n| theme.localization | \nObject | \nIf the localization object is not defined, English will be used. If the localization type is set to PRESET, the language code is mandatory to be defined to one of the predefined values.If the localization type is set to BROWSER_DETECTED and the browser language is one of the languages that could be set in PRESET type, then that language will be used. Otherwise, English will be used. | \n
\n\n| theme.localization.type | \nString | \nOne of: BROWSER_DETECTED, PRESET. | \n
\n\n| subdomainId | \nString | \nId of the subdomain that will be set on every call link generated with this configuration. If undefined, call links will be generated without a subdomain. | \n
\n\n| webhook | \nObject | \nWebhook triggered when there is a call event. | \n
\n\n| webhook.url | \nString | \nRequired. Your webhook URL. | \n
\n\n| webhook.securityConfig | \nObject | \nSecurity settings object holding the authentication settings necessary to access your webhook. | \n
\n\n| webhook.securityConfig.type | \nString | \nOne of: BASIC, HMAC. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["call-link","1","configs","{{callLinkConfigId}}"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"206e0cd9-46a1-4a38-adf4-52ee0002e908","name":"200 - Call Link Config Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"638dbdc6ecede164c3799d04\",\n \"name\": \"Company name\",\n \"isDefault\": true,\n \"initialOptions\": {\n \"audio\": true,\n \"video\": false,\n \"muted\": false,\n \"cameraFacingMode\": \"FRONT\"\n },\n \"callOptions\": {\n \"mute\": true,\n \"screenShare\": true,\n \"switchCameraFacingMode\": true,\n \"dialPad\": true\n },\n \"theme\": {\n \"images\": {\n \"logoImageId\": \"638dbe28ecede164c3799d06\",\n \"backgroundImageId\": \"638dbe0cecede164c3799d05\"\n },\n \"messages\": {\n \"welcomeText\": \"Call link page\",\n \"inactiveText\": \"This link is no longer active.\",\n \"expirationText\": \"This link has expired\"\n },\n \"colors\": {\n \"primary\": \"D8D8D8\",\n \"primaryText\": \"242424\",\n \"background\": \"FFFFFF\"\n }\n }\n}"},{"id":"f48f607b-fca1-47c3-8bf8-44bc05141b5c","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"7d2b93a4-6b57-4b2c-9562-68509ae22d8a","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"ee52eee3-893b-41ac-a692-afaddf3cf802","name":"404 - Error responses","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"NOT_FOUND\",\n \"text\": \"Not found.\"\n }\n }\n}"},{"id":"52ce7e7a-04c3-4191-8c48-cbd112c2d72d","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"ee54026d-91fe-4886-81bd-df2cc9639494","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"3b86ce9b-4670-4fc8-923f-05f28639a578"},{"name":"Partial call link configuration update","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","if (!(pm.environment.get(\"callLinkConfigId\") || \"\")) { skip(\"callLinkConfigId is not set (an earlier request did not create it)\"); }"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"id\", \"name\", \"isDefault\", \"initialOptions\", \"callOptions\", \"theme\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});"],"type":"text/javascript","packages":{}}}],"id":"7905151b-dfc2-4bfe-ab7c-791ef1021a3b","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sample call link configuration (patched)\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}","description":"Partial configuration update.
\nUse this method to update a call link configuration. New values for configuration attributes replace the existing ones. If no value is passed in the request, the attribute keeps its value.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nString | \nRequired. ID of a call link configuration to update. | \n
\n\n
\n
Request body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| name | \nString | \nRequired. Configuration name. | \n
\n\n| initialOptions | \nObject | \nUser options available when a user opens a call link page before initiating the call. Depending on the fields, certain options for the call will be shown to a user. | \n
\n\n| initialOptions.audio | \nBoolean | \nUser will be able to initiate the audio call. | \n
\n\n| initialOptions.video | \nBoolean | \nUser will be able to initiate the video call. | \n
\n\n| initialOptions.muted | \nBoolean | \nUser will be muted once the call is established. | \n
\n\n| initialOptions.settings | \nBoolean | \nUser will be able to configure settings before a call. | \n
\n\n| initialOptions.cameraFacingMode | \nString | \nIn the case of a video call on mobile phones camera will be back or front depending on this value. It is 'FRONT' by default. One of: FRONT, BACK. | \n
\n\n| callOptions | \nObject | \nUser options available during a call. Depending on the fields, certain options for a call will be shown to a user. | \n
\n\n| callOptions.mute | \nBoolean | \nUser will be able to mute themselves during the call. | \n
\n\n| callOptions.screenShare | \nBoolean | \nUser will be able to share the screen during the call. | \n
\n\n| callOptions.camera | \nBoolean | \nUser will be able to toggle the video during the call. | \n
\n\n| callOptions.switchCameraFacingMode | \nBoolean | \nUser will be able to switch between front-facing and back camera during the call. | \n
\n\n| callOptions.dialPad | \nBoolean | \nUser will be able to use dial pad for DTMF, during the call. | \n
\n\n| callOptions.chat | \nBoolean | \nUsers will be able to open the chat box and send and receive text messages that are visible to all the participants. This is applicable only for the ROOM call type. Messages sent before joining the room are not visible. | \n
\n\n| callOptions.settings | \nBoolean | \nUser will be able to access settings during the call. | \n
\n\n| callOptions.recordingIndicator | \nBoolean | \nUser will be able to see if the call is being recorded. | \n
\n\n| theme | \nObject | \nCall link theme-specific configuration settings. Use it to add image, color, and text selections to customize a call link page. | \n
\n\n| theme.images | \nObject | \nEnumerate images shown on a call link page. Once an image is uploaded (by using the image upload API) a unique ID returned in that response can be used to add a background image or a logo image. | \n
\n\n| theme.images.logoImageId | \nString | \nID of an image shown as a logo on a call link page. | \n
\n\n| theme.images.backgroundImageId | \nString | \nID of an image shown as a background on a call link page. | \n
\n\n| theme.messages | \nObject | \nCall link messaging settings. | \n
\n\n| theme.messages.welcomeText | \nString | \nMessage shown when a call link is opened. | \n
\n\n| theme.messages.inactiveText | \nString | \nMessage shown when a call link is not active. | \n
\n\n| theme.messages.expirationText | \nString | \nMessage shown when a call link is expired. | \n
\n\n| theme.colors | \nObject | \nColors settings. If not specified, the default colors will be used. | \n
\n\n| theme.colors.primary | \nString | \nPrimary color of a theme in the hexadecimal format. | \n
\n\n| theme.colors.primaryText | \nString | \nPrimary color of a text in the hexadecimal format. | \n
\n\n| theme.colors.background | \nString | \nBackground color in the hexadecimal format. | \n
\n\n| theme.layouts | \nArray | \nRepresents layout during the call.When GRID layout is selected, multiple video streams are displayed simultaneously and user can spotlight specific video stream.When SOLO layout is selected, an user can see only his video streams.If there are more than one layout in this list, the first one will be initially selected, and users can change it during the call.The default layout will be set to GRID. | \n
\n\n| theme.localization | \nObject | \nIf the localization object is not defined, English will be used. If the localization type is set to PRESET, the language code is mandatory to be defined to one of the predefined values.If the localization type is set to BROWSER_DETECTED and the browser language is one of the languages that could be set in PRESET type, then that language will be used. Otherwise, English will be used. | \n
\n\n| theme.localization.type | \nString | \nOne of: BROWSER_DETECTED, PRESET. | \n
\n\n| isDefault | \nBoolean | \nIndicates whether the specific call link configuration is the default one and used with any call link without a callLinkConfigId. Only one configuration can be default.If you don't have a configuration, the basic VHD theme with default values and minimal options will be used.If you want to use another configuration, set this value to true for the call link config you wish as default. | \n
\n\n| subdomainId | \nString | \nSubdomain to use for every call link generated for this configuration.If not defined, no subdomain will be used. | \n
\n\n| webhook | \nObject | \nWebhook triggered when there is a call event. | \n
\n\n| webhook.url | \nString | \nRequired. Your webhook URL. | \n
\n\n| webhook.securityConfig | \nObject | \nSecurity settings object holding the authentication settings necessary to access your webhook. | \n
\n\n| webhook.securityConfig.type | \nString | \nOne of: BASIC, HMAC. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nString | \nConfiguration ID. Once a call link is created, this value might be sent in the request as one specific call link configuration to be used by the call link. | \n
\n\n| name | \nString | \nConfiguration name or description. It doesn't have to be unique. | \n
\n\n| isDefault | \nBoolean | \nWhen you create call link without callLinkConfigId, the one marked as default will be used. Only one configuration can be default.If you don't have a configuration, the basic VHD theme with default values and minimal options will be used.If you want to set another configuration as default, specify its value when adding or updating it. | \n
\n\n| initialOptions | \nObject | \nUser options available when a user opens a call link page before initiating the call. Depending on the fields, certain options for the call will be shown to a user. | \n
\n\n| initialOptions.audio | \nBoolean | \nUser will be able to initiate the audio call. | \n
\n\n| initialOptions.video | \nBoolean | \nUser will be able to initiate the video call. | \n
\n\n| initialOptions.muted | \nBoolean | \nUser will be muted once the call is established. | \n
\n\n| initialOptions.settings | \nBoolean | \nUser will be able to configure settings before a call. | \n
\n\n| initialOptions.cameraFacingMode | \nString | \nIn the case of a video call on mobile phones camera will be back or front depending on this value. It is 'FRONT' by default. One of: FRONT, BACK. | \n
\n\n| callOptions | \nObject | \nUser options available during a call. Depending on the fields, certain options for a call will be shown to a user. | \n
\n\n| callOptions.mute | \nBoolean | \nUser will be able to mute themselves during the call. | \n
\n\n| callOptions.screenShare | \nBoolean | \nUser will be able to share the screen during the call. | \n
\n\n| callOptions.camera | \nBoolean | \nUser will be able to toggle the video during the call. | \n
\n\n| callOptions.switchCameraFacingMode | \nBoolean | \nUser will be able to switch between front-facing and back camera during the call. | \n
\n\n| callOptions.dialPad | \nBoolean | \nUser will be able to use dial pad for DTMF, during the call. | \n
\n\n| callOptions.chat | \nBoolean | \nUsers will be able to open the chat box and send and receive text messages that are visible to all the participants. This is applicable only for the ROOM call type. Messages sent before joining the room are not visible. | \n
\n\n| callOptions.settings | \nBoolean | \nUser will be able to access settings during the call. | \n
\n\n| callOptions.recordingIndicator | \nBoolean | \nUser will be able to see if the call is being recorded. | \n
\n\n| theme | \nObject | \nCall link theme-specific configuration settings. Use it to add image, color, and text selections to customize a call link page. | \n
\n\n| theme.images | \nObject | \nEnumerate images shown on a call link page. Once an image is uploaded (by using the image upload API) a unique ID returned in that response can be used to add a background image or a logo image. | \n
\n\n| theme.images.logoImageId | \nString | \nID of an image shown as a logo on a call link page. | \n
\n\n| theme.images.backgroundImageId | \nString | \nID of an image shown as a background on a call link page. | \n
\n\n| theme.messages | \nObject | \nCall link messaging settings. | \n
\n\n| theme.messages.welcomeText | \nString | \nMessage shown when a call link is opened. | \n
\n\n| theme.messages.inactiveText | \nString | \nMessage shown when a call link is not active. | \n
\n\n| theme.messages.expirationText | \nString | \nMessage shown when a call link is expired. | \n
\n\n| theme.colors | \nObject | \nColors settings. If not specified, the default colors will be used. | \n
\n\n| theme.colors.primary | \nString | \nPrimary color of a theme in the hexadecimal format. | \n
\n\n| theme.colors.primaryText | \nString | \nPrimary color of a text in the hexadecimal format. | \n
\n\n| theme.colors.background | \nString | \nBackground color in the hexadecimal format. | \n
\n\n| theme.layouts | \nArray | \nRepresents layout during the call.When GRID layout is selected, multiple video streams are displayed simultaneously and user can spotlight specific video stream.When SOLO layout is selected, an user can see only his video streams.If there are more than one layout in this list, the first one will be initially selected, and users can change it during the call.The default layout will be set to GRID. | \n
\n\n| theme.localization | \nObject | \nIf the localization object is not defined, English will be used. If the localization type is set to PRESET, the language code is mandatory to be defined to one of the predefined values.If the localization type is set to BROWSER_DETECTED and the browser language is one of the languages that could be set in PRESET type, then that language will be used. Otherwise, English will be used. | \n
\n\n| theme.localization.type | \nString | \nOne of: BROWSER_DETECTED, PRESET. | \n
\n\n| subdomainId | \nString | \nId of the subdomain that will be set on every call link generated with this configuration. If undefined, call links will be generated without a subdomain. | \n
\n\n| webhook | \nObject | \nWebhook triggered when there is a call event. | \n
\n\n| webhook.url | \nString | \nRequired. Your webhook URL. | \n
\n\n| webhook.securityConfig | \nObject | \nSecurity settings object holding the authentication settings necessary to access your webhook. | \n
\n\n| webhook.securityConfig.type | \nString | \nOne of: BASIC, HMAC. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["call-link","1","configs","{{callLinkConfigId}}"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"e48402d5-5225-436b-9771-a4ca88c6f562","name":"200 - Call Link Config Response","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Company name\",\n \"initialOptions\": {\n \"audio\": true,\n \"video\": false,\n \"muted\": false,\n \"cameraFacingMode\": \"FRONT\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"638dbdc6ecede164c3799d04\",\n \"name\": \"Company name\",\n \"isDefault\": true,\n \"initialOptions\": {\n \"audio\": true,\n \"video\": false,\n \"muted\": false,\n \"cameraFacingMode\": \"FRONT\"\n },\n \"callOptions\": {\n \"mute\": true,\n \"screenShare\": true,\n \"switchCameraFacingMode\": true,\n \"dialPad\": true\n },\n \"theme\": {\n \"images\": {\n \"logoImageId\": \"638dbe28ecede164c3799d06\",\n \"backgroundImageId\": \"638dbe0cecede164c3799d05\"\n },\n \"messages\": {\n \"welcomeText\": \"Call link page\",\n \"inactiveText\": \"This link is no longer active.\",\n \"expirationText\": \"This link has expired\"\n },\n \"colors\": {\n \"primary\": \"D8D8D8\",\n \"primaryText\": \"242424\",\n \"background\": \"FFFFFF\"\n }\n }\n}"},{"id":"6dae9977-2629-442b-b210-fedc4e11785d","name":"400 - Error responses","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Company name\",\n \"initialOptions\": {\n \"audio\": true,\n \"video\": false,\n \"muted\": false,\n \"cameraFacingMode\": \"FRONT\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Bad request\",\n \"validationErrors\": {\n \"field\": [\n \"field must not be null.\"\n ]\n }\n }\n }\n}"},{"id":"eaf3987d-de0a-4179-af59-0f6cc95a9d4d","name":"401 - Example","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Company name\",\n \"initialOptions\": {\n \"audio\": true,\n \"video\": false,\n \"muted\": false,\n \"cameraFacingMode\": \"FRONT\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"1196520f-65ba-41f1-833e-6c6dd7d47f24","name":"403 - Example","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Company name\",\n \"initialOptions\": {\n \"audio\": true,\n \"video\": false,\n \"muted\": false,\n \"cameraFacingMode\": \"FRONT\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"8341e3bc-d9e7-4f97-8e4b-c627c5e56ea6","name":"404 - Error responses","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Company name\",\n \"initialOptions\": {\n \"audio\": true,\n \"video\": false,\n \"muted\": false,\n \"cameraFacingMode\": \"FRONT\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"NOT_FOUND\",\n \"text\": \"Not found.\"\n }\n }\n}"},{"id":"fb2a985f-ec51-4eb1-88e3-28443c2afdaf","name":"429 - Example","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Company name\",\n \"initialOptions\": {\n \"audio\": true,\n \"video\": false,\n \"muted\": false,\n \"cameraFacingMode\": \"FRONT\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"cae7e6c1-8cde-4448-9322-17b47384663c","name":"500 - Example","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Company name\",\n \"initialOptions\": {\n \"audio\": true,\n \"video\": false,\n \"muted\": false,\n \"cameraFacingMode\": \"FRONT\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"7905151b-dfc2-4bfe-ab7c-791ef1021a3b"},{"name":"Create call link","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","if (!(pm.environment.get(\"callLinkConfigId\") || \"\")) { skip(\"callLinkConfigId is not set (an earlier request did not create it)\"); } else {"," var f = function (d) { var t = new Date(Date.now() + d * 86400000); function p(n) { return (\"0\" + n).slice(-2); } return t.getUTCFullYear() + \"-\" + p(t.getUTCMonth() + 1) + \"-\" + p(t.getUTCDate()) + \"T\" + p(t.getUTCHours()) + \":\" + p(t.getUTCMinutes()) + \":\" + p(t.getUTCSeconds()) + \".000+0000\"; };"," pm.environment.set(\"linkStart\", f(0)); pm.environment.set(\"linkEnd\", f(3));","}"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 201\", function () {"," pm.expect(pm.response.code).to.be.oneOf([201]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"id\", \"url\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});","","pm.environment.set(\"callLinkId\", pm.response.json().id);"],"type":"text/javascript","packages":{}}}],"id":"ee9d29c2-4076-459c-b602-02066cf28ab5","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"destination\": {\n \"identity\": \"bob\",\n \"type\": \"WEBRTC\"\n },\n \"validityWindow\": {\n \"oneTime\": true,\n \"startTime\": \"{{linkStart}}\",\n \"endTime\": \"{{linkEnd}}\"\n },\n \"callLinkConfigId\": \"{{callLinkConfigId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/links","description":"Create call link.
\nCreate a link to send to someone who will then initiate a call.
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| identity | \nString | \nIdentity of a user that will use a call link. Must not be set if the destination type of a call link is ROOM. | \n
\n\n| displayName | \nString | \nDisplay name of a user that will use a call link to initiate a call. Must not be set if the destination type of a call link is ROOM. For other destination types, if you want to set a display name, also set identity. | \n
\n\n| showIdentity | \nBoolean | \nShow identity or displayName on before a call. | \n
\n\n| destination | \nObject | \nRequired. Description of who or what is going to receive a call. | \n
\n\n| destination.type | \nString | \nOne of: WEBRTC, CONVERSATIONS, ROOM, PHONE, VIBER, APPLICATION. | \n
\n\n| customData | \nObject | \nCustom attributes sent in a call once it has started. | \n
\n\n| validityWindow | \nObject | \nDescription of a call link validation period and the number of times it can be used within the range. | \n
\n\n| validityWindow.oneTime | \nBoolean | \nBy default, call links are generated for multiple calls.If you want to limit the period for how long a link is valid, specify the start and end time. If you want to invalidate a link after establishing a call, set this value to 'true' (defaults to 'false').For ROOM calls, this value cannot be 'true'. | \n
\n\n| validityWindow.startTime | \nString | \nSpecify starting moment in the UTC timezone for when a call link becomes valid. Defaults to the time when a link was created. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ. | \n
\n\n| validityWindow.endTime | \nString | \nSpecify ending moment in the UTC timezone for when a call link becomes invalid. Default value is 24 hours after a link was created. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ. | \n
\n\n| validityWindow.acceptableHours | \nObject | \nSpecify time range within a day when a link can be used. It is 00:00 - 23:59, by default. UTC timezone is used. | \n
\n\n| validityWindow.acceptableHours.start | \nObject | \n | \n
\n\n| validityWindow.acceptableHours.start.hour | \nInt | \n | \n
\n\n| validityWindow.acceptableHours.start.minute | \nInt | \n | \n
\n\n| validityWindow.acceptableHours.end | \nObject | \n | \n
\n\n| validityWindow.acceptableHours.end.hour | \nInt | \n | \n
\n\n| validityWindow.acceptableHours.end.minute | \nInt | \n | \n
\n\n| validityWindow.acceptableDays | \nArray | \nSpecify the days a link can be used. It is every day of the week, by default. | \n
\n\n| callLinkConfigId | \nString | \nIdentifier of a call link configuration. You can use your existing configuration. If this parameter is not sent and there are call link configurations available, the default one will be used. If there are no configurations, the one with system default values will be used. | \n
\n\n
\n
On success the response is 201 Created.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nString | \nIdentifier of the created call link. To open a call link, an ID will be concatenated to the URL: https://call-link.com/. | \n
\n\n| url | \nString | \nA URL to initiate the call. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["call-link","1","links"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"914846d9-981e-40d8-9739-657d9c0122d4","name":"201 - Call Link Response","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"destination\": {\n \"identity\": \"bob\",\n \"type\": \"WEBRTC\"\n },\n \"validityWindow\": {\n \"oneTime\": true,\n \"startTime\": \"2026-08-24T10:45:59.432+0000\",\n \"endTime\": \"2026-08-25T10:45:59.432+0000\"\n },\n \"callLinkConfigId\": \"638dbdc6ecede164c3799d04\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/links"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"r9wpIY\",\n \"url\": \"https://call-link.com/r9wpIY\"\n}"},{"id":"6bbf7dad-5f42-438a-beed-c722ecc73a50","name":"400 - Error responses","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"destination\": {\n \"identity\": \"bob\",\n \"type\": \"WEBRTC\"\n },\n \"validityWindow\": {\n \"oneTime\": true,\n \"startTime\": \"2026-08-24T10:45:59.432+0000\",\n \"endTime\": \"2026-08-25T10:45:59.432+0000\"\n },\n \"callLinkConfigId\": \"638dbdc6ecede164c3799d04\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/links"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Bad request\",\n \"validationErrors\": {\n \"field\": [\n \"field must not be null.\"\n ]\n }\n }\n }\n}"},{"id":"2221c15f-9ef0-4c2c-a02a-db39d21771fb","name":"401 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"destination\": {\n \"identity\": \"bob\",\n \"type\": \"WEBRTC\"\n },\n \"validityWindow\": {\n \"oneTime\": true,\n \"startTime\": \"2026-08-24T10:45:59.432+0000\",\n \"endTime\": \"2026-08-25T10:45:59.432+0000\"\n },\n \"callLinkConfigId\": \"638dbdc6ecede164c3799d04\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/links"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"c23f00b3-f063-42d2-a1d2-eb7be4ba2444","name":"403 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"destination\": {\n \"identity\": \"bob\",\n \"type\": \"WEBRTC\"\n },\n \"validityWindow\": {\n \"oneTime\": true,\n \"startTime\": \"2026-08-24T10:45:59.432+0000\",\n \"endTime\": \"2026-08-25T10:45:59.432+0000\"\n },\n \"callLinkConfigId\": \"638dbdc6ecede164c3799d04\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/links"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"8c3791ec-d809-4640-b8fc-96e0d99e2203","name":"429 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"destination\": {\n \"identity\": \"bob\",\n \"type\": \"WEBRTC\"\n },\n \"validityWindow\": {\n \"oneTime\": true,\n \"startTime\": \"2026-08-24T10:45:59.432+0000\",\n \"endTime\": \"2026-08-25T10:45:59.432+0000\"\n },\n \"callLinkConfigId\": \"638dbdc6ecede164c3799d04\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/links"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"258eaea7-78ad-4586-abdb-a497399efea9","name":"500 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"destination\": {\n \"identity\": \"bob\",\n \"type\": \"WEBRTC\"\n },\n \"validityWindow\": {\n \"oneTime\": true,\n \"startTime\": \"2026-08-24T10:45:59.432+0000\",\n \"endTime\": \"2026-08-25T10:45:59.432+0000\"\n },\n \"callLinkConfigId\": \"638dbdc6ecede164c3799d04\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/call-link/1/links"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"ee9d29c2-4076-459c-b602-02066cf28ab5"},{"name":"Get call links","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"results\", \"paging\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});","","pm.test(\"'results' is an array\", function () {"," pm.expect(responseBody[\"results\"]).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"25dbf9c6-63ed-4074-9d9a-0c00ad814802","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/links","description":"Get call links.
\nUse this method to retrieve all call links.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| page | \nInt | \nResults page to retrieve (0..N). Default: 0. | \n
\n\n| size | \nInt | \nNumber of records per page. Default: 20. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \nArray | \nThe list of the results for this page. | \n
\n\n| results[].id | \nString | \nIdentifier of the created call link. To open a call link, it should be concatenated to the URL: https://call-link.com/. | \n
\n\n| results[].url | \nString | \nA URL to initiate a call. | \n
\n\n| results[].identity | \nString | \nRequired. Identity of a user who will use a call link. | \n
\n\n| results[].displayName | \nString | \nDisplay name of a user who will use a call link to initiate a call. | \n
\n\n| results[].showIdentity | \nBoolean | \nShow identity or displayName on before a call. | \n
\n\n| results[].destination | \nObject | \nRequired. Description of who or what is going to receive a call. | \n
\n\n| results[].destination.type | \nString | \nOne of: WEBRTC, CONVERSATIONS, ROOM, PHONE, VIBER, APPLICATION. | \n
\n\n| results[].customData | \nObject | \nCustom attributes sent in a call once it is started. | \n
\n\n| results[].validityWindow | \nObject | \nDescription of a call link validation period and the number of times it can be used within the range. | \n
\n\n| results[].validityWindow.oneTime | \nBoolean | \nBy default, call links are generated for multiple calls.If you want to limit the period for how long a link is valid, specify the start and end time. If you want to invalidate a link after establishing a call, set this value to 'true' (defaults to 'false').For ROOM calls, this value cannot be 'true'. | \n
\n\n| results[].validityWindow.startTime | \nString | \nSpecify starting moment in the UTC timezone for when a call link becomes valid. Defaults to the time when a link was created. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ. | \n
\n\n| results[].validityWindow.endTime | \nString | \nSpecify ending moment in the UTC timezone for when a call link becomes invalid. Default value is 24 hours after a link was created. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ. | \n
\n\n| results[].validityWindow.acceptableHours | \nObject | \nSpecify time range within a day when a link can be used. It is 00:00 - 23:59, by default. UTC timezone is used. | \n
\n\n| results[].validityWindow.acceptableHours.start | \nObject | \n | \n
\n\n| results[].validityWindow.acceptableHours.start.hour | \nInt | \n | \n
\n\n| results[].validityWindow.acceptableHours.start.minute | \nInt | \n | \n
\n\n| results[].validityWindow.acceptableHours.end | \nObject | \n | \n
\n\n| results[].validityWindow.acceptableHours.end.hour | \nInt | \n | \n
\n\n| results[].validityWindow.acceptableHours.end.minute | \nInt | \n | \n
\n\n| results[].validityWindow.acceptableDays | \nArray | \nSpecify the days a link can be used. It is every day of the week, by default. | \n
\n\n| results[].callLinkConfigId | \nString | \nID of a configuration to use on an existing call link. If this parameter is not sent, and there are some call link configurations, the default one will be used. If there is no configurations, then the one with the system default values will be used. | \n
\n\n| paging | \nObject | \nContains information about the page. | \n
\n\n| paging.page | \nInt | \nRequired. Requested page number. | \n
\n\n| paging.size | \nInt | \nRequired. Requested page size. | \n
\n\n| paging.totalPages | \nInt | \nRequired. The total number of pages of the results matching the requested parameters. | \n
\n\n| paging.totalResults | \nInt | \nRequired. The total number of the results matching the requested parameters. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["call-link","1","links"],"host":["go2","vhdmedia","se"],"query":[{"disabled":true,"description":{"content":"Results page to retrieve (0..N). Default: 0.
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Number of records per page. Default: 20.
\n","type":"text/plain"},"key":"size","value":""}],"variable":[]}},"response":[{"id":"58a4452c-1d5c-42b4-9f36-2348606b206c","name":"200 - Call Link Page Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/links","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","links"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"id\": \"r9wpIY\",\n \"identity\": \"john\",\n \"displayName\": \"John Doe\",\n \"destination\": {\n \"identity\": \"bob\",\n \"type\": \"WEBRTC\"\n },\n \"customData\": {\n \"city\": \"New York\",\n \"language\": \"en\"\n },\n \"validityWindow\": {\n \"oneTime\": true,\n \"startTime\": \"2026-08-24T10:45:59.432+0000\",\n \"endTime\": \"2026-08-25T10:45:59.432+0000\"\n },\n \"callLinkConfigId\": \"638dbdc6ecede164c3799d04\"\n },\n {\n \"id\": \"1234\",\n \"identity\": \"jane\",\n \"displayName\": \"Jane Doe\",\n \"destination\": {\n \"identity\": \"bob\",\n \"type\": \"WEBRTC\"\n }\n }\n ],\n \"paging\": {\n \"page\": 0,\n \"size\": 10,\n \"totalPages\": 1,\n \"totalResults\": 2\n }\n}"},{"id":"0cc95a35-7cb3-4cc7-9a3f-b9b5bbf03548","name":"400 - Error responses","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/links","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","links"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Bad request\",\n \"validationErrors\": {\n \"field\": [\n \"field must not be null.\"\n ]\n }\n }\n }\n}"},{"id":"d0c65599-22e6-4cbc-8deb-c6f6164355e4","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/links","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","links"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"9d76bf91-0c82-4d11-9bbc-72c9d6d13729","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/links","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","links"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"5cd7c9f1-99e2-4dbf-a9b6-0d33d1ebcae1","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/links","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","links"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"30f00611-74a0-436c-81d7-51ff28185cd1","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/links","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","links"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"25dbf9c6-63ed-4074-9d9a-0c00ad814802"},{"name":"Get call link","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","if (!(pm.environment.get(\"callLinkId\") || \"\")) { skip(\"callLinkId is not set (an earlier request did not create it)\"); }"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});"],"type":"text/javascript","packages":{}}}],"id":"25b100b3-041c-4ac1-ba7d-9795ad27759f","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/links/{{callLinkId}}","description":"Get call link.
\nUse this method to get a call link by its ID.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nString | \nRequired. ID of a call link. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nString | \nIdentifier of the created call link. To open a call link, it should be concatenated to the URL: https://call-link.com/. | \n
\n\n| url | \nString | \nA URL to initiate a call. | \n
\n\n| identity | \nString | \nRequired. Identity of a user who will use a call link. | \n
\n\n| displayName | \nString | \nDisplay name of a user who will use a call link to initiate a call. | \n
\n\n| showIdentity | \nBoolean | \nShow identity or displayName on before a call. | \n
\n\n| destination | \nObject | \nRequired. Description of who or what is going to receive a call. | \n
\n\n| destination.type | \nString | \nOne of: WEBRTC, CONVERSATIONS, ROOM, PHONE, VIBER, APPLICATION. | \n
\n\n| customData | \nObject | \nCustom attributes sent in a call once it is started. | \n
\n\n| validityWindow | \nObject | \nDescription of a call link validation period and the number of times it can be used within the range. | \n
\n\n| validityWindow.oneTime | \nBoolean | \nBy default, call links are generated for multiple calls.If you want to limit the period for how long a link is valid, specify the start and end time. If you want to invalidate a link after establishing a call, set this value to 'true' (defaults to 'false').For ROOM calls, this value cannot be 'true'. | \n
\n\n| validityWindow.startTime | \nString | \nSpecify starting moment in the UTC timezone for when a call link becomes valid. Defaults to the time when a link was created. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ. | \n
\n\n| validityWindow.endTime | \nString | \nSpecify ending moment in the UTC timezone for when a call link becomes invalid. Default value is 24 hours after a link was created. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ. | \n
\n\n| validityWindow.acceptableHours | \nObject | \nSpecify time range within a day when a link can be used. It is 00:00 - 23:59, by default. UTC timezone is used. | \n
\n\n| validityWindow.acceptableHours.start | \nObject | \n | \n
\n\n| validityWindow.acceptableHours.start.hour | \nInt | \n | \n
\n\n| validityWindow.acceptableHours.start.minute | \nInt | \n | \n
\n\n| validityWindow.acceptableHours.end | \nObject | \n | \n
\n\n| validityWindow.acceptableHours.end.hour | \nInt | \n | \n
\n\n| validityWindow.acceptableHours.end.minute | \nInt | \n | \n
\n\n| validityWindow.acceptableDays | \nArray | \nSpecify the days a link can be used. It is every day of the week, by default. | \n
\n\n| callLinkConfigId | \nString | \nID of a configuration to use on an existing call link. If this parameter is not sent, and there are some call link configurations, the default one will be used. If there is no configurations, then the one with the system default values will be used. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["call-link","1","links","{{callLinkId}}"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"5e579bb9-bac7-48a3-b98d-46682f72e8b0","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/links/{{callLinkId}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"6ad1b9f4-ecad-4775-ac53-babf6ba29e4f","name":"400 - Error responses","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/links/{{callLinkId}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Bad request\",\n \"validationErrors\": {\n \"field\": [\n \"field must not be null.\"\n ]\n }\n }\n }\n}"},{"id":"042bee4d-6814-48de-937b-699130649732","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/links/{{callLinkId}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"bbb26ff4-8d8e-4dde-8e04-9d17816ebb54","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/links/{{callLinkId}}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"5204e0e7-6610-4eda-a6e5-ac1da4c0de92","name":"404 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/links/{{callLinkId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"NOT_FOUND\",\n \"text\": \"Not found\"\n }\n }\n}"},{"id":"85fffe9b-ffaf-45b2-8f61-61da9dddf642","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/links/{{callLinkId}}"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"649c3787-5921-42a7-a16e-57fdd74e3815","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/links/{{callLinkId}}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"25b100b3-041c-4ac1-ba7d-9795ad27759f"},{"name":"Delete call link","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","if (!(pm.environment.get(\"callLinkId\") || \"\")) { skip(\"callLinkId is not set (an earlier request did not create it)\"); }"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});"],"type":"text/javascript","packages":{}}}],"id":"804a5ba8-4ed2-43eb-b04a-89313c2a33e8","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/links/{{callLinkId}}","description":"Delete call link.
\nUse this method to delete a call link by its ID.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nString | \nRequired. ID of a call link to delete. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nString | \nIdentifier of the created call link. To open a call link, it should be concatenated to the URL: https://call-link.com/. | \n
\n\n| url | \nString | \nA URL to initiate a call. | \n
\n\n| identity | \nString | \nRequired. Identity of a user who will use a call link. | \n
\n\n| displayName | \nString | \nDisplay name of a user who will use a call link to initiate a call. | \n
\n\n| showIdentity | \nBoolean | \nShow identity or displayName on before a call. | \n
\n\n| destination | \nObject | \nRequired. Description of who or what is going to receive a call. | \n
\n\n| destination.type | \nString | \nOne of: WEBRTC, CONVERSATIONS, ROOM, PHONE, VIBER, APPLICATION. | \n
\n\n| customData | \nObject | \nCustom attributes sent in a call once it is started. | \n
\n\n| validityWindow | \nObject | \nDescription of a call link validation period and the number of times it can be used within the range. | \n
\n\n| validityWindow.oneTime | \nBoolean | \nBy default, call links are generated for multiple calls.If you want to limit the period for how long a link is valid, specify the start and end time. If you want to invalidate a link after establishing a call, set this value to 'true' (defaults to 'false').For ROOM calls, this value cannot be 'true'. | \n
\n\n| validityWindow.startTime | \nString | \nSpecify starting moment in the UTC timezone for when a call link becomes valid. Defaults to the time when a link was created. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ. | \n
\n\n| validityWindow.endTime | \nString | \nSpecify ending moment in the UTC timezone for when a call link becomes invalid. Default value is 24 hours after a link was created. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ. | \n
\n\n| validityWindow.acceptableHours | \nObject | \nSpecify time range within a day when a link can be used. It is 00:00 - 23:59, by default. UTC timezone is used. | \n
\n\n| validityWindow.acceptableHours.start | \nObject | \n | \n
\n\n| validityWindow.acceptableHours.start.hour | \nInt | \n | \n
\n\n| validityWindow.acceptableHours.start.minute | \nInt | \n | \n
\n\n| validityWindow.acceptableHours.end | \nObject | \n | \n
\n\n| validityWindow.acceptableHours.end.hour | \nInt | \n | \n
\n\n| validityWindow.acceptableHours.end.minute | \nInt | \n | \n
\n\n| validityWindow.acceptableDays | \nArray | \nSpecify the days a link can be used. It is every day of the week, by default. | \n
\n\n| callLinkConfigId | \nString | \nID of a configuration to use on an existing call link. If this parameter is not sent, and there are some call link configurations, the default one will be used. If there is no configurations, then the one with the system default values will be used. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["call-link","1","links","{{callLinkId}}"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"1e87247d-4454-4912-900d-c8f3af391811","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/links/{{callLinkId}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"269567a7-b9de-4bad-8555-dea2b6a5690b","name":"401 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/links/{{callLinkId}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"8e80f9dc-e139-4175-b0fc-cdc89ee9b672","name":"403 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/links/{{callLinkId}}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"11a734cd-33bb-4b1f-912c-eb29f93d5ded","name":"404 - Error responses","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/links/{{callLinkId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"NOT_FOUND\",\n \"text\": \"Not found.\"\n }\n }\n}"},{"id":"6f08108d-8f8c-4861-9a4b-a6d1b276b039","name":"429 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/links/{{callLinkId}}"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"91b233b6-643b-43b2-beda-ba2bc942f486","name":"500 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/links/{{callLinkId}}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"804a5ba8-4ed2-43eb-b04a-89313c2a33e8"},{"name":"Delete call link configuration","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","if (!(pm.environment.get(\"callLinkConfigId\") || \"\")) { skip(\"callLinkConfigId is not set (an earlier request did not create it)\"); }"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"id\", \"name\", \"isDefault\", \"initialOptions\", \"callOptions\", \"theme\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});"],"type":"text/javascript","packages":{}}}],"id":"16e029e5-fa60-483b-b751-88b21f09d509","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}","description":"Delete configuration.
\nUse this method to delete a call link configuration by its ID.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nString | \nRequired. ID of a call link configuration to delete. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nString | \nConfiguration ID. Once a call link is created, this value might be sent in the request as one specific call link configuration to be used by the call link. | \n
\n\n| name | \nString | \nConfiguration name or description. It doesn't have to be unique. | \n
\n\n| isDefault | \nBoolean | \nWhen you create call link without callLinkConfigId, the one marked as default will be used. Only one configuration can be default.If you don't have a configuration, the basic VHD theme with default values and minimal options will be used.If you want to set another configuration as default, specify its value when adding or updating it. | \n
\n\n| initialOptions | \nObject | \nUser options available when a user opens a call link page before initiating the call. Depending on the fields, certain options for the call will be shown to a user. | \n
\n\n| initialOptions.audio | \nBoolean | \nUser will be able to initiate the audio call. | \n
\n\n| initialOptions.video | \nBoolean | \nUser will be able to initiate the video call. | \n
\n\n| initialOptions.muted | \nBoolean | \nUser will be muted once the call is established. | \n
\n\n| initialOptions.settings | \nBoolean | \nUser will be able to configure settings before a call. | \n
\n\n| initialOptions.cameraFacingMode | \nString | \nIn the case of a video call on mobile phones camera will be back or front depending on this value. It is 'FRONT' by default. One of: FRONT, BACK. | \n
\n\n| callOptions | \nObject | \nUser options available during a call. Depending on the fields, certain options for a call will be shown to a user. | \n
\n\n| callOptions.mute | \nBoolean | \nUser will be able to mute themselves during the call. | \n
\n\n| callOptions.screenShare | \nBoolean | \nUser will be able to share the screen during the call. | \n
\n\n| callOptions.camera | \nBoolean | \nUser will be able to toggle the video during the call. | \n
\n\n| callOptions.switchCameraFacingMode | \nBoolean | \nUser will be able to switch between front-facing and back camera during the call. | \n
\n\n| callOptions.dialPad | \nBoolean | \nUser will be able to use dial pad for DTMF, during the call. | \n
\n\n| callOptions.chat | \nBoolean | \nUsers will be able to open the chat box and send and receive text messages that are visible to all the participants. This is applicable only for the ROOM call type. Messages sent before joining the room are not visible. | \n
\n\n| callOptions.settings | \nBoolean | \nUser will be able to access settings during the call. | \n
\n\n| callOptions.recordingIndicator | \nBoolean | \nUser will be able to see if the call is being recorded. | \n
\n\n| theme | \nObject | \nCall link theme-specific configuration settings. Use it to add image, color, and text selections to customize a call link page. | \n
\n\n| theme.images | \nObject | \nEnumerate images shown on a call link page. Once an image is uploaded (by using the image upload API) a unique ID returned in that response can be used to add a background image or a logo image. | \n
\n\n| theme.images.logoImageId | \nString | \nID of an image shown as a logo on a call link page. | \n
\n\n| theme.images.backgroundImageId | \nString | \nID of an image shown as a background on a call link page. | \n
\n\n| theme.messages | \nObject | \nCall link messaging settings. | \n
\n\n| theme.messages.welcomeText | \nString | \nMessage shown when a call link is opened. | \n
\n\n| theme.messages.inactiveText | \nString | \nMessage shown when a call link is not active. | \n
\n\n| theme.messages.expirationText | \nString | \nMessage shown when a call link is expired. | \n
\n\n| theme.colors | \nObject | \nColors settings. If not specified, the default colors will be used. | \n
\n\n| theme.colors.primary | \nString | \nPrimary color of a theme in the hexadecimal format. | \n
\n\n| theme.colors.primaryText | \nString | \nPrimary color of a text in the hexadecimal format. | \n
\n\n| theme.colors.background | \nString | \nBackground color in the hexadecimal format. | \n
\n\n| theme.layouts | \nArray | \nRepresents layout during the call.When GRID layout is selected, multiple video streams are displayed simultaneously and user can spotlight specific video stream.When SOLO layout is selected, an user can see only his video streams.If there are more than one layout in this list, the first one will be initially selected, and users can change it during the call.The default layout will be set to GRID. | \n
\n\n| theme.localization | \nObject | \nIf the localization object is not defined, English will be used. If the localization type is set to PRESET, the language code is mandatory to be defined to one of the predefined values.If the localization type is set to BROWSER_DETECTED and the browser language is one of the languages that could be set in PRESET type, then that language will be used. Otherwise, English will be used. | \n
\n\n| theme.localization.type | \nString | \nOne of: BROWSER_DETECTED, PRESET. | \n
\n\n| subdomainId | \nString | \nId of the subdomain that will be set on every call link generated with this configuration. If undefined, call links will be generated without a subdomain. | \n
\n\n| webhook | \nObject | \nWebhook triggered when there is a call event. | \n
\n\n| webhook.url | \nString | \nRequired. Your webhook URL. | \n
\n\n| webhook.securityConfig | \nObject | \nSecurity settings object holding the authentication settings necessary to access your webhook. | \n
\n\n| webhook.securityConfig.type | \nString | \nOne of: BASIC, HMAC. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["call-link","1","configs","{{callLinkConfigId}}"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"6a33a4a3-d06d-468c-a77a-7b4b1e02238b","name":"200 - Call Link Config Response","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"638dbdc6ecede164c3799d04\",\n \"name\": \"Company name\",\n \"isDefault\": true,\n \"initialOptions\": {\n \"audio\": true,\n \"video\": false,\n \"muted\": false,\n \"cameraFacingMode\": \"FRONT\"\n },\n \"callOptions\": {\n \"mute\": true,\n \"screenShare\": true,\n \"switchCameraFacingMode\": true,\n \"dialPad\": true\n },\n \"theme\": {\n \"images\": {\n \"logoImageId\": \"638dbe28ecede164c3799d06\",\n \"backgroundImageId\": \"638dbe0cecede164c3799d05\"\n },\n \"messages\": {\n \"welcomeText\": \"Call link page\",\n \"inactiveText\": \"This link is no longer active.\",\n \"expirationText\": \"This link has expired\"\n },\n \"colors\": {\n \"primary\": \"D8D8D8\",\n \"primaryText\": \"242424\",\n \"background\": \"FFFFFF\"\n }\n }\n}"},{"id":"7fbaf220-b395-4ee7-8f81-f34f3292df6e","name":"401 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"715a9b80-288d-4907-a484-4bdb0b849290","name":"403 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"dfb50d94-11c3-475b-87cb-2932b9598efe","name":"404 - Error responses","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"NOT_FOUND\",\n \"text\": \"Not found.\"\n }\n }\n}"},{"id":"090e5f76-8cb1-4079-952c-ed4cfb24f64f","name":"429 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"32870c0f-ce14-4f40-81fd-d05cada74d45","name":"500 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/configs/{{callLinkConfigId}}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"16e029e5-fa60-483b-b751-88b21f09d509"},{"name":"Get call link images","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"results\", \"paging\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});","","pm.test(\"'results' is an array\", function () {"," pm.expect(responseBody[\"results\"]).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"62513967-518c-4fab-8ef0-685f4afaa288","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/images","description":"Get images.
\nUse this method to retrieve all images.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| page | \nInt | \nResults page to retrieve (0..N). Default: 0. | \n
\n\n| size | \nInt | \nNumber of records per page. Default: 20. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \nArray | \nThe list of the results for this page. | \n
\n\n| results[].id | \nString | \nUnique ID of an image. | \n
\n\n| results[].name | \nString | \nImage name. | \n
\n\n| results[].type | \nString | \nImage type. One of: LOGO, BACKGROUND. | \n
\n\n| results[].size | \nInt | \nImage size in bytes. | \n
\n\n| paging | \nObject | \nContains information about the page. | \n
\n\n| paging.page | \nInt | \nRequired. Requested page number. | \n
\n\n| paging.size | \nInt | \nRequired. Requested page size. | \n
\n\n| paging.totalPages | \nInt | \nRequired. The total number of pages of the results matching the requested parameters. | \n
\n\n| paging.totalResults | \nInt | \nRequired. The total number of the results matching the requested parameters. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["call-link","1","images"],"host":["go2","vhdmedia","se"],"query":[{"disabled":true,"description":{"content":"Results page to retrieve (0..N). Default: 0.
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Number of records per page. Default: 20.
\n","type":"text/plain"},"key":"size","value":""}],"variable":[]}},"response":[{"id":"db0c3370-e4d0-4876-89a4-4d745cd4642e","name":"200 - Image Page Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/images","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","images"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"id\": \"638f29f0ee8f0c1da369a722\",\n \"name\": \"logo.png\",\n \"type\": \"LOGO\",\n \"size\": 512\n },\n {\n \"id\": \"968f29f0ee8f0c1da369a545\",\n \"name\": \"background.jpg\",\n \"type\": \"BACKGROUND\",\n \"size\": 1512\n }\n ],\n \"paging\": {\n \"page\": 0,\n \"size\": 10,\n \"totalPages\": 1,\n \"totalResults\": 2\n }\n}"},{"id":"33ef6d8e-65c2-450f-8c51-183872683868","name":"400 - Error responses","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/images","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","images"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Bad request\",\n \"validationErrors\": {\n \"field\": [\n \"field must not be null.\"\n ]\n }\n }\n }\n}"},{"id":"2057ccef-1977-45c4-a2c6-feca8ce364ab","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/images","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","images"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"caad3c0a-c44b-420b-9cc4-5ff444dfa521","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/images","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","images"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"70f46d6e-a0ef-434d-b50a-7338b7a96853","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/images","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","images"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"c0eaa256-5fad-4e18-9c35-7f129bb32a95","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/images","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","images"],"query":[{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"62513967-518c-4fab-8ef0-685f4afaa288"},{"name":"Get call link subdomains","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});"],"type":"text/javascript","packages":{}}}],"id":"cd29f6ed-97b4-4ed6-a660-a057ff5d4389","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/subdomains","description":"Get subdomains.
\nUse this method to get all subdomains.
\n\nOn success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| [].id | \nString | \n | \n
\n\n| [].name | \nString | \n | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["call-link","1","subdomains"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"c695d394-ba3b-418c-9995-a0a7a93119a4","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/subdomains"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"12667b6b-c230-4d97-8638-8bbf083210d2","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/subdomains"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"c721c028-6818-4112-95d4-703f2481b326","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/subdomains"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"479b440d-8c09-40bb-9c97-0392980fe680","name":"404 - Error responses","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/subdomains"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"NOT_FOUND\",\n \"text\": \"Not found.\"\n }\n }\n}"},{"id":"1bdf8829-de9b-449e-b5c5-d3a7a0a8ecd8","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/subdomains"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"631444cb-ac2b-4192-b50e-b74bca8094ad","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/subdomains"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"cd29f6ed-97b4-4ed6-a660-a057ff5d4389"},{"name":"Get call link recordings","event":[{"listen":"test","script":{"exec":["// Tests for Get call link recordings.","pm.test(\"Status code is 200\", function () { pm.expect(pm.response.code).to.eql(200); });","pm.test(\"Response time is below 5000ms\", function () { pm.expect(pm.response.responseTime).to.be.below(5000); });","pm.test(\"Recordings are returned as a page of results\", function () {"," var j = pm.response.json();"," pm.expect(j.results).to.be.an(\"array\");"," pm.expect(j.paging).to.include.all.keys(\"page\", \"size\", \"totalPages\", \"totalResults\");","});"],"type":"text/javascript","packages":{}}}],"id":"2f635268-ce48-4814-b86d-6ecee24e3b05","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/call-link/1/recordings","description":"Get call link recordings.
\nUse this method to filter and retrieve call link recordings.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| sortBy | \nString | \nField that will be used for sorting. One of: DESTINATION_DATA, DESTINATION_TYPE, CALL_LINK_CONFIG_ID, CALL_LINK_ID, START_TIME_BEFORE, START_TIME_AFTER. | \n
\n\n| sortDirection | \nString | \nOrder in which files will be sorted based on sortBy field. One of: ASC, DESC. | \n
\n\n| destinationData | \nString | \nDestination the call was made towards. For WEBRTC calls, this is the WebRTC identity. For PHONE calls, this is the phone number. For ROOM calls, this is the room name. | \n
\n\n| destinationType | \nString | \nType of call link destination. One of: ROOM, WEBRTC, PHONE. | \n
\n\n| callLinkConfigId | \nString | \nID of the call link configuration used to establish the recorded call. | \n
\n\n| callLinkId | \nString | \nID of a call link used to establish the recorded call. | \n
\n\n| startTimeAfter | \nString | \nDate and time when the (first) call recording started. | \n
\n\n| startTimeBefore | \nString | \nDate and time when the (last) call recording started. | \n
\n\n| location | \nString | \nRecording location. One of: SAO_PAULO, BOGOTA, FRANKFURT, JOHANNESBURG, JOHANNESBURG_1, NEW_YORK, PORTLAND, MOSCOW, SINGAPORE, ISTANBUL, KUALA_LUMPUR, JAKARTA, MUMBAI, HONG_KONG_1, HONG_KONG, RIYADH, CHENNAI. | \n
\n\n| page | \nInt | \nPage number for pagination, starting from 0. Default: 0. | \n
\n\n| size | \nInt | \nNumber of items per page, maximum is 100. Default: 10. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \nArray | \nThe list of the results for this page. | \n
\n\n| results[].application | \nObject | \nRequired. Recording application metadata | \n
\n\n| results[].application.type | \nString | \nRequired. One of: CALL_LINK. | \n
\n\n| results[].recording | \nObject | \nRequired. Recording metadata. | \n
\n\n| results[].recording.composedFiles | \nArray | \nList of composed files. | \n
\n\n| results[].recording.composedFiles[].id | \nString | \nFile identifier. | \n
\n\n| results[].recording.composedFiles[].name | \nString | \nFile name. | \n
\n\n| results[].recording.composedFiles[].fileFormat | \nString | \nFile format. One of: MP3, WAV, MP4. | \n
\n\n| results[].recording.composedFiles[].size | \nInt | \nFile size in bytes. | \n
\n\n| results[].recording.composedFiles[].startTime | \nString | \nDate and time in the UTC timezone when the recording started. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ. | \n
\n\n| results[].recording.composedFiles[].endTime | \nString | \nDate and time in the UTC timezone when the recording ended. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ. | \n
\n\n| results[].recording.composedFiles[].creationTime | \nString | \nDate and time in the UTC timezone when the recording file was created. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ. | \n
\n\n| results[].recording.composedFiles[].duration | \nInt | \nFile duration in seconds. | \n
\n\n| results[].recording.composedFiles[].location | \nString | \nLocation of recording file after processing. One of: UPLOADING, UPLOADED, HOSTED. | \n
\n\n| results[].recording.composedFiles[].customData | \nObject | \nClient-defined data. | \n
\n\n| results[].recording.callRecordings | \nArray | \nList of call recordings. | \n
\n\n| results[].recording.callRecordings[].callId | \nString | \nCall identifier. | \n
\n\n| results[].recording.callRecordings[].endpoint | \nString | \nCall endpoint. Represents a caller for the inbound calls and a callee for the outbound calls. | \n
\n\n| results[].recording.callRecordings[].direction | \nString | \nCall direction. One of: INBOUND, OUTBOUND. | \n
\n\n| results[].recording.callRecordings[].status | \nString | \nStatus of call recording. One of: SUCCESSFUL, PARTIALLY_FAILED, FAILED. | \n
\n\n| results[].recording.callRecordings[].reason | \nString | \nReason for recording failure. Empty if call did not fail. | \n
\n\n| results[].recording.callRecordings[].files | \nArray | \nRecording files. | \n
\n\n| results[].recording.callRecordings[].files[].id | \nString | \nFile identifier. | \n
\n\n| results[].recording.callRecordings[].files[].name | \nString | \nFile name. | \n
\n\n| results[].recording.callRecordings[].files[].fileFormat | \nString | \nFile format. One of: MP3, WAV, MP4. | \n
\n\n| results[].recording.callRecordings[].files[].size | \nInt | \nFile size in bytes. | \n
\n\n| results[].recording.callRecordings[].files[].startTime | \nString | \nDate and time in the UTC timezone when the recording started. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ. | \n
\n\n| results[].recording.callRecordings[].files[].endTime | \nString | \nDate and time in the UTC timezone when the recording ended. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ. | \n
\n\n| results[].recording.callRecordings[].files[].creationTime | \nString | \nDate and time in the UTC timezone when the recording file was created. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ. | \n
\n\n| results[].recording.callRecordings[].files[].duration | \nInt | \nFile duration in seconds. | \n
\n\n| results[].recording.callRecordings[].files[].location | \nString | \nLocation of recording file after processing. One of: UPLOADING, UPLOADED, HOSTED. | \n
\n\n| results[].recording.callRecordings[].files[].customData | \nObject | \nClient-defined data. | \n
\n\n| paging | \nObject | \nContains information about the page. | \n
\n\n| paging.page | \nInt | \nRequired. Requested page number. | \n
\n\n| paging.size | \nInt | \nRequired. Requested page size. | \n
\n\n| paging.totalPages | \nInt | \nRequired. The total number of pages of the results matching the requested parameters. | \n
\n\n| paging.totalResults | \nInt | \nRequired. The total number of the results matching the requested parameters. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["call-link","1","recordings"],"host":["go2","vhdmedia","se"],"query":[{"disabled":true,"description":{"content":"Field that will be used for sorting.
\n","type":"text/plain"},"key":"sortBy","value":""},{"disabled":true,"description":{"content":"Order in which files will be sorted based on sortBy field.
\n","type":"text/plain"},"key":"sortDirection","value":""},{"disabled":true,"description":{"content":"Destination the call was made towards. For WEBRTC calls, this is the WebRTC identity. For PHONE calls, this is the phone number. For ROOM calls, this is the room name.
\n","type":"text/plain"},"key":"destinationData","value":""},{"disabled":true,"description":{"content":"Type of call link destination.
\n","type":"text/plain"},"key":"destinationType","value":""},{"disabled":true,"description":{"content":"ID of the call link configuration used to establish the recorded call.
\n","type":"text/plain"},"key":"callLinkConfigId","value":"{{callLinkConfigId}}"},{"disabled":true,"description":{"content":"ID of a call link used to establish the recorded call.
\n","type":"text/plain"},"key":"callLinkId","value":""},{"disabled":true,"description":{"content":"Date and time when the (first) call recording started.
\n","type":"text/plain"},"key":"startTimeAfter","value":""},{"disabled":true,"description":{"content":"Date and time when the (last) call recording started.
\n","type":"text/plain"},"key":"startTimeBefore","value":""},{"disabled":true,"description":{"content":"Recording location.
\n","type":"text/plain"},"key":"location","value":""},{"disabled":true,"description":{"content":"Page number for pagination, starting from 0. Default: 0.
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Number of items per page, maximum is 100. Default: 10.
\n","type":"text/plain"},"key":"size","value":""}],"variable":[]}},"response":[{"id":"0f1b3e29-3c3e-4c5c-adce-1063915cea94","name":"200 - Recording Page","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/recordings","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","recordings"],"query":[{"key":"sortBy","value":"","description":"Field that will be used for sorting.","disabled":true},{"key":"sortDirection","value":"","description":"Order in which files will be sorted based on sortBy field.","disabled":true},{"key":"destinationData","value":"","description":"Destination the call was made towards. For WEBRTC calls, this is the WebRTC identity. For PHONE calls, this is the phone number. For ROOM calls, this is the room name.","disabled":true},{"key":"destinationType","value":"","description":"Type of call link destination.","disabled":true},{"key":"callLinkConfigId","value":"{{callLinkConfigId}}","description":"ID of the call link configuration used to establish the recorded call.","disabled":true},{"key":"callLinkId","value":"","description":"ID of a call link used to establish the recorded call.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time when the (first) call recording started.","disabled":true},{"key":"startTimeBefore","value":"","description":"Date and time when the (last) call recording started.","disabled":true},{"key":"location","value":"","description":"Recording location.","disabled":true},{"key":"page","value":"","description":"Page number for pagination, starting from 0. Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of items per page, maximum is 100. Default: `10`.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"application\": {\n \"id\": \"2e75743a-7626-425c-879c-19e7f6111359\",\n \"callLinkId\": \"34QubX\",\n \"callLinkConfigId\": \"63f742074d09a250fdc74025\",\n \"destinationType\": \"PHONE\",\n \"destinationData\": \"+1234567890\",\n \"type\": \"CALL_LINK\"\n },\n \"recording\": {\n \"composedFiles\": [\n {\n \"id\": \"d8d84155-3831-43fb-91c9-bb897149a79d\",\n \"name\": \"d8d84155-3831-43fb-91c9-bb897149a79d_1652725357412.wav\",\n \"fileFormat\": \"WAV\",\n \"size\": 67564,\n \"startTime\": \"2024-05-01T14:25:45.125+0000\",\n \"endTime\": \"2024-05-01T14:26:45.125+0000\",\n \"creationTime\": \"2024-05-01T14:26:48.125+0000\",\n \"duration\": 60,\n \"location\": \"HOSTED\",\n \"customData\": {\n \"key1\": \"value1\"\n }\n }\n ],\n \"callRecordings\": [\n {\n \"callId\": \"d8d84155-3831-43fb-91c9-bb897149a79d\",\n \"endpoint\": {\n \"identity\": \"phoneCaller\",\n \"displayName\": null,\n \"type\": \"WEBRTC\"\n },\n \"direction\": \"INBOUND\",\n \"status\": \"SUCCESSFUL\",\n \"files\": [\n {\n \"id\": \"564202f9-4788-4766-866c-6a58f4058dac\",\n \"name\": \"564202f9-4788-4766-866c-6a58f4058dac.wav\",\n \"fileFormat\": \"WAV\",\n \"size\": 123456,\n \"startTime\": \"2024-05-01T14:25:45.125+0000\",\n \"endTime\": \"2024-05-01T14:26:45.125+0000\",\n \"creationTime\": \"2024-05-01T14:26:48.125+0000\",\n \"duration\": 60,\n \"location\": \"HOSTED\",\n \"customData\": {\n \"key1\": \"value1\"\n }\n }\n ]\n },\n {\n \"callId\": \"9b793eeb-31e7-4a39-bf24-a267777b0313\",\n \"endpoint\": {\n \"phoneNumber\": \"32475388773\",\n \"type\": \"PHONE\"\n },\n \"direction\": \"OUTBOUND\",\n \"status\": \"SUCCESSFUL\",\n \"files\": [\n {\n \"id\": \"c8f2817c-e2cd-47f1-ac40-2558d74c5c7b\",\n \"name\": \"c8f2817c-e2cd-47f1-ac40-2558d74c5c7b.wav\",\n \"fileFormat\": \"WAV\",\n \"size\": 123456,\n \"startTime\": \"2024-05-01T14:25:45.125+0000\",\n \"endTime\": \"2024-05-01T14:26:45.125+0000\",\n \"creationTime\": \"2024-05-01T14:26:48.125+0000\",\n \"duration\": 60,\n \"location\": \"HOSTED\",\n \"customData\": {\n \"key1\": \"value1\"\n }\n }\n ]\n }\n ]\n }\n }\n]"},{"id":"1737d241-9757-4ff1-8c28-f545f035d69b","name":"400 - Error responses","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/recordings","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","recordings"],"query":[{"key":"sortBy","value":"","description":"Field that will be used for sorting.","disabled":true},{"key":"sortDirection","value":"","description":"Order in which files will be sorted based on sortBy field.","disabled":true},{"key":"destinationData","value":"","description":"Destination the call was made towards. For WEBRTC calls, this is the WebRTC identity. For PHONE calls, this is the phone number. For ROOM calls, this is the room name.","disabled":true},{"key":"destinationType","value":"","description":"Type of call link destination.","disabled":true},{"key":"callLinkConfigId","value":"{{callLinkConfigId}}","description":"ID of the call link configuration used to establish the recorded call.","disabled":true},{"key":"callLinkId","value":"","description":"ID of a call link used to establish the recorded call.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time when the (first) call recording started.","disabled":true},{"key":"startTimeBefore","value":"","description":"Date and time when the (last) call recording started.","disabled":true},{"key":"location","value":"","description":"Recording location.","disabled":true},{"key":"page","value":"","description":"Page number for pagination, starting from 0. Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of items per page, maximum is 100. Default: `10`.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Bad request\",\n \"validationErrors\": {\n \"field\": [\n \"field must not be null.\"\n ]\n }\n }\n }\n}"},{"id":"722a7c62-c1c7-4f75-bfd1-a4a4462b6826","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/recordings","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","recordings"],"query":[{"key":"sortBy","value":"","description":"Field that will be used for sorting.","disabled":true},{"key":"sortDirection","value":"","description":"Order in which files will be sorted based on sortBy field.","disabled":true},{"key":"destinationData","value":"","description":"Destination the call was made towards. For WEBRTC calls, this is the WebRTC identity. For PHONE calls, this is the phone number. For ROOM calls, this is the room name.","disabled":true},{"key":"destinationType","value":"","description":"Type of call link destination.","disabled":true},{"key":"callLinkConfigId","value":"{{callLinkConfigId}}","description":"ID of the call link configuration used to establish the recorded call.","disabled":true},{"key":"callLinkId","value":"","description":"ID of a call link used to establish the recorded call.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time when the (first) call recording started.","disabled":true},{"key":"startTimeBefore","value":"","description":"Date and time when the (last) call recording started.","disabled":true},{"key":"location","value":"","description":"Recording location.","disabled":true},{"key":"page","value":"","description":"Page number for pagination, starting from 0. Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of items per page, maximum is 100. Default: `10`.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"5ed97093-e465-4b85-b047-70b934bf7b6d","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/recordings","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","recordings"],"query":[{"key":"sortBy","value":"","description":"Field that will be used for sorting.","disabled":true},{"key":"sortDirection","value":"","description":"Order in which files will be sorted based on sortBy field.","disabled":true},{"key":"destinationData","value":"","description":"Destination the call was made towards. For WEBRTC calls, this is the WebRTC identity. For PHONE calls, this is the phone number. For ROOM calls, this is the room name.","disabled":true},{"key":"destinationType","value":"","description":"Type of call link destination.","disabled":true},{"key":"callLinkConfigId","value":"{{callLinkConfigId}}","description":"ID of the call link configuration used to establish the recorded call.","disabled":true},{"key":"callLinkId","value":"","description":"ID of a call link used to establish the recorded call.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time when the (first) call recording started.","disabled":true},{"key":"startTimeBefore","value":"","description":"Date and time when the (last) call recording started.","disabled":true},{"key":"location","value":"","description":"Recording location.","disabled":true},{"key":"page","value":"","description":"Page number for pagination, starting from 0. Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of items per page, maximum is 100. Default: `10`.","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"10ef481f-565a-4635-8eb3-9deab4f8f92b","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/recordings","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","recordings"],"query":[{"key":"sortBy","value":"","description":"Field that will be used for sorting.","disabled":true},{"key":"sortDirection","value":"","description":"Order in which files will be sorted based on sortBy field.","disabled":true},{"key":"destinationData","value":"","description":"Destination the call was made towards. For WEBRTC calls, this is the WebRTC identity. For PHONE calls, this is the phone number. For ROOM calls, this is the room name.","disabled":true},{"key":"destinationType","value":"","description":"Type of call link destination.","disabled":true},{"key":"callLinkConfigId","value":"{{callLinkConfigId}}","description":"ID of the call link configuration used to establish the recorded call.","disabled":true},{"key":"callLinkId","value":"","description":"ID of a call link used to establish the recorded call.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time when the (first) call recording started.","disabled":true},{"key":"startTimeBefore","value":"","description":"Date and time when the (last) call recording started.","disabled":true},{"key":"location","value":"","description":"Recording location.","disabled":true},{"key":"page","value":"","description":"Page number for pagination, starting from 0. Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of items per page, maximum is 100. Default: `10`.","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"db9d5f09-5510-4fc2-a7e5-ddee8e1ac750","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/call-link/1/recordings","protocol":"https","host":["go2","vhdmedia","se"],"path":["call-link","1","recordings"],"query":[{"key":"sortBy","value":"","description":"Field that will be used for sorting.","disabled":true},{"key":"sortDirection","value":"","description":"Order in which files will be sorted based on sortBy field.","disabled":true},{"key":"destinationData","value":"","description":"Destination the call was made towards. For WEBRTC calls, this is the WebRTC identity. For PHONE calls, this is the phone number. For ROOM calls, this is the room name.","disabled":true},{"key":"destinationType","value":"","description":"Type of call link destination.","disabled":true},{"key":"callLinkConfigId","value":"{{callLinkConfigId}}","description":"ID of the call link configuration used to establish the recorded call.","disabled":true},{"key":"callLinkId","value":"","description":"ID of a call link used to establish the recorded call.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time when the (first) call recording started.","disabled":true},{"key":"startTimeBefore","value":"","description":"Date and time when the (last) call recording started.","disabled":true},{"key":"location","value":"","description":"Recording location.","disabled":true},{"key":"page","value":"","description":"Page number for pagination, starting from 0. Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of items per page, maximum is 100. Default: `10`.","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"2f635268-ce48-4814-b86d-6ecee24e3b05"}],"id":"d8ac51a2-4e4f-4102-a860-8e8117408777","description":"A call link is a web address that starts a call when someone opens it. Create a configuration (how the page looks and behaves), then create links that use it. The requests run in order and clean up after themselves.
\n","_postman_id":"d8ac51a2-4e4f-4102-a860-8e8117408777"},{"name":"CALL ROUTING","item":[{"name":"Get call routing recordings","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"results\", \"paging\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});","","pm.test(\"'results' is an array\", function () {"," pm.expect(responseBody[\"results\"]).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"cba4bc7f-deed-4982-b2ec-a88255ae2110","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/callrouting/1/recordings","description":"Get recordings.
\nThis method allows searching and filtering based on various recording data properties.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| sortBy | \nString | \nField that will be used for sorting. One of: ENDPOINT_TYPE, ROUTE_ID, CORRELATION_ID, START_TIME, END_TIME. | \n
\n\n| sortDirection | \nString | \nOrder in which files will be sorted based on sortBy field. One of: ASC, DESC. | \n
\n\n| endpointType | \nString | \nEndpoint type of at least one participant in the recorded call. | \n
\n\n| phoneNumber | \nString | \nPhone number that was participant of the recorded call. | \n
\n\n| sipTrunkId | \nString | \nSIP Trunk ID that was participant of the recorded call. | \n
\n\n| sipUsername | \nString | \nUsername on the SIP trunk that was participant of the recorded call. | \n
\n\n| webrtcIdentity | \nString | \nWebRTC Identity that was participant of the recorded call. | \n
\n\n| routeId | \nString | \nRoute ID that was used to establish the recorded call. | \n
\n\n| routeName | \nString | \nRoute name to be used to match recordings. Name will be matched comparing it to all route names. | \n
\n\n| correlationId | \nString | \nCorrelation ID to match. | \n
\n\n| startTimeAfter | \nString | \nDate and time when the (first) call recording started. | \n
\n\n| startTimeBefore | \nString | \nDate and time when the (last) call recording started. | \n
\n\n| location | \nString | \nRecording location. One of: SAO_PAULO, BOGOTA, FRANKFURT, JOHANNESBURG, JOHANNESBURG_1, NEW_YORK, PORTLAND, MOSCOW, SINGAPORE, ISTANBUL, KUALA_LUMPUR, JAKARTA, MUMBAI, HONG_KONG_1, HONG_KONG, RIYADH, CHENNAI. | \n
\n\n| page | \nInt | \nResults page to retrieve (0..N). Default: 0. | \n
\n\n| size | \nInt | \nNumber of records per page. Default: 20. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \nArray | \nThe list of the results for this page. | \n
\n\n| results[].application | \nObject | \nRequired. Recording application metadata | \n
\n\n| results[].application.type | \nString | \nRequired. One of: CALL_ROUTING. | \n
\n\n| results[].recording | \nObject | \nRequired. Recording metadata | \n
\n\n| results[].recording.composedFiles | \nArray | \nComposed recording files. | \n
\n\n| results[].recording.composedFiles[].id | \nString | \nFile ID. | \n
\n\n| results[].recording.composedFiles[].name | \nString | \nFile name. | \n
\n\n| results[].recording.composedFiles[].fileFormat | \nString | \nFile format. One of: MP3, WAV, MP4. | \n
\n\n| results[].recording.composedFiles[].size | \nInt | \nFile size in bytes. | \n
\n\n| results[].recording.composedFiles[].startTime | \nString | \nDate and time when the recording started. | \n
\n\n| results[].recording.composedFiles[].endTime | \nString | \nDate and time when the recording ended. | \n
\n\n| results[].recording.composedFiles[].creationTime | \nString | \nFile creation time. | \n
\n\n| results[].recording.composedFiles[].duration | \nInt | \nFile duration in seconds. | \n
\n\n| results[].recording.composedFiles[].location | \nString | \nLocation of recording file after processing. One of: UPLOADING, UPLOADED, HOSTED. | \n
\n\n| results[].recording.composedFiles[].customData | \nObject | \nClient-defined data. | \n
\n\n| results[].recording.callRecordings | \nArray | \nCall recording data. | \n
\n\n| results[].recording.callRecordings[].callId | \nString | \nCall identifier. | \n
\n\n| results[].recording.callRecordings[].endpoint | \nString | \nCall endpoint. Represents a caller for the inbound calls and a callee for the outbound calls. | \n
\n\n| results[].recording.callRecordings[].direction | \nString | \nCall direction. One of: INBOUND, OUTBOUND. | \n
\n\n| results[].recording.callRecordings[].status | \nString | \nStatus of call recording. | \n
\n\n| results[].recording.callRecordings[].reason | \nString | \nReason for recording failure. | \n
\n\n| results[].recording.callRecordings[].files | \nArray | \nRecording files. | \n
\n\n| results[].recording.callRecordings[].files[].id | \nString | \nFile ID. | \n
\n\n| results[].recording.callRecordings[].files[].name | \nString | \nFile name. | \n
\n\n| results[].recording.callRecordings[].files[].fileFormat | \nString | \nFile format. One of: MP3, WAV, MP4. | \n
\n\n| results[].recording.callRecordings[].files[].size | \nInt | \nFile size in bytes. | \n
\n\n| results[].recording.callRecordings[].files[].startTime | \nString | \nDate and time when the recording started. | \n
\n\n| results[].recording.callRecordings[].files[].endTime | \nString | \nDate and time when the recording ended. | \n
\n\n| results[].recording.callRecordings[].files[].creationTime | \nString | \nFile creation time. | \n
\n\n| results[].recording.callRecordings[].files[].duration | \nInt | \nFile duration in seconds. | \n
\n\n| results[].recording.callRecordings[].files[].location | \nString | \nLocation of recording file after processing. One of: UPLOADING, UPLOADED, HOSTED. | \n
\n\n| results[].recording.callRecordings[].files[].customData | \nObject | \nClient-defined data. | \n
\n\n| paging | \nObject | \nContains information about the page. | \n
\n\n| paging.page | \nInt | \nRequired. Requested page number. | \n
\n\n| paging.size | \nInt | \nRequired. Requested page size. | \n
\n\n| paging.totalPages | \nInt | \nRequired. The total number of pages of the results matching the requested parameters. | \n
\n\n| paging.totalResults | \nInt | \nRequired. The total number of the results matching the requested parameters. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["callrouting","1","recordings"],"host":["go2","vhdmedia","se"],"query":[{"disabled":true,"description":{"content":"Field that will be used for sorting.
\n","type":"text/plain"},"key":"sortBy","value":""},{"disabled":true,"description":{"content":"Order in which files will be sorted based on sortBy field.
\n","type":"text/plain"},"key":"sortDirection","value":""},{"disabled":true,"description":{"content":"Endpoint type of at least one participant in the recorded call.
\n","type":"text/plain"},"key":"endpointType","value":""},{"disabled":true,"description":{"content":"Phone number that was participant of the recorded call.
\n","type":"text/plain"},"key":"phoneNumber","value":""},{"disabled":true,"description":{"content":"SIP Trunk ID that was participant of the recorded call.
\n","type":"text/plain"},"key":"sipTrunkId","value":""},{"disabled":true,"description":{"content":"Username on the SIP trunk that was participant of the recorded call.
\n","type":"text/plain"},"key":"sipUsername","value":""},{"disabled":true,"description":{"content":"WebRTC Identity that was participant of the recorded call.
\n","type":"text/plain"},"key":"webrtcIdentity","value":""},{"disabled":true,"description":{"content":"Route ID that was used to establish the recorded call.
\n","type":"text/plain"},"key":"routeId","value":""},{"disabled":true,"description":{"content":"Route name to be used to match recordings. Name will be matched comparing it to all route names.
\n","type":"text/plain"},"key":"routeName","value":""},{"disabled":true,"description":{"content":"Correlation ID to match.
\n","type":"text/plain"},"key":"correlationId","value":""},{"disabled":true,"description":{"content":"Date and time when the (first) call recording started.
\n","type":"text/plain"},"key":"startTimeAfter","value":""},{"disabled":true,"description":{"content":"Date and time when the (last) call recording started.
\n","type":"text/plain"},"key":"startTimeBefore","value":""},{"disabled":true,"description":{"content":"Recording location.
\n","type":"text/plain"},"key":"location","value":""},{"disabled":true,"description":{"content":"Results page to retrieve (0..N). Default: 0.
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Number of records per page. Default: 20.
\n","type":"text/plain"},"key":"size","value":""}],"variable":[]}},"response":[{"id":"b5d80c2e-f591-4046-b99e-00041542b178","name":"200 - Successfully fetching results","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/callrouting/1/recordings","protocol":"https","host":["go2","vhdmedia","se"],"path":["callrouting","1","recordings"],"query":[{"key":"sortBy","value":"","description":"Field that will be used for sorting.","disabled":true},{"key":"sortDirection","value":"","description":"Order in which files will be sorted based on sortBy field.","disabled":true},{"key":"endpointType","value":"","description":"Endpoint type of at least one participant in the recorded call.","disabled":true},{"key":"phoneNumber","value":"","description":"Phone number that was participant of the recorded call.","disabled":true},{"key":"sipTrunkId","value":"","description":"SIP Trunk ID that was participant of the recorded call.","disabled":true},{"key":"sipUsername","value":"","description":"Username on the SIP trunk that was participant of the recorded call.","disabled":true},{"key":"webrtcIdentity","value":"","description":"WebRTC Identity that was participant of the recorded call.","disabled":true},{"key":"routeId","value":"","description":"Route ID that was used to establish the recorded call.","disabled":true},{"key":"routeName","value":"","description":"Route name to be used to match recordings. Name will be matched comparing it to all route names.","disabled":true},{"key":"correlationId","value":"","description":"Correlation ID to match.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time when the (first) call recording started.","disabled":true},{"key":"startTimeBefore","value":"","description":"Date and time when the (last) call recording started.","disabled":true},{"key":"location","value":"","description":"Recording location.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"application\": {\n \"routeId\": \"edef623d-0e1a-4a83-91e5-73c75ed31473\",\n \"routeName\": \"Route with disabled recording composition\",\n \"correlationId\": \"8fdbf7d9-9889-4c2e-8f16-246d5fe066de\",\n \"startTime\": \"2025-04-04T09:25:50.060+0000\",\n \"endTime\": \"2025-04-04T09:25:57.780+0000\",\n \"type\": \"CALL_ROUTING\"\n },\n \"recording\": {\n \"composedFiles\": [],\n \"callRecordings\": [\n {\n \"callId\": \"q9lo60o6ihb23q06epc23n46ihd0nilcibb8nihd5jpu6n5d3boqip1e1bqs667ofk00\",\n \"endpoint\": {\n \"phoneNumber\": \"38761111222\",\n \"type\": \"PHONE\"\n },\n \"direction\": \"INBOUND\",\n \"status\": \"SUCCESSFUL\",\n \"files\": [\n {\n \"id\": \"b83f049e-6b2a-4111-bbeb-32426fe0a737\",\n \"name\": \"b83f049e-6b2a-4111-bbeb-32426fe0a737.wav\",\n \"fileFormat\": \"WAV\",\n \"size\": 123392,\n \"startTime\": \"2025-04-04T09:25:50.059+0000\",\n \"endTime\": \"2025-04-04T09:25:57.739+0000\",\n \"creationTime\": \"2025-04-04T09:25:57.829+0000\",\n \"duration\": 7,\n \"location\": \"HOSTED\",\n \"customData\": {\n \"routeId\": \"edef623d-0e1a-4a83-91e5-73c75ed31473\"\n }\n }\n ]\n },\n {\n \"callId\": \"cb64100e-371c-4928-8cbd-1256752e4de4\",\n \"endpoint\": {\n \"phoneNumber\": \"38762222333\",\n \"type\": \"PHONE\"\n },\n \"direction\": \"OUTBOUND\",\n \"status\": \"SUCCESSFUL\",\n \"files\": [\n {\n \"id\": \"d411529b-cc99-4144-8e4d-53214a1f1660\",\n \"name\": \"d411529b-cc99-4144-8e4d-53214a1f1660.wav\",\n \"fileFormat\": \"WAV\",\n \"size\": 123682,\n \"startTime\": \"2025-04-04T09:25:50.079+0000\",\n \"endTime\": \"2025-04-04T09:25:57.779+0000\",\n \"creationTime\": \"2025-04-04T09:25:57.825+0000\",\n \"duration\": 7,\n \"location\": \"HOSTED\",\n \"customData\": {\n \"routeId\": \"edef623d-0e1a-4a83-91e5-73c75ed31473\"\n }\n }\n ]\n }\n ]\n }\n },\n {\n \"application\": {\n \"routeId\": \"3a1fcde8-df41-4209-b9a5-895db5d42e3d\",\n \"routeName\": \"Route with enabled recording composition\",\n \"correlationId\": \"fc840e38-29dc-47d5-9947-17371c939a17\",\n \"startTime\": \"2025-04-04T11:38:01.723+0000\",\n \"endTime\": \"2025-04-04T11:38:12.763+0000\",\n \"type\": \"CALL_ROUTING\"\n },\n \"recording\": {\n \"composedFiles\": [\n {\n \"id\": \"294cdf1b-70ae-4249-b384-6f267b5cf345\",\n \"name\": \"294cdf1b-70ae-4249-b384-6f267b5cf345.wav\",\n \"fileFormat\": \"WAV\",\n \"size\": 177152,\n \"startTime\": \"2025-04-04T11:38:01.724+0000\",\n \"endTime\": \"2025-04-04T11:38:12.764+0000\",\n \"creationTime\": \"2025-04-04T11:38:12.829+0000\",\n \"duration\": 11,\n \"location\": \"HOSTED\",\n \"customData\": {\n \"routeId\": \"3a1fcde8-df41-4209-b9a5-895db5d42e3d\"\n }\n }\n ],\n \"callRecordings\": [\n {\n \"callId\": \"m1to60o6ihb23q06epc23n46ihd0nilcibb8nihd5jpu6n5d3boqip1e1bqs6lfdgk00\",\n \"endpoint\": {\n \"phoneNumber\": \"38761111222\",\n \"type\": \"PHONE\"\n },\n \"direction\": \"INBOUND\",\n \"files\": []\n },\n {\n \"callId\": \"81a815ee-4fc2-45e3-a3eb-50277359a089\",\n \"endpoint\": {\n \"phoneNumber\": \"38761111333\",\n \"type\": \"PHONE\"\n },\n \"direction\": \"OUTBOUND\",\n \"files\": []\n }\n ]\n }\n }\n ],\n \"paging\": {\n \"page\": 0,\n \"size\": 20,\n \"totalPages\": 1,\n \"totalResults\": 2\n }\n}"},{"id":"bae8c02c-a637-4ace-adec-bc898b77fdcd","name":"400 - Error responses","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/callrouting/1/recordings","protocol":"https","host":["go2","vhdmedia","se"],"path":["callrouting","1","recordings"],"query":[{"key":"sortBy","value":"","description":"Field that will be used for sorting.","disabled":true},{"key":"sortDirection","value":"","description":"Order in which files will be sorted based on sortBy field.","disabled":true},{"key":"endpointType","value":"","description":"Endpoint type of at least one participant in the recorded call.","disabled":true},{"key":"phoneNumber","value":"","description":"Phone number that was participant of the recorded call.","disabled":true},{"key":"sipTrunkId","value":"","description":"SIP Trunk ID that was participant of the recorded call.","disabled":true},{"key":"sipUsername","value":"","description":"Username on the SIP trunk that was participant of the recorded call.","disabled":true},{"key":"webrtcIdentity","value":"","description":"WebRTC Identity that was participant of the recorded call.","disabled":true},{"key":"routeId","value":"","description":"Route ID that was used to establish the recorded call.","disabled":true},{"key":"routeName","value":"","description":"Route name to be used to match recordings. Name will be matched comparing it to all route names.","disabled":true},{"key":"correlationId","value":"","description":"Correlation ID to match.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time when the (first) call recording started.","disabled":true},{"key":"startTimeBefore","value":"","description":"Date and time when the (last) call recording started.","disabled":true},{"key":"location","value":"","description":"Recording location.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Invalid sort column.\"\n }\n }\n}"},{"id":"bbb5dd4a-8e4f-44e6-9a0d-a3d6fe80fa22","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/callrouting/1/recordings","protocol":"https","host":["go2","vhdmedia","se"],"path":["callrouting","1","recordings"],"query":[{"key":"sortBy","value":"","description":"Field that will be used for sorting.","disabled":true},{"key":"sortDirection","value":"","description":"Order in which files will be sorted based on sortBy field.","disabled":true},{"key":"endpointType","value":"","description":"Endpoint type of at least one participant in the recorded call.","disabled":true},{"key":"phoneNumber","value":"","description":"Phone number that was participant of the recorded call.","disabled":true},{"key":"sipTrunkId","value":"","description":"SIP Trunk ID that was participant of the recorded call.","disabled":true},{"key":"sipUsername","value":"","description":"Username on the SIP trunk that was participant of the recorded call.","disabled":true},{"key":"webrtcIdentity","value":"","description":"WebRTC Identity that was participant of the recorded call.","disabled":true},{"key":"routeId","value":"","description":"Route ID that was used to establish the recorded call.","disabled":true},{"key":"routeName","value":"","description":"Route name to be used to match recordings. Name will be matched comparing it to all route names.","disabled":true},{"key":"correlationId","value":"","description":"Correlation ID to match.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time when the (first) call recording started.","disabled":true},{"key":"startTimeBefore","value":"","description":"Date and time when the (last) call recording started.","disabled":true},{"key":"location","value":"","description":"Recording location.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"31de9cea-79ff-4405-90ca-79007130893f","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/callrouting/1/recordings","protocol":"https","host":["go2","vhdmedia","se"],"path":["callrouting","1","recordings"],"query":[{"key":"sortBy","value":"","description":"Field that will be used for sorting.","disabled":true},{"key":"sortDirection","value":"","description":"Order in which files will be sorted based on sortBy field.","disabled":true},{"key":"endpointType","value":"","description":"Endpoint type of at least one participant in the recorded call.","disabled":true},{"key":"phoneNumber","value":"","description":"Phone number that was participant of the recorded call.","disabled":true},{"key":"sipTrunkId","value":"","description":"SIP Trunk ID that was participant of the recorded call.","disabled":true},{"key":"sipUsername","value":"","description":"Username on the SIP trunk that was participant of the recorded call.","disabled":true},{"key":"webrtcIdentity","value":"","description":"WebRTC Identity that was participant of the recorded call.","disabled":true},{"key":"routeId","value":"","description":"Route ID that was used to establish the recorded call.","disabled":true},{"key":"routeName","value":"","description":"Route name to be used to match recordings. Name will be matched comparing it to all route names.","disabled":true},{"key":"correlationId","value":"","description":"Correlation ID to match.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time when the (first) call recording started.","disabled":true},{"key":"startTimeBefore","value":"","description":"Date and time when the (last) call recording started.","disabled":true},{"key":"location","value":"","description":"Recording location.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"e989a5de-6713-45bd-8e19-8e1b6dfac9d4","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/callrouting/1/recordings","protocol":"https","host":["go2","vhdmedia","se"],"path":["callrouting","1","recordings"],"query":[{"key":"sortBy","value":"","description":"Field that will be used for sorting.","disabled":true},{"key":"sortDirection","value":"","description":"Order in which files will be sorted based on sortBy field.","disabled":true},{"key":"endpointType","value":"","description":"Endpoint type of at least one participant in the recorded call.","disabled":true},{"key":"phoneNumber","value":"","description":"Phone number that was participant of the recorded call.","disabled":true},{"key":"sipTrunkId","value":"","description":"SIP Trunk ID that was participant of the recorded call.","disabled":true},{"key":"sipUsername","value":"","description":"Username on the SIP trunk that was participant of the recorded call.","disabled":true},{"key":"webrtcIdentity","value":"","description":"WebRTC Identity that was participant of the recorded call.","disabled":true},{"key":"routeId","value":"","description":"Route ID that was used to establish the recorded call.","disabled":true},{"key":"routeName","value":"","description":"Route name to be used to match recordings. Name will be matched comparing it to all route names.","disabled":true},{"key":"correlationId","value":"","description":"Correlation ID to match.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time when the (first) call recording started.","disabled":true},{"key":"startTimeBefore","value":"","description":"Date and time when the (last) call recording started.","disabled":true},{"key":"location","value":"","description":"Recording location.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"750f4a1e-0630-4a50-903c-1042cb1ba3a5","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/callrouting/1/recordings","protocol":"https","host":["go2","vhdmedia","se"],"path":["callrouting","1","recordings"],"query":[{"key":"sortBy","value":"","description":"Field that will be used for sorting.","disabled":true},{"key":"sortDirection","value":"","description":"Order in which files will be sorted based on sortBy field.","disabled":true},{"key":"endpointType","value":"","description":"Endpoint type of at least one participant in the recorded call.","disabled":true},{"key":"phoneNumber","value":"","description":"Phone number that was participant of the recorded call.","disabled":true},{"key":"sipTrunkId","value":"","description":"SIP Trunk ID that was participant of the recorded call.","disabled":true},{"key":"sipUsername","value":"","description":"Username on the SIP trunk that was participant of the recorded call.","disabled":true},{"key":"webrtcIdentity","value":"","description":"WebRTC Identity that was participant of the recorded call.","disabled":true},{"key":"routeId","value":"","description":"Route ID that was used to establish the recorded call.","disabled":true},{"key":"routeName","value":"","description":"Route name to be used to match recordings. Name will be matched comparing it to all route names.","disabled":true},{"key":"correlationId","value":"","description":"Correlation ID to match.","disabled":true},{"key":"startTimeAfter","value":"","description":"Date and time when the (first) call recording started.","disabled":true},{"key":"startTimeBefore","value":"","description":"Date and time when the (last) call recording started.","disabled":true},{"key":"location","value":"","description":"Recording location.","disabled":true},{"key":"page","value":"","description":"Results page to retrieve (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"Number of records per page. Default: `20`.","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"cba4bc7f-deed-4982-b2ec-a88255ae2110"}],"id":"b7dfd1f8-aa1d-4796-87f0-502d9d2d3afd","description":"Recordings of routed calls.
\n","_postman_id":"b7dfd1f8-aa1d-4796-87f0-502d9d2d3afd"},{"name":"NUMBERS","item":[{"name":"List owned numbers","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"numbers\", \"numberCount\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});","","pm.test(\"'numbers' is an array\", function () {"," pm.expect(responseBody[\"numbers\"]).to.be.an('array');","});","","var j = pm.response.json();","if (j.numbers && j.numbers.length) { pm.environment.set(\"numberKey\", j.numbers[0].numberKey); }"],"type":"text/javascript","packages":{}}}],"id":"1e5d54bb-850c-496a-8a58-3b4a4ddd32da","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/numbers/1/numbers","description":"List owned numbers.
\nUse this method to get all the owned numbers for this account.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| limit | \nInt | \nNumber of records returned per page. Default: 50. | \n
\n\n| number | \nString | \nSearched number. | \n
\n\n| page | \nInt | \nPage number. Use with limit for paging purposes. Default: 0. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| numbers | \nArray | \n | \n
\n\n| numbers[].numberKey | \nString | \nUnique ID of a number. | \n
\n\n| numbers[].number | \nString | \nThe number. | \n
\n\n| numbers[].country | \nString | \nNumber's country code. | \n
\n\n| numbers[].countryName | \nString | \nNumber's country. | \n
\n\n| numbers[].type | \nString | \nThe type of number. One of: VIRTUAL_LONG_NUMBER, SHORT_CODE, SIM_HOSTING, VIRTUAL_SIM_HOSTING, VIRTUAL_LONG_NUMBER_CALL_TRIGGER, SHORT_CODE_USSD, WHATSAPP, VIBER, VIBER_VOICE, FACEBOOK, RCS, TELEGRAM, KAKAO_SANGDAM, ZALO_ZMS, OPEN_CHANNEL, ZALO_FOLLOWER. | \n
\n\n| numbers[].capabilities | \nArray | \nAn array of communication channels the number can support. | \n
\n\n| numbers[].shared | \nBoolean | \nIndicates whether a number is shared. | \n
\n\n| numbers[].price | \nObject | \nThe price object indicating pricing details for the number. | \n
\n\n| numbers[].price.pricePerMonth | \nNumber | \nPrice of the monthly fee. | \n
\n\n| numbers[].price.setupPrice | \nNumber | \nPrice of the setup fee. | \n
\n\n| numbers[].price.initialMonthPrice | \nNumber | \nPrice for the initial month. | \n
\n\n| numbers[].price.currency | \nString | \nCurrency of the number's fees. | \n
\n\n| numbers[].network | \nString | \nIndicates the network that owns the number. | \n
\n\n| numbers[].keywords | \nArray | \nKeywords defined for the number. | \n
\n\n| numbers[].voiceSetup | \nObject | \nVoice setup configuration. | \n
\n\n| numbers[].voiceSetup.applicationId | \nString | \nID of the Application that would be associated with the voice setup. | \n
\n\n| numbers[].voiceSetup.entityId | \nString | \nID of the Entity that would be associated with the voice setup. | \n
\n\n| numbers[].voiceSetup.action | \nObject | \nRequired. Voice action configuration. | \n
\n\n| numbers[].voiceSetup.action.type | \nString | \nDefines action type. It is not possible to create new action type. One of: PULL, HTTP_FORWARD, SMPP_FORWARD, MAIL_FORWARD, NO_ACTION, BLOCK, AUTORESPONSE, USSD, SEND_BULK_MT, EMAIL_TO_SMS_FORWARD, CNS_FWD, USE_CONVERSATIONS, FORWARD_TO_PSTN, FORWARD_TO_IP, FORWARD_TO_IVR, VOICE_NUMBER_MASKING, VOICE_CALL_DROP, FORWARD_TO_WEBRTC, VOICE_FORWARD_TO_CONVERSATIONS, VOICE_FORWARD_TO_CONVERSATIONS_WITH_FLOW, CALL_FORWARD_TO_APPLICATION, FORWARD_TO_SUBSCRIPTION, FORWARD_TO_CALL_ROUTING, USE_ANSWERS, VOICE_FORWARD_TO_ANSWERS, VOICE_FORWARD_TO_FLOW, VOICE_FORWARD_TO_FLOW_WITH_CONVERSATIONS, FORWARD_TO_OPERATOR_CONNECT, FORWARD_TO_EXTERNAL_INTEGRATION, FORWARD_TO_AI_AGENT, FORWARD_TO_MARKUP_LANGUAGE, OTHER. | \n
\n\n| numbers[].voiceSetup.action.description | \nString | \nAdditional action description. | \n
\n\n| numbers[].voiceSetup.channel | \nString | \nChannel the voice action is configured on. One of: VOICE, WHATSAPP. | \n
\n\n| numbers[].reservationStatus | \nString | \nStatus of the number reservation. One of: PENDING, BILLING_FAILED, ERROR, RESERVATION_FAILED. | \n
\n\n| numbers[].additionalSetupRequired | \nBoolean | \nIndicates whether the number requires additional setup before being used. | \n
\n\n| numbers[].editPermissions | \nObject | \nThe editPermissions object to indicate editing permissions for the number. | \n
\n\n| numbers[].editPermissions.canEditNumber | \nBoolean | \nIndicates whether the permissions allow for editing a number. | \n
\n\n| numbers[].editPermissions.canEditConfiguration | \nBoolean | \nIndicates whether the the permissions allow for editing number configuration. | \n
\n\n| numbers[].note | \nString | \nAdditional information attached to the number. Available only for SHORT_CODE and VIRTUAL_LONG_NUMBER number types. | \n
\n\n| numbers[].applicationId | \nString | \nID of the Application that would be associated with the number. | \n
\n\n| numbers[].entityId | \nString | \nID of the Entity that would be associated with the number. | \n
\n\n| numberCount | \nInt | \n | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["numbers","1","numbers"],"host":["go2","vhdmedia","se"],"query":[{"disabled":true,"description":{"content":"Number of records returned per page. Default: 50.
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Searched number.
\n","type":"text/plain"},"key":"number","value":""},{"disabled":true,"description":{"content":"Page number. Use with limit for paging purposes. Default: 0.
\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[{"id":"d2a738aa-5649-4273-95fb-6899ea8dcb12","name":"200 - Response example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/numbers/1/numbers","protocol":"https","host":["go2","vhdmedia","se"],"path":["numbers","1","numbers"],"query":[{"key":"limit","value":"","description":"Number of records returned per page. Default: `50`.","disabled":true},{"key":"number","value":"","description":"Searched number.","disabled":true},{"key":"page","value":"","description":"Page number. Use with `limit` for paging purposes. Default: `0`.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"numbers\": [\n {\n \"numberKey\": \"6FED0BC540BFADD9B05ED7D89AAC22FA\",\n \"number\": \"447860041117\",\n \"country\": \"GB\",\n \"countryName\": \"United Kingdom\",\n \"type\": \"VIRTUAL_LONG_NUMBER\",\n \"capabilities\": [\n \"SMS\"\n ],\n \"shared\": false,\n \"price\": {\n \"pricePerMonth\": 5,\n \"setupPrice\": 0,\n \"currency\": \"EUR\"\n },\n \"network\": \"02 (Telefonica UK Ltd)\",\n \"keywords\": [\n \"test\",\n \"stop\"\n ],\n \"additionalSetupRequired\": false,\n \"editPermissions\": {\n \"canEditNumber\": true,\n \"canEditConfiguration\": true\n },\n \"applicationId\": \"default\"\n }\n ],\n \"numberCount\": 1\n}"},{"id":"8d781664-f052-4abf-9d34-faafe15d36bf","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/numbers/1/numbers","protocol":"https","host":["go2","vhdmedia","se"],"path":["numbers","1","numbers"],"query":[{"key":"limit","value":"","description":"Number of records returned per page. Default: `50`.","disabled":true},{"key":"number","value":"","description":"Searched number.","disabled":true},{"key":"page","value":"","description":"Page number. Use with `limit` for paging purposes. Default: `0`.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"a29923d0-6646-43ef-91f7-7d2fceb2d083","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/numbers/1/numbers","protocol":"https","host":["go2","vhdmedia","se"],"path":["numbers","1","numbers"],"query":[{"key":"limit","value":"","description":"Number of records returned per page. Default: `50`.","disabled":true},{"key":"number","value":"","description":"Searched number.","disabled":true},{"key":"page","value":"","description":"Page number. Use with `limit` for paging purposes. Default: `0`.","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"11e3dcaa-e312-4ff4-ad5f-33458894188e","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/numbers/1/numbers","protocol":"https","host":["go2","vhdmedia","se"],"path":["numbers","1","numbers"],"query":[{"key":"limit","value":"","description":"Number of records returned per page. Default: `50`.","disabled":true},{"key":"number","value":"","description":"Searched number.","disabled":true},{"key":"page","value":"","description":"Page number. Use with `limit` for paging purposes. Default: `0`.","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"c4e98361-329b-42e5-8af0-049e9a20107c","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/numbers/1/numbers","protocol":"https","host":["go2","vhdmedia","se"],"path":["numbers","1","numbers"],"query":[{"key":"limit","value":"","description":"Number of records returned per page. Default: `50`.","disabled":true},{"key":"number","value":"","description":"Searched number.","disabled":true},{"key":"page","value":"","description":"Page number. Use with `limit` for paging purposes. Default: `0`.","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"1e5d54bb-850c-496a-8a58-3b4a4ddd32da"},{"name":"Get single owned number","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","if (!(pm.environment.get(\"numberKey\") || \"\")) { skip(\"numberKey is not set (an earlier request did not create it)\"); }"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"numberKey\", \"number\", \"country\", \"type\", \"capabilities\", \"shared\", \"price\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});","","pm.test(\"'capabilities' is an array\", function () {"," pm.expect(responseBody[\"capabilities\"]).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"cba7d2b3-7cfa-47b5-9fe3-959519d21d10","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/numbers/1/numbers/{{numberKey}}","description":"Get single owned number.
\nGet information about an owned number using the unique ID of the number.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| numberKey | \nString | \nRequired. The unique ID of the number for which information is requested. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| numberKey | \nString | \nUnique ID of a number. | \n
\n\n| number | \nString | \nThe number. | \n
\n\n| country | \nString | \nNumber's country code. | \n
\n\n| countryName | \nString | \nNumber's country. | \n
\n\n| type | \nString | \nThe type of number. One of: VIRTUAL_LONG_NUMBER, SHORT_CODE, SIM_HOSTING, VIRTUAL_SIM_HOSTING, VIRTUAL_LONG_NUMBER_CALL_TRIGGER, SHORT_CODE_USSD, WHATSAPP, VIBER, VIBER_VOICE, FACEBOOK, RCS, TELEGRAM, KAKAO_SANGDAM, ZALO_ZMS, OPEN_CHANNEL, ZALO_FOLLOWER. | \n
\n\n| capabilities | \nArray | \nAn array of communication channels the number can support. | \n
\n\n| shared | \nBoolean | \nIndicates whether a number is shared. | \n
\n\n| price | \nObject | \nThe price object indicating pricing details for the number. | \n
\n\n| price.pricePerMonth | \nNumber | \nPrice of the monthly fee. | \n
\n\n| price.setupPrice | \nNumber | \nPrice of the setup fee. | \n
\n\n| price.initialMonthPrice | \nNumber | \nPrice for the initial month. | \n
\n\n| price.currency | \nString | \nCurrency of the number's fees. | \n
\n\n| network | \nString | \nIndicates the network that owns the number. | \n
\n\n| keywords | \nArray | \nKeywords defined for the number. | \n
\n\n| voiceSetup | \nObject | \nVoice setup configuration. | \n
\n\n| voiceSetup.applicationId | \nString | \nID of the Application that would be associated with the voice setup. | \n
\n\n| voiceSetup.entityId | \nString | \nID of the Entity that would be associated with the voice setup. | \n
\n\n| voiceSetup.action | \nObject | \nRequired. Voice action configuration. | \n
\n\n| voiceSetup.action.type | \nString | \nDefines action type. It is not possible to create new action type. One of: PULL, HTTP_FORWARD, SMPP_FORWARD, MAIL_FORWARD, NO_ACTION, BLOCK, AUTORESPONSE, USSD, SEND_BULK_MT, EMAIL_TO_SMS_FORWARD, CNS_FWD, USE_CONVERSATIONS, FORWARD_TO_PSTN, FORWARD_TO_IP, FORWARD_TO_IVR, VOICE_NUMBER_MASKING, VOICE_CALL_DROP, FORWARD_TO_WEBRTC, VOICE_FORWARD_TO_CONVERSATIONS, VOICE_FORWARD_TO_CONVERSATIONS_WITH_FLOW, CALL_FORWARD_TO_APPLICATION, FORWARD_TO_SUBSCRIPTION, FORWARD_TO_CALL_ROUTING, USE_ANSWERS, VOICE_FORWARD_TO_ANSWERS, VOICE_FORWARD_TO_FLOW, VOICE_FORWARD_TO_FLOW_WITH_CONVERSATIONS, FORWARD_TO_OPERATOR_CONNECT, FORWARD_TO_EXTERNAL_INTEGRATION, FORWARD_TO_AI_AGENT, FORWARD_TO_MARKUP_LANGUAGE, OTHER. | \n
\n\n| voiceSetup.action.description | \nString | \nAdditional action description. | \n
\n\n| voiceSetup.channel | \nString | \nChannel the voice action is configured on. One of: VOICE, WHATSAPP. | \n
\n\n| reservationStatus | \nString | \nStatus of the number reservation. One of: PENDING, BILLING_FAILED, ERROR, RESERVATION_FAILED. | \n
\n\n| additionalSetupRequired | \nBoolean | \nIndicates whether the number requires additional setup before being used. | \n
\n\n| editPermissions | \nObject | \nThe editPermissions object to indicate editing permissions for the number. | \n
\n\n| editPermissions.canEditNumber | \nBoolean | \nIndicates whether the permissions allow for editing a number. | \n
\n\n| editPermissions.canEditConfiguration | \nBoolean | \nIndicates whether the the permissions allow for editing number configuration. | \n
\n\n| note | \nString | \nAdditional information attached to the number. Available only for SHORT_CODE and VIRTUAL_LONG_NUMBER number types. | \n
\n\n| applicationId | \nString | \nID of the Application that would be associated with the number. | \n
\n\n| entityId | \nString | \nID of the Entity that would be associated with the number. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["numbers","1","numbers","{{numberKey}}"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"c17f6e7b-62dd-49d7-9e16-3e207861bfa0","name":"200 - Response example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/numbers/1/numbers/{{numberKey}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"numberKey\": \"6FED0BC540BFADD9B05ED7D89AAC22FA\",\n \"number\": \"447860041117\",\n \"country\": \"GB\",\n \"type\": \"VIRTUAL_LONG_NUMBER\",\n \"capabilities\": [\n \"SMS\"\n ],\n \"shared\": false,\n \"price\": {\n \"pricePerMonth\": 5,\n \"setupPrice\": 0,\n \"currency\": \"EUR\"\n }\n}"},{"id":"90f76377-8ddb-4b9d-954a-dbff491d1c57","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/numbers/1/numbers/{{numberKey}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"f7b09804-d474-48bb-8832-3c727dab2a14","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/numbers/1/numbers/{{numberKey}}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"b37ed282-11eb-43fd-911c-e90fe6dd6b30","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/numbers/1/numbers/{{numberKey}}"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"fb272c07-b1f3-4ca5-8f3c-104a58ac3e41","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/numbers/1/numbers/{{numberKey}}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"cba7d2b3-7cfa-47b5-9fe3-959519d21d10"},{"name":"Get voice setup on number","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","if (!(pm.environment.get(\"numberKey\") || \"\")) { skip(\"numberKey is not set (an earlier request did not create it)\"); }"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["pm.test(\"Status code is 200 or 404\", function () { pm.expect(pm.response.code).to.be.oneOf([200, 404]); });","pm.test(\"Response time is below 5000ms\", function () { pm.expect(pm.response.responseTime).to.be.below(5000); });","pm.test(\"The voice setup is returned, or 404 when the number has none\", function () { if (pm.response.code === 200) { pm.expect(pm.response.json()).to.be.an(\"object\"); } });"],"type":"text/javascript","packages":{}}}],"id":"0b74b470-f021-4fb1-bb83-b27bd8244901","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/numbers/2/numbers/{{numberKey}}/voice","description":"Get voice setup on number.
\nThis method fetches the voice setup on a number. Use the channel parameter to fetch the setup for a specific channel.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| numberKey | \nString | \nRequired. Unique ID of a number. | \n
\n\n| channel | \nString | \nChannel the voice setup belongs to. Default: VOICE. One of: VOICE, WHATSAPP. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| applicationId | \nString | \nID of the Application that would be associated with the voice setup. | \n
\n\n| entityId | \nString | \nID of the Entity that would be associated with the voice setup. | \n
\n\n| action | \nObject | \nRequired. Voice action configuration. | \n
\n\n| action.type | \nString | \nDefines action type. It is not possible to create new action type. One of: PULL, HTTP_FORWARD, SMPP_FORWARD, MAIL_FORWARD, NO_ACTION, BLOCK, AUTORESPONSE, USSD, SEND_BULK_MT, EMAIL_TO_SMS_FORWARD, CNS_FWD, USE_CONVERSATIONS, FORWARD_TO_PSTN, FORWARD_TO_IP, FORWARD_TO_IVR, VOICE_NUMBER_MASKING, VOICE_CALL_DROP, FORWARD_TO_WEBRTC, VOICE_FORWARD_TO_CONVERSATIONS, VOICE_FORWARD_TO_CONVERSATIONS_WITH_FLOW, CALL_FORWARD_TO_APPLICATION, FORWARD_TO_SUBSCRIPTION, FORWARD_TO_CALL_ROUTING, USE_ANSWERS, VOICE_FORWARD_TO_ANSWERS, VOICE_FORWARD_TO_FLOW, VOICE_FORWARD_TO_FLOW_WITH_CONVERSATIONS, FORWARD_TO_OPERATOR_CONNECT, FORWARD_TO_EXTERNAL_INTEGRATION, FORWARD_TO_AI_AGENT, FORWARD_TO_MARKUP_LANGUAGE, OTHER. | \n
\n\n| action.description | \nString | \nAdditional action description. | \n
\n\n| channel | \nString | \nChannel the voice action is configured on. One of: VOICE, WHATSAPP. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["numbers","2","numbers","{{numberKey}}","voice"],"host":["go2","vhdmedia","se"],"query":[{"disabled":true,"description":{"content":"Channel the voice setup belongs to. Default: VOICE.
\n","type":"text/plain"},"key":"channel","value":""}],"variable":[]}},"response":[{"id":"d8f3eb1e-a13a-41a0-b46f-ad41ee8230fe","name":"200 - VOICE_NUMBER_MASKING","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/numbers/2/numbers/{{numberKey}}/voice","protocol":"https","host":["go2","vhdmedia","se"],"path":["numbers","2","numbers","{{numberKey}}","voice"],"query":[{"key":"channel","value":"","description":"Channel the voice setup belongs to. Default: `VOICE`.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"channel\": \"VOICE\",\n \"action\": {\n \"voiceNumberMaskingConfigKey\": \"C6A5995CBF4D2DF2ADE29963B3BB00E6\",\n \"type\": \"VOICE_NUMBER_MASKING\"\n }\n}"},{"id":"0c37d7a7-fd55-4bf3-897b-e32331bf0c77","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/numbers/2/numbers/{{numberKey}}/voice","protocol":"https","host":["go2","vhdmedia","se"],"path":["numbers","2","numbers","{{numberKey}}","voice"],"query":[{"key":"channel","value":"","description":"Channel the voice setup belongs to. Default: `VOICE`.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"3cfc40eb-cc96-4b6a-86cd-daf94db0add4","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/numbers/2/numbers/{{numberKey}}/voice","protocol":"https","host":["go2","vhdmedia","se"],"path":["numbers","2","numbers","{{numberKey}}","voice"],"query":[{"key":"channel","value":"","description":"Channel the voice setup belongs to. Default: `VOICE`.","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"a0d1ccb9-08d6-4adb-9af2-9bcf226e0d7b","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/numbers/2/numbers/{{numberKey}}/voice","protocol":"https","host":["go2","vhdmedia","se"],"path":["numbers","2","numbers","{{numberKey}}","voice"],"query":[{"key":"channel","value":"","description":"Channel the voice setup belongs to. Default: `VOICE`.","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"0b74b470-f021-4fb1-bb83-b27bd8244901"}],"id":"f7e54036-2e02-4139-a9a5-996bd4fb67e8","description":"The phone numbers on your account. These requests only read: buying, canceling and changing numbers is not covered here.
\n","_postman_id":"f7e54036-2e02-4139-a9a5-996bd4fb67e8"}],"id":"43dfdc9f-4ea0-4318-b903-bd2d13ae46c0","description":"\nRunning these requests. They run in order and need no setup, except: voice calls are placed only when the environment variable runVoiceCalls is true (otherwise those requests are skipped), and Download Voice IVR Recorded File needs ivrFileId. The scheduled voice message is canceled at the end, so no call is placed for it.
\n
\n","_postman_id":"43dfdc9f-4ea0-4318-b903-bd2d13ae46c0"},{"name":"EMAIL","item":[{"name":"SEND EMAIL","item":[{"name":"Send email messages (API v4, latest)","event":[{"listen":"test","script":{"exec":["// Tests for Send email messages (API v4).","pm.test(\"Status code is 200\", function () { pm.response.to.have.status(200); });","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var res;","pm.test(\"Response body is valid JSON\", function () { res = pm.response.json(); });","","pm.test(\"Response has bulkId\", function () {"," pm.expect(res).to.have.property('bulkId').that.is.a('string');","});","","pm.test(\"Response contains 'messages' array\", function () {"," pm.expect(res).to.have.property('messages').that.is.an('array').with.lengthOf.at.least(1);","});","","pm.test(\"Each message has the documented fields\", function () {"," res.messages.forEach(function (m) {"," pm.expect(m).to.have.property('messageId').that.is.a('string');"," pm.expect(m).to.have.property('status');"," pm.expect(m.status).to.include.all.keys('groupId', 'groupName', 'id', 'name', 'description');"," pm.expect(m.status.groupName).to.be.oneOf(['ACCEPTED', 'PENDING', 'UNDELIVERABLE', 'DELIVERED', 'EXPIRED', 'REJECTED']);"," });","});","","pm.test(\"Number of messages matches the number of recipients\", function () {"," var req = JSON.parse(pm.request.body.raw), n = 0;"," req.messages.forEach(function (m) {"," m.destinations.forEach(function (d) {"," ['to', 'cc', 'bcc'].forEach(function (k) { n += (d[k] || []).length; });"," });"," });"," pm.expect(res.messages.length).to.be.at.least(1);"," pm.expect(res.messages.length).to.be.at.most(Math.max(n, 1));","});",""],"type":"text/javascript","packages":{}}}],"id":"fcc95463-f3f1-4b70-a561-1597e9af2842","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"sender\": \"example@vhdmedia.eu\",\n \"destinations\": [\n {\n \"to\": [\n {\n \"destination\": \"jane.smith@vhdmedia.se\",\n \"placeholders\": \"{\\\"name\\\":\\\"Jane\\\"}\"\n }\n ]\n }\n ],\n \"content\": {\n \"subject\": \"Welcome to VHD, {{name}}\",\n \"html\": \"Hello {{name}}
This is a test email from the VHD API.
\",\n \"text\": \"Dear {{name}}, this is a test email from the VHD API.\"\n },\n \"webhooks\": {\n \"delivery\": {\n \"url\": \"https://www.example.com/email/delivery\",\n \"intermediateReport\": true,\n \"notify\": true\n },\n \"contentType\": \"application/json\",\n \"callbackData\": \"DLR callback data\"\n }\n }\n ],\n \"options\": {\n \"tracking\": {\n \"trackOpens\": true,\n \"trackClicks\": true\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/email/4/messages","description":"Send one email or many in a single request, with text, HTML, a template, attachments, and placeholders. This is the current version of the email send API and replaces Send fully featured email (API v3), which stays available.
\nMessages sent here can use the VHD options for tracking, scheduling, delivery windows, IP pools, and storage. Delivery reports go to the URL in webhooks.delivery.url, and open and click notifications go to options.tracking.trackingUrl.
\n\nScheduling. With options.schedule.sendAt, an email can be scheduled up to 5 days ahead. The older v3 send accepted dates further ahead. Use the scheduled-email requests to view, pause, reschedule or cancel a scheduled bulk.
\n
\n\nPlaceholders are JSON strings. The values of placeholders and defaultPlaceholders must be sent as a string that contains JSON, for example \"{\\\"name\\\": \\\"Jane\\\"}\", not as an object.
\n
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| messages | \nArray | \nRequired. An array of message objects of a single message or multiple messages sent under one bulk ID. | \n
\n\n| messages[].sender | \nString | \nEmail address with optional sender name. Note: This field is required if templateId is not present. | \n
\n\n| messages[].destinations | \nArray | \nRequired. An array of destination objects for where messages are being sent. A valid destination is required. Note: Maximum number of recipients is 1000 overall including to, cc and bcc field. | \n
\n\n| messages[].destinations[].to | \nArray | \nRequired. List of TO recipient email addresses. | \n
\n\n| messages[].destinations[].to[].destination | \nString | \nRequired. Email address of the recipient in a form of john.smith@somecompany.com | \n
\n\n| messages[].destinations[].to[].messageId | \nString | \nThe ID that uniquely identifies the message sent to a recipient. | \n
\n\n| messages[].destinations[].to[].placeholders | \nString | \nAs optional feature, a specific placeholder can be defined whose value will apply only for this destination. Value should be defined as: {\"name\": \"John\"}. | \n
\n\n| messages[].destinations[].cc | \nArray | \nList of CC recipient email addresses. | \n
\n\n| messages[].destinations[].cc[].destination | \nString | \nRequired. Email address of the recipient in a form of john.smith@somecompany.com | \n
\n\n| messages[].destinations[].cc[].messageId | \nString | \nThe ID that uniquely identifies the message sent to a recipient. | \n
\n\n| messages[].destinations[].cc[].placeholders | \nString | \nAs optional feature, a specific placeholder can be defined whose value will apply only for this destination. Value should be defined as: {\"name\": \"John\"}. | \n
\n\n| messages[].destinations[].bcc | \nArray | \nList of BCC recipient email addresses. | \n
\n\n| messages[].destinations[].bcc[].destination | \nString | \nRequired. Email address of the recipient in a form of john.smith@somecompany.com | \n
\n\n| messages[].destinations[].bcc[].messageId | \nString | \nThe ID that uniquely identifies the message sent to a recipient. | \n
\n\n| messages[].destinations[].bcc[].placeholders | \nString | \nAs optional feature, a specific placeholder can be defined whose value will apply only for this destination. Value should be defined as: {\"name\": \"John\"}. | \n
\n\n| messages[].destinations[].replyTo | \nString | \nEmail address to which recipients of the email can reply. | \n
\n\n| messages[].destinations[].preserveRecipients | \nBoolean | \nWhen this option is set to true, all recipients in the to field will be able to see the entire list of recipients who received the email, and the response will include a single messageId. If the option is set to false , each recipient will only see their own email address, and the response will provide a unique messageId for each individual recipient. | \n
\n\n| messages[].content | \nObject | \nRequired. Message content. | \n
\n\n| messages[].content.subject | \nString | \nMessage subject. Note: This field is required if templateId is not present. | \n
\n\n| messages[].content.text | \nString | \nBody of the message. | \n
\n\n| messages[].content.html | \nString | \nThe message's body in HTML format. If both html and text fields are included, the text field will be disregarded, and the message will be sent using the html content. | \n
\n\n| messages[].content.ampHtml | \nString | \nThe message's body in AMP HTML format. If you include ampHtml, you must also include html, which will be displayed if AMP is not supported. Keep in mind that not all email clients support AMP HTML. For guidance on configuring the Gmail client, please visit this link: https://developers.google.com/gmail/ampemail/ . | \n
\n\n| messages[].content.templateId | \nString | \nThe Template ID with predefined email content created through the VHD web interface or API. When templateId is specified, the html and text fields will be disregarded. Note: templateId only supports the Broadcast value; Content and Flow templates are not supported. | \n
\n\n| messages[].content.attachments | \nArray | \nFile attachments. | \n
\n\n| messages[].content.attachments[].type | \nString | \nRequired. | \n
\n\n| messages[].content.inlineImages | \nArray | \nAllows for inserting an image file inside the HTML code of the email by using cid:FILENAME instead of providing an external link to the image. | \n
\n\n| messages[].content.inlineImages[].type | \nString | \nRequired. | \n
\n\n| messages[].content.defaultPlaceholders | \nString | \nGeneral placeholders: {\"ph1\": \"Success\"} will replace the key {{ph1}} with the value Success throughout the email, including the subject, text, and HTML. If there are multiple recipients in the To field, this placeholder will use the same value for the key ph1 for all recipients. | \n
\n\n| messages[].content.landingPagePlaceholders | \nString | \nPersonalize Opt-Out Landing Page by inserting placeholders. Insert placeholder or tag while designing landing page. Value should be defined as: {\"unsubscribe\": \"Unsubscribe\"} | \n
\n\n| messages[].content.optoutLandingPageId | \nString | \nThe Opt-Out Landing Page ID specifies the page to be displayed when an end user clicks the unsubscribe link. If the ID is not provided, the default opt-out landing page will be used. Create a landing page over VHD web interface and use its ID, for example, 1_23456. | \n
\n\n| messages[].content.templateLanguageVersion | \nString | \nIndicates the version of the template language to be used in the current message template. Use version 1 for the older template language and version 2 to access features of the new template language. If not specified, version 1 will be used by default. | \n
\n\n| messages[].content.headers | \nString | \nAdditional email headers for customization that can be provided in a form of JSON. Example: headers={\"X-CustomHeader\": \"Header value\"}. There are a few exceptions of headers which are not adjustable through this option: To, Cc, Bcc, Subject, Content-Type, DKIM-Signature, Content-Transfer-Encoding, Return-Path, MIME-Version | \n
\n\n| messages[].options | \nObject | \nMessage options. | \n
\n\n| messages[].options.platform | \nObject | \nPlatform options. For more details, see documentation. | \n
\n\n| messages[].options.platform.entityId | \nString | \nUsed when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the documentation. | \n
\n\n| messages[].options.platform.applicationId | \nString | \nUsed when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the documentation. | \n
\n\n| messages[].options.validityPeriod | \nObject | \nMessage validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. | \n
\n\n| messages[].options.validityPeriod.amount | \nInt | \nRequired. Message validity period's value. If timeUnit is not set, it will default to MINUTES. | \n
\n\n| messages[].options.validityPeriod.timeUnit | \nString | \nMessage validity period time unit. One of: SECONDS, MINUTES, HOURS. | \n
\n\n| messages[].options.deliveryTimeWindow | \nObject | \nSets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the from property. The exact time of the day to end sending messages can be defined using the to property. Properties from and to should be both provided with the minimum 1 hour difference or omitted. | \n
\n\n| messages[].options.deliveryTimeWindow.days | \nArray | \nRequired. Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma. | \n
\n\n| messages[].options.deliveryTimeWindow.from | \nObject | \nThe exact time of the day. The time is expressed in the UTC time zone. | \n
\n\n| messages[].options.deliveryTimeWindow.from.hour | \nInt | \nRequired. Hour when the time window opens when used in the from property or closes when used in the to property. | \n
\n\n| messages[].options.deliveryTimeWindow.from.minute | \nInt | \nRequired. Minute when the time window opens when used in the from property or closes when used in the to property. | \n
\n\n| messages[].options.deliveryTimeWindow.to | \nObject | \nThe exact time of the day. The time is expressed in the UTC time zone. | \n
\n\n| messages[].options.deliveryTimeWindow.to.hour | \nInt | \nRequired. Hour when the time window opens when used in the from property or closes when used in the to property. | \n
\n\n| messages[].options.deliveryTimeWindow.to.minute | \nInt | \nRequired. Minute when the time window opens when used in the from property or closes when used in the to property. | \n
\n\n| messages[].options.campaignReferenceId | \nString | \nID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel. | \n
\n\n| messages[].webhooks | \nObject | \nProvides options for configuring message webhooks. | \n
\n\n| messages[].webhooks.delivery | \nObject | \nProvides options for configuring the delivery report behavior. | \n
\n\n| messages[].webhooks.delivery.url | \nString | \nThe URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the retry cycle uses the following formula: 1min + (1min * retryNumber * retryNumber). | \n
\n\n| messages[].webhooks.delivery.intermediateReport | \nBoolean | \nThe real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to false. | \n
\n\n| messages[].webhooks.delivery.notify | \nBoolean | \nNotify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to 'true' or not defined, your Subscription settings will apply. | \n
\n\n| messages[].webhooks.contentType | \nString | \nPreferred delivery report content type, application/json or application/xml. | \n
\n\n| messages[].webhooks.callbackData | \nString | \nAdditional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters. | \n
\n\n| messages[].ips | \nObject | \nIP options per message. | \n
\n\n| messages[].ips.ipPoolId | \nString | \nThe ID of the IP pool that will be used to send the email. | \n
\n\n| messages[].placeholdersMasking | \nArray | \nOptions to full or partially mask placeholders. | \n
\n\n| messages[].placeholdersMasking[].name | \nString | \nRequired. The placeholder name that needs to be masked. | \n
\n\n| messages[].placeholdersMasking[].side | \nString | \nThe side from which characters should be hidden. Options are L (left) or R (right). | \n
\n\n| messages[].placeholdersMasking[].maskChar | \nString | \nThe character used to replace the masked placeholders, e.g., *, +. | \n
\n\n| messages[].placeholdersMasking[].visibleChars | \nInt | \nThe number of characters to leave visible. Ignored if a delimiter is specified. Defaults to 0 (i.e., all characters hidden) if not specified. | \n
\n\n| messages[].placeholdersMasking[].delimiter | \nString | \nOptional delimiter character (e.g., @, /). When specified, masking applies only to the part of the placeholder before or after the delimiter, depending on the side value. If this is set, the visibleChars field is ignored. | \n
\n\n| messages[].placeholdersMasking[].skipChars | \nArray | \nA list of characters that should not be masked, even if they fall within the masked region. For example, if we want to mask (385)-9134849 into (***)-********, we should include the characters (,) and - in this list to preserve the formatting. In this case, only digits will be masked while parentheses and dashes remain visible. | \n
\n\n| messages[].storage | \nObject | \nEmail storage options per message. | \n
\n\n| messages[].storage.skipPassive | \nBoolean | \nSet to true to skip passive email storage (long-term storage used for compliance, legal, or audit purposes). If false or not set, the account-level setting is used. | \n
\n\n| messages[].storage.skipActive | \nBoolean | \nSet to true to skip active email storage (short-term storage used for troubleshooting or support). If false or not set, the account-level setting is used. | \n
\n\n| options | \nObject | \nOptions applicable to all messages in the request. | \n
\n\n| options.schedule | \nObject | \nOptions for scheduling a message. | \n
\n\n| options.schedule.bulkId | \nString | \nUnique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response. | \n
\n\n| options.schedule.sendAt | \nString | \nDate and time when the message is to be sent. Used for scheduled messages. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ, and can only be scheduled for no later than 5 days in advance. | \n
\n\n| options.tracking | \nObject | \nSets up URL shortening and tracking feature. | \n
\n\n| options.tracking.track | \nBoolean | \nEnable or disable open and click tracking. Passing true will only enable tracking and the statistics will be visible in the web interface alone. This can be explicitly overridden by trackClicks and trackOpens. | \n
\n\n| options.tracking.trackOpens | \nBoolean | \nThis parameter enables or disables track open feature. | \n
\n\n| options.tracking.trackClicks | \nBoolean | \nThis parameter enables or disables track click feature. | \n
\n\n| options.tracking.trackingUrl | \nString | \nThe URL on your callback server on which the open and click notifications will be sent. See Tracking Notifications for details. | \n
\n\n| options.tracking.trackingPixelPosition | \nString | \nThis parameter specifies the position of the open tracking pixel within the email content. Allowed values are TOP and BOTTOM. If no value is provided, the default is TOP. | \n
\n\n| options.clientPriority | \nString | \nClient priority set on request. Must be 'HIGH', 'STANDARD' or 'LOW'. One of: HIGH, STANDARD, LOW. | \n
\n\n
\n
On success the response is 200 OK. Invalid requests return 400 with the list of violations, missing or invalid credentials 401.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| bulkId | \nString | \nUnique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response. Typically used for fetching delivery reports and message logs. | \n
\n\n| messages | \nArray | \nRequired. An array of message objects of a single message or multiple messages sent under one bulk ID. | \n
\n\n| messages[].messageId | \nString | \nUnique message ID. If not provided, it will be auto-generated and returned in the API response. | \n
\n\n| messages[].status | \nObject | \nIndicates the status of the message and how to recover from an error should there be any. | \n
\n\n| messages[].status.groupId | \nInt | \nStatus group ID. | \n
\n\n| messages[].status.groupName | \nString | \nStatus group name that describes which category the status code belongs to, i.e., PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED. One of: ACCEPTED, PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED. | \n
\n\n| messages[].status.id | \nInt | \nStatus code ID. | \n
\n\n| messages[].status.name | \nString | \nStatus code name. | \n
\n\n| messages[].status.description | \nString | \nHuman-readable description of the status. | \n
\n\n| messages[].status.action | \nString | \nAction to take to recover from the error. | \n
\n\n| messages[].destination | \nString | \nThe destination address of the message, i.e., its recipient. | \n
\n\n| messages[].details | \nObject | \nOther details of the message. | \n
\n\n
\n
Errors use the common format: errorCode, description, action, violations[] (property, violation).
\n","urlObject":{"protocol":"https","path":["email","4","messages"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"9479cce9-8496-4f64-a5c5-06a8cd66e528","name":"Email accepted","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"sender\": \"example@vhdmedia.eu\",\n \"destinations\": [\n {\n \"to\": [\n {\n \"destination\": \"jane.smith@vhdmedia.se\",\n \"placeholders\": \"{\\\"name\\\":\\\"Jane\\\"}\"\n }\n ]\n }\n ],\n \"content\": {\n \"subject\": \"Welcome to VHD, {{name}}\",\n \"html\": \"Hello {{name}}
This is a test email from the VHD API.
\",\n \"text\": \"Dear {{name}}, this is a test email from the VHD API.\"\n },\n \"webhooks\": {\n \"delivery\": {\n \"url\": \"https://www.example.com/email/delivery\",\n \"intermediateReport\": true,\n \"notify\": true\n },\n \"contentType\": \"application/json\",\n \"callbackData\": \"DLR callback data\"\n }\n }\n ],\n \"options\": {\n \"tracking\": {\n \"trackOpens\": true,\n \"trackClicks\": true\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/email/4/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"x7kferxomzc2nlihlouz\",\n \"messages\": [\n {\n \"messageId\": \"claxbdvqvssvnc12hypo\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\",\n \"description\": \"Message accepted, pending for delivery.\"\n },\n \"destination\": \"jane.smith@vhdmedia.se\"\n }\n ]\n}"},{"id":"3c600934-371f-4ab9-bba7-716c942b8d34","name":"Bad request - required fields are missing","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"destinations\": []\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/email/4/messages"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E400\",\n \"description\": \"Request cannot be processed.\",\n \"action\": \"Check the syntax, violations and adjust the request.\",\n \"violations\": [\n {\n \"property\": \"messages[0].destinations\",\n \"violation\": \"must not be empty\"\n },\n {\n \"property\": \"messages[0]\",\n \"violation\": \"Sender is mandatory if templateId is missing\"\n },\n {\n \"property\": \"messages[0].content\",\n \"violation\": \"must not be null\"\n }\n ],\n \"resources\": []\n}"},{"id":"b73c2eb4-a5cb-4cb5-abeb-5770925d9d64","name":"Unauthorized - invalid API key","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"sender\": \"example@vhdmedia.eu\",\n \"destinations\": [\n {\n \"to\": [\n {\n \"destination\": \"jane.smith@vhdmedia.se\",\n \"placeholders\": \"{\\\"name\\\":\\\"Jane\\\"}\"\n }\n ]\n }\n ],\n \"content\": {\n \"subject\": \"Welcome to VHD, {{name}}\",\n \"html\": \"Hello {{name}}
This is a test email from the VHD API.
\",\n \"text\": \"Dear {{name}}, this is a test email from the VHD API.\"\n },\n \"webhooks\": {\n \"delivery\": {\n \"url\": \"https://www.example.com/email/delivery\",\n \"intermediateReport\": true,\n \"notify\": true\n },\n \"contentType\": \"application/json\",\n \"callbackData\": \"DLR callback data\"\n }\n }\n ],\n \"options\": {\n \"tracking\": {\n \"trackOpens\": true,\n \"trackClicks\": true\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/email/4/messages"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E401\",\n \"description\": \"The request lacks valid authentication credentials for the requested resource.\",\n \"action\": \"Check the resources and adjust authentication credentials.\",\n \"violations\": [],\n \"resources\": []\n}"}],"_postman_id":"fcc95463-f3f1-4b70-a561-1597e9af2842"},{"name":"Send MIME email (API v4)","event":[{"listen":"test","script":{"exec":["// Tests for Send MIME email (API v4).","pm.test(\"Status code is 200\", function () { pm.response.to.have.status(200); });","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var res;","pm.test(\"Response body is valid JSON\", function () { res = pm.response.json(); });","","pm.test(\"Response has bulkId\", function () {"," pm.expect(res).to.have.property('bulkId').that.is.a('string');","});","","pm.test(\"Each message has the documented fields\", function () {"," pm.expect(res).to.have.property('messages').that.is.an('array').with.lengthOf.at.least(1);"," res.messages.forEach(function (m) {"," pm.expect(m).to.have.property('to').that.is.a('string');"," pm.expect(m).to.have.property('messageId').that.is.a('string');"," pm.expect(m.status).to.include.all.keys('groupId', 'groupName', 'id', 'name', 'description');"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"384e5a92-9797-41a9-bba6-b3b628f23b11","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"from\": \"example@vhdmedia.eu\",\n \"destinations\": [\n \"jane.smith@vhdmedia.se\"\n ],\n \"mimeMessage\": \"TUlNRS1WZXJzaW9uOiAxLjANCkZyb206IGV4YW1wbGVAdmhkbWVkaWEuZXUNClRvOiBqYW5lLnNtaXRoQHZoZG1lZGlhLnNlDQpTdWJqZWN0OiBWSEQgQVBJIE1JTUUgdGVzdA0KQ29udGVudC1UeXBlOiB0ZXh0L3BsYWluOyBjaGFyc2V0PVVURi04DQoNClRoaXMgaXMgYSBNSU1FIHRlc3QgZW1haWwgZnJvbSB0aGUgVkhEIEFQSS4=\",\n \"callbackData\": \"DLR callback data\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/email/4/mime","description":"Send an email that you have already built as a complete MIME message, for example when your application produces the message with its own mail library. Use Send email messages (API v4) if you want VHD to build the message from a subject, text, and HTML.
\n\nThe MIME message must be base64-encoded. Build the full message (headers, blank line, body), then base64-encode the whole thing and send it in mimeMessage. The addresses in destinations decide who receives the email; they take precedence over the To header inside the message.
\n
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| messageId | \nString | \nThe ID that uniquely identifies the message sent to a recipient. | \n
\n\n| bulkId | \nString | \nThe ID that uniquely identifies the sent bulk. This filter will enable you to query delivery reports for all the messages using just one request. You will receive a bulkId in the response after sending an email request. If you don't set your own bulkId, unique ID will be generated by our system and returned in the API response. (Optional Field)\") | \n
\n\n| from | \nString | \nThe email address specified in this field takes precedence over the From header in the MIME message. If you leave this field empty, the From address in the MIME message will be used instead. If you provide both values and they are different, their domains must match at the organizational level; otherwise, the request will be rejected. | \n
\n\n| destinations | \nArray | \nA list of recipient email addresses. The email addresses specified in this field takes precedence over the To, CC, and BCC headers in the MIME message. Only the addresses in this list will receive the final email. If you leave this field empty, To, CC, and BCC headers in the MIME message will be used instead. Note: Maximum number of recipients per request is 1000 overall including to, cc and bcc field. | \n
\n\n| mimeMessage | \nString | \nRequired. This field accepts a complete email message serialized in the MIME format, conforming to RFC 5322 and MIME-related standards (RFCs 2045–2047, RFC 2183). The MIME message must be correctly constructed per the following requirements as if it were being sent via traditional SMTP. The entire MIME message (including headers and body) must be base64-encoded before being sent. When using this field, these are the requirements: - The message must consist of a set of header fields, followed by a blank line (CRLF), and then the message body - All required and optional fields must be properly formatted with header-name, colon, and header-value - If any MIME part contains non-7-bit-ASCII data (e.g., UTF-8 text, binaries), that part must be encoded - If your message uses multipart content (attachments, alternative bodies, etc.), each MIME part must contain Content-Type header. For encoded parts, include Content-Transfer-Encoding. For attachments, include a valid Content-Disposition. We also support specifying additional headers in your MIME message, such as List-Unsubscribe, List-Unsubscribe-Post, In-Reply-To, References and Message-ID. | \n
\n\n| intermediateReport | \nBoolean | \nThe real-time Intermediate delivery report that will be sent on your callback server. | \n
\n\n| notifyUrl | \nString | \nThe URL on your callback server on which the Delivery report will be sent. | \n
\n\n| notifyContentType | \nString | \nPreferred Delivery report content type. Can be application/json or application/xml. | \n
\n\n| callbackData | \nString | \nAdditional client data that will be sent on the notifyUrl. | \n
\n\n| trackingUrl | \nString | \nThe URL on your callback server on which the open and click notifications will be sent. See Tracking Notifications for details. | \n
\n\n| clientPriority | \nString | \nAdds a priority rating to this email message. Allowed values are HIGH, STANDARD and LOW. Messages with a higher priority value sent by your account are prioritized over messages with a lower priority value sent by your account. If no priority value is provided, messages will be treated with STANDARD priority by default. | \n
\n\n| applicationId | \nString | \nRequired for application use in a send request for outbound traffic. Returned in notification events. | \n
\n\n| entityId | \nString | \nRequired for entity use in a send request for outbound traffic. Returned in notification events. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| bulkId | \nString | \nThe ID that uniquely identifies a list of message responses. | \n
\n\n| messages | \nArray | \nRequired. List of message response details. | \n
\n\n| messages[].to | \nString | \nRequired. The destination address of the message. | \n
\n\n| messages[].messageId | \nString | \nRequired. The ID that uniquely identifies a message response. | \n
\n\n| messages[].status | \nObject | \nRequired. Indicates the message status. | \n
\n\n| messages[].status.groupId | \nInt | \nRequired. Status group ID. | \n
\n\n| messages[].status.groupName | \nString | \nRequired. Status group name. | \n
\n\n| messages[].status.id | \nInt | \nRequired. Status ID. | \n
\n\n| messages[].status.name | \nString | \nRequired. Status name. | \n
\n\n| messages[].status.description | \nString | \nRequired. Status description. | \n
\n\n
\n
Invalid requests return 400 (for example mimeMessage must be base64 encoded string) and missing or invalid credentials 401, in the format requestError.serviceException with messageId, text, and validationErrors.
\n","urlObject":{"protocol":"https","path":["email","4","mime"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"5c110e19-0e40-44b8-9cf8-11c91b180d2e","name":"Email accepted","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"from\": \"example@vhdmedia.eu\",\n \"destinations\": [\n \"jane.smith@vhdmedia.se\"\n ],\n \"mimeMessage\": \"TUlNRS1WZXJzaW9uOiAxLjANCkZyb206IGV4YW1wbGVAdmhkbWVkaWEuZXUNClRvOiBqYW5lLnNtaXRoQHZoZG1lZGlhLnNlDQpTdWJqZWN0OiBWSEQgQVBJIE1JTUUgdGVzdA0KQ29udGVudC1UeXBlOiB0ZXh0L3BsYWluOyBjaGFyc2V0PVVURi04DQoNClRoaXMgaXMgYSBNSU1FIHRlc3QgZW1haWwgZnJvbSB0aGUgVkhEIEFQSS4=\",\n \"callbackData\": \"DLR callback data\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/email/4/mime"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"zyh6lbgbmuakoy2b96x4\",\n \"messages\": [\n {\n \"to\": \"jane.smith@vhdmedia.se\",\n \"messageId\": \"62tkkkoury1z18udltu7\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\",\n \"description\": \"Message accepted, pending for delivery.\"\n }\n }\n ]\n}"},{"id":"8bde9374-5813-4e35-8dc0-24d1b9fa8a16","name":"Bad request - mimeMessage is not base64","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"from\": \"example@vhdmedia.eu\",\n \"destinations\": [\n \"jane.smith@vhdmedia.se\"\n ],\n \"mimeMessage\": \"not base64\",\n \"callbackData\": \"DLR callback data\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/email/4/mime"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Bad Request\",\n \"validationErrors\": {\n \"mimeMessage\": [\n \"must be base64 encoded string\"\n ]\n }\n }\n }\n}"},{"id":"d4ee2c82-910b-4fdd-9303-2a8697057120","name":"Unauthorized - invalid API key","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"from\": \"example@vhdmedia.eu\",\n \"destinations\": [\n \"jane.smith@vhdmedia.se\"\n ],\n \"mimeMessage\": \"TUlNRS1WZXJzaW9uOiAxLjANCkZyb206IGV4YW1wbGVAdmhkbWVkaWEuZXUNClRvOiBqYW5lLnNtaXRoQHZoZG1lZGlhLnNlDQpTdWJqZWN0OiBWSEQgQVBJIE1JTUUgdGVzdA0KQ29udGVudC1UeXBlOiB0ZXh0L3BsYWluOyBjaGFyc2V0PVVURi04DQoNClRoaXMgaXMgYSBNSU1FIHRlc3QgZW1haWwgZnJvbSB0aGUgVkhEIEFQSS4=\",\n \"callbackData\": \"DLR callback data\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/email/4/mime"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Invalid login details\"\n }\n }\n}"}],"_postman_id":"384e5a92-9797-41a9-bba6-b3b628f23b11"},{"name":"Send fully featured email (API v3)","event":[{"listen":"test","script":{"exec":["// Test if response status code is 200","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","// Parse response body as JSON","var responseBody = pm.response.json();","","// Parse the request body from form-data","var formData = pm.request.body.formdata;","","// Extract the 'from', 'to', 'subject', 'text', and 'html' properties from the form-data","var from, to, subject, text, html;","formData.each(function(item) {"," switch (item.key) {"," case \"from\":"," from = item.value;"," break;"," case \"to\":"," to = item.value;"," break;"," case \"subject\":"," subject = item.value;"," break;"," case \"text\":"," text = item.value;"," break;"," case \"html\":"," html = item.value;"," break;"," }","});","","// Test if 'from' property exists in the form-data and is valid","pm.test(\"From field exists and is a valid email address\", function () {"," pm.expect(from).to.exist;"," pm.expect(from).to.match(/^[\\w-.]+@([\\w-]+\\.)+[\\w-]{2,4}$/);","});","","","// Test if 'subject' property exists in the form-data","pm.test(\"'Subject' field exists and is a string\", function () {"," pm.expect(subject).to.exist;"," pm.expect(subject).to.be.a('string');","});","","// Test if either 'text' or 'html' field exists in the form-data","pm.test(\"At least 'text' or 'html' field exists\", function () {"," pm.expect(text || html).to.exist;"," if (text) {"," pm.expect(text).to.be.a('string');"," }"," if (html) {"," pm.expect(html).to.be.a('string');"," }","});","","// Test if response contains 'messages' array","pm.test(\"Response contains 'messages' array\", function () {"," pm.expect(responseBody).to.have.property('messages').that.is.an('array');","});","","// Test if each message in the 'messages' array contains the expected properties","pm.test(\"Each message contains expected properties\", function () {"," responseBody.messages.forEach(function(message) {"," pm.expect(message).to.have.property('messageId');"," pm.expect(message).to.have.property('to');"," pm.expect(message).to.have.property('status');"," "," var status = message.status;"," pm.expect(status).to.have.property('description');"," pm.expect(status).to.have.property('groupId');"," pm.expect(status).to.have.property('groupName');"," pm.expect(status).to.have.property('id');"," pm.expect(status).to.have.property('name');"," });","});","","// Test if system-assigned bulkId exists in the response","pm.test(\"BulkId exists in the response\", function () {"," pm.expect(responseBody).to.have.property('bulkId');","});",""],"type":"text/javascript","packages":{}}}],"id":"14eaa0bf-924e-4bbc-9e06-2abc9cddb079","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"from","value":"example@vhdmedia.eu","type":"text"},{"key":"to","value":"jane.smith@vhdmedia.se","type":"text","disabled":true},{"key":"to","value":"{ \"to\": \"jane.smith@vhdmedia.se\", \"placeholders\" :{ \"name\": \"Jane\"}}","type":"text"},{"key":"to","value":"{ \"to\": \"tom.smith@vhdmedia.se\", \"placeholders\" :{ \"name\": \"Tom\"}}","type":"text"},{"key":"subject","value":"Sneakers","type":"text"},{"key":"text","value":"Dear {{name}}, this is mail body text with placeholder in body {{ph1}}","type":"text","disabled":true},{"key":"html","value":"Html body
Rich HTML message body.
","type":"text","disabled":true},{"key":"ampHtml","value":"","type":"text","disabled":true},{"key":"templateId","value":"200000000034913","type":"text"},{"key":"attachment","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/Users/johnpaulbabu/Desktop/sample.m4a"],"src":"/Users/johnpaulbabu/Desktop/sample.m4a","disabled":true},{"key":"inlineImage","value":"","type":"text","disabled":true},{"key":"intermediateReport","value":"true","type":"text"},{"key":"notifyUrl","value":"https://www.example.com/email/advanced","type":"text","disabled":true},{"key":"notifyContentType","value":"\"application/json\"","type":"text"},{"key":"callbackData","value":"DLR callback data","type":"text"},{"key":"track","value":"","type":"text","disabled":true},{"key":"trackClicks","value":"","type":"text","disabled":true},{"key":"trackOpens","value":"","type":"text","disabled":true},{"key":"trackingUrl","value":"","type":"text","disabled":true},{"key":"bulkId","value":"customBulkId1","type":"text"},{"key":"messageId","value":"","type":"text","disabled":true},{"key":"replyTo","value":"contact@vhdmedia.se","type":"text","disabled":true},{"key":"defaultPlaceholders","value":"{\"ph1\": \"Success\"}","type":"text","disabled":true},{"key":"sendAt","value":"2023-05-04T16:00:00.085-00:00","type":"text","disabled":true}]},"url":"https://go2.vhdmedia.se/email/3/send","description":"\nPrevious version. New integrations should use Send email messages (API v4) (POST /email/4/messages). This request still works.
\n
\nSend an email or multiple emails to a recipient or multiple recipients with CC/BCC enabled.
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| from | \nstring | \nEmail address with optional sender name.
Note: This field is required if templateId is not present | \n
\n\n| to | \nArray of stings <=1000
Required | \nEmail address of the recipient in a form of To=\"john.smith@somecompany.com\". As optional feature on this field, a specific placeholder can be defined whose value will apply only for this destination. Given To value should look like: To= {\"to\": \"john.smith@somecompany.com\",\"placeholders\": {\"name\": \"John\"}} To= {\"to\": \"alice.grey@somecompany.com\",\"placeholders\": {\"name\": \"Alice\"}}.
Note: Maximum number of recipients per request is 1000 overall including to, cc and bcc field. | \n
\n\n| cc | \nArray of strings <= 1000 | \nCC recipient email address.
Note: Maximum number of recipients per request is 1000 overall including to, cc and bcc field. | \n
\n\n| bcc | \nArray of strings <= 1000 | \nBCC recipient email address.
Note: Maximum number of recipients per request is 1000 overall including to, cc and bcc field. | \n
\n\n| subject | \nstring [ 1 .. 1000 ] | \nMessage subject.
Note: This field is required if templateId is not present. | \n
\n\n| text | \nstring | \nBody of the message. | \n
\n\n| html | \nstring | \nHTML body of the message. If html and text fields are present, the text field will be ignored and html will be delivered as a message body. | \n
\n\n| ampHtml | \nstring | \nAmp HTML body of the message. If ampHtml is present, html is mandatory. Amp HTML is not supported by all the email clients. Please check this link for configuring gmail client https://developers.google.com/gmail/ampemail/. | \n
\n\n| templateId | \ninteger | \nTemplate ID used for generating email content. The template is created over the VHD web interface. If templateId is present, then html and text values are ignored. TemplateId's are the number followed by # on the templates in the web ui.
Note: templateId only supports the value of Broadcast. Content and Flow are not supported. | \n
\n\n| attachment | \nArray of strings | \nFile attachment. | \n
\n\n| inlineImage | \nArray of strings | \nAllows for inserting an image file inside the HTML code of the email by using cid:FILENAME instead of providing an external link to the image. | \n
\n\n| intermediateReport | \nboolean | \nThe real-time Intermediate delivery report that will be sent on your callback server. | \n
\n\n| notifyUrl | \nstring | \nThe URL on your callback server on which the Delivery report will be sent. | \n
\n\n| notifyContentType | \nstring | \nPreferred Delivery report content type. Can be application/json or application/xml. | \n
\n\n| callbackData | \nstring [ 0 .. 4000 ] | \nAdditional client data that will be sent on the notifyUrl. | \n
\n\n| track | \nboolean | \nDefault: true
Enable or disable open and click tracking. Passing true will only enable tracking and the statistics would be visible in the web interface alone. This can be explicitly overridden by trackClicks and trackOpens. | \n
\n\n| trackClicks | \nboolean | \nThis parameter enables or disables track click feature. | \n
\n\n| trackOpens | \nboolean | \nThis parameter enables or disables track open feature. | \n
\n\n| trackingUrl | \nstring | \nThe URL on your callback server on which the open and click notifications will be sent. See Tracking Notifications for details. | \n
\n\n| bulkId | \nstring | \nThe ID uniquely identifies the sent email request. This filter will enable you to query delivery reports for all the messages using just one request. You will receive a bulkId in the response after sending an email request. If you don't set your own bulkId, unique ID will be generated by our system and returned in the API response. (Optional Field) | \n
\n\n| messageId | \nstring | \nThe ID that uniquely identifies the message sent to a recipient. (Optional Field) | \n
\n\n| replyTo | \nstring | \nEmail address to which recipients of the email can reply. | \n
\n\n| defaultPlaceholders | \nstring | \nGeneral placeholder, given in a form of json example: defaultPlaceholders={\"ph1\": \"Success\"}, which will replace given key {{ph1}} with given value Success anywhere in the email (subject, text, html...). In case of more destinations in To field, this placeholder will resolve the same value for key ph1. | \n
\n\n| preserveRecipients | \nboolean | \nDefault: false
If set to true, the to recipients will see the list of all other recipients to get the email and the response will return only one messageId. Otherwise, each recipient will see just their own email and the response will return a unique messageId for each email recipient. | \n
\n\n| sendAt | \nstring | \nTo schedule message at a given time. Time provided should be in UTC in the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ and cannot exceed 30 days in the future. | \n
\n\n| landingPagePlaceholders | \nstring | \nPersonalize opt out landing page by inserting placeholders. Insert placeholder or tag while designing landing page. | \n
\n\n| landingPageId | \nstring | \nThe ID of an opt out landing page to be used and displayed once an end user clicks the unsubscribe link. If not present, default opt out landing page will be displayed. Create a landing page in your VHD account and use its ID, e.g., #1_23456. | \n
\n\n| templateLanguageVersion | \nstring | \nDefault: \"1\"
Specifies template language version that will be used in the current message template. Use version 1 for previous version of template language. Use version 2 for features of the new template language. If not present version 1 will be used as default version. | \n
\n\n| applicationId | \nstring | \nRequired for application use in a send request for outbound traffic. Returned in notification events. | \n
\n\n| entityId | \nstring | \nRequired for entity use in a send request for outbound traffic. Returned in notification events. | \n
\n\n
\n
Responses (200 Successful Request)
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| bulkId | \nstring | \nThe ID that uniquely identifies a list of message responses. | \n
\n\nmessages
Array [
to
messageId
status
{
groupId
groupName
id
name
description
} | \nArray of objects
string
string
object
integer
string
integer
string
string | \nList of message response details.
The destination address of the message.
The ID that uniquely identifies a message response.
Indicates the message status.
Status group ID.
Status group name.
Status ID.
Status name
Status description. | \n
\n\n
\n
Error object
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\nrequestError
{
serviceException
{
messageId,
text,
validationErrors {
property name*
}
}
} | \nobject
object
string
string
object
Array of strings | \nIdentifier of the error.
Detailed error description.
Validation errors. | \n
\n\n| groupName | \nstring | \nError group name. | \n
\n\n| id | \nint | \nError ID. | \n
\n\n| name | \nstring | \nError name. | \n
\n\n| description | \nstring | \nHuman readable description of the error. | \n
\n\n| permanent | \nboolean | \nIndicates whether the error is permanent. | \n
\n\n
\n
Additional parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| trackingPixelPosition | \nString | \nThis parameter specifies the position of the open tracking pixel within the email content. Allowed values are TOP and BOTTOM. If no value is provided, the default is TOP. | \n
\n\n| campaignReferenceId | \nString | \nThe ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns. | \n
\n\n| clientPriority | \nString | \nAdds a priority rating to this email message. Allowed values are HIGH, STANDARD and LOW. Messages with a higher priority value sent by your account are prioritized over messages with a lower priority value sent by your account. If no priority value is provided, messages will be treated with STANDARD priority by default. | \n
\n\n| headers | \nString | \nAdditional email headers for customization that can be provided in a form of JSON. For example, you can override List-Unsubscribe header and provide your own custom one: headers={\"List-Unsubscribe\": \"your unsubscribe link\", \"X-CustomHeader\": \"Header value\"}. There are a few exceptions of headers which are not adjustable through this option: To, Cc, Bcc, Subject, Content-Type, DKIM-Signature, Content-Transfer-Encoding, Return-Path, MIME-Version | \n
\n\n| ipPoolId | \nString | \nThe ID of the IP Pool which will be used for sending. | \n
\n\n| skipPassiveStorage | \nBoolean | \nSet to true to skip passive email storage (long-term storage used for compliance, legal, or audit purposes). If false or not set, the account-level setting is used. | \n
\n\n| skipActiveStorage | \nBoolean | \nSet to true to skip active email storage (short-term storage used for troubleshooting or support). If false or not set, the account-level setting is used. | \n
\n\n
\n
Html body
Rich HTML message body.
","type":"text"},{"key":"attachment","value":"","type":"text","disabled":true},{"key":"bulkId","value":"customBulkId1","type":"text"},{"key":"intermediateReport","value":"true","type":"text"},{"key":"defaultPlaceholders","value":"{\"ph1\": \"Success\"}","type":"text"},{"key":"notifyUrl","value":"https://www.example.com/email/advanced","type":"text","disabled":true},{"key":"notifyContentType","value":"\"application/json\"","type":"text","disabled":true},{"key":"callbackData","value":"DLR callback data","type":"text"},{"key":"text","value":"Hello World","type":"text","disabled":true},{"key":"text","value":"Dear {{name}}, this is mail body text with placeholder in body {{ph1}} ","type":"text","disabled":true}]},"url":"https://go2.vhdmedia.se/email/3/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Date","value":"Mon, 27 Mar 2023 09:53:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Server","value":"SMS API"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"X-Request-Id","value":"1679910802194990226"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"customBulkId1\",\n \"messages\": [\n {\n \"to\": \"jane.smith@vhdmedia.se\",\n \"messageId\": \"n48fjq86ugsccm4pzjxr\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\",\n \"description\": \"Message accepted, pending for delivery.\"\n }\n }\n ]\n}"},{"id":"875e22d9-d290-4a11-96c8-ce339c097e4b","name":"Fully featured email","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"from","value":"example@vhdmedia.se","type":"text"},{"key":"to","value":"jane.smith@vhdmedia.se","type":"text","disabled":true},{"key":"to","value":"{ \"to\": \"jane.smith@vhdmedia.se\", \"placeholders\" :{ \"name\": \"Jane\"}}","type":"text"},{"key":"to","value":"{ \"to\": \"tom.smith@vhdmedia.se\", \"placeholders\" :{ \"name\": \"Tom\"}}","type":"text"},{"key":"cc","value":"tom.smith@vhdmedia.se","type":"text","disabled":true},{"key":"replyTo","value":"contact@vhdmedia.se","type":"text"},{"key":"html","value":"Html body
Rich HTML message body.
","type":"text","disabled":true},{"key":"attachment","type":"file","src":"/Users/johnpaulbabu/Desktop/sample.m4a"},{"key":"bulkId","value":"customBulkId1","type":"text"},{"key":"intermediateReport","value":"true","type":"text"},{"key":"defaultPlaceholders","value":"{\"ph1\": \"Success\"}","type":"text"},{"key":"notifyUrl","value":"https://www.example.com/email/advanced","type":"text","disabled":true},{"key":"notifyContentType","value":"\"application/json\"","type":"text"},{"key":"callbackData","value":"DLR callback data","type":"text"},{"key":"subject","value":"Hello World","type":"text"},{"key":"text","value":"Dear {{name}}, this is mail body text with placeholder in body {{ph1}}","type":"text"}]},"url":"https://go2.vhdmedia.se/email/3/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Date","value":"Wed, 19 Apr 2023 08:51:28 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Server","value":"SMS API"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"X-Request-Id","value":"1681894288478348838"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"customBulkId1\",\n \"messages\": [\n {\n \"to\": \"tom.smith@vhdmedia.se\",\n \"messageId\": \"78mz86sf6p4ktg1xnyxf\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\",\n \"description\": \"Message accepted, pending for delivery.\"\n }\n },\n {\n \"to\": \"jane.smith@vhdmedia.se\",\n \"messageId\": \"43bsnicpxv1n4m94nrz1\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\",\n \"description\": \"Message accepted, pending for delivery.\"\n }\n }\n ]\n}"},{"id":"92e335f8-8c36-48ae-b595-fc1ef3a400b4","name":"Schedule Email","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"from","value":"example@vhdmedia.se","type":"text"},{"key":"to","value":"jane.smith@vhdmedia.se","type":"text","disabled":true},{"key":"to","value":"{ \"to\": \"jane.smith@vhdmedia.se\", \"placeholders\" :{ \"name\": \"Jane\"}}","type":"text"},{"key":"to","value":"{ \"to\": \"tom.smith@vhdmedia.se\", \"placeholders\" :{ \"name\": \"Tom\"}}","type":"text","disabled":true},{"key":"cc","value":"tom.smith@vhdmedia.se","type":"text","disabled":true},{"key":"replyTo","value":"contact@vhdmedia.se","type":"text"},{"key":"html","value":"Html body
Rich HTML message body.
","type":"text","disabled":true},{"key":"attachment","type":"file","src":"/Users/johnpaulbabu/Desktop/sample.m4a"},{"key":"bulkId","value":"customBulkId1","type":"text"},{"key":"intermediateReport","value":"true","type":"text"},{"key":"defaultPlaceholders","value":"{\"ph1\": \"Success\"}","type":"text"},{"key":"notifyUrl","value":"https://www.example.com/email/advanced","type":"text","disabled":true},{"key":"notifyContentType","value":"\"application/json\"","type":"text"},{"key":"callbackData","value":"DLR callback data","type":"text"},{"key":"subject","value":"Hello World","type":"text"},{"key":"text","value":"Dear {{name}}, this is mail body text with placeholder in body {{ph1}}","type":"text"},{"key":"sendAt","value":"2023-05-04T16:00:00.085-00:00","type":"text"}]},"url":"https://go2.vhdmedia.se/email/3/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"vary","value":"Access-Control-Request-Method"},{"key":"vary","value":"Access-Control-Request-Headers"},{"key":"date","value":"Thu, 04 May 2023 14:51:52 GMT"},{"key":"content-type","value":"application/json;charset=utf-8"},{"key":"server","value":"SMS API"},{"key":"transfer-encoding","value":"chunked"},{"key":"x-request-id","value":"1683211912739998666"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"customBulkId1\",\n \"messages\": [\n {\n \"to\": \"jane.smith@vhdmedia.se\",\n \"messageId\": \"qqukgp6o5raxmqhqy2u3\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\",\n \"description\": \"Message accepted, pending for delivery.\"\n }\n }\n ]\n}"},{"id":"fe255766-634f-42b7-a914-9143351a3ea9","name":"Email template","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"from","value":"example@vhdmedia.eu","type":"text"},{"key":"to","value":"jane.smith@vhdmedia.se","type":"text"},{"key":"to","value":"{ \"to\": \"jane.smith@vhdmedia.se\", \"placeholders\" :{ \"name\": \"Jane\"}}","type":"text","disabled":true},{"key":"to","value":"{ \"to\": \"tom.smith@vhdmedia.se\", \"placeholders\" :{ \"name\": \"Tom\"}}","type":"text","disabled":true},{"key":"subject","value":"Sneakers","type":"text"},{"key":"templateId","value":"200000000034913","type":"text"},{"key":"intermediateReport","value":"true","type":"text"},{"key":"notifyContentType","value":"\"application/json\"","type":"text"},{"key":"callbackData","value":"DLR callback data","type":"text"},{"key":"bulkId","value":"customBulkId1","type":"text"}]},"url":"https://go2.vhdmedia.se/email/3/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"vary","value":"Access-Control-Request-Method"},{"key":"vary","value":"Access-Control-Request-Headers"},{"key":"date","value":"Sun, 03 Dec 2023 15:13:13 GMT"},{"key":"content-type","value":"application/json;charset=utf-8"},{"key":"server","value":"SMS API"},{"key":"transfer-encoding","value":"chunked"},{"key":"x-request-id","value":"1701616393540777838"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"customBulkId1\",\n \"messages\": [\n {\n \"to\": \"fredrik@vhdmedia.se\",\n \"messageId\": \"hp421btu9lmxhi61osgn\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\",\n \"description\": \"Message accepted, pending for delivery.\"\n }\n }\n ]\n}"}],"_postman_id":"14eaa0bf-924e-4bbc-9e06-2abc9cddb079"}],"id":"a2c527cc-4a28-46f6-8144-97333dec6197","description":"Send emails with text, HTML, templates, attachments and placeholders. Use Send email messages (API v4) for new integrations. The v3 request is kept for existing ones.
\n","_postman_id":"a2c527cc-4a28-46f6-8144-97333dec6197"},{"name":"LOGS AND REPORTS","item":[{"name":"Email delivery reports (API v4, latest)","event":[{"listen":"test","script":{"exec":["// Tests for Email delivery reports (API v4).","pm.test(\"Status code is 200\", function () { pm.response.to.have.status(200); });","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var res;","pm.test(\"Response body is valid JSON\", function () { res = pm.response.json(); });","","var reports = [];","pm.test(\"Response contains the reports array\", function () {"," pm.expect(res.results || res.emailResults, \"results (or emailResults) array\").to.be.an('array');"," reports = res.results || res.emailResults;","});","","pm.test(\"Each report has the documented fields\", function () {"," reports.forEach(function (r) {"," ['bulkId', 'messageId', 'to', 'sender', 'sentAt', 'doneAt', 'messageCount', 'status'].forEach(function (k) {"," pm.expect(r, 'missing field ' + k).to.have.property(k);"," });"," pm.expect(r.status.groupName).to.be.oneOf(['ACCEPTED', 'PENDING', 'UNDELIVERABLE', 'DELIVERED', 'EXPIRED', 'REJECTED']);"," if (r.error) {"," pm.expect(r.error.groupName).to.be.oneOf(['OK', 'HANDSET_ERRORS', 'USER_ERRORS', 'OPERATOR_ERRORS']);"," }"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"d6dc46aa-efe4-4506-b045-8f83a96b2f67","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/email/4/reports","description":"Get delivery reports for sent emails when you cannot receive them in real time on your own server. This is the current version of the email delivery reports API.
\n\nEach report is returned only once. A report you have already fetched is not returned again; if a message status changes later, the next request returns a new report for the updated status. Running this request consumes the reports it returns. Reports from the last 48 hours are available.
\n
\nQuery parameters
\nAll parameters are optional.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| bulkId | \nString | \nThe ID that uniquely identifies the request. | \n
\n\n| messageId | \nString | \nThe ID that uniquely identifies the message sent. | \n
\n\n| limit | \nInt | \nMaximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h. | \n
\n\n| entityId | \nString | \nEntity id used to send the message. For more details, see our documentation. | \n
\n\n| applicationId | \nString | \nApplication id used to send the message. For more details, see our documentation. | \n
\n\n| campaignReferenceId | \nString | \nID of a campaign that was sent in the message. | \n
\n\n
\n
On success the response is 200 OK. The reports are in the results array, one per message. For compatibility the same reports can also be returned in emailResults.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \nArray | \nRequired. Collection of email delivery reports, one per every message. | \n
\n\n| results[].bulkId | \nString | \nUnique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. | \n
\n\n| results[].price | \nObject | \nSent message price. | \n
\n\n| results[].price.pricePerMessage | \nNumber | \nPrice per one message. | \n
\n\n| results[].price.currency | \nString | \nThe currency in which the price is expressed. | \n
\n\n| results[].status | \nObject | \nIndicates the status of the message and how to recover from an error should there be any. | \n
\n\n| results[].status.groupId | \nInt | \nStatus group ID. | \n
\n\n| results[].status.groupName | \nString | \nStatus group name that describes which category the status code belongs to, i.e., PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED. One of: ACCEPTED, PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED. | \n
\n\n| results[].status.id | \nInt | \nStatus code ID. | \n
\n\n| results[].status.name | \nString | \nStatus code name. | \n
\n\n| results[].status.description | \nString | \nHuman-readable description of the status. | \n
\n\n| results[].status.action | \nString | \nAction to take to recover from the error. | \n
\n\n| results[].error | \nObject | \nIndicates whether an error occurred during the query execution. | \n
\n\n| results[].error.groupId | \nInt | \nError group ID. | \n
\n\n| results[].error.groupName | \nString | \nError group name that describes which category the error code belongs to. One of: OK, HANDSET_ERRORS, USER_ERRORS, OPERATOR_ERRORS. | \n
\n\n| results[].error.id | \nInt | \nError ID. | \n
\n\n| results[].error.name | \nString | \nError name. | \n
\n\n| results[].error.description | \nString | \nHuman-readable description of the error. | \n
\n\n| results[].error.permanent | \nBoolean | \nIndicates whether the error is recoverable or not. | \n
\n\n| results[].messageId | \nString | \nUnique message ID. | \n
\n\n| results[].to | \nString | \nMessage destination address. | \n
\n\n| results[].sender | \nString | \nThe sender ID which can be alphanumeric or numeric (e.g., CompanyName). | \n
\n\n| results[].sentAt | \nString | \nDate and time when the message was sent. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ. | \n
\n\n| results[].doneAt | \nString | \nDate and time when the VHD services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ. | \n
\n\n| results[].messageCount | \nInt | \nThe number of sent messages. | \n
\n\n| results[].callbackData | \nString | \nCallback data sent through ‛callbackData‛ field when sending message. | \n
\n\n| results[].platform | \nObject | \nPlatform options. For more details, see documentation. | \n
\n\n| results[].platform.entityId | \nString | \nUsed when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the documentation. | \n
\n\n| results[].platform.applicationId | \nString | \nUsed when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the documentation. | \n
\n\n| results[].campaignReferenceId | \nString | \nID of a campaign that was sent in the message. | \n
\n\n| results[].attemptCount | \nInt | \nNumber of times delivery was attempted for the email. | \n
\n\n| results[].timeToFirstAttempt | \nInt | \nThis is the time in milliseconds between accepting the request and making the first delivery attempt to the destination. | \n
\n\n
\n
Errors use the common format: errorCode, description, action, violations[]. Status codes: 401 missing or invalid credentials, 403 insufficient permissions, 500 server error.
\n","urlObject":{"protocol":"https","path":["email","4","reports"],"host":["go2","vhdmedia","se"],"query":[{"disabled":true,"description":{"content":"The ID that uniquely identifies the request.
\n","type":"text/plain"},"key":"bulkId","value":""},{"disabled":true,"description":{"content":"The ID that uniquely identifies the message sent.
\n","type":"text/plain"},"key":"messageId","value":""},{"disabled":true,"description":{"content":"Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h.
\n","type":"text/plain"},"key":"limit","value":"50"},{"disabled":true,"description":{"content":"Entity id used to send the message. For more details, see our documentation.
\n","type":"text/plain"},"key":"entityId","value":""},{"disabled":true,"description":{"content":"Application id used to send the message. For more details, see our documentation.
\n","type":"text/plain"},"key":"applicationId","value":""},{"disabled":true,"description":{"content":"ID of a campaign that was sent in the message.
\n","type":"text/plain"},"key":"campaignReferenceId","value":""}],"variable":[]}},"response":[{"id":"342d411f-9bc2-452e-90ef-87fb8292f5e7","name":"Email delivery reports","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/email/4/reports","protocol":"https","host":["go2","vhdmedia","se"],"path":["email","4","reports"],"query":[{"key":"bulkId","value":"","description":"The ID that uniquely identifies the request.","disabled":true},{"key":"messageId","value":"","description":"The ID that uniquely identifies the message sent.","disabled":true},{"key":"limit","value":"50","description":"Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h.","disabled":true},{"key":"entityId","value":"","description":"Entity id used to send the message. For more details, see our documentation.","disabled":true},{"key":"applicationId","value":"","description":"Application id used to send the message. For more details, see our documentation.","disabled":true},{"key":"campaignReferenceId","value":"","description":"ID of a campaign that was sent in the message.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"bulkId\": \"x7kferxomzc2nlihlouz\",\n \"price\": {\n \"pricePerMessage\": 0.0001,\n \"currency\": \"EUR\"\n },\n \"status\": {\n \"groupId\": 3,\n \"groupName\": \"DELIVERED\",\n \"id\": 5,\n \"name\": \"DELIVERED_TO_HANDSET\",\n \"description\": \"Message delivered to handset\"\n },\n \"error\": {\n \"groupId\": 0,\n \"groupName\": \"OK\",\n \"id\": 0,\n \"name\": \"NO_ERROR\",\n \"description\": \"No Error\",\n \"permanent\": false\n },\n \"messageId\": \"claxbdvqvssvnc12hypo\",\n \"to\": \"jane.smith@vhdmedia.se\",\n \"sender\": \"example@vhdmedia.eu\",\n \"sentAt\": \"2026-10-18T09:00:00.000+0000\",\n \"doneAt\": \"2026-10-18T09:00:05.000+0000\",\n \"messageCount\": 1,\n \"callbackData\": \"DLR callback data\",\n \"platform\": {\n \"applicationId\": \"default\"\n },\n \"campaignReferenceId\": \"my-campaign\",\n \"attemptCount\": 1,\n \"timeToFirstAttempt\": 1200\n }\n ]\n}"},{"id":"94862aa4-ec0f-4dd8-8e69-6d77eb0295a8","name":"Unauthorized - invalid API key","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/email/4/reports","protocol":"https","host":["go2","vhdmedia","se"],"path":["email","4","reports"],"query":[{"key":"bulkId","value":"","description":"The ID that uniquely identifies the request.","disabled":true},{"key":"messageId","value":"","description":"The ID that uniquely identifies the message sent.","disabled":true},{"key":"limit","value":"50","description":"Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h.","disabled":true},{"key":"entityId","value":"","description":"Entity id used to send the message. For more details, see our documentation.","disabled":true},{"key":"applicationId","value":"","description":"Application id used to send the message. For more details, see our documentation.","disabled":true},{"key":"campaignReferenceId","value":"","description":"ID of a campaign that was sent in the message.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E401\",\n \"description\": \"The request lacks valid authentication credentials for the requested resource.\",\n \"action\": \"Check the resources and adjust authentication credentials.\",\n \"violations\": [],\n \"resources\": []\n}"}],"_postman_id":"d6dc46aa-efe4-4506-b045-8f83a96b2f67"},{"name":"Email message logs (API v4, latest)","event":[{"listen":"test","script":{"exec":["// Tests for Email message logs (API v4).","pm.test(\"Status code is 200\", function () { pm.response.to.have.status(200); });","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var res;","pm.test(\"Response body is valid JSON\", function () { res = pm.response.json(); });","","pm.test(\"Response contains 'results' array\", function () {"," pm.expect(res).to.have.property('results').that.is.an('array');","});","","pm.test(\"Each log entry has the documented fields\", function () {"," res.results.forEach(function (r) {"," ['sender', 'destination', 'bulkId', 'messageId', 'sentAt', 'messageCount', 'status'].forEach(function (k) {"," pm.expect(r, 'missing field ' + k).to.have.property(k);"," });"," pm.expect(r.status).to.include.all.keys('groupId', 'groupName', 'id', 'name', 'description');"," pm.expect(r.status.groupName).to.be.oneOf(['ACCEPTED', 'PENDING', 'UNDELIVERABLE', 'DELIVERED', 'EXPIRED', 'REJECTED']);"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"fe9c1c12-daaf-4ad3-a30e-552efb6a9328","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/email/4/logs","description":"Get logs of sent emails, for example to show them in a user interface. This is the current version of the email logs API. Logs from the last 48 hours are available.
\nQuery parameters
\nAll parameters are optional.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| sender | \nString | \nThe sender ID which can be alphanumeric or numeric. | \n
\n\n| destination | \nString | \nMessage destination address. | \n
\n\n| bulkId | \nArray | \nUnique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters. | \n
\n\n| messageId | \nArray | \nUnique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters. | \n
\n\n| generalStatus | \nString | \nOne of: ACCEPTED, PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED. | \n
\n\n| sentSince | \nString | \nThe logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ. | \n
\n\n| sentUntil | \nString | \nThe logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ. | \n
\n\n| limit | \nInt | \nMaximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h. | \n
\n\n| entityId | \nString | \nEntity id used to send the message. For more details, see our documentation. | \n
\n\n| applicationId | \nString | \nApplication id used to send the message. For more details, see our documentation. | \n
\n\n| campaignReferenceId | \nArray | \nID of a campaign that was sent in the message. May contain multiple comma-separated values. | \n
\n\n| useCursor | \nBoolean | \nFlag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs. | \n
\n\n| cursor | \nString | \nValue which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the nextCursor value returned from the previous response to continue fetching data. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \nArray | \nAn array of message log results, one object per each message log entry. | \n
\n\n| results[].text | \nString | \nMessage text. | \n
\n\n| results[].sender | \nString | \nThe sender ID which can be alphanumeric or numeric. | \n
\n\n| results[].destination | \nString | \nMessage destination address. | \n
\n\n| results[].bulkId | \nString | \nUnique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. | \n
\n\n| results[].messageId | \nString | \nUnique message ID for which a log is requested. | \n
\n\n| results[].sentAt | \nString | \nDate and time when the message was sent. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ. | \n
\n\n| results[].doneAt | \nString | \nDate and time when the VHD services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ. | \n
\n\n| results[].messageCount | \nInt | \nThe number of messages content was split to. | \n
\n\n| results[].price | \nObject | \nSent message price. | \n
\n\n| results[].price.pricePerMessage | \nNumber | \nPrice per one message. | \n
\n\n| results[].price.currency | \nString | \nThe currency in which the price is expressed. | \n
\n\n| results[].status | \nObject | \nIndicates the status of the message and how to recover from an error should there be any. | \n
\n\n| results[].status.groupId | \nInt | \nStatus group ID. | \n
\n\n| results[].status.groupName | \nString | \nStatus group name that describes which category the status code belongs to, i.e., PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED. One of: ACCEPTED, PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED. | \n
\n\n| results[].status.id | \nInt | \nStatus code ID. | \n
\n\n| results[].status.name | \nString | \nStatus code name. | \n
\n\n| results[].status.description | \nString | \nHuman-readable description of the status. | \n
\n\n| results[].status.action | \nString | \nAction to take to recover from the error. | \n
\n\n| results[].error | \nObject | \nIndicates whether an error occurred during the query execution. | \n
\n\n| results[].error.groupId | \nInt | \nError group ID. | \n
\n\n| results[].error.groupName | \nString | \nError group name that describes which category the error code belongs to. One of: OK, HANDSET_ERRORS, USER_ERRORS, OPERATOR_ERRORS. | \n
\n\n| results[].error.id | \nInt | \nError ID. | \n
\n\n| results[].error.name | \nString | \nError name. | \n
\n\n| results[].error.description | \nString | \nHuman-readable description of the error. | \n
\n\n| results[].error.permanent | \nBoolean | \nIndicates whether the error is recoverable or not. | \n
\n\n| results[].platform | \nObject | \nPlatform options. For more details, see documentation. | \n
\n\n| results[].platform.entityId | \nString | \nUsed when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the documentation. | \n
\n\n| results[].platform.applicationId | \nString | \nUsed when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the documentation. | \n
\n\n| results[].campaignReferenceId | \nString | \nID of a campaign that was sent in the message. | \n
\n\n| cursor | \nObject | \nCursor information. | \n
\n\n| cursor.limit | \nInt | \nRequested limit. | \n
\n\n| cursor.nextCursor | \nString | \nThe cursor value you will use in your next request to fetch the subsequent set of results. | \n
\n\n
\n
Errors use the common format: errorCode, description, action, violations[]. Status codes: 401 missing or invalid credentials, 403 insufficient permissions, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["email","4","logs"],"host":["go2","vhdmedia","se"],"query":[{"disabled":true,"description":{"content":"The sender ID which can be alphanumeric or numeric.
\n","type":"text/plain"},"key":"sender","value":""},{"disabled":true,"description":{"content":"Message destination address.
\n","type":"text/plain"},"key":"destination","value":""},{"disabled":true,"description":{"content":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.
\n","type":"text/plain"},"key":"bulkId","value":""},{"disabled":true,"description":{"content":"Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.
\n","type":"text/plain"},"key":"messageId","value":""},{"disabled":true,"description":{"content":"generalStatus
\n","type":"text/plain"},"key":"generalStatus","value":"DELIVERED"},{"disabled":true,"description":{"content":"The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
\n","type":"text/plain"},"key":"sentSince","value":""},{"disabled":true,"description":{"content":"The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
\n","type":"text/plain"},"key":"sentUntil","value":""},{"disabled":true,"description":{"content":"Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.
\n","type":"text/plain"},"key":"limit","value":"50"},{"disabled":true,"description":{"content":"Entity id used to send the message. For more details, see our documentation.
\n","type":"text/plain"},"key":"entityId","value":""},{"disabled":true,"description":{"content":"Application id used to send the message. For more details, see our documentation.
\n","type":"text/plain"},"key":"applicationId","value":""},{"disabled":true,"description":{"content":"ID of a campaign that was sent in the message. May contain multiple comma-separated values.
\n","type":"text/plain"},"key":"campaignReferenceId","value":""},{"disabled":true,"description":{"content":"Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.
\n","type":"text/plain"},"key":"useCursor","value":"true"},{"disabled":true,"description":{"content":"Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the nextCursor value returned from the previous response to continue fetching data.
\n","type":"text/plain"},"key":"cursor","value":""}],"variable":[]}},"response":[{"id":"97b55ba5-db7f-4b15-9391-911c60d7ce52","name":"Email message logs","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/email/4/logs","protocol":"https","host":["go2","vhdmedia","se"],"path":["email","4","logs"],"query":[{"key":"sender","value":"","description":"The sender ID which can be alphanumeric or numeric.","disabled":true},{"key":"destination","value":"","description":"Message destination address.","disabled":true},{"key":"bulkId","value":"","description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.","disabled":true},{"key":"messageId","value":"","description":"Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.","disabled":true},{"key":"generalStatus","value":"DELIVERED","description":"generalStatus","disabled":true},{"key":"sentSince","value":"","description":"The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.","disabled":true},{"key":"sentUntil","value":"","description":"The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.","disabled":true},{"key":"limit","value":"50","description":"Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.","disabled":true},{"key":"entityId","value":"","description":"Entity id used to send the message. For more details, see our documentation.","disabled":true},{"key":"applicationId","value":"","description":"Application id used to send the message. For more details, see our documentation.","disabled":true},{"key":"campaignReferenceId","value":"","description":"ID of a campaign that was sent in the message. May contain multiple comma-separated values.","disabled":true},{"key":"useCursor","value":"true","description":"Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.","disabled":true},{"key":"cursor","value":"","description":"Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"text\": \"Dear Jane, this is a test email from the VHD API.\",\n \"sender\": \"example@vhdmedia.eu\",\n \"destination\": \"jane.smith@vhdmedia.se\",\n \"bulkId\": \"x7kferxomzc2nlihlouz\",\n \"messageId\": \"claxbdvqvssvnc12hypo\",\n \"sentAt\": \"2026-10-18T09:00:00.000+0000\",\n \"doneAt\": \"2026-10-18T09:00:05.000+0000\",\n \"messageCount\": 1,\n \"price\": {\n \"pricePerMessage\": 0.0001,\n \"currency\": \"EUR\"\n },\n \"status\": {\n \"groupId\": 3,\n \"groupName\": \"DELIVERED\",\n \"id\": 5,\n \"name\": \"DELIVERED_TO_HANDSET\",\n \"description\": \"Message delivered to handset\"\n },\n \"error\": {\n \"groupId\": 0,\n \"groupName\": \"OK\",\n \"id\": 0,\n \"name\": \"NO_ERROR\",\n \"description\": \"No Error\",\n \"permanent\": false\n },\n \"platform\": {\n \"applicationId\": \"default\"\n },\n \"campaignReferenceId\": \"my-campaign\"\n }\n ]\n}"},{"id":"18061e79-e73d-402b-abe4-f9ca0b3229eb","name":"Unauthorized - invalid API key","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/email/4/logs","protocol":"https","host":["go2","vhdmedia","se"],"path":["email","4","logs"],"query":[{"key":"sender","value":"","description":"The sender ID which can be alphanumeric or numeric.","disabled":true},{"key":"destination","value":"","description":"Message destination address.","disabled":true},{"key":"bulkId","value":"","description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.","disabled":true},{"key":"messageId","value":"","description":"Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.","disabled":true},{"key":"generalStatus","value":"DELIVERED","description":"generalStatus","disabled":true},{"key":"sentSince","value":"","description":"The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.","disabled":true},{"key":"sentUntil","value":"","description":"The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.","disabled":true},{"key":"limit","value":"50","description":"Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.","disabled":true},{"key":"entityId","value":"","description":"Entity id used to send the message. For more details, see our documentation.","disabled":true},{"key":"applicationId","value":"","description":"Application id used to send the message. For more details, see our documentation.","disabled":true},{"key":"campaignReferenceId","value":"","description":"ID of a campaign that was sent in the message. May contain multiple comma-separated values.","disabled":true},{"key":"useCursor","value":"true","description":"Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.","disabled":true},{"key":"cursor","value":"","description":"Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E401\",\n \"description\": \"The request lacks valid authentication credentials for the requested resource.\",\n \"action\": \"Check the resources and adjust authentication credentials.\",\n \"violations\": [],\n \"resources\": []\n}"}],"_postman_id":"fe9c1c12-daaf-4ad3-a30e-552efb6a9328"},{"name":"Email delivery reports (API v1)","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"results\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});","","pm.test(\"'results' is an array\", function () {"," pm.expect(responseBody[\"results\"]).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"1c107353-9c45-411c-b888-d0915034caad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"bulkId\": \"customBulkId1\",\n \"messageId\": \"n48fjq86ugsccm4pzjxr\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/email/1/reports","description":"\nPrevious version (v1). New integrations should use Email delivery reports (API v4) (GET /email/4/reports). This request still works.
\n
\nREQUEST RATE LIMIT:
\n1000 requests / second (per account)
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| bulkId | \nString | \nBulk ID for which report is requested. | \n
\n\n| messageId | \nString | \nThe ID that uniquely identifies the sent email | \n
\n\n| limit | \nInteger | \nMaximum number of reports | \n
\n\n
\n
On success, response header HTTP status code will be 200 OK and delivery reports will be returned in the response body.
\nIf you try to send a message without authorization, you will get a response with HTTP status code 401 Unauthorized.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \nSentEmailReport | \nCollection of reports, one per e-mail. | \n
\n\n
\n
SentEmailReport
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| messageId | \nString | \nMessage ID. | \n
\n\n| to | \nString | \nDestination address. | \n
\n\n| sentAt | \nDate | \nTells when the e-mail was sent. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ. | \n
\n\n| doneAt | \nDate | \nTells when the e-mail was finished processing by us(ie. delivered to destination) | \n
\n\n| messageCount | \nInt | \nHow many parts the message was split into. Always will be 1 for e-mail. | \n
\n\n| price | \nPrice | \nSent e-mail price. | \n
\n\n| status | \nStatus | \nIndicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status. | \n
\n\n| error | \nError | \nIndicates whether any error occurred during query execution. | \n
\n\n
\n
Price
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| pricePerMessage | \nBigDecimal | \nPrice per one Email. | \n
\n\n| currency | \nString | \nThe currency in which the price is expressed. | \n
\n\n
\n
Status
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| groupId | \nInt | \nStatus group ID | \n
\n\n| groupName | \nString | \nStatus group name. | \n
\n\n| id | \nInt | \nStatus ID | \n
\n\n| name | \nString | \nStatus name. | \n
\n\n| description | \nString | \nHuman readable description of the status. | \n
\n\n| action | \nString | \nAction that should be taken to eliminate the error. | \n
\n\n
\n
Error
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| groupId | \nInt | \nError group ID | \n
\n\n| groupName | \nString | \nError group name | \n
\n\n| id | \nInt | \nError ID | \n
\n\n| name | \nString | \nError name | \n
\n\n| description | \nString | \nHuman-readable description of the error. | \n
\n\n| permanent | \nBoolean | \nTells if the error is permanent | \n
\n\n
\n
Additional query parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| campaignReferenceId | \nString | \nThe ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns. | \n
\n\n| applicationId | \nString | \nApplication identifier used for filtering. | \n
\n\n| entityId | \nString | \nEntity identifier used for filtering. | \n
\n\n
\n
Additional response fields
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results[].attemptCount | \nInt | \nNumber of times delivery was attempted for the email. | \n
\n\n| results[].timeToFirstAttempt | \nInt | \nThis is the time in milliseconds between accepting the request and making the first delivery attempt to the destination. | \n
\n\n
\n
\nPrevious version (v1). New integrations should use Email message logs (API v4) (GET /email/4/logs). This request still works.
\n
\nREQUEST RATE LIMIT: 1000 requests/second (per account)
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| bulkId | \nString | \nBulk ID for which report is requested. | \n
\n\n| messageId | \nString | \nThe ID that uniquely identifies the sent email | \n
\n\n| limit | \nInteger | \nMaximum number of reports | \n
\n\n| from | \nString | \nThe recipient email address. | \n
\n\n| to | \nString | \nThe recipient email address. | \n
\n\n| generalStatus | \nString | \nBulk ID that uniquely identifies the request. | \n
\n\n| sentSince | \nString | \nTells when the email was initiated. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ. | \n
\n\n| sentUntil | \nString | \nTells when the email was initiated. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ. | \n
\n\n| limit | \nInteger | \nMaximum number of logs | \n
\n\n
\n
None of the query parameters is mandatory for this request. For filtering results, any combination of parameters can be used. Some examples are shown below.
\n\nIf successful, the response header HTTP status code will be 200 OK and the message logs will be returned.
\nIf you try to send a message without authorization, you will get a response with HTTP status code 401 Unauthorized.
\nIf you are using this method too many times in a short period, you will get status code 429 Too Many Requests. This prevents misusing logs in cases where reports would be more appropriate. For more information about when to use logs, please see the documentation.
\nSMSLogsResponse
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \nSentEmailLog | \nCollection of logs. | \n
\n\n
\n
SentEmailLog
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| messageId | \nString | \nThe ID that uniquely identifies the message sent. | \n
\n\n| to | \nString | \nThe message destination address. | \n
\n\n| from | \nString | \nSender e-mail address. | \n
\n\n| text | \nString | \nText of the message that was sent. | \n
\n\n| sentAt | \nDate | \nTells when the e-mail was sent. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ. | \n
\n\n| doneAt | \nDate | \nTells when the e-mail was finished processing by us (i.e. delivered to destination) | \n
\n\n| messageCount | \nint | \nHow many parts the message was split into. Always will be 1 for e-mail. | \n
\n\n| price | \nPrice | \nSent e-mail price. | \n
\n\n| status | \nStatus | \nIndicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status. | \n
\n\n| error | \nError | \nIndicates whether the error occurred during the query execution. | \n
\n\n
\n
Price
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| pricePerMessage | \nBigDecimal | \nPrice per one e-mail. | \n
\n\n| currency | \nString | \nThe currency in which the price is expressed. | \n
\n\n
\n
Status
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| groupId | \nint | \nStatus group ID | \n
\n\n| groupName | \nString | \nStatus group name. | \n
\n\n| id | \nint | \nStatus ID | \n
\n\n| name | \nString | \nStatus name. | \n
\n\n| description | \nString | \nHuman readable description of the status. | \n
\n\n| action | \nString | \nAction that should be taken to eliminate the error. | \n
\n\n
\n
Error
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| groupId | \nint | \nError group ID | \n
\n\n| groupName | \nString | \nError group name | \n
\n\n| id | \nint | \nError ID | \n
\n\n| name | \nString | \nError name | \n
\n\n| description | \nString | \nHuman readable description of the error. | \n
\n\n| permanent | \nboolean | \nTells if the error is permanent | \n
\n\n
\n
Additional query parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| campaignReferenceId | \nString | \nThe ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns. | \n
\n\n| applicationId | \nString | \nApplication identifier used for filtering. | \n
\n\n| entityId | \nString | \nEntity identifier used for filtering. | \n
\n\n| useCursor | \nBoolean | \nFlag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs. | \n
\n\n| cursor | \nString | \nValue which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the nextCursor value returned from the previous response to continue fetching data. | \n
\n\n
\n
Additional response fields
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| cursor | \nObject | \nCursor information. | \n
\n\n| cursor.limit | \nInt | \nRequested limit. | \n
\n\n| cursor.nextCursor | \nString | \nThe cursor value you will use in your next request to fetch the subsequent set of results. | \n
\n\n
\n
\nDocumentation only. This is the message that VHD sends to a URL on your server. It is skipped when you run the collection.
\n
\nGet real-time tracking reports for all opens/clicks to a specified endpoint.
\nRequest body schema
\n\n\n\n| Parameter | \nType | \n
\n\n\n\n| results | \narray of objects | \n
\n\n
\n
{\n\"results\": [\n{\n\"bulkId\": \"\",\n\"price\": {\n\"pricePerMessage\": ,\n\"currency\": \"\"\n},\n\"status\": {\n\"id\": ,\n\"groupId\": ,\n\"groupName\": \"\",\n\"name\": \"\",\n\"description\": \"\"\n},\n\"error\": {\n\"id\": ,\n\"name\": \"\",\n\"description\": \"\",\n\"groupId\": ,\n\"groupName\": \"\",\n\"permanent\": \n},\n\"messageId\": \"\",\n\"doneAt\": \"\",\n\"smsCount\": ,\n\"sentAt\": \"\",\n\"browserLink\": \"\",\n\"callbackData\": \"\",\n\"to\": \"\"\n}\n]\n}\n\n
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| bulkId | \nString | \nThe ID that uniquely identifies a list of email messages. This is either defined by user in the request or auto generated. | \n
\n\n| price | \nobject | \nSent email price. | \n
\n\n| status | \nobject | \nIndicates whether the email is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status. | \n
\n\n| error | \nobject | \nIndicates whether the error occurred during the query execution. | \n
\n\n| messageId | \nstring | \n | \n
\n\n| doneAt | \n
string | \nDelivery date and time.The ID that uniquely identifies the email sent to the recipient. | \n
\n\n| smsCount | \n
integer | \nThe number of emails sent. | \n
\n\n| sentAt | \n
string | \nSend date and time. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ. | \n
\n\n| browserLink | \nstring | \nContains the link to the HTML sent to recipient. This will be present only if the view in browser feature is used in the email | \n
\n\n| callbackData | \n
string | \nCallback data sent through callbackData field in fully featured email. | \n
\n\n| to | \n
string | \nDestination email address. | \n
\n\n
\n
Price object
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| currency | \nstring | \nThe currency in which the price is expressed. | \n
\n\n| pricePerMessage | \nnumber | \nPrice per message. | \n
\n\n
\n
Status object
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| groupId | \nint | \nStatus group ID. | \n
\n\n| groupName | \nstring | \nStatus group name. | \n
\n\n| id | \nint | \nStatus ID. | \n
\n\n| name | \nstring | \nStatus name. | \n
\n\n| description | \nstring | \nHuman readable description of the status. | \n
\n\n| action | \nstring | \nAction that should be taken to eliminate the error | \n
\n\n
\n
Error object
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| groupId | \nint | \nError group ID. | \n
\n\n| groupName | \nstring | \nError group name. | \n
\n\n| id | \nint | \nError ID. | \n
\n\n| name | \nstring | \nError name. | \n
\n\n| description | \nstring | \nHuman readable description of the error. | \n
\n\n| permanent | \nboolean | \nIndicates whether the error is permanent. | \n
\n\n
\n
Additional fields
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results[].entityId | \nString | \nUsed when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the documentation. | \n
\n\n| results[].applicationId | \nString | \nUsed when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the documentation. | \n
\n\n| results[].campaignReferenceId | \nString | \nID of a campaign that was sent in the message. | \n
\n\n| results[].attemptCount | \nInt | \nNumber of times delivery was attempted for the email. | \n
\n\n| results[].timeToFirstAttempt | \nInt | \nThis is the time in milliseconds between accepting the request and making the first delivery attempt to the destination. | \n
\n\n| results[].sendingIp | \nString | \nThe IP address that was used to send out the email. | \n
\n\n| results[].smtp | \nObject | \nSMTP details for the sent email. | \n
\n\n| results[].smtp.response | \nString | \nSMTP server response for the sent email. | \n
\n\n
\n
\nDocumentation only. This is the message that VHD sends to a URL on your server. It is skipped when you run the collection.
\n
\n\nNotifications for opens, clicks, unsubscribes and similar recipient actions. The URL is set with options.tracking.trackingUrl (v4) or trackingUrl (v3) when you send.
\n
\nFor each email that you send out, we can send you a tracking report for opened, clicked, complained and unsubscribed. All you need to do is specify your endpoint when sending an email and we will deliver a report to you in real-time.
\nRequest body schema
\n{\n\"notificationType\": \"\",\n\"domain\": \"string\",\n\"recipient\": \"\",\n\"url\": \"\"\n\"sendDateTime\": \"\",\n\"messageId\": ,\n\"bulkId\": \"\",\n\"recipientInfo\": {\n \"deviceType\": \"\",\n \"os\": \"\",\n \"deviceName\": \"\",\n},\n\"geoLocation\": {\n \"country_name\": \"\",\n \"city\": \"\",\n \"latitude\": \"\",\n \"longitude\":\"\"\n}\n}\n\n
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| notificationType | \nstring | \nTells the type of user event that took place. Possible events: OPENED, CLICKED, COMPLAINED, UNSUBSCRIBED. | \n
\n\n| domain | \nstring | \nThe sending domain used to send the email to the recipient. | \n
\n\n| recipient | \nstring | \nRecipient of the email. | \n
\n\n| url | \nstring | \nThe link the recipient has clicked. This attribute will only be present only if the event is of the type CLICKED. | \n
\n\n| sendDateTime | \nnumber | \nThe time at which the email was sent. Time is in milliseconds. | \n
\n\n| messageId | \nstring | \nThe ID uniquely identifies the message sent to the recipient. | \n
\n\n| bulkId | \nstring | \nThe ID uniquely identifies a list of email messages. This is either defined by the user in the request or auto-generated | \n
\n\n| recipientInfo | \nobject | \nRecipient information such as device type, OS and device name.auto-generated | \n
\n\n| geoLocation | \nobject | \nGeolocation data such as Country, City, Latitude and Longitude. This data will be available only for opens and clicks. | \n
\n\n
\n
RecipientInfo object
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| deviceType | \nstring | \nThe currency in which the price is expressed. | \n
\n\n| os | \nstring | \nDevice name of the action originating device. | \n
\n\n| deviceName | \nstring | \nDevice name of the action originating device. | \n
\n\n
\n
GeoLocation object
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| country_name | \nstring | \nCountry where the user action is recorded. | \n
\n\n| city | \nstring | \nThe city where the user action is recorded. | \n
\n\n| latitude | \nstring | \nLatitude of the action-originating device. | \n
\n\n| longitude | \nstring | \nLongitude of the action-originating device. | \n
\n\n
\n
\nDocumentation only. This is the message that VHD sends to a URL on your server. It is skipped when you run the collection.
\n
\nVHD sends platform events about your email sending setup to a URL on your server as they happen, for example a warning when a domain's bounce rate is high or a notice that sending was suspended. Your server should reply 200 OK to confirm it accepted the event.
\nThe eventDetails.type field tells you which event it is.
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| eventId | \nString | \nRequired. Unique ID of the event. This ID can be used for deduplication purposes. | \n
\n\n| createdAt | \nInt | \nRequired. Epoch milliseconds when the event occurred. | \n
\n\n| eventDetails | \nObject | \nRequired. Email platform event data. | \n
\n\n| eventDetails.type | \nString | \nRequired. Type of the email platform event. One of: HIGH_BOUNCE_RATE_WARNING, HIGH_BOUNCE_RATE_BLOCKED. | \n
\n\n
\n
Events
\n\n- High bounce rate warning: Sent when a domain's bounce rate exceeds the warning threshold. The domain remains active but action is recommended to avoid suspension.
\n- High bounce rate block: Sent when a domain's bounce rate exceeds the block threshold. The domain has been suspended and email sending is disabled for following 24 hours.
\n
\nUse eventId to ignore events you have already processed.
\n","urlObject":{"protocol":"https","path":["your","webhook","path"],"host":["{yourDomain}"],"query":[],"variable":[]}},"response":[{"id":"6c545cdc-0a93-4e83-b101-4a24742e623e","name":"High bounce rate warning","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"eventId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"createdAt\": 1767308400000,\n \"eventDetails\": {\n \"type\": \"HIGH_BOUNCE_RATE_WARNING\",\n \"accountKey\": \"8F0792F86035A9F4290821F1EE6BC06A\",\n \"domain\": \"example.com\",\n \"warnThreshold\": 3.0,\n \"bounceRate\": 4.6,\n \"scope\": \"HOURLY\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{yourDomain}/your/webhook/path"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null},{"id":"fa32bcac-a638-43fd-9b0f-8d1e3cc36544","name":"High bounce rate block","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"eventId\": \"dc592d92-54bb-4c97-b9fb-7aafb8f07bfd\",\n \"createdAt\": 1767308400000,\n \"eventDetails\": {\n \"type\": \"HIGH_BOUNCE_RATE_BLOCKED\",\n \"accountKey\": \"8F0792F86035A9F4290821F1EE6BC06A\",\n \"domain\": \"example.com\",\n \"blockThreshold\": 5.0,\n \"bounceRate\": 6.6,\n \"scope\": \"DAILY\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{yourDomain}/your/webhook/path"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0718a4df-42c4-4e4f-a38b-0220ac26b381"}],"id":"4a9831d5-df59-4860-bd68-9cfb9ee4a163","description":"Get delivery reports and logs of sent emails, or receive delivery reports, tracking reports and platform events on your own server through webhooks. Use the v4 requests for new integrations.
\n","_postman_id":"4a9831d5-df59-4860-bd68-9cfb9ee4a163"},{"name":"MANAGE SCHEDULED EMAIL","item":[{"name":"Schedule an email (API v4)","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","if (!(pm.environment.get(\"testEmail\") || \"\").trim()) { skip(\"testEmail is not set\"); }"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests for Schedule an email (API v4).","pm.test(\"Status code is 200\", function () { pm.expect(pm.response.code).to.eql(200); });","pm.test(\"The scheduled email is accepted (it is canceled at the end of this flow)\", function () {"," var j = pm.response.json();"," pm.expect(j).to.have.property(\"bulkId\").that.is.a(\"string\");"," pm.expect(j.messages[0].status.groupName).to.not.be.oneOf([\"REJECTED\", \"UNDELIVERABLE\"]);","});","","pm.environment.set(\"emailBulkId\", pm.response.json().bulkId);"],"type":"text/javascript","packages":{}}}],"id":"994c3726-e269-4cb1-a250-1e34a9d5adf7","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"sender\": \"example@vhdmedia.eu\",\n \"destinations\": [\n {\n \"to\": [\n {\n \"destination\": \"jane.smith@vhdmedia.se\",\n \"placeholders\": \"{\\\"name\\\":\\\"Jane\\\"}\"\n }\n ]\n }\n ],\n \"content\": {\n \"subject\": \"Welcome to VHD, {{name}}\",\n \"html\": \"Hello {{name}}
This is a test email from the VHD API.
\",\n \"text\": \"Dear {{name}}, this is a test email from the VHD API.\"\n },\n \"webhooks\": {\n \"delivery\": {\n \"url\": \"https://www.example.com/email/delivery\",\n \"intermediateReport\": true,\n \"notify\": true\n },\n \"contentType\": \"application/json\",\n \"callbackData\": \"DLR callback data\"\n }\n }\n ],\n \"options\": {\n \"tracking\": {\n \"trackOpens\": true,\n \"trackClicks\": true\n },\n \"schedule\": {\n \"sendAt\": \"{{sendAt}}\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/email/4/messages","description":"Schedule an email for later with options.schedule.sendAt (up to 5 days ahead). The bulkId is saved in the environment variable emailBulkId, and the requests that follow act on it. The flow cancels the email at the end, so it is never sent.
\nSend one email or many in a single request, with text, HTML, a template, attachments, and placeholders. This is the current version of the email send API and replaces Send fully featured email (API v3), which stays available.
\nMessages sent here can use the VHD options for tracking, scheduling, delivery windows, IP pools, and storage. Delivery reports go to the URL in webhooks.delivery.url, and open and click notifications go to options.tracking.trackingUrl.
\n\nScheduling. With options.schedule.sendAt, an email can be scheduled up to 5 days ahead. The older v3 send accepted dates further ahead. Use the scheduled-email requests to view, pause, reschedule or cancel a scheduled bulk.
\n
\n\nPlaceholders are JSON strings. The values of placeholders and defaultPlaceholders must be sent as a string that contains JSON, for example \"{\\\"name\\\": \\\"Jane\\\"}\", not as an object.
\n
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| messages | \nArray | \nRequired. An array of message objects of a single message or multiple messages sent under one bulk ID. | \n
\n\n| messages[].sender | \nString | \nEmail address with optional sender name. Note: This field is required if templateId is not present. | \n
\n\n| messages[].destinations | \nArray | \nRequired. An array of destination objects for where messages are being sent. A valid destination is required. Note: Maximum number of recipients is 1000 overall including to, cc and bcc field. | \n
\n\n| messages[].destinations[].to | \nArray | \nRequired. List of TO recipient email addresses. | \n
\n\n| messages[].destinations[].to[].destination | \nString | \nRequired. Email address of the recipient in a form of john.smith@somecompany.com | \n
\n\n| messages[].destinations[].to[].messageId | \nString | \nThe ID that uniquely identifies the message sent to a recipient. | \n
\n\n| messages[].destinations[].to[].placeholders | \nString | \nAs optional feature, a specific placeholder can be defined whose value will apply only for this destination. Value should be defined as: {\"name\": \"John\"}. | \n
\n\n| messages[].destinations[].cc | \nArray | \nList of CC recipient email addresses. | \n
\n\n| messages[].destinations[].cc[].destination | \nString | \nRequired. Email address of the recipient in a form of john.smith@somecompany.com | \n
\n\n| messages[].destinations[].cc[].messageId | \nString | \nThe ID that uniquely identifies the message sent to a recipient. | \n
\n\n| messages[].destinations[].cc[].placeholders | \nString | \nAs optional feature, a specific placeholder can be defined whose value will apply only for this destination. Value should be defined as: {\"name\": \"John\"}. | \n
\n\n| messages[].destinations[].bcc | \nArray | \nList of BCC recipient email addresses. | \n
\n\n| messages[].destinations[].bcc[].destination | \nString | \nRequired. Email address of the recipient in a form of john.smith@somecompany.com | \n
\n\n| messages[].destinations[].bcc[].messageId | \nString | \nThe ID that uniquely identifies the message sent to a recipient. | \n
\n\n| messages[].destinations[].bcc[].placeholders | \nString | \nAs optional feature, a specific placeholder can be defined whose value will apply only for this destination. Value should be defined as: {\"name\": \"John\"}. | \n
\n\n| messages[].destinations[].replyTo | \nString | \nEmail address to which recipients of the email can reply. | \n
\n\n| messages[].destinations[].preserveRecipients | \nBoolean | \nWhen this option is set to true, all recipients in the to field will be able to see the entire list of recipients who received the email, and the response will include a single messageId. If the option is set to false , each recipient will only see their own email address, and the response will provide a unique messageId for each individual recipient. | \n
\n\n| messages[].content | \nObject | \nRequired. Message content. | \n
\n\n| messages[].content.subject | \nString | \nMessage subject. Note: This field is required if templateId is not present. | \n
\n\n| messages[].content.text | \nString | \nBody of the message. | \n
\n\n| messages[].content.html | \nString | \nThe message's body in HTML format. If both html and text fields are included, the text field will be disregarded, and the message will be sent using the html content. | \n
\n\n| messages[].content.ampHtml | \nString | \nThe message's body in AMP HTML format. If you include ampHtml, you must also include html, which will be displayed if AMP is not supported. Keep in mind that not all email clients support AMP HTML. For guidance on configuring the Gmail client, please visit this link: https://developers.google.com/gmail/ampemail/ . | \n
\n\n| messages[].content.templateId | \nString | \nThe Template ID with predefined email content created through the VHD web interface or API. When templateId is specified, the html and text fields will be disregarded. Note: templateId only supports the Broadcast value; Content and Flow templates are not supported. | \n
\n\n| messages[].content.attachments | \nArray | \nFile attachments. | \n
\n\n| messages[].content.attachments[].type | \nString | \nRequired. | \n
\n\n| messages[].content.inlineImages | \nArray | \nAllows for inserting an image file inside the HTML code of the email by using cid:FILENAME instead of providing an external link to the image. | \n
\n\n| messages[].content.inlineImages[].type | \nString | \nRequired. | \n
\n\n| messages[].content.defaultPlaceholders | \nString | \nGeneral placeholders: {\"ph1\": \"Success\"} will replace the key {{ph1}} with the value Success throughout the email, including the subject, text, and HTML. If there are multiple recipients in the To field, this placeholder will use the same value for the key ph1 for all recipients. | \n
\n\n| messages[].content.landingPagePlaceholders | \nString | \nPersonalize Opt-Out Landing Page by inserting placeholders. Insert placeholder or tag while designing landing page. Value should be defined as: {\"unsubscribe\": \"Unsubscribe\"} | \n
\n\n| messages[].content.optoutLandingPageId | \nString | \nThe Opt-Out Landing Page ID specifies the page to be displayed when an end user clicks the unsubscribe link. If the ID is not provided, the default opt-out landing page will be used. Create a landing page over VHD web interface and use its ID, for example, 1_23456. | \n
\n\n| messages[].content.templateLanguageVersion | \nString | \nIndicates the version of the template language to be used in the current message template. Use version 1 for the older template language and version 2 to access features of the new template language. If not specified, version 1 will be used by default. | \n
\n\n| messages[].content.headers | \nString | \nAdditional email headers for customization that can be provided in a form of JSON. Example: headers={\"X-CustomHeader\": \"Header value\"}. There are a few exceptions of headers which are not adjustable through this option: To, Cc, Bcc, Subject, Content-Type, DKIM-Signature, Content-Transfer-Encoding, Return-Path, MIME-Version | \n
\n\n| messages[].options | \nObject | \nMessage options. | \n
\n\n| messages[].options.platform | \nObject | \nPlatform options. For more details, see documentation. | \n
\n\n| messages[].options.platform.entityId | \nString | \nUsed when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the documentation. | \n
\n\n| messages[].options.platform.applicationId | \nString | \nUsed when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the documentation. | \n
\n\n| messages[].options.validityPeriod | \nObject | \nMessage validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. | \n
\n\n| messages[].options.validityPeriod.amount | \nInt | \nRequired. Message validity period's value. If timeUnit is not set, it will default to MINUTES. | \n
\n\n| messages[].options.validityPeriod.timeUnit | \nString | \nMessage validity period time unit. One of: SECONDS, MINUTES, HOURS. | \n
\n\n| messages[].options.deliveryTimeWindow | \nObject | \nSets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the from property. The exact time of the day to end sending messages can be defined using the to property. Properties from and to should be both provided with the minimum 1 hour difference or omitted. | \n
\n\n| messages[].options.deliveryTimeWindow.days | \nArray | \nRequired. Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma. | \n
\n\n| messages[].options.deliveryTimeWindow.from | \nObject | \nThe exact time of the day. The time is expressed in the UTC time zone. | \n
\n\n| messages[].options.deliveryTimeWindow.from.hour | \nInt | \nRequired. Hour when the time window opens when used in the from property or closes when used in the to property. | \n
\n\n| messages[].options.deliveryTimeWindow.from.minute | \nInt | \nRequired. Minute when the time window opens when used in the from property or closes when used in the to property. | \n
\n\n| messages[].options.deliveryTimeWindow.to | \nObject | \nThe exact time of the day. The time is expressed in the UTC time zone. | \n
\n\n| messages[].options.deliveryTimeWindow.to.hour | \nInt | \nRequired. Hour when the time window opens when used in the from property or closes when used in the to property. | \n
\n\n| messages[].options.deliveryTimeWindow.to.minute | \nInt | \nRequired. Minute when the time window opens when used in the from property or closes when used in the to property. | \n
\n\n| messages[].options.campaignReferenceId | \nString | \nID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel. | \n
\n\n| messages[].webhooks | \nObject | \nProvides options for configuring message webhooks. | \n
\n\n| messages[].webhooks.delivery | \nObject | \nProvides options for configuring the delivery report behavior. | \n
\n\n| messages[].webhooks.delivery.url | \nString | \nThe URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the retry cycle uses the following formula: 1min + (1min * retryNumber * retryNumber). | \n
\n\n| messages[].webhooks.delivery.intermediateReport | \nBoolean | \nThe real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to false. | \n
\n\n| messages[].webhooks.delivery.notify | \nBoolean | \nNotify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to 'true' or not defined, your Subscription settings will apply. | \n
\n\n| messages[].webhooks.contentType | \nString | \nPreferred delivery report content type, application/json or application/xml. | \n
\n\n| messages[].webhooks.callbackData | \nString | \nAdditional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters. | \n
\n\n| messages[].ips | \nObject | \nIP options per message. | \n
\n\n| messages[].ips.ipPoolId | \nString | \nThe ID of the IP pool that will be used to send the email. | \n
\n\n| messages[].placeholdersMasking | \nArray | \nOptions to full or partially mask placeholders. | \n
\n\n| messages[].placeholdersMasking[].name | \nString | \nRequired. The placeholder name that needs to be masked. | \n
\n\n| messages[].placeholdersMasking[].side | \nString | \nThe side from which characters should be hidden. Options are L (left) or R (right). | \n
\n\n| messages[].placeholdersMasking[].maskChar | \nString | \nThe character used to replace the masked placeholders, e.g., *, +. | \n
\n\n| messages[].placeholdersMasking[].visibleChars | \nInt | \nThe number of characters to leave visible. Ignored if a delimiter is specified. Defaults to 0 (i.e., all characters hidden) if not specified. | \n
\n\n| messages[].placeholdersMasking[].delimiter | \nString | \nOptional delimiter character (e.g., @, /). When specified, masking applies only to the part of the placeholder before or after the delimiter, depending on the side value. If this is set, the visibleChars field is ignored. | \n
\n\n| messages[].placeholdersMasking[].skipChars | \nArray | \nA list of characters that should not be masked, even if they fall within the masked region. For example, if we want to mask (385)-9134849 into (***)-********, we should include the characters (,) and - in this list to preserve the formatting. In this case, only digits will be masked while parentheses and dashes remain visible. | \n
\n\n| messages[].storage | \nObject | \nEmail storage options per message. | \n
\n\n| messages[].storage.skipPassive | \nBoolean | \nSet to true to skip passive email storage (long-term storage used for compliance, legal, or audit purposes). If false or not set, the account-level setting is used. | \n
\n\n| messages[].storage.skipActive | \nBoolean | \nSet to true to skip active email storage (short-term storage used for troubleshooting or support). If false or not set, the account-level setting is used. | \n
\n\n| options | \nObject | \nOptions applicable to all messages in the request. | \n
\n\n| options.schedule | \nObject | \nOptions for scheduling a message. | \n
\n\n| options.schedule.bulkId | \nString | \nUnique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response. | \n
\n\n| options.schedule.sendAt | \nString | \nDate and time when the message is to be sent. Used for scheduled messages. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ, and can only be scheduled for no later than 5 days in advance. | \n
\n\n| options.tracking | \nObject | \nSets up URL shortening and tracking feature. | \n
\n\n| options.tracking.track | \nBoolean | \nEnable or disable open and click tracking. Passing true will only enable tracking and the statistics will be visible in the web interface alone. This can be explicitly overridden by trackClicks and trackOpens. | \n
\n\n| options.tracking.trackOpens | \nBoolean | \nThis parameter enables or disables track open feature. | \n
\n\n| options.tracking.trackClicks | \nBoolean | \nThis parameter enables or disables track click feature. | \n
\n\n| options.tracking.trackingUrl | \nString | \nThe URL on your callback server on which the open and click notifications will be sent. See Tracking Notifications for details. | \n
\n\n| options.tracking.trackingPixelPosition | \nString | \nThis parameter specifies the position of the open tracking pixel within the email content. Allowed values are TOP and BOTTOM. If no value is provided, the default is TOP. | \n
\n\n| options.clientPriority | \nString | \nClient priority set on request. Must be 'HIGH', 'STANDARD' or 'LOW'. One of: HIGH, STANDARD, LOW. | \n
\n\n
\n
On success the response is 200 OK. Invalid requests return 400 with the list of violations, missing or invalid credentials 401.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| bulkId | \nString | \nUnique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response. Typically used for fetching delivery reports and message logs. | \n
\n\n| messages | \nArray | \nRequired. An array of message objects of a single message or multiple messages sent under one bulk ID. | \n
\n\n| messages[].messageId | \nString | \nUnique message ID. If not provided, it will be auto-generated and returned in the API response. | \n
\n\n| messages[].status | \nObject | \nIndicates the status of the message and how to recover from an error should there be any. | \n
\n\n| messages[].status.groupId | \nInt | \nStatus group ID. | \n
\n\n| messages[].status.groupName | \nString | \nStatus group name that describes which category the status code belongs to, i.e., PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED. One of: ACCEPTED, PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED. | \n
\n\n| messages[].status.id | \nInt | \nStatus code ID. | \n
\n\n| messages[].status.name | \nString | \nStatus code name. | \n
\n\n| messages[].status.description | \nString | \nHuman-readable description of the status. | \n
\n\n| messages[].status.action | \nString | \nAction to take to recover from the error. | \n
\n\n| messages[].destination | \nString | \nThe destination address of the message, i.e., its recipient. | \n
\n\n| messages[].details | \nObject | \nOther details of the message. | \n
\n\n
\n
Errors use the common format: errorCode, description, action, violations[] (property, violation).
\n","urlObject":{"protocol":"https","path":["email","4","messages"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[],"_postman_id":"994c3726-e269-4cb1-a250-1e34a9d5adf7"},{"name":"Get sent email bulks","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","if (!(pm.environment.get(\"emailBulkId\") || \"\")) { skip(\"emailBulkId is not set\"); } else {","waitUntil(function (cb) { api(\"GET\", \"/email/1/bulks?bulkId=\" + pm.environment.get(\"emailBulkId\"), null, function (e, r) { cb(r && r.code === 200); }); }, 12, 3000, function () {});","}"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","",""],"type":"text/javascript","packages":{}}}],"id":"4ad58667-07cb-4e82-9100-7c4cdac77c90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/email/1/bulks?bulkId={{emailBulkId}}","description":"REQUEST RATE LIMIT:
\n1000 requests / second (per account)
\nQuery parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| bulkId | \nString | \nBulk ID for which report is requested. | \n
\n\n
\n
Required. The ID of the bulk, returned when the messages were sent.
\n","type":"text/plain"},"key":"bulkId","value":"{{emailBulkId}}"}],"variable":[]}},"response":[{"id":"54a015cf-fc15-40dd-9b9a-80d9c82c25e6","name":"Get sent email bulks","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/email/1/bulks?bulkId={{bulkId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["email","1","bulks"],"query":[{"key":"bulkId","value":"{{bulkId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Date","value":"Thu, 04 May 2023 15:01:09 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Server","value":"SMS API"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"X-Request-Id","value":"1683212469479510255"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"externalBulkId\": \"customBulkId1\",\n \"bulks\": [\n {\n \"bulkId\": \"2038774678111\",\n \"sendAt\": \"2023-05-04T16:00:00.087+0000\"\n },\n {\n \"bulkId\": \"2038770383111\",\n \"sendAt\": \"2023-05-04T23:00:00.207+0000\"\n }\n ]\n}"}],"_postman_id":"4ad58667-07cb-4e82-9100-7c4cdac77c90"},{"name":"Get sent email bulks status","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","",""],"type":"text/javascript","packages":{}}}],"id":"bbbbf884-98a3-4e37-97b3-77e8e2d1201f","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://go2.vhdmedia.se/email/1/bulks/status?bulkId={{emailBulkId}}","description":"REQUEST RATE LIMIT:
\n1000 requests / second (per account)
\nQuery parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| bulkId | \nString | \nBulk ID for which report is requested. | \n
\n\n
\n
Required. The ID of the bulk, returned when the messages were sent.
\n","type":"text/plain"},"key":"bulkId","value":"{{emailBulkId}}"}],"variable":[]}},"response":[{"id":"fc37ab8c-ba96-4ea7-8485-d24d6e5ce205","name":"Get sent email bulks status","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://go2.vhdmedia.se/email/1/bulks/status?bulkId={{bulkId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["email","1","bulks","status"],"query":[{"key":"bulkId","value":"{{bulkId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"vary","value":"Access-Control-Request-Method"},{"key":"vary","value":"Access-Control-Request-Headers"},{"key":"date","value":"Thu, 04 May 2023 15:14:54 GMT"},{"key":"content-type","value":"application/json;charset=utf-8"},{"key":"server","value":"SMS API"},{"key":"transfer-encoding","value":"chunked"},{"key":"x-request-id","value":"1683213294451564254"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"externalBulkId\": \"customBulkId1\",\n \"bulks\": [\n {\n \"bulkId\": \"2038774678111\",\n \"status\": \"PENDING\"\n },\n {\n \"bulkId\": \"2038770383111\",\n \"status\": \"PENDING\"\n }\n ]\n}"}],"_postman_id":"bbbbf884-98a3-4e37-97b3-77e8e2d1201f"},{"name":"Update scheduled Email messages status","event":[{"listen":"prerequest","script":{"exec":["var bulk = pm.environment.get(\"emailBulkId\");","var base = \"https://go2.vhdmedia.se/email/1/bulks/status?bulkId=\" + encodeURIComponent(bulk);","var headers = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\" };","","function currentStatus(res) {"," var json = res.json();"," return (json.bulks && json.bulks[0]) ? json.bulks[0].status : json.status;","}","// Email status changes take a few seconds to apply: wait until the status is what we expect.","function waitFor(wanted, tries, done) {"," pm.sendRequest({ url: base, method: \"GET\", header: headers }, function (err, res) {"," var current = (!err && res.code === 200) ? currentStatus(res) : null;"," if (current === wanted || tries <= 0) { done(); }"," else { setTimeout(function () { waitFor(wanted, tries - 1, done); }, 2000); }"," });","}","","// A bulk cannot be set to PAUSED when it is already PAUSED. If it is paused now,","// resume it first, so this request can pause it again and every run ends in PAUSED.","pm.sendRequest({ url: base, method: \"GET\", header: headers }, function (err, res) {"," if (err || res.code !== 200 || currentStatus(res) !== \"PAUSED\") { return; }"," pm.sendRequest({"," url: base, method: \"PUT\","," header: Object.assign({ \"Content-Type\": \"application/json\" }, headers),"," body: { mode: \"raw\", raw: JSON.stringify({ status: \"PENDING\" }) }"," }, function () { waitFor(\"PENDING\", 10, function () {}); });","});",""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"bulkId\", \"status\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});"],"type":"text/javascript","packages":{}}}],"id":"a305f3aa-c5d9-4d02-ab48-d14efd3c0d38","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"status\":\"PAUSED\"}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/email/1/bulks/status?bulkId={{emailBulkId}}","description":"REQUEST RATE LIMIT:
\n1000 requests / second (per account)
\nQuery parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| bulkId | \nString | \nBulk ID for which report is requested. | \n
\n\n
\n
Request body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| status | \nString | \nRequired
Enum: \"PENDING\" \"PAUSED\" \"PROCESSING\" \"CANCELED\" \"FINISHED\" \"FAILED\" | \n
\n\n
\n
Required. The ID of the bulk, returned when the messages were sent.
\n","type":"text/plain"},"key":"bulkId","value":"{{emailBulkId}}"}],"variable":[]}},"response":[{"id":"f9b30844-3c79-4945-9288-8318645b1452","name":"Canceled","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"status\":\"CANCELED\"}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/email/1/bulks/status?bulkId={{bulkId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["email","1","bulks","status"],"query":[{"key":"bulkId","value":"{{bulkId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Date","value":"Thu, 04 May 2023 15:19:01 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Server","value":"SMS API"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"X-Request-Id","value":"1683213541957590255"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"customBulkId1\",\n \"status\": \"CANCELED\"\n}"}],"_postman_id":"a305f3aa-c5d9-4d02-ab48-d14efd3c0d38"},{"name":"Reschedule Email messages","event":[{"listen":"prerequest","script":{"exec":["var bulk = pm.environment.get(\"emailBulkId\");","var base = \"https://go2.vhdmedia.se/email/1/bulks/status?bulkId=\" + encodeURIComponent(bulk);","var headers = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\" };","","function currentStatus(res) {"," var json = res.json();"," return (json.bulks && json.bulks[0]) ? json.bulks[0].status : json.status;","}","// Email status changes take a few seconds to apply: wait until the status is what we expect.","function waitFor(wanted, tries, done) {"," pm.sendRequest({ url: base, method: \"GET\", header: headers }, function (err, res) {"," var current = (!err && res.code === 200) ? currentStatus(res) : null;"," if (current === wanted || tries <= 0) { done(); }"," else { setTimeout(function () { waitFor(wanted, tries - 1, done); }, 2000); }"," });","}","","// Schedule the email 7 days from now (UTC). Emails can be scheduled up to 30 days ahead.","var d = new Date(Date.now() + 7 * 24 * 60 * 60 * 1000);","function p(n) { return (\"0\" + n).slice(-2); }","pm.environment.set(\"sendAt\", d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) +"," \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\");","","// A bulk can only be rescheduled while it is PAUSED: wait until the pause has been applied.","waitFor(\"PAUSED\", 10, function () {"," // give the platform a moment to apply the pause everywhere before rescheduling"," setTimeout(function () {}, 4000);","});",""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"bulkId\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});"],"type":"text/javascript","packages":{}}}],"id":"5adfab95-d6f1-4b6f-94b7-549d74eba06b","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"sendAt\": \"{{sendAt}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/email/1/bulks?bulkId={{emailBulkId}}","description":"\nPause first. A scheduled bulk can only be rescheduled while its status is PAUSED. Call Update scheduled Email messages status with {\"status\": \"PAUSED\"} first; otherwise the request fails (for example 409 Conflict for SMS or 404 Not Found for email). Set the status back to PENDING to resume sending.
\n
\nREQUEST RATE LIMIT:
\n1000 requests / second (per account)
\nQuery parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| bulkId | \nString | \nBulk ID for which report is requested. | \n
\n\n
\n
Request body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| sendAt | \nString | \nRequired
| \n
\n\n
\n
Required. The ID of the bulk, returned when the messages were sent.
\n","type":"text/plain"},"key":"bulkId","value":"{{emailBulkId}}"}],"variable":[]}},"response":[{"id":"8670693c-a18c-4af8-a788-3252a5e066f7","name":"Reschedule Email messages","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"sendAt\":\"2023-05-04T17:00:00.085-00:00\"}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/email/1/bulks?bulkId={{bulkId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["email","1","bulks"],"query":[{"key":"bulkId","value":"{{bulkId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"vary","value":"Access-Control-Request-Method"},{"key":"vary","value":"Access-Control-Request-Headers"},{"key":"date","value":"Thu, 04 May 2023 15:12:38 GMT"},{"key":"content-type","value":"application/json;charset=utf-8"},{"key":"server","value":"SMS API"},{"key":"transfer-encoding","value":"chunked"},{"key":"x-request-id","value":"1683213158345979254"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"customBulkId1\",\n \"sendAt\": \"2023-05-04T17:00:00.085+0000\"\n}"}],"_postman_id":"5adfab95-d6f1-4b6f-94b7-549d74eba06b"},{"name":"Cancel the scheduled email","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","if (!(pm.environment.get(\"emailBulkId\") || \"\")) { skip(\"emailBulkId is not set\"); } else {","// a status change takes a few seconds to apply: wait until the bulk is paused, then cancel","waitUntil(function (cb) { api(\"GET\", \"/email/1/bulks/status?bulkId=\" + pm.environment.get(\"emailBulkId\"), null, function (e, r) { var j = jsonOf(r) || {}; cb(j.bulks && j.bulks[0] && j.bulks[0].status === \"PAUSED\"); }); }, 12, 2500, function () {});","}"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests for Cancel the scheduled email.","pm.test(\"Status code is 200\", function () { pm.expect(pm.response.code).to.eql(200); });","pm.test(\"The bulk is canceled, so nothing is ever sent\", function () { pm.expect(pm.response.json().status).to.eql(\"CANCELED\"); });"],"type":"text/javascript","packages":{}}}],"id":"787b322f-327c-4048-a7d4-9254b23d00d7","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"CANCELED\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/email/1/bulks/status?bulkId={{emailBulkId}}","description":"Cancel a scheduled email bulk so the emails are never sent.
\nREQUEST RATE LIMIT:
\n1000 requests / second (per account)
\nQuery parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| bulkId | \nString | \nBulk ID for which report is requested. | \n
\n\n
\n
Request body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| status | \nString | \nRequired
Enum: \"PENDING\" \"PAUSED\" \"PROCESSING\" \"CANCELED\" \"FINISHED\" \"FAILED\" | \n
\n\n
\n
Required. The ID of the bulk, returned when the messages were sent.
\n","type":"text/plain"},"key":"bulkId","value":"{{emailBulkId}}"}],"variable":[]}},"response":[],"_postman_id":"787b322f-327c-4048-a7d4-9254b23d00d7"}],"id":"59499ad0-d161-42e9-8d7e-561caf5f5254","description":"View, reschedule, pause, or cancel emails that were scheduled with sendAt. Each request needs the bulkId of the scheduled send. A bulk can only be rescheduled while its status is PAUSED.
\n\nRunning these requests. The flow schedules its own email, pauses and reschedules it, and cancels it at the end. No setup is needed, and nothing is ever sent.
\n
\n","_postman_id":"59499ad0-d161-42e9-8d7e-561caf5f5254"}],"id":"2a9b3800-f312-4cb8-b498-4ee3638a1fc7","description":"Introduction
\nThis documentation will help you get started using email API
\nEmail nowadays plays an essential part in everyone’s daily business communication, and it is important to have it included in your business applications as well, either as a standalone service, or as part of our OMNI solution.
\nIn this brief introduction, we will provide instructions on how to set up everything that will enable you to send emails over our platform in no time.
\nOur email service will allow you to send HTML emails, add attachments and view delivery reports to reach an ever increasing number of your clients directly, through our API, as explained in the next steps.
\nChoose your domain carefully
\nThe most important step in this initial stage is choosing the way you would like to route your emails.
\nIndividuals and organizations often use email as their primary means of communication. However, most users recently have started complaining about their inboxes being flooded with unsolicited bulk emails or spam emails. No technique is a complete solution to the spam problem, and each has trade-offs between incorrectly rejecting legitimate email (false positives) and not rejecting all spam (false negatives). This is why the domain reputation rating system was introduced - recognizing potential threats for emails sent out from the domain, based on what was sent from it in the past.
\nSince the domain reputation is affected by the type of emails being sent from it, once the domain is classified as 'bad' (possibly due to a generally negative impact from sending bulk type emails) - it is very hard to restore its reputation fully.
\nIt may be a good idea to separate the domains based on the type of messages that you are planning to send. For example: use different domains/subdomains for each type of email that you are intending to send (transactional, corporate, marketing, etc.) to keep the reputation levels separate.
\nRegister your domain with us
\nFor this step, you need to have access to your domain’s DNS configuration. Please, contact us with your preferred domain so we can integrate it within our platform. You will receive additional instructions (DNS configuration) on how to establish a proper communication channel between your domain and our platform.
\nOnce the configuration is properly applied, you can follow the steps outlined in the following pages to successfully send emails.
\nIf you have any questions regarding the service integration, please contact us.
\nEmail Template Creation Guide
\nTo facilitate the process of sending emails using templates, follow the steps below to create an email template on the VHD web platform:
\n\n- Login: Access the VHD web platform by logging in to your account.
\n- Navigate to Templates: Once logged in, go to the \"Moments/Templates/Broadcast Templates\" section.
\n- Initiate Template Creation: Select the option create new template.
\n- Choose Email Channel: Specify the communication channel as \"Email\" for the template you are creating.
\n- Select Sender: Choose the appropriate sender account.
\n- Template Design: Create the content of your template or choose an existing template.
\n- Save Template: After finalizing the template, save your work to ensure all changes are retained.
\n- Note the templateId, templateId's are the numbers followed by #.
\n- Now use Fully featured email API
\n- Add the templateId to send email templates.
\n
\n","_postman_id":"2a9b3800-f312-4cb8-b498-4ee3638a1fc7"},{"name":"PEOPLE","item":[{"name":"PERSON PROFILE","item":[{"name":"Create a new person","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","(function () {"," var calls = [\"/people/2/persons?identifier=janewilliams@example.com&type=EMAIL\", \"/people/2/persons?identifier=janesmith@example.com&type=EMAIL\", \"/people/2/persons?identifier=john.doe@example.com&type=EMAIL\", \"/people/2/persons?identifier=jane.work@example.com&type=EMAIL\", \"/people/2/persons?identifier=jane.home@example.com&type=EMAIL\", \"/people/2/persons?identifier=sample-3&type=EXTERNAL_ID\"];"," (function next(i) { if (i >= calls.length) { return; } api(\"DELETE\", calls[i], null, function () { next(i + 1); }); })(0);","})();"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Test if response status code is 200","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","// Check if response body is not empty before trying to parse it","pm.test(\"Response body is not empty\", function () {"," pm.expect(pm.response.text()).to.not.be.empty;","});","","// Attempt to parse response body as JSON","var responseBody;","try {"," responseBody = pm.response.json(); // Attempt to parse response body as JSON","} catch (error) {"," console.log(\"Error parsing response body as JSON:\", error);","}","","// Test if response is a valid JSON object only if the response status is 200","if (pm.response.code === 200) {"," pm.test(\"Response is a valid JSON object\", function () {"," pm.expect(responseBody).to.be.an('object');"," });",""," // Validate response properties"," pm.test(\"Response contains 'createdAt' and 'modifiedAt'\", function () {"," pm.expect(responseBody).to.have.property('createdAt');"," pm.expect(responseBody).to.have.property('modifiedAt');"," });",""," pm.test(\"Response contains 'id' as a number\", function () {"," pm.expect(responseBody).to.have.property('id').that.is.a('number');"," });",""," pm.test(\"Response 'firstName' and 'lastName' match the request\", function () {"," var sent = JSON.parse(pm.request.body.raw);"," pm.expect(responseBody.firstName).to.equal(sent.firstName);"," pm.expect(responseBody.lastName).to.equal(sent.lastName);"," });",""," pm.test(\"Response contains 'contactInformation'\", function () {"," pm.expect(responseBody).to.have.property('contactInformation').that.is.an('object');"," });",""," pm.test(\"Response contains the phone and email that were sent\", function () {"," var sentContact = JSON.parse(pm.request.body.raw).contactInformation || {};"," ['phone', 'email'].forEach(function (kind) {"," if (sentContact[kind]) {"," pm.expect(responseBody.contactInformation).to.have.property(kind).that.is.an('array').with.lengthOf(sentContact[kind].length);"," }"," });"," });",""," pm.test(\"Response 'type', 'origin', and 'modifiedFrom' are valid\", function () {"," pm.expect(responseBody).to.have.property('type', 'CUSTOMER');"," pm.expect(responseBody).to.have.property('origin', 'API');"," pm.expect(responseBody).to.have.property('modifiedFrom', 'API');"," });","}","","// Log the response for debugging","console.log(\"Response Body:\", responseBody);","",""],"type":"text/javascript","packages":{}}}],"id":"fb9740cd-3fbc-42b4-b782-71a2af83404a","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"contactInformation\": {\n \"email\": [\n {\n \"address\": \"janewilliams@example.com\"\n }\n ],\n \"phone\": [\n {\n \"number\": \"4670123456\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/persons","description":"Use this method to create a new person.
\nRequest rate limit
\n10 requests / second (per account)
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| address | \nstring | \nPerson's address, 256 characters max | \n
\n\n| birthDate | \nstring | \nPerson's date of birth, format YYYY-MM-DD | \n
\n\n| city | \nstring | \nPerson's city, 50 characters max | \n
\n\ncomputedAttributes
{
property name*
{ }
} | \nobject
object | \nPerson's computed attributes grouped by type | \n
\n\ncontactInformation
{
email
[{
address
}] ,
phone
[{
number
}] ,
facebook
[{
applicationId,
userId,
systemData
{
property name
}
}],
instagram
[{
applicationId,
userId,
systemData
{
property name
}
}],
liveChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
telegram
[{
applicationId,
userId,
systemData
{
property name
}
}],
viberBots
[{
applicationId,
userId,
systemData
{
property name
}
}],
twitter
[{
applicationId,
userId,
systemData
{
property name
}
}],
webpush
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
},
push
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
}
}],
appleBusinessChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
line
[{
applicationId,
userId,
systemData
{
property name
}
}]
}
| \nobject
array of objects
string
array of objects
string
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
object
array of objects
string
string
object
object
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
| \nRequired
List of phones, emails and other information how a person can be contacted
A list of person's email addresses. Max 100 emails per person.
Person's email address. Must comply with the email format and cannot exceed 255characters. One person can have up to 100 email addresses.
A list of person's phone numbers. Max 100 numbers per person.
Person's phone number. Must be in international format and cannot exceed 50 characters. One person can have up to 100 phone numbers.
A list of person's Facebook destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Instagram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Live Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's telegram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Viber Bots destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's twitter destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's web push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's Apple Business Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Line destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
| \n
\n\n| country | \nstring | \nPerson's country, 50 characters max | \n
\n\ncustomAttributes
{
property name*
{ }
} | \nobject
object | \nList of custom attributes for the person, 4096 characters max per value | \n
\n\n| externalId | \nstring | \nUnique ID for a person from your or another external system, 256 characters max | \n
\n\n| firstName | \nstring | \nPerson's first name, 255 characters max | \n
\n\n| gender | \nstring | \nEnum: \"MALE\" \"FEMALE\"
Person's gender | \n
\n\nintegrations
{
salesforce
{
contactId
leadId
}
} | \nobject
object
string
string
| \nIntegrations
Salesforce integration
Salesforce contact id
Salesforce lead id | \n
\n\n| lastName | \nstring | \nPerson's last name, 255 characters max | \n
\n\n| middleName | \nstring | \nPerson's middle name, 50 characters max | \n
\n\n| profilePicture | \nstring | \nURL for the person's profile picture, 2083 characters max | \n
\n\n| tags | \narray of
strings | \nList of tags that this person has | \n
\n\n| type | \nstring | \nEnum: \"CUSTOMER\" \"LEAD\"
Person's type, default type is CUSTOMER | \n
\n\n
\n
Response
\nDefault sucessful response
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| address | \nstring | \nPerson's address, 256 characters max | \n
\n\n| birthDate | \nstring | \nPerson's date of birth, format YYYY-MM-DD | \n
\n\n| city | \nstring | \nPerson's city, 50 characters max | \n
\n\ncomputedAttributes
{
property name*
{ }
} | \nobject
object | \nPerson's computed attributes grouped by type | \n
\n\ncontactInformation
{
email
[{
address
}] ,
phone
[{
number
}] ,
facebook
[{
applicationId,
userId,
systemData
{
property name
}
}],
instagram
[{
applicationId,
userId,
systemData
{
property name
}
}],
liveChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
telegram
[{
applicationId,
userId,
systemData
{
property name
}
}],
viberBots
[{
applicationId,
userId,
systemData
{
property name
}
}],
twitter
[{
applicationId,
userId,
systemData
{
property name
}
}],
webpush
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
},
push
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
}
}],
appleBusinessChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
line
[{
applicationId,
userId,
systemData
{
property name
}
}]
}
| \nobject
array of objects
string
array of objects
string
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
object
array of objects
string
string
object
object
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
| \nRequired
List of phones, emails and other information how a person can be contacted
A list of person's email addresses. Max 100 emails per person.
Person's email address. Must comply with the email format and cannot exceed 255characters. One person can have up to 100 email addresses.
A list of person's phone numbers. Max 100 numbers per person.
Person's phone number. Must be in international format and cannot exceed 50 characters. One person can have up to 100 phone numbers.
A list of person's Facebook destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Instagram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Live Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's telegram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Viber Bots destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's twitter destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's web push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's Apple Business Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Line destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
| \n
\n\n| country | \nstring | \nPerson's country, 50 characters max | \n
\n\ncustomAttributes
{
property name*
{ }
} | \nobject
object | \nList of custom attributes for the person, 4096 characters max per value | \n
\n\n| externalId | \nstring | \nUnique ID for a person from your or another external system, 256 characters max | \n
\n\n| firstName | \nstring | \nPerson's first name, 255 characters max | \n
\n\n| gender | \nstring | \nEnum: \"MALE\" \"FEMALE\"
Person's gender | \n
\n\nintegrations
{
salesforce
{
contactId
leadId
}
} | \nobject
object
string
string
| \nIntegrations
Salesforce integration
Salesforce contact id
Salesforce lead id | \n
\n\n| lastName | \nstring | \nPerson's last name, 255 characters max | \n
\n\n| middleName | \nstring | \nPerson's middle name, 50 characters max | \n
\n\n| profilePicture | \nstring | \nURL for the person's profile picture, 2083 characters max | \n
\n\n| tags | \narray of
strings | \nList of tags that this person has | \n
\n\n| type | \nstring | \nEnum: \"CUSTOMER\" \"LEAD\"
Person's type, default type is CUSTOMER | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| contactInformation.instagramDm | \nArray | \nA list of person's Instagram DM destinations. | \n
\n\n| contactInformation.kakaoSangdam | \nArray | \nA list of person's Kakao Sangdam destinations. | \n
\n\n| contactInformation.kakaoTalk | \nArray | \nA list of person's KakaoTalk destinations. | \n
\n\n| contactInformation.openChannel | \nArray | \nA list of person's Open Channel destinations. | \n
\n\n| contactInformation.push[].isPrimary | \nBoolean | \nSet to true if this device is a primary device of a user among other devices. | \n
\n\n| contactInformation.tiktokBm | \nArray | \nA list of person's TikTok Business Messaging destinations. | \n
\n\n| contactInformation.whatsapp | \nArray | \nA list of person's WhatsApp destinations. | \n
\n\n| contactInformation.zaloFollower | \nArray | \nA list of person's Zalo Follower destinations. | \n
\n\n| createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedFrom | \n | \nThe information which describes the source of the last modification of record. | \n
\n\n| origin | \n | \nThe information which describes the origin of the record. | \n
\n\n| preferredLanguage | \nString | \nPerson's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format. | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| contactInformation.instagramDm | \nArray | \nA list of person's Instagram DM destinations. | \n
\n\n| contactInformation.kakaoSangdam | \nArray | \nA list of person's Kakao Sangdam destinations. | \n
\n\n| contactInformation.kakaoTalk | \nArray | \nA list of person's KakaoTalk destinations. | \n
\n\n| contactInformation.openChannel | \nArray | \nA list of person's Open Channel destinations. | \n
\n\n| contactInformation.push[].isPrimary | \nBoolean | \nSet to true if this device is a primary device of a user among other devices. | \n
\n\n| contactInformation.tiktokBm | \nArray | \nA list of person's TikTok Business Messaging destinations. | \n
\n\n| contactInformation.whatsapp | \nArray | \nA list of person's WhatsApp destinations. | \n
\n\n| contactInformation.zaloFollower | \nArray | \nA list of person's Zalo Follower destinations. | \n
\n\n| createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedFrom | \n | \nThe information which describes the source of the last modification of record. | \n
\n\n| origin | \n | \nThe information which describes the origin of the record. | \n
\n\n| preferredLanguage | \nString | \nPerson's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format. | \n
\n\n
\n
Use this method with a query parameter to get a single person. If the query parameter is not specified, this method will return a list of people.
\nRequest rate limit
\n5 requests / second (per account)
\nQuery parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| phone | \nstring | \nExample: phone=46701234567
Person’s phone number. Phone numbers must be in international format. | \n
\n\n| email | \nstring | \nExample: email=name@example.com
Person’s email address. Must comply with the email format and cannot exceed 255 characters. One person can have up to 100 email addresses. | \n
\n\n| externalId | \nstring | \nExample: externalId=6F9619FF-8B86-D011-B42D-00CF4FC964FF
Unique ID for a person from your or another external system. | \n
\n\n| pushRegistrationId | \nstring | \nExample: pushRegistrationId=6F9619FF-8B86-D011-B42D-00CF4FC964FF
Person's push registration ID. | \n
\n\n| id | \nineger | \nExample: id=11351351
Person's internal ID. | \n
\n\n| lineId | \nstring | \nExample: lineId=U045147f1ad961bfe996b72bbf417f3c9
Person’s Line ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameters. | \n
\n\n| lineSenderId | \nstring | \nExample: lineSenderId=1644264921
Person’s Line sender ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameter | \n
\n\n| facebookId | \nstring | \nExample: facebookId=370329180020364
Person’s Facebook ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters. | \n
\n\n| facebookSenderId | \ninteger | \nExample: facebookSenderId=2094832040560427
Person’s Facebook sender ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters. | \n
\n\n| telegramUserId | \nstring | \nExample: telegramUserId=1303201999
Person’s Telegram user ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters. | \n
\n\n| telegramBotId | \nstring | \nExample: telegramBotId=1495032701
Person’s Telegram bot ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters. | \n
\n\n| viberBotUserId | \nstring | \nExample: viberBotUserId=Upk26V/i1GXfvxZ8S41P/w==
Person’s Viber Bot user ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters. | \n
\n\n| viberBotId | \n
integer | \nExample: viberBotId=5591458813882487336
Person’s Viber Bot ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters. | \n
\n\n| instagramId | \nstring | \nExample: instagramId=17841546155331428
Person’s Instagram user ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters. | \n
\n\n| instagramSenderId | \ninteger | \nExample: instagramSenderId=17841405793187218
Person’s Instagram sender ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters. | \n
\n\n| twitterId | \nstring | \nexample: twitterId=370329180020364
Person’s Twitter user ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters. | \n
\n\n| twitterSenderId | \ninteger | \nExample: twitterSenderId=10765432100123456789
Person’s Twitter sender ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters. | \n
\n\n| appleBusinessChatId | \nstring | \nExample: appleBusinessChatId=ef6ca8e9-3718-4dc9-a9a0-b4ac28d135ca
Person’s Apple Business Chat ID. To get person by Apple BC channel, you need to specify both appleBusinessChatId and appleBusinessChatSenderId parameters. | \n
\n\n| appleBusinessChatSenderId | \nstring | \nExample: appleBusinessChatSenderId=urn:mbid:AQAAYyUbut3B2E3T9GLv4EaF/
Person’s Apple Business Chat sender ID. To get person by Apple BC channel, you need to specify both appleBusinessChatId and appleBusinessChatSenderId parameters. | \n
\n\n| liveChatRegId | \nstring | \nExample: liveChatRegId=79f9701b-e350-4497-9689-b2257864e63f | \n
\n\n| limit | \ninteger | \nExample: limit=20
Maximum number of rows returned per page. | \n
\n\n| page | \ninteger | \nExample: page=1
This parameter says which results page you want to get. If both page and limit appear, then page rows are skipped before starting to count the limit rows that are returned. | \n
\n\n| includeTotalCount | \nboolean | \nExample: includeTotalCount=false
Returns total count of persons, if set to true. | \n
\n\n| orderBy | \nstring | \nExample: orderBy=modifiedAt:desc
Results ordering. Possible ordering fields are firstName, lastName, createdAt and modifiedAt. Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one | \n
\n\n| filter | \nstring | \nExample: filter={\"#and\":[{\"firstName\":\"Alex\"},{\"#contains\": { \"tags\":\"VIP Client\"}}]}}
Allows to filter persons using simple queries. Just pass to the parameter URL encoded query | \n
\n\n
\n
List of supported logical operators:
\n\n\n\n| Logical Operator | \nDescription | \n
\n\n\n\n#and | \nJoins query clauses with a logical AND returns all records that match the conditions of both clauses. | \n
\n\n#or | \nJoins query clauses with a logical OR returns all records that match the conditions of either clause. | \n
\n\n
\n
List of supported comparison operators:
\n\n\n\n| Comparison Operator | \nSupported Type | \nDescription | \n
\n\n\n\n#eq | \nstring, integer, decimal, date | \nMatches values that are equal to a specified value. | \n
\n\n#ne | \nstring, integer, decimal, date | \nMatches all values that are not equal to a specified value. | \n
\n\n#contains | \nstring | \nMatches the records that contain a specified value. | \n
\n\n#startsWith | \nstring | \nMatches the records that start with a specified value. | \n
\n\n#endsWith | \nstring | \nMatches the records that end with a specified value. | \n
\n\n#gt | \ninteger, decimal, date | \nMatches values that are greater than a specified value. | \n
\n\n#lt | \ninteger, decimal, date | \nMatches values that are less than a specified value. | \n
\n\n#gte | \ninteger, decimal, date | \nMatches values that are greater than or equal to a specified value. | \n
\n\n#lte | \ninteger, decimal, date | \nMatches values that are less than or equal to a specified value. | \n
\n\n
\n
Paging and ordering
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\nlimit | \nint | \nIf a limit count is given, no more than that many rows will be returned (possibly less, if the query itself yields fewer rows). The default value is 20. The maximum value is 1000. | \n
\n\npage | \nint | \nThis parameter says to skip that many rows before beginning to return rows. If both page and limit appear, then page rows are skipped before starting to count the limit rows that are returned. The default value is 1. | \n
\n\norderBy | \nstring | \nThis parameter is used to order your results. If an order is not given, the default order modifiedAt:desc will be applied. | \n
\n\n
\n
Responses
\nDefault sucessful response
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| address | \nstring | \nPerson's address, 256 characters max | \n
\n\n| birthDate | \nstring | \nPerson's date of birth, format YYYY-MM-DD | \n
\n\n| city | \nstring | \nPerson's city, 50 characters max | \n
\n\ncomputedAttributes
{
property name*
{ }
} | \nobject
object | \nPerson's computed attributes grouped by type | \n
\n\ncontactInformation
{
email
[{
address
}] ,
phone
[{
number
}] ,
facebook
[{
applicationId,
userId,
systemData
{
property name
}
}],
instagram
[{
applicationId,
userId,
systemData
{
property name
}
}],
liveChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
telegram
[{
applicationId,
userId,
systemData
{
property name
}
}],
viberBots
[{
applicationId,
userId,
systemData
{
property name
}
}],
twitter
[{
applicationId,
userId,
systemData
{
property name
}
}],
webpush
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
},
push
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
}
}],
appleBusinessChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
line
[{
applicationId,
userId,
systemData
{
property name
}
}]
}
| \nobject
array of objects
string
array of objects
string
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
object
array of objects
string
string
object
object
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
| \nRequired
List of phones, emails and other information how a person can be contacted
A list of person's email addresses. Max 100 emails per person.
Person's email address. Must comply with the email format and cannot exceed 255characters. One person can have up to 100 email addresses.
A list of person's phone numbers. Max 100 numbers per person.
Person's phone number. Must be in international format and cannot exceed 50 characters. One person can have up to 100 phone numbers.
A list of person's Facebook destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Instagram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Live Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's telegram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Viber Bots destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's twitter destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's web push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's Apple Business Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Line destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
| \n
\n\n| country | \nstring | \nPerson's country, 50 characters max | \n
\n\ncustomAttributes
{
property name*
{ }
} | \nobject
object | \nList of custom attributes for the person, 4096 characters max per value | \n
\n\n| externalId | \nstring | \nUnique ID for a person from your or another external system, 256 characters max | \n
\n\n| firstName | \nstring | \nPerson's first name, 255 characters max | \n
\n\n| gender | \nstring | \nEnum: \"MALE\" \"FEMALE\"
Person's gender | \n
\n\nintegrations
{
salesforce
{
contactId
leadId
}
} | \nobject
object
string
string
| \nIntegrations
Salesforce integration
Salesforce contact id
Salesforce lead id | \n
\n\n| lastName | \nstring | \nPerson's last name, 255 characters max | \n
\n\n| middleName | \nstring | \nPerson's middle name, 50 characters max | \n
\n\n| profilePicture | \nstring | \nURL for the person's profile picture, 2083 characters max | \n
\n\n| tags | \narray of
strings | \nList of tags that this person has | \n
\n\n| type | \nstring | \nEnum: \"CUSTOMER\" \"LEAD\"
Person's type, default type is CUSTOMER | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional parameters
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| identifier | \nString | \nPerson ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| contactInformation.instagramDm | \nArray | \nA list of person's Instagram DM destinations. | \n
\n\n| contactInformation.kakaoSangdam | \nArray | \nA list of person's Kakao Sangdam destinations. | \n
\n\n| contactInformation.kakaoTalk | \nArray | \nA list of person's KakaoTalk destinations. | \n
\n\n| contactInformation.openChannel | \nArray | \nA list of person's Open Channel destinations. | \n
\n\n| contactInformation.push[].isPrimary | \nBoolean | \nSet to true if this device is a primary device of a user among other devices. | \n
\n\n| contactInformation.tiktokBm | \nArray | \nA list of person's TikTok Business Messaging destinations. | \n
\n\n| contactInformation.whatsapp | \nArray | \nA list of person's WhatsApp destinations. | \n
\n\n| contactInformation.zaloFollower | \nArray | \nA list of person's Zalo Follower destinations. | \n
\n\n| modifiedFrom | \n | \nThe information which describes the source of the last modification of record. | \n
\n\n| origin | \n | \nThe information which describes the origin of the record. | \n
\n\n| preferredLanguage | \nString | \nPerson's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format. | \n
\n\n
\n
Use this method to overwrite a person profile with the data passed in the request body as follows:
1. New values for standard and custom profile attributes replace existing values on the profile. If no value is passed in the request, the attribute is set to empty.
2. Tags in the request replace the existing profile tags. If no tags are passed, the existing profile tag list is cleared.
3. New contact information (email addresses and phone numbers) in the request replaces the current information on the profile.
\nRequest rate limit
\n5 requests / second (per account)
\nQuery parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| phone | \nstring | \nExample: phone=46701234567
Person’s phone number. Phone numbers must be in international format. | \n
\n\n| email | \nstring | \nExample: email=name@example.com
Person’s email address. Must comply with the email format and cannot exceed 255 characters. One person can have up to 100 email addresses. | \n
\n\n| externalId | \nstring | \nExample: externalId=6F9619FF-8B86-D011-B42D-00CF4FC964FF
Unique ID for a person from your or another external system. | \n
\n\n| pushRegistrationId | \nstring | \nExample: pushRegistrationId=6F9619FF-8B86-D011-B42D-00CF4FC964FF
Person's push registration ID. | \n
\n\n| id | \ninteger | \nExample: id=11351351
Person's internal ID. | \n
\n\n| lineId | \nstring | \nExample: lineId=U045147f1ad961bfe996b72bbf417f3c9
Person’s Line ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameters. | \n
\n\n| lineSenderId | \nstring | \nExample: lineSenderId=1644264921
Person’s Line sender ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameter | \n
\n\n| facebookId | \nstring | \nExample: facebookId=370329180020364
Person’s Facebook ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters. | \n
\n\n| facebookSenderId | \ninteger | \nExample: facebookSenderId=2094832040560427
Person’s Facebook sender ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters. | \n
\n\n| telegramUserId | \nstring | \nExample: telegramUserId=1303201999
Person’s Telegram user ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters. | \n
\n\n| telegramBotId | \nstring | \nExample: telegramBotId=1495032701
Person’s Telegram bot ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters. | \n
\n\n| viberBotUserId | \nstring | \nExample: viberBotUserId=Upk26V/i1GXfvxZ8S41P/w==
Person’s Viber Bot user ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters. | \n
\n\n| viberBotId | \n
integer | \nExample: viberBotId=5591458813882487336
Person’s Viber Bot ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters. | \n
\n\n| instagramId | \nstring | \nExample: instagramId=17841546155331428
Person’s Instagram user ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters. | \n
\n\n| instagramSenderId | \ninteger | \nExample: instagramSenderId=17841405793187218
Person’s Instagram sender ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters. | \n
\n\n| twitterId | \nstring | \nexample: twitterId=370329180020364
Person’s Twitter user ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters. | \n
\n\n| twitterSenderId | \ninteger | \nExample: twitterSenderId=10765432100123456789
Person’s Twitter sender ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters. | \n
\n\n| appleBusinessChatId | \nstring | \nExample: appleBusinessChatId=ef6ca8e9-3718-4dc9-a9a0-b4ac28d135ca
Person’s Apple Business Chat ID. To get person by Apple BC channel, you need to specify both appleBusinessChatId and appleBusinessChatSenderId parameters. | \n
\n\n| appleBusinessChatSenderId | \nstring | \nExample: appleBusinessChatSenderId=urn:mbid:AQAAYyUbut3B2E3T9GLv4EaF/
Person’s Apple Business Chat sender ID. To get person by Apple BC channel, you need to specify both appleBusinessChatId and appleBusinessChatSenderId parameters. | \n
\n\n| liveChatRegId | \nstring | \nExample: liveChatRegId=79f9701b-e350-4497-9689-b2257864e63f | \n
\n\n
\n
Request body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| address | \nstring | \nPerson's address, 256 characters max | \n
\n\n| birthDate | \nstring | \nPerson's date of birth, format YYYY-MM-DD | \n
\n\n| city | \nstring | \nPerson's city, 50 characters max | \n
\n\ncomputedAttributes
{
property name*
{ }
} | \nobject
object | \nPerson's computed attributes grouped by type | \n
\n\ncontactInformation
{
email
[{
address
}] ,
phone
[{
number
}] ,
facebook
[{
applicationId,
userId,
systemData
{
property name
}
}],
instagram
[{
applicationId,
userId,
systemData
{
property name
}
}],
liveChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
telegram
[{
applicationId,
userId,
systemData
{
property name
}
}],
viberBots
[{
applicationId,
userId,
systemData
{
property name
}
}],
twitter
[{
applicationId,
userId,
systemData
{
property name
}
}],
webpush
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
},
push
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
}
}],
appleBusinessChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
line
[{
applicationId,
userId,
systemData
{
property name
}
}]
}
| \nobject
array of objects
string
array of objects
string
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
object
array of objects
string
string
object
object
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
| \nRequired
List of phones, emails and other information how a person can be contacted
A list of person's email addresses. Max 100 emails per person.
Person's email address. Must comply with the email format and cannot exceed 255characters. One person can have up to 100 email addresses.
A list of person's phone numbers. Max 100 numbers per person.
Person's phone number. Must be in international format and cannot exceed 50 characters. One person can have up to 100 phone numbers.
A list of person's Facebook destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Instagram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Live Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's telegram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Viber Bots destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's twitter destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's web push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's Apple Business Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Line destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
| \n
\n\n| country | \nstring | \nPerson's country, 50 characters max | \n
\n\ncustomAttributes
{
property name*
{ }
} | \nobject
object | \nList of custom attributes for the person, 4096 characters max per value | \n
\n\n| externalId | \nstring | \nUnique ID for a person from your or another external system, 256 characters max | \n
\n\n| firstName | \nstring | \nPerson's first name, 255 characters max | \n
\n\n| gender | \nstring | \nEnum: \"MALE\" \"FEMALE\"
Person's gender | \n
\n\nintegrations
{
salesforce
{
contactId
leadId
}
} | \nobject
object
string
string
| \nIntegrations
Salesforce integration
Salesforce contact id
Salesforce lead id | \n
\n\n| lastName | \nstring | \nPerson's last name, 255 characters max | \n
\n\n| middleName | \nstring | \nPerson's middle name, 50 characters max | \n
\n\n| profilePicture | \nstring | \nURL for the person's profile picture, 2083 characters max | \n
\n\n| tags | \narray of
strings | \nList of tags that this person has | \n
\n\n| type | \nstring | \nEnum: \"CUSTOMER\" \"LEAD\"
Person's type, default type is CUSTOMER | \n
\n\n
\n
Responses
\nDefault sucessful response
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| address | \nstring | \nPerson's address, 256 characters max | \n
\n\n| birthDate | \nstring | \nPerson's date of birth, format YYYY-MM-DD | \n
\n\n| city | \nstring | \nPerson's city, 50 characters max | \n
\n\ncomputedAttributes
{
property name*
{ }
} | \nobject
object | \nPerson's computed attributes grouped by type | \n
\n\ncontactInformation
{
email
[{
address
}] ,
phone
[{
number
}] ,
facebook
[{
applicationId,
userId,
systemData
{
property name
}
}],
instagram
[{
applicationId,
userId,
systemData
{
property name
}
}],
liveChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
telegram
[{
applicationId,
userId,
systemData
{
property name
}
}],
viberBots
[{
applicationId,
userId,
systemData
{
property name
}
}],
twitter
[{
applicationId,
userId,
systemData
{
property name
}
}],
webpush
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
},
push
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
}
}],
appleBusinessChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
line
[{
applicationId,
userId,
systemData
{
property name
}
}]
}
| \nobject
array of objects
string
array of objects
string
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
object
array of objects
string
string
object
object
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
| \nRequired
List of phones, emails and other information how a person can be contacted
A list of person's email addresses. Max 100 emails per person.
Person's email address. Must comply with the email format and cannot exceed 255characters. One person can have up to 100 email addresses.
A list of person's phone numbers. Max 100 numbers per person.
Person's phone number. Must be in international format and cannot exceed 50 characters. One person can have up to 100 phone numbers.
A list of person's Facebook destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Instagram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Live Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's telegram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Viber Bots destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's twitter destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's web push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's Apple Business Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Line destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
| \n
\n\n| country | \nstring | \nPerson's country, 50 characters max | \n
\n\ncustomAttributes
{
property name*
{ }
} | \nobject
object | \nList of custom attributes for the person, 4096 characters max per value | \n
\n\n| externalId | \nstring | \nUnique ID for a person from your or another external system, 256 characters max | \n
\n\n| firstName | \nstring | \nPerson's first name, 255 characters max | \n
\n\n| gender | \nstring | \nEnum: \"MALE\" \"FEMALE\"
Person's gender | \n
\n\nintegrations
{
salesforce
{
contactId
leadId
}
} | \nobject
object
string
string
| \nIntegrations
Salesforce integration
Salesforce contact id
Salesforce lead id | \n
\n\n| lastName | \nstring | \nPerson's last name, 255 characters max | \n
\n\n| middleName | \nstring | \nPerson's middle name, 50 characters max | \n
\n\n| profilePicture | \nstring | \nURL for the person's profile picture, 2083 characters max | \n
\n\n| tags | \narray of
strings | \nList of tags that this person has | \n
\n\n| type | \nstring | \nEnum: \"CUSTOMER\" \"LEAD\"
Person's type, default type is CUSTOMER | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional parameters
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| identifier | \nString | \nPerson ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| contactInformation.instagramDm | \nArray | \nA list of person's Instagram DM destinations. | \n
\n\n| contactInformation.kakaoSangdam | \nArray | \nA list of person's Kakao Sangdam destinations. | \n
\n\n| contactInformation.kakaoTalk | \nArray | \nA list of person's KakaoTalk destinations. | \n
\n\n| contactInformation.openChannel | \nArray | \nA list of person's Open Channel destinations. | \n
\n\n| contactInformation.push[].isPrimary | \nBoolean | \nSet to true if this device is a primary device of a user among other devices. | \n
\n\n| contactInformation.tiktokBm | \nArray | \nA list of person's TikTok Business Messaging destinations. | \n
\n\n| contactInformation.whatsapp | \nArray | \nA list of person's WhatsApp destinations. | \n
\n\n| contactInformation.zaloFollower | \nArray | \nA list of person's Zalo Follower destinations. | \n
\n\n| createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedFrom | \n | \nThe information which describes the source of the last modification of record. | \n
\n\n| origin | \n | \nThe information which describes the origin of the record. | \n
\n\n| preferredLanguage | \nString | \nPerson's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format. | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| contactInformation.instagramDm | \nArray | \nA list of person's Instagram DM destinations. | \n
\n\n| contactInformation.kakaoSangdam | \nArray | \nA list of person's Kakao Sangdam destinations. | \n
\n\n| contactInformation.kakaoTalk | \nArray | \nA list of person's KakaoTalk destinations. | \n
\n\n| contactInformation.openChannel | \nArray | \nA list of person's Open Channel destinations. | \n
\n\n| contactInformation.push[].isPrimary | \nBoolean | \nSet to true if this device is a primary device of a user among other devices. | \n
\n\n| contactInformation.tiktokBm | \nArray | \nA list of person's TikTok Business Messaging destinations. | \n
\n\n| contactInformation.whatsapp | \nArray | \nA list of person's WhatsApp destinations. | \n
\n\n| contactInformation.zaloFollower | \nArray | \nA list of person's Zalo Follower destinations. | \n
\n\n| createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedFrom | \n | \nThe information which describes the source of the last modification of record. | \n
\n\n| origin | \n | \nThe information which describes the origin of the record. | \n
\n\n| preferredLanguage | \nString | \nPerson's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format. | \n
\n\n
\n
Partial person update
\nUse this method to update a person profile with the data passed in the request body as follows:
1. New values for standard and custom profile attributes replace existing values on the profile. If no value is passed in the request, the attribute keeps its value.
2. Tags in the request are appended to the profile tag list.
3. New contact information (email addresses and phone numbers) in the request is appended to the contact list of the profile.
\nRequest rate limit
\n5 requests / second (per account)
\nQuery parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| phone | \nstring | \nExample: phone=46701234567
Person’s phone number. Phone numbers must be in international format. | \n
\n\n| email | \nstring | \nExample: email=name@example.com
Person’s email address. Must comply with the email format and cannot exceed 255 characters. One person can have up to 100 email addresses. | \n
\n\n| externalId | \nstring | \nExample: externalId=6F9619FF-8B86-D011-B42D-00CF4FC964FF
Unique ID for a person from your or another external system. | \n
\n\n| pushRegistrationId | \nstring | \nExample: pushRegistrationId=6F9619FF-8B86-D011-B42D-00CF4FC964FF
Person's push registration ID. | \n
\n\n| id | \ninteger | \nExample: id=11351351
Person's internal ID. | \n
\n\n| lineId | \nstring | \nExample: lineId=U045147f1ad961bfe996b72bbf417f3c9
Person’s Line ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameters. | \n
\n\n| lineSenderId | \nstring | \nExample: lineSenderId=1644264921
Person’s Line sender ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameter | \n
\n\n| facebookId | \nstring | \nExample: facebookId=370329180020364
Person’s Facebook ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters. | \n
\n\n| facebookSenderId | \ninteger | \nExample: facebookSenderId=2094832040560427
Person’s Facebook sender ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters. | \n
\n\n| telegramUserId | \nstring | \nExample: telegramUserId=1303201999
Person’s Telegram user ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters. | \n
\n\n| telegramBotId | \nstring | \nExample: telegramBotId=1495032701
Person’s Telegram bot ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters. | \n
\n\n| viberBotUserId | \nstring | \nExample: viberBotUserId=Upk26V/i1GXfvxZ8S41P/w==
Person’s Viber Bot user ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters. | \n
\n\n| viberBotId | \n
integer | \nExample: viberBotId=5591458813882487336
Person’s Viber Bot ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters. | \n
\n\n| instagramId | \nstring | \nExample: instagramId=17841546155331428
Person’s Instagram user ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters. | \n
\n\n| instagramSenderId | \ninteger | \nExample: instagramSenderId=17841405793187218
Person’s Instagram sender ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters. | \n
\n\n| twitterId | \nstring | \nexample: twitterId=370329180020364
Person’s Twitter user ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters. | \n
\n\n| twitterSenderId | \ninteger | \nExample: twitterSenderId=10765432100123456789
Person’s Twitter sender ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters. | \n
\n\n| appleBusinessChatId | \nstring | \nExample: appleBusinessChatId=ef6ca8e9-3718-4dc9-a9a0-b4ac28d135ca
Person’s Apple Business Chat ID. To get person by Apple BC channel, you need to specify both appleBusinessChatId and appleBusinessChatSenderId parameters. | \n
\n\n| appleBusinessChatSenderId | \nstring | \nExample: appleBusinessChatSenderId=urn:mbid:AQAAYyUbut3B2E3T9GLv4EaF/
Person’s Apple Business Chat sender ID. To get person by Apple BC channel, you need to specify both appleBusinessChatId and appleBusinessChatSenderId parameters. | \n
\n\n| liveChatRegId | \nstring | \nExample: liveChatRegId=79f9701b-e350-4497-9689-b2257864e63f | \n
\n\n
\n
Request body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| address | \nstring | \nPerson's address, 256 characters max | \n
\n\n| birthDate | \nstring | \nPerson's date of birth, format YYYY-MM-DD | \n
\n\n| city | \nstring | \nPerson's city, 50 characters max | \n
\n\ncomputedAttributes
{
property name*
{ }
} | \nobject
object | \nPerson's computed attributes grouped by type | \n
\n\ncontactInformation
{
email
[{
address
}] ,
phone
[{
number
}] ,
facebook
[{
applicationId,
userId,
systemData
{
property name
}
}],
instagram
[{
applicationId,
userId,
systemData
{
property name
}
}],
liveChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
telegram
[{
applicationId,
userId,
systemData
{
property name
}
}],
viberBots
[{
applicationId,
userId,
systemData
{
property name
}
}],
twitter
[{
applicationId,
userId,
systemData
{
property name
}
}],
webpush
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
},
push
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
}
}],
appleBusinessChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
line
[{
applicationId,
userId,
systemData
{
property name
}
}]
}
| \nobject
array of objects
string
array of objects
string
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
object
array of objects
string
string
object
object
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
| \nRequired
List of phones, emails and other information how a person can be contacted
A list of person's email addresses. Max 100 emails per person.
Person's email address. Must comply with the email format and cannot exceed 255characters. One person can have up to 100 email addresses.
A list of person's phone numbers. Max 100 numbers per person.
Person's phone number. Must be in international format and cannot exceed 50 characters. One person can have up to 100 phone numbers.
A list of person's Facebook destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Instagram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Live Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's telegram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Viber Bots destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's twitter destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's web push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's Apple Business Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Line destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
| \n
\n\n| country | \nstring | \nPerson's country, 50 characters max | \n
\n\ncustomAttributes
{
property name*
{ }
} | \nobject
object | \nList of custom attributes for the person, 4096 characters max per value | \n
\n\n| externalId | \nstring | \nUnique ID for a person from your or another external system, 256 characters max | \n
\n\n| firstName | \nstring | \nPerson's first name, 255 characters max | \n
\n\n| gender | \nstring | \nEnum: \"MALE\" \"FEMALE\"
Person's gender | \n
\n\nintegrations
{
salesforce
{
contactId
leadId
}
} | \nobject
object
string
string
| \nIntegrations
Salesforce integration
Salesforce contact id
Salesforce lead id | \n
\n\n| lastName | \nstring | \nPerson's last name, 255 characters max | \n
\n\n| middleName | \nstring | \nPerson's middle name, 50 characters max | \n
\n\n| profilePicture | \nstring | \nURL for the person's profile picture, 2083 characters max | \n
\n\n| tags | \narray of
strings | \nList of tags that this person has | \n
\n\n| type | \nstring | \nEnum: \"CUSTOMER\" \"LEAD\"
Person's type, default type is CUSTOMER | \n
\n\n
\n
Responses
\nDefault sucessful response
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| address | \nstring | \nPerson's address, 256 characters max | \n
\n\n| birthDate | \nstring | \nPerson's date of birth, format YYYY-MM-DD | \n
\n\n| city | \nstring | \nPerson's city, 50 characters max | \n
\n\ncomputedAttributes
{
property name*
{ }
} | \nobject
object | \nPerson's computed attributes grouped by type | \n
\n\ncontactInformation
{
email
[{
address
}] ,
phone
[{
number
}] ,
facebook
[{
applicationId,
userId,
systemData
{
property name
}
}],
instagram
[{
applicationId,
userId,
systemData
{
property name
}
}],
liveChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
telegram
[{
applicationId,
userId,
systemData
{
property name
}
}],
viberBots
[{
applicationId,
userId,
systemData
{
property name
}
}],
twitter
[{
applicationId,
userId,
systemData
{
property name
}
}],
webpush
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
},
push
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
}
}],
appleBusinessChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
line
[{
applicationId,
userId,
systemData
{
property name
}
}]
}
| \nobject
array of objects
string
array of objects
string
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
object
array of objects
string
string
object
object
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
| \nRequired
List of phones, emails and other information how a person can be contacted
A list of person's email addresses. Max 100 emails per person.
Person's email address. Must comply with the email format and cannot exceed 255characters. One person can have up to 100 email addresses.
A list of person's phone numbers. Max 100 numbers per person.
Person's phone number. Must be in international format and cannot exceed 50 characters. One person can have up to 100 phone numbers.
A list of person's Facebook destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Instagram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Live Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's telegram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Viber Bots destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's twitter destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's web push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's Apple Business Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Line destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
| \n
\n\n| country | \nstring | \nPerson's country, 50 characters max | \n
\n\ncustomAttributes
{
property name*
{ }
} | \nobject
object | \nList of custom attributes for the person, 4096 characters max per value | \n
\n\n| externalId | \nstring | \nUnique ID for a person from your or another external system, 256 characters max | \n
\n\n| firstName | \nstring | \nPerson's first name, 255 characters max | \n
\n\n| gender | \nstring | \nEnum: \"MALE\" \"FEMALE\"
Person's gender | \n
\n\nintegrations
{
salesforce
{
contactId
leadId
}
} | \nobject
object
string
string
| \nIntegrations
Salesforce integration
Salesforce contact id
Salesforce lead id | \n
\n\n| lastName | \nstring | \nPerson's last name, 255 characters max | \n
\n\n| middleName | \nstring | \nPerson's middle name, 50 characters max | \n
\n\n| profilePicture | \nstring | \nURL for the person's profile picture, 2083 characters max | \n
\n\n| tags | \narray of
strings | \nList of tags that this person has | \n
\n\n| type | \nstring | \nEnum: \"CUSTOMER\" \"LEAD\"
Person's type, default type is CUSTOMER | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional parameters
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| identifier | \nString | \nPerson ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| contactInformation.instagramDm | \nArray | \nA list of person's Instagram DM destinations. | \n
\n\n| contactInformation.kakaoSangdam | \nArray | \nA list of person's Kakao Sangdam destinations. | \n
\n\n| contactInformation.kakaoTalk | \nArray | \nA list of person's KakaoTalk destinations. | \n
\n\n| contactInformation.openChannel | \nArray | \nA list of person's Open Channel destinations. | \n
\n\n| contactInformation.push[].isPrimary | \nBoolean | \nSet to true if this device is a primary device of a user among other devices. | \n
\n\n| contactInformation.tiktokBm | \nArray | \nA list of person's TikTok Business Messaging destinations. | \n
\n\n| contactInformation.whatsapp | \nArray | \nA list of person's WhatsApp destinations. | \n
\n\n| contactInformation.zaloFollower | \nArray | \nA list of person's Zalo Follower destinations. | \n
\n\n| createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedFrom | \n | \nThe information which describes the source of the last modification of record. | \n
\n\n| origin | \n | \nThe information which describes the origin of the record. | \n
\n\n| preferredLanguage | \nString | \nPerson's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format. | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| contactInformation.instagramDm | \nArray | \nA list of person's Instagram DM destinations. | \n
\n\n| contactInformation.kakaoSangdam | \nArray | \nA list of person's Kakao Sangdam destinations. | \n
\n\n| contactInformation.kakaoTalk | \nArray | \nA list of person's KakaoTalk destinations. | \n
\n\n| contactInformation.openChannel | \nArray | \nA list of person's Open Channel destinations. | \n
\n\n| contactInformation.push[].isPrimary | \nBoolean | \nSet to true if this device is a primary device of a user among other devices. | \n
\n\n| contactInformation.tiktokBm | \nArray | \nA list of person's TikTok Business Messaging destinations. | \n
\n\n| contactInformation.whatsapp | \nArray | \nA list of person's WhatsApp destinations. | \n
\n\n| contactInformation.zaloFollower | \nArray | \nA list of person's Zalo Follower destinations. | \n
\n\n| createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedFrom | \n | \nThe information which describes the source of the last modification of record. | \n
\n\n| origin | \n | \nThe information which describes the origin of the record. | \n
\n\n| preferredLanguage | \nString | \nPerson's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format. | \n
\n\n
\n
Use this method to replace contact information for a particular person. This methods will replace all existing emails and mobile phones with new contact information.
\nRequest rate limit
\n5 requests / second (per account)
\nQuery parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| phone | \nstring | \nExample: phone=46701234567
Person’s phone number. Phone numbers must be in international format. | \n
\n\n| email | \nstring | \nExample: email=name@example.com
Person’s email address. Must comply with the email format and cannot exceed 255 characters. One person can have up to 100 email addresses. | \n
\n\n| externalId | \nstring | \nExample: externalId=6F9619FF-8B86-D011-B42D-00CF4FC964FF
Unique ID for a person from your or another external system. | \n
\n\n| pushRegistrationId | \nstring | \nExample: pushRegistrationId=6F9619FF-8B86-D011-B42D-00CF4FC964FF
Person's push registration ID. | \n
\n\n| id | \nineger | \nExample: id=11351351
Person's internal ID. | \n
\n\n| lineId | \nstring | \nExample: lineId=U045147f1ad961bfe996b72bbf417f3c9
Person’s Line ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameters. | \n
\n\n| lineSenderId | \nstring | \nExample: lineSenderId=1644264921
Person’s Line sender ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameter | \n
\n\n| facebookId | \nstring | \nExample: facebookId=370329180020364
Person’s Facebook ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters. | \n
\n\n| facebookSenderId | \ninteger | \nExample: facebookSenderId=2094832040560427
Person’s Facebook sender ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters. | \n
\n\n| telegramUserId | \nstring | \nExample: telegramUserId=1303201999
Person’s Telegram user ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters. | \n
\n\n| telegramBotId | \nstring | \nExample: telegramBotId=1495032701
Person’s Telegram bot ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters. | \n
\n\n| viberBotUserId | \nstring | \nExample: viberBotUserId=Upk26V/i1GXfvxZ8S41P/w==
Person’s Viber Bot user ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters. | \n
\n\n| viberBotId | \n
integer | \nExample: viberBotId=5591458813882487336
Person’s Viber Bot ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters. | \n
\n\n| instagramId | \nstring | \nExample: instagramId=17841546155331428
Person’s Instagram user ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters. | \n
\n\n| instagramSenderId | \ninteger | \nExample: instagramSenderId=17841405793187218
Person’s Instagram sender ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters. | \n
\n\n| twitterId | \nstring | \nexample: twitterId=370329180020364
Person’s Twitter user ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters. | \n
\n\n| twitterSenderId | \ninteger | \nExample: twitterSenderId=10765432100123456789
Person’s Twitter sender ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters. | \n
\n\n| appleBusinessChatId | \nstring | \nExample: appleBusinessChatId=ef6ca8e9-3718-4dc9-a9a0-b4ac28d135ca
Person’s Apple Business Chat ID. To get person by Apple BC channel, you need to specify both appleBusinessChatId and appleBusinessChatSenderId parameters. | \n
\n\n| appleBusinessChatSenderId | \nstring | \nExample: appleBusinessChatSenderId=urn:mbid:AQAAYyUbut3B2E3T9GLv4EaF/
Person’s Apple Business Chat sender ID. To get person by Apple BC channel, you need to specify both appleBusinessChatId and appleBusinessChatSenderId parameters. | \n
\n\n| liveChatRegId | \nstring | \nExample: liveChatRegId=79f9701b-e350-4497-9689-b2257864e63f | \n
\n\n
\n
Request body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\ncontactInformation
{
email
[{
address
}] ,
phone
[{
number
}]
}
| \nobject
array of objects
string
array of objects
string | \nRequired
List of phones, emails and other information how a person can be contacted
A list of person's email addresses. Max 100 emails per person.
Person's email address. Must comply with the email format and cannot exceed 255characters. One person can have up to 100 email addresses.
A list of person's phone numbers. Max 100 numbers per person.
Person's phone number. Must be in international format and cannot exceed 50 characters. One person can have up to 100 phone numbers. | \n
\n\n
\n
Responses
\nDefault sucessful response
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| address | \nstring | \nPerson's address, 256 characters max | \n
\n\n| birthDate | \nstring | \nPerson's date of birth, format YYYY-MM-DD | \n
\n\n| city | \nstring | \nPerson's city, 50 characters max | \n
\n\ncomputedAttributes
{
property name*
{ }
} | \nobject
object | \nPerson's computed attributes grouped by type | \n
\n\ncontactInformation
{
email
[{
address
}] ,
phone
[{
number
}] ,
facebook
[{
applicationId,
userId,
systemData
{
property name
}
}],
instagram
[{
applicationId,
userId,
systemData
{
property name
}
}],
liveChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
telegram
[{
applicationId,
userId,
systemData
{
property name
}
}],
viberBots
[{
applicationId,
userId,
systemData
{
property name
}
}],
twitter
[{
applicationId,
userId,
systemData
{
property name
}
}],
webpush
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
},
push
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
}
}],
appleBusinessChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
line
[{
applicationId,
userId,
systemData
{
property name
}
}]
}
| \nobject
array of objects
string
array of objects
string
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
object
array of objects
string
string
object
object
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
| \nRequired
List of phones, emails and other information how a person can be contacted
A list of person's email addresses. Max 100 emails per person.
Person's email address. Must comply with the email format and cannot exceed 255characters. One person can have up to 100 email addresses.
A list of person's phone numbers. Max 100 numbers per person.
Person's phone number. Must be in international format and cannot exceed 50 characters. One person can have up to 100 phone numbers.
A list of person's Facebook destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Instagram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Live Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's telegram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Viber Bots destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's twitter destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's web push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's Apple Business Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Line destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
| \n
\n\n| country | \nstring | \nPerson's country, 50 characters max | \n
\n\ncustomAttributes
{
property name*
{ }
} | \nobject
object | \nList of custom attributes for the person, 4096 characters max per value | \n
\n\n| externalId | \nstring | \nUnique ID for a person from your or another external system, 256 characters max | \n
\n\n| firstName | \nstring | \nPerson's first name, 255 characters max | \n
\n\n| gender | \nstring | \nEnum: \"MALE\" \"FEMALE\"
Person's gender | \n
\n\nintegrations
{
salesforce
{
contactId
leadId
}
} | \nobject
object
string
string
| \nIntegrations
Salesforce integration
Salesforce contact id
Salesforce lead id | \n
\n\n| lastName | \nstring | \nPerson's last name, 255 characters max | \n
\n\n| middleName | \nstring | \nPerson's middle name, 50 characters max | \n
\n\n| profilePicture | \nstring | \nURL for the person's profile picture, 2083 characters max | \n
\n\n| tags | \narray of
strings | \nList of tags that this person has | \n
\n\n| type | \nstring | \nEnum: \"CUSTOMER\" \"LEAD\"
Person's type, default type is CUSTOMER | \n
\n\n
\n
Responses
\nDefault sucesful response
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| address | \nstring | \nPerson's address, 256 characters max | \n
\n\n| birthDate | \nstring | \nPerson's date of birth, format YYYY-MM-DD | \n
\n\n| city | \nstring | \nPerson's city, 50 characters max | \n
\n\ncomputedAttributes
{
property name*
{ }
} | \nobject
object | \nPerson's computed attributes grouped by type | \n
\n\ncontactInformation
{
email
[{
address
}] ,
phone
[{
number
}] ,
facebook
[{
applicationId,
userId,
systemData
{
property name
}
}],
instagram
[{
applicationId,
userId,
systemData
{
property name
}
}],
liveChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
telegram
[{
applicationId,
userId,
systemData
{
property name
}
}],
viberBots
[{
applicationId,
userId,
systemData
{
property name
}
}],
twitter
[{
applicationId,
userId,
systemData
{
property name
}
}],
webpush
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
},
push
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
}
}],
appleBusinessChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
line
[{
applicationId,
userId,
systemData
{
property name
}
}]
}
| \nobject
array of objects
string
array of objects
string
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
object
array of objects
string
string
object
object
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
| \nRequired
List of phones, emails and other information how a person can be contacted
A list of person's email addresses. Max 100 emails per person.
Person's email address. Must comply with the email format and cannot exceed 255characters. One person can have up to 100 email addresses.
A list of person's phone numbers. Max 100 numbers per person.
Person's phone number. Must be in international format and cannot exceed 50 characters. One person can have up to 100 phone numbers.
A list of person's Facebook destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Instagram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Live Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's telegram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Viber Bots destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's twitter destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's web push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's Apple Business Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Line destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
| \n
\n\n| country | \nstring | \nPerson's country, 50 characters max | \n
\n\ncustomAttributes
{
property name*
{ }
} | \nobject
object | \nList of custom attributes for the person, 4096 characters max per value | \n
\n\n| externalId | \nstring | \nUnique ID for a person from your or another external system, 256 characters max | \n
\n\n| firstName | \nstring | \nPerson's first name, 255 characters max | \n
\n\n| gender | \nstring | \nEnum: \"MALE\" \"FEMALE\"
Person's gender | \n
\n\nintegrations
{
salesforce
{
contactId
leadId
}
} | \nobject
object
string
string
| \nIntegrations
Salesforce integration
Salesforce contact id
Salesforce lead id | \n
\n\n| lastName | \nstring | \nPerson's last name, 255 characters max | \n
\n\n| middleName | \nstring | \nPerson's middle name, 50 characters max | \n
\n\n| profilePicture | \nstring | \nURL for the person's profile picture, 2083 characters max | \n
\n\n| tags | \narray of
strings | \nList of tags that this person has | \n
\n\n| type | \nstring | \nEnum: \"CUSTOMER\" \"LEAD\"
Person's type, default type is CUSTOMER | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional parameters
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| identifier | \nString | \nPerson ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| contactInformation.instagramDm | \nArray | \nA list of person's Instagram DM destinations. | \n
\n\n| contactInformation.kakaoSangdam | \nArray | \nA list of person's Kakao Sangdam destinations. | \n
\n\n| contactInformation.kakaoTalk | \nArray | \nA list of person's KakaoTalk destinations. | \n
\n\n| contactInformation.openChannel | \nArray | \nA list of person's Open Channel destinations. | \n
\n\n| contactInformation.push[].isPrimary | \nBoolean | \nSet to true if this device is a primary device of a user among other devices. | \n
\n\n| contactInformation.tiktokBm | \nArray | \nA list of person's TikTok Business Messaging destinations. | \n
\n\n| contactInformation.whatsapp | \nArray | \nA list of person's WhatsApp destinations. | \n
\n\n| contactInformation.zaloFollower | \nArray | \nA list of person's Zalo Follower destinations. | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| contactInformation.instagramDm | \nArray | \nA list of person's Instagram DM destinations. | \n
\n\n| contactInformation.kakaoSangdam | \nArray | \nA list of person's Kakao Sangdam destinations. | \n
\n\n| contactInformation.kakaoTalk | \nArray | \nA list of person's KakaoTalk destinations. | \n
\n\n| contactInformation.openChannel | \nArray | \nA list of person's Open Channel destinations. | \n
\n\n| contactInformation.push[].isPrimary | \nBoolean | \nSet to true if this device is a primary device of a user among other devices. | \n
\n\n| contactInformation.tiktokBm | \nArray | \nA list of person's TikTok Business Messaging destinations. | \n
\n\n| contactInformation.whatsapp | \nArray | \nA list of person's WhatsApp destinations. | \n
\n\n| contactInformation.zaloFollower | \nArray | \nA list of person's Zalo Follower destinations. | \n
\n\n| createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedFrom | \n | \nThe information which describes the source of the last modification of record. | \n
\n\n| origin | \n | \nThe information which describes the origin of the record. | \n
\n\n| preferredLanguage | \nString | \nPerson's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format. | \n
\n\n
\n
Use this method to add emails and mobile phones to a particular person.
\nRequest rate limit
\n5 requests / second (per account)
\nQuery parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| phone | \nstring | \nExample: phone=46701234567
Person’s phone number. Phone numbers must be in international format. | \n
\n\n| email | \nstring | \nExample: email=name@example.com
Person’s email address. Must comply with the email format and cannot exceed 255 characters. One person can have up to 100 email addresses. | \n
\n\n| externalId | \nstring | \nExample: externalId=6F9619FF-8B86-D011-B42D-00CF4FC964FF
Unique ID for a person from your or another external system. | \n
\n\n| pushRegistrationId | \nstring | \nExample: pushRegistrationId=6F9619FF-8B86-D011-B42D-00CF4FC964FF
Person's push registration ID. | \n
\n\n| id | \ninteger | \nExample: id=11351351
Person's internal ID. | \n
\n\n| lineId | \nstring | \nExample: lineId=U045147f1ad961bfe996b72bbf417f3c9
Person’s Line ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameters. | \n
\n\n| lineSenderId | \nstring | \nExample: lineSenderId=1644264921
Person’s Line sender ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameter | \n
\n\n| facebookId | \nstring | \nExample: facebookId=370329180020364
Person’s Facebook ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters. | \n
\n\n| facebookSenderId | \ninteger | \nExample: facebookSenderId=2094832040560427
Person’s Facebook sender ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters. | \n
\n\n| telegramUserId | \nstring | \nExample: telegramUserId=1303201999
Person’s Telegram user ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters. | \n
\n\n| telegramBotId | \nstring | \nExample: telegramBotId=1495032701
Person’s Telegram bot ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters. | \n
\n\n| viberBotUserId | \nstring | \nExample: viberBotUserId=Upk26V/i1GXfvxZ8S41P/w==
Person’s Viber Bot user ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters. | \n
\n\n| viberBotId | \n
integer | \nExample: viberBotId=5591458813882487336
Person’s Viber Bot ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters. | \n
\n\n| instagramId | \nstring | \nExample: instagramId=17841546155331428
Person’s Instagram user ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters. | \n
\n\n| instagramSenderId | \ninteger | \nExample: instagramSenderId=17841405793187218
Person’s Instagram sender ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters. | \n
\n\n| twitterId | \nstring | \nexample: twitterId=370329180020364
Person’s Twitter user ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters. | \n
\n\n| twitterSenderId | \ninteger | \nExample: twitterSenderId=10765432100123456789
Person’s Twitter sender ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters. | \n
\n\n| appleBusinessChatId | \nstring | \nExample: appleBusinessChatId=ef6ca8e9-3718-4dc9-a9a0-b4ac28d135ca
Person’s Apple Business Chat ID. To get person by Apple BC channel, you need to specify both appleBusinessChatId and appleBusinessChatSenderId parameters. | \n
\n\n| appleBusinessChatSenderId | \nstring | \nExample: appleBusinessChatSenderId=urn:mbid:AQAAYyUbut3B2E3T9GLv4EaF/
Person’s Apple Business Chat sender ID. To get person by Apple BC channel, you need to specify both appleBusinessChatId and appleBusinessChatSenderId parameters. | \n
\n\n| liveChatRegId | \nstring | \nExample: liveChatRegId=79f9701b-e350-4497-9689-b2257864e63f | \n
\n\n
\n
Request body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\ncontactInformation
{
email
[{
address
}] ,
phone
[{
number
}]
}
| \nobject
array of objects
string
array of objects
string | \nRequired
List of phones, emails and other information how a person can be contacted
A list of person's email addresses. Max 100 emails per person.
Person's email address. Must comply with the email format and cannot exceed 255characters. One person can have up to 100 email addresses.
A list of person's phone numbers. Max 100 numbers per person.
Person's phone number. Must be in international format and cannot exceed 50 characters. One person can have up to 100 phone numbers. | \n
\n\n
\n
Responses
\nDefault sucesful response
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| address | \nstring | \nPerson's address, 256 characters max | \n
\n\n| birthDate | \nstring | \nPerson's date of birth, format YYYY-MM-DD | \n
\n\n| city | \nstring | \nPerson's city, 50 characters max | \n
\n\ncomputedAttributes
{
property name*
{ }
} | \nobject
object | \nPerson's computed attributes grouped by type | \n
\n\ncontactInformation
{
email
[{
address
}] ,
phone
[{
number
}] ,
facebook
[{
applicationId,
userId,
systemData
{
property name
}
}],
instagram
[{
applicationId,
userId,
systemData
{
property name
}
}],
liveChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
telegram
[{
applicationId,
userId,
systemData
{
property name
}
}],
viberBots
[{
applicationId,
userId,
systemData
{
property name
}
}],
twitter
[{
applicationId,
userId,
systemData
{
property name
}
}],
webpush
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
},
push
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
}
}],
appleBusinessChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
line
[{
applicationId,
userId,
systemData
{
property name
}
}]
}
| \nobject
array of objects
string
array of objects
string
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
object
array of objects
string
string
object
object
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
| \nRequired
List of phones, emails and other information how a person can be contacted
A list of person's email addresses. Max 100 emails per person.
Person's email address. Must comply with the email format and cannot exceed 255characters. One person can have up to 100 email addresses.
A list of person's phone numbers. Max 100 numbers per person.
Person's phone number. Must be in international format and cannot exceed 50 characters. One person can have up to 100 phone numbers.
A list of person's Facebook destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Instagram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Live Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's telegram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Viber Bots destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's twitter destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's web push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's Apple Business Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Line destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
| \n
\n\n| country | \nstring | \nPerson's country, 50 characters max | \n
\n\ncustomAttributes
{
property name*
{ }
} | \nobject
object | \nList of custom attributes for the person, 4096 characters max per value | \n
\n\n| externalId | \nstring | \nUnique ID for a person from your or another external system, 256 characters max | \n
\n\n| firstName | \nstring | \nPerson's first name, 255 characters max | \n
\n\n| gender | \nstring | \nEnum: \"MALE\" \"FEMALE\"
Person's gender | \n
\n\nintegrations
{
salesforce
{
contactId
leadId
}
} | \nobject
object
string
string
| \nIntegrations
Salesforce integration
Salesforce contact id
Salesforce lead id | \n
\n\n| lastName | \nstring | \nPerson's last name, 255 characters max | \n
\n\n| middleName | \nstring | \nPerson's middle name, 50 characters max | \n
\n\n| profilePicture | \nstring | \nURL for the person's profile picture, 2083 characters max | \n
\n\n| tags | \narray of
strings | \nList of tags that this person has | \n
\n\n| type | \nstring | \nEnum: \"CUSTOMER\" \"LEAD\"
Person's type, default type is CUSTOMER | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional parameters
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| identifier | \nString | \nPerson ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| contactInformation.instagramDm | \nArray | \nA list of person's Instagram DM destinations. | \n
\n\n| contactInformation.kakaoSangdam | \nArray | \nA list of person's Kakao Sangdam destinations. | \n
\n\n| contactInformation.kakaoTalk | \nArray | \nA list of person's KakaoTalk destinations. | \n
\n\n| contactInformation.openChannel | \nArray | \nA list of person's Open Channel destinations. | \n
\n\n| contactInformation.push[].isPrimary | \nBoolean | \nSet to true if this device is a primary device of a user among other devices. | \n
\n\n| contactInformation.tiktokBm | \nArray | \nA list of person's TikTok Business Messaging destinations. | \n
\n\n| contactInformation.whatsapp | \nArray | \nA list of person's WhatsApp destinations. | \n
\n\n| contactInformation.zaloFollower | \nArray | \nA list of person's Zalo Follower destinations. | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| contactInformation.instagramDm | \nArray | \nA list of person's Instagram DM destinations. | \n
\n\n| contactInformation.kakaoSangdam | \nArray | \nA list of person's Kakao Sangdam destinations. | \n
\n\n| contactInformation.kakaoTalk | \nArray | \nA list of person's KakaoTalk destinations. | \n
\n\n| contactInformation.openChannel | \nArray | \nA list of person's Open Channel destinations. | \n
\n\n| contactInformation.push[].isPrimary | \nBoolean | \nSet to true if this device is a primary device of a user among other devices. | \n
\n\n| contactInformation.tiktokBm | \nArray | \nA list of person's TikTok Business Messaging destinations. | \n
\n\n| contactInformation.whatsapp | \nArray | \nA list of person's WhatsApp destinations. | \n
\n\n| contactInformation.zaloFollower | \nArray | \nA list of person's Zalo Follower destinations. | \n
\n\n| createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedFrom | \n | \nThe information which describes the source of the last modification of record. | \n
\n\n| origin | \n | \nThe information which describes the origin of the record. | \n
\n\n| preferredLanguage | \nString | \nPerson's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format. | \n
\n\n
\n
Use this method to delete specified emails and mobile phones from a particular person.
\nRequest rate limit
\n5 requests / second (per account)
\nQuery parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| phone | \nstring | \nExample: phone=46701234567
Person’s phone number. Phone numbers must be in international format. | \n
\n\n| email | \nstring | \nExample: email=name@example.com
Person’s email address. Must comply with the email format and cannot exceed 255 characters. One person can have up to 100 email addresses. | \n
\n\n| externalId | \nstring | \nExample: externalId=6F9619FF-8B86-D011-B42D-00CF4FC964FF
Unique ID for a person from your or another external system. | \n
\n\n| pushRegistrationId | \nstring | \nExample: pushRegistrationId=6F9619FF-8B86-D011-B42D-00CF4FC964FF
Person's push registration ID. | \n
\n\n| id | \ninteger | \nExample: id=11351351
Person's internal ID. | \n
\n\n| lineId | \nstring | \nExample: lineId=U045147f1ad961bfe996b72bbf417f3c9
Person’s Line ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameters. | \n
\n\n| lineSenderId | \nstring | \nExample: lineSenderId=1644264921
Person’s Line sender ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameter | \n
\n\n| facebookId | \nstring | \nExample: facebookId=370329180020364
Person’s Facebook ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters. | \n
\n\n| facebookSenderId | \ninteger | \nExample: facebookSenderId=2094832040560427
Person’s Facebook sender ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters. | \n
\n\n| telegramUserId | \nstring | \nExample: telegramUserId=1303201999
Person’s Telegram user ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters. | \n
\n\n| telegramBotId | \nstring | \nExample: telegramBotId=1495032701
Person’s Telegram bot ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters. | \n
\n\n| viberBotUserId | \nstring | \nExample: viberBotUserId=Upk26V/i1GXfvxZ8S41P/w==
Person’s Viber Bot user ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters. | \n
\n\n| viberBotId | \n
integer | \nExample: viberBotId=5591458813882487336
Person’s Viber Bot ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters. | \n
\n\n| instagramId | \nstring | \nExample: instagramId=17841546155331428
Person’s Instagram user ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters. | \n
\n\n| instagramSenderId | \ninteger | \nExample: instagramSenderId=17841405793187218
Person’s Instagram sender ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters. | \n
\n\n| twitterId | \nstring | \nexample: twitterId=370329180020364
Person’s Twitter user ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters. | \n
\n\n| twitterSenderId | \ninteger | \nExample: twitterSenderId=10765432100123456789
Person’s Twitter sender ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters. | \n
\n\n| appleBusinessChatId | \nstring | \nExample: appleBusinessChatId=ef6ca8e9-3718-4dc9-a9a0-b4ac28d135ca
Person’s Apple Business Chat ID. To get person by Apple BC channel, you need to specify both appleBusinessChatId and appleBusinessChatSenderId parameters. | \n
\n\n| appleBusinessChatSenderId | \nstring | \nExample: appleBusinessChatSenderId=urn:mbid:AQAAYyUbut3B2E3T9GLv4EaF/
Person’s Apple Business Chat sender ID. To get person by Apple BC channel, you need to specify both appleBusinessChatId and appleBusinessChatSenderId parameters. | \n
\n\n| liveChatRegId | \nstring | \nExample: liveChatRegId=79f9701b-e350-4497-9689-b2257864e63f | \n
\n\n
\n
Request body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\ncontactInformation
{
email
[{
address
}] ,
phone
[{
number
}]
}
| \nobject
array of objects
string
array of objects
string | \nRequired
List of phones, emails and other information how a person can be contacted
A list of person's email addresses. Max 100 emails per person.
Person's email address. Must comply with the email format and cannot exceed 255characters. One person can have up to 100 email addresses.
A list of person's phone numbers. Max 100 numbers per person.
Person's phone number. Must be in international format and cannot exceed 50 characters. One person can have up to 100 phone numbers. | \n
\n\n
\n
Responses
\nDefault sucesful response
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| address | \nstring | \nPerson's address, 256 characters max | \n
\n\n| birthDate | \nstring | \nPerson's date of birth, format YYYY-MM-DD | \n
\n\n| city | \nstring | \nPerson's city, 50 characters max | \n
\n\ncomputedAttributes
{
property name*
{ }
} | \nobject
object | \nPerson's computed attributes grouped by type | \n
\n\ncontactInformation
{
email
[{
address
}] ,
phone
[{
number
}] ,
facebook
[{
applicationId,
userId,
systemData
{
property name
}
}],
instagram
[{
applicationId,
userId,
systemData
{
property name
}
}],
liveChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
telegram
[{
applicationId,
userId,
systemData
{
property name
}
}],
viberBots
[{
applicationId,
userId,
systemData
{
property name
}
}],
twitter
[{
applicationId,
userId,
systemData
{
property name
}
}],
webpush
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
},
push
[{
applicationId,
registrationId,
systemData
{
property name
},
additionalData
{
property name
}
}],
appleBusinessChat
[{
applicationId,
userId,
systemData
{
property name
}
}],
line
[{
applicationId,
userId,
systemData
{
property name
}
}]
}
| \nobject
array of objects
string
array of objects
string
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
object
array of objects
string
string
object
object
object
object
array of objects
string
string
object
object
array of objects
string
string
object
object
| \nRequired
List of phones, emails and other information how a person can be contacted
A list of person's email addresses. Max 100 emails per person.
Person's email address. Must comply with the email format and cannot exceed 255characters. One person can have up to 100 email addresses.
A list of person's phone numbers. Max 100 numbers per person.
Person's phone number. Must be in international format and cannot exceed 50 characters. One person can have up to 100 phone numbers.
A list of person's Facebook destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Instagram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Live Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's telegram destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Viber Bots destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's twitter destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's web push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's push registrations
Application Id on which the user is subscribed
Push registration ID
System data collected from the user's profile
Additional data collected from the destination
A list of person's Apple Business Chat destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
A list of person's Line destinations.
Application Id on which the user is subscribed
Unique user ID for a person
System data collected from the user's profile
| \n
\n\n| country | \nstring | \nPerson's country, 50 characters max | \n
\n\ncustomAttributes
{
property name*
{ }
} | \nobject
object | \nList of custom attributes for the person, 4096 characters max per value | \n
\n\n| externalId | \nstring | \nUnique ID for a person from your or another external system, 256 characters max | \n
\n\n| firstName | \nstring | \nPerson's first name, 255 characters max | \n
\n\n| gender | \nstring | \nEnum: \"MALE\" \"FEMALE\"
Person's gender | \n
\n\nintegrations
{
salesforce
{
contactId
leadId
}
} | \nobject
object
string
string
| \nIntegrations
Salesforce integration
Salesforce contact id
Salesforce lead id | \n
\n\n| lastName | \nstring | \nPerson's last name, 255 characters max | \n
\n\n| middleName | \nstring | \nPerson's middle name, 50 characters max | \n
\n\n| profilePicture | \nstring | \nURL for the person's profile picture, 2083 characters max | \n
\n\n| tags | \narray of
strings | \nList of tags that this person has | \n
\n\n| type | \nstring | \nEnum: \"CUSTOMER\" \"LEAD\"
Person's type, default type is CUSTOMER | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional parameters
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| identifier | \nString | \nPerson ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| contactInformation.instagramDm | \nArray | \nA list of person's Instagram DM destinations. | \n
\n\n| contactInformation.kakaoSangdam | \nArray | \nA list of person's Kakao Sangdam destinations. | \n
\n\n| contactInformation.kakaoTalk | \nArray | \nA list of person's KakaoTalk destinations. | \n
\n\n| contactInformation.openChannel | \nArray | \nA list of person's Open Channel destinations. | \n
\n\n| contactInformation.push[].isPrimary | \nBoolean | \nSet to true if this device is a primary device of a user among other devices. | \n
\n\n| contactInformation.tiktokBm | \nArray | \nA list of person's TikTok Business Messaging destinations. | \n
\n\n| contactInformation.whatsapp | \nArray | \nA list of person's WhatsApp destinations. | \n
\n\n| contactInformation.zaloFollower | \nArray | \nA list of person's Zalo Follower destinations. | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| contactInformation.instagramDm | \nArray | \nA list of person's Instagram DM destinations. | \n
\n\n| contactInformation.kakaoSangdam | \nArray | \nA list of person's Kakao Sangdam destinations. | \n
\n\n| contactInformation.kakaoTalk | \nArray | \nA list of person's KakaoTalk destinations. | \n
\n\n| contactInformation.openChannel | \nArray | \nA list of person's Open Channel destinations. | \n
\n\n| contactInformation.push[].isPrimary | \nBoolean | \nSet to true if this device is a primary device of a user among other devices. | \n
\n\n| contactInformation.tiktokBm | \nArray | \nA list of person's TikTok Business Messaging destinations. | \n
\n\n| contactInformation.whatsapp | \nArray | \nA list of person's WhatsApp destinations. | \n
\n\n| contactInformation.zaloFollower | \nArray | \nA list of person's Zalo Follower destinations. | \n
\n\n| createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedFrom | \n | \nThe information which describes the source of the last modification of record. | \n
\n\n| origin | \n | \nThe information which describes the origin of the record. | \n
\n\n| preferredLanguage | \nString | \nPerson's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format. | \n
\n\n
\n
Use this method to create multiple persons.
NOTE Array size of the batch create request is limited to 1000 persons
\nRequest rate limit
\n5 requests / second (per account)
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| people | \narray of objects | \nList of people | \n
\n\n
\n
Responses
\nDefault sucesful response
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \narray of objects | \nList of any unsuccessful result from the batch operation for each processed entry. Example, email used in the request already exists. | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| people[].address | \nString | \nPerson's address, 256 characters max. | \n
\n\n| people[].birthDate | \nString | \nPerson's date of birth, format YYYY-MM-DD. | \n
\n\n| people[].city | \nString | \nPerson's city, 50 characters max. | \n
\n\n| people[].computedAttributes | \nObject | \nPerson's computed attributes grouped by type. | \n
\n\n| people[].contactInformation | \n | \nList of phones, emails and other information how a person can be contacted. | \n
\n\n| people[].contactInformation.appleBusinessChat | \nArray | \nA list of person's Apple Business Chat destinations. | \n
\n\n| people[].contactInformation.appleBusinessChat[].applicationId | \nString | \nApplication Id on which the user is subscribed. | \n
\n\n| people[].contactInformation.appleBusinessChat[].systemData | \nObject | \nSystem data collected from the user's profile. | \n
\n\n| people[].contactInformation.appleBusinessChat[].userId | \nString | \nUnique user ID for a person. | \n
\n\n| people[].contactInformation.facebook | \nArray | \nA list of person's Messenger destinations. | \n
\n\n| people[].contactInformation.instagram | \nArray | \nA list of person's Instagram destinations. | \n
\n\n| people[].contactInformation.instagramDm | \nArray | \nA list of person's Instagram DM destinations. | \n
\n\n| people[].contactInformation.kakaoSangdam | \nArray | \nA list of person's Kakao Sangdam destinations. | \n
\n\n| people[].contactInformation.kakaoTalk | \nArray | \nA list of person's KakaoTalk destinations. | \n
\n\n| people[].contactInformation.line | \nArray | \nA list of person's Line destinations. | \n
\n\n| people[].contactInformation.liveChat | \nArray | \nA list of person's Live Chat destinations. | \n
\n\n| people[].contactInformation.openChannel | \nArray | \nA list of person's Open Channel destinations. | \n
\n\n| people[].contactInformation.phone | \nArray | \nA list of person's phone numbers. Max 100 numbers per person. | \n
\n\n| people[].contactInformation.phone[].number | \nString | \nPerson's phone number. Must be in international format and cannot exceed 50 characters. One person can have up to 100 phone numbers. | \n
\n\n| people[].contactInformation.push | \nArray | \nList of person's push registrations. | \n
\n\n| people[].contactInformation.push[].additionalData | \nObject | \nAdditional data collected from the user's profile | \n
\n\n| people[].contactInformation.push[].isPrimary | \nBoolean | \nSet to true if this device is a primary device of a user among other devices. | \n
\n\n| people[].contactInformation.push[].registrationId | \nString | \nPush registration ID. | \n
\n\n| people[].contactInformation.telegram | \nArray | \nA list of person's Telegram destinations. | \n
\n\n| people[].contactInformation.tiktokBm | \nArray | \nA list of person's TikTok Business Messaging destinations. | \n
\n\n| people[].contactInformation.twitter | \nArray | \nA list of person's Twitter destinations. | \n
\n\n| people[].contactInformation.viberBots | \nArray | \nA list of person's Viber Bots destinations. | \n
\n\n| people[].contactInformation.webpush | \nArray | \nA list of person's web push registrations | \n
\n\n| people[].contactInformation.whatsapp | \nArray | \nA list of person's WhatsApp destinations. | \n
\n\n| people[].contactInformation.zaloFollower | \nArray | \nA list of person's Zalo Follower destinations. | \n
\n\n| people[].country | \nString | \nPerson's country, 50 characters max. | \n
\n\n| people[].createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| people[].customAttributes | \nObject | \nList of custom attributes for the person, 4096 characters max per value. | \n
\n\n| people[].externalId | \nString | \nUnique ID for a person from your or another external system, 256 characters max. | \n
\n\n| people[].firstName | \nString | \nPerson's first name, 255 characters max. | \n
\n\n| people[].gender | \n | \nPerson's gender. | \n
\n\n| people[].id | \nInt | \nUnique id of the entity. | \n
\n\n| people[].integrations | \n | \nIntegrations. | \n
\n\n| people[].integrations.salesforce | \n | \nSalesforce integration. | \n
\n\n| people[].integrations.salesforce.contactId | \nString | \nSalesforce contact id. | \n
\n\n| people[].integrations.salesforce.leadId | \nString | \nSalesforce lead id. | \n
\n\n| people[].lastName | \nString | \nPerson's last name, 255 characters max. | \n
\n\n| people[].middleName | \nString | \nPerson's middle name, 50 characters max. | \n
\n\n| people[].modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| people[].modifiedFrom | \n | \nThe information which describes the source of the last modification of record. | \n
\n\n| people[].origin | \n | \nThe information which describes the origin of the record. | \n
\n\n| people[].preferredLanguage | \nString | \nPerson's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format. | \n
\n\n| people[].profilePicture | \nString | \nURL for the person's profile picture, 2083 characters max. | \n
\n\n| people[].tags | \nArray | \nList of tags that this person has. | \n
\n\n| people[].type | \n | \nPerson's type, default type is CUSTOMER. | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results[].errors | \nArray | \nList of errors | \n
\n\n| results[].index | \nInt | \nIndex of person in request list | \n
\n\n| results[].status | \nInt | \nHTTP status | \n
\n\n
\n
Use this method to update multiple persons.
NOTE Array size of the batch update request is limited to 1000 persons.
\nRequest rate limit
\n5 requests / second (per account)
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| people | \narray of objects | \nList of people | \n
\n\n
\n
Responses
\nDefault sucesful response
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \narray of objects | \nList of any unsuccessful result from the batch operation for each processed entry. Example, email used in the request already exists. | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| people[].query | \n | \n | \n
\n\n| people[].query.identifier | \nString | \nPerson ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request | \n
\n\n| people[].query.sender | \nString | \nSender or application ID. sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL. | \n
\n\n| people[].query.type | \n | \nType of the person ID. Can be one of the above | \n
\n\n| people[].update.address | \nString | \nPerson's address, 256 characters max. | \n
\n\n| people[].update.birthDate | \nString | \nPerson's date of birth, format YYYY-MM-DD. | \n
\n\n| people[].update.city | \nString | \nPerson's city, 50 characters max. | \n
\n\n| people[].update.computedAttributes | \nObject | \nPerson's computed attributes grouped by type. | \n
\n\n| people[].update.contactInformation | \n | \nList of phones, emails and other information how a person can be contacted. | \n
\n\n| people[].update.contactInformation.appleBusinessChat | \nArray | \nA list of person's Apple Business Chat destinations. | \n
\n\n| people[].update.contactInformation.appleBusinessChat[].applicationId | \nString | \nApplication Id on which the user is subscribed. | \n
\n\n| people[].update.contactInformation.appleBusinessChat[].systemData | \nObject | \nSystem data collected from the user's profile. | \n
\n\n| people[].update.contactInformation.appleBusinessChat[].userId | \nString | \nUnique user ID for a person. | \n
\n\n| people[].update.contactInformation.facebook | \nArray | \nA list of person's Messenger destinations. | \n
\n\n| people[].update.contactInformation.instagram | \nArray | \nA list of person's Instagram destinations. | \n
\n\n| people[].update.contactInformation.instagramDm | \nArray | \nA list of person's Instagram DM destinations. | \n
\n\n| people[].update.contactInformation.kakaoSangdam | \nArray | \nA list of person's Kakao Sangdam destinations. | \n
\n\n| people[].update.contactInformation.kakaoTalk | \nArray | \nA list of person's KakaoTalk destinations. | \n
\n\n| people[].update.contactInformation.line | \nArray | \nA list of person's Line destinations. | \n
\n\n| people[].update.contactInformation.liveChat | \nArray | \nA list of person's Live Chat destinations. | \n
\n\n| people[].update.contactInformation.openChannel | \nArray | \nA list of person's Open Channel destinations. | \n
\n\n| people[].update.contactInformation.phone | \nArray | \nA list of person's phone numbers. Max 100 numbers per person. | \n
\n\n| people[].update.contactInformation.phone[].number | \nString | \nPerson's phone number. Must be in international format and cannot exceed 50 characters. One person can have up to 100 phone numbers. | \n
\n\n| people[].update.contactInformation.push | \nArray | \nList of person's push registrations. | \n
\n\n| people[].update.contactInformation.push[].additionalData | \nObject | \nAdditional data collected from the user's profile | \n
\n\n| people[].update.contactInformation.push[].isPrimary | \nBoolean | \nSet to true if this device is a primary device of a user among other devices. | \n
\n\n| people[].update.contactInformation.push[].registrationId | \nString | \nPush registration ID. | \n
\n\n| people[].update.contactInformation.telegram | \nArray | \nA list of person's Telegram destinations. | \n
\n\n| people[].update.contactInformation.tiktokBm | \nArray | \nA list of person's TikTok Business Messaging destinations. | \n
\n\n| people[].update.contactInformation.twitter | \nArray | \nA list of person's Twitter destinations. | \n
\n\n| people[].update.contactInformation.viberBots | \nArray | \nA list of person's Viber Bots destinations. | \n
\n\n| people[].update.contactInformation.webpush | \nArray | \nA list of person's web push registrations | \n
\n\n| people[].update.contactInformation.whatsapp | \nArray | \nA list of person's WhatsApp destinations. | \n
\n\n| people[].update.contactInformation.zaloFollower | \nArray | \nA list of person's Zalo Follower destinations. | \n
\n\n| people[].update.country | \nString | \nPerson's country, 50 characters max. | \n
\n\n| people[].update.createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| people[].update.customAttributes | \nObject | \nList of custom attributes for the person, 4096 characters max per value. | \n
\n\n| people[].update.externalId | \nString | \nUnique ID for a person from your or another external system, 256 characters max. | \n
\n\n| people[].update.firstName | \nString | \nPerson's first name, 255 characters max. | \n
\n\n| people[].update.gender | \n | \nPerson's gender. | \n
\n\n| people[].update.id | \nInt | \nUnique id of the entity. | \n
\n\n| people[].update.integrations | \n | \nIntegrations. | \n
\n\n| people[].update.integrations.salesforce | \n | \nSalesforce integration. | \n
\n\n| people[].update.integrations.salesforce.contactId | \nString | \nSalesforce contact id. | \n
\n\n| people[].update.integrations.salesforce.leadId | \nString | \nSalesforce lead id. | \n
\n\n| people[].update.lastName | \nString | \nPerson's last name, 255 characters max. | \n
\n\n| people[].update.middleName | \nString | \nPerson's middle name, 50 characters max. | \n
\n\n| people[].update.modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| people[].update.modifiedFrom | \n | \nThe information which describes the source of the last modification of record. | \n
\n\n| people[].update.origin | \n | \nThe information which describes the origin of the record. | \n
\n\n| people[].update.preferredLanguage | \nString | \nPerson's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format. | \n
\n\n| people[].update.profilePicture | \nString | \nURL for the person's profile picture, 2083 characters max. | \n
\n\n| people[].update.tags | \nArray | \nList of tags that this person has. | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results[].errors | \nArray | \nList of errors | \n
\n\n| results[].isModified | \nBoolean | \n | \n
\n\n| results[].query | \n | \n | \n
\n\n| results[].query.identifier | \nString | \nPerson ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request | \n
\n\n| results[].query.sender | \nString | \nSender or application ID. sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL. | \n
\n\n| results[].query.type | \n | \nType of the person ID. Can be one of the above | \n
\n\n| results[].status | \nInt | \nHTTP status | \n
\n\n
\n
Match profiles.
\nUse this method to match a list of identities against existing person profiles in People. For each successfully matched identity the internal ID of the person profile will be returned. Duplicate identities will fetch a single profile reference.
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| identities | \nArray | \nRequired. List of identities. | \n
\n\n| identities[].type | \nString | \nRequired. Type of the person ID. Can be one of the above. One of: ID, EXTERNAL_ID, PHONE, EMAIL, LINE, FACEBOOK, TELEGRAM, PUSH, LIVE_CHAT, VIBER_BOTS, INSTAGRAM, INSTAGRAM_DM, TWITTER, APPLE_BUSINESS_CHAT, KAKAO_SANGDAM, OPEN_CHANNEL, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK. | \n
\n\n| identities[].identifier | \nString | \nRequired. Person ID. ID type must match the type parameter. | \n
\n\n| identities[].sender | \nString | \nSender or application ID.sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| matches | \nArray | \nRequired. List of matches. | \n
\n\n| matches[].personId | \nInt | \nRequired. Person's internal ID. | \n
\n\n| matches[].type | \nString | \nRequired. Type of the person ID. Can be one of the above. One of: ID, EXTERNAL_ID, PHONE, EMAIL, LINE, FACEBOOK, TELEGRAM, PUSH, LIVE_CHAT, VIBER_BOTS, INSTAGRAM, INSTAGRAM_DM, TWITTER, APPLE_BUSINESS_CHAT, KAKAO_SANGDAM, OPEN_CHANNEL, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK. | \n
\n\n| matches[].identifier | \nString | \nRequired. Person ID | \n
\n\n| matches[].sender | \nString | \nSender or application ID. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["people","2","persons","match"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"d236ac85-fefa-49e9-94b8-ee3499af3b79","name":"200 - Response example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"identities\": [\n {\n \"type\": \"EXTERNAL_ID\",\n \"identifier\": \"XXX\"\n },\n {\n \"type\": \"PHONE\",\n \"identifier\": \"XXXXXXXXXXX\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/persons/match"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"matches\": [\n {\n \"type\": \"EMAIL\",\n \"identifier\": \"example@example.com\",\n \"personId\": 1\n },\n {\n \"type\": \"PUSH\",\n \"identifier\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"sender\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"personId\": 2\n }\n ]\n}"},{"id":"fd81d30a-2f5c-46a0-b69f-501e45f938bf","name":"401 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"identities\": [\n {\n \"type\": \"EXTERNAL_ID\",\n \"identifier\": \"XXX\"\n },\n {\n \"type\": \"PHONE\",\n \"identifier\": \"XXXXXXXXXXX\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/persons/match"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"2eb40cd1-bc2c-4c90-9517-610a0c0ec35b","name":"403 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"identities\": [\n {\n \"type\": \"EXTERNAL_ID\",\n \"identifier\": \"XXX\"\n },\n {\n \"type\": \"PHONE\",\n \"identifier\": \"XXXXXXXXXXX\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/persons/match"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"2d456f68-8160-45e0-a3db-5f0dfb5f5371","name":"429 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"identities\": [\n {\n \"type\": \"EXTERNAL_ID\",\n \"identifier\": \"XXX\"\n },\n {\n \"type\": \"PHONE\",\n \"identifier\": \"XXXXXXXXXXX\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/persons/match"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"27c84989-7792-4b2d-ba9c-931413dc05f0","name":"500 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"identities\": [\n {\n \"type\": \"EXTERNAL_ID\",\n \"identifier\": \"XXX\"\n },\n {\n \"type\": \"PHONE\",\n \"identifier\": \"XXXXXXXXXXX\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/persons/match"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"20d08088-0a2b-43f1-8f3f-77bc2de36f57"},{"name":"Delete a person","event":[{"listen":"test","script":{"exec":["// Tests for this request (no success example is documented, so only the basics are checked).","pm.test(\"Status code is 200 or 204\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 204]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});"],"type":"text/javascript","packages":{}}}],"id":"e83ff2f4-da5c-4de5-bf62-a39e53a6899f","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://go2.vhdmedia.se/people/2/persons?identifier=janesmith@example.com&type=EMAIL","description":"Use this method to delete a person.
\nRequest rate limit
\n5 requests / second (per account)
\nQuery parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| phone | \nstring | \nExample: phone=46701234567
Person’s phone number. Phone numbers must be in international format. | \n
\n\n| email | \nstring | \nExample: email=name@example.com
Person’s email address. Must comply with the email format and cannot exceed 255 characters. One person can have up to 100 email addresses. | \n
\n\n| externalId | \nstring | \nExample: externalId=6F9619FF-8B86-D011-B42D-00CF4FC964FF
Unique ID for a person from your or another external system. | \n
\n\n| pushRegistrationId | \nstring | \nExample: pushRegistrationId=6F9619FF-8B86-D011-B42D-00CF4FC964FF
Person's push registration ID. | \n
\n\n| id | \ninteger | \nExample: id=11351351
Person's internal ID. | \n
\n\n| lineId | \nstring | \nExample: lineId=U045147f1ad961bfe996b72bbf417f3c9
Person’s Line ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameters. | \n
\n\n| lineSenderId | \nstring | \nExample: lineSenderId=1644264921
Person’s Line sender ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameter | \n
\n\n| facebookId | \nstring | \nExample: facebookId=370329180020364
Person’s Facebook ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters. | \n
\n\n| facebookSenderId | \ninteger | \nExample: facebookSenderId=2094832040560427
Person’s Facebook sender ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters. | \n
\n\n| telegramUserId | \nstring | \nExample: telegramUserId=1303201999
Person’s Telegram user ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters. | \n
\n\n| telegramBotId | \nstring | \nExample: telegramBotId=1495032701
Person’s Telegram bot ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters. | \n
\n\n| viberBotUserId | \nstring | \nExample: viberBotUserId=Upk26V/i1GXfvxZ8S41P/w==
Person’s Viber Bot user ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters. | \n
\n\n| viberBotId | \n
integer | \nExample: viberBotId=5591458813882487336
Person’s Viber Bot ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters. | \n
\n\n| instagramId | \nstring | \nExample: instagramId=17841546155331428
Person’s Instagram user ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters. | \n
\n\n| instagramSenderId | \ninteger | \nExample: instagramSenderId=17841405793187218
Person’s Instagram sender ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters. | \n
\n\n| twitterId | \nstring | \nexample: twitterId=370329180020364
Person’s Twitter user ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters. | \n
\n\n| twitterSenderId | \ninteger | \nExample: twitterSenderId=10765432100123456789
Person’s Twitter sender ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters. | \n
\n\n| appleBusinessChatId | \nstring | \nExample: appleBusinessChatId=ef6ca8e9-3718-4dc9-a9a0-b4ac28d135ca
Person’s Apple Business Chat ID. To get person by Apple BC channel, you need to specify both appleBusinessChatId and appleBusinessChatSenderId parameters. | \n
\n\n| appleBusinessChatSenderId | \nstring | \nExample: appleBusinessChatSenderId=urn:mbid:AQAAYyUbut3B2E3T9GLv4EaF/
Person’s Apple Business Chat sender ID. To get person by Apple BC channel, you need to specify both appleBusinessChatId and appleBusinessChatSenderId parameters. | \n
\n\n| liveChatRegId | \nstring | \nExample: liveChatRegId=79f9701b-e350-4497-9689-b2257864e63f | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional parameters
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| identifier | \nString | \nPerson ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request | \n
\n\n| type | \nString | \nType of the person ID | \n
\n\n
\n
Batch full people upsert.
\nUse this method to create or fully replace person profiles by matching on identifiers such as external ID, email, or phone. If a match is identified, the existing profile is entirely replaced with the provided data; any fields excluded from the request will be cleared. If no match is identified, a new profile is created. The operation returns a status for each profile: CREATED, UPDATED, or NOT_MODIFIED. Notes: 1. The batch size limit is 1000 persons. 2. Contact information (emails and phone numbers) in the request is checked only for formal validity. Ensure accuracy and absence of errors.
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| persons | \nArray | \nRequired. | \n
\n\n| persons[].id | \nInt | \nUnique id of the entity. | \n
\n\n| persons[].externalId | \nString | \nUnique ID for a person from your or another external system, 256 characters max. | \n
\n\n| persons[].type | \nString | \nPerson's type, default type is CUSTOMER. One of: CUSTOMER, LEAD. | \n
\n\n| persons[].firstName | \nString | \nPerson's first name, 255 characters max. | \n
\n\n| persons[].middleName | \nString | \nPerson's middle name, 50 characters max. | \n
\n\n| persons[].lastName | \nString | \nPerson's last name, 255 characters max. | \n
\n\n| persons[].nickName | \nString | \nPerson's nick name, 50 characters max. | \n
\n\n| persons[].country | \nString | \nPerson's country, 50 characters max. | \n
\n\n| persons[].city | \nString | \nPerson's city, 50 characters max. | \n
\n\n| persons[].address | \nString | \nPerson's address, 256 characters max. | \n
\n\n| persons[].gender | \nString | \nPerson's gender. One of: MALE, FEMALE. | \n
\n\n| persons[].preferredLanguage | \nString | \nPerson's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format. | \n
\n\n| persons[].birthDate | \nString | \nPerson's date of birth, format YYYY-MM-DD. | \n
\n\n| persons[].profilePicture | \nString | \nURL for the person's profile picture, 2083 characters max. | \n
\n\n| persons[].tags | \nArray | \nList of tags that this person has. | \n
\n\n| persons[].contactInformation | \nArray | \nList of phones, emails and other information how a person can be contacted. | \n
\n\n| persons[].contactInformation[].type | \nString | \nType of the person ID. One of: PHONE, EMAIL. | \n
\n\n| persons[].contactInformation[].identifier | \nString | \nPerson ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request. 255 characters max. | \n
\n\n| persons[].contactInformation[].sender | \nString | \nSender or application ID. Sender is required for all identifier types except PHONE and EMAIL. 255 characters max. | \n
\n\n| persons[].contactInformation[].primary | \nBoolean | \nIndicates if this ID is preferred for communication. | \n
\n\n| persons[].customAttributes | \nObject | \nList of custom attributes for the person, 4096 characters max per value. | \n
\n\n| persons[].computedAttributes | \nObject | \nPerson's computed attributes grouped by type. | \n
\n\n| persons[].createdFrom | \nString | \nSource system that last modified this person record. One of: API, PORTAL, WEB_SDK, INTEGRATION, PUSH, FACEBOOK, LINE, TELEGRAM, SALESFORCE, DYNAMICS, ZAPIER, FORMS, AMS, COMPUTED, ANSWERS, CONVERSATIONS, IMPORT, INSTAGRAM_DM, FLOW, LIVE_CHAT, VKONTAKTE, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK, UNKNOWN. | \n
\n\n| persons[].createdBy | \nString | \nIdentifier of the user who created this person record. | \n
\n\n| persons[].createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| persons[].modifiedFrom | \nString | \nSource system that last modified this person record. One of: API, PORTAL, WEB_SDK, INTEGRATION, PUSH, FACEBOOK, LINE, TELEGRAM, SALESFORCE, DYNAMICS, ZAPIER, FORMS, AMS, COMPUTED, ANSWERS, CONVERSATIONS, IMPORT, INSTAGRAM_DM, FLOW, LIVE_CHAT, VKONTAKTE, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK, UNKNOWN. | \n
\n\n| persons[].modifiedBy | \nString | \nIdentifier of the user who last modified this person record. | \n
\n\n| persons[].modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n
\n
On success the response is 207 Multi-Status.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| errors | \nObject | \nError information for failed batch operation items. | \n
\n\n| errors.code | \nInt | \nRequired. Error code identifying the type of error that occurred. One of: 400100, 400101, 400102, 400103, 400104, 400105, 400106, 400107, 404100, 404101, 405100, 409100, 500100. | \n
\n\n| errors.message | \nString | \nRequired. Human-readable error message describing what went wrong. | \n
\n\n| errors.details | \nArray | \nAdditional validation error details with specific property-level information. | \n
\n\n| errors.details[].property | \nString | \nRequired. Name of the property or field that caused the validation error. | \n
\n\n| errors.details[].message | \nString | \nRequired. Specific error message describing the validation failure. | \n
\n\n| errors.details[].payload | \nObject | \nAdditional context or metadata related to the validation error. | \n
\n\n| errors.index | \nInt | \nIndex position of the failed item in the original request batch. | \n
\n\n| results | \nObject | \nSuccessful result for a person upsert operation. | \n
\n\n| results.id | \nInt | \nRequired. Unique identifier of the upserted person profile. | \n
\n\n| results.index | \nInt | \nRequired. Index position of this person in the original request batch. | \n
\n\n| results.status | \nString | \nStatus indicating the type of operation performed on a person profile during upsert One of: CREATED, UPDATED, NOT_MODIFIED. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["people","3","persons","upsert"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"b9a0710a-cccb-4316-a97e-2d864ae75b76","name":"207 - Successful upsert - Single person created","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"persons\": [\n {\n \"externalId\": \"3\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"address\": \"67 Farringdon Road\",\n \"city\": \"London\",\n \"country\": \"United Kingdom\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"1966-01-15\",\n \"middleName\": \"Janie\",\n \"preferredLanguage\": \"en-gb\",\n \"profilePicture\": \"http://profile.com\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2018-06-01\",\n \"Company\": \"Acme\",\n \"ShoppingCartList\": [\n {\n \"productName\": \"Sneakers\",\n \"productPrice\": 25.33,\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\"\n },\n {\n \"productName\": \"T-Shirt\",\n \"productPrice\": 9.99,\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\"\n }\n ]\n },\n \"contactInformation\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"type\": \"EMAIL\"\n },\n {\n \"identifier\": \"41793026727\",\n \"type\": \"PHONE\"\n }\n ],\n \"tags\": [\n \"VIP Customers\",\n \"New Customers\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/persons/upsert"},"status":"Multi-Status","code":207,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [],\n \"results\": [\n {\n \"id\": 12345,\n \"index\": 0,\n \"status\": \"CREATED\"\n }\n ]\n}"},{"id":"ae3feff9-eca0-4aa1-909d-2d8db3dc327b","name":"400 - real VHD response","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"persons\": [\n {\n \"externalId\": \"3\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"address\": \"67 Farringdon Road\",\n \"city\": \"London\",\n \"country\": \"United Kingdom\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"1966-01-15\",\n \"middleName\": \"Janie\",\n \"preferredLanguage\": \"en-gb\",\n \"profilePicture\": \"http://profile.com\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2018-06-01\",\n \"Company\": \"Acme\",\n \"ShoppingCartList\": [\n {\n \"productName\": \"Sneakers\",\n \"productPrice\": 25.33,\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\"\n },\n {\n \"productName\": \"T-Shirt\",\n \"productPrice\": 9.99,\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\"\n }\n ]\n },\n \"contactInformation\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"type\": \"EMAIL\"\n },\n {\n \"identifier\": \"41793026727\",\n \"type\": \"PHONE\"\n }\n ],\n \"tags\": [\n \"VIP Customers\",\n \"New Customers\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/persons/upsert"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400104,\n \"message\": \"Missing required property 'persons'\",\n \"details\": [\n {\n \"property\": \"persons\",\n \"message\": \"Required, but value is missing\"\n }\n ]\n}"},{"id":"2d163e58-a123-411a-9a19-1af24ece26dc","name":"401 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"persons\": [\n {\n \"externalId\": \"3\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"address\": \"67 Farringdon Road\",\n \"city\": \"London\",\n \"country\": \"United Kingdom\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"1966-01-15\",\n \"middleName\": \"Janie\",\n \"preferredLanguage\": \"en-gb\",\n \"profilePicture\": \"http://profile.com\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2018-06-01\",\n \"Company\": \"Acme\",\n \"ShoppingCartList\": [\n {\n \"productName\": \"Sneakers\",\n \"productPrice\": 25.33,\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\"\n },\n {\n \"productName\": \"T-Shirt\",\n \"productPrice\": 9.99,\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\"\n }\n ]\n },\n \"contactInformation\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"type\": \"EMAIL\"\n },\n {\n \"identifier\": \"41793026727\",\n \"type\": \"PHONE\"\n }\n ],\n \"tags\": [\n \"VIP Customers\",\n \"New Customers\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/persons/upsert"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"c8f5b1d6-5463-43c2-bd2a-0076e09f2504","name":"403 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"persons\": [\n {\n \"externalId\": \"3\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"address\": \"67 Farringdon Road\",\n \"city\": \"London\",\n \"country\": \"United Kingdom\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"1966-01-15\",\n \"middleName\": \"Janie\",\n \"preferredLanguage\": \"en-gb\",\n \"profilePicture\": \"http://profile.com\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2018-06-01\",\n \"Company\": \"Acme\",\n \"ShoppingCartList\": [\n {\n \"productName\": \"Sneakers\",\n \"productPrice\": 25.33,\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\"\n },\n {\n \"productName\": \"T-Shirt\",\n \"productPrice\": 9.99,\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\"\n }\n ]\n },\n \"contactInformation\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"type\": \"EMAIL\"\n },\n {\n \"identifier\": \"41793026727\",\n \"type\": \"PHONE\"\n }\n ],\n \"tags\": [\n \"VIP Customers\",\n \"New Customers\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/persons/upsert"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"9ecd2f34-e728-45ba-b127-9b65e39fc748","name":"429 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"persons\": [\n {\n \"externalId\": \"3\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"address\": \"67 Farringdon Road\",\n \"city\": \"London\",\n \"country\": \"United Kingdom\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"1966-01-15\",\n \"middleName\": \"Janie\",\n \"preferredLanguage\": \"en-gb\",\n \"profilePicture\": \"http://profile.com\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2018-06-01\",\n \"Company\": \"Acme\",\n \"ShoppingCartList\": [\n {\n \"productName\": \"Sneakers\",\n \"productPrice\": 25.33,\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\"\n },\n {\n \"productName\": \"T-Shirt\",\n \"productPrice\": 9.99,\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\"\n }\n ]\n },\n \"contactInformation\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"type\": \"EMAIL\"\n },\n {\n \"identifier\": \"41793026727\",\n \"type\": \"PHONE\"\n }\n ],\n \"tags\": [\n \"VIP Customers\",\n \"New Customers\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/persons/upsert"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"7ad01fe7-964a-47a9-8cda-519008fd72fb","name":"500 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"persons\": [\n {\n \"externalId\": \"3\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"address\": \"67 Farringdon Road\",\n \"city\": \"London\",\n \"country\": \"United Kingdom\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"1966-01-15\",\n \"middleName\": \"Janie\",\n \"preferredLanguage\": \"en-gb\",\n \"profilePicture\": \"http://profile.com\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2018-06-01\",\n \"Company\": \"Acme\",\n \"ShoppingCartList\": [\n {\n \"productName\": \"Sneakers\",\n \"productPrice\": 25.33,\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\"\n },\n {\n \"productName\": \"T-Shirt\",\n \"productPrice\": 9.99,\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\"\n }\n ]\n },\n \"contactInformation\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"type\": \"EMAIL\"\n },\n {\n \"identifier\": \"41793026727\",\n \"type\": \"PHONE\"\n }\n ],\n \"tags\": [\n \"VIP Customers\",\n \"New Customers\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/persons/upsert"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"2e107f9c-b3f9-4ddf-96b2-233892fa56a4"},{"name":"Batch partial people upsert","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 207\", function () {"," pm.expect(pm.response.code).to.be.oneOf([207]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"results\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});","","pm.test(\"'errors' is an array when present\", function () {"," if (responseBody.errors !== undefined) { pm.expect(responseBody.errors).to.be.an('array'); }","});","","pm.test(\"'results' is an array\", function () {"," pm.expect(responseBody[\"results\"]).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"495c5e92-88cc-4af0-b761-90b02207f982","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"persons\": [\n {\n \"externalId\": \"sample-3\",\n \"lastName\": \"Doe Updated\",\n \"contactInformation\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"type\": \"EMAIL\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/persons/upsert","description":"Batch partial people upsert.
\nUse this method to create or partially update person profiles by matching on identifiers such as external ID, email, or phone. If a match is identified, the existing profile is updated only with the provided data; any fields excluded from the request remain unchanged. If no match is identified, a new profile is created. The operation returns a status for each profile: CREATED, UPDATED, or NOT_MODIFIED. Notes: 1. The batch size limit is 1000 persons. 2. Contact information (emails and phone numbers) in the request is checked only for formal validity. Ensure accuracy and absence of errors.
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| persons | \nArray | \nRequired. | \n
\n\n| persons[].id | \nInt | \nUnique id of the entity. | \n
\n\n| persons[].externalId | \nString | \nUnique ID for a person from your or another external system, 256 characters max. | \n
\n\n| persons[].type | \nString | \nPerson's type, default type is CUSTOMER. One of: CUSTOMER, LEAD. | \n
\n\n| persons[].firstName | \nString | \nPerson's first name, 255 characters max. | \n
\n\n| persons[].middleName | \nString | \nPerson's middle name, 50 characters max. | \n
\n\n| persons[].lastName | \nString | \nPerson's last name, 255 characters max. | \n
\n\n| persons[].nickName | \nString | \nPerson's nick name, 50 characters max. | \n
\n\n| persons[].country | \nString | \nPerson's country, 50 characters max. | \n
\n\n| persons[].city | \nString | \nPerson's city, 50 characters max. | \n
\n\n| persons[].address | \nString | \nPerson's address, 256 characters max. | \n
\n\n| persons[].gender | \nString | \nPerson's gender. One of: MALE, FEMALE. | \n
\n\n| persons[].preferredLanguage | \nString | \nPerson's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format. | \n
\n\n| persons[].birthDate | \nString | \nPerson's date of birth, format YYYY-MM-DD. | \n
\n\n| persons[].profilePicture | \nString | \nURL for the person's profile picture, 2083 characters max. | \n
\n\n| persons[].tags | \nArray | \nList of tags that this person has. | \n
\n\n| persons[].contactInformation | \nArray | \nList of phones, emails and other information how a person can be contacted. | \n
\n\n| persons[].contactInformation[].type | \nString | \nType of the person ID. One of: PHONE, EMAIL. | \n
\n\n| persons[].contactInformation[].identifier | \nString | \nPerson ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request. 255 characters max. | \n
\n\n| persons[].contactInformation[].sender | \nString | \nSender or application ID. Sender is required for all identifier types except PHONE and EMAIL. 255 characters max. | \n
\n\n| persons[].contactInformation[].primary | \nBoolean | \nIndicates if this ID is preferred for communication. | \n
\n\n| persons[].customAttributes | \nObject | \nList of custom attributes for the person, 4096 characters max per value. | \n
\n\n| persons[].computedAttributes | \nObject | \nPerson's computed attributes grouped by type. | \n
\n\n| persons[].createdFrom | \nString | \nSource system that last modified this person record. One of: API, PORTAL, WEB_SDK, INTEGRATION, PUSH, FACEBOOK, LINE, TELEGRAM, SALESFORCE, DYNAMICS, ZAPIER, FORMS, AMS, COMPUTED, ANSWERS, CONVERSATIONS, IMPORT, INSTAGRAM_DM, FLOW, LIVE_CHAT, VKONTAKTE, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK, UNKNOWN. | \n
\n\n| persons[].createdBy | \nString | \nIdentifier of the user who created this person record. | \n
\n\n| persons[].createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| persons[].modifiedFrom | \nString | \nSource system that last modified this person record. One of: API, PORTAL, WEB_SDK, INTEGRATION, PUSH, FACEBOOK, LINE, TELEGRAM, SALESFORCE, DYNAMICS, ZAPIER, FORMS, AMS, COMPUTED, ANSWERS, CONVERSATIONS, IMPORT, INSTAGRAM_DM, FLOW, LIVE_CHAT, VKONTAKTE, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK, UNKNOWN. | \n
\n\n| persons[].modifiedBy | \nString | \nIdentifier of the user who last modified this person record. | \n
\n\n| persons[].modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n
\n
On success the response is 207 Multi-Status.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| errors | \nObject | \nError information for failed batch operation items. | \n
\n\n| errors.code | \nInt | \nRequired. Error code identifying the type of error that occurred. One of: 400100, 400101, 400102, 400103, 400104, 400105, 400106, 400107, 404100, 404101, 405100, 409100, 500100. | \n
\n\n| errors.message | \nString | \nRequired. Human-readable error message describing what went wrong. | \n
\n\n| errors.details | \nArray | \nAdditional validation error details with specific property-level information. | \n
\n\n| errors.details[].property | \nString | \nRequired. Name of the property or field that caused the validation error. | \n
\n\n| errors.details[].message | \nString | \nRequired. Specific error message describing the validation failure. | \n
\n\n| errors.details[].payload | \nObject | \nAdditional context or metadata related to the validation error. | \n
\n\n| errors.index | \nInt | \nIndex position of the failed item in the original request batch. | \n
\n\n| results | \nObject | \nSuccessful result for a person upsert operation. | \n
\n\n| results.id | \nInt | \nRequired. Unique identifier of the upserted person profile. | \n
\n\n| results.index | \nInt | \nRequired. Index position of this person in the original request batch. | \n
\n\n| results.status | \nString | \nStatus indicating the type of operation performed on a person profile during upsert One of: CREATED, UPDATED, NOT_MODIFIED. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["people","3","persons","upsert"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"552978fd-cb0a-43a5-b012-900dfc3d49fd","name":"207 - Successful upsert - Single person created","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"persons\": [\n {\n \"externalId\": \"3\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"address\": \"67 Farringdon Road\",\n \"city\": \"London\",\n \"country\": \"United Kingdom\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"1966-01-15\",\n \"middleName\": \"Janie\",\n \"preferredLanguage\": \"en-gb\",\n \"profilePicture\": \"http://profile.com\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2018-06-01\",\n \"Company\": \"Acme\",\n \"ShoppingCartList\": [\n {\n \"productName\": \"Sneakers\",\n \"productPrice\": 25.33,\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\"\n },\n {\n \"productName\": \"T-Shirt\",\n \"productPrice\": 9.99,\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\"\n }\n ]\n },\n \"contactInformation\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"type\": \"EMAIL\"\n },\n {\n \"identifier\": \"41793026727\",\n \"type\": \"PHONE\"\n }\n ],\n \"tags\": [\n \"VIP Customers\",\n \"New Customers\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/persons/upsert"},"status":"Multi-Status","code":207,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [],\n \"results\": [\n {\n \"id\": 12345,\n \"index\": 0,\n \"status\": \"CREATED\"\n }\n ]\n}"},{"id":"b0856631-f37e-4d7a-a9ad-24a58983d9c6","name":"400 - real VHD response","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"persons\": [\n {\n \"externalId\": \"3\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"address\": \"67 Farringdon Road\",\n \"city\": \"London\",\n \"country\": \"United Kingdom\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"1966-01-15\",\n \"middleName\": \"Janie\",\n \"preferredLanguage\": \"en-gb\",\n \"profilePicture\": \"http://profile.com\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2018-06-01\",\n \"Company\": \"Acme\",\n \"ShoppingCartList\": [\n {\n \"productName\": \"Sneakers\",\n \"productPrice\": 25.33,\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\"\n },\n {\n \"productName\": \"T-Shirt\",\n \"productPrice\": 9.99,\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\"\n }\n ]\n },\n \"contactInformation\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"type\": \"EMAIL\"\n },\n {\n \"identifier\": \"41793026727\",\n \"type\": \"PHONE\"\n }\n ],\n \"tags\": [\n \"VIP Customers\",\n \"New Customers\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/persons/upsert"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400104,\n \"message\": \"Missing required property 'persons'\",\n \"details\": [\n {\n \"property\": \"persons\",\n \"message\": \"Required, but value is missing\"\n }\n ]\n}"},{"id":"afdfe42c-9636-43c3-92ad-41a5cf351cde","name":"401 - Example","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"persons\": [\n {\n \"externalId\": \"3\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"address\": \"67 Farringdon Road\",\n \"city\": \"London\",\n \"country\": \"United Kingdom\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"1966-01-15\",\n \"middleName\": \"Janie\",\n \"preferredLanguage\": \"en-gb\",\n \"profilePicture\": \"http://profile.com\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2018-06-01\",\n \"Company\": \"Acme\",\n \"ShoppingCartList\": [\n {\n \"productName\": \"Sneakers\",\n \"productPrice\": 25.33,\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\"\n },\n {\n \"productName\": \"T-Shirt\",\n \"productPrice\": 9.99,\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\"\n }\n ]\n },\n \"contactInformation\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"type\": \"EMAIL\"\n },\n {\n \"identifier\": \"41793026727\",\n \"type\": \"PHONE\"\n }\n ],\n \"tags\": [\n \"VIP Customers\",\n \"New Customers\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/persons/upsert"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"b7db1c78-b453-4e84-b5e4-98fee9e8bec1","name":"403 - Example","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"persons\": [\n {\n \"externalId\": \"3\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"address\": \"67 Farringdon Road\",\n \"city\": \"London\",\n \"country\": \"United Kingdom\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"1966-01-15\",\n \"middleName\": \"Janie\",\n \"preferredLanguage\": \"en-gb\",\n \"profilePicture\": \"http://profile.com\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2018-06-01\",\n \"Company\": \"Acme\",\n \"ShoppingCartList\": [\n {\n \"productName\": \"Sneakers\",\n \"productPrice\": 25.33,\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\"\n },\n {\n \"productName\": \"T-Shirt\",\n \"productPrice\": 9.99,\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\"\n }\n ]\n },\n \"contactInformation\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"type\": \"EMAIL\"\n },\n {\n \"identifier\": \"41793026727\",\n \"type\": \"PHONE\"\n }\n ],\n \"tags\": [\n \"VIP Customers\",\n \"New Customers\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/persons/upsert"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"cc638581-b02b-42cf-b285-ff8b9eb8034c","name":"429 - Example","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"persons\": [\n {\n \"externalId\": \"3\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"address\": \"67 Farringdon Road\",\n \"city\": \"London\",\n \"country\": \"United Kingdom\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"1966-01-15\",\n \"middleName\": \"Janie\",\n \"preferredLanguage\": \"en-gb\",\n \"profilePicture\": \"http://profile.com\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2018-06-01\",\n \"Company\": \"Acme\",\n \"ShoppingCartList\": [\n {\n \"productName\": \"Sneakers\",\n \"productPrice\": 25.33,\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\"\n },\n {\n \"productName\": \"T-Shirt\",\n \"productPrice\": 9.99,\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\"\n }\n ]\n },\n \"contactInformation\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"type\": \"EMAIL\"\n },\n {\n \"identifier\": \"41793026727\",\n \"type\": \"PHONE\"\n }\n ],\n \"tags\": [\n \"VIP Customers\",\n \"New Customers\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/persons/upsert"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"a2554b64-2b21-4b4d-ae53-645b61fca6d5","name":"500 - Example","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"persons\": [\n {\n \"externalId\": \"3\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"address\": \"67 Farringdon Road\",\n \"city\": \"London\",\n \"country\": \"United Kingdom\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"1966-01-15\",\n \"middleName\": \"Janie\",\n \"preferredLanguage\": \"en-gb\",\n \"profilePicture\": \"http://profile.com\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2018-06-01\",\n \"Company\": \"Acme\",\n \"ShoppingCartList\": [\n {\n \"productName\": \"Sneakers\",\n \"productPrice\": 25.33,\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\"\n },\n {\n \"productName\": \"T-Shirt\",\n \"productPrice\": 9.99,\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\"\n }\n ]\n },\n \"contactInformation\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"type\": \"EMAIL\"\n },\n {\n \"identifier\": \"41793026727\",\n \"type\": \"PHONE\"\n }\n ],\n \"tags\": [\n \"VIP Customers\",\n \"New Customers\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/persons/upsert"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"495c5e92-88cc-4af0-b761-90b02207f982"},{"name":"Batch merge profiles","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 207\", function () {"," pm.expect(pm.response.code).to.be.oneOf([207]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"results\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});","","pm.test(\"'errors' is an array when present\", function () {"," if (responseBody.errors !== undefined) { pm.expect(responseBody.errors).to.be.an('array'); }","});","","pm.test(\"'results' is an array\", function () {"," pm.expect(responseBody[\"results\"]).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"465c7f89-5040-4f49-916f-9b9b8335e36c","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"persons\": [\n {\n \"externalId\": \"sample-3\",\n \"contactInformation\": [\n {\n \"identifier\": \"john.doe.work@example.com\",\n \"type\": \"EMAIL\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/persons/merge","description":"Batch merge profiles.
\nUse this method to merge multiple person profiles belonging to the same user based on matching identifiers such as external ID, email, phone, and other contact information. The standard merge logic applies: the system selects a primary profile and consolidates fields and events from the secondary profiles into it. More information about the merge logic is available in the People documentation. Any data included in the merge request overrides what is already stored. If the request provides a new external ID or new contact information, it is written into the resulting profile, either replacing the existing identifier or being added to the contact list, depending on the type. If the merge request includes only new identifiers or contact information that match no existing profile, the system creates a new profile and populates it entirely with the data from the request. Notes: 1. The batch size limit is 1000 persons. 2. Contact information in the request is checked only for formal validity (emails and phone numbers). Ensure its correctness, alignment with configured senders, and absence of errors.
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| persons | \nArray | \nRequired. | \n
\n\n| persons[].id | \nInt | \nUnique id of the entity. | \n
\n\n| persons[].externalId | \nString | \nUnique ID for a person from your or another external system, 256 characters max. | \n
\n\n| persons[].type | \nString | \nPerson's type, default type is CUSTOMER. One of: CUSTOMER, LEAD. | \n
\n\n| persons[].firstName | \nString | \nPerson's first name, 255 characters max. | \n
\n\n| persons[].middleName | \nString | \nPerson's middle name, 50 characters max. | \n
\n\n| persons[].lastName | \nString | \nPerson's last name, 255 characters max. | \n
\n\n| persons[].nickName | \nString | \nPerson's nick name, 50 characters max. | \n
\n\n| persons[].country | \nString | \nPerson's country, 50 characters max. | \n
\n\n| persons[].city | \nString | \nPerson's city, 50 characters max. | \n
\n\n| persons[].address | \nString | \nPerson's address, 256 characters max. | \n
\n\n| persons[].gender | \nString | \nPerson's gender. One of: MALE, FEMALE. | \n
\n\n| persons[].preferredLanguage | \nString | \nPerson's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format. | \n
\n\n| persons[].birthDate | \nString | \nPerson's date of birth, format YYYY-MM-DD. | \n
\n\n| persons[].profilePicture | \nString | \nURL for the person's profile picture, 2083 characters max. | \n
\n\n| persons[].tags | \nArray | \nList of tags that this person has. | \n
\n\n| persons[].contactInformation | \nArray | \nList of phones, emails and other information how a person can be contacted. | \n
\n\n| persons[].contactInformation[].type | \nString | \nType of the person ID. One of: PHONE, EMAIL, FACEBOOK, LINE, TELEGRAM, PUSH, WEB_PUSH, LIVE_CHAT, VIBER_BOTS, INSTAGRAM, TWITTER, INSTAGRAM_DM, KAKAO_SANGDAM, APPLE_BUSINESS_CHAT, OPEN_CHANNEL, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK. | \n
\n\n| persons[].contactInformation[].identifier | \nString | \nPerson ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request. 255 characters max. | \n
\n\n| persons[].contactInformation[].sender | \nString | \nSender or application ID. Sender is required for all identifier types except PHONE and EMAIL. 255 characters max. | \n
\n\n| persons[].contactInformation[].primary | \nBoolean | \nIndicates if this ID is preferred for communication. This flag only applies to PHONE and EMAIL. | \n
\n\n| persons[].customAttributes | \nObject | \nList of custom attributes for the person, 4096 characters max per value. | \n
\n\n| persons[].computedAttributes | \nObject | \nPerson's computed attributes grouped by type. | \n
\n\n| persons[].createdFrom | \nString | \nSource system that last modified this person record. One of: API, PORTAL, WEB_SDK, INTEGRATION, PUSH, FACEBOOK, LINE, TELEGRAM, SALESFORCE, DYNAMICS, ZAPIER, FORMS, AMS, COMPUTED, ANSWERS, CONVERSATIONS, IMPORT, INSTAGRAM_DM, FLOW, LIVE_CHAT, VKONTAKTE, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK, UNKNOWN. | \n
\n\n| persons[].createdBy | \nString | \nIdentifier of the user who created this person record. | \n
\n\n| persons[].createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| persons[].modifiedFrom | \nString | \nSource system that last modified this person record. One of: API, PORTAL, WEB_SDK, INTEGRATION, PUSH, FACEBOOK, LINE, TELEGRAM, SALESFORCE, DYNAMICS, ZAPIER, FORMS, AMS, COMPUTED, ANSWERS, CONVERSATIONS, IMPORT, INSTAGRAM_DM, FLOW, LIVE_CHAT, VKONTAKTE, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK, UNKNOWN. | \n
\n\n| persons[].modifiedBy | \nString | \nIdentifier of the user who last modified this person record. | \n
\n\n| persons[].modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n
\n
On success the response is 207 Multi-Status.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| errors | \nObject | \nError information for failed batch operation items. | \n
\n\n| errors.code | \nInt | \nRequired. Error code identifying the type of error that occurred. One of: 400100, 400101, 400102, 400103, 400104, 400105, 400106, 400107, 404100, 404101, 405100, 409100, 500100. | \n
\n\n| errors.message | \nString | \nRequired. Human-readable error message describing what went wrong. | \n
\n\n| errors.details | \nArray | \nAdditional validation error details with specific property-level information. | \n
\n\n| errors.details[].property | \nString | \nRequired. Name of the property or field that caused the validation error. | \n
\n\n| errors.details[].message | \nString | \nRequired. Specific error message describing the validation failure. | \n
\n\n| errors.details[].payload | \nObject | \nAdditional context or metadata related to the validation error. | \n
\n\n| errors.index | \nInt | \nIndex position of the failed item in the original request batch. | \n
\n\n| results | \nObject | \nSuccessful result for a person merge operation. | \n
\n\n| results.id | \nInt | \nRequired. Unique identifier of the merged person profile. | \n
\n\n| results.index | \nInt | \nRequired. Index position of this person in the original request batch. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["people","3","persons","merge"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"08f8a174-b2c1-4e6e-95d8-0212253ac1c5","name":"207 - Successful merge - Single person","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"persons\": [\n {\n \"externalId\": \"3\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"address\": \"67 Farringdon Road\",\n \"city\": \"London\",\n \"country\": \"United Kingdom\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"1966-01-15\",\n \"middleName\": \"Janie\",\n \"preferredLanguage\": \"en-gb\",\n \"profilePicture\": \"http://profile.com\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2018-06-01\",\n \"Company\": \"Acme\",\n \"ShoppingCartList\": [\n {\n \"productName\": \"Sneakers\",\n \"productPrice\": 25.33,\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\"\n },\n {\n \"productName\": \"T-Shirt\",\n \"productPrice\": 9.99,\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\"\n }\n ]\n },\n \"contactInformation\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"type\": \"EMAIL\"\n },\n {\n \"identifier\": \"41793026727\",\n \"type\": \"PHONE\"\n }\n ],\n \"tags\": [\n \"VIP Customers\",\n \"New Customers\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/persons/merge"},"status":"Multi-Status","code":207,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [],\n \"results\": [\n {\n \"id\": 12345,\n \"index\": 0\n }\n ]\n}"},{"id":"e683ada6-5613-4d9c-8476-663160c2d8e3","name":"400 - real VHD response","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"persons\": [\n {\n \"externalId\": \"3\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"address\": \"67 Farringdon Road\",\n \"city\": \"London\",\n \"country\": \"United Kingdom\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"1966-01-15\",\n \"middleName\": \"Janie\",\n \"preferredLanguage\": \"en-gb\",\n \"profilePicture\": \"http://profile.com\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2018-06-01\",\n \"Company\": \"Acme\",\n \"ShoppingCartList\": [\n {\n \"productName\": \"Sneakers\",\n \"productPrice\": 25.33,\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\"\n },\n {\n \"productName\": \"T-Shirt\",\n \"productPrice\": 9.99,\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\"\n }\n ]\n },\n \"contactInformation\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"type\": \"EMAIL\"\n },\n {\n \"identifier\": \"41793026727\",\n \"type\": \"PHONE\"\n }\n ],\n \"tags\": [\n \"VIP Customers\",\n \"New Customers\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/persons/merge"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400104,\n \"message\": \"Missing required property 'persons'\",\n \"details\": [\n {\n \"property\": \"persons\",\n \"message\": \"Required, but value is missing\"\n }\n ]\n}"},{"id":"1643dd31-0e4f-4c21-9827-5e9fcfea8ed6","name":"401 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"persons\": [\n {\n \"externalId\": \"3\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"address\": \"67 Farringdon Road\",\n \"city\": \"London\",\n \"country\": \"United Kingdom\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"1966-01-15\",\n \"middleName\": \"Janie\",\n \"preferredLanguage\": \"en-gb\",\n \"profilePicture\": \"http://profile.com\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2018-06-01\",\n \"Company\": \"Acme\",\n \"ShoppingCartList\": [\n {\n \"productName\": \"Sneakers\",\n \"productPrice\": 25.33,\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\"\n },\n {\n \"productName\": \"T-Shirt\",\n \"productPrice\": 9.99,\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\"\n }\n ]\n },\n \"contactInformation\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"type\": \"EMAIL\"\n },\n {\n \"identifier\": \"41793026727\",\n \"type\": \"PHONE\"\n }\n ],\n \"tags\": [\n \"VIP Customers\",\n \"New Customers\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/persons/merge"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"24dcc3c2-56dd-4d85-8bd4-812fa7e2563e","name":"403 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"persons\": [\n {\n \"externalId\": \"3\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"address\": \"67 Farringdon Road\",\n \"city\": \"London\",\n \"country\": \"United Kingdom\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"1966-01-15\",\n \"middleName\": \"Janie\",\n \"preferredLanguage\": \"en-gb\",\n \"profilePicture\": \"http://profile.com\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2018-06-01\",\n \"Company\": \"Acme\",\n \"ShoppingCartList\": [\n {\n \"productName\": \"Sneakers\",\n \"productPrice\": 25.33,\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\"\n },\n {\n \"productName\": \"T-Shirt\",\n \"productPrice\": 9.99,\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\"\n }\n ]\n },\n \"contactInformation\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"type\": \"EMAIL\"\n },\n {\n \"identifier\": \"41793026727\",\n \"type\": \"PHONE\"\n }\n ],\n \"tags\": [\n \"VIP Customers\",\n \"New Customers\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/persons/merge"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"f6ced74d-7679-4ded-bb1c-6fd85e622c12","name":"429 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"persons\": [\n {\n \"externalId\": \"3\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"address\": \"67 Farringdon Road\",\n \"city\": \"London\",\n \"country\": \"United Kingdom\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"1966-01-15\",\n \"middleName\": \"Janie\",\n \"preferredLanguage\": \"en-gb\",\n \"profilePicture\": \"http://profile.com\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2018-06-01\",\n \"Company\": \"Acme\",\n \"ShoppingCartList\": [\n {\n \"productName\": \"Sneakers\",\n \"productPrice\": 25.33,\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\"\n },\n {\n \"productName\": \"T-Shirt\",\n \"productPrice\": 9.99,\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\"\n }\n ]\n },\n \"contactInformation\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"type\": \"EMAIL\"\n },\n {\n \"identifier\": \"41793026727\",\n \"type\": \"PHONE\"\n }\n ],\n \"tags\": [\n \"VIP Customers\",\n \"New Customers\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/persons/merge"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"97e9a6fa-3417-4c94-8846-1b8e4df45f42","name":"500 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"persons\": [\n {\n \"externalId\": \"3\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"address\": \"67 Farringdon Road\",\n \"city\": \"London\",\n \"country\": \"United Kingdom\",\n \"gender\": \"FEMALE\",\n \"birthDate\": \"1966-01-15\",\n \"middleName\": \"Janie\",\n \"preferredLanguage\": \"en-gb\",\n \"profilePicture\": \"http://profile.com\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2018-06-01\",\n \"Company\": \"Acme\",\n \"ShoppingCartList\": [\n {\n \"productName\": \"Sneakers\",\n \"productPrice\": 25.33,\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\"\n },\n {\n \"productName\": \"T-Shirt\",\n \"productPrice\": 9.99,\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\"\n }\n ]\n },\n \"contactInformation\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"type\": \"EMAIL\"\n },\n {\n \"identifier\": \"41793026727\",\n \"type\": \"PHONE\"\n }\n ],\n \"tags\": [\n \"VIP Customers\",\n \"New Customers\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/persons/merge"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"465c7f89-5040-4f49-916f-9b9b8335e36c"},{"name":"Batch people delete","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 204 or 207\", function () {"," pm.expect(pm.response.code).to.be.oneOf([204, 207]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","// A 204 response has no body; check the body only for the other success codes.","if (pm.response.code !== 204) {"," var responseBody;"," pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();"," });",""," pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');"," });",""," pm.test(\"Response contains the documented fields\", function () {"," [\"results\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });"," });",""," pm.test(\"'results' is an array\", function () {"," pm.expect(responseBody[\"results\"]).to.be.an('array');"," });","}"],"type":"text/javascript","packages":{}}}],"id":"0c51d0e7-e8b9-433d-a4d2-5868ec0fdefe","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"people\": [\n {\n \"query\": {\n \"email\": \"john.doe@example.com\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/persons/batch","description":"Use this method to delete multiple persons.
NOTE Array size of the batch delete request is limited to 1000 persons.
\nRequest rate limit
\n5 requests / second (per account)
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| people | \narray of objects | \nList of people | \n
\n\n
\n
Responses
\nDefault sucesful response
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \narray of objects | \nList of any unsuccessful result from the batch operation for each processed entry. Example, email used in the request already exists. | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| people[].query | \n | \n | \n
\n\n| people[].query.identifier | \nString | \nPerson ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request | \n
\n\n| people[].query.sender | \nString | \nSender or application ID. sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL. | \n
\n\n| people[].query.type | \n | \nType of the person ID. Can be one of the above | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results[].errors | \nArray | \nList of errors | \n
\n\n| results[].query | \n | \n | \n
\n\n| results[].query.identifier | \nString | \nPerson ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request | \n
\n\n| results[].query.sender | \nString | \nSender or application ID. sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL. | \n
\n\n| results[].query.type | \n | \nType of the person ID. Can be one of the above | \n
\n\n| results[].status | \nInt | \nHTTP status | \n
\n\n
\n
GET Get a single person or a list of people
\nUse this method with a query parameter to get a single person. If the query parameter is not specified, this method will return a list of people.
\nPUT Update a person
\nUse this method to overwrite a person profile with the data passed in the request body as follows:
1. New values for standard and custom profile attributes replace existing values on the profile. If no value is passed in the request, the attribute is set to empty.
2. Tags in the request replace the existing profile tags. If no tags are passed, the existing profile tag list is cleared.
3. New contact information (email addresses and phone numbers) in the request replaces the current information on the profile
\nPOST Create a new person
\nUse this method to create a new person.
\nDEL Delete a person
\nUse this method to delete a person.
\nPATCH Partial person update
\nUse this method to update a person profile with the data passed in the request body as follows:
1. New values for standard and custom profile attributes replace existing values on the profile. If no value is passed in the request, the attribute keeps its value.
2. Tags in the request are appended to the profile tag list.
3. New contact information (email addresses and phone numbers) in the request is appended to the contact list of the profile.
\nPUT Set contact information to person
\nUse this method to replace contact information for a particular person. This methods will replace all existing emails and mobile phones with new contact information.
\nDEL Delete contact information to person
\nUse this method to delete specified emails and mobile phones from a particular person.
\nPATCH Add contact information to person
\nUse this method to add emails and mobile phones to a particular person.
\nPOST Batch people create
\nUse this method to create multiple persons.
NOTE Array size of the batch create request is limited to 1000 persons.
\nDEL Batch people delete
\nUse this method to delete multiple persons.
NOTE Array size of the batch delete request is limited to 1000 persons.
\nPATCH Batch people update
\nUse this method to update multiple persons.
NOTE Array size of the batch update request is limited to 1000 persons.
\n","_postman_id":"b3c95fb7-99bb-4001-b36e-1917e2a2d874"},{"name":"COMPANY PROFILE","item":[{"name":"Create a new company","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","(function () {"," var calls = [\"/people/2/companies?name=Example\", \"/people/2/companies?name=Company%20name%20one\", \"/people/2/companies?name=Company%20name%20two\"];"," (function next(i) { if (i >= calls.length) { return; } api(\"DELETE\", calls[i], null, function () { next(i + 1); }); })(0);","})();"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"id\", \"name\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});","","","","var r = pm.response.json();","pm.environment.set(\"companyId\", String(r.id));"],"type":"text/javascript","packages":{}}}],"id":"8679d7cc-697e-4dc9-861a-e1068d869664","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Example\",\n \"notes\": \"Sample company\",\n \"country\": \"Sweden\",\n \"industry\": \"IT\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/companies","description":"Request rate limit
\n5 requests / second (per account)
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| accountManager | \nstring [ 0 .. 255 ] characters | \nAccount manager. | \n
\n\n| country | \nstring [ 0 .. 50 ] characters | \nCountry. | \n
\n\ncustomAttributes
{
property name*
} | \nobject
object | \nList of custom attributes for the company. | \n
\n\n| customerStage | \nstring [ 0 .. 255 ] characters | \nCustomer stage. | \n
\n\n| domains | \narray of strings non-empty | \nrequired
List of domains for the company. | \n
\n\n| industry | \nstring [ 0 .. 255 ] characters | \nIndustry | \n
\n\n| name | \nstring [ 0 .. 255 ] characters | \nrequired
Company name.
| \n
\n\n| notes | \nstring [ 0 .. 1023 ] characters | \nNotes. | \n
\n\n| region | \nstring [ 0 .. 255 ] characters | \nRegion. | \n
\n\n| segment | \nstring [ 0 .. 255 ] characters | \nSegment. | \n
\n\nserviceData
{
property name*
} | \nobject
object | \nCompany's service information. | \n
\n\n| vatNumber | \nstring [ 0 .. 50 ] characters | \nVAT number. | \n
\n\n
\n
Responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| accountManager | \nstring [ 0 .. 255 ] characters | \nAccount manager. | \n
\n\n| country | \nstring [ 0 .. 50 ] characters | \nCountry. | \n
\n\n| createdAt | \nstring | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\ncustomAttributes
{
property name*
} | \nobject
object | \nList of custom attributes for the company. | \n
\n\n| customerStage | \nstring [ 0 .. 255 ] characters | \nCustomer stage. | \n
\n\n| domains | \narray of strings non-empty | \nrequired
List of domains for the company. | \n
\n\n| id | \ninteger | \nUnique id of the entity. | \n
\n\n| modifiedAt | \nstring | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedFrom | \nstring | \nEnum: \"API\" \"PORTAL\" \"WEB_SDK\" \"INTEGRATION\" \"PUSH\" \"FACEBOOK\" \"LINE\" \"TELEGRAM\" \"SALESFORCE\" \"DYNAMICS\" \"ZAPIER\" \"FORMS\" \"COMPUTED\" \"ANSWERS\" \"CONVERSATIONS\"
The information which describes the source of the last modification of record. | \n
\n\n| industry | \nstring [ 0 .. 255 ] characters | \nIndustry | \n
\n\n| name | \nstring [ 0 .. 255 ] characters | \nrequired
Company name.
| \n
\n\n| notes | \nstring [ 0 .. 1023 ] characters | \nNotes. | \n
\n\n| origin | \nstring | \nEnum: \"API\" \"PORTAL\" \"WEB_SDK\" \"INTEGRATION\" \"PUSH\" \"FACEBOOK\" \"LINE\" \"TELEGRAM\" \"SALESFORCE\" \"DYNAMICS\" \"ZAPIER\" \"FORMS\" \"COMPUTED\" \"ANSWERS\" \"CONVERSATIONS\"
The information which describes the origin of the record. | \n
\n\n| region | \nstring [ 0 .. 255 ] characters | \nRegion. | \n
\n\n| segment | \nstring [ 0 .. 255 ] characters | \nSegment. | \n
\n\nserviceData
{
property name*
} | \nobject
object | \nCompany's service information. | \n
\n\n| vatNumber | \nstring [ 0 .. 50 ] characters | \n | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| externalId | \nString | \nUnique ID for a company from your or another external system, 256 characters max | \n
\n\n| tags | \nArray | \nList of tags for the company. | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| externalId | \nString | \nUnique ID for a company from your or another external system, 256 characters max | \n
\n\n| tags | \nArray | \nList of tags for the company. | \n
\n\n
\n
Use this method with a query parameter to get a single company. If the query parameter is not specified, this method will return a list of companies.
\nRequest rate limit
\n5 requests / second (per account)
\nQuery parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| name | \nstring | \nExample: name=VHD
Name of company you want to get. | \n
\n\n| id | \n
integer | \nExample: id=87951351
ID of company you want to get. | \n
\n\n| limit | \ninteger | \nExample: limit=20
Maximum number of rows returned per page. | \n
\n\n| page | \ninteger | \nExample: page=1
This parameter says which results page you want to get. If both page and limit appear, then page rows are skipped before starting to count the limit rows that are returned. | \n
\n\n| includeTotalCount | \nboolean | \nExample: includeTotalCount=false
Returns total count of companies, if set to true. | \n
\n\n| orderBy | \nstring | \n
Example: orderBy=modifiedAt:desc
Results ordering. Possible ordering fields are name, createdAt and modifiedAt. Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.
| \n
\n\n| filter | \nstring | \nExample: filter={\"#or\":[{\"name\":\"vhd\"},{\"#contains\":{\"notes\":\"another\"}}]}
Allows to filter companies using simple queries. Just pass to the parameter URL encoded query. | \n
\n\n
\n
List of supported logical operators:
\n\n\n\n| Logical Operator | \nDescription | \n
\n\n\n\n#and | \nJoins query clauses with a logical AND returns all records that match the conditions of both clauses. | \n
\n\n#or | \nJoins query clauses with a logical OR returns all records that match the conditions of either clause. | \n
\n\n
\n
List of supported comparison operators:
\n\n\n\n| Comparison Operator | \nSupported Type | \nDescription | \n
\n\n\n\n#eq | \nstring, integer, decimal, date | \nMatches values that are equal to a specified value. | \n
\n\n#ne | \nstring, integer, decimal, date | \nMatches all values that are not equal to a specified value. | \n
\n\n#contains | \nstring | \nMatches the records that contain a specified value. | \n
\n\n#startsWith | \nstring | \nMatches the records that start with a specified value. | \n
\n\n#endsWith | \nstring | \nMatches the records that end with a specified value. | \n
\n\n#gt | \ninteger, decimal, date | \nMatches values that are greater than a specified value. | \n
\n\n#lt | \ninteger, decimal, date | \nMatches values that are less than a specified value. | \n
\n\n#gte | \ninteger, decimal, date | \nMatches values that are greater than or equal to a specified value. | \n
\n\n#lte | \ninteger, decimal, date | \nMatches values that are less than or equal to a specified value. | \n
\n\n
\n
Paging and ordering
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\nlimit | \nint | \nIf a limit count is given, no more than that many rows will be returned (possibly less, if the query itself yields fewer rows). The default value is 20. The maximum value is 1000. | \n
\n\npage | \nint | \nThis parameter says to skip that many rows before beginning to return rows. If both page and limit appear, then page rows are skipped before starting to count the limit rows that are returned. The default value is 1. | \n
\n\norderBy | \nstring | \nThis parameter is used to order your results. If an order is not given, the default order modifiedAt:desc will be applied. | \n
\n\n
\n
Responses
\nDefault sucessful response
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\ncompanies
[
accountManager
country
customAttributes
{
property name*
}
customerStage
domains
id
industry
modifiedAt
modifiedFrom
name
notes
origin
region
segment
serviceData
{
property name*
}
vatNumber
] | \narray of objects
string [ 0 .. 255 ] characters
string [ 0 .. 50 ] characters
object
object
string [ 0 .. 255 ] characters
Array of strings non-empty
integer
string [ 0 .. 255 ] characters
string
string
string [ 0 .. 255 ] characters
string [ 0 .. 1023 ] characters
string
string [ 0 .. 255 ] characters
string [ 0 .. 255 ] characters
object
object
string [ 0 .. 50 ] characters
| \nExample: name=VHD
Name of company you want to get.
Account manager.
Country.
List of custom attributes for the company.
Customer stage.
required
List of domains for the company.
Unique id of the entity.
Industry.
Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.
Enum: \"API\" \"PORTAL\" \"WEB_SDK\" \"INTEGRATION\" \"PUSH\" \"FACEBOOK\" \"LINE\" \"TELEGRAM\" \"SALESFORCE\" \"DYNAMICS\" \"ZAPIER\" \"FORMS\" \"COMPUTED\" \"ANSWERS\" \"CONVERSATIONS\"
The information which describes the source of the last modification of record.
required
Company name.
Notes.
Enum: \"API\" \"PORTAL\" \"WEB_SDK\" \"INTEGRATION\" \"PUSH\" \"FACEBOOK\" \"LINE\" \"TELEGRAM\" \"SALESFORCE\" \"DYNAMICS\" \"ZAPIER\" \"FORMS\" \"COMPUTED\" \"ANSWERS\" \"CONVERSATIONS\"
The information which describes the origin of the record.
Region.
Segment.
Company's service information.
VAT number. | \n
\n\n| limit | \n
integer | \nExample: id=11351351
ID of company you want to get. | \n
\n\n| orderBy | \nstring | \nResults ordering | \n
\n\n| page | \ninteger | \nPage number | \n
\n\n| totalCount | \ninteger | \nTotal amount of rows | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional parameters
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| externalId | \nString | \nExternal ID of company you want to get. | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| companies[].externalId | \nString | \nUnique ID for a company from your or another external system, 256 characters max | \n
\n\n| companies[].tags | \nArray | \nList of tags for the company. | \n
\n\n
\n
Partial company update method is used for updating a part of the company information. Exactly one of the query parameters must be included in the query.
\nRequest rate limit
\n5 requests / second (per account)
\nQuery parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \ninteger | \nExample: id=61451351
ID of company you want to delete. | \n
\n\n| name | \nstring | \nExample: name=vhd
Name of company you want to delete. | \n
\n\n| domain | \nstring | \nExample: domain=company-domain.com
Domain of company you want to delete. | \n
\n\n| replaceTags | \nboolean | \nExample: replaceTags=false
Flag which indicates replacement operation. | \n
\n\n
\n
Request body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| accountManager | \nstring [ 0 .. 255 ] characters | \nAccount manager. | \n
\n\n| country | \nstring [ 0 .. 50 ] characters | \nCountry. | \n
\n\ncustomAttributes
{
property name*
} | \nobject
object | \nList of custom attributes for the company. | \n
\n\n| customerStage | \nstring [ 0 .. 255 ] characters | \nCustomer stage. | \n
\n\n| domains | \narray of strings non-empty | \nrequired
List of domains for the company. | \n
\n\n| industry | \nstring [ 0 .. 255 ] characters | \nIndustry | \n
\n\n| name | \nstring [ 0 .. 255 ] characters | \nrequired
Company name.
| \n
\n\n| notes | \nstring [ 0 .. 1023 ] characters | \nNotes. | \n
\n\n| region | \nstring [ 0 .. 255 ] characters | \nRegion. | \n
\n\n| segment | \nstring [ 0 .. 255 ] characters | \nSegment. | \n
\n\n| vatNumber | \nstring [ 0 .. 50 ] characters | \nVAT number. | \n
\n\n
\n
Responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| accountManager | \nstring [ 0 .. 255 ] characters | \nAccount manager. | \n
\n\n| country | \nstring [ 0 .. 50 ] characters | \nCountry. | \n
\n\n| createdAt | \nstring | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\ncustomAttributes
{
property name*
} | \nobject
object | \nList of custom attributes for the company. | \n
\n\n| customerStage | \nstring [ 0 .. 255 ] characters | \nCustomer stage. | \n
\n\n| domains | \narray of strings non-empty | \nrequired
List of domains for the company. | \n
\n\n| id | \ninteger | \nUnique id of the entity. | \n
\n\n| modifiedAt | \nstring | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedFrom | \nstring | \nEnum: \"API\" \"PORTAL\" \"WEB_SDK\" \"INTEGRATION\" \"PUSH\" \"FACEBOOK\" \"LINE\" \"TELEGRAM\" \"SALESFORCE\" \"DYNAMICS\" \"ZAPIER\" \"FORMS\" \"COMPUTED\" \"ANSWERS\" \"CONVERSATIONS\"
The information which describes the source of the last modification of record. | \n
\n\n| industry | \nstring [ 0 .. 255 ] characters | \nIndustry | \n
\n\n| name | \nstring [ 0 .. 255 ] characters | \nrequired
Company name.
| \n
\n\n| notes | \nstring [ 0 .. 1023 ] characters | \nNotes. | \n
\n\n| origin | \nstring | \nEnum: \"API\" \"PORTAL\" \"WEB_SDK\" \"INTEGRATION\" \"PUSH\" \"FACEBOOK\" \"LINE\" \"TELEGRAM\" \"SALESFORCE\" \"DYNAMICS\" \"ZAPIER\" \"FORMS\" \"COMPUTED\" \"ANSWERS\" \"CONVERSATIONS\"
The information which describes the origin of the record. | \n
\n\n| region | \nstring [ 0 .. 255 ] characters | \nRegion. | \n
\n\n| segment | \nstring [ 0 .. 255 ] characters | \nSegment. | \n
\n\nserviceData
{
property name*
} | \nobject
object | \nCompany's service information. | \n
\n\n| vatNumber | \nstring [ 0 .. 50 ] characters | \n | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional parameters
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| externalId | \nString | \nExternal ID of company you want to update. | \n
\n\n| replaceDomains | \nBoolean | \nFlag which indicates domain replacement operation. | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| externalId | \nString | \nUnique ID for a company from your or another external system, 256 characters max | \n
\n\n| tags | \nArray | \nList of tags for the company. | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| externalId | \nString | \nUnique ID for a company from your or another external system, 256 characters max | \n
\n\n| tags | \nArray | \nList of tags for the company. | \n
\n\n
\n
Use this method to add persons to a company.
\nRequest rate limit
\n5 requests / second (per account)
\nQuery parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \n
integer | \nExample: id=61451351
ID of company you want to remove persons from. | \n
\n\n| name | \nstring | \nExample: name=VHD
Name of company you want to remove persons from. | \n
\n\n| domain | \nstring | \nstringExample: domain=www.example.com
Domain of company you want to remove persons from.
| \n
\n\n
\n
Request body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\npeople
[{
query
{
property name
}
}]
| \narray of objects
object
object | \nList of person profiles. Maximum 1000 entries
Query for single person profile. Keys can be either one of the \"contactInformation\" entry, \"external_id\" or \"id\" from the person profile json structure. Person profile keys can be mixed within a single request body | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional parameters
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| externalId | \nString | \nExternal ID of company you want to assign persons to. | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| people[].query.identifier | \nString | \nPerson ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request | \n
\n\n| people[].query.sender | \nString | \nSender or application ID. sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL. | \n
\n\n| people[].query.type | \n | \nType of the person ID. Can be one of the above | \n
\n\n
\n
Use this method to remove persons from a company.
\nRequest rate limit
\n5 requests / second (per account)
\nQuery parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \n
integer | \nExample: id=61451351
ID of company you want to remove persons from. | \n
\n\n| name | \nstring | \nExample: name=VHD
Name of company you want to remove persons from. | \n
\n\n| domain | \nstring | \nstringExample: domain=www.example.com
Domain of company you want to remove persons from.
| \n
\n\n
\n
Request body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\npeople
[{
query
{
property name
}
}]
| \narray of objects
object
object | \nList of person profiles. Maximum 1000 entries
Query for single person profile. Keys can be either one of the \"contactInformation\" entry, \"external_id\" or \"id\" from the person profile json structure. Person profile keys can be mixed within a single request body | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional parameters
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| externalId | \nString | \nExternal ID of company you want to remove persons from. | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| people[].query.identifier | \nString | \nPerson ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request | \n
\n\n| people[].query.sender | \nString | \nSender or application ID. sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL. | \n
\n\n| people[].query.type | \n | \nType of the person ID. Can be one of the above | \n
\n\n
\n
Use this method to create multiple companies.
NOTE Array size of the batch create request is limited to 1000 companies.
\nRequest rate limit
\n5 requests / second (per account)
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\ncompanies
| \narray of objects | \nList of companies. | \n
\n\n
\n
[{
\n\n\n\n | \n | \n | \n
\n\n\n\n| accountManager | \nstring [ 0 .. 255 ] characters | \nAccount manager. | \n
\n\n| country | \nstring [ 0 .. 50 ] characters | \nCountry. | \n
\n\ncustomAttributes
{
property name*
} | \nobject
object | \nList of custom attributes for the company. | \n
\n\n| customerStage | \nstring [ 0 .. 255 ] characters | \nCustomer stage. | \n
\n\n| domains | \narray of strings non-empty | \nrequired
List of domains for the company. | \n
\n\n| industry | \nstring [ 0 .. 255 ] characters | \nIndustry | \n
\n\n| name | \nstring [ 0 .. 255 ] characters | \nrequired
Company name.
| \n
\n\n| notes | \nstring [ 0 .. 1023 ] characters | \nNotes. | \n
\n\n| region | \nstring [ 0 .. 255 ] characters | \nRegion. | \n
\n\n| segment | \nstring [ 0 .. 255 ] characters | \nSegment. | \n
\n\nserviceData
{
property name*
} | \nobject
object | \nCompany's service information. | \n
\n\n| vatNumber | \nstring [ 0 .. 50 ] characters | \nVAT number. | \n
\n\n
\n
}]
\nResponses
\nDefault sucessful response
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\nresults
[{
errors
[{
message
}]
index
status
]}
| \narray of objects
array of objects
string
integer integer | \nList of any unsuccessful result from the batch operation for each processed entry. Example, name used in the request already exists.
List of errors
Error message
Index of company in request list
HTTP status in case of failure
| \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| companies[].createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| companies[].externalId | \nString | \nUnique ID for a company from your or another external system, 256 characters max | \n
\n\n| companies[].id | \nInt | \nUnique id of the entity. | \n
\n\n| companies[].modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| companies[].modifiedFrom | \n | \nThe information which describes the source of the last modification of record. | \n
\n\n| companies[].origin | \n | \nThe information which describes the origin of the record. | \n
\n\n| companies[].tags | \nArray | \nList of tags for the company. | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results[].id | \nInt | \nId of created company | \n
\n\n
\n
Use this method to update multiple companies.
NOTE Array size of the batch update request is limited to 1000 companies.
\nRequest rate limit
\n5 requests / second (per account)
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\ncompanies
[{
query
}]
| \narray of objects
object | \nList of companies.
Should contain company object defined as (key, value) pair. Key can be \"id\", \"name\", \"domain\". | \n
\n\n
\n
Responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\nresults
[{
errors
[{
message
}]
query
status
]}
| \narray of objects
array of objects
string
object | \nList of any unsuccessful result from the batch operation for each processed entry. Example, name used in the request already exists.
List of errors
Error message
Query used for company identification
HTTP status in case of failure | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| companies[].query.externalId | \nString | \nCompany external ID | \n
\n\n| companies[].update.accountManager | \nString | \nAccount manager. | \n
\n\n| companies[].update.country | \nString | \nCountry. | \n
\n\n| companies[].update.createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| companies[].update.customAttributes | \nObject | \nList of custom attributes for the company. | \n
\n\n| companies[].update.customerStage | \nString | \nCustomer stage. | \n
\n\n| companies[].update.domains | \nArray | \nList of domains for the company. | \n
\n\n| companies[].update.industry | \nString | \nIndustry. | \n
\n\n| companies[].update.modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| companies[].update.modifiedFrom | \n | \nThe information which describes the source of the last modification of record. | \n
\n\n| companies[].update.notes | \nString | \nNotes. | \n
\n\n| companies[].update.origin | \n | \nThe information which describes the origin of the record. | \n
\n\n| companies[].update.region | \nString | \nRegion. | \n
\n\n| companies[].update.segment | \nString | \nSegment. | \n
\n\n| companies[].update.serviceData | \nObject | \nCompany's service information. | \n
\n\n| companies[].update.tags | \nArray | \nList of tags for the company. | \n
\n\n| companies[].update.vatNumber | \nString | \nVAT number. | \n
\n\n
\n
Use this method with a query parameter to delete a company. Exactly one of the query parameters must be included in the query.
\nRequest rate limit
\n5 requests / second (per account)
\nQuery parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \ninteger | \nExample: id=11351351
ID of company you want to delete. | \n
\n\n| name | \nstring | \nExample: name=vhd
Name of company you want to delete. | \n
\n\n| domain | \nstring | \nExample: domain=company-domain.com
Domain of company you want to delete. | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional parameters
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| externalId | \nString | \nExternal ID of company you want to delete. | \n
\n\n
\n
Use this method to delete multiple companies.
NOTE Array size of the batch delete request is limited to 1000 companies.
\nRequest rate limit
\n5 requests / second (per account)
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\ncompanies
[{
query
}]
| \narray of objects
object | \nList of companies.
Should contain company object defined as (key, value) pair. Key can be \"id\", \"name\", \"domain\". | \n
\n\n
\n
Responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\nresults
[{
errors
[{
message
}]
query
status
]}
| \narray of objects
array of objects
string
object | \nList of any unsuccessful result from the batch operation for each processed entry. Example, name used in the request already exists.
List of errors
Error message
Query used for company identification
HTTP status in case of failure
| \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| companies[].query.externalId | \nString | \nCompany external ID | \n
\n\n
\n
GET Get a single company or a list of companies
\nUse this method with a query parameter to get a single company. If the query parameter is not specified, this method will return a list of companies.
\nPOST Create a new company
\nUse this method to create a new company.
\nDEL Delete a company
\nUse this method with a query parameter to delete a company. Exactly one of the query parameters must be included in the query.
\nPATCH Partial company update
\nPartial company update method is used for updating a part of the company information. Exactly one of the query parameters must be included in the query.
\nPOST Batch companies create
\nUse this method to create multiple companies.
NOTE Array size of the batch create request is limited to 1000 companies.
\nDEL Batch companies delete
\nUse this method to delete multiple companies.
NOTE Array size of the batch delete request is limited to 1000 companies.
\nPATCH Batch companies update
\nUse this method to update multiple companies.
NOTE Array size of the batch update request is limited to 1000 companies.
\nDEL Remove persons from company batch
\nUse this method to remove persons from a company.
\nPATCH Add persons to company batch
\nUse this method to add persons to a company.
\n","_postman_id":"388a4bd4-8a81-4cd2-9e3c-864472ab3aa2"},{"name":"TAGS","item":[{"name":"Create a new tag","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","(function () {"," var calls = [\"/people/2/tags/Vip\"];"," (function next(i) { if (i >= calls.length) { return; } api(\"DELETE\", calls[i], null, function () { next(i + 1); }); })(0);","})();"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","pm.test(\"Response contains the documented fields\", function () {"," [\"name\"].forEach(function (key) {"," pm.expect(responseBody, 'missing field ' + key).to.have.property(key);"," });","});"],"type":"text/javascript","packages":{}}}],"id":"615be2bb-addf-4984-9811-01c728d8e141","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Vip\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/tags","description":"Use this method to create a new tag.
\nRequest rate limit
\n5 requests/second (per account)
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| name | \nstring | \nTag name, 256 characters max | \n
\n\n
\n
Responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| createdAt | \nstring | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modieifedAt | \nstring | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss | \n
\n\n| name | \nstring | \nTag name, 256 characters max | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nInt | \nUnique id of the entity. | \n
\n\n| modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nInt | \nUnique id of the entity. | \n
\n\n| modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n
\n
Use this method to get a list of tags with pagination.
\nRequest rate limit
\n5 requests / second (per account)
\nQuery parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| limit | \n
integer | \nExample: limit=100 | \n
\n\n| page | \ninteger | \nExample: page=1 | \n
\n\n| orderBy | \nstring | \nExample: orderBy=name:asc | \n
\n\n| includeTotalCount | \nboolean | \nExample: includeTotalCount=false | \n
\n\n
\n
Response
\nArray [
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| createsAt | \nstring | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedAt | \nstring | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| name | \nstring | \nTag name, 256 characters max | \n
\n\n
\n
]
\nError responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| [].createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| [].id | \nInt | \nUnique id of the entity. | \n
\n\n
\n
Use this method to get a single tag.
\nRequest rate limit
\n5 requests / second (per account)
\nPath parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| name | \nstring | \nRequired.
Example: name=Vip
Name of the tag. | \n
\n\n
\n
Response
\nArray [
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| createsAt | \nstring | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| modifiedAt | \nstring | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| name | \nstring | \nTag name, 256 characters max | \n
\n\n
\n
]
\nError responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| id | \nInt | \nUnique id of the entity. | \n
\n\n
\n
This method allows you to assign tag to multiple people.
NOTE Array size of the batch add request is limited to 1000 people.
\nRequest rate limit
\n5 requests / second (per account)
\nPath parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| name | \nstring | \nRequired.
Example: name=Vip
Name of the tag. | \n
\n\n
\n
Request body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\npeople
[{
query
{
property name
}
}]
| \narray of objects
object
object | \nList of person profiles. Maximum 1000 entries
Query for single person. Example: \"email\": \"janesmith@example.com\" | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| people[].query.identifier | \nString | \nPerson ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request | \n
\n\n| people[].query.sender | \nString | \nSender or application ID. sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL. | \n
\n\n| people[].query.type | \n | \nType of the person ID. Can be one of the above | \n
\n\n
\n
This method allows you to remove tags from multiple people.
NOTE Array size of the batch remove request is limited to 1000 people.
\nRequest rate limit
\n5 requests / second (per account)
\nPath parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| name | \nstring | \nRequired.
Example: name=Vip
Name of the tag. | \n
\n\n
\n
Request body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\npeople
[{
query
{
property name
}
}]
| \narray of objects
object
object | \nList of person profiles. Maximum 1000 entries
Query for single person. Example: \"email\": \"janesmith@example.com\" | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional request fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| people[].query.identifier | \nString | \nPerson ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request | \n
\n\n| people[].query.sender | \nString | \nSender or application ID. sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL. | \n
\n\n| people[].query.type | \n | \nType of the person ID. Can be one of the above | \n
\n\n
\n
Use this method to delete the existing tag.
\nRequest rate limit
\n5 requests / second (per account)
\nPath parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| name | \nstring | \nExample: name=Vip
Name of the tag. | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description | \n
\n\n
\n
Create a new custom attribute by using this method.
\nRequest rate limit
\n5 requests / second (per account)
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| dataType | \nstring | \nEnum: \"STRING\" \"DECIMAL\" \"INTEGER\" \"BOOLEAN\" \"DATE\" \"DATE_TIME\" \"LIST_OF_OBJECTS\"
Custom attribute type. | \n
\n\n| name | \nstring | \nCustom attribute name, 256 characters max. Invalid characters: {}[]. | \n
\n\nobjectSchema
{
property name
} | \nobject
string | \nObject schema for LIST_OF_OBJECTS type. Defines the shape of the list items.
Enum: \"STRING\" \"DECIMAL\" \"INTEGER\" \"BOOLEAN\" \"DATE\" \"DATE_TIME\" \"LIST_OF_OBJECTS\" | \n
\n\n
\n
Responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\ncreatedAt
dataType
modifiedAt
name
objectSchema
{
property name
}
| \nstring
string
string
string
object
string
| \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss
Enum: \"STRING\" \"DECIMAL\" \"INTEGER\" \"BOOLEAN\" \"DATE\" \"DATE_TIME\" \"LIST_OF_OBJECTS\"
Custom attribute type.
Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.
Custom attribute name, 256 characters max. Invalid characters: {}[].
Enum: \"STRING\" \"DECIMAL\" \"INTEGER\" \"BOOLEAN\" \"DATE\" \"DATE_TIME\" \"LIST_OF_OBJECTS\"
| \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Create an attribute that holds a list of objects, here a shopping cart. The person list requests (PERSON LISTS (API v3)) work on this attribute.
\nCreate a new custom attribute by using this method.
\nRequest rate limit
\n5 requests / second (per account)
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| dataType | \nstring | \nEnum: \"STRING\" \"DECIMAL\" \"INTEGER\" \"BOOLEAN\" \"DATE\" \"DATE_TIME\" \"LIST_OF_OBJECTS\"
Custom attribute type. | \n
\n\n| name | \nstring | \nCustom attribute name, 256 characters max. Invalid characters: {}[]. | \n
\n\nobjectSchema
{
property name
} | \nobject
string | \nObject schema for LIST_OF_OBJECTS type. Defines the shape of the list items.
Enum: \"STRING\" \"DECIMAL\" \"INTEGER\" \"BOOLEAN\" \"DATE\" \"DATE_TIME\" \"LIST_OF_OBJECTS\" | \n
\n\n
\n
Responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\ncreatedAt
dataType
modifiedAt
name
objectSchema
{
property name
}
| \nstring
string
string
string
object
string
| \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss
Enum: \"STRING\" \"DECIMAL\" \"INTEGER\" \"BOOLEAN\" \"DATE\" \"DATE_TIME\" \"LIST_OF_OBJECTS\"
Custom attribute type.
Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.
Custom attribute name, 256 characters max. Invalid characters: {}[].
Enum: \"STRING\" \"DECIMAL\" \"INTEGER\" \"BOOLEAN\" \"DATE\" \"DATE_TIME\" \"LIST_OF_OBJECTS\"
| \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Get a list of custom attributes using this method.
\nRequest rate limit
\n5 requests / second (per account)
\nQuery parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| limit | \ninteger | \nExample: limit=100
Limit how many rows will be returned (but possibly less, if the query itself yields fewer rows). | \n
\n\n| page | \ninteger | \nExample: page=1
This parameter says which results page you want to get. If both page and limit appear, then page rows are skipped before starting to count the limit rows that are returned | \n
\n\n| includeTotalCount | \nboolean | \nExample: includeTotalCount=false
Will return total count of custom attributes if set to true. | \n
\n\n| orderBy | \nstring | \nExample: orderBy=name:asc
Results ordering. Possible ordering fields are name, createdAt and modifiedAt. Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one. | \n
\n\n
\n
Responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\ncustomAttributes
[{
createdAt
dataType
modifiedAt
name
objectSchema
{
property name
}
}]
limit
orderBy
page
totalCount
| \narray of objects
string
string
string
string
object
string
integer
string
integer
integer | \nList of custom attributes.
Date and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss
Enum: \"STRING\" \"DECIMAL\" \"INTEGER\" \"BOOLEAN\" \"DATE\" \"DATE_TIME\" \"LIST_OF_OBJECTS\"
Custom attribute type.
Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.
Custom attribute name, 256 characters max. Invalid characters: {}[].
Enum: \"STRING\" \"DECIMAL\" \"INTEGER\" \"BOOLEAN\" \"DATE\" \"DATE_TIME\" \"LIST_OF_OBJECTS\"
Limit how many rows will be returned (but possibly less, if the query itself yields fewer rows)
Results ordering.
Page number
Total amount of rows | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Get a single custom attribute using this method.
\nRequest rate limit
\n5 requests / second (per account)
\nQuery parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| name | \nstring | \nRequired
Example: Attribute
Name of the attribute you want to delete. | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Additional response fields
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| dataType | \n | \nCustom attribute type. | \n
\n\n| modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| objectSchema | \nObject | \nObject schema for LIST_OF_OBJECTS type. Defines the shape of the list items. | \n
\n\n
\n
Custom attributes with LIST_OF_OBJECTS type contain an array of items as a value. Using this API method, you can add a new item to the specified list type custom attribute of a specific person. The item you want to add should match the defined list schema.
\nRequest rate limit
\n5 requests / second (per account)
\nPath parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| name | \nstring | \nRequired
Example: Attribute
Name of the attribute you want to delete. | \n
\n\n
\n
Query parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| phone | \nstring | \nExample: phone=46701234567
Person’s phone number. Phone numbers must be in international format. | \n
\n\n| email | \nstring | \nExample: email=name@example.com
Person’s email address. Must comply with the email format and cannot exceed 255 characters. One person can have up to 100 email addresses. | \n
\n\n| externalId | \nstring | \nExample: externalId=6F9619FF-8B86-D011-B42D-00CF4FC964FF
Unique ID for a person from your or another external system. | \n
\n\n| pushRegistrationId | \nstring | \nExample: pushRegistrationId=6F9619FF-8B86-D011-B42D-00CF4FC964FF
Person's push registration ID. | \n
\n\n| id | \nineger | \nExample: id=11351351
Person's internal ID. | \n
\n\n| lineId | \nstring | \nExample: lineId=U045147f1ad961bfe996b72bbf417f3c9
Person’s Line ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameters. | \n
\n\n| lineSenderId | \nstring | \nExample: lineSenderId=1644264921
Person’s Line sender ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameter | \n
\n\n| facebookId | \nstring | \nExample: facebookId=370329180020364
Person’s Facebook ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters. | \n
\n\n| facebookSenderId | \ninteger | \nExample: facebookSenderId=2094832040560427
Person’s Facebook sender ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters. | \n
\n\n| telegramUserId | \nstring | \nExample: telegramUserId=1303201999
Person’s Telegram user ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters. | \n
\n\n| telegramBotId | \nstring | \nExample: telegramBotId=1495032701
Person’s Telegram bot ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters. | \n
\n\n| viberBotUserId | \nstring | \nExample: viberBotUserId=Upk26V/i1GXfvxZ8S41P/w==
Person’s Viber Bot user ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters. | \n
\n\n| viberBotId | \n
integer | \nExample: viberBotId=5591458813882487336
Person’s Viber Bot ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters. | \n
\n\n| instagramId | \nstring | \nExample: instagramId=17841546155331428
Person’s Instagram user ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters. | \n
\n\n| instagramSenderId | \ninteger | \nExample: instagramSenderId=17841405793187218
Person’s Instagram sender ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters. | \n
\n\n| twitterId | \nstring | \nexample: twitterId=370329180020364
Person’s Twitter user ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters. | \n
\n\n| twitterSenderId | \ninteger | \nExample: twitterSenderId=10765432100123456789
Person’s Twitter sender ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters. | \n
\n\n| appleBusinessChatId | \nstring | \nExample: appleBusinessChatId=ef6ca8e9-3718-4dc9-a9a0-b4ac28d135ca
Person’s Apple Business Chat ID. To get person by Apple BC channel, you need to specify both appleBusinessChatId and appleBusinessChatSenderId parameters. | \n
\n\n| appleBusinessChatSenderId | \nstring | \nExample: appleBusinessChatSenderId=urn:mbid:AQAAYyUbut3B2E3T9GLv4EaF/
Person’s Apple Business Chat sender ID. To get person by Apple BC channel, you need to specify both appleBusinessChatId and appleBusinessChatSenderId parameters. | \n
\n\n| liveChatRegId | \nstring | \nExample: liveChatRegId=79f9701b-e350-4497-9689-b2257864e63f | \n
\n\n
\n
Additional parameters
\nThese fields are also supported.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| identifier | \nString | \nPerson ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request | \n
\n\n
\n
Use this method to delete the custom attribute.
\nRequest rate limit
\n5 requests / second (per account)
\nPath parameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| name | \nstring | \nRequired
Example: Attribute
Name of the attribute you want to delete. | \n
\n\n
\n
Error responses
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| requestError | \nobject | \n | \n
\n\n| serviceException | \nobject | \n | \n
\n\n| messageId | \nstring | \nIdentifier of the error | \n
\n\n| text | \nstring | \nDetailed error description. | \n
\n\n
\n
Replace a list.
\nReplaces all items in a list attribute and returns all items of the updated list.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| listName | \nString | \nRequired. Name of the list attribute. | \n
\n\n| type | \nString | \nRequired. Type of the person ID. Can be one of the above. One of: ID, EXTERNAL_ID, PHONE, EMAIL, LINE, FACEBOOK, TELEGRAM, PUSH, LIVE_CHAT, VIBER_BOTS, INSTAGRAM, INSTAGRAM_DM, TWITTER, APPLE_BUSINESS_CHAT, KAKAO_SANGDAM, OPEN_CHANNEL, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK. | \n
\n\n| identifier | \nString | \nRequired. Person ID. ID type must match the type parameter. | \n
\n\n| sender | \nString | \nSender or application ID.sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL | \n
\n\n
\n
On success the response is 200 OK.
\nStatus codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["people","3","lists","ShoppingCartList"],"host":["go2","vhdmedia","se"],"query":[{"key":"type","value":"EMAIL"},{"key":"identifier","value":"janewilliams@example.com"}],"variable":[]}},"response":[{"id":"9256bc9f-5c1f-4539-a6fa-4f47ff7e3ba6","name":"200 - Response example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n },\n {\n \"item_field_#1\": \"some value\"\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"__id\": \"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4\",\n \"item_field_#1\": \"some value\"\n },\n {\n \"__id\": \"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f\",\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n }\n]"},{"id":"0de625aa-fdbe-4119-8242-0633b23a4368","name":"400 - real VHD response","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n },\n {\n \"item_field_#1\": \"some value\"\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid body\"\n}"},{"id":"82164090-7895-4b9a-8f40-b284f69837de","name":"401 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n },\n {\n \"item_field_#1\": \"some value\"\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"590727fc-1572-4be5-82e2-7e3d9dbb4722","name":"403 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n },\n {\n \"item_field_#1\": \"some value\"\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"c00868ec-6976-454d-87a5-1b9fd64d6eee","name":"404 - person doesn't exist","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n },\n {\n \"item_field_#1\": \"some value\"\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 300101,\n \"message\": \"Person with ID 'test@gmail.com' does not exist\"\n}"},{"id":"f2034523-37e9-4725-a870-bbc20e5883d5","name":"429 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n },\n {\n \"item_field_#1\": \"some value\"\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"68b7d225-76bf-4a10-9fc1-ae9ab76c8f5e","name":"500 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n },\n {\n \"item_field_#1\": \"some value\"\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"a764a22f-084e-423d-9354-f2232dd22afc"},{"name":"Get lists","event":[{"listen":"test","script":{"exec":["// Tests for Get lists.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var res;","pm.test(\"Response body is valid JSON\", function () { res = pm.response.json(); });","","pm.test(\"Response is an object with one array of items per requested list\", function () {"," pm.expect(res).to.be.an('object');"," Object.keys(res).forEach(function (listName) {"," pm.expect(res[listName], 'list ' + listName).to.be.an('array');"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"2464a2c6-ee29-4879-84a3-33fe20b2428a","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/lists?listNames=ShoppingCartList&type=EMAIL&identifier=janewilliams@example.com","description":"Get lists.
\nReturns all items of a single or multiple list attributes.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| listNames | \nArray | \nRequired. Names of list attributes to return, separated by commas (,). | \n
\n\n| type | \nString | \nRequired. Type of the person ID. Can be one of the above. One of: ID, EXTERNAL_ID, PHONE, EMAIL, LINE, FACEBOOK, TELEGRAM, PUSH, LIVE_CHAT, VIBER_BOTS, INSTAGRAM, INSTAGRAM_DM, TWITTER, APPLE_BUSINESS_CHAT, KAKAO_SANGDAM, OPEN_CHANNEL, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK. | \n
\n\n| identifier | \nString | \nRequired. Person ID. ID type must match the type parameter. | \n
\n\n| sender | \nString | \nSender or application ID.sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL | \n
\n\n
\n
On success the response is 200 OK.
\nStatus codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["people","3","lists"],"host":["go2","vhdmedia","se"],"query":[{"key":"listNames","value":"ShoppingCartList"},{"key":"type","value":"EMAIL"},{"key":"identifier","value":"janewilliams@example.com"}],"variable":[]}},"response":[{"id":"84701f1a-f4d3-4f27-9af4-7a18467e28e0","name":"200 - Response example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists?listNames={{listName}}&type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists"],"query":[{"key":"listNames","value":"{{listName}}","description":"Names of list attributes to return, separated by commas (,)."},{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"my list\": [\n {\n \"__id\": \"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4\",\n \"item_field_#1\": \"some value\"\n },\n {\n \"__id\": \"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f\",\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n }\n ]\n}"},{"id":"a72ef323-f878-4deb-b20b-da837d6cd3e1","name":"400 - identifier is not provided","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists?listNames={{listName}}&type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists"],"query":[{"key":"listNames","value":"{{listName}}","description":"Names of list attributes to return, separated by commas (,)."},{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 400116,\n \"message\": \"Missing parameter: identifier\"\n}"},{"id":"cdb6661b-4f68-4f6c-9313-9879e798b371","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists?listNames={{listName}}&type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists"],"query":[{"key":"listNames","value":"{{listName}}","description":"Names of list attributes to return, separated by commas (,)."},{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"ff5ede65-1655-4f38-be5e-b5b44f1af4fc","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists?listNames={{listName}}&type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists"],"query":[{"key":"listNames","value":"{{listName}}","description":"Names of list attributes to return, separated by commas (,)."},{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"50d85e74-8a25-4736-94d0-7fedea36f377","name":"404 - real VHD response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists?listNames={{listName}}&type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists"],"query":[{"key":"listNames","value":"{{listName}}","description":"Names of list attributes to return, separated by commas (,)."},{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 300101,\n \"message\": \"Person with ID 'jane.smith@vhdmedia.se' does not exist\"\n}"},{"id":"c8aead34-216a-4e08-a464-445a45d1daf4","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists?listNames={{listName}}&type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists"],"query":[{"key":"listNames","value":"{{listName}}","description":"Names of list attributes to return, separated by commas (,)."},{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"a8756f89-20f3-4b04-b1c7-8ebc7a3e8325","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists?listNames={{listName}}&type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists"],"query":[{"key":"listNames","value":"{{listName}}","description":"Names of list attributes to return, separated by commas (,)."},{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"2464a2c6-ee29-4879-84a3-33fe20b2428a"},{"name":"Append items","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an array\", function () {"," pm.expect(responseBody).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"7496ca62-930a-4d27-b7ad-4299084c4921","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"productName\": \"Cap\",\n \"productPrice\": 11.33,\n \"productCategory\": \"Sport\",\n \"productImage\": \"/image.png\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/lists/ShoppingCartList/items?type=EMAIL&identifier=janewilliams@example.com","description":"Append items.
\nAdds new items to a list attribute and returns all items of the updated list.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| listName | \nString | \nRequired. Name of the list attribute. | \n
\n\n| type | \nString | \nRequired. Type of the person ID. Can be one of the above. One of: ID, EXTERNAL_ID, PHONE, EMAIL, LINE, FACEBOOK, TELEGRAM, PUSH, LIVE_CHAT, VIBER_BOTS, INSTAGRAM, INSTAGRAM_DM, TWITTER, APPLE_BUSINESS_CHAT, KAKAO_SANGDAM, OPEN_CHANNEL, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK. | \n
\n\n| identifier | \nString | \nRequired. Person ID. ID type must match the type parameter. | \n
\n\n| sender | \nString | \nSender or application ID.sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL | \n
\n\n
\n
On success the response is 200 OK.
\nStatus codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["people","3","lists","ShoppingCartList","items"],"host":["go2","vhdmedia","se"],"query":[{"key":"type","value":"EMAIL"},{"key":"identifier","value":"janewilliams@example.com"}],"variable":[]}},"response":[{"id":"131c37d8-db3b-4fd8-8dff-78c745972ec4","name":"200 - Response example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"__id\": \"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4\",\n \"item_field_#1\": \"some value\"\n },\n {\n \"__id\": \"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f\",\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n }\n]"},{"id":"4702def3-517d-46b2-ba26-a20f28d8b17b","name":"400 - real VHD response","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid body\"\n}"},{"id":"c70c315f-a28e-42dd-9369-5c9300d0bc94","name":"401 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"e2734989-f208-4a31-8888-b92db064c2af","name":"403 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"4e4e5082-073a-4eba-9128-c4b4cd17ab59","name":"404 - person doesn't exist","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 300101,\n \"message\": \"Person with ID 'test@gmail.com' does not exist\"\n}"},{"id":"6c941810-6e7d-4c40-9263-e94295aabe09","name":"429 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"481e2834-29c7-4828-b807-65688025cdf9","name":"500 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"7496ca62-930a-4d27-b7ad-4299084c4921"},{"name":"Get items","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an array\", function () {"," pm.expect(responseBody).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"9e938d0e-f7e4-48b1-9411-c50e53ef3d29","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/lists/ShoppingCartList/items?type=EMAIL&identifier=janewilliams@example.com&itemIds={{itemIds}}","description":"Get items.
\nGet a single item or a list of items of a list attribute.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| listName | \nString | \nRequired. Name of the list attribute. | \n
\n\n| type | \nString | \nRequired. Type of the person ID. Can be one of the above. One of: ID, EXTERNAL_ID, PHONE, EMAIL, LINE, FACEBOOK, TELEGRAM, PUSH, LIVE_CHAT, VIBER_BOTS, INSTAGRAM, INSTAGRAM_DM, TWITTER, APPLE_BUSINESS_CHAT, KAKAO_SANGDAM, OPEN_CHANNEL, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK. | \n
\n\n| identifier | \nString | \nRequired. Person ID. ID type must match the type parameter. | \n
\n\n| sender | \nString | \nSender or application ID.sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL | \n
\n\n| itemIds | \nArray | \nRequired. UUIDs of list items to return, separated by commas (,). | \n
\n\n
\n
On success the response is 200 OK.
\nStatus codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["people","3","lists","ShoppingCartList","items"],"host":["go2","vhdmedia","se"],"query":[{"key":"type","value":"EMAIL"},{"key":"identifier","value":"janewilliams@example.com"},{"key":"itemIds","value":"{{itemIds}}"}],"variable":[]}},"response":[{"id":"7f56dbd5-2915-48b2-a1cf-60e6a5af1574","name":"200 - Response example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}&itemIds={{itemIds}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true},{"key":"itemIds","value":"{{itemIds}}","description":"UUIDs of list items to return, separated by commas (,)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"__id\": \"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4\",\n \"item_field_#1\": \"some value\"\n },\n {\n \"__id\": \"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f\",\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n }\n]"},{"id":"4d57ff95-2588-4b4f-96ef-5c8106ce6332","name":"400 - identifier is not provided","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}&itemIds={{itemIds}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true},{"key":"itemIds","value":"{{itemIds}}","description":"UUIDs of list items to return, separated by commas (,)."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 400116,\n \"message\": \"Missing parameter: identifier\"\n}"},{"id":"fad94c5a-7032-491b-b900-1fbeb0d818c7","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}&itemIds={{itemIds}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true},{"key":"itemIds","value":"{{itemIds}}","description":"UUIDs of list items to return, separated by commas (,)."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"41a2fa64-ff34-4b39-a38d-4c9c5cb266f2","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}&itemIds={{itemIds}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true},{"key":"itemIds","value":"{{itemIds}}","description":"UUIDs of list items to return, separated by commas (,)."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"7f37625a-393c-446b-86e4-beef77a890e6","name":"404 - real VHD response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}&itemIds={{itemIds}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true},{"key":"itemIds","value":"{{itemIds}}","description":"UUIDs of list items to return, separated by commas (,)."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 300101,\n \"message\": \"Person with ID 'jane.smith@vhdmedia.se' does not exist\"\n}"},{"id":"651af559-4f6d-4263-8998-55bb4ace4fe2","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}&itemIds={{itemIds}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true},{"key":"itemIds","value":"{{itemIds}}","description":"UUIDs of list items to return, separated by commas (,)."}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"7e732335-7fcc-4d63-9432-24d21d4c79d3","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}&itemIds={{itemIds}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true},{"key":"itemIds","value":"{{itemIds}}","description":"UUIDs of list items to return, separated by commas (,)."}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"9e938d0e-f7e4-48b1-9411-c50e53ef3d29"},{"name":"Update an item","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an array\", function () {"," pm.expect(responseBody).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"c84a80fb-0b5a-40e0-88b6-7045943cab3f","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"productName\": \"Sneakers (patched)\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/lists/ShoppingCartList/items/{{itemId}}?type=EMAIL&identifier=janewilliams@example.com","description":"Update an item.
\nUpdates the fields of a list item that are passed in the request. Missing fields will keep their values. Returns all items of the updated list attribute.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| listName | \nString | \nRequired. Name of the list attribute. | \n
\n\n| itemId | \nString | \nRequired. UUID of the list item to update. | \n
\n\n| type | \nString | \nRequired. Type of the person ID. Can be one of the above. One of: ID, EXTERNAL_ID, PHONE, EMAIL, LINE, FACEBOOK, TELEGRAM, PUSH, LIVE_CHAT, VIBER_BOTS, INSTAGRAM, INSTAGRAM_DM, TWITTER, APPLE_BUSINESS_CHAT, KAKAO_SANGDAM, OPEN_CHANNEL, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK. | \n
\n\n| identifier | \nString | \nRequired. Person ID. ID type must match the type parameter. | \n
\n\n| sender | \nString | \nSender or application ID.sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL | \n
\n\n
\n
On success the response is 200 OK.
\nStatus codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["people","3","lists","ShoppingCartList","items","{{itemId}}"],"host":["go2","vhdmedia","se"],"query":[{"key":"type","value":"EMAIL"},{"key":"identifier","value":"janewilliams@example.com"}],"variable":[]}},"response":[{"id":"f9a4cf0d-1985-492f-bd37-d0943fc8445c","name":"200 - Response example","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"item_field_#1\": \"new field value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items/{{itemId}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items","{{itemId}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"__id\": \"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4\",\n \"item_field_#1\": \"new field value\"\n },\n {\n \"__id\": \"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f\",\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n }\n]"},{"id":"c1720316-f37e-4433-86d8-29c249d40108","name":"400 - real VHD response","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"item_field_#1\": \"new field value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items/{{itemId}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items","{{itemId}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 400101,\n \"message\": \"Validation errors: property itemBody - size must be between 1 and 128\"\n}"},{"id":"6038a2d5-d379-4459-881c-0a45fd6e7695","name":"401 - Example","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"item_field_#1\": \"new field value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items/{{itemId}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items","{{itemId}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"bd2bc927-a1c4-4352-b06d-64faa241c6f3","name":"403 - Example","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"item_field_#1\": \"new field value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items/{{itemId}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items","{{itemId}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"20aa85f7-22c0-4f1f-b607-c6aa3d7698d6","name":"404 - person doesn't exist","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"item_field_#1\": \"new field value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items/{{itemId}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items","{{itemId}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 300101,\n \"message\": \"Person with ID 'test@gmail.com' does not exist\"\n}"},{"id":"6725afc2-44c9-46b5-b6f8-99187f23da88","name":"429 - Example","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"item_field_#1\": \"new field value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items/{{itemId}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items","{{itemId}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"e5d0a010-56e2-4e7b-9c67-09f5a9cc6c42","name":"500 - Example","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"item_field_#1\": \"new field value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items/{{itemId}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items","{{itemId}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"c84a80fb-0b5a-40e0-88b6-7045943cab3f"},{"name":"Replace an item","event":[{"listen":"test","script":{"exec":["// Tests for Replace an item.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var res;","pm.test(\"Response body is valid JSON\", function () { res = pm.response.json(); });","","pm.test(\"Response is the updated list (an array of items)\", function () {"," pm.expect(res).to.be.an('array');"," res.forEach(function (item) { pm.expect(item).to.have.property('__id'); });","});",""],"type":"text/javascript","packages":{}}}],"id":"a5da7a0d-4fc5-4665-a2c5-832d1272c8dd","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"productName\": \"T-Shirt (replaced)\",\n \"productPrice\": 7.5,\n \"productCategory\": \"Sport\",\n \"productImage\": \"/image.png\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/lists/ShoppingCartList/items/{{itemLastId}}?type=EMAIL&identifier=janewilliams@example.com","description":"Replace an item.
\nReplaces an item of a list attribute and returns all items of the updated list.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| listName | \nString | \nRequired. Name of the list attribute. | \n
\n\n| itemId | \nString | \nRequired. UUID of the list item to replace. | \n
\n\n| type | \nString | \nRequired. Type of the person ID. Can be one of the above. One of: ID, EXTERNAL_ID, PHONE, EMAIL, LINE, FACEBOOK, TELEGRAM, PUSH, LIVE_CHAT, VIBER_BOTS, INSTAGRAM, INSTAGRAM_DM, TWITTER, APPLE_BUSINESS_CHAT, KAKAO_SANGDAM, OPEN_CHANNEL, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK. | \n
\n\n| identifier | \nString | \nRequired. Person ID. ID type must match the type parameter. | \n
\n\n| sender | \nString | \nSender or application ID.sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL | \n
\n\n
\n
On success the response is 200 OK.
\nStatus codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["people","3","lists","ShoppingCartList","items","{{itemLastId}}"],"host":["go2","vhdmedia","se"],"query":[{"key":"type","value":"EMAIL"},{"key":"identifier","value":"janewilliams@example.com"}],"variable":[]}},"response":[{"id":"d0944379-207b-41bb-b636-f54c060b95f1","name":"200 - Item replaced (the updated list is returned)","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"item_field_#1\": \"new field value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items/{{itemId}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items","{{itemId}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"__id\": \"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f\",\n \"item_field_#1\": \"new field value\"\n },\n {\n \"__id\": \"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4\",\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n }\n]"},{"id":"6342113f-2d36-43ff-a2c7-9f3de6a0d34f","name":"400 - real VHD response","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"item_field_#1\": \"new field value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items/{{itemId}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items","{{itemId}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 400101,\n \"message\": \"Validation errors: property itemBody - size must be between 1 and 128\"\n}"},{"id":"02a242e2-cf73-4b08-9ba5-14d2f7b0e029","name":"401 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"item_field_#1\": \"new field value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items/{{itemId}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items","{{itemId}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"1140a983-ac96-4c30-b863-b871c6606765","name":"403 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"item_field_#1\": \"new field value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items/{{itemId}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items","{{itemId}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"b8e532cf-9269-4e25-8d38-4762e917b2c6","name":"404 - person doesn't exist","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"item_field_#1\": \"new field value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items/{{itemId}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items","{{itemId}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 300101,\n \"message\": \"Person with ID 'test@gmail.com' does not exist\"\n}"},{"id":"3e41d7c1-05c9-449a-a02c-1a63c2929e22","name":"429 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"item_field_#1\": \"new field value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items/{{itemId}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items","{{itemId}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"a67bd116-9518-4227-a1d8-da553f4f2ce0","name":"500 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"item_field_#1\": \"new field value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items/{{itemId}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items","{{itemId}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"a5da7a0d-4fc5-4665-a2c5-832d1272c8dd"},{"name":"Update a list","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an array\", function () {"," pm.expect(responseBody).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"ce8a01f6-2e3d-4198-b436-9499c5efde1f","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"__id\": \"{{itemId}}\",\n \"productName\": \"Sneakers (list-patched)\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/lists/ShoppingCartList?type=EMAIL&identifier=janewilliams@example.com","description":"Update a list.
\nUpdates the fields of list items passed in the request. Missing items and fields will keep their values. Returns all items of the updated list.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| listName | \nString | \nRequired. Name of the list attribute. | \n
\n\n| type | \nString | \nRequired. Type of the person ID. Can be one of the above. One of: ID, EXTERNAL_ID, PHONE, EMAIL, LINE, FACEBOOK, TELEGRAM, PUSH, LIVE_CHAT, VIBER_BOTS, INSTAGRAM, INSTAGRAM_DM, TWITTER, APPLE_BUSINESS_CHAT, KAKAO_SANGDAM, OPEN_CHANNEL, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK. | \n
\n\n| identifier | \nString | \nRequired. Person ID. ID type must match the type parameter. | \n
\n\n| sender | \nString | \nSender or application ID.sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL | \n
\n\n
\n
On success the response is 200 OK.
\nStatus codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["people","3","lists","ShoppingCartList"],"host":["go2","vhdmedia","se"],"query":[{"key":"type","value":"EMAIL"},{"key":"identifier","value":"janewilliams@example.com"}],"variable":[]}},"response":[{"id":"3891555e-40b2-410b-98b6-f00d304a110a","name":"200 - Response example","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"__id\": \"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4\",\n \"item_field_#1\": \"new value\",\n \"item_field_#2\": null\n },\n {\n \"__id\": \"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f\",\n \"item_field_#1\": \"new value\",\n \"item_field_#2\": 42\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"__id\": \"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4\",\n \"item_field_#1\": \"new value\",\n \"item_field_#3\": \"old value\"\n },\n {\n \"__id\": \"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f\",\n \"item_field_#1\": \"new value\",\n \"item_field_#2\": 42,\n \"item_field_#3\": \"old value\"\n }\n]"},{"id":"c2247764-4e41-448c-86cb-4454b3a9a45a","name":"400 - real VHD response","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"__id\": \"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4\",\n \"item_field_#1\": \"new value\",\n \"item_field_#2\": null\n },\n {\n \"__id\": \"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f\",\n \"item_field_#1\": \"new value\",\n \"item_field_#2\": 42\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid body\"\n}"},{"id":"7994c4d3-011f-41f2-a3ec-c3aa985f1642","name":"401 - Example","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"__id\": \"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4\",\n \"item_field_#1\": \"new value\",\n \"item_field_#2\": null\n },\n {\n \"__id\": \"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f\",\n \"item_field_#1\": \"new value\",\n \"item_field_#2\": 42\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"c4c523d5-1577-4b9a-af01-1555496e7001","name":"403 - Example","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"__id\": \"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4\",\n \"item_field_#1\": \"new value\",\n \"item_field_#2\": null\n },\n {\n \"__id\": \"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f\",\n \"item_field_#1\": \"new value\",\n \"item_field_#2\": 42\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"0a9ed5bf-bafa-4200-8426-ec3a36942785","name":"404 - person doesn't exist","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"__id\": \"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4\",\n \"item_field_#1\": \"new value\",\n \"item_field_#2\": null\n },\n {\n \"__id\": \"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f\",\n \"item_field_#1\": \"new value\",\n \"item_field_#2\": 42\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 300101,\n \"message\": \"Person with ID 'test@gmail.com' does not exist\"\n}"},{"id":"c077d847-88f3-456b-8fea-d2c93fd456a4","name":"429 - Example","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"__id\": \"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4\",\n \"item_field_#1\": \"new value\",\n \"item_field_#2\": null\n },\n {\n \"__id\": \"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f\",\n \"item_field_#1\": \"new value\",\n \"item_field_#2\": 42\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"1866cec0-9b91-4106-bd47-10eca92c5a49","name":"500 - Example","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"__id\": \"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4\",\n \"item_field_#1\": \"new value\",\n \"item_field_#2\": null\n },\n {\n \"__id\": \"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f\",\n \"item_field_#1\": \"new value\",\n \"item_field_#2\": 42\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}?type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"ce8a01f6-2e3d-4198-b436-9499c5efde1f"},{"name":"Delete items","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var responseBody;","pm.test(\"Response body is valid JSON\", function () {"," responseBody = pm.response.json();","});","","pm.test(\"Response is an array\", function () {"," pm.expect(responseBody).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"8470eb07-edcc-4567-b9cd-38484ead8702","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/lists/ShoppingCartList/items?type=EMAIL&identifier=janewilliams@example.com&itemIds={{itemLastId}}","description":"Delete items.
\nDeletes items in a list attribute and returns all items of the updated list.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| listName | \nString | \nRequired. Name of the list attribute. | \n
\n\n| type | \nString | \nRequired. Type of the person ID. Can be one of the above. One of: ID, EXTERNAL_ID, PHONE, EMAIL, LINE, FACEBOOK, TELEGRAM, PUSH, LIVE_CHAT, VIBER_BOTS, INSTAGRAM, INSTAGRAM_DM, TWITTER, APPLE_BUSINESS_CHAT, KAKAO_SANGDAM, OPEN_CHANNEL, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK. | \n
\n\n| identifier | \nString | \nRequired. Person ID. ID type must match the type parameter. | \n
\n\n| sender | \nString | \nSender or application ID.sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL | \n
\n\n| itemIds | \nArray | \nRequired. UUIDs of list items to delete, separated by commas (,). | \n
\n\n
\n
On success the response is 200 OK.
\nStatus codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["people","3","lists","ShoppingCartList","items"],"host":["go2","vhdmedia","se"],"query":[{"key":"type","value":"EMAIL"},{"key":"identifier","value":"janewilliams@example.com"},{"key":"itemIds","value":"{{itemLastId}}"}],"variable":[]}},"response":[{"id":"ade134af-96fc-4ce7-83f4-2e956b8eebe4","name":"200 - Response example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}&itemIds={{itemIds}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true},{"key":"itemIds","value":"{{itemIds}}","description":"UUIDs of list items to delete, separated by commas (,)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"__id\": \"1d543ae8-957d-4fe6-b0f4-ad3ce1eb5bbf\",\n \"item_field_#1\": \"some value\"\n },\n {\n \"__id\": \"844011e5-8c0d-4447-b67f-499bb9ff2783\",\n \"item_field_#1\": \"some value\",\n \"item_field_#2\": 42\n }\n]"},{"id":"ec24e272-43c9-4532-8584-53713400f7df","name":"400 - identifier is not provided","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}&itemIds={{itemIds}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true},{"key":"itemIds","value":"{{itemIds}}","description":"UUIDs of list items to delete, separated by commas (,)."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 400116,\n \"message\": \"Missing parameter: identifier\"\n}"},{"id":"8f3f2cad-cd71-434c-998a-9b812f2100c3","name":"401 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}&itemIds={{itemIds}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true},{"key":"itemIds","value":"{{itemIds}}","description":"UUIDs of list items to delete, separated by commas (,)."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"8cfd6f20-5e49-4efc-8cb8-027d57495058","name":"403 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}&itemIds={{itemIds}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true},{"key":"itemIds","value":"{{itemIds}}","description":"UUIDs of list items to delete, separated by commas (,)."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"84a47edc-a668-4a89-8364-2874fc1609fb","name":"404 - real VHD response","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}&itemIds={{itemIds}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true},{"key":"itemIds","value":"{{itemIds}}","description":"UUIDs of list items to delete, separated by commas (,)."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 300101,\n \"message\": \"Person with ID 'jane.smith@vhdmedia.se' does not exist\"\n}"},{"id":"bf0cbc39-b234-45fa-8340-661d0b93c98c","name":"429 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}&itemIds={{itemIds}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true},{"key":"itemIds","value":"{{itemIds}}","description":"UUIDs of list items to delete, separated by commas (,)."}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"d30f63dd-138c-4614-9a5e-9f2360ea6685","name":"500 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists/{{listName}}/items?type={{personIdentifierType}}&identifier={{personId}}&itemIds={{itemIds}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists","{{listName}}","items"],"query":[{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true},{"key":"itemIds","value":"{{itemIds}}","description":"UUIDs of list items to delete, separated by commas (,)."}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"8470eb07-edcc-4567-b9cd-38484ead8702"},{"name":"Delete lists","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 204\", function () {"," pm.expect(pm.response.code).to.be.oneOf([204]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});"],"type":"text/javascript","packages":{}}}],"id":"f8f0bb29-34b8-4ae7-8bd2-0d2b8aa9d98d","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/lists?listNames=ShoppingCartList&type=EMAIL&identifier=janewilliams@example.com","description":"Delete lists.
\nDeletes a single or multiple list attributes of a profile.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| listNames | \nArray | \nRequired. Names of list attributes to delete, separated by commas (,). | \n
\n\n| type | \nString | \nRequired. Type of the person ID. Can be one of the above. One of: ID, EXTERNAL_ID, PHONE, EMAIL, LINE, FACEBOOK, TELEGRAM, PUSH, LIVE_CHAT, VIBER_BOTS, INSTAGRAM, INSTAGRAM_DM, TWITTER, APPLE_BUSINESS_CHAT, KAKAO_SANGDAM, OPEN_CHANNEL, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK. | \n
\n\n| identifier | \nString | \nRequired. Person ID. ID type must match the type parameter. | \n
\n\n| sender | \nString | \nSender or application ID.sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL | \n
\n\n
\n
On success the response is 204 No Content.
\nStatus codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["people","3","lists"],"host":["go2","vhdmedia","se"],"query":[{"key":"listNames","value":"ShoppingCartList"},{"key":"type","value":"EMAIL"},{"key":"identifier","value":"janewilliams@example.com"}],"variable":[]}},"response":[{"id":"1d548289-4c9b-44fa-8645-26a99c0bebca","name":"204 No Content","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists?listNames={{listName}}&type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists"],"query":[{"key":"listNames","value":"{{listName}}","description":"Names of list attributes to delete, separated by commas (,)."},{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"455b0b5e-1876-4a72-b934-16a0d88e7f62","name":"400 - identifier is not provided","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists?listNames={{listName}}&type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists"],"query":[{"key":"listNames","value":"{{listName}}","description":"Names of list attributes to delete, separated by commas (,)."},{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 400116,\n \"message\": \"Missing parameter: identifier\"\n}"},{"id":"c3ed3ffe-eae8-4329-8d73-6dc844b059ad","name":"401 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists?listNames={{listName}}&type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists"],"query":[{"key":"listNames","value":"{{listName}}","description":"Names of list attributes to delete, separated by commas (,)."},{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Unauthorized\"\n }\n }\n}"},{"id":"bed10c20-c918-472d-b2bf-fc722c605d0a","name":"403 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists?listNames={{listName}}&type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists"],"query":[{"key":"listNames","value":"{{listName}}","description":"Names of list attributes to delete, separated by commas (,)."},{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"49eb71df-c5c6-468f-8914-4a995bfbbce8","name":"404 - real VHD response","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists?listNames={{listName}}&type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists"],"query":[{"key":"listNames","value":"{{listName}}","description":"Names of list attributes to delete, separated by commas (,)."},{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 300101,\n \"message\": \"Person with ID 'jane.smith@vhdmedia.se' does not exist\"\n}"},{"id":"2c609cdf-23fa-4860-ab75-6868a030a783","name":"429 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists?listNames={{listName}}&type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists"],"query":[{"key":"listNames","value":"{{listName}}","description":"Names of list attributes to delete, separated by commas (,)."},{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"5aaf69c6-2242-4916-ab05-c090b8c84521","name":"500 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/lists?listNames={{listName}}&type={{personIdentifierType}}&identifier={{personId}}","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","lists"],"query":[{"key":"listNames","value":"{{listName}}","description":"Names of list attributes to delete, separated by commas (,)."},{"key":"type","value":"{{personIdentifierType}}","description":"Type of the person ID. Can be one of the above."},{"key":"identifier","value":"{{personId}}","description":"Person ID. ID type must match the `type` parameter."},{"key":"sender","value":"","description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"f8f0bb29-34b8-4ae7-8bd2-0d2b8aa9d98d"}],"id":"dc2dc490-3a6a-40fd-9dd4-ee786f103465","description":"Lists store ordered items on a person profile, for example a shopping cart or a wish list. These are the current (v3) list requests; they replace the earlier list requests of the People API. Each request identifies the person with the identifier and type query parameters.
\n","_postman_id":"dc2dc490-3a6a-40fd-9dd4-ee786f103465"},{"name":"SEGMENTS","item":[{"name":"Create a segment","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","(function () {"," api(\"GET\", \"/people/3/segments?size=100\", null, function (e, r) {"," var list = ((jsonOf(r) || {}).results || []).filter(function (s) { return s.name === \"Sample segment\"; });"," (function next(i) { if (i >= list.length) { return; } api(\"DELETE\", \"/people/3/segments/\" + list[i].id, null, function () { next(i + 1); }); })(0);"," });","})();"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests for Create a segment.","pm.test(\"Status code is 201\", function () {"," pm.expect(pm.response.code).to.be.oneOf([201]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var res;","pm.test(\"Response body is valid JSON\", function () { res = pm.response.json(); });","","pm.test(\"Segment has the documented fields\", function () {"," pm.expect(res).to.be.an('object');"," pm.expect(res).to.have.property('id');"," pm.expect(res).to.have.property('name').that.is.a('string');","});","","","var r = pm.response.json();","pm.environment.set(\"segmentId\", String(r.id));"],"type":"text/javascript","packages":{}}}],"id":"74fd28c3-06e8-4a52-b4ac-ded0a948cfa7","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sample segment\",\n \"description\": \"Everyone whose first name starts with J\",\n \"query\": {\n \"#startsWith\": {\n \"firstName\": \"J\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/segments","description":"Create a segment.
\nUse this method to create a segment.
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| name | \nString | \nRequired. A unique segment name. | \n
\n\n| description | \nString | \nSegment description. | \n
\n\n| query | \nObject | \nAllows to filter persons using simple queries. ##### Supported logical operators | Operator | Description | Example | #and | All records that match the conditions of all clauses. | {\"#and\":[{\"firstName\":\"John\"},{\"lastName\":\"Smith\"}]} | #or | All records that match the conditions of any clause. | {\"#or\":[{\"firstName\":\"John\"},{\"firstName\":\"Jane\"}]} | ##### Supported comparison operators | Attributes | Description | Example | #notExist | Matches records that do not have given attribute. | {\"#notExist\":\"firstName\"} | #exist | Matches records that have given attribute. | {\"#exists\":\"firstName\"} | | Strings | Description | Example | #eq | Equals to a specified string. | {\"firstName\":\"John\"} | #ne | Not equal to a specified string. | {\"#ne\":{\"firstName\":\"John\"}} | #startsWith | Starts with a specified string. | {\"#startsWith\":{\"firstName\":\"John\"}} | #endsWith | Ends with a specified string. | {\"#endsWith\":{\"firstName\":\"John\"}} | #contains | Contains a specified string. | {\"#contains\":{\"firstName\":\"oh\"}} | #notContain | Does not contain a specified string. | {\"#notContain\":{\"firstName\":\"oh\"}} | #in | At least one of the strings in a list. | {\"#in\":{\"firstName\":[\"John\",\"Jane\"]}} | #notIn | Not any of the strings in a list. | {\"#notIn\":{\"firstName\":[\"John\",\"Jane\"]}} | | Dates | Description | Example | #eq | Equals to a specified date. | {\"birthDate\":\"1987-07-10\"} | #ne | Not equal to a specified date. | {\"#ne\":{\"birthDate\":\"1987-07-10\"}} | #eq (relative) | Will be in specified interval. | {\"#eq\":{\"birthDate\":{\"#relNow\":\"P1D\"}}} | #lt (relative) | Will be within a specified interval. | {\"#lt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}} | #gt (relative) | Will be in more than a specified interval. | {\"#gt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}} | #eq (relative) - | Was a specified interval ago. | {\"#eq\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}} | #gt (relative) - | Was within a specified interval ago. | {\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}} | #gt (relative) - | Was more than a specified interval ago. | {\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}} | #lt | Is before a specified date. | {\"#lt\":{\"birthDate\":\"1987-07-10\"}} | #lte | Is before or equal to a specified date. | {\"#lte\":{\"birthDate\":\"1987-07-10\"}} | #gt | Is after a specified date. | {\"#gt\":{\"birthDate\":\"1987-07-10\"}} | #gte | Is after or equal to a specified date. | {\"#gte\":{\"birthDate\":\"1987-07-10\"}} | #in | Is equal to one of dates in a given list. | {\"#in\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}} | #notIn | Is not equal to any of dates in a given list. | {\"#notIn\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}} | | Integers | Description | Example | #eq | Equals to a specified integer. | {\"data\\u0001counter\":1} | #ne | Not equal to a specified integer. | {\"#ne\":{\"data\\u0001counter\":1}} | #lt | Is less than a specified integer. | {\"#lt\":{\"data\\u0001counter\":1}} | #lte | Is less than or equal to a specified integer. | {\"#lte\":{\"data\\u0001counter\":1}} | #gt | Is greater than a specified integer. | {\"#gt\":{\"data\\u0001counter\":1}} | #gte | Is greater than or equal to a specified integer. | {\"#gte\":{\"data\\u0001counter\":1}} | #in | Is equal to any of specified integers in a list. | {\"#in\":{\"data\\u0001counter\":[1,2,3]}} | #notIn | Is not equal to any of specified integers in a list. | {\"#notIn\":{\"data\\u0001counter\":[1,2,3]}} | | Decimals | Description | Example | #eq | Equals to a specified decimal. | {\"data\\u0001price\":1.1} | #ne | Is not equal to a specified decimal. | {\"#ne\":{\"data\\u0001price\":1.1}} | #lt | Is less than a specified decimal. | {\"#lt\":{\"data\\u0001price\":1.1}} | #lte | Is less than or equal to a specified decimal. | {\"#lte\":{\"data\\u0001price\":1.1}} | #gt | Is greater than a specified decimal. | {\"#gt\":{\"data\\u0001price\":1.1}} | #gte | Is greater than or equal to a specified decimal. | {\"#gte\":{\"data\\u0001price\":1.1}} | #in | Is equal to any of specified decimals in a list. | {\"#in\":{\"data\\u0001price\":[1.1,2.1,3.0]}} | #notIn | Is not equal to any of specified decimals in a list. | {\"#notIn\":{\"data\\u0001price\":[1.1,2.1,3.0]}} | | Booleans | Description | Example | #eq | Equals to a specified boolean. | {\"data\\u0001happy\":true} | #ne | Not equal to a specified boolean. | {\"#ne\":{\"data\\u0001happy\":true}} | | Tags | Description | Example | #contains | Contains a specified tag. | {\"#contains\":{\"tags\":\"SOME_TAG\"}} | #notContain | Does not contain a specified tag. | {\"#notContain\":{\"tags\":\"SOME_TAG\"}} | | Gender | Description | Example | #eq | Equals a specified gender. | {\"gender\":\"MALE\"} | #ne | Does not equal a specified gender. | {\"#ne\":{\"gender\":\"FEMALE\"}} | | Lists | Description | Example | #all | All items in the list match. | {\"#all\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}} | #any | Any item in the list match. | {\"#any\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}} | | \n
\n\n| events | \nArray | \nList of events that persons should match. | \n
\n\n| events[].definitionId | \nString | \nRequired. Event definition ID. | \n
\n\n| events[].occurrenceCondition | \nObject | \nSpecify how many times did the event occur. | \n
\n\n| events[].occurrenceCondition.operation | \nString | \nRequired. Operation to compare how many times the event has occurred. One of: IS, LESS_THAN, LESS_OR_EQUAL, GREATER_OR_EQUAL, GREATER_THAN. | \n
\n\n| events[].occurrenceCondition.times | \nInt | \nRequired. Number of times the event has occurred. | \n
\n\n| events[].timelineCondition | \nObject | \nRequired. Specify in which timespan did the event occur. | \n
\n\n| events[].timelineCondition.occurred | \nString | \nRequired. Specifies whether an event is occurring for the first or last time within a given period. Additionally, we can use an operator to specify if any event has occurred or never occurred within the specified timeframe. One of: ALL, FIRST, LAST, NOT. | \n
\n\n| events[].timelineCondition.operator | \nString | \nRequired. The operators AFTER, BEFORE, and BETWEEN can be used to specify relative time periods, while their counterparts with the suffix _ABS (e.g., AFTER_ABS, BEFORE_ABS, BETWEEN_ABS) are used for absolute time values. These operators can be applied with start and end attributes to define the beginning and ending points of the time. Units need to be used with relative operators to specify the duration of the time periods. One of: EMPTY, AFTER, BEFORE, BETWEEN, AFTER_ABS, BEFORE_ABS, BETWEEN_ABS. | \n
\n\n| events[].timelineCondition.start | \nInt | \nStart of timespan: For relative operators, specify the number of units. For absolute operators, provide a Unix timestamp. | \n
\n\n| events[].timelineCondition.end | \nInt | \nEnd of timespan: For relative operators, specify the number of units. For absolute operators, provide a Unix timestamp. | \n
\n\n| events[].timelineCondition.units | \nString | \nTime units for relative operators. One of: DAYS, HOURS, MINUTES. | \n
\n\n| events[].payloadConditions | \nArray | \nSpecify the conditions of the event payload. | \n
\n\n| events[].payloadConditions[].attribute | \nString | \nRequired. Event payload attribute. | \n
\n\n| events[].payloadConditions[].operator | \nString | \nRequired. Operator for comparing condition value with payload value. One of: EQ, LT, LTE, GT, GTE, NE, SW, EW, CON. | \n
\n\n| events[].payloadConditions[].value | \nString | \nRequired. Payload condition value. | \n
\n\n
\n
On success the response is 201 Created.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nInt | \nRequired. A unique segment identifier. | \n
\n\n| name | \nString | \nRequired. A unique segment name. | \n
\n\n| description | \nString | \nSegment description. | \n
\n\n| query | \nObject | \nAllows to filter persons using simple queries. ##### Supported logical operators | Operator | Description | Example | #and | All records that match the conditions of all clauses. | {\"#and\":[{\"firstName\":\"John\"},{\"lastName\":\"Smith\"}]} | #or | All records that match the conditions of any clause. | {\"#or\":[{\"firstName\":\"John\"},{\"firstName\":\"Jane\"}]} | ##### Supported comparison operators | Attributes | Description | Example | #notExist | Matches records that do not have given attribute. | {\"#notExist\":\"firstName\"} | #exist | Matches records that have given attribute. | {\"#exists\":\"firstName\"} | | Strings | Description | Example | #eq | Equals to a specified string. | {\"firstName\":\"John\"} | #ne | Not equal to a specified string. | {\"#ne\":{\"firstName\":\"John\"}} | #startsWith | Starts with a specified string. | {\"#startsWith\":{\"firstName\":\"John\"}} | #endsWith | Ends with a specified string. | {\"#endsWith\":{\"firstName\":\"John\"}} | #contains | Contains a specified string. | {\"#contains\":{\"firstName\":\"oh\"}} | #notContain | Does not contain a specified string. | {\"#notContain\":{\"firstName\":\"oh\"}} | #in | At least one of the strings in a list. | {\"#in\":{\"firstName\":[\"John\",\"Jane\"]}} | #notIn | Not any of the strings in a list. | {\"#notIn\":{\"firstName\":[\"John\",\"Jane\"]}} | | Dates | Description | Example | #eq | Equals to a specified date. | {\"birthDate\":\"1987-07-10\"} | #ne | Not equal to a specified date. | {\"#ne\":{\"birthDate\":\"1987-07-10\"}} | #eq (relative) | Will be in specified interval. | {\"#eq\":{\"birthDate\":{\"#relNow\":\"P1D\"}}} | #lt (relative) | Will be within a specified interval. | {\"#lt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}} | #gt (relative) | Will be in more than a specified interval. | {\"#gt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}} | #eq (relative) - | Was a specified interval ago. | {\"#eq\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}} | #gt (relative) - | Was within a specified interval ago. | {\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}} | #gt (relative) - | Was more than a specified interval ago. | {\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}} | #lt | Is before a specified date. | {\"#lt\":{\"birthDate\":\"1987-07-10\"}} | #lte | Is before or equal to a specified date. | {\"#lte\":{\"birthDate\":\"1987-07-10\"}} | #gt | Is after a specified date. | {\"#gt\":{\"birthDate\":\"1987-07-10\"}} | #gte | Is after or equal to a specified date. | {\"#gte\":{\"birthDate\":\"1987-07-10\"}} | #in | Is equal to one of dates in a given list. | {\"#in\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}} | #notIn | Is not equal to any of dates in a given list. | {\"#notIn\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}} | | Integers | Description | Example | #eq | Equals to a specified integer. | {\"data\\u0001counter\":1} | #ne | Not equal to a specified integer. | {\"#ne\":{\"data\\u0001counter\":1}} | #lt | Is less than a specified integer. | {\"#lt\":{\"data\\u0001counter\":1}} | #lte | Is less than or equal to a specified integer. | {\"#lte\":{\"data\\u0001counter\":1}} | #gt | Is greater than a specified integer. | {\"#gt\":{\"data\\u0001counter\":1}} | #gte | Is greater than or equal to a specified integer. | {\"#gte\":{\"data\\u0001counter\":1}} | #in | Is equal to any of specified integers in a list. | {\"#in\":{\"data\\u0001counter\":[1,2,3]}} | #notIn | Is not equal to any of specified integers in a list. | {\"#notIn\":{\"data\\u0001counter\":[1,2,3]}} | | Decimals | Description | Example | #eq | Equals to a specified decimal. | {\"data\\u0001price\":1.1} | #ne | Is not equal to a specified decimal. | {\"#ne\":{\"data\\u0001price\":1.1}} | #lt | Is less than a specified decimal. | {\"#lt\":{\"data\\u0001price\":1.1}} | #lte | Is less than or equal to a specified decimal. | {\"#lte\":{\"data\\u0001price\":1.1}} | #gt | Is greater than a specified decimal. | {\"#gt\":{\"data\\u0001price\":1.1}} | #gte | Is greater than or equal to a specified decimal. | {\"#gte\":{\"data\\u0001price\":1.1}} | #in | Is equal to any of specified decimals in a list. | {\"#in\":{\"data\\u0001price\":[1.1,2.1,3.0]}} | #notIn | Is not equal to any of specified decimals in a list. | {\"#notIn\":{\"data\\u0001price\":[1.1,2.1,3.0]}} | | Booleans | Description | Example | #eq | Equals to a specified boolean. | {\"data\\u0001happy\":true} | #ne | Not equal to a specified boolean. | {\"#ne\":{\"data\\u0001happy\":true}} | | Tags | Description | Example | #contains | Contains a specified tag. | {\"#contains\":{\"tags\":\"SOME_TAG\"}} | #notContain | Does not contain a specified tag. | {\"#notContain\":{\"tags\":\"SOME_TAG\"}} | | Gender | Description | Example | #eq | Equals a specified gender. | {\"gender\":\"MALE\"} | #ne | Does not equal a specified gender. | {\"#ne\":{\"gender\":\"FEMALE\"}} | | Lists | Description | Example | #all | All items in the list match. | {\"#all\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}} | #any | Any item in the list match. | {\"#any\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}} | | \n
\n\n| events | \nArray | \nList of events that persons should match. | \n
\n\n| events[].definitionId | \nString | \nRequired. Event definition ID. | \n
\n\n| events[].occurrenceCondition | \nObject | \nSpecify how many times did the event occur. | \n
\n\n| events[].occurrenceCondition.operation | \nString | \nRequired. Operation to compare how many times the event has occurred. One of: IS, LESS_THAN, LESS_OR_EQUAL, GREATER_OR_EQUAL, GREATER_THAN. | \n
\n\n| events[].occurrenceCondition.times | \nInt | \nRequired. Number of times the event has occurred. | \n
\n\n| events[].timelineCondition | \nObject | \nRequired. Specify in which timespan did the event occur. | \n
\n\n| events[].timelineCondition.occurred | \nString | \nRequired. Specifies whether an event is occurring for the first or last time within a given period. Additionally, we can use an operator to specify if any event has occurred or never occurred within the specified timeframe. One of: ALL, FIRST, LAST, NOT. | \n
\n\n| events[].timelineCondition.operator | \nString | \nRequired. The operators AFTER, BEFORE, and BETWEEN can be used to specify relative time periods, while their counterparts with the suffix _ABS (e.g., AFTER_ABS, BEFORE_ABS, BETWEEN_ABS) are used for absolute time values. These operators can be applied with start and end attributes to define the beginning and ending points of the time. Units need to be used with relative operators to specify the duration of the time periods. One of: EMPTY, AFTER, BEFORE, BETWEEN, AFTER_ABS, BEFORE_ABS, BETWEEN_ABS. | \n
\n\n| events[].timelineCondition.start | \nInt | \nStart of timespan: For relative operators, specify the number of units. For absolute operators, provide a Unix timestamp. | \n
\n\n| events[].timelineCondition.end | \nInt | \nEnd of timespan: For relative operators, specify the number of units. For absolute operators, provide a Unix timestamp. | \n
\n\n| events[].timelineCondition.units | \nString | \nTime units for relative operators. One of: DAYS, HOURS, MINUTES. | \n
\n\n| events[].payloadConditions | \nArray | \nSpecify the conditions of the event payload. | \n
\n\n| events[].payloadConditions[].attribute | \nString | \nRequired. Event payload attribute. | \n
\n\n| events[].payloadConditions[].operator | \nString | \nRequired. Operator for comparing condition value with payload value. One of: EQ, LT, LTE, GT, GTE, NE, SW, EW, CON. | \n
\n\n| events[].payloadConditions[].value | \nString | \nRequired. Payload condition value. | \n
\n\n| createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ. | \n
\n\n| modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["people","3","segments"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"ac359d69-cf56-424a-849d-fa5e61823d4e","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"afede060-91db-455e-8575-b22dbc4e0740","name":"400 - real VHD response","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E400\",\n \"description\": \"Request cannot be processed.\",\n \"action\": \"Check the syntax, violations and adjust the request.\",\n \"violations\": [\n {\n \"property\": \"name\",\n \"violation\": \"Invalid type\"\n }\n ],\n \"resources\": []\n}"},{"id":"ae9619fb-7bc2-400b-9bb0-5764e6c5dd27","name":"401 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E401\",\n \"description\": \"The request lacks valid authentication credentials for the requested resource.\",\n \"action\": \"Check the resources and adjust authentication credentials.\",\n \"violations\": [],\n \"resources\": [\n {\n \"name\": \"API Authentication\",\n \"url\": \"https://www.vhd.com/docs/essentials/api-authentication\"\n }\n ]\n}"},{"id":"8020e290-257e-4b9e-be90-e8507cda2a3f","name":"403 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E403\",\n \"description\": \"Insufficient permissions to access the requested resource.\",\n \"action\": \"Repeat the request with new or different credentials.\",\n \"violations\": [],\n \"resources\": [\n {\n \"name\": \"API Scopes\",\n \"url\": \"https://www.vhd.com/docs/essentials/api-essentials/api-authorization#api-scopes\"\n }\n ]\n}"},{"id":"65a1fd25-d56d-4d97-99cc-a7caa3a4eb89","name":"429 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E429\",\n \"description\": \"Too many requests sent.\",\n \"action\": \"Check request rate limit specified in the API endpoint documentation resource.\",\n \"violations\": [],\n \"resources\": [\n {\n \"name\": \"Throttling handling errors\",\n \"url\": \"https://www.vhd.com/docs/essentials/integration-best-practices#throttling-handling-errors\"\n }\n ]\n}"},{"id":"32a06675-c024-4288-a129-a74775380fbf","name":"500 - Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E500\",\n \"description\": \"Something went wrong.\",\n \"action\": \"Contact the support.\",\n \"violations\": [],\n \"resources\": []\n}"}],"_postman_id":"74fd28c3-06e8-4a52-b4ac-ded0a948cfa7"},{"name":"Get a segment","event":[{"listen":"test","script":{"exec":["// Tests for Get a segment.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var res;","pm.test(\"Response body is valid JSON\", function () { res = pm.response.json(); });","","pm.test(\"Segment has the documented fields\", function () {"," pm.expect(res).to.be.an('object');"," pm.expect(res).to.have.property('id');"," pm.expect(res).to.have.property('name').that.is.a('string');","});",""],"type":"text/javascript","packages":{}}}],"id":"191840db-89e3-4010-b28b-1969cc069b2f","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}","description":"Get a segment.
\nUse this method to get a segment by ID.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| segmentId | \nInt | \nRequired. A unique segment identifier. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nInt | \nRequired. A unique segment identifier. | \n
\n\n| name | \nString | \nRequired. A unique segment name. | \n
\n\n| description | \nString | \nSegment description. | \n
\n\n| query | \nObject | \nAllows to filter persons using simple queries. ##### Supported logical operators | Operator | Description | Example | #and | All records that match the conditions of all clauses. | {\"#and\":[{\"firstName\":\"John\"},{\"lastName\":\"Smith\"}]} | #or | All records that match the conditions of any clause. | {\"#or\":[{\"firstName\":\"John\"},{\"firstName\":\"Jane\"}]} | ##### Supported comparison operators | Attributes | Description | Example | #notExist | Matches records that do not have given attribute. | {\"#notExist\":\"firstName\"} | #exist | Matches records that have given attribute. | {\"#exists\":\"firstName\"} | | Strings | Description | Example | #eq | Equals to a specified string. | {\"firstName\":\"John\"} | #ne | Not equal to a specified string. | {\"#ne\":{\"firstName\":\"John\"}} | #startsWith | Starts with a specified string. | {\"#startsWith\":{\"firstName\":\"John\"}} | #endsWith | Ends with a specified string. | {\"#endsWith\":{\"firstName\":\"John\"}} | #contains | Contains a specified string. | {\"#contains\":{\"firstName\":\"oh\"}} | #notContain | Does not contain a specified string. | {\"#notContain\":{\"firstName\":\"oh\"}} | #in | At least one of the strings in a list. | {\"#in\":{\"firstName\":[\"John\",\"Jane\"]}} | #notIn | Not any of the strings in a list. | {\"#notIn\":{\"firstName\":[\"John\",\"Jane\"]}} | | Dates | Description | Example | #eq | Equals to a specified date. | {\"birthDate\":\"1987-07-10\"} | #ne | Not equal to a specified date. | {\"#ne\":{\"birthDate\":\"1987-07-10\"}} | #eq (relative) | Will be in specified interval. | {\"#eq\":{\"birthDate\":{\"#relNow\":\"P1D\"}}} | #lt (relative) | Will be within a specified interval. | {\"#lt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}} | #gt (relative) | Will be in more than a specified interval. | {\"#gt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}} | #eq (relative) - | Was a specified interval ago. | {\"#eq\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}} | #gt (relative) - | Was within a specified interval ago. | {\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}} | #gt (relative) - | Was more than a specified interval ago. | {\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}} | #lt | Is before a specified date. | {\"#lt\":{\"birthDate\":\"1987-07-10\"}} | #lte | Is before or equal to a specified date. | {\"#lte\":{\"birthDate\":\"1987-07-10\"}} | #gt | Is after a specified date. | {\"#gt\":{\"birthDate\":\"1987-07-10\"}} | #gte | Is after or equal to a specified date. | {\"#gte\":{\"birthDate\":\"1987-07-10\"}} | #in | Is equal to one of dates in a given list. | {\"#in\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}} | #notIn | Is not equal to any of dates in a given list. | {\"#notIn\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}} | | Integers | Description | Example | #eq | Equals to a specified integer. | {\"data\\u0001counter\":1} | #ne | Not equal to a specified integer. | {\"#ne\":{\"data\\u0001counter\":1}} | #lt | Is less than a specified integer. | {\"#lt\":{\"data\\u0001counter\":1}} | #lte | Is less than or equal to a specified integer. | {\"#lte\":{\"data\\u0001counter\":1}} | #gt | Is greater than a specified integer. | {\"#gt\":{\"data\\u0001counter\":1}} | #gte | Is greater than or equal to a specified integer. | {\"#gte\":{\"data\\u0001counter\":1}} | #in | Is equal to any of specified integers in a list. | {\"#in\":{\"data\\u0001counter\":[1,2,3]}} | #notIn | Is not equal to any of specified integers in a list. | {\"#notIn\":{\"data\\u0001counter\":[1,2,3]}} | | Decimals | Description | Example | #eq | Equals to a specified decimal. | {\"data\\u0001price\":1.1} | #ne | Is not equal to a specified decimal. | {\"#ne\":{\"data\\u0001price\":1.1}} | #lt | Is less than a specified decimal. | {\"#lt\":{\"data\\u0001price\":1.1}} | #lte | Is less than or equal to a specified decimal. | {\"#lte\":{\"data\\u0001price\":1.1}} | #gt | Is greater than a specified decimal. | {\"#gt\":{\"data\\u0001price\":1.1}} | #gte | Is greater than or equal to a specified decimal. | {\"#gte\":{\"data\\u0001price\":1.1}} | #in | Is equal to any of specified decimals in a list. | {\"#in\":{\"data\\u0001price\":[1.1,2.1,3.0]}} | #notIn | Is not equal to any of specified decimals in a list. | {\"#notIn\":{\"data\\u0001price\":[1.1,2.1,3.0]}} | | Booleans | Description | Example | #eq | Equals to a specified boolean. | {\"data\\u0001happy\":true} | #ne | Not equal to a specified boolean. | {\"#ne\":{\"data\\u0001happy\":true}} | | Tags | Description | Example | #contains | Contains a specified tag. | {\"#contains\":{\"tags\":\"SOME_TAG\"}} | #notContain | Does not contain a specified tag. | {\"#notContain\":{\"tags\":\"SOME_TAG\"}} | | Gender | Description | Example | #eq | Equals a specified gender. | {\"gender\":\"MALE\"} | #ne | Does not equal a specified gender. | {\"#ne\":{\"gender\":\"FEMALE\"}} | | Lists | Description | Example | #all | All items in the list match. | {\"#all\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}} | #any | Any item in the list match. | {\"#any\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}} | | \n
\n\n| events | \nArray | \nList of events that persons should match. | \n
\n\n| events[].definitionId | \nString | \nRequired. Event definition ID. | \n
\n\n| events[].occurrenceCondition | \nObject | \nSpecify how many times did the event occur. | \n
\n\n| events[].occurrenceCondition.operation | \nString | \nRequired. Operation to compare how many times the event has occurred. One of: IS, LESS_THAN, LESS_OR_EQUAL, GREATER_OR_EQUAL, GREATER_THAN. | \n
\n\n| events[].occurrenceCondition.times | \nInt | \nRequired. Number of times the event has occurred. | \n
\n\n| events[].timelineCondition | \nObject | \nRequired. Specify in which timespan did the event occur. | \n
\n\n| events[].timelineCondition.occurred | \nString | \nRequired. Specifies whether an event is occurring for the first or last time within a given period. Additionally, we can use an operator to specify if any event has occurred or never occurred within the specified timeframe. One of: ALL, FIRST, LAST, NOT. | \n
\n\n| events[].timelineCondition.operator | \nString | \nRequired. The operators AFTER, BEFORE, and BETWEEN can be used to specify relative time periods, while their counterparts with the suffix _ABS (e.g., AFTER_ABS, BEFORE_ABS, BETWEEN_ABS) are used for absolute time values. These operators can be applied with start and end attributes to define the beginning and ending points of the time. Units need to be used with relative operators to specify the duration of the time periods. One of: EMPTY, AFTER, BEFORE, BETWEEN, AFTER_ABS, BEFORE_ABS, BETWEEN_ABS. | \n
\n\n| events[].timelineCondition.start | \nInt | \nStart of timespan: For relative operators, specify the number of units. For absolute operators, provide a Unix timestamp. | \n
\n\n| events[].timelineCondition.end | \nInt | \nEnd of timespan: For relative operators, specify the number of units. For absolute operators, provide a Unix timestamp. | \n
\n\n| events[].timelineCondition.units | \nString | \nTime units for relative operators. One of: DAYS, HOURS, MINUTES. | \n
\n\n| events[].payloadConditions | \nArray | \nSpecify the conditions of the event payload. | \n
\n\n| events[].payloadConditions[].attribute | \nString | \nRequired. Event payload attribute. | \n
\n\n| events[].payloadConditions[].operator | \nString | \nRequired. Operator for comparing condition value with payload value. One of: EQ, LT, LTE, GT, GTE, NE, SW, EW, CON. | \n
\n\n| events[].payloadConditions[].value | \nString | \nRequired. Payload condition value. | \n
\n\n| createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ. | \n
\n\n| modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["people","3","segments","{{segmentId}}"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"f2d5d0c9-74c8-4ca7-956c-3f40b78712a6","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"9377049b-0445-4433-ade3-c02a55b2fd17","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E401\",\n \"description\": \"The request lacks valid authentication credentials for the requested resource.\",\n \"action\": \"Check the resources and adjust authentication credentials.\",\n \"violations\": [],\n \"resources\": [\n {\n \"name\": \"API Authentication\",\n \"url\": \"https://www.vhd.com/docs/essentials/api-authentication\"\n }\n ]\n}"},{"id":"fd1dcbdd-a1e3-4234-9547-f1287c3fa3da","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E403\",\n \"description\": \"Insufficient permissions to access the requested resource.\",\n \"action\": \"Repeat the request with new or different credentials.\",\n \"violations\": [],\n \"resources\": [\n {\n \"name\": \"API Scopes\",\n \"url\": \"https://www.vhd.com/docs/essentials/api-essentials/api-authorization#api-scopes\"\n }\n ]\n}"},{"id":"50b201de-13f2-4bce-b3b9-8fbbd71fe53a","name":"404 - real VHD response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E404\",\n \"description\": \"Not found - request URL doesn't exist on the API server or resource is not found.\",\n \"action\": \"Check the resources and adjust your request.\",\n \"violations\": [\n {\n \"violation\": \"Segment with given id does not exist.\"\n }\n ],\n \"resources\": []\n}"},{"id":"1953cbe4-b131-4b78-b5fe-259e0d26c413","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E429\",\n \"description\": \"Too many requests sent.\",\n \"action\": \"Check request rate limit specified in the API endpoint documentation resource.\",\n \"violations\": [],\n \"resources\": [\n {\n \"name\": \"Throttling handling errors\",\n \"url\": \"https://www.vhd.com/docs/essentials/integration-best-practices#throttling-handling-errors\"\n }\n ]\n}"},{"id":"063a34db-999e-4a2e-bffd-6e8bbc04dc9e","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E500\",\n \"description\": \"Something went wrong.\",\n \"action\": \"Contact the support.\",\n \"violations\": [],\n \"resources\": []\n}"}],"_postman_id":"191840db-89e3-4010-b28b-1969cc069b2f"},{"name":"Update a segment","event":[{"listen":"test","script":{"exec":["// Tests for Update a segment.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var res;","pm.test(\"Response body is valid JSON\", function () { res = pm.response.json(); });","","pm.test(\"Segment has the documented fields\", function () {"," pm.expect(res).to.be.an('object');"," pm.expect(res).to.have.property('id');"," pm.expect(res).to.have.property('name').that.is.a('string');","});",""],"type":"text/javascript","packages":{}}}],"id":"35dc3d6b-96ab-4fdf-ba09-9f2d206ae4f8","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sample segment\",\n \"description\": \"Updated sample segment\",\n \"query\": {\n \"#startsWith\": {\n \"firstName\": \"J\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}","description":"Update a segment.
\nUse this method to update a segment.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| segmentId | \nInt | \nRequired. A unique segment identifier. | \n
\n\n
\n
Request body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| name | \nString | \nRequired. A unique segment name. | \n
\n\n| description | \nString | \nSegment description. | \n
\n\n| query | \nObject | \nAllows to filter persons using simple queries. ##### Supported logical operators | Operator | Description | Example | #and | All records that match the conditions of all clauses. | {\"#and\":[{\"firstName\":\"John\"},{\"lastName\":\"Smith\"}]} | #or | All records that match the conditions of any clause. | {\"#or\":[{\"firstName\":\"John\"},{\"firstName\":\"Jane\"}]} | ##### Supported comparison operators | Attributes | Description | Example | #notExist | Matches records that do not have given attribute. | {\"#notExist\":\"firstName\"} | #exist | Matches records that have given attribute. | {\"#exists\":\"firstName\"} | | Strings | Description | Example | #eq | Equals to a specified string. | {\"firstName\":\"John\"} | #ne | Not equal to a specified string. | {\"#ne\":{\"firstName\":\"John\"}} | #startsWith | Starts with a specified string. | {\"#startsWith\":{\"firstName\":\"John\"}} | #endsWith | Ends with a specified string. | {\"#endsWith\":{\"firstName\":\"John\"}} | #contains | Contains a specified string. | {\"#contains\":{\"firstName\":\"oh\"}} | #notContain | Does not contain a specified string. | {\"#notContain\":{\"firstName\":\"oh\"}} | #in | At least one of the strings in a list. | {\"#in\":{\"firstName\":[\"John\",\"Jane\"]}} | #notIn | Not any of the strings in a list. | {\"#notIn\":{\"firstName\":[\"John\",\"Jane\"]}} | | Dates | Description | Example | #eq | Equals to a specified date. | {\"birthDate\":\"1987-07-10\"} | #ne | Not equal to a specified date. | {\"#ne\":{\"birthDate\":\"1987-07-10\"}} | #eq (relative) | Will be in specified interval. | {\"#eq\":{\"birthDate\":{\"#relNow\":\"P1D\"}}} | #lt (relative) | Will be within a specified interval. | {\"#lt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}} | #gt (relative) | Will be in more than a specified interval. | {\"#gt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}} | #eq (relative) - | Was a specified interval ago. | {\"#eq\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}} | #gt (relative) - | Was within a specified interval ago. | {\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}} | #gt (relative) - | Was more than a specified interval ago. | {\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}} | #lt | Is before a specified date. | {\"#lt\":{\"birthDate\":\"1987-07-10\"}} | #lte | Is before or equal to a specified date. | {\"#lte\":{\"birthDate\":\"1987-07-10\"}} | #gt | Is after a specified date. | {\"#gt\":{\"birthDate\":\"1987-07-10\"}} | #gte | Is after or equal to a specified date. | {\"#gte\":{\"birthDate\":\"1987-07-10\"}} | #in | Is equal to one of dates in a given list. | {\"#in\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}} | #notIn | Is not equal to any of dates in a given list. | {\"#notIn\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}} | | Integers | Description | Example | #eq | Equals to a specified integer. | {\"data\\u0001counter\":1} | #ne | Not equal to a specified integer. | {\"#ne\":{\"data\\u0001counter\":1}} | #lt | Is less than a specified integer. | {\"#lt\":{\"data\\u0001counter\":1}} | #lte | Is less than or equal to a specified integer. | {\"#lte\":{\"data\\u0001counter\":1}} | #gt | Is greater than a specified integer. | {\"#gt\":{\"data\\u0001counter\":1}} | #gte | Is greater than or equal to a specified integer. | {\"#gte\":{\"data\\u0001counter\":1}} | #in | Is equal to any of specified integers in a list. | {\"#in\":{\"data\\u0001counter\":[1,2,3]}} | #notIn | Is not equal to any of specified integers in a list. | {\"#notIn\":{\"data\\u0001counter\":[1,2,3]}} | | Decimals | Description | Example | #eq | Equals to a specified decimal. | {\"data\\u0001price\":1.1} | #ne | Is not equal to a specified decimal. | {\"#ne\":{\"data\\u0001price\":1.1}} | #lt | Is less than a specified decimal. | {\"#lt\":{\"data\\u0001price\":1.1}} | #lte | Is less than or equal to a specified decimal. | {\"#lte\":{\"data\\u0001price\":1.1}} | #gt | Is greater than a specified decimal. | {\"#gt\":{\"data\\u0001price\":1.1}} | #gte | Is greater than or equal to a specified decimal. | {\"#gte\":{\"data\\u0001price\":1.1}} | #in | Is equal to any of specified decimals in a list. | {\"#in\":{\"data\\u0001price\":[1.1,2.1,3.0]}} | #notIn | Is not equal to any of specified decimals in a list. | {\"#notIn\":{\"data\\u0001price\":[1.1,2.1,3.0]}} | | Booleans | Description | Example | #eq | Equals to a specified boolean. | {\"data\\u0001happy\":true} | #ne | Not equal to a specified boolean. | {\"#ne\":{\"data\\u0001happy\":true}} | | Tags | Description | Example | #contains | Contains a specified tag. | {\"#contains\":{\"tags\":\"SOME_TAG\"}} | #notContain | Does not contain a specified tag. | {\"#notContain\":{\"tags\":\"SOME_TAG\"}} | | Gender | Description | Example | #eq | Equals a specified gender. | {\"gender\":\"MALE\"} | #ne | Does not equal a specified gender. | {\"#ne\":{\"gender\":\"FEMALE\"}} | | Lists | Description | Example | #all | All items in the list match. | {\"#all\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}} | #any | Any item in the list match. | {\"#any\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}} | | \n
\n\n| events | \nArray | \nList of events that persons should match. | \n
\n\n| events[].definitionId | \nString | \nRequired. Event definition ID. | \n
\n\n| events[].occurrenceCondition | \nObject | \nSpecify how many times did the event occur. | \n
\n\n| events[].occurrenceCondition.operation | \nString | \nRequired. Operation to compare how many times the event has occurred. One of: IS, LESS_THAN, LESS_OR_EQUAL, GREATER_OR_EQUAL, GREATER_THAN. | \n
\n\n| events[].occurrenceCondition.times | \nInt | \nRequired. Number of times the event has occurred. | \n
\n\n| events[].timelineCondition | \nObject | \nRequired. Specify in which timespan did the event occur. | \n
\n\n| events[].timelineCondition.occurred | \nString | \nRequired. Specifies whether an event is occurring for the first or last time within a given period. Additionally, we can use an operator to specify if any event has occurred or never occurred within the specified timeframe. One of: ALL, FIRST, LAST, NOT. | \n
\n\n| events[].timelineCondition.operator | \nString | \nRequired. The operators AFTER, BEFORE, and BETWEEN can be used to specify relative time periods, while their counterparts with the suffix _ABS (e.g., AFTER_ABS, BEFORE_ABS, BETWEEN_ABS) are used for absolute time values. These operators can be applied with start and end attributes to define the beginning and ending points of the time. Units need to be used with relative operators to specify the duration of the time periods. One of: EMPTY, AFTER, BEFORE, BETWEEN, AFTER_ABS, BEFORE_ABS, BETWEEN_ABS. | \n
\n\n| events[].timelineCondition.start | \nInt | \nStart of timespan: For relative operators, specify the number of units. For absolute operators, provide a Unix timestamp. | \n
\n\n| events[].timelineCondition.end | \nInt | \nEnd of timespan: For relative operators, specify the number of units. For absolute operators, provide a Unix timestamp. | \n
\n\n| events[].timelineCondition.units | \nString | \nTime units for relative operators. One of: DAYS, HOURS, MINUTES. | \n
\n\n| events[].payloadConditions | \nArray | \nSpecify the conditions of the event payload. | \n
\n\n| events[].payloadConditions[].attribute | \nString | \nRequired. Event payload attribute. | \n
\n\n| events[].payloadConditions[].operator | \nString | \nRequired. Operator for comparing condition value with payload value. One of: EQ, LT, LTE, GT, GTE, NE, SW, EW, CON. | \n
\n\n| events[].payloadConditions[].value | \nString | \nRequired. Payload condition value. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| id | \nInt | \nRequired. A unique segment identifier. | \n
\n\n| name | \nString | \nRequired. A unique segment name. | \n
\n\n| description | \nString | \nSegment description. | \n
\n\n| query | \nObject | \nAllows to filter persons using simple queries. ##### Supported logical operators | Operator | Description | Example | #and | All records that match the conditions of all clauses. | {\"#and\":[{\"firstName\":\"John\"},{\"lastName\":\"Smith\"}]} | #or | All records that match the conditions of any clause. | {\"#or\":[{\"firstName\":\"John\"},{\"firstName\":\"Jane\"}]} | ##### Supported comparison operators | Attributes | Description | Example | #notExist | Matches records that do not have given attribute. | {\"#notExist\":\"firstName\"} | #exist | Matches records that have given attribute. | {\"#exists\":\"firstName\"} | | Strings | Description | Example | #eq | Equals to a specified string. | {\"firstName\":\"John\"} | #ne | Not equal to a specified string. | {\"#ne\":{\"firstName\":\"John\"}} | #startsWith | Starts with a specified string. | {\"#startsWith\":{\"firstName\":\"John\"}} | #endsWith | Ends with a specified string. | {\"#endsWith\":{\"firstName\":\"John\"}} | #contains | Contains a specified string. | {\"#contains\":{\"firstName\":\"oh\"}} | #notContain | Does not contain a specified string. | {\"#notContain\":{\"firstName\":\"oh\"}} | #in | At least one of the strings in a list. | {\"#in\":{\"firstName\":[\"John\",\"Jane\"]}} | #notIn | Not any of the strings in a list. | {\"#notIn\":{\"firstName\":[\"John\",\"Jane\"]}} | | Dates | Description | Example | #eq | Equals to a specified date. | {\"birthDate\":\"1987-07-10\"} | #ne | Not equal to a specified date. | {\"#ne\":{\"birthDate\":\"1987-07-10\"}} | #eq (relative) | Will be in specified interval. | {\"#eq\":{\"birthDate\":{\"#relNow\":\"P1D\"}}} | #lt (relative) | Will be within a specified interval. | {\"#lt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}} | #gt (relative) | Will be in more than a specified interval. | {\"#gt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}} | #eq (relative) - | Was a specified interval ago. | {\"#eq\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}} | #gt (relative) - | Was within a specified interval ago. | {\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}} | #gt (relative) - | Was more than a specified interval ago. | {\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}} | #lt | Is before a specified date. | {\"#lt\":{\"birthDate\":\"1987-07-10\"}} | #lte | Is before or equal to a specified date. | {\"#lte\":{\"birthDate\":\"1987-07-10\"}} | #gt | Is after a specified date. | {\"#gt\":{\"birthDate\":\"1987-07-10\"}} | #gte | Is after or equal to a specified date. | {\"#gte\":{\"birthDate\":\"1987-07-10\"}} | #in | Is equal to one of dates in a given list. | {\"#in\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}} | #notIn | Is not equal to any of dates in a given list. | {\"#notIn\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}} | | Integers | Description | Example | #eq | Equals to a specified integer. | {\"data\\u0001counter\":1} | #ne | Not equal to a specified integer. | {\"#ne\":{\"data\\u0001counter\":1}} | #lt | Is less than a specified integer. | {\"#lt\":{\"data\\u0001counter\":1}} | #lte | Is less than or equal to a specified integer. | {\"#lte\":{\"data\\u0001counter\":1}} | #gt | Is greater than a specified integer. | {\"#gt\":{\"data\\u0001counter\":1}} | #gte | Is greater than or equal to a specified integer. | {\"#gte\":{\"data\\u0001counter\":1}} | #in | Is equal to any of specified integers in a list. | {\"#in\":{\"data\\u0001counter\":[1,2,3]}} | #notIn | Is not equal to any of specified integers in a list. | {\"#notIn\":{\"data\\u0001counter\":[1,2,3]}} | | Decimals | Description | Example | #eq | Equals to a specified decimal. | {\"data\\u0001price\":1.1} | #ne | Is not equal to a specified decimal. | {\"#ne\":{\"data\\u0001price\":1.1}} | #lt | Is less than a specified decimal. | {\"#lt\":{\"data\\u0001price\":1.1}} | #lte | Is less than or equal to a specified decimal. | {\"#lte\":{\"data\\u0001price\":1.1}} | #gt | Is greater than a specified decimal. | {\"#gt\":{\"data\\u0001price\":1.1}} | #gte | Is greater than or equal to a specified decimal. | {\"#gte\":{\"data\\u0001price\":1.1}} | #in | Is equal to any of specified decimals in a list. | {\"#in\":{\"data\\u0001price\":[1.1,2.1,3.0]}} | #notIn | Is not equal to any of specified decimals in a list. | {\"#notIn\":{\"data\\u0001price\":[1.1,2.1,3.0]}} | | Booleans | Description | Example | #eq | Equals to a specified boolean. | {\"data\\u0001happy\":true} | #ne | Not equal to a specified boolean. | {\"#ne\":{\"data\\u0001happy\":true}} | | Tags | Description | Example | #contains | Contains a specified tag. | {\"#contains\":{\"tags\":\"SOME_TAG\"}} | #notContain | Does not contain a specified tag. | {\"#notContain\":{\"tags\":\"SOME_TAG\"}} | | Gender | Description | Example | #eq | Equals a specified gender. | {\"gender\":\"MALE\"} | #ne | Does not equal a specified gender. | {\"#ne\":{\"gender\":\"FEMALE\"}} | | Lists | Description | Example | #all | All items in the list match. | {\"#all\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}} | #any | Any item in the list match. | {\"#any\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}} | | \n
\n\n| events | \nArray | \nList of events that persons should match. | \n
\n\n| events[].definitionId | \nString | \nRequired. Event definition ID. | \n
\n\n| events[].occurrenceCondition | \nObject | \nSpecify how many times did the event occur. | \n
\n\n| events[].occurrenceCondition.operation | \nString | \nRequired. Operation to compare how many times the event has occurred. One of: IS, LESS_THAN, LESS_OR_EQUAL, GREATER_OR_EQUAL, GREATER_THAN. | \n
\n\n| events[].occurrenceCondition.times | \nInt | \nRequired. Number of times the event has occurred. | \n
\n\n| events[].timelineCondition | \nObject | \nRequired. Specify in which timespan did the event occur. | \n
\n\n| events[].timelineCondition.occurred | \nString | \nRequired. Specifies whether an event is occurring for the first or last time within a given period. Additionally, we can use an operator to specify if any event has occurred or never occurred within the specified timeframe. One of: ALL, FIRST, LAST, NOT. | \n
\n\n| events[].timelineCondition.operator | \nString | \nRequired. The operators AFTER, BEFORE, and BETWEEN can be used to specify relative time periods, while their counterparts with the suffix _ABS (e.g., AFTER_ABS, BEFORE_ABS, BETWEEN_ABS) are used for absolute time values. These operators can be applied with start and end attributes to define the beginning and ending points of the time. Units need to be used with relative operators to specify the duration of the time periods. One of: EMPTY, AFTER, BEFORE, BETWEEN, AFTER_ABS, BEFORE_ABS, BETWEEN_ABS. | \n
\n\n| events[].timelineCondition.start | \nInt | \nStart of timespan: For relative operators, specify the number of units. For absolute operators, provide a Unix timestamp. | \n
\n\n| events[].timelineCondition.end | \nInt | \nEnd of timespan: For relative operators, specify the number of units. For absolute operators, provide a Unix timestamp. | \n
\n\n| events[].timelineCondition.units | \nString | \nTime units for relative operators. One of: DAYS, HOURS, MINUTES. | \n
\n\n| events[].payloadConditions | \nArray | \nSpecify the conditions of the event payload. | \n
\n\n| events[].payloadConditions[].attribute | \nString | \nRequired. Event payload attribute. | \n
\n\n| events[].payloadConditions[].operator | \nString | \nRequired. Operator for comparing condition value with payload value. One of: EQ, LT, LTE, GT, GTE, NE, SW, EW, CON. | \n
\n\n| events[].payloadConditions[].value | \nString | \nRequired. Payload condition value. | \n
\n\n| createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ. | \n
\n\n| modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["people","3","segments","{{segmentId}}"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"ab1b72c0-1a01-46ab-a495-c57622f9a888","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"a8a48ed6-740a-48d3-a013-58508919b9d7","name":"400 - real VHD response","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E400\",\n \"description\": \"Request cannot be processed.\",\n \"action\": \"Check the syntax, violations and adjust the request.\",\n \"violations\": [\n {\n \"property\": \"name\",\n \"violation\": \"Invalid type\"\n }\n ],\n \"resources\": []\n}"},{"id":"6475d962-d7b1-4461-a51e-b2a49af9781e","name":"401 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E401\",\n \"description\": \"The request lacks valid authentication credentials for the requested resource.\",\n \"action\": \"Check the resources and adjust authentication credentials.\",\n \"violations\": [],\n \"resources\": [\n {\n \"name\": \"API Authentication\",\n \"url\": \"https://www.vhd.com/docs/essentials/api-authentication\"\n }\n ]\n}"},{"id":"e7bce10d-dc39-496f-a3d7-5ccca84797bd","name":"403 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E403\",\n \"description\": \"Insufficient permissions to access the requested resource.\",\n \"action\": \"Repeat the request with new or different credentials.\",\n \"violations\": [],\n \"resources\": [\n {\n \"name\": \"API Scopes\",\n \"url\": \"https://www.vhd.com/docs/essentials/api-essentials/api-authorization#api-scopes\"\n }\n ]\n}"},{"id":"8f15d405-f61b-4a34-9ed8-95f618ce43f9","name":"404 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E404\",\n \"description\": \"Not found - request URL doesn't exist on the API server or resource is not found.\",\n \"action\": \"Check the resources and adjust your request.\",\n \"violations\": [],\n \"resources\": []\n}"},{"id":"fcb58d2a-a0ea-4ad3-b02e-01ab4c1e6375","name":"429 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E429\",\n \"description\": \"Too many requests sent.\",\n \"action\": \"Check request rate limit specified in the API endpoint documentation resource.\",\n \"violations\": [],\n \"resources\": [\n {\n \"name\": \"Throttling handling errors\",\n \"url\": \"https://www.vhd.com/docs/essentials/integration-best-practices#throttling-handling-errors\"\n }\n ]\n}"},{"id":"5da9fb89-221f-4445-a11c-65d9698d276f","name":"500 - Example","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E500\",\n \"description\": \"Something went wrong.\",\n \"action\": \"Contact the support.\",\n \"violations\": [],\n \"resources\": []\n}"}],"_postman_id":"35dc3d6b-96ab-4fdf-ba09-9f2d206ae4f8"},{"name":"Get persons in a segment","event":[{"listen":"test","script":{"exec":["// Tests for Get persons in a segment.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var res;","pm.test(\"Response body is valid JSON\", function () { res = pm.response.json(); });","","pm.test(\"Response contains 'results' array and 'paging'\", function () {"," pm.expect(res).to.have.property('results').that.is.an('array');"," pm.expect(res).to.have.property('paging');"," pm.expect(res.paging).to.include.all.keys('page', 'size', 'totalPages', 'totalResults');","});",""],"type":"text/javascript","packages":{}}}],"id":"6cc260ba-7436-4194-9308-7f75a99c21f9","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}/persons","description":"Get persons in a segment.
\nUse this method to get persons in a segment by ID.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| segmentId | \nInt | \nRequired. A unique segment identifier. | \n
\n\n| page | \nInt | \nZero-based page index (0..N). Default: 0. | \n
\n\n| size | \nInt | \nThe size of the page to be returned. Default: 20. | \n
\n\n| sort | \nArray | \nSorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \nArray | \nRequired. The list of the results for this page. | \n
\n\n| results[].id | \nInt | \nUnique id of the entity. | \n
\n\n| results[].externalId | \nString | \nUnique ID for a person from your or another external system, 256 characters max. | \n
\n\n| results[].type | \nString | \nPerson's type, default type is CUSTOMER. One of: CUSTOMER, LEAD. | \n
\n\n| results[].firstName | \nString | \nPerson's first name, 255 characters max. | \n
\n\n| results[].middleName | \nString | \nPerson's middle name, 50 characters max. | \n
\n\n| results[].lastName | \nString | \nPerson's last name, 255 characters max. | \n
\n\n| results[].nickName | \nString | \nPerson's nick name, 50 characters max. | \n
\n\n| results[].country | \nString | \nPerson's country, 50 characters max. | \n
\n\n| results[].city | \nString | \nPerson's city, 50 characters max. | \n
\n\n| results[].address | \nString | \nPerson's address, 256 characters max. | \n
\n\n| results[].gender | \nString | \nPerson's gender. One of: MALE, FEMALE. | \n
\n\n| results[].preferredLanguage | \nString | \nPerson's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format. | \n
\n\n| results[].birthDate | \nString | \nPerson's date of birth, format YYYY-MM-DD. | \n
\n\n| results[].profilePicture | \nString | \nURL for the person's profile picture, 2083 characters max. | \n
\n\n| results[].tags | \nArray | \nList of tags that this person has. | \n
\n\n| results[].contactInformation | \nArray | \nList of phones, emails and other information how a person can be contacted. | \n
\n\n| results[].contactInformation[].type | \nString | \nRequired. Type of the person ID One of: PHONE, EMAIL, FACEBOOK, LINE, TELEGRAM, PUSH, WEB_PUSH, LIVE_CHAT, VIBER_BOTS, INSTAGRAM, TWITTER, INSTAGRAM_DM, KAKAO_SANGDAM, APPLE_BUSINESS_CHAT, OPEN_CHANNEL, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK. | \n
\n\n| results[].contactInformation[].identifier | \nString | \nRequired. Person ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request. 255 characters max. | \n
\n\n| results[].contactInformation[].sender | \nString | \nSender or application ID. Sender is required for all identifier types except PHONE and EMAIL. 255 characters max. | \n
\n\n| results[].contactInformation[].primary | \nBoolean | \nIndicates if this ID is preferred for communication. | \n
\n\n| results[].customAttributes | \nObject | \nList of custom attributes for the person, 4096 characters max per value. | \n
\n\n| results[].computedAttributes | \nObject | \nPerson's computed attributes grouped by type. | \n
\n\n| results[].createdFrom | \nString | \nSource system that last modified this person record. One of: API, PORTAL, WEB_SDK, INTEGRATION, PUSH, FACEBOOK, LINE, TELEGRAM, SALESFORCE, DYNAMICS, ZAPIER, FORMS, AMS, COMPUTED, ANSWERS, CONVERSATIONS, IMPORT, INSTAGRAM_DM, FLOW, LIVE_CHAT, VKONTAKTE, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK, UNKNOWN. | \n
\n\n| results[].createdBy | \nString | \nIdentifier of the user who created this person record. | \n
\n\n| results[].createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| results[].modifiedFrom | \nString | \nSource system that last modified this person record. One of: API, PORTAL, WEB_SDK, INTEGRATION, PUSH, FACEBOOK, LINE, TELEGRAM, SALESFORCE, DYNAMICS, ZAPIER, FORMS, AMS, COMPUTED, ANSWERS, CONVERSATIONS, IMPORT, INSTAGRAM_DM, FLOW, LIVE_CHAT, VKONTAKTE, ZALO_FOLLOWER, TIKTOK_BM, WHATSAPP, KAKAO_TALK, UNKNOWN. | \n
\n\n| results[].modifiedBy | \nString | \nIdentifier of the user who last modified this person record. | \n
\n\n| results[].modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss. | \n
\n\n| paging | \nObject | \nRequired. Contains information about the page. | \n
\n\n| paging.page | \nInt | \nRequired. Requested page number. | \n
\n\n| paging.size | \nInt | \nRequired. Requested page size. | \n
\n\n| paging.totalPages | \nInt | \nRequired. The total number of pages of the results matching the requested parameters. | \n
\n\n| paging.totalResults | \nInt | \nRequired. The total number of the results matching the requested parameters. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["people","3","segments","{{segmentId}}","persons"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"08ac80fe-8119-495d-96ef-0f881029f93f","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}/persons","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","segments","{{segmentId}}","persons"],"query":[{"key":"page","value":"","description":"Zero-based page index (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"The size of the page to be returned. Default: `20`.","disabled":true},{"key":"sort","value":"","description":"Sorting criteria in the format: property,(asc\\|desc). Default sort order is ascending. Multiple sort criteria are supported.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"941ce372-c985-4b32-ba8c-6c0e70f6c2fe","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}/persons","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","segments","{{segmentId}}","persons"],"query":[{"key":"page","value":"","description":"Zero-based page index (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"The size of the page to be returned. Default: `20`.","disabled":true},{"key":"sort","value":"","description":"Sorting criteria in the format: property,(asc\\|desc). Default sort order is ascending. Multiple sort criteria are supported.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E401\",\n \"description\": \"The request lacks valid authentication credentials for the requested resource.\",\n \"action\": \"Check the resources and adjust authentication credentials.\",\n \"violations\": [],\n \"resources\": [\n {\n \"name\": \"API Authentication\",\n \"url\": \"https://www.vhd.com/docs/essentials/api-authentication\"\n }\n ]\n}"},{"id":"b79db8fc-1996-49e7-9abc-70d1e50b4b95","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}/persons","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","segments","{{segmentId}}","persons"],"query":[{"key":"page","value":"","description":"Zero-based page index (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"The size of the page to be returned. Default: `20`.","disabled":true},{"key":"sort","value":"","description":"Sorting criteria in the format: property,(asc\\|desc). Default sort order is ascending. Multiple sort criteria are supported.","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E403\",\n \"description\": \"Insufficient permissions to access the requested resource.\",\n \"action\": \"Repeat the request with new or different credentials.\",\n \"violations\": [],\n \"resources\": [\n {\n \"name\": \"API Scopes\",\n \"url\": \"https://www.vhd.com/docs/essentials/api-essentials/api-authorization#api-scopes\"\n }\n ]\n}"},{"id":"f7cc5e9a-11b8-458b-985b-b9f7bcf0c5a8","name":"404 - real VHD response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}/persons","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","segments","{{segmentId}}","persons"],"query":[{"key":"page","value":"","description":"Zero-based page index (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"The size of the page to be returned. Default: `20`.","disabled":true},{"key":"sort","value":"","description":"Sorting criteria in the format: property,(asc\\|desc). Default sort order is ascending. Multiple sort criteria are supported.","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E404\",\n \"description\": \"Not found - request URL doesn't exist on the API server or resource is not found.\",\n \"action\": \"Check the resources and adjust your request.\",\n \"violations\": [\n {\n \"violation\": \"Segment with given id does not exist.\"\n }\n ],\n \"resources\": []\n}"},{"id":"6f42e0e6-c6f6-4e7e-b244-95e79cf2f1fa","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}/persons","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","segments","{{segmentId}}","persons"],"query":[{"key":"page","value":"","description":"Zero-based page index (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"The size of the page to be returned. Default: `20`.","disabled":true},{"key":"sort","value":"","description":"Sorting criteria in the format: property,(asc\\|desc). Default sort order is ascending. Multiple sort criteria are supported.","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E429\",\n \"description\": \"Too many requests sent.\",\n \"action\": \"Check request rate limit specified in the API endpoint documentation resource.\",\n \"violations\": [],\n \"resources\": [\n {\n \"name\": \"Throttling handling errors\",\n \"url\": \"https://www.vhd.com/docs/essentials/integration-best-practices#throttling-handling-errors\"\n }\n ]\n}"},{"id":"31bfa3f5-5dc6-4016-b7a8-cc8edcb890bf","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}/persons","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","segments","{{segmentId}}","persons"],"query":[{"key":"page","value":"","description":"Zero-based page index (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"The size of the page to be returned. Default: `20`.","disabled":true},{"key":"sort","value":"","description":"Sorting criteria in the format: property,(asc\\|desc). Default sort order is ascending. Multiple sort criteria are supported.","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E500\",\n \"description\": \"Something went wrong.\",\n \"action\": \"Contact the support.\",\n \"violations\": [],\n \"resources\": []\n}"}],"_postman_id":"6cc260ba-7436-4194-9308-7f75a99c21f9"},{"name":"Get a list of segments","event":[{"listen":"test","script":{"exec":["// Tests for Get a list of segments.","pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var res;","pm.test(\"Response body is valid JSON\", function () { res = pm.response.json(); });","","pm.test(\"Response contains 'results' array and 'paging'\", function () {"," pm.expect(res).to.have.property('results').that.is.an('array');"," pm.expect(res).to.have.property('paging');"," pm.expect(res.paging).to.include.all.keys('page', 'size', 'totalPages', 'totalResults');","});","","pm.test(\"Each segment has an id and a name\", function () {"," res.results.forEach(function (s) {"," pm.expect(s).to.have.property('id');"," pm.expect(s).to.have.property('name').that.is.a('string');"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"799ca5d2-ccfd-4a8c-99da-e1320d49d4f0","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments","description":"Get a list of segments.
\nUse this method to get a list of segments.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| page | \nInt | \nZero-based page index (0..N). Default: 0. | \n
\n\n| size | \nInt | \nThe size of the page to be returned. Default: 20. | \n
\n\n| sort | \nArray | \nSorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \nArray | \nRequired. The list of the results for this page. | \n
\n\n| results[].id | \nInt | \nRequired. A unique segment identifier. | \n
\n\n| results[].name | \nString | \nRequired. A unique segment name. | \n
\n\n| results[].description | \nString | \nSegment description. | \n
\n\n| results[].query | \nObject | \nAllows to filter persons using simple queries. ##### Supported logical operators | Operator | Description | Example | #and | All records that match the conditions of all clauses. | {\"#and\":[{\"firstName\":\"John\"},{\"lastName\":\"Smith\"}]} | #or | All records that match the conditions of any clause. | {\"#or\":[{\"firstName\":\"John\"},{\"firstName\":\"Jane\"}]} | ##### Supported comparison operators | Attributes | Description | Example | #notExist | Matches records that do not have given attribute. | {\"#notExist\":\"firstName\"} | #exist | Matches records that have given attribute. | {\"#exists\":\"firstName\"} | | Strings | Description | Example | #eq | Equals to a specified string. | {\"firstName\":\"John\"} | #ne | Not equal to a specified string. | {\"#ne\":{\"firstName\":\"John\"}} | #startsWith | Starts with a specified string. | {\"#startsWith\":{\"firstName\":\"John\"}} | #endsWith | Ends with a specified string. | {\"#endsWith\":{\"firstName\":\"John\"}} | #contains | Contains a specified string. | {\"#contains\":{\"firstName\":\"oh\"}} | #notContain | Does not contain a specified string. | {\"#notContain\":{\"firstName\":\"oh\"}} | #in | At least one of the strings in a list. | {\"#in\":{\"firstName\":[\"John\",\"Jane\"]}} | #notIn | Not any of the strings in a list. | {\"#notIn\":{\"firstName\":[\"John\",\"Jane\"]}} | | Dates | Description | Example | #eq | Equals to a specified date. | {\"birthDate\":\"1987-07-10\"} | #ne | Not equal to a specified date. | {\"#ne\":{\"birthDate\":\"1987-07-10\"}} | #eq (relative) | Will be in specified interval. | {\"#eq\":{\"birthDate\":{\"#relNow\":\"P1D\"}}} | #lt (relative) | Will be within a specified interval. | {\"#lt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}} | #gt (relative) | Will be in more than a specified interval. | {\"#gt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}} | #eq (relative) - | Was a specified interval ago. | {\"#eq\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}} | #gt (relative) - | Was within a specified interval ago. | {\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}} | #gt (relative) - | Was more than a specified interval ago. | {\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}} | #lt | Is before a specified date. | {\"#lt\":{\"birthDate\":\"1987-07-10\"}} | #lte | Is before or equal to a specified date. | {\"#lte\":{\"birthDate\":\"1987-07-10\"}} | #gt | Is after a specified date. | {\"#gt\":{\"birthDate\":\"1987-07-10\"}} | #gte | Is after or equal to a specified date. | {\"#gte\":{\"birthDate\":\"1987-07-10\"}} | #in | Is equal to one of dates in a given list. | {\"#in\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}} | #notIn | Is not equal to any of dates in a given list. | {\"#notIn\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}} | | Integers | Description | Example | #eq | Equals to a specified integer. | {\"data\\u0001counter\":1} | #ne | Not equal to a specified integer. | {\"#ne\":{\"data\\u0001counter\":1}} | #lt | Is less than a specified integer. | {\"#lt\":{\"data\\u0001counter\":1}} | #lte | Is less than or equal to a specified integer. | {\"#lte\":{\"data\\u0001counter\":1}} | #gt | Is greater than a specified integer. | {\"#gt\":{\"data\\u0001counter\":1}} | #gte | Is greater than or equal to a specified integer. | {\"#gte\":{\"data\\u0001counter\":1}} | #in | Is equal to any of specified integers in a list. | {\"#in\":{\"data\\u0001counter\":[1,2,3]}} | #notIn | Is not equal to any of specified integers in a list. | {\"#notIn\":{\"data\\u0001counter\":[1,2,3]}} | | Decimals | Description | Example | #eq | Equals to a specified decimal. | {\"data\\u0001price\":1.1} | #ne | Is not equal to a specified decimal. | {\"#ne\":{\"data\\u0001price\":1.1}} | #lt | Is less than a specified decimal. | {\"#lt\":{\"data\\u0001price\":1.1}} | #lte | Is less than or equal to a specified decimal. | {\"#lte\":{\"data\\u0001price\":1.1}} | #gt | Is greater than a specified decimal. | {\"#gt\":{\"data\\u0001price\":1.1}} | #gte | Is greater than or equal to a specified decimal. | {\"#gte\":{\"data\\u0001price\":1.1}} | #in | Is equal to any of specified decimals in a list. | {\"#in\":{\"data\\u0001price\":[1.1,2.1,3.0]}} | #notIn | Is not equal to any of specified decimals in a list. | {\"#notIn\":{\"data\\u0001price\":[1.1,2.1,3.0]}} | | Booleans | Description | Example | #eq | Equals to a specified boolean. | {\"data\\u0001happy\":true} | #ne | Not equal to a specified boolean. | {\"#ne\":{\"data\\u0001happy\":true}} | | Tags | Description | Example | #contains | Contains a specified tag. | {\"#contains\":{\"tags\":\"SOME_TAG\"}} | #notContain | Does not contain a specified tag. | {\"#notContain\":{\"tags\":\"SOME_TAG\"}} | | Gender | Description | Example | #eq | Equals a specified gender. | {\"gender\":\"MALE\"} | #ne | Does not equal a specified gender. | {\"#ne\":{\"gender\":\"FEMALE\"}} | | Lists | Description | Example | #all | All items in the list match. | {\"#all\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}} | #any | Any item in the list match. | {\"#any\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}} | | \n
\n\n| results[].events | \nArray | \nList of events that persons should match. | \n
\n\n| results[].events[].definitionId | \nString | \nRequired. Event definition ID. | \n
\n\n| results[].events[].occurrenceCondition | \nObject | \nSpecify how many times did the event occur. | \n
\n\n| results[].events[].occurrenceCondition.operation | \nString | \nRequired. Operation to compare how many times the event has occurred. One of: IS, LESS_THAN, LESS_OR_EQUAL, GREATER_OR_EQUAL, GREATER_THAN. | \n
\n\n| results[].events[].occurrenceCondition.times | \nInt | \nRequired. Number of times the event has occurred. | \n
\n\n| results[].events[].timelineCondition | \nObject | \nRequired. Specify in which timespan did the event occur. | \n
\n\n| results[].events[].timelineCondition.occurred | \nString | \nRequired. Specifies whether an event is occurring for the first or last time within a given period. Additionally, we can use an operator to specify if any event has occurred or never occurred within the specified timeframe. One of: ALL, FIRST, LAST, NOT. | \n
\n\n| results[].events[].timelineCondition.operator | \nString | \nRequired. The operators AFTER, BEFORE, and BETWEEN can be used to specify relative time periods, while their counterparts with the suffix _ABS (e.g., AFTER_ABS, BEFORE_ABS, BETWEEN_ABS) are used for absolute time values. These operators can be applied with start and end attributes to define the beginning and ending points of the time. Units need to be used with relative operators to specify the duration of the time periods. One of: EMPTY, AFTER, BEFORE, BETWEEN, AFTER_ABS, BEFORE_ABS, BETWEEN_ABS. | \n
\n\n| results[].events[].timelineCondition.start | \nInt | \nStart of timespan: For relative operators, specify the number of units. For absolute operators, provide a Unix timestamp. | \n
\n\n| results[].events[].timelineCondition.end | \nInt | \nEnd of timespan: For relative operators, specify the number of units. For absolute operators, provide a Unix timestamp. | \n
\n\n| results[].events[].timelineCondition.units | \nString | \nTime units for relative operators. One of: DAYS, HOURS, MINUTES. | \n
\n\n| results[].events[].payloadConditions | \nArray | \nSpecify the conditions of the event payload. | \n
\n\n| results[].events[].payloadConditions[].attribute | \nString | \nRequired. Event payload attribute. | \n
\n\n| results[].events[].payloadConditions[].operator | \nString | \nRequired. Operator for comparing condition value with payload value. One of: EQ, LT, LTE, GT, GTE, NE, SW, EW, CON. | \n
\n\n| results[].events[].payloadConditions[].value | \nString | \nRequired. Payload condition value. | \n
\n\n| results[].createdAt | \nString | \nDate and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ. | \n
\n\n| results[].modifiedAt | \nString | \nDate and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ. | \n
\n\n| paging | \nObject | \nRequired. Contains information about the page. | \n
\n\n| paging.page | \nInt | \nRequired. Requested page number. | \n
\n\n| paging.size | \nInt | \nRequired. Requested page size. | \n
\n\n| paging.totalPages | \nInt | \nRequired. The total number of pages of the results matching the requested parameters. | \n
\n\n| paging.totalResults | \nInt | \nRequired. The total number of the results matching the requested parameters. | \n
\n\n
\n
Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["people","3","segments"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"515bab07-888a-4bf8-be8e-56947f591eec","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/segments","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","segments"],"query":[{"key":"page","value":"","description":"Zero-based page index (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"The size of the page to be returned. Default: `20`.","disabled":true},{"key":"sort","value":"","description":"Sorting criteria in the format: property,(asc\\|desc). Default sort order is ascending. Multiple sort criteria are supported.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"a0a6a5e2-00fa-429a-85d1-d2747e3c445a","name":"401 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/segments","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","segments"],"query":[{"key":"page","value":"","description":"Zero-based page index (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"The size of the page to be returned. Default: `20`.","disabled":true},{"key":"sort","value":"","description":"Sorting criteria in the format: property,(asc\\|desc). Default sort order is ascending. Multiple sort criteria are supported.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E401\",\n \"description\": \"The request lacks valid authentication credentials for the requested resource.\",\n \"action\": \"Check the resources and adjust authentication credentials.\",\n \"violations\": [],\n \"resources\": [\n {\n \"name\": \"API Authentication\",\n \"url\": \"https://www.vhd.com/docs/essentials/api-authentication\"\n }\n ]\n}"},{"id":"a9dd76f2-00df-4b9d-b7de-a8f2c97316b8","name":"403 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/segments","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","segments"],"query":[{"key":"page","value":"","description":"Zero-based page index (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"The size of the page to be returned. Default: `20`.","disabled":true},{"key":"sort","value":"","description":"Sorting criteria in the format: property,(asc\\|desc). Default sort order is ascending. Multiple sort criteria are supported.","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E403\",\n \"description\": \"Insufficient permissions to access the requested resource.\",\n \"action\": \"Repeat the request with new or different credentials.\",\n \"violations\": [],\n \"resources\": [\n {\n \"name\": \"API Scopes\",\n \"url\": \"https://www.vhd.com/docs/essentials/api-essentials/api-authorization#api-scopes\"\n }\n ]\n}"},{"id":"53e52ebe-410c-4253-ae19-9e406a308faa","name":"429 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/segments","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","segments"],"query":[{"key":"page","value":"","description":"Zero-based page index (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"The size of the page to be returned. Default: `20`.","disabled":true},{"key":"sort","value":"","description":"Sorting criteria in the format: property,(asc\\|desc). Default sort order is ascending. Multiple sort criteria are supported.","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E429\",\n \"description\": \"Too many requests sent.\",\n \"action\": \"Check request rate limit specified in the API endpoint documentation resource.\",\n \"violations\": [],\n \"resources\": [\n {\n \"name\": \"Throttling handling errors\",\n \"url\": \"https://www.vhd.com/docs/essentials/integration-best-practices#throttling-handling-errors\"\n }\n ]\n}"},{"id":"7ba4af3d-d819-4d0a-8fee-732e980279d1","name":"500 - Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/people/3/segments","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","3","segments"],"query":[{"key":"page","value":"","description":"Zero-based page index (0..N). Default: `0`.","disabled":true},{"key":"size","value":"","description":"The size of the page to be returned. Default: `20`.","disabled":true},{"key":"sort","value":"","description":"Sorting criteria in the format: property,(asc\\|desc). Default sort order is ascending. Multiple sort criteria are supported.","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E500\",\n \"description\": \"Something went wrong.\",\n \"action\": \"Contact the support.\",\n \"violations\": [],\n \"resources\": []\n}"}],"_postman_id":"799ca5d2-ccfd-4a8c-99da-e1320d49d4f0"},{"name":"Delete a segment","event":[{"listen":"test","script":{"exec":["// Tests generated from the documented example response of this request.","pm.test(\"Status code is 204\", function () {"," pm.expect(pm.response.code).to.be.oneOf([204]);","});","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});"],"type":"text/javascript","packages":{}}}],"id":"815f8500-4bf6-49e1-9479-75b096276f65","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}","description":"Delete a segment.
\nUse this method to delete a segment by ID.
\nParameters
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| segmentId | \nInt | \nRequired. A unique segment identifier. | \n
\n\n
\n
On success the response is 204 No Content.
\nStatus codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 404 not found, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["people","3","segments","{{segmentId}}"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"cfe4efb4-b8ec-4723-a7bf-4a6674ef1e90","name":"204 No Content","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}"},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"4683af7b-b062-414e-8085-f4b8e1423fbc","name":"401 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E401\",\n \"description\": \"The request lacks valid authentication credentials for the requested resource.\",\n \"action\": \"Check the resources and adjust authentication credentials.\",\n \"violations\": [],\n \"resources\": [\n {\n \"name\": \"API Authentication\",\n \"url\": \"https://www.vhd.com/docs/essentials/api-authentication\"\n }\n ]\n}"},{"id":"c5342ec8-59ce-42ab-8293-b05d3488788c","name":"403 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E403\",\n \"description\": \"Insufficient permissions to access the requested resource.\",\n \"action\": \"Repeat the request with new or different credentials.\",\n \"violations\": [],\n \"resources\": [\n {\n \"name\": \"API Scopes\",\n \"url\": \"https://www.vhd.com/docs/essentials/api-essentials/api-authorization#api-scopes\"\n }\n ]\n}"},{"id":"f53439f1-9161-4da1-85c4-5f9343bb540c","name":"404 - real VHD response","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E404\",\n \"description\": \"Not found - request URL doesn't exist on the API server or resource is not found.\",\n \"action\": \"Check the resources and adjust your request.\",\n \"violations\": [\n {\n \"violation\": \"Segment with given id does not exist.\"\n }\n ],\n \"resources\": []\n}"},{"id":"98469771-1780-4445-a413-55a604d1182b","name":"429 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E429\",\n \"description\": \"Too many requests sent.\",\n \"action\": \"Check request rate limit specified in the API endpoint documentation resource.\",\n \"violations\": [],\n \"resources\": [\n {\n \"name\": \"Throttling handling errors\",\n \"url\": \"https://www.vhd.com/docs/essentials/integration-best-practices#throttling-handling-errors\"\n }\n ]\n}"},{"id":"0a6abdf0-86e0-4f8c-a48c-4b405dd96e77","name":"500 - Example","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/people/3/segments/{{segmentId}}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"E500\",\n \"description\": \"Something went wrong.\",\n \"action\": \"Contact the support.\",\n \"violations\": [],\n \"resources\": []\n}"}],"_postman_id":"815f8500-4bf6-49e1-9479-75b096276f65"}],"id":"608bbc81-2a08-4ecb-9c61-01543cb5517b","description":"Segments group people by rules, so you can target them together. Create and manage segments, and list the people in a segment.
\n","_postman_id":"608bbc81-2a08-4ecb-9c61-01543cb5517b"}],"id":"b16ca812-cf1b-4843-b163-f13d0b35b195","description":"Build rich profiles for each person to create audience segments for more precise targeting. Manage duplicates and import your data over API.
\nEvents reflect actions that end users take on your website or in your mobile application.
\nEvents API is a robust way to send those events to VHD. Event can be sent only to an existing person in Target module and an event definition should be created beforehand to describe contents of the event.
\n\nRunning these requests. The requests in this folder run in order, on sample data (janewilliams@example.com, the tag Vip, the company Example, the attribute ShoppingCartList). Each create request first removes leftovers of an earlier run, so you can run the folder again and again. No variables need to be set.
\n
\n","_postman_id":"b16ca812-cf1b-4843-b163-f13d0b35b195"},{"name":"BLOCKLIST","item":[{"name":"Get all blocklists","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","// The Blocklist API allows 1 request per second, so wait a moment before each request.","pause(1300, function () {});"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests for Get all blocklists.","pm.test(\"Response status code is 200\", function () { pm.response.to.have.status(200); });","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","var res;","pm.test(\"Content-Type is application/json\", function () {"," pm.expect(pm.response.headers.get('Content-Type')).to.include('application/json');"," res = pm.response.json();","});","","pm.test(\"Response contains the 'results' array\", function () {"," pm.expect(res).to.have.property('results').that.is.an('array');","});","","pm.test(\"Each blocklist record has the documented fields\", function () {"," res.results.forEach(function (r) {"," pm.expect(r, 'missing destination').to.have.property('destination');"," pm.expect(r, 'missing sourceType').to.have.property('sourceType');"," pm.expect(r.sourceType).to.be.oneOf(['CUSTOM', 'MO', 'URL_OPT_OUT', 'CAMPAIGN']);"," pm.expect(r, 'missing createdDate').to.have.property('createdDate');"," if (r.channel) {"," pm.expect(r.channel).to.be.oneOf(['SMS', 'EMAIL', 'VOICE_OUTBOUND_TTS', 'NEW_PUSH_NOTIF', 'VIBER', 'RCS', 'WHATSAPP', 'APPLE_MB', 'MMS']);"," }"," });","});","","pm.test(\"Paging object is present in the response\", function () {"," pm.expect(res).to.have.property('paging');"," pm.expect(res.paging).to.include.all.keys('page', 'size', 'totalPages', 'totalResults');","});",""],"type":"text/javascript","packages":{}}}],"id":"2ba114c4-5380-409b-a26a-511ff6a3a6b6","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://go2.vhdmedia.se/platform/1/blocklists","description":"Get all blocklist records, or filter them by sender, destination, channel, source, account, creation date, or campaign.
\nAUTHORIZATIONS:
\nAPI Key Header, Basic, OAuth 2
\nREQUEST RATE LIMIT:
\n1 request per second (per account). Faster requests return 429 Too Many Requests.
\nQuery parameters
\nAll parameters are optional.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| sender | \nString | \nThe sender ID for which blocklist happened. | \n
\n\n| destination | \nString | \nBlocklisted destination address. | \n
\n\n| channel | \nString | \nChannel used for sending for which blocklist happened. If you want to check blocklist records for all channels, this field can be left out. One of: SMS, EMAIL, VOICE_OUTBOUND_TTS, NEW_PUSH_NOTIF, VIBER, RCS, WHATSAPP, APPLE_MB, MMS. | \n
\n\n| sourceType | \nString | \nRepresents the way blocklist record was created: CUSTOM - blocklist record that was created manually MO - blocklist record automatically created once an end user unsubscribes by replying with a specific keyword (e.g.: STOP). This is applicable for the following channels: SMS, MMS. URL_OPT_OUT - blocklist record automatically created once an end user clicks an opt-out link included in the message. CAMPAIGN - blocklist record automatically created through a triggered event in the Flow (e.g., if the message was not opened in 24h, add to blocklist). One of: CUSTOM, MO, URL_OPT_OUT, CAMPAIGN. | \n
\n\n| accountKey | \nString | \nAccount connected with a blocklist record. Main account has access to blocklist records of their subaccounts. Subaccounts can only access blocklist records specific to them. API to retrieve account key. | \n
\n\n| getAllAccountKeysBlocklists | \nBoolean | \nIf set to true, blocklist records for subaccounts will be returned as well. | \n
\n\n| createdDateFrom | \nString | \nUse with createDateTo to search for blocklists for a particular date range. | \n
\n\n| createdDateTo | \nString | \nUse with createDateFrom to search for blocklists for a particular date range. | \n
\n\n| campaign | \nString | \nID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel. | \n
\n\n| page | \nInt | \nRequested page number. Default: 0. | \n
\n\n| size | \nInt | \nRequested page size. Default: 100. Maximum: 1000. | \n
\n\n
\n
On success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| results | \nArray | \nRequired. Blocklists for requested paging information. | \n
\n\n| results[].sender | \nString | \nThe sender ID for which blocklist happened. | \n
\n\n| results[].destination | \nString | \nRequired. Blocklisted destination address. | \n
\n\n| results[].sourceType | \nString | \nRequired. Represents the way blocklist record was created: CUSTOM - blocklist record that was created manually MO - blocklist record automatically created once an end user unsubscribes by replying with a specific keyword (e.g.: STOP). This is applicable for the following channels: SMS, MMS. URL_OPT_OUT - blocklist record automatically created once an end user clicks an opt-out link included in the message. CAMPAIGN - blocklist record automatically created through a triggered event in the Flow (e.g., if the message was not opened in 24h, add to blocklist). If source type is omitted while deleting, all blocklists that match delete request will be deleted regardless of the source type. One of: CUSTOM, MO, URL_OPT_OUT, CAMPAIGN. | \n
\n\n| results[].channel | \nString | \nChannel used for sending for which blocklist happened. One of: SMS, EMAIL, VOICE_OUTBOUND_TTS, NEW_PUSH_NOTIF, VIBER, RCS, WHATSAPP, APPLE_MB, MMS. | \n
\n\n| results[].accountKey | \nString | \nRequired. Account connected with a blocklist record. Main account has access to blocklist records of their subaccounts. Subaccounts can only access blocklist records specific to them. API to retrieve account key. | \n
\n\n| results[].createdDate | \nString | \nRequired. Timestamp of created blocklist record. | \n
\n\n| results[].campaign | \nString | \nID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel. | \n
\n\n| paging | \nObject | \nRequired. Paging response. | \n
\n\n| paging.page | \nInt | \nRequired. Requested page number. | \n
\n\n| paging.size | \nInt | \nRequired. Requested page size. | \n
\n\n| paging.totalPages | \nInt | \nRequired. Total pages. | \n
\n\n| paging.totalResults | \nInt | \nRequired. Total results. | \n
\n\n
\n
Errors use the format requestError.serviceException with messageId, text and validationErrors. Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["platform","1","blocklists"],"host":["go2","vhdmedia","se"],"query":[{"disabled":true,"description":{"content":"The sender ID for which blocklist happened.
\n","type":"text/plain"},"key":"sender","value":""},{"disabled":true,"description":{"content":"Blocklisted destination address.
\n","type":"text/plain"},"key":"destination","value":""},{"disabled":true,"description":{"content":"Channel used for sending for which blocklist happened. If you want to check blocklist records for all channels, this field can be left out.
\n","type":"text/plain"},"key":"channel","value":""},{"disabled":true,"description":{"content":"Represents the way blocklist record was created: CUSTOM - blocklist record that was created manually MO - blocklist record automatically created once an end user unsubscribes by replying with a specific keyword (e.g.: STOP). This is applicable for the following channels: SMS, MMS. URL_OPT_OUT - blocklist record automatically created once an end user clicks an opt-out link included in the message. CAMPAIGN - blocklist record automatically created through a triggered event in the Flow (e.g., if the message was not opened in 24h, add to blocklist).
\n","type":"text/plain"},"key":"sourceType","value":""},{"disabled":true,"description":{"content":"Account connected with a blocklist record. Main account has access to blocklist records of their subaccounts. Subaccounts can only access blocklist records specific to them. API to retrieve account key.
\n","type":"text/plain"},"key":"accountKey","value":""},{"disabled":true,"description":{"content":"If set to true, blocklist records for subaccounts will be returned as well.
\n","type":"text/plain"},"key":"getAllAccountKeysBlocklists","value":""},{"disabled":true,"description":{"content":"Use with createDateTo to search for blocklists for a particular date range.
\n","type":"text/plain"},"key":"createdDateFrom","value":""},{"disabled":true,"description":{"content":"Use with createDateFrom to search for blocklists for a particular date range.
\n","type":"text/plain"},"key":"createdDateTo","value":""},{"disabled":true,"description":{"content":"ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
\n","type":"text/plain"},"key":"campaign","value":""},{"disabled":true,"description":{"content":"Requested page number. Default: 0.
\n","type":"text/plain"},"key":"page","value":"0"},{"disabled":true,"description":{"content":"Requested page size. Default: 100. Maximum: 1000.
\n","type":"text/plain"},"key":"size","value":"10"}],"variable":[]}},"response":[{"id":"5ca4a993-be57-4882-b1b2-96caad18c10f","name":"Get all blocklists","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/platform/1/blocklists?size=10","protocol":"https","host":["go2","vhdmedia","se"],"path":["platform","1","blocklists"],"query":[{"key":"size","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"destination\": \"46731234567\",\n \"sourceType\": \"CUSTOM\",\n \"channel\": \"SMS\",\n \"accountKey\": \"90D1D1EB0272BE71B1C7924926E33F0A\",\n \"createdDate\": \"2026-10-18T09:00:00Z\"\n },\n {\n \"sender\": \"example@vhdmedia.eu\",\n \"destination\": \"jane.smith@vhdmedia.se\",\n \"sourceType\": \"URL_OPT_OUT\",\n \"channel\": \"EMAIL\",\n \"accountKey\": \"90D1D1EB0272BE71B1C7924926E33F0A\",\n \"createdDate\": \"2026-10-17T14:30:00Z\"\n }\n ],\n \"paging\": {\n \"page\": 0,\n \"size\": 10,\n \"totalPages\": 1,\n \"totalResults\": 2\n }\n}"},{"id":"1114d8c9-0f8a-4968-84fe-c04d63c7b883","name":"Bad request - unsupported channel","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://go2.vhdmedia.se/platform/1/blocklists?channel=NOPE","protocol":"https","host":["go2","vhdmedia","se"],"path":["platform","1","blocklists"],"query":[{"key":"channel","value":"NOPE"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Bad request\",\n \"validationErrors\": {\n \"channel\": [\n \"unsupported channel\"\n ]\n }\n }\n }\n}"},{"id":"945e03cb-fe06-4ba0-9503-61ec5f0d26f7","name":"Unauthorized - invalid API key","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/platform/1/blocklists"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Invalid login details\"\n }\n }\n}"},{"id":"6f1beb73-bd9d-4788-891f-6d282a925bb5","name":"Too many requests","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://go2.vhdmedia.se/platform/1/blocklists"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"}],"_postman_id":"2ba114c4-5380-409b-a26a-511ff6a3a6b6"},{"name":"Create blocklists","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","// The Blocklist API allows 1 request per second, so wait a moment before each request.","pause(1300, function () {});"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests for Create blocklists. The request is processed asynchronously, so a successful call returns 202 with no body.","pm.test(\"Status code is 202\", function () { pm.response.to.have.status(202); });","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","pm.test(\"Request body lists at least one destination\", function () {"," var body = JSON.parse(pm.request.body.raw);"," pm.expect(body.blocklist).to.be.an('array').with.lengthOf.at.least(1);"," body.blocklist.forEach(function (b) {"," pm.expect(b.destinations).to.be.an('array').with.lengthOf.at.least(1);"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"ae75471c-b1ed-462f-b3ed-212ba918da64","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"blocklist\": [\n {\n \"destinations\": [\n {\n \"to\": \"46731234567\"\n }\n ],\n \"sender\": \"VHD\",\n \"channel\": \"SMS\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/platform/1/blocklists","description":"This method allows you to add destinations to the blocklist, so that no messages are sent to them. Duplicate entries are left out.
\nAUTHORIZATIONS:
\nAPI Key Header, Basic, OAuth 2
\nREQUEST RATE LIMIT:
\n1 request per second (per account). Faster requests return 429 Too Many Requests.
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| blocklist | \nArray | \nRequired. Blocklist elements that need to be blocklisted. Number of destinations cannot exceed 50 000. | \n
\n\n| blocklist[].destinations | \nArray | \nRequired. Destination addresses that need to be blocklisted. | \n
\n\n| blocklist[].destinations[].to | \nString | \nRequired. Destination address that needs to be blocklisted. Addresses must be a number in international format (example: 41793026727), a valid email address (example: recipient@example.com) or valid email domain (example: example.com). | \n
\n\n| blocklist[].sender | \nString | \nThe sender ID for which blocklist happened. | \n
\n\n| blocklist[].channel | \nString | \nChannel used for sending for which blocklist happened. One of: SMS, EMAIL, VIBER, RCS, MMS, WHATSAPP. | \n
\n\n| blocklist[].accountKey | \nString | \nAccount connected with a blocklist record. Main account has access to blocklist records of their subaccounts. Subaccounts can only access blocklist records specific to them. API to retrieve account key. | \n
\n\n
\n
The number of destinations in one request cannot exceed 50 000.
\n\nOn success the response is 202 Accepted with no body. The request is processed asynchronously, so the change can take a moment to show up in Get all blocklists.
\nErrors use the format requestError.serviceException with messageId, text and validationErrors. Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["platform","1","blocklists"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"de3a5b5e-b2ce-4bb5-9ff4-3a98dae272ed","name":"Create blocklists SMS","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"blocklist\": [\n {\n \"destinations\": [\n {\n \"to\": \"46731234567\"\n }\n ],\n \"sender\": \"VHD\",\n \"channel\": \"SMS\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/platform/1/blocklists"},"status":"Accepted","code":202,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"3fe452c3-97e1-40fe-a6ae-ac07224e9914","name":"Create blocklists Email","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"blocklist\": [\n {\n \"destinations\": [\n {\n \"to\": \"jane.smith@vhdmedia.se\"\n }\n ],\n \"sender\": \"example@vhdmedia.eu\",\n \"channel\": \"EMAIL\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/platform/1/blocklists"},"status":"Accepted","code":202,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"05b3a7e8-0ab1-49eb-82e0-9bbaa9fa806c","name":"Bad request - destinations are missing","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"blocklist\": [\n {\n \"destinations\": []\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/platform/1/blocklists"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Bad request\",\n \"validationErrors\": {\n \"blocklist[0].destinations\": [\n \"must not be empty\"\n ]\n }\n }\n }\n}"},{"id":"4a429329-fabc-4b9f-bd3d-4e3681a6d86e","name":"Unauthorized - invalid API key","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"blocklist\": [\n {\n \"destinations\": [\n {\n \"to\": \"46731234567\"\n }\n ],\n \"sender\": \"VHD\",\n \"channel\": \"SMS\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/platform/1/blocklists"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Invalid login details\"\n }\n }\n}"},{"id":"ac03aed4-2237-4fe4-9c58-67fa87af655e","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"blocklist\": [\n {\n \"destinations\": [\n {\n \"to\": \"46731234567\"\n }\n ],\n \"sender\": \"VHD\",\n \"channel\": \"SMS\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/platform/1/blocklists"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"FORBIDDEN\",\n \"text\": \"Forbidden\"\n }\n }\n}"},{"id":"89994146-5afa-4ea8-af1f-7760a2d2f956","name":"Too many requests","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"blocklist\": [\n {\n \"destinations\": [\n {\n \"to\": \"46731234567\"\n }\n ],\n \"sender\": \"VHD\",\n \"channel\": \"SMS\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/platform/1/blocklists"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"5eacdb35-836f-4812-9c94-a3ba164ab947","name":"Internal server error","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"blocklist\": [\n {\n \"destinations\": [\n {\n \"to\": \"46731234567\"\n }\n ],\n \"sender\": \"VHD\",\n \"channel\": \"SMS\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/platform/1/blocklists"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"GENERAL_ERROR\",\n \"text\": \"Something went wrong. Please contact support.\"\n }\n }\n}"}],"_postman_id":"ae75471c-b1ed-462f-b3ed-212ba918da64"},{"name":"Delete Blocklist","event":[{"listen":"prerequest","script":{"exec":["var BASE = \"https://go2.vhdmedia.se\";","var HDR = { \"Authorization\": \"App \" + pm.environment.get(\"API_KEY\"), \"Accept\": \"application/json\", \"Content-Type\": \"application/json\" };","function api(method, path, body, cb) {"," var o = { url: BASE + path, method: method, header: HDR };"," if (body !== undefined && body !== null) { o.body = { mode: \"raw\", raw: JSON.stringify(body) }; }"," pm.sendRequest(o, function (err, res) { cb(err, res); });","}","function jsonOf(res) { try { return res.json(); } catch (e) { return null; } }","function cv(k, v) { if (v === undefined) { return pm.collectionVariables.get(k); } pm.collectionVariables.set(k, v); }","function skip(why) {"," console.warn(\"Skipping: \" + why);"," if (pm.execution && pm.execution.skipRequest) { pm.execution.skipRequest(); }"," else { pm.request.url.update(\"http://localhost:1/skipped\"); }","}","function need() {"," for (var i = 0; i < arguments.length; i++) {"," if (!cv(arguments[i])) { skip(arguments[i] + \" is not set (an earlier step failed or was skipped).\"); return false; }"," }"," return true;","}","function waitUntil(check, tries, delayMs, done) {"," check(function (ok) {"," if (ok || tries <= 0) { done(ok); }"," else { setTimeout(function () { waitUntil(check, tries - 1, delayMs, done); }, delayMs); }"," });","}","function iso(days) {"," var d = new Date(Date.now() + days * 86400000);"," function p(n) { return (\"0\" + n).slice(-2); }"," return d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\";","}","function pause(ms, then) { setTimeout(then, ms); }","","// The Blocklist API allows 1 request per second, and creating a record is asynchronous:","// wait until the sample record is really on the blocklist before it is deleted.","waitUntil(function (cb) {"," pause(1300, function () {"," api(\"GET\", \"/platform/1/blocklists?destination=46731234567\", null, function (e, r) { cb(((jsonOf(r) || {}).paging || {}).totalResults > 0); });"," });","}, 10, 1000, function () { pause(1400, function () {}); });"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"exec":["// Tests for Delete Blocklist. The request is processed asynchronously, so a successful call returns 202 with no body.","pm.test(\"Status code is 202\", function () { pm.response.to.have.status(202); });","","pm.test(\"Response time is below 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(5000);","});","","pm.test(\"Request body lists at least one destination\", function () {"," var body = JSON.parse(pm.request.body.raw);"," pm.expect(body.blocklist).to.be.an('array').with.lengthOf.at.least(1);"," body.blocklist.forEach(function (b) {"," pm.expect(b.destinations).to.be.an('array').with.lengthOf.at.least(1);"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"73786208-9b2c-44e2-8d44-c01e6622183d","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"blocklist\": [\n {\n \"destinations\": [\n {\n \"to\": \"46731234567\"\n }\n ],\n \"sender\": \"VHD\",\n \"channel\": \"SMS\",\n \"sourceType\": \"CUSTOM\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/platform/1/blocklists","description":"This method allows you to remove destinations from the blocklist.
\nAUTHORIZATIONS:
\nAPI Key Header, Basic, OAuth 2
\nREQUEST RATE LIMIT:
\n1 request per second (per account). Faster requests return 429 Too Many Requests.
\nRequest body schema
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| blocklist | \nArray | \nRequired. Blocklist elements that need to be removed from blocklist. Number of destinations cannot exceed 50 000. | \n
\n\n| blocklist[].destinations | \nArray | \nRequired. Destination addresses that need to be removed from blocklist. | \n
\n\n| blocklist[].destinations[].to | \nString | \nRequired. Destination address that needs to be removed from blocklist. Addresses must be a number in international format (example: 41793026727), a valid email address (example: recipient@example.com) or valid email domain (example: example.com). | \n
\n\n| blocklist[].sender | \nString | \nThe sender ID that needs to be removed from blocklist. Sender can be alphanumeric or numeric. | \n
\n\n| blocklist[].channel | \nString | \nChannel for which blocklist record/s will be removed. One of: SMS, EMAIL, VIBER, RCS, MMS, APPLE_MB, WHATSAPP. | \n
\n\n| blocklist[].accountKey | \nString | \nAccount for which blocklist record/s will be removed. Main account can remove blocklist record/s for their subaccounts. Subaccounts can remove blocklist record/s specific to them. API to retrieve account key. | \n
\n\n| blocklist[].sourceType | \nString | \nRepresents the way blocklist record was created: CUSTOM - blocklist record that was created manually MO - blocklist record automatically created once an end user unsubscribes by replying with a specific keyword (e.g.: STOP). This is applicable for the following channels: SMS, MMS. URL_OPT_OUT - blocklist record automatically created once an end user clicks an opt-out link included in the message. CAMPAIGN - blocklist record automatically created through a triggered event in the Flow (e.g., if the message was not opened in 24h, add to blocklist). If source type is omitted while deleting, all blocklists that match delete request will be deleted regardless of the source type. One of: CUSTOM, MO, URL_OPT_OUT, CAMPAIGN. | \n
\n\n
\n
The number of destinations in one request cannot exceed 50 000.
\n\nOn success the response is 202 Accepted with no body. The request is processed asynchronously, so the change can take a moment to show up in Get all blocklists.
\n\nList every property of the record. To delete a record you must send all the properties it was created with. For example, a record created with sender VHD, destination 46731234567, sourceType CUSTOM and channel SMS is removed with {\"blocklist\": [{\"destinations\": [{\"to\": \"46731234567\"}], \"sender\": \"VHD\", \"channel\": \"SMS\", \"sourceType\": \"CUSTOM\"}]}. The record is removed only when all of its properties are listed.
\n
\nErrors use the format requestError.serviceException with messageId, text and validationErrors. Status codes: 400 bad request, 401 missing or invalid credentials, 403 insufficient permissions, 429 too many requests, 500 server error.
\n","urlObject":{"protocol":"https","path":["platform","1","blocklists"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"87f7175e-b2ec-458b-be63-f2ad7a673197","name":"Delete Blocklist SMS","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"blocklist\": [\n {\n \"destinations\": [\n {\n \"to\": \"46731234567\"\n }\n ],\n \"sender\": \"VHD\",\n \"channel\": \"SMS\",\n \"sourceType\": \"CUSTOM\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/platform/1/blocklists"},"status":"Accepted","code":202,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"8c69f078-e2ee-497c-8b94-43cf5e8e7a6f","name":"Delete Blocklist Email","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"blocklist\": [\n {\n \"destinations\": [\n {\n \"to\": \"jane.smith@vhdmedia.se\"\n }\n ],\n \"sender\": \"example@vhdmedia.eu\",\n \"channel\": \"EMAIL\",\n \"sourceType\": \"CUSTOM\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/platform/1/blocklists"},"status":"Accepted","code":202,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"48eb5892-5df4-4b6a-a51e-bc4860ed3142","name":"Bad request - destinations are missing","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"blocklist\": [\n {\n \"destinations\": []\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/platform/1/blocklists"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Bad request\",\n \"validationErrors\": {\n \"blocklist[0].destinations\": [\n \"must not be empty\"\n ]\n }\n }\n }\n}"},{"id":"b4bc9a4a-1098-465d-b346-8084e5a2f4e2","name":"Unauthorized - invalid API key","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"blocklist\": [\n {\n \"destinations\": [\n {\n \"to\": \"46731234567\"\n }\n ],\n \"sender\": \"VHD\",\n \"channel\": \"SMS\",\n \"sourceType\": \"CUSTOM\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/platform/1/blocklists"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Invalid login details\"\n }\n }\n}"},{"id":"be251eee-1eda-4a19-ba26-507c72637902","name":"Too many requests","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"blocklist\": [\n {\n \"destinations\": [\n {\n \"to\": \"46731234567\"\n }\n ],\n \"sender\": \"VHD\",\n \"channel\": \"SMS\",\n \"sourceType\": \"CUSTOM\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/platform/1/blocklists"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"}],"_postman_id":"73786208-9b2c-44e2-8d44-c01e6622183d"}],"id":"f55c8381-0d19-4bac-8b3b-9c32a051d8ba","description":"Phone numbers and email addresses (referred to as destinations) that no longer want to be contacted are stored inside a Blocklist (also known as Do Not Contact List)
\nThis platform feature is used to make sure that no communication is sent to recipients who have opted out of your communication campaigns.
\nWith the Blocklist API, you are able to programmatically manage and track the list of recipients who want to stop receiving communication from your company while remaining compliant with important personal data regulations, such as GDPR.
\nRequests to the Blocklist API are limited to 1 per second per account. Creating and deleting records is asynchronous: the API answers 202 Accepted and applies the change shortly afterwards.
\n\nRunning these requests. They run in order: get, create, delete. Each request waits briefly because of the rate limit, and the delete waits until the sample record exists, so you can run the folder again and again. The sample record (46731234567) is removed at the end.
\n
\n","_postman_id":"f55c8381-0d19-4bac-8b3b-9c32a051d8ba"},{"name":"ACCOUNTS","item":[{"name":"Get current accounts","event":[{"listen":"test","script":{"exec":["// Test if the response status code is 200","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","// Parse the response body as JSON","var responseBody;","try {"," responseBody = pm.response.json();","} catch (error) {"," pm.test(\"Response body is valid JSON\", function () {"," pm.expect.fail(\"Response body is not valid JSON: \" + error);"," });","}","","// Test if the response is an object","pm.test(\"Response is a JSON object\", function () {"," pm.expect(responseBody).to.be.an('object');","});","","// Test if 'enabled' property exists and is a boolean","pm.test(\"'enabled' property exists and is a boolean\", function () {"," pm.expect(responseBody).to.have.property('enabled').that.is.a('boolean');","});","","// Test if 'key' property exists and is a string","pm.test(\"'key' property exists and is a string\", function () {"," pm.expect(responseBody).to.have.property('key').that.is.a('string');","});","","// Test if 'name' property exists and is a string, and does not exceed 150 characters","pm.test(\"'name' property exists and is a string with max length of 150 characters\", function () {"," pm.expect(responseBody).to.have.property('name').that.is.a('string');"," pm.expect(responseBody.name).to.have.lengthOf.at.most(150);","});","","","","// Log the response body for debugging purposes","console.log(\"Response Body:\", responseBody);",""],"type":"text/javascript","packages":{}}}],"id":"bccf6a4e-1bb4-4e09-a377-bdfff87fb329","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://go2.vhdmedia.se/settings/1/accounts/_","description":"Get details of the account that owns the API key used for the request. Use it to check that your key is valid and which account it belongs to.
\n\nOn success the response is 200 OK.
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| key | \nString | \nUnique key of the account. | \n
\n\n| ownerKey | \nString | \nKey of the account that owns this account. | \n
\n\n| name | \nString | \nName of the account. Up to 150 characters. | \n
\n\n| enabled | \nBoolean | \nWhether the account is enabled. | \n
\n\n
\n
If the key is missing or invalid you receive 401 Unauthorized.
\n","urlObject":{"protocol":"https","path":["settings","1","accounts","_"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"3249ff63-bf16-4829-970b-cc9a5026bc36","name":"Get current account","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://go2.vhdmedia.se/settings/1/accounts/_"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"vary","value":"Access-Control-Request-Method"},{"key":"vary","value":"Access-Control-Request-Headers"},{"key":"date","value":"Wed, 31 Jan 2024 16:57:23 GMT"},{"key":"content-type","value":"application/json;charset=utf-8"},{"key":"x-http2-stream-id","value":"3"},{"key":"server","value":"SMS API"},{"key":"transfer-encoding","value":"chunked"},{"key":"x-request-id","value":"1706720243926920663"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": \"90D1D1EB0272BE71B1C7924926E33F0A\",\n \"ownerKey\": \"40B82F5D1DC3C58B78826EAEAA1AB36D\",\n \"name\": \"VHD\",\n \"enabled\": true\n}"}],"_postman_id":"bccf6a4e-1bb4-4e09-a377-bdfff87fb329"}],"id":"d72c74b2-381f-42ee-8d73-54a9b1dd5e9a","description":"Manage your VHD account details
\n","_postman_id":"d72c74b2-381f-42ee-8d73-54a9b1dd5e9a"},{"name":"SMPP SPECIFICATION","item":[],"id":"2c64d453-2e5f-4b87-b600-e24e126a8f18","description":"The Short Message Peer-to-Peer (SMPP) is an open, industry-standard protocol used by the telecommunication industry for exchanging SMS messages between SMS application systems and Short Message Service Centers (SMSC).
\nThe connection between the application and the VHD SMPP server is SMPP version 3.4 (versions 3.3 and 5.0 are not supported).
\nSupported SMPP Features
\nBind Parameters
\nNOTE
\nIf your SMPP environment supports only passwords up to 8 characters (SMPP v3.4 standard), contact our Support team to decrease the password strength policy on your account.
\n\n\n\n| Name | \nMandatory | \nDescription | \n
\n\n\n\n| system_id | \nYes | \nProvided for each client. | \n
\n\n| password | \nYes | \nProvided for each client. | \n
\n\n| IP address | \nYes | \nContact support@vhdmedia.se. | \n
\n\n| port | \nYes | \n8888 (primary and secondary)
8887 (SSL) | \n
\n\ntimeout
(keep alive or msg) | \nYes | \n30 sec | \n
\n\n| system_type | \nNo | \n | \n
\n\n
\n
IMPORTANT
\nYou are allowed to bind as a transmitter, receiver or a transceiver. To receive delivery reports, you must bind as a transceiver or a receiver.
\nYou’ll receive delivery reports only if your route provides delivery reporting. Delivery reports will be sent equally over all of your currently available sessions capable of receiving them (transceiver or receiver).
\nBy default, you are allowed to bind with 4 sessions. There is no other throughput (TPS) limitations besides internet speed.
\nPDU Types
\n\n- bind_transmitter
\n- bind_receiver
\n- bind_transceiver
\n- unbind
\n- submit_sm
\n- deliver_sm
\n- enquire_link
\n
\nData Coding Schemes
\nSetting DCS to 0 or 1 will apply the IA5 / GSM7 coding scheme to the message (GSM7 being the default VHD SMSC alphabet).
\nSet DCS = 3 for Latin1 (ISO-8859-1), and DCS = 8 for sending messages as Unicode / UCS-2 (ISO/IEC-10646).
\nScheduled Delivery
\nScheduled delivery is supported over the SMPP protocol using relative time format.
\n070605040302100R
\nFor example, that would would mean that the message will be delivered in 7 years, 6 months, 5 days, 4 hours, 3 minutes, 2 seconds and 1 tenth of a second from now.
\nCommand Status
\nEach request to our system will receive an acknowledgement as per SMPP v 3.4 standard, including command_status. Most relevant command statuses, including VHD-specific ones, are in the table below:
\n\n\n\n| command_status | \nPDU | \nDescription | \n
\n\n\n\n| 0x0000000E | \nbind_resp | \nInvalid credentials | \n
\n\n| 0x00000022 / 34 | \nsubmit_sm_resp | \nNetwork not covered | \n
\n\n| 0x000000FF / 255 | \nsubmit_sm_resp | \nAccount has insufficient balance | \n
\n\n| 0x0000000a | \nsubmit_sm_resp | \nInvalid source address | \n
\n\n| 0x0000000b | \nsubmit_sm_resp | \nInvalid destination address | \n
\n\n| 0x0000000c | \nsubmit_sm_resp | \nDuplicate or invalid messageID | \n
\n\n| 0x000004a1 | \nsubmit_sm_resp | \nSystem error or channel disabled | \n
\n\n| 0x0000009F | \nsubmit_sm_resp | \nInvalid optional parameter length | \n
\n\n
\n
Delivery report in this format will be returned in short message field of deliver_sm PDU:
\nid:{message_id} sub:{message_sub} dlvrd:{message_dlvrd}
\nsubmit date:{message_submit_date} done date:{message_done_date}
\nstat:{message_stat} err:{message_err}
\nDelivery Statuses
\n\nDELIVRDEXPIREDUNDELIVACCEPTDUNKNOWNENROUTEREJECTD
\nGSM Error Codes
\nGSM error codes are returned in DLRs and explain the status of the message (whether intermediate or final). Error code will be returned in the short_message as a part of delivery information, or (if enabled by VHD) in Optional TLV 0x423.
\nPossible error codes.
\n","_postman_id":"2c64d453-2e5f-4b87-b600-e24e126a8f18"},{"name":"RESPONSE STATUS AND ERROR CODES","item":[{"name":"Email status codes","item":[],"id":"c71c1b77-9a06-4f55-b063-0119922b6af9","description":"REJECTED (group id: 5) - Email status codes
\nThe email has been received but has either been rejected by VHD or the operator has reverted to rejected as the final status.
\n\n\n\n| ID | \nStatus | \n
\n\n\n\n| 75 | \nREJECTED_FREE_TRIAL_EXCEEDED This status code is returned by the API when a user's free trial has been exceeded. It means that the user has exceeded the allowed number of messages or other usage limits during the trial period and must upgrade to their plan to continue using the service. | \n
\n\n| 88 | \nREJECTED_DATA_TRANSFORMATION_FAILED This status code is returned by the API when there is an error in the data transformation process while creating the data needed to proceed with sending a mail. The error can be caused by the placeholder size exceeding limits, or data failing to parse, for example, custom headers. | \n
\n\n| 89 | \nREJECTED_INTERNAL_ERROR This status code is returned by the API when there is an internal error with the system processing a message. It is set when a message goes over the limit of retries or when internal data fails to parse. | \n
\n\n| 90 | \nREJECTED_VALIDATION_FAILED This status code is returned by the API when a validation check fails during the message processing. The validation error can be caused by issues such as an invalid sender, an invalid landing page, invalid preserved recipients, a missing template, and so on. | \n
\n\n
\n
Every HTTP transaction has a status code sent back by the server to define how the server has handled the transaction. The most common statuses you may encounter are 200 OK, 404 Not Found, or 401 Unauthorized.
\nCheck out the list of the HTTP status codes to learn more.
\n","_postman_id":"51b4c2c5-98cb-4b1d-adcb-006fd2ca0fa3"},{"name":"API status code","item":[],"id":"bd8c0602-1d74-4517-84b4-09598c2dbff1","description":"Besides standard HTTP status code, status object may be returned as part of the API response message, delivery report or message log.
\nStatus object example:
\nJSON
\n{ \n \"groupId\":3,\n \"groupName\":\"DELIVERED\",\n \"id\":5,\n \"name\":\"DELIVERED_TO_HANDSET\",\n \"description\":\"Message delivered to handset\"\n}\n\n
","_postman_id":"bd8c0602-1d74-4517-84b4-09598c2dbff1"},{"name":"GENERAL status code","item":[],"id":"ca2e7f15-53f4-4373-ba1a-ae780bd01bff","description":"PENDING (group id: 1) - general status codes
\nMessage has been processed and sent to the next instance i.e. mobile operator.
\n\n\n\n| Id | \nStatus | \n
\n\n\n\n| 3 | \nPENDING_WAITING_DELIVERY
- Message has been processed and sent to the next instance i.e. mobile operator with request acknowledgment from their platform. Delivery report has not yet been received, and is awaited thus the status is still pending. | \n
\n\n| 7 | \nPENDING_ENROUTE
- Message has been processed and sent to the next instance i.e. mobile operator. | \n
\n\n| 26 | \nPENDING_ACCEPTED
- Message has been accepted and processed, and is ready to be sent to the next instance i.e. operator. | \n
\n\n
\n
UNDELIVERABLE (group id: 2) - general status codes
\nMessage has not been delivered.
\n\n\n\n| Id | \nStatus | \n
\n\n\n\n| 4 | \nUNDELIVERABLE_REJECTED_OPERATOR
- Message has been sent to the operator, whereas the request was rejected, or a delivery report with status \"REJECTED\" was reverted. | \n
\n\n| 9 | \nUNDELIVERABLE_NOT_DELIVERED
- Message has been sent to the operator, but has failed to deliver, since a delivery report with status \"UNDELIVERED\" was reverted from the operator. | \n
\n\n
\n
DELIVERED (group id: 3) - general status codes
\nMessage has successfully been processed and delivered.
\n\n\n\n| Id | \nStatus | \n
\n\n\n\n| 2 | \nDELIVERED_TO_OPERATOR
- Message has been successfully sent and delivered to the operator. | \n
\n\n| 5 | \nDELIVERED_TO_HANDSET
- Message has been successfully processed and delivered to recipient. | \n
\n\n
\n
EXPIRED (group id: 4) - general status codes
\nMessage has been sent, and has either expired due to being pending past its validity period (our platform default is 48 hours), or the delivery report from the operator has reverted the expired as a final status.
\n\n\n\n| Id | \nStatus | \n
\n\n\n\n| 15 | \nEXPIRED_EXPIRED
- The message was received and sent to the operator, however it has been pending until the validity period has expired, or the operator returned EXPIRED status in the meantime. | \n
\n\n| 29 | \nEXPIRED_DLR_UNKNOWN
- The message has been received and forwarded to the operator for delivery, however the delivery report from the operator has not been formatted correctly, or has not been recognized as valid. | \n
\n\n
\n
REJECTED (group id: 5) - general status codes
\nMessage has been received, but has either been rejected by our system, or the operator has reverted Rejected as final status.
\n\n\n\n| ID | \nStatus | \n
\n\n\n\n| 6 | \nREJECTED_NETWORK Message has been received, but the network is either out of our coverage or is not set up on your account. Your Account Manager can inform you about the coverage status or set up the network in question. | \n
\n\n| 8 | \nREJECTED_PREFIX_MISSING Message has been received but rejected as the number is not recognized due to an incorrect number prefix or length. This information is different for each network and is regularly updated. | \n
\n\n| 10 | \nREJECTED_DND Message has been received and rejected because the user is subscribed to DND (Do Not Disturb) services, disabling any service traffic to their number. | \n
\n\n| 11 | \nREJECTED_SOURCE Your account is set to accept only registered sender IDs, and the sender ID defined in the request has not been registered on your account. | \n
\n\n| 12 | \nREJECTED_NOT_ENOUGH_CREDITS Your account is out of credits for further submission. Top up your account. | \n
\n\n| 13 | \nREJECTED_SENDER The sender ID has been blocklisted on your account. Remove the blocklist on your account or contact support for further assistance. | \n
\n\n| 14 | \nREJECTED_DESTINATION_BLOCKLISTED The destination address has been blocklisted either at the operator's request or on your account via the web interface. Remove the blocklist on your account via the VHD web interface(opens in a new tab) or contact support for more information. | \n
\n\n| 17 | \nREJECTED_PREPAID_PACKAGE_EXPIRED Account credits are past their validity period. Top up your sub-account with credits to extend the validity period. | \n
\n\n| 18 | \nREJECTED_DESTINATION_NOT_REGISTERED Your account has been set up for submission only to a single number for testing purposes. Contact your account manager. | \n
\n\n| 19 | \nREJECTED_ROUTE_NOT_AVAILABLE Message has been received on the system. However, your account has not been set up to send messages, that is, no routes on your account are available for further submission. | \n
\n\n| 20 | \nREJECTED_FLOODING_FILTER Message has been rejected due to an anti-flooding mechanism. By default, a single number can only receive 20 varied and 6 identical messages per hour. If a requirement exists, the limitation can be extended per account on request to your account manager. | \n
\n\n| 21 | \nREJECTED_SYSTEM_ERROR The request has been rejected due to an expected system error. Retry the submission or contact our Technical Support team for more details. | \n
\n\n| 23 | \nREJECTED_DUPLICATE_MESSAGE_ID The request has been rejected due to a duplicate message ID specified in the submit request; the message IDs should be a unique value. | \n
\n\n| 24 | \nREJECTED_INVALID_UDH
Message has been received and our system detected the message was formatted incorrectly because of either an invalid ESM class parameter (fully featured binary message API method) or an inaccurate amount of characters when using esmclass:64 (UDH). For more information, visit the articles below or contact our support team for clarification.
User Data Header
Concatenated SMS | \n
\n\n| 25 | \nREJECTED_MESSAGE_TOO_LONG Message has been received, but the total message length is more than 25 parts, or the message text exceeds 4000 bytes as per our system limitation. | \n
\n\n| 51 | \nMISSING_TO The request has been received, but the to parameter has not been set, or it is empty, that is, there must be a valid recipient to send the message to. | \n
\n\n| 52 | \nREJECTED_DESTINATION The request has been received, but the destination is invalid—the number prefix is incorrect as it does not match a valid number prefix by any mobile operator. Number length is also taken into consideration when verifying number validity. | \n
\n\n| 87 | \nSIGNALS_BLOCKED Message has been rejected due to an anti-fraud mechanism. If the message is deemed fraudulent, it will not be charged. | \n
\n\n| 99 | \nREJECTED The call was rejected/declined by the end user at the receiving end. | \n
\n\n| 100 | \nUNDELIVERABLE_REJECTED_PLATFORM The request was rejected due to being invalid, malformed, or because the service is temporarily unavailable. Review the request parameters and structure, and try again when the service is accessible. | \n
\n\n
\n
REJECTED (group id: 5) - voice status codes
\nMessage has been received, but has either been rejected by our system, or the operator has reverted the rejected as final status.
\n\n\n\n| Id | \nStatus | \n
\n\n\n\n| 53 | \nREJECTED_INVALID_AUDIO_FILE_URL
- The URL of audio file is invalid and could not be read properly. | \n
\n\n| 54 | \nREJECTED_UNSUPPORTED_LANGUAGE
- The language submitted within the request is not supported and request couldn't be processed correctly. | \n
\n\n| 55 | \nREJECTED_MESSAGE_IS_EMPTY
- Native to Voice services, this status is returned in case there is no text sent in your Voice message request. | \n
\n\n| 56 | \nREJECTED_INVALID_NOTIFY_URL
- Native to Voice services, this status is returned in case the notifyUrl parameter is not formatter properly. Please revisit the documentation for voice messages in this collection. | \n
\n\n| 57 | \nREJECTED_INVALID_NOTIFY_CONTENT_TYPE
- Native to Voice services, this status is returned in case the notifyContentType parameter is not formatter properly. Please revisit the documentation for voice messages in this collection. | \n
\n\n| 58 | \nREJECTED_INVALID_DTMF_SIGN
- Defined value for repeating message is invalid and must be positive number. | \n
\n\n| 59 | \nREJECTED_INVALID_DTMF_TIMEOUT
- Defined value for the waiting period is invalid and must be positive number. | \n
\n\n| 60 | \nREJECTED_INVALID_RING_TIMEOUT
- Defined value for duration of call is invalid and must be positive number. | \n
\n\n| 61 | \nREJECTED_INVALID_CALL_TIMEOUT
- Defined value for total period of call is invalid and must be positive number. | \n
\n\n| 62 | \nREJECTED_INVALID_MACHINE_DETECTION
- The action which attempts to detect answering machines at the beginning of the call is invalid. | \n
\n\n| 63 | \nREJECTED_INVALID_ACTIONS
- Actions submitted in HTTP API request are invalid. | \n
\n\n| 64 | \nREJECTED_INVALID_ACTION_GROUPS
- Action groups submitted in HTTP API request are invalid. | \n
\n\n| 83 | \nREJECTED_MACHINE_DECTION_DISALBED
Machine detection is not enabled. Contact your dedicated Account manager. | \n
\n\n| 87 | \nREJECTED_INVALID_DELIVERY_TIME_WINDOW
Invalid deliveryTimeWindow. The time gap between from and to cannot be less than 1 hour. | \n
\n\n| 91 | \nREJECTED_INVALID_SSML
Submitted message text contains invalid SSML. | \n
\n\n
\n
Error object can be returned as part of the send message response or Delivery report response.
\nError object example:
\nJSON
\n{ \n \"groupId\":0,\n \"groupName\":\"OK\",\n \"id\":0,\n \"name\":\"NO_ERROR\",\n \"description\":\"No Error\",\n \"permanent\":false\n}\n
","_postman_id":"58bebf83-edfa-4a31-bb93-5f09da4130e9"},{"name":"GENERAL error codes","item":[],"id":"106c8a3b-efd4-42e3-88d7-ff6ccafd0b25","description":"OK (group id: 0) - general error codes
\nThe request has been completed successfully.
\n\n\n\n| ID | \nPermanent | \nError | \n
\n\n\n\n| 0 | \nfalse | \nNO_ERROR
- There is no error description provided. Mostly returned for successful delivery, or when error code was not returned by the operator. | \n
\n\n
\n
HANDSET_ERRORS (group id: 1) - general error codes
\nThe request has not been completed due to handset-related issues.
\n\n\n\n| ID | \nPermanent | \nError | \n
\n\n\n\n| 1 | \ntrue | \nEC_UNKNOWN_SUBSCRIBER
- The number does not exist or it has not been assigned to any active subscriber in the operator’s user database. | \n
\n\n| 2 | \nfalse | \nEC_UNKNOWN_BASE_STATION
Suggests an error involving an unidentified or unrecognized base station, often in the context of network or communication systems. This could be due to a missing or inaccessible base station. | \n
\n\n| 5 | \nfalse | \nEC_UNIDENTIFIED_SUBSCRIBER
- Unidentified Subscriber | \n
\n\n| 6 | \nfalse | \nEC_ABSENT_SUBSCRIBER_SM
- The subscriber is detected unavailable as there was no paging response from the handset. This is often due to the handset being switched off or low signal area. Applies to MAP protocol version 3. | \n
\n\n| 7 | \nfalse | \nEC_UNKNOWN_EQUIPMENT
- The mobile device has not been recognized by EIR (Equipment Identity Register) during device verification on the MAP protocol level at operator’s infrastructure. | \n
\n\n| 8 | \nfalse | \nEC_ROAMING_NOT_ALLOWED
- The subscriber is currently in roaming in another country or other operator’s infrastructure - roaming delivery is not guaranteed due to lack of roaming agreements between many different operators. | \n
\n\n| 9 | \ntrue | \nEC_ILLEGAL_SUBSCRIBER
- Illegal Subscriber | \n
\n\n| 11 | \ntrue | \nEC_TELESERVICE_NOT_PROVISIONED
- The subscriber’s mobile service has been suspended by the operator. | \n
\n\n| 12 | \ntrue | \nEC_ILLEGAL_EQUIPMENT
- Illegal Equipment | \n
\n\n| 13 | \nfalse | \nEC_CALL_BARRED
- Message is rejected due to barring of message service; blocking is set by operator or subscriber for the number. | \n
\n\n| 21 | \nfalse | \nEC_FACILITY_NOT_SUPPORTED
- Facility Not Supported | \n
\n\n| 27 | \nfalse | \nEC_ABSENT_SUBSCRIBER
- The subscriber is offline in the network, as confirmed by the handset’s paging response. This is often due to the handset being switched off. | \n
\n\n| 31 | \nfalse | \nEC_SUBSCRIBER_BUSY_FOR_MT_SMS
- Subscriber Busy For Mt SMS | \n
\n\n| 32 | \nfalse | \nEC_SM_DELIVERY_FAILURE
- SM Delivery Failure | \n
\n\n| 33 | \nfalse | \nEC_MESSAGE_WAITING_LIST_FULL
- Message Waiting List Full | \n
\n\n| 34 | \nfalse | \nEC_SYSTEM_FAILURE
- System Failure | \n
\n\n| 35 | \nfalse | \nEC_DATA_MISSING
- Data Missing | \n
\n\n| 36 | \nfalse | \nEC_UNEXPECTED_DATA_VALUE
- Unexpected Data Value | \n
\n\n| 255 | \nfalse | \nEC_UNKNOWN_ERROR
- Unknown Error | \n
\n\n| 256 | \nfalse | \nEC_SM_DF_MEMORYCAPACITYEXCEEDED
- There has been a mobile subscriber equipment error whereas the handset memory has been exceeded. | \n
\n\n| 257 | \nfalse | \nEC_SM_DF_EQUIPMENTPROTOCOLERROR
- There has been a mobile subscriber equipment error. | \n
\n\n| 258 | \nfalse | \nEC_SM_DF_EQUIPMENTNOTSM_EQUIPPED
- There has been a mobile subscriber equipment error. | \n
\n\n| 259 | \nfalse | \nEC_SM_DF_UNKNOWNSERVICECENTRE
- There has been a mobile subscriber equipment error. | \n
\n\n| 260 | \nfalse | \nEC_SM_DF_SC_CONGESTION
- There has been a mobile subscriber equipment error. | \n
\n\n| 261 | \nfalse | \nEC_SM_DF_INVALIDSME_ADDRESS
- There has been a mobile subscriber equipment error. | \n
\n\n| 262 | \nfalse | \nEC_SM_DF_SUBSCRIBERNOTSC_SUBSCRIBER
- There has been a mobile subscriber equipment error. | \n
\n\n| 500 | \nfalse | \nEC_PROVIDER_GENERAL_ERROR
- General network protocol error caused by incompatible operator network protocol versions or parameters between two network components. | \n
\n\n| 502 | \nfalse | \nEC_NO_RESPONSE
- The message has been successfully processed and forwarded to the operator, but no response was returned from the operator upon the message submit request, or such error was reverted by the operator. The error also applies to similar errors on SS7 network level. | \n
\n\n| 503 | \nfalse | \nEC_SERVICE_COMPLETION_FAILURE
- General network protocol error caused by incompatible operator network protocol versions or parameters between two network components. | \n
\n\n| 504 | \nfalse | \nEC_UNEXPECTED_RESPONSE_FROM_PEER
- General network protocol error caused by incompatible operator network protocol versions or parameters between two network components. | \n
\n\n| 507 | \nfalse | \nEC_MISTYPED_PARAMETER
- General network protocol error caused by incompatible operator network protocol versions or parameters between two network components. | \n
\n\n| 508 | \nfalse | \nEC_NOT_SUPPORTED_SERVICE
- General network protocol error caused by incompatible operator network protocol versions or parameters between two network components. | \n
\n\n| 509 | \nfalse | \nEC_DUPLICATED_INVOKE_ID
- General network protocol error caused by incompatible operator network protocol versions or parameters between two network components. | \n
\n\n| 565 | \ntrue | \nEC_CANNOT_RECEIVE_SC
- End users connected to this MVNO cannot receive Short Code messages. The mobile operator rejected the message as the end user is connected to their network via a mobile virtual network operator (MVNO). This restriction is on Short Code messages. | \n
\n\n| 573 | \ntrue | \nEC_SC_BLOCKED_BY_END_USER
- The end user has asked their mobile operator to block any messages sent from your Short Code. Additional messages from the same Short Code must not be sent to the phone number unless the end user opts in again. | \n
\n\n| 581 | \nfalse | \nEC_USER_OUT_OF_CREDIT
- End user out of prepay credit. The end user does not have enough credit on their phone account to receive the message. Message sending can be retried every 24 hours for no more than seven days. | \n
\n\n| 628 | \ntrue | \nEC_TEMPORARY_HANDSET_FAILURE
- Temporary handset failure. | \n
\n\n| 629 | \ntrue | \nEC_DEST_ADDRESS_UNABLE_TO_RECEIVE_SMS
- Destination address unable to receive SMS. | \n
\n\n| 1024 | \nfalse | \nEC_OR_APPCONTEXTNOTSUPPORTED
- General network protocol error caused by incompatible operator network protocol versions or parameters between two network components. | \n
\n\n| 1025 | \nfalse | \nEC_OR_INVALIDDESTINATIONREFERENCE
- General network protocol error caused by incompatible operator network protocol versions or parameters between two network components. | \n
\n\n| 1026 | \nfalse | \nEC_OR_INVALIDORIGINATINGREFERENCE
- General network protocol error caused by incompatible operator network protocol versions or parameters between two network components. | \n
\n\n| 1027 | \nfalse | \nEC_OR_ENCAPSULATEDAC_NOTSUPPORTED
- General network protocol error caused by incompatible operator network protocol versions or parameters between two network components. | \n
\n\n| 1028 | \nfalse | \nEC_OR_TRANSPORTPROTECTIONNOTADEQUATE
- General network protocol error caused by incompatible operator network protocol versions or parameters between two network components. | \n
\n\n| 1029 | \nfalse | \nEC_OR_NOREASONGIVEN
- General network protocol error caused by incompatible operator network protocol versions or parameters between two network components. | \n
\n\n| 1030 | \nfalse | \nEC_OR_POTENTIALVERSIONINCOMPATIBILITY
- General network protocol error caused by incompatible operator network protocol versions or parameters between two network components. | \n
\n\n| 1031 | \nfalse | \nEC_OR_REMOTENODENOTREACHABLE
- Mobile subscriber was not reachable due to a network operator protocol error. | \n
\n\n| 1152 | \nfalse | \nEC_NNR_NOTRANSLATIONFORANADDRESSOFSUCHNATURE
- Mobile subscriber was not reachable due to a network operator protocol error. | \n
\n\n| 1153 | \nfalse | \nEC_NNR_NOTRANSLATIONFORTHISSPECIFICADDRESS
- No Translation For This Specific Address | \n
\n\n| 1154 | \nfalse | \nEC_NNR_SUBSYSTEMCONGESTION
- Mobile subscriber was not reachable due to a network operator protocol error. | \n
\n\n| 1155 | \nfalse | \nEC_NNR_SUBSYSTEMFAILURE
- Mobile subscriber was not reachable due to a network operator protocol error. | \n
\n\n| 1156 | \nfalse | \nEC_NNR_UNEQUIPPEDUSER
- Mobile subscriber was not reachable due to a network operator protocol error. | \n
\n\n| 1157 | \nfalse | \nEC_NNR_MTPFAILURE
- Mobile subscriber was not reachable due to a network operator protocol error. | \n
\n\n| 1158 | \nfalse | \nEC_NNR_NETWORKCONGESTION
- Mobile subscriber was not reachable due to a network operator protocol error. | \n
\n\n| 1159 | \nfalse | \nEC_NNR_UNQUALIFIED
- Mobile subscriber was not reachable due to a network operator protocol error. | \n
\n\n| 1160 | \nfalse | \nEC_NNR_ERRORINMESSAGETRANSPORTXUDT
- Mobile subscriber was not reachable due to a network operator protocol error. | \n
\n\n| 1161 | \nfalse | \nEC_NNR_ERRORINLOCALPROCESSINGXUDT
- Mobile subscriber was not reachable due to a network operator protocol error. | \n
\n\n| 1162 | \nfalse | \nEC_NNR_DESTINATIONCANNOTPERFORMREASSEMBLYXUDT
- Mobile subscriber was not reachable due to a network operator protocol error. | \n
\n\n| 1163 | \nfalse | \nEC_NNR_SCCPFAILURE
- Mobile subscriber was not reachable due to a network operator protocol error. | \n
\n\n| 1164 | \nfalse | \nEC_NNR_HOPCOUNTERVIOLATION
- Mobile subscriber was not reachable due to a network operator protocol error. | \n
\n\n| 1165 | \nfalse | \nEC_NNR_SEGMENTATIONNOTSUPPORTED
- Mobile subscriber was not reachable due to a network operator protocol error. | \n
\n\n| 1166 | \nfalse | \nEC_NNR_SEGMENTATIONFAILURE
- Mobile subscriber was not reachable due to a network operator protocol error. | \n
\n\n| 1281 | \nfalse | \nEC_UA_USERSPECIFICREASON
- Message was aborted by network peer because of a network protocol error. | \n
\n\n| 1282 | \nfalse | \nEC_UA_USERRESOURCELIMITATION
- Message was aborted by network peer because of a network protocol error. | \n
\n\n| 1283 | \nfalse | \nEC_UA_RESOURCEUNAVAILABLE
- Message was aborted by network peer because of a network protocol error. | \n
\n\n| 1284 | \nfalse | \nEC_UA_APPLICATIONPROCEDURECANCELLATION
- Message was aborted by network peer because of a network protocol error. | \n
\n\n| 1536 | \nfalse | \nEC_PA_PROVIDERMALFUNCTION
- Message was aborted due to other network protocol errors. | \n
\n\n| 1537 | \nfalse | \nEC_PA_SUPPORTINGDIALOGORTRANSACTIONREALEASED
- Message was aborted due to other network protocol errors. | \n
\n\n| 1538 | \nfalse | \nEC_PA_RESSOURCELIMITATION
- Message was aborted due to other network protocol errors. | \n
\n\n| 1539 | \nfalse | \nEC_PA_MAINTENANCEACTIVITY
- Message was aborted due to other network protocol errors. | \n
\n\n| 1540 | \nfalse | \nEC_PA_VERSIONINCOMPATIBILITY
- Message was aborted due to other network protocol errors. | \n
\n\n| 1541 | \nfalse | \nEC_PA_ABNORMALMAPDIALOG
- Message was aborted due to other network protocol errors. | \n
\n\n| 1792 | \nfalse | \nEC_NC_ABNORMALEVENTDETECTEDBYPEER
- Message was aborted due to other network protocol errors. | \n
\n\n| 1793 | \nfalse | \nEC_NC_RESPONSEREJECTEDBYPEER
- Message was aborted due to other network protocol errors. | \n
\n\n| 1794 | \nfalse | \nEC_NC_ABNORMALEVENTRECEIVEDFROMPEER
- Message was aborted due to other network protocol errors. | \n
\n\n| 1795 | \nfalse | \nEC_NC_MESSAGECANNOTBEDELIVEREDTOPEER
- Message was aborted due to other network protocol errors. | \n
\n\n| 1796 | \nfalse | \nEC_NC_PROVIDEROUTOFINVOKE
- Message was aborted due to other network protocol errors. | \n
\n\n
\n
USER_ERRORS (group id: 2) - general error codes
\nUser error occurred.
\n\n\n\n| ID | \nPermanent | \nError | \n
\n\n\n\n| 323 | \ntrue | \nEC_INVALID_REQUEST_TYPE
- The request type was invalid. | \n
\n\n| 351 | \nfalse | \nEC_INVALID_DESTINATION_ADDRESS
- Invalid destination address. Possible reasons for receiving this error for the following mobile operators might be:
Any operator:
-The mobile number is not on the mobile operator's network.
-The mobile number has been deactivated.
T-Mobile and MetroPCS:
-The phone number belongs to a prepaid user who does not have enough credit to receive a message.
T-Mobile:
-The end user is not provisioned to receive a message from all short codes (or from specific short codes).
-The end user is on an MVNO connected via T-Mobile.
-T-Mobile does not deliver messages from short codes to end users on MVNOs.
AT&T (US):
- The phone number belongs to a prepaid user who does not have enough credit to receive a message, the phone number is not provisioned for any messages, or the phone number could be blocked due to a spam complaint. | \n
\n\n| 352 | \ntrue | \nEC_INVALID_REQUEST_DESTINATION
- Invalid request - destination address country code is not recognized. | \n
\n\n| 355 | \ntrue | \nEC_MSG_TEXT_TOO_LONG
- Message text is too long. | \n
\n\n| 368 | \ntrue | \nEC_INVALID_SOURCE_ADDRESS
- Invalid source address value. The mobile operator rejected the message with an invalid MT source address error. Contact your account manager to determine if your MT source address should be supported by the end user's mobile operator. | \n
\n\n| 375 | \ntrue | \nEC_SOURCE_ADDRESS_IS_BLOCKED
- Source address (recipient) is blocked or is not provisioned. | \n
\n\n| 433 | \ntrue | \nEC_ACCOUNT_ACCESS_DENIED
- Account access denied. | \n
\n\n| 488 | \ntrue | \nEC_TF_NUMBER_NOT_VERIFIED
- ''Toll-Free Number Not Verified'' which indicates that the number has either gone over the limit or they are trying to send to Canada and the number is not verified. Contact your account manager to get the TFN verified. | \n
\n\n| 541 | \nfalse | \nEC_LIMIT_REACHED
- Carrier sending limit has been reached. The message was blocked by AT&T because the TPS (transactions per second) limit on your messaging campaign has been exceeded. | \n
\n\n| 542 | \nfalse | \nEC_QUOTA_REACHED
- Carrier daily quota reached. The message was blocked by T-Mobile because the daily volume limit for your brand has been exceeded. You cannot resend the message until the next day. | \n
\n\n| 572 | \ntrue | \nEC_CAMPAIGNID_NOT_PROVISIONED
- Program ID or campaign ID is not provisioned for this mobile operator or is not active. | \n
\n\n| 577 | \ntrue | \nEC_ACC_NOT_PROVISIONED_TO_SMS_DEMO_SC
- Account not provisioned to use SMS demo short code. | \n
\n\n| 578 | \ntrue | \nEC_EXCEEDED_THE_TIME_LIMIT_OF_SMS_DEMO
- Exceeded the time limit for using SMS demo. | \n
\n\n| 579 | \ntrue | \nEC_DEST_ADDRESS_NOT_IN_SMS_DEMO
- Destination address not in whitelist for SMS demo. | \n
\n\n| 580 | \ntrue | \nEC_EXCEEDED_THE_MAX_NUMBER
- Exceeded the maximum number of demo requests. | \n
\n\n| 594 | \ntrue | \nEC_INVALID_GLOBAL_CAMPAIGN_ID
- Invalid global campaign ID. | \n
\n\n| 597 | \ntrue | \nEC_ACC_HAS_NO_ADRESS_FOR_DESR
- Account is not provisioned with the address that can reach the destination. | \n
\n\n| 598 | \ntrue | \nEC_INTERACTION_NOT_SUPPORTED
- Interaction not supported for message destination. | \n
\n\n| 601 | \ntrue | \nEC_ACC_NOT_2_WAY
- Account is not provisioned for global two-way SMS. | \n
\n\n| 603 | \ntrue | \nEC_CONTENT_BLOCKED
- Content blocked by user opt-out (MO: STOP). This code can be returned in a delivery receipt for an MT originating from a North American, SMS-enabled toll-free number or an SMS-enabled landline number. Messaging can resume to the end user if the end user opts back in to your program. | \n
\n\n| 604 | \ntrue | \nEC_BLOCKED_BY_CAMPAIGN_BLACKLIST
- Content blocked by campaign blocklist. | \n
\n\n| 607 | \ntrue | \nEC_BLOCKED_AS_SPAM
- This message was identified as spam and cannot be delivered | \n
\n\n| 2049 | \ntrue | \nEC_IMSI_BLACKLISTED
- IMSI blocklisted | \n
\n\n| 2052 | \ntrue | \nEC_BLACKLISTED_DESTINATIONADDRESS
- The destination number has been blocklisted either at the operator`s request or on your account via the VHD web interface. Go to the web interface to remove the blocklist on your account or contact Support for more information. | \n
\n\n| 2053 | \ntrue | \nEC_BLACKLISTED_SENDERADDRESS
- The sender number has been blocklisted either at the operator request or on your account via VHD web interface. Go to the web interface to remove the blocklist on your account or contact Support for more information. | \n
\n\n| 2053 | \ntrue | \nEC_SOURCE_ADDRESS_BLACKLISTED
- Source address is blocklisted on the VHD account. | \n
\n\n| 4096 | \ntrue | \nEC_INVALID_PDU_FORMAT
- Invalid PDU Format | \n
\n\n| 4099 | \ntrue | \nEC_MONTHLY_LIMIT_REACHED
- Your account monthly credit limit has been reached. For further financial assistance, please contact your account manager. | \n
\n\n| 4100 | \ntrue | \nEC_MESSAGE_CANCELED
- The request was received, but has not been sent to the next instance within its validity period and has expired with the appropriate error code EC_MESSAGE_CANCELED, or the same error code was reverted from the operator. | \n
\n\n| 4101 | \ntrue | \nEC_VALIDITYEXPIRED
- The message was sent to the next instance and has not been delivered within the message validity period, thus it has expired with the appropriate error code EC_VALIDITYEXPIRED or the error code was reverted from the operator. | \n
\n\n| 4102 | \ntrue | \nEC_NOTSUBMITTEDTOSMPPCHANNEL
- Inbound SM can not be transferred via SMPP due to the lack of SMPP connectivity. | \n
\n\n| 4103 | \ntrue | \nEC_DESTINATION_FLOODING
- Related to status REJECTED_FLOODING_FILTER, the message is rejected due to the number of messages sent to a single number. | \n
\n\n| 4104 | \ntrue | \nEC_DESTINATION_TXT_FLOODING
- Related to status REJECTED_FLOODING_FILTER, the message is rejected due to the number of identical messages sent to a single number. | \n
\n\n
\n
OPERATOR_ERRORS (group id: 3) - general error codes
\nThe request has not been completed due to operator issues.
\n\n\n\n| ID | \nPermanent | \nError | \n
\n\n\n\n| 10 | \ntrue | \nEC_BEARER_SERVICE_NOT_PROVISIONED
- Bearer Service Not Provisioned | \n
\n\n| 20 | \nfalse | \nEC_SS_INCOMPATIBILITY
- SS Incompatibility | \n
\n\n| 51 | \ntrue | \nEC_RESOURCE_LIMITATION
- Indicates that invoked MAP operation could not be finished due to the network congestion - this is an SS7 network congestion error on the MAP protocol level. | \n
\n\n| 71 | \nfalse | \nEC_UNKNOWN_ALPHABET
- Unknown Alphabet | \n
\n\n| 345 | \ntrue | \nEC_OPERATOR_NOT_FOUND
- Mobile operator not found for the destination address. The service performed a dynamic carrier lookup for the destination address, but it could not be identified; or, the MT source address is not a North American toll-free phone number or landline. | \n
\n\n| 501 | \nfalse | \nEC_INVALID_RESPONSE_RECEIVED
- Invalid Response Received | \n
\n\n| 560 | \ntrue | \nEC_SC_BLOCKED_FOR_END_USER
- Mobile operator blocking the end user from this Short Code | \n
\n\n| 561 | \ntrue | \nEC_CONTENT_BLOCKED_BY_OPERATOR
- Content blocked by mobile operator for this end user. | \n
\n\n| 562 | \ntrue | \nEC_SC_NOT_PROVISIONED
- Short code not provisioned with mobile operator. Contact your dedicated Account Manager if you believe that you are provisioned for the operator or if you want to begin provisioning. | \n
\n\n| 563 | \ntrue | \nEC_SC_EXPIRED
- Short code expired with mobile operator. Contact your dedicated Account Manager if you believe that you are provisioned for the operator or if you want to begin provisioning. | \n
\n\n| 564 | \ntrue | \nEC_SC_BLOCKED
- Short Code blocked by mobile operator. The mobile operator rejected the message as the Short Code is currently blocked from sending messages across their network. Contact your dedicated Account Manager if you are unsure why you received this error. | \n
\n\n| 566 | \ntrue | \nEC_DESTINATION_BLOCKED_BY_OPERATOR
- The mobile operator is blocking the phone number from receiving messages from Short Codes. This is likely due to the end-user's account being suspended or barred in some way. | \n
\n\n| 568 | \ntrue | \nEC_DESTINATION_NOT_SMS_PROVISIONED
- Destination address not provisioned for SMS. | \n
\n\n| 569 | \ntrue | \nEC_DEST_ADDRESS_SUSPENDED
- Destination address suspended by the mobile operator. | \n
\n\n| 571 | \nfalse | \nEC_CAMPAIGN_ID_REJECTED
- Program ID or Campaign ID rejected by mobile operator. This error applies to messages sent to US mobile operators. The error indicates the program ID or campaign ID in the message request is not provisioned with the mobile operator. Contact your dedicated Account Manager if you are unsure why you received this error. | \n
\n\n| 574 | \ntrue | \nEEC_BLOCKED_NEW_SUBSCRIPTIONS_FOR_SC
- New subscriptions for this short code are blocked by the mobile operator. Indicates that for a given Short Code, new subscribers are not allowed to receive or send messages. However, existing subscribers are still allowed to receive and send messages. | \n
\n\n| 630 | \ntrue | \nEC_DEST_OVERLOADED
- Destination overloaded. | \n
\n\n| 631 | \ntrue | \nEC_MOBILE_OPERATOR_NETWORK_ERROR
- Mobile operator network error. | \n
\n\n| 632 | \ntrue | \nEC_SMS_REJECTED_BY_MOBILE_OPERATOR
- SMS rejected by the mobile operator for attempted destination address. | \n
\n\n| 633 | \ntrue | \nEC_UNKNOWN_MOBILE_OPERATOR
- Message failed due to an unknown mobile operator error. | \n
\n\n| 810 | \ntrue | \nEC_FAILED_MESSAGE_DELIVERY
- Failed message delivery. | \n
\n\n| 811 | \ntrue | \nEC_MESSAGE_EXPIRED
- Message expired before it reached handset. | \n
\n\n| 815 | \ntrue | \nEC_MESSAGE_SUBMITTED_NOT_ACKED
- Message submitted to but not acknowledged by the mobile operator. | \n
\n\n| 2048 | \nfalse | \nEC_TIME_OUT
- Time Out | \n
\n\n| 2050 | \ntrue | \nEC_DEST_ADDRESS_BLACKLISTED
- The number was flagged as blocklisted in the DND (Do Not Disturb) blocklist provided by the operator, or the same error code was reverted by the operator. | \n
\n\n| 2051 | \nfalse | \nEC_INVALIDMSCADDRESS
- Text blocklisted | \n
\n\n| 4097 | \nfalse | \nEC_NOTSUBMITTEDTOGMSC
- Not Submitted To GMSC | \n
\n\n| 4102 | \ntrue | \nEC_NOTSUBMITTEDTOSMPPCHANNEL
- Not Submitted To Smpp Channel | \n
\n\n| 5492 | \ntrue | \nEC_DUPLICATE_MESSAGE
- The same message has already been sent to this destination address. | \n
\n\n
\n
Voice error codes
\nOK (group id: 0) - voice error codes
\nThe request has been completed successfully.
\n\n\n\n| ID | \nPermanent | \nError | \n
\n\n\n\n| 5000 | \ntrue | \nVOICE_ANSWERED
- The call has been received and answered. | \n
\n\n| 5001 | \ntrue | \nVOICE_ANSWERED_MACHINE
- The call has been received and answered by a voice machine. | \n
\n\n
\n
HANDSET_ERRORS (group id: 1) - voice error codes
\nThe request has not been completed due to handset related issues.
\n\n\n\n| ID | \nPermanent | \nError | \n
\n\n\n\n| 5480 | \nfalse | \nEC_VOICE_ERROR_TEMPORARILY_NOT_AVAILABLE
- Destination address is currently not available. | \n
\n\n| 5603 | \nfalse | \nEC_DECLINE
- Destination does not wish to participate in the call or cannot do so. | \n
\n\n
\n
OPERATOR_ERRORS (group id: 3) - voice error codes
\nThe request has not been completed due to operator issues.
\n\n\n\n| ID | \nPermanent | \nError | \n
\n\n\n\n| 5002 | \ntrue | \nEC_VOICE_USER_BUSY
- The end user is currently busy to receive the Voice call. | \n
\n\n| 5003 | \ntrue | \nEC_VOICE_NO_ANSWER
- The end user received a call but didn’t answer it. | \n
\n\n| 5004 | \ntrue | \nEC_VOICE_ERROR_DOWNLOADING_FILE
- The file specified in the HTTP request is inaccessible and could not have been downloaded. | \n
\n\n| 5005 | \ntrue | \nEC_VOICE_ERROR_UNSUPPORTED_AUDIO_FORMAT
- The format of the file specified is not supported. | \n
\n\n| 5400 | \nfalse | \nEC_VOICE_ERROR_BAD_REQUEST
- The received request was rejected because it wasn’t formatted correctly. | \n
\n\n| 5403 | \nfalse | \nEC_VOICE_ERROR_FORBIDDEN
- The received request was rejected by the operator. | \n
\n\n| 5404 | \nfalse | \nEC_VOICE_ERROR_DESTINATION_NOT_FOUND
- The server has definitive information that the user does not exist at the domain specified in the Request-URI. | \n
\n\n| 5407 | \nfalse | \nEC_VOICE_ERROR_PROXY_AUTHENTICATION_REQUIRED
- The request requires user authentication on the operator’s end. | \n
\n\n| 5408 | \nfalse | \nEC_VOICE_ERROR_REQUEST_TIMEOUT
- There was no coverage for a specific destination number or the end user couldn’t be found in time during the call. | \n
\n\n| 5410 | \nfalse | \nEC_VOICE_ERROR_GONE
- The user existed once, but operator doesn’t support destination address anymore. | \n
\n\n| 5413 | \nfalse | \nEC_VOICE_ERROR_REQUEST_ENTITY_TOO_LARGE
- Request entity-body is larger than the server is willing or able to process. | \n
\n\n| 5414 | \nfalse | \nEC_VOICE_ERROR_REQUEST_URI_TOO_LONG
- The server is refusing to process the request because the Request-URI is longer than the server is willing to interpret (destination too long). | \n
\n\n| 5415 | \nfalse | \nEC_VOICE_UNSUPPORTED_MEDIA_TYPE
- Format of the file is not supported. | \n
\n\n| 5481 | \nfalse | \nEC_VOICE_ERROR_CALL_DOES_NOT_EXIST
- Call or Transaction does not exist. | \n
\n\n| 5484 | \nfalse | \nEC_VOICE_ERROR_ADDRESS_INCOMPLETE
- Specified destination number is incomplete. | \n
\n\n| 5487 | \nfalse | \nEC_VOICE_ERROR_REQUEST_TERMINATED
- Request has been terminated with a cancel button and end user refused to receive a voice call. | \n
\n\n| 5488 | \nfalse | \nEC_VOICE_ERROR_NOT_ACCEPTABLE_HERE
- The format of the request is not acceptable on the operator’s end. | \n
\n\n| 5491 | \nfalse | \nEC_VOICE_ERROR_REQUEST_PENDING
- Server has some pending request from the same dialog. | \n
\n\n| 5501 | \ntrue | \nEC_VOICE_NOT_IMPLEMENTED
- The submitted request is not supported on the operator’s end. | \n
\n\n| 5503 | \ntrue | \nEC_VOICE_SERVICE_UNAVAILABLE
- The service failed to complete the request. | \n
\n\n
\n
OK (group id: 0)
\nThe request has been completed successfully.
\n\n\n\n| ID | \nPermanent | \nError | \n
\n\n\n\n| 10000 | \ntrue | \nNORMAL_HANGUP The call ended due to a hangup initiated by the caller, callee, or API. | \n
\n\n| 10001 | \ntrue | \nANSWERED_ELSEWHERE The call was answered on another device or platform. Verify the call status on the intended device or investigate further if needed. | \n
\n\n| 10002 | \ntrue | \nMACHINE_DETECTED The voice call was answered by a machine or voicemail system. You may consider adjusting your communication strategy for machine-answered calls. | \n
\n\n| 10003 | \ntrue | \nHUMAN_DETECTED A human answered the call. You can take appropriate action based on the call's purpose. | \n
\n\n| 10004 | \ntrue | \nMAX_DURATION_REACHED The call reached the maximum allowed duration. If needed, initiate a new call or adjust the call duration settings and contact Support for further assistance. | \n
\n\n
\n
HANDSET_ERRORS (group id: 1)
\nThe request has not been completed due to handset-related issues.
\n\n\n\n| ID | \nPermanent | \nError | \n
\n\n\n\n| 10100 | \ntrue | \nDEVICE_FORBIDDEN The device (camera and/or microphone) used for the call is not allowed or blocked. Check device permissions or restrictions and take appropriate action. | \n
\n\n| 10101 | \ntrue | \nDEVICE_NOT_FOUND The device (camera and/or microphone) for the call could not be found or is unavailable. Ensure the device is accessible and try again. | \n
\n\n| 10102 | \ntrue | \nDEVICE_UNAVAILABLE The device (camera and/or microphone) for the call is currently unavailable. | \n
\n\n| 10103 | \ntrue | \nMEDIA_ERROR An error occurred with the media during the call (for example, an audio issue). Check the media settings and equipment, and troubleshoot as necessary. | \n
\n\n
\n
USER_ERRORS (group id: 2)
\nUser error occurred.
\n\n\n\n| ID | \nPermanent | \nError | \n
\n\n\n\n| 10200 | \ntrue | \nNO_ANSWER The call was successfully delivered to the end user device, however, it was not answered by the end user. | \n
\n\n| 10201 | \ntrue | \nBUSY The call has been successfully delivered to the end user's device, but the end user's device indicates that they are currently busy and unable to answer the incoming call. | \n
\n\n| 10202 | \ntrue | \nCANCELED The call was canceled at the origination end before it could be successfully routed to the end user. | \n
\n\n| 10203 | \ntrue | \nREJECTED The call was rejected/declined by the end user at the receiving end. | \n
\n\n| 10204 | \ntrue | \nTEMPORARILY_UNAVAILABLE The end user was unavailable to receive the call at the moment. The operator attempted to connect the call but encountered an issue with the end user's connection or availability, resulting in the call not being successfully connected. It is advisable to verify if the phone number provided is valid and reachable to ensure effective communication in the future. | \n
\n\n
\n
OPERATOR_ERRORS (group id: 3)
\nThe request has not been completed due to operator issues.
\n\n\n\n| ID | \nPermanent | \nError | \n
\n\n\n\n| 10300 | \ntrue | \nFORBIDDEN The received request was rejected. Contact Support for further assistance. | \n
\n\n| 10301 | \ntrue | \nINSUFFICIENT_FUNDS The account you are using does not have sufficient credits or funds available to initiate the phone call you are attempting to make. In order to proceed with the call, you will need to ensure that there are enough credits or funds in your account. | \n
\n\n| 10302 | \ntrue | \nUNAUTHENTICATED The caller's credentials or access rights are invalid or insufficient to initiate the call. To resolve this, ensure that the caller provides valid authentication credentials or obtains proper authorization for making the call. | \n
\n\n| 10303 | \ntrue | \nDESTINATION_NOT_FOUND The server was unable to locate the destination number you dialed. This could be due to an incorrect country prefix or an invalid number format. To resolve this issue, double-check the country prefix and ensure that the number you dialed is accurate and in the correct format. | \n
\n\n| 10304 | \ntrue | \nDESTINATION_UNAVAILABLE The destination number you attempted to call is currently unavailable to receive incoming calls. To address this situation, it is recommended to verify if the number you dialed is valid and reachable. | \n
\n\n| 10305 | \ntrue | \nINVALID_DESTINATION The server was unable to locate the destination number you dialed. This could be due to an incorrect country prefix or an invalid number format. To resolve this issue, double-check the country prefix and ensure that the number you dialed is accurate and in the correct format. | \n
\n\n| 10306 | \ntrue | \nINVALID_REQUEST The call request is invalid or malformed. Review the request parameters and structure, and make necessary adjustments. | \n
\n\n| 10307 | \ntrue | \nREQUEST_TIMEOUT The call request timed out without a response. For more specific details and assistance, contact the Support team, who can provide further information and guidance. | \n
\n\n| 10308 | \ntrue | \nNETWORK_ERROR An error occurred in the network during the call. Check the network connection and contact Support for further investigation. | \n
\n\n| 10309 | \ntrue | \nSERVICE_UNAVAILABLE The call service is temporarily unavailable. Contact Support for assistance. | \n
\n\n| 10310 | \ntrue | \nUNKNOWN An unknown error occurred during the call. Contact Support for further investigation and assistance. | \n
\n\n| 10311 | \ntrue | \nFEATURE_UNAVAILABLE The requested call feature is not available or supported. Consider alternative features or methods for communication or contact Support for assistance. | \n
\n\n| 10312 | \ntrue | \nCONGESTION The call could not be completed due to network congestion or overload. Contact Support for further investigation and assistance. | \n
\n\n| 10400 | \ntrue | \nURL_NOT_FOUND The requested URL for the call was not found. Verify the URL and make necessary corrections. | \n
\n\n| 10401 | \ntrue | \nURL_UNREACHABLE The requested URL for the call is unreachable. Check the network connectivity and URL accessibility. | \n
\n\n| 10402 | \ntrue | \nINVALID_RESPONSE The response received during the call is invalid or unexpected. Contact Support for assistance. | \n
\n\n
\n
HANDSET_ERRORS (group id: 1) - WebRTC error codes
\nThe request has not been completed due to handset-related issues.
\n\n\n\n| ID | \nPermanent | \nError | \n
\n\n\n\n| 5720 | \ntrue | \nEC_NO_PEER_CONNECTION The peer connection has not been established. | \n
\n\n| 5721 | \ntrue | \nEC_INVALID_DTMF_CONFIG_NO_AUDIO_TRACK Invalid DTMF configuration (no audio track). | \n
\n\n| 5722 | \ntrue | \nEC_DTMF_UNAVAILABLE DTMF options are not available. | \n
\n\n| 5723 | \ntrue | \nEC_DTMF_INVALID_TONE Invalid DTMF tone sent. Allowed tones are digits 1-9, * and #. | \n
\n\n| 5724 | \ntrue | \nEC_NO_LOCAL_STREAM Local stream was not initialized. | \n
\n\n| 5725 | \ntrue | \nEC_NO_AUDIO_TRACK The audio track is missing. | \n
\n\n| 5726 | \ntrue | \nEC_NO_VIDEO_TRACK The video track is missing. | \n
\n\n| 5727 | \ntrue | \nEC_NO_DISPLAY_MEDIA Display media API is not available. | \n
\n\n| 5728 | \ntrue | \nEC_UNKNOWN_SCREEN_SHARE_ERROR Unknown screen share error. | \n
\n\n
\n
USER_ERRORS (group id: 2) - WebRTC error codes
\nUser error occurred.
\n\n\n\n| ID | \nPermanent | \nError | \n
\n\n\n\n| 5800 | \ntrue | \nEC_NO_ANSWER The end user received the call but did not answer it. | \n
\n\n| 5801 | \ntrue | \nEC_USER_BUSY The end user is currently busy and not able to receive the call. | \n
\n\n| 5802 | \ntrue | \nEC_PERMISSION_DENIED Permission to use a camera and/or microphone was denied. | \n
\n\n| 5803 | \ntrue | \nEC_DEVICE_NOT_FOUND Device does not have a camera and/or microphone connected/enabled. | \n
\n\n| 5804 | \ntrue | \nEC_DEVICE_NOT_AVAILABLE Camera or microphone is already in use. | \n
\n\n| 5805 | \ntrue | \nEC_ACTIVE_CALL_ON_INCOMING_CAL The end user received an incoming call while they were on another active call. | \n
\n\n| 5806 | \ntrue | \nEC_CALL_TERMINATED Call terminated. | \n
\n\n| 5850 | \ntrue | \nEC_USER_ALREADY_JOINED The end user is already joined on another device. | \n
\n\n| 5851 | \ntrue | \nEC_MAX_USERS_LIMIT_REACHED The maximum number of users was already reached. | \n
\n\n| 5852 | \ntrue | \nEC_VIDEO_PUBLISHERS_LIMIT_REACHED The maximum number of users that are publishing a video was already reached. | \n
\n\n
\n
OPERATOR_ERRORS (group id: 3) - WebRTC error codes
\nThe request has not been completed due to operator issues.
\n\n\n\n| ID | \nPermanent | \nError | \n
\n\n\n\n| 5768 | \ntrue | \nEC_CLIENT_URL_READ_FAILURE Could not read the client's URL. | \n
\n\n| 5769 | \ntrue | \nEC_CLIENT_URL_REACH_FAILURE Could not reach the client's URL. | \n
\n\n| 5900 | \ntrue | \nEC_FORBIDDEN The received request was rejected. | \n
\n\n| 5901 | \ntrue | \nEC_REQUEST_TIMEOUT There was no coverage for a specific destination number, or the end user could not be reached in time for the call. | \n
\n\n| 5902 | \ntrue | \nEC_INTERNAL_SERVER_ERROR The server could not process the request because of an unexpected error. | \n
\n\n| 5903 | \ntrue | \nEC_DESTINATION_NOT_FOUND The server has definitive information that the end user does not exist within the domain specified in the Request-URI. | \n
\n\n| 5904 | \ntrue | \nEC_SERVICE_TEMPORARY_UNAVAILABLE The service is temporarily unavailable. | \n
\n\n| 5905 | \ntrue | \nEC_REQUEST_PENDING The server has a pending request from the same dialog. | \n
\n\n| 5906 | \ntrue | \nEC_ADDRESS_INCOMPLETE The specified destination number is incomplete. | \n
\n\n| 5907 | \ntrue | \nEC_TEMPORARILY_NOT_AVAILABLE The destination address is currently unavailable. | \n
\n\n| 5990 | \ntrue | \nEC_CONNECTION_ERROR There has been a connection error. | \n
\n\n| 5991 | \ntrue | \nEC_UNKNOWN_WEBRTC_ERROR There has been an unknown WebRTC error. | \n
\n\n
\n
Dropped (group id: 1)
\nThe request has not been completed successfully as there was an issue noticed before the sending attempt causing an error.
The
\n\n\n\n| ID | \nPermanent | \nName | \n
\n\n\n\n| 6003 | \ntrue | \nEC_UNSUBSCRIBED_EMAIL_ADDRESS
The recipient opted out of receiving updates from this specific address. If removal is desired, complete the request by going to Do not contact in the web interface. | \n
\n\n| 6034 | \ntrue | \nEC_SUPPRESSED_BOUNCE
A bounce SMTP response from the recipient's mailbox provider earlier has resulted in the recipient address being suppressed. | \n
\n\n| 6035 | \ntrue | \nEC_SUPPRESSED_SPAM_COMPLAINT
Due to the recipient reporting previous content sent from the same domain as spam, the recipient's address has been suppressed.
* Note that this error code will be deployed at a later stage. For the time being, spam complaints will be marked with EC 6034. | \n
\n\n| 6033 | \ntrue | \nEC_INVALID_CC_BCC_EMAIL_ADDRESS
The request contains invalid addresses in the CC and/or BCC. Ensure that the addresses are correctly formatted by checking them. | \n
\n\n| 6023 | \ntrue | \nEC_BLOCKED_SUSPICIOUS_ACTIVITY
Your domain has been blocked by VHD due to suspicious activity. Should you require any additional information regarding this matter, contact Support or your account manager. | \n
\n\n| 6036 | \ntrue | \nEC_SENDING_DOMAIN_UNVERIFIED
Domain does not currently have all required DNS records set up correctly. Check your DNS configuration. | \n
\n\n| 6016 | \ntrue | \nEC_SENDER_DOMAIN_BOUNCE_BLOCKED
Your domain has been blocked due to a high bounce rate to protect IPs and its reputation. The domain unblocking procedure is automated and will happen after a 24-hour cooling-off period. To prevent this from occurring in the future, check the reports and clean up your recipient database from inactive addresses. Use the Email validation service to help you with the procedure. | \n
\n\n| 6029 | \ntrue | \nEC_SENDER_ADDRESS_INVALID
The email sender is invalid or unauthorized to send emails. To resolve the issue, check the sender domain for spelling mistakes and ensure that the domain is verified and properly configured. | \n
\n\n| 6018 | \ntrue | \nEC_REQUEST_INVALID
The submitted request is not valid. Ensure that the data and request parameters are accurate and in the right format. | \n
\n\n| 6002 | \ntrue | \nEC_SPAM_DETECTED
The content you are trying to send was detected as possible spam by VHD. Review the Deliverability recommendations and adjust your content accordingly before retry. | \n
\n\n| 6038 | \ntrue | \nEC_EMAIL_CONTENT_EXPIRED
The content in a Template expired due to the lack of regular usage. To help the situation, check the content and re-upload it to help the situation. If the issue persists, contact Support. | \n
\n\n| 6021 | \ntrue | \nEC_EMAIL_PLACEHOLDERS_ERROR
Error with Placeholders in the Content. Check the placeholders and confirm that there are no issues or typos in them and retry. | \n
\n\n| 6039 | \ntrue | \nEC_EMAIL_TEMPLATE_LANGUAGE_ERROR
Error in Template Language in your Content. See Template language personalization or more details. If the problem persists, contact Support. | \n
\n\n| 6024 | \ntrue | \nEC_EMAIL_TOO_MANY_URLS
Maximum amount of URLs with Tracking enabled is 150. Lower the amount of URLs or turn off the Tracking features before retry. | \n
\n\n| 6025 | \ntrue | \nEC_EMAIL_INVALID_TRACKING_PARAMS
Tracking parameters in the email are invalid. Review and help these before the retry. | \n
\n\n| 6026 | \ntrue | \nEC_EMAIL_LANDING_PAGE_PLACEHOLDERS_SIZE_EXCEEDED
Size of the Placeholders on the landing page limit is 256 characters. Adjust (decrease) the landing page placeholder size accordingly and retry. | \n
\n\n| 6027 | \ntrue | \nEC_EMAIL_INVALID_HEADERS
The headers of the email are invalid or improperly formatted. Check the headers and ensure they meet the required format. | \n
\n\n| 6030 | \ntrue | \nEC_EMAIL_INVALID_LANDING_PAGE
The specified landing page is invalid or inaccessible. Confirm the landing page's URL and availability and retry. | \n
\n\n| 6031 | \ntrue | \nEC_INVALID_PRESERVED_CC_OR_BCC_RECIPIENT
Invalid preserved recipient in CC or BCC. Check the recipient list and ensure that all preserved recipients are valid and the limit is not reached. | \n
\n\n| 6020 | \ntrue | \nEC_EMAIL_TEMPLATE_NOT_FOUND
The Email Template from the request could not be found. Make sure that the Template ID is correct before retry. | \n
\n\n| 6040 | \ntrue | \nEC_EMAIL_TEMPLATE_EXPIRED
The Template validity period expired. Either update a Template to prolong the validity, or copy it and update the Template ID before retry. | \n
\n\n| 6041 | \ntrue | \nEC_EMAIL_TEMPLATE_NOT_SAVED
The Template was not saved. Make sure the requested Template is correctly stored on the VHD web interface before retry. | \n
\n\n
\n
Bounced (group id: 2)
\nThe response from the mailbox provider indicates that there was an error and the delivery attempt was unsuccessful.
\n\n\n\n| ID | \nPermanent | \nName | \n
\n\n\n\n| 6010 | \nfalse | \nEC_RECIPIENT_INBOX_FULL
The recipient's mailbox storage limit has been reached and they cannot receive additional emails. Contact the recipient and resolve this situation by clearing some data. | \n
\n\n| 6007 | \nfalse | \nEC_MAILBOX_TEMPORARY_UNAVAILABLE
The recipient's mailbox is temporarily unavailable. Retry the email in a few hours and contact Support if you continue to encounter the same response for the additional checks. | \n
\n\n| 6017 | \nfalse | \nEC_SENDER_IP_BLACKLISTED
The IP address assigned to your domain has been blacklisted. Review using the Deliverability recommendations and request the delisting on the relevant blacklist. | \n
\n\n| 6046 | \nfalse | \nEC_UNSOLICITED_RECIPIENT
The recipient mailbox provider (domain) has detected that this message is likely to be an unsolicited email, therefore, it was blocked. Ensure that your recipients are subscribed and interested in the traffic before retry. | \n
\n\n| 6011 | \nfalse | \nEC_SOFT_BOUNCE
Response indicates a temporary delivery error. Retry sending and if the same response is returned, contact the recipient to attend to the situation. | \n
\n\n| 6006 | \ntrue | \nEC_INVALID_EMAIL_ADDRESS
The recipient's email address provided is either invalid, inactive, or disabled. Check for possible typos and validate the address before the retry. Use the Email validation service to help you with the procedure. | \n
\n\n| 6009 | \ntrue | \nEC_MAILBOX_PERMANENTLY_UNAVAILABLE
The recipient's mailbox provider (domain) might be permanently unavailable. Contact the recipient and attend to the situation before retry. | \n
\n\n| 6037 | \ntrue | \nEC_RECIPIENT_DOMAIN_MX_NOT_FOUND
The domain to which this address belongs is possibly unavailable or does not exist due to the MX not being found or being unavailable. Check the address for any typos and validate the address. | \n
\n\n| 6042 | \ntrue | \nEC_SPAM_REVERTED
The content in the email was flagged as spam by the mailbox provider. Review the Deliverability recommendations and adjust your content accordingly before retry. | \n
\n\n| 6043 | \ntrue | \nEC_SUSPICIOUS_CONTENT
Mailbox provider decided to deny your traffic due to the suspicious content. Ensure that you are following content best practices before retrying the traffic. If the error persists, contact the mailbox provider. | \n
\n\n| 6044 | \ntrue | \nEC_SUSPICIOUS_SENDER
Recipient mailbox provider denied your messages due to very low reputation of your domain or IPs. This usually happens due to different sending best practices not being followed. Ensure that you respect general and mailbox provider's best practices when sending traffic and if the error repeats, contact the mailbox provider to resolve the situation. | \n
\n\n| 6045 | \ntrue | \nEC_RECIPIENT_DOMAIN_POLICY_ERROR
Mailbox provider blocked your message as it does not meet their email policy requirements for your organization or for the recipient's organization. Follow the best practices and if the error repeats, contact the recipient for additional details and possible solution. | \n
\n\n| 6047 | \ntrue | \nEC_DOMAIN_CONFIGURATION_ERROR
Your domain might be missing valid DKIM or SPF, so your traffic has been denied by the recipient mailbox provider. Ensure that your DNS records are valid before retry. | \n
\n\n| 6048 | \ntrue | \nEC_DMARC_POLICY_ISSUE
Recipient mailbox provider denied your domain's DMARC policy. Ensure that the policy is valid before retry and if the error repeats, contact the recipient mailbox provider for the further instructions. | \n
\n\n| 6049 | \ntrue | \nEC_SENDER_DOMAIN_BLACKLISTED
Your domain has been blockisted by the recipient mailbox. Review the Deliverability recommendations and request the delisting on the relevant blocklist. | \n
\n\n| 6012 | \ntrue | \nEC_HARD_BOUNCE
Response is indicating a permanent error related to the delivery. Contact the recipient to confirm and solve the situation. | \n
\n\n
\n
System Error (group id: 3)
\nThe request has not been successful due to the issue on the VHD end.
\n\n\n\n| ID | \nPermanent | \nName | \n
\n\n\n\n| 6013 | \nfalse | \nEC_INTERNAL_SYSTEM_ERROR
Something went wrong on the VHD end. Retry the traffic and contact Support if the same error is returned. | \n
\n\n
\n
When using our API, you may encounter certain status and error codes that you need to understand or troubleshoot. This page contains a list of all codes with thorough descriptions and action steps you need to take if you are looking to resolve a problem.
\nCode lists:
\n\n","_postman_id":"4fa7b951-2c08-4e1a-849f-d0d3e4789c76"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["// Documentation examples use sample recipients: the number 46731234567 for SMS, and","// jane.smith@vhdmedia.se / tom.smith@vhdmedia.se for email. When you run a send request they are","// replaced with your own test recipient (environment variables \"testNumber\" and \"testEmail\"). Voice call requests use testNumber too.","// If the variable is empty, the request is not sent.","var path = pm.request.url.getPath();","var isVoice = /^\\/(tts\\/3\\/(single|multi|advanced)|voice\\/ivr\\/1\\/messages)$/.test(path);","var isSms = /^\\/sms\\/(3\\/(messages|text\\/query)|2\\/(text|binary)\\/|1\\/text\\/query)/.test(path) || isVoice;","var isEmail = /^\\/email\\/(4\\/(messages|mime)|3\\/send)/.test(path);","","if (isSms || isEmail) {"," var variable = isSms ? \"testNumber\" : \"testEmail\";"," var target = (pm.environment.get(variable) || \"\").trim();"," if (isVoice) {"," // voice calls use testVoiceNumber when it is set, otherwise testNumber"," variable = (pm.environment.get(\"testVoiceNumber\") || \"\").trim() ? \"testVoiceNumber\" : \"testNumber\";"," target = (pm.environment.get(variable) || \"\").trim();"," }"," var samples = isSms ? [\"46731234567\"] : [\"jane.smith@vhdmedia.se\", \"tom.smith@vhdmedia.se\"];",""," if (!target) {"," console.warn(variable + \" is not set in the environment - request not sent.\");"," if (pm.execution && pm.execution.skipRequest) {"," pm.execution.skipRequest();"," } else {"," pm.request.url.update(\"http://localhost:1/\" + variable + \"-not-set\");"," }"," } else {"," var swap = function (text) {"," samples.forEach(function (s) { text = text.split(s).join(target); });"," return text;"," };"," var body = pm.request.body;"," if (body && body.raw) {"," body.update({ mode: \"raw\", raw: swap(body.raw), options: body.options });"," }"," if (body && body.formdata) {"," body.formdata.each(function (p) { if (p.value) { p.value = swap(p.value); } });"," }"," pm.request.url.query.each(function (q) { if (q.value) { q.value = swap(q.value); } });"," }","}","","// Keep the \"sendAt\" variable between 1 and 4 days from now, so it is valid for every channel:","// if it is empty, less than a day away, or more than 4 days away, set it to 3 days from now (UTC).","// (Email v4 accepts at most 5 days ahead; SMS up to 180 days; email v3 up to 30 days.)","(function () {"," var current = pm.environment.get(\"sendAt\");"," var t = current ? Date.parse(String(current).replace(/\\+0000$/, \"Z\")) : NaN;"," if (isNaN(t) || t < Date.now() + 86400000 || t > Date.now() + 4 * 86400000) {"," var d = new Date(Date.now() + 3 * 86400000);"," var p = function (n) { return (\"0\" + n).slice(-2); };"," pm.environment.set(\"sendAt\", d.getUTCFullYear() + \"-\" + p(d.getUTCMonth() + 1) + \"-\" + p(d.getUTCDate()) + \"T\" + p(d.getUTCHours()) + \":\" + p(d.getUTCMinutes()) + \":\" + p(d.getUTCSeconds()) + \".000+0000\");"," }","})();",""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"variable":[{"key":"to","value":""},{"key":"text","value":""},{"key":"from","value":""},{"key":"lisName","value":"listName"}]}