{"swagger":"2.0","info":{"title":"46elks API","description":"The 46elks SMS, MMS & Voice API","version":"1.0.0"},"host":"api.46elks.com","schemes":["https"],"securityDefinitions":{"basicAuth":{"type":"basic","description":"HTTP Basic Authentication is used for all API calls."}},"basePath":"/a1","consumes":["application/x-www-form-urlencoded"],"produces":["application/json"],"paths":{"/me":{"get":{"tags":["Account"],"security":[{"basicAuth":[]}],"description":"Get your account data","responses":{"200":{"description":"The account data","schema":{"$ref":"#/definitions/Account"},"examples":{"application/json":"{\n\"mobilenumber\": \"+46766861647\"\n\"displayname\": \"Your name or company\"\n\"id\": \"u5a9566c072160b318445d163949bf505\"\n\"currency\": \"SEK\"\n\"trialactivated\": \"2013-06-20T18:44:27.434000\"\n\"balance\": 9670500\n\"email\": \"help@46elks.com\"\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to get account."}}}},"post":{"tags":["Account"],"security":[{"basicAuth":[]}],"description":"Set level for when credit alert e-mail to be sent","parameters":[{"name":"creditalert","in":"formData","description":"Alert credits level","required":true,"type":"string","default":"200000"}],"responses":{"200":{"description":"The account data","schema":{"$ref":"#/definitions/Account"},"examples":{"application/json":"{\n\"mobilenumber\": \"+46766861647\",\n\"displayname\": \"Your name or company\",\n\"id\": \"u5a9566c072160b318445d163949bf505\",\n\"currency\": \"SEK\",\n\"trialactivated\": \"2013-06-20T18:44:27.434000\",\n\"balance\": 9670500,\n\"email\": \"help@46elks.com\",\n\"creditalert\": 200000\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to create account."}}}}},"/subaccounts":{"get":{"security":[{"basicAuth":[]}],"description":"Get all subaccounts","tags":["Subaccount"],"responses":{"200":{"description":"List of subaccounts.","schema":{"$ref":"#/definitions/SubaccountsList"},"examples":{"application/json":"{data:[\n    {\n    \"secret\": \"D81DEF1B65E19A83DBCEA0BE0D89D082\"\n    \"created\": \"2014-12-08T13:18:07.625000\"\n    \"usagelimit\": 67575670000\n    \"id\": \"af3d05a159669e1951c5301bc6a61bac\"\n    \"name\": \"This Co\"\n    \"usage\": 0\n    },\n    {\n    \"secret\": \"D81DEF1B65E19A83DBCEA0BE0D89D082\"\n    \"created\": \"2014-12-08T13:18:07.625000\"\n    \"usagelimit\": 345350000\n    \"id\": \"af3d05a159669e1951c5301bc6a61bac2\"\n    \"name\": \"This Co2\"\n    \"usage\": 345300\n    }\n    ]\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to get accounts."}}}},"post":{"security":[{"basicAuth":[]}],"description":"Create new subaccount.","tags":["Subaccount"],"parameters":[{"name":"name","in":"formData","description":"Name of subaccount","required":true,"type":"string","default":"Company XYZ"},{"name":"usagelimit","in":"formData","description":"The usage limit for the subaccount.","required":false,"type":"integer","default":3423432400}],"responses":{"200":{"description":"The created subaccount","schema":{"$ref":"#/definitions/Subaccount"},"examples":{"application/json":"{\n\"secret\": \"D81DEF1B65E19A83DBCEA0BE0D89D082\"\n\"created\": \"2014-12-08T13:18:07.625000\"\n\"usagelimit\": 99999999999\n\"id\": \"af3d05a159669e1951c5301bc6a61bac\"\n\"name\": \"This Co2\"\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to create account."}}}}},"/subaccounts/{id}":{"get":{"security":[{"basicAuth":[]}],"description":"Get the data about one subaccount.","parameters":[{"name":"id","in":"path","description":"Id of the subaccount","required":true,"type":"string","default":"a70df59406a2b4643b96f3f10e1bfb7b1"}],"tags":["Subaccount"],"responses":{"200":{"description":"The subaccount data","schema":{"$ref":"#/definitions/Subaccount"},"examples":{"application/json":"{\n\"secret\": \"D81DEF1B65E19A83DBCEA0BE0D89D082\"\n\"created\": \"2014-12-08T13:18:07.625000\"\n\"usagelimit\": 910000\n\"id\": \"af3d05a159669e1951c5301bc6a61bac\"\n\"name\": \"This Co\"\n\"usage\": 12300\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to get subaccount."}}}},"post":{"security":[{"basicAuth":[]}],"tags":["Subaccount"],"description":"Update subaccount.","parameters":[{"name":"id","in":"path","description":"Id of the subaccount","required":true,"type":"string","default":"a70df59406a1b4643b96f3f10e1bfb7b1"},{"name":"name","in":"formData","description":"Name of subaccount","required":false,"type":"string","default":"Company XYZ"},{"name":"usagelimit","in":"formData","description":"The usage limit for the subaccount.","required":false,"type":"integer","default":3423432400}],"responses":{"200":{"description":"The updated subaccount","schema":{"$ref":"#/definitions/Number"},"examples":{"application/json":"{\n  \"secret\": \"D81DEF1B65E19A83DBCEA0BE0D89D082\",\n  \"created\": \"2014-12-08T13:18:07.625000\",\n  \"usagelimit\": 99999999999,\n  \"id\": \"af3d05a159669e1951c5301bc6a61bac\",\n  \"name\": \"This Co\",\n  \"usage\": 12300\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to update subaccount."}}}}},"/images":{"get":{"security":[{"basicAuth":[]}],"description":"Get image list","tags":["MMS"],"parameters":[{"name":"start","in":"query","description":"Show images older than this date.","required":false,"type":"string","default":"2016-01-01T00:00:00.000"},{"name":"end","in":"query","description":"Show images newer than this date.","required":false,"type":"string","default":"2016-01-01T00:00:00.000"}],"responses":{"200":{"description":"The list of images","schema":{"$ref":"#/definitions/ImagesList"},"examples":{"application/json":"{\n  \"data\": [\n    {\n      \"created\": \"2016-11-03T12:44:56.190000\",\n      \"filetype\": \"jpg\",\n      \"mmsid\": \"mf3d05c159aa49e1951c5301bc6af1bac\",\n      \"bytes\": 4200,\n      \"id\": \"mf3d05c159aa49e1951c5301bc6af1bac-i0\",\n      \"digest\": \"6f15a43f350b49a02e6cdb0dd1863feeaa9f2fc4\"\n    },\n    {\n      \"created\": \"2016-11-03T12:30:18.964000\",\n      \"filetype\": \"png\",\n      \"mmsid\": \"m84af96809ff8989f3668c93aaaedb69c\",\n      \"bytes\": 206210,\n      \"id\": \"m84af96809ff8989f3668c93aaaedb69c-i0\",\n      \"digest\": \"c7e02bad59c63f8616fda84ac1ef689d017fa906\"\n    }\n  ]\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to get image list."}}}}},"/images/{id}":{"get":{"security":[{"basicAuth":[]}],"description":"Get metadata of one image.","tags":["MMS"],"parameters":[{"name":"id","in":"path","description":"Id of the image.","required":true,"type":"string","default":"m84af96809ff8989f3668c93aaaedb69c-i0"}],"responses":{"200":{"description":"The metadata for the image","schema":{"$ref":"#/definitions/Image"},"examples":{"application/json":"{\n  \"created\": \"2016-11-03T12:30:18.964000\",\n  \"filetype\": \"jpg\",\n  \"mmsid\": \"m84af96809ff8989f3668c93aaaedb69c\",\n  \"bytes\": 206210,\n  \"id\": \"m84af96809ff8989f3668c93aaaedb69c-i0\",\n  \"digest\": \"c7e02bad59c63f8616fda84ac1ef689d017fa906\"\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to get recording."}}}}},"/images/{id}.jpg":{"get":{"produces":["application/octet-stream"],"security":[{"basicAuth":[]}],"description":"Get image file","tags":["MMS"],"parameters":[{"name":"id","in":"path","description":"Id of the image","required":true,"type":"string","default":"m84af96809ff8989f3668c93aaaedb69c-i0"}],"responses":{"200":{"description":"The imge data","schema":{"type":"file"},"examples":{"application/octet-stream":null}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to download image."}}}}},"/recordings":{"get":{"security":[{"basicAuth":[]}],"description":"Get list of recordings","tags":["Calls"],"parameters":[{"name":"start","in":"query","description":"Show recordings older than this date","required":false,"type":"string","default":"2016-01-01T00:00:00.000"},{"name":"end","in":"query","description":"Show recordings newer than this date","required":false,"type":"string","default":"2016-01-01T00:00:00.000"}],"responses":{"200":{"description":"The list of recordings","schema":{"$ref":"#/definitions/RecordingsList"},"examples":{"application/json":"{\n  \"data\": [\n    {\n      \"duration\": 1,\n      \"id\": \"c361e5927d2c4d7dcf71a142dc0ec6d9b-r0\",\n      \"created\": \"2016-02-28T23:54:57.075000\"\n    },\n    {\n      \"duration\": 2,\n      \"id\": \"c110cf16e8a0e202b7efb345ba4571d2d-r0\",\n      \"created\": \"2015-02-24T15:09:08.146000\"\n    }\n  ]\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to get recordings."}}}}},"/recordings/{id}":{"get":{"security":[{"basicAuth":[]}],"description":"Get metadata of one recording.","tags":["Calls"],"parameters":[{"name":"id","in":"path","description":"Id of the recording","required":true,"type":"string","default":"c814b5dd6ac2b5881834b710a1dedcad3-r0"}],"responses":{"200":{"description":"The metadata for the recording","schema":{"$ref":"#/definitions/Recording"},"examples":{"application/json":"{\n    \"duration\": 15,\n    \"id\": \"c361e5927d2c4d7dcf71a142dc0ec6d9b-r0\",\n    \"created\": \"2016-02-28T23:54:57.075000\"\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to get recording."}}}}},"/recordings/{id}.wav":{"get":{"produces":["application/octet-stream"],"security":[{"basicAuth":[]}],"description":"Get recodring soundfile.","tags":["Calls"],"parameters":[{"name":"id","in":"path","description":"Id of the recording","required":true,"type":"string","default":"c814b5dd6ac2b5881834b710a1dedcad3-r0"}],"responses":{"200":{"description":"The sound file of the recording","schema":{"type":"file"},"examples":{"application/octet-stream":null}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to download recording."}}}}},"/numbers":{"get":{"security":[{"basicAuth":[]}],"description":"Get all numbers allocated in the API","tags":["SMS","MMS","Calls"],"responses":{"200":{"description":"The list of the phone numbers.","schema":{"$ref":"#/definitions/NumberList"},"examples":{"application/json":"{\n  \"data\": [\n    {\n      \"id\": \"n53c05a4e002ae26f790cbaf82b93bc37\",\n      \"category\": \"mobile\",\n      \"country\": \"se\",\n      \"expires\": \"2016-12-01T07:52:15\",\n      \"voice_start\": \"http://www.server.nu/incommuingcall\",\n      \"number\": \"+46766861475\",\n      \"capabilities\": [\n        \"sms\",\n        \"voice\"\n      ],\n      \"sms_replies\": \"yes\",\n      \"active\": \"yes\"\n    },\n    {\n      \"id\": \"n53c05a4e002ae26f790cbaf82b93bc38\",\n      \"category\": \"mobile\",\n      \"country\": \"se\",\n      \"expires\": \"2016-12-01T07:52:15\",\n      \"sms_url\": \"http://www.server.nu/incommuingcall\",\n      \"number\": \"+46766861476\",\n      \"capabilities\": [\n        \"sms\",\n        \"voice\",\n        \"mms\"\n      ],\n      \"active\": \"yes\"\n    }\n  ]\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to get numbers."}}}},"post":{"security":[{"basicAuth":[]}],"tags":["SMS","MMS","Calls"],"description":"Allocate new number for usage in the API.","parameters":[{"name":"country","in":"formData","description":"country","required":true,"type":"string","default":"se"},{"name":"capabilities","in":"formData","description":"SMS, MMS, Voice","required":false,"type":"string","default":"sms,voice"},{"name":"sms_url","in":"formData","description":"Url where to send incomming sms. Set to \"none\" to clear.","required":false,"type":"string","default":"http://www.server.com/incommingsms"},{"name":"mms_url","in":"formData","description":"Url where to send incomming MMS. Set to \"none\" to clear.","required":false,"type":"string","default":"http://www.server.com/incommingmms"},{"name":"voice_start","in":"formData","description":"Url / JSON where to send incomming calls. Set to \"none\" to clear.","required":false,"type":"string","default":"http://www.server.com/incommingcall"},{"name":"sms_replies","in":"formData","description":"Prevent automatic response from callback server.","required":false,"type":"string","default":"yes"}],"responses":{"200":{"description":"Number allocated","schema":{"$ref":"#/definitions/Number"},"examples":{"application/json":"{\n  \"id\": \"n53c05a4e002ae26f790cbaf82b93bc37\",\n  \"category\": \"mobile\",\n  \"country\": \"se\",\n  \"expires\": \"2016-12-01T07:52:15\",\n  \"voice_start\": \"http://www.server.nu/incommuingcall\",\n  \"number\": \"+46766861475\",\n  \"capabilities\": [\n    \"sms\",\n    \"voice\"\n  ],\n  \"sms_replies\": \"yes\",\n  \"active\": \"yes\"\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to allocate number."}}}}},"/numbers/{id}":{"get":{"security":[{"basicAuth":[]}],"description":"Get information about one number.","parameters":[{"name":"id","in":"path","description":"Id of the number","required":true,"type":"string","default":"n70df59406a1b4643b96f3f10e1bfb7b1"}],"tags":["SMS","Calls","MMS"],"responses":{"200":{"description":"The number information","schema":{"$ref":"#/definitions/Number"},"examples":{"application/json":"{\n  \"id\": \"n53c05a4e002ae26f790cbaf82b93bc37\",\n  \"category\": \"mobile\",\n  \"country\": \"se\",\n  \"expires\": \"2016-12-01T07:52:15\",\n  \"voice_start\": \"http://www.server.nu/incommuingcall\",\n  \"number\": \"+46766861475\",\n  \"capabilities\": [\n    \"sms\",\n    \"voice\"\n  ],\n  \"sms_replies\": \"yes\",\n  \"active\": \"yes\"\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to get number."}}}},"post":{"security":[{"basicAuth":[]}],"description":"Change parameters of number","tags":["SMS","Calls","MMS"],"parameters":[{"name":"id","in":"path","description":"Number id","required":true,"type":"string","default":"n53c05a4e002ae26f790cbaf82b93bc37"},{"name":"sms_url","in":"formData","description":"Url where to send incomming messages.","required":false,"type":"string","default":"http://www.server.com/incommingsms"},{"name":"voice_start","in":"formData","description":"Url / JSON where to send incomming calls.","required":false,"type":"string","default":"http://www.server.com/incommingcall"},{"name":"mms_url","in":"formData","description":"Url where to send incomming MMS.","required":false,"type":"string","default":"http://www.server.com/incommingmms"},{"name":"sms_replies","in":"formData","description":"Prevent automatic response from callback server.","required":false,"type":"string","default":"yes"},{"name":"active","in":"formData","description":"Prevent automatic response from callback server.","required":false,"type":"string","default":"yes, (setting this to no is irreversible)"}],"responses":{"200":{"description":"Number updated","schema":{"$ref":"#/definitions/Number"},"examples":{"application/json":"{\n  \"id\": \"n53c05a4e002ae26f790cbaf82b93bc37\",\n  \"category\": \"mobile\",\n  \"country\": \"se\",\n  \"expires\": \"2016-12-01T07:52:15\",\n  \"voice_start\": \"http://www.server.nu/incommuingcall\",\n  \"number\": \"+46766861475\",\n  \"capabilities\": [\n    \"sms\",\n    \"voice\"\n  ],\n  \"sms_replies\": \"yes\",\n  \"active\": \"yes\"\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to change number."}}}}},"/Calls":{"post":{"tags":["Calls"],"security":[{"basicAuth":[]}],"description":"Start Phonecall","parameters":[{"name":"from","in":"formData","description":"Your 46elks umber like +46766861647.","required":true,"type":"string","default":"TestElk"},{"name":"to","in":"formData","description":"Number in e164 number like +46723175800.","required":true,"type":"string","default":"+46723175800"},{"name":"voice_start","in":"formData","description":"The JSON data for the call or URL to access when the call is awnserd.","required":true,"type":"string","default":"Hi! This is your message."},{"name":"whenhangup","in":"formData","description":"Url to send call data to when call ends.","required":false,"type":"string","default":"http://yourserver/"},{"name":"timeout","in":"formData","description":"Secounds to wait before stopping call.","required":false,"type":"integer","default":25}],"responses":{"200":{"description":"The metataa for the started call.","schema":{"$ref":"#/definitions/Callstart"},"examples":{"application/json":"{\n  \"direction\": \"outgoing\",\n  \"from\": \"+46723175800\",\n  \"created\": \"2016-11-03T15:08:14.609873\",\n  \"to\": \"+46723175800\",\n  \"state\": \"ongoing\",\n  \"id\": \"c719b1eefbf65b1f89c013e6433dbf537\"\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"The message was not sent."}}}},"get":{"security":[{"basicAuth":[]}],"description":"List latest 100 Calls","parameters":[{"name":"start","in":"query","description":"Show Calls older than this date","required":false,"type":"string","default":"2016-01-01T00:00:00.000"},{"name":"end","in":"query","description":"Show Calls newer than this date","required":false,"type":"string","default":"2016-01-01T00:00:00.000"}],"tags":["Calls"],"responses":{"200":{"description":"An array of products","schema":{"$ref":"#/definitions/CallsHistory"},"examples":{"application/json":"{\n  \"data\": [\n    {\n      \"direction\": \"outgoing\",\n      \"from\": \"+46723175800\",\n      \"created\": \"2016-11-03T15:08:14.609000\",\n      \"to\": \"+46723175800\",\n      \"state\": \"failed\",\n      \"id\": \"c719b1eefbf65b1f89c013e6433dbf537\"\n    },\n    {\n      \"direction\": \"incoming\",\n      \"from\": \"+46723175800\",\n      \"to\": \"+46101994214\",\n      \"created\": \"2016-11-03T09:24:24.355000\",\n      \"actions\": [\n        {\n          \"connect\": \"+4634090510\",\n          \"result\": \"success\"\n        }\n      ],\n      \"start\": \"2016-11-03T09:24:24.333000\",\n      \"state\": \"success\",\n      \"cost\": 1500,\n      \"duration\": 15,\n      \"legs\": [\n        {\n          \"duration\": 14,\n          \"to\": \"+4634090510\",\n          \"state\": \"success\",\n          \"from\": \"+46723175800\"\n        }\n      ],\n      \"id\": \"c595183c042b1e43d1c8e79b9fd5cbcab\"\n    }\n  ]\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to get calls."}}}}},"/Calls/{id}":{"delete":{"security":[{"basicAuth":[]}],"description":"Delete Call from history","parameters":[{"name":"id","in":"path","description":"Id of Call to delete","required":true,"type":"string","default":"c70df59406a1b4643b96f3f10e1bfb7b1"}],"tags":["Calls"],"responses":{"200":{"description":"The deleted Call","schema":{"$ref":"#/definitions/DeletedCall"},"examples":{"application/json":"{\n  \"id\": \"c70df59406a1b4643b96f3f10e1bfb7b1\",\n  \"deleted\": \"2018-06-25T08:40:22.109482\"\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to delete call."}}}},"get":{"security":[{"basicAuth":[]}],"description":"Get one Call.","parameters":[{"name":"id","in":"path","description":"Id of call to get","required":true,"type":"string","default":"c70df59406a1b4643b96f3f10e1bfb7b1"}],"tags":["Calls"],"responses":{"200":{"description":"The Call metadata","schema":{"$ref":"#/definitions/Calls"},"examples":{"application/json":"{\n  \"direction\": \"incoming\",\n  \"from\": \"+46723175800\",\n  \"to\": \"+46101994214\",\n  \"created\": \"2016-11-03T09:24:24.355000\",\n  \"actions\": [\n    {\n      \"connect\": \"+4634090510\",\n      \"result\": \"success\"\n    }\n  ],\n  \"start\": \"2016-11-03T09:24:24.333000\",\n  \"state\": \"success\",\n  \"cost\": 1500,\n  \"duration\": 15,\n  \"legs\": [\n    {\n      \"duration\": 14,\n      \"to\": \"+4634090510\",\n      \"state\": \"success\",\n      \"from\": \"+46723175800\"\n    }\n  ],\n  \"id\": \"c595183c042b1e43d1c8e79b9fd5cbcab\"\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to get call data."}}}}},"/SMS":{"post":{"tags":["SMS"],"security":[{"basicAuth":[]}],"description":"Send SMS","parameters":[{"name":"from","in":"formData","description":"Senderid like Elks (3-11 chars a-Z and 0-9 starting with a char), or a 46elks number like +46766861004 or a unlocked from number like your own number +46723175800.","required":true,"type":"string","default":"TestElk"},{"name":"to","in":"formData","description":"Number in e164 number like +46723175800 or in local format for AU,CA,DK,FI,IN,NO,SE and US prefix with country code like SE0723175800","required":true,"type":"string","default":"+46723175800"},{"name":"message","in":"formData","description":"Text to send to the phone.","required":true,"type":"string","default":"Hi! This is your message."},{"name":"whendelivered","in":"formData","description":"Url to send the Delivery report to","required":false,"type":"string","default":"http://yourserver/"},{"name":"flashsms","in":"formData","description":"Do not store message on the phone.","required":false,"type":"string","default":"no"},{"name":"dryrun","in":"formData","description":"Do not send the message, get price estimation and verify parameters.","required":false,"type":"string","default":"no"},{"name":"dontlog","in":"formData","description":"Do not store data about SMS in the API platform, set to \"message\" to hide message content.","required":false,"type":"string","default":"none"}],"responses":{"200":{"description":"SMS data","schema":{"$ref":"#/definitions/SMS"},"examples":{"application/json":"{\n  \"id\": \"s70df59406a1b4643b96f3f91e0bfb7b0\",\n  \"from\": \"Lasse\",\n  \"to\": \"+46723175800\",\n  \"message\": \"This is the message sent to the phone.\",\n  \"created\": \"2016-10-11T13:36:13.081000\",\n  \"cost\": 3500,\n  \"direction\": \"outgoing\"\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"The message was not sent."}}}},"get":{"security":[{"basicAuth":[]}],"description":"List latest 100 SMS","parameters":[{"name":"start","in":"query","description":"Show SMS older than this date","required":false,"type":"string","default":"2016-01-01T00:00:00.000"},{"name":"end","in":"query","description":"Show SMS newer than this date","required":false,"type":"string","default":"2016-01-01T00:00:00.000"}],"tags":["SMS"],"responses":{"200":{"description":"List of SMS","schema":{"$ref":"#/definitions/SMSHistory"},"examples":{"application/json":"{\n  \"data\": [\n    {\n      \"id\": \"s70df59406a1b4643b96f3f91e0bfb7b0\",\n      \"from\": \"Lasse\",\n      \"to\": \"+46723175800\",\n      \"message\": \"This is the message sent to the phone.\",\n      \"created\": \"2016-10-11T13:36:13.081000\",\n      \"cost\": 3500,\n      \"direction\": \"outgoing\"\n    },\n    {\n      \"id\": \"s3633fa8e62f823e52fbc67ebf6925ab5\",\n      \"direction\": \"incoming\",\n      \"from\": \"Martin\",\n      \"created\": \"2016-08-18T09:55:31.116000\",\n      \"to\": \"+46766861475\",\n      \"message\": \"TEst 32423\"\n    }\n  ]\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to get messages."}}}}},"/SMS/{id}":{"delete":{"security":[{"basicAuth":[]}],"description":"Delete SMS","parameters":[{"name":"id","in":"path","description":"Id of SMS to get","required":true,"type":"string","default":"s70df59406a1b4643b96f3f10e1bfb7b1"}],"tags":["SMS"],"responses":{"200":{"description":"The Deleted SMS","schema":{"$ref":"#/definitions/DeletedSMS"},"examples":{"application/json":"{\n  \"id\": \"s70df59406a1b4643b96f3f10e1bfb7b1\",\n  \"deleted\": \"2018-06-25T08:40:22.109482\"\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to delete message."}}}},"get":{"security":[{"basicAuth":[]}],"description":"Get one SMS.","parameters":[{"name":"id","in":"path","description":"Id of SMS to get","required":true,"type":"string","default":"s70df59406a1b4643b96f3f10e1bfb7b1"}],"tags":["SMS"],"responses":{"200":{"description":"The SMS","schema":{"$ref":"#/definitions/SMS"},"examples":{"application/json":"{\n  \"id\": \"s3633fa8e62f823e52fbc67ebf6925ab5\",\n  \"direction\": \"incoming\",\n  \"from\": \"Martin\",\n  \"created\": \"2016-08-18T09:55:31.116000\",\n  \"to\": \"+46766861475\",\n  \"message\": \"TEst 32423\"\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to get message."}}}}},"/MMS":{"post":{"security":[{"basicAuth":[]}],"description":"Send MMS","tags":["MMS"],"parameters":[{"name":"from","in":"formData","description":"\"noreply\" or number like +46723175800.","required":true,"type":"string","default":"TestElk"},{"name":"to","in":"formData","description":"Number in E.164 number like +46723175800.","required":true,"type":"string","default":"+46723175800"},{"name":"message","in":"formData","description":"Text to send to the phone.","required":true,"type":"string","default":"Hi! This is your message."},{"name":"image","in":"formData","description":"Url or Base64/url-encoded imagedata to send.","required":false,"type":"string","default":"http://yourserver/imge.png"}],"responses":{"200":{"description":"MMS object","schema":{"$ref":"#/definitions/MMS"},"examples":{"application/json":"{\n  \"direction\": \"outgoing\",\n  \"from\": \"+46766861218\",\n  \"created\": \"2016-11-03T12:44:56.180704\",\n  \"to\": \"+46723175800\",\n  \"cost\": 12500,\n  \"owner\": \"u5a0588130b2bfe9dec437a4df1056d15\",\n  \"message\": \"Hej!\",\n  \"id\": \"mf3d05c159aa49e1951c5301bc6af1bac\"\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"The message was not sent."}}}},"get":{"security":[{"basicAuth":[]}],"description":"List latest 100 MMS","parameters":[{"name":"start","in":"query","description":"Show MMS older than this date","required":false,"type":"string","default":"2016-01-01T00:00:00.000"},{"name":"end","in":"query","description":"Show MMS newer than this date","required":false,"type":"string","default":"2016-01-01T00:00:00.000"}],"tags":["MMS"],"responses":{"200":{"description":"An array of MMS","schema":{"$ref":"#/definitions/MMSHistory"},"examples":{"application/json":"{\n  \"data\": [\n    {\n      \"id\": \"m70df59406a1b4643b96f3f91e0bfb7b0\",\n      \"from\": \"Lasse\",\n      \"to\": \"+46723175800\",\n      \"message\": \"This is the message sent to the phone.\",\n      \"created\": \"2016-10-11T13:36:13.081000\",\n      \"cost\": 12500,\n      \"direction\": \"outgoing\",\n      \"images\": [\n        \"m70df59406a1b4643b96f3f91e0bfb7b0-i0\"\n      ]\n    },\n    {\n      \"id\": \"m3633fa8e62f823e52fbc67ebf6925ab5\",\n      \"direction\": \"incoming\",\n      \"from\": \"Martin\",\n      \"created\": \"2016-08-18T09:55:31.116000\",\n      \"to\": \"+46766861475\",\n      \"message\": \"TEst 32423\",\n      \"images\": [\n        \"m70df59406a1b4643b96f3f91e0bfb7b0-i0\"\n      ]\n    }\n  ]\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to get messages."}}}}},"/MMS/{id}":{"delete":{"security":[{"basicAuth":[]}],"description":"Delete MMS","parameters":[{"name":"id","in":"path","description":"Id of MMS to get","required":true,"type":"string","default":"m70df59406a1b4643b96f3f10e1bfb7b1"}],"tags":["MMS"],"responses":{"200":{"description":"The deleted MMS","schema":{"$ref":"#/definitions/DeletedMMS"},"examples":{"application/json":"{\n  \"id\": \"m70df59406a1b4643b96f3f10e1bfb7b1\",\n  \"deleted\": \"2018-06-25T08:40:22.109482\"\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to delete message."}}}},"get":{"security":[{"basicAuth":[]}],"description":"Get one MMS.","parameters":[{"name":"id","in":"path","description":"Id of MMS to get","required":true,"type":"string","default":"s70df59406a1b4643b96f3f10e1bfb7b1"}],"tags":["MMS"],"responses":{"200":{"description":"The MMS","schema":{"$ref":"#/definitions/MMS"},"examples":{"application/json":"{\n  \"id\": \"m84af96809ff8989f3668c93aaaedb69c\",\n  \"direction\": \"incoming\",\n  \"from\": \"+46723175800\",\n  \"created\": \"2016-08-18T09:55:31.116000\",\n  \"to\": \"+46766861475\",\n  \"message\": \"Message text.\",\n  \"images\": [\n    \"m84af96809ff8989f3668c93aaaedb69c-i0\"\n  ]\n}\n"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/Error"},"examples":{"text/plain; charset=utf-8":"Unable to get message."}}}}}},"definitions":{"RecordingsList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Recording"}}}},"Recording":{"type":"object","properties":{"id":{"type":"string","description":"c361e5927d2c4d7dcf71a142dc0ec6d9b-r0"},"duration":{"type":"integer","description":"15"},"created":{"type":"string","description":"2016-02-28T23:54:57.075000"}}},"NumberList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Number"}}}},"Number":{"type":"object","properties":{"id":{"type":"string","description":"n70df59406a1b4643b96f3f91e0bfb7b0"},"country":{"type":"string","description":"se"},"expires":{"type":"string","description":"2016-12-01T07:52:15"},"voice_start":{"type":"string","description":"https://yourserver/hooks/x"},"sms_url":{"type":"string","description":"https://yourserver/hooks/x"},"mms_url":{"type":"string","description":"https://yourserver/hooks/x"},"number":{"type":"string","description":"+46766861475"},"capabilities":{"type":"array","items":{"type":"string"},"description":"sms, voice, mms"},"sms_replies":{"type":"string","description":"yes"},"active":{"type":"string","description":"yes"},"category":{"type":"string","description":"mobile"}}},"SMSHistory":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/SMS"}}}},"DeletedMMS":{"type":"object","properties":{"id":{"type":"string","description":"m70df59406a1b4643b96f3f91e0bfb7b0"},"deleted":{"type":"string","description":"2018-06-25T08:40:22.109482"}}},"DeletedCall":{"type":"object","properties":{"id":{"type":"string","description":"c70df59406a1b4643b96f3f91e0bfb7b0"},"deleted":{"type":"string","description":"2018-06-25T08:40:22.109482"}}},"DeletedSMS":{"type":"object","properties":{"id":{"type":"string","description":"s70df59406a1b4643b96f3f91e0bfb7b0"},"deleted":{"type":"string","description":"2018-06-25T08:40:22.109482"}}},"SMS":{"type":"object","properties":{"id":{"type":"string","description":"s70df59406a1b4643b96f3f91e0bfb7b0"},"direction":{"type":"string","description":"outgoing"},"from":{"type":"string","description":"Lasse"},"to":{"type":"string","description":"+46723175800"},"message":{"type":"string","description":"test"},"created":{"type":"string","description":"2016-10-11T13:36:08.951000"},"cost":{"type":"integer","description":"3500"},"status":{"type":"string","description":"delivered"},"delivered":{"type":"string","description":"2016-10-11T13:36:13.081000"},"flashsms":{"type":"string","description":"yes"}}},"Callstart":{"type":"object","properties":{"direction":{"type":"string","description":"outgoing"},"from":{"type":"string","description":"+46723175800"},"created":{"type":"string","description":"2016-11-03T15:08:14.609873"},"to":{"type":"string","description":"+46723175800"},"state":{"type":"string","description":"ongoing"},"id":{"type":"string","description":"c719b1eefbf65b1f89c013e6433dbf537"}}},"CallsHistory":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Calls"}}}},"Calls":{"type":"object","properties":{"id":{"type":"string","description":"c595183c042b1e43d1c8e79b9fd5cbcab"},"direction":{"type":"string","description":"incoming"},"from":{"type":"string","description":"+46723175800"},"to":{"type":"string","description":"+46101994214"},"legs":{"type":"array","items":{"type":"object"},"description":"List of all call parts."},"actions":{"type":"array","items":{"type":"object"},"description":"Array of actions taken by the 46elks API"},"start":{"type":"string","description":"2016-11-03T09:24:24.333000"},"state":{"type":"string","description":"success"},"created":{"type":"string","description":"2016-10-11T13:36:08.951000"},"cost":{"type":"integer","description":"1500"},"duration":{"type":"integer","description":"15"}}},"MMSHistory":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/MMS"}}}},"MMS":{"type":"object","properties":{"id":{"type":"string","description":"s70df59406a1b4643b96f3f91e0bfb7b0"},"direction":{"type":"string","description":"outgoing"},"from":{"type":"string","description":"+46723175800"},"to":{"type":"string","description":"+46723175800"},"message":{"type":"string","description":"test"},"created":{"type":"string","description":"2016-10-11T13:36:08.951000"},"cost":{"type":"integer","description":"3500"},"images":{"type":"array","items":{"type":"string"},"description":"m84af96809ff8989f3668c93aaaedb69c-i0"}}},"ImagesList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Image"}}}},"Image":{"type":"object","properties":{"id":{"type":"string","description":"mf3d05c159aa49e1951c5301bc6af1bac-i0"},"digest":{"type":"string","description":"6f15a43f350b49a02e6cdb0dd1863feeaa9f2fc4"},"created":{"type":"string","description":"2016-11-03T12:44:56.190000"},"filetype":{"type":"integer","description":"jpg"},"mmsid":{"type":"string","description":"mf3d05c159aa49e1951c5301bc6af1bac"},"bytes":{"type":"integer","description":"42"}}},"SubaccountsList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Subaccount"}}}},"Subaccount":{"type":"object","properties":{"usage":{"type":"integer","description":"10000"},"id":{"type":"string","description":"af3d05a159669e1951c5301bc6a61bac"},"secret":{"type":"string","description":"D81DEF1B65E19A83DBCEA0BE0D89D082"},"created":{"type":"string","description":"2016-11-03T12:44:56.190000"},"usagelimit":{"type":"integer","description":"99999999999"},"name":{"type":"string","description":"This Co"}}},"Account":{"type":"object","properties":{"id":{"type":"string","description":"u5a9566c072160c398445d163949bf505"},"mobilenumber":{"type":"string","description":"+46723175800"},"balance":{"type":"integer","description":"9670500"},"creditalert":{"type":"integer","description":"200000"},"currency":{"type":"string","description":"SEK / EUR"},"email":{"type":"string","description":"martin.thure@gmail.com"},"displayname":{"type":"string","description":"Martin Harari Thuresson"}}},"Error":{"type":"string"}}}