{ "uuid": "f8ddcc37-3ab3-4c71-ad7e-2cbb80054c54", "lastMigration": 19, "name": "Numbers API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "0.0.0.0", "routes": [ { "uuid": "ef9a3e1d-3a1c-4907-97c4-9e844a04b0d5", "documentation": "List the numbers you own", "method": "get", "endpoint": "account/numbers", "responses": [ { "uuid": "fe63280a-3579-4f7b-8240-4cc8855f82e7", "body": "{\n \"count\": 1,\n \"numbers\": [\n {\n \"country\": \"GB\",\n \"features\": [\n \"VOICE\",\n \"SMS\",\n \"MMS\"\n ],\n \"messagesCallbackType\": \"app\",\n \"messagesCallbackValue\": \"aaaaaaaa-bbbb-cccc-dddd-0123456789ab\",\n \"moHttpUrl\": \"https://example.com/webhooks/inbound-sms\",\n \"msisdn\": \"447700900000\",\n \"type\": \"mobile-lvn\",\n \"voiceCallbackType\": \"app\",\n \"voiceCallbackValue\": \"aaaaaaaa-bbbb-cccc-dddd-0123456789ab\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "633501fd-97a4-4550-8f65-eb9f0ed5bbdb", "body": "{\n \"error-code\": \"401\",\n \"error-code-label\": \"authentication failed\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "3e3d272a-bf93-419b-b8d6-2edc3112505e", "documentation": "Buy a number", "method": "post", "endpoint": "number/buy", "responses": [ { "uuid": "1cc8a559-7a3a-49cf-b48e-6b96cc1a24df", "body": "{\n \"error-code\": \"200\",\n \"error-code-label\": \"success\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a960dbf9-0582-48e7-9900-c4054b407382", "body": "{\n \"error-code\": \"401\",\n \"error-code-label\": \"authentication failed\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "8e86e90c-b64d-4d3b-9a20-8857a268d3bf", "body": "{\n \"error-code\": \"420\",\n \"error-code-label\": \"Numbers from this country can be requested from the Dashboard (https://dashboard.nexmo.com/buy-numbers) as they require a valid local address to be provided before being purchased.\"\n}", "latency": 0, "statusCode": 420, "label": "Action failed", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c965e969-5bd0-4668-b303-017be82c711d", "documentation": "Cancel a number", "method": "post", "endpoint": "number/cancel", "responses": [ { "uuid": "a917ad0b-4ecd-4c82-ad80-45b8b507a2c2", "body": "{\n \"error-code\": \"200\",\n \"error-code-label\": \"success\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "930294f7-bc83-4a03-9d1a-a68cd288cdd6", "body": "{\n \"error-code\": \"401\",\n \"error-code-label\": \"authentication failed\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "3bd5b844-9aa5-4d68-8fd8-2610aa38e208", "documentation": "Search available numbers", "method": "get", "endpoint": "number/search", "responses": [ { "uuid": "c142d40f-22bf-4a9a-9e96-2e13765b150f", "body": "{\n \"count\": 1234,\n \"numbers\": [\n {\n \"cost\": \"1.25\",\n \"country\": \"GB\",\n \"features\": [\n \"VOICE\",\n \"SMS\",\n \"MMS\"\n ],\n \"msisdn\": \"447700900000\",\n \"type\": \"mobile-lvn\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "8e7d47bf-bdff-4db2-a444-e1fd3b640ff8", "body": "{\n \"error-code\": \"401\",\n \"error-code-label\": \"authentication failed\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "8c36f359-1948-4b39-a98d-5d6c060fac79", "documentation": "Update a number", "method": "post", "endpoint": "number/update", "responses": [ { "uuid": "1e8e2232-1dcf-48ea-93ad-69abdbf6a507", "body": "{\n \"error-code\": \"200\",\n \"error-code-label\": \"success\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "4b5a1fcb-53b9-449d-b5a6-5efa8714ebfc", "body": "{\n \"error-code\": \"401\",\n \"error-code-label\": \"authentication failed\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [ { "key": "", "value": "" } ], "proxyResHeaders": [ { "key": "", "value": "" } ] }