{"info":{"_postman_id":"0fa70722-7e93-4348-9e88-0870fa684a5f","name":"Spryng REST API (Documentation)","description":"<html><head></head><body><h1 id=\"1-authorization\">1. Authorization</h1>\n<p>When you login to your <a href=\"https://www.spryng.nl\">account</a>, under Your Profile &gt; Security you can generate a new REST API key which you can use as <strong>Bearer Token</strong> for your API requests.</p>\n<p>With the above generated Bearer Token you can set an <em>Authorization header</em>. This header consists of a bearer token. See example below:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-console\">Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjRkNWJlZjg3NjZhNWVjMzk5NmRiYzliZDQ3NjU3YzYxNjdhZWI2OTRkOGUwYWZmMDU3MTY4MGY5ZDcxNjQzZDI2M2ZhY2I1MTEyYjA0MmFmIn0.eyJhdWQiOiIzIiwianRpIjoiNGQ1YmVmODc2NmE1ZWMzOTk2ZGJjOWJkNDc2NTdjNjE2N2FlYjY5NGQ4ZTBhZmYwNTcxNjgwZjlkNzE2NDNkMjYzZmFjYjUxMTJiMDQyYWYiLCJpYXQiOjE1NTA2NzEwNjksIm5iZiI6MTU1MDY3MTA2OSwiZXhwIjoxNTgyMjA3MDY5LCJzdWIiOiI1MzU0OCIsInNjb3BlcyI6W119.w_axNwBr3UraOrO9BTsNDHS2JBJb-oOZYTcMLkDRv6romb__Q_4UmSg97HCmUTUY0o8PcbiefNHSqMhUB6GTCOduqRvQEQ0yaZ3TAldi6xj5Jcj1I4JP5_A3gORmoiUX0f_BuXCN_rTelZgC0F6IGUI0bJOafVdY1n-ADCzlXTAbVXqWvy40oPnI36Ny7mwmeLGO1eKmRnywlvK6-igZ3V37meGtFDyxOrZ2sBKUAWwUzuwl3oKEyxArRLUIkfYRVu4-OeEYBBTuLCXYyz0DvcTbjM9Up6cU1S-j01bpQIMgi3udk8WYCMF5dzNExWIRYfZc04r3uDHgYD2JL0v2FsDPLdQCjP8glBAi2qVJrc2QEteMBPzEvhW_36kw_cxAx_UqeZdr8QxdL8r3SR_xtFPk9ePzbkXQKsQBGvf0lCV6ydICMiLXaVihr4SDshoAMiZZXD8FegclAhU4q4UcWQSZlhEHubiCDJqfPnyw2VWpKGgiGMNvFyW9zgg50DXassIAc3KwLo2Zo6JFinze3XuAF7dGZVwJdV5589J4LVKkJIokh28LapR1Sm9K-SkhnFsczci2ZLpfZIh1v_HVqi41XiJVBYRci6YbUNUEKT8qr1JVZEi2IQYS7rTNsUO7rraBadeWslKngZxWaKdfRnM_S_cLS0v-uJeMpnXFIECU\n\n</code></pre>\n<p>This token can be retreived via the Spryng portal on your profile page (<a href=\"https://portal.spryngsms.com/portal/account\">https://portal.spryngsms.com/portal/account</a>)</p>\n<p>The required headers for each endpoint are listed under the header section of the endpoint documentation.</p>\n<h1 id=\"2-rate-limits\">2. Rate Limits</h1>\n<p>API access rate limits are applied at a per-key basis in unit time. Access to the API using a key is limited to 1200 requests per minute. This is a <strong>soft limit</strong> which can be increased by mailing a request to <a href=\"https://mailto:info@spryng.nl\">info@spryng.nl</a>.</p>\n<p>In addition, every API response is accompanied by the following set of headers to identify the status of your consumption.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Header</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>X-RateLimit-Limit</td>\n<td>The maximum number of requests that the consumer is permitted to make per minute.</td>\n</tr>\n<tr>\n<td>X-RateLimit-Remaining</td>\n<td>The number of requests remaining in the current rate limit window.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Once you hit the rate limit, you will receive a response similar to the following JSON, with a status code of <code>429 Too Many Requests</code>.</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"message\": \"Too Many Attempts.\"\n}\n\n</code></pre>\n<h1 id=\"3-http-status-codes\">3. HTTP Status Codes</h1>\n<h2 id=\"31-http-statuses\">3.1 HTTP Statuses</h2>\n<p>The REST API returns an HTTP status and code each time a request is made. The following HTTP status codes are used by our API. Additional codes might be added in the future and if you encounter a code not in this list please consult the HTTP specification for a definition.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Status</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200 OK</td>\n<td>The request was successful.</td>\n</tr>\n<tr>\n<td>401 Unauthorized</td>\n<td>Authentication token is invalid</td>\n</tr>\n<tr>\n<td>404 Not Found</td>\n<td>The path is invalid or no resource exists with the given ID.</td>\n</tr>\n<tr>\n<td>405 Method Not Allowed</td>\n<td>The path is valid but not for this method.</td>\n</tr>\n<tr>\n<td>422 Unprocessable Entity</td>\n<td>The request has missing or invalid parameters.</td>\n</tr>\n<tr>\n<td>429 Too Many Requests</td>\n<td>The user or path has too many outstanding requests.</td>\n</tr>\n<tr>\n<td>500 Internal Server Error</td>\n<td>An unexpected internal error occurred and the request was not processed.</td>\n</tr>\n<tr>\n<td>503 Service Unavailable</td>\n<td>The service is unable to perform the request at this point. Most likely due to a required subsystem being unavailable.</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"32-http-validation-errors\">3.2 HTTP Validation Errors</h2>\n<p>Responses with status 422 Unprocessable Entity implies that the request has missing or invalid request parameters. In this case a JSON object is returned explaining the error:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Description</th>\n<th>JSON Type</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>message</td>\n<td>An generic description of the issue.</td>\n<td>String</td>\n</tr>\n<tr>\n<td>errors</td>\n<td>Human readable description of each parameter with an explanatory message</td>\n<td>Array</td>\n</tr>\n</tbody>\n</table>\n</div><p>For example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"message\": \"The given data was invalid.\",\n  \"errors\": {\n    \"originator\": [\n      \"The originator must be a valid format.\"\n    ],\n    \"recipients.0\": [\n      \"Recipient 9999999 is invalid format. Format should look like 31612345678.\"\n    ]\n  }\n}\n\n</code></pre>\n<h1 id=\"4-filters\">4. Filters</h1>\n<p>Filters provide the ability to query, sort and paginate an endpoint for its information.<br>Let's take a look at the query string that would be required to filter for the criteria in the previous sentence:</p>\n<p><code>/v1/messages?filters[created_from]=2017-05-01&amp;filters[status]=send&amp;limit=10&amp;sort=!created_at</code>.</p>\n<p>Notice how <code>limit</code> and <code>sort</code> do not belong to <code>filters[]</code>. Parameters passed to <code>filters[]</code> are unique to that endpoint. The available filters will be listed per endpoint. We also have a few generic filters that are available all the time. These include: <code>limit</code>, <code>page</code> &amp; <code>sort</code>.</p>\n<h2 id=\"41-generic-filters\">4.1 Generic Filters</h2>\n<p>Generic filters are applicable to all filterable endpoints. They provide standard functionality such as sorting the result data set and paginating through it.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Filter</th>\n<th>Example Usage</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>limit</td>\n<td>?limit=10</td>\n<td>Defines the amount of records you want to return. There is a hard limit of 100.</td>\n</tr>\n<tr>\n<td>page</td>\n<td>?page=1</td>\n<td>Skips the amount of records defined in limit multiplied by the page number. This is used for paginating through the results.</td>\n</tr>\n<tr>\n<td>sort</td>\n<td>?sort=!created_at</td>\n<td>The sortable value is dependent on what is available per endpoint. Use <em>!</em> before the value to reverse the order. Consult the endpoint for which values can be sorted.</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"42-unique-filters\">4.2 Unique Filters</h2>\n<p>Unique filters are only applicable to a specific endpoint. They are documented under each endpoint.</p>\n<h2 id=\"43-chaining-filters\">4.3 Chaining Filters</h2>\n<p>Filters can be chained by attaching as many as you want (e.g. <code>?filters[status]=active&amp;filters[age]=25</code>). Parameters will be automatically casted.</p>\n<h1 id=\"5-includes\">5. Includes</h1>\n<p>Some endpoints have includeables. Includeables are defined by passing the query parameter with (e.g. <code>?with[]=recipients</code>). The include will return an extra data that is not normally returned. Only add includes when the data is needed. Including any unnecessary date will only slow down the response, creating worse perceived performance for the end user. Available includes will be listed per endpoint.</p>\n<h1 id=\"6-character-sets\">6. Character Sets</h1>\n<h3 id=\"61-gsm-0338-character-set\">6.1 GSM 03.38 Character Set</h3>\n<p>When using the <code>plain</code> encoding only <em>GSM 03.38 basic characters</em> are visible which allows you to send up to 160 characters per SMS message. Below a table of all available characters in the GSM 03.38 basic characters.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th></th>\n<th></th>\n<th></th>\n<th></th>\n<th></th>\n<th></th>\n<th></th>\n<th></th>\n<th></th>\n<th></th>\n<th></th>\n<th></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>@</td>\n<td>Δ</td>\n<td>SP</td>\n<td>Ø</td>\n<td>,</td>\n<td>0</td>\n<td>A</td>\n<td>K</td>\n<td>V</td>\n<td>a</td>\n<td>l</td>\n<td>w</td>\n</tr>\n<tr>\n<td>£</td>\n<td>_</td>\n<td>!</td>\n<td>ø</td>\n<td>-</td>\n<td>1</td>\n<td>B</td>\n<td>L</td>\n<td>W</td>\n<td>b</td>\n<td>m</td>\n<td>x</td>\n</tr>\n<tr>\n<td>$</td>\n<td>Φ</td>\n<td>\"</td>\n<td>CR</td>\n<td>.</td>\n<td>2</td>\n<td>C</td>\n<td>M</td>\n<td>X</td>\n<td>c</td>\n<td>n</td>\n<td>y</td>\n</tr>\n<tr>\n<td>¥</td>\n<td>Γ</td>\n<td>#</td>\n<td>Å</td>\n<td>/</td>\n<td>3</td>\n<td>D</td>\n<td>N</td>\n<td>Y</td>\n<td>d</td>\n<td>o</td>\n<td>z</td>\n</tr>\n<tr>\n<td>è</td>\n<td>Λ</td>\n<td>¤</td>\n<td>å</td>\n<td>;</td>\n<td>4</td>\n<td>E</td>\n<td>O</td>\n<td>Z</td>\n<td>e</td>\n<td>p</td>\n<td>ä</td>\n</tr>\n<tr>\n<td>é</td>\n<td>Ω</td>\n<td>%</td>\n<td>ESC</td>\n<td>&lt;</td>\n<td>5</td>\n<td>F</td>\n<td>P</td>\n<td>Ä</td>\n<td>f</td>\n<td>q</td>\n<td>ö</td>\n</tr>\n<tr>\n<td>ù</td>\n<td>Π</td>\n<td>&amp;</td>\n<td>Æ</td>\n<td>=</td>\n<td>6</td>\n<td>G</td>\n<td>Q</td>\n<td>Ö</td>\n<td>g</td>\n<td>r</td>\n<td>ñ</td>\n</tr>\n<tr>\n<td>ì</td>\n<td>Ψ</td>\n<td>'</td>\n<td>æ</td>\n<td>&gt;</td>\n<td>7</td>\n<td>H</td>\n<td>R</td>\n<td>Ñ</td>\n<td>h</td>\n<td>s</td>\n<td>ü</td>\n</tr>\n<tr>\n<td>ò</td>\n<td>Σ</td>\n<td>(</td>\n<td>ß</td>\n<td>?</td>\n<td>8</td>\n<td>I</td>\n<td>S</td>\n<td>Ü</td>\n<td>i</td>\n<td>t</td>\n<td>à</td>\n</tr>\n<tr>\n<td>Ç</td>\n<td>Θ</td>\n<td>)</td>\n<td>É</td>\n<td>¡</td>\n<td>9</td>\n<td>J</td>\n<td>T</td>\n<td>§</td>\n<td>j</td>\n<td>u</td>\n<td>¿</td>\n</tr>\n<tr>\n<td>LF</td>\n<td>Ξ</td>\n<td>*</td>\n<td>+</td>\n<td>:</td>\n<td></td>\n<td>K</td>\n<td>U</td>\n<td></td>\n<td>k</td>\n<td>v</td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p><code>LF</code> is the Line Feed character - for JSON format, enter this as <code>\\n</code></p>\n<p><code>SP</code> is the Space character</p>\n<h3 id=\"62-extended-character-set\">6.2 Extended Character Set</h3>\n<p>The following characters are also available, but they take up two characters in the SMS message instead of one.</p>\n<p><code>|</code> , <code>^</code> , <code>€</code> , <code>{</code> , <code>}</code> , <code>[</code> , <code>]</code> , <code>~</code> , <code>\\</code></p>\n<h3 id=\"63-unicode-character-set\">6.3 Unicode Character Set</h3>\n<p>If you require to sent other characters than shown above you'll have to use the <strong>unicode</strong> encoding type. You achieve this by setting the <code>encoding</code> value to either <code>auto</code> or <code>unicode</code>.<br>Unicode allows you to sent up to 70 characters per SMS message.</p>\n<h3 id=\"64-long-messages\">6.4 Long Messages</h3>\n<p>The message body in a batch request can contain up to 10 messages. Depending on the characters used in the message, this will equate to the following numbers of SMS messages.</p>\n<h4 id=\"641-plain-encoded-message\">6.4.1 Plain encoded message:</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Message Length</th>\n<th>Number of SMS Parts</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>1 - 160</td>\n<td>1</td>\n</tr>\n<tr>\n<td>161 - 306</td>\n<td>2</td>\n</tr>\n<tr>\n<td>307 - 459</td>\n<td>3</td>\n</tr>\n<tr>\n<td>460 - 612</td>\n<td>4</td>\n</tr>\n<tr>\n<td>613 - 765</td>\n<td>5</td>\n</tr>\n<tr>\n<td>766 - 918</td>\n<td>6</td>\n</tr>\n<tr>\n<td>919 - 1071</td>\n<td>7</td>\n</tr>\n<tr>\n<td>1072 - 1224</td>\n<td>8</td>\n</tr>\n<tr>\n<td>1225 - 1377</td>\n<td>9</td>\n</tr>\n<tr>\n<td>1378 - 1530</td>\n<td>10</td>\n</tr>\n<tr>\n<td>1521 - 1600</td>\n<td>11</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"642-unicode-encoded-message\">6.4.2 Unicode encoded message:</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Message Length</th>\n<th>Number of SMS Parts</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>1 - 70</td>\n<td>1</td>\n</tr>\n<tr>\n<td>71 - 134</td>\n<td>2</td>\n</tr>\n<tr>\n<td>135 - 201</td>\n<td>3</td>\n</tr>\n<tr>\n<td>202 - 268</td>\n<td>4</td>\n</tr>\n<tr>\n<td>269 - 335</td>\n<td>5</td>\n</tr>\n<tr>\n<td>336 - 402</td>\n<td>6</td>\n</tr>\n<tr>\n<td>403 - 469</td>\n<td>7</td>\n</tr>\n<tr>\n<td>470 - 536</td>\n<td>8</td>\n</tr>\n<tr>\n<td>537 - 603</td>\n<td>9</td>\n</tr>\n<tr>\n<td>604 - 670</td>\n<td>10</td>\n</tr>\n<tr>\n<td>661 - 726</td>\n<td>11</td>\n</tr>\n<tr>\n<td>727 - 792</td>\n<td>12</td>\n</tr>\n<tr>\n<td>792 - 858</td>\n<td>13</td>\n</tr>\n<tr>\n<td>859 - 924</td>\n<td>14</td>\n</tr>\n<tr>\n<td>925 - 990</td>\n<td>15</td>\n</tr>\n<tr>\n<td>991 - 1056</td>\n<td>16</td>\n</tr>\n<tr>\n<td>1057 - 1122</td>\n<td>17</td>\n</tr>\n<tr>\n<td>1123 - 1188</td>\n<td>18</td>\n</tr>\n<tr>\n<td>1189 - 1254</td>\n<td>19</td>\n</tr>\n<tr>\n<td>1255 - 1320</td>\n<td>20</td>\n</tr>\n<tr>\n<td>1321 - 1386</td>\n<td>21</td>\n</tr>\n<tr>\n<td>1387 - 1452</td>\n<td>22</td>\n</tr>\n<tr>\n<td>1453 - 1518</td>\n<td>23</td>\n</tr>\n<tr>\n<td>1519 - 1584</td>\n<td>24</td>\n</tr>\n<tr>\n<td>1585 - 1600</td>\n<td>25</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"7-delivery-reports-callback\">7. Delivery Reports callback</h1>\n<h3 id=\"71-setup\">7.1 Setup</h3>\n<p>To enable delivery reports, login into your account on the Spryng portal and by selecting the menu item ‘Settings’ in your SMS dashboard. Here you can enter the url of your script (servlet, php script, perl, etc…) on which you wish to receive your delivery reports.</p>\n<p>This script should expect the below parameters via an HTTP GET call.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>ID</code></td>\n<td>string</td>\n<td>The <code>uuid</code> of the message</td>\n</tr>\n<tr>\n<td><code>RECIPIENT</code></td>\n<td>string</td>\n<td>The phone number of the destination in format <code>31612345678</code></td>\n</tr>\n<tr>\n<td><code>STATUS</code></td>\n<td>enum</td>\n<td>10(=Delivered), 20(=Not Delivered)</td>\n</tr>\n<tr>\n<td><code>REASONCODE</code></td>\n<td>string</td>\n<td>See <strong>#7.2 Error Reason Codes</strong> below for expected values and their meaning</td>\n</tr>\n<tr>\n<td><code>REFERENCE</code></td>\n<td>string</td>\n<td>value given by you in the API call</td>\n</tr>\n<tr>\n<td><code>ADDED</code></td>\n<td>string</td>\n<td>Timestamp when the messages was created in the Spryng service in <code>YYYYmmddHHiiss</code> format</td>\n</tr>\n<tr>\n<td><code>RESULTDATE</code></td>\n<td>string</td>\n<td>Timestamp when the messages was sent from the Spryng service in <code>YYYYmmddHHiiss</code> format</td>\n</tr>\n<tr>\n<td><code>OPERATOR_STATUS_AT</code></td>\n<td>string</td>\n<td>Timestamp of the response from the originating SMSC in <code>YYYYmmddHHiiss</code> format</td>\n</tr>\n<tr>\n<td><code>OPERATOR</code></td>\n<td>string</td>\n<td>The <a href=\"https://en.wikipedia.org/wiki/Mobile_country_code\">MCCMNC</a> code of the network provider operator if available</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>When you require a delivery report you should not specify more than 1 DESTINATION in your request. You can expect the following parameters:</strong></p>\n<p>The HTTP request conducted by Spryng must be answered by your server with a status code of <strong>2xx</strong> which means that the message was successfully accepted by your system. If either the HTTP server cannot be reached, for example it returns an 500 internal server error, Spryng assumes that the message was not successfully accepted by your system and the request will be retried exponentially (which means more times at the beginning and less and less afterwards). The message will not be retried forever, the current setting around 2,5 days.</p>\n<h3 id=\"72-error-reason-codes\">7.2 Error Reason Codes</h3>\n<p>Below an overview of the possible <strong>error reason codes</strong> which you can retrieve.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>0</code></td>\n<td>No error</td>\n</tr>\n<tr>\n<td><code>20</code></td>\n<td>Recipient number unreachable</td>\n</tr>\n<tr>\n<td><code>21</code></td>\n<td>Recipient number incorrect</td>\n</tr>\n<tr>\n<td><code>22</code></td>\n<td>Delivery Failure</td>\n</tr>\n<tr>\n<td><code>31</code></td>\n<td>The recipient is blacklisted (e.g. People that respond \"STOP\" to an earlier message can appear in the blacklist)</td>\n</tr>\n<tr>\n<td><code>32</code></td>\n<td>The originator is not registered for this country</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"8-mo-gateway\">8. MO Gateway</h1>\n<p>Spryng delivers a HTTP POST request to a script on your server whenever a mobile originated (MO) message arrives. You must set up a script that can handle HTTP POST data to receive the requests.</p>\n<p>The HTTP request conducted by Spryng must be answered by your server in the response HTTP body with status code 200, which means that the message was successfully accepted by your system. We don't follow redirects (301/302). If the HTTP server cannot be reached and if it returns e.g. 500 internal server error, Spryng assumes that the message was not successfully accepted by your system and the request will be retried once every minute. The message will not be retried forever, the current setting is 24 hours.</p>\n<p>You can set a return url in our <a href=\"https://portal.spryngsms.com/messages-received/settings\">Spryng Portal</a>. You can expect the following parameters</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>MSISDN</code></td>\n<td>string</td>\n<td>The phone number from which the response originated</td>\n</tr>\n<tr>\n<td><code>SHORTCODE</code></td>\n<td>string</td>\n<td>The shortcode to which the response was sent</td>\n</tr>\n<tr>\n<td><code>KEYWORD</code></td>\n<td>string</td>\n<td>The keyword with which the message text starts</td>\n</tr>\n<tr>\n<td><code>PARM</code></td>\n<td>string</td>\n<td>All message text after the KEYWORD</td>\n</tr>\n<tr>\n<td><code>OPERATOR</code></td>\n<td>string</td>\n<td>The <a href=\"https://en.wikipedia.org/wiki/Mobile_country_code\">MCCMNC</a> code of the network provider operator if available</td>\n</tr>\n<tr>\n<td><code>TIMESTAMP</code></td>\n<td>string</td>\n<td>Time that message was received by SMSC or system</td>\n</tr>\n<tr>\n<td><code>COUNTRY</code></td>\n<td>string</td>\n<td>The two-letter country code (ISO 3166-1 alpha-2)</td>\n</tr>\n<tr>\n<td><code>REFERENCE</code></td>\n<td>string</td>\n<td>Reference linked to the original message if applicable</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"9-simple-http-api\">9. Simple HTTP API</h1>\n<p>You can also still use our <a href=\"https://simple.docs.spryngsms.com/\">simple API</a>. However it's recommended to use our REST API since the Simple API has less functionality.</p>\n<h1 id=\"10-rcs\">10. RCS</h1>\n<p>RCS (Rich Communication Services) allows you to send richer messages compared to SMS.</p>\n<p><strong>Important:</strong> You need to have RCS enabled for your account before you can start using this. If you don’t have this enabled yet, please contact Spryng Support.</p>\n<p>Setup:</p>\n<ul>\n<li><p>RCS uses the same API endpoint and parameters as SMS. No changes to your integration are needed.</p>\n</li>\n<li><p>A dedicated route must be configured for RCS traffic. Spryng will set this up for you.</p>\n</li>\n<li><p>If the recipient’s operator or operating system does not support RCS, the message will automatically be delivered as SMS.</p>\n</li>\n<li><p>Delivery receipts (DLRs) are available via the webhook you already use for SMS.</p>\n</li>\n<li><p>RCS messages can contain up to <strong>160 characters</strong>.</p>\n</li>\n</ul>\n<h1 id=\"11-support\">11. Support</h1>\n<p>Please contact <a href=\"https://mailto:info@spryng.nl\">info@spryng.nl</a> for any questions or problems related to the API.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"1. Authorization","slug":"1-authorization"},{"content":"2. Rate Limits","slug":"2-rate-limits"},{"content":"3. HTTP Status Codes","slug":"3-http-status-codes"},{"content":"4. Filters","slug":"4-filters"},{"content":"5. Includes","slug":"5-includes"},{"content":"6. Character Sets","slug":"6-character-sets"},{"content":"7. Delivery Reports callback","slug":"7-delivery-reports-callback"},{"content":"8. MO Gateway","slug":"8-mo-gateway"},{"content":"9. Simple HTTP API","slug":"9-simple-http-api"},{"content":"10. RCS","slug":"10-rcs"},{"content":"11. Support","slug":"11-support"}],"owner":"6569146","collectionId":"0fa70722-7e93-4348-9e88-0870fa684a5f","publishedId":"S1EH53S1","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"DDF8FF","highlight":"EE6445"},"publishDate":"2019-04-05T06:08:50.000Z"},"item":[{"name":"Messages","item":[{"name":"Create Message","id":"39c42dee-53ea-4a4f-8f68-74ac844ecd57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"body\": \"This is a test message\",\n    \"originator\": \"Test\",\n    \"recipients\": [\n        \"31612345678\"\n    ],\n    \"route\": \"business\"\n}"},"url":"{{server}}/v1/messages","description":"<p>Create a new message.</p>\n<h4 id=\"required-parameters\">Required Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameters</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>encoding</code></td>\n<td>string</td>\n<td>Character encoding of the body. Value can be: <code>plain</code>, <code>unicode</code> or <code>auto</code></td>\n</tr>\n<tr>\n<td><code>body</code></td>\n<td>string</td>\n<td>The message body.</td>\n</tr>\n<tr>\n<td><code>route</code></td>\n<td>string/int</td>\n<td>Your given route to send the message on. Can be a valid route ID supplied by Spryng or the default <code>business</code> route</td>\n</tr>\n<tr>\n<td><code>originator</code></td>\n<td>string</td>\n<td>The sender of the message. Can be alphanumeric string (max. 11 characters) or phonenumber (max. 14 digits in E.164 format like 31612345678)</td>\n</tr>\n<tr>\n<td><code>recipients</code></td>\n<td>array [strings]</td>\n<td>List of recipient numbers MSISDNs. <strong>Max. 50 per API-call</strong></td>\n</tr>\n</tbody>\n</table>\n</div><ul>\n<li>(1) Originator and recipient numbers must be in a format like \"31612345678\" (international numeric).</li>\n</ul>\n<h4 id=\"optional-parameters\">Optional Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameters</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>scheduled_at</code></td>\n<td>datetime</td>\n<td>Time when the message should be sent, Atom/RFC3339 formatted. <em>(default: now)</em></td>\n</tr>\n<tr>\n<td><code>reference</code></td>\n<td>string</td>\n<td>A client reference.</td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"includes\">Includes</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Filter</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>recipients</code></td>\n<td>Display all recipient information</td>\n</tr>\n<tr>\n<td><code>route</code></td>\n<td>Display route id</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["v1","messages"],"host":["{{server}}"],"query":[{"disabled":true,"key":"with[]","value":"recipients"}],"variable":[]}},"response":[{"id":"995eb31d-76c1-4710-a76d-73955789b133","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"body\": \"This is a test message.\",\n    \"encoding\": \"auto\",\n    \"originator\": \"DocsTest\",\n    \"recipients\": [\n        \"31612345678\"\n    ],\n    \"route\": \"business\",\n    \"scheduled_at\": \"2019-01-01T15:00:00+00:00\"\n}"},"url":"{{server}}/v1/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 05 Dec 2018 15:56:26 GMT"},{"key":"Server","value":"Apache/2.4.29 (Unix) OpenSSL/1.0.2o PHP/7.1.14"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"297"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Robots-Tag","value":"none"},{"key":"Content-Length","value":"464"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"91646b0b-b425-4e98-bb53-8c545873eec0\",\n    \"encoding\": \"auto\",\n    \"originator\": \"DocsTest\",\n    \"body\": \"This is a test message.\",\n    \"reference\": \"\",\n    \"credits\": 1.2,\n    \"scheduled_at\": \"2019-01-01T15:00:00+00:00\",\n    \"canceled_at\": \"\",\n    \"created_at\": \"2018-12-05T15:56:26+00:00\",\n    \"updated_at\": \"2018-12-05T15:56:26+00:00\",\n    \"links\": {\n        \"self\": \"https://rest.spryngsms.com/v1/messages/91646b0b-b425-4e98-bb53-8c545873eec0\"\n    }\n}\n"},{"id":"4d873734-2fd8-43d6-9921-79afb7bfb13a","name":"422 - Unprocessable Entity","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"body\": \"This is a test message.\",\n    \"recipients\": [\n        \"9999999\"\n    ],\n    \"originator\": \"TooLongOriginator\",\n    \"encoding\": \"auto\",\n    \"route\": \"business\"\n}"},"url":"{{server}}/v1/messages"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 07 May 2019 11:44:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"39"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Vary","value":"Authorization"},{"key":"X-RateLimit-Limit","value":"1"},{"key":"X-RateLimit-Remaining","value":"0"},{"key":"Retry-After","value":"25"},{"key":"X-RateLimit-Reset","value":"1557229489"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"The given data was invalid.\",\n    \"errors\": {\n        \"originator\": [\n            \"The originator must be a valid format.\"\n        ],\n        \"recipients.0\": [\n            \"Recipient 9999999 is invalid format. Format should look like 31612345678.\"\n        ]\n    }\n}"},{"id":"c23805be-c98f-45c1-87d4-22d2c9546e87","name":"429 - Too Many Requests","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"body\": \"This is a test message.\",\n    \"originator\": \"Test\",\n    \"recipients\": [\n        \"31612345678\"\n    ],\n    \"route\": \"business\"\n}"},"url":"{{server}}/v1/messages"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 07 May 2019 11:46:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"248"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"598"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"Too Many Attempts.\"\n}"},{"id":"dec1d37c-ad66-42c8-a9c2-d179a668e2bd","name":"401 - Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"body\": \"This is a test message.\",\n    \"originator\": \"Test\",\n    \"recipients\": [\n        \"31612345678\"\n    ],\n    \"route\": \"business\"\n}"},"url":{"raw":"{{server}}/v1/messages","host":["{{server}}"],"path":["v1","messages"],"query":[{"key":"with[]","value":"recipients","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Jan 2021 12:48:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"28"},{"key":"Connection","value":"close"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Unauthenticated.\"\n}"},{"id":"cb718d26-0586-49f3-aaaf-93ae1c2da37c","name":"405 - Method not allowed","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"body\": \"This is a test message.\",\n    \"originator\": \"Test\",\n    \"recipients\": [\n        \"31612345678\"\n    ],\n    \"route\": \"business\"\n}"},"url":{"raw":"{{server}}/v1/messages","host":["{{server}}"],"path":["v1","messages"],"query":[{"key":"with[]","value":"recipients","disabled":true}]}},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Jan 2021 12:51:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Vary","value":"Authorization"},{"key":"Allow","value":"GET, HEAD, POST"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"\"\n}"},{"id":"34e5a00e-07df-4b95-9829-4c2e795cd475","name":"404 - Not Found","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{server}}/v1/messages404","host":["{{server}}"],"path":["v1","messages404"],"query":[{"key":"with[]","value":"recipients","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Jan 2021 12:52:02 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"48"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"The requested resource is not found.\"\n}"},{"id":"61d643b6-65ab-4f11-8412-eeb0890330e4","name":"422 - Unprocessable Entity (Extensive)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{server}}/v1/messages","host":["{{server}}"],"path":["v1","messages"],"query":[{"key":"with[]","value":"recipients","disabled":true}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Jan 2021 12:52:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"287"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"The given data was invalid.\",\n    \"errors\": {\n        \"body\": [\n            \"The text field is required.\"\n        ],\n        \"body_parts\": [\n            \"The text parts must be at least 1.\"\n        ],\n        \"originator\": [\n            \"The originator field is required.\"\n        ],\n        \"route\": [\n            \"The routes field is required.\"\n        ],\n        \"recipients\": [\n            \"The recipients field is required.\"\n        ]\n    }\n}"},{"id":"45657591-f138-42b6-9dbe-28b806b7fb1b","name":"422 - Unprocessable Entity (body too large)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"body\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean nec ultrices magna, quis pharetra leo. Mauris sed nibh lobortis, suscipit nisi non, finibus arcu. In hac habitasse platea dictumst. Nam metus justo, convallis et leo sed, facilisis finibus dolor. Phasellus faucibus venenatis mi, a egestas ex. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Phasellus porttitor maximus luctus. Fusce at sapien ac massa sagittis pharetra eu ac arcu. Aenean et mauris a lacus rutrum accumsan et nec lorem. Maecenas sollicitudin accumsan dui. Nulla nec mi et ex laoreet tempus non vel nulla. Curabitur nec bibendum est, in pharetra purus. Mauris venenatis mauris a velit fringilla, auctor aliquet lacus tincidunt. Mauris sem arcu, dapibus et nisi at, elementum sagittis erat. Nulla iaculis pharetra luctus. Duis tellus nulla, fermentum id nisi ac, iaculis varius arcu. Integer lacus quam, sagittis non nisi semper, imperdiet ornare nibh. Praesent nisi urna, scelerisque id tortor eget, cursus euismod sem. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Vestibulum quis tellus orci. Cras at scelerisque lacus. Integer commodo euismod iaculis. Sed in eros et sem consequat vestibulum ut non elit. Aliquam tempus turpis vitae leo laoreet molestie vitae non velit. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. In lobortis mi urna. Duis eu semper mi. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Duis nec interdum risus. In tempor venenatis augue at euismod. Curabitur eget est sodales, fringilla risus vitae, consectetur libero. Nunc tristique eros eget pharetra mattis. Aliquam aliquam pellentesque lorem vestibulum congue. Mauris dictum semper eros, eget ultrices lectus convallis vel.\",\n    \"originator\": \"Test\",\n    \"recipients\": [\n        \"31612345678\"\n    ],\n    \"route\": \"business\"\n}"},"url":{"raw":"{{server}}/v1/messages","host":["{{server}}"],"path":["v1","messages"],"query":[{"key":"with[]","value":"recipients","disabled":true}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Jan 2021 12:54:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"168"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"The given data was invalid.\",\n    \"errors\": {\n        \"body_parts\": [\n            \"Your message body count can be maximum of 1530 characters for a plain and 670 for unicode messages\"\n        ]\n    }\n}"},{"id":"fcd4cfc3-b415-445f-9b46-134f5e7472b4","name":"422 - Unprocessable Entity (Invalid recipients)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"body\": \"This is a test message.\",\n    \"originator\": \"Test\",\n    \"recipients\": [\n        \"31612345678\",\n        \"9999999\",\n        \"31612345678\",\n        \"9999998\"\n    ],\n    \"route\": \"business\"\n}"},"url":{"raw":"{{server}}/v1/messages","host":["{{server}}"],"path":["v1","messages"],"query":[{"key":"with[]","value":"recipients","disabled":true}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Jan 2021 12:55:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"238"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"The given data was invalid.\",\n    \"errors\": {\n        \"recipients.1\": [\n            \"Recipient 9999999 is invalid format. Format should look like 31612345678.\"\n        ],\n        \"recipients.3\": [\n            \"Recipient 9999998 is invalid format. Format should look like 31612345678.\"\n        ]\n    }\n}"},{"id":"84df72fc-7b0c-4180-8f92-76fb91aa5ce1","name":"422 - Unprocessable Entity (Blocked recipient country)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"body\": \"This is a test message.\",\n    \"originator\": \"Test\",\n    \"recipients\": [\n        \"31612345678\",\n        \"32612345678\"\n    ],\n    \"route\": \"business\"\n}"},"url":{"raw":"{{server}}/v1/messages","host":["{{server}}"],"path":["v1","messages"],"query":[{"key":"with[]","value":"recipients","disabled":true}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Jan 2021 12:55:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"238"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"The given data was invalid.\",\n    \"errors\": {\n        \"recipients.1\": [\n            \"You can't send to recipients in the country BE for selected route.\"\n        ]\n    }\n}"},{"id":"7e6d76bc-082b-4261-bdbe-091188b35994","name":"422 - Unprocessable Entity (Invalid Parameters)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"originator\": \"TooLongOriginator\",\n    \"encoding\": \"invalidencoding\",\n    \"route\": \"invalidroute\",\n    \"scheduled_at\": \"01-01-2020\"\n}"},"url":{"raw":"{{server}}/v1/messages","host":["{{server}}"],"path":["v1","messages"],"query":[{"key":"with[]","value":"recipients","disabled":true}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Jan 2021 12:59:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"421"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"The given data was invalid.\",\n    \"errors\": {\n        \"body\": [\n            \"The text field is required.\"\n        ],\n        \"body_parts\": [\n            \"The text parts must be at least 1.\"\n        ],\n        \"encoding\": [\n            \"The selected codering is invalid.\"\n        ],\n        \"originator\": [\n            \"The originator must be a valid format.\"\n        ],\n        \"scheduled_at\": [\n            \"The scheduled at does not match the format Y-m-d\\\\TH:i:sP.\"\n        ],\n        \"route\": [\n            \"The selected routes is invalid.\"\n        ],\n        \"recipients\": [\n            \"The recipients field is required.\"\n        ]\n    }\n}"}],"_postman_id":"39c42dee-53ea-4a4f-8f68-74ac844ecd57"},{"name":"List Messages","id":"9d59b689-4967-4b87-8ec7-9102c3de632d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{server}}/v1/messages?filters[recipient_number]=31612345678&with[]=recipients","description":"<p>To list all SMS messages sent with your account.</p>\n<h4 id=\"body-parameters\">Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Filter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>originator</code></td>\n<td>string</td>\n<td>Display messages for given originator</td>\n</tr>\n<tr>\n<td><code>recipient_number</code></td>\n<td>string</td>\n<td>Display messages which contain given recipient</td>\n</tr>\n<tr>\n<td><code>reference</code></td>\n<td>string</td>\n<td>Display messages including the specified reference</td>\n</tr>\n<tr>\n<td><code>created_from</code></td>\n<td>datetime</td>\n<td>Display messages created from the specified date in RFC3339 format (Y-m-d\\TH:i:sP).</td>\n</tr>\n<tr>\n<td><code>created_until</code></td>\n<td>datetime</td>\n<td>Display messages created until the specified date in RFC3339 format (Y-m-d\\TH:i:sP).</td>\n</tr>\n<tr>\n<td><code>scheduled_from</code></td>\n<td>datetime</td>\n<td>Display messages scheduled from the specified date in RFC3339 format (Y-m-d\\TH:i:sP).</td>\n</tr>\n<tr>\n<td><code>scheduled_until</code></td>\n<td>datetime</td>\n<td>Display messages scheduled until the specified date in RFC3339 format (Y-m-d\\TH:i:sP).</td>\n</tr>\n<tr>\n<td><code>status</code></td>\n<td>string</td>\n<td>Display messages with status <code>pending</code>, <code>sent</code>, <code>delivered</code>, <code>failed</code></td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"includes\">Includes</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Includes</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>recipients</code></td>\n<td>Display all recipient information</td>\n</tr>\n<tr>\n<td><code>route</code></td>\n<td>Display route id</td>\n</tr>\n<tr>\n<td><code>country_code</code></td>\n<td>Display recipients country_code (e.g. <code>NL</code>) -&gt; <code>null</code> if not available</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["v1","messages"],"host":["{{server}}"],"query":[{"key":"filters[recipient_number]","value":"31612345678"},{"key":"with[]","value":"recipients"}],"variable":[]}},"response":[{"id":"03d4e9f2-d24d-454c-b45e-16d674314551","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{server}}/v1/messages?filters[recipient_number]=31612345678&with[]=recipients","host":["{{server}}"],"path":["v1","messages"],"query":[{"key":"filters[recipient_number]","value":"31612345678"},{"key":"with[]","value":"recipients"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Feb 2019 14:12:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"576"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"299"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n    \"total\": 1,\n    \"per_page\": 15,\n    \"current_page\": 1,\n    \"last_page\": 1,\n    \"next_page_url\": \"\",\n    \"prev_page_url\": \"\",\n    \"from\": 1,\n    \"to\": 1,\n    \"data\": [\n        {\n            \"id\": \"8cfc0ddb-75ba-46d4-9c5c-7bd0208be402\",\n            \"encoding\": \"auto\",\n            \"originator\": \"DocsTest\",\n            \"body\": \"This is a test message.\",\n            \"reference\": \"\",\n            \"credits\": 1.2,\n            \"scheduled_at\": \"2019-02-14T11:58:41+01:00\",\n            \"created_at\": \"2019-02-14T11:58:41+01:00\",\n            \"updated_at\": \"2019-02-14T11:58:45+01:00\",\n            \"links\": {\n                \"self\": \"https://rest.spryngsms.com/v1/messages/8cfc0ddb-75ba-46d4-9c5c-7bd0208be402\"\n            },\n            \"recipients\": [\n                {\n                    \"number\": \"31612345678\",\n                    \"status\": \"delivered\",\n                    \"sent_at\": \"2019-02-14T11:59:30+01:00\"\n                }\n            ]\n        }\n    ]\n}"}],"_postman_id":"9d59b689-4967-4b87-8ec7-9102c3de632d"},{"name":"Show Message","id":"7e2ce8c0-18b3-435c-b9ff-7f5b5d0bd971","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{server}}/v1/messages/{{message_uuid}}","description":"<p>Get the information of one message.</p>\n<h4 id=\"required-parameters\">Required Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>string</td>\n<td>A unique random ID which is created by Spryng and is returned upon creation of the object.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"includes\">Includes</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Includes</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>recipients</code></td>\n<td>Display all recipient information</td>\n</tr>\n<tr>\n<td><code>route</code></td>\n<td>Display route id</td>\n</tr>\n<tr>\n<td><code>country_code</code></td>\n<td>Display recipients country_code (e.g. NL) -&gt; null if not available</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["v1","messages","{{message_uuid}}"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"2ed6c08d-4243-468f-8150-af6c9e481a15","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{server}}/v1/messages/{{message_uuid}}?with[]=recipients","host":["{{server}}"],"path":["v1","messages","{{message_uuid}}"],"query":[{"key":"with[]","value":"recipients"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 05 Dec 2018 16:15:51 GMT"},{"key":"Server","value":"Apache/2.4.29 (Unix) OpenSSL/1.0.2o PHP/7.1.14"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"298"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Robots-Tag","value":"none"},{"key":"Content-Length","value":"405"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"8c6da478-8721-469d-8bbd-db4bbcdefa04\",\n    \"encoding\": \"unicode\",\n    \"originator\": \"31612345678\",\n    \"body\": \"This is a test message.\",\n    \"reference\": \"\",\n    \"credits\": 1,\n    \"scheduled_at\": \"2019-01-01T13:00:00+00:00\",\n    \"created_at\": \"2018-12-05T15:56:26+00:00\",\n    \"updated_at\": \"2018-12-05T15:56:27+00:00\",\n    \"links\": {\n        \"self\": \"http://api.spryng.local/v1/messages/8c6da478-8721-469d-8bbd-db4bbcdefa04\"\n    }\n}"}],"_postman_id":"7e2ce8c0-18b3-435c-b9ff-7f5b5d0bd971"},{"name":"Cancel Message","id":"42cec3db-be94-4051-9a29-77e4bf86df67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{server}}/v1/messages/{{message_uuid}}/cancel","description":"<p>Cancel a message scheduled in the future the information of one message.</p>\n<h4 id=\"required-parameters\">Required Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>string</td>\n<td>A unique random ID which is created by Spryng and is returned upon creation of the object.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["v1","messages","{{message_uuid}}","cancel"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"475290bc-bf7e-4809-83fc-d78d93e552c8","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{server}}/v1/messages/{{message_uuid}}/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Wed, 05 Dec 2018 16:49:05 GMT"},{"key":"Server","value":"Apache/2.4.29 (Unix) OpenSSL/1.0.2o PHP/7.1.14"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"297"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Robots-Tag","value":"none"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"42cec3db-be94-4051-9a29-77e4bf86df67"}],"id":"79adec1f-c4fe-4496-a561-468464f5c920","description":"<p>The below section is about sending, listing and cancelling messages. By default messages are retained for 7 days. However you can contact support to request a change for this retention period.</p>\n","_postman_id":"79adec1f-c4fe-4496-a561-468464f5c920"},{"name":"Balance","item":[{"name":"Get Balance","id":"2123795c-deb7-43c3-b24f-962d854535ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{server}}/v1/balance","description":"<p>Get the current balance/credits of your account.</p>\n","urlObject":{"path":["v1","balance"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"e8c47bd1-2ae5-44c7-81c6-b46931f99a25","name":"Get Balance","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"url":"{{server}}/v1/balance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, private","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"15","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 28 Sep 2018 09:13:42 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=31536000;","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Vary","value":"Authorization","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-RateLimit-Limit","value":"120","name":"X-RateLimit-Limit","description":"Custom header"},{"key":"X-RateLimit-Remaining","value":"117","name":"X-RateLimit-Remaining","description":"Custom header"},{"key":"X-Robots-Tag","value":"none","name":"X-Robots-Tag","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"amount\":10.5}"}],"_postman_id":"2123795c-deb7-43c3-b24f-962d854535ce"}],"id":"99c9ea9d-29c6-448a-be09-869ca4269f49","_postman_id":"99c9ea9d-29c6-448a-be09-869ca4269f49","description":""},{"name":"Subaccounts","item":[{"name":"Create Subaccount","event":[{"listen":"test","script":{"id":"4c9ba222-24be-4282-a468-073794a4bb6f","exec":["var data = JSON.parse(responseBody);","","if (data.email) {","    postman.setEnvironmentVariable(\"subaccount_id\", data.id);","}"],"type":"text/javascript","packages":{}}}],"id":"898c46fe-5ce8-4111-b7ef-2c148424b3d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"username\": \"johndoe\"\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/v1/subaccounts","description":"<p>Create a new subaccount.</p>\n<h4 id=\"required-parameters\">Required Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameters</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>username</code></td>\n<td>string</td>\n<td>the name of the clientaccount. <strong>attention:</strong> the client account name from the mainaccount will automatically be appended by Spryng.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"optional-parameters\">Optional Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameters</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>email</code></td>\n<td>string</td>\n<td>email of the user, which can then login into the portal of the subaccount</td>\n</tr>\n<tr>\n<td><code>password</code></td>\n<td>string</td>\n<td>password of the user, which can then login into the portal of the subaccount. must be at least 14 characters, capital case, special characters, numbers and not include personal identifiable information .</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"includes\">Includes</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Includes</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>token</code></td>\n<td>Return a bearer token for that subaccount to communicate with the REST API</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["v1","subaccounts"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"2a0d80ac-db3e-4d1c-8204-8409123bbd8e","name":"200 - OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"username\": \"johndoe\",\n    \"password\": \"LongPassword123\",\n    \"email\": \"johndoe@spryng.nl\"\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/v1/subaccounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Jul 2021 11:04:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.46 () OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"60838\",\n    \"first_name\": \"\",\n    \"middle_name\": \"\",\n    \"last_name\": \"\",\n    \"username\": \"spryng_johndoe\",\n    \"email\": \"johndoe@spryng.nl\",\n    \"is_active\": true\n}"},{"id":"2dc7d529-70a9-4f7a-bc64-6c937c9f779b","name":"200 - OK with Token","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"username\": \"johndoe\",\n    \"password\": \"LongPassword123\",\n    \"email\": \"johndoe@spryng.nl\"\n    \n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{server}}/v1/subaccounts?with[]=token","host":["{{server}}"],"path":["v1","subaccounts"],"query":[{"key":"with[]","value":"token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Jul 2021 11:04:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.46 () OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"60838\",\n    \"first_name\": \"\",\n    \"middle_name\": \"\",\n    \"last_name\": \"\",\n    \"username\": \"spryng_johndoe\",\n    \"email\": \"johndoe@spryng.nl\",\n    \"is_active\": true,\n    \"token\": {\n        \"bearer\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI0IiwianRpIjoiY2EzZGNiOWVmYjFlZDE5ODc5MzM3YTJjOTllMDcyOWQ1YTA2NzM4YTQyMGMyYTFmNmYzNDM5YTMwZjAwZjIyZGVkM2M1MjI5NjI5NGI2NjIiLCJpYXQiOiIxNjI2MjQ4MTU0LjYyMjg3NyIsIm5iZiI6IjE2MjYyNDgxNTQuNjIyODgwIiwiZXhwIjoiNDc4MTkyNTM1NC40OTkxMzYiLCJzdWIiOiI2ODE2OCIsInNjb3BlcyI6WyIqIl19.Ky8kvA7CG9YPQe8ZYzj6Z8upJfcsO8rqYM8F9g6IuQkAelEwKas5niJ5EWWZnfXUuhFiH61Kg9O7mTgYlVMm_RFe95DY9kgsFlG9I-2fdzZaeDL5JBogkts5OwPXTwDb11SO2T0p6iER5xON0ZUolJWoHwNpba-Nq6a1j_-9EMfqmcwP4stUkHidd3bB8Ry1brGNOJ5wNX700Ok6QoBW4UD8xipvv4IMh2Z470kSQyI7EuwqxNtdWMdZ7uwVFBBStu7yiWxDgQVZBJ9S3_BjF4z_0JH8gY8zyutjkB5JOIj4tvMubxjq9-ZC6AhK5wxbsD07Sh1_R-TeCf-Pt8AMnDPoRz5UEaAIxkqbgf1ujEU0drpjxyL_wgVOT1w-xS1SDSmbEwR1WyXqc_GM1rSFJc0yNXexRhAaJ4eAziK2iVTulK5g_6xGwrHa665zTGvkZa4j8lsTT06_UE5xZZhTAXAYINfNXJ8NgXvPR_ccDKuaiUinecrMgZ3i2oYOcJdvsDceQ1Mqs9frKKUjg3k53CuV4VaEwS1sfFXmyo-Bi63fBz0uNOtLCf5ftP67Ud3Peoj41Xq7Kxtmu7olnlnPm1LiqT0UhbNEbRsK38DZrqJLnxadsgH1nwxuOEqHi-DNTW61b2kwKriSm6mGHVaPjoYBbX6qBtps0jiBRlcQMbM\"\n    }\n}"},{"id":"6f439cf7-3934-4cc3-9a07-f06d91dd0b85","name":"403 - Forbidden","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"username\": \"johndoe\",\n    \"password\": \"LongPassword123\",\n    \"email\": \"johndoe@spryng.nl\"\n}"},"url":"{{server}}/v1/subaccounts"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Jul 2021 06:21:16 GMT"},{"key":"Server","value":"Apache/2.4.43 (Unix) OpenSSL/1.1.1k PHP/7.4.16"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.4.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"598"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"X-Robots-Tag","value":"none"},{"key":"Content-Length","value":"107"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"This action is unauthorized. Please contact support to enable this subaccount feature.\"\n}"},{"id":"29b1d84f-ede5-4154-85b7-ce75000d3919","name":"422 - Unprocessable Entity","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{server}}/v1/subaccounts"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Jul 2021 11:14:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.46 () OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"The given data was invalid.\",\n    \"errors\": {\n        \"username\": [\n            \"The username field is required.\"\n        ],\n        \"password\": [\n            \"The password field is required.\"\n        ],\n        \"email\": [\n            \"The e-mail field is required.\"\n        ]\n    }\n}"}],"_postman_id":"898c46fe-5ce8-4111-b7ef-2c148424b3d0"},{"name":"List Subaccounts","id":"d981cd9f-51b0-4001-9dab-53394d4bdd9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{server}}/v1/subaccounts?filters[is_active]=true&filters[search]=john&sort=username","description":"<p>To list all subaccounts for your account.</p>\n<h4 id=\"body-parameters\">Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Filter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>is_active</code></td>\n<td>boolean</td>\n<td>Show active/inactive subaccounts</td>\n</tr>\n<tr>\n<td><code>search</code></td>\n<td>string</td>\n<td>Default search string which searches on username or email</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["v1","subaccounts"],"host":["{{server}}"],"query":[{"key":"filters[is_active]","value":"true"},{"key":"filters[search]","value":"john"},{"key":"sort","value":"username"}],"variable":[]}},"response":[{"id":"a986be5a-4987-42c6-a0e7-a66e7cc687f1","name":"200 - OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{server}}/v1/subaccounts?filters[is_active]=true&filters[search]=john&sort=username","host":["{{server}}"],"path":["v1","subaccounts"],"query":[{"key":"filters[is_active]","value":"true"},{"key":"filters[search]","value":"john"},{"key":"sort","value":"username"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Jul 2021 06:26:47 GMT"},{"key":"Server","value":"Apache/2.4.43 (Unix) OpenSSL/1.1.1k PHP/7.4.16"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.4.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"596"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"X-Robots-Tag","value":"none"},{"key":"Content-Length","value":"269"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"total\": 1,\n    \"per_page\": 15,\n    \"current_page\": 1,\n    \"last_page\": 1,\n    \"next_page_url\": \"\",\n    \"prev_page_url\": \"\",\n    \"from\": 1,\n    \"to\": 1,\n    \"data\": [\n        {\n            \"id\": \"60838\",\n            \"first_name\": \"\",\n            \"middle_name\": \"\",\n            \"last_name\": \"\",\n            \"username\": \"spryng_johndoe\",\n            \"email\": \"johndoe@spryng.n\",\n            \"is_active\": true\n        }\n    ]\n}"},{"id":"1bd9dd9f-78d5-4877-a39e-bb2836dd525b","name":"403 - Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{server}}/v1/subaccounts?filters[is_active]=true&filters[search]=john&sort=username","host":["{{server}}"],"path":["v1","subaccounts"],"query":[{"key":"filters[is_active]","value":"true"},{"key":"filters[search]","value":"john"},{"key":"sort","value":"username"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Jul 2021 06:21:16 GMT"},{"key":"Server","value":"Apache/2.4.43 (Unix) OpenSSL/1.1.1k PHP/7.4.16"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.4.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"598"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"X-Robots-Tag","value":"none"},{"key":"Content-Length","value":"107"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"This action is unauthorized. Please contact support to enable this subaccount feature.\"\n}"}],"_postman_id":"d981cd9f-51b0-4001-9dab-53394d4bdd9d"},{"name":"Stats Subaccounts","id":"970bec37-46de-4653-b767-9bb4c7909e4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{server}}/v1/subaccounts/stats?filters[year]=2021&filters[is_active]=true","description":"<p>View stats for your subaccounts</p>\n<h4 id=\"body-parameters\">Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Filter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>is_active</code></td>\n<td>boolean</td>\n<td>Show active/inactive subaccounts. <strong>default</strong> is active</td>\n</tr>\n<tr>\n<td><code>search</code></td>\n<td>string</td>\n<td>Default search string which searches on username or email</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["v1","subaccounts","stats"],"host":["{{server}}"],"query":[{"key":"filters[year]","value":"2021"},{"key":"filters[is_active]","value":"true"}],"variable":[]}},"response":[{"id":"2be1b87c-d7e4-4f2c-9fce-738f823ec102","name":"200 - OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{server}}/v1/subaccounts/stats?filters[year]=2021","host":["{{server}}"],"path":["v1","subaccounts","stats"],"query":[{"key":"filters[year]","value":"2021"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Jul 2021 06:28:11 GMT"},{"key":"Server","value":"Apache/2.4.43 (Unix) OpenSSL/1.1.1k PHP/7.4.16"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.4.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"599"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"X-Robots-Tag","value":"none"},{"key":"Content-Length","value":"3242"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"subaccounts\": [\n        {\n            \"id\": 60838,\n            \"username\": \"spryng_johndoe\",\n            \"results\": {\n                \"2021-01\": {\n                    \"total_messages\": 12730,\n                    \"total_credits\": 12730\n                },\n                \"2021-02\": {\n                    \"total_messages\": 83723,\n                    \"total_credits\": 93401\n                },\n                \"2021-03\": {\n                    \"total_messages\": 0,\n                    \"total_credits\": 0\n                },\n                \"2021-04\": {\n                    \"total_messages\": 0,\n                    \"total_credits\": 0\n                },\n                \"2021-05\": {\n                    \"total_messages\": 0,\n                    \"total_credits\": 0\n                },\n                \"2021-06\": {\n                    \"total_messages\": 0,\n                    \"total_credits\": 0\n                },\n                \"2021-07\": {\n                    \"total_messages\": 0,\n                    \"total_credits\": 0\n                },\n                \"2021-08\": {\n                    \"total_messages\": 0,\n                    \"total_credits\": 0\n                },\n                \"2021-09\": {\n                    \"total_messages\": 0,\n                    \"total_credits\": 0\n                },\n                \"2021-10\": {\n                    \"total_messages\": 0,\n                    \"total_credits\": 0\n                },\n                \"2021-11\": {\n                    \"total_messages\": 0,\n                    \"total_credits\": 0\n                },\n                \"2021-12\": {\n                    \"total_messages\": 0,\n                    \"total_credits\": 0\n                }\n            }\n        }\n    ]\n}"},{"id":"9a98dcbb-fc14-4cc7-8f93-09bbabeb535f","name":"403 - Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{server}}/v1/subaccounts/stats?filters[year]=2021","host":["{{server}}"],"path":["v1","subaccounts","stats"],"query":[{"key":"filters[year]","value":"2021"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Jul 2021 06:21:16 GMT"},{"key":"Server","value":"Apache/2.4.43 (Unix) OpenSSL/1.1.1k PHP/7.4.16"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.4.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"598"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"X-Robots-Tag","value":"none"},{"key":"Content-Length","value":"107"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"This action is unauthorized. Please contact support to enable this subaccount feature.\"\n}"}],"_postman_id":"970bec37-46de-4653-b767-9bb4c7909e4d"},{"name":"Update Subaccount","id":"4a414c2f-163b-416c-bcef-d16aa952e26c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"is_active\": true\n}"},"url":"{{server}}/v1/subaccounts/{{subaccount_id}}","description":"<p>Update existing subaccount.</p>\n<h4 id=\"required-parameters\">Required Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameters</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>is_active</code></td>\n<td>boolean</td>\n<td>enable or disable a subaccount</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["v1","subaccounts","{{subaccount_id}}"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"3de10e4e-e259-4b35-b559-a92dc85084c8","name":"200 - OK","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"is_active\": false\n}"},"url":"{{server}}/v1/subaccounts/{{subaccount_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Jul 2021 06:30:15 GMT"},{"key":"Server","value":"Apache/2.4.43 (Unix) OpenSSL/1.1.1k PHP/7.4.16"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.4.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"598"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"X-Robots-Tag","value":"none"},{"key":"Content-Length","value":"149"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"60838\",\n    \"first_name\": \"\",\n    \"middle_name\": \"\",\n    \"last_name\": \"\",\n    \"username\": \"spryng_johndoe\",\n    \"email\": \"johndoe@spryng.nl\",\n    \"is_active\": false\n}"},{"id":"9e6f7555-703f-4710-a27c-d47530169331","name":"403 - Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{server}}/v1/subaccounts"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Jul 2021 06:21:16 GMT"},{"key":"Server","value":"Apache/2.4.43 (Unix) OpenSSL/1.1.1k PHP/7.4.16"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.4.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"598"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"X-Robots-Tag","value":"none"},{"key":"Content-Length","value":"107"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"This action is unauthorized. Please contact support to enable this subaccount feature.\"\n}"},{"id":"73a6015a-b971-4624-80d6-1db6acb4d977","name":"404 - Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"is_active\": true\n}"},"url":"{{server}}/v1/subaccounts/{{subaccount_id}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Jul 2021 06:38:32 GMT"},{"key":"Server","value":"Apache/2.4.43 (Unix) OpenSSL/1.1.1k PHP/7.4.16"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.4.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"598"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"X-Robots-Tag","value":"none"},{"key":"Content-Length","value":"45"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Subaccount not found for ID 54435\"\n}"}],"_postman_id":"4a414c2f-163b-416c-bcef-d16aa952e26c"},{"name":"Delete Subaccount","id":"214c1192-86c3-44bb-ab35-2e1ae99df034","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{server}}/v1/subaccounts/{{subaccount_id}}","description":"<p>Deleting a subaccount. This will <strong>archive</strong> the subaccount. It won't be possible to restore this subaccount, however will be retained for stats/history purpose. If you require to restore/wipe the subaccounts data, please contact Spryng Support.</p>\n","urlObject":{"path":["v1","subaccounts","{{subaccount_id}}"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"5b44818e-c169-4fdc-b4c9-984983ff8692","name":"200 - OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{server}}/v1/subaccounts/{{subaccount_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Jul 2021 06:31:08 GMT"},{"key":"Server","value":"Apache/2.4.43 (Unix) OpenSSL/1.1.1k PHP/7.4.16"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.4.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"599"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"X-Robots-Tag","value":"none"},{"key":"Content-Length","value":"174"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"60838\",\n    \"first_name\": \"\",\n    \"middle_name\": \"\",\n    \"last_name\": \"\",\n    \"username\": \"!20210712_083108__54435_spryng_johndoe\",\n    \"email\": \"johndoe@spryng.nl\",\n    \"is_active\": false\n}"},{"id":"1766d9a3-1f9e-4d64-9fca-aa74dadc5574","name":"403 - Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{server}}/v1/subaccounts/{{subaccount_id}}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Jul 2021 06:21:16 GMT"},{"key":"Server","value":"Apache/2.4.43 (Unix) OpenSSL/1.1.1k PHP/7.4.16"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.4.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"600"},{"key":"X-RateLimit-Remaining","value":"598"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"X-Robots-Tag","value":"none"},{"key":"Content-Length","value":"107"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"This action is unauthorized. Please contact support to enable this subaccount feature.\"\n}"}],"_postman_id":"214c1192-86c3-44bb-ab35-2e1ae99df034"}],"id":"7dd456b4-9b62-4850-8b69-cf94ceddf454","description":"<p><strong>Important</strong>: You need to have the subaccount-feature enabled for your account before you can start using this. if you don't have this enabled yet please contact <a>Spryng</a></p>\n","_postman_id":"7dd456b4-9b62-4850-8b69-cf94ceddf454"},{"name":"Meta WhatsApp API","item":[{"name":"Templates","item":[{"name":"Get Template","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"6544afaf-f51d-42f3-ace3-1f814defcbf6"}}],"id":"0249fec4-2eeb-493c-817a-be7b18f6a3f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{server}}/v1/whatsapp/<version>/<waba_id>/message_templates","description":"<h4 id=\"required-request-parameters\">Required Request Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Sample Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>version</code></td>\n<td><code>v17.0</code></td>\n<td>The Cloud API version.</td>\n</tr>\n<tr>\n<td><code>waba_id</code></td>\n<td></td>\n<td>WhatsApp Business Account ID</td>\n</tr>\n</tbody>\n</table>\n</div><p><a href=\"https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates\">Meta Documentation - Get Template</a></p>\n","urlObject":{"path":["v1","whatsapp","<version>","<waba_id>","message_templates"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"5f64c239-61c4-4d45-bb97-b7c2f7449be7","name":"200 - OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{server}}/v1/whatsapp/v15.0/<waba_id>/message_templates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Jul 2021 11:04:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.46 () OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": [\n    {\n      \"name\": \"hello_world\",\n      \"components\": [{\n          \"type\": \"BODY\",\n          \"text\": \"Hello, {{1}}\"\n      }],\n      \"language\": \"en_US\",\n      \"status\": \"APPROVED\",\n      \"category\": \"TRANSACTIONAL\",\n      \"id\": \"409119052980796\"\n    },\n    {\n      \"name\": \"case_opened\",\n      \"components\": [{\n          \"type\": \"BODY\",\n          \"text\": \"Seu caso {{1}} foi aberto. Entraremos em contato em breve.\"\n      }],\n      \"language\": \"pt_BR\",\n      \"status\": \"APPROVED\",\n      \"category\": \"TRANSACTIONAL\",\n      \"id\": \"718173718589371\"\n    },\n    {\n      \"name\": \"case_opened\",\n      \"components\": [{\n          \"type\": \"BODY\",\n          \"text\": \"Your case {{1}} was opened. We will get in touch soon.\"\n      }],\n      \"language\": \"en_US\",\n      \"status\": \"APPROVED\",\n      \"category\": \"TRANSACTIONAL\",\n      \"id\": \"755551981307120\"\n    }\n  ],\n  \"paging\": {\n    \"cursors\": {\n      \"before\": \"MAZDZD\",\n      \"after\": \"MjQZD\"\n    }\n  }"}],"_postman_id":"0249fec4-2eeb-493c-817a-be7b18f6a3f7"},{"name":"Create Template","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"557db77e-a237-4873-af5d-69aeab851d1a"}}],"id":"88b0941e-cc28-4a0b-92de-43b16fdca25f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"name\": \"<name>\",\n    \"language\": \"<language_code>\",\n    \"category\": \"<category>\",\n    \"components\": \"[<components>]\"\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/v1/whatsapp/<version>/<waba_id>/message_templates","description":"<h4 id=\"required-request-parameters\">Required Request Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Sample Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>version</code></td>\n<td><code>v17.0</code></td>\n<td>The Cloud API version.</td>\n</tr>\n<tr>\n<td><code>waba_id</code></td>\n<td></td>\n<td>WhatsApp Business Account ID</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"payload-values\">Payload Values</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameters</th>\n<th>Type</th>\n<th>Sample Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>name</code></td>\n<td>string</td>\n<td><code>seasonal_promotion</code></td>\n<td>Template name</td>\n</tr>\n<tr>\n<td><code>language_code</code></td>\n<td>string</td>\n<td><code>en_US</code></td>\n<td>Template language and locale code</td>\n</tr>\n<tr>\n<td><code>category</code></td>\n<td>string</td>\n<td><code>MARKETING</code>, <code>UTILITY</code>, <code>AUTHENTICATION</code></td>\n<td>Template category</td>\n</tr>\n<tr>\n<td><code>components</code></td>\n<td>array</td>\n<td>See example</td>\n<td>Components that make up the template</td>\n</tr>\n</tbody>\n</table>\n</div><p><a href=\"https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates\">Meta Documentation - Create Template</a></p>\n","urlObject":{"path":["v1","whatsapp","<version>","<waba_id>","message_templates"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"4408fd9b-179a-43f0-b833-f74d955134d2","name":"200 - OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"name\": \"seasonal_promotion\",\n    \"language\": \"en_US\",\n    \"category\": \"MARKETING\",\n    \"components\": [\n        {\n            \"type\": \"HEADER\",\n            \"format\": \"TEXT\",\n            \"text\": \"Our {{1}} is on!\",\n            \"example\": {\n                \"header_text\": [\n                    \"Summer Sale\"\n                ]\n            }\n        },\n        {\n            \"type\": \"BODY\",\n            \"text\": \"Shop now through {{1}} and use code {{2}} to get {{3}} off of all merchandise.\",\n            \"example\": {\n                \"body_text\": [\n                    [\n                        \"the end of August\",\n                        \"25OFF\",\n                        \"25%\"\n                    ]\n                ]\n            }\n        },\n        {\n            \"type\": \"FOOTER\",\n            \"text\": \"Use the buttons below to manage your marketing subscriptions\"\n        },\n        {\n            \"type\": \"BUTTONS\",\n            \"buttons\": [\n                {\n                    \"type\": \"QUICK_REPLY\",\n                    \"text\": \"Unsubscribe from Promos\"\n                },\n                {\n                    \"type\": \"QUICK_REPLY\",\n                    \"text\": \"Unsubscribe from All\"\n                }\n            ]\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/v1/whatsapp/v15.0/<waba_id>/message_templates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Jul 2021 11:04:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.46 () OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"594425479261596\",\n    \"status\": \"PENDING\",\n    \"category\": \"MARKETING\"\n}"}],"_postman_id":"88b0941e-cc28-4a0b-92de-43b16fdca25f"},{"name":"Update Template","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"7aa5baa5-ac2d-4ca6-b8f7-297af9543a88"}}],"id":"c0a24dc3-03a4-4d0d-a633-a3cf5250c68e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"components\": [\n        {\n            \"type\": \"BODY\",\n            \"text\": \"Shop now through {{1}} and use code {{2}} to get {{3}} off of all merchandise.\",\n            \"example\": {\n                \"body_text\": [\n                    [\n                        \"the end of August\",\n                        \"25OFF\",\n                        \"25%\"\n                    ]\n                ]\n            }\n        },\n        {\n            \"type\": \"BUTTONS\",\n            \"buttons\": [\n                {\n                    \"type\": \"QUICK_REPLY\",\n                    \"text\": \"Unsubscribe from Promos\"\n                },\n                {\n                    \"type\": \"QUICK_REPLY\",\n                    \"text\": \"Unsubscribe from All\"\n                }\n            ]\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/v1/whatsapp/<version>/<message_template_id>","description":"<p>Editing a template replaces its old contents entirely, so include any components you wish to preserve as well as components you wish to update using the <code>components</code> parameter.</p>\n<h4 id=\"required-request-parameters\">Required Request Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Sample Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>version</code></td>\n<td><code>v17.0</code></td>\n<td>The Cloud API version.</td>\n</tr>\n<tr>\n<td><code>message_template_id</code></td>\n<td></td>\n<td>The ID from a message template</td>\n</tr>\n</tbody>\n</table>\n</div><p><a href=\"https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates\">Meta Documentation - Update Template</a></p>\n","urlObject":{"path":["v1","whatsapp","<version>","<message_template_id>"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"4c69681a-90ba-4aab-b94f-489ecf315be7","name":"200 - OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"{{server}}/v1/whatsapp/<version>/409119052980796"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Jul 2021 11:04:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.46 () OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true\n}"}],"_postman_id":"c0a24dc3-03a4-4d0d-a633-a3cf5250c68e"},{"name":"Delete Template","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"9b5d9def-44c9-4b8d-95d8-c7adbce306dd"}}],"id":"6a213c66-1156-4005-a828-ddc83ccc5f39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"components\": [\n        {\n            \"type\": \"BODY\",\n            \"text\": \"Shop now through {{1}} and use code {{2}} to get {{3}} off of all merchandise.\",\n            \"example\": {\n                \"body_text\": [\n                    [\n                        \"the end of August\",\n                        \"25OFF\",\n                        \"25%\"\n                    ]\n                ]\n            }\n        },\n        {\n            \"type\": \"BUTTONS\",\n            \"buttons\": [\n                {\n                    \"type\": \"QUICK_REPLY\",\n                    \"text\": \"Unsubscribe from Promos\"\n                },\n                {\n                    \"type\": \"QUICK_REPLY\",\n                    \"text\": \"Unsubscribe from All\"\n                }\n            ]\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/v1/whatsapp/<version>/<waba_id>/message_templates?name=<name>","description":"<h4 id=\"required-request-parameters\">Required Request Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Sample Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>version</code></td>\n<td><code>v17.0</code></td>\n<td>The Cloud API version.</td>\n</tr>\n<tr>\n<td><code>waba_id</code></td>\n<td></td>\n<td>WhatsApp Business Account ID</td>\n</tr>\n<tr>\n<td><code>name</code></td>\n<td><code>order_confirmation</code></td>\n<td>The name of the template</td>\n</tr>\n</tbody>\n</table>\n</div><p><a href=\"https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates\">Meta Documentation - Delete Template</a></p>\n","urlObject":{"path":["v1","whatsapp","<version>","<waba_id>","message_templates"],"host":["{{server}}"],"query":[{"key":"name","value":"<name>"}],"variable":[]}},"response":[{"id":"5f54e701-89a2-482b-9672-033dc6be3de3","name":"200 - OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"components\": [\n        {\n            \"type\": \"BODY\",\n            \"text\": \"Shop now through {{1}} and use code {{2}} to get {{3}} off of all merchandise.\",\n            \"example\": {\n                \"body_text\": [\n                    [\n                        \"the end of August\",\n                        \"25OFF\",\n                        \"25%\"\n                    ]\n                ]\n            }\n        },\n        {\n            \"type\": \"BUTTONS\",\n            \"buttons\": [\n                {\n                    \"type\": \"QUICK_REPLY\",\n                    \"text\": \"Unsubscribe from Promos\"\n                },\n                {\n                    \"type\": \"QUICK_REPLY\",\n                    \"text\": \"Unsubscribe from All\"\n                }\n            ]\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{server}}/v1/whatsapp/<version>/<waba_id>/message_templates?name=order_confirmation","host":["{{server}}"],"path":["v1","whatsapp","<version>","<waba_id>","message_templates"],"query":[{"key":"name","value":"order_confirmation"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Jul 2021 11:04:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.46 () OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true\n}"}],"_postman_id":"6a213c66-1156-4005-a828-ddc83ccc5f39"}],"id":"a69e34fd-d6a7-485e-9b5e-d169a5a6ae83","_postman_id":"a69e34fd-d6a7-485e-9b5e-d169a5a6ae83","description":""},{"name":"Media","item":[{"name":"Upload Media","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"85ca8cf6-e666-404b-b45a-1ee7060dc5c2"}}],"id":"d3f180cf-c8e0-4e28-b398-ad2d1efcdacc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"messaging_product","value":"whatsapp","type":"text"},{"key":"file","type":"file","value":null},{"key":"type","value":"image/png","type":"text"}]},"url":"{{server}}/v1/whatsapp/<version>/<phone_number_id>/media","description":"<h4 id=\"required-request-parameters\">Required Request Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Sample Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>version</code></td>\n<td><code>v17.0</code></td>\n<td>The Cloud API version.</td>\n</tr>\n<tr>\n<td><code>phone_number_id</code></td>\n<td><code>105954558954427</code></td>\n<td>ID of the business phone number to send the message from</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"payload-values\">Payload Values</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameters</th>\n<th>Sample Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>file</code></td>\n<td><code>@/local/path/file.jpg</code></td>\n<td>Path to the file stored in your local directory</td>\n</tr>\n<tr>\n<td><code>type</code></td>\n<td>Supported options for images are:  <br /><code>image/jpeg</code>  <br /><code>image/png</code>  <br />Supported options for documents are:  <br /><code>text/plain</code>  <br /><code>application/pdf application/vnd.ms-powerpoint application/msword application/vnd.ms-excel application/vnd.openxmlformats-officedocument.wordprocessingml.document application/vnd.openxmlformats-officedocument.presentationml.presentation application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</code>  <br />Supported options for audio are:  <br /><code>audio/aac audio/mp4 audio/mpeg audio/amr audio/ogg audio/opus</code>  <br />Supported options for video are:  <br /><code>video/mp4</code>  <br /><code>video/3gp</code>  <br />  <br />Supported options for stickers are:  <br /><code>image/webp</code></td>\n<td>Type of media file being uploaded</td>\n</tr>\n<tr>\n<td><code>messaging_product</code></td>\n<td><code>whatsapp</code></td>\n<td>Messaging service used for the request.</td>\n</tr>\n</tbody>\n</table>\n</div><p><a href=\"https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media\">Meta Documentation - Upload Media</a></p>\n","urlObject":{"path":["v1","whatsapp","<version>","<phone_number_id>","media"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"560d95a2-8ea6-49ea-bd1f-eb1142848b62","name":"200 - OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"messaging_product","value":"whatsapp","type":"text"},{"key":"file","type":"file","src":[]},{"key":"type","value":"image/png","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"{{server}}/v1/whatsapp/<version>/1906385232743451/media"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Jul 2021 11:04:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.46 () OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\":\"<MEDIA_ID>\"\n}"}],"_postman_id":"d3f180cf-c8e0-4e28-b398-ad2d1efcdacc"},{"name":"Retrieve Media URL","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"6ce5c759-88d1-427d-9906-40d43ba411d8"}}],"id":"782927ba-b9a9-47f0-a616-5935e664b2b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[],"url":"{{server}}/v1/whatsapp/<version>/<media_id>","description":"<h4 id=\"required-request-parameters\">Required Request Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Sample Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>version</code></td>\n<td><code>v17.0</code></td>\n<td>The Cloud API version.</td>\n</tr>\n<tr>\n<td><code>media_id</code></td>\n<td></td>\n<td>The ID for the uploaded media</td>\n</tr>\n</tbody>\n</table>\n</div><p><a href=\"https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media\">Meta Documentation - Retrieve Media</a></p>\n","urlObject":{"path":["v1","whatsapp","<version>","<media_id>"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"a8629ada-154f-44b4-af15-bf3d8af08a44","name":"200 - OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"url":"{{server}}/v1/whatsapp/<version>/<media_id>"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Jul 2021 11:04:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.46 () OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n  \"messaging_product\": \"whatsapp\",\n  \"url\": \"<URL>\",\n  \"mime_type\": \"<MIME_TYPE>\",\n  \"sha256\": \"<HASH>\",\n  \"file_size\": \"<FILE_SIZE>\",\n  \"id\": \"<MEDIA_ID>\"\n}\n"}],"_postman_id":"782927ba-b9a9-47f0-a616-5935e664b2b1"},{"name":"Delete Media","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"c5cdb730-a1f0-4aba-8564-014b883fe61e"}}],"id":"6d3a5848-15b2-45dc-b4ca-8b96b9c9887e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"DELETE","header":[],"url":"{{server}}/v1/whatsapp/<version>/<media_id>","description":"<h4 id=\"required-request-parameters\">Required Request Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Sample Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>version</code></td>\n<td><code>v17.0</code></td>\n<td>The Cloud API version.</td>\n</tr>\n<tr>\n<td><code>media_id</code></td>\n<td></td>\n<td>The ID for the uploaded media</td>\n</tr>\n</tbody>\n</table>\n</div><p><a href=\"https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media\">Meta Documentation - Delete Media</a></p>\n","urlObject":{"path":["v1","whatsapp","<version>","<media_id>"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"a60b382c-2de1-421a-8ddc-9df37612c489","name":"200 - OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"url":"{{server}}/v1/whatsapp/<version>/<media_id>"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Jul 2021 11:04:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.46 () OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true\n}"}],"_postman_id":"6d3a5848-15b2-45dc-b4ca-8b96b9c9887e"}],"id":"c281f109-4427-485f-b7cf-f1e83d6e6e51","_postman_id":"c281f109-4427-485f-b7cf-f1e83d6e6e51","description":""},{"name":"Send Message","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"c2fb68f5-ec45-4c21-a3a8-b016cc777cda"}}],"id":"2ffb75d8-c1a4-4ce1-a478-a221cfab8bf6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"messaging_product\": \"whatsapp\",\n    \"to\": \"<recipient_phone_number>\",\n    \"type\": \"template\",\n    \"template\": {\n       \"name\": \"<template_name>\",\n       \"language\": {\n           \"code\": \"<template_language_code>\",\n           \"policy\": \"deterministic\"\n       },\n       \"components\": [\n         {\n           \"type\": \"body\",\n           \"parameters\": [\n               {\n                   \"type\": \"text\",\n                   \"text\": \"2\"\n               }\n           ]\n         }\n       ]\n    }\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/v1/whatsapp/<version>/<phone_number_id>/messages","description":"<p>Before you can send a template message, you need to create a message template. This can be done in the Business Manager, see <a href=\"https://www.facebook.com/business/help/2055875911147364?id=2129163877102343\">Meta Documentation - create message template</a></p>\n<h4 id=\"required-request-parameters\">Required Request Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Sample Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>version</code></td>\n<td><code>v18.0</code></td>\n<td>The Cloud API version.</td>\n</tr>\n<tr>\n<td><code>phone_number_id</code></td>\n<td><code>105954558954427</code></td>\n<td>ID of the business phone number to send the message from</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"payload-values\">Payload Values</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameters</th>\n<th>Type</th>\n<th>Sample Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>recipient_phone_number</code></td>\n<td>string</td>\n<td><code>+31612345678</code></td>\n<td>The recipients WhatsApp phone number</td>\n</tr>\n<tr>\n<td><code>template_name</code></td>\n<td>string</td>\n<td><code>sample_shipping_confirmation</code></td>\n<td>The name of the template</td>\n</tr>\n<tr>\n<td><code>template_language_code</code></td>\n<td>string</td>\n<td><code>en_US</code></td>\n<td>The language and locale code of the template</td>\n</tr>\n</tbody>\n</table>\n</div><p><a href=\"https://developers.facebook.com/docs/whatsapp/cloud-api/guides/send-message-templates\">Meta Documentation - send template message</a></p>\n","urlObject":{"path":["v1","whatsapp","<version>","<phone_number_id>","messages"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"519ff92a-4ec2-4bcb-bb3d-1f63648f5f5a","name":"200 - OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"messaging_product\": \"whatsapp\",\n    \"to\": \"12015553931\",\n    \"type\": \"template\",\n    \"template\": {\n       \"name\": \"sample_shipping_confirmation\",\n       \"language\": {\n           \"code\": \"en_US\",\n           \"policy\": \"deterministic\"\n       },\n       \"components\": [\n         {\n           \"type\": \"body\",\n           \"parameters\": [\n               {\n                   \"type\": \"text\",\n                   \"text\": \"2\"\n               }\n           ]\n         }\n       ]\n    }\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/v1/whatsapp/v15.0/105954558954427/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Jul 2021 11:04:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.46 () OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n    \"messaging_product\": \"whatsapp\",\n    \"contacts\": [\n        {\n            \"input\": \"12015553931\",\n            \"wa_id\": \"12015553931\"\n        }\n    ],\n    \"messages\": [\n        {\n            \"id\": \"wamid.HBgLMTY1MDM4Nzk0MzkVAgARGBI4Qzc5QkNGNTc5NTMyMDU5QzEA\"\n        }\n    ]\n}"}],"_postman_id":"2ffb75d8-c1a4-4ce1-a478-a221cfab8bf6"},{"name":"Register a Business Phone Number","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"9ad2bffd-3f70-4969-9412-fe493cfb7f08"}}],"id":"f00d95bf-5f3d-4e15-97bf-cbd0cf8c1e40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"messaging_product\": \"whatsapp\",\n    \"pin\": \"<pin>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/v1/whatsapp/<version>/<phone_number_id>/register","description":"<h4 id=\"required-request-parameters\">Required Request Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Sample Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>version</code></td>\n<td><code>v17.0</code></td>\n<td>The Cloud API version.</td>\n</tr>\n<tr>\n<td><code>phone_number_id</code></td>\n<td><code>105954558954427</code></td>\n<td>ID of the business phone number to send the message from</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"payload-values\">Payload Values</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameters</th>\n<th>Sample Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>messaging_product</code></td>\n<td><code>whatsapp</code></td>\n<td>Messaging service used</td>\n</tr>\n<tr>\n<td><code>pin</code></td>\n<td><code>123456</code></td>\n<td>If your verified business phone number already has two-step verification enabled, set this value to your number's 6-digit two-step verification PIN. If you cannot recall your PIN, you can update it.  <br />  <br />If your verified business phone number does not have two-step verification enabled, set this value to a 6-digit number. This will be the newly verified business phone number's two-step verification PIN.</td>\n</tr>\n</tbody>\n</table>\n</div><p><a href=\"https://developers.facebook.com/docs/whatsapp/cloud-api/reference/registration\">Meta Documentation - Register Phone Number</a></p>\n","urlObject":{"path":["v1","whatsapp","<version>","<phone_number_id>","register"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"89a519dc-88a0-4297-8342-3fcae74fb115","name":"200 - OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"messaging_product\": \"whatsapp\",\n    \"pin\": \"123456\"\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/v1/whatsapp/<version>/1906385232743451/register"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Jul 2021 11:04:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.46 () OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true\n}"}],"_postman_id":"f00d95bf-5f3d-4e15-97bf-cbd0cf8c1e40"},{"name":"Deregister a Business Phone Number","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"8c31e97e-7bf1-424b-86ff-326303833956"}}],"id":"0611ea56-8cde-423d-99bf-34d3a0a15e18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"{{server}}/v1/whatsapp/<version>/<phone_number_id>/deregister","description":"<h4 id=\"required-request-parameters\">Required Request Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Sample Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>version</code></td>\n<td><code>v17.0</code></td>\n<td>The Cloud API version.</td>\n</tr>\n<tr>\n<td><code>phone_number_id</code></td>\n<td><code>105954558954427</code></td>\n<td>ID of the business phone number to send the message from</td>\n</tr>\n</tbody>\n</table>\n</div><p><a href=\"https://developers.facebook.com/docs/whatsapp/cloud-api/reference/registration\">Meta Documentation - Deregister Phone Number</a></p>\n","urlObject":{"path":["v1","whatsapp","<version>","<phone_number_id>","deregister"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"a9f682d3-6926-42fc-9c03-a9b420840fdb","name":"200 - OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"messaging_product\": \"whatsapp\",\n    \"pin\": \"123456\"\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/v1/whatsapp/<version>/1906385232743451/register"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Jul 2021 11:04:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.46 () OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true\n}"}],"_postman_id":"0611ea56-8cde-423d-99bf-34d3a0a15e18"},{"name":"Two-Step verification","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"28d4f348-e745-4248-bd00-e1ed07749521"}}],"id":"a9cb507c-f161-4f87-bd2f-e594f93442d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"pin\": \"<pin>\"\n}"},"url":"{{server}}/v1/whatsapp/<version>/<phone_number_id>","description":"<h4 id=\"required-request-parameters\">Required Request Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Sample Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>version</code></td>\n<td><code>v17.0</code></td>\n<td>The Cloud API version.</td>\n</tr>\n<tr>\n<td><code>phone_number_id</code></td>\n<td><code>105954558954427</code></td>\n<td>ID of the business phone number to send the message from</td>\n</tr>\n</tbody>\n</table>\n</div><p><a href=\"https://developers.facebook.com/docs/whatsapp/cloud-api/reference/registration\">Meta Documentation - Deregister Phone Number</a></p>\n","urlObject":{"path":["v1","whatsapp","<version>","<phone_number_id>"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"5d1d5b19-e561-45c6-b9b4-a085fb52259a","name":"200 - OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"pin\": \"<pin>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/v1/whatsapp/<version>/1906385232743451"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Jul 2021 11:04:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.46 () OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true\n}"}],"_postman_id":"a9cb507c-f161-4f87-bd2f-e594f93442d0"},{"name":"List Conversation Statistics","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"556f39d9-1874-4c61-bee3-7302f3b049d5"}}],"id":"5634d2cd-0b1a-4edd-a302-4fdd720e761a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{server}}/v1/whatsapp/<version>/<waba_id>?fields=conversation_analytics.start(<start_unix_timestamp>).end(<end_unix_timestamp>).granularity(<period>)","description":"<h4 id=\"required-request-parameters\">Required Request Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Sample Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>version</code></td>\n<td><code>v17.0</code></td>\n<td>The Cloud API version.</td>\n</tr>\n<tr>\n<td><code>waba_id</code></td>\n<td></td>\n<td>WhatsApp Business Account ID</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Fields parameters</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n<th><strong>Supported Options</strong></th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>start</code></td>\n<td>UNIX Timestamp</td>\n<td></td>\n<td>Required  <br />The start date for the date range you are retrieving analytics for</td>\n</tr>\n<tr>\n<td><code>end</code></td>\n<td>UNIX Timestamp</td>\n<td></td>\n<td>Required  <br />The end date for the date range you are retrieving analytics for</td>\n</tr>\n<tr>\n<td><code>granularity</code></td>\n<td>string</td>\n<td><code>HALF_HOUR</code>, <code>DAILY</code>, <code>MONTHLY</code></td>\n<td>Required  <br />The granularity by which you would like to retrieve the analytics</td>\n</tr>\n<tr>\n<td><code>phone_numbers</code></td>\n<td>array</td>\n<td></td>\n<td>Optional  <br />an array of phone numbers for which you would like to retrieve analytics. If not provided, all phone numbers added to your WABA are included</td>\n</tr>\n<tr>\n<td><code>metric_types</code></td>\n<td>array</td>\n<td><code>COST</code>, <code>CONVERSATION</code></td>\n<td>Optional  <br />List of metrics you would like to receive. If you send an empty list, we return results for all metric types</td>\n</tr>\n<tr>\n<td><code>conversation_types</code></td>\n<td>array</td>\n<td><code>FREE_ENTRY</code>, <code>FREE_TIER</code>, <code>REGULAR</code></td>\n<td>Optional  <br />List of conversation types. If you send an empty list, we return results for all conversation types</td>\n</tr>\n<tr>\n<td><code>conversation_directions</code></td>\n<td>array</td>\n<td><code>business_initiated</code>, <code>user_initiated</code></td>\n<td>Optional  <br />List of conversation directions. If you send an empty list, we return results for all conversation directions</td>\n</tr>\n<tr>\n<td><code>dimensions</code></td>\n<td>array</td>\n<td><code>phone</code>, <code>country</code>, <code>conversation_type</code>, <code>conversation_direction</code></td>\n<td>Optional  <br />List of breakdowns you would like to apply to your metrics. If you send an empty list, we return results without any breakdowns</td>\n</tr>\n</tbody>\n</table>\n</div><p><a href=\"https://developers.facebook.com/docs/whatsapp/business-management-api/analytics\">Meta Documentation - Conversation Analytics</a></p>\n","urlObject":{"path":["v1","whatsapp","<version>","<waba_id>"],"host":["{{server}}"],"query":[{"key":"fields","value":"conversation_analytics.start(<start_unix_timestamp>).end(<end_unix_timestamp>).granularity(<period>)"}],"variable":[]}},"response":[{"id":"f973a3b8-7fc0-4bbf-ba17-203473db2f03","name":"200 - OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{server}}/v1/whatsapp/v15.0/<waba_id>?fields=conversation_analytics.start(1666244003).end(1679494551).granularity(MONTHLY).phone_numbers([]).dimensions([\"conversation_type\", \"conversation_direction\", \"phone\"])","host":["{{server}}"],"path":["v1","whatsapp","v15.0","<waba_id>"],"query":[{"key":"fields","value":"conversation_analytics.start(1666244003).end(1679494551).granularity(MONTHLY).phone_numbers([]).dimensions([\"conversation_type\", \"conversation_direction\", \"phone\"])"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Jul 2021 11:04:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.46 () OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n  \"conversation_analytics\": {\n  \"data\": [\n    {\n      \"data_points\": [\n        {\n          \"start\": 1643702400,\n          \"end\": 1646121600,\n          \"conversation\": 6250,\n          \"phone_number\": \"19195552584\",\n          \"conversation_type\": \"REGULAR\",\n          \"conversation_direction\": \"BUSINESS_INITIATED\",\n          \"cost\": 55.0204\n        },\n        {\n          \"start\": 1643702400,\n          \"end\": 1646121600,\n          \"conversation\": 2250,\n          \"phone_number\": \"19195552584\",\n          \"conversation_type\": \"REGULAR\",\n          \"conversation_direction\": \"USER_INITIATED\",\n          \"cost\": 33.0806\n        },\n         {\n          \"start\": 1643702400,\n          \"end\": 1646121600,\n          \"conversation\": 800,\n          \"phone_number\": \"19195552584\",\n          \"conversation_type\": \"FREE_TIER\",\n          \"conversation_direction\": \"BUSINESS_INITIATED\",\n          \"cost\": 0.0000\n        },\n        {\n          \"start\": 1643702400,\n          \"end\": 1646121600,\n          \"conversation\": 200,\n          \"phone_number\": \"19195552584\",\n          \"conversation_type\": \"FREE_TIER\",\n          \"conversation_direction\": \"USER_INITIATED\",\n          \"cost\": 0.0000\n        },\n        {\n          \"start\": 1643702400,\n          \"end\": 1646121600,\n          \"conversation\": 1000,\n          \"phone_number\": \"19195552584\",\n          \"conversation_type\": \"FREE_ENTRY_POINT\",\n          \"conversation_direction\": \"USER_INITIATED\",\n          \"cost\": 0.0000\n        }\n      ]\n    }\n  ]\n }\n}"}],"_postman_id":"5634d2cd-0b1a-4edd-a302-4fdd720e761a"},{"name":"Get Phone Numbers","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"013d89f3-bf4e-4502-a55d-6aa51bc54b52"}}],"id":"6c165f5a-9419-4beb-8a94-95bb44aab35d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{server}}/v1/whatsapp/<version>/<waba_id>/phone_numbers?fields=code_verification_status,display_phone_number,certificate,name_status,new_certificate,new_name_status","description":"<p>Retrieve the phone numbers registered to your WhatsApp Business Account (WABA).</p>\n<h4 id=\"required-request-parameters\">Required Request Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Sample Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>version</code></td>\n<td><code>v17.0</code></td>\n<td>The Cloud API version.</td>\n</tr>\n<tr>\n<td><code>waba_id</code></td>\n<td></td>\n<td>WhatsApp Business Account ID</td>\n</tr>\n</tbody>\n</table>\n</div><p><a href=\"https://developers.facebook.com/docs/whatsapp/business-management-api/manage-phone-numbers#all-phone-numbers\">Meta Documentation - Get Phone Numbers</a></p>\n","urlObject":{"path":["v1","whatsapp","<version>","<waba_id>","phone_numbers"],"host":["{{server}}"],"query":[{"key":"fields","value":"code_verification_status,display_phone_number,certificate,name_status,new_certificate,new_name_status"}],"variable":[]}},"response":[{"id":"164539e5-2b5e-4a23-b943-f38f61d81c5f","name":"200 - OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{server}}/v1/whatsapp/v15.0/<waba_id>/phone_numbers?fields=code_verification_status,display_phone_number,certificate,name_status,new_certificate,new_name_status","host":["{{server}}"],"path":["v1","whatsapp","v15.0","<waba_id>","phone_numbers"],"query":[{"key":"fields","value":"code_verification_status,display_phone_number,certificate,name_status,new_certificate,new_name_status"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Jul 2021 11:04:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.46 () OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": [\n    {\n      \"verified_name\": \"Jasper's Market\",\n      \"display_phone_number\": \"+1 631-555-5555\",\n      \"id\": \"1906385232743451\",\n      \"quality_rating\": \"GREEN\"\n      \n    },\n    {\n      \"verified_name\": \"Jasper's Ice Cream\",\n      \"display_phone_number\": \"+1 631-555-5556\",\n      \"id\": \"1913623884432103\",\n      \"quality_rating\": \"NA\"\n    }\n  ]\n}"}],"_postman_id":"6c165f5a-9419-4beb-8a94-95bb44aab35d"},{"name":"Get Business Profile","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"a40a65ac-fb3c-4149-901d-df769b9e2072"}}],"id":"87ba589a-6c87-4fe3-8071-282f130ac61b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{server}}/v1/whatsapp/<version>/<phone_number_id>/whatsapp_business_profile","description":"<h4 id=\"required-request-parameters\">Required Request Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Sample Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>version</code></td>\n<td><code>v17.0</code></td>\n<td>The Cloud API version.</td>\n</tr>\n<tr>\n<td><code>phone_number_id</code></td>\n<td><code>1906385232743451</code></td>\n<td>The ID of a phone number</td>\n</tr>\n</tbody>\n</table>\n</div><p><a href=\"https://developers.facebook.com/docs/whatsapp/cloud-api/reference/business-profiles\">Meta Documentation - Business Profile</a></p>\n","urlObject":{"path":["v1","whatsapp","<version>","<phone_number_id>","whatsapp_business_profile"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"d5ec1661-95de-45b9-9475-41c6c89ca27e","name":"200 - OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{server}}/v1/whatsapp/v15.0/1906385232743451/whatsapp_business_profile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Jul 2021 11:04:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.46 () OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"1200"},{"key":"X-RateLimit-Remaining","value":"1199"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Vary","value":"Authorization"},{"key":"X-Robots-Tag","value":"none"}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": [{\n    \"about\": \"ABOUT\",\n    \"address\": \"ADDRESS\",\n    \"description\": \"DESCRIPTION\",\n    \"email\": \"EMAIL\",\n    \"messaging_product\": \"whatsapp\",\n    \"profile_picture_url\": \"https://URL\",\n    \"websites\": [\n       \"https://WEBSITE-1\",\n       \"https://WEBSITE-2\"\n     ],\n    \"vertical\": \"INDUSTRY\",\n  }]\n}"}],"_postman_id":"87ba589a-6c87-4fe3-8071-282f130ac61b"}],"id":"1b50086e-849e-495f-83bd-6f28c03b8de2","description":"<p>The WhatsApp API allows developers to integrate WhatsApp messaging capabilities into their applications. This documentation will provide details on how to use the API endpoints to interact with the WhatsApp platform.</p>\n<p><strong>Important:</strong> before you can use the WhatsApp API, you need to connect your Facebook Business account. This can be manually done in the Spryng portal.</p>\n<p>The following API endpoints are available for use:</p>\n","_postman_id":"1b50086e-849e-495f-83bd-6f28c03b8de2"},{"name":"Voice Messages","item":[{"name":"Create Voice Message","id":"f3597840-d3ec-4c71-b5af-eb5dec3dee80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"body\": \"This is a test voice Message\",\n    \"voice_locale\": \"nl-us\",\n    \"recipients\": [\n        \"31612345678\"\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/v1/voice/messages","description":"<p>Create a new voice message.</p>\n<h3 id=\"body-parameters\">Body Parameters</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>key</th>\n<th>type</th>\n<th>description</th>\n<th>values, conditions</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>body</code></td>\n<td>string</td>\n<td>The message body</td>\n<td><strong>Length limits apply</strong> (1)</td>\n</tr>\n<tr>\n<td><code>ssml</code></td>\n<td>string</td>\n<td>The ssml vioce message</td>\n<td></td>\n</tr>\n<tr>\n<td><code>otp_code</code></td>\n<td>integer</td>\n<td>The code that will be said at the end of the message, number for number</td>\n<td></td>\n</tr>\n<tr>\n<td><code>recipients</code></td>\n<td>array [strings]</td>\n<td>List of recipient numbers</td>\n<td><strong>required</strong> (2)(3)</td>\n</tr>\n<tr>\n<td><code>reference</code></td>\n<td>string</td>\n<td>Reference code</td>\n<td></td>\n</tr>\n<tr>\n<td><code>voice_locale</code></td>\n<td>string</td>\n<td>Locale that will be used for to say the body and otp_code</td>\n<td><code>nl-NL</code>, <code>fr-FR</code>, <code>de-DE</code>, <code>en-US</code>, <code>en-GB</code>, <code>ro-RO</code></td>\n</tr>\n<tr>\n<td><code>repeat</code></td>\n<td>int</td>\n<td>The amount of times the messaeg needs to be repeated (Default 1)</td>\n<td><strong>Maximum values apply</strong> (4)</td>\n</tr>\n</tbody>\n</table>\n</div><ul>\n<li><p>(1) Maximum of 500 characters.</p>\n</li>\n<li><p>(2) Only 1 recipients is allowed.</p>\n</li>\n<li><p>(3) Recipient numbers must be in a format like \"31612345678\" (international numeric).</p>\n</li>\n<li><p>(4) Maximum value of 5.</p>\n</li>\n</ul>\n<h3 id=\"includes\">Includes</h3>\n<p>See the Show Voice Message endpoint for details.</p>\n","urlObject":{"path":["v1","voice","messages"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"6b201950-0c42-4eb1-9ed3-7bffd4d10b82","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"body\": \"Dit is een voice bericht\",\n\t\"voice_locale\": \"nl-NL\",\n\t\"recipients\": [\n\t\t\"31612345678\"\n\t]\n}"},"url":{"raw":"{{server}}/v1/messages?with[]=recipients","host":["{{server}}"],"path":["v1","messages"],"query":[{"key":"with[]","value":"recipients"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 05 Dec 2018 15:56:26 GMT"},{"key":"Server","value":"Apache/2.4.29 (Unix) OpenSSL/1.0.2o PHP/7.1.14"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"297"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Robots-Tag","value":"none"},{"key":"Content-Length","value":"464"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"9e41a6f6-ddd6-4902-bdb8-627fa47c59f5\",\n    \"body\": \"Dit is een voice bericht\",\n    \"reference\": \"\",\n    \"credits\": 1,\n    \"created_at\": \"2025-02-20T11:41:52+01:00\",\n    \"updated_at\": \"2025-02-20T11:41:52+01:00\",\n    \"priority\": \"priority\",\n    \"links\": {\n        \"self\": \"http://spryng-api.test/v1/voice/messages/9e41a6f6-ddd6-4902-bdb8-627fa47c59f5\"\n    }\n}"}],"_postman_id":"f3597840-d3ec-4c71-b5af-eb5dec3dee80"},{"name":"Create Voice OTP","id":"59f19c13-406c-4b19-80f9-015e93f385d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"body\": \"Jouw inlogcode is\",\n    \"otp_code\": \"321321\",\n\t\"voice_locale\": \"nl-NL\",\n\t\"recipients\": [\n\t\t\"31612345678\"\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/v1/voice/otp","description":"<p>Create a new voice message.</p>\n<h3 id=\"body-parameters\">Body Parameters</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>key</th>\n<th>type</th>\n<th>description</th>\n<th>values, conditions</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>body</code></td>\n<td>string</td>\n<td>The message body</td>\n<td><strong>required</strong> Length limits apply (1)</td>\n</tr>\n<tr>\n<td><code>otp_code</code></td>\n<td>integer</td>\n<td>The code that will be said at the end of the message</td>\n<td></td>\n</tr>\n<tr>\n<td><code>recipients</code></td>\n<td>array [strings]</td>\n<td>List of recipient numbers</td>\n<td><strong>required</strong> (2)(3)</td>\n</tr>\n<tr>\n<td><code>reference</code></td>\n<td>string</td>\n<td>Reference code</td>\n<td></td>\n</tr>\n<tr>\n<td><code>voice_locale</code></td>\n<td>string</td>\n<td>Locale that will be used for to say the body and otp_code</td>\n<td><code>nl-NL</code>, <code>fr-FR</code>, <code>de-DE</code>, <code>en-US</code>, <code>en-GB</code>, <code>ro-RO</code></td>\n</tr>\n<tr>\n<td><code>repeat</code></td>\n<td>int</td>\n<td>The amount of times the messaeg needs to be repeated (Default 1)</td>\n<td><strong>Maximum values apply</strong> (4)</td>\n</tr>\n</tbody>\n</table>\n</div><ul>\n<li><p>(1) Maximum of 500 characters.</p>\n</li>\n<li><p>(2) Only 1 recipients is allowed.</p>\n</li>\n<li><p>(3) Recipient numbers must be in a format like \"31612345678\" (international numeric).</p>\n</li>\n<li><p>(4) Maximum value of 5.</p>\n</li>\n</ul>\n<h3 id=\"includes\">Includes</h3>\n<p>See the Show Voice Message endpoint for details.</p>\n","urlObject":{"path":["v1","voice","otp"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"4ef1ba5b-20db-4891-b2b5-af61586e74bb","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"body\": \"Jouw inlogcode is\",\n    \"otp_code\": \"321321\",\n\t\"voice_locale\": \"nl-NL\",\n\t\"recipients\": [\n\t\t\"31612345678\"\n\t]\n}"},"url":{"raw":"{{server}}/v1/messages?with[]=recipients","host":["{{server}}"],"path":["v1","messages"],"query":[{"key":"with[]","value":"recipients"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 05 Dec 2018 15:56:26 GMT"},{"key":"Server","value":"Apache/2.4.29 (Unix) OpenSSL/1.0.2o PHP/7.1.14"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"297"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Robots-Tag","value":"none"},{"key":"Content-Length","value":"464"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"9e41a6f6-ddd6-4902-bdb8-627fa47c59f5\",\n    \"body\": \"Jouw inlogcode is 321321\",\n    \"reference\": \"\",\n    \"credits\": 1,\n    \"created_at\": \"2025-02-20T11:41:52+01:00\",\n    \"updated_at\": \"2025-02-20T11:41:52+01:00\",\n    \"priority\": \"priority\",\n    \"links\": {\n        \"self\": \"http://spryng-api.test/v1/voice/messages/9e41a6f6-ddd6-4902-bdb8-627fa47c59f5\"\n    }\n}"}],"_postman_id":"59f19c13-406c-4b19-80f9-015e93f385d0"},{"name":"Show Voice Message","id":"52a0adc3-d83a-44b6-bec3-6e058dc44c1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{server}}/v1/voice/messages/{{voice_message_uuid}}?with[]=recipients","description":"<p>Show message details.</p>\n<h3 id=\"url-parameters\">URL parameters</h3>\n<p>The voice message uuid that was returned in the response of the Create Message request.</p>\n<h3 id=\"includes\">Includes</h3>\n<p>The following includes are available:</p>\n<ul>\n<li><code>recipients</code></li>\n</ul>\n","urlObject":{"path":["v1","voice","messages","{{voice_message_uuid}}"],"host":["{{server}}"],"query":[{"key":"with[]","value":"recipients"}],"variable":[]}},"response":[{"id":"eb08e806-09d6-4324-bd37-ab0c12805447","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{server}}/v1/messages/{{message_uuid}}?","host":["{{server}}"],"path":["v1","messages","{{message_uuid}}"],"query":[{"key":"","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 05 Dec 2018 16:15:51 GMT"},{"key":"Server","value":"Apache/2.4.29 (Unix) OpenSSL/1.0.2o PHP/7.1.14"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.1.14"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"300"},{"key":"X-RateLimit-Remaining","value":"298"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Robots-Tag","value":"none"},{"key":"Content-Length","value":"405"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"9e41a6f6-ddd6-4902-bdb8-627fa47c59f5\",\n    \"body\": \"Jouw inlogcode is 321321\",\n    \"reference\": \"\",\n    \"credits\": 1,\n    \"created_at\": \"2025-02-20T11:41:52+01:00\",\n    \"updated_at\": \"2025-02-20T11:41:52+01:00\",\n    \"priority\": \"priority\",\n    \"links\": {\n        \"self\": \"http://spryng-api.test/v1/voice/messages/9e41a6f6-ddd6-4902-bdb8-627fa47c59f5\"\n    }\n}"}],"_postman_id":"52a0adc3-d83a-44b6-bec3-6e058dc44c1d"}],"id":"86dc51da-b3a0-4ecc-8f36-d466e2bdcf86","description":"<p><strong>Important</strong>: You need to have the voice-feature enabled for your account before you can start using this. if you don't have this enabled yet please contact <a href=\"https://null\">Spryng</a>  </p>\n<p>The below section is about sending voice messages. By default voice messages are retained for 7 days. However you can contact support to request a change for this retention period.</p>\n","_postman_id":"86dc51da-b3a0-4ecc-8f36-d466e2bdcf86"}],"event":[{"listen":"prerequest","script":{"id":"f8d8a805-0c33-4b4a-b675-1d99635d7de0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f21e8505-d415-4d69-b820-fe9b87af0b2c","type":"text/javascript","exec":[""]}}]}