{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"58cf776a-949c-4908-95ed-6b94342e48ee","name":"ProSMS.se API Documentation","description":"This is the API for ProSMS.se\n\n# Overview\nAll data must be send as JSON, and all data will be returned as JSON.\n\n# Authentication\nA request is authenticated by a bearer token header. The token can be optained from your account settings on <a href=\"{{loginURL}}account/settings/edit#APIKey\">{{loginURL}}</a>\n\n### Error response codes\n|Response code|HTTP status code|Description|\n|----|----|----|\n|1000|500|Something went wrong.|\n|1002|400|Parameter \"receiver\" is required.|\n|1003|400|Parameter \"senderName\" is required.|\n|1004|400|Parameter \"message\" is required.|\n|1005|400|Parameter \"contactName\" is required.|\n|1006|400|Parameter \"groupName\" is required.|\n|1007|400|Parameter \"phoneNumber\" required.|\n|1008|400|Parameter \"groupId\" is required.|\n|1009|409|Format not recognized.|\n|1010|409|Encoding format not recognized.|\n|1011|400|Parameter \"senderName\" is required and must be between 3 and max 11 characters in length. Or 15 digits.|\n|1012|406|Characters not allowed in \"senderName\".|\n|1013|409|Parameter \"dlrUrl\" is not a valid URL.|\n|1014|409|Phone number should be specified as a number.|\n|1015|409|Country code and phone number do not match.|\n|1016|409|No contacts in group.|\n|1017|409|Parameter \"senderName\" is not a approved sender name.|\n|1018|400|Could not create user.|\n|1019|400|Could not update user.|\n|1020|400|Could not delete user.|\n|1021|406|A group with that name already exists.|\n|1022|406|You have reached the limit of allowed groups.|\n|1023|400|Group not found.|\n|1024|409|There is no group(s) to return.|\n|1025|406|Contact already exists.|\n|1026|409|Contact not found.|\n|1027|400|Contact not found in group.|\n|1028|409|Parameter \"scheduled\" needs to be at least 10 minutes in the future.|\n|1029|409|The date and time is not following the ISO 8601 standard.|\n|1030|402|You do not have sufficient credits.|\n|1031|409|Already exists|\n|1032|400|Must be between 3 and max 11 characters in length. Or 15 digits.|\n|1033|409|Nothing to return|\n|1034|400|Groups with contacts, cannot be deleted.|\n|1035|409|Parameter \"id\" required.|\n|1036|409|Parameter \"username\" required.|\n|1037|401|Login credentials invalid.|\n|1038|401|Basic authentication missing.|\n|1039|401|Password not changed.|\n|1040|409|One or more parameters missing.|\n|1041|409|Parameter \"countryCode\" is required.|\n|1042|409|Contactname is too short. I must be at least 2 characters long.|\n|1043|409|Country code is wrong. It must consist of exactly two characters.|\n|1044|409|Data is missing.|\n|1045|409|Phone number is not valid.|\n|1046|409|Max 50 chars in \"userReference\".|\n|1047|409|Parameter \"receiver\" needs to be a digit.|\n|1048|409|Define parameter \"reference\" or a \"batchId\".|\n|1049|409|There is no record to delete.|\n|1050|409|There is a cool down. remaining: |\n|1051|404|The End point you are trying to reach do not exist.|\n|1052|401|No user found.|\n|1053|409|Token is missing.|\n|1054|401|Invalid token.|\n|1055|401|Action not permitted.|\n|1056|401|Points not transferred.|\n|1057|401|Users with points and no parent user, can't be deleted.|\n|1058|401|User does not have a key set.|\n|1059|409|See specific error in returned rejected array.|\n|1060|409|Parameter \"receiver\" must be of numeric characters only.|\n|1061|400|User already exists.|\n|1062|406|Dial code is missing.|\n|1063|409|Phone number too short|\n|1064|409|Phone number too long|\n|1065|409|Phone number might be a local number|\n|1066|409|The country is not supported|\n\n### Mixed response codes\n|Response code|HTTP status code|Description|\n|----|----|----|\n|3000|207|Mixed result|\n\n### Success response codes\n|Response code|HTTP status code|Description|\n|----|----|----|\n|5000|200|Action succeeded.|\n|5001|200|Contact created.|\n|5002|200|Group created.|\n|5003|200|User created.|\n|5004|200|Contact updated.|\n|5005|200|Group updated.|\n|5006|200|User updated.|\n|5007|200|Created.|\n|5008|200|Updated.|\n|5009|200|Contact removed.|\n|5010|200|Removed.|\n|5011|200|Contact deleted.|\n|5012|200|Group deleted.|\n|5013|200|User deleted.|\n|5014|200|Deleted.|","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"538229","team":122203,"collectionId":"58cf776a-949c-4908-95ed-6b94342e48ee","publishedId":"Szzeh12G","public":true,"publicUrl":"https://docs.prosms.se","privateUrl":"https://go.postman.co/documentation/538229-58cf776a-949c-4908-95ed-6b94342e48ee","customColor":{"top-bar":"1B1E2B","right-sidebar":"303030","highlight":"0198D1"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2020-06-10T12:21:43.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"ProSMS.se Production documentation","id":"db16b7ae-d0ae-4bda-8a2c-25c36807f98f","owner":"538229","values":[{"key":"url","value":"https://api.prosms.se","enabled":true},{"key":"apiSubdomain","value":"api","enabled":true},{"key":"apiURL","value":"https://{{apiSubdomain}}.{{domain}}.{{tld}}","enabled":true},{"key":"protocol","value":"https","enabled":true},{"key":"token","value":"Your-API-key","enabled":true},{"key":"phoneNumber","value":"46223344561","enabled":true,"type":"default"},{"key":"phoneNumber2","value":"46223344562","enabled":true,"type":"default"},{"key":"countryCode","value":"SE","enabled":true,"type":"default"}],"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/06963e8706d838acd570cb97543b89d5b32a418b31e3aa6efcf81bd778c7e785","favicon":"https://res.cloudinary.com/postman/image/upload/v1597847655/team/hbmprrgy36laya2n1j1h.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":"ProSMS.se Production documentation","value":"538229-db16b7ae-d0ae-4bda-8a2c-25c36807f98f"}],"canonicalUrl":"https://docs.prosms.se/view/metadata/Szzeh12G"}