{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"20495e32-673b-4043-86e6-f5065816ca3e","name":"Kaleyra Hexa (AP)","description":"Kaleyra Hexa, the flagship product, allows developers, businesses and startups to code, build and scale their communication. At Hexa, we offer it all; right from SMS, Voice, Numbers, Instant Messaging and Emails. Read more [here](https://www.kaleyra.com/product/hexa/)\n\n# Hexa API\nIntroducing the powerful API that can seamlessly perform multiple functions in less than 5 milliseconds. We made it simple for you, with minimum coding and a multidimensional approach. \n\nYou can download the [Postman collection for Hexa here](https://www.getpostman.com/collections/6c76b14dbb3fa2f323f3)\n\n# Login And Get API Key to get started\n\nTo get an API Key, you will have to create one by [logging in to our application](https://hexa.kaleyra.io/). The process is listed below: \n\n# Create an API Key\n\nTo create an API key, follow the steps below:\n\n1. From the Hexa application, click on 'Dev Console'\n2. Click on 'Create an API Key'\n3. Enter the details and click 'Add' \n\n# API Parameters\nThe following are the API Parameters for Hexa APIs:\n\n|Parameter Name |Description |\n|---------- |-------------- |\n|type |Type of SMS, i.e, marketing (MKT), transactional (TXN), One Time Passwords (OTP) |\n|body |Message(s) to be sent |\n|to |To phone number(s) |\n|sender |Sender id|\n|ref |Message reference tags |\n|listid |Contact number groups |\n|time |Time in the format dd-mm-yyyy hh:mm:ss |\n|dlrurl |Delivery url |\n\n# Parameter Combinations\n> 'to' and 'listid' cannot be used in the same trigger. 'to' parameter will be priortized instead of 'listid', for both sending and scheduling the SMS.\n\n> For OTP messages, only one mobile number can be added per request\n\n# Mandatory Parameters\n|Parameter Name |Description |\n|---------- |-------------- |\n|to |Mobile number(s) to which the SMS has to be sent |\n|body|Message content |\n|sender |Sender id |\n|type |Type of the message (TXT, MKT, OTP)\n\n\n# Error Codes\n|Error Code |Description |\n|--------- |---------- |\n|E100 |Message Submitted Successfully |\n|E101 |Campaign Accepted |\n|E102 |No Medium Configured for Queue |\n|E400 |For bulk SMS type should be MKT |\n|E401 |SMS length is exceeding 4000 characters |\n|E402 |Invalid schedule time. Minimum 5 minutes time gap is required and 3 months from now |\n|E403 |Some thing went wrong at our end please try again after some time |\n|E404 |If Type is OTP then only one mobile number is allowed |\n|E405 |If Type is TXN then mobile numbers should not be more than 100 |\n|E406 |No Valid mobile numbers found |\n|E600 |To field has to be filled |\n|E601 |Body cannot be left empty |\n|E602 |Sender-Id is required |\n|E603 |Port number must contain only numbers |\n|E604 |Unicode should contain only 0, 1 or AUTO |\n|E605 |Duplicate should contain only 1 or 0 |\n|E606 |Flash should contain only 1 or 0 |\n|E607 |Campaign name should contain only alpha numerics |\n|E608 |ref should contain only alpha numerics |\n|E609 |ref1 should contain only alpha numerics |\n|E610 |ref2 should contain only alpha numerics |\n|E611 |Type is required |\n|E612 |For Group SMS Use Either 'to' field or 'list_id' field |\n|E613 |List_id field has to be filled |\n|E614 |For 'list_id' type should not be OTP |\n|E615 |Type has to be either TXN, MKT or OTP |\n|E616 |Sender field has to be filled |\n|E617 |Campaign_id field has to be filled |\n|E618 |Body field has to be filled |\n|E619 |InValid Sender ID Pattern |\n|E620 |Campaign validated successfully |\n|E621 |Invalid Sender ID Pattern |\n|E638 |Upload the files |\n|E639 |Upload only csv or pdf files |\n|E640 |Upload files which are less than 1 MB |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"7136989","team":354573,"collectionId":"20495e32-673b-4043-86e6-f5065816ca3e","publishedId":"S1TR4ewA","public":true,"publicUrl":"https://apidocs-hexaap.kaleyra.com","privateUrl":"https://go.postman.co/documentation/7136989-20495e32-673b-4043-86e6-f5065816ca3e","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"D80D30"},"documentationLayout":"classic-double-column","version":"8.10.0","publishDate":"2019-05-24T10:48:24.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Kaleyra Hexa","id":"475da510-2d1c-4fc6-ab82-31c24bc0e791","owner":"7136989","values":[{"key":"jwt_token","value":"XXXXXXXiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyIjoiNDM0XXXXXXIsImNvbXBhbnkiOiJaXXXXXXQwIiwic2lkIjoiSFhBUDE2Mjk2OTQ2MjhJTiIsImXXXXXXXTU1NDM2MTIxNX0.hJODju-Y5XXXXXXG-EhVzS-XTbMizn2d5sXXXXXXXX","enabled":true},{"key":"url","value":"https://web.kaleyra.io","enabled":true},{"key":"sid","value":"XXXXX629694XXXXN","enabled":true},{"key":"version","value":"v1","enabled":true},{"key":"value","value":"XXXXXXXX50c3-4ae8-b3e1-47f5eXXXXXX7d:1","enabled":true},{"key":"eu_url","value":"https://api.eu.kaleyra.io","enabled":true},{"key":"ap_url","value":"https://api.ap.kaleyra.io","enabled":true},{"key":"jwt-token","value":"eyJ0XXXXXXXXXXXQiLCJhbGcXXXXXXXXXXiJ9.eyJ1cXXXXXXXXXX0NDMyOCIsIXXXXXXXXXXXiXXXXXXXXXXXQwIXXXX2lkIjoiSFXXXXXXXXXXOTQ2MjhJXXXXXXXXXXI6XXXXXXXXXXXE1M30.VOLw2i3R8cEIzXoRcAo-0iHaw-F7Wc2tAEAhdpYFjOI\n","enabled":true},{"key":"api-key","value":"A05XXXXXXXXXX1b69568f9XXXXXXXXXXa","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/ea24eedf6f11499fb53bb562b502131e39e3014f4556564cb6b3d173e5dcb09d","favicon":"https://res.cloudinary.com/postman/image/upload/v1557479917/team/xx5i10isr2ldfn91ifgt.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":"Kaleyra Hexa","value":"7136989-475da510-2d1c-4fc6-ab82-31c24bc0e791"}],"canonicalUrl":"https://apidocs-hexaap.kaleyra.com/view/metadata/S1TR4ewA"}