{"info":{"_postman_id":"27038313-1498-45b2-9e6f-253b5f9ed077","name":"VHD Enterprise API-documentation","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"18007588","collectionId":"27038313-1498-45b2-9e6f-253b5f9ed077","publishedId":"2s93JwNN7T","public":true,"customColor":{"top-bar":"0099CC","right-sidebar":"303030","highlight":"0099CC"},"publishDate":"2023-06-15T19:28:53.000Z"},"item":[{"name":"INTRODUCTION","item":[],"id":"ba1f7d9d-eff3-42aa-9461-3a40fbffa471","description":"

Getting Started with API

The provided documentation encompasses the complete range of VHD APIs for Enterprise. By simply glancing at the left-side navigation menu, you can explore the entire VHD product stack for Enterprise. Each product includes comprehensive documentation for all accessible API endpoints and webhooks.

API is based on REST standards, enabling you to use your browser for accessing URLs. In order to interact with our API, any HTTP client in any programming language can be used.

Support

If you need help, do the following;

Email: support@vhdmedia.se
Submit your Username
Submit YOUR name and YOUR contact details
Describe what you were doing when the error occurred
Describe any (error) messages that appeared
If you have any issues in receiving SMS, please submit the receiver's phone number

Without the information above, it is very difficult for us to handle and solve your errand. Also, without the information, the time for us to handle your errand might demand more time.

Call us: + 46 (0) 10-160 50 40.
Observe that all support errands that are called in are first line errands. If your errand is prioritized, our support will create an errand and get back to you through email.

Base URL

Submit all requests to the base URL. All the requests are submitted thorough HTTP POST or GET method. Connecting via SMPP? Please look below.

https://go2.vhdmedia.se\n\n

SMPP

For those of you who use SMPP, all information is on the left in the menu. Please note that you need to activate SMPP with us before you start. Contact support@vhdmedia.se (state your username and contact details) and we will get back with an activation and more information.

Content-Type & Accept header

API supports JSON and XML Content-Types and Accept criteria that should be specified in the header. If the Content-Type is not specified you will receive a General error. Depending which Accept type is chosen in the deader for the request, the same one will be applied in the response.

Content-Type: application/json or application/xml
Accept header: application/json or application/xml

\n","_postman_id":"ba1f7d9d-eff3-42aa-9461-3a40fbffa471"},{"name":"AUTHORIZATION","item":[],"id":"16df7cca-2397-4297-a637-01ccb9c4005a","description":"

Authorization

In order to make API requests through the VHD API, authentication via the Authorization header is required. There are several authentication methods available, including:

HTTP Basic authentication
API Keys

The method chosen should align with the current technology stack and level of security required. However, it is recommended to combine authentication methods with other security mechanisms, such as an encrypted connection or SSL, due to the vulnerability of some of the methods to man-in-the-middle attacks.

If there are any potential issues, reference the Response status and Error codes section for troubleshooting or reach out to the VHD Support team for assistance.

Basic authentication

Basic authentication, which involves sending a username and password with each API request. This method is typically used when the API key is not available, for example, API methods that generate API keys may be authenticated with Basic authentication. However, it is the least recommended method since it is relatively easy to decode encrypted credentials back to their original values. The HTTP Authentication resource provides information on how to restrict server access using Basic authentication.

We support basic authorization using a username and password with Base64 encoding variation RFC2045-MIME.

The authorization header is constructed as follows:

Username and password are combined into a string username:password.
The resulting string is encoded using the RFC2045-MIME variant of Base64.
The authorization method and a space, like this: \"Basic \", are put before the encoded string.

Example

Username: myUsername
Password: myPassword

Base64 encoded string: QWxhZGRpbjpvcGVuIHNlc2FtZQ==Authorization header: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

API Key Header

An API key is an access token that a client provides when making API calls. It's a simple way to secure access and thus the most popular authentication method used with REST APIs. The key can be sent in the query string or as a request header. You are automatically assigned an API Key once you create an account. Generate more keys and manage the existing ones through the VHD API key management page, please contact us if you need help.

Create API Key

Here are some key facts about this method:

API keys can be generated by calling the dedicated API method
Keys can be revoked at any time which is useful when separating the API access rights across multiple applications or use cases
Lost API keys are easily retrievable
VHD API keys have a predefined expiry date to eventually become invalid

Example

key: Authorization
value: App {{API_Key}}

","_postman_id":"16df7cca-2397-4297-a637-01ccb9c4005a"},{"name":"SMS","item":[{"name":"SEND SMS","item":[{"name":"Simple textual message","event":[{"listen":"test","script":{"id":"94bf933d-162b-446c-a296-686987892890","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","var requestBody = pm.request.body;","","// Extract the 'from', 'to', and 'text' properties from the request body","var from, toNumbers, text;","try {"," var bodyJson = JSON.parse(requestBody.raw);"," from = bodyJson.from;"," toNumbers = bodyJson.to;"," text = bodyJson.text;","} catch (error) {"," console.log(\"Error parsing request body as JSON:\", error);","}","","// Test if 'from' property exists in the request body","pm.test(\"From property exists in the request body\", function () {"," pm.expect(from).to.exist;","});","","// Test if 'from' property is a string","pm.test(\"From property is a string\", function () {"," pm.expect(from).to.be.a('string');","});","","// Test if 'to' property exists in the request body","pm.test(\"To property exists in the request body\", function () {"," pm.expect(toNumbers).to.exist;","});","","// Test if 'to' property is an array","pm.test(\"To property is an array\", function () {"," pm.expect(toNumbers).to.be.an('array');","});","","// Test if 'to' array has at least one element","pm.test(\"To array has at least one element\", function () {"," pm.expect(toNumbers).to.have.lengthOf.at.least(1);","});","","// Test if 'text' property exists in the request body","pm.test(\"Text property exists in the request body\", function () {"," pm.expect(text).to.exist;","});","","// Test if 'text' property is a string","pm.test(\"Text property is a string\", function () {"," pm.expect(text).to.be.a('string');","});","","// Extract 'to' numbers from the request body","var toNumbersInRequest = [];","try {"," var requestBodyJson = pm.request.json();"," requestBodyJson.to.forEach(function(toNumber) {"," // Log the 'to' number being extracted"," console.log(\"Extracted 'to' number:\", toNumber);"," toNumbersInRequest.push(toNumber);"," });"," // Log the extracted 'to' numbers for debugging"," console.log(\"To Numbers in Request:\", toNumbersInRequest);","} catch (error) {"," console.log(\"Error parsing request body as JSON:\", error);","}","","// 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, index) {"," pm.expect(message).to.have.property('messageId');"," pm.expect(message).to.have.property('status');"," pm.expect(message.status).to.have.property('description');"," pm.expect(message.status).to.have.property('groupId');"," pm.expect(message.status).to.have.property('groupName');"," pm.expect(message.status).to.have.property('id');"," pm.expect(message.status).to.have.property('name');",""," // Check if 'text' property exists in the message"," if ('text' in message) {"," // Calculate the number of SMS messages required based on the character count of the text"," var textLength = message.text.length;"," var smsCount = Math.ceil(textLength / 160); // Assuming 160 characters per SMS",""," // Assert the smsCount property"," pm.expect(message).to.have.property('smsCount', smsCount);"," } else {"," console.log(\"text property not found in message:\", message);"," }",""," // Check if 'to' property exists in the message"," if ('to' in message) {"," // Check if index is within bounds of toNumbersInRequest array"," if (index < toNumbersInRequest.length) {"," // Expect the 'to' property to be equal to the extracted 'to' number"," pm.expect(message.to).to.eql(toNumbersInRequest[index]);"," } else {"," console.log(\"Index out of bounds for toNumbersInRequest array\");"," }"," } else {"," console.log(\"to property not found in message:\", message);"," }"," });","});","","// Test if system-assigned bulkId exists in the response","pm.test(\"BulkId exists in the response\", function () {"," pm.expect(responseBody).to.have.property('bulkId');"," // Add additional checks for bulkId if required, such as format or specific properties","});","",""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"39002532-091e-40fc-a0cb-ef0a912b6bf8","exec":[""],"type":"text/javascript","packages":{}}}],"id":"49a776d8-af93-4b54-afd1-2b515aa978be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"from\": \"VHD\",\n \"to\": [\"4670123456\",\"4670123457\"],\n \"text\": \"Hello World\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/sms/2/text/single","description":"

Request body schema

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

Parameter	Type	Description
from	String	Represents sender ID and it can be alphanumeric or numeric. Alphanumeric sender ID length should be between 3 and 11 characters (Example: CompanyName). Numeric sender ID length should be between 3 and 14 characters.
to	Array of Strings	Required Array of message destination addresses. If you want to send a message to one destination, a single String is supported instead of an Array. Destination addresses must be in international format (Example: 46731234567).
text	String	Required Text of the message that will be sent.

Response format

On success, response header HTTP status code will be 200 OK and the message will be sent.
If you try to send message without authorization, you will receive an error 401 Unauthorized.

SMSResponse

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

Parameter	Type	Description
bulkId	String	The ID that uniquely identifies the request. Bulk ID will be generated only when you send a message to more than one destination address.
messages	Array of Object	Array of sent message objects, one object per every message.

Messages (Array of Object )

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

Parameter	Type	Description
to	String	The message destination address.
status	Object	Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
smsCount	Int	The number of sent message segments.
messageId	String	The ID that uniquely identifies the message sent.

Status (Object)

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

Parameter	Type	Description
groupId	Int	Status group ID.
groupName	String	Status group name.
id	Int	Status ID.
name	String	Status name.
description	String	Human readable description of the status.
action	String	Action that should be taken to eliminate the error.

","urlObject":{"protocol":"https","path":["sms","2","text","single"],"host":["go2","vhdmedia","se"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"3e76f144-2a8b-43be-87dc-c1829e38475c","name":"Sending multiple messages","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"from\": \"VHD\",\n \"to\": [\"4670123456\",\"4670123457\"],\n \"text\": \"Hello World\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/sms/2/text/single","protocol":"https","host":["go2","vhdmedia","se"],"path":["sms","2","text","single"],"query":[{"key":"from ","value":"vhd","description":"Type: String. Represents sender ID and it can be alphanumeric or numeric. Alphanumeric sender ID length should be between 3 and 11 characters (Example: CompanyName). Numeric sender ID length should be between 3 and 14 characters.","type":"text","disabled":true},{"key":"to","value":"467012345","description":"Type: String. Required.\nArray of message destination addresses. If you want to send a message to one destination, a single String is supported instead of an Array. Destination addresses must be in international format (Example: 41793026727).","type":"text","disabled":true},{"key":"text","value":"hello world","description":"Type: String. Required. \nText of the message that will be sent.","type":"text","disabled":true}]}},"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":"429"},{"key":"Date","value":"Mon, 06 Mar 2023 17:33:28 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1678124009298306830"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"37812400930501630431\",\n \"messages\": [\n {\n \"to\": \"4670123456\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"messageId\": \"37812400930501630432\",\n \"smsCount\": 1\n },\n {\n \"to\": \"4670123457\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"messageId\": \"37812400930601630433\",\n \"smsCount\": 1\n }\n ]\n}"},{"id":"245f3ce9-31d4-422f-88ed-ab234fa8ca06","name":"Sending single message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \n \"from\": \"VHD\",\n \"to\": \"4670123456\",\n \"text\": \"Hello World\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/sms/2/text/single","protocol":"https","host":["go2","vhdmedia","se"],"path":["sms","2","text","single"],"query":[{"key":"from ","value":"string","description":"Type: String. Represents sender ID and it can be alphanumeric or numeric. Alphanumeric sender ID length should be between 3 and 11 characters (Example: CompanyName). Numeric sender ID length should be between 3 and 14 characters.","type":"text","disabled":true},{"key":"to","value":"string","description":"Type: String. Required.\nArray of message destination addresses. If you want to send a message to one destination, a single String is supported instead of an Array. Destination addresses must be in international format (Example: 41793026727).","type":"text","disabled":true},{"key":"text","value":"string","description":"Type: String. Required. \nText of the message that will be sent.","type":"text","disabled":true}]}},"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":"205"},{"key":"Date","value":"Thu, 09 Mar 2023 21:26:54 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1678397215170029162"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n {\n \"to\": \"4670123456\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"messageId\": \"37839721517937213123\",\n \"smsCount\": 1\n }\n ]\n}"},{"id":"8b539832-d734-4f49-8b6d-f5db342078ab","name":"Example 400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"from\": \"\",\n \"to\": ,\n \"text\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/sms/2/text/single","protocol":"https","host":["go2","vhdmedia","se"],"path":["sms","2","text","single"],"query":[{"key":"from ","value":"","description":"Represents sender ID and it can be alphanumeric or numeric. Alphanumeric sender ID length should be between 3 and 11 characters (Example: CompanyName). Numeric sender ID length should be between 3 and 14 characters.","type":"text","disabled":true},{"key":"to","value":"","description":"Required.\nArray of message destination addresses. If you want to send a message to one destination, a single String is supported instead of an Array. Destination addresses must be in international format (Example: 41793026727).","type":"text","disabled":true},{"key":"text","value":"","description":"Required. \nText of the message that will be sent.","type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_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":"86"},{"key":"Date","value":"Wed, 01 Mar 2023 12:33:15 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1677673995880365828"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Bad request\"\n }\n }\n}"},{"id":"1b76f61e-f0b3-417d-a2ae-0daa51b32378","name":"Example 401","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"from\": \"\",\n \"to\": \"\",\n \"text\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/sms/2/text/single","protocol":"https","host":["go2","vhdmedia","se"],"path":["sms","2","text","single"],"query":[{"key":"from ","value":"","description":"Represents sender ID and it can be alphanumeric or numeric. Alphanumeric sender ID length should be between 3 and 11 characters (Example: CompanyName). Numeric sender ID length should be between 3 and 14 characters.","type":"text","disabled":true},{"key":"to","value":"","description":"Required.\nArray of message destination addresses. If you want to send a message to one destination, a single String is supported instead of an Array. Destination addresses must be in international format (Example: 41793026727).","type":"text","disabled":true},{"key":"text","value":"","description":"Required. \nText of the message that will be sent.","type":"text","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"SMS API"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"97"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Invalid login details\"\n }\n }\n}"}],"_postman_id":"49a776d8-af93-4b54-afd1-2b515aa978be"},{"name":"Fully featured textual message","event":[{"listen":"prerequest","script":{"id":"7827b484-d2f0-4e49-a3d0-09746021dce6","exec":["// Get the current date and time","var now = new Date();","","// Add 1 hour to the current time","var sendAtTime = new Date(now.getTime() + (1 * 60 * 60 * 1000));","","// Format the date and time as required","var year = sendAtTime.getUTCFullYear();","var month = ('0' + (sendAtTime.getUTCMonth() + 1)).slice(-2);","var day = ('0' + sendAtTime.getUTCDate()).slice(-2);","var hours = ('0' + sendAtTime.getUTCHours()).slice(-2);","var minutes = ('0' + sendAtTime.getUTCMinutes()).slice(-2);","var seconds = ('0' + sendAtTime.getUTCSeconds()).slice(-2);","","// Construct the formatted string for sendAt","var sendAt = year + '-' + month + '-' + day + 'T' + hours + ':' + minutes + ':' + seconds + '.000+0000';","","// Set the dynamic sendAt value as an environment variable","pm.environment.set(\"sendAt\", sendAt);","","// Function to generate a random string of given length","function generateRandomString(length) {"," var result = '';"," var characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';"," var charactersLength = characters.length;"," for (var i = 0; i < length; i++) {"," result += characters.charAt(Math.floor(Math.random() * charactersLength));"," }"," return result;","}","","// Generate a random string of length 9 (same length as the placeholder 123-xyz-123)","var randomString = generateRandomString(9);","","// Set the dynamic bulkId value as an environment variable","pm.environment.set(\"bulkId\", \"BULK-ID-\" + randomString);","// Set the dynamic messageId value as an environment variable","pm.environment.set(\"messageId\", \"MESSAGE-ID-\" + randomString);"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"228756f8-67bd-4a58-b1a7-5d8d2fa56a6a","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","var requestBody = pm.request.body;","","// Extract the 'from', 'to', and 'text' properties from the request body","var from, toNumbers, text;","try {"," var bodyJson = JSON.parse(requestBody);"," var messages = bodyJson.messages;"," from = messages[0].from;"," toNumbers = messages.flatMap(message => message.destinations.map(destination => destination.to));"," text = messages[1].text;","} catch (error) {"," console.log(\"Error parsing request body as JSON:\", error);","}","","// Test if 'from' property exists in the request body","pm.test(\"From property exists in the request body\", function () {"," pm.expect(from).to.exist;","});","","// Test if 'from' property is a string","pm.test(\"From property is a string\", function () {"," pm.expect(from).to.be.a('string');","});","","// Test if 'to' property exists in the request body","pm.test(\"To property exists in the request body\", function () {"," pm.expect(toNumbers).to.exist;","});","","// Test if 'to' property is an array","pm.test(\"To property is an array\", function () {"," pm.expect(toNumbers).to.be.an('array');","});","","// Test if 'to' array has at least one element","pm.test(\"To array has at least one element\", function () {"," pm.expect(toNumbers).to.have.lengthOf.at.least(1);","});","","// Test if 'text' property exists in the request body","pm.test(\"Text property exists in the request body\", function () {"," pm.expect(text).to.exist;","});","","// Test if 'text' property is a string","pm.test(\"Text property is a string\", function () {"," pm.expect(text).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, index) {"," pm.expect(message).to.have.property('messageId');"," pm.expect(message).to.have.property('status');"," pm.expect(message.status).to.have.property('description');"," pm.expect(message.status).to.have.property('groupId');"," pm.expect(message.status).to.have.property('groupName');"," pm.expect(message.status).to.have.property('id');"," pm.expect(message.status).to.have.property('name');",""," // Check if 'text' property exists in the message"," if ('text' in message) {"," // Calculate the number of SMS messages required based on the character count of the text"," var textLength = message.text.length;"," var smsCount = Math.ceil(textLength / 160); // Assuming 160 characters per SMS",""," // Assert the smsCount property"," pm.expect(message).to.have.property('smsCount', smsCount);"," } else {"," console.log(\"text property not found in message:\", message);"," }",""," // Check if 'to' property exists in the message"," if ('to' in message) {"," // Expect the 'to' property to be equal to the extracted 'to' number"," pm.expect(message.to).to.eql(toNumbers[index]);"," } else {"," console.log(\"to property not found in message:\", message);"," }"," });","});","","// Test if system-assigned bulkId exists in the response","pm.test(\"BulkId exists in the response\", function () {"," pm.expect(responseBody).to.have.property('bulkId');"," // Add additional checks for bulkId if required, such as format or specific properties","});","",""],"type":"text/javascript","packages":{}}}],"id":"164621bc-e3f0-430c-90b0-7fd363a5e797","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\n \"bulkId\": \"{{bulkId}}\",\n \"messages\": [\n\n {\n\n \"callbackData\": \"DLR callback data\",\n\n \"destinations\": [\n\n {\n\n \"messageId\": \"{{messageId}}\",\n\n \"to\": \"4670123456\"\n\n },\n\n {\n\n \"to\": \"4670123457\"\n\n }\n\n ],\n\n \"flash\": false,\n\n \"from\": \"VHD\",\n\n \"intermediateReport\": true,\n\n \"language\": {\n\n \"languageCode\": \"TR\"\n\n },\n\n \"notifyContentType\": \"application/json\",\n\n \"notifyUrl\": \"https://www.example.com/sms/advanced\",\n\n \"text\": \"Merhaba dünya\",\n\n \"transliteration\": \"TURKISH\",\n\n \"validityPeriod\": 720\n\n },\n\n {\n\n \"deliveryTimeWindow\": {\n\n \"days\": [\n\n \"MONDAY\",\n\n \"TUESDAY\",\n\n \"WEDNESDAY\",\n\n \"THURSDAY\",\n\n \"FRIDAY\",\n\n \"SATURDAY\",\n\n \"SUNDAY\"\n\n ],\n\n \"from\": {\n\n \"hour\": 6,\n\n \"minute\": 0\n\n },\n\n \"to\": {\n\n \"hour\": 15,\n\n \"minute\": 30\n\n }\n\n },\n\n \"destinations\": [\n\n {\n\n \"to\": \"4670123458\"\n\n }\n\n ],\n\n \"from\": \"4670123456\",\n\n \"sendAt\": \"{{sendAt}}\",\n\n \"text\": \"Hello World\"\n\n }\n\n ],\n\n \"tracking\": {\n\n \"track\": \"SMS\",\n\n \"type\": \"MY_CAMPAIGN\"\n\n }\n\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/sms/2/text/advanced","description":"

Send advanced SMS with all available features and parameters.

Request body schema

{\n  \"bulkId\": \" \",\n  \"messages\": [{},], \n  \"sendingSpeedLimit\":{},\n  \"urlOptions\":{},\n  \"tracking\": {},\n  \"includeSmsCountInResponse\": boolean\n}\n\n

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

Parameter	Type	Description
bulkId	String	Unique 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 to fetch delivery reports and message logs.
messages	Array of Objects	Required Array of sent message objects, one object per every message.
sendingSpeedLimit	Object	Limits the send speed when sending messages in bulk to deliver messages over a longer period of time. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic, e.g., if you are expecting recipients to follow through with a call-to-action option from a message you sent. Not setting a send speed limit can overwhelm your resources with incoming traffic.
urlOptions	Object	Sets up URL shortening and tracking feature. Not compatible with old tracking feature.
tracking	Object	Sets up tracking parameters to track conversion metrics and type.
includeSmsCountInResponse	boolean	Default: false Set to true to return smsCount in the response. Default is false. smsCount is the total count of SMS submitted in the request. SMS messages have a character limit and messages longer than that limit will be split into multiple SMS and reflected in the total count of SMS submitted.

Messages [Array of Objects]

\"messages\": [ {\n      \"callbackData\": \" \",\n      \"deliveryTimeWindow\": { },\n      \"destinations\": [ {}, ],\n      \"flash\":  ,\n      \"from\": \"\",\n      \"intermediateReport\": ,\n      \"language\": { },\n      \"notifyContentType\": \"\",\n      \"notifyUrl\": \"\",\n      \"regional\": { },\n      \"sendAt\": \"\"\n      \"text\": \"\",\n      \"transliteration\": \"\",\n      \"validityPeriod\": ,\n      \"entityId\": \"\",\n      \"applicationId\": \"\"\n }]\n\n

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

Parameter	Type	Description
callbackData	String	Additional client's data that will be sent on the notifyUrl. The maximum value is 200 characters
deliveryTimeWindow	Object	When there are restrictions on when messages can be sent, a specific SMS delivery window is often set, outside of which messages will not be delivered.
destinations	Array of Object	Required. An array of destination objects for where messages are being sent.
flash	Boolean	Default: false To enable a flash SMS, set the value to true, allowing it to appear automatically on the recipient's device without any interaction. Alternatively, leave the value as false to send a standard SMS
from	String	Represents a sender ID which can be alphanumeric or numeric. Alphanumeric sender ID length should be between 3 and 11 characters (Example: CompanyName). Numeric sender ID length should be between 3 and 14 characters.
intermediateReport	Boolean	The real-time Intermediate delivery report that will be sent on your callback server. Can be true or false
language	Object
notifyContentType	String	Preferred Delivery report content type. Can be application/json or application/xml
notifyUrl	String	The URL on your callback server on which the Delivery reports will be sent.
regional	Object	Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.
sendAT	String	Date and time when the message is to be sent. Used for scheduled SMS (SMS not sent immediately, but at scheduled time).
text	String	Text of the message that will be sent.
transliteration	String	Conversion of a message text from one script to another. Possible values: \"TURKISH\", \"GREEK\", \"CYRILLIC\", \"CENTRAL_EUROPEAN\" and \"NON_UNICODE\".
validityPeriod	integer	The message validity period in minutes. When the period expires, it will not be allowed for the message to be sent. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h).
entityId	string [ 0 .. 50 ] characters	Required for entity use in a send request for outbound traffic. Returned in notification events.
applicationId	string [ 0 .. 50 ] characters	Required for application use in a send request for outbound traffic. Returned in notification events.

deliveryTimeWindow {Object}

\"deliveryTimeWindow\": {\n        \"days\": [\"string\",\"string\"],\n        \"from\": {},\n        \"to\": {}\n      },\n\n

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

Parameter	Type	Description
days	Array of String	Required Items Enum: \"MONDAY\" \"TUESDAY\" \"WEDNESDAY\" \"THURSDAY\" \"FRIDAY\" \"SATURDAY\" \"SUNDAY\" 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.
from	Object	The exact time of day to start sending messages. Time is expressed in the UTC time zone. If set, use it together with the to property with minimum 1 hour difference.
to	Object	The exact time of day to end sending messages. Time is expressed in the UTC time zone. If set, use it together with the from property with minimum 1 hour difference.

from {object}, to {object}

        \"from\": {\n          \"hour\": integer,\n          \"minute\": integer\n        },\n        \"to\": {\n          \"hour\": integer,\n          \"minute\": integer\n        }\n\n

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

Parameter	Type	Description
hour	Integer	Required [ 0 .. 23 ]. Hour when the time window opens when used in the from property or closes when used in the to property.
minute	Integer	Required [ 0 .. 59 ]. Minute when the time window opens when used in the from property or closes when used in the to property.

destinations {Object}

\"destinations\": [\n        {\n          \"messageId\": \"string\",\n          \"to\": \"string\"\n        },\n ]\n\n

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

Parameter	Type	Description
messageId	String	The ID that uniquely identifies the message sent.
to	String	Required [ 0 .. 50 ] characters Message destination address. Addresses must be in international format (Example: 46731234567).

language {Object}

 \"language\": {\n        \"languageCode\": \"string\"\n      },\n\n

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

Parameter	Type	Description
languageCode	String	Code for language character set of a message text. Possible values: TR for Turkish, ES for Spanish and PT for Portuguese.

regional {Object}

 \"regional\": {\n        \"indiaDlt\": {},\n         \"turkeyIys\": {},\n         \"southKorea\": {},\n      },\n\n

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

Parameter	Type	Description
indiaDlt	Object	Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
turkeyIys	Object	YS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
southKorea	Object	Use case dependent parameters for sending SMS to phone numbers registered in South Korea.

indiaDlt {Object}

\"indiaDlt\": {\n        \"contentTemplateId\": \"string\",\n         \"principalEntityId\": \"string\"\n      },\n\n

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

Parameter	Type	Description
contentTemplateId	String	Registered DLT content template ID which matches message you are sending.
principalEntityId	String	Required. Your assigned DLT principal entity ID.

turkeyIys {Object}

\"turkeyIys\": {\n        \"contentTemplateId\": \"string\",\n         \"principalEntityId\": \"string\"\n      },\n\n

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

Parameter	Type	Description
brandCode	integer	Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your VHD account.
recipientType	String	Required. Enum: \"BIREYSEL\" \"TACIR\" Recipient Type must be TACIR or BIREYSEL.

southKorea {Object}

\"southKorea\": {\n        \"resellerCode\": \"integer\"\n      }\n\n

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

Parameter	Type	Description
resellerCode	integer	Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.

sendingSpeedLimit {Object}

 \"sendingSpeedLimit\": {\n    \"amount\": int<32>,\n    \"timeUnit\": \"string\"\n  }\n\n

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

Parameter	Type	Description
amount	integer	The number of messages to be sent per timeUnit. By default, the system sends messages as fast as the infrastructure allows. Use this parameter to adapt sending capacity to your needs. The system is only able to work against its maximum capacity for ambitious message batches.
timeUnit	string	Default: \"MINUTE\" Enum: \"MINUTE\" \"HOUR\" \"DAY\" The time unit to define when setting a messaging speed limit. Defaults to MINUTE.

urlOptions {Object}

 \"urlOptions\": {\n    \"shortenUrl\": boolean,\n    \"trackClicks\": boolean,\n    \"trackingUrl\": \"string\",\n    \"removeProtocol\":boolean\n  }\n\n

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

Parameter	Type	Description
shortenUrl	boolean	Default: true Enable shortening of the URLs within a message. Set this to true, if you want to set up other URL options.
trackClicks	boolean	Default: true Enable tracking of short URL clicks within a message: which URL was clicked, how many times, and by whom.
trackingUrl	string	The URL of your callback server on to which the Click report will be sent
removeProtocol	boolean	Default: false Remove a protocol, such as https://, from links to shorten a message. Note that some mobiles may not recognize such links as a URL

tracking {Object}

 \"tracking\": {\n    \"baseUrl\":\"string\",\n    \"track\": \"string\",\n    \"type\": \"string\",\n    \"processKey\": \"string\"\n  }\n\n

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

Parameter	Type	Description
baseUrl	string	Custom base URL for shortened links in messages when tracking URL conversions. Legacy - use urlOptions instead.
track	String	Indicates if the message has to be tracked for Conversion rates. Possible values: SMS and URL
type	String	User defined type of the Conversion tracking process or flow type or message type, etc. Example: ONE_TIME_PIN or SOCIAL_INVITES.
processKey	String	Key that uniquely identifies Conversion tracking process.

Response format

If successful, response header HTTP status code will be 200 OK and the message will be sent. If you try to send the message without authorization, you will receive an 401 Unauthorized error.

SMSResponse

SMSResponseDetails

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

Parameter	Type	Description
to	String	The message destination address.
status	Status	Indicates whether the message is sent successfully, not sent, delivered, not delivered, waiting for delivery or any other possible status.
smsCount	Int	The number of sent message segments. This value is not returned for scheduled messages.
messageId	String	The ID that uniquely identifies the sent message.

Status

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

Parameter	Type	Description
groupId	Int	Status group ID.
groupName	String	Status group name.
id	Int	Status ID.
name	String	Status name.
description	String	Human readable description of the status.
action	String	Action that should be taken to eliminate the error.

","urlObject":{"protocol":"https","path":["sms","2","text","advanced"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"87e9537e-6c65-4bcc-8fb0-47c9332ddbcf","name":"Fully featured textual message example 1","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\n \"bulkId\": \"BULK-ID-123-xyz\",\n\n \"messages\": [\n\n {\n\n \"callbackData\": \"DLR callback data\",\n\n \"destinations\": [\n\n {\n\n \"messageId\": \"MESSAGE-ID-123-xyz\",\n\n \"to\": \"4670123456\"\n\n },\n\n {\n\n \"to\": \"4670123457\"\n\n }\n\n ],\n\n \"flash\": false,\n\n \"from\": \"VHD\",\n\n \"intermediateReport\": true,\n\n \"language\": {\n\n \"languageCode\": \"TR\"\n\n },\n\n \"notifyContentType\": \"application/json\",\n\n \"notifyUrl\": \"https://www.example.com/sms/advanced\",\n\n \"text\": \"Merhaba dünya\",\n\n \"transliteration\": \"TURKISH\",\n\n \"validityPeriod\": 720\n\n },\n\n {\n\n \"deliveryTimeWindow\": {\n\n \"days\": [\n\n \"MONDAY\",\n\n \"TUESDAY\",\n\n \"WEDNESDAY\",\n\n \"THURSDAY\",\n\n \"FRIDAY\",\n\n \"SATURDAY\",\n\n \"SUNDAY\"\n\n ],\n\n \"from\": {\n\n \"hour\": 6,\n\n \"minute\": 0\n\n },\n\n \"to\": {\n\n \"hour\": 15,\n\n \"minute\": 30\n\n }\n\n },\n\n \"destinations\": [\n\n {\n\n \"to\": \"4670123458\"\n\n }\n\n ],\n\n \"from\": \"4670123456\",\n\n \"sendAt\": \"2021-08-25T16:00:00.000+0000\",\n\n \"text\": \"Hello World\"\n\n }\n\n ],\n\n \"tracking\": {\n\n \"track\": \"SMS\",\n\n \"type\": \"MY_CAMPAIGN\"\n\n }\n\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/sms/2/text/advanced","protocol":"https","host":["go2","vhdmedia","se"],"path":["sms","2","text","advanced"],"query":[{"key":"bulkId","value":"string","description":"The ID which uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.","disabled":true},{"key":"from","value":"string","description":"Represents a sender ID which can be alphanumeric or numeric. Alphanumeric sender ID length should be between 3 and 11 characters (Example: CompanyName). Numeric sender ID length should be between 3 and 14 characters.","type":"text","disabled":true},{"key":"to","value":"string","description":"Required. Message destination address. Addresses must be in international format (Example: 41793026727).","type":"text","disabled":true},{"key":"messageId","value":"string","description":"The ID that uniquely identifies the message sent.","type":"text","disabled":true},{"key":"text","value":"string ","description":"Required. Text of the message that will be sent.","type":"text","disabled":true},{"key":"flash","value":"boolean","description":"Can be true or false. If the value is set to true, a flash SMS will be sent. Otherwise, a normal SMS will be sent. The default value is false.","type":"text","disabled":true},{"key":"transileration","value":"string","description":"Conversion of a message text from one script to another.\nPossible values: \"TURKISH\", \"GREEK\", \"CYRILLIC\", \"CENTRAL_EUROPEAN\" and \"NON_UNICODE\".","type":"text","disabled":true},{"key":"languageCode","value":"string","description":"Code for language character set of a message text.\nPossible values: TR for Turkish, ES for Spanish and PT for Portuguese.","type":"text","disabled":true},{"key":"intermediateReport","value":"boolean","description":"The real-time Intermediate delivery report that will be sent on your callback server. Can be true or false.","type":"text","disabled":true},{"key":"notifyUrl","value":"string","description":"The URL on your callback server on which the Delivery reports will be sent.","type":"text","disabled":true},{"key":"notifyContentType","value":"string","description":"Preferred Delivery report content type. Can be application/json or application/xml.","type":"text","disabled":true},{"key":"callbackData","value":"string","description":"Additional client's data that will be sent on the notifyUrl. The maximum value is 200 characters.","type":"text","disabled":true},{"key":"validityPeriod","value":"int32","description":"The message validity period in minutes. When the period expires, it will not be allowed for the message to be sent. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h).","type":"text","disabled":true},{"key":"sendAT","value":"date","description":"Date and time when the message is to be sent. Used for scheduled SMS (SMS not sent immediately, but at scheduled time).","type":"text","disabled":true},{"key":"hour","value":"int32","description":"Hour when the time window opens when used in from property or closes when used in to property.","type":"text","disabled":true},{"key":"minute","value":"int32","description":"Minute when the time window opens when used in from property or closes when used in to property.","type":"text","disabled":true},{"key":"days","value":"array of strings ","description":"Days which are included in the delivery time window. Values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY. At least one day must be stated.","type":"text","disabled":true},{"key":"track","value":"string","description":"Indicates if the message has to be tracked for Conversion rates.\nPossible values: SMS and URL","type":"text","disabled":true},{"key":"processKey","value":"string","description":"Key that uniquely identifies Conversion tracking process.","type":"text","disabled":true},{"key":"type","value":"string ","description":"User defined type of the Conversion tracking process or flow type or message type, etc. Example: ONE_TIME_PIN or SOCIAL_INVITES.","type":"text","disabled":true}]}},"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":"614"},{"key":"Date","value":"Thu, 09 Mar 2023 21:14:29 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1678396470120660227"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"BULK-ID-123-xyz\",\n \"messages\": [\n {\n \"to\": \"4670123456\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"messageId\": \"37839647015934994017\",\n \"smsCount\": 1\n },\n {\n \"to\": \"4670123457\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"messageId\": \"37839647015934994018\",\n \"smsCount\": 1\n },\n {\n \"to\": \"4670123458\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"messageId\": \"MESSAGE-ID-123-xyz\",\n \"smsCount\": 1\n }\n ]\n}"},{"id":"b2c63025-b33a-41b8-9df4-160659100acb","name":"Fully featured textual message example 2","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\n \"bulkId\": \"BULK-ID-123-xyz\",\n\n \"messages\": [\n\n {\n\n \"callbackData\": \"DLR callback data\",\n\n \"destinations\": [\n\n {\n\n \"messageId\": \"MESSAGE-ID-123-xyz\",\n\n \"to\": \"4670123456\"\n\n },\n\n {\n\n \"to\": \"4670123457\"\n\n }\n\n ],\n\n \"flash\": false,\n\n \"from\": \"VHD\",\n\n \"intermediateReport\": true,\n\n \"language\": {\n\n \"languageCode\": \"TR\"\n\n },\n\n \"notifyContentType\": \"application/json\",\n\n \"notifyUrl\": \"https://www.example.com/sms/advanced\",\n\n \"text\": \"Merhaba dünya\",\n\n \"transliteration\": \"TURKISH\",\n\n \"validityPeriod\": 720\n\n },\n\n {\n\n \"deliveryTimeWindow\": {\n\n \"days\": [\n\n \"MONDAY\",\n\n \"TUESDAY\",\n\n \"WEDNESDAY\",\n\n \"THURSDAY\",\n\n \"FRIDAY\",\n\n \"SATURDAY\",\n\n \"SUNDAY\"\n\n ],\n\n \"from\": {\n\n \"hour\": 6,\n\n \"minute\": 0\n\n },\n\n \"to\": {\n\n \"hour\": 15,\n\n \"minute\": 30\n\n }\n\n },\n\n \"destinations\": [\n\n {\n\n \"to\": \"4670123458\"\n\n }\n\n ],\n\n \"from\": \"4670123456\",\n\n \n\n \"text\": \"To find out more on messaging go to https://www.vhdmedia.se/tjanster/\"\n \n\n }\n\n ],\n\n\n \"sendingSpeedLimit\": {\n \"amount\": 1,\n \"timeUnit\": \"minute\"\n },\n\n \"urlOptions\": {\n \"shortenUrl\": true,\n \"trackClicks\": true,\n \"trackingUrl\": \"https://mybrand.com/track-url-clicks-webhook\",\n \"removeProtocol\":true\n \n },\n \"includeSmsCountInResponse\": true\n\n\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/sms/2/text/advanced"},"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":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"623"},{"key":"x-http2-stream-id","value":"4041"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1683196074663422836"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"BULK-ID-123-xyz\",\n \"messages\": [\n {\n \"messageId\": \"MESSAGE-ID-123-xyz\",\n \"status\": {\n \"description\": \"Message sent to next instance\",\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\"\n },\n \"to\": \"4670123456\",\n \"smsCount\": 1\n },\n {\n \"messageId\": \"3831960746854335621918\",\n \"status\": {\n \"description\": \"Message sent to next instance\",\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\"\n },\n \"to\": \"4670123457\",\n \"smsCount\": 1\n },\n {\n \"messageId\": \"3831960746854335621919\",\n \"status\": {\n \"description\": \"Message sent to next instance\",\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\"\n },\n \"to\": \"4670123458\",\n \"smsCount\": 1\n }\n ]\n}"},{"id":"4f5a6345-2381-4434-9d89-cbb3141dff45","name":"Fully featured textual message Scheduled SMS","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"bulkId\": \"BULK-ID-VHD\",\n \"messages\": [\n {\n \"callbackData\": \"DLR callback data\",\n \"destinations\": [\n {\n \"messageId\": \"MESSAGE-ID-123-xyz\",\n \"to\": \"41793026727\"\n },\n {\n \"to\": \"41793026834\"\n }\n ],\n \"flash\": false,\n \"from\": \"VHD\",\n \"intermediateReport\": true,\n \"language\": {\n \"languageCode\": \"TR\"\n },\n \"notifyContentType\": \"application/json\",\n \"notifyUrl\": \"https://www.example.com/sms/advanced\",\n \"text\": \"Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.\",\n \"transliteration\": \"TURKISH\",\n \"validityPeriod\": 720\n },\n {\n \"deliveryTimeWindow\": {\n \"days\": [\n \"MONDAY\",\n \"TUESDAY\",\n \"WEDNESDAY\",\n \"THURSDAY\",\n \"FRIDAY\",\n \"SATURDAY\",\n \"SUNDAY\"\n ],\n \"from\": {\n \"hour\": 6,\n \"minute\": 0\n },\n \"to\": {\n \"hour\": 15,\n \"minute\": 30\n }\n },\n \"destinations\": [\n {\n \"to\": \"41793026700\"\n }\n ],\n \"from\": \"41793026700\",\n \"sendAt\": \"2024-03-02T09:34:00.000+0000\",\n \"text\": \"A long time ago, in a galaxy far, far away... It is a period of civil war. Rebel spaceships, striking from a hidden base, have won their first victory against the evil Galactic Empire.\"\n }\n ],\n \"tracking\": {\n \"track\": \"SMS\",\n \"type\": \"MY_CAMPAIGN\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/sms/2/text/advanced"},"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":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"582"},{"key":"x-http2-stream-id","value":"3681"},{"key":"server","value":"SMS API"},{"key":"x-request-id","value":"1709286347846241830"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"BULK-ID-VHD\",\n \"messages\": [\n {\n \"messageId\": \"MESSAGE-ID-123-xyz\",\n \"status\": {\n \"description\": \"Message sent to next instance\",\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\"\n },\n \"to\": \"41793026727\"\n },\n {\n \"messageId\": \"4092863478724335888340\",\n \"status\": {\n \"description\": \"Message sent to next instance\",\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\"\n },\n \"to\": \"41793026834\"\n },\n {\n \"messageId\": \"4092863478724335888341\",\n \"status\": {\n \"description\": \"Message sent to next instance\",\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\"\n },\n \"to\": \"41793026700\"\n }\n ]\n}"},{"id":"ca60ba98-2ecf-444a-ae09-eda19b283631","name":"Simple message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"destinations\": [\n {\n \"to\": \"4670123456\"\n },\n {\n \"to\": \"4670123457\"\n }\n ],\n \"from\": \"vhd\",\n \"text\": \"Hello World\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/sms/2/text/advanced","protocol":"https","host":["go2","vhdmedia","se"],"path":["sms","2","text","advanced"],"query":[{"key":"bulkId","value":"string","description":"The ID which uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.","disabled":true},{"key":"from","value":"string","description":"Represents a sender ID which can be alphanumeric or numeric. Alphanumeric sender ID length should be between 3 and 11 characters (Example: CompanyName). Numeric sender ID length should be between 3 and 14 characters.","type":"text","disabled":true},{"key":"to","value":"string","description":"Required. Message destination address. Addresses must be in international format (Example: 41793026727).","type":"text","disabled":true},{"key":"messageId","value":"string","description":"The ID that uniquely identifies the message sent.","type":"text","disabled":true},{"key":"text","value":"string ","description":"Required. Text of the message that will be sent.","type":"text","disabled":true},{"key":"flash","value":"boolean","description":"Can be true or false. If the value is set to true, a flash SMS will be sent. Otherwise, a normal SMS will be sent. The default value is false.","type":"text","disabled":true},{"key":"transileration","value":"string","description":"Conversion of a message text from one script to another.\nPossible values: \"TURKISH\", \"GREEK\", \"CYRILLIC\", \"CENTRAL_EUROPEAN\" and \"NON_UNICODE\".","type":"text","disabled":true},{"key":"languageCode","value":"string","description":"Code for language character set of a message text.\nPossible values: TR for Turkish, ES for Spanish and PT for Portuguese.","type":"text","disabled":true},{"key":"intermediateReport","value":"boolean","description":"The real-time Intermediate delivery report that will be sent on your callback server. Can be true or false.","type":"text","disabled":true},{"key":"notifyUrl","value":"string","description":"The URL on your callback server on which the Delivery reports will be sent.","type":"text","disabled":true},{"key":"notifyContentType","value":"string","description":"Preferred Delivery report content type. Can be application/json or application/xml.","type":"text","disabled":true},{"key":"callbackData","value":"string","description":"Additional client's data that will be sent on the notifyUrl. The maximum value is 200 characters.","type":"text","disabled":true},{"key":"validityPeriod","value":"int32","description":"The message validity period in minutes. When the period expires, it will not be allowed for the message to be sent. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h).","type":"text","disabled":true},{"key":"sendAT","value":"date","description":"Date and time when the message is to be sent. Used for scheduled SMS (SMS not sent immediately, but at scheduled time).","type":"text","disabled":true},{"key":"hour","value":"int32","description":"Hour when the time window opens when used in from property or closes when used in to property.","type":"text","disabled":true},{"key":"minute","value":"int32","description":"Minute when the time window opens when used in from property or closes when used in to property.","type":"text","disabled":true},{"key":"days","value":"array of strings ","description":"Days which are included in the delivery time window. Values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY. At least one day must be stated.","type":"text","disabled":true},{"key":"track","value":"string","description":"Indicates if the message has to be tracked for Conversion rates.\nPossible values: SMS and URL","type":"text","disabled":true},{"key":"processKey","value":"string","description":"Key that uniquely identifies Conversion tracking process.","type":"text","disabled":true},{"key":"type","value":"string ","description":"User defined type of the Conversion tracking process or flow type or message type, etc. Example: ONE_TIME_PIN or SOCIAL_INVITES.","type":"text","disabled":true}]}},"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":"429"},{"key":"Date","value":"Thu, 09 Mar 2023 21:09:58 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1678396198909008663"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"37839619891537213988\",\n \"messages\": [\n {\n \"to\": \"4670123456\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"messageId\": \"37839619891537213990\",\n \"smsCount\": 1\n },\n {\n \"to\": \"4670123457\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"messageId\": \"37839619891537213989\",\n \"smsCount\": 1\n }\n ]\n}"},{"id":"45042c55-423a-48ea-a7ee-42573aec1714","name":"ShortenUrl default","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\n \"messages\": [\n\n {\n\n\n \"destinations\": [\n\n {\n\n \"to\": \"4670123456\"\n\n }\n\n ],\n\n \"text\": \"To find out more on messaging go to https://www.vhdmedia.se\"\n\n }\n\n ],\n\n \"urlOptions\": {\n \"shortenUrl\": true\n }\n\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/sms/2/text/advanced"},"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":"207"},{"key":"Date","value":"Wed, 03 May 2023 14:14:22 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1683123262879801836"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n {\n \"to\": \"4670123456\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"messageId\": \"38312326290133825258\",\n \"smsCount\": 1\n }\n ]\n}"}],"_postman_id":"164621bc-e3f0-430c-90b0-7fd363a5e797"},{"name":"Fully feaured binary message","event":[{"listen":"test","script":{"id":"13c8b5e8-2a9e-4835-b2f3-b9e22b559b08","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();","","// Extract 'to' numbers from the request body","var toNumbersInRequest = [];","try {"," var requestBodyJson = pm.request.json();"," requestBodyJson.messages.forEach(function(message) {"," message.destinations.forEach(function(destination) {"," // Log the 'to' number being extracted"," console.log(\"Extracted 'to' number:\", destination.to);"," toNumbersInRequest.push(destination.to);"," });"," });"," // Log the extracted 'to' numbers for debugging"," console.log(\"To Numbers in Request:\", toNumbersInRequest);","} catch (error) {"," console.log(\"Error parsing request body as JSON:\", error);","}","","// 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, index) {"," pm.expect(message).to.have.property('messageId');"," pm.expect(message).to.have.property('status');"," pm.expect(message.status).to.have.property('description');"," pm.expect(message.status).to.have.property('groupId');"," pm.expect(message.status).to.have.property('groupName');"," pm.expect(message.status).to.have.property('id');"," pm.expect(message.status).to.have.property('name');",""," // Check if 'text' property exists in the message"," if ('text' in message) {"," // Calculate the number of SMS messages required based on the character count of the text"," var textLength = message.text.length;"," var smsCount = Math.ceil(textLength / 160); // Assuming 160 characters per SMS",""," // Assert the smsCount property"," pm.expect(message).to.have.property('smsCount', smsCount);"," } else {"," console.log(\"text property not found in message:\", message);"," }",""," // Check if 'to' property exists in the message"," if ('to' in message) {"," // Check if index is within bounds of toNumbersInRequest array"," if (index < toNumbersInRequest.length) {"," // Expect the 'to' property to be equal to the extracted 'to' number"," pm.expect(message.to).to.eql(toNumbersInRequest[index]);"," } else {"," console.log(\"Index out of bounds for toNumbersInRequest array\");"," }"," } else {"," console.log(\"to property not found in message:\", message);"," }"," });","});","","// Test if system-assigned bulkId exists in the response","pm.test(\"BulkId exists in the response\", function () {"," pm.expect(responseBody).to.have.property('bulkId');"," // Add additional checks for bulkId if required, such as format or specific properties","});"],"type":"text/javascript","packages":{}}}],"id":"3f836d04-1c2d-4750-a678-2058a236266d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"bulkId\": \"BULK-ID-123-xyz\",\n \"messages\": [\n {\n \"binary\": {\n \"dataCoding\": 0,\n \"esmClass\": 0,\n \"hex\": \"54 65 73 74 20 6d 65 73 73 61 67 65 2e\"\n },\n \"callbackData\": \"DLR callback data\",\n \"destinations\": [\n {\n \"messageId\": \"MESSAGE-ID-123-xyz\",\n \"to\": \"41793026727\"\n },\n {\n \"to\": \"41793026834\"\n }\n ],\n \"flash\": true,\n \"from\": \"VHD\",\n \"intermediateReport\": true,\n \"notifyContentType\": \"application/json\",\n \"notifyUrl\": \"https://www.example.com/sms/advanced\",\n \"validityPeriod\": 720\n },\n {\n \"binary\": {\n \"dataCoding\": 0,\n \"esmClass\": 0,\n \"hex\": \"41 20 6C 6F 6E 67 20 74 …20 45 6D 70 69 72 65 2E\"\n },\n \"deliveryTimeWindow\": {\n \"days\": [\n \"MONDAY\",\n \"TUESDAY\",\n \"WEDNESDAY\",\n \"THURSDAY\",\n \"FRIDAY\",\n \"SATURDAY\",\n \"SUNDAY\"\n ],\n \"from\": {\n \"hour\": 6,\n \"minute\": 0\n },\n \"to\": {\n \"hour\": 15,\n \"minute\": 30\n }\n },\n \"destinations\": [\n {\n \"to\": \"41793026727\"\n }\n ],\n \"from\": \"41793026727\",\n \"sendAt\": \"2021-08-25T16:00:00.000+0000\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/sms/2/binary/advanced","description":"

Send single or multiple binary messages to one or more destination address.

Request body schema

{\n  \"bulkId\": \" \",\n  \"messages\": [{},]\n}\n\n

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

Parameter	Type	Description
bulkId	String	Required When sending multiple messages or messaging multiple recipients through a single API request, a distinct identifier is assigned to the request. If this identifier is not provided, it will be automatically generated and returned as part of the API response. This identifier is usually used to retrieve delivery reports and message logs.
messages	Array of Objects	Required Array of sent message objects, one object per every message.

Messages [Array of Objects]

\"messages\": [{\n      \"binary\": {},\n      \"callbackData\": \"\",\n      \"destinations\": [ {},],\n      \"flash\": ,\n      \"from\": \"\",\n      \"intermediateReport\": ,\n      \"notifyContentType\": \"\",\n      \"notifyUrl\": \"\",\n      \"validityPeriod\": ,\n      \"deliveryTimeWindow\": {},\n      \"sendAt\": \"\"\n }]\n\n

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

Parameter	Type	Description
binary	Object
callbackData	String	Additional client's data that will be sent on the notifyUrl. The maximum value is 200 characters
destinations	Array of Object	Required. An array of destination objects for where messages are being sent.
flash	Boolean	Default: false To enable a flash SMS, set the value to true, allowing it to appear automatically on the recipient's device without any interaction. Alternatively, leave the value as false to send a standard SMS
from	String	Represents a sender ID which can be alphanumeric or numeric. Alphanumeric sender ID length should be between 3 and 11 characters (Example: CompanyName). Numeric sender ID length should be between 3 and 14 characters.
intermediateReport	Boolean	The real-time Intermediate delivery report that will be sent on your callback server. Can be true or false
notifyContentType	String	Preferred Delivery report content type. Can be application/json or application/xml
notifyUrl	String	The URL on your callback server on which the Delivery reports will be sent.
validityPeriod	Integer32	The message validity period in minutes. When the period expires, it will not be allowed for the message to be sent. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h).
deliveryTimeWindow	Object	When there are restrictions on when messages can be sent, a specific SMS delivery window is often set, outside of which messages will not be delivered.
sendAT	String	Date and time when the message is to be sent. Used for scheduled SMS (SMS not sent immediately, but at scheduled time).

binary {Object}

\"binary\": {\n        \"dataCoding\": ,\n        \"esmClass\": ,\n        \"hex\": \"\"\n      }\n\n

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

Parameter	Type	Description
dataCoding	Integer	Binary content data coding. The default value is (0) for GSM7. Example: (8) for Unicode data.
esmClass	Integer	“Esm_class” parameter. Indicate special message attributes associated with the SMS. Default value is (0).
hex	string	Hexadecimal string. This is the representation of your binary data. Two hex digits represent one byte. They should be separated by the space character (Example: 0f c2 4a bf 34 13 ba).

destinations {Object}

\"destinations\": [\n        {\n          \"messageId\": \"string\",\n          \"to\": \"string\"\n        },\n ]\n\n

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

Parameter	Type	Description
messageId	String	The ID that uniquely identifies the message sent.
to	String	Required [ 0 .. 50 ] characters Message destination address. Addresses must be in international format (Example: 46731234567).

deliveryTimeWindow {Object}

\"deliveryTimeWindow\": {\n        \"days\": [\"string\",\"string\"],\n        \"from\": {},\n        \"to\": {}\n      },\n\n

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

Parameter	Type	Description
days	Array of String	Required Items Enum: \"MONDAY\" \"TUESDAY\" \"WEDNESDAY\" \"THURSDAY\" \"FRIDAY\" \"SATURDAY\" \"SUNDAY\" 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.
from	Object	The exact time of day to start sending messages. Time is expressed in the UTC time zone. If set, use it together with the to property with minimum 1 hour difference.
to	Object	The exact time of day to end sending messages. Time is expressed in the UTC time zone. If set, use it together with the from property with minimum 1 hour difference.

from {object}, to {object}

        \"from\": {\n          \"hour\": integer,\n          \"minute\": integer\n        },\n        \"to\": {\n          \"hour\": integer,\n          \"minute\": integer\n        }\n\n

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

Parameter	Type	Description
hour	Integer	Required [ 0 .. 23 ]. Hour when the time window opens when used in the from property or closes when used in the to property.
minute	Integer	Required [ 0 .. 59 ]. Minute when the time window opens when used in the from property or closes when used in the to property.

Response format

If successful, response header HTTP status code will be 200 OK and the message will be sent. If you try to send the message without authorization, you will receive an 401 Unauthorized error.

SMSResponse

SMSResponseDetails

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

Parameter	Type	Description
to	String	The message destination address.
status	Status	Indicates whether the message is sent successfully, not sent, delivered, not delivered, waiting for delivery or any other possible status.
smsCount	Int	The number of sent message segments. This value is not returned for scheduled messages.
messageId	String	The ID that uniquely identifies the sent message.

Status

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

Parameter	Type	Description
groupId	Int	Status group ID.
groupName	String	Status group name.
id	Int	Status ID.
name	String	Status name.
description	String	Human readable description of the status.
action	String	Action that should be taken to eliminate the error.

","urlObject":{"protocol":"https","path":["sms","2","binary","advanced"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"fa187fe4-418b-4fc7-91ba-2f1dba4e1a70","name":"Send fully feaured binary message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"bulkId\": \"BULK-ID-123-xyz\",\n \"messages\": [\n {\n \"binary\": {\n \"dataCoding\": 0,\n \"esmClass\": 0,\n \"hex\": \"54 65 73 74 20 6d 65 73 73 61 67 65 2e\"\n },\n \"callbackData\": \"DLR callback data\",\n \"destinations\": [\n {\n \"messageId\": \"MESSAGE-ID-123-xyz\",\n \"to\": \"4670123457\"\n },\n {\n \"to\": \"4670123458\"\n }\n ],\n \"flash\": true,\n \"from\": \"VHD\",\n \"intermediateReport\": true,\n \"notifyContentType\": \"application/json\",\n \"notifyUrl\": \"https://www.example.com/sms/advanced\",\n \"validityPeriod\": 720\n },\n {\n \"binary\": {\n \"dataCoding\": 0,\n \"esmClass\": 0,\n \"hex\": \"41 20 6C 6F 6E 67 20 74 …20 45 6D 70 69 72 65 2E\"\n },\n \"deliveryTimeWindow\": {\n \"days\": [\n \"MONDAY\",\n \"TUESDAY\",\n \"WEDNESDAY\",\n \"THURSDAY\",\n \"FRIDAY\",\n \"SATURDAY\",\n \"SUNDAY\"\n ],\n \"from\": {\n \"hour\": 6,\n \"minute\": 0\n },\n \"to\": {\n \"hour\": 15,\n \"minute\": 30\n }\n },\n \"destinations\": [\n {\n \"to\": \"4670123459\"\n }\n ],\n \"from\": \"4670123456\",\n \"sendAt\": \"2021-08-25T16:00:00.000+0000\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/sms/1/binary/advanced"},"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":"615"},{"key":"Date","value":"Sat, 11 Mar 2023 09:57:24 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1678528645251120830"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"BULK-ID-123-xyz\",\n \"messages\": [\n {\n \"to\": \"4670123457\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"messageId\": \"37852864526237213687\",\n \"smsCount\": 1\n },\n {\n \"to\": \"4670123458\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"messageId\": \"37852864526237213688\",\n \"smsCount\": 1\n },\n {\n \"to\": \"4670123459\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"messageId\": \"MESSAGE-ID-123-xyz\",\n \"smsCount\": 1\n }\n ]\n}"},{"id":"ca55c9d7-7086-4532-b611-b7357c2518ff","name":"Unicode flash binary SMS","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"binary\": {\n \"dataCoding\": 8,\n \"esmClass\": 0,\n \"hex\": \"0048 0065 006c 006c 006f 0020 0077 006f 0072 006c 0064 002c 0020 039a 03b1 03bb 03b7 03bc 03ad 03c1 03b1 0020 03ba 03cc 03c3 03bc 03b5 002c 0020 30b3 30f3 30cb 30c1 30cf\"\n },\n \"destinations\": [\n {\n \"to\": \"4670123456\"\n }\n ],\n \"flash\": true,\n \"from\": \"VHD\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/sms/1/binary/advanced"},"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":"206"},{"key":"Date","value":"Sat, 11 Mar 2023 10:52:49 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1678531969979179227"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n {\n \"to\": \"4670123456\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"messageId\": \"37853196998703536443\",\n \"smsCount\": 1\n }\n ]\n}"}],"_postman_id":"3f836d04-1c2d-4750-a678-2058a236266d"},{"name":"SMS over URL parameters","id":"6ae761a1-0a36-441b-aee7-46771c0d2dfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://go2.vhdmedia.se/sms/1/text/query","description":"

Send SMS by including all of the required parameters in the URL using HTTP GET request.

Owning custom-made applications tailored for specific requirements of a single organization is an expensive privilege few can afford. Using third-party software solutions for your business needs is a more common case for businesses today. These \"generic\" applications are usually highly configurable in order to cover the widest range of use cases. No matter how clever the application is designed, it seems like there is always at least one crucial feature missing.

If you happen to have one of those applications, you probably have options to configure different workflows and triggers. Often the application also offers integration options too. Due to its generic nature, the application has to cover a variety of integration scenarios and also keep a certain level of simplicity to remain intuitive and usable. This trade-off between options and usability can result in a solution with limited integration possibilities.

Integrating our REST API method for sending SMS in such an application may be impossible since you have to configure the request type, headers, and body model. This is something that is usually handled by developers and this type of application will not allow you to write custom code. At best it will provide you with a single input to enter the URL of the service you want to trigger, and that's it.

Important!

Please use this method to send messages only when you don't have the option to integrate via the fully-featured SMS method.

Please keep in mind:

This method does not support API key authorization. You are sending the username and password over the network which is less secure than using an API key.
\n
Your application should support the URL encoding of your requests. Messages that are not properly formatted may be delivered with incorrectly encoded text or not delivered at all.
\n

EndFragment

Simple SMS with basic parameters

With this single input, we have designed a method which allows you to send SMS in a single line of the HTTP request:

JSON
\n
XML
\n
PHP
\n

GET /sms/1/text/query?username=myUsername&password=myPassword&to=46701234567&text=Message text HTTP/1.1\nHost: go2.vhdmedia.se\nAccept: application/json\n\n

GET /sms/1/text/query?username=myUsername&password=myPassword&to=46701234567&text=Message text HTTP/1.1\nHost: go2.vhdmedia.se\nAccept: application/xml\n\n

This is all you need to send a message. You can even send this message through your web browser address bar, the same way you would type an address to open a web page. Now, this is something that you could put into your application without writing any code!

The response will be identical to a fully-featured SMS response:

JSON

{\n  \"bulkId\": \"1478520834465349757\",\n  \"messages\": [\n    {\n      \"to\": \"46701234567\",\n      \"status\": {\n        \"groupId\": 1,\n        \"groupName\": \"PENDING\",\n        \"id\": 7,\n        \"name\": \"PENDING_ENROUTE\",\n        \"description\": \"Message sent to next instance\"\n      },\n      \"smsCount\": 1,\n      \"messageId\": \"844acc75-e5c6-4a21-a7e3-444c412c385b\"\n    }\n  ]\n}\n\n

XML response format

The default response format is JSON. However, if you would like to receive XML instead, you may specify the format .xml extension at the end of the method base URL, such as:

http://go2.vhdmedia.se/sms/1/text/query.xml

There is one more catch. You will probably need to replace hard-coded values like phone number and message text with placeholders unless you want to send the same message to the same recipient every time. Placeholder names will be provided by the application system you are using. What you need to understand is where to put the placeholders. Let's break down our example request in several lines so we can examine it closely:

https://go2.vhdmedia.se/sms/1/text/query/sms/1/text/query?\nusername=myUsername\n&password=myPassword\n&to=46701234567\n&text=Message text\n\n

The first line is the API endpoint and this never changes. The question mark at the end represents beginning of the query string parameters. It's a system of key / value pairs separated by symbol &. It's quite clear now what the values are and which values you will need to replace by a value placeholder.

&to=%phoneNumber%\n&text=%message%\n\n

Value placeholders

Placeholder names and format will vary depending on your application. Refer to your application documentation for instructions.

Here is the final result:

https://go2.vhdmedia.se/sms/1/text/query/sms/1/text/query?username=myUsername&password=myPassword&to=%phoneNumber%&text=%message%\n\n

Your application should now dynamically send different messages to different recipients and dynamically replace placeholders with the recipient's phone number and message.

Key / value pairs

It's important to understand how to properly format the query string in order to make it work properly. This rule must be followed:

http://go2.vhdmedia.se/sms/1/text/query ?key=value&key=value&key=` value

The sorting order of key/value pairs is not important as long as it's well formatted. If your application supports placeholders, you should use it to replace values only!

Multiple recipients

Sending messages to multiple recipients at once is also supported, as long as they all get the same message. The URL is basically the same as with simple SMS. The only difference is in the to key where you need to separate recipients by a comma.

https://go2.vhdmedia.se/sms/1/text/query?username=myUsername&password=myPassword&to=46701234567,46761234567&text=Message text\n\n

Closer look:

&to=46701234567,46761234567\n\n

Fully-featured SMS

You can use this method to send an SMS with almost all features of our standard fully-featured SMS.

Optional key value pairs:

&from=VHD\n&flash=true\n&transliteration=TURKISH\n&languageCode=TR\n&intermediateReport=true\n¬ifyUrl=https//www.example.com\n¬ifyContentType=application/json\n&callbackData=callbackData\n&validityPeriod=86400000\n&track=SMS\n&processKey=A612ECB0F62799FDC12EC50D2A6F0472\n&trackingType=Custom+field+test\n\n

Refer to our fully-featured SMS documentation for an explanation of each parameter.

\n","urlObject":{"protocol":"https","path":["sms","1","text","query"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[],"_postman_id":"6ae761a1-0a36-441b-aee7-46771c0d2dfa"},{"name":"Preview SMS message","event":[{"listen":"test","script":{"id":"94c7dfc8-4c0a-46f2-87eb-804ff8125bef","exec":["// Get the text from the request body","var requestBody = pm.request.body;","var text = requestBody.raw;","","// Remove leading and trailing whitespaces","text = text.trim();","","// Calculate the character count","var characterCount = text.length;","","// Calculate the number of messages","var messageCount = Math.ceil(characterCount / 160);","","// Calculate remaining characters after last complete message","var remainingCharacters = 160 - (characterCount % 160);","","// Test for status code 200","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","// Validate the calculated values","pm.test(\"Number of characters: \" + characterCount, function () {"," pm.expect(characterCount).to.eql(176); // Replace with the expected character count","});","","pm.test(\"Number of messages: \" + messageCount, function () {"," pm.expect(messageCount).to.eql(2); // Replace with the expected message count","});","","pm.test(\"Remaining characters after last complete message: \" + remainingCharacters, function () {"," pm.expect(remainingCharacters).to.eql(144); // Replace with the expected remaining characters","});",""],"type":"text/javascript","packages":{}}}],"id":"dc307d80-45c3-452f-a4ed-99886345da5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"text\": \" Let's see how many characters remain unused in this message.Let's see how many characters remain unused in this message.Let's see.1111111111111111111111111111 \"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/sms/1/preview","description":"

Avoid unpleasant surprises and check how different message configurations will affect your message text, number of characters and message parts.

Request body schema

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

Parameter	Type	Description
text	String	Content of the message being sent.
languageCode	string ^(TR	ES
transliteration	string ^(TURKISH	GREEK

","urlObject":{"protocol":"https","path":["sms","1","preview"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"a3a689a0-b1da-41e6-a80b-979982105518","name":"Preview response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"text\": \"Let's see how many characters remain unused in this message.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/sms/1/preview"},"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":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"233"},{"key":"x-http2-stream-id","value":"2483"},{"key":"server","value":"SMS API"},{"key":"x-request-id","value":"1705582076633221663"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"originalText\": \"Let's see how many characters remain unused in this message.\",\n \"previews\": [\n {\n \"textPreview\": \"Let's see how many characters remain unused in this message.\",\n \"messageCount\": 1,\n \"charactersRemaining\": 100,\n \"configuration\": {}\n }\n ]\n}"}],"_postman_id":"dc307d80-45c3-452f-a4ed-99886345da5a"}],"id":"38e5bbbe-7eef-4ce4-aba3-db5ad15dbfff","_postman_id":"38e5bbbe-7eef-4ce4-aba3-db5ad15dbfff","description":""},{"name":"RECEIVE SMS","item":[{"name":"Receive SMS by Pull method","event":[{"listen":"test","script":{"id":"2b710954-fbc1-4516-8daf-860b43b27a5a","exec":["// Get the limit from the request body if it exists","var requestBody = pm.request.body;","var limit = requestBody.hasOwnProperty('limit') ? requestBody.limit : null;","","// Validate the presence of 'limit' in the request body if it exists","if (limit !== null) {"," pm.test(\"Request body has 'limit'\", function () {"," pm.expect(limit).to.exist;"," });","}","","// Test for status code 200","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","// Parse the response body as JSON","var responseBody = pm.response.json();","","// Validate the presence of expected parameters in the response body","pm.test(\"Response contains 'results'\", function () {"," pm.expect(responseBody).to.have.property('results');","});","","pm.test(\"Response contains 'messageCount'\", function () {"," pm.expect(responseBody).to.have.property('messageCount');","});","","pm.test(\"Response contains 'pendingMessageCount'\", function () {"," pm.expect(responseBody).to.have.property('pendingMessageCount');","});",""],"type":"text/javascript","packages":{}}}],"id":"3eee7fbf-047e-4946-b357-9a11d9fac361","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 \"limit\": 2\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/sms/1/inbox/reports","description":"

If for some reason you are unable to receive incoming SMS to the endpoint of your choice in real time, you can use this API call to fetch messages. Each request will return a batch of received messages - only once. The API request will only return new messages that arrived since the last API request.

Important

All received messages can be pulled only once! Once a certain message has been pulled by this method, it will not be available for the next API call. This means that every time you make an API call, you will receive only new messages that arrived since the last API call.

Query parameters

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

Parameter	Type	Description
limit	integer	Maximum number of messages to be returned in a response. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access messages for the last 48h.

Response format

If successful, the response header HTTP status code will be 200 OK and messages will be returned in the response body. If you try to get received messages without authorization, you will get a response with HTTP status code 401 Unauthorized.

SMSResponse

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

Parameter	Type	Description
results	Messages	Collection of reports, one per every received message.
messageCount	Int	Number of returned messages in this request.
pendingMessageCount	Int	Number of remaining new messages on our server ready to be returned in the next API call.

Messages

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

Parameter	Type	Description
messageId	String	The ID that uniquely identifies the received message.
from	String	Sender ID that can be alphanumeric or numeric.
to	String	The message destination address.
text	String	Full text of the received message.
cleanText	String	Text of received message without a keyword (if a keyword was sent).
keyword	String	Keyword extracted from the message text.
receivedAt	Date	Tells when our system received the message. It has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSXXX`.
smsCount	Int	The number of sent message segments.
pricePerMessage	Decimal	Cost of receiving a message.
currency	String	Currency of the message price.
callbackData	Int	Custom callback data can be inserted during the setup phase.

","urlObject":{"protocol":"https","path":["sms","1","inbox","reports"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"bab2ad34-c9d6-488d-8a18-4c6c23a2aa98","name":"Receive SMS by Pull method","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"limit\": 2\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/sms/1/inbox/reports"},"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":"293"},{"key":"Date","value":"Tue, 21 Mar 2023 07:22:12 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1679383332847948828"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"messageId\": \"5979214246198724922\",\n \"from\": \"4670123456\",\n \"to\": \"71611\",\n \"text\": \"STOPVHD Test2\",\n \"cleanText\": \"Test2\",\n \"keyword\": \"STOPVHD\",\n \"receivedAt\": \"2023-03-21T07:21:42.617+0000\",\n \"smsCount\": 1,\n \"price\": {\n \"pricePerMessage\": 0,\n \"currency\": \"SEK\"\n }\n }\n ],\n \"messageCount\": 1,\n \"pendingMessageCount\": 0\n}"}],"_postman_id":"3eee7fbf-047e-4946-b357-9a11d9fac361"},{"name":"Receive SMS by forward method","id":"71ff72e8-5643-41f4-acb7-beea566bb71c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"results\": [\n {\n \"messageId\": \"817790313235066447\",\n \"from\": \"test\",\n \"to\": \"46701923177\",\n \"text\": \"QUIZ Correct answer is Paris\",\n \"cleanText\": \"Correct answer is Paris\",\n \"keyword\": \"QUIZ\",\n \"receivedAt\": \"2016-10-06T09:28:39.220+0000\",\n \"smsCount\": 1,\n \"price\": {\n \"pricePerMessage\": 0,\n \"currency\": \"EUR\"\n },\n \"callbackData\": \"callbackData\"\n }\n ],\n \"messageCount\": 1,\n \"pendingMessageCount\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://{yourDomain}/your/webhook/path","description":"

If you want to receive SMS messages from your subscribers we can have them delivered to you in real time. When you buy and configure a number capable of receiving SMS, specify your endpoint and we will send inbound messages to you as soon as they are delivered to us by a mobile network operator.

Request body schema

{\n  \"results\": [{}],\n  \"messageCount\": ,\n  \"pendingMessageCount\": \n}\n\n

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

Parameter	Type	Description
results	Array of Object	Collection of reports, one per every received message.
messageCount	Int	Number of returned messages in this request.
pendingMessageCount	Int	Number of remaining new messages on our server ready to be returned in the next API call.

results [Array of Objects]

\"results\": [\n{\n\"messageId\": \"\",\n\"from\": \"\",\n\"to\": \"\",\n\"text\": \"\",\n\"cleanText\": \"\",\n\"keyword\": \"\",\n\"receivedAt\": \"\",\n\"smsCount\": ,\n\"price\": {},\n\"callbackData\": \"\"\n}\n]\n\n

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

Parameter	Type	Description
messageId	String	The ID that uniquely identifies the received message.
from	String	Sender ID that can be alphanumeric or numeric.
to	String	The message destination address.
text	String	Full text of the received message.
cleanText	String	Text of received message without a keyword (if a keyword was sent).
keyword	String	Keyword extracted from the message text.
receivedAt	Date	Tells when our platform received the message. It has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSXXX`.
smsCount	Int	The number of sent message segments.
price	Object	Price of the sent SMS.
callbackData	int	Custom callback data can be inserted during setup phase.

price [Object]

\"price\": {\n\"pricePerMessage\": ,\n\"currency\": \"\"\n},\n\n

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

Parameter	Type	Description
pricePerMessage	Decimal	Cost of receiving a message.
currency	String	Currency of the message price.

","urlObject":{"protocol":"https","path":["your","webhook","path"],"host":["{yourDomain}"],"query":[],"variable":[]}},"response":[{"id":"1c20b43f-76e3-480b-a74e-ad6918cc2bd8","name":"Receive SMS by forward method","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"url":"https://{yourDomain}/your/webhook/path"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"166"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 22 May 2023 15:33:37 GMT"},{"key":"x-zapier-hook-status","value":"success"},{"key":"access-control-allow-origin","value":"*"},{"key":"X-Rate-Limit-Limit","value":"10000"},{"key":"X-Rate-Limit-Remaining","value":"9999"},{"key":"X-Rate-Limit-Reset","value":"1684769765"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b088f021bbfbe62b285291be4d6fc2ae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR61-P4"},{"key":"X-Amz-Cf-Id","value":"4OUCFz7uSQVnrRI6-lzg0NUOBQ7g3q_VsrXL0BMgzXpkxa5tmTCIwg=="}],"cookie":[],"responseTime":null,"body":"{\n \"attempt\": \"01884418-3778-c19d-8a4d-5a833c9f15c9\",\n \"id\": \"01884418-3778-c19d-8a4d-5a833c9f15c9\",\n \"request_id\": \"01884418-3778-c19d-8a4d-5a833c9f15c9\",\n \"status\": \"success\"\n}"}],"_postman_id":"71ff72e8-5643-41f4-acb7-beea566bb71c"}],"id":"50ecd8be-42c0-42c2-b86b-97b7b3c48e64","description":"

Receive SMS by Forward method

This method allows you to receive messages in real time by implementing a URL on your application server where new messages will be forwarded.

Activate service

To activate the feature to receive SMS please contact our support at support@vhdmedia.se.

Forward message example

When our system receives an MO message, it will be forwarded automatically to the URL you have provided. When a new message from your customers arrives in our system, it will be forwarded with the message body as follows:

JSON

{\n  \"results\": [\n    {\n      \"messageId\": \"817790313874066447\",\n      \"from\": \"46701234567\",\n      \"to\": \"46761234567\",\n      \"text\": \"QUIZ Correct answer is Stockholm\",\n      \"cleanText\": \"Correct answer is Stockholm\",\n      \"keyword\": \"QUIZ\",\n      \"receivedAt\": \"2018-10-06T09:28:39.220+0000\",\n      \"smsCount\": 1,\n      \"price\": {\n        \"pricePerMessage\": 0,\n        \"currency\": \"EUR\"\n      },\n      \"callbackData\": \"callbackData\"\n    }\n  ],\n  \"messageCount\": 1,\n  \"pendingMessageCount\": 0\n}\n\n

Request body parameters

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

Parameter	Type	Description
results	Messages	Collection of reports, one per every received message.
messageCount	Int	Number of returned messages in this request.
pendingMessageCount	Int	Number of remaining new messages on our server ready to be returned in the next API call.

Messages

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

Parameter	Type	Description
messageId	String	The ID that uniquely identifies the received message.
from	String	Sender ID that can be alphanumeric or numeric.
to	String	The message destination address.
text	String	Full text of the received message.
cleanText	String	Text of received message without a keyword (if a keyword was sent).
keyword	String	Keyword extracted from the message text.
receivedAt	Date	Tells when our platform received the message. It has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSXXX`.
smsCount	Int	The number of sent message segments.
pricePerMessage	Decimal	Cost of receiving a message.
currency	String	Currency of the message price.
callbackData	int	Custom callback data can be inserted during setup phase.

","_postman_id":"50ecd8be-42c0-42c2-b86b-97b7b3c48e64"},{"name":"NUMBER CONTEXT","item":[{"name":"Number Context Asynchronous request","event":[{"listen":"test","script":{"id":"660353d1-60d4-4ede-9a4a-2a3fc8b475a8","exec":["// Parse the response body","var responseBody = pm.response.json();","","// Test if status code is 200","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","// Parse the request body","var requestBody = pm.request.body;","","// Extract the 'to' property from the request body","var toNumbers;","try {"," toNumbers = JSON.parse(requestBody.raw).to;","} catch (error) {"," console.log(\"Error parsing request body as JSON:\", error);","}","","// Test if 'to' property exists in the request body","pm.test(\"To property exists in the request body\", function () {"," pm.expect(toNumbers).to.exist;","});","","// Test if 'to' property is an array","pm.test(\"To property is an array\", function () {"," pm.expect(toNumbers).to.be.an('array');","});","","// Test if 'to' array has at least one element","pm.test(\"To array has at least one element\", function () {"," pm.expect(toNumbers).to.have.lengthOf.at.least(1);","});","","// Test if response contains 'results' array","pm.test(\"Response contains 'results' array\", function () {"," pm.expect(responseBody).to.have.property('results').that.is.an('array');"," pm.expect(responseBody.results).to.have.lengthOf(2); // Ensure there are two results","});","","// Test each message in the 'results' array","pm.test(\"Each message contains expected properties\", function () {"," responseBody.results.forEach(function (message) {"," pm.expect(message).to.have.property('to').that.is.a('string');"," pm.expect(message).to.have.property('status').that.is.an('object');"," pm.expect(message.status).to.have.property('groupId').that.is.a('number');"," pm.expect(message.status).to.have.property('groupName').that.is.a('string');"," pm.expect(message.status).to.have.property('id').that.is.a('number');"," pm.expect(message.status).to.have.property('name').that.is.a('string');"," pm.expect(message.status).to.have.property('description').that.is.a('string');"," pm.expect(message).to.have.property('messageId').that.is.a('string');"," });","});","","// Test if 'bulkId' exists in the response","pm.test(\"BulkId exists in the response\", function () {"," pm.expect(responseBody).to.have.property('bulkId').that.is.a('string');","});",""],"type":"text/javascript","packages":{}}}],"id":"77c16ca0-1ba4-4903-8204-cb45030d6ed3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": [\n \"46701234567\",\n \"46701234568\"\n ],\n \"notifyUrl\": \"https://www.example.com/number/lookup/report\",\n \"notifyContentType\": \"application/json\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/number/1/notify","description":"

This method gives you the ability to make an asynchronous Number Context request over HTTP. Number Lookup response is sent to a notify URL at your call back server.

This API method is designed for batch numbers processing, to validate large amounts of phone numbers. One example use-case would be validating previously collected numbers from a database.

to [Array of strings]

JSON

{\n\"to\": [\"\",],\n\"notifyContentType\": ,\n\"notifyUrl\": \n}\n\n

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

Parameter	Type	Description
notifyUrl	Srring	The URL on your call back server on which the lookup report will be sen
notifyContentType	String	Preferred lookup report content type. Can be application/json or application/xml.
to	Array of strings	Array of phone numbers to look up. Numbers must be in international format (Example: 46701234567).

Response format

If successful, the response header HTTP status code will be 200 OK and include Number Lookup information in the response body. If you try to send a Number Lookup without authorization, you will get a response with the HTTP status code 401 Unauthorized.

NCResponseAsync

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

Parameter	Type	Description
bulkId	String	The ID that uniquely identifies the request. Bulk ID will be received only when you send a Number Lookup to more than one destination address.
results	NCResponseDetails	Array of Number Lookup results, one per every phone number.

NCResponseDetails

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

Parameter	Type	Description
to	String	The Number Lookup destination address.
status	Status	Indicates whether the Number Lookup query was successfully executed, not executed or any other possible status.
messageId	String	The ID that uniquely identifies the performed lookup on destination address.

Status

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

Parameter	Type	Description
groupId	int	Status group ID.
groupName	String	Status group name.
id	int	Status ID.
name	String	Status name.
description	String	Human readable description of the status.
action	String	Action that should be taken to eliminate the error.

Error

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

Parameter	Type	Description
groupId	int	Error group ID.
groupName	String	Error group name.
id	int	Error ID.
name	String	Error name.
description	String	Human readable description of the error.
permanent	boolean	Tells if the error is permanent.

","urlObject":{"protocol":"https","path":["number","1","notify"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"f0f9052d-11ce-4096-ae3c-a58f99fef50a","name":"Number Context Asynchronous request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"to\": [\n\"4670123456\",\n\"4670123457\"\n],\n\"notifyUrl\": \"https://www.example.com/number/lookup/report\",\n\"notifyContentType\": \"application/json\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/number/1/notify"},"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":"434"},{"key":"Date","value":"Mon, 20 Mar 2023 12:52:20 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1679316741038515837"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"to\": \"4670123456\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"messageId\": \"2bd09cbf-895c-43ad-b0e1-881b05d46ffe\"\n },\n {\n \"to\": \"4670123457\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\"\n },\n \"messageId\": \"dfd5bb2a-2b45-413a-b6a9-398432789895\"\n }\n ],\n \"bulkId\": \"1679316741073752284\"\n}"}],"_postman_id":"77c16ca0-1ba4-4903-8204-cb45030d6ed3"},{"name":"Number Context lookup","event":[{"listen":"test","script":{"id":"e8353058-89a1-4e58-8348-9c3c3300bf1d","exec":["","// Test if status code is 200","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","// Parse the request body","var requestBody = pm.request.body;","","// Extract the 'to' property from the request body","var toNumbers;","try {"," toNumbers = JSON.parse(requestBody.raw).to;","} catch (error) {"," console.log(\"Error parsing request body as JSON:\", error);","}","","// Test if 'to' property exists in the request body","pm.test(\"To property exists in the request body\", function () {"," pm.expect(toNumbers).to.exist;","});","","// Test if 'to' property is an array","pm.test(\"To property is an array\", function () {"," pm.expect(toNumbers).to.be.an('array');","});","","// Test if 'to' array has at least one element","pm.test(\"To array has at least one element\", function () {"," pm.expect(toNumbers).to.have.lengthOf.at.least(1);","});","","","","","// Parse the response body","var responseBody = pm.response.json();","","","","// Test if 'results' array exists in the response","pm.test(\"Response contains 'results' array\", function () {"," pm.expect(responseBody).to.have.property('results').that.is.an('array');"," pm.expect(responseBody.results.length).to.be.above(0); // Ensure there's at least one result","","});","",""],"type":"text/javascript","packages":{}}}],"id":"42a6437d-3319-4a10-977d-7b9ed6f2396f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"to\": [\n\"46701234567\"\n]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/number/1/query","description":"

This method gives you the ability to make a synchronous Number Context request over HTTP. Number context response is returned immediately, eliminating the need for the call back server.

Unlike the asynchronous version of Number context, this endpoint is intended to be used to check smaller amounts of phone numbers and does not support batch processing. It is more convenient, and can be used in scenarios like validating individual phone numbers collected from the user interface. Note that this API endpoint may incur larger latency then the reset of the API.

to [Array of strings]

{\n\"to\": [\"\",]\n}\n\n

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

Parameter	Type	Description
to	Array of strings	Array of phone numbers to look up. Numbers must be in international format (Example: 46701234567).

Response format

If successful, the response header HTTP status code will be 200 OK and include Number Context information in the response body. If you try to send a Number Context without authorization, you will get a response with the HTTP status code 401 Unauthorized. If your request contains more than 1000 destination addresses, API will return the status code 400 Bad Request.

NCResponse

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

Parameter	Type	Description
bulkId	String	The ID that uniquely identifies the request. Bulk ID will be received only when you send a Number Context to more than one destination address.
results	NCResponseDetails	Array of Number results, one per every phone number.

NCResponseDetails

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

Parameter	Type	Description
to	String	The Number Context destination address.
mccMnc	String	Mobile country code and mobile network code concatenated. MccMnc will start with the MCC, and it will always have three digits, followed by the MNC (length of the MNC depends on the value of the MCC, and it can be two or three).
imsi	String	International Mobile Subscriber Identity, used to uniquely identify the user of a mobile network.
originalNetwork	Network	Information about the original network.
ported	Boolean	Tells if the phone number is ported.
portedNetwork	Network	Information about the ported network.
roaming	Boolean	Informs if the phone number is in roaming.
roamingNetwork	Network	Information about the roaming network.
servingMSC	String	Serving mobile switching center.
status	Status	Indicates whether the Number Context query was successfully executed, not executed or any other possible status.
error	Error	Indicates whether the error occurred during the query execution.

Network

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

Parameter	Type	Description
networkName	String	Network name.
networkPrefix	String	Network prefix.
countryName	String	Country name.
countryPrefix	String	Country prefix.

Status

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

Parameter	Type	Description
groupId	int	Status group ID.
groupName	String	Status group name.
id	int	Status ID.
name	String	Status name.
description	String	Human readable description of the status.
action	String	Action that should be taken to eliminate the error.

Error

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

Parameter	Type	Description
groupId	int	Error group ID.
groupName	String	Error group name.
id	int	Error ID.
name	String	Error name.
description	String	Human readable description of the error.
permanent	boolean	Tells if the error is permanent.

","urlObject":{"protocol":"https","path":["number","1","query"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"77b98111-81b0-4020-a142-2ef107c194d3","name":"Number Context lookup","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"to\": [\n\"4670123456\"\n]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/number/1/query"},"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":"398"},{"key":"Date","value":"Mon, 20 Mar 2023 12:58:32 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1679317113086870827"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"to\": \"4670123456\",\n \"mccMnc\": \"22801\",\n \"imsi\": \"22801\",\n \"originalNetwork\": {\n \"networkPrefix\": \"79302\",\n \"countryPrefix\": \"41\"\n },\n \"ported\": false,\n \"roaming\": false,\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 }\n ]\n}"}],"_postman_id":"42a6437d-3319-4a10-977d-7b9ed6f2396f"},{"name":"Get Number Context logs","event":[{"listen":"test","script":{"id":"1fe1a6fa-9631-49e3-af7c-22d8e1dc4f3b","exec":["// Parse the response body","var responseBody = pm.response.json();","","// Test if status code is 200","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","// Test if 'results' array exists in the response","pm.test(\"Response contains 'results' array\", function () {"," pm.expect(responseBody).to.have.property('results').that.is.an('array');"," pm.expect(responseBody.results.length).to.be.above(0); // Ensure there's at least one result","","});","",""],"type":"text/javascript","packages":{}}}],"id":"d3a865d6-5dd2-427a-9a40-e3aca66b5e3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://go2.vhdmedia.se/number/1/logs","description":"

This method allows you to get logs of sent Number Context requests.

Request rate limit

60 requests / minute (per account)

Query parameters

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

Parameter	Type	Description
to	string	Destination address.
bulkId	Array of strings	Bulk ID for which log is requested.
messageId	Array of strings	NC lookup ID for which log is requested.
generalStatus	string	Requested Number Context status.
sentSince	string	Example: sentSince=2024-02-22T17:42:05.390+0100 0r sentSince=2024-03-24T17:42:05.39+0100 Lower limit for NC sentAt time (time of sending the lookup). Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
sentUntil	string	string Example: sentUntil=2024-03-25T16:50:05+100 or 2024-03-25T16:50:05+0100 Upper limit for NC sentAt time (time of sending the lookup). Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. or yyyy T HH:mm::ss.sssZ
limit	integer	Maximal number of Number Context lookups in returned logs.
mcc	string	Mobile country code.
mnc	string	Mobile network code.

Responses

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

Parameter	Type	Description
results	Array of objects	Collection of logs.
Array [ bulkId doneAt	string string	The ID that uniquely identifies the request. Tells when VHD finished processing the lookup (e.g. lookup request was delivered to the destination network). Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
error { description groupId groupName id name permanent }	object string integer string integer string boolean	object Human-readable description of the error.. Error group ID. Error group name. Error ID. Error name. Tells if the error is permanent.
mccMnc	string	Mobile country and network codes.
messageId	string	The ID that uniquely identifies the performed lookup.
price { currency pricePerMessage }	object string number	object The currency in which the price is expressed. Price per one SMS.
sentAt	string	Tells when the lookup was performed. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
status { action description groupId id name }	object string string integer integer string	object Action that should be taken to recover from the error. Human-readable description of the status. Status group ID. Status ID. Status name.
to ]	string	The looked up phone number.

","urlObject":{"protocol":"https","path":["number","1","logs"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"f7eae1f1-e29e-4659-9aad-5b41f2034555","name":"Get Number Context logs","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://go2.vhdmedia.se/number/1/logs?sentSince=2024-03-24T17%3A42%3A05%2B0100&sentUntil=2024-03-25T16%3A50%3A05%2B0100","protocol":"https","host":["go2","vhdmedia","se"],"path":["number","1","logs"],"query":[{"key":"sentSince","value":"2024-03-24T17%3A42%3A05%2B0100"},{"key":"sentUntil","value":"2024-03-25T16%3A50%3A05%2B0100"}]}},"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":"541"},{"key":"date","value":"Mon, 25 Mar 2024 15:50:28 GMT"},{"key":"server","value":"SMS API"},{"key":"x-request-id","value":"1711381828740906829"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"bulkId\": \"1711381775048065755\",\n \"messageId\": \"4a05e95a-517a-4c6f-ab07-0f3f281389b9\",\n \"to\": \"46701234567\",\n \"sentAt\": \"2024-03-25T15:49:35.051+0000\",\n \"doneAt\": \"2024-03-25T15:49:35.405+0000\",\n \"mccMnc\": \"24013\",\n \"price\": {\n \"currency\": \"SEK\",\n \"pricePerLookup\": 0.25\n },\n \"status\": {\n \"groupId\": 2,\n \"groupName\": \"UNDELIVERABLE\",\n \"id\": 9,\n \"name\": \"UNDELIVERABLE_NOT_DELIVERED\",\n \"description\": \"Message sent not delivered\"\n },\n \"error\": {\n \"groupId\": 1,\n \"groupName\": \"HANDSET_ERRORS\",\n \"id\": 27,\n \"name\": \"EC_ABSENT_SUBSCRIBER\",\n \"description\": \"Absent Subscriber\",\n \"permanent\": false\n }\n }\n ]\n}"}],"_postman_id":"d3a865d6-5dd2-427a-9a40-e3aca66b5e3a"}],"id":"c73f1981-5c8a-4d17-b1cb-44c2ff25ac00","_postman_id":"c73f1981-5c8a-4d17-b1cb-44c2ff25ac00","description":""},{"name":"LOGS AND REPORTS","item":[{"name":"Delivery reports","event":[{"listen":"test","script":{"id":"cba676f6-8c6c-4368-b1a8-dbcda9bdf643","exec":["// Parse the response body","var responseBody = pm.response.json();","","// Test if status code is 200","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","// Test if 'results' array exists in the response","pm.test(\"Response contains 'results' array\", function () {"," pm.expect(responseBody).to.have.property('results').that.is.an('array');"," pm.expect(responseBody.results.length).to.be.above(0); // Ensure there's at least one result",""," // Iterate over each message in the 'results' array"," responseBody.results.forEach(function (message, index) {"," // Test the message in the 'results' array"," "," });","});","",""],"type":"text/javascript","packages":{}}}],"id":"6826a99e-85b1-420e-bd96-bfe869eacf9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://go2.vhdmedia.se/sms/1/reports","description":"

This method allows you to get one time delivery reports for sent SMS.

Request body schema

{\n  \"bulkId\": \"\",\n  \"messageId\": \"\",\n  \"limit\": \"\"\n}\n\n

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

Parameter	Type	Description
bulkId	String	The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
messageId	String	The ID that uniquely identifies the message sent.
limit	String	Number of returned delivery reports. Default value is 50. Max number per request is 1000

Response format

On success, response header HTTP status code will be 200 OK and delivery reports will be returned in the response body.

If you try to send a message without authorization, you will get a response with HTTP status code 401 Unauthorized.

SMSReportResponse

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

Parameter	Type	Description
results	SentSMSReport	Collection of reports, one per every message.

SentSMSReport

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

Parameter	Type	Description
bulkId	String	Bulk ID.
messageId	String	Message ID.
to	String	Destination address.
from	String	Sender ID that can be alphanumeric or numeric.
sentAt	Date	Tells when the SMS was sent. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
doneAt	Date	Tells when the SMS was finished processing by our system (ie. delivered to destination, delivered to destination network, etc.)
smsCount	int	Number of parts the sent SMS was split into.
mccMnc	String	Mobile country and network codes.
callbackData	String	Callback data sent through 'callbackData' field in fully featured SMS message
price	Price	Sent SMS price.
status	Status	Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
error	Error	Indicates whether the error occurred during the query execution.

Price

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

Parameter	Type	Description
pricePerMessage	BigDecimal	Price per one SMS.
currency	String	The currency in which the price is expressed.

Status

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

Parameter	Type	Description
groupId	int	Status group ID.
groupName	String	Status group name.
id	int	Status ID.
name	String	Status name.
description	String	Human readable description of the status.
action	String	Action that should be taken to eliminate the error.

Error

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

Parameter	Type	Description
groupId	int	Error group ID.
groupName	String	Error group name.
id	int	Error ID.
name	String	Error name.
description	String	Human readable description of the error.
permanent	boolean	Tells if the error is permanent.

","urlObject":{"protocol":"https","path":["sms","1","reports"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"597406db-c9db-471a-9261-5719d51637ad","name":"Delivery reports","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"bulkId\": \"BULK-ID-123-xyz\",\n \"messageId\": \"MESSAGE-ID-123-xyz\",\n \"limit\": \"2\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/sms/1/reports"},"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":"476"},{"key":"Date","value":"Sat, 11 Mar 2023 10:56:52 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1678532212874616827"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"messageId\": \"37853196998703536443\",\n \"to\": \"4670123456\",\n \"from\": \"VHD\",\n \"sentAt\": \"2023-03-11T10:52:50.035+0000\",\n \"doneAt\": \"2023-03-11T10:53:00.202+0000\",\n \"smsCount\": 1,\n \"mccMnc\": \"null\",\n \"price\": {\n \"pricePerMessage\": 1,\n \"currency\": \"SEK\"\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 }\n ]\n}"}],"_postman_id":"6826a99e-85b1-420e-bd96-bfe869eacf9e"},{"name":"Sent messages logs","event":[{"listen":"test","script":{"id":"970c79c1-b266-4728-b413-f94423694e93","exec":["// Parse the response body","var responseBody = pm.response.json();","","// Test if status code is 200","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","// Test if 'results' array exists in the response","pm.test(\"Response contains 'results' array\", function () {"," pm.expect(responseBody).to.have.property('results').that.is.an('array');"," pm.expect(responseBody.results.length).to.be.above(0); // Ensure there's at least one result",""," // Iterate over each message in the 'results' array"," responseBody.results.forEach(function (message, index) {"," // Test the message in the 'results' array"," "," });","});","",""],"type":"text/javascript","packages":{}}}],"id":"485ab845-9de0-4c4a-89ba-a1e3bd44b196","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/sms/1/logs","description":"

Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours and you can only retrieve maximum of 1000 logs per call.

Request body schema

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

Parameter	Type	Description
from	String	The sender ID which can be alphanumeric or numeric.
bulkId	String	The ID that uniquely identifies the request.
messageId	String	The ID that uniquely identifies the message sent.
generalStatus	Array of Strings	Sent message status. Possible values: ACCEPTED, PENDING, UNDELIVERABLE, DELIVERED, REJECTED, EXPIRED.
to	String	The message destination address.
from	String	Sender ID that can be alphanumeric or numeric.
text	String	Text of the message that was sent.
sentAt	Date	Tells when the SMS was sent. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
limit	Integer	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. If you want to fetch more than 1000 logs allowed per call, use sentBefore and sentUntil to retrieve them in pages.
mcc	String	Mobile Country Code
mnc	String	Mobile Network Code
sentSince	String	Example: sentSince=2015-02-22T17:42:05.390+0100 The logs will only include messages sent after this date. Use it together with sentUntil to return a time range or if you want to fetch more than 1000 logs allowed per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
sentUntil	String	Example: sentUntil=2015-02-22T19:42:05.390+0100 The logs will only include messages sent before this date. Use it together with sentBefore to return a time range or if you want to fetch more than 1000 logs allowed per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
mcc	String	Mobile Country Code.
mnc	String	Mobile Network Code.

Response format

If successful, the response header HTTP status code will be 200 OK and the message logs will be returned. If you try to send a message without authorization, you will get a response with HTTP status code 401 Unauthorized.

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

SMSLogsResponse

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

Parameter	Type	Description
results	SentSMSLog	Collection of logs.

SentSMSLog

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

Parameter	Type	Description
bulkId	String	The ID that uniquely identifies the request.
messageId	String	The ID that uniquely identifies the message sent.
to	String	The message destination address.
from	String	Sender ID that can be alphanumeric or numeric.
text	String	Text of the message that was sent.
sentAt	Date	Tells when the SMS was sent. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
doneAt	Date	Tells when the SMS was finished processing by our system (ie. delivered to destination, delivered to destination network, etc.)
smsCount	int	The number of sent message segments.
mccmnc	String	Mobile country and network codes.
price	Price	Sent SMS price.
status	Status	Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
error	Error	Indicates whether the error occurred during the query execution.

Price

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

Parameter	Type	Description
pricePerMessage	BigDecimal	Price per one SMS.
currency	String	The currency in which the price is expressed.

Status

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

Parameter	Type	Description
groupId	int	Status group ID.
groupName	String	Status group name.
id	int	Status ID.
name	String	Status name.
description	String	Human readable description of the status.
action	String	Action that should be taken to eliminate the error.

Error

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

Parameter	Type	Description
groupId	int	Error group ID.
groupName	String	Error group name.
id	int	Error ID.
name	String	Error name.
description	String	Human readable description of the error.
permanent	boolean	Tells if the error is permanent.

","urlObject":{"protocol":"https","path":["sms","1","logs"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"aa039f15-0595-4dbf-bc4a-93c59911bac0","name":"Sent messages logs","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"from\": \"VHD\",\n \"bulkId\": \"BULK-ID-123-xyz\",\n \"messageId\": \"MESSAGE-ID-123-xyz\",\n \"limit\": \"2\"\n}\n\n","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/sms/1/logs"},"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":"1632"},{"key":"Date","value":"Mon, 13 Mar 2023 15:05:04 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1678719904301745666"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"bulkId\": \"BULK-ID-123-xyz\",\n \"messageId\": \"37871984270837213776\",\n \"to\": \"4670123456\",\n \"from\": \"VHD\",\n \"text\": \"Merhaba dünya\",\n \"sentAt\": \"2023-03-13T15:04:02.714+0000\",\n \"doneAt\": \"2023-03-13T15:04:02.848+0000\",\n \"smsCount\": 1,\n \"mccMnc\": \"24013\",\n \"price\": {\n \"pricePerMessage\": 1,\n \"currency\": \"SEK\"\n },\n \"status\": {\n \"groupId\": 2,\n \"groupName\": \"UNDELIVERABLE\",\n \"id\": 9,\n \"name\": \"UNDELIVERABLE_NOT_DELIVERED\",\n \"description\": \"Message sent not delivered\"\n },\n \"error\": {\n \"groupId\": 1,\n \"groupName\": \"HANDSET_ERRORS\",\n \"id\": 1,\n \"name\": \"EC_UNKNOWN_SUBSCRIBER\",\n \"description\": \"Unknown Subscriber\",\n \"permanent\": true\n }\n },\n {\n \"bulkId\": \"BULK-ID-123-xyz\",\n \"messageId\": \"37871984270837213777\",\n \"to\": \"4670123457\",\n \"from\": \"VHD\",\n \"text\": \"Hello Wolrd\",\n \"sentAt\": \"2023-03-13T15:04:02.713+0000\",\n \"doneAt\": \"2023-03-13T15:04:02.841+0000\",\n \"smsCount\": 1,\n \"mccMnc\": \"22802\",\n \"price\": {\n \"pricePerMessage\": 1,\n \"currency\": \"SEK\"\n },\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 3,\n \"name\": \"PENDING_WAITING_DELIVERY\",\n \"description\": \"Message sent, waiting for delivery report\"\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 },\n {\n \"bulkId\": \"BULK-ID-123-xyz\",\n \"messageId\": \"MESSAGE-ID-123-xyz\",\n \"to\": \"4670123458\",\n \"from\": \"VHD\",\n \"text\": \"Merhaba dünya\",\n \"sentAt\": \"2023-03-13T15:04:02.713+0000\",\n \"doneAt\": \"2023-03-13T15:04:02.788+0000\",\n \"smsCount\": 1,\n \"mccMnc\": \"22801\",\n \"price\": {\n \"pricePerMessage\": 1,\n \"currency\": \"SEK\"\n },\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 3,\n \"name\": \"PENDING_WAITING_DELIVERY\",\n \"description\": \"Message sent, waiting for delivery report\"\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 }\n ]\n}"}],"_postman_id":"485ab845-9de0-4c4a-89ba-a1e3bd44b196"},{"name":"{ Webhook } Receive outbound SMS message report","id":"c32d815d-1eac-4d11-b10f-4070e89fc003","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"results\": [\n {\n \"bulkId\": \"BULK-ID-123-xyz\",\n \"messageId\": \"MESSAGE-ID-123-xyz\",\n \"to\": \"41793026727\",\n \"sentAt\": \"2024-04-09T16:00:00.000+0000\",\n \"doneAt\": \"2024-04-09T16:00:00.000+0000\",\n \"smsCount\": 1,\n \"price\": {\n \"pricePerMessage\": 0.01,\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 \"entityId\": \"promotional-traffic-entity\",\n \"applicationId\": \"marketing-automation-application\"\n },\n {\n \"bulkId\": \"BULK-ID-123-xyz\",\n \"messageId\": \"12db39c3-7822-4e72-a3ec-c87442c0ffc5\",\n \"to\": \"41793026834\",\n \"sentAt\": \"2024-04-09T17:00:00.000+0000\",\n \"doneAt\": \"2024-04-09T17:00:00.000+0000\",\n \"smsCount\": 1,\n \"price\": {\n \"pricePerMessage\": 0.01,\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 \"applicationId\": \"default\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{yourDomain}/your/webhook/path","description":"

For every message you send, we offer the option to receive a delivery report. To use this feature, you should set up an endpoint to receive these reports. You can specify the endpoint when sending SMS. If you need assistance with this process, please contact support@vhdmedia.se. Please note that the default number of delivery reports in a single request is 100.

Request body schema

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

Parameter	Type	Description
results	Array of Objects	Collection of reports, one per every message.

Array [

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

	Type	Description
bulkId	String	Bulk ID.
messageId	String	Message ID.
to	String	Destination address.
from	String	Sender ID that can be alphanumeric or numeric.
sentAt	Date	Tells when the SMS was sent. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
doneAt	Date	Tells when the SMS was finished processing by our system (ie. delivered to destination, delivered to destination network, etc.)
smsCount	Int	Number of parts the sent SMS was split into.
mccMnc	String	Mobile country and network codes.
callbackData	String	Callback data sent through 'callbackData' field in fully featured SMS message
price	Object	Sent SMS price.
status	Status	Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
error	Error	Indicates whether the error occurred during the query execution.

Price

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

Parameter	Type	Description
pricePerMessage	BigDecimal	Price per one SMS.
currency	String	The currency in which the price is expressed.

Status

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

Parameter	Type	Description
groupId	Int	Status group ID.
groupName	String	Status group name.
id	Int	Status ID.
name	String	Status name.
description	String	Human readable description of the status.
action	String	Action that should be taken to eliminate the error.

Error

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

Parameter	Type	Description
groupId	Int	Error group ID.
groupName	String	Error group name.
id	Int	Error ID.
name	String	Error name.
description	String	Human readable description of the error.
permanent	Boolean	Tells if the error is permanent.

]

Responses

200

Your server returns this code if it accepts the callback.

\n","urlObject":{"protocol":"https","path":["your","webhook","path"],"host":["{yourDomain}"],"query":[],"variable":[]}},"response":[{"id":"d13f8e61-321e-457e-9004-b30a0d79acf9","name":"Receive outbound SMS message report Example","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"results\": [\n {\n \"bulkId\": \"BULK-ID-123-xyz\",\n \"messageId\": \"MESSAGE-ID-123-xyz\",\n \"to\": \"41793026727\",\n \"sentAt\": \"2024-04-09T16:00:00.000+0000\",\n \"doneAt\": \"2024-04-09T16:00:00.000+0000\",\n \"smsCount\": 1,\n \"price\": {\n \"pricePerMessage\": 0.01,\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 \"entityId\": \"promotional-traffic-entity\",\n \"applicationId\": \"marketing-automation-application\"\n },\n {\n \"bulkId\": \"BULK-ID-123-xyz\",\n \"messageId\": \"12db39c3-7822-4e72-a3ec-c87442c0ffc5\",\n \"to\": \"41793026834\",\n \"sentAt\": \"2024-04-09T17:00:00.000+0000\",\n \"doneAt\": \"2024-04-09T17:00:00.000+0000\",\n \"smsCount\": 1,\n \"price\": {\n \"pricePerMessage\": 0.01,\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 \"applicationId\": \"default\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{yourDomain}/your/webhook/path"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Apr 2024 09:13:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"1cce7a52-bef8-4ae7-b359-c5a59d8dce3f"},{"key":"x-amz-apigw-id","value":"WuT9iEEpIAMEZnA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6628cd23-288b6e3d11f852b86752e576;Parent=698c21fa7bb84c4d;Sampled=0;lineage=f4509577:0"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Success\"\n}"}],"_postman_id":"c32d815d-1eac-4d11-b10f-4070e89fc003"}],"id":"e5894551-8ee2-4a3c-b269-9e70bf790d20","_postman_id":"e5894551-8ee2-4a3c-b269-9e70bf790d20","description":""},{"name":"MANAGE SCHEDULED SMS MESSAGES","item":[{"name":"Get scheduled SMS messages","event":[{"listen":"test","script":{"id":"95da2fec-98c3-45ca-9140-1ef5db7894ee","exec":["// Test if status code is 200","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","// Get the bulkId from environment variables","var bulkId = pm.environment.get(\"bulkId\");","","// Test if bulkId exists in the query","pm.test(\"BulkId exists in the query\", function () {"," var queryParams = pm.request.url.query.toObject(); // Convert query parameters to an object"," pm.expect(queryParams).to.have.property(\"bulkId\", bulkId);","});","","","// Parse the response body as JSON","var responseBody = pm.response.json();","","// Test if bulkId exists in the response body","pm.test(\"BulkId exists in the response body\", function () {"," pm.expect(responseBody).to.have.property('bulkId');","});","","// Test if sendAt exists in the response body","pm.test(\"SendAt exists in the response body\", function () {"," pm.expect(responseBody).to.have.property('sendAt');","});",""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"packages":{},"type":"text/javascript"}}],"id":"36de3614-8a46-4c9c-ae37-89016b36aca8","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/sms/1/bulks?bulkId={{bulkId}}","description":"

See all scheduled messages and their scheduled date and time. To schedule a message, use the sendAt field when sending a message.

Query Parameters

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

Parameter	Type	Description
bulkId	String	Required.

Response

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

Parameter	Type	Description
bulkId	string	Required Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
status	string	string Enum: \"PENDING\" \"PAUSED\" \"PROCESSING\" \"CANCELED\" \"FINISHED\" \"FAILED\" The status of the message(s).

","urlObject":{"protocol":"https","path":["sms","1","bulks"],"host":["go2","vhdmedia","se"],"query":[{"key":"bulkId","value":"{{bulkId}}"}],"variable":[]}},"response":[{"id":"27a8047d-2c52-4ce4-8b2b-8d07eac30e14","name":"Get scheduled SMS messages","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/sms/1/bulks?bulkId=BULK-ID-VHD","protocol":"https","host":["go2","vhdmedia","se"],"path":["sms","1","bulks"],"query":[{"key":"bulkId","value":"BULK-ID-VHD"}]}},"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":"64"},{"key":"date","value":"Fri, 01 Mar 2024 09:46:04 GMT"},{"key":"server","value":"SMS API"},{"key":"x-request-id","value":"1709286364762597225"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"BULK-ID-VHD\",\n \"sendAt\": \"2024-03-02T09:34:00.000+0000\"\n}"}],"_postman_id":"36de3614-8a46-4c9c-ae37-89016b36aca8"},{"name":"Get scheduled SMS messages status","event":[{"listen":"test","script":{"id":"53c0b9c4-c5b1-4c21-a2af-bec503f511d2","exec":["// Test if status code is 200","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","// Get the bulkId from environment variables","var bulkId = pm.environment.get(\"bulkId\");","","// Test if bulkId exists in the query","pm.test(\"BulkId exists in the query\", function () {"," var queryParams = pm.request.url.query.toObject(); // Convert query parameters to an object"," pm.expect(queryParams).to.have.property(\"bulkId\", bulkId);","});","","","// Parse the response body as JSON","var responseBody = pm.response.json();","","// Test if bulkId exists in the response body","pm.test(\"BulkId exists in the response body\", function () {"," pm.expect(responseBody).to.have.property('bulkId');","});","","// Test if sendAt exists in the response body","pm.test(\"status exists in the response body\", function () {"," pm.expect(responseBody).to.have.property('status');","});",""],"type":"text/javascript","packages":{}}}],"id":"ed9c1ef2-2c01-40eb-a7ca-6b3cd55c57a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://go2.vhdmedia.se/sms/1/bulks/status?bulkId={{bulkId}}","description":"

See the status of scheduled messages. To schedule a message, use the sendAt field when sending a message.

Learn more about SMS channel and use cases

Query Parameters

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

Parameter	Type	Description
bulkId	String	Required.

Response

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

Parameter	Type	Description
bulkId	string	Required Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
status	string	Enum: \"PENDING\" \"PAUSED\" \"PROCESSING\" \"CANCELED\" \"FINISHED\" \"FAILED\" The status of the message(s).

","urlObject":{"protocol":"https","path":["sms","1","bulks","status"],"host":["go2","vhdmedia","se"],"query":[{"key":"bulkId","value":"{{bulkId}}"}],"variable":[]}},"response":[{"id":"4e5dfb62-8843-4257-9d07-05182bb49ca0","name":"Get scheduled SMS messages status","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://go2.vhdmedia.se/sms/1/bulks/status?bulkId=BULK-ID-VHD","protocol":"https","host":["go2","vhdmedia","se"],"path":["sms","1","bulks","status"],"query":[{"key":"bulkId","value":"BULK-ID-VHD"}]}},"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":"content-type","value":"application/json;charset=UTF-8"},{"key":"content-length","value":"43"},{"key":"x-http2-stream-id","value":"843"},{"key":"server","value":"SMS API"},{"key":"x-request-id","value":"1709299328571290828"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"BULK-ID-VHD\",\n \"status\": \"PENDING\"\n}"}],"_postman_id":"ed9c1ef2-2c01-40eb-a7ca-6b3cd55c57a6"},{"name":"Reschedule SMS messages","event":[{"listen":"prerequest","script":{"id":"d4563600-d3ff-4fe6-a192-fbc91d18fc35","exec":["","// Get the current value of the sendAt environment variable","var currentSendAt = pm.environment.get(\"sendAt\");","","// Convert the currentSendAt string to a Date object","var sendAtDate = new Date(currentSendAt);","","// Add 10 minutes to the sendAtDate","sendAtDate.setMinutes(sendAtDate.getMinutes() + 10);","","// Format the date and time as required","var year = sendAtDate.getUTCFullYear();","var month = ('0' + (sendAtDate.getUTCMonth() + 1)).slice(-2);","var day = ('0' + sendAtDate.getUTCDate()).slice(-2);","var hours = ('0' + sendAtDate.getUTCHours()).slice(-2);","var minutes = ('0' + sendAtDate.getUTCMinutes()).slice(-2);","var seconds = ('0' + sendAtDate.getUTCSeconds()).slice(-2);","","// Construct the formatted string for sendAt","var newSendAt = year + '-' + month + '-' + day + 'T' + hours + ':' + minutes + ':' + seconds + '.000+0000';","","// Set the new sendAt value as an environment variable","pm.environment.set(\"sendAt\", newSendAt);",""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"6f4f6e73-3b30-47ce-b228-cabffaa46a6c","exec":["// Test if status code is 200","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","// Get the bulkId from environment variables","var bulkId = pm.environment.get(\"bulkId\");","","// Test if bulkId exists in the query","pm.test(\"BulkId exists in the query\", function () {"," var queryParams = pm.request.url.query.toObject(); // Convert query parameters to an object"," pm.expect(queryParams).to.have.property(\"bulkId\", bulkId);","});","","","// Parse the response body as JSON","var responseBody = pm.response.json();","","// Test if sendAt exists in the response body","pm.test(\"SendAt exists in the response body\", function () {"," pm.expect(responseBody).to.have.property('sendAt');","});",""],"type":"text/javascript","packages":{}}}],"id":"773ebe7b-a022-4a6a-8051-3ef027bfea5a","protocolProfileBehavior":{"disableBodyPruning":true},"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/sms/1/bulks?bulkId={{bulkId}}","description":"

Change the date and time of already scheduled messages. To schedule a message, use the sendAt field when sending a message.

Query Parameters

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

Parameter	Type	Description
bulkId	String	Required.

Request body schema

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

Parameter	Type	Description

sendAt	string	Date and time when the message is to be sent. Used for scheduled SMS (see Scheduled SMS endpoints for more details). Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ, and can only be scheduled for no later than 180 days in advance.

Response

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

Parameter	Type	Description
bulkId	string	Required Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
sendAt	string	Date and time when the message is to be sent. Used for scheduled SMS (see Scheduled SMS endpoints for more details). Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ, and can only be scheduled for no later than 180 days in advance.

","urlObject":{"protocol":"https","path":["sms","1","bulks"],"host":["go2","vhdmedia","se"],"query":[{"key":"bulkId","value":"{{bulkId}}"}],"variable":[]}},"response":[{"id":"5c038713-8fb7-4a56-b78e-b4b607bf88f9","name":"Reschedule SMS messages","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"sendAt\": \"2024-03-25T16:00:00.000+0000\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/sms/1/bulks?bulkId=BULK-ID-VHD","protocol":"https","host":["go2","vhdmedia","se"],"path":["sms","1","bulks"],"query":[{"key":"bulkId","value":"BULK-ID-VHD"}]}},"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":"64"},{"key":"date","value":"Fri, 01 Mar 2024 10:05:33 GMT"},{"key":"server","value":"SMS API"},{"key":"x-request-id","value":"1709287533273818227"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"BULK-ID-VHD\",\n \"sendAt\": \"2024-03-25T16:00:00.000+0000\"\n}"}],"_postman_id":"773ebe7b-a022-4a6a-8051-3ef027bfea5a"},{"name":"Update scheduled SMS messages status","event":[{"listen":"test","script":{"id":"0925b193-0657-44a6-8c1b-64d5da782105","exec":["// Test if status code is 200","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","// Get the bulkId from environment variables","var bulkId = pm.environment.get(\"bulkId\");","","// Test if bulkId exists in the query","pm.test(\"BulkId exists in the query\", function () {"," var queryParams = pm.request.url.query.toObject(); // Convert query parameters to an object"," pm.expect(queryParams).to.have.property(\"bulkId\", bulkId);","});","","// Parse the request body","var requestBody = pm.request.body;","","// Extract the status from the request body","var status;","try {"," status = JSON.parse(requestBody.raw).status;","} catch (error) {"," console.log(\"Error parsing request body as JSON:\", error);","}","","// Test if status exists in the request body","pm.test(\"Status exists in the request body\", function () {"," pm.expect(status).to.exist;","});","","// Test if status is one of the expected values","pm.test(\"Status is one of the expected values\", function () {"," var expectedStatusValues = [\"PENDING\", \"PAUSED\", \"PROCESSING\", \"CANCELED\", \"FINISHED\", \"FAILED\"];"," pm.expect(expectedStatusValues).to.include(status);","});","","// Test if bulkId exists in the response body","pm.test(\"BulkId exists in the response body\", function () {"," var responseBody = pm.response.json();"," pm.expect(responseBody).to.have.property(\"bulkId\");","});",""],"type":"text/javascript","packages":{}}}],"id":"100cc2ae-258c-424d-837e-591d05259fa0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"PAUSED\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/sms/1/bulks/status?bulkId={{bulkId}}","description":"

Change the status or completely cancel sending of scheduled messages.. To schedule a message, use the sendAt field when sending a message.

Learn more about SMS channel and use cases

Query Parameters

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

Parameter	Type	Description
bulkId	String	Required.

Request body schema

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

Parameter	Type	Description
status	string	Required Enum: \"PENDING\" \"PAUSED\" \"PROCESSING\" \"CANCELED\" \"FINISHED\" \"FAILED\" The status of the message(s).

Response

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

Parameter	Type	Description
bulkId	string	Required Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
status	string	Enum: \"PENDING\" \"PAUSED\" \"PROCESSING\" \"CANCELED\" \"FINISHED\" \"FAILED\" The status of the message(s).

Short Message Service (SMS) boasts the broadest reach and coverage among messaging services. It facilitates communication to and from any mobile device worldwide, without the need for a data connection.

\n","_postman_id":"01731fa3-3ed6-47ca-9967-0f704e39e81f"},{"name":"VOICE","item":[{"name":"VOICE MESSAGES","item":[{"name":"Send single voice message","id":"b6a2b5fe-65fb-4c22-b0ad-660f53aacafb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/tts/3/single","description":"

This method allows you to send a single voice message to one destination address.

Request body schema

{\n  \"text\": \"\",\n  \"audioFileUrl\": \"\"\n  \"language\": \"\",\n  \"voice\": {\n    \"name\": \"\",\n    \"gender\": \"\"\n  },\n  \"from\": \"\",\n  \"to\": \"\"\n}\n\n

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

Parameter	Type	Description
audioFileUrl	string	An audio file can be delivered as a voice message to the recipients. An audio file must be uploaded online, so that the existing URL can be available for file download. Size of the audio file must be below 4 MB. 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.
from	string	Required Numeric sender ID in E.164 standard format (Example: 46701234567). This is caller ID that will be presented to the end user where applicable.
language	string	If the message is in text format, the language in which the message is written must be defined for correct pronunciation. More about Text-to-speech functionality and supported TTS languages can be found here. If not set, default language is English [en]. If voice is not set, then default voice for that specific language is used. In the case of English language, the voice is [Joanna].
text	string	Message to be converted to speech and played to subscribers. Message text can be up to 1400 characters long and cannot contain only punctuation.
to	string required	Phone number of the recipient. Phone number must be written in E.164 standard format (Example: 46701234567).
voice	object	Used to define voice in which text would be synthesized. It has two parameters: name and gender. When only name is provided, then that exact voice with that name will be used to synthesize text. If only gender is provided, then text is synthesized with first voice in given gender. If voice is not set, then default voice is used.

Voice: object

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

Parameter	Type	Description
gender	string	Gender of the voice. Can be male or female.
name	string	Name of the voice. Example: Joanna

Response format

If successful, response header HTTP status code will be 200 OK and the message will be sent.

If you try to send a message without authorization, you will receive the 401 Unauthorized error .

VoiceResponse

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

Parameter	Type	Description
messages	Array of object	Array of sent message objects, one object per every message.

VoiceResponseDetails

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

Parameter	Type	Description
to	String	The message destination address.
status	Status	Indicates whether the message has been successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
messageId	String	The ID that uniquely identifies the message sent.

Status

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

Parameter	Type	Description
groupId	Int	Status group ID
groupName	String	Status group name
id	Int	Status ID
name	String	Status name
description	String	Human readable description of the status.

Languages

List of supported languages:

Language	Language shortcut
English	en
English (British)	en-gb
English (Australian)	en-au
English (Indian)	en-in
English (Welsh)	en-gb-wls
Spanish	es
Catalan	ca
Chinese-Simplified	zh-cn
Chinese-Traditional	zh-tw
Danish	da
Dutch	nl
French	fr
German	de
Italian	it
Japanese	ja
Korean	ko
Norwegian	no
Polish	pl
Portuguese	pt-pt
Portuguese - Brazilian	pt-br
Russian	ru
Swedish	sv
Finnish	fi
Turkish	tr
Welsh	wls

","urlObject":{"protocol":"https","path":["tts","3","single"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"d0cafecf-ee63-4e11-8fab-095561e834ca","name":"Single voice message by audioFile","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"audioFileUrl\": \"https://www.example.com/media.mp3\",\n\"language\": \"en\",\n\"voice\": {\n\"name\": \"Joanna\",\n\"gender\": \"female\"\n},\n\"from\": \"46701923177\",\n\"to\": \"4670123456\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/tts/3/single"},"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":"268"},{"key":"Date","value":"Wed, 19 Apr 2023 06:13:00 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1681884781063398162"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"6e64033a-96e5-4c1e-b2c6-0c4106525af9\",\n \"messages\": [\n {\n \"to\": \"4670123456\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\",\n \"description\": \"Message accepted, pending for delivery.\"\n },\n \"messageId\": \"bee4d267-b36d-4ef9-8ccc-542700bc3a97\"\n }\n ]\n}"},{"id":"4b833099-17dd-48cf-8020-b112dff04e37","name":"Single voice message by text","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"text\": \"Hello world!\",\n\"language\": \"en\",\n\"voice\": {\n\"name\": \"Joanna\",\n\"gender\": \"female\"\n},\n\"from\": \"46701923177\",\n\"to\": \"4670123456\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/tts/3/single"},"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":"268"},{"key":"Date","value":"Wed, 19 Apr 2023 07:45:54 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1681890355081433830"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"d87320ae-c3a6-450c-9e0e-d919836e8d84\",\n \"messages\": [\n {\n \"to\": \"4670123456\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\",\n \"description\": \"Message accepted, pending for delivery.\"\n },\n \"messageId\": \"c090e05d-deb5-4aa3-8687-bdac0cc3c7d8\"\n }\n ]\n}"}],"_postman_id":"b6a2b5fe-65fb-4c22-b0ad-660f53aacafb"},{"name":"Multiple voice message","id":"d5d8caba-614c-401a-8a7c-24b4726686c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/tts/3/multi","description":"

This method allows you to send multiple voice messages to more destination addresses.

Request body schema

{\n  \"text\": \"\",\n  \"audioFileUrl\": \"\"\n  \"language\": \"\",\n  \"voice\": {\n    \"name\": \"\",\n    \"gender\": \"\"\n  },\n  \"from\": \"\",\n  \"to\": \"\"\n}\n\n

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

Parameter	Type	Description
audioFileUrl	string	An audio file can be delivered as a voice message to the recipients. An audio file must be uploaded online, so that the existing URL can be available for file download. Size of the audio file must be below 4 MB. 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.
from	string	Required Numeric sender ID in E.164 standard format (Example: 46701234567). This is caller ID that will be presented to the end user where applicable.
language	string	If the message is in text format, the language in which the message is written must be defined for correct pronunciation. More about Text-to-speech functionality and supported TTS languages can be found here. If not set, default language is English [en]. If voice is not set, then default voice for that specific language is used. In the case of English language, the voice is [Joanna].
text	string	Message to be converted to speech and played to subscribers. Message text can be up to 1400 characters long and cannot contain only punctuation.
to	string required	Phone number of the recipient. Phone number must be written in E.164 standard format (Example: 46701234567).
voice	object	Used to define voice in which text would be synthesized. It has two parameters: name and gender. When only name is provided, then that exact voice with that name will be used to synthesize text. If only gender is provided, then text is synthesized with first voice in given gender. If voice is not set, then default voice is used.

Voice: object

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

Parameter	Type	Description
gender	string	Gender of the voice. Can be male or female.
name	string	Name of the voice. Example: Joanna

Response format

If successful, response header HTTP status code will be 200 OK and the message will be sent.

If you try to send a message without authorization, you will receive the 401 Unauthorized error .

VoiceResponse

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

Parameter	Type	Description
messages	Array of objects	Array of sent message objects, one object per every message.

VoiceResponseDetails

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

Parameter	Type	Description
to	String	The message destination address.
status	Status	Indicates whether the message has been successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
messageId	String	The ID that uniquely identifies the message sent.

Status

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

Parameter	Type	Description
groupId	Int	Status group ID
groupName	String	Status group name
id	Int	Status ID
name	String	Status name
description	String	Human readable description of the status.

Languages

List of supported languages:

Language	Language shortcut
English	en
English (British)	en-gb
English (Australian)	en-au
English (Indian)	en-in
English (Welsh)	en-gb-wls
Spanish	es
Catalan	ca
Chinese-Simplified	zh-cn
Chinese-Traditional	zh-tw
Danish	da
Dutch	nl
French	fr
German	de
Italian	it
Japanese	ja
Korean	ko
Norwegian	no
Polish	pl
Portuguese	pt-pt
Portuguese - Brazilian	pt-br
Russian	ru
Swedish	sv
Finnish	fi
Turkish	tr
Welsh	wls

","urlObject":{"protocol":"https","path":["tts","3","multi"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"057bc74c-af2f-4b59-858f-e2927be74e75","name":"Multiple voice message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"audioFileUrl\": \"https://www.example.com/media.mp3\",\n \"from\": \"46701923177\",\n \"to\": [\n \"4670123456\",\n \"4670123457\"\n ]\n },\n {\n \"text\": \"Hello world!\",\n \"language\": \"en\",\n \"voice\": {\n \"name\": \"Joanna\",\n \"gender\": \"female\"\n },\n \"from\": \"46701923177\",\n \"to\": [\n \"4670123458\",\n \"4670123459\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/tts/3/multi"},"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":"888"},{"key":"Date","value":"Wed, 19 Apr 2023 06:14:42 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1681884883339997226"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"1cab30c2-4730-45e5-a911-dd63aa4cff67\",\n \"messages\": [\n {\n \"to\": \"4670123456\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\",\n \"description\": \"Message accepted, pending for delivery.\"\n },\n \"messageId\": \"b1a662cf-4509-4084-8f24-5c57223e0efa\"\n },\n {\n \"to\": \"4670123457\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\",\n \"description\": \"Message accepted, pending for delivery.\"\n },\n \"messageId\": \"67d03a79-54ca-4cf2-aba2-98f0ff9ebbec\"\n },\n {\n \"to\": \"4670123458\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\",\n \"description\": \"Message accepted, pending for delivery.\"\n },\n \"messageId\": \"ef80839d-4829-462a-9c8f-c973452344f1\"\n },\n {\n \"to\": \"4670123459\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\",\n \"description\": \"Message accepted, pending for delivery.\"\n },\n \"messageId\": \"18b2cde8-a914-4ab3-8166-711616f28cf9\"\n }\n ]\n}"}],"_postman_id":"d5d8caba-614c-401a-8a7c-24b4726686c2"},{"name":"Send advanced voice messages","id":"61358299-8d87-4a38-a9eb-9ce761e5b96c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/tts/3/advanced","description":"

This method allows you to send advanced voice messages with all the available features and parameters.

Request body schema

{\n  \"bulkId\": \"\",\n  \"messages\": [\n    {\n      \"from\": \"\",\n      \"destinations\": [\n        {\n          \"to\": \"\",\n          \"messageId\": \"\"\n        },\n        {\n          \"to\": \"\"\n        }\n      ],\n      \"audioFileUrl\":\"\",\n      \"text\": \"\",\n      \"language\": \",\n      \"voice\": {\n        \"name\": \"\",\n        \"gender\": \"\"\n      },\n      \"speechRate\": ,\n      \"notifyUrl\": \"\",\n      \"notifyContentType\": \"\",\n      \"validityPeriod\": ,\n      \"sendAt\": \"\",\n      \"record\":,\n      \"repeatDtmf\": \"\",\n      \"maxDtmf\":,\n      \"ringTimeout\": ,\n      \"dtmfTimeout\": ,\n      \"callTimeout\": ,\n      \"callTransfers\": [\n        {\n          \"equals\": \"\",\n          \"transferTo\": \"\",\n          \"callTransferMaxDuration\": ,\n          \"if\": \"\"\n        },\n        {\n          \"transferTo\": \"\",\n          \"callTransferMaxDuration\": ,\n          \"if\": \"\"\n        }\n      ],\n      \"callbackData\": \"\",\n      \"pause\": ,\n      \"retry\": {\n        \"minPeriod\": ,\n        \"maxPeriod\": ,\n        \"maxCount\": \n      },\n      \"sendingSpeed\": {\n        \"speed\":,\n        \"timeUnit\": \"\"\n      },\n      \"machineDetection\": \"\",\n      \"deliveryTimeWindow\": {\n        \"from\": {\n          \"hour\": ,\n          \"minute\": \n        },\n        \"to\": {\n          \"hour\": ,\n          \"minute\": \n        },\n        \"days\": [\n          \"\",\n          \"\",\n          \"\",\n          \"\",\n          \"\",\n          \"\",\n          \"\"\n        ]\n      }\n    }\n  ]\n}\n\n

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

Parameter	Type	Description
bulkId	string	The ID which uniquely identifies the request.
messages	array of objects	Required Array of messages to be sent, one object per every message

  \"messages\": [\n    {\n      \"from\": \"\",\n      \"destinations\": [],\n      \"audioFileUrl\":\"\",\n      \"text\": \"\",\n      \"language\": \",\n      \"voice\": {},\n      \"speechRate\": ,\n      \"notifyUrl\": \"\",\n      \"notifyContentType\": \"\",\n      \"validityPeriod\": ,\n      \"sendAt\": \"\",\n      \"record\":,\n      \"repeatDtmf\": \"\",\n      \"maxDtmf\":,\n      \"ringTimeout\": ,\n      \"dtmfTimeout\": ,\n      \"callTimeout\": ,\n      \"callTransfers\": [],\n      \"callbackData\": \"\",\n      \"pause\": ,\n      \"retry\": {},\n      \"sendingSpeed\": {},\n      \"machineDetection\": \"\",\n      \"deliveryTimeWindow\": {}\n    }\n  ]\n\n

Parameter	Type	Description
from	string	The ID which uniquely identifies the request.
destinations	array of objects	Required Message destination addresses. Destination address must be in the E.164 standard format (Example: 46701234567).
audioFileUrl	string	An audio file can be delivered as a voice message to the recipients. An audio file must be uploaded online, so that the existing URL can be available for file download. Size of the audio file must be below 4 MB. 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. Note: We can only use either audioFileUrl or text not both.
text	string	Text of the message that will be sent. Message text can be up to 1400 characters long and cannot contain only punctuation. Adding pauses between the words and extending the duration of the voice message is possible by using the comma character “,”. For example, if you want to have a 3 second pause after each word, then the text parameter should look like this “one,,,,,,two,,,,,,three,,,,,,”. Each comma creates a pause of 0.5 seconds. Note: We can only use either audioFileUrl or text not both.
language	string	If the message is in text format, the language in which the message is written must be defined for correct pronunciation. More about Text-to-speech functionality and supported TTS languages can be found here. If not set, default language is English [en]. If voice is not set, then default voice for that specific language is used. In the case of English language, the voice is [Joanna]. Voice Text-To-Speech Languages
voice	object	Used to define voice in which text would be synthesized. It has two parameters: name and gender. When only name is provided, then that exact voice with that name will be used to synthesize text. If only gender is provided, then text is synthesized with first voice in given gender. If voice is not set, then default voice for that specific language is used.
speechRate	number	The reproduction speed of speech in the resulting message. Effective only when using text. Supported range is from 0.5 (slow down speech) to 2 (speed up speech). Values less than 0.5 will be replaced with 0.5, and values higher than 2 will be replaced with 2. Default value is 1.
notifyUrl	string	The URL on your callback server on which the Delivery report will be sent.
notifyContentType	string	Preferred Delivery report content type. Can be application/json or application/xml.
validityPeriod	integer	The 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).
sendAt	string	Used for scheduled Voice messages (message not to be sent immediately, but at scheduled time).
record	boolean	Record the call and expose it to client as URL inside the delivery report. Can be true or false
repeatDtmf	string	Specify DTMF code that is used as an indicator to repeat the voice message to the end user. The # key cannot be collected, as it is reserved for user input termination. Message can be repeated up to 5 times.
maxDtmf	integer	Defines the maximum number of DTMF codes entered by end user that would be collected.
ringTimeout	integer	Ringing 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.
dtmfTimeout	integer	The waiting period for end user to enter DTMF digits. Default value is 10 seconds.
callTimeout	integer	Maximum possible duration of the call to be set, shown in seconds.
callTransfers	array of objects	Call transfers object enables transferring the ongoing call to another recipient(s) and establish a communication between your original recipient and additional one.
callbackData	string	Additional client's data that will be sent on the notifyUrl. The maximum value is 200 characters. Example: Text containing some additional data needed in Delivery Report
pause	integer	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.
retry	object	Used 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.
sendingSpeed	object	Sending rate defined in number of messages sent per second, minute, hour or day. First message will be sent immediately (or at sendAt time if scheduling is used) and subsequent messages will be sent respecting defined speed. For example, if sendingSpeed is defined as 10 messages per hour, messages will be sent every 6 minutes. If this parameter is defined, validityPeriod is ignored.
machineDetection	string	Used for enabling detection of answering machine after the call has been answered. It can be set to hangup or continue. When set to hangup, if a machine is detected call will hang up. When set to continue, if a machine is detected, then voice message starts playing into voice mail after the answering message is finished with its greeting. If machineDetection is used, there is a minimum of 4 seconds detection time, which can result in delay of playing the message. Answering machine detection is additionally charged. For more information please contact your account manager and check documentation on Answering Machine Detection.
deliveryTimeWindow	object	Scheduling 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. Days in the week are written as their full names: Monday-Sunday. Days parameter must be populated as a list, between two square brackets. Example: ['MONDAY', 'TUESDAY', 'WEDNESDAY']. 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. From and to parameters are objects, that consist of hour and minute fields that hold integer values. For example, from: [ hour: 15, minute:45 ]. For complete json, please check out our example. Note: delivery time window is set in UTC timezone.

destinations\": [\n        {\n          \"to\": \"\",\n          \"messageId\": \"\"\n        },\n        {\n          \"to\": \"\"\n        }\n      ]\n\n

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

Parameter	Type	Description
messageId	string	The ID that uniquely identifies the message sent
to	string	Required Message destination addresses. Destination address must be in the E.164 standard format (Example: 46701234567).

voice\": {\n        \"name\": \"\",\n        \"gender\": \"\"\n      }\n\n

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

Parameter	Type	Description
name	string	Gender of the voice. Can be male or female.
gender	string	Name of the voice. Example: Joanna.

callTransfers\": [\n        {\n          \"equals\": \"\",\n          \"transferTo\": \"\",\n          \"callTransferMaxDuration\": ,\n          \"if\": \"\"\n        }\n\n

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

Parameter	Type	Description
equals	string	Criteria for establishing call transfer, if dtmf is evaluated.
transferTo	string	Phone number of the recipient that will receive transferred call. Must be written in E.164 standard (Example: 46701234567).
callTransferMaxDuration	integer	Maximum duration of the transferred call, specified in seconds.
if	string	Specifies what to evaluate. Can be dtmf or anyDtmf.

\"retry\": {\n        \"minPeriod\": ,\n        \"maxPeriod\": ,\n        \"maxCount\": \n      }\n\n

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

Parameter	Type	Description
minPeriod	integer	Required Defines the maximum waiting time (in minutes) after the previous failed attempt to try to deliver the message again.
maxPeriod	integer	Required Defines the minimal waiting time (in minutes) after the previous failed attempt to try to deliver the message again.
maxCount	integer [ -32768 .. 32767 ]	Required 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.

\"sendingSpeed\": {\n        \"speed\":,\n        \"timeUnit\": \"\"\n      }\n\n

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

Parameter	Type	Description
speed	integer	Defines the number of messages that will be sent per specified time unit.
timeUnit	string	Defines time unit used for calculating sending speed. Possible values: second, minute, hour and day.

 \"deliveryTimeWindow\": {\n        \"from\": {\n          \"hour\": ,\n          \"minute\": \n        },\n        \"to\": {\n          \"hour\": ,\n          \"minute\": \n        },\n        \"days\": [\n          \"\",\n          \"\",\n          \"\",\n          \"\",\n          \"\",\n          \"\",\n          \"\"\n        ]\n      }\n    }\n\n

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

Parameter	Type	Description
days	Array of strings	Items Enum: \"MONDAY\" \"TUESDAY\" \"WEDNESDAY\" \"THURSDAY\" \"FRIDAY\" \"SATURDAY\" \"SUNDAY\"
from	object	Required.
to	object	Required

\"from\": {\n          \"hour\": ,\n          \"minute\": \n\n

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

Parameter	Type	Description
hour	integer	Required
minute	integer	Required

to\": {\n          \"hour\": ,\n          \"minute\": \n\n

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

Parameter	Type	Description
hour	integer	Required
minute	integer	Required

Languages

List of supported languages:

Language	Language shortcut
English	en
English (British)	en-gb
English (Australian)	en-au
English (Indian)	en-in
English (Welsh)	en-gb-wls
Spanish	es
Catalan	ca
Chinese-Simplified	zh-cn
Chinese-Traditional	zh-tw
Danish	da
Dutch	nl
French	fr
German	de
Italian	it
Japanese	ja
Korean	ko
Norwegian	no
Polish	pl
Portuguese	pt-pt
Portuguese - Brazilian	pt-br
Russian	ru
Swedish	sv
Finnish	fi
Turkish	tr
Welsh	wls

Response format

If successful, the response header HTTP status code will be 200 OK and the message will be sent.

If you try to send the message without authorization, you will receive a 401 Unauthorized error.

VoiceResponse

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

Parameter	Type	Description
bulkId	String	The ID that uniquely identifies the request. Bulk ID will be received when a message is sent to more than one destination address.
messages	VoiceResponseDetails	Array of sent message objects, one object per every message.

VoiceResponseDetails

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

Parameter	Type	Description
to	String	The message destination address.
status	Status	Indicates whether the message has been sent successfully, not sent, delivered, not delivered, waiting for delivery or any other possible status.
messageId	String	The ID that uniquely identifies the sent message.

Status

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

Parameter	Type	Description
groupId	Int	Status group ID.
groupName	String	Status group name.
id	Int	Status ID.
name	String	Status name.
description	String	Human readable description of the status.

","urlObject":{"protocol":"https","path":["tts","3","advanced"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"0ddc400f-69ab-4978-b1af-fca9187cbef9","name":"Fully featured voice messages","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"bulkId\": \"BULK-ID-123-xyz\",\n \"messages\": [\n {\n \"from\": \"46701923177\",\n \"destinations\": [\n {\n \"to\": \"4670123456\",\n \"messageId\": \"MESSAGE-ID-123-xyz\"\n },\n {\n \"to\": \"4670123457\"\n }\n ],\n \"text\": \"Test Voice message.\",\n \"language\": \"en\",\n \"voice\": {\n \"name\": \"Joanna\",\n \"gender\": \"female\"\n },\n \"speechRate\": 1,\n \"notifyUrl\": \"https://www.example.com/voice/advanced\",\n \"notifyContentType\": \"application/json\",\n \"validityPeriod\": 720,\n \"sendAt\": \"2023-04-20T15:45:10.649+0000\",\n \"record\": false,\n \"repeatDtmf\": \"123\",\n \"maxDtmf\": 1,\n \"ringTimeout\": 45,\n \"dtmfTimeout\": 10,\n \"callTimeout\": 130,\n \"callTransfers\": [\n {\n \"equals\": \"2\",\n \"transferTo\": \"4670123450\",\n \"callTransferMaxDuration\": 45,\n \"if\": \"DTMF\"\n },\n {\n \"transferTo\": \"4670123451\",\n \"callTransferMaxDuration\": 45,\n \"if\": \"anyDtmf\"\n }\n ],\n \"callbackData\": \"DLR callback data\",\n \"pause\": 3,\n \"retry\": {\n \"minPeriod\": 1,\n \"maxPeriod\": 5,\n \"maxCount\": 5\n },\n \"sendingSpeed\": {\n \"speed\": 5,\n \"timeUnit\": \"minute\"\n },\n \"deliveryTimeWindow\": {\n \"from\": {\n \"hour\": 6,\n \"minute\": 0\n },\n \"to\": {\n \"hour\": 15,\n \"minute\": 30\n },\n \"days\": [\n \"MONDAY\",\n \"TUESDAY\",\n \"WEDNESDAY\",\n \"THURSDAY\",\n \"FRIDAY\",\n \"SATURDAY\",\n \"SUNDAY\"\n ]\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/tts/3/advanced"},"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":"437"},{"key":"Date","value":"Thu, 20 Apr 2023 14:33:54 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1682001234027824663"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"BULK-ID-123-xyz\",\n \"messages\": [\n {\n \"to\": \"4670123456\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\",\n \"description\": \"Message accepted, pending for delivery.\"\n },\n \"messageId\": \"MESSAGE-ID-123-xyz\"\n },\n {\n \"to\": \"4670123457\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\",\n \"description\": \"Message accepted, pending for delivery.\"\n },\n \"messageId\": \"31b710ff-b996-48ae-a478-e2de291f16de\"\n }\n ]\n}"}],"_postman_id":"61358299-8d87-4a38-a9eb-9ce761e5b96c"},{"name":"Delivery reports for voice messages","id":"eeeb5229-21f2-4696-95b5-12f7b43d1ad4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://go2.vhdmedia.se/tts/3/reports","description":"

This method allows you to get one-time delivery reports Response format

If successful, the response header HTTP status code will be 200 OK and delivery reports will be returned in the response body.

If you try to send a message without authorization, you will get a response with the HTTP status code 401 Unauthorized.

VoiceReportResponse

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

Parameter	Type	Description
results	array of Objects	Collection of reports, one per every message.

VoiceReport

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

Parameter	Type	Description
bulkId	string	Bulk ID.
messageId	string	Message ID.
to	string	Destination address.
sentAt	string	Tells when the voice message was sent. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
doneAt	string	Tells when the voice message was processed (ie. delivered to destination, delivered to destination network, etc.)
duration	int	Call duration in seconds.
mccMnc	string	Mobile country and network codes.
dtmfCodes	string	DTMF code entered by user.
recordedAudioFileUrl	string	Url to retrieve recorded calls that were made by messages with the record feature activated.
price	price	Sent voice message price.
status	status	Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
error	object	Indicates whether the error occurred during the query execution.

Price

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

Parameter	Type	Description
pricePerSecond	number	Price per one second of the voice message.
currency	string	The currency in which the price is expressed.

Status

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

Parameter	Type	Description
groupId	int	Status group ID.
groupName	string	Status group name.
id	int	Status ID.
name	string	Status name.
description	string	Human readable description of the status.

Error

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

Parameter	Type	Description
groupId	int	Error group ID.
groupName	string	Error group name.
id	int	Error ID.
name	string	Error name.
description	string	Human readable description of the error.
permanent	boolean	Tells if the error is permanent.

Recorded Audio File

If the option to record was enabled, the response will contain the recordedAudioFileUrl field. Using that URL with a GET method will initiate the download of the recorded file. If using a REST testing client, make sure to save the downloaded data instead of displaying it in the client's response area.
Recordings are encoded as PCM WAVE signed little-endian 16bit 8kHz audio files.

\n

Delivery reports are returned only once. Additional delivery report request will return an empty collection.

\n","urlObject":{"protocol":"https","path":["tts","3","reports"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"c2c1bf7c-56d1-4ac5-89fb-8cb0b8020aef","name":"Delivery reports for voice messages","originalRequest":{"method":"GET","header":[],"url":"https://go2.vhdmedia.se/restapi/tts/3/reports"},"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":"Date","value":"Wed, 19 Apr 2023 13:23:11 GMT"},{"key":"Server","value":"SMS API"},{"key":"Deprecation","value":"true"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"X-Request-Id","value":"1681910592023698663"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"bulkId\": \"f7c13c8e-fd34-4852-a531-6de2ad016c10\",\n \"messageId\": \"8adc066c-2c03-4f9f-b928-a788f832f763\",\n \"to\": \"4670123456\",\n \"sentAt\": \"2023-04-18T10:49:08.692+0000\",\n \"doneAt\": \"2023-04-18T10:49:33.335+0000\",\n \"startTime\": \"2023-04-18T10:49:08.000+0000\",\n \"endTime\": \"2023-04-18T10:49:23.291+0000\",\n \"answerTime\": \"2023-04-18T10:49:21.000+0000\",\n \"duration\": 0,\n \"fileDuration\": 1.306125,\n \"mccMnc\": \"null\",\n \"callbackData\": \"\",\n \"dtmfCodes\": \"\",\n \"price\": {\n \"pricePerSecond\": 0,\n \"currency\": \"UNKNOWN\"\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\": 5000,\n \"name\": \"VOICE_ANSWERED\",\n \"description\": \"Call answered by human\",\n \"permanent\": true\n }\n },\n {\n \"bulkId\": \"91800d15-664c-4916-b86d-4b7f6c4d8eb3\",\n \"messageId\": \"4ef64d1f-d3a4-43fb-ac4a-9419a423150e\",\n \"to\": \"4670123457\",\n \"sentAt\": \"2023-04-18T10:50:19.187+0000\",\n \"doneAt\": \"2023-04-18T10:50:37.353+0000\",\n \"startTime\": \"2023-04-18T10:50:19.000+0000\",\n \"endTime\": \"2023-04-18T10:50:27.314+0000\",\n \"answerTime\": \"2023-04-18T10:50:25.000+0000\",\n \"duration\": 0,\n \"fileDuration\": 1.985375,\n \"mccMnc\": \"null\",\n \"callbackData\": \"\",\n \"dtmfCodes\": \"\",\n \"price\": {\n \"pricePerSecond\": 0,\n \"currency\": \"UNKNOWN\"\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\": 5000,\n \"name\": \"VOICE_ANSWERED\",\n \"description\": \"Call answered by human\",\n \"permanent\": true\n }\n }\n \n \n \n ]\n}"},{"id":"44b53384-7eeb-4d81-a917-91e56ad21307","name":"Getting two initial delivery reports for voice messages","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://go2.vhdmedia.se/tts/3/reports?limit=2","protocol":"https","host":["go2","vhdmedia","se"],"path":["tts","3","reports"],"query":[{"key":"limit","value":"2"}]}},"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":"1490"},{"key":"Date","value":"Tue, 25 Apr 2023 17:33:06 GMT"},{"key":"Server","value":"SMS API"},{"key":"Deprecation","value":"true"},{"key":"X-Request-Id","value":"1682443987375062827"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"bulkId\": \"BULK-ID-123-xyz\",\n \"messageId\": \"724f8453-0cb4-4d46-a361-d6142bd9facb\",\n \"to\": \"4670123456\",\n \"sentAt\": \"2023-04-25T14:38:26.012+0000\",\n \"doneAt\": \"2023-04-25T14:39:34.089+0000\",\n \"startTime\": \"2023-04-25T14:38:24.086+0000\",\n \"endTime\": \"2023-04-25T14:39:34.086+0000\",\n \"answerTime\": \"2023-04-25T14:38:48.086+0000\",\n \"duration\": 0,\n \"mccMnc\": \"null\",\n \"callbackData\": \"DLR callback data\",\n \"price\": {\n \"pricePerSecond\": 0,\n \"currency\": \"UNKNOWN\"\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\": 5000,\n \"name\": \"VOICE_ANSWERED\",\n \"description\": \"Call answered by human\",\n \"permanent\": true\n }\n },\n {\n \"bulkId\": \"BULK-ID-123-xyz\",\n \"messageId\": \"MESSAGE-ID-123-xyz\",\n \"to\": \"4670123457\",\n \"sentAt\": \"2023-04-25T14:37:26.847+0000\",\n \"doneAt\": \"2023-04-25T14:37:27.546+0000\",\n \"startTime\": \"2023-04-25T14:37:26.000+0000\",\n \"endTime\": \"2023-04-25T14:37:27.506+0000\",\n \"duration\": 0,\n \"fileDuration\": 1.724125,\n \"mccMnc\": \"null\",\n \"callbackData\": \"DLR callback data\",\n \"dtmfCodes\": \"\",\n \"price\": {\n \"pricePerSecond\": 0,\n \"currency\": \"UNKNOWN\"\n },\n \"status\": {\n \"groupId\": 2,\n \"groupName\": \"UNDELIVERABLE\",\n \"id\": 4,\n \"name\": \"UNDELIVERABLE_REJECTED_OPERATOR\",\n \"description\": \"Message rejected by operator\"\n },\n \"error\": {\n \"groupId\": 3,\n \"groupName\": \"OPERATOR_ERRORS\",\n \"id\": 5404,\n \"name\": \"EC_VOICE_ERROR_DESTINATION_NOT_FOUND\",\n \"description\": \"The server has definitive information that the user does not exist at the domain specified in the Request-URI\",\n \"permanent\": false\n }\n }\n ]\n}"}],"_postman_id":"eeeb5229-21f2-4696-95b5-12f7b43d1ad4"},{"name":"Voice message logs","id":"45c85b2b-c5cc-476b-809f-32aa8b5b651d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://go2.vhdmedia.se/tts/3/logs","description":"

This method allows you to get logs for sent voice messages.

Request body schema

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

Parameter	Type	Description
from	string	Sender ID that can be numeric.
to	string	The message destination address.
bulkId	array of strings	The ID which uniquely identifies the request.
messageId	array of strings	The ID that uniquely identifies the message sent.
generalStatus	string	Sent voice message status group. Indicates whether the message has been successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status
sentSince	string	Lower limit on date and time of sending a Voice message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
sentUntil	string	Upper limit on date and time of sending a Voice message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
limit	integer	Maximal number of messages in the returned logs. Default value is 50.
mcc	string	Mobile country code.
mnc	string	Mobile network code.

Response format

If successful, the response header HTTP status code will be 200 OK and the message logs will be returned.

If you try to send the message without authorization, you will get a response with HTTP status code 401 Unauthorized.

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

VoiceLogsResponse

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

Parameter	Type	Description
results	array of objects	Array of voice message logs, one object per each message

VoiceLog

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

Parameter	Type	Description
bulkId	string	The ID that uniquely identifies the request.
messageId	string	The ID that uniquely identifies the message sent.
to	string	The message destination address.
from	string	Sender ID that can be alphanumeric or numeric.
text	string	Text of the message that was sent.
sentAt	date	Tells when the voice message was sent. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
doneAt	date	Tells when the voice message was processed (ie. delivered to the destination, delivered to the destination network, etc.)
duration	Int	Call duration in seconds.
mccMnc	string	Mobile country and network codes.
price	object	Sent voice message price.
status	object	Indicates whether the message has been successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
error	object	Indicates whether the error occurred during the query execution.

Price

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

Parameter	Type	Description
pricePerSecond	number	Price per one second of voice message.
currency	string	The currency in which the price is expressed.

Status

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

Parameter	Type	Description
groupId	Int	Status group ID.
groupName	String	Status group name
id	Int	Status ID.
name	String	Status name.
description	String	Human readable description of the status.

Error

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

Parameter	Type	Description
groupId	int	Error group ID.
groupName	string	Error group name.
id	int	Error ID.
name	string	Error name.
description	string	Human-readable description of the error.
permanent	boolean	Tells if the error is permanent.

","urlObject":{"protocol":"https","path":["tts","3","logs"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"72fd1d46-a261-42f7-8655-882d1578f6b7","name":"Voice message logs","originalRequest":{"method":"GET","header":[],"url":"https://go2.vhdmedia.se/restapi/tts/3/logs"},"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":"Date","value":"Wed, 19 Apr 2023 13:25:57 GMT"},{"key":"Server","value":"SMS API"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"X-Request-Id","value":"1681910758002824837"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n \n {\n \"bulkId\": \"f7c13c8e-fd34-4852-a531-6de2ad016c10\",\n \"messageId\": \"8adc066c-2c03-4f9f-b928-a788f832f763\",\n \"to\": \"4670123456\",\n \"from\": \"46701923188\",\n \"text\": \"Test Voice message.\",\n \"sentAt\": \"2023-04-18T10:49:08.692+0000\",\n \"doneAt\": \"2023-04-18T10:49:23.333+0000\",\n \"duration\": 2,\n \"mccMnc\": \"24001\",\n \"price\": {\n \"pricePerSecond\": 0.0001,\n \"currency\": \"Swedish Krona\"\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\": 5000,\n \"name\": \"VOICE_ANSWERED\",\n \"description\": \"Call answered by human\",\n \"permanent\": true\n }\n }\n ]\n}"}],"_postman_id":"45c85b2b-c5cc-476b-809f-32aa8b5b651d"}],"id":"74290ac5-ea20-4ece-99ef-7200de7c6dfe","description":"

Service Description

Voice messaging is an automated way to call many people to deliver a voice message that was prerecorded or converted from a text. Also known as Voice SMS or Voice broadcast or robo calling, it delivers voice messages to any fixed or mobile phone in the world. Text2Speech can also record voice or dial pad responses from the called party. Voice messaging helps many companies save money, because it eliminates the need for call centers to spread messages.

Many companies use Voice messaging to inform their customers of their latest promotions and offers. It is especially effective for spreading time sensitive messages like emergency messages, PINs for 2-Factor Authentication, last minute updates, to generate an opinion on a certain matter, send political messages and various other use cases

Developer API

Our Voice messaging API is a simple REST API. For an originating call you submit a POST HTTP request with a well-structured body and in response you get a token with which you can identify the originated call. With that token you can poll for call status, or call for a detailed record (CDR), which is an object containing detailed information about a call.

Our API provide several features, other than just playing a voice message to an end user. You can record an entire call and get a download URL of the recorded file. You can tell us not to stop after just one failed try, and if necessary we will retry the call. You can instruct us to wait for the user to enter one digit, and we will provide you with the user's input in CDR. Detailed specification can be found in the following pages.

\n","_postman_id":"74290ac5-ea20-4ece-99ef-7200de7c6dfe"},{"name":"INTERACTIVE VOICE RESPONSE","item":[{"name":"IVR variables and actions","item":[],"id":"c821c4cd-8750-45f4-9d23-a151c2575874","description":"

IVR Variables and Actions

Let's learn about IVR building blocks

Variables

During 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:

from - 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

Let's take a look at the available scenario actions:

Say
Collect
Dial
Play
Call API
Switch - Case
Repeat - Until
While do
Hang up

Also, IVR use cases contain simple examples you can use for your own scenarios.

Say

A 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
say	String	message text
options > language	String	Must be defined for correct pronunciation. In the Languages section, you can find the list of languages that we support.
options > speechRate	Double	Must be within [0.5 - 2.0] range, default value is 1.

JSON

{\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

A Collect action performs DTMF input reading and saving from the user's phone.

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

Property	Type	Description
collectInto	String	the name of the variable to set
options > maxInputLength	Integer	the maximum number of DTMF tones to wait for, 0 for unlimited.

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

JSON

{\n  \"collectInto\": \"myVariable\",\n  \"options\": {\n    \"maxInputLength\": 1\n  }\n}\n\n

Dial

A 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\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Note
dial	String	must be a valid E164 MSISDN; the parameter can be constructed using variables

JSON

{\n  \"dial\": \"41793026731\"\n}\n\n

Play

A Play action performs playback of audio provided by the client’s URL.

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

Property	Type	Default	Note
playFromUrlString	string	(required)	(required)

JSON

{\n  \"playFromUrl\": \"http://www.example.com/voice/sound.mp3\"\n}\n\n

Call API

A Call 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. 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.

The 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Default	Note
request	String	(required)	the URL to target
options > method	String	(required)	GET, POST, PUT, DELETE
options > headers	Object	(required, for content-type)
options > body	String or Object	(required for body-enclosing methods)	the request body to send
options > collectResponse	boolean	false	if set, will cause the system to process the response

JSON

{\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  \"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  \"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

A 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Default	Note
switch	String	(required)	name of the variable whose value to inspect
case	Object	(required)	object whose keys are possible variable values, and values are arrays of actions
__default	Array		array of actions to execute if none of the conditions above are met

JSON

{\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

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

JSON

{\n  \"repeat\": [\n    { \"say\": \"For exit you must press one.\" },\n    { \"collectInto\": \"myVariable\" }\n  ],\n  \"until\": \"${myVariable} == 1\"\n}\n\n

While - Do

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

JSON

{\n    \"while\": \"${myVariable} != 1\",\n    \"do\": [\n        { \"say\": \"For exit you must press one.\" },\n        { \"collectInto\": \"myVariable\" }\n    ]\n}\n\n

Hang up

A Hangup action is a pseudo-action marking the end of the IVR flow execution, leading to the call actually being hung up.

JSON

\"hangup\"\n\n

Languanges

List of languages available for Say action:

Language	Language shortcut
English	en
English (British)	en-gb
English (Australian)	en-au
English (Indian)	en-in
English (Welsh)	en-gb-wls
Spanish	es
Catalan	ca
Chinese-Simplified	zh-cn
Chinese-Traditional	zh-tw
Danish	da
Dutch	nl
French	fr
German	de
Italian	it
Japanese	ja
Korean	ko
Norwegian	no
Polish	pl
Portuguese	pt-pt
Portuguese - Brazilian	pt-br
Russian	ru
Swedish	sv
Finnish	fi
Turkish	tr
Welsh	wls

","_postman_id":"c821c4cd-8750-45f4-9d23-a151c2575874"},{"name":"IVR use cases","item":[],"id":"badb0b71-13a5-4bd8-a7ba-2ca338b66972","description":"

Just a few sample scenarios to inspire but possibilities are endless

Various IVR scenarios could be created by combining available actions. Here are just a few samples that you might check out before creating your own.

Scheduling an appointment
Checking order/delivery status
Cart abandonment

Scheduling an appointment

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

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

Here’s how the steps look. Code samples and a flow diagram are below:

Call customer phone number
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.
Collect action gathers the DTMF code entered by end user
User input is analyzed and, based on the DTMF, one of the following responses is played::

4a For DTMF 1, 2 or 3: Thank you. Your appointment is scheduled.
4b For any other DTMF or no DTMF: Thank you We will suggest another time slot once it’s available.

Example

JSON

{\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

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

Let us break down this process in steps.

Customer logs in to the web shop and stores a couple of products inside his shopping cart
After some time he leaves the web shop without completing the buying process
This is noticed by the client's back end system and this will trigger an IVR scenario ID towards that customer/destination
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.
Customer response will be collected and call API action will enable client to receive it
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.

Example

JSON

{\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":"badb0b71-13a5-4bd8-a7ba-2ca338b66972"},{"name":"Create a Voice IVR Scenario","id":"2e0981e8-86ae-44f3-8b95-4f21c0843d04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Capture speech\",\n \"description\": \"Capture users speech and branch the call based on the spoken words.\",\n \"script\": [\n {\n \"say\": \"Say yes or no\"\n },\n {\n \"capture\": \"myVar\",\n \"timeout\": 3,\n \"speechOptions\": {\n \"language\": \"en-US\",\n \"keyPhrases\": [\n \"yes\",\n \"no\"\n ]\n }\n },\n {\n \"if\": \"${myVar == 'yes'}\",\n \"then\": [\n {\n \"say\": \"Ok. I will send you more details\"\n }\n ],\n \"else\": []\n },\n {\n \"if\": \"${myVar == 'no'}\",\n \"then\": [\n {\n \"say\": \"Thank you for listening.\"\n }\n ],\n \"else\": []\n },\n {\n \"if\": \"${myVar == ''}\",\n \"then\": [\n {\n \"say\": \"I did not understand\"\n }\n ],\n \"else\": []\n },\n \"hangup\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/voice/ivr/1/scenarios","description":"

This method allows you to create a Voice IVR Scenario.

Request rate limit

1 requests / second (per account)

Request body schema

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

Property	Type	Description
name	string	The name of IVR scenario.
description	string	Description of IVR scenario.
script		Required 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.

Array [

One of

Call API

Call 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
request	string	The URL to target
options { method headers collectResponse	object string object boolean	Required 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.
actionId	integer	User-defined ID of an action that can be used with go-to action.

Capture

Capture action performs speech recognition of a specified duration. The recognized text can be used in other actions of the scenario.

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

Property	Type	Description
capture	string	Required. 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.
timeout	integer	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.
speechOptions { language keyPhrases maxSilence }	obejct string array of strings integer	Required. 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`.
dtmfOptions { maxInputLength mappedValues }	object integer object	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.
sendToReports	string	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).
actionId	integer	User-defined ID of an action that can be used with go-to action.

Collect

Collect 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
collectInto	string	Required. The name of the variable to set.
options { maxInputLength timeout sendToReports mappedValues }	object integer integer string object	Required 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.
actionId	integer	User-defined ID of an action that can be used with go-to action.

Dial

Dial 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
dial	string	Required. must be a valid E164 MSISDN; the parameter can be constructed using variables
options { senderId maxCallDuration }	object string integer	Required 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.
actionId	integer	User-defined ID of an action that can be used with go-to action.

Dial to Many

Dial 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
dialToMany [{ number numbers }]	arry of objects string string	Required. 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
options { parallel senderId maxCallDuration ringTimeout	obect boolean string integer integer	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.
actionId	integer	User-defined ID of an action that can be used with go-to action.

Dial to WebRTC

Dial 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\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
dialToWebRTC	string	Required. Web and in-app calls applicationId. Read more about Web and in-app calls here

Dial to SIP trunk

Dial 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
dialToSipTrunk	object	Required. Only one of these two properties (ipAddress, domainName) can be set.
options { from to headers ]	object string string object	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.
actionId	integer	User-defined ID of an action that can be used with go-to action.

Dial to Conversations

Dial 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\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
dialToConversations { options { tags } }	object object array of strings	Required. 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.

For-Each

For-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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
for-each	string	Required. Variable name that will be used inside the loop to represent single value from supplied list of values.
in	string	Required. Delimited string representing list of values; the parameter can be constructed using variables.
delimiter	string	Delimiter used for separating values in supplied list of values; the parameter can be constructed using variables. Default is comma.
do	arry of objects	Required.

Go-To

Go-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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
goTo	integer	Required. The actionId of an action to which to jumpç
options { gotoLimit countVariable }	object integer string	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.

Hang-up

Hangup action marks the end of the IVR flow execution, leading to the call actually being hung up.

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

Property	Type	Description
Hang-up	string	Value: \"hangup\"

If-Then-Else

If-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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
If-Then-Else	string	Required. The expression to evaluate
then	array of objects	The actions to execute if condition is evaluated to true
else	arry of objects	The actions to execute if condition is evaluated to false
actionId	integer	User-defined ID of an action that can be used with go-to action.

Machine Detection

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

Property	Type	Description
Machine Detection	string	Required. 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.

Pause

Pause action pauses execution of the IVR scenario for the provided duration.

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

Property	Type	Description
pause	number	Required. the amount to wait in seconds, from 0 (exclusive) to 5 (inclusive)
actionId	integer	User-defined ID of an action that can be used with go-to action.

Play

Play 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
playFromUrl	string	Required. Audio file URL.
actionId	integer	User-defined ID of an action that can be used with go-to action.

playFromRecording

Play from Recording Action plays audio recorded from the current or some other call.

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

Property	Type	Description
playFromRecording	string	Required. 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)
actionId	integer	User-defined ID of an action that can be used with go-to action.

Record

Record 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
record	integer	Required. The duration to record for in seconds; null for unlimited.
options { escapeDigits beep maxSilence identifier }	object string boolean integer string	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.
actionId	integer	User-defined ID of an action that can be used with go-to action.

Rpeat-Until

This 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
repeat	array of objects	Required.
until	string	The expression to evaluate.

Repeat-While

Repeat-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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
repeat	array of objects	Required.
while	string	The expression to evaluate.

Say

Say 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
say	string	Required. Message text. Cannot contain only punctuation.
options { language voice { name gender } speechRate }	object string object string string number	The 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.
actionId	integer	User-defined ID of an action that can be used with go-to action.

Send SMS

Send SMS action creates and sends a text message from the scenario.

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

Property	Type	Description
sendSms { text from to }	object string string string	Required. 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
actionId	integer	User-defined ID of an action that can be used with go-to action.

]

Set Variable

Set variable action makes it possible to set a variable defined inside the IVR scenario to a specified value.

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

Property	Type	Description
setVariable	string	Required. Name of a variable.
value	string	Value to which the variable should be set.

Switch-Case

Switch-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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
switch	string	Required. Name of the variable whose value to inspect.
case { _default }	object array of objects	Object 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.
actionId	integer	User-defined ID of an action that can be used with go-to action.

While-Do

While-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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
while	string	Required. The expression to evaluate.
do	arry of objects	Required.

Response

Default sucessful response

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

Parameter	Type	Description
createTime	object	Creation timestamp.
description	object	Scenario description.
id	string	Scenario key. It is used for launching IVR scenario.
name		Scenario name.
script	object	The list of scenario actions.
updateTime	string	Update timestamp

Error response

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["voice","ivr","1","scenarios"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"a45361ed-669c-4bdd-b8a9-dd6b6b89a30d","name":"Call API","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Call API\",\n \"description\": \"Perform a POST request to provided URL with headers and payload.\",\n \"script\": [\n {\n \"request\": \"https://example.com/hooks/catch/\",\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}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/voice/ivr/1/scenarios"},"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":"396"},{"key":"Date","value":"Tue, 23 May 2023 18:55:48 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684868149029882162"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"30FF52E6766A1DB018CB24DAD9635AF9\",\n \"name\": \"Call API\",\n \"description\": \"Perform a POST request to provided URL with headers and payload.\",\n \"createTime\": \"2023-05-23T18:55:49.063+0000\",\n \"updateTime\": null,\n \"script\": [\n {\n \"request\": \"https://example.com/hooks/catch/\",\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}"},{"id":"21c1cef6-c058-4999-bbae-c5bec3c12c3e","name":"Call Api to send collected DTMFs","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Call Api\",\n \"description\": \"Collect users input and submits it with a POST request to a url.\",\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}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/voice/ivr/1/scenarios"},"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":"627"},{"key":"Date","value":"Tue, 23 May 2023 21:06:00 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684875960343539827"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"AE04E18E021AF533B4AF8CEA8F615E0E\",\n \"name\": \"Call Api\",\n \"description\": \"Collect users input and submits it with a POST request to a url.\",\n \"createTime\": \"2023-05-23T21:06:00.363+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}"},{"id":"b13b6faa-7027-4225-8c40-d1445518db6d","name":"Create API with response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Call Api with collected response\",\n \"description\": \"Collect users input and submit it with a POST request to a url, and play the response back to the user. Let's assume the response is a simple JSON object that has only one field with a key called 'responseText' and value defined by the clients API.\",\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 \"collectResponse\": true\n }\n },\n {\n \"say\": \"${responseText}\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/voice/ivr/1/scenarios"},"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":"799"},{"key":"Date","value":"Tue, 23 May 2023 21:18:39 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684876720088623837"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"A3E37F97BE572E2BA0994C358741D12D\",\n \"name\": \"Call Api with collected response\",\n \"description\": \"Collect users input and submit it with a POST request to a url, and play the response back to the user. Let's assume the response is a simple JSON object that has only one field with a key called 'responseText' and value defined by the clients API.\",\n \"createTime\": \"2023-05-23T21:18:40.153+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 \"collectResponse\": true\n }\n },\n {\n \"say\": \"${responseText}\"\n }\n ]\n}"},{"id":"f8899214-a44f-4a49-ad83-0019d43e69c9","name":"Capture speech or digit","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Capture speech or digit\",\n \"description\": \"Capture speech or digit\",\n \"script\": [\n {\n \"say\": \"Say discount or press 1 to get discount. Say exit or press 0 to exit.\"\n },\n {\n \"capture\": \"myVar\",\n \"timeout\": 5,\n \"speechOptions\": {\n \"language\": \"en-US\",\n \"maxSilence\": 2,\n \"keyPhrases\": [\n \"discount\",\n \"exit\"\n ]\n },\n \"dtmfOptions\": {\n \"maxInputLength\": 1\n }\n },\n {\n \"if\": \"${myVar == 'discount' || myVar == '1'}\",\n \"then\": [\n {\n \"say\": \"You will get discount\"\n }\n ],\n \"else\": [\n {\n \"if\": \"${myVar == 'exit' || myVar == '0'}\",\n \"then\": [\n {\n \"say\": \"Goodbye\"\n }\n ],\n \"else\": [\n {\n \"say\": \"I did not understand\"\n }\n ]\n }\n ]\n },\n \"hangup\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/voice/ivr/1/scenarios"},"status":"Bad Request","code":400,"_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":"115"},{"key":"Date","value":"Tue, 23 May 2023 21:29:20 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684877360658761225"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"1684877360683748645\",\n \"text\": \"Route not set for: CaptureAction\"\n }\n }\n}"},{"id":"df5b83a7-944d-446a-9e19-56054f0df8a3","name":"Collect dtmf and branch call execution based on input","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Collect dtmf and branch call execution based on input\",\n \"description\": \"Based on the collected dtmf input, the execution is branched.\",\n \"script\": [\n {\n \"say\": \"Hello. Press 1 or 2.\"\n },\n {\n \"collectInto\": \"myVariable\",\n \"options\": {\n \"maxInputLength\": 1,\n \"timeout\": 5,\n \"sendToReports\": \"ALWAYS\",\n \"mappedValues\": {\n \"1\": \"pressed one\",\n \"2\": \"pressed two\"\n }\n }\n },\n {\n \"case\": {\n \"1\": [\n {\n \"say\": \"You have pressed 1,\"\n }\n ],\n \"2\": [\n {\n \"say\": \"You have pressed 2.\"\n }\n ]\n },\n \"switch\": \"myVariable\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/voice/ivr/1/scenarios"},"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":"541"},{"key":"Date","value":"Tue, 23 May 2023 21:30:33 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684877434199252663"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"E44CB14DD947C09A89C34A6614F82958\",\n \"name\": \"Collect dtmf and branch call execution based on input\",\n \"description\": \"Based on the collected dtmf input, the execution is branched.\",\n \"createTime\": \"2023-05-23T21:30:34.220+0000\",\n \"updateTime\": null,\n \"script\": [\n {\n \"say\": \"Hello. Press 1 or 2.\"\n },\n {\n \"collectInto\": \"myVariable\",\n \"options\": {\n \"maxInputLength\": 1,\n \"timeout\": 5,\n \"sendToReports\": \"ALWAYS\",\n \"mappedValues\": {\n \"1\": \"pressed one\",\n \"2\": \"pressed two\"\n }\n }\n },\n {\n \"case\": {\n \"1\": [\n {\n \"say\": \"You have pressed 1,\"\n }\n ],\n \"2\": [\n {\n \"say\": \"You have pressed 2.\"\n }\n ]\n },\n \"switch\": \"myVariable\"\n }\n ]\n}"},{"id":"25157977-4f24-46e9-a7e8-3f57abe8d7f0","name":"Capture","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Capture speech\",\n \"description\": \"Capture users speech and branch the call based on the spoken words.\",\n \"script\": [\n {\n \"say\": \"Say yes or no\"\n },\n {\n \"capture\": \"myVar\",\n \"timeout\": 3,\n \"speechOptions\": {\n \"language\": \"en-US\",\n \"keyPhrases\": [\n \"yes\",\n \"no\"\n ]\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/voice/ivr/1/scenarios"},"status":"Bad Request","code":400,"_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":"115"},{"key":"Date","value":"Tue, 23 May 2023 21:33:48 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684877628571046666"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"1684877628589707644\",\n \"text\": \"Route not set for: CaptureAction\"\n }\n }\n}"},{"id":"4ab4dbf3-f8d6-47bb-b860-55e51ea86bc7","name":"Capture short","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Capture speech\",\n \"description\": \"Capture users speech and branch the call based on the spoken words.\",\n \"script\": [\n {\n \"say\": \"If you want more info, say: info. If you want to reach our agent, say: agent\"\n},\n{\n \"capture\": \"myVar\",\n \"timeout\": 5,\n \"speechOptions\": {\n \"language\": \"en-US\",\n \"maxSilence\": 3,\n \"keyPhrases\": [\"info\", \"agent\"]\n }\n},\n{\n \"if\": \"${myVar == 'info'}\",\n \"then\": [\n {\n \"say\": \"Ok. I will send you more details\"\n }\n ],\n \"else\": []\n}\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/voice/ivr/1/scenarios"},"status":"Bad Request","code":400,"_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":"115"},{"key":"Date","value":"Tue, 23 May 2023 21:42:24 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684878145005532225"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"1684878145035674642\",\n \"text\": \"Route not set for: CaptureAction\"\n }\n }\n}"}],"_postman_id":"2e0981e8-86ae-44f3-8b95-4f21c0843d04"},{"name":"Search Voice IVR Scenarios","id":"b1e4e23b-8544-4ccb-9dae-c6d83fc11b59","protocolProfileBehavior":{"disableBodyPruning":true},"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 read the specific scenario by using the (scenario) name parameter or read all scenarios you have created.

Request without parameters will return first fifty scenarios ordered by name.

Query parameters

{\n  \"page\": \"\",\n  \"pageSize\": \"\",\n  \"name\": \"\",\n  \"label\": \"\"\n}\n\n

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

Parameter	Type	Description
page	integer	Page number you want to see. Default is 1.
pageSize	integer	Size of the page you want to see. Default is 50.
name	string	The name to search by.
label	string	The label of scenario to search by.

Responses

 {\n        \"id\": \"\",\n        \"name\": \"\",\n        \"description\": \"\",\n        \"createTime\": \"\",\n        \"updateTime\": ,\n        \"script\": [\n            {\n                \"request\": \"\",\n                \"options\": {\n                    \"method\": \"\",\n                    \"headers\": {\n                        \"content-type\": \"\"\n                    },\n                    \"body\": {\n                        \"payload\": \"\"\n                    }\n                }\n            }\n        ]\n    },\n\n

Array

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

Parameter	Type	Description
createTime	string	Creation timestamp.
description	string	Scenario description.
id	string	Scenario key. It is used for launching IVR scenario.
name	string	Scenario name.
script	object	The list of scenario actions..
updateTime	string	Update timestamp

Error response

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["voice","ivr","1","scenarios","{{id}}"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"022bc501-b88d-4e9b-afb1-7850e78b56b3","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://hooks.zapier.com/hooks/catch/4947235/34zpubx/\",\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":"b1e4e23b-8544-4ccb-9dae-c6d83fc11b59"},{"name":"Get IVR scenario","id":"a67bf4d1-6639-494b-b1be-cb46f7eafa3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://go2.vhdmedia.se/restapi/voice/ivr/1/scenarios/{{id}}","description":"

Use this method to get the scenario using scenarioId in the API endpoint.

Request body schema

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

Parameter	Type	Description
id	string [ 0 .. 255 ] characters	Required. Scenario identifier.

Responses

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

Parameter	Type	Description
createTime	string [ 0 .. 255 ] characters	Creation timestamp.
description	string [ 0 .. 50 ] characters	Scenario description.
id	string	Scenario key. It is used for launching IVR scenario.
name	string	Scenario name.
script	object	The list of scenario actions.
updateTime	string	Update timestamp

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["restapi","voice","ivr","1","scenarios","{{id}}"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"8a29de9e-6524-4511-a4ec-42c5345b38cd","name":"Get a voice IVR scenario","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":"372"},{"key":"Date","value":"Tue, 25 Apr 2023 10:15:38 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1682417739076789228"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5734EF89BEC28D09B7DF26E298242E97\",\n \"name\": \"Call API\",\n \"description\": \"Perform a POST request to provided URL with headers and payload.\",\n \"createTime\": \"2023-04-25T08:32:18.410+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}"}],"_postman_id":"a67bf4d1-6639-494b-b1be-cb46f7eafa3f"},{"name":"Update a Voice IVR Scenario","id":"56aa97b7-eec0-405c-a97e-c90ab0bcbe77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Call API\",\n \"description\": \"Perform a POST request to provided URL with headers and payload.\",\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}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/voice/ivr/1/scenarios/{{id}}","description":"

This method allows you to update a Voice IVR Scenario.

REQUEST RATE LIMIT:

1 requests / minute (per account)

Path parameters

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

Parameter	Type	Description
id	string	Required. Scenario identifier.

Request rate limit

1 requests / second (per account)

Request body schema

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

Property	Type	Description
name	string	The name of IVR scenario.
description	string	Description of IVR scenario.
script		Required 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.

Array [

One of

Call API

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

Property	Type	Description
request	string	The URL to target
options { method headers collectResponse	object string object boolean	Required 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.
actionId	integer	User-defined ID of an action that can be used with go-to action.

Capture

Capture action performs speech recognition of a specified duration. The recognized text can be used in other actions of the scenario.

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

Property	Type	Description
capture	string	Required. 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.
timeout	integer	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.
speechOptions { language keyPhrases maxSilence }	obejct string array of strings integer	Required. 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`.
dtmfOptions { maxInputLength mappedValues }	object integer object	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.
sendToReports	string	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).
actionId	integer	User-defined ID of an action that can be used with go-to action.

Collect

Collect 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
collectInto	string	Required. The name of the variable to set.
options { maxInputLength timeout sendToReports mappedValues }	object integer integer string object	Required 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.
actionId	integer	User-defined ID of an action that can be used with go-to action.

Dial

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

Property	Type	Description
dial	string	Required. must be a valid E164 MSISDN; the parameter can be constructed using variables
options { senderId maxCallDuration }	object string integer	Required 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.
actionId	integer	User-defined ID of an action that can be used with go-to action.

Dial to Many

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

Property	Type	Description
dialToMany [{ number numbers }]	arry of objects string string	Required. 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
options { parallel senderId maxCallDuration ringTimeout	obect boolean string integer integer	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.
actionId	integer	User-defined ID of an action that can be used with go-to action.

Dial to WebRTC

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

Property	Type	Description
dialToWebRTC	string	Required. Web and in-app calls applicationId. Read more about Web and in-app calls here

Dial to SIP trunk

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

Property	Type	Description
dialToSipTrunk	object	Required. Only one of these two properties (ipAddress, domainName) can be set.
options { from to headers ]	object string string object	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.
actionId	integer	User-defined ID of an action that can be used with go-to action.

Dial to Conversations

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

Property	Type	Description
dialToConversations { options { tags } }	object object array of strings	Required. 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.

For-Each

For-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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
for-each	string	Required. Variable name that will be used inside the loop to represent single value from supplied list of values.
in	string	Required. Delimited string representing list of values; the parameter can be constructed using variables.
delimiter	string	Delimiter used for separating values in supplied list of values; the parameter can be constructed using variables. Default is comma.
do	arry of objects	Required.

Go-To

Go-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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
goTo	integer	Required. The actionId of an action to which to jumpç
options { gotoLimit countVariable }	object integer string	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.

Hang-up

Hangup action marks the end of the IVR flow execution, leading to the call actually being hung up.

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

Property	Type	Description
Hang-up	string	Value: \"hangup\"

If-Then-Else

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

Property	Type	Description
If-Then-Else	string	Required. The expression to evaluate
then	array of objects	The actions to execute if condition is evaluated to true
else	arry of objects	The actions to execute if condition is evaluated to false
actionId	integer	User-defined ID of an action that can be used with go-to action.

Machine Detection

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

Property	Type	Description
Machine Detection	string	Required. 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.

Pause

Pause action pauses execution of the IVR scenario for the provided duration.

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

Property	Type	Description
pause	number	Required. the amount to wait in seconds, from 0 (exclusive) to 5 (inclusive)
actionId	integer	User-defined ID of an action that can be used with go-to action.

Play

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

Property	Type	Description
playFromUrl	string	Required. Audio file URL.
actionId	integer	User-defined ID of an action that can be used with go-to action.

playFromRecording

Play from Recording Action plays audio recorded from the current or some other call.

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

Property	Type	Description
playFromRecording	string	Required. 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)
actionId	integer	User-defined ID of an action that can be used with go-to action.

Record

Record 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
record	integer	Required. The duration to record for in seconds; null for unlimited.
options { escapeDigits beep maxSilence identifier }	object string boolean integer string	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.
actionId	integer	User-defined ID of an action that can be used with go-to action.

Rpeat-Until

This 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
repeat	array of objects	Required.
until	string	The expression to evaluate.

Repeat-While

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

Property	Type	Description
repeat	array of objects	Required.
while	string	The expression to evaluate.

Say

Say 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
say	string	Required. Message text. Cannot contain only punctuation.
options { language voice { name gender } speechRate }	object string object string string number	The 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.
actionId	integer	User-defined ID of an action that can be used with go-to action.

Send SMS

Send SMS action creates and sends a text message from the scenario.

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

Property	Type	Description
sendSms { text from to }	object string string string	Required. 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
actionId	integer	User-defined ID of an action that can be used with go-to action.

]

Set Variable

Set variable action makes it possible to set a variable defined inside the IVR scenario to a specified value.

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

Property	Type	Description
setVariable	string	Required. Name of a variable.
value	string	Value to which the variable should be set.

Switch-Case

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

Property	Type	Description
switch	string	Required. Name of the variable whose value to inspect.
case { _default }	object array of objects	Object 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.
actionId	integer	User-defined ID of an action that can be used with go-to action.

While-Do

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

Property	Type	Description
while	string	Required. The expression to evaluate.
do	arry of objects	Required.

]

Response

Default sucessful response

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

Parameter	Type	Description
createTime	object	Creation timestamp.
description	object	Scenario description.
id	string	Scenario key. It is used for launching IVR scenario.
name		Scenario name.
script	object	The list of scenario actions.
updateTime	string	Update timestamp

Error response

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

This method allows you to delete a Voice IVR Scenario.

Path parameters

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

Parameter	Type	Description
id	string	Required. Scenario identifier.

This method allows you to start an outbound IVR toward a multiple destinations.

Response format

If successful, the response header HTTP status code will be 200 OK and the IVR flow will be sent.

If you try to send the request without authorization, you will receive a 401 Unauthorized error.

Voice Response

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

Parameter	Type	Description
bulkId	String	The ID that uniquely identifies the request. Bulk ID will be received when a message is sent to more than one destination address.
messages	VoiceResponseDetails	Array of sent message objects, one object per message.

Voice Response Details

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

Parameter	Type	Description
to	String	The message destination address.
status	Status	Indicates whether the message has been sent successfully, not sent, delivered, not delivered, waiting for delivery, or other status.
messageId	String	The ID that uniquely identifies the sent message.

Status

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

Parameter	Type	Description
groupId	Int	Status group ID
groupName	String	Status group name
id	Int	Status ID
name	String	Status name
description	String	Human readable description of the status.

","urlObject":{"protocol":"https","path":["voice","ivr","1","messages"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"ac8feb9f-c38c-4c03-81c1-9595361dfd97","name":"Launch outbound IVR","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"bulkId\": \"BULK-ID-123-xyz\",\n \"messages\": [\n {\n \"scenarioId\": \"5484CAA003789D634478D4456B717B78\",\n \"from\": \"46701234561\",\n \"destinations\": [\n {\n \"to\": \"4670123456\"\n },\n {\n \"to\": \"4670123457\"\n }\n ],\n \"notifyUrl\": \"https://www.example.com/voice/advanced\",\n \"notifyContentType\": \"application/json\",\n \"callbackData\": \"DLR callback data\",\n \"validityPeriod\": 720,\n \"sendAt\": \"2023-05-25T08:50:25.320+0000\",\n \"retry\": {\n \"minPeriod\": 1,\n \"maxPeriod\": 5,\n \"maxCount\": 5\n },\n \"record\": false,\n \"deliveryTimeWindow\": {\n \"from\": {\n \"hour\": 6,\n \"minute\": 0\n },\n \"to\": {\n \"hour\": 15,\n \"minute\": 30\n },\n \"days\": [\n \"MONDAY\",\n \"TUESDAY\",\n \"WEDNESDAY\",\n \"THURSDAY\",\n \"FRIDAY\",\n \"SATURDAY\",\n \"SUNDAY\"\n ]\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/voice/ivr/1/messages"},"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":"455"},{"key":"Date","value":"Tue, 23 May 2023 15:41:58 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684856518474106663"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"bulkId\": \"BULK-ID-123-xyz\",\n \"messages\": [\n {\n \"to\": \"4670123456\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\",\n \"description\": \"Message accepted, pending for delivery.\"\n },\n \"messageId\": \"8d769b89-8012-4c27-8c5f-f6e5afa8cb4a\"\n },\n {\n \"to\": \"4670123457\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 26,\n \"name\": \"PENDING_ACCEPTED\",\n \"description\": \"Message accepted, pending for delivery.\"\n },\n \"messageId\": \"ded3cb37-50bc-47b1-afef-4416ff38776e\"\n }\n ]\n}"}],"_postman_id":"37d6ac22-43e1-41d1-97d4-32a0e5cb6c2f"},{"name":"Search Voice IVR Recorded Files","id":"63006082-b16e-4a36-9c5a-32d07b5683ef","protocolProfileBehavior":{"disableBodyPruning":true},"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","urlObject":{"protocol":"https","path":["voice","ivr","1","files"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[],"_postman_id":"63006082-b16e-4a36-9c5a-32d07b5683ef"},{"name":"Download Voice IVR Recorded File","id":"3986fd4a-85b7-4f00-ab05-57de06033b77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://go2.vhdmedia.se/voice/ivr/1/files/{{id}}","description":"

This 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

Path parameters

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

Parameter	Type	Description
id	string	Required. Scenario identifier.

","urlObject":{"protocol":"https","path":["voice","ivr","1","files","{{id}}"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[],"_postman_id":"3986fd4a-85b7-4f00-ab05-57de06033b77"}],"id":"cfd76c21-9be8-4841-8f4c-c79f9ee6dbab","description":"

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.

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

Our IVR solution is available in two flavours – inbound and outbound. IVR allows a great deal of flexibility and enables clients to create numerous scenarios:

Outbound IVR:

Multiple questions and answers required for creating:
- Code verification and a subsequent action depending on the results
- Surveys with the recording of end users' opinion
\n
Collecting DTMF/response codes from the end user and sending it to client’s API

Inbound IVR:

Surveys done via DTMF
Surveys recording customer opinions
Polls
Automation of processes like appointment bookings, appointment confirmations, and package tracking

Manage IVR Scenarios

POST Create a Voice IVR Scenario

This method allows you to create a Voice IVR Scenario.

GET Search Voice IVR Scenarios

This method allows you to search Voice IVR Scenarios by name. To get a list of all IVR Scenarios, make a request without any parameters.

GET Get a Voice IVR Scenario

This method allows you to get a Voice IVR Scenario.

PUT Update a Voice IVR Scenario

This method allows you to update a Voice IVR Scenario.

DEL Delete a Voice IVR Scenario

This method allows you to delete a Voice IVR Scenario.

POST Launch IVR Scenario

This method allows you to start an outbound IVR toward a multiple destinations.

Retrieve Recorded Files

GET Search Voice IVR Recorded Files

This method allows you to search Voice IVR Recorded Audio Files.

GET Download Voice IVR Recorded File

This 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":"cfd76c21-9be8-4841-8f4c-c79f9ee6dbab"}],"id":"9b207556-0f46-4cea-a264-b74a0273751e","_postman_id":"9b207556-0f46-4cea-a264-b74a0273751e","description":""},{"name":"EMAIL","item":[{"name":"SEND EMAIL","item":[{"name":"Fully featured email","event":[{"listen":"test","script":{"id":"b9a5d320-f87e-44ec-8d1f-93b253254395","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":"bdf08bd6-ac17-4a5b-abee-3cf3350b1ab7","protocolProfileBehavior":{"disableBodyPruning":true},"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":"

Send an email or multiple emails to a recipient or multiple recipients with CC/BCC enabled.

Request body schema

Parameter	Type	Description
from	string	Email address with optional sender name. Note: This field is required if templateId is not present
to	Array of stings <=1000 Required	Email 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.
cc	Array of strings <= 1000	CC recipient email address. Note: Maximum number of recipients per request is 1000 overall including to, cc and bcc field.
bcc	Array of strings <= 1000	BCC recipient email address. Note: Maximum number of recipients per request is 1000 overall including to, cc and bcc field.
subject	string [ 1 .. 1000 ]	Message subject. Note: This field is required if templateId is not present.
text	string	Body of the message.
html	string	HTML 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.
ampHtml	string	Amp 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/.
templateId	integer	Template 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.
attachment	Array of strings	File attachment.
inlineImage	Array of strings	Allows 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.
intermediateReport	boolean	The real-time Intermediate delivery report that will be sent on your callback server.
notifyUrl	string	The URL on your callback server on which the Delivery report will be sent.
notifyContentType	string	Preferred Delivery report content type. Can be application/json or application/xml.
callbackData	string [ 0 .. 4000 ]	Additional client data that will be sent on the notifyUrl.
track	boolean	Default: 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.
trackClicks	boolean	This parameter enables or disables track click feature.
trackOpens	boolean	This parameter enables or disables track open feature.
trackingUrl	string	The URL on your callback server on which the open and click notifications will be sent. See Tracking Notifications for details.
bulkId	string	The 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)
messageId	string	The ID that uniquely identifies the message sent to a recipient. (Optional Field)
replyTo	string	Email address to which recipients of the email can reply.
defaultPlaceholders	string	General 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.
preserveRecipients	boolean	Default: 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.
sendAt	string	To 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.
landingPagePlaceholders	string	Personalize opt out landing page by inserting placeholders. Insert placeholder or tag while designing landing page.
landingPageId	string	The 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.
templateLanguageVersion	string	Default: \"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.
applicationId	string	Required for application use in a send request for outbound traffic. Returned in notification events.
entityId	string	Required for entity use in a send request for outbound traffic. Returned in notification events.

Responses (200 Successful Request)

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

Parameter	Type	Description
bulkId	string	The ID that uniquely identifies a list of message responses.
messages Array [ to messageId status { groupId groupName id name description }	Array of objects string string object integer string integer string string	List 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.

Error object

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

Parameter	Type	Description
requestError { serviceException { messageId, text, validationErrors { property name* } } }	object object string string object Array of strings	Identifier of the error. Detailed error description. Validation errors.
groupName	string	Error group name.
id	int	Error ID.
name	string	Error name.
description	string	Human readable description of the error.
permanent	boolean	Indicates whether the error is permanent.

","urlObject":{"protocol":"https","path":["email","3","send"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"b94e3e30-4bbe-4fce-960c-815b9691b57a","name":"Simple 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"},{"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":"cc","value":"tom.smith@vhdmedia.se","type":"text"},{"key":"replyTo","value":"contact@vhdmedia.se","type":"text"},{"key":"subject","value":"Hello Word","type":"text"},{"key":"html","value":"

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":"369a21f8-fdd5-4c64-b5fb-9060402b33eb","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.

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":"ca32d490-65f1-4b09-80c1-e46c6869e99d","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":"bdf08bd6-ac17-4a5b-abee-3cf3350b1ab7"}],"id":"79d2e340-b662-4820-8a01-c5c4046fc2aa","_postman_id":"79d2e340-b662-4820-8a01-c5c4046fc2aa","description":""},{"name":"LOGS AND REPORTS","item":[{"name":"Receive sent Email report (webhook)","id":"94a2836c-d56a-4815-a3b8-dcd81ab5fcd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"results\": [\n{\n\"bulkId\": \"aszzmbhu62l7bxkhmyrj\",\n\"price\": {\n\"pricePerMessage\": 0,\n\"currency\": \"UNKNOWN\"\n},\n\"status\": {\n\"id\": 5,\n\"groupId\": 3,\n\"groupName\": \"DELIVERED\",\n\"name\": \"DELIVERED_TO_HANDSET\",\n\"description\": \"Message delivered to handset\"\n},\n\"error\": {\n\"id\": 0,\n\"name\": \"NO_ERROR\",\n\"description\": \"No Error\",\n\"groupId\": 0,\n\"groupName\": \"OK\",\n\"permanent\": false\n},\n\"messageId\": \"hgtesn8bcmc71pujp92d\",\n\"doneAt\": \"2020-09-08T05:27:59.256+0000\",\n\"smsCount\": 1,\n\"sentAt\": \"2020-09-08T05:27:57.628+0000\",\n\"browserLink\": \"http://tracking.domain.com/render/content?id=9A31C6F61DBAE9664D74C7A5A5A01F92283F581D11EA80A28C12E83BC83D449BC4A9F32F1AE3C3E\",\n\"callbackData\": \"something you want back\",\n\"to\": \"john.doe@gmail.com\"\n}\n]\n}","options":{"raw":{"language":"json"}}},"url":"https://{yourDomain}/your/webhook/path","description":"

Get real-time tracking reports for all opens/clicks to a specified endpoint.

Request body schema

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

Parameter	Type
results	array of objects

{\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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
bulkId	String	The ID that uniquely identifies a list of email messages. This is either defined by user in the request or auto generated.
price	object	Sent email price.
status	object	Indicates whether the email is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
error	object	Indicates whether the error occurred during the query execution.
messageId	string
doneAt	string	Delivery date and time.The ID that uniquely identifies the email sent to the recipient.
smsCount	integer	The number of emails sent.
sentAt	string	Send date and time. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
browserLink	string	Contains the link to the HTML sent to recipient. This will be present only if the view in browser feature is used in the email
callbackData	string	Callback data sent through callbackData field in fully featured email.
to	string	Destination email address.

Price object

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

Parameter	Type	Description
currency	string	The currency in which the price is expressed.
pricePerMessage	number	Price per message.

Status object

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

Parameter	Type	Description
groupId	int	Status group ID.
groupName	string	Status group name.
id	int	Status ID.
name	string	Status name.
description	string	Human readable description of the status.
action	string	Action that should be taken to eliminate the error

Error object

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

Parameter	Type	Description
groupId	int	Error group ID.
groupName	string	Error group name.
id	int	Error ID.
name	string	Error name.
description	string	Human readable description of the error.
permanent	boolean	Indicates whether the error is permanent.

","urlObject":{"protocol":"https","path":["your","webhook","path"],"host":["{yourDomain}"],"query":[],"variable":[]}},"response":[{"id":"86c2ec08-e7d7-4189-9c87-d00cf4960cc9","name":"Receive sent Email report","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"results\": [\n{\n\"bulkId\": \"aszzmbhu62l7bxkhmyrj\",\n\"price\": {\n\"pricePerMessage\": 0,\n\"currency\": \"UNKNOWN\"\n},\n\"status\": {\n\"id\": 5,\n\"groupId\": 3,\n\"groupName\": \"DELIVERED\",\n\"name\": \"DELIVERED_TO_HANDSET\",\n\"description\": \"Message delivered to handset\"\n},\n\"error\": {\n\"id\": 0,\n\"name\": \"NO_ERROR\",\n\"description\": \"No Error\",\n\"groupId\": 0,\n\"groupName\": \"OK\",\n\"permanent\": false\n},\n\"messageId\": \"hgtesn8bcmc71pujp92d\",\n\"doneAt\": \"2020-09-08T05:27:59.256+0000\",\n\"smsCount\": 1,\n\"sentAt\": \"2020-09-08T05:27:57.628+0000\",\n\"browserLink\": \"http://tracking.domain.com/render/content?id=9A31C6F61DBAE9664D74C7A5A5A01F92283F581D11EA80A28C12E83BC83D449BC4A9F32F1AE3C3E\",\n\"callbackData\": \"something you want back\",\n\"to\": \"john.doe@gmail.com\"\n}\n]\n}","options":{"raw":{"language":"json"}}},"url":"https://{yourDomain}/your/webhook/path"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"166"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 04 May 2023 13:28:15 GMT"},{"key":"x-zapier-hook-id","value":"0187e6f2-f5f6-caa9-173f-f113ca25d097"},{"key":"x-zapier-hook-attempt","value":"0187e6f2-f5f6-caa9-173f-f113ca25d097"},{"key":"x-zapier-hook-request-id","value":"0187e6f2-f5f6-caa9-173f-f113ca25d097"},{"key":"x-zapier-hook-status","value":"success"},{"key":"access-control-allow-origin","value":"*"},{"key":"X-Rate-Limit-Limit","value":"10000"},{"key":"X-Rate-Limit-Remaining","value":"9999"},{"key":"X-Rate-Limit-Reset","value":"1683207065"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b088f021bbfbe62b285291be4d6fc2ae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR61-P4"},{"key":"X-Amz-Cf-Id","value":"cjw6ei401u0tGpI617J06d_AZoVTNnBsLSbqJ9ZDDJRUyUGCBBMRBQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"attempt\": \"0187e6f2-f5f6-caa9-173f-f113ca25d097\",\n \"id\": \"0187e6f2-f5f6-caa9-173f-f113ca25d097\",\n \"request_id\": \"0187e6f2-f5f6-caa9-173f-f113ca25d097\",\n \"status\": \"success\"\n}"}],"_postman_id":"94a2836c-d56a-4815-a3b8-dcd81ab5fcd7"},{"name":"Email delivery reports","id":"16413d76-bc7d-4d42-884d-6d23a1a1ab7b","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":"

REQUEST RATE LIMIT:

1000 requests / second (per account)

Request body schema

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

Parameter	Type	Description
bulkId	String	Bulk ID for which report is requested.
messageId	String	The ID that uniquely identifies the sent email
limit	Integer	Maximum number of reports

Response format

On success, response header HTTP status code will be 200 OK and delivery reports will be returned in the response body.

If you try to send a message without authorization, you will get a response with HTTP status code 401 Unauthorized.

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

Parameter	Type	Description
results	SentEmailReport	Collection of reports, one per e-mail.

SentEmailReport

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

Parameter	Type	Description
messageId	String	Message ID.
to	String	Destination address.
sentAt	Date	Tells when the e-mail was sent. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
doneAt	Date	Tells when the e-mail was finished processing by us(ie. delivered to destination)
messageCount	Int	How many parts the message was split into. Always will be 1 for e-mail.
price	Price	Sent e-mail price.
status	Status	Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
error	Error	Indicates whether any error occurred during query execution.

Price

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

Parameter	Type	Description
pricePerMessage	BigDecimal	Price per one Email.
currency	String	The currency in which the price is expressed.

Status

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

Parameter	Type	Description
groupId	Int	Status group ID
groupName	String	Status group name.
id	Int	Status ID
name	String	Status name.
description	String	Human readable description of the status.
action	String	Action that should be taken to eliminate the error.

Error

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

Parameter	Type	Description
groupId	Int	Error group ID
groupName	String	Error group name
id	Int	Error ID
name	String	Error name
description	String	Human-readable description of the error.
permanent	Boolean	Tells if the error is permanent

","urlObject":{"protocol":"https","path":["email","1","reports"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"46ab215c-9a49-41b0-8801-ee93892e1e81","name":"Email delivery reports","originalRequest":{"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"},"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 20:21:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Server","value":"SMS API"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"X-Request-Id","value":"1679948474212853255"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"bulkId\": \"customBulkId1\",\n \"messageId\": \"n48fjq86ugsccm4pzjxr\",\n \"to\": \"tom.smith@vhdmedia.se\",\n \"sentAt\": \"2023-03-27T09:53:22.388+0000\",\n \"doneAt\": \"2023-03-27T09:53:22.782+0000\",\n \"messageCount\": 1,\n \"price\": {\n \"pricePerMessage\": 0.00043,\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 \"channel\": \"EMAIL\"\n }\n ]\n}"}],"_postman_id":"16413d76-bc7d-4d42-884d-6d23a1a1ab7b"},{"name":"Email messages logs","id":"59792e17-a5d7-4cc2-b953-16a1b725602d","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":"{\"limit\":1 }"},"url":"https://go2.vhdmedia.se/email/1/logs","description":"

REQUEST RATE LIMIT: 1000 requests/second (per account)

Request body schema

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

Parameter	Type	Description
bulkId	String	Bulk ID for which report is requested.
messageId	String	The ID that uniquely identifies the sent email
limit	Integer	Maximum number of reports
from	String	The recipient email address.
to	String	The recipient email address.
generalStatus	String	Bulk ID that uniquely identifies the request.
sentSince	String	Tells when the email was initiated. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
sentUntil	String	Tells when the email was initiated. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
limit	Integer	Maximum number of logs

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.

Response format

If successful, the response header HTTP status code will be 200 OK and the message logs will be returned.

If you try to send a message without authorization, you will get a response with HTTP status code 401 Unauthorized.

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

SMSLogsResponse

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

Parameter	Type	Description
results	SentEmailLog	Collection of logs.

SentEmailLog

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

Parameter	Type	Description
messageId	String	The ID that uniquely identifies the message sent.
to	String	The message destination address.
from	String	Sender e-mail address.
text	String	Text of the message that was sent.
sentAt	Date	Tells when the e-mail was sent. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
doneAt	Date	Tells when the e-mail was finished processing by us (i.e. delivered to destination)
messageCount	int	How many parts the message was split into. Always will be 1 for e-mail.
price	Price	Sent e-mail price.
status	Status	Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
error	Error	Indicates whether the error occurred during the query execution.

Price

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

Parameter	Type	Description
pricePerMessage	BigDecimal	Price per one e-mail.
currency	String	The currency in which the price is expressed.

Status

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

Parameter	Type	Description
groupId	int	Status group ID
groupName	String	Status group name.
id	int	Status ID
name	String	Status name.
description	String	Human readable description of the status.
action	String	Action that should be taken to eliminate the error.

Error

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

Parameter	Type	Description
groupId	int	Error group ID
groupName	String	Error group name
id	int	Error ID
name	String	Error name
description	String	Human readable description of the error.
permanent	boolean	Tells if the error is permanent

","urlObject":{"protocol":"https","path":["email","1","logs"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"d6825a32-456d-4ac3-9715-9f2d977cdcc5","name":"Email messages logs","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\"limit\":1 }"},"url":"https://go2.vhdmedia.se/email/1/logs"},"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, 23 Mar 2023 15:36:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Server","value":"SMS API"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"X-Request-Id","value":"1679585806478798787"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"messageId\": \"u7lvsf2hyur7hmg6igue\",\n \"to\": \"tom.smith@vhdmedia.se\",\n \"from\": \"example@vhdmedia.se\",\n \"text\": \"b63fe043d0717b2b4a97cfa92802c394c985919213120cef902b6c45c20edf1d\",\n \"sentAt\": \"2023-03-23T15:35:41.651+0000\",\n \"doneAt\": \"2023-03-23T15:35:42.504+0000\",\n \"messageCount\": 1,\n \"price\": {\n \"pricePerMessage\": 0.00043,\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 \"channel\": \"EMAIL\",\n \"bulkId\": \"customBulkId1\"\n },\n {\n \"messageId\": \"u7lvsf2hyur7hmg6igue\",\n \"to\": \"jane.smith@vhdmedia.se\",\n \"from\": \"example@vhdmedia.se\",\n \"text\": \"b63fe043d0717b2b4a97cfa92802c394c985919213120cef902b6c45c20edf1d\",\n \"sentAt\": \"2023-03-23T15:35:41.635+0000\",\n \"doneAt\": \"2023-03-23T15:35:42.082+0000\",\n \"messageCount\": 1,\n \"price\": {\n \"pricePerMessage\": 0.00043,\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 \"channel\": \"EMAIL\",\n \"bulkId\": \"customBulkId1\"\n }\n ]\n}"}],"_postman_id":"59792e17-a5d7-4cc2-b953-16a1b725602d"},{"name":"Receive user events (webhook)","id":"3921104d-9129-47d3-b25c-cddd096b62e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"notificationType\": \"UNSUBSCRIBED\",\n \"recipient\": \"john.doe@somedomain.com\",\n \"url\": \"http://www.somelink.com\",\n \"sendDateTime\": 1599619719349,\n \"messageId\": \"3h5dleyqk6cle5fc54md\",\n \"bulkId\": \"4f8prts39ems4g1o3m5s\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{yourDomain}/your/webhook/path","description":"

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

Request body schema

{\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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
notificationType	string	Tells the type of user event that took place. Possible events: OPENED, CLICKED, COMPLAINED, UNSUBSCRIBED.
domain	string	The sending domain used to send the email to the recipient.
recipient	string	Recipient of the email.
url	string	The link the recipient has clicked. This attribute will only be present only if the event is of the type CLICKED.
sendDateTime	number	The time at which the email was sent. Time is in milliseconds.
messageId	string	The ID uniquely identifies the message sent to the recipient.
bulkId	string	The ID uniquely identifies a list of email messages. This is either defined by the user in the request or auto-generated
recipientInfo	object	Recipient information such as device type, OS and device name.auto-generated
geoLocation	object	Geolocation data such as Country, City, Latitude and Longitude. This data will be available only for opens and clicks.

RecipientInfo object

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

Parameter	Type	Description
deviceType	string	The currency in which the price is expressed.
os	string	Device name of the action originating device.
deviceName	string	Device name of the action originating device.

GeoLocation object

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

Parameter	Type	Description
country_name	string	Country where the user action is recorded.
city	string	The city where the user action is recorded.
latitude	string	Latitude of the action-originating device.
longitude	string	Longitude of the action-originating device.

","urlObject":{"protocol":"https","path":["your","webhook","path"],"host":["{yourDomain}"],"query":[],"variable":[]}},"response":[{"id":"8134571e-e50a-471e-b570-19801ee37e4e","name":"Open reports","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"notificationType\": \"OPENED\",\n \"domain\": \"mydomain.com\",\n \"recipient\": \"john.doe@somedomain.com\",\n \"sendDateTime\": 1599542877689,\n \"messageId\": \"14b734recsf69n8zkao5\",\n \"bulkId\": \"ikzzmbhu6223bxkhmyrj\",\n \"recipientInfo\": {\n \"deviceType\": \"Phone\",\n \"os\": \"iOS 12\",\n \"deviceName\": \"Apple\"\n },\n \"geoLocation\": {\n \"city\": \"Los Angeles\",\n \"longitude\": \"-118.24550\",\n \"latitude\": \"34.05361\",\n \"country_name\": \"United States\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{yourDomain}/your/webhook/path"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"166"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 04 May 2023 13:35:31 GMT"},{"key":"x-zapier-hook-status","value":"success"},{"key":"access-control-allow-origin","value":"*"},{"key":"X-Rate-Limit-Limit","value":"10000"},{"key":"X-Rate-Limit-Remaining","value":"9999"},{"key":"X-Rate-Limit-Reset","value":"1683207365"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 ebeaa224cccd8c2d73fa986469993296.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR61-P4"},{"key":"X-Amz-Cf-Id","value":"s5f6P2qq_0yDgiuES3s8E8byw6f0QMwpEHCIn96-Wi6Y-Ae6zseoXw=="}],"cookie":[],"responseTime":null,"body":"{\n \"attempt\": \"0187e6f9-9cf8-4c05-c47e-19c6e6d452a3\",\n \"id\": \"0187e6f9-9cf8-4c05-c47e-19c6e6d452a3\",\n \"request_id\": \"0187e6f9-9cf8-4c05-c47e-19c6e6d452a3\",\n \"status\": \"success\"\n}"},{"id":"bc0a3706-3bcf-4bfc-a29c-8ed53bf0ffc1","name":"Click reports","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\n{\n\"notificationType\": \"CLICKED\",\n\"domain\": \"sd1.emailtesthub.com\",\n\"recipient\": \"john.doe@somedomain.com\",\n\"url\": \"http://www.somelink.com\",\n\"sendDateTime\": 1599619719349,\n\"messageId\": \"3h5dleyqk6cle5fc54md\",\n\"bulkId\": \"4f8prts39ems4g1o3m5s\",\n\"recipientInfo\": {\n\"deviceType\": \"Desktop\",\n\"os\": \"Windows 10\",\n\"deviceName\": \"PC\"\n},\n\"geoLocation\": {\n\"city\": \"Los Angeles\",\n\"longitude\": \"-118.24550\",\n\"latitude\": \"34.05361\",\n\"country_name\": \"United States\"\n}\n}","options":{"raw":{"language":"json"}}},"url":"https://{yourDomain}/your/webhook/path"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-zapier-hook-status","value":"success"},{"key":"access-control-allow-origin","value":"*"},{"key":"X-Rate-Limit-Limit","value":"10000"},{"key":"X-Rate-Limit-Remaining","value":"9999"},{"key":"X-Rate-Limit-Reset","value":"1683207665"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 ebeaa224cccd8c2d73fa986469993296.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR61-P4"},{"key":"X-Amz-Cf-Id","value":"qkCpXwGqT_tBqeTyQgKsguwrcbPe_Pa2WeXLvHjA4Aa5n5jTdZONGQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"attempt\": \"0187e6fb-580d-370e-2ebe-e2fec17c361e\",\n \"id\": \"0187e6fb-580d-370e-2ebe-e2fec17c361e\",\n \"request_id\": \"0187e6fb-580d-370e-2ebe-e2fec17c361e\",\n \"status\": \"success\"\n}"},{"id":"e9da455f-c557-4a39-9cd2-ab2d8612f6f1","name":"Complained reports","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"notificationType\": \"COMPLAINED\",\n \"domain\": \"sd1.emailtesthub.com\",\n \"recipient\": \"john.doe@somedomain.com\",\n \"sendDateTime\": 1599619719349,\n \"messageId\": \"3h5dleyqk6cle5fc54md\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{yourDomain}/your/webhook/path"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"166"},{"key":"Connection","value":"keep-alive"},{"key":"x-zapier-hook-status","value":"success"},{"key":"access-control-allow-origin","value":"*"},{"key":"X-Rate-Limit-Limit","value":"10000"},{"key":"X-Rate-Limit-Remaining","value":"9998"},{"key":"X-Rate-Limit-Reset","value":"1683207665"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 ebeaa224cccd8c2d73fa986469993296.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR61-P4"},{"key":"X-Amz-Cf-Id","value":"OT9QgxnLtbGcyc9uQoQIWT5dhExY4RcjknjJg_xut023FeG3lZ8gaQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"attempt\": \"0187e6fb-f736-a4f9-781d-7d6bbd592dc3\",\n \"id\": \"0187e6fb-f736-a4f9-781d-7d6bbd592dc3\",\n \"request_id\": \"0187e6fb-f736-a4f9-781d-7d6bbd592dc3\",\n \"status\": \"success\"\n}"},{"id":"ae543066-3f09-410b-8717-9a27482ad000","name":"Unsubscribe reports","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"notificationType\": \"UNSUBSCRIBED\",\n \"recipient\": \"john.doe@somedomain.com\",\n \"url\": \"http://www.somelink.com\",\n \"sendDateTime\": 1599619719349,\n \"messageId\": \"3h5dleyqk6cle5fc54md\",\n \"bulkId\": \"4f8prts39ems4g1o3m5s\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{yourDomain}/your/webhook/path"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"166"},{"key":"Connection","value":"keep-alive"},{"key":"x-zapier-hook-status","value":"success"},{"key":"access-control-allow-origin","value":"*"},{"key":"X-Rate-Limit-Limit","value":"10000"},{"key":"X-Rate-Limit-Remaining","value":"9997"},{"key":"X-Rate-Limit-Reset","value":"1683207665"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 ebeaa224cccd8c2d73fa986469993296.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR61-P4"},{"key":"X-Amz-Cf-Id","value":"qTAM-Wd8VzEsGZDQb7XwQuYWAWVpKCwG6sJlt6m2T-U4raE9PLQgOA=="}],"cookie":[],"responseTime":null,"body":"{\n \"attempt\": \"0187e6fc-e8fd-ea9b-02f2-e891a970814c\",\n \"id\": \"0187e6fc-e8fd-ea9b-02f2-e891a970814c\",\n \"request_id\": \"0187e6fc-e8fd-ea9b-02f2-e891a970814c\",\n \"status\": \"success\"\n}"}],"_postman_id":"3921104d-9129-47d3-b25c-cddd096b62e3"}],"id":"5d089320-60d1-4bf2-8411-ab3ca9ce8b69","_postman_id":"5d089320-60d1-4bf2-8411-ab3ca9ce8b69","description":""},{"name":"MANAGE SCHEDULED EMAIL","item":[{"name":"Get sent email bulks","id":"dc6373ff-0c40-464f-a841-da2d690673bc","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={{bulkId}}","description":"

REQUEST RATE LIMIT:

1000 requests / second (per account)

Query parameters

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

Parameter	Type	Description
bulkId	String	Bulk ID for which report is requested.

","urlObject":{"protocol":"https","path":["email","1","bulks"],"host":["go2","vhdmedia","se"],"query":[{"key":"bulkId","value":"{{bulkId}}"}],"variable":[]}},"response":[{"id":"fce24ea1-79ab-4984-9f8c-7f08b24a4cfa","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":"dc6373ff-0c40-464f-a841-da2d690673bc"},{"name":"Reschedule Email messages","id":"8f89642d-729c-47a6-9bfd-b42277022cbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"sendAt\":\"2023-05-04T17:00:00.085-00:00\"}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/email/1/bulks?bulkId={{bulkId}}","description":"

REQUEST RATE LIMIT:

1000 requests / second (per account)

Query parameters

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

Parameter	Type	Description
bulkId	String	Bulk ID for which report is requested.

Request body schema

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

Parameter	Type	Description
sendAt	String	Required

","urlObject":{"protocol":"https","path":["email","1","bulks"],"host":["go2","vhdmedia","se"],"query":[{"key":"bulkId","value":"{{bulkId}}"}],"variable":[]}},"response":[{"id":"3b25114c-8c1e-45cc-9288-b6ecaa4e6770","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":"8f89642d-729c-47a6-9bfd-b42277022cbc"},{"name":"Get sent email bulks status","id":"dc61db78-8752-41c2-b2f3-d022daf919cb","protocolProfileBehavior":{"disableBodyPruning":true},"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={{bulkId}}","description":"

REQUEST RATE LIMIT:

1000 requests / second (per account)

Query parameters

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

Parameter	Type	Description
bulkId	String	Bulk ID for which report is requested.

","urlObject":{"protocol":"https","path":["email","1","bulks","status"],"host":["go2","vhdmedia","se"],"query":[{"key":"bulkId","value":"{{bulkId}}"}],"variable":[]}},"response":[{"id":"c4f5b262-597c-4475-b3b1-ef496ec823d6","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":"dc61db78-8752-41c2-b2f3-d022daf919cb"},{"name":"Update scheduled Email messages status","id":"764bc712-826e-4484-a914-1bb9286500b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"status\":\"CANCELED\"}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/email/1/bulks/status?bulkId={{bulkId}}","description":"

REQUEST RATE LIMIT:

1000 requests / second (per account)

Query parameters

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

Parameter	Type	Description
bulkId	String	Bulk ID for which report is requested.

Request body schema

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

Parameter	Type	Description
status	String	Required Enum: \"PENDING\" \"PAUSED\" \"PROCESSING\" \"CANCELED\" \"FINISHED\" \"FAILED\"

","urlObject":{"protocol":"https","path":["email","1","bulks","status"],"host":["go2","vhdmedia","se"],"query":[{"key":"bulkId","value":"{{bulkId}}"}],"variable":[]}},"response":[{"id":"317fecbf-2713-4a02-931e-14184f88d7c4","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":"764bc712-826e-4484-a914-1bb9286500b0"}],"id":"d9e06d92-69c6-44ee-99c4-495fc50a3f19","_postman_id":"d9e06d92-69c6-44ee-99c4-495fc50a3f19","description":""}],"id":"5d546e04-61c2-4a1d-afdf-99c9db2728c1","description":"

Introduction

This documentation will help you get started using email API

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

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

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

Choose your domain carefully

The most important step in this initial stage is choosing the way you would like to route your emails.

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

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

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

Register your domain with us

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

Once the configuration is properly applied, you can follow the steps outlined in the following pages to successfully send emails.

If you have any questions regarding the service integration, please contact us.

Email Template Creation Guide

To facilitate the process of sending emails using templates, follow the steps below to create an email template on the VHD web platform:

Login: Access the VHD web platform by logging in to your account.
Navigate to Templates: Once logged in, go to the \"Moments/Templates/Broadcast Templates\" section.
Initiate Template Creation: Select the option create new template.
Choose Email Channel: Specify the communication channel as \"Email\" for the template you are creating.
Select Sender: Choose the appropriate sender account.
Template Design: Create the content of your template or choose an existing template.
Save Template: After finalizing the template, save your work to ensure all changes are retained.
Note the templateId, templateId's are the numbers followed by #.
Now use Fully featured email API
Add the templateId to send email templates.

\n","_postman_id":"5d546e04-61c2-4a1d-afdf-99c9db2728c1"},{"name":"PEOPLE","item":[{"name":"PERSON PROFILE","item":[{"name":"Get a single person or a list of people","id":"41ae2f56-19c9-41b2-a32d-91da85847852","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://go2.vhdmedia.se/people/2/persons","description":"

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.

Request rate limit

5 requests / second (per account)

Query parameters

Parameter	Type	Description
phone	string	Example: phone=46701234567 Person’s phone number. Phone numbers must be in international format.
email	string	Example: 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.
externalId	string	Example: externalId=6F9619FF-8B86-D011-B42D-00CF4FC964FF Unique ID for a person from your or another external system.
pushRegistrationId	string	Example: pushRegistrationId=6F9619FF-8B86-D011-B42D-00CF4FC964FF Person's push registration ID.
id	ineger	Example: id=11351351 Person's internal ID.
lineId	string	Example: lineId=U045147f1ad961bfe996b72bbf417f3c9 Person’s Line ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameters.
lineSenderId	string	Example: lineSenderId=1644264921 Person’s Line sender ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameter
facebookId	string	Example: facebookId=370329180020364 Person’s Facebook ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters.
facebookSenderId	integer	Example: facebookSenderId=2094832040560427 Person’s Facebook sender ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters.
telegramUserId	string	Example: telegramUserId=1303201999 Person’s Telegram user ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters.
telegramBotId	string	Example: telegramBotId=1495032701 Person’s Telegram bot ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters.
viberBotUserId	string	Example: 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.
viberBotId	integer	Example: viberBotId=5591458813882487336 Person’s Viber Bot ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters.
instagramId	string	Example: instagramId=17841546155331428 Person’s Instagram user ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters.
instagramSenderId	integer	Example: instagramSenderId=17841405793187218 Person’s Instagram sender ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters.
twitterId	string	example: twitterId=370329180020364 Person’s Twitter user ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters.
twitterSenderId	integer	Example: twitterSenderId=10765432100123456789 Person’s Twitter sender ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters.
appleBusinessChatId	string	Example: 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.
appleBusinessChatSenderId	string	Example: 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.
liveChatRegId	string	Example: liveChatRegId=79f9701b-e350-4497-9689-b2257864e63f
limit	integer	Example: limit=20 Maximum number of rows returned per page.
page	integer	Example: 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.
includeTotalCount	boolean	Example: includeTotalCount=false Returns total count of persons, if set to true.
orderBy	string	Example: 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
filter	string	Example: filter={\"#and\":[{\"firstName\":\"Alex\"},{\"#contains\": { \"tags\":\"VIP Client\"}}]}} Allows to filter persons using simple queries. Just pass to the parameter URL encoded query

List of supported logical operators:

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

Logical Operator	Description
`#and`	Joins query clauses with a logical AND returns all records that match the conditions of both clauses.
`#or`	Joins query clauses with a logical OR returns all records that match the conditions of either clause.

List of supported comparison operators:

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

Comparison Operator	Supported Type	Description
`#eq`	string, integer, decimal, date	Matches values that are equal to a specified value.
`#ne`	string, integer, decimal, date	Matches all values that are not equal to a specified value.
`#contains`	string	Matches the records that contain a specified value.
`#startsWith`	string	Matches the records that start with a specified value.
`#endsWith`	string	Matches the records that end with a specified value.
`#gt`	integer, decimal, date	Matches values that are greater than a specified value.
`#lt`	integer, decimal, date	Matches values that are less than a specified value.
`#gte`	integer, decimal, date	Matches values that are greater than or equal to a specified value.
`#lte`	integer, decimal, date	Matches values that are less than or equal to a specified value.

Paging and ordering

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

Parameter	Type	Description
`limit`	int	If 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.
`page`	int	This 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.
`orderBy`	string	This parameter is used to order your results. If an order is not given, the default order `modifiedAt:desc` will be applied.

Responses

Default sucessful response

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

Parameter	Type	Description
address	string	Person's address, 256 characters max
birthDate	string	Person's date of birth, format YYYY-MM-DD
city	string	Person's city, 50 characters max
computedAttributes { property name* { } }	object object	Person's computed attributes grouped by type
contactInformation { 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 } }] }	object 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	Required 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
country	string	Person's country, 50 characters max
customAttributes { property name* { } }	object object	List of custom attributes for the person, 4096 characters max per value
externalId	string	Unique ID for a person from your or another external system, 256 characters max
firstName	string	Person's first name, 255 characters max
gender	string	Enum: \"MALE\" \"FEMALE\" Person's gender
integrations { salesforce { contactId leadId } }	object object string string	Integrations Salesforce integration Salesforce contact id Salesforce lead id
lastName	string	Person's last name, 255 characters max
middleName	string	Person's middle name, 50 characters max
profilePicture	string	URL for the person's profile picture, 2083 characters max
tags	array of strings	List of tags that this person has
type	string	Enum: \"CUSTOMER\" \"LEAD\" Person's type, default type is CUSTOMER

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","persons"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"9942cff7-eff0-43a9-96bb-9f9617397029","name":"Get a list of people","originalRequest":{"method":"GET","header":[],"url":"https://go2.vhdmedia.se/people/2/persons"},"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":"7476"},{"key":"Date","value":"Mon, 08 May 2023 12:43:51 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1683549832709629227"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 20,\n \"page\": 1,\n \"orderBy\": \"modifiedAt:desc, id:asc\",\n \"persons\": [\n {\n \"createdAt\": \"2023-02-02T13:24:37\",\n \"modifiedAt\": \"2023-02-02T13:25:47\",\n \"id\": 1118,\n \"firstName\": \"Jane\",\n \"type\": \"CUSTOMER\",\n \"origin\": \"PORTAL\",\n \"modifiedFrom\": \"PORTAL\",\n \"contactInformation\": {\n \"phone\": [\n {\n \"number\": \"4670123456\"\n }\n ]\n }\n },\n {\n \"createdAt\": \"2018-02-15T18:24:29\",\n \"modifiedAt\": \"2023-01-21T13:40:27\",\n \"id\": 9,\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"type\": \"CUSTOMER\",\n \"address\": \"2021-12-01 2022-04-30\",\n \"origin\": \"PORTAL\",\n \"modifiedFrom\": \"PORTAL\",\n \"tags\": [\n \"Test23\"\n ],\n \"customAttributes\": {\n \"personal_code\": \"keyvqblf6bw\"\n },\n \"contactInformation\": {\n \"phone\": [\n {\n \"number\": \"4670123456\"\n }\n ],\n \"email\": [\n {\n \"address\": \"jane.smith@vhdmedia.se\"\n }\n ],\n \"push\": [\n {\n \"applicationId\": \"9565CC313BC4E294950FC8A624\",\n \"registrationId\": \"56C5233A-05E2-4E69BE71357B\",\n \"systemData\": {\n \"os\": \"Android\",\n \"osLanguage\": \"sv\",\n \"geofencingSdk\": true,\n \"deviceTimezoneOffset\": \"GMT+01:00\",\n \"appVersion\": \"3.1.0\",\n \"deviceSecure\": true,\n \"deviceModel\": \"SM-F721B\",\n \"sdkVersion\": \"7.1.0\",\n \"deviceManufacturer\": \"samsung\",\n \"deviceName\": \"Jans Z Flip4\",\n \"registrationEnabled\": true,\n \"osVersion\": \"13\",\n \"cloudType\": \"GCM\",\n \"notificationsEnabled\": true\n },\n \"isPrimary\": false\n }\n ]\n }\n },\n \n \n {\n \"createdAt\": \"2018-02-15T18:24:29\",\n \"modifiedAt\": \"2021-11-17T08:34:14\",\n \"id\": 7,\n \"firstName\": \"Jim\",\n \"lastName\": \"Dole\",\n \"type\": \"CUSTOMER\",\n \"address\": \"2021-12-01 2022-04-30\",\n \"city\": \"75550 Uppsala\",\n \"country\": \"Sweden\",\n \"origin\": \"PORTAL\",\n \"modifiedFrom\": \"PORTAL\",\n \"tags\": [\n \"Office\",\n \"Upload_2018-03-13_16:06:29\",\n \"Upload_2018-03-14_11:24:47\"\n ],\n \"customAttributes\": {\n \"Code\": 46,\n \"personal_code\": \"70123456\",\n \"Countrycode\": \"46\"\n },\n \"contactInformation\": {\n \"phone\": [\n {\n \"number\": \"4670123456\"\n }\n ],\n \"email\": [\n {\n \"address\": \"jim@vhdmedia.se\"\n }\n ]\n }\n }\n \n \n \n \n ]\n}"},{"id":"0ba43597-7df7-4936-95ec-4ad502d3cb8f","name":"Get a single person","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://go2.vhdmedia.se/people/2/persons?email=janewilliams@vhdmeida.com","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","2","persons"],"query":[{"key":"email","value":"janewilliams@vhdmeida.com"}]}},"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":"637"},{"key":"date","value":"Wed, 10 May 2023 09:23:52 GMT"},{"key":"server","value":"SMS API"},{"key":"x-request-id","value":"1683710633252971162"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2023-05-08T15:00:54\",\n \"modifiedAt\": \"2023-05-10T09:16:44\",\n \"id\": 4,\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"type\": \"CUSTOMER\",\n \"origin\": \"API\",\n \"modifiedFrom\": \"API\",\n \"customAttributes\": {\n \"Company\": \"VHD\",\n \"ShoppingCartList\": [\n {\n \"__id\": \"d980c585-e7e8-4e6b-868e-b82d6b4f2bdf\",\n \"productName\": \"Sneakers\",\n \"productImage\": \"/image1.png\",\n \"productPrice\": 25.33,\n \"productCategory\": \"Sport Sneakers\"\n },\n {\n \"__id\": \"07f89266-9a6f-4998-b22c-778e01c94814\",\n \"productName\": \"T-Shirt\",\n \"productImage\": \"/image2.png\",\n \"productPrice\": 9.99,\n \"productCategory\": \"Casual\"\n }\n ],\n \"Contract Expiry\": \"2023-06-01\"\n },\n \"contactInformation\": {\n \"email\": [\n {\n \"address\": \"janewilliams@vhdmeida.com\"\n }\n ]\n }\n}"}],"_postman_id":"41ae2f56-19c9-41b2-a32d-91da85847852"},{"name":"Update a person","id":"d9840ed6-d52a-43b1-98cc-27d801fa2c5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/persons","description":"

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.

Request rate limit

5 requests / second (per account)

Query parameters

Parameter	Type	Description
phone	string	Example: phone=46701234567 Person’s phone number. Phone numbers must be in international format.
email	string	Example: 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.
externalId	string	Example: externalId=6F9619FF-8B86-D011-B42D-00CF4FC964FF Unique ID for a person from your or another external system.
pushRegistrationId	string	Example: pushRegistrationId=6F9619FF-8B86-D011-B42D-00CF4FC964FF Person's push registration ID.
id	integer	Example: id=11351351 Person's internal ID.
lineId	string	Example: lineId=U045147f1ad961bfe996b72bbf417f3c9 Person’s Line ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameters.
lineSenderId	string	Example: lineSenderId=1644264921 Person’s Line sender ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameter
facebookId	string	Example: facebookId=370329180020364 Person’s Facebook ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters.
facebookSenderId	integer	Example: facebookSenderId=2094832040560427 Person’s Facebook sender ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters.
telegramUserId	string	Example: telegramUserId=1303201999 Person’s Telegram user ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters.
telegramBotId	string	Example: telegramBotId=1495032701 Person’s Telegram bot ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters.
viberBotUserId	string	Example: 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.
viberBotId	integer	Example: viberBotId=5591458813882487336 Person’s Viber Bot ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters.
instagramId	string	Example: instagramId=17841546155331428 Person’s Instagram user ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters.
instagramSenderId	integer	Example: instagramSenderId=17841405793187218 Person’s Instagram sender ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters.
twitterId	string	example: twitterId=370329180020364 Person’s Twitter user ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters.
twitterSenderId	integer	Example: twitterSenderId=10765432100123456789 Person’s Twitter sender ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters.
appleBusinessChatId	string	Example: 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.
appleBusinessChatSenderId	string	Example: 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.
liveChatRegId	string	Example: liveChatRegId=79f9701b-e350-4497-9689-b2257864e63f

Request body schema

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

Parameter	Type	Description
address	string	Person's address, 256 characters max
birthDate	string	Person's date of birth, format YYYY-MM-DD
city	string	Person's city, 50 characters max
computedAttributes { property name* { } }	object object	Person's computed attributes grouped by type
contactInformation { 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 } }] }	object 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	Required 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
country	string	Person's country, 50 characters max
customAttributes { property name* { } }	object object	List of custom attributes for the person, 4096 characters max per value
externalId	string	Unique ID for a person from your or another external system, 256 characters max
firstName	string	Person's first name, 255 characters max
gender	string	Enum: \"MALE\" \"FEMALE\" Person's gender
integrations { salesforce { contactId leadId } }	object object string string	Integrations Salesforce integration Salesforce contact id Salesforce lead id
lastName	string	Person's last name, 255 characters max
middleName	string	Person's middle name, 50 characters max
profilePicture	string	URL for the person's profile picture, 2083 characters max
tags	array of strings	List of tags that this person has
type	string	Enum: \"CUSTOMER\" \"LEAD\" Person's type, default type is CUSTOMER

Responses

Default sucessful response

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

Parameter	Type	Description
address	string	Person's address, 256 characters max
birthDate	string	Person's date of birth, format YYYY-MM-DD
city	string	Person's city, 50 characters max
computedAttributes { property name* { } }	object object	Person's computed attributes grouped by type
contactInformation { 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 } }] }	object 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	Required 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
country	string	Person's country, 50 characters max
customAttributes { property name* { } }	object object	List of custom attributes for the person, 4096 characters max per value
externalId	string	Unique ID for a person from your or another external system, 256 characters max
firstName	string	Person's first name, 255 characters max
gender	string	Enum: \"MALE\" \"FEMALE\" Person's gender
integrations { salesforce { contactId leadId } }	object object string string	Integrations Salesforce integration Salesforce contact id Salesforce lead id
lastName	string	Person's last name, 255 characters max
middleName	string	Person's middle name, 50 characters max
profilePicture	string	URL for the person's profile picture, 2083 characters max
tags	array of strings	List of tags that this person has
type	string	Enum: \"CUSTOMER\" \"LEAD\" Person's type, default type is CUSTOMER

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","persons"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"3515182e-6aaf-41a6-a3e0-0df63e2605e9","name":"Update a person","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2023-06-01\",\n \"Company\": \"VHD\",\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 \"email\": [\n {\n \"address\": \"janewilliams@vhdmeida.com\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/2/persons?email=janewilliams@vhdmeida.com","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","2","persons"],"query":[{"key":"email","value":"janewilliams@vhdmeida.com"}]}},"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":"637"},{"key":"date","value":"Wed, 10 May 2023 09:16:43 GMT"},{"key":"server","value":"SMS API"},{"key":"x-request-id","value":"1683710204041349836"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2023-05-08T15:00:54\",\n \"modifiedAt\": \"2023-05-10T09:16:44\",\n \"id\": 4,\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"type\": \"CUSTOMER\",\n \"origin\": \"API\",\n \"modifiedFrom\": \"API\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2023-06-01\",\n \"Company\": \"VHD\",\n \"ShoppingCartList\": [\n {\n \"__id\": \"d980c585-e7e8-4e6b-868e-b82d6b4f2bdf\",\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\",\n \"productName\": \"Sneakers\",\n \"productPrice\": 25.33\n },\n {\n \"__id\": \"07f89266-9a6f-4998-b22c-778e01c94814\",\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\",\n \"productName\": \"T-Shirt\",\n \"productPrice\": 9.99\n }\n ]\n },\n \"contactInformation\": {\n \"email\": [\n {\n \"address\": \"janewilliams@vhdmeida.com\"\n }\n ]\n }\n}"}],"_postman_id":"d9840ed6-d52a-43b1-98cc-27d801fa2c5e"},{"name":"Create a new person","event":[{"listen":"test","script":{"id":"39a64071-a654-4e27-85a6-17b6a5f065d6","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 () {"," pm.expect(responseBody.firstName).to.equal(\"Jane\");"," pm.expect(responseBody.lastName).to.equal(\"Smith\");"," });",""," pm.test(\"Response contains 'contactInformation'\", function () {"," pm.expect(responseBody).to.have.property('contactInformation').that.is.an('object');"," });",""," pm.test(\"Response contains valid phone and email\", function () {"," pm.expect(responseBody.contactInformation).to.have.property('phone').that.is.an('array').with.lengthOf(1);"," pm.expect(responseBody.contactInformation).to.have.property('email').that.is.an('array').with.lengthOf(1);"," });",""," 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":{}}},{"listen":"prerequest","script":{"packages":{},"type":"text/javascript"}}],"id":"b5ea26a0-c402-4024-b2b6-ee8290ec62e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"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.

Request rate limit

10 requests / second (per account)

Request body schema

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

Parameter	Type	Description
address	string	Person's address, 256 characters max
birthDate	string	Person's date of birth, format YYYY-MM-DD
city	string	Person's city, 50 characters max
computedAttributes { property name* { } }	object object	Person's computed attributes grouped by type
contactInformation { 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 } }] }	object 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	Required 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
country	string	Person's country, 50 characters max
customAttributes { property name* { } }	object object	List of custom attributes for the person, 4096 characters max per value
externalId	string	Unique ID for a person from your or another external system, 256 characters max
firstName	string	Person's first name, 255 characters max
gender	string	Enum: \"MALE\" \"FEMALE\" Person's gender
integrations { salesforce { contactId leadId } }	object object string string	Integrations Salesforce integration Salesforce contact id Salesforce lead id
lastName	string	Person's last name, 255 characters max
middleName	string	Person's middle name, 50 characters max
profilePicture	string	URL for the person's profile picture, 2083 characters max
tags	array of strings	List of tags that this person has
type	string	Enum: \"CUSTOMER\" \"LEAD\" Person's type, default type is CUSTOMER

Response

Default sucessful response

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

Parameter	Type	Description
address	string	Person's address, 256 characters max
birthDate	string	Person's date of birth, format YYYY-MM-DD
city	string	Person's city, 50 characters max
computedAttributes { property name* { } }	object object	Person's computed attributes grouped by type
contactInformation { 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 } }] }	object 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	Required 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
country	string	Person's country, 50 characters max
customAttributes { property name* { } }	object object	List of custom attributes for the person, 4096 characters max per value
externalId	string	Unique ID for a person from your or another external system, 256 characters max
firstName	string	Person's first name, 255 characters max
gender	string	Enum: \"MALE\" \"FEMALE\" Person's gender
integrations { salesforce { contactId leadId } }	object object string string	Integrations Salesforce integration Salesforce contact id Salesforce lead id
lastName	string	Person's last name, 255 characters max
middleName	string	Person's middle name, 50 characters max
profilePicture	string	URL for the person's profile picture, 2083 characters max
tags	array of strings	List of tags that this person has
type	string	Enum: \"CUSTOMER\" \"LEAD\" Person's type, default type is CUSTOMER

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","persons"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"b5cd9d91-f3e0-432d-96c8-04ee8e010b69","name":"Create a new person simple","originalRequest":{"method":"POST","header":[],"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"},"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":"278"},{"key":"Date","value":"Wed, 17 May 2023 13:47:52 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684331272845080836"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2023-05-17T13:47:52\",\n \"modifiedAt\": \"2023-05-17T13:47:52\",\n \"id\": 45,\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"type\": \"CUSTOMER\",\n \"origin\": \"API\",\n \"modifiedFrom\": \"API\",\n \"contactInformation\": {\n \"phone\": [\n {\n \"number\": \"4670123456\"\n }\n ],\n \"email\": [\n {\n \"address\": \"janewilliams@example.com\"\n }\n ]\n }\n}"},{"id":"95aef4d0-c93a-4513-a9db-946926d9ce18","name":"Create a new person full list","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"firstName\": \"John\",\n\"lastName\": \"Doe\",\n\"address\": \"67 Farringdon Road\",\n\"city\": \"Uppsala\",\n\"country\": \"Sweden\",\n\"gender\": \"MALE\",\n\"birthDate\": \"1966-01-15\",\n\"middleName\": \"Janie\",\n\"profilePicture\": \"http://profile.com\",\n\"origin\": \"API\",\n\"modifiedFrom\": \"API\",\n\"tags\": [\n\"VIP Customers\",\n\"New Customers\"\n],\n\"customAttributes\": {\n\"Contract Expiry\": \"2023-06-30\",\n\"Company\": \"Example\",\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\"phone\": [\n{\n\"number\": \"4670123456\"\n}\n],\n\"email\": [\n{\n\"address\": \"johndoe@wxample.com\"\n}\n],\n\"push\": [\n{\n\"applicationId\": \"FDCC8516470A3AE97FB8AC218D5D0D3D\",\n\"registrationId\": \"c5db0c47-465c-4e1c-abf8-7cedc275dd19\",\n\"additionalData\": {\n\"birthdate\": \"1988-07-31\",\n\"email\": \"test@test.com\",\n\"firstName\": \"John\",\n\"gender\": \"M\",\n\"lastName\": \"Doe\",\n\"middleName\": \"Janie\"\n},\n\"systemData\": {\n\"cloudType\": \"GCM\",\n\"registrationEnabled\": true,\n\"sdkName\": \"MobileMessaging SDK\",\n\"os\": \"Android\"\n}\n}\n],\n\"facebook\": [\n{\n\"applicationId\": \"370329180020364\",\n\"userId\": \"2094832040560427\",\n\"systemData\": {\n\"gender\": \"male\",\n\"lastName\": \"Doe\",\n\"firstName\": \"John\"\n}\n}\n],\n\"line\": [\n{\n\"applicationId\": \"1644264921\",\n\"userId\": \"U045147f1ad961bfe996b72bbf417f3c9\",\n\"systemData\": {\n\"displayName\": \"John Doe\"\n}\n}\n],\n\"instagram\": [\n{\n\"applicationId\": \"17841446795352028\",\n\"userId\": \"12461436693342628\",\n\"systemData\": {\n\"displayName\": \"john.doe\"\n}\n}\n],\n\"twitter\": [\n{\n\"applicationId\": \"1148203323283877\",\n\"userId\": \"370329180020364\",\n\"systemData\": {\n\"displayName\": \"John Doe\"\n}\n}\n]\n}\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/persons"},"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":"878"},{"key":"Date","value":"Wed, 17 May 2023 12:10:04 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684325404495123830"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2023-05-17T12:10:04\",\n \"modifiedAt\": \"2023-05-17T12:10:04\",\n \"id\": 44,\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"type\": \"CUSTOMER\",\n \"address\": \"67 Farringdon Road\",\n \"city\": \"Uppsala\",\n \"country\": \"Sweden\",\n \"gender\": \"MALE\",\n \"birthDate\": \"1966-01-15\",\n \"middleName\": \"Janie\",\n \"profilePicture\": \"http://profile.com\",\n \"origin\": \"API\",\n \"modifiedFrom\": \"API\",\n \"tags\": [\n \"VIP Customers\",\n \"New Customers\"\n ],\n \"customAttributes\": {\n \"Contract Expiry\": \"2023-06-30\",\n \"Company\": \"Example\",\n \"ShoppingCartList\": [\n {\n \"__id\": \"619ee046-d435-4b04-8445-9c9b67f1ffbd\",\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\",\n \"productName\": \"Sneakers\",\n \"productPrice\": 25.33\n },\n {\n \"__id\": \"1ed808bc-b9a8-40ab-ba24-b712cdab183d\",\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\",\n \"productName\": \"T-Shirt\",\n \"productPrice\": 9.99\n }\n ]\n },\n \"contactInformation\": {\n \"phone\": [\n {\n \"number\": \"4670123456\"\n }\n ],\n \"email\": [\n {\n \"address\": \"johndoe@wxample.com\"\n }\n ]\n }\n}"}],"_postman_id":"b5ea26a0-c402-4024-b2b6-ee8290ec62e0"},{"name":"Delete a person","id":"586619a6-3a6c-4515-900a-5eb8bbdf6e53","protocolProfileBehavior":{"disableBodyPruning":true},"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","description":"

Use this method to delete a person.

Request rate limit

5 requests / second (per account)

Query parameters

Parameter	Type	Description
phone	string	Example: phone=46701234567 Person’s phone number. Phone numbers must be in international format.
email	string	Example: 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.
externalId	string	Example: externalId=6F9619FF-8B86-D011-B42D-00CF4FC964FF Unique ID for a person from your or another external system.
pushRegistrationId	string	Example: pushRegistrationId=6F9619FF-8B86-D011-B42D-00CF4FC964FF Person's push registration ID.
id	integer	Example: id=11351351 Person's internal ID.
lineId	string	Example: lineId=U045147f1ad961bfe996b72bbf417f3c9 Person’s Line ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameters.
lineSenderId	string	Example: lineSenderId=1644264921 Person’s Line sender ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameter
facebookId	string	Example: facebookId=370329180020364 Person’s Facebook ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters.
facebookSenderId	integer	Example: facebookSenderId=2094832040560427 Person’s Facebook sender ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters.
telegramUserId	string	Example: telegramUserId=1303201999 Person’s Telegram user ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters.
telegramBotId	string	Example: telegramBotId=1495032701 Person’s Telegram bot ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters.
viberBotUserId	string	Example: 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.
viberBotId	integer	Example: viberBotId=5591458813882487336 Person’s Viber Bot ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters.
instagramId	string	Example: instagramId=17841546155331428 Person’s Instagram user ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters.
instagramSenderId	integer	Example: instagramSenderId=17841405793187218 Person’s Instagram sender ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters.
twitterId	string	example: twitterId=370329180020364 Person’s Twitter user ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters.
twitterSenderId	integer	Example: twitterSenderId=10765432100123456789 Person’s Twitter sender ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters.
appleBusinessChatId	string	Example: 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.
appleBusinessChatSenderId	string	Example: 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.
liveChatRegId	string	Example: liveChatRegId=79f9701b-e350-4497-9689-b2257864e63f

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","persons"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"83a87730-0855-4eba-81c7-1a16e4c8216a","name":"Delete a person","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://go2.vhdmedia.se/people/2/persons?phone=4670123456&email=name@example.com&externalId=6F9619FF-8B86-D011-B42D-00CF4FC964FF&pushRegistrationId=6F9619FF-8B86-D011-B42D-00CF4FC964FF&id=61451351&lineId=U045147f1ad961bfe996b72bbf417f3c9&lineSenderId=1644264921&facebookId=370329180020364&facebookSenderId=2094832040560427&telegramUserId=1303201999&telegramBotId=1495032701&viberBotUserId=Upk26V/i1GXfvxZ8S41P/w==&viberBotId=5591458813882487336&instagramId=17841546155331428&instagramSenderId=17841405793187218&twitterId=370329180020364&twitterSenderId=2094832040560427&appleBusinessChatId=ef6ca8e9-3718-4dc9-a9a0-b4ac28d135ca&appleBusinessChatSenderId=urn:mbid:AQAAYyUbut3B2E3T9GLv4EaF/%3Ctruncated%3E&liveChatRegId=79f9701b-e350-4497-9689-b2257864e63f","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","2","persons"],"query":[{"key":"phone","value":"4670123456"},{"key":"email","value":"name@example.com"},{"key":"externalId","value":"6F9619FF-8B86-D011-B42D-00CF4FC964FF"},{"key":"pushRegistrationId","value":"6F9619FF-8B86-D011-B42D-00CF4FC964FF"},{"key":"id","value":"61451351"},{"key":"lineId","value":"U045147f1ad961bfe996b72bbf417f3c9"},{"key":"lineSenderId","value":"1644264921"},{"key":"facebookId","value":"370329180020364"},{"key":"facebookSenderId","value":"2094832040560427"},{"key":"telegramUserId","value":"1303201999"},{"key":"telegramBotId","value":"1495032701"},{"key":"viberBotUserId","value":"Upk26V/i1GXfvxZ8S41P/w=="},{"key":"viberBotId","value":"5591458813882487336"},{"key":"instagramId","value":"17841546155331428"},{"key":"instagramSenderId","value":"17841405793187218"},{"key":"twitterId","value":"370329180020364"},{"key":"twitterSenderId","value":"2094832040560427"},{"key":"appleBusinessChatId","value":"ef6ca8e9-3718-4dc9-a9a0-b4ac28d135ca"},{"key":"appleBusinessChatSenderId","value":"urn:mbid:AQAAYyUbut3B2E3T9GLv4EaF/%3Ctruncated%3E"},{"key":"liveChatRegId","value":"79f9701b-e350-4497-9689-b2257864e63f"}]}},"status":"Bad Request","code":400,"_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":"82"},{"key":"Date","value":"Wed, 17 May 2023 11:40:06 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684323607340580827"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"586619a6-3a6c-4515-900a-5eb8bbdf6e53"},{"name":"Partial person update","id":"4aff58d7-495a-4fe2-b382-d9379ef60342","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/persons","description":"

Partial person update

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

Request rate limit

5 requests / second (per account)

Query parameters

Parameter	Type	Description
phone	string	Example: phone=46701234567 Person’s phone number. Phone numbers must be in international format.
email	string	Example: 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.
externalId	string	Example: externalId=6F9619FF-8B86-D011-B42D-00CF4FC964FF Unique ID for a person from your or another external system.
pushRegistrationId	string	Example: pushRegistrationId=6F9619FF-8B86-D011-B42D-00CF4FC964FF Person's push registration ID.
id	integer	Example: id=11351351 Person's internal ID.
lineId	string	Example: lineId=U045147f1ad961bfe996b72bbf417f3c9 Person’s Line ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameters.
lineSenderId	string	Example: lineSenderId=1644264921 Person’s Line sender ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameter
facebookId	string	Example: facebookId=370329180020364 Person’s Facebook ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters.
facebookSenderId	integer	Example: facebookSenderId=2094832040560427 Person’s Facebook sender ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters.
telegramUserId	string	Example: telegramUserId=1303201999 Person’s Telegram user ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters.
telegramBotId	string	Example: telegramBotId=1495032701 Person’s Telegram bot ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters.
viberBotUserId	string	Example: 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.
viberBotId	integer	Example: viberBotId=5591458813882487336 Person’s Viber Bot ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters.
instagramId	string	Example: instagramId=17841546155331428 Person’s Instagram user ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters.
instagramSenderId	integer	Example: instagramSenderId=17841405793187218 Person’s Instagram sender ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters.
twitterId	string	example: twitterId=370329180020364 Person’s Twitter user ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters.
twitterSenderId	integer	Example: twitterSenderId=10765432100123456789 Person’s Twitter sender ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters.
appleBusinessChatId	string	Example: 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.
appleBusinessChatSenderId	string	Example: 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.
liveChatRegId	string	Example: liveChatRegId=79f9701b-e350-4497-9689-b2257864e63f

Request body schema

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

Parameter	Type	Description
address	string	Person's address, 256 characters max
birthDate	string	Person's date of birth, format YYYY-MM-DD
city	string	Person's city, 50 characters max
computedAttributes { property name* { } }	object object	Person's computed attributes grouped by type
contactInformation { 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 } }] }	object 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	Required 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
country	string	Person's country, 50 characters max
customAttributes { property name* { } }	object object	List of custom attributes for the person, 4096 characters max per value
externalId	string	Unique ID for a person from your or another external system, 256 characters max
firstName	string	Person's first name, 255 characters max
gender	string	Enum: \"MALE\" \"FEMALE\" Person's gender
integrations { salesforce { contactId leadId } }	object object string string	Integrations Salesforce integration Salesforce contact id Salesforce lead id
lastName	string	Person's last name, 255 characters max
middleName	string	Person's middle name, 50 characters max
profilePicture	string	URL for the person's profile picture, 2083 characters max
tags	array of strings	List of tags that this person has
type	string	Enum: \"CUSTOMER\" \"LEAD\" Person's type, default type is CUSTOMER

Responses

Default sucessful response

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

Parameter	Type	Description
address	string	Person's address, 256 characters max
birthDate	string	Person's date of birth, format YYYY-MM-DD
city	string	Person's city, 50 characters max
computedAttributes { property name* { } }	object object	Person's computed attributes grouped by type
contactInformation { 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 } }] }	object 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	Required 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
country	string	Person's country, 50 characters max
customAttributes { property name* { } }	object object	List of custom attributes for the person, 4096 characters max per value
externalId	string	Unique ID for a person from your or another external system, 256 characters max
firstName	string	Person's first name, 255 characters max
gender	string	Enum: \"MALE\" \"FEMALE\" Person's gender
integrations { salesforce { contactId leadId } }	object object string string	Integrations Salesforce integration Salesforce contact id Salesforce lead id
lastName	string	Person's last name, 255 characters max
middleName	string	Person's middle name, 50 characters max
profilePicture	string	URL for the person's profile picture, 2083 characters max
tags	array of strings	List of tags that this person has
type	string	Enum: \"CUSTOMER\" \"LEAD\" Person's type, default type is CUSTOMER

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","persons"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"9db3aed6-4983-4fe8-bf7b-fc3da194e814","name":"Partial person update","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"customAttributes\": {\n \"ShoppingCartList\": [\n {\n \"productName\": \"Sneakers\",\n \"productPrice\": 20.33,\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\"\n },\n {\n \"productName\": \"T-Shirt\",\n \"productPrice\": 10.99,\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/2/persons?email=janewilliams@vhdmeida.com","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","2","persons"],"query":[{"key":"email","value":"janewilliams@vhdmeida.com"}]}},"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":"638"},{"key":"Date","value":"Wed, 17 May 2023 12:00:31 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684324831442251666"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2023-05-08T15:00:54\",\n \"modifiedAt\": \"2023-05-10T09:16:44\",\n \"id\": 4,\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"type\": \"CUSTOMER\",\n \"origin\": \"API\",\n \"modifiedFrom\": \"API\",\n \"customAttributes\": {\n \"Company\": \"VHD\",\n \"ShoppingCartList\": [\n {\n \"__id\": \"6fc50081-3832-4630-8d5e-c2d2b3e581ac\",\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\",\n \"productName\": \"Sneakers\",\n \"productPrice\": 20.33\n },\n {\n \"__id\": \"f03121ae-5485-40e1-9849-cf1dfaedfb6e\",\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\",\n \"productName\": \"T-Shirt\",\n \"productPrice\": 10.99\n }\n ],\n \"Contract Expiry\": \"2023-06-01\"\n },\n \"contactInformation\": {\n \"email\": [\n {\n \"address\": \"janewilliams@vhdmeida.com\"\n }\n ]\n }\n}"}],"_postman_id":"4aff58d7-495a-4fe2-b382-d9379ef60342"},{"name":"Set contact information to person","id":"072a3252-780b-4a40-89e2-193d76290717","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"contactInformation\": {\n \"email\": [\n {\n \"address\": \"janewilliams@example.com\"\n }\n ],\n \"phone\": [\n {\n \"number\": \"447012725479\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/persons/contactInformation","description":"

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.

Request rate limit

5 requests / second (per account)

Query parameters

Parameter	Type	Description
phone	string	Example: phone=46701234567 Person’s phone number. Phone numbers must be in international format.
email	string	Example: 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.
externalId	string	Example: externalId=6F9619FF-8B86-D011-B42D-00CF4FC964FF Unique ID for a person from your or another external system.
pushRegistrationId	string	Example: pushRegistrationId=6F9619FF-8B86-D011-B42D-00CF4FC964FF Person's push registration ID.
id	ineger	Example: id=11351351 Person's internal ID.
lineId	string	Example: lineId=U045147f1ad961bfe996b72bbf417f3c9 Person’s Line ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameters.
lineSenderId	string	Example: lineSenderId=1644264921 Person’s Line sender ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameter
facebookId	string	Example: facebookId=370329180020364 Person’s Facebook ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters.
facebookSenderId	integer	Example: facebookSenderId=2094832040560427 Person’s Facebook sender ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters.
telegramUserId	string	Example: telegramUserId=1303201999 Person’s Telegram user ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters.
telegramBotId	string	Example: telegramBotId=1495032701 Person’s Telegram bot ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters.
viberBotUserId	string	Example: 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.
viberBotId	integer	Example: viberBotId=5591458813882487336 Person’s Viber Bot ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters.
instagramId	string	Example: instagramId=17841546155331428 Person’s Instagram user ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters.
instagramSenderId	integer	Example: instagramSenderId=17841405793187218 Person’s Instagram sender ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters.
twitterId	string	example: twitterId=370329180020364 Person’s Twitter user ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters.
twitterSenderId	integer	Example: twitterSenderId=10765432100123456789 Person’s Twitter sender ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters.
appleBusinessChatId	string	Example: 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.
appleBusinessChatSenderId	string	Example: 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.
liveChatRegId	string	Example: liveChatRegId=79f9701b-e350-4497-9689-b2257864e63f

Request body schema

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

Parameter	Type	Description
contactInformation { email [{ address }] , phone [{ number }] }	object array of objects string array of objects string	Required 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.

Responses

Default sucessful response

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

Parameter	Type	Description
address	string	Person's address, 256 characters max
birthDate	string	Person's date of birth, format YYYY-MM-DD
city	string	Person's city, 50 characters max
computedAttributes { property name* { } }	object object	Person's computed attributes grouped by type
contactInformation { 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 } }] }	object 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	Required 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
country	string	Person's country, 50 characters max
customAttributes { property name* { } }	object object	List of custom attributes for the person, 4096 characters max per value
externalId	string	Unique ID for a person from your or another external system, 256 characters max
firstName	string	Person's first name, 255 characters max
gender	string	Enum: \"MALE\" \"FEMALE\" Person's gender
integrations { salesforce { contactId leadId } }	object object string string	Integrations Salesforce integration Salesforce contact id Salesforce lead id
lastName	string	Person's last name, 255 characters max
middleName	string	Person's middle name, 50 characters max
profilePicture	string	URL for the person's profile picture, 2083 characters max
tags	array of strings	List of tags that this person has
type	string	Enum: \"CUSTOMER\" \"LEAD\" Person's type, default type is CUSTOMER

Responses

Default sucesful response

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

Parameter	Type	Description
address	string	Person's address, 256 characters max
birthDate	string	Person's date of birth, format YYYY-MM-DD
city	string	Person's city, 50 characters max
computedAttributes { property name* { } }	object object	Person's computed attributes grouped by type
contactInformation { 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 } }] }	object 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	Required 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
country	string	Person's country, 50 characters max
customAttributes { property name* { } }	object object	List of custom attributes for the person, 4096 characters max per value
externalId	string	Unique ID for a person from your or another external system, 256 characters max
firstName	string	Person's first name, 255 characters max
gender	string	Enum: \"MALE\" \"FEMALE\" Person's gender
integrations { salesforce { contactId leadId } }	object object string string	Integrations Salesforce integration Salesforce contact id Salesforce lead id
lastName	string	Person's last name, 255 characters max
middleName	string	Person's middle name, 50 characters max
profilePicture	string	URL for the person's profile picture, 2083 characters max
tags	array of strings	List of tags that this person has
type	string	Enum: \"CUSTOMER\" \"LEAD\" Person's type, default type is CUSTOMER

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","persons","contactInformation"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"4e66e55d-091d-43ef-84db-f75db4997e44","name":"Set contact information to person","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\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":{"raw":"https://go2.vhdmedia.se/people/2/persons/contactInformation?email=janewilliams@example.com","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","2","persons","contactInformation"],"query":[{"key":"email","value":"janewilliams@example.com"}]}},"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":"278"},{"key":"Date","value":"Wed, 17 May 2023 15:58:56 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684339137248564226"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2023-05-17T13:47:52\",\n \"modifiedAt\": \"2023-05-17T13:47:52\",\n \"id\": 45,\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"type\": \"CUSTOMER\",\n \"origin\": \"API\",\n \"modifiedFrom\": \"API\",\n \"contactInformation\": {\n \"phone\": [\n {\n \"number\": \"4670123456\"\n }\n ],\n \"email\": [\n {\n \"address\": \"janewilliams@example.com\"\n }\n ]\n }\n}"}],"_postman_id":"072a3252-780b-4a40-89e2-193d76290717"},{"name":"Delete contact information to person","id":"ac817f02-6654-46f4-9621-749510c3ff47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/persons/contactInformation","description":"

Use this method to delete specified emails and mobile phones from a particular person.

Request rate limit

5 requests / second (per account)

Query parameters

Parameter	Type	Description
phone	string	Example: phone=46701234567 Person’s phone number. Phone numbers must be in international format.
email	string	Example: 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.
externalId	string	Example: externalId=6F9619FF-8B86-D011-B42D-00CF4FC964FF Unique ID for a person from your or another external system.
pushRegistrationId	string	Example: pushRegistrationId=6F9619FF-8B86-D011-B42D-00CF4FC964FF Person's push registration ID.
id	integer	Example: id=11351351 Person's internal ID.
lineId	string	Example: lineId=U045147f1ad961bfe996b72bbf417f3c9 Person’s Line ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameters.
lineSenderId	string	Example: lineSenderId=1644264921 Person’s Line sender ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameter
facebookId	string	Example: facebookId=370329180020364 Person’s Facebook ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters.
facebookSenderId	integer	Example: facebookSenderId=2094832040560427 Person’s Facebook sender ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters.
telegramUserId	string	Example: telegramUserId=1303201999 Person’s Telegram user ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters.
telegramBotId	string	Example: telegramBotId=1495032701 Person’s Telegram bot ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters.
viberBotUserId	string	Example: 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.
viberBotId	integer	Example: viberBotId=5591458813882487336 Person’s Viber Bot ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters.
instagramId	string	Example: instagramId=17841546155331428 Person’s Instagram user ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters.
instagramSenderId	integer	Example: instagramSenderId=17841405793187218 Person’s Instagram sender ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters.
twitterId	string	example: twitterId=370329180020364 Person’s Twitter user ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters.
twitterSenderId	integer	Example: twitterSenderId=10765432100123456789 Person’s Twitter sender ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters.
appleBusinessChatId	string	Example: 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.
appleBusinessChatSenderId	string	Example: 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.
liveChatRegId	string	Example: liveChatRegId=79f9701b-e350-4497-9689-b2257864e63f

Request body schema

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

Parameter	Type	Description
contactInformation { email [{ address }] , phone [{ number }] }	object array of objects string array of objects string	Required 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.

Responses

Default sucesful response

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

Parameter	Type	Description
address	string	Person's address, 256 characters max
birthDate	string	Person's date of birth, format YYYY-MM-DD
city	string	Person's city, 50 characters max
computedAttributes { property name* { } }	object object	Person's computed attributes grouped by type
contactInformation { 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 } }] }	object 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	Required 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
country	string	Person's country, 50 characters max
customAttributes { property name* { } }	object object	List of custom attributes for the person, 4096 characters max per value
externalId	string	Unique ID for a person from your or another external system, 256 characters max
firstName	string	Person's first name, 255 characters max
gender	string	Enum: \"MALE\" \"FEMALE\" Person's gender
integrations { salesforce { contactId leadId } }	object object string string	Integrations Salesforce integration Salesforce contact id Salesforce lead id
lastName	string	Person's last name, 255 characters max
middleName	string	Person's middle name, 50 characters max
profilePicture	string	URL for the person's profile picture, 2083 characters max
tags	array of strings	List of tags that this person has
type	string	Enum: \"CUSTOMER\" \"LEAD\" Person's type, default type is CUSTOMER

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","persons","contactInformation"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"6ef5d52c-f4b6-45a4-b915-477068a04d42","name":"Delete contact information to person","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"contactInformation\": {\n \"phone\": [\n {\n \"number\": \"4670123456\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/2/persons/contactInformation?email=janewilliams@example.com","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","2","persons","contactInformation"],"query":[{"key":"email","value":"janewilliams@example.com"}]}},"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":"242"},{"key":"Date","value":"Wed, 17 May 2023 16:11:41 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684339902304252226"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2023-05-17T13:47:52\",\n \"modifiedAt\": \"2023-05-17T15:58:57\",\n \"id\": 45,\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"type\": \"CUSTOMER\",\n \"origin\": \"API\",\n \"modifiedFrom\": \"API\",\n \"contactInformation\": {\n \"email\": [\n {\n \"address\": \"janewilliams@example.com\"\n }\n ]\n }\n}"}],"_postman_id":"ac817f02-6654-46f4-9621-749510c3ff47"},{"name":"Add contact information to person","id":"a02c2143-3bdd-4bc3-83fa-d50ec7785367","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/persons/contactInformation","description":"

Use this method to add emails and mobile phones to a particular person.

Request rate limit

5 requests / second (per account)

Query parameters

Parameter	Type	Description
phone	string	Example: phone=46701234567 Person’s phone number. Phone numbers must be in international format.
email	string	Example: 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.
externalId	string	Example: externalId=6F9619FF-8B86-D011-B42D-00CF4FC964FF Unique ID for a person from your or another external system.
pushRegistrationId	string	Example: pushRegistrationId=6F9619FF-8B86-D011-B42D-00CF4FC964FF Person's push registration ID.
id	integer	Example: id=11351351 Person's internal ID.
lineId	string	Example: lineId=U045147f1ad961bfe996b72bbf417f3c9 Person’s Line ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameters.
lineSenderId	string	Example: lineSenderId=1644264921 Person’s Line sender ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameter
facebookId	string	Example: facebookId=370329180020364 Person’s Facebook ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters.
facebookSenderId	integer	Example: facebookSenderId=2094832040560427 Person’s Facebook sender ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters.
telegramUserId	string	Example: telegramUserId=1303201999 Person’s Telegram user ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters.
telegramBotId	string	Example: telegramBotId=1495032701 Person’s Telegram bot ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters.
viberBotUserId	string	Example: 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.
viberBotId	integer	Example: viberBotId=5591458813882487336 Person’s Viber Bot ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters.
instagramId	string	Example: instagramId=17841546155331428 Person’s Instagram user ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters.
instagramSenderId	integer	Example: instagramSenderId=17841405793187218 Person’s Instagram sender ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters.
twitterId	string	example: twitterId=370329180020364 Person’s Twitter user ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters.
twitterSenderId	integer	Example: twitterSenderId=10765432100123456789 Person’s Twitter sender ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters.
appleBusinessChatId	string	Example: 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.
appleBusinessChatSenderId	string	Example: 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.
liveChatRegId	string	Example: liveChatRegId=79f9701b-e350-4497-9689-b2257864e63f

Request body schema

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

Parameter	Type	Description
contactInformation { email [{ address }] , phone [{ number }] }	object array of objects string array of objects string	Required 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.

Responses

Default sucesful response

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

Parameter	Type	Description
address	string	Person's address, 256 characters max
birthDate	string	Person's date of birth, format YYYY-MM-DD
city	string	Person's city, 50 characters max
computedAttributes { property name* { } }	object object	Person's computed attributes grouped by type
contactInformation { 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 } }] }	object 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	Required 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
country	string	Person's country, 50 characters max
customAttributes { property name* { } }	object object	List of custom attributes for the person, 4096 characters max per value
externalId	string	Unique ID for a person from your or another external system, 256 characters max
firstName	string	Person's first name, 255 characters max
gender	string	Enum: \"MALE\" \"FEMALE\" Person's gender
integrations { salesforce { contactId leadId } }	object object string string	Integrations Salesforce integration Salesforce contact id Salesforce lead id
lastName	string	Person's last name, 255 characters max
middleName	string	Person's middle name, 50 characters max
profilePicture	string	URL for the person's profile picture, 2083 characters max
tags	array of strings	List of tags that this person has
type	string	Enum: \"CUSTOMER\" \"LEAD\" Person's type, default type is CUSTOMER

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","persons","contactInformation"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"bbe44ef7-f5f1-461f-8c29-680373fa4887","name":"Add contact information to person","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"contactInformation\": {\n \"phone\": [\n {\n \"number\": \"4670123456\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/2/persons/contactInformation?email=janewilliams@example.com","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","2","persons","contactInformation"],"query":[{"key":"email","value":"janewilliams@example.com"}]}},"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":"278"},{"key":"Date","value":"Thu, 18 May 2023 08:33:20 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684398800847491227"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2023-05-17T13:47:52\",\n \"modifiedAt\": \"2023-05-17T16:11:42\",\n \"id\": 45,\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"type\": \"CUSTOMER\",\n \"origin\": \"API\",\n \"modifiedFrom\": \"API\",\n \"contactInformation\": {\n \"phone\": [\n {\n \"number\": \"4670123456\"\n }\n ],\n \"email\": [\n {\n \"address\": \"janewilliams@example.com\"\n }\n ]\n }\n}"}],"_postman_id":"a02c2143-3bdd-4bc3-83fa-d50ec7785367"},{"name":"Batch people create","id":"fe6ccb25-79d5-442d-968e-9a2e7e8b8fc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/persons/batch","description":"

Use this method to create multiple persons.
NOTE Array size of the batch create request is limited to 1000 persons

Request rate limit

5 requests / second (per account)

Request body schema

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

Parameter	Type	Description
people	array of objects	List of people

Responses

Default sucesful response

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

Parameter	Type	Description
results	array of objects	List of any unsuccessful result from the batch operation for each processed entry. Example, email used in the request already exists.

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","persons","batch"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"c92dfa5e-b0d5-433e-bfc1-b7cdb6b9dab2","name":"Batch people create","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"people\": [\n{\n\"firstName\": \"Jane\",\n\"lastName\": \"Smith\",\n\"customAttributes\": {\n\"Contract Expiry\": \"2023-06-01\",\n\"Company\": \"Example\",\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\"email\": [\n{\n\"address\": \"janem@example.com\"\n}\n]\n}\n},\n{\n\"firstName\": \"Jane\",\n\"lastName\": \"Will\",\n\"customAttributes\": {\n\"Contract Expiry\": \"2023-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\"email\": [\n{\n\"address\": \"janewil@example.com\"\n}\n]\n}\n}\n]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/persons/batch"},"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":"4"},{"key":"Date","value":"Thu, 18 May 2023 10:15:09 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684404910068137829"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"null"}],"_postman_id":"fe6ccb25-79d5-442d-968e-9a2e7e8b8fc3"},{"name":"Batch people delete","id":"dd1bbe82-e8b1-4fa3-b31b-ad0676d8df0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","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.

Request rate limit

5 requests / second (per account)

Request body schema

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

Parameter	Type	Description
people	array of objects	List of people

Responses

Default sucesful response

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

Parameter	Type	Description
results	array of objects	List of any unsuccessful result from the batch operation for each processed entry. Example, email used in the request already exists.

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","persons","batch"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"ab979b2e-e240-448e-973b-bb504833e8be","name":"Batch people delete","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"people\": [\n {\n \"query\": {\n \"phone\": \"4670123456\"\n }\n },\n {\n \"query\": {\n \"email\": \"janewil@example.com\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/persons/batch"},"status":"No Content","code":204,"_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":"Date","value":"Thu, 18 May 2023 10:24:17 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684405457968355666"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":null},{"id":"38f7fa63-7196-42b5-9142-dede49bdcf4b","name":"status 207","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"people\": [\n {\n \"query\": {\n \"phone\": \"4670123456\"\n }\n },\n {\n \"query\": {\n \"email\": \"janem@example.com\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/persons/batch"},"status":"Multi-Status","code":207,"_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":"132"},{"key":"Date","value":"Thu, 18 May 2023 10:21:20 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684405280736196666"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"errors\": [\n {\n \"message\": \"Person with (phone=4670123456) does not exist\"\n }\n ],\n \"status\": 409,\n \"query\": {\n \"phone\": \"4670123456\"\n }\n }\n ]\n}"}],"_postman_id":"dd1bbe82-e8b1-4fa3-b31b-ad0676d8df0a"},{"name":"Batch people update","id":"afaa1734-e188-4326-93c7-07cf3c71560e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"\n","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/persons/batch","description":"

Use this method to update multiple persons.
NOTE Array size of the batch update request is limited to 1000 persons.

Request rate limit

5 requests / second (per account)

Request body schema

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

Parameter	Type	Description
people	array of objects	List of people

Responses

Default sucesful response

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

Parameter	Type	Description
results	array of objects	List of any unsuccessful result from the batch operation for each processed entry. Example, email used in the request already exists.

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

GET Get a single person or a list of people

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.

PUT Update a person

POST Create a new person

Use this method to create a new person.

DEL Delete a person

Use this method to delete a person.

PATCH Partial person update

PUT Set contact information to person

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.

DEL Delete contact information to person

Use this method to delete specified emails and mobile phones from a particular person.

PATCH Add contact information to person

Use this method to add emails and mobile phones to a particular person.

POST Batch people create

Use this method to create multiple persons.
NOTE Array size of the batch create request is limited to 1000 persons.

DEL Batch people delete

Use this method to delete multiple persons.
NOTE Array size of the batch delete request is limited to 1000 persons.

PATCH Batch people update

Use this method to update multiple persons.
NOTE Array size of the batch update request is limited to 1000 persons.

\n","_postman_id":"c3b2a4ac-8b9e-4c66-b2cf-70af2ca2a972"},{"name":"COMPANY PROFILE","item":[{"name":"Get a single company or a list of companies","id":"c524be37-9656-4a53-be0b-3957328a5456","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://go2.vhdmedia.se/people/2/companies","description":"

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.

Request rate limit

5 requests / second (per account)

Query parameters

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

Parameter	Type	Description
name	string	Example: name=VHD Name of company you want to get.
id	integer	Example: id=87951351 ID of company you want to get.
limit	integer	Example: limit=20 Maximum number of rows returned per page.
page	integer	Example: 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.
includeTotalCount	boolean	Example: includeTotalCount=false Returns total count of companies, if set to true.
orderBy	string	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.
filter	string	Example: filter={\"#or\":[{\"name\":\"vhd\"},{\"#contains\":{\"notes\":\"another\"}}]} Allows to filter companies using simple queries. Just pass to the parameter URL encoded query.

List of supported logical operators:

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

Logical Operator	Description
`#and`	Joins query clauses with a logical AND returns all records that match the conditions of both clauses.
`#or`	Joins query clauses with a logical OR returns all records that match the conditions of either clause.

List of supported comparison operators:

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

Comparison Operator	Supported Type	Description
`#eq`	string, integer, decimal, date	Matches values that are equal to a specified value.
`#ne`	string, integer, decimal, date	Matches all values that are not equal to a specified value.
`#contains`	string	Matches the records that contain a specified value.
`#startsWith`	string	Matches the records that start with a specified value.
`#endsWith`	string	Matches the records that end with a specified value.
`#gt`	integer, decimal, date	Matches values that are greater than a specified value.
`#lt`	integer, decimal, date	Matches values that are less than a specified value.
`#gte`	integer, decimal, date	Matches values that are greater than or equal to a specified value.
`#lte`	integer, decimal, date	Matches values that are less than or equal to a specified value.

Paging and ordering

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

Parameter	Type	Description
`limit`	int	If 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.
`page`	int	This 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.
`orderBy`	string	This parameter is used to order your results. If an order is not given, the default order `modifiedAt:desc` will be applied.

Responses

Default sucessful response

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

Parameter	Type	Description
companies [ accountManager country customAttributes { property name* } customerStage domains id industry modifiedAt modifiedFrom name notes origin region segment serviceData { property name* } vatNumber ]	array 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	Example: 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.
limit	integer	Example: id=11351351 ID of company you want to get.
orderBy	string	Results ordering
page	integer	Page number
totalCount	integer	Total amount of rows

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","companies"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"6e7e0984-37cc-4631-9ee0-e00e8f4b93ff","name":"Get a single company or a list of companies","originalRequest":{"method":"GET","header":[],"url":"https://go2.vhdmedia.se/people/2/companies"},"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":"433"},{"key":"Date","value":"Thu, 18 May 2023 15:24:01 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684423441982061827"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 100,\n \"page\": 1,\n \"orderBy\": \"modifiedAt:desc, id:asc\",\n \"companies\": [\n {\n \"createdAt\": \"2023-05-18T15:23:49\",\n \"modifiedAt\": \"2023-05-18T15:23:49\",\n \"id\": 1,\n \"name\": \"Example\",\n \"notes\": \"notes example\",\n \"country\": \"Sweden\",\n \"region\": \"Europe\",\n \"accountManager\": \"Jane Smith\",\n \"customerStage\": \"Active\",\n \"industry\": \"IT\",\n \"vatNumber\": \"00000\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2023-06-01\"\n },\n \"domains\": [\n \"example.com\"\n ],\n \"origin\": \"API\",\n \"modifiedFrom\": \"API\"\n }\n ]\n}"}],"_postman_id":"c524be37-9656-4a53-be0b-3957328a5456"},{"name":"Create a new company","id":"4731e19b-e781-4d55-b7ac-e0ee37d5546b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/companies","description":"

Request rate limit

5 requests / second (per account)

Request body schema

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

Parameter	Type	Description
accountManager	string [ 0 .. 255 ] characters	Account manager.
country	string [ 0 .. 50 ] characters	Country.
customAttributes { property name* }	object object	List of custom attributes for the company.
customerStage	string [ 0 .. 255 ] characters	Customer stage.
domains	array of strings non-empty	required List of domains for the company.
industry	string [ 0 .. 255 ] characters	Industry
name	string [ 0 .. 255 ] characters	required Company name.
notes	string [ 0 .. 1023 ] characters	Notes.
region	string [ 0 .. 255 ] characters	Region.
segment	string [ 0 .. 255 ] characters	Segment.
serviceData { property name* }	object object	Company's service information.
vatNumber	string [ 0 .. 50 ] characters	VAT number.

Responses

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

Parameter	Type	Description
accountManager	string [ 0 .. 255 ] characters	Account manager.
country	string [ 0 .. 50 ] characters	Country.
createdAt	string	Date and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.
customAttributes { property name* }	object object	List of custom attributes for the company.
customerStage	string [ 0 .. 255 ] characters	Customer stage.
domains	array of strings non-empty	required List of domains for the company.
id	integer	Unique id of the entity.
modifiedAt	string	Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.
modifiedFrom	string	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.
industry	string [ 0 .. 255 ] characters	Industry
name	string [ 0 .. 255 ] characters	required Company name.
notes	string [ 0 .. 1023 ] characters	Notes.
origin	string	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	string [ 0 .. 255 ] characters	Region.
segment	string [ 0 .. 255 ] characters	Segment.
serviceData { property name* }	object object	Company's service information.
vatNumber	string [ 0 .. 50 ] characters

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","companies"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"072963ee-92bb-489d-9ce9-a38e0c0e681f","name":"Create a new company","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Example\",\n \"notes\": \"notes example\",\n \"country\": \"Sweden\",\n \"region\": \"Europe\",\n \"accountManager\": \"Jane Smith\",\n \"customerStage\": \"Active\",\n \"industry\": \"IT\",\n \"vatNumber\": \"00000\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2023-06-01\"\n },\n \"domains\": [\n \"example.com\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/companies"},"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":"360"},{"key":"Date","value":"Thu, 18 May 2023 15:23:49 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684423429894686228"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2023-05-18T15:23:49\",\n \"modifiedAt\": \"2023-05-18T15:23:49\",\n \"id\": 1,\n \"name\": \"Example\",\n \"notes\": \"notes example\",\n \"country\": \"Sweden\",\n \"region\": \"Europe\",\n \"accountManager\": \"Jane Smith\",\n \"customerStage\": \"Active\",\n \"industry\": \"IT\",\n \"vatNumber\": \"00000\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2023-06-01\"\n },\n \"domains\": [\n \"example.com\"\n ],\n \"origin\": \"API\",\n \"modifiedFrom\": \"API\"\n}"}],"_postman_id":"4731e19b-e781-4d55-b7ac-e0ee37d5546b"},{"name":"Delete a company","id":"6c9e7417-65af-408d-9c9e-ece5b2dbe2c9","protocolProfileBehavior":{"disableBodyPruning":true},"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/companies","description":"

Use this method with a query parameter to delete a company. Exactly one of the query parameters must be included in the query.

Request rate limit

5 requests / second (per account)

Query parameters

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

Parameter	Type	Description
id	integer	Example: id=11351351 ID of company you want to delete.
name	string	Example: name=vhd Name of company you want to delete.
domain	string	Example: domain=company-domain.com Domain of company you want to delete.

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","companies"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"67ccf53c-2ac7-411b-b572-76986e86839d","name":"Delete a company","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://go2.vhdmedia.se/people/2/companies?name=example","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","2","companies"],"query":[{"key":"name","value":"example"}]}},"status":"No Content","code":204,"_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":"Date","value":"Thu, 18 May 2023 15:29:28 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684423768110882830"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"6c9e7417-65af-408d-9c9e-ece5b2dbe2c9"},{"name":"Partial company update","id":"fdef4971-93a1-4148-a859-82ec998fde7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/companies","description":"

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.

Request rate limit

5 requests / second (per account)

Query parameters

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

Parameter	Type	Description
id	integer	Example: id=61451351 ID of company you want to delete.
name	string	Example: name=vhd Name of company you want to delete.
domain	string	Example: domain=company-domain.com Domain of company you want to delete.
replaceTags	boolean	Example: replaceTags=false Flag which indicates replacement operation.

Request body schema

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

Parameter	Type	Description
accountManager	string [ 0 .. 255 ] characters	Account manager.
country	string [ 0 .. 50 ] characters	Country.
customAttributes { property name* }	object object	List of custom attributes for the company.
customerStage	string [ 0 .. 255 ] characters	Customer stage.
domains	array of strings non-empty	required List of domains for the company.
industry	string [ 0 .. 255 ] characters	Industry
name	string [ 0 .. 255 ] characters	required Company name.
notes	string [ 0 .. 1023 ] characters	Notes.
region	string [ 0 .. 255 ] characters	Region.
segment	string [ 0 .. 255 ] characters	Segment.
vatNumber	string [ 0 .. 50 ] characters	VAT number.

Responses

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

Parameter	Type	Description
accountManager	string [ 0 .. 255 ] characters	Account manager.
country	string [ 0 .. 50 ] characters	Country.
createdAt	string	Date and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.
customAttributes { property name* }	object object	List of custom attributes for the company.
customerStage	string [ 0 .. 255 ] characters	Customer stage.
domains	array of strings non-empty	required List of domains for the company.
id	integer	Unique id of the entity.
modifiedAt	string	Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.
modifiedFrom	string	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.
industry	string [ 0 .. 255 ] characters	Industry
name	string [ 0 .. 255 ] characters	required Company name.
notes	string [ 0 .. 1023 ] characters	Notes.
origin	string	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	string [ 0 .. 255 ] characters	Region.
segment	string [ 0 .. 255 ] characters	Segment.
serviceData { property name* }	object object	Company's service information.
vatNumber	string [ 0 .. 50 ] characters

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","companies"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"0271b4c6-182d-4823-ab37-64a82028421a","name":"Partial company update","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"customerStage\": \"Testing\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/2/companies??id=2&name=Example","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","2","companies"],"query":[{"key":"?id","value":"2"},{"key":"name","value":"Example"}]}},"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":"361"},{"key":"Date","value":"Thu, 18 May 2023 15:45:50 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684424750737543161"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2023-05-18T15:39:30\",\n \"modifiedAt\": \"2023-05-18T15:45:50\",\n \"id\": 2,\n \"name\": \"Example\",\n \"notes\": \"notes example\",\n \"country\": \"Sweden\",\n \"region\": \"Europe\",\n \"accountManager\": \"Jane Smith\",\n \"customerStage\": \"Testing\",\n \"industry\": \"IT\",\n \"vatNumber\": \"00000\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2023-06-01\"\n },\n \"domains\": [\n \"example.com\"\n ],\n \"origin\": \"API\",\n \"modifiedFrom\": \"API\"\n}"}],"_postman_id":"fdef4971-93a1-4148-a859-82ec998fde7d"},{"name":"Batch companies create","id":"33d1e6d5-0543-49ff-b39a-f04577d01259","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/companies/batch","description":"

Use this method to create multiple companies.
NOTE Array size of the batch create request is limited to 1000 companies.

Request rate limit

5 requests / second (per account)

Request body schema

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

Parameter	Type	Description
companies	array of objects	List of companies.

[{

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


accountManager	string [ 0 .. 255 ] characters	Account manager.
country	string [ 0 .. 50 ] characters	Country.
customAttributes { property name* }	object object	List of custom attributes for the company.
customerStage	string [ 0 .. 255 ] characters	Customer stage.
domains	array of strings non-empty	required List of domains for the company.
industry	string [ 0 .. 255 ] characters	Industry
name	string [ 0 .. 255 ] characters	required Company name.
notes	string [ 0 .. 1023 ] characters	Notes.
region	string [ 0 .. 255 ] characters	Region.
segment	string [ 0 .. 255 ] characters	Segment.
serviceData { property name* }	object object	Company's service information.
vatNumber	string [ 0 .. 50 ] characters	VAT number.

}]

Responses

Default sucessful response

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

Parameter	Type	Description
results [{ errors [{ message }] index status ]}	array of objects array of objects string integer integer	List 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

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","companies","batch"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"9509b4eb-785e-4e25-9ac2-8ec8b5cd135c","name":"Batch companies create","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"companies\": [\n {\n \"name\": \"Company name one\",\n \"notes\": \"Some notes\",\n \"country\": \"Sweden\",\n \"segment\": \"Some segment\",\n \"accountManager\": \"Jane Smith\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2023-06-01\"\n },\n \"domains\": [\n \"companyone.com\"\n ]\n },\n {\n \"name\": \"Company name two\",\n \"notes\": \"Some notes\",\n \"country\": \"Sweden\",\n \"segment\": \"Some segment\",\n \"accountManager\": \"John Smith\",\n \"customAttributes\": {\n \"Contract Expiry\": \"2023-06-01\"\n },\n \"domains\": [\n \"companytwo.com\"\n ]\n }\n\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/companies/batch"},"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":"4"},{"key":"Date","value":"Thu, 18 May 2023 16:10:39 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684426240135210836"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"null"}],"_postman_id":"33d1e6d5-0543-49ff-b39a-f04577d01259"},{"name":"Batch companies delete","id":"0fa2eca0-6184-48a0-94f1-d5bfb154361b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"companies\": [\n {\n \"query\": {\n \"name\": \"Company name two\"\n }\n },\n {\n \"query\": {\n \"name\": \"Company name one\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/companies/batch","description":"

Use this method to delete multiple companies.
NOTE Array size of the batch delete request is limited to 1000 companies.

Request rate limit

5 requests / second (per account)

Request body schema

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

Parameter	Type	Description
companies [{ query }]	array of objects object	List of companies. Should contain company object defined as (key, value) pair. Key can be \"id\", \"name\", \"domain\".

Responses

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

Parameter	Type	Description
results [{ errors [{ message }] query status ]}	array of objects array of objects string object	List 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

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","companies","batch"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"a7b6857e-9613-460b-9f11-440d43e2a178","name":"Batch companies delete","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"companies\": [\n {\n \"query\": {\n \"name\": \"Company name two\"\n }\n },\n {\n \"query\": {\n \"name\": \"Company name one\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/companies/batch"},"status":"No Content","code":204,"_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":"Date","value":"Fri, 19 May 2023 08:21:49 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684484509607778837"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0fa2eca0-6184-48a0-94f1-d5bfb154361b"},{"name":"Batch companies update","id":"6b720bf9-a349-46ff-9806-734e4ba0c77d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/companies/batch","description":"

Use this method to update multiple companies.
NOTE Array size of the batch update request is limited to 1000 companies.

Request rate limit

5 requests / second (per account)

Request body schema

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

Parameter	Type	Description
companies [{ query }]	array of objects object	List of companies. Should contain company object defined as (key, value) pair. Key can be \"id\", \"name\", \"domain\".

Responses

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

Parameter	Type	Description
results [{ errors [{ message }] query status ]}	array of objects array of objects string object	List 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

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","companies","batch"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"481ecf10-6b94-4cb2-8f44-97e0bee090df","name":"Batch companies update","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"companies\": [\n {\n \"query\": {\n \"name\": \"Company name one\"\n },\n \"update\": {\n \"segment\": \"fixed segment\",\n \"domains\": [\n \"onedomain.com\"\n ]\n }\n },\n {\n \"query\": {\n \"name\": \"Company name two\"\n },\n \"update\": {\n \"segment\": \"fixed segment\",\n \"domains\": [\n \"twodomain.com\"\n ]\n }\n }\n ]\n \n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/companies/batch"},"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":"4"},{"key":"Date","value":"Fri, 19 May 2023 08:32:21 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684485141335370827"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"null"}],"_postman_id":"6b720bf9-a349-46ff-9806-734e4ba0c77d"},{"name":"Remove persons from company batch","id":"6a8b90d9-98da-43fc-8203-7db342a3ed10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"people\": [\n {\n \"query\": {\n \"phone\": \"46705774377\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/companies/persons","description":"

Use this method to remove persons from a company.

Request rate limit

5 requests / second (per account)

Query parameters

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

Parameter	Type	Description
id	integer	Example: id=61451351 ID of company you want to remove persons from.
name	string	Example: name=VHD Name of company you want to remove persons from.
domain	string	stringExample: domain=www.example.com Domain of company you want to remove persons from.

Request body schema

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

Parameter	Type	Description
people [{ query { property name } }]	array of objects object object	List 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

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","companies","persons"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"699abae6-ef2a-4776-b48b-808bb1a64c63","name":"Remove persons from company batch","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"people\": [\n {\n \"query\": {\n \"phone\": \"4670123456\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/2/companies/persons?id=6","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","2","companies","persons"],"query":[{"key":"id","value":"6"}]}},"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":"0"},{"key":"Date","value":"Fri, 19 May 2023 09:26:00 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684488360749616227"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"6a8b90d9-98da-43fc-8203-7db342a3ed10"},{"name":"Add persons to company batch","id":"7877701c-4999-4fd3-aba0-4e181d14ca0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"people\": [\n {\n \"query\": {\n \"phone\": \"46705774377\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/companies/persons","description":"

Use this method to add persons to a company.

Request rate limit

5 requests / second (per account)

Query parameters

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

Parameter	Type	Description
id	integer	Example: id=61451351 ID of company you want to remove persons from.
name	string	Example: name=VHD Name of company you want to remove persons from.
domain	string	stringExample: domain=www.example.com Domain of company you want to remove persons from.

Request body schema

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

Parameter	Type	Description
people [{ query { property name } }]	array of objects object object	List 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

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","companies","persons"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"461a3238-9d26-4a1f-861f-7d9775dd3c2a","name":"Add persons to company batch","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"people\": [\n {\n \"query\": {\n \"phone\": \"4670123456\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/2/companies/persons?id=6","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","2","companies","persons"],"query":[{"key":"id","value":"6"}]}},"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":"0"},{"key":"Date","value":"Fri, 19 May 2023 09:21:08 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684488068782108228"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"7877701c-4999-4fd3-aba0-4e181d14ca0e"}],"id":"d90e4b20-f6cc-4dd2-9705-826c2017fd99","description":"

GET Get a single company or a list of companies

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.

POST Create a new company

Use this method to create a new company.

DEL Delete a company

Use this method with a query parameter to delete a company. Exactly one of the query parameters must be included in the query.

PATCH Partial company update

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.

POST Batch companies create

Use this method to create multiple companies.
NOTE Array size of the batch create request is limited to 1000 companies.

DEL Batch companies delete

Use this method to delete multiple companies.
NOTE Array size of the batch delete request is limited to 1000 companies.

PATCH Batch companies update

Use this method to update multiple companies.
NOTE Array size of the batch update request is limited to 1000 companies.

DEL Remove persons from company batch

Use this method to remove persons from a company.

PATCH Add persons to company batch

Use this method to add persons to a company.

\n","_postman_id":"d90e4b20-f6cc-4dd2-9705-826c2017fd99"},{"name":"TAGS","item":[{"name":"Get list of tags","id":"78cbe501-ad1d-4395-bd3f-058857e4b810","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://go2.vhdmedia.se/people/2/tags","description":"

Use this method to get a list of tags with pagination.

Request rate limit

5 requests / second (per account)

Query parameters

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

Parameter	Type	Description
limit	integer	Example: limit=100
page	integer	Example: page=1
orderBy	string	Example: orderBy=name:asc
includeTotalCount	boolean	Example: includeTotalCount=false

Response

Array [

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

Parameter	Type	Description
createsAt	string	Date and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.
modifiedAt	string	Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.
name	string	Tag name, 256 characters max

]

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","tags"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"94b786d8-0c1d-4510-8701-823160088bea","name":"Get list of tags","originalRequest":{"method":"GET","header":[],"url":"https://go2.vhdmedia.se/people/2/tags"},"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":"416"},{"key":"Date","value":"Fri, 19 May 2023 14:51:54 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684507914569741227"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 100,\n \"page\": 1,\n \"orderBy\": \"name:asc, id:asc\",\n \"tags\": [\n {\n \"createdAt\": \"2023-05-17T12:10:04\",\n \"modifiedAt\": \"2023-05-17T12:10:04\",\n \"name\": \"New Customers\"\n },\n {\n \"createdAt\": \"2023-05-16T11:33:06\",\n \"modifiedAt\": \"2023-05-16T11:33:06\",\n \"name\": \"SOS\"\n },\n {\n \"createdAt\": \"2023-05-17T12:10:04\",\n \"modifiedAt\": \"2023-05-17T12:10:04\",\n \"name\": \"VIP Customers\"\n },\n {\n \"createdAt\": \"2023-05-19T14:51:42\",\n \"modifiedAt\": \"2023-05-19T14:51:42\",\n \"name\": \"Vip\"\n }\n ]\n}"}],"_postman_id":"78cbe501-ad1d-4395-bd3f-058857e4b810"},{"name":"Create a new tag","id":"2a6c3458-5b46-4c32-b078-76f8c42ada06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/tags","description":"

Use this method to create a new tag.

Request rate limit

5 requests/second (per account)

Request body schema

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

Parameter	Type	Description
name	string	Tag name, 256 characters max

Responses

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

Parameter	Type	Description
createdAt	string	Date and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.
modieifedAt	string	Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss
name	string	Tag name, 256 characters max

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description

","urlObject":{"protocol":"https","path":["people","2","tags"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"83f185d8-3bfb-45fe-953b-9c1d92330608","name":"Create a new tag","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Vip\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/tags"},"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":"83"},{"key":"Date","value":"Fri, 19 May 2023 14:51:41 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684507902176481828"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2023-05-19T14:51:42\",\n \"modifiedAt\": \"2023-05-19T14:51:42\",\n \"name\": \"Vip\"\n}"}],"_postman_id":"2a6c3458-5b46-4c32-b078-76f8c42ada06"},{"name":"Get a tag","id":"5745ed65-d309-409c-aac8-e90484e5f04d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://go2.vhdmedia.se/people/2/tags/{{name}}","description":"

Use this method to get a single tag.

Request rate limit

5 requests / second (per account)

Path parameters

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

Parameter	Type	Description
name	string	Required. Example: name=Vip Name of the tag.

Response

Array [

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

Parameter	Type	Description
createsAt	string	Date and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.
modifiedAt	string	Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.
name	string	Tag name, 256 characters max

]

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","tags","{{name}}"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"9e248514-f113-4e2c-96f4-7186cdaa4d3c","name":"Get a tag","originalRequest":{"method":"GET","header":[],"url":"https://go2.vhdmedia.se/people/2/tags/{{name}}"},"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":"83"},{"key":"Date","value":"Fri, 19 May 2023 14:54:06 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684508046606325830"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2023-05-19T14:51:42\",\n \"modifiedAt\": \"2023-05-19T14:51:42\",\n \"name\": \"Vip\"\n}"}],"_postman_id":"5745ed65-d309-409c-aac8-e90484e5f04d"},{"name":"Delete a tag","id":"bd17f5e9-91d6-4864-b96c-9912390fe3bb","protocolProfileBehavior":{"disableBodyPruning":true},"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/tags/{{name}}","description":"

Use this method to delete the existing tag.

Request rate limit

5 requests / second (per account)

Path parameters

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

Parameter	Type	Description
name	string	Example: name=Vip Name of the tag.

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description

","urlObject":{"protocol":"https","path":["people","2","tags","{{name}}"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"488372c6-a105-4eb5-996e-c72984f48a3b","name":"Delete a tag","originalRequest":{"method":"DELETE","header":[],"url":"https://go2.vhdmedia.se/people/2/tags/{{name}}"},"status":"No Content","code":204,"_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":"Date","value":"Fri, 19 May 2023 15:00:54 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684508455287899837"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"bd17f5e9-91d6-4864-b96c-9912390fe3bb"},{"name":"Remove tag from people batch","id":"ae1c70bb-cae1-49e0-99d6-d8d87ff3d8ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/tags/{{name}}/persons","description":"

This method allows you to remove tags from multiple people.
NOTE Array size of the batch remove request is limited to 1000 people.

Request rate limit

5 requests / second (per account)

Path parameters

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

Parameter	Type	Description
name	string	Required. Example: name=Vip Name of the tag.

Request body schema

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

Parameter	Type	Description
people [{ query { property name } }]	array of objects object object	List of person profiles. Maximum 1000 entries Query for single person. Example: \"email\": \"janesmith@example.com\"

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","tags","{{name}}","persons"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"b2db006e-55df-4ead-b4db-bc3dbc75b76c","name":"Remove tag from people batch","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"people\": [\n {\n \"query\": {\n \"email\": \"johndoe@wxample.com\"\n }\n },{\n \"query\": {\n \"email\": \"janesm@example.com\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/tags/{{name}}/persons"},"status":"No Content","code":204,"_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":"Date","value":"Fri, 19 May 2023 15:43:53 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684511034436912827"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"ae1c70bb-cae1-49e0-99d6-d8d87ff3d8ab"},{"name":"Add tag to people batch","id":"7899a1f4-aa6f-4535-8fb7-91a412058f92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/tags/{{name}}/persons","description":"

This method allows you to assign tag to multiple people.
NOTE Array size of the batch add request is limited to 1000 people.

Request rate limit

5 requests / second (per account)

Path parameters

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

Parameter	Type	Description
name	string	Required. Example: name=Vip Name of the tag.

Request body schema

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

Parameter	Type	Description
people [{ query { property name } }]	array of objects object object	List of person profiles. Maximum 1000 entries Query for single person. Example: \"email\": \"janesmith@example.com\"

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","tags","{{name}}","persons"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"2de2c31c-57ca-4c6f-ba81-8f366f811dca","name":"Add tag to people batch","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"people\": [\n {\n \"query\": {\n \"email\": \"johndoe@example.com\"\n }\n },{\n \"query\": {\n \"email\": \"janesm@example.com\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/tags/ShoppingCartList/persons"},"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":"0"},{"key":"Date","value":"Fri, 19 May 2023 15:43:05 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684510985545918829"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"7899a1f4-aa6f-4535-8fb7-91a412058f92"}],"id":"ff18ce33-19a5-4347-b8ff-83f102a22778","_postman_id":"ff18ce33-19a5-4347-b8ff-83f102a22778","description":""},{"name":"CUSTOM ATTRIBUTES","item":[{"name":"Create a custom attribute","id":"5d67ad97-69a3-40ed-9c2a-ae7e03f23ee4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Contract Expiry Date\",\n \"dataType\": \"DATE\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/customAttributes","description":"

Create a new custom attribute by using this method.

Request rate limit

5 requests / second (per account)

Request body schema

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

Parameter	Type	Description
dataType	string	Enum: \"STRING\" \"DECIMAL\" \"INTEGER\" \"BOOLEAN\" \"DATE\" \"DATE_TIME\" \"LIST_OF_OBJECTS\" Custom attribute type.
name	string	Custom attribute name, 256 characters max. Invalid characters: {}[].
objectSchema { property name }	object string	Object schema for LIST_OF_OBJECTS type. Defines the shape of the list items. Enum: \"STRING\" \"DECIMAL\" \"INTEGER\" \"BOOLEAN\" \"DATE\" \"DATE_TIME\" \"LIST_OF_OBJECTS\"

Responses

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

Parameter	Type	Description
createdAt dataType modifiedAt name objectSchema { property name }	string string string string object string	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\"

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","customAttributes"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"a69d226e-12b3-4459-a8ac-6c1d91db8c29","name":"Create a custom attribute LIst of Objects","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"name\": \"ShoppingCartList\",\n\"dataType\": \"LIST_OF_OBJECTS\",\n\"objectSchema\" : \n {\n\n\"productName\": \"STRING\",\n\"productPrice\": \"DECIMAL\",\n\"productCategory\": \"STRING\",\n\"productImage\": \"STRING\"\n }\n\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/customAttributes"},"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":"257"},{"key":"Date","value":"Mon, 08 May 2023 14:09:08 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1683554948651075836"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2023-05-08T14:09:08\",\n \"modifiedAt\": \"2023-05-08T14:09:08\",\n \"name\": \"ShoppingCartList\",\n \"dataType\": \"LIST_OF_OBJECTS\",\n \"objectSchema\": {\n \"productName\": \"STRING\",\n \"productPrice\": \"DECIMAL\",\n \"productCategory\": \"STRING\",\n \"productImage\": \"STRING\",\n \"__id\": \"STRING\"\n }\n}"},{"id":"524a57de-ec28-4f54-9d31-85be4ee32044","name":"Create a custom attribute","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Contract Expiry Date\",\n \"dataType\": \"DATE\"\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/people/2/customAttributes"},"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":"118"},{"key":"Date","value":"Mon, 08 May 2023 15:03:46 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1683558227064967835"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2023-05-08T15:03:47\",\n \"modifiedAt\": \"2023-05-08T15:03:47\",\n \"name\": \"Contract Expiry Date\",\n \"dataType\": \"DATE\"\n}"}],"_postman_id":"5d67ad97-69a3-40ed-9c2a-ae7e03f23ee4"},{"name":"Get a list of custom attributes","id":"ff9c46a1-0493-499a-9b17-e2a626edd26e","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/people/2/customAttributes","description":"

Get a list of custom attributes using this method.

Request rate limit

5 requests / second (per account)

Query parameters

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

Parameter	Type	Description
limit	integer	Example: limit=100 Limit how many rows will be returned (but possibly less, if the query itself yields fewer rows).
page	integer	Example: 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
includeTotalCount	boolean	Example: includeTotalCount=false Will return total count of custom attributes if set to true.
orderBy	string	Example: 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.

Responses

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

Parameter	Type	Description
customAttributes [{ createdAt dataType modifiedAt name objectSchema { property name } }] limit orderBy page totalCount	array of objects string string string string object string integer string integer integer	List 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

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

Use this method to delete the custom attribute.

Request rate limit

5 requests / second (per account)

Path parameters

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

Parameter	Type	Description
name	string	Required Example: Attribute Name of the attribute you want to delete.

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","customAttributes","{{name}}"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"e203e5e1-bc36-42f5-a831-93bb7164e006","name":"Delete a custom attribute","originalRequest":{"method":"DELETE","header":[],"url":"https://go2.vhdmedia.se/people/2/customAttributes/Contract Expiry Date"},"status":"No Content","code":204,"_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":"Date","value":"Mon, 08 May 2023 15:03:27 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1683558207797660836"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"1357d2af-64d4-41b7-bd5e-39ff652b6e30"},{"name":"Get a single custom attribute","id":"a9367df4-7acf-44bf-ad3a-2d053eb4a2c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://go2.vhdmedia.se/people/2/customAttributes/{{name}}","description":"

Get a single custom attribute using this method.

Request rate limit

5 requests / second (per account)

Query parameters

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

Parameter	Type	Description
name	string	Required Example: Attribute Name of the attribute you want to delete.

Error responses

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

Parameter	Type	Description
requestError	object
serviceException	object
messageId	string	Identifier of the error
text	string	Detailed error description.

","urlObject":{"protocol":"https","path":["people","2","customAttributes","{{name}}"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"8534f007-8507-4a4a-9a87-c47f2c1f4294","name":"Get a single custom attribute","originalRequest":{"method":"GET","header":[],"url":"https://go2.vhdmedia.se/people/2/customAttributes/{{name}}"},"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":"118"},{"key":"Date","value":"Sat, 20 May 2023 09:30:06 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684575006706644836"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2023-05-20T09:29:53\",\n \"modifiedAt\": \"2023-05-20T09:29:53\",\n \"name\": \"Contract Expiry Date\",\n \"dataType\": \"DATE\"\n}"}],"_postman_id":"a9367df4-7acf-44bf-ad3a-2d053eb4a2c2"},{"name":"Append item to custom attribute","id":"db21e35d-36b9-4a6b-83ed-3b19ee7c415f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://go2.vhdmedia.se/people/2/customAttributes/{{name}}/append","description":"

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.

Request rate limit

5 requests / second (per account)

Path parameters

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

Parameter	Type	Description
name	string	Required Example: Attribute Name of the attribute you want to delete.

Query parameters

Parameter	Type	Description
phone	string	Example: phone=46701234567 Person’s phone number. Phone numbers must be in international format.
email	string	Example: 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.
externalId	string	Example: externalId=6F9619FF-8B86-D011-B42D-00CF4FC964FF Unique ID for a person from your or another external system.
pushRegistrationId	string	Example: pushRegistrationId=6F9619FF-8B86-D011-B42D-00CF4FC964FF Person's push registration ID.
id	ineger	Example: id=11351351 Person's internal ID.
lineId	string	Example: lineId=U045147f1ad961bfe996b72bbf417f3c9 Person’s Line ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameters.
lineSenderId	string	Example: lineSenderId=1644264921 Person’s Line sender ID. To get person by Line OTT channel, you need to specify both lineId and lineSenderId parameter
facebookId	string	Example: facebookId=370329180020364 Person’s Facebook ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters.
facebookSenderId	integer	Example: facebookSenderId=2094832040560427 Person’s Facebook sender ID. To get person by Facebook OTT channel, you need to specify both facebookId and facebookSenderId parameters.
telegramUserId	string	Example: telegramUserId=1303201999 Person’s Telegram user ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters.
telegramBotId	string	Example: telegramBotId=1495032701 Person’s Telegram bot ID. To get person by Telegram OTT channel, you need to specify both telegramUserId and telegramBotId parameters.
viberBotUserId	string	Example: 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.
viberBotId	integer	Example: viberBotId=5591458813882487336 Person’s Viber Bot ID. To get person by Viber Bot OTT channel, you need to specify both viberBotUserId and viberBotId parameters.
instagramId	string	Example: instagramId=17841546155331428 Person’s Instagram user ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters.
instagramSenderId	integer	Example: instagramSenderId=17841405793187218 Person’s Instagram sender ID. To get person by Instagram channel, you need to specify both instagramId and instagramSenderId parameters.
twitterId	string	example: twitterId=370329180020364 Person’s Twitter user ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters.
twitterSenderId	integer	Example: twitterSenderId=10765432100123456789 Person’s Twitter sender ID. To get person by Twitter channel, you need to specify both twitterId and twitterSenderId parameters.
appleBusinessChatId	string	Example: 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.
appleBusinessChatSenderId	string	Example: 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.
liveChatRegId	string	Example: liveChatRegId=79f9701b-e350-4497-9689-b2257864e63f

","urlObject":{"protocol":"https","path":["people","2","customAttributes","{{name}}","append"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"2d7ea1ed-9d7d-4bb8-9b4c-13dfdda44e96","name":"Append item to custom attribute","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"productName\": \"Cap\",\n\"productPrice\": 11.33,\n\"productCategory\": \"Hats\",\n\"productImage\": \"/image3.png\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://go2.vhdmedia.se/people/2/customAttributes/{{name}}/append?email=janewilliams@vhdmeida.com","protocol":"https","host":["go2","vhdmedia","se"],"path":["people","2","customAttributes","{{name}}","append"],"query":[{"key":"email","value":"janewilliams@vhdmeida.com"}]}},"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":"451"},{"key":"Date","value":"Mon, 22 May 2023 14:05:48 GMT"},{"key":"Server","value":"SMS API"},{"key":"X-Request-Id","value":"1684764348099376162"},{"key":"connection","value":"close"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload;"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"__id\": \"6fc50081-3832-4630-8d5e-c2d2b3e581ac\",\n \"productCategory\": \"Sport Sneakers\",\n \"productImage\": \"/image1.png\",\n \"productName\": \"Sneakers\",\n \"productPrice\": 20.33\n },\n {\n \"__id\": \"f03121ae-5485-40e1-9849-cf1dfaedfb6e\",\n \"productCategory\": \"Casual\",\n \"productImage\": \"/image2.png\",\n \"productName\": \"T-Shirt\",\n \"productPrice\": 10.99\n },\n {\n \"__id\": \"f6010d0b-f5d1-4d69-9b6e-c081dac98b86\",\n \"productCategory\": \"Hats\",\n \"productImage\": \"/image3.png\",\n \"productName\": \"Cap\",\n \"productPrice\": 11.33\n }\n]"}],"_postman_id":"db21e35d-36b9-4a6b-83ed-3b19ee7c415f"}],"id":"29897cf3-9be9-46d8-b49b-cc8bb8cd6ee5","_postman_id":"29897cf3-9be9-46d8-b49b-cc8bb8cd6ee5","description":""}],"id":"7e2b4f6f-79ca-452d-a385-e67937d20d64","description":"

Build rich profiles for each person to create audience segments for more precise targeting. Manage duplicates and import your data over API.

Events reflect actions that end users take on your website or in your mobile application.

Events 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","_postman_id":"7e2b4f6f-79ca-452d-a385-e67937d20d64"},{"name":"BLOCKLIST","item":[{"name":"Get all blocklists","event":[{"listen":"test","script":{"id":"828e14d8-ee19-47a8-b5be-d6a5acce07f1","exec":["","pm.test(\"Response status code is 200\", function () {"," pm.expect(pm.response.code).to.equal(200);","});","","","pm.test(\"Content-Type is application/json\", function () {"," pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");","});","","","pm.test(\"Paging object is present in the response\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.paging).to.exist;","});","","","","",""],"type":"text/javascript","packages":{}}}],"id":"8c893afc-2500-4213-aa16-97bef7e68632","protocolProfileBehavior":{"disableBodyPruning":true},"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":"

This method allows you to get all blocklist records or filter them based on specific parameters.

AUTHORIZATIONS:

API Key HeaderBasicIBSSO Token HeaderOAuth 2

REQUEST RATE LIMIT:

1 requests / second (per account)

QUERY PARAMETERS

Request body schema

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

Parameter	Type	Description
sender	string [ 1 .. 255 ] characters	Example: sender=10950 The sender ID for which blocklist happened.
destination	string [ 1 .. 255 ] characters	Example: destination=46700000000 Blocklisted destination address.
channel	string \"SMS\" \"EMAIL\"	Channel used for sending for which blocklist happened. If you want to check blocklist records for all channels, this field can be left out.
sourceType	string Enum: \"CUSTOM\" \"MO\" \"URL_OPT_OUT\" \"CAMPAIGN\"	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_OPTOUT - 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).
accountKey	string	Example: accountKey=8F0792F86035A9F4290821F1EE6BC06A 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.
getAllAccountKeysBlocklists	boolean	Example: getAllAccountKeysBlocklists=false If set to true, blocklist records for subaccounts will be returned as well.
createdDateFrom	string	Example: createdDateFrom=2022-08-18T12:33:42.123Z Use with createDateTo to search for blocklists for a particular date range.
createdDateTo	string	Example: createdDateTo=2022-08-18T13:33:42.123Z Use with createDateFrom to search for blocklists for a particular date range.
page	integer >= 0	Default: 0 Example: page=0 Requested page number.
size	integer [ 1 .. 1000 ]	Default: 100 Example: size=10 Requested page size.

Response format

200 OK

{\n    \"results\": [\n        {\n            \"sender\": \"The sender ID for which blocklist happened.\",\n            \"destination\": \"Blocklisted destination address.\",\n            \"sourceType\": \"Represents the way blocklist record was create\",\n            \"channel\": \"Channel used for sending for which blocklist happened.\",\n            \"accountKey\": \"Account connected with a blocklist record.\",\n            \"createdDate\": \"Timestamp of created blocklist record.\"\n\"\n        },\n    \"paging\": {\n        \"page\": \"Requested page number.\",\n        \"size\": \"Requested page size.\"\n        \"totalPages\": \"Total pages.\",\n        \"totalResults\": \"Total results.\"\n    }\n}\n\n

This method allows you to add someone to blocklist. It accepts create request with blocklists and asynchronously saves them, leaving out duplicate entries.

AUTHORIZATIONS:

API Key HeaderBasicIBSSO Token HeaderOAuth 2

REQUEST RATE LIMIT:

1 requests / second (per account)

Request body schema

{

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

Parameter	Type	Description
blocklist	Array of objects	Required Blocklist elements that need to be blocklisted. Number of destinations cannot exceed 50 000.

Array [

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

Parameter	Type	Description
destinations Array [ to ]	Array of objects string [ 1 .. 255 ] characters	Required Destination addresses that need to be blocklisted. Required Destination address that needs to be blocklisted. Addresses must be a number in international format (example: 41793026727) or a valid email address (example: recipient@example.com).

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

Parameter	Type	Description
sender	Array of objects	Required The sender ID for which blocklist happened.
channel	string	Enum: \"MMS\" \"SMS\" \"VIBER\" \"RCS\" \"EMAIL\" Channel used for sending for which blocklist happened.
accountKey	string	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.

]

}

Response format

202 Accepted

\n","urlObject":{"protocol":"https","path":["platform","1","blocklists"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"fdfd51ea-22bf-4b76-a497-89c2087ff2da","name":"Create blocklists SMS","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"blocklist\": [\n {\n\n \"destinations\": [\n {\n \"to\": \"4670123456\"\n },\n {\n \"to\": \"4670123457\"\n }\n ],\n \"channel\": \"SMS\",\n \"accountKey\": \"90D1D1EB0272BE71B1C7924926E33F0A\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/platform/1/blocklists"},"status":"Accepted","code":202,"_postman_previewlanguage":"plain","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:01:43 GMT"},{"key":"content-length","value":"0"},{"key":"server","value":"SMS API"},{"key":"x-request-id","value":"1706716903712503228"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":null},{"id":"f7a0ee84-6ec5-41d3-8081-73a91d1034ec","name":"Create blocklists Email","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"blocklist\": [\n {\n \"sender\": \"admin@example.com\",\n \"destinations\": [\n {\n \"to\": \"pete.doe@example.com\"\n },\n {\n \"to\": \"mark.doe@example.com\"\n }\n ],\n \"channel\": \"EMAIL\",\n \"accountKey\": \"90D1D1EB0272BE71B1C7924926E33F0A\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/platform/1/blocklists"},"status":"Accepted","code":202,"_postman_previewlanguage":"plain","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 15:48:40 GMT"},{"key":"content-length","value":"0"},{"key":"server","value":"SMS API"},{"key":"x-request-id","value":"1706716120334137162"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":null},{"id":"56f562d8-4a9a-4752-a942-d9e4f56204d0","name":"400 Bad Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/platform/1/blocklists"},"status":"Bad Request","code":400,"_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 07:26:16 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":"1706685976599586663"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"BAD_REQUEST\",\n \"text\": \"Bad request\",\n \"validationErrors\": {\n \"blocklist[0].destinations[0].to\": [\n \"size must be between 1 and 255\",\n \"unsupported to (must be valid numeric without leading zeros or valid email address)\"\n ],\n \"blocklist[0].destinations[1].to\": [\n \"unsupported to (must be valid numeric without leading zeros or valid email address)\",\n \"size must be between 1 and 255\"\n ],\n \"blocklist[1].sender\": [\n \"size must be between 1 and 255\"\n ]\n }\n }\n }\n}"},{"id":"1cdb909e-7796-446f-9062-53bacc7b4a97","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/platform/1/blocklists"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"vary","value":"Access-Control-Request-Method"},{"key":"vary","value":"Access-Control-Request-Headers"},{"key":"server","value":"SMS API"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"97"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"UNAUTHORIZED\",\n \"text\": \"Invalid login details\"\n }\n }\n}"},{"id":"8e633619-b4d5-4a95-9188-bcf2d290c5c2","name":"429 Too Many Requests","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/platform/1/blocklists"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"vary","value":"Access-Control-Request-Method"},{"key":"vary","value":"Access-Control-Request-Headers"},{"key":"server","value":"SMS API"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"97"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"requestError\": {\n \"serviceException\": {\n \"messageId\": \"TOO_MANY_REQUESTS\",\n \"text\": \"Too many requests\"\n }\n }\n}"},{"id":"2cf0e6b5-fe14-4edf-9b3b-00e9473d9533","name":"500 Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://go2.vhdmedia.se/platform/1/blocklists"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"vary","value":"Access-Control-Request-Method"},{"key":"vary","value":"Access-Control-Request-Headers"},{"key":"server","value":"SMS API"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"97"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload;"},{"key":"connection","value":"close"}],"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":"c3c69cb3-a418-4652-ba07-c40849a6a673"},{"name":"Delete Blocklist","id":"fc3b90c0-4279-434d-92d5-18d2b7dc1ada","protocolProfileBehavior":{"disableBodyPruning":true},"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 {\n\n \"destinations\": [\n {\n \"to\": \"4670123456\"\n },\n {\n \"to\": \"4670123457\"\n }\n ],\n \"channel\": \"SMS\",\n \"accountKey\": \"90D1D1EB0272BE71B1C7924926E33F0A\",\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 someone from blocklist. It accepts delete request and asynchronously deletes all blocklists that match given properties.

Note: To delete a blocklist, you must list all properties that were defined in the create request. For example, to delete the blocklist with the following properties:

{\"sender\": \"10950\", \"destination\": \"12022921990\", \"sourceType\": \"CUSTOM\", \"channel\": \"SMS\", \"createdDate\": \"2022-08-18T12:36:42.123Z\"}

The delete request must contain all present properties, like this:

{\"blocklist\": [{\"destinations\": [{\"to\": \"12022921990\"}], \"sender\": \"10950\", \"channel\": \"SMS\", \"sourceType\": \"CUSTOM\"}.

Only when all properties are listed will the blocklist be removed.

AUTHORIZATIONS:

API Key Header BasicIBSSO Token Header OAuth 2

REQUEST RATE LIMIT:

1 requests / second (per account)

Request body schema

{

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

Parameter	Type	Description
blocklist	Array of objects	Required Blocklist elements that need to be removed from blocklist. Number of destinations cannot exceed 50 000.

Array [

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

Parameter	Type	Description
destinations Array [ to ]	Array of objects string [ 1 .. 255 ] characters	Required Destination addresses that need to be removed from blocklist. Required Destination address that needs to be removed from blocklist. Addresses must be a number in international format (example: 41793026727) or a valid email address (example: recipient@example.com).

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

Parameter	Type	Description
sender	Array of objects	Required The sender ID that needs to be removed from blocklist. Sender can be alphanumeric or numeric.
channel	string	Enum: \"MMS\" \"SMS\" \"VIBER\" \"RCS\" \"EMAIL\" Channel for which blocklist record/s will be removed..
accountKey	string	Account 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.
sourceType	string	Enum: \"CUSTOM\" \"MO\" \"URL_OPT_OUT\" \"CAMPAIGN\" 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_OPTOUT - 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.

]

}

Response format

202 Accepted

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)

This platform feature is used to make sure that no communication is sent to recipients who have opted out of your communication campaigns.

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

\n","_postman_id":"46a810bc-3452-41ec-8844-af6a496ac282"},{"name":"ACCOUNTS","item":[{"name":"Get current accounts","event":[{"listen":"test","script":{"id":"24bbc632-e82d-4d52-9cc3-9363d55ae25a","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":"f03dd94a-4adf-4c60-824e-b110d5978f81","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":"

This method allows you to get the current authenticated account.

AUTHORIZATIONS:

\n","urlObject":{"protocol":"https","path":["settings","1","accounts","_"],"host":["go2","vhdmedia","se"],"query":[],"variable":[]}},"response":[{"id":"df7ec656-89ae-44ea-8ef7-b7243036488e","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":"f03dd94a-4adf-4c60-824e-b110d5978f81"}],"id":"548d2de6-5543-4c6c-9bab-ca02d1922807","description":"

Manage your VHD account details

\n","_postman_id":"548d2de6-5543-4c6c-9bab-ca02d1922807"},{"name":"SMPP SPECIFICATION","item":[],"id":"6b915017-6a01-4dcc-9d4b-0a9ffdf450d1","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).

The connection between the application and the VHD SMPP server is SMPP version 3.4 (versions 3.3 and 5.0 are not supported).

Supported SMPP Features

Bind Parameters

NOTE

If 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Mandatory	Description
system_id	Yes	Provided for each client.
password	Yes	Provided for each client.
IP address	Yes	Contact support@vhdmedia.se.
port	Yes	8888 (primary and secondary) 8887 (SSL)
timeout (keep alive or msg)	Yes	30 sec
system_type	No

IMPORTANT

You are allowed to bind as a transmitter, receiver or a transceiver. To receive delivery reports, you must bind as a transceiver or a receiver.

You’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).

By default, you are allowed to bind with 4 sessions. There is no other throughput (TPS) limitations besides internet speed.

PDU Types

bind_transmitter
bind_receiver
bind_transceiver
unbind
submit_sm
deliver_sm
enquire_link

Data Coding Schemes

Setting DCS to 0 or 1 will apply the IA5 / GSM7 coding scheme to the message (GSM7 being the default VHD SMSC alphabet).

Set DCS = 3 for Latin1 (ISO-8859-1), and DCS = 8 for sending messages as Unicode / UCS-2 (ISO/IEC-10646).

Scheduled Delivery

Scheduled delivery is supported over the SMPP protocol using relative time format.

070605040302100R

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

Command Status

Each 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

command_status	PDU	Description
0x0000000E	bind_resp	Invalid credentials
0x00000022 / 34	submit_sm_resp	Network not covered
0x000000FF / 255	submit_sm_resp	Account has insufficient balance
0x0000000a	submit_sm_resp	Invalid source address
0x0000000b	submit_sm_resp	Invalid destination address
0x0000000c	submit_sm_resp	Duplicate or invalid messageID
0x000004a1	submit_sm_resp	System error or channel disabled
0x0000009F	submit_sm_resp	Invalid optional parameter length

Delivery Report Format

Delivery report in this format will be returned in short message field of deliver_sm PDU:

id:{message_id} sub:{message_sub} dlvrd:{message_dlvrd}

submit date:{message_submit_date} done date:{message_done_date}

stat:{message_stat} err:{message_err}

Delivery Statuses

DELIVRD
EXPIRED
UNDELIV
ACCEPTD
UNKNOWN
ENROUTE
REJECTD

GSM Error Codes

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

Possible error codes.

\n","_postman_id":"6b915017-6a01-4dcc-9d4b-0a9ffdf450d1"},{"name":"RESPONSE STATUS AND ERROR CODES","item":[{"name":"Email status codes","item":[],"id":"8af0169b-95e4-49fe-8b17-5a35e5540428","description":"

REJECTED (group id: 5) - Email status codes

The 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ID	Status
75	`REJECTED_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.
88	`REJECTED_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.
89	`REJECTED_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.
90	`REJECTED_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.

","_postman_id":"8af0169b-95e4-49fe-8b17-5a35e5540428"},{"name":"HTTP status code","item":[],"id":"76c2475f-4276-49c3-9761-20c2804d9d77","description":"

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.

Check out the list of the HTTP status codes to learn more.

\n","_postman_id":"76c2475f-4276-49c3-9761-20c2804d9d77"},{"name":"API status code","item":[],"id":"4a44e247-b4b5-4c7e-a5b9-1e162ad42f1e","description":"

Besides standard HTTP status code, status object may be returned as part of the API response message, delivery report or message log.

Status object example:

JSON

{  \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":"4a44e247-b4b5-4c7e-a5b9-1e162ad42f1e"},{"name":"GENERAL status code","item":[],"id":"3d436a03-85b8-4fd5-8208-0106cb7dcca0","description":"

PENDING (group id: 1) - general status codes

Message has been processed and sent to the next instance i.e. mobile operator.

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

Id	Status
3	`PENDING_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.
7	`PENDING_ENROUTE` - Message has been processed and sent to the next instance i.e. mobile operator.
26	`PENDING_ACCEPTED` - Message has been accepted and processed, and is ready to be sent to the next instance i.e. operator.

UNDELIVERABLE (group id: 2) - general status codes

Message has not been delivered.

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

Id	Status
4	`UNDELIVERABLE_REJECTED_OPERATOR` - Message has been sent to the operator, whereas the request was rejected, or a delivery report with status \"REJECTED\" was reverted.
9	`UNDELIVERABLE_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.

DELIVERED (group id: 3) - general status codes

Message has successfully been processed and delivered.

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

Id	Status
2	`DELIVERED_TO_OPERATOR` - Message has been successfully sent and delivered to the operator.
5	`DELIVERED_TO_HANDSET` - Message has been successfully processed and delivered to recipient.

EXPIRED (group id: 4) - general status codes

Message 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\n\n\n\n\n\n\n\n\n\n\n\n\n

Id	Status
15	`EXPIRED_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.
29	`EXPIRED_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.

REJECTED (group id: 5) - general status codes

Message has been received, but has either been rejected by our system, or the operator has reverted Rejected as final status.

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

ID	Status
6	`REJECTED_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.
8	`REJECTED_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.
10	`REJECTED_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.
11	`REJECTED_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.
12	`REJECTED_NOT_ENOUGH_CREDITS` Your account is out of credits for further submission. Top up your account.
13	`REJECTED_SENDER` The sender ID has been blocklisted on your account. Remove the blocklist on your account or contact support for further assistance.
14	`REJECTED_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.
17	`REJECTED_PREPAID_PACKAGE_EXPIRED` Account credits are past their validity period. Top up your sub-account with credits to extend the validity period.
18	`REJECTED_DESTINATION_NOT_REGISTERED` Your account has been set up for submission only to a single number for testing purposes. Contact your account manager.
19	REJECTED_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.
20	REJECTED_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.
21	`REJECTED_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.
23	`REJECTED_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.
24	`REJECTED_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
25	`REJECTED_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.
51	`MISSING_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.
52	`REJECTED_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.
87	`SIGNALS_BLOCKED` Message has been rejected due to an anti-fraud mechanism. If the message is deemed fraudulent, it will not be charged.
99	`REJECTED` The call was rejected/declined by the end user at the receiving end.
100	`UNDELIVERABLE_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.

","_postman_id":"3d436a03-85b8-4fd5-8208-0106cb7dcca0"},{"name":"VOICE status codes","item":[],"id":"7dd6ad58-ef4a-453a-be9b-95a03d42cb0d","description":"

REJECTED (group id: 5) - voice status codes

Message 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Id	Status
53	`REJECTED_INVALID_AUDIO_FILE_URL` - The URL of audio file is invalid and could not be read properly.
54	`REJECTED_UNSUPPORTED_LANGUAGE` - The language submitted within the request is not supported and request couldn't be processed correctly.
55	`REJECTED_MESSAGE_IS_EMPTY` - Native to Voice services, this status is returned in case there is no text sent in your Voice message request.
56	`REJECTED_INVALID_NOTIFY_URL` - Native to Voice services, this status is returned in case the notifyUrl parameter is not formatter properly. Please revisit the documentation here.
57	`REJECTED_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 on here.
58	`REJECTED_INVALID_DTMF_SIGN` - Defined value for repeating message is invalid and must be positive number.
59	`REJECTED_INVALID_DTMF_TIMEOUT` - Defined value for the waiting period is invalid and must be positive number.
60	`REJECTED_INVALID_RING_TIMEOUT` - Defined value for duration of call is invalid and must be positive number.
61	`REJECTED_INVALID_CALL_TIMEOUT` - Defined value for total period of call is invalid and must be positive number.
62	`REJECTED_INVALID_MACHINE_DETECTION` - The action which attempts to detect answering machines at the beginning of the call is invalid.
63	`REJECTED_INVALID_ACTIONS` - Actions submitted in HTTP API request are invalid.
64	`REJECTED_INVALID_ACTION_GROUPS` - Action groups submitted in HTTP API request are invalid.
83	`REJECTED_MACHINE_DECTION_DISALBED` Machine detection is not enabled. Contact your dedicated Account manager.
87	`REJECTED_INVALID_DELIVERY_TIME_WINDOW` Invalid deliveryTimeWindow. The time gap between from and to cannot be less than 1 hour.
91	`REJECTED_INVALID_SSML` Submitted message text contains invalid SSML.

","_postman_id":"7dd6ad58-ef4a-453a-be9b-95a03d42cb0d"},{"name":"ERROR codes","item":[],"id":"1cc7b1b9-3e5e-4f2c-b6fa-529f69a6066d","description":"

Error object can be returned as part of the send message response or Delivery report response.

Error object example:

JSON

{  \n   \"groupId\":0,\n   \"groupName\":\"OK\",\n   \"id\":0,\n   \"name\":\"NO_ERROR\",\n   \"description\":\"No Error\",\n   \"permanent\":false\n}\n

","_postman_id":"1cc7b1b9-3e5e-4f2c-b6fa-529f69a6066d"},{"name":"GENERAL error codes","item":[],"id":"8b6ff3f5-ec85-4442-b7cd-ba5d8c315fbf","description":"

OK (group id: 0) - general error codes

The request has been completed successfully.

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

ID	Permanent	Error
0	false	`NO_ERROR` - There is no error description provided. Mostly returned for successful delivery, or when error code was not returned by the operator.

HANDSET_ERRORS (group id: 1) - general error codes

The request has not been completed due to handset-related issues.

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

ID	Permanent	Error
1	true	`EC_UNKNOWN_SUBSCRIBER` - The number does not exist or it has not been assigned to any active subscriber in the operator’s user database.
2	false	`EC_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.
5	false	`EC_UNIDENTIFIED_SUBSCRIBER` - Unidentified Subscriber
6	false	`EC_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.
7	false	`EC_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.
8	false	`EC_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.
9	true	`EC_ILLEGAL_SUBSCRIBER` - Illegal Subscriber
11	true	`EC_TELESERVICE_NOT_PROVISIONED` - The subscriber’s mobile service has been suspended by the operator.
12	true	`EC_ILLEGAL_EQUIPMENT` - Illegal Equipment
13	false	`EC_CALL_BARRED` - Message is rejected due to barring of message service; blocking is set by operator or subscriber for the number.
21	false	`EC_FACILITY_NOT_SUPPORTED` - Facility Not Supported
27	false	`EC_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.
31	false	`EC_SUBSCRIBER_BUSY_FOR_MT_SMS` - Subscriber Busy For Mt SMS
32	false	`EC_SM_DELIVERY_FAILURE` - SM Delivery Failure
33	false	`EC_MESSAGE_WAITING_LIST_FULL` - Message Waiting List Full
34	false	`EC_SYSTEM_FAILURE` - System Failure
35	false	`EC_DATA_MISSING` - Data Missing
36	false	`EC_UNEXPECTED_DATA_VALUE` - Unexpected Data Value
255	false	`EC_UNKNOWN_ERROR` - Unknown Error
256	false	`EC_SM_DF_MEMORYCAPACITYEXCEEDED` - There has been a mobile subscriber equipment error whereas the handset memory has been exceeded.
257	false	`EC_SM_DF_EQUIPMENTPROTOCOLERROR` - There has been a mobile subscriber equipment error.
258	false	`EC_SM_DF_EQUIPMENTNOTSM_EQUIPPED` - There has been a mobile subscriber equipment error.
259	false	`EC_SM_DF_UNKNOWNSERVICECENTRE` - There has been a mobile subscriber equipment error.
260	false	`EC_SM_DF_SC_CONGESTION` - There has been a mobile subscriber equipment error.
261	false	`EC_SM_DF_INVALIDSME_ADDRESS` - There has been a mobile subscriber equipment error.
262	false	`EC_SM_DF_SUBSCRIBERNOTSC_SUBSCRIBER` - There has been a mobile subscriber equipment error.
500	false	`EC_PROVIDER_GENERAL_ERROR` - General network protocol error caused by incompatible operator network protocol versions or parameters between two network components.
502	false	`EC_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.
503	false	`EC_SERVICE_COMPLETION_FAILURE` - General network protocol error caused by incompatible operator network protocol versions or parameters between two network components.
504	false	`EC_UNEXPECTED_RESPONSE_FROM_PEER` - General network protocol error caused by incompatible operator network protocol versions or parameters between two network components.
507	false	`EC_MISTYPED_PARAMETER` - General network protocol error caused by incompatible operator network protocol versions or parameters between two network components.
508	false	`EC_NOT_SUPPORTED_SERVICE` - General network protocol error caused by incompatible operator network protocol versions or parameters between two network components.
509	false	`EC_DUPLICATED_INVOKE_ID` - General network protocol error caused by incompatible operator network protocol versions or parameters between two network components.
565	true	`EC_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.
573	true	`EC_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.
581	false	`EC_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.
628	true	`EC_TEMPORARY_HANDSET_FAILURE` - Temporary handset failure.
629	true	`EC_DEST_ADDRESS_UNABLE_TO_RECEIVE_SMS` - Destination address unable to receive SMS.
1024	false	`EC_OR_APPCONTEXTNOTSUPPORTED` - General network protocol error caused by incompatible operator network protocol versions or parameters between two network components.
1025	false	`EC_OR_INVALIDDESTINATIONREFERENCE` - General network protocol error caused by incompatible operator network protocol versions or parameters between two network components.
1026	false	`EC_OR_INVALIDORIGINATINGREFERENCE` - General network protocol error caused by incompatible operator network protocol versions or parameters between two network components.
1027	false	`EC_OR_ENCAPSULATEDAC_NOTSUPPORTED` - General network protocol error caused by incompatible operator network protocol versions or parameters between two network components.
1028	false	`EC_OR_TRANSPORTPROTECTIONNOTADEQUATE` - General network protocol error caused by incompatible operator network protocol versions or parameters between two network components.
1029	false	`EC_OR_NOREASONGIVEN` - General network protocol error caused by incompatible operator network protocol versions or parameters between two network components.
1030	false	`EC_OR_POTENTIALVERSIONINCOMPATIBILITY` - General network protocol error caused by incompatible operator network protocol versions or parameters between two network components.
1031	false	`EC_OR_REMOTENODENOTREACHABLE` - Mobile subscriber was not reachable due to a network operator protocol error.
1152	false	`EC_NNR_NOTRANSLATIONFORANADDRESSOFSUCHNATURE` - Mobile subscriber was not reachable due to a network operator protocol error.
1153	false	`EC_NNR_NOTRANSLATIONFORTHISSPECIFICADDRESS` - No Translation For This Specific Address
1154	false	`EC_NNR_SUBSYSTEMCONGESTION` - Mobile subscriber was not reachable due to a network operator protocol error.
1155	false	`EC_NNR_SUBSYSTEMFAILURE` - Mobile subscriber was not reachable due to a network operator protocol error.
1156	false	`EC_NNR_UNEQUIPPEDUSER` - Mobile subscriber was not reachable due to a network operator protocol error.
1157	false	`EC_NNR_MTPFAILURE` - Mobile subscriber was not reachable due to a network operator protocol error.
1158	false	`EC_NNR_NETWORKCONGESTION` - Mobile subscriber was not reachable due to a network operator protocol error.
1159	false	`EC_NNR_UNQUALIFIED` - Mobile subscriber was not reachable due to a network operator protocol error.
1160	false	`EC_NNR_ERRORINMESSAGETRANSPORTXUDT` - Mobile subscriber was not reachable due to a network operator protocol error.
1161	false	`EC_NNR_ERRORINLOCALPROCESSINGXUDT` - Mobile subscriber was not reachable due to a network operator protocol error.
1162	false	`EC_NNR_DESTINATIONCANNOTPERFORMREASSEMBLYXUDT` - Mobile subscriber was not reachable due to a network operator protocol error.
1163	false	`EC_NNR_SCCPFAILURE` - Mobile subscriber was not reachable due to a network operator protocol error.
1164	false	`EC_NNR_HOPCOUNTERVIOLATION` - Mobile subscriber was not reachable due to a network operator protocol error.
1165	false	`EC_NNR_SEGMENTATIONNOTSUPPORTED` - Mobile subscriber was not reachable due to a network operator protocol error.
1166	false	`EC_NNR_SEGMENTATIONFAILURE` - Mobile subscriber was not reachable due to a network operator protocol error.
1281	false	`EC_UA_USERSPECIFICREASON` - Message was aborted by network peer because of a network protocol error.
1282	false	`EC_UA_USERRESOURCELIMITATION` - Message was aborted by network peer because of a network protocol error.
1283	false	`EC_UA_RESOURCEUNAVAILABLE` - Message was aborted by network peer because of a network protocol error.
1284	false	`EC_UA_APPLICATIONPROCEDURECANCELLATION` - Message was aborted by network peer because of a network protocol error.
1536	false	`EC_PA_PROVIDERMALFUNCTION` - Message was aborted due to other network protocol errors.
1537	false	`EC_PA_SUPPORTINGDIALOGORTRANSACTIONREALEASED` - Message was aborted due to other network protocol errors.
1538	false	`EC_PA_RESSOURCELIMITATION` - Message was aborted due to other network protocol errors.
1539	false	`EC_PA_MAINTENANCEACTIVITY` - Message was aborted due to other network protocol errors.
1540	false	`EC_PA_VERSIONINCOMPATIBILITY` - Message was aborted due to other network protocol errors.
1541	false	`EC_PA_ABNORMALMAPDIALOG` - Message was aborted due to other network protocol errors.
1792	false	`EC_NC_ABNORMALEVENTDETECTEDBYPEER` - Message was aborted due to other network protocol errors.
1793	false	`EC_NC_RESPONSEREJECTEDBYPEER` - Message was aborted due to other network protocol errors.
1794	false	`EC_NC_ABNORMALEVENTRECEIVEDFROMPEER` - Message was aborted due to other network protocol errors.
1795	false	`EC_NC_MESSAGECANNOTBEDELIVEREDTOPEER` - Message was aborted due to other network protocol errors.
1796	false	`EC_NC_PROVIDEROUTOFINVOKE` - Message was aborted due to other network protocol errors.

USER_ERRORS (group id: 2) - general error codes

User error occurred.

ID	Permanent	Error
323	true	`EC_INVALID_REQUEST_TYPE` - The request type was invalid.
351	false	`EC_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.
352	true	`EC_INVALID_REQUEST_DESTINATION` - Invalid request - destination address country code is not recognized.
355	true	`EC_MSG_TEXT_TOO_LONG` - Message text is too long.
368	true	`EC_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.
375	true	`EC_SOURCE_ADDRESS_IS_BLOCKED` - Source address (recipient) is blocked or is not provisioned.
433	true	`EC_ACCOUNT_ACCESS_DENIED` - Account access denied.
488	true	`EC_TF_NUMBER_NOT_VERIFIED` - ''Toll-Free Number Not Veriﬁed'' 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.
541	false	`EC_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.
542	false	`EC_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.
572	true	`EC_CAMPAIGNID_NOT_PROVISIONED` - Program ID or campaign ID is not provisioned for this mobile operator or is not active.
577	true	`EC_ACC_NOT_PROVISIONED_TO_SMS_DEMO_SC` - Account not provisioned to use SMS demo short code.
578	true	`EC_EXCEEDED_THE_TIME_LIMIT_OF_SMS_DEMO` - Exceeded the time limit for using SMS demo.
579	true	`EC_DEST_ADDRESS_NOT_IN_SMS_DEMO` - Destination address not in whitelist for SMS demo.
580	true	`EC_EXCEEDED_THE_MAX_NUMBER` - Exceeded the maximum number of demo requests.
594	true	`EC_INVALID_GLOBAL_CAMPAIGN_ID` - Invalid global campaign ID.
597	true	`EC_ACC_HAS_NO_ADRESS_FOR_DESR` - Account is not provisioned with the address that can reach the destination.
598	true	`EC_INTERACTION_NOT_SUPPORTED` - Interaction not supported for message destination.
601	true	`EC_ACC_NOT_2_WAY` - Account is not provisioned for global two-way SMS.
603	true	`EC_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.
604	true	`EC_BLOCKED_BY_CAMPAIGN_BLACKLIST` - Content blocked by campaign blocklist.
607	true	`EC_BLOCKED_AS_SPAM` - This message was identified as spam and cannot be delivered
2049	true	`EC_IMSI_BLACKLISTED` - IMSI blocklisted
2052	true	`EC_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.
2053	true	`EC_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.
2053	true	`EC_SOURCE_ADDRESS_BLACKLISTED` - Source address is blocklisted on the VHD account.
4096	true	`EC_INVALID_PDU_FORMAT` - Invalid PDU Format
4099	true	`EC_MONTHLY_LIMIT_REACHED` - Your account monthly credit limit has been reached. For further financial assistance, please contact your account manager.
4100	true	`EC_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.
4101	true	`EC_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.
4102	true	`EC_NOTSUBMITTEDTOSMPPCHANNEL` - Inbound SM can not be transferred via SMPP due to the lack of SMPP connectivity.
4103	true	`EC_DESTINATION_FLOODING` - Related to status REJECTED_FLOODING_FILTER, the message is rejected due to the number of messages sent to a single number.
4104	true	`EC_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.

OPERATOR_ERRORS (group id: 3) - general error codes

The request has not been completed due to operator issues.

ID	Permanent	Error
10	true	`EC_BEARER_SERVICE_NOT_PROVISIONED` - Bearer Service Not Provisioned
20	false	`EC_SS_INCOMPATIBILITY` - SS Incompatibility
51	true	`EC_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.
71	false	`EC_UNKNOWN_ALPHABET` - Unknown Alphabet
345	true	`EC_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.
501	false	`EC_INVALID_RESPONSE_RECEIVED` - Invalid Response Received
560	true	`EC_SC_BLOCKED_FOR_END_USER` - Mobile operator blocking the end user from this Short Code
561	true	`EC_CONTENT_BLOCKED_BY_OPERATOR` - Content blocked by mobile operator for this end user.
562	true	`EC_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.
563	true	`EC_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.
564	true	`EC_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.
566	true	`EC_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.
568	true	`EC_DESTINATION_NOT_SMS_PROVISIONED` - Destination address not provisioned for SMS.
569	true	`EC_DEST_ADDRESS_SUSPENDED` - Destination address suspended by the mobile operator.
571	false	`EC_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.
574	true	`EEC_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.
630	true	`EC_DEST_OVERLOADED` - Destination overloaded.
631	true	`EC_MOBILE_OPERATOR_NETWORK_ERROR` - Mobile operator network error.
632	true	`EC_SMS_REJECTED_BY_MOBILE_OPERATOR` - SMS rejected by the mobile operator for attempted destination address.
633	true	`EC_UNKNOWN_MOBILE_OPERATOR` - Message failed due to an unknown mobile operator error.
810	true	`EC_FAILED_MESSAGE_DELIVERY` - Failed message delivery.
811	true	`EC_MESSAGE_EXPIRED` - Message expired before it reached handset.
815	true	`EC_MESSAGE_SUBMITTED_NOT_ACKED` - Message submitted to but not acknowledged by the mobile operator.
2048	false	`EC_TIME_OUT` - Time Out
2050	true	`EC_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.
2051	false	`EC_INVALIDMSCADDRESS` - Text blocklisted
4097	false	`EC_NOTSUBMITTEDTOGMSC` - Not Submitted To GMSC
4102	true	`EC_NOTSUBMITTEDTOSMPPCHANNEL` - Not Submitted To Smpp Channel
5492	true	`EC_DUPLICATE_MESSAGE` - The same message has already been sent to this destination address.

Voice error codes

OK (group id: 0) - voice error codes

The request has been completed successfully.

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

ID	Permanent	Error
5000	true	`VOICE_ANSWERED` - The call has been received and answered.
5001	true	`VOICE_ANSWERED_MACHINE` - The call has been received and answered by a voice machine.

HANDSET_ERRORS (group id: 1) - voice error codes

The request has not been completed due to handset related issues.

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

ID	Permanent	Error
5480	false	`EC_VOICE_ERROR_TEMPORARILY_NOT_AVAILABLE` - Destination address is currently not available.
5603	false	`EC_DECLINE` - Destination does not wish to participate in the call or cannot do so.

OPERATOR_ERRORS (group id: 3) - voice error codes

The request has not been completed due to operator issues.

ID	Permanent	Error
5002	true	`EC_VOICE_USER_BUSY` - The end user is currently busy to receive the Voice call.
5003	true	`EC_VOICE_NO_ANSWER` - The end user received a call but didn’t answer it.
5004	true	`EC_VOICE_ERROR_DOWNLOADING_FILE` - The file specified in the HTTP request is inaccessible and could not have been downloaded.
5005	true	`EC_VOICE_ERROR_UNSUPPORTED_AUDIO_FORMAT` - The format of the file specified is not supported.
5400	false	`EC_VOICE_ERROR_BAD_REQUEST` - The received request was rejected because it wasn’t formatted correctly.
5403	false	`EC_VOICE_ERROR_FORBIDDEN` - The received request was rejected by the operator.
5404	false	`EC_VOICE_ERROR_DESTINATION_NOT_FOUND` - The server has definitive information that the user does not exist at the domain specified in the Request-URI.
5407	false	`EC_VOICE_ERROR_PROXY_AUTHENTICATION_REQUIRED` - The request requires user authentication on the operator’s end.
5408	false	`EC_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.
5410	false	`EC_VOICE_ERROR_GONE` - The user existed once, but operator doesn’t support destination address anymore.
5413	false	`EC_VOICE_ERROR_REQUEST_ENTITY_TOO_LARGE` - Request entity-body is larger than the server is willing or able to process.
5414	false	`EC_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).
5415	false	`EC_VOICE_UNSUPPORTED_MEDIA_TYPE` - Format of the file is not supported.
5481	false	`EC_VOICE_ERROR_CALL_DOES_NOT_EXIST` - Call or Transaction does not exist.
5484	false	`EC_VOICE_ERROR_ADDRESS_INCOMPLETE` - Specified destination number is incomplete.
5487	false	`EC_VOICE_ERROR_REQUEST_TERMINATED` - Request has been terminated with a cancel button and end user refused to receive a voice call.
5488	false	`EC_VOICE_ERROR_NOT_ACCEPTABLE_HERE` - The format of the request is not acceptable on the operator’s end.
5491	false	`EC_VOICE_ERROR_REQUEST_PENDING` - Server has some pending request from the same dialog.
5501	true	`EC_VOICE_NOT_IMPLEMENTED` - The submitted request is not supported on the operator’s end.
5503	true	`EC_VOICE_SERVICE_UNAVAILABLE` - The service failed to complete the request.

","_postman_id":"8b6ff3f5-ec85-4442-b7cd-ba5d8c315fbf"},{"name":"VOICE and WebRTC error codes","item":[],"id":"2673c275-9533-4554-b4c9-b5abfb5637ea","description":"

OK (group id: 0)

The request has been completed successfully.

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

ID	Permanent	Error
10000	true	`NORMAL_HANGUP` The call ended due to a hangup initiated by the caller, callee, or API.
10001	true	`ANSWERED_ELSEWHERE` The call was answered on another device or platform. Verify the call status on the intended device or investigate further if needed.
10002	true	`MACHINE_DETECTED` The voice call was answered by a machine or voicemail system. You may consider adjusting your communication strategy for machine-answered calls.
10003	true	`HUMAN_DETECTED` A human answered the call. You can take appropriate action based on the call's purpose.
10004	true	`MAX_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.

HANDSET_ERRORS (group id: 1)

The request has not been completed due to handset-related issues.

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

ID	Permanent	Error
10100	true	`DEVICE_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.
10101	true	`DEVICE_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.
10102	true	`DEVICE_UNAVAILABLE` The device (camera and/or microphone) for the call is currently unavailable.
10103	true	`MEDIA_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.

USER_ERRORS (group id: 2)

User error occurred.

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

ID	Permanent	Error
10200	true	`NO_ANSWER` The call was successfully delivered to the end user device, however, it was not answered by the end user.
10201	true	`BUSY` 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.
10202	true	`CANCELED` The call was canceled at the origination end before it could be successfully routed to the end user.
10203	true	`REJECTED` The call was rejected/declined by the end user at the receiving end.
10204	true	`TEMPORARILY_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.

OPERATOR_ERRORS (group id: 3)

The request has not been completed due to operator issues.

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

ID	Permanent	Error
10300	true	`FORBIDDEN` The received request was rejected. Contact Support for further assistance.
10301	true	`INSUFFICIENT_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.
10302	true	`UNAUTHENTICATED` 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.
10303	true	`DESTINATION_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.
10304	true	`DESTINATION_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.
10305	true	`INVALID_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.
10306	true	`INVALID_REQUEST` The call request is invalid or malformed. Review the request parameters and structure, and make necessary adjustments.
10307	true	`REQUEST_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.
10308	true	`NETWORK_ERROR` An error occurred in the network during the call. Check the network connection and contact Support for further investigation.
10309	true	`SERVICE_UNAVAILABLE` The call service is temporarily unavailable. Contact Support for assistance.
10310	true	`UNKNOWN` An unknown error occurred during the call. Contact Support for further investigation and assistance.
10311	true	`FEATURE_UNAVAILABLE` The requested call feature is not available or supported. Consider alternative features or methods for communication or contact Support for assistance.
10312	true	`CONGESTION` The call could not be completed due to network congestion or overload. Contact Support for further investigation and assistance.
10400	true	`URL_NOT_FOUND` The requested URL for the call was not found. Verify the URL and make necessary corrections.
10401	true	`URL_UNREACHABLE` The requested URL for the call is unreachable. Check the network connectivity and URL accessibility.
10402	true	`INVALID_RESPONSE` The response received during the call is invalid or unexpected. Contact Support for assistance.

HANDSET_ERRORS (group id: 1) - WebRTC error codes

The request has not been completed due to handset-related issues.

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

ID	Permanent	Error
5720	true	`EC_NO_PEER_CONNECTION` The peer connection has not been established.
5721	true	`EC_INVALID_DTMF_CONFIG_NO_AUDIO_TRACK` Invalid DTMF configuration (no audio track).
5722	true	`EC_DTMF_UNAVAILABLE` DTMF options are not available.
5723	true	`EC_DTMF_INVALID_TONE` Invalid DTMF tone sent. Allowed tones are digits 1-9, * and #.
5724	true	`EC_NO_LOCAL_STREAM` Local stream was not initialized.
5725	true	`EC_NO_AUDIO_TRACK` The audio track is missing.
5726	true	`EC_NO_VIDEO_TRACK` The video track is missing.
5727	true	`EC_NO_DISPLAY_MEDIA` Display media API is not available.
5728	true	`EC_UNKNOWN_SCREEN_SHARE_ERROR` Unknown screen share error.

USER_ERRORS (group id: 2) - WebRTC error codes

User error occurred.

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

ID	Permanent	Error
5800	true	`EC_NO_ANSWER` The end user received the call but did not answer it.
5801	true	`EC_USER_BUSY` The end user is currently busy and not able to receive the call.
5802	true	`EC_PERMISSION_DENIED` Permission to use a camera and/or microphone was denied.
5803	true	`EC_DEVICE_NOT_FOUND` Device does not have a camera and/or microphone connected/enabled.
5804	true	`EC_DEVICE_NOT_AVAILABLE` Camera or microphone is already in use.
5805	true	`EC_ACTIVE_CALL_ON_INCOMING_CAL` The end user received an incoming call while they were on another active call.
5806	true	`EC_CALL_TERMINATED` Call terminated.
5850	true	`EC_USER_ALREADY_JOINED` The end user is already joined on another device.
5851	true	`EC_MAX_USERS_LIMIT_REACHED` The maximum number of users was already reached.
5852	true	`EC_VIDEO_PUBLISHERS_LIMIT_REACHED` The maximum number of users that are publishing a video was already reached.

OPERATOR_ERRORS (group id: 3) - WebRTC error codes

The request has not been completed due to operator issues.

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

ID	Permanent	Error
5768	true	`EC_CLIENT_URL_READ_FAILURE` Could not read the client's URL.
5769	true	`EC_CLIENT_URL_REACH_FAILURE` Could not reach the client's URL.
5900	true	`EC_FORBIDDEN` The received request was rejected.
5901	true	`EC_REQUEST_TIMEOUT` There was no coverage for a specific destination number, or the end user could not be reached in time for the call.
5902	true	`EC_INTERNAL_SERVER_ERROR` The server could not process the request because of an unexpected error.
5903	true	`EC_DESTINATION_NOT_FOUND` The server has definitive information that the end user does not exist within the domain specified in the Request-URI.
5904	true	`EC_SERVICE_TEMPORARY_UNAVAILABLE` The service is temporarily unavailable.
5905	true	`EC_REQUEST_PENDING` The server has a pending request from the same dialog.
5906	true	`EC_ADDRESS_INCOMPLETE` The specified destination number is incomplete.
5907	true	`EC_TEMPORARILY_NOT_AVAILABLE` The destination address is currently unavailable.
5990	true	`EC_CONNECTION_ERROR` There has been a connection error.
5991	true	`EC_UNKNOWN_WEBRTC_ERROR` There has been an unknown WebRTC error.

","_postman_id":"2673c275-9533-4554-b4c9-b5abfb5637ea"},{"name":"EMAIL error codes","item":[],"id":"f62dd84e-99a1-4d47-82ee-08cc675cc1d6","description":"

Dropped (group id: 1)

The request has not been completed successfully as there was an issue noticed before the sending attempt causing an error.
The

ID	Permanent	Name
6003	true	`EC_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.
6034	true	`EC_SUPPRESSED_BOUNCE` A bounce SMTP response from the recipient's mailbox provider earlier has resulted in the recipient address being suppressed.
6035	true	`EC_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.
6033	true	`EC_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.
6023	true	`EC_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.
6036	true	`EC_SENDING_DOMAIN_UNVERIFIED` Domain does not currently have all required DNS records set up correctly. Check your DNS configuration.
6016	true	`EC_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.
6029	true	`EC_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.
6018	true	`EC_REQUEST_INVALID` The submitted request is not valid. Ensure that the data and request parameters are accurate and in the right format.
6002	true	`EC_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.
6038	true	`EC_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.
6021	true	`EC_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.
6039	true	`EC_EMAIL_TEMPLATE_LANGUAGE_ERROR` Error in Template Language in your Content. See Template language personalization or more details. If the problem persists, contact Support.
6024	true	`EC_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.
6025	true	`EC_EMAIL_INVALID_TRACKING_PARAMS` Tracking parameters in the email are invalid. Review and help these before the retry.
6026	true	`EC_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.
6027	true	`EC_EMAIL_INVALID_HEADERS` The headers of the email are invalid or improperly formatted. Check the headers and ensure they meet the required format.
6030	true	`EC_EMAIL_INVALID_LANDING_PAGE` The specified landing page is invalid or inaccessible. Confirm the landing page's URL and availability and retry.
6031	true	`EC_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.
6020	true	`EC_EMAIL_TEMPLATE_NOT_FOUND` The Email Template from the request could not be found. Make sure that the Template ID is correct before retry.
6040	true	`EC_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.
6041	true	`EC_EMAIL_TEMPLATE_NOT_SAVED` The Template was not saved. Make sure the requested Template is correctly stored on the VHD web interface before retry.

Bounced (group id: 2)

The response from the mailbox provider indicates that there was an error and the delivery attempt was unsuccessful.

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

ID	Permanent	Name
6010	false	`EC_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.
6007	false	`EC_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.
6017	false	`EC_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.
6046	false	`EC_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.
6011	false	`EC_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.
6006	true	`EC_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.
6009	true	`EC_MAILBOX_PERMANENTLY_UNAVAILABLE` The recipient's mailbox provider (domain) might be permanently unavailable. Contact the recipient and attend to the situation before retry.
6037	true	`EC_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.
6042	true	`EC_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.
6043	true	`EC_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.
6044	true	`EC_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.
6045	true	`EC_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.
6047	true	`EC_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.
6048	true	`EC_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.
6049	true	`EC_SENDER_DOMAIN_BLACKLISTED` Your domain has been blockisted by the recipient mailbox. Review the Deliverability recommendations and request the delisting on the relevant blocklist.
6012	true	`EC_HARD_BOUNCE` Response is indicating a permanent error related to the delivery. Contact the recipient to confirm and solve the situation.

System Error (group id: 3)

The request has not been successful due to the issue on the VHD end.

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

ID	Permanent	Name
6013	false	`EC_INTERNAL_SYSTEM_ERROR` Something went wrong on the VHD end. Retry the traffic and contact Support if the same error is returned.

","_postman_id":"f62dd84e-99a1-4d47-82ee-08cc675cc1d6"}],"id":"d97429d9-5513-4933-a520-1d47fcfaa857","description":"

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.

Code lists:

\n","_postman_id":"d97429d9-5513-4933-a520-1d47fcfaa857"}],"event":[{"listen":"prerequest","script":{"id":"7b2d09d6-9440-4d24-82b0-4b7d3b171f1d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5e94b5eb-7683-46fc-9c10-88b8a6816385","type":"text/javascript","exec":[""]}}],"variable":[{"key":"to","value":""},{"key":"text","value":""},{"key":"from","value":""},{"key":"lisName","value":"listName"}]}