{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"054d3ed6-a7ff-3f1a-1c3d-b2d0697420ef","name":"Message API","description":"> All rights reserved. The Material may not be reproduced or distributed, in whole or in part, without prior written permission by F24 Norge AS. \n  \n\nWelcome to the the official documentation for our Message API!\n\nBuild amazing SMS message experiences easily with our API. We send millions of messages each month. Read the API documentation and see how the API works for you, in any programming language.\n\nThis document contains specific technical information. It is intended for developers and integration partners. Parts of the API is written in Norwegian. This part is for the Norwegian market only.\n\n#### RPC & JSON\n\nThe Message API provides RPC style functions for sending sms messages. For a detailed discussion on RPC vs REST see this [article](https://blog.jscrambler.com/rpc-style-vs-rest-web-apis)\n\nData format is JSON.\n\n## API\n\nContact us for API endpoints\n\n## Interface\n\n\\* Use HTTP POST for methods calls  \n\\* Use UTF-8 encoding  \n\\* HTTP StatusCode = 200 means success. HTTP StatusCode <> 200 means failure. In case of failure the response body contains more detailed information about the error.  \n\\* Request/Response uses JSON objects. Please note the JSON format we use is `case-sensitive`.  \n\\* Authorization header\n\n## Example\n\nHere is an example of the \"SendSMSExt\" action in the SMS Gateway API:\n\nThe request contains the minimum information you need to provide to send an sms to a recipient. The response contains information for earch recipient. Is the message valid and the status of sending the SMS. Outgoing SMS messages are always \"queued\" for sending.\n\nRequest header\n\n```\nContent-Type:application/json \nAccessKey:yourAccessKey\nAccessToken:yourAccessToken \n\n ```\n\nRequest body\n\n```\n    {\n        \"Messages\": [\n            {\n                \"Sender\": \"F24\",\n                \"Recipient\": \"+4794505514\",\n                \"Content\": \"Greetings from the Message API\"\n            }\n        ]\n    }\n\n ```\n\nResponse headers\n\n```\nAccess-Control-Allow-Origin = \\\\\\\\* \nCONTENT-LENGTH = 2 \nCONTENT-TYPE = application/json; \ncharset=UTF-8 Cache-Control = no-cache \nX-Uncompressed-Content-Length = 2 \n\n ```\n\nResponse body\n\n```\n        {\n            \"Recipients\": [\n                {\n                    \"Status\": \"Queued\",\n                    \"Valid\": true,\n                    \"Recipient\": \"+4794505514\",\n                }\n            ],\n            \"Status\": \"1 messages queued\",\n            \"BatchId\": \"57CF5360-B948-4DCD-B554-159A76CC8835\"\n        }\n\n ```\n\n## HTTP Status Codes\n\nBelow is a list of HTTP StatusCodes:\n\n| StatusCode | Description | Details |\n| --- | --- | --- |\n| 200 | OK |  |\n| 400 | Invalid request | Invalid json format in request |\n| 401 | Unauthorized | Invalid password or account is closed |\n| 404 | Not found | Search for data failed |\n| 460 | Invalid request data | Invalid or missing data in json request |\n| 461 | Invalid request data | Duplicate entity is not allowed |\n| 462 | Invalid request data | Entity is in use and cannot be removed |\n| 500 | System Error | An exception occurred |\n| 520 | Database Error | An exception occurred during DB read/write |\n\nIf the HTTP StatusCode <> 200 then reponse body contains an `Errors` array.\n\nHere is an example reponse body example:\n\n```\n{\n  \"Errors\": [\n    {\n      \"Title\": \"Not authorized\",\n      \"Details\": \"\",\n      \"Code\": 401\n    }\n  ]\n}\n\n ```\n\n## Feedback\n\nWe welcome your feedback. Please send an email to support.norge@f24.com and let us know what you think.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1565332","collectionId":"054d3ed6-a7ff-3f1a-1c3d-b2d0697420ef","publishedId":"6YsWxPu","public":true,"publicUrl":"https://api.framweb.net","privateUrl":"https://go.postman.co/documentation/1565332-054d3ed6-a7ff-3f1a-1c3d-b2d0697420ef","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/d4d4e4d8-a0c1-443e-bbd3-27d5adb44916/RjI0IExvZ28gd2hpdGVibHVlLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/56f54621-6303-4223-bd67-1b970804f72f/RjI0IExvZ28gZGFya2JsdWUucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"}}]}},"version":"8.11.4","publishDate":"2025-07-01T09:34:49.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/56f54621-6303-4223-bd67-1b970804f72f/RjI0IExvZ28gZGFya2JsdWUucG5n","logoDark":"https://content.pstmn.io/d4d4e4d8-a0c1-443e-bbd3-27d5adb44916/RjI0IExvZ28gd2hpdGVibHVlLnBuZw=="}},"statusCode":200},"environments":[{"name":"PublicTemplate","id":"65b2b09b-4a90-f03e-ebf3-06889370be6e","owner":"1565332","values":[{"key":"accessToken","value":"yourAccessToken","enabled":true},{"key":"url","value":"apiUrl","enabled":true},{"key":"mobil","value":"+4712345678","enabled":true},{"key":"svarurl","value":"https://myapp.net/reply","enabled":true},{"key":"epost","value":"ole.olsen@online.no","enabled":true},{"key":"brukerid","value":"userid","enabled":true},{"key":"passord","value":"password","enabled":true},{"key":"mottaker","value":"John Smith","enabled":true},{"key":"accessKey","value":"yourAccessKey","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/1156389589184656aa4ebfd9c46999b49bd4d4b5bb052dd522684c47f4b2b978","favicon":"https://framweb.net/favicon.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"},{"label":"PublicTemplate","value":"1565332-65b2b09b-4a90-f03e-ebf3-06889370be6e"}],"canonicalUrl":"https://api.framweb.net/view/metadata/6YsWxPu"}