{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"375be173-6148-40ee-8d28-181eb6bbd971","name":"Olivia's API's","description":"Welcome to our API documentation. Copy and paste examples, or import this collection directly into [Postman](https://www.getpostman.com/).\n\nBefore getting started, buy a SIM card at [oliviawireless.com](https://oliviawireless.com) or login to our [SIM Management Console](https://oliviawireless.io)\n\n# Overview\nCurrently, we offer the APIs listed below. If you have any questions or have any requests for future API's, please contact us at [support@oliviawireless.com](mailto:support@oliviawireless.com)\n\n# API Key\nTo make a successful API call, you need your accounts API key. You can obtain and reset your API key in the [SIM Management Console](https://www.oliviawireless.io/). Log in and go to 'API Key' under 'Settings'. Every account has one API key. API keys are only visible for Admin users.\n\nTo make a successful API call put the header below in every API call:\n\n\n    {\"api_key\":\"{{api_key}}\" }\n\n# Pricing\nAll API calls are included in the monthly connectivity fees. Please note that when you trigger an SMS to be sent, the SMS itself will be billed accordingly.\n\n# Rate limit\nPlease limit your request to a maximum of 10 calls/second and 1000 calls/day. Should you require more calls, please contact us at [support@oliviawireless.com](mailto:support@oliviawireless.com)\n\n# Global Variables\n\n## device_name [STRING]\nThe device_name is a custom identifier you can assign to a SIM card. The value will also appear in the [SIM Management Console](https://www.oliviawireless.io/).\n\n## group [STRING]\nYou can assign your SIM cards to a group. This helps in organizing your SIM base. Examples are groups like: 'test' and 'production, or 'customer A' and 'customer B'.\nFirst, create a group in the [SIM Management Console](https://www.oliviawireless.io/). Once created, you can assign the group to a SIM via the GUI or API.\n\n## iccid (SIM Barcode) [INTEGER]\nTo address an individual SIM card in your account, the API requires an [iccid](https://en.wikipedia.org/wiki/SIM_card#ICCID) to identify the subscription. The iccid is the barcode printed on the SIM card. You can get an overview of the iccid's in the [SIM Management Console](https://www.oliviawireless.io/) your account, or call the 'sims' API.\n\n## imsi [INTEGER]\nThe imsi of this SIM card. The physical SIM ID of a SIM card is its [imsi](https://en.wikipedia.org/wiki/International_mobile_subscriber_identity). You can find the imsi of a SIM by calling the API or via the [SIM Management Console](https://www.oliviawireless.io/).\n\n## rateplan [STRING]\nThe assigned rateplan to this SIM card. A rateplan is the commercial plan or bundle, that defines how usage of a SIM card is billed.\n\n## sim_state [STRING]\nThere are 4 SIM states that you can assign to your SIM card. The different SIM states have implications on service- and billing state.\n\nSIM State|Service|Billable|Remark\n---------|-------|--------|--------\nTest ready|All services are allowed|No|When you start using the SIM it will activate itself automatically. Once activated, it is not possible to go back to this state.\nActive|All services are allowed|Yes|\nPaused|All services are blocked|Yes|\tTemporarily pause the SIM cards functionalities\nDeleted|The connection is terminated|No|It is not possible to restore the functionalities on a terminated SIM card.\n\n## usage_data [INTEGER]\nThe aggregated data usage of a SIM in bytes for this calendar month.\n\n## usage_sms [INTEGER]\nThe number of SMS messages sent by this SIM card during this calendar month.\n\n## usage_sms_pmt [INTEGER]\nThe number of platform SMS messages sent by the platform or API during this calendar month to the SIM card.\n\n## usage_voice [INTEGER]\nThe total minutes of voice traffic for this SIM during the current calendar month.\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"1177543","team":319103,"collectionId":"375be173-6148-40ee-8d28-181eb6bbd971","publishedId":"S1ENyJr4","public":true,"publicUrl":"https://documenter-api.postman.tech/view/1177543/S1ENyJr4","privateUrl":"https://go.postman.co/documentation/1177543-375be173-6148-40ee-8d28-181eb6bbd971","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2020-05-13T15:38:23.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Demo","id":"5c6f7343-03d5-4b1c-a0c1-30cec448ec27","owner":"1177543","values":[{"key":"api_key","value":"YoUr_oLiViA-WiReLeSs_aPi_kEy","enabled":true},{"key":"iccid","value":"8912345600001234567","enabled":true},{"key":"sender","value":"31612345678","enabled":true},{"key":"david","value":"31612345678","enabled":true}],"published":true}],"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/b918d50cab3cb0ed5c9dca97e1e77ac88b0c53250dba12536c6d286bc9113b4c","favicon":""},"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"},{"label":"Demo","value":"1177543-5c6f7343-03d5-4b1c-a0c1-30cec448ec27"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/S1ENyJr4"}