{ "uuid": "aeb65db6-6d42-4ed7-acde-8923140e8402", "lastMigration": 29, "name": "The SMS Works API", "endpointPrefix": "v1", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "b4b13b31-3f6d-449d-b356-9a5acbcd0e63", "documentation": "Utility method. Please generate your API key by following the instructions on your account page at https://thesmsworks.co.uk/user/login", "method": "get", "endpoint": "auth/getApiKey", "responses": [ { "uuid": "ad7965c1-2448-4b63-b5a6-d80e8c28f794", "body": "{\n \"key\": \"22795661-48a1-442d-92a3-bc2384836fad\",\n \"secret\": \"10045176307448ced2e1b74963d137f2bfaefbdad6fe415df429b64c4d63b856\"\n}", "latency": 0, "statusCode": 201, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f151202a-8583-40b3-bc31-eb2f4b1ac49a", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f195c3df-8997-40ce-a62d-11745b2dd76f", "documentation": "Generates a JSON Web Token for including in the Authorization header of all your calls to the API. This only needs to be done once. Generate the customer ID, API Key & Secret required for this call from the API Key tab your account page.", "method": "post", "endpoint": "auth/token", "responses": [ { "uuid": "af99addd-9156-4470-a677-7553f91b491a", "body": "{\n \"token\": \"JWT eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJPbmxpbmUgSldUIEJ1aWxkZXIiLCJpYXQiOjE1MDA0OTU2NjEsImV4cCI6MTUzMjAzMTY2MSwiYXVkIjoid3d3LmV4YW1wbGUuY29tIiwic3ViIjoianJvY2tldEBleGFtcGxlLmNvbSIsIkdpdmVuTmFtZSI6IkpvaG5ueSIsIlN1cm5hbWUiOiJSb2NrZXQiLCJFbWFpbCI6Impyb2NrZXRAZXhhbXBsZS5jb20iLCJSb2xlIjpbIk1hbmFnZXIiLCJQcm9qZWN0IEFkbWluaXN0cmF0b3IiXX0.BR1BIDy0Mw3R4ilfqAojsnh7bp_pgeX2jfjhhZyaexQ\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "76208a15-71f6-40ce-a40f-3745d35984a2", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b869c6eb-d347-4c74-bdcb-94ee3989d857", "documentation": "Schedules a batch of SMS messages to be sent at the date time you specify", "method": "post", "endpoint": "batch/schedule", "responses": [ { "uuid": "e4fa017c-74a9-4d40-847b-51ac87628396", "body": "{\n \"batchid\": 3200562,\n \"status\": \"SCHEDULED\"\n}", "latency": 0, "statusCode": 201, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5b25b95a-96de-4a4d-8b65-aca74f71b58a", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1690053a-718e-42fb-bdd4-cd5471ba0a05", "documentation": "Send a single SMS message to multiple recipients", "method": "post", "endpoint": "batch/send", "responses": [ { "uuid": "7a81faae-c67c-48af-b4b9-e7e5210d4edb", "body": "{\n \"batchid\": 2586749,\n \"status\": \"SCHEDULED\"\n}", "latency": 0, "statusCode": 201, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e1cb4772-db91-4cdd-8a42-b971487c675a", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b85b0532-6b9b-4064-b7a9-ca515cf84e4d", "documentation": "Retrieve all messages in a batch with the given batch ID", "method": "get", "endpoint": "batch/:batchid", "responses": [ { "uuid": "1185e4ac-ab3f-4555-9e27-dc8c971c5a7a", "body": "[\n {\n \"batchid\": \"2586749\",\n \"content\": \"My super awesome message\",\n \"created\": \"Wed Jul 19 2017 20:53:46 GMT+0100 (BST)\",\n \"customerid\": \"0fca8c3c-6cbc-11e7-8154-a6006ad3dba0\",\n \"deliveryreporturl\": \"https://your.domain.com/delivery/report/path\",\n \"destination\": \"447777777777\",\n \"failurereason\": {\n \"code\": 34,\n \"details\": \"Handset error\",\n \"permanent\": {{faker 'datatype.boolean'}}\n },\n \"id\": 123456789,\n \"identifier\": 7777777777,\n \"keyword\": \"CALRISSIAN\",\n \"messageid\": 123456789,\n \"modified\": \"Wed Jul 19 2017 20:53:49 GMT+0100 (BST)\",\n \"schedule\": \"Wed Jul 19 2017 20:53:45 GMT+0100 (BST)\",\n \"sender\": \"YourCompany\",\n \"status\": \"DELIVERED\",\n \"tag\": \"campaign2\"\n }\n]", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0157178b-99e3-4245-bc4d-4ec2977b591f", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7e5cc2da-0703-48e7-9de0-2cc052455763", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1ac2221a-b7e8-4b18-aefe-0edb1d2831c7", "documentation": "Cancels a scheduled SMS message", "method": "delete", "endpoint": "batches/schedule/:batchid", "responses": [ { "uuid": "f32ce8ae-1fcd-49f4-b6d0-2c821c3584ac", "body": "{\n \"messageid\": 5620320,\n \"status\": \"CANCELLED\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "67b6bb10-941d-42f7-8afb-3ed782c25b76", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "071fcc5b-bc3f-4585-9924-092584b8c0f1", "documentation": "Returns the number of credits currently available on the account", "method": "get", "endpoint": "credits/balance", "responses": [ { "uuid": "603027b4-a287-4ee0-8b33-7144071999cd", "body": "{\n \"credits\": 180\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e7e74990-c2ad-4f6a-a77b-33bc36fb162c", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5d39d0a7-421c-4b1b-be22-dcdcff8871fd", "documentation": "Sends an SMS flash message, which appears on the recipients lock screen", "method": "post", "endpoint": "message/flash", "responses": [ { "uuid": "39c225ee-82dc-4a20-b19a-578c87c9258e", "body": "{\n \"credits\": 180,\n \"creditsUsed\": 2,\n \"messageid\": 123456789,\n \"status\": \"SENT\"\n}", "latency": 0, "statusCode": 201, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e62e6737-e7ba-4623-9032-687360b515dc", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 402, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dc4bd5fa-3016-4861-a6ea-3a6352791e16", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9d6c762d-6259-4534-b90c-932f04151c8e", "documentation": "Schedules an SMS message to be sent at the date-time you specify", "method": "post", "endpoint": "message/schedule", "responses": [ { "uuid": "e219c45e-e4fd-41f8-8818-0ab74d99c3b7", "body": "{\n \"messageid\": 123456789,\n \"status\": \"SCHEDULED\"\n}", "latency": 0, "statusCode": 201, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "06d5512e-9937-4fb4-a414-f6cd57354fc5", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e35db7c4-528f-428a-8352-1ffed9cbfc00", "documentation": "Send an SMS Message", "method": "post", "endpoint": "message/send", "responses": [ { "uuid": "048b6d66-bd16-49a4-a5a9-fb413744dd51", "body": "{\n \"credits\": 180,\n \"creditsUsed\": 2,\n \"messageid\": 123456789,\n \"status\": \"SENT\"\n}", "latency": 0, "statusCode": 201, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7d8db6b1-82bd-4ac8-bc85-4659ead1f0f5", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 402, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c0e58da8-2fea-4678-9794-cac17a3f059d", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "047ec289-be9e-49a2-910c-dc2e78484e1f", "documentation": "Retrieve up to 1000 messages matching your search criteria", "method": "post", "endpoint": "messages", "responses": [ { "uuid": "16cb0380-816a-45b4-80cc-31cd8239926d", "body": "[\n {\n \"batchid\": \"2586749\",\n \"content\": \"My super awesome message\",\n \"created\": \"Wed Jul 19 2017 20:53:46 GMT+0100 (BST)\",\n \"customerid\": \"0fca8c3c-6cbc-11e7-8154-a6006ad3dba0\",\n \"deliveryreporturl\": \"https://your.domain.com/delivery/report/path\",\n \"destination\": \"447777777777\",\n \"failurereason\": {\n \"code\": 34,\n \"details\": \"Handset error\",\n \"permanent\": {{faker 'datatype.boolean'}}\n },\n \"id\": 123456789,\n \"identifier\": 7777777777,\n \"keyword\": \"CALRISSIAN\",\n \"messageid\": 123456789,\n \"modified\": \"Wed Jul 19 2017 20:53:49 GMT+0100 (BST)\",\n \"schedule\": \"Wed Jul 19 2017 20:53:45 GMT+0100 (BST)\",\n \"sender\": \"YourCompany\",\n \"status\": \"DELIVERED\",\n \"tag\": \"campaign2\"\n }\n]", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1ef3ef70-6b73-4072-8c0a-7cf37842e5a6", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "32bd8047-7c27-4b5d-804c-2e9f6ab4d78d", "documentation": "Get failed messages matching your search criteria", "method": "post", "endpoint": "messages/failed", "responses": [ { "uuid": "2072492f-8d65-4537-8056-221f6d84fed9", "body": "[\n {\n \"batchid\": \"2586749\",\n \"content\": \"My super awesome message\",\n \"created\": \"Wed Jul 19 2017 20:53:46 GMT+0100 (BST)\",\n \"customerid\": \"0fca8c3c-6cbc-11e7-8154-a6006ad3dba0\",\n \"deliveryreporturl\": \"https://your.domain.com/delivery/report/path\",\n \"destination\": \"447777777777\",\n \"failurereason\": {\n \"code\": 34,\n \"details\": \"Handset error\",\n \"permanent\": {{faker 'datatype.boolean'}}\n },\n \"id\": 123456789,\n \"identifier\": 7777777777,\n \"keyword\": \"CALRISSIAN\",\n \"messageid\": 123456789,\n \"modified\": \"Wed Jul 19 2017 20:53:49 GMT+0100 (BST)\",\n \"schedule\": \"Wed Jul 19 2017 20:53:45 GMT+0100 (BST)\",\n \"sender\": \"YourCompany\",\n \"status\": \"DELIVERED\",\n \"tag\": \"campaign2\"\n }\n]", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1c5ac30c-4a53-4715-ae66-0e5edb761848", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "12d81cde-93f9-44f0-bddf-96094665ab25", "documentation": "Get unread uncoming messages matching your search criteria", "method": "post", "endpoint": "messages/inbox", "responses": [ { "uuid": "596a15ca-8a94-4181-9175-551b0bd5668e", "body": "[\n {\n \"batchid\": \"2586749\",\n \"content\": \"My super awesome message\",\n \"created\": \"Wed Jul 19 2017 20:53:46 GMT+0100 (BST)\",\n \"customerid\": \"0fca8c3c-6cbc-11e7-8154-a6006ad3dba0\",\n \"deliveryreporturl\": \"https://your.domain.com/delivery/report/path\",\n \"destination\": \"447777777777\",\n \"failurereason\": {\n \"code\": 34,\n \"details\": \"Handset error\",\n \"permanent\": {{faker 'datatype.boolean'}}\n },\n \"id\": 123456789,\n \"identifier\": 7777777777,\n \"keyword\": \"CALRISSIAN\",\n \"messageid\": 123456789,\n \"modified\": \"Wed Jul 19 2017 20:53:49 GMT+0100 (BST)\",\n \"schedule\": \"Wed Jul 19 2017 20:53:45 GMT+0100 (BST)\",\n \"sender\": \"YourCompany\",\n \"status\": \"DELIVERED\",\n \"tag\": \"campaign2\"\n }\n]", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7b0c887c-acbd-4eab-9b0b-b70737f060b9", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f67828f3-b200-4925-8c2a-b69e46b1efed", "documentation": "Cancels a scheduled SMS message", "method": "delete", "endpoint": "messages/schedule/:messageid", "responses": [ { "uuid": "2cb5bc50-9c1e-4d2c-a900-556e1bbad6fc", "body": "{\n \"messageid\": 5620320,\n \"status\": \"CANCELLED\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b488d469-2417-4109-95c8-66d1cbf4af80", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5883448e-d79f-451f-9940-107c591dd697", "documentation": "Delete the message with the mathcing messageid", "method": "delete", "endpoint": "messages/:messageid", "responses": [ { "uuid": "abc0ccd0-1e62-485d-bfac-f589e8be861c", "body": "{\n \"messageid\": 5620320,\n \"status\": \"DELETED\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9f878ca4-0c45-4ad7-b3df-fe1008feee0a", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d76a5ca7-6409-4ef8-8283-06f36f308483", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "abef01c2-19e3-4fca-ae7e-c79d413fee4d", "documentation": "Retrieve a logged message by the message ID", "method": "get", "endpoint": "messages/:messageid", "responses": [ { "uuid": "a86d94ab-6f9d-4203-8c99-00e81e215531", "body": "{\n \"batchid\": \"2586749\",\n \"content\": \"My super awesome message\",\n \"created\": \"Wed Jul 19 2017 20:53:46 GMT+0100 (BST)\",\n \"customerid\": \"0fca8c3c-6cbc-11e7-8154-a6006ad3dba0\",\n \"deliveryreporturl\": \"https://your.domain.com/delivery/report/path\",\n \"destination\": \"447777777777\",\n \"failurereason\": {\n \"code\": 34,\n \"details\": \"Handset error\",\n \"permanent\": {{faker 'datatype.boolean'}}\n },\n \"id\": 123456789,\n \"identifier\": 7777777777,\n \"keyword\": \"CALRISSIAN\",\n \"messageid\": 123456789,\n \"modified\": \"Wed Jul 19 2017 20:53:49 GMT+0100 (BST)\",\n \"schedule\": \"Wed Jul 19 2017 20:53:45 GMT+0100 (BST)\",\n \"sender\": \"YourCompany\",\n \"status\": \"DELIVERED\",\n \"tag\": \"campaign2\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "98549e32-a096-4023-9009-51cb38adac53", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9c8eb535-d51f-49b6-a6c8-2cec81ad7f0d", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d5c82c2a-31b5-471a-8401-6635a944c453", "documentation": "Returns a sample error object for the given error code. Useful for designing code to react to errors when they occur for real.", "method": "get", "endpoint": "utils/errors/:errorcode", "responses": [ { "uuid": "aee186b7-d708-4695-b3ed-310297ff03de", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b1dfdc69-6810-475f-a119-fc5fb8d873c9", "documentation": "Returns the customer ID to the caller", "method": "get", "endpoint": "utils/test", "responses": [ { "uuid": "7c49b641-8f21-43aa-8d1b-f186015d8582", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "62791aa8-5223-4ace-aaa7-3962cf734ac6", "body": "{\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "b4b13b31-3f6d-449d-b356-9a5acbcd0e63" }, { "type": "route", "uuid": "f195c3df-8997-40ce-a62d-11745b2dd76f" }, { "type": "route", "uuid": "b869c6eb-d347-4c74-bdcb-94ee3989d857" }, { "type": "route", "uuid": "1690053a-718e-42fb-bdd4-cd5471ba0a05" }, { "type": "route", "uuid": "b85b0532-6b9b-4064-b7a9-ca515cf84e4d" }, { "type": "route", "uuid": "1ac2221a-b7e8-4b18-aefe-0edb1d2831c7" }, { "type": "route", "uuid": "071fcc5b-bc3f-4585-9924-092584b8c0f1" }, { "type": "route", "uuid": "5d39d0a7-421c-4b1b-be22-dcdcff8871fd" }, { "type": "route", "uuid": "9d6c762d-6259-4534-b90c-932f04151c8e" }, { "type": "route", "uuid": "e35db7c4-528f-428a-8352-1ffed9cbfc00" }, { "type": "route", "uuid": "047ec289-be9e-49a2-910c-dc2e78484e1f" }, { "type": "route", "uuid": "32bd8047-7c27-4b5d-804c-2e9f6ab4d78d" }, { "type": "route", "uuid": "12d81cde-93f9-44f0-bddf-96094665ab25" }, { "type": "route", "uuid": "f67828f3-b200-4925-8c2a-b69e46b1efed" }, { "type": "route", "uuid": "5883448e-d79f-451f-9940-107c591dd697" }, { "type": "route", "uuid": "abef01c2-19e3-4fca-ae7e-c79d413fee4d" }, { "type": "route", "uuid": "d5c82c2a-31b5-471a-8401-6635a944c453" }, { "type": "route", "uuid": "b1dfdc69-6810-475f-a119-fc5fb8d873c9" } ] }