{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"2c29bfbe-afda-5499-cec2-039711ed0484","name":"Omnilert API Version 2.0","description":"Welcome to the Omnilert REST API documentation. This API can be used to customize the functionality of your Omnilert 6 account.\n\nThe Omnilert REST API provides the tools you need to create your own applications to handle Omnilert subscriber management.  All subscriber management functionality provided with the Omnilert platform can be accessed using the Omnilert's REST API. All SMS and email devices added via the API must be validated by a recipient to ensure that consent is unambiguously provided by the device owner.\n\nHere are some examples of what you can do with the Omnilert REST API. \n\n* Integrate with a Human Resource Management system such as Workday to manage your subscriber base for your notifications.\n* Create your own interface within a corporate intranet.\n* Integrate subscriber management within a smartphone application.\n\n*Please note: API access is restricted to approved accounts only. To obtain API credentials and your Omnilert API Key, please contact your Omnilert Account Manager.*\n\n# Authentication\nThe Omnilert REST API supports three different methods of authentication:\n\n* Basic Authentication (Recommended)\n* Digest Authentication \n* Request Authentication  \n\nBasic Authentication: ($_SERVER['PHP_AUTH_USER'] and $_SERVER['PHP_AUTH_PW']) \n\nDigest Authentication: ($_SERVER['PHP_AUTH_DIGEST']) which is a 2 step process. \n\nRequest Authentication: $_REQUEST variables: ($_REQUEST['apiusername'] and $_REQUEST['apipassword']).\n\nYou will need to pass your provided `omnilert_account_key` and your `username` in the headers of your calls.\n\n__Note:__ The code examples provided here do _not_ include authentication. All calls to the Omnilert API must include authentication. \n\n# Error Codes\nAPI connections which exceed the API limit will receive an **HTTP/1.1 429 - Too Many Requests** response along with a 906 response code.\n\nAPI calls that receive a 429 response should be assumed to be not processed and should be retried. If/when this occurs, a one second \"time out\" is recommended for your application before retrying the API call.\n\n##### Response Codes\n\n| Code | Message |\n|------|---------|\n| 900 | Digest Authentication: API username/password may be incorrect. |\n| 901 | Account name variable is missing. |\n| 902 | Account name variable is empty. |\n| 903 | Account name is invalid. |\n| 904 | No authorization specified. |\n| 905 | ACL credential file missing, call Omnilert support. |\n| 906 | Rate exceeded, too many requests at one time, try again. |\n| 907 | Invalid content type, try application\\json for json output. |\n| 908 | Failed Authentication. Please use Basic, digest or request. |\n| 909 | there is a problem with your configuration file, call Omnilert support. |\n| 910 | Your ip address is not authorized to access this page |\n| 911 | Invalid request method. Should be put, get, delete or post. |\n| 912 | Invalid endpoint. |\n| 913 | Invalid method for the endpoint. |\n| 914 | You don't have permissions to run this command (ACL). |\n| 915 | Record not found. |\n| 916 | Missing required data for the command. |\n| 917 | Username contains invalid characters. Must be alpha-numeric, underscore (_), period (.), dash (-) or at sign (@). |\n| 918 | Username already in use. |\n| 919 | Invalid date format, needs to be in the format or `mm-dd-yyyy`, `mm/dd/yyyy`, `yyyy-mm-dd` or `yyyy/mm/dd`. |\n| 920 | Invalid date. |\n| 921 | Invalid email address. |\n| 922 | Group name already in use. |\n| 923 | Email address already in use by this user. |\n| 924 | SMS number already in use by this user. |\n| 925 | TTY number already in use by this user. |\n| 926 | Voice number already in use by this user. |\n| 927 | Max email addresses in use for this user. |\n| 928 | Max sms numbers in use for this user. |\n| 929 | Max tty numbers in use for this user. |\n| 930 | Max voice numbers in use for this user. |\n\n# Rate limit\nThe Omnilert REST API does not accept an unlimited numbers of API calls from any\ngiven source. \n\nThis API is designed for retrieving and updating subscriber data in real-time from your own custom application, and not for the bulk loading of subscribers. \n(The Omnilert platform provides a suite of upload utilities for bulk loading subscriber data into your Omnilert notification system.) \n\nThere is a limit of 1 connections/calls per 1 second interval.\n\nThe HTTP **429 Too Many Requests** response status code indicates the user has sent too many requests in a given amount of time. We advise that you code your requests so that when you receive a 429 response, you have the process sleep for one second before re-submitting the request.  The retry loop in your application should repeat a specific request a maximum of three times. If you receive three HTTP 429 responses in a row on that request, you should show an error message on screen and have the end-user try again from the start (which should reset the API rate) or increase the wait time before re-submitting the request in your application.\n\n*Please note: Repeated excesses may cause your IP to be blocked/suspended from API access to\nOmnilert.*","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"245792","team":9181,"collectionId":"2c29bfbe-afda-5499-cec2-039711ed0484","publishedId":"7157vh2","public":true,"publicUrl":"https://api.omnilert.com","privateUrl":"https://go.postman.co/documentation/245792-2c29bfbe-afda-5499-cec2-039711ed0484","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2017-11-15T22:39:55.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/e652fa7e9438a266cd76408424c2167fb415d8846e16b2f003295f3e05e8d590","favicon":"https://res.cloudinary.com/postman/image/upload/v1639417070/team/lc6ypoz6uja8bky7nolg.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api.omnilert.com/view/metadata/7157vh2"}