{ "uuid": "50b0560d-8ab9-4edb-be67-490e379f4eaa", "lastMigration": 19, "name": "Telnyx API", "endpointPrefix": "v2", "latency": 0, "port": 3000, "hostname": "0.0.0.0", "routes": [ { "uuid": "f8d1a489-15ee-4f72-ae71-6e6a3e1ee5af", "documentation": "Delete several credentials", "method": "delete", "endpoint": "actions/bulk/telephony_credentials", "responses": [ { "uuid": "93b7283f-4d06-49ab-9453-15d8cebc63cd", "body": "{\n \"data\": {\n \"credentials\": {{faker 'random.number'}}\n }\n}", "latency": 0, "statusCode": 201, "label": "Successful response for Bulk credential requests", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "aa9cd5b9-a2d2-48ca-8215-80ad9006d8ad", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e5113783-54a7-4ebc-bc2f-01aace852a6a", "documentation": "Update several credentials", "method": "patch", "endpoint": "actions/bulk/telephony_credentials", "responses": [ { "uuid": "3c201bfc-5125-4946-979e-ebc68fb3c870", "body": "{\n \"data\": {\n \"credentials\": {{faker 'random.number'}}\n }\n}", "latency": 0, "statusCode": 201, "label": "Successful response for Bulk credential requests", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3e8a8d00-f950-4712-a316-b80cb76874a9", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "4d1f24f9-e2e7-423c-83fa-fe0f1389bc8d", "documentation": "Creates several credentials", "method": "post", "endpoint": "actions/bulk/telephony_credentials", "responses": [ { "uuid": "32baed88-ec54-499f-9bec-d1fbbb8c6c67", "body": "{\n \"data\": {\n \"credentials\": {{faker 'random.number'}}\n }\n}", "latency": 0, "statusCode": 201, "label": "Successful response for Bulk credential requests", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ba783e6e-5695-44fd-b4aa-ace47530c787", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "9fc8f181-1190-4067-bea5-42a4c0f930b8", "documentation": "Bulk Network Preferences for SIM cards", "method": "put", "endpoint": "actions/network_preferences/sim_cards", "responses": [ { "uuid": "592d331e-37d4-40ae-80fe-70ce5c630c41", "body": "{\n \"data\": [\n {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"mobile_operator_network_name\": \"AT&T Mobility (USACG)\",\n \"priority\": {{faker 'random.number'}}\n }\n ],\n \"ota_updates\": [\n {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"ota_update\",\n \"settings\": {\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"mobile_operator_network_name\": \"AT&T Mobility (USACG)\",\n \"priority\": 0\n }\n ]\n },\n \"sim_card_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"in-progress\",\n \"type\": \"sim_card_network_preferences\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n ],\n \"record_type\": \"sim_card_network_preferences\",\n \"sim_card_id\": \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n ],\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 202, "label": "", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e069625e-e759-4a37-8f5a-ef60b22613fd", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check the 'detail' field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5b7897aa-72b5-41da-8bb0-2df7931ed0c5", "documentation": "Register SIM cards", "method": "post", "endpoint": "actions/register/sim_cards", "responses": [ { "uuid": "77de0c40-915b-4397-817c-13da6ac7bdd6", "body": "{\n \"data\": [\n {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"iccid\": \"89310410106543789301\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"imsi\": 81932214823362980,\n \"msisdn\": \"+13109976224\",\n \"record_type\": \"sim_card\",\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"{{oneOf (array 'registering' 'enabling' 'enabled' 'disabling' 'disabled' 'data_limit_exceeded')}}\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ],\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n ],\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 202, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "4df1c65f-16e9-498f-8d97-e59c6f418fc8", "documentation": "Perform activate or deactivate action on all credentials filtered by the provided tag.", "method": "post", "endpoint": "actions/:action/telephony_credentials", "responses": [ { "uuid": "3713f4a1-d993-4f46-a779-1cba01966354", "body": "{\n \"data\": {\n \"credentials\": {{faker 'random.number'}}\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response for Bulk credential requests", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "b728db99-afec-4336-904a-f60c187cab41", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ffea09a9-09fd-4b00-8fbe-d0246829f3ec", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e44ab3f8-1c55-49ee-a6aa-46c319eb915f", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "44150242-60d9-4f46-b9de-259a6175c59a", "documentation": "List all addresses", "method": "get", "endpoint": "addresses", "responses": [ { "uuid": "863ca2f8-7685-4caa-946c-2f45ac08d063", "body": "{\n \"data\": [\n {\n \"address_book\": true,\n \"administrative_area\": \"IL\",\n \"borough\": \"Guadalajara\",\n \"business_name\": \"Toy-O'Kon\",\n \"country_code\": \"US\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"customer_reference\": \"MY REF 001\",\n \"extended_address\": \"#504\",\n \"first_name\": \"Alfred\",\n \"id\": \"1293384261075731499\",\n \"last_name\": \"Foster\",\n \"locality\": \"Chicago\",\n \"neighborhood\": \"Ciudad de los deportes\",\n \"phone_number\": \"+12125559000\",\n \"postal_code\": \"60654\",\n \"record_type\": \"address\",\n \"street_address\": \"311 W Superior Street\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"validate_address\": true\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ccdb3ad4-580b-41d8-83cf-8bc3c09f0cf1", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "db8ec1e4-32ad-4733-b7fb-19d9de1b12ed", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "9919dd89-283b-4064-bace-16e19dd432bf", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a828f915-71d4-42b6-853f-e1c19ceaf8f2", "documentation": "Creates an address", "method": "post", "endpoint": "addresses", "responses": [ { "uuid": "bddf49a9-ca21-4220-afdb-1e3983aa586d", "body": "{\n \"data\": {\n \"address_book\": true,\n \"administrative_area\": \"IL\",\n \"borough\": \"Guadalajara\",\n \"business_name\": \"Toy-O'Kon\",\n \"country_code\": \"US\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"customer_reference\": \"MY REF 001\",\n \"extended_address\": \"#504\",\n \"first_name\": \"Alfred\",\n \"id\": \"1293384261075731499\",\n \"last_name\": \"Foster\",\n \"locality\": \"Chicago\",\n \"neighborhood\": \"Ciudad de los deportes\",\n \"phone_number\": \"+12125559000\",\n \"postal_code\": \"60654\",\n \"record_type\": \"address\",\n \"street_address\": \"311 W Superior Street\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"validate_address\": true\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "765e6841-92c0-4608-924e-905f27dfe368", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0f6e3bd7-ae89-4d7a-883a-86e043c71d8a", "documentation": "Validate an address", "method": "post", "endpoint": "addresses/actions/validate", "responses": [ { "uuid": "f6a61135-5c71-4519-853d-ab647245e03c", "body": "{\n \"data\": {\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ],\n \"record_type\": \"address_validation\",\n \"result\": \"{{oneOf (array 'valid' 'invalid')}}\",\n \"suggested\": {\n \"administrative_area\": \"IL\",\n \"country_code\": \"US\",\n \"extended_address\": \"#504\",\n \"locality\": \"Chicago\",\n \"postal_code\": \"60654\",\n \"street_address\": \"311 W Superior Street\"\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Action response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "b147c08c-8505-4a16-93ab-9fa0f27aafff", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "bc8e44aa-5a85-4761-88e6-6002c18f2598", "documentation": "Deletes an address", "method": "delete", "endpoint": "addresses/:id", "responses": [ { "uuid": "baec7ded-8dcf-49e9-aa43-2180e32d97b6", "body": "{\n \"data\": {\n \"address_book\": true,\n \"administrative_area\": \"IL\",\n \"borough\": \"Guadalajara\",\n \"business_name\": \"Toy-O'Kon\",\n \"country_code\": \"US\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"customer_reference\": \"MY REF 001\",\n \"extended_address\": \"#504\",\n \"first_name\": \"Alfred\",\n \"id\": \"1293384261075731499\",\n \"last_name\": \"Foster\",\n \"locality\": \"Chicago\",\n \"neighborhood\": \"Ciudad de los deportes\",\n \"phone_number\": \"+12125559000\",\n \"postal_code\": \"60654\",\n \"record_type\": \"address\",\n \"street_address\": \"311 W Superior Street\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"validate_address\": true\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "7ea51563-db63-4254-ad9b-062da0d0bae9", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "60bf4770-ccef-49e9-976a-8c2dd5f20e0c", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "7aa4e7a8-cabd-4a1f-b2fa-a925aade4304", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "50983420-ff10-4e48-a5da-26cfc415240b", "documentation": "Retrieve an address", "method": "get", "endpoint": "addresses/:id", "responses": [ { "uuid": "99fd08e7-80a4-45cb-9b3c-0ca9f5f240d0", "body": "{\n \"data\": {\n \"address_book\": true,\n \"administrative_area\": \"IL\",\n \"borough\": \"Guadalajara\",\n \"business_name\": \"Toy-O'Kon\",\n \"country_code\": \"US\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"customer_reference\": \"MY REF 001\",\n \"extended_address\": \"#504\",\n \"first_name\": \"Alfred\",\n \"id\": \"1293384261075731499\",\n \"last_name\": \"Foster\",\n \"locality\": \"Chicago\",\n \"neighborhood\": \"Ciudad de los deportes\",\n \"phone_number\": \"+12125559000\",\n \"postal_code\": \"60654\",\n \"record_type\": \"address\",\n \"street_address\": \"311 W Superior Street\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"validate_address\": true\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "b24ff010-ef2f-44d6-a59e-f3a738d7168c", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "dd2ce032-619e-4c13-b667-a260aa48682e", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "189fcb92-bcd8-498e-b0a7-ebe689006df6", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f5655afc-c5ef-48da-84e7-03af0bf35d61", "documentation": "List all SSO authentication providers", "method": "get", "endpoint": "authentication_providers", "responses": [ { "uuid": "681a531d-5367-4016-83ab-05cf96eacaac", "body": "{\n \"data\": [\n {\n \"active\": true,\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"35146afd-df93-4963-b1e9-1a085e2ae874\",\n \"name\": \"Okta\",\n \"organization_id\": \"24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7\",\n \"record_type\": \"authentication_provider\",\n \"settings\": {\n \"assertion_consumer_service_url\": \"https://api.telnyx.com/sso/saml/auth/myorg\",\n \"idp_cert_fingerprint\": \"13:38:C7:BB:C9:FF:4A:70:38:3A:E3:D9:5C:CD:DB:2E:50:1E:80:A7\",\n \"idp_cert_fingerprint_algorithm\": \"{{oneOf (array 'sha1' 'sha256' 'sha384' 'sha512')}}\",\n \"idp_entity_id\": \"https://myorg.myidp.com/saml/metadata\",\n \"idp_sso_target_url\": \"https://myorg.myidp.com/trust/saml2/http-post/sso\",\n \"name_identifier_format\": \"urn:oasis:names:tc:SAML:1.1:nameid-format\",\n \"service_provider_entity_id\": \"https://api.telnyx.com/sso/saml/metadata/myorg\"\n },\n \"short_name\": \"myorg\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "93cdbedc-6f80-42d6-b232-4148c35fb061", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ca07aff6-07ec-464c-90d6-dbd90185d3be", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0b337b7f-4cf6-48a6-8ace-10ef4bb66a91", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "23b6d259-76dc-4328-be97-f432d1077489", "documentation": "Creates an authentication provider", "method": "post", "endpoint": "authentication_providers", "responses": [ { "uuid": "05d15a38-1f96-49e3-b705-b2d960663aa1", "body": "{\n \"data\": {\n \"active\": true,\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"35146afd-df93-4963-b1e9-1a085e2ae874\",\n \"name\": \"Okta\",\n \"organization_id\": \"24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7\",\n \"record_type\": \"authentication_provider\",\n \"settings\": {\n \"assertion_consumer_service_url\": \"https://api.telnyx.com/sso/saml/auth/myorg\",\n \"idp_cert_fingerprint\": \"13:38:C7:BB:C9:FF:4A:70:38:3A:E3:D9:5C:CD:DB:2E:50:1E:80:A7\",\n \"idp_cert_fingerprint_algorithm\": \"{{oneOf (array 'sha1' 'sha256' 'sha384' 'sha512')}}\",\n \"idp_entity_id\": \"https://myorg.myidp.com/saml/metadata\",\n \"idp_sso_target_url\": \"https://myorg.myidp.com/trust/saml2/http-post/sso\",\n \"name_identifier_format\": \"urn:oasis:names:tc:SAML:1.1:nameid-format\",\n \"service_provider_entity_id\": \"https://api.telnyx.com/sso/saml/metadata/myorg\"\n },\n \"short_name\": \"myorg\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "b8e98d72-8f82-4a5d-aae1-c900c81bb285", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "1154f247-d6db-4063-b0be-c077c061a94c", "documentation": "Deletes an authentication provider", "method": "delete", "endpoint": "authentication_providers/:id", "responses": [ { "uuid": "b5611e37-fdc2-4560-b25a-aa22bb317a0a", "body": "{\n \"data\": {\n \"active\": true,\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"35146afd-df93-4963-b1e9-1a085e2ae874\",\n \"name\": \"Okta\",\n \"organization_id\": \"24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7\",\n \"record_type\": \"authentication_provider\",\n \"settings\": {\n \"assertion_consumer_service_url\": \"https://api.telnyx.com/sso/saml/auth/myorg\",\n \"idp_cert_fingerprint\": \"13:38:C7:BB:C9:FF:4A:70:38:3A:E3:D9:5C:CD:DB:2E:50:1E:80:A7\",\n \"idp_cert_fingerprint_algorithm\": \"{{oneOf (array 'sha1' 'sha256' 'sha384' 'sha512')}}\",\n \"idp_entity_id\": \"https://myorg.myidp.com/saml/metadata\",\n \"idp_sso_target_url\": \"https://myorg.myidp.com/trust/saml2/http-post/sso\",\n \"name_identifier_format\": \"urn:oasis:names:tc:SAML:1.1:nameid-format\",\n \"service_provider_entity_id\": \"https://api.telnyx.com/sso/saml/metadata/myorg\"\n },\n \"short_name\": \"myorg\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "82e5a6f1-ac97-4260-82df-2968f3d80a9a", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c62bdc7d-3edb-4615-98c9-ef8595db5238", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "572865f6-356d-4c03-a4bd-9ef3e7bb3e62", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "4009479d-a4ef-489f-a004-3b068a7df057", "documentation": "Retrieve an authentication provider", "method": "get", "endpoint": "authentication_providers/:id", "responses": [ { "uuid": "bf938523-f52d-4450-9efb-70221706e454", "body": "{\n \"data\": {\n \"active\": true,\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"35146afd-df93-4963-b1e9-1a085e2ae874\",\n \"name\": \"Okta\",\n \"organization_id\": \"24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7\",\n \"record_type\": \"authentication_provider\",\n \"settings\": {\n \"assertion_consumer_service_url\": \"https://api.telnyx.com/sso/saml/auth/myorg\",\n \"idp_cert_fingerprint\": \"13:38:C7:BB:C9:FF:4A:70:38:3A:E3:D9:5C:CD:DB:2E:50:1E:80:A7\",\n \"idp_cert_fingerprint_algorithm\": \"{{oneOf (array 'sha1' 'sha256' 'sha384' 'sha512')}}\",\n \"idp_entity_id\": \"https://myorg.myidp.com/saml/metadata\",\n \"idp_sso_target_url\": \"https://myorg.myidp.com/trust/saml2/http-post/sso\",\n \"name_identifier_format\": \"urn:oasis:names:tc:SAML:1.1:nameid-format\",\n \"service_provider_entity_id\": \"https://api.telnyx.com/sso/saml/metadata/myorg\"\n },\n \"short_name\": \"myorg\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ea654d52-d41f-4654-991b-a7b7b0a460a8", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "50589ba5-b831-483a-b8c1-00c05d2297b2", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "61e9a599-304d-44e1-b4b1-82109c7e8718", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "326efe4a-fa40-46cc-9ebd-6ae14af32d3d", "documentation": "Update a authentication provider", "method": "patch", "endpoint": "authentication_providers/:id", "responses": [ { "uuid": "1bd09945-1d5a-4824-8298-072bb12f93ba", "body": "{\n \"data\": {\n \"active\": true,\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"35146afd-df93-4963-b1e9-1a085e2ae874\",\n \"name\": \"Okta\",\n \"organization_id\": \"24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7\",\n \"record_type\": \"authentication_provider\",\n \"settings\": {\n \"assertion_consumer_service_url\": \"https://api.telnyx.com/sso/saml/auth/myorg\",\n \"idp_cert_fingerprint\": \"13:38:C7:BB:C9:FF:4A:70:38:3A:E3:D9:5C:CD:DB:2E:50:1E:80:A7\",\n \"idp_cert_fingerprint_algorithm\": \"{{oneOf (array 'sha1' 'sha256' 'sha384' 'sha512')}}\",\n \"idp_entity_id\": \"https://myorg.myidp.com/saml/metadata\",\n \"idp_sso_target_url\": \"https://myorg.myidp.com/trust/saml2/http-post/sso\",\n \"name_identifier_format\": \"urn:oasis:names:tc:SAML:1.1:nameid-format\",\n \"service_provider_entity_id\": \"https://api.telnyx.com/sso/saml/metadata/myorg\"\n },\n \"short_name\": \"myorg\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "5f6f65dd-794f-457e-93a5-fe0305d227d8", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "71428d7e-a46b-4513-8c2b-c7c867adbb3f", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d2586822-891c-44e6-8ece-781f3b6c6000", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "dcca13c5-ecd0-4e1d-9659-0fd33e8fccb7", "documentation": "List available phone number blocks", "method": "get", "endpoint": "available_phone_number_blocks", "responses": [ { "uuid": "bcf7c1e8-478a-4949-81d5-628de1178b1c", "body": "{\n \"data\": [\n {\n \"cost_information\": {\n \"currency\": \"USD\",\n \"monthly_cost\": \"6.54\",\n \"upfront_cost\": \"3.21\"\n },\n \"features\": [\n {\n \"name\": \"sms\"\n },\n {\n \"name\": \"voice\"\n }\n ],\n \"phone_number\": \"+19705555000\",\n \"range\": 10,\n \"record_type\": \"available_phone_number_block\",\n \"region_information\": [\n {\n \"region_name\": \"US\",\n \"region_type\": \"country_code\"\n }\n ]\n }\n ],\n \"meta\": {\n \"best_effort_results\": 50,\n \"total_results\": 100\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of available phone numbers blocks.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "7fa8007a-505d-4000-ad32-2ca5e87e55e5", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d5b40261-3b5b-47c6-aecf-fbe48e17eb7d", "documentation": "List available phone numbers", "method": "get", "endpoint": "available_phone_numbers", "responses": [ { "uuid": "731d12eb-bf5b-4806-b33d-adb1732b294c", "body": "{\n \"data\": [\n {\n \"best_effort\": false,\n \"cost_information\": {\n \"currency\": \"USD\",\n \"monthly_cost\": \"6.54\",\n \"upfront_cost\": \"3.21\"\n },\n \"features\": [\n {\n \"name\": \"sms\"\n },\n {\n \"name\": \"voice\"\n }\n ],\n \"phone_number\": \"+19705555098\",\n \"quickship\": true,\n \"record_type\": \"available_phone_number\",\n \"region_information\": [\n {\n \"region_name\": \"US\",\n \"region_type\": \"country_code\"\n }\n ],\n \"reservable\": true,\n \"vanity_format\": \"\"\n }\n ],\n \"meta\": {\n \"best_effort_results\": 50,\n \"total_results\": 100\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of available phone numbers.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "83ed09f5-5980-477f-a6a6-b7a20a640485", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5c57b6e9-b413-4809-acd7-bce8aac33597", "documentation": "Retrieve user balance details", "method": "get", "endpoint": "balance", "responses": [ { "uuid": "cd0cf400-c572-4385-bdd4-3bc06962a2bc", "body": "{\n \"data\": {\n \"available_credit\": \"400.00\",\n \"balance\": \"300.00\",\n \"credit_limit\": \"100.00\",\n \"currency\": \"USD\",\n \"record_type\": \"balance\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Retrieve user balance details", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "75a51d85-2947-4b88-948a-f1ee732d40c5", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "483ae2fd-2c80-45c9-9e8e-e61d54a8bfcb", "documentation": "List all billing groups", "method": "get", "endpoint": "billing_groups", "responses": [ { "uuid": "d79f9c51-6564-4354-8efc-1990ff5eedfa", "body": "{\n \"data\": [\n {\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"deleted_at\": null,\n \"id\": \"f5586561-8ff0-4291-a0ac-84fe544797bd\",\n \"name\": \"My billing group name\",\n \"organization_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"record_type\": \"billing_group\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "A paginated array of billing groups", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6d641425-9e1a-40f3-8dbe-c460f82198af", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "4859212e-2d2d-49f8-abcf-f1bba4f903a6", "documentation": "Create a billing group", "method": "post", "endpoint": "billing_groups", "responses": [ { "uuid": "25adbc03-8897-41f9-963a-2a0810bb4909", "body": "{\n \"data\": {\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"deleted_at\": null,\n \"id\": \"f5586561-8ff0-4291-a0ac-84fe544797bd\",\n \"name\": \"My billing group name\",\n \"organization_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"record_type\": \"billing_group\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Expected billing group response to a valid request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "1fd2f7a1-6115-41f8-a16f-dad6ffa09a8e", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "8559cf9a-9744-4da6-89a9-a0260d210d93", "documentation": "Delete a billing group", "method": "delete", "endpoint": "billing_groups/:id", "responses": [ { "uuid": "7dea2435-5b5a-4fe5-a49c-57255c0f379a", "body": "{\n \"data\": {\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"deleted_at\": null,\n \"id\": \"f5586561-8ff0-4291-a0ac-84fe544797bd\",\n \"name\": \"My billing group name\",\n \"organization_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"record_type\": \"billing_group\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Expected billing group response to a valid request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "aba6fa62-157c-4617-afeb-f3eb9d9d52d3", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "6efb94b6-412e-40c7-b190-b0251412fab4", "documentation": "Retrieve a billing group", "method": "get", "endpoint": "billing_groups/:id", "responses": [ { "uuid": "0900fa33-79b9-4b3c-8663-2413dbd35afc", "body": "{\n \"data\": {\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"deleted_at\": null,\n \"id\": \"f5586561-8ff0-4291-a0ac-84fe544797bd\",\n \"name\": \"My billing group name\",\n \"organization_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"record_type\": \"billing_group\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Expected billing group response to a valid request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "993f8ae1-0b29-4aa0-ba0e-a09cf487fa3d", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d5ad7ba9-2add-45a5-a525-53a93e3f2798", "documentation": "Update a billing group", "method": "patch", "endpoint": "billing_groups/:id", "responses": [ { "uuid": "16dbdb30-a892-45be-9c25-296ec30ee2f4", "body": "{\n \"data\": {\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"deleted_at\": null,\n \"id\": \"f5586561-8ff0-4291-a0ac-84fe544797bd\",\n \"name\": \"My billing group name\",\n \"organization_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"record_type\": \"billing_group\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Expected billing group response to a valid request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ae98d1a3-f659-46a4-a111-83674050bfb8", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5e293516-132e-4867-a7d2-b3e067023c63", "documentation": "List call control applications", "method": "get", "endpoint": "call_control_applications", "responses": [ { "uuid": "e481e20e-b73b-4c20-b0bc-678529bb13b6", "body": "{\n \"data\": [\n {\n \"active\": false,\n \"anchorsite_override\": \"\\\"Latency\\\"\",\n \"application_name\": \"call-router\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"dtmf_type\": \"Inband\",\n \"first_command_timeout\": true,\n \"first_command_timeout_secs\": 10,\n \"id\": \"1293384261075731499\",\n \"inbound\": {\n \"channel_limit\": 10,\n \"sip_subdomain\": \"example\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\"\n },\n \"outbound\": {\n \"channel_limit\": 10,\n \"outbound_voice_profile_id\": \"1293384261075731499\"\n },\n \"record_type\": \"call_control_application\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of call control applications.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c0b041da-92b4-4d56-9655-ee1384a60b64", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "47ca7515-0fc1-4c29-82d5-711a3fc28014", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "58cadf09-89f2-4944-9fdf-4628c06dab2c", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "044f00cc-8d4a-4e34-bd4b-5f552837eaa9", "documentation": "Create a call control application", "method": "post", "endpoint": "call_control_applications", "responses": [ { "uuid": "0cbb566a-7106-47c0-81c3-265565b09d65", "body": "{\n \"data\": {\n \"active\": false,\n \"anchorsite_override\": \"\\\"Latency\\\"\",\n \"application_name\": \"call-router\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"dtmf_type\": \"Inband\",\n \"first_command_timeout\": true,\n \"first_command_timeout_secs\": 10,\n \"id\": \"1293384261075731499\",\n \"inbound\": {\n \"channel_limit\": 10,\n \"sip_subdomain\": \"example\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\"\n },\n \"outbound\": {\n \"channel_limit\": 10,\n \"outbound_voice_profile_id\": \"1293384261075731499\"\n },\n \"record_type\": \"call_control_application\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n}", "latency": 0, "statusCode": 201, "label": "Successful response with details about a call control application.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "7515a8c5-3ecb-45d7-9d74-b9af0ab67cc6", "body": "", "latency": 0, "statusCode": 422, "label": "Bad Request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "927e78b1-e476-4ad2-bf76-0c8f2fb491af", "documentation": "Delete a call control application", "method": "delete", "endpoint": "call_control_applications/:id", "responses": [ { "uuid": "dbe1819d-c886-4735-82bc-155f95336c67", "body": "{\n \"data\": {\n \"active\": false,\n \"anchorsite_override\": \"\\\"Latency\\\"\",\n \"application_name\": \"call-router\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"dtmf_type\": \"Inband\",\n \"first_command_timeout\": true,\n \"first_command_timeout_secs\": 10,\n \"id\": \"1293384261075731499\",\n \"inbound\": {\n \"channel_limit\": 10,\n \"sip_subdomain\": \"example\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\"\n },\n \"outbound\": {\n \"channel_limit\": 10,\n \"outbound_voice_profile_id\": \"1293384261075731499\"\n },\n \"record_type\": \"call_control_application\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a call control application.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f8298cc9-d4f7-4cbe-b36d-79dd7661d408", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "aa694adc-efbf-4cd8-b7e2-dd510cc0e346", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ff64505a-d350-479a-824b-b3ef595908b4", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "69baad3a-3747-4dbb-a762-352b2d5deaf7", "documentation": "Retrieve a call control application", "method": "get", "endpoint": "call_control_applications/:id", "responses": [ { "uuid": "d7f2d4f2-7038-4ff8-8a81-28f2b59e63c7", "body": "{\n \"data\": {\n \"active\": false,\n \"anchorsite_override\": \"\\\"Latency\\\"\",\n \"application_name\": \"call-router\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"dtmf_type\": \"Inband\",\n \"first_command_timeout\": true,\n \"first_command_timeout_secs\": 10,\n \"id\": \"1293384261075731499\",\n \"inbound\": {\n \"channel_limit\": 10,\n \"sip_subdomain\": \"example\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\"\n },\n \"outbound\": {\n \"channel_limit\": 10,\n \"outbound_voice_profile_id\": \"1293384261075731499\"\n },\n \"record_type\": \"call_control_application\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a call control application.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a24ed189-c319-4f43-bd4a-19429c26ceef", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "46a4ccc2-34f0-4a36-8445-a487811b05e4", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "fdcb8c87-ddee-4c2f-bde3-67224e8fdb18", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "1b642ddd-5d02-43c6-b806-924a08cbd37e", "documentation": "Update a call control application", "method": "patch", "endpoint": "call_control_applications/:id", "responses": [ { "uuid": "b232f521-378e-4cc6-8df2-000047960420", "body": "{\n \"data\": {\n \"active\": false,\n \"anchorsite_override\": \"\\\"Latency\\\"\",\n \"application_name\": \"call-router\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"dtmf_type\": \"Inband\",\n \"first_command_timeout\": true,\n \"first_command_timeout_secs\": 10,\n \"id\": \"1293384261075731499\",\n \"inbound\": {\n \"channel_limit\": 10,\n \"sip_subdomain\": \"example\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\"\n },\n \"outbound\": {\n \"channel_limit\": 10,\n \"outbound_voice_profile_id\": \"1293384261075731499\"\n },\n \"record_type\": \"call_control_application\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a call control application.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a69705f3-dcc9-46aa-b065-d96bb90be12e", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "13169b6a-2c2b-454c-a416-f46f5e6813c2", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ab594053-a942-4bfd-9ebe-7e1d72cab5eb", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "893420d8-189b-4b6d-87e7-880ca430e26a", "documentation": "List call events", "method": "get", "endpoint": "call_events", "responses": [ { "uuid": "761fcefa-0ea4-4fa2-8c94-e81aa8d3c1ce", "body": "{\n \"data\": [\n {\n \"call_leg_id\": \"308fe500-5213-11e9-ace7-02420a0f0668\",\n \"call_session_id\": \"308fec30-5213-11e9-9d3f-02420a0f0668\",\n \"event_timestamp\": \"2019-03-29T11:10:19.127783Z\",\n \"metadata\": {},\n \"name\": \"call.hangup\",\n \"record_type\": \"call_event\",\n \"type\": \"webhook\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of call events.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "9aa50df3-7fe1-4a06-8f2f-d13c9329cf50", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "57bae506-357e-4609-96c1-56574c8efb27", "documentation": "Dial", "method": "post", "endpoint": "calls", "responses": [ { "uuid": "0ecda5aa-248b-4307-8b45-dbd46922f5fc", "body": "{\n \"data\": {\n \"call_control_id\": \"v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ\",\n \"call_leg_id\": \"2dc6fc34-f9e0-11ea-b68e-02420a0f7768\",\n \"call_session_id\": \"2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768\",\n \"is_alive\": false,\n \"record_type\": \"call\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a call status.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "fdab5222-4d94-42ec-860d-1739bf3537d9", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "3188a7a0-f8ce-4879-9816-e13c4713c04b", "documentation": "Retrieve a call status", "method": "get", "endpoint": "calls/:call_control_id", "responses": [ { "uuid": "a3f45f4c-e71e-4b0b-8e5f-36383e515448", "body": "{\n \"data\": {\n \"call_control_id\": \"v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ\",\n \"call_leg_id\": \"2dc6fc34-f9e0-11ea-b68e-02420a0f7768\",\n \"call_session_id\": \"2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768\",\n \"is_alive\": false,\n \"record_type\": \"call\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a call status.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "da9e7961-aa29-4fc4-a44a-cc42da64fda5", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "20233456-6a60-4693-bd69-28336c1ae2a3", "documentation": "Answer call", "method": "post", "endpoint": "calls/:call_control_id/actions/answer", "responses": [ { "uuid": "3d162f01-7ed3-473b-875a-ea8ac8c737c2", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "58d550ed-4e9d-4e8b-bdcf-840d0b1a84ea", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "16a0260b-687a-4642-b067-ef866a040550", "documentation": "Bridge calls", "method": "post", "endpoint": "calls/:call_control_id/actions/bridge", "responses": [ { "uuid": "7eb74a09-ec3a-48aa-bce4-e6b77873a31b", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "1f581322-3e72-4d84-a510-090bd5648f16", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f5300cda-a46b-4be6-8beb-73a90e782fcc", "documentation": "Enqueue call", "method": "post", "endpoint": "calls/:call_control_id/actions/enqueue", "responses": [ { "uuid": "1fe7c000-cf08-45c6-954e-e933ab1b7719", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6b745a2b-95c3-4235-b16e-6d34bbfa00ee", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2404b3d2-f982-4a82-858c-3b6eccd08c66", "documentation": "Forking start", "method": "post", "endpoint": "calls/:call_control_id/actions/fork_start", "responses": [ { "uuid": "99c530fd-dbb6-49b0-989f-49096c4adfff", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "45a8d73d-8cc0-477c-957b-1bdf39e3c01e", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5d2ef5f1-68fa-4259-b4e8-cd263614afa9", "documentation": "Forking stop", "method": "post", "endpoint": "calls/:call_control_id/actions/fork_stop", "responses": [ { "uuid": "1cc289a3-f72f-4c79-97eb-d433a344a6a6", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "93f0e1d0-3b85-4918-b9f3-32fc555c35a7", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c1955c76-9cfe-4b81-ad05-2869f2cfafd0", "documentation": "Gather stop", "method": "post", "endpoint": "calls/:call_control_id/actions/gather_stop", "responses": [ { "uuid": "a50a401d-4650-4748-b8ad-0ea26d6aefb3", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "014393a5-3442-4ae1-a134-e710a71b093b", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ed20a0e1-e4a4-44e7-b874-ce69523e4fa0", "documentation": "Gather using audio", "method": "post", "endpoint": "calls/:call_control_id/actions/gather_using_audio", "responses": [ { "uuid": "51d28bd6-7aac-4c43-aa15-d6d25e2de91b", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c1100a49-971f-432a-9fa7-1cc8b2829720", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ec7b3608-93fe-4ad3-bf4e-cc8cf54fc07f", "documentation": "Gather using speak", "method": "post", "endpoint": "calls/:call_control_id/actions/gather_using_speak", "responses": [ { "uuid": "f75d3b48-3ab5-4276-ab2e-47319eac58d4", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "68763651-fc36-414f-8886-efbd8c08a642", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "366d7f6b-8421-440c-b412-4bf63d9d04ec", "documentation": "Hangup call", "method": "post", "endpoint": "calls/:call_control_id/actions/hangup", "responses": [ { "uuid": "ef7d2f8f-39a8-4fa1-aec4-6edddf6d923b", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "329d0bce-de5c-4813-bbca-07f482fccadc", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "9b6b3c6e-cd4a-46e3-9832-f2c71b13e2ec", "documentation": "Remove call from a queue", "method": "post", "endpoint": "calls/:call_control_id/actions/leave_queue", "responses": [ { "uuid": "18ca4481-b2a2-4ca7-a61b-0459486001d6", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "42dcc23b-2ec8-4827-97ee-087334baab4e", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "16c5bdaf-ec5f-43c2-a519-5b0bc8c9e5ff", "documentation": "Play audio URL", "method": "post", "endpoint": "calls/:call_control_id/actions/playback_start", "responses": [ { "uuid": "21afdcdc-45ae-45dd-aa20-033a12efb151", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "72207066-9ac3-4c2e-8181-d863d2341c0d", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "74d811f3-a770-4cfc-9768-203492f81fe4", "documentation": "Stop audio playback", "method": "post", "endpoint": "calls/:call_control_id/actions/playback_stop", "responses": [ { "uuid": "2c9ad09b-003e-4e1c-b92b-31d5086f1d97", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "bc6aef9f-b041-4b0c-a307-4272b02d90e6", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "32b009a4-d628-4d53-8d62-b45a355dcb29", "documentation": "Record pause", "method": "post", "endpoint": "calls/:call_control_id/actions/record_pause", "responses": [ { "uuid": "5c7fc464-f403-4fa4-a26f-44a0ed68be4b", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ec133891-bbd7-4459-aded-3746d1b622ff", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "bcc63eec-600d-424c-8da7-b82da419b4b5", "documentation": "Record resume", "method": "post", "endpoint": "calls/:call_control_id/actions/record_resume", "responses": [ { "uuid": "61a82ef6-7ca8-4189-878b-fb4bdee58595", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "33921fc8-b70b-4c66-a9be-d81312aaf89c", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "54e230f8-72ce-4fe3-8035-470453719c78", "documentation": "Recording start", "method": "post", "endpoint": "calls/:call_control_id/actions/record_start", "responses": [ { "uuid": "fcc0a79a-96d7-4637-9704-7302d7ad6a2b", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c9752d0c-f737-42b6-bc11-7154152edea2", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e822af35-a4a1-484c-8c60-ff104c9dffcd", "documentation": "Recording stop", "method": "post", "endpoint": "calls/:call_control_id/actions/record_stop", "responses": [ { "uuid": "f14580ac-61db-4437-887f-5bf2031654ab", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "093126cc-2f42-4265-bb2a-f69e24d71557", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "bd52bc76-ae72-47da-bb60-8a98bac94e9e", "documentation": "SIP Refer a call", "method": "post", "endpoint": "calls/:call_control_id/actions/refer", "responses": [ { "uuid": "f180770d-3056-4055-986d-0b53eac1e29d", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ff9a4809-5fd1-47d7-9553-292a6b3ff584", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "dd0bb28d-9d0e-4666-a3fc-88c6816e5b45", "documentation": "Reject a call", "method": "post", "endpoint": "calls/:call_control_id/actions/reject", "responses": [ { "uuid": "8f0a17df-3416-40a2-8f3d-38acb78e1dfc", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c532cb0e-8f06-4d5c-ac92-da81bcacfbf9", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "06ca4a80-1c36-4a2a-a326-bc03b299610c", "documentation": "Send DTMF", "method": "post", "endpoint": "calls/:call_control_id/actions/send_dtmf", "responses": [ { "uuid": "6d7e2fbe-862d-4416-bcdd-1ba63297fed1", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c1da69ba-577d-4aee-b00f-c7318132b83d", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e1a60fe6-bf6d-436a-9182-9f3b666b1bce", "documentation": "Speak text", "method": "post", "endpoint": "calls/:call_control_id/actions/speak", "responses": [ { "uuid": "c4bfcf13-101e-479c-93f3-b4bcfdf00a03", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3a492f37-45a3-4607-a61b-7aa3bcc654f9", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "1a0e321d-4ee6-423a-bf62-d59dce0db7b7", "documentation": "Transcription start", "method": "post", "endpoint": "calls/:call_control_id/actions/transcription_start", "responses": [ { "uuid": "44acf8f3-bda4-42eb-b93b-9f7db6574506", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e07d8e4b-c4a5-4da4-b63d-54bfbb1de0be", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "512632e7-c43b-49b2-aa9a-786cfd22fa33", "documentation": "Transcription stop", "method": "post", "endpoint": "calls/:call_control_id/actions/transcription_stop", "responses": [ { "uuid": "fe7cb380-c015-4a51-9e45-b5996bb9c90c", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "fb53eda8-f208-4a22-82e2-f81257160483", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "17bebf5b-27a8-4666-a48c-e5e631db58d8", "documentation": "Transfer call", "method": "post", "endpoint": "calls/:call_control_id/actions/transfer", "responses": [ { "uuid": "3f07692d-7f9d-4ef8-a436-bdd31bb847fd", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a call control command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "07464ba3-00f8-4bb6-b171-cfaadfc2938c", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "fe53f122-4cee-4d45-bda8-b029f93057ae", "documentation": "Retrieve all comments", "method": "get", "endpoint": "comments", "responses": [ { "uuid": "cb3c9d8a-3464-4ce3-9881-5817a18b0b25", "body": "{\n \"data\": [\n {\n \"body\": \"Hi there, ....\",\n \"comment_record_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\",\n \"comment_record_type\": \"{{oneOf (array 'number_order' 'sub_number_order' 'number_order_phone_number')}}\",\n \"commenter\": \"user@company.com\",\n \"commenter_type\": \"{{oneOf (array 'admin' 'user')}}\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"read_at\": \"\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "An array of Comment Responses", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c3128563-97f8-4e7d-b2c1-73173c9887ed", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "259c6501-8c33-4de7-82fc-7372f7b7efc8", "documentation": "Create a comment", "method": "post", "endpoint": "comments", "responses": [ { "uuid": "57542820-7e5b-4685-9ba7-d0d1a798027b", "body": "{\n \"data\": {\n \"body\": \"Hi there, ....\",\n \"comment_record_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\",\n \"comment_record_type\": \"{{oneOf (array 'number_order' 'sub_number_order' 'number_order_phone_number')}}\",\n \"commenter\": \"user@company.com\",\n \"commenter_type\": \"{{oneOf (array 'admin' 'user')}}\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"read_at\": \"\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A Comment Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0f55f784-d3e7-4b90-b447-6542e3abfa23", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e0b8b68a-8c9e-40b7-9245-63a0d9979673", "documentation": "Retrieve a comment", "method": "get", "endpoint": "comments/:id", "responses": [ { "uuid": "93843c4b-315a-4045-b656-c3e8f1816ce6", "body": "{\n \"data\": {\n \"body\": \"Hi there, ....\",\n \"comment_record_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\",\n \"comment_record_type\": \"{{oneOf (array 'number_order' 'sub_number_order' 'number_order_phone_number')}}\",\n \"commenter\": \"user@company.com\",\n \"commenter_type\": \"{{oneOf (array 'admin' 'user')}}\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"read_at\": \"\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A Comment Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "186f8b19-c5a7-4e25-b8f0-05559ca6fa5b", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e6128564-ac9b-4d3d-8c83-cd61b245168e", "documentation": "Mark a comment as read", "method": "patch", "endpoint": "comments/:id/read", "responses": [ { "uuid": "004844b2-ed31-4936-bbb3-809723987d98", "body": "{\n \"data\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "A Comment Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "584cd3ba-3a65-445f-bc21-44aa2764222c", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7675bb16-669d-4535-be3a-0562bef73661", "documentation": "List conferences", "method": "get", "endpoint": "conferences", "responses": [ { "uuid": "aaa4e542-80f1-408b-b370-432b26976579", "body": "{\n \"data\": [\n {\n \"connection_id\": \"3fa85f64-9191-4567-b3fc-2c963f66afa6\",\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"end_reason\": \"all_left\",\n \"ended_by\": {\n \"call_control_id\": \"v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ==\",\n \"call_session_id\": \"428c31b6-abf3-3bc1-b7f4-5013ef9657c1\"\n },\n \"expires_at\": \"2019-01-23T18:10:02.574Z\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"All hands meeting\",\n \"record_type\": \"conference\",\n \"region\": \"sv1\",\n \"status\": \"completed\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of conferences.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d57e837a-8a0f-4c04-b9fe-e7172a4adb5e", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "52275d79-d835-4d5c-9c17-2d569c04ac5d", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "6f804f3b-9497-48ac-8649-5b952e0be95d", "documentation": "Create conference", "method": "post", "endpoint": "conferences", "responses": [ { "uuid": "a3b08e9a-2f22-42d1-8e75-d601cccf5f34", "body": "{\n \"data\": {\n \"connection_id\": \"3fa85f64-9191-4567-b3fc-2c963f66afa6\",\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"end_reason\": \"all_left\",\n \"ended_by\": {\n \"call_control_id\": \"v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ==\",\n \"call_session_id\": \"428c31b6-abf3-3bc1-b7f4-5013ef9657c1\"\n },\n \"expires_at\": \"2019-01-23T18:10:02.574Z\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"All hands meeting\",\n \"record_type\": \"conference\",\n \"region\": \"sv1\",\n \"status\": \"completed\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a conference.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "899b542e-3f50-49d5-9dd2-f0e5131425eb", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "75a759f1-3305-414a-a887-c42d2e9202f6", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "823b121a-0f2c-4c98-a89f-00c77a7befa4", "documentation": "List conference participants", "method": "get", "endpoint": "conferences/:conference_id/participants", "responses": [ { "uuid": "4aa289bf-045b-4ef6-8f31-952858566282", "body": "{\n \"data\": [\n {\n \"call_control_id\": \"v2:v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ\",\n \"call_leg_id\": \"3a15df2d-c801-4729-adf5-b56dd42e2abb\",\n \"conference\": {\n \"id\": \"41b9acd4-f4da-4ff5-a85c-e07e90b53f46\",\n \"name\": \"1\"\n },\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"end_conference_on_exit\": true,\n \"id\": \"dfadada7-af74-47bc-83a4-554275f55f5c\",\n \"muted\": false,\n \"on_hold\": true,\n \"record_type\": \"participant\",\n \"soft_end_conference_on_exit\": true,\n \"status\": \"joining\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\",\n \"whisper_call_control_ids\": [\n \"v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ\",\n \"v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw\"\n ]\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of conference participants.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "912224c7-d88c-4eff-9496-762e4b449b87", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "8aac5403-c923-49eb-bd6c-9ae2d4c48429", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2323bbcc-e7f6-483c-8fe7-ca31cbaf2c12", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f3fa661a-ac97-43ac-85c3-1a047525127a", "documentation": "Retrieve a conference", "method": "get", "endpoint": "conferences/:id", "responses": [ { "uuid": "def96b72-3ded-4b2c-b81a-ae18a2d9f7d2", "body": "{\n \"data\": {\n \"connection_id\": \"3fa85f64-9191-4567-b3fc-2c963f66afa6\",\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"end_reason\": \"all_left\",\n \"ended_by\": {\n \"call_control_id\": \"v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ==\",\n \"call_session_id\": \"428c31b6-abf3-3bc1-b7f4-5013ef9657c1\"\n },\n \"expires_at\": \"2019-01-23T18:10:02.574Z\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"All hands meeting\",\n \"record_type\": \"conference\",\n \"region\": \"sv1\",\n \"status\": \"completed\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a conference.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "da669ce4-45b3-42ff-97a8-1c0130b74a04", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "fbaecd3e-4366-4985-908a-ee25a0c24175", "documentation": "Dial a new participant into a conference", "method": "post", "endpoint": "conferences/:id/actions/dial_participant", "responses": [ { "uuid": "aac9a6e6-53be-4301-ac67-31484133dd95", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a conference command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3cb1b336-2e90-4085-a46f-2f56594d0fa3", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "fae402ac-6e60-4f89-a35a-e32869fe953a", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "96730f50-95f1-4bfa-9464-855bcc8be466", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d48bf003-88b2-4cc2-8e02-8c634ebfcae3", "documentation": "Hold conference participants", "method": "post", "endpoint": "conferences/:id/actions/hold", "responses": [ { "uuid": "53669fbc-eb17-4bd7-95c0-d9ef0da905b5", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a conference command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ff9cdaf2-03be-46d3-9920-ef469122f863", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c1d19c71-26d6-4070-9bed-41076d49a45c", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "29e51a81-b224-40b1-9682-46432cd1009f", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c9cf2396-b498-454b-a4c2-1e29f99a9893", "documentation": "Join a conference", "method": "post", "endpoint": "conferences/:id/actions/join", "responses": [ { "uuid": "e6e1609a-1994-4392-8764-453034d54633", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a conference command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a5ca609c-10de-4dd3-9fc8-e0e2878e21c8", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d4a83b03-2b4a-4fd0-ab4f-b4ace36e7d9d", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7fdc6957-011d-4c30-9bd6-c98163e3706d", "documentation": "Leave a conference", "method": "post", "endpoint": "conferences/:id/actions/leave", "responses": [ { "uuid": "4abb4e6a-3d66-4d2f-a2e7-2485d316ca26", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a conference command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "4d9b8cc5-bd51-4f0e-b618-a26e0b705d3b", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "504167d1-7d65-4aa0-9d55-7506bde0f57f", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "103c2aba-4e5b-4121-a63a-00bce4cb7352", "documentation": "Mute conference participants", "method": "post", "endpoint": "conferences/:id/actions/mute", "responses": [ { "uuid": "2d7a57e2-cf00-4352-9ffc-9e0ae0f6b62b", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a conference command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "cf986baa-358f-43ef-86ec-183f00e13d8e", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "eb3c87a6-800b-4e56-84e5-c70b323d4037", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ccf3b66a-452d-4c80-a167-cbfb1fa19857", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "97eef239-b7c7-4799-bfe3-b5aaf9cf2161", "documentation": "Play audio to conference participants", "method": "post", "endpoint": "conferences/:id/actions/play", "responses": [ { "uuid": "3b145b54-44ad-4dcf-a918-5ca035be4d9b", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a conference command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f86ba016-a24d-45f7-81ce-e14357b55795", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "087ac570-8da6-482a-9052-e372fdaa6640", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f2ee31cc-67f0-4558-844a-57bd98276e03", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d2a28f47-8d8e-496a-a30c-7a5ad723eb69", "documentation": "Conference recording start", "method": "post", "endpoint": "conferences/:id/actions/record_start", "responses": [ { "uuid": "d0213735-1384-4b40-a3b9-fdd3e1fdf61e", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a conference command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6cef56b2-877a-4bfc-a4f4-c346b2695eaa", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d9354d55-69d8-4b2b-aab5-2f9c59d80823", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6ad9f35f-e288-488b-bdbd-48550c33c0bd", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5d93d2d1-2026-469f-86b6-4c25db54967a", "documentation": "Conference recording stop", "method": "post", "endpoint": "conferences/:id/actions/record_stop", "responses": [ { "uuid": "a1b86e5e-f0b5-43e5-95d2-012a54e8f477", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a conference command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a2b11fc0-6a18-454e-9c27-f33229cd99e9", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "14c6562b-6f3c-44dc-a0d7-a90ce730e335", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "1a6912fc-d7c9-4777-a34b-5cc66679dfaf", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "81fb2426-af32-44ba-b9a2-53f0fceb19d4", "documentation": "Speak text to conference participants", "method": "post", "endpoint": "conferences/:id/actions/speak", "responses": [ { "uuid": "13a86d06-86a4-460f-9e2d-c0cf445ed6ab", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a conference command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "eedbc1e2-1b32-4d16-a55d-fe0037e68202", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f06aa03a-5de6-4c34-82a4-4c99ff6f7a2e", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "8f204793-656d-4649-a25e-c9f9e4291fcb", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "9f1b8287-28cf-4f45-ab0b-29f86940b307", "documentation": "Stop audio being played on the conference", "method": "post", "endpoint": "conferences/:id/actions/stop", "responses": [ { "uuid": "c44d09b5-6e41-411d-b045-8a7cbd541924", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a conference command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "52f8e4b2-84d9-46e0-8ae1-56fae2f85dcd", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "037a4712-e613-49e1-817b-23c51ab18c5c", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "563898cb-5f8f-41fe-bd79-2fa3cffc5560", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "34db4729-4dd8-43e0-8999-b71e888edd02", "documentation": "Unhold conference participants", "method": "post", "endpoint": "conferences/:id/actions/unhold", "responses": [ { "uuid": "f78dd1b9-ddc5-40f3-ad62-faa4d098ed57", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a conference command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "fe1c9737-e93a-43e8-8dad-6c4e832af763", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "9c18f777-8077-41bc-b243-f452938e78a2", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2db94550-cbf6-47a0-8033-103300560f67", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f70e5f7f-8d97-460d-9910-24b226ed17eb", "documentation": "Unmute conference participants", "method": "post", "endpoint": "conferences/:id/actions/unmute", "responses": [ { "uuid": "2d2a85f5-2d37-4f8a-a1f1-5336c1680a40", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a conference command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "50003c17-4677-4dfe-8897-2e59915ee794", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2d17d04a-b3fc-4f45-8551-dbf522bbb5c1", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "283769a4-da9e-4a85-882e-df61049bc165", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "bf472a8a-4a79-40bc-bc44-94d8d89f51ea", "documentation": "Update conference participant", "method": "post", "endpoint": "conferences/:id/actions/update", "responses": [ { "uuid": "eba7517b-39c6-4d62-a5ab-f94f8e4f6aa9", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response upon making a conference command.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c34b8de3-e287-4db9-be15-295ad8692505", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a3607b1b-6b8a-45c8-acc9-2d583520f726", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5b9331b7-22e2-4e10-a958-1b71b4f758ca", "documentation": "List connections", "method": "get", "endpoint": "connections", "responses": [ { "uuid": "ee53e893-28bb-4361-9552-a6927a766378", "body": "{\n \"data\": [\n {\n \"active\": true,\n \"anchorsite_override\": \"Latency\",\n \"connection_name\": \"string\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"outbound_voice_profile_id\": \"1293384261075731499\",\n \"record_type\": \"ip_connection\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of connections.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3fdafe1e-6772-4a7d-90ef-0e7e2e0ab5f3", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "4eae27ed-2401-4ce4-bcf3-0df8b414576d", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ddca6099-7a23-49ef-9d23-3282e8ea65b8", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "27e5e686-a638-4019-b875-c6c575872323", "documentation": "Retrieve a connection", "method": "get", "endpoint": "connections/:id", "responses": [ { "uuid": "a4b0a186-20be-47dc-8108-b22014e4010a", "body": "{\n \"data\": {\n \"active\": true,\n \"anchorsite_override\": \"Latency\",\n \"connection_name\": \"string\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"outbound_voice_profile_id\": \"1293384261075731499\",\n \"record_type\": \"ip_connection\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a connection.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "81709c18-bcfb-4e22-bf68-bbe5adbf60df", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2418b88b-5c54-44fc-a54e-9beedf8af750", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "56955d82-78a2-4a77-b971-61e35ad1861c", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7beb57c3-b762-42e5-82f9-c1b0d2d173dc", "documentation": "List credential connections", "method": "get", "endpoint": "credential_connections", "responses": [ { "uuid": "69a33f67-c7e9-4b95-9b19-eabf79c2c278", "body": "{\n \"data\": [\n {\n \"active\": true,\n \"anchorsite_override\": \"Latency\",\n \"connection_name\": \"string\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"default_on_hold_comfort_noise_enabled\": true,\n \"dtmf_type\": \"RFC 2833\",\n \"encode_contact_header_enabled\": true,\n \"encrypted_media\": \"SRTP\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"inbound\": {\n \"ani_number_format\": \"+E.164\",\n \"channel_limit\": 10,\n \"codecs\": [\n \"G722\"\n ],\n \"dnis_number_format\": \"+e164\",\n \"generate_ringback_tone\": true,\n \"isup_headers_enabled\": true,\n \"prack_enabled\": true,\n \"privacy_zone_enabled\": true,\n \"sip_compact_headers_enabled\": true,\n \"timeout_1xx_secs\": 10,\n \"timeout_2xx_secs\": \"15\"\n },\n \"onnet_t38_passthrough_enabled\": true,\n \"outbound\": {\n \"ani_override\": \"string\",\n \"ani_override_type\": \"always\",\n \"call_parking_enabled\": true,\n \"channel_limit\": 10,\n \"generate_ringback_tone\": true,\n \"instant_ringback_enabled\": true,\n \"localization\": \"string\",\n \"outbound_voice_profile_id\": \"1293384261075731499\",\n \"t38_reinvite_source\": \"telnyx\"\n },\n \"password\": \"my123secure456password789\",\n \"record_type\": \"credential_connection\",\n \"rtcp_settings\": {\n \"capture_enabled\": true,\n \"port\": \"rtp+1\",\n \"report_frequency_seconds\": 10\n },\n \"sip_uri_calling_preference\": \"disabled\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"user_name\": \"myusername123\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of credential connections.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "72dfbb23-0630-4521-9478-0919d8d1929f", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2d6de515-1dbf-415c-a1b4-aa630a6cc073", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "7c6de2e6-44b4-4b6b-b18b-758b79cac9cc", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f43a7c27-6127-4262-bad3-9bdcf9848ff2", "documentation": "Create a credential connection", "method": "post", "endpoint": "credential_connections", "responses": [ { "uuid": "0e6eeec7-831a-4ee2-a7cd-7efab8e34f4f", "body": "{\n \"data\": {\n \"active\": true,\n \"anchorsite_override\": \"Latency\",\n \"connection_name\": \"string\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"default_on_hold_comfort_noise_enabled\": true,\n \"dtmf_type\": \"RFC 2833\",\n \"encode_contact_header_enabled\": true,\n \"encrypted_media\": \"SRTP\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"inbound\": {\n \"ani_number_format\": \"+E.164\",\n \"channel_limit\": 10,\n \"codecs\": [\n \"G722\"\n ],\n \"dnis_number_format\": \"+e164\",\n \"generate_ringback_tone\": true,\n \"isup_headers_enabled\": true,\n \"prack_enabled\": true,\n \"privacy_zone_enabled\": true,\n \"sip_compact_headers_enabled\": true,\n \"timeout_1xx_secs\": 10,\n \"timeout_2xx_secs\": \"15\"\n },\n \"onnet_t38_passthrough_enabled\": true,\n \"outbound\": {\n \"ani_override\": \"string\",\n \"ani_override_type\": \"always\",\n \"call_parking_enabled\": true,\n \"channel_limit\": 10,\n \"generate_ringback_tone\": true,\n \"instant_ringback_enabled\": true,\n \"localization\": \"string\",\n \"outbound_voice_profile_id\": \"1293384261075731499\",\n \"t38_reinvite_source\": \"telnyx\"\n },\n \"password\": \"my123secure456password789\",\n \"record_type\": \"credential_connection\",\n \"rtcp_settings\": {\n \"capture_enabled\": true,\n \"port\": \"rtp+1\",\n \"report_frequency_seconds\": 10\n },\n \"sip_uri_calling_preference\": \"disabled\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"user_name\": \"myusername123\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n}", "latency": 0, "statusCode": 201, "label": "Successful response with details about a credential connection.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "48010c6a-96cb-4e94-af22-f15f2ab572e8", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "9d531776-128a-4b02-aaee-8ba5d73b536c", "documentation": "Delete a credential connection", "method": "delete", "endpoint": "credential_connections/:id", "responses": [ { "uuid": "c3a2370d-b16a-4b24-a483-c43d99975d6d", "body": "{\n \"data\": {\n \"active\": true,\n \"anchorsite_override\": \"Latency\",\n \"connection_name\": \"string\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"default_on_hold_comfort_noise_enabled\": true,\n \"dtmf_type\": \"RFC 2833\",\n \"encode_contact_header_enabled\": true,\n \"encrypted_media\": \"SRTP\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"inbound\": {\n \"ani_number_format\": \"+E.164\",\n \"channel_limit\": 10,\n \"codecs\": [\n \"G722\"\n ],\n \"dnis_number_format\": \"+e164\",\n \"generate_ringback_tone\": true,\n \"isup_headers_enabled\": true,\n \"prack_enabled\": true,\n \"privacy_zone_enabled\": true,\n \"sip_compact_headers_enabled\": true,\n \"timeout_1xx_secs\": 10,\n \"timeout_2xx_secs\": \"15\"\n },\n \"onnet_t38_passthrough_enabled\": true,\n \"outbound\": {\n \"ani_override\": \"string\",\n \"ani_override_type\": \"always\",\n \"call_parking_enabled\": true,\n \"channel_limit\": 10,\n \"generate_ringback_tone\": true,\n \"instant_ringback_enabled\": true,\n \"localization\": \"string\",\n \"outbound_voice_profile_id\": \"1293384261075731499\",\n \"t38_reinvite_source\": \"telnyx\"\n },\n \"password\": \"my123secure456password789\",\n \"record_type\": \"credential_connection\",\n \"rtcp_settings\": {\n \"capture_enabled\": true,\n \"port\": \"rtp+1\",\n \"report_frequency_seconds\": 10\n },\n \"sip_uri_calling_preference\": \"disabled\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"user_name\": \"myusername123\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a credential connection.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c19eb580-100d-4cc1-94f0-513f7f3e2c85", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "bf9191b2-c36b-4173-a905-9d39828e5f6c", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3cf5c730-4a15-46ba-a7da-3ac56b106126", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "3f3f4b7d-13de-4d9f-b886-263d0810c862", "documentation": "Retrieve a credential connection", "method": "get", "endpoint": "credential_connections/:id", "responses": [ { "uuid": "c42c448d-0825-4776-a63f-bb7ed5088d4e", "body": "{\n \"data\": {\n \"active\": true,\n \"anchorsite_override\": \"Latency\",\n \"connection_name\": \"string\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"default_on_hold_comfort_noise_enabled\": true,\n \"dtmf_type\": \"RFC 2833\",\n \"encode_contact_header_enabled\": true,\n \"encrypted_media\": \"SRTP\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"inbound\": {\n \"ani_number_format\": \"+E.164\",\n \"channel_limit\": 10,\n \"codecs\": [\n \"G722\"\n ],\n \"dnis_number_format\": \"+e164\",\n \"generate_ringback_tone\": true,\n \"isup_headers_enabled\": true,\n \"prack_enabled\": true,\n \"privacy_zone_enabled\": true,\n \"sip_compact_headers_enabled\": true,\n \"timeout_1xx_secs\": 10,\n \"timeout_2xx_secs\": \"15\"\n },\n \"onnet_t38_passthrough_enabled\": true,\n \"outbound\": {\n \"ani_override\": \"string\",\n \"ani_override_type\": \"always\",\n \"call_parking_enabled\": true,\n \"channel_limit\": 10,\n \"generate_ringback_tone\": true,\n \"instant_ringback_enabled\": true,\n \"localization\": \"string\",\n \"outbound_voice_profile_id\": \"1293384261075731499\",\n \"t38_reinvite_source\": \"telnyx\"\n },\n \"password\": \"my123secure456password789\",\n \"record_type\": \"credential_connection\",\n \"rtcp_settings\": {\n \"capture_enabled\": true,\n \"port\": \"rtp+1\",\n \"report_frequency_seconds\": 10\n },\n \"sip_uri_calling_preference\": \"disabled\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"user_name\": \"myusername123\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a credential connection.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6f5b6a91-2d98-4057-9f68-a267b6dc2333", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d9e83279-6b59-4918-9b75-62f7e880d25f", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "5450de7c-be65-4258-89b4-a862e0ee9e4c", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "fbc8a4c0-a164-4aef-afe1-f4d0681416a8", "documentation": "Update a credential connection", "method": "patch", "endpoint": "credential_connections/:id", "responses": [ { "uuid": "bc7ba333-0465-44d5-a5b9-f4a2b7677381", "body": "{\n \"data\": {\n \"active\": true,\n \"anchorsite_override\": \"Latency\",\n \"connection_name\": \"string\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"default_on_hold_comfort_noise_enabled\": true,\n \"dtmf_type\": \"RFC 2833\",\n \"encode_contact_header_enabled\": true,\n \"encrypted_media\": \"SRTP\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"inbound\": {\n \"ani_number_format\": \"+E.164\",\n \"channel_limit\": 10,\n \"codecs\": [\n \"G722\"\n ],\n \"dnis_number_format\": \"+e164\",\n \"generate_ringback_tone\": true,\n \"isup_headers_enabled\": true,\n \"prack_enabled\": true,\n \"privacy_zone_enabled\": true,\n \"sip_compact_headers_enabled\": true,\n \"timeout_1xx_secs\": 10,\n \"timeout_2xx_secs\": \"15\"\n },\n \"onnet_t38_passthrough_enabled\": true,\n \"outbound\": {\n \"ani_override\": \"string\",\n \"ani_override_type\": \"always\",\n \"call_parking_enabled\": true,\n \"channel_limit\": 10,\n \"generate_ringback_tone\": true,\n \"instant_ringback_enabled\": true,\n \"localization\": \"string\",\n \"outbound_voice_profile_id\": \"1293384261075731499\",\n \"t38_reinvite_source\": \"telnyx\"\n },\n \"password\": \"my123secure456password789\",\n \"record_type\": \"credential_connection\",\n \"rtcp_settings\": {\n \"capture_enabled\": true,\n \"port\": \"rtp+1\",\n \"report_frequency_seconds\": 10\n },\n \"sip_uri_calling_preference\": \"disabled\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"user_name\": \"myusername123\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a credential connection.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6e93f758-9429-448d-8562-4bf8354ec6aa", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e4ea919a-fb20-4341-b761-d2f27c677d80", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6d9e4b7f-29b4-4237-9ce2-077f85b21a3f", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "12903053-abf6-45db-ab77-9ff18de00b62", "documentation": "Search detail records", "method": "get", "endpoint": "detail_records", "responses": [ { "uuid": "7b4979b3-0f9a-4b5d-93b3-aeadb4838400", "body": "{\n \"data\": [\n {\n \"carrier\": \"T-Mobile USA\",\n \"carrier_fee\": \"0.003\",\n \"cld\": \"+1555123456\",\n \"cli\": \"+1555123456\",\n \"completed_at\": \"2020-07-01T00:00:00Z\",\n \"cost\": \"0.003\",\n \"country_code\": \"US\",\n \"created_at\": \"2020-07-01T00:00:00Z\",\n \"currency\": \"USD\",\n \"delivery_status\": \"success: webhook succeeded\",\n \"delivery_status_failover_url\": \"https://api.example.com/sms/telnyx/inbound\",\n \"delivery_status_webhook_url\": \"https://api.example.com/sms/telnyx/inbound\",\n \"direction\": \"{{oneOf (array 'inbound' 'outbound')}}\",\n \"errors\": [\n \"40001\"\n ],\n \"fteu\": {{faker 'random.boolean'}},\n \"mcc\": \"204\",\n \"message_type\": \"{{oneOf (array 'SMS' 'MMS' 'RCS')}}\",\n \"mnc\": \"01\",\n \"on_net\": true,\n \"parts\": 2,\n \"profile_id\": \"30ef55db-c4a2-4c4a-9804-a68077973d07\",\n \"profile_name\": \"My Messaging Profile\",\n \"rate\": \"0.003\",\n \"record_type\": \"message_detail_record\",\n \"sent_at\": \"2020-07-01T00:00:00Z\",\n \"source_country_code\": \"US\",\n \"status\": \"{{oneOf (array 'gw_timeout' 'delivered' 'dlr_unconfirmed' 'dlr_timeout' 'received' 'gw_reject' 'failed')}}\",\n \"tags\": \"tag1,tag2,tag3\",\n \"updated_at\": \"2020-07-01T00:00:00Z\",\n \"user_id\": \"3ca7bd3d-7d82-4e07-9df4-009123068320\",\n \"uuid\": \"3ca7bd3d-7d82-4e07-9df4-009123068320\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7baecbdf-0990-4c04-9fc9-7337981bb314", "documentation": "List all document links", "method": "get", "endpoint": "document_links", "responses": [ { "uuid": "5fd1bcab-b49e-4e46-b4a5-1705763fadb4", "body": "{\n \"data\": [\n {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"sample_record_type\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "98ea0422-00c4-47e3-9069-99ea61676045", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "29701dda-1545-441f-804b-f48d365a88b8", "documentation": "List all documents", "method": "get", "endpoint": "documents", "responses": [ { "uuid": "a37a7aca-6445-45fe-9c7a-c6245b0b01ac", "body": "{\n \"data\": [\n {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"sample_record_type\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f1f73048-a6e2-461e-b6fe-0ee3d2084797", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "308e3f85-b4e0-4b3c-b238-41164956ae62", "documentation": "Upload a document", "method": "post", "endpoint": "documents", "responses": [ { "uuid": "7b2ee201-1f37-4d8c-8363-ea24cd1a3a69", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"sample_record_type\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "75d3f5a9-b38c-4807-a10f-14c0c65d074f", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check the 'detail' field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f1cf5224-f628-4fce-bf98-ff9201c6785a", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a95093cd-e3e4-4ca5-9989-96ca729d281c", "documentation": "Delete a document", "method": "delete", "endpoint": "documents/:id", "responses": [ { "uuid": "6dd21348-1543-4e59-9646-adce610a5ee9", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"sample_record_type\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d4e3aab6-6fcf-49dd-bae9-5d30523e4948", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5cc81de4-bc5f-4425-b828-990d3accdc19", "documentation": "Retrieve a document", "method": "get", "endpoint": "documents/:id", "responses": [ { "uuid": "1570dafb-e9f0-4bc8-85d2-fcaa420df2a2", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"sample_record_type\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "92e5313b-9a35-4a15-b32d-3f7bc7a7b26f", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e16a913f-8943-4102-9c22-dac54bf9a710", "documentation": "Update a document", "method": "patch", "endpoint": "documents/:id", "responses": [ { "uuid": "d815ba6e-5a3d-4185-864d-f6bdd72b98f2", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"sample_record_type\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6dba35ac-bbbb-498f-a64f-88593c927762", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2c370ea2-f142-497c-b9c4-0364a033350b", "documentation": "Download a document", "method": "get", "endpoint": "documents/:id/download", "responses": [ { "uuid": "31f28fdf-8c00-43e3-8e60-d313013dff94", "body": "", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "*" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "448f169a-ef7a-4ae5-989b-debc501128b6", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7c04bd96-49ae-4afc-84eb-251323216bee", "documentation": "List all Fax Applications", "method": "get", "endpoint": "fax_applications", "responses": [ { "uuid": "5256c2c6-4118-4ca9-88c5-5690c9452da0", "body": "{\n \"data\": [\n {\n \"active\": false,\n \"anchorsite_override\": \"Amsterdam, Netherlands\",\n \"application_name\": \"fax-router\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"1293384261075731499\",\n \"inbound\": {\n \"channel_limit\": 10,\n \"sip_subdomain\": \"example\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\"\n },\n \"outbound\": {\n \"channel_limit\": 10,\n \"outbound_voice_profile_id\": \"1293384261075731499\"\n },\n \"record_type\": \"fax_application\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "03e46cb1-3050-4564-a0f0-0eed8fb6c34c", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "aada3b41-5ce1-4c26-a405-22a336477e5c", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "61b39d54-8dd4-4f4d-9f23-ad3cf546b584", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "918f57ef-90d3-406d-9c35-25740e887b93", "documentation": "Creates a Fax Application", "method": "post", "endpoint": "fax_applications", "responses": [ { "uuid": "f1e4ec64-7987-4de6-aa3c-d1e8e24b6e31", "body": "{\n \"data\": {\n \"active\": false,\n \"anchorsite_override\": \"Amsterdam, Netherlands\",\n \"application_name\": \"fax-router\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"1293384261075731499\",\n \"inbound\": {\n \"channel_limit\": 10,\n \"sip_subdomain\": \"example\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\"\n },\n \"outbound\": {\n \"channel_limit\": 10,\n \"outbound_voice_profile_id\": \"1293384261075731499\"\n },\n \"record_type\": \"fax_application\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n}", "latency": 0, "statusCode": 201, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "886272c7-611a-4e63-b03b-73d385b89f8c", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2b9f5588-5b8a-4269-b1ae-8f4f6c312a5a", "documentation": "Deletes a Fax Application", "method": "delete", "endpoint": "fax_applications/:id", "responses": [ { "uuid": "2d5855e5-aa1e-473a-aa3c-e9e8fea79f68", "body": "{\n \"data\": {\n \"active\": false,\n \"anchorsite_override\": \"Amsterdam, Netherlands\",\n \"application_name\": \"fax-router\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"1293384261075731499\",\n \"inbound\": {\n \"channel_limit\": 10,\n \"sip_subdomain\": \"example\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\"\n },\n \"outbound\": {\n \"channel_limit\": 10,\n \"outbound_voice_profile_id\": \"1293384261075731499\"\n },\n \"record_type\": \"fax_application\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "b9fe2d11-11b8-48e1-abba-ddd5ed207ab6", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "85cd22d3-ddf5-488d-afef-2bcabfc22474", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6b9c032a-5237-4e14-a76e-30d3527e9a16", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "24fd8be2-5016-43c8-9c46-a0ebf917bf92", "documentation": "Retrieve a Fax Application", "method": "get", "endpoint": "fax_applications/:id", "responses": [ { "uuid": "66700104-62fd-4775-b237-e964511b516a", "body": "{\n \"data\": {\n \"active\": false,\n \"anchorsite_override\": \"Amsterdam, Netherlands\",\n \"application_name\": \"fax-router\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"1293384261075731499\",\n \"inbound\": {\n \"channel_limit\": 10,\n \"sip_subdomain\": \"example\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\"\n },\n \"outbound\": {\n \"channel_limit\": 10,\n \"outbound_voice_profile_id\": \"1293384261075731499\"\n },\n \"record_type\": \"fax_application\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2c598087-697f-4bdc-bb66-2cfd396d1e56", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "81bc6052-3cc1-4404-a716-014b30ce4222", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "fe89485b-5556-4061-8543-8fbd82b4e2cc", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "56f34678-6141-469b-bfa0-1a56d808aa89", "documentation": "Update a Fax Application", "method": "patch", "endpoint": "fax_applications/:id", "responses": [ { "uuid": "3524a448-80d5-4b28-b5a4-74bea3e0a992", "body": "{\n \"data\": {\n \"active\": false,\n \"anchorsite_override\": \"Amsterdam, Netherlands\",\n \"application_name\": \"fax-router\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"1293384261075731499\",\n \"inbound\": {\n \"channel_limit\": 10,\n \"sip_subdomain\": \"example\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\"\n },\n \"outbound\": {\n \"channel_limit\": 10,\n \"outbound_voice_profile_id\": \"1293384261075731499\"\n },\n \"record_type\": \"fax_application\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "5dad023a-65fc-4952-8cc5-ce4e304784ef", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e6e33f61-87be-401a-a843-93ba3a38e466", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "732e3395-d443-4444-93ca-1c9ce4fc3273", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c2e538ea-3206-4a5e-8849-d3565a367b1d", "documentation": "View a list of faxes", "method": "get", "endpoint": "faxes", "responses": [ { "uuid": "35b29f77-3ed3-4370-b605-257fb0af769d", "body": "{\n \"data\": [\n {\n \"connection_id\": \"c-1\",\n \"created_at\": \"2020-05-05T09:59:12\",\n \"direction\": \"outbound\",\n \"from\": \"+123\",\n \"id\": \"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0\",\n \"media_url\": \"http://www.example.com/fax.pdf\",\n \"quality\": \"high\",\n \"record_type\": \"fax\",\n \"status\": \"queued\",\n \"store_media\": true,\n \"stored_media_url\": \"https://s3.amazonaws.com/faxes-dev/user-1/cf4a6b52-bf8e-4945-9f49-611d0d2b083b.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=xxxxxxxxxx%2F20200505%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20200505T095917Z&X-Amz-Expires=7200&X-Amz-SignedHeaders=host&X-Amz-Signature=fac2af40464fcc77673ad762db86e34f9c1b91a82699b5578c5327f53874df51\",\n \"to\": \"+456\",\n \"updated_at\": \"2020-05-05T09:59:12\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"http://www.example.com/webhooks\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 1,\n \"total_pages\": 3,\n \"total_results\": 3\n }\n}", "latency": 0, "statusCode": 200, "label": "List faxes response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "37c5352f-1671-49b5-9eb6-287931076a11", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "547942b5-020e-426c-b95d-1a078f0f6fe7", "documentation": "Send a fax", "method": "post", "endpoint": "faxes", "responses": [ { "uuid": "169c896e-0e7b-444a-adb5-cc360a9635bf", "body": "{\n \"data\": {\n \"connection_id\": \"c-1\",\n \"created_at\": \"2020-05-05T09:59:12\",\n \"direction\": \"outbound\",\n \"from\": \"+123\",\n \"id\": \"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0\",\n \"media_url\": \"http://www.example.com/fax.pdf\",\n \"quality\": \"high\",\n \"record_type\": \"fax\",\n \"status\": \"queued\",\n \"store_media\": true,\n \"stored_media_url\": \"https://s3.amazonaws.com/faxes-dev/user-1/cf4a6b52-bf8e-4945-9f49-611d0d2b083b.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=xxxxxxxxxx%2F20200505%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20200505T095917Z&X-Amz-Expires=7200&X-Amz-SignedHeaders=host&X-Amz-Signature=fac2af40464fcc77673ad762db86e34f9c1b91a82699b5578c5327f53874df51\",\n \"to\": \"+456\",\n \"updated_at\": \"2020-05-05T09:59:12\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"http://www.example.com/webhooks\"\n }\n}", "latency": 0, "statusCode": 202, "label": "Send fax response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "15eaf854-5346-480f-8450-4a420b4671f9", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c5318388-5919-4264-b104-b29cebb7b008", "documentation": "Delete a fax", "method": "delete", "endpoint": "faxes/:id", "responses": [ { "uuid": "de61cc3d-e92e-4d33-870e-48123289d6bb", "body": "", "latency": 0, "statusCode": 204, "label": "The resource was deleted successfully.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "63db3e39-5628-4221-9124-09b094b3d4dc", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d1f8fb87-535a-4a5c-8fe5-c41282bf7498", "documentation": "View a fax", "method": "get", "endpoint": "faxes/:id", "responses": [ { "uuid": "788746b3-2c97-4bbf-b053-6ac84f004b91", "body": "{\n \"data\": {\n \"connection_id\": \"c-1\",\n \"created_at\": \"2020-05-05T09:59:12\",\n \"direction\": \"outbound\",\n \"from\": \"+123\",\n \"id\": \"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0\",\n \"media_url\": \"http://www.example.com/fax.pdf\",\n \"quality\": \"high\",\n \"record_type\": \"fax\",\n \"status\": \"queued\",\n \"store_media\": true,\n \"stored_media_url\": \"https://s3.amazonaws.com/faxes-dev/user-1/cf4a6b52-bf8e-4945-9f49-611d0d2b083b.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=xxxxxxxxxx%2F20200505%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20200505T095917Z&X-Amz-Expires=7200&X-Amz-SignedHeaders=host&X-Amz-Signature=fac2af40464fcc77673ad762db86e34f9c1b91a82699b5578c5327f53874df51\",\n \"to\": \"+456\",\n \"updated_at\": \"2020-05-05T09:59:12\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"http://www.example.com/webhooks\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Get fax response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "15342a69-0f7a-4cc9-98f3-ec1e13dfcba5", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d847936a-0098-41a2-a506-a92f205390d2", "documentation": "Refresh a fax", "method": "post", "endpoint": "faxes/:id/actions/refresh", "responses": [ { "uuid": "9134703d-7d5c-4fa4-b2a9-04cf04397c98", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Refresh fax response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6a357436-6fcf-4273-a700-f632300441b5", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "5a86dcfa-2872-466f-9aec-6a9acab2331f", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f396b577-dc64-409d-8be6-bf4e4be41264", "documentation": "List FQDN connections", "method": "get", "endpoint": "fqdn_connections", "responses": [ { "uuid": "4586efc6-7f21-41e2-ae63-da317fe44723", "body": "{\n \"data\": [\n {\n \"active\": true,\n \"anchorsite_override\": \"Latency\",\n \"connection_name\": \"string\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"default_on_hold_comfort_noise_enabled\": true,\n \"dtmf_type\": \"RFC 2833\",\n \"encode_contact_header_enabled\": true,\n \"encrypted_media\": \"SRTP\",\n \"id\": \"1293384261075731499\",\n \"inbound\": {\n \"ani_number_format\": \"+E.164\",\n \"channel_limit\": 10,\n \"codecs\": [\n \"G722\"\n ],\n \"default_routing_method\": \"sequential\",\n \"dnis_number_format\": \"+e164\",\n \"generate_ringback_tone\": true,\n \"isup_headers_enabled\": true,\n \"prack_enabled\": true,\n \"privacy_zone_enabled\": true,\n \"sip_compact_headers_enabled\": true,\n \"sip_region\": \"US\",\n \"sip_subdomain\": \"string\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\",\n \"timeout_1xx_secs\": 10,\n \"timeout_2xx_secs\": 10\n },\n \"onnet_t38_passthrough_enabled\": true,\n \"record_type\": \"fqdn_connection\",\n \"rtcp_settings\": {\n \"capture_enabled\": true,\n \"port\": \"rtcp-mux\",\n \"report_frequency_secs\": 10\n },\n \"transport_protocol\": \"UDP\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of FQDN connections.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2a19c1ea-71d3-488d-8da8-5e21f289e415", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d3043065-c229-4b39-a3ae-9582422c1242", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "736296c1-5af0-4814-a3a9-1858f6d76fc5", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5c314ece-bb7a-4deb-a440-a117ef660367", "documentation": "Create an FQDN connection", "method": "post", "endpoint": "fqdn_connections", "responses": [ { "uuid": "164c1375-ce28-4696-9284-7965dfc970bd", "body": "{\n \"data\": {\n \"active\": true,\n \"anchorsite_override\": \"Latency\",\n \"connection_name\": \"string\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"default_on_hold_comfort_noise_enabled\": true,\n \"dtmf_type\": \"RFC 2833\",\n \"encode_contact_header_enabled\": true,\n \"encrypted_media\": \"SRTP\",\n \"id\": \"1293384261075731499\",\n \"inbound\": {\n \"ani_number_format\": \"+E.164\",\n \"channel_limit\": 10,\n \"codecs\": [\n \"G722\"\n ],\n \"default_routing_method\": \"sequential\",\n \"dnis_number_format\": \"+e164\",\n \"generate_ringback_tone\": true,\n \"isup_headers_enabled\": true,\n \"prack_enabled\": true,\n \"privacy_zone_enabled\": true,\n \"sip_compact_headers_enabled\": true,\n \"sip_region\": \"US\",\n \"sip_subdomain\": \"string\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\",\n \"timeout_1xx_secs\": 10,\n \"timeout_2xx_secs\": 10\n },\n \"onnet_t38_passthrough_enabled\": true,\n \"record_type\": \"fqdn_connection\",\n \"rtcp_settings\": {\n \"capture_enabled\": true,\n \"port\": \"rtcp-mux\",\n \"report_frequency_secs\": 10\n },\n \"transport_protocol\": \"UDP\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n}", "latency": 0, "statusCode": 201, "label": "Successful response with details about an FQDN connection.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6d0a23a4-7c91-4fa9-8b44-f3d16d358fa8", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d435f0c2-7d31-4be6-bbe8-bb7665e8df3b", "documentation": "Delete an FQDN connection", "method": "delete", "endpoint": "fqdn_connections/:id", "responses": [ { "uuid": "d2d00a9e-811e-4e84-aebb-f3da05e49aae", "body": "{\n \"data\": {\n \"active\": true,\n \"anchorsite_override\": \"Latency\",\n \"connection_name\": \"string\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"default_on_hold_comfort_noise_enabled\": true,\n \"dtmf_type\": \"RFC 2833\",\n \"encode_contact_header_enabled\": true,\n \"encrypted_media\": \"SRTP\",\n \"id\": \"1293384261075731499\",\n \"inbound\": {\n \"ani_number_format\": \"+E.164\",\n \"channel_limit\": 10,\n \"codecs\": [\n \"G722\"\n ],\n \"default_routing_method\": \"sequential\",\n \"dnis_number_format\": \"+e164\",\n \"generate_ringback_tone\": true,\n \"isup_headers_enabled\": true,\n \"prack_enabled\": true,\n \"privacy_zone_enabled\": true,\n \"sip_compact_headers_enabled\": true,\n \"sip_region\": \"US\",\n \"sip_subdomain\": \"string\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\",\n \"timeout_1xx_secs\": 10,\n \"timeout_2xx_secs\": 10\n },\n \"onnet_t38_passthrough_enabled\": true,\n \"record_type\": \"fqdn_connection\",\n \"rtcp_settings\": {\n \"capture_enabled\": true,\n \"port\": \"rtcp-mux\",\n \"report_frequency_secs\": 10\n },\n \"transport_protocol\": \"UDP\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about an FQDN connection.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "b44ffe67-8ff5-4e26-865b-4aec02638aca", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ed357e2a-5b48-46f0-a0ae-84da848d7257", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0f2bbaec-3b7a-4f13-8d99-852cc433dbc9", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "25ea402d-eec5-4126-8ca3-6d44ee52ccb0", "documentation": "Retrieve an FQDN connection", "method": "get", "endpoint": "fqdn_connections/:id", "responses": [ { "uuid": "5cbb1797-ff57-429f-be91-0a05265aee85", "body": "{\n \"data\": {\n \"active\": true,\n \"anchorsite_override\": \"Latency\",\n \"connection_name\": \"string\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"default_on_hold_comfort_noise_enabled\": true,\n \"dtmf_type\": \"RFC 2833\",\n \"encode_contact_header_enabled\": true,\n \"encrypted_media\": \"SRTP\",\n \"id\": \"1293384261075731499\",\n \"inbound\": {\n \"ani_number_format\": \"+E.164\",\n \"channel_limit\": 10,\n \"codecs\": [\n \"G722\"\n ],\n \"default_routing_method\": \"sequential\",\n \"dnis_number_format\": \"+e164\",\n \"generate_ringback_tone\": true,\n \"isup_headers_enabled\": true,\n \"prack_enabled\": true,\n \"privacy_zone_enabled\": true,\n \"sip_compact_headers_enabled\": true,\n \"sip_region\": \"US\",\n \"sip_subdomain\": \"string\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\",\n \"timeout_1xx_secs\": 10,\n \"timeout_2xx_secs\": 10\n },\n \"onnet_t38_passthrough_enabled\": true,\n \"record_type\": \"fqdn_connection\",\n \"rtcp_settings\": {\n \"capture_enabled\": true,\n \"port\": \"rtcp-mux\",\n \"report_frequency_secs\": 10\n },\n \"transport_protocol\": \"UDP\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about an FQDN connection.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e8887974-eb54-4555-95bc-7c7c8288fc60", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3dd9730d-461e-4a26-aa1a-85611890d8d8", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3e00ea98-f0b5-489c-ba26-79d37e485e8e", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f55125a1-e239-4c1e-b00e-e85bf7c88198", "documentation": "Update an FQDN connection", "method": "patch", "endpoint": "fqdn_connections/:id", "responses": [ { "uuid": "2e5ae61b-1850-43c8-8871-58b59768d905", "body": "{\n \"data\": {\n \"active\": true,\n \"anchorsite_override\": \"Latency\",\n \"connection_name\": \"string\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"default_on_hold_comfort_noise_enabled\": true,\n \"dtmf_type\": \"RFC 2833\",\n \"encode_contact_header_enabled\": true,\n \"encrypted_media\": \"SRTP\",\n \"id\": \"1293384261075731499\",\n \"inbound\": {\n \"ani_number_format\": \"+E.164\",\n \"channel_limit\": 10,\n \"codecs\": [\n \"G722\"\n ],\n \"default_routing_method\": \"sequential\",\n \"dnis_number_format\": \"+e164\",\n \"generate_ringback_tone\": true,\n \"isup_headers_enabled\": true,\n \"prack_enabled\": true,\n \"privacy_zone_enabled\": true,\n \"sip_compact_headers_enabled\": true,\n \"sip_region\": \"US\",\n \"sip_subdomain\": \"string\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\",\n \"timeout_1xx_secs\": 10,\n \"timeout_2xx_secs\": 10\n },\n \"onnet_t38_passthrough_enabled\": true,\n \"record_type\": \"fqdn_connection\",\n \"rtcp_settings\": {\n \"capture_enabled\": true,\n \"port\": \"rtcp-mux\",\n \"report_frequency_secs\": 10\n },\n \"transport_protocol\": \"UDP\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about an FQDN connection.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "85a01930-fd9d-4817-a9e2-8af28019c6c3", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "7ea22b69-993d-4147-a6c5-7ee371132ec4", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "cdbe514f-6d9a-48f4-8fd0-10bae3b18775", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7329fc3f-97e2-4ea2-940a-f18be6cedc80", "documentation": "List FQDNs", "method": "get", "endpoint": "fqdns", "responses": [ { "uuid": "d4a6938b-0f51-467b-935d-abe2b91904c6", "body": "{\n \"data\": [\n {\n \"connection_id\": \"1516447646313612565\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"dns_record_type\": \"a\",\n \"fqdn\": \"example.com\",\n \"id\": \"1293384261075731499\",\n \"port\": 5060,\n \"record_type\": \"fqdn\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of FQDN connections.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6b67309a-6e5d-46ea-bfcd-792408202bec", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d46be40b-eba9-46cb-b55d-ee409868fe8f", "body": "", "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": "135e2d5a-ab66-4203-944f-03f8bd5557d4", "documentation": "Create an FQDN", "method": "post", "endpoint": "fqdns", "responses": [ { "uuid": "e80d990f-7119-456f-85dc-c1521bbce045", "body": "{\n \"data\": {\n \"connection_id\": \"1516447646313612565\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"dns_record_type\": \"a\",\n \"fqdn\": \"example.com\",\n \"id\": \"1293384261075731499\",\n \"port\": 5060,\n \"record_type\": \"fqdn\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 201, "label": "Successful response with details about an FQDN connection.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "4aabba1d-34d9-443c-8117-7e9c730cbbd4", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "24f0210b-f521-4e64-b131-e45644e6f187", "body": "", "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": "72b5a27f-15ea-4e4f-a6a6-5844a1723258", "documentation": "Delete an FQDN", "method": "delete", "endpoint": "fqdns/:id", "responses": [ { "uuid": "97691332-b83b-49db-b7e0-94b681c2bbe5", "body": "{\n \"data\": {\n \"connection_id\": \"1516447646313612565\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"dns_record_type\": \"a\",\n \"fqdn\": \"example.com\",\n \"id\": \"1293384261075731499\",\n \"port\": 5060,\n \"record_type\": \"fqdn\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about an FQDN connection.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f68b6e76-79f8-4d14-8543-b387efe60f13", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "93a625aa-c0f2-4fa1-8baa-6f17b9e0abba", "body": "", "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": "cd9ade61-6d26-4ef6-b16d-2e06fd3073b1", "documentation": "Retrieve an FQDN", "method": "get", "endpoint": "fqdns/:id", "responses": [ { "uuid": "d15f5be1-f4d0-4d71-bce1-36b7d7a2633f", "body": "{\n \"data\": {\n \"connection_id\": \"1516447646313612565\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"dns_record_type\": \"a\",\n \"fqdn\": \"example.com\",\n \"id\": \"1293384261075731499\",\n \"port\": 5060,\n \"record_type\": \"fqdn\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about an FQDN connection.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "5a2e0ee5-f433-42c6-9494-7a3d3df9af0c", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "51ed0559-745a-4b73-8aff-09f188295164", "body": "", "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": "c54a00b6-6c1d-49e4-bece-d556775d470e", "documentation": "Update an FQDN", "method": "patch", "endpoint": "fqdns/:id", "responses": [ { "uuid": "918238af-c96e-47d9-8592-53be57be1d70", "body": "{\n \"data\": {\n \"connection_id\": \"1516447646313612565\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"dns_record_type\": \"a\",\n \"fqdn\": \"example.com\",\n \"id\": \"1293384261075731499\",\n \"port\": 5060,\n \"record_type\": \"fqdn\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about an FQDN connection.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "cd24d18f-d995-48c4-a0ff-5d2c9f74e195", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "87e44fdc-0d77-4d11-a2bf-08b6e7602fec", "body": "", "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": "332347b8-7cb2-4225-b563-4207c60a4b93", "documentation": "Create an inventory coverage request", "method": "get", "endpoint": "inventory_coverage", "responses": [ { "uuid": "cbbaeebc-634e-4208-a081-7f5befa017e5", "body": "{\n \"data\": [\n {\n \"count\": 3,\n \"coverage_type\": \"number\",\n \"group\": \"318\",\n \"group_type\": \"npa\",\n \"number_range\": 1,\n \"number_type\": \"did\",\n \"phone_number_type\": \"local\",\n \"record_type\": \"inventory_coverage_group\"\n }\n ],\n \"meta\": {\n \"total_results\": 25\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of inventory coverage levels", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0cf82f5f-71d5-41ab-8a6d-0d2949bd0767", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "3bd72d72-0e8a-48ce-86d6-e739ef0834ba", "documentation": "List Ip connections", "method": "get", "endpoint": "ip_connections", "responses": [ { "uuid": "44f5c766-bd91-4182-b2fd-a8ebb54d145a", "body": "{\n \"data\": [\n {\n \"active\": true,\n \"anchorsite_override\": \"Latency\",\n \"connection_name\": \"string\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"default_on_hold_comfort_noise_enabled\": true,\n \"dtmf_type\": \"RFC 2833\",\n \"encode_contact_header_enabled\": true,\n \"encrypted_media\": \"SRTP\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"inbound\": {\n \"ani_number_format\": \"+E.164\",\n \"channel_limit\": 10,\n \"codecs\": [\n \"G722\"\n ],\n \"default_primary_ip_id\": \"192.0.2.1\",\n \"default_routing_method\": \"sequential\",\n \"default_secondary_ip_id\": \"198.51.100.1\",\n \"default_tertiary_ip_id\": \"203.0.113.1\",\n \"dnis_number_format\": \"+e164\",\n \"generate_ringback_tone\": true,\n \"isup_headers_enabled\": true,\n \"prack_enabled\": true,\n \"privacy_zone_enabled\": true,\n \"sip_compact_headers_enabled\": true,\n \"sip_region\": \"US\",\n \"sip_subdomain\": \"string\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\",\n \"timeout_1xx_secs\": 10,\n \"timeout_2xx_secs\": 10\n },\n \"onnet_t38_passthrough_enabled\": true,\n \"outbound\": {\n \"ani_override\": \"string\",\n \"ani_override_type\": \"always\",\n \"call_parking_enabled\": true,\n \"channel_limit\": 10,\n \"generate_ringback_tone\": true,\n \"instant_ringback_enabled\": true,\n \"ip_authentication_method\": \"token\",\n \"ip_authentication_token\": \"string\",\n \"localization\": \"string\",\n \"outbound_voice_profile_id\": \"1293384261075731499\",\n \"t38_reinvite_source\": \"telnyx\",\n \"tech_prefix\": \"string\"\n },\n \"record_type\": \"ip_connection\",\n \"rtcp_settings\": {\n \"capture_enabled\": true,\n \"port\": \"rtcp-mux\",\n \"report_frequency_secs\": 10\n },\n \"transport_protocol\": \"UDP\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of IP connections.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3debc468-9958-4e3e-b81c-422fef8e4d15", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d7daf4bf-32bc-41c9-a3df-3963e7ddb4ea", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "acee2db6-352e-4ba8-9a43-8126fbff53a9", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "fd6e1b69-3d00-40b0-8e55-0a712c6d39a4", "documentation": "Create an Ip connection", "method": "post", "endpoint": "ip_connections", "responses": [ { "uuid": "546f90ca-f0b1-4f0c-9980-dc00b13b1cbd", "body": "{\n \"data\": {\n \"active\": true,\n \"anchorsite_override\": \"Latency\",\n \"connection_name\": \"string\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"default_on_hold_comfort_noise_enabled\": true,\n \"dtmf_type\": \"RFC 2833\",\n \"encode_contact_header_enabled\": true,\n \"encrypted_media\": \"SRTP\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"inbound\": {\n \"ani_number_format\": \"+E.164\",\n \"channel_limit\": 10,\n \"codecs\": [\n \"G722\"\n ],\n \"default_primary_ip_id\": \"192.0.2.1\",\n \"default_routing_method\": \"sequential\",\n \"default_secondary_ip_id\": \"198.51.100.1\",\n \"default_tertiary_ip_id\": \"203.0.113.1\",\n \"dnis_number_format\": \"+e164\",\n \"generate_ringback_tone\": true,\n \"isup_headers_enabled\": true,\n \"prack_enabled\": true,\n \"privacy_zone_enabled\": true,\n \"sip_compact_headers_enabled\": true,\n \"sip_region\": \"US\",\n \"sip_subdomain\": \"string\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\",\n \"timeout_1xx_secs\": 10,\n \"timeout_2xx_secs\": 10\n },\n \"onnet_t38_passthrough_enabled\": true,\n \"outbound\": {\n \"ani_override\": \"string\",\n \"ani_override_type\": \"always\",\n \"call_parking_enabled\": true,\n \"channel_limit\": 10,\n \"generate_ringback_tone\": true,\n \"instant_ringback_enabled\": true,\n \"ip_authentication_method\": \"token\",\n \"ip_authentication_token\": \"string\",\n \"localization\": \"string\",\n \"outbound_voice_profile_id\": \"1293384261075731499\",\n \"t38_reinvite_source\": \"telnyx\",\n \"tech_prefix\": \"string\"\n },\n \"record_type\": \"ip_connection\",\n \"rtcp_settings\": {\n \"capture_enabled\": true,\n \"port\": \"rtcp-mux\",\n \"report_frequency_secs\": 10\n },\n \"transport_protocol\": \"UDP\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n}", "latency": 0, "statusCode": 201, "label": "Successful response with details about an IP connection.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "abf0a705-7886-488f-8558-8686ff4b7303", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b8382aba-8237-48da-8327-e55944266f5b", "documentation": "Delete an Ip connection", "method": "delete", "endpoint": "ip_connections/:id", "responses": [ { "uuid": "5416ee4a-bc05-4e10-ab3e-d05eddb9c2a3", "body": "{\n \"data\": {\n \"active\": true,\n \"anchorsite_override\": \"Latency\",\n \"connection_name\": \"string\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"default_on_hold_comfort_noise_enabled\": true,\n \"dtmf_type\": \"RFC 2833\",\n \"encode_contact_header_enabled\": true,\n \"encrypted_media\": \"SRTP\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"inbound\": {\n \"ani_number_format\": \"+E.164\",\n \"channel_limit\": 10,\n \"codecs\": [\n \"G722\"\n ],\n \"default_primary_ip_id\": \"192.0.2.1\",\n \"default_routing_method\": \"sequential\",\n \"default_secondary_ip_id\": \"198.51.100.1\",\n \"default_tertiary_ip_id\": \"203.0.113.1\",\n \"dnis_number_format\": \"+e164\",\n \"generate_ringback_tone\": true,\n \"isup_headers_enabled\": true,\n \"prack_enabled\": true,\n \"privacy_zone_enabled\": true,\n \"sip_compact_headers_enabled\": true,\n \"sip_region\": \"US\",\n \"sip_subdomain\": \"string\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\",\n \"timeout_1xx_secs\": 10,\n \"timeout_2xx_secs\": 10\n },\n \"onnet_t38_passthrough_enabled\": true,\n \"outbound\": {\n \"ani_override\": \"string\",\n \"ani_override_type\": \"always\",\n \"call_parking_enabled\": true,\n \"channel_limit\": 10,\n \"generate_ringback_tone\": true,\n \"instant_ringback_enabled\": true,\n \"ip_authentication_method\": \"token\",\n \"ip_authentication_token\": \"string\",\n \"localization\": \"string\",\n \"outbound_voice_profile_id\": \"1293384261075731499\",\n \"t38_reinvite_source\": \"telnyx\",\n \"tech_prefix\": \"string\"\n },\n \"record_type\": \"ip_connection\",\n \"rtcp_settings\": {\n \"capture_enabled\": true,\n \"port\": \"rtcp-mux\",\n \"report_frequency_secs\": 10\n },\n \"transport_protocol\": \"UDP\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about an IP connection.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0ed216b4-35cc-4f6a-adea-1b5c4c75a34b", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c730c989-1952-4462-8f6d-46895afb77cc", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ead1ffde-8c84-4225-a7ba-7cce35efe10b", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "17c1eaa1-e2d5-40c9-9fe5-ae01a5d455b9", "documentation": "Retrieve an Ip connection", "method": "get", "endpoint": "ip_connections/:id", "responses": [ { "uuid": "50565087-a39b-4153-a7ef-f5fcfe91ee0d", "body": "{\n \"data\": {\n \"active\": true,\n \"anchorsite_override\": \"Latency\",\n \"connection_name\": \"string\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"default_on_hold_comfort_noise_enabled\": true,\n \"dtmf_type\": \"RFC 2833\",\n \"encode_contact_header_enabled\": true,\n \"encrypted_media\": \"SRTP\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"inbound\": {\n \"ani_number_format\": \"+E.164\",\n \"channel_limit\": 10,\n \"codecs\": [\n \"G722\"\n ],\n \"default_primary_ip_id\": \"192.0.2.1\",\n \"default_routing_method\": \"sequential\",\n \"default_secondary_ip_id\": \"198.51.100.1\",\n \"default_tertiary_ip_id\": \"203.0.113.1\",\n \"dnis_number_format\": \"+e164\",\n \"generate_ringback_tone\": true,\n \"isup_headers_enabled\": true,\n \"prack_enabled\": true,\n \"privacy_zone_enabled\": true,\n \"sip_compact_headers_enabled\": true,\n \"sip_region\": \"US\",\n \"sip_subdomain\": \"string\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\",\n \"timeout_1xx_secs\": 10,\n \"timeout_2xx_secs\": 10\n },\n \"onnet_t38_passthrough_enabled\": true,\n \"outbound\": {\n \"ani_override\": \"string\",\n \"ani_override_type\": \"always\",\n \"call_parking_enabled\": true,\n \"channel_limit\": 10,\n \"generate_ringback_tone\": true,\n \"instant_ringback_enabled\": true,\n \"ip_authentication_method\": \"token\",\n \"ip_authentication_token\": \"string\",\n \"localization\": \"string\",\n \"outbound_voice_profile_id\": \"1293384261075731499\",\n \"t38_reinvite_source\": \"telnyx\",\n \"tech_prefix\": \"string\"\n },\n \"record_type\": \"ip_connection\",\n \"rtcp_settings\": {\n \"capture_enabled\": true,\n \"port\": \"rtcp-mux\",\n \"report_frequency_secs\": 10\n },\n \"transport_protocol\": \"UDP\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about an IP connection.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "221f0a09-fcaf-40dd-ba7b-f03e19f299f3", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "4041da78-3f59-4a0b-83e1-9ef0ea698ee0", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d9d66743-6efa-4a3b-b0d7-76a03ffb17b0", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "18c01f36-531a-4714-910f-586d88aaf72e", "documentation": "Update an Ip connection", "method": "patch", "endpoint": "ip_connections/:id", "responses": [ { "uuid": "33011eb6-8f8d-4ca7-8fba-5bc2e0e62545", "body": "{\n \"data\": {\n \"active\": true,\n \"anchorsite_override\": \"Latency\",\n \"connection_name\": \"string\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"default_on_hold_comfort_noise_enabled\": true,\n \"dtmf_type\": \"RFC 2833\",\n \"encode_contact_header_enabled\": true,\n \"encrypted_media\": \"SRTP\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"inbound\": {\n \"ani_number_format\": \"+E.164\",\n \"channel_limit\": 10,\n \"codecs\": [\n \"G722\"\n ],\n \"default_primary_ip_id\": \"192.0.2.1\",\n \"default_routing_method\": \"sequential\",\n \"default_secondary_ip_id\": \"198.51.100.1\",\n \"default_tertiary_ip_id\": \"203.0.113.1\",\n \"dnis_number_format\": \"+e164\",\n \"generate_ringback_tone\": true,\n \"isup_headers_enabled\": true,\n \"prack_enabled\": true,\n \"privacy_zone_enabled\": true,\n \"sip_compact_headers_enabled\": true,\n \"sip_region\": \"US\",\n \"sip_subdomain\": \"string\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\",\n \"timeout_1xx_secs\": 10,\n \"timeout_2xx_secs\": 10\n },\n \"onnet_t38_passthrough_enabled\": true,\n \"outbound\": {\n \"ani_override\": \"string\",\n \"ani_override_type\": \"always\",\n \"call_parking_enabled\": true,\n \"channel_limit\": 10,\n \"generate_ringback_tone\": true,\n \"instant_ringback_enabled\": true,\n \"ip_authentication_method\": \"token\",\n \"ip_authentication_token\": \"string\",\n \"localization\": \"string\",\n \"outbound_voice_profile_id\": \"1293384261075731499\",\n \"t38_reinvite_source\": \"telnyx\",\n \"tech_prefix\": \"string\"\n },\n \"record_type\": \"ip_connection\",\n \"rtcp_settings\": {\n \"capture_enabled\": true,\n \"port\": \"rtcp-mux\",\n \"report_frequency_secs\": 10\n },\n \"transport_protocol\": \"UDP\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"webhook_api_version\": \"1\",\n \"webhook_event_failover_url\": \"https://failover.example.com\",\n \"webhook_event_url\": \"https://example.com\",\n \"webhook_timeout_secs\": 25\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about an IP connection.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f44c8e7e-a82f-427a-91e7-be4bc65a5f17", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6b1497e4-f5a3-4052-9094-5b9135417e8a", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "26c44615-a0ab-46c3-b2de-ed068a90a7fe", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "23f8df4a-a97c-45c8-944f-978b3eb35188", "documentation": "List Ips", "method": "get", "endpoint": "ips", "responses": [ { "uuid": "ac46839a-8ab9-45c1-8c78-cb78a742d351", "body": "{\n \"data\": [\n {\n \"connection_id\": \"3456789987654\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"ip_address\": \"192.168.0.0\",\n \"port\": 5060,\n \"record_type\": \"ip\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of IPs.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "986a00ad-1446-4820-8eef-71d8e5386be0", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "73e363f4-f0bc-48fb-afa0-22e3c2c8cbff", "body": "", "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": "0a79e932-75f3-4b7b-a9ae-3ac5974414f6", "documentation": "Create an Ip", "method": "post", "endpoint": "ips", "responses": [ { "uuid": "2479da02-a126-4354-b0ea-9c9107789b7a", "body": "{\n \"data\": {\n \"connection_id\": \"3456789987654\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"ip_address\": \"192.168.0.0\",\n \"port\": 5060,\n \"record_type\": \"ip\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 201, "label": "Successful response with details about an IP.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f5201e03-2921-4fab-b41b-4a9285beb9cf", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "52bf8bf1-6311-4470-a65b-74b44f35662a", "body": "", "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": "15cc8474-4460-4224-aca7-1bb1a0035b5e", "documentation": "Delete an Ip", "method": "delete", "endpoint": "ips/:id", "responses": [ { "uuid": "a270b4e7-280c-4dff-ab27-ab7237df7655", "body": "{\n \"data\": {\n \"connection_id\": \"3456789987654\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"ip_address\": \"192.168.0.0\",\n \"port\": 5060,\n \"record_type\": \"ip\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about an IP.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "1c3d2717-1300-46cc-aa17-f5bd53fc8d2d", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "49472049-7605-49a3-9c7f-9d193f70ca15", "body": "", "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": "8df70f9b-84aa-4687-b81a-94aca346e105", "documentation": "Retrieve an Ip", "method": "get", "endpoint": "ips/:id", "responses": [ { "uuid": "bab258b0-8b41-4149-b799-6fffde4d961a", "body": "{\n \"data\": {\n \"connection_id\": \"3456789987654\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"ip_address\": \"192.168.0.0\",\n \"port\": 5060,\n \"record_type\": \"ip\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about an IP.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "73812365-2752-446e-8264-13c4779080a5", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "61fe6cd1-07de-4c60-a739-7b45506d6690", "body": "", "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": "f559142e-1984-4329-903f-efa7f7f2024b", "documentation": "Update an Ip", "method": "patch", "endpoint": "ips/:id", "responses": [ { "uuid": "9e0c7ceb-6f05-48b2-b2d2-20a3bc633568", "body": "{\n \"data\": {\n \"connection_id\": \"3456789987654\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"ip_address\": \"192.168.0.0\",\n \"port\": 5060,\n \"record_type\": \"ip\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about an IP.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "cd982748-eea8-421c-9785-b3af6e06f156", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ba5df8d3-046d-4812-ad31-32596bd48b91", "body": "", "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": "b45bfdc3-d4c3-4130-89f8-e7407b405987", "documentation": "Create a ledger billing group report", "method": "post", "endpoint": "ledger_billing_group_reports", "responses": [ { "uuid": "e34724bc-c477-4dd6-beec-fb4d40c4069a", "body": "{\n \"data\": {\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"id\": \"f5586561-8ff0-4291-a0ac-84fe544797bd\",\n \"organization_id\": \"f5586561-8ff0-4291-a0ac-84fe544797bd\",\n \"record_type\": \"ledger_billing_group_report\",\n \"report_url\": \"https://example.com\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Expected ledger billing group report response to a valid request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "bf64ea73-bef2-4b48-b390-57d3127b147a", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "73ff139c-611f-4a7d-976a-7b450bc8cc0c", "documentation": "Retrieve a ledger billing group report", "method": "get", "endpoint": "ledger_billing_group_reports/:id", "responses": [ { "uuid": "5f5d238b-6fb0-4aea-b72d-5efa8b734d38", "body": "{\n \"data\": {\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"id\": \"f5586561-8ff0-4291-a0ac-84fe544797bd\",\n \"organization_id\": \"f5586561-8ff0-4291-a0ac-84fe544797bd\",\n \"record_type\": \"ledger_billing_group_report\",\n \"report_url\": \"https://example.com\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Expected ledger billing group report response to a valid request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "11ecb011-2810-4674-9100-dfafa47b4fed", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5700eae2-9d11-4c4c-8b45-25e90375df4c", "documentation": "Lists accounts managed by the current user.", "method": "get", "endpoint": "managed_accounts", "responses": [ { "uuid": "c093931b-d7cb-480a-a232-2921ffe0d6ab", "body": "{\n \"data\": [\n {\n \"api_key\": \"KEY0174227C1D16D1B180A8FF742AD37F70_1bA4vlJKHpZcJGaSXaadFu\",\n \"api_token\": \"x6oexQNHTs-fZ7-QsDMOeg\",\n \"api_user\": \"managed_account@example.com\",\n \"balance\": {\n \"available_credit\": \"400.00\",\n \"balance\": \"300.00\",\n \"credit_limit\": \"100.00\",\n \"currency\": \"USD\",\n \"record_type\": \"balance\"\n },\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"email\": \"user@example.com\",\n \"id\": \"f65ceda4-6522-4ad6-aede-98de83385123\",\n \"manager_account_id\": \"f65ceda4-6522-4ad6-aede-98de83385123\",\n \"organization_name\": \"Example Company LLC\",\n \"record_type\": \"{{oneOf (array 'managed_account')}}\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of managed accounts.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "07c6bd2e-3ded-4b1d-b8ae-47e33463d477", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "8899d5e2-5c77-44d2-9014-45b49f22ce68", "documentation": "Create a new managed account.", "method": "post", "endpoint": "managed_accounts", "responses": [ { "uuid": "8853d9db-e644-4e74-83bc-7029b4a2c8eb", "body": "{\n \"data\": {\n \"api_key\": \"KEY0174227C1D16D1B180A8FF742AD37F70_1bA4vlJKHpZcJGaSXaadFu\",\n \"api_token\": \"x6oexQNHTs-fZ7-QsDMOeg\",\n \"api_user\": \"managed_account@example.com\",\n \"balance\": {\n \"available_credit\": \"400.00\",\n \"balance\": \"300.00\",\n \"credit_limit\": \"100.00\",\n \"currency\": \"USD\",\n \"record_type\": \"balance\"\n },\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"email\": \"user@example.com\",\n \"id\": \"f65ceda4-6522-4ad6-aede-98de83385123\",\n \"manager_account_id\": \"f65ceda4-6522-4ad6-aede-98de83385123\",\n \"organization_name\": \"Example Company LLC\",\n \"record_type\": \"{{oneOf (array 'managed_account')}}\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with information about a single managed account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a75bc0c3-d5e3-4e43-a316-ec2e9d6aac5c", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "b8031f87-fc3c-4e18-92e8-bd0ef0473ed7", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check the 'detail' field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5747cf6b-a49b-478c-9c3f-ed0a7d382583", "documentation": "Retrieve a managed account", "method": "get", "endpoint": "managed_accounts/:id", "responses": [ { "uuid": "508f709a-1e25-4ab4-94a9-fd93c6638014", "body": "{\n \"data\": {\n \"api_key\": \"KEY0174227C1D16D1B180A8FF742AD37F70_1bA4vlJKHpZcJGaSXaadFu\",\n \"api_token\": \"x6oexQNHTs-fZ7-QsDMOeg\",\n \"api_user\": \"managed_account@example.com\",\n \"balance\": {\n \"available_credit\": \"400.00\",\n \"balance\": \"300.00\",\n \"credit_limit\": \"100.00\",\n \"currency\": \"USD\",\n \"record_type\": \"balance\"\n },\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"email\": \"user@example.com\",\n \"id\": \"f65ceda4-6522-4ad6-aede-98de83385123\",\n \"manager_account_id\": \"f65ceda4-6522-4ad6-aede-98de83385123\",\n \"organization_name\": \"Example Company LLC\",\n \"record_type\": \"{{oneOf (array 'managed_account')}}\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with information about a single managed account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "09bf39c0-941c-4308-90ef-e6a70d2f32bf", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "08b4c011-5471-40c3-8639-3369972872d9", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f07b8103-d668-4c58-a50a-f44b5dd879e8", "documentation": "Disables a managed account", "method": "post", "endpoint": "managed_accounts/:id/actions/disable", "responses": [ { "uuid": "d095148f-fef3-4dfd-adc9-0c79727fac6f", "body": "{\n \"data\": {\n \"api_key\": \"KEY0174227C1D16D1B180A8FF742AD37F70_1bA4vlJKHpZcJGaSXaadFu\",\n \"api_token\": \"x6oexQNHTs-fZ7-QsDMOeg\",\n \"api_user\": \"managed_account@example.com\",\n \"balance\": {\n \"available_credit\": \"400.00\",\n \"balance\": \"300.00\",\n \"credit_limit\": \"100.00\",\n \"currency\": \"USD\",\n \"record_type\": \"balance\"\n },\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"email\": \"user@example.com\",\n \"id\": \"f65ceda4-6522-4ad6-aede-98de83385123\",\n \"manager_account_id\": \"f65ceda4-6522-4ad6-aede-98de83385123\",\n \"organization_name\": \"Example Company LLC\",\n \"record_type\": \"{{oneOf (array 'managed_account')}}\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with information about a single managed account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "21b00e5a-832e-4b71-88fc-3b17ce4fff49", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "84455238-6d12-4c44-8cfb-a9010ec98ec5", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "8d90eb85-a684-40d6-ac06-8e11fcb91847", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check the 'detail' field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f1284cb2-a58c-4747-977c-061e68891759", "documentation": "Enables a managed account", "method": "post", "endpoint": "managed_accounts/:id/actions/enable", "responses": [ { "uuid": "564ebe8e-ee10-4ad8-87b6-b329f95ebfc8", "body": "{\n \"data\": {\n \"api_key\": \"KEY0174227C1D16D1B180A8FF742AD37F70_1bA4vlJKHpZcJGaSXaadFu\",\n \"api_token\": \"x6oexQNHTs-fZ7-QsDMOeg\",\n \"api_user\": \"managed_account@example.com\",\n \"balance\": {\n \"available_credit\": \"400.00\",\n \"balance\": \"300.00\",\n \"credit_limit\": \"100.00\",\n \"currency\": \"USD\",\n \"record_type\": \"balance\"\n },\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"email\": \"user@example.com\",\n \"id\": \"f65ceda4-6522-4ad6-aede-98de83385123\",\n \"manager_account_id\": \"f65ceda4-6522-4ad6-aede-98de83385123\",\n \"organization_name\": \"Example Company LLC\",\n \"record_type\": \"{{oneOf (array 'managed_account')}}\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with information about a single managed account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "dab4efe3-e6e4-40a4-baea-e983251b7518", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "9a46bf16-21cd-41f2-87ce-55375ea1e322", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "95a4bf97-a6a0-473d-8e48-ecf6586d0fa5", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check the 'detail' field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "9056be4f-e150-46b5-9661-6d582843fdc2", "documentation": "List uploaded media", "method": "get", "endpoint": "media", "responses": [ { "uuid": "fa1b4193-34f8-4163-b2ab-861789d13a3a", "body": "{\n \"data\": [\n {\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"expires_at\": \"2020-01-23T18:10:02.574Z\",\n \"media_name\": \"f5586561-8ff0-4291-a0ac-84fe544797bd\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "A response with a list of media resources", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "73cf45ea-0df6-4ee7-bca2-e26d26c07f19", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0ef8ebbe-c57a-41f7-a4af-8c2017f5cab4", "documentation": "Upload media", "method": "post", "endpoint": "media", "responses": [ { "uuid": "a48a843a-b14b-4236-a491-9b42691b5221", "body": "{\n \"data\": {\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"expires_at\": \"2020-01-23T18:10:02.574Z\",\n \"media_name\": \"f5586561-8ff0-4291-a0ac-84fe544797bd\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\"\n }\n}", "latency": 0, "statusCode": 201, "label": "A response describing a media resource", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "80a0a48a-09b1-4084-9489-b5539117b52e", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0267c591-e467-49e6-b5d9-e5c2eac50f85", "documentation": "Deletes stored media", "method": "delete", "endpoint": "media/:media_name", "responses": [ { "uuid": "9acec79f-3ad4-4c81-871c-7bbccd6d13b6", "body": "", "latency": 0, "statusCode": 204, "label": "The media was deleted successfully.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e10b615b-9e24-4bb3-a6a6-7ed643b58db2", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e4c6d93d-7699-45f0-96ea-99dad5c9774f", "documentation": "Retrieve stored media", "method": "get", "endpoint": "media/:media_name", "responses": [ { "uuid": "9bfb37fa-3a44-48f7-9786-3edd125695ea", "body": "{\n \"data\": {\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"expires_at\": \"2020-01-23T18:10:02.574Z\",\n \"media_name\": \"f5586561-8ff0-4291-a0ac-84fe544797bd\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A response describing a media resource", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "043e5071-750a-4f66-abe3-e76f9288d8ef", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b22208ae-e1f6-43b0-9325-362018452fe5", "documentation": "Update stored media", "method": "put", "endpoint": "media/:media_name", "responses": [ { "uuid": "7562cf61-9ed1-4abf-b3e0-a05addf625c8", "body": "{\n \"data\": {\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"expires_at\": \"2020-01-23T18:10:02.574Z\",\n \"media_name\": \"f5586561-8ff0-4291-a0ac-84fe544797bd\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A response describing a media resource", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "46335b38-e3f8-4454-b1bf-3eb160a63a95", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f9acdfa6-dc6d-4ccc-9c79-e797ff825366", "documentation": "Download stored media", "method": "get", "endpoint": "media/:media_name/download", "responses": [ { "uuid": "a48195d8-9f62-4599-b685-6d1c733c5243", "body": "", "latency": 0, "statusCode": 200, "label": "A response describing a media resource", "headers": [ { "key": "Content-Type", "value": "*/*" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "71b00033-0aaf-44fa-9984-70deb242c09e", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2ab8d2f3-4d0c-44a8-bbc7-0f77b1e9e0e8", "documentation": "Fetch messaging detail records.", "method": "get", "endpoint": "message_detail_records", "responses": [ { "uuid": "6795b4d7-a2b4-4f63-9cbf-b582e8834f43", "body": "{\n \"data\": [\n {\n \"cld\": \"+1555123456\",\n \"cli\": \"+1555123456\",\n \"cost\": \"0.1\",\n \"created_at\": \"2020-07-01T00:00:00-06:00\",\n \"currency\": \"{{oneOf (array 'AUD' 'CAD' 'EUR' 'GBP' 'USD')}}\",\n \"direction\": \"outbound\",\n \"id\": \"99b637f3-07fd-45ac-b9ca-b87208c24650\",\n \"message_type\": \"{{oneOf (array 'SMS' 'MMS')}}\",\n \"parts\": 2,\n \"profile_name\": \"configured-profile-name\",\n \"rate\": \"0.05\",\n \"record_type\": \"mdr_report\",\n \"status\": \"{{oneOf (array 'GW_TIMEOUT' 'DELIVERED' 'DLR_UNCONFIRMED' 'DLR_TIMEOUT' 'RECEIVED' 'GW_REJECT' 'FAILED')}}\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0dd559f4-b5ad-4cb7-b485-cd8b37bb8a65", "documentation": "Fetch message body by id.", "method": "get", "endpoint": "message_detail_records/:id/message_body", "responses": [ { "uuid": "7c16f8a7-1938-4d23-8cdd-02081b394e1d", "body": "{\n \"data\": {\n \"message_body\": \"This is message text\",\n \"record_type\": \"message_body\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "375d8920-4c49-430f-a5b5-b6f59513247e", "documentation": "Send a message", "method": "post", "endpoint": "messages", "responses": [ { "uuid": "ae09158f-f646-4373-85a7-350aa40ed7b0", "body": "{\n \"data\": {\n \"completed_at\": null,\n \"cost\": null,\n \"direction\": \"outbound\",\n \"encoding\": \"GSM-7\",\n \"errors\": [],\n \"from\": {\n \"carrier\": \"TELNYX LLC\",\n \"line_type\": \"VoIP\",\n \"phone_number\": \"+18445550001\"\n },\n \"id\": \"40385f64-5717-4562-b3fc-2c963f66afa6\",\n \"media\": [\n {\n \"content_type\": null,\n \"sha256\": null,\n \"size\": null,\n \"url\": \"https://pbs.twimg.com/profile_images/1142168442042118144/AW3F4fFD_400x400.png\"\n }\n ],\n \"messaging_profile_id\": \"4000eba1-a0c0-4563-9925-b25e842a7cb6\",\n \"organization_id\": \"b448f9cc-a842-4784-98e9-03c1a5872950\",\n \"parts\": 1,\n \"received_at\": \"2019-01-23T18:10:02.574Z\",\n \"record_type\": \"message\",\n \"sent_at\": null,\n \"subject\": \"From Telnyx!\",\n \"tags\": [\n \"Greetings\"\n ],\n \"text\": \"Hello, World!\",\n \"to\": [\n {\n \"carrier\": \"T-MOBILE USA, INC.\",\n \"line_type\": \"Wireless\",\n \"phone_number\": \"+18665550001\",\n \"status\": \"queued\"\n }\n ],\n \"type\": \"MMS\",\n \"valid_until\": null,\n \"webhook_failover_url\": \"https://backup.example.com/hooks\",\n \"webhook_url\": \"https://www.example.com/hooks\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a message.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "38445500-a367-449d-87bc-a2951a5b0eec", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "00618575-474d-42c3-ae32-fa2176723cdb", "documentation": "Send a long code message", "method": "post", "endpoint": "messages/long_code", "responses": [ { "uuid": "dfde581f-d8ce-4a81-9f76-bdd1fdcc0158", "body": "{\n \"data\": {\n \"completed_at\": null,\n \"cost\": null,\n \"direction\": \"outbound\",\n \"encoding\": \"GSM-7\",\n \"errors\": [],\n \"from\": {\n \"carrier\": \"TELNYX LLC\",\n \"line_type\": \"VoIP\",\n \"phone_number\": \"+18445550001\"\n },\n \"id\": \"40385f64-5717-4562-b3fc-2c963f66afa6\",\n \"media\": [\n {\n \"content_type\": null,\n \"sha256\": null,\n \"size\": null,\n \"url\": \"https://pbs.twimg.com/profile_images/1142168442042118144/AW3F4fFD_400x400.png\"\n }\n ],\n \"messaging_profile_id\": \"4000eba1-a0c0-4563-9925-b25e842a7cb6\",\n \"organization_id\": \"b448f9cc-a842-4784-98e9-03c1a5872950\",\n \"parts\": 1,\n \"received_at\": \"2019-01-23T18:10:02.574Z\",\n \"record_type\": \"message\",\n \"sent_at\": null,\n \"subject\": \"From Telnyx!\",\n \"tags\": [\n \"Greetings\"\n ],\n \"text\": \"Hello, World!\",\n \"to\": [\n {\n \"carrier\": \"T-MOBILE USA, INC.\",\n \"line_type\": \"Wireless\",\n \"phone_number\": \"+18665550001\",\n \"status\": \"queued\"\n }\n ],\n \"type\": \"MMS\",\n \"valid_until\": null,\n \"webhook_failover_url\": \"https://backup.example.com/hooks\",\n \"webhook_url\": \"https://www.example.com/hooks\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a message.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "5fdcf69e-239a-4aed-8fb2-ac2cbfe9d6a5", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "cc745c54-a336-4add-9223-4db3706bad59", "documentation": "Send a message using number pool", "method": "post", "endpoint": "messages/number_pool", "responses": [ { "uuid": "2f13ba4c-28c6-4e4d-ae67-a59a77518851", "body": "{\n \"data\": {\n \"completed_at\": null,\n \"cost\": null,\n \"direction\": \"outbound\",\n \"encoding\": \"GSM-7\",\n \"errors\": [],\n \"from\": {\n \"carrier\": \"TELNYX LLC\",\n \"line_type\": \"VoIP\",\n \"phone_number\": \"+18445550001\"\n },\n \"id\": \"40385f64-5717-4562-b3fc-2c963f66afa6\",\n \"media\": [\n {\n \"content_type\": null,\n \"sha256\": null,\n \"size\": null,\n \"url\": \"https://pbs.twimg.com/profile_images/1142168442042118144/AW3F4fFD_400x400.png\"\n }\n ],\n \"messaging_profile_id\": \"4000eba1-a0c0-4563-9925-b25e842a7cb6\",\n \"organization_id\": \"b448f9cc-a842-4784-98e9-03c1a5872950\",\n \"parts\": 1,\n \"received_at\": \"2019-01-23T18:10:02.574Z\",\n \"record_type\": \"message\",\n \"sent_at\": null,\n \"subject\": \"From Telnyx!\",\n \"tags\": [\n \"Greetings\"\n ],\n \"text\": \"Hello, World!\",\n \"to\": [\n {\n \"carrier\": \"T-MOBILE USA, INC.\",\n \"line_type\": \"Wireless\",\n \"phone_number\": \"+18665550001\",\n \"status\": \"queued\"\n }\n ],\n \"type\": \"MMS\",\n \"valid_until\": null,\n \"webhook_failover_url\": \"https://backup.example.com/hooks\",\n \"webhook_url\": \"https://www.example.com/hooks\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a message.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ef357f39-d04a-4542-a5a0-33670603bc5e", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a846f846-5d65-4877-9723-113b8256d6f6", "documentation": "Send a short code message", "method": "post", "endpoint": "messages/short_code", "responses": [ { "uuid": "df705e50-7e76-45b2-b9e8-3453e2143b59", "body": "{\n \"data\": {\n \"completed_at\": null,\n \"cost\": null,\n \"direction\": \"outbound\",\n \"encoding\": \"GSM-7\",\n \"errors\": [],\n \"from\": {\n \"carrier\": \"TELNYX LLC\",\n \"line_type\": \"VoIP\",\n \"phone_number\": \"+18445550001\"\n },\n \"id\": \"40385f64-5717-4562-b3fc-2c963f66afa6\",\n \"media\": [\n {\n \"content_type\": null,\n \"sha256\": null,\n \"size\": null,\n \"url\": \"https://pbs.twimg.com/profile_images/1142168442042118144/AW3F4fFD_400x400.png\"\n }\n ],\n \"messaging_profile_id\": \"4000eba1-a0c0-4563-9925-b25e842a7cb6\",\n \"organization_id\": \"b448f9cc-a842-4784-98e9-03c1a5872950\",\n \"parts\": 1,\n \"received_at\": \"2019-01-23T18:10:02.574Z\",\n \"record_type\": \"message\",\n \"sent_at\": null,\n \"subject\": \"From Telnyx!\",\n \"tags\": [\n \"Greetings\"\n ],\n \"text\": \"Hello, World!\",\n \"to\": [\n {\n \"carrier\": \"T-MOBILE USA, INC.\",\n \"line_type\": \"Wireless\",\n \"phone_number\": \"+18665550001\",\n \"status\": \"queued\"\n }\n ],\n \"type\": \"MMS\",\n \"valid_until\": null,\n \"webhook_failover_url\": \"https://backup.example.com/hooks\",\n \"webhook_url\": \"https://www.example.com/hooks\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a message.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "40f02af6-ad87-47b5-a4cd-619bf6978ff2", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "51ea3219-fe4b-421e-907d-8e1cf335765e", "documentation": "Retrieve a message", "method": "get", "endpoint": "messages/:id", "responses": [ { "uuid": "594cd343-aa30-4a1c-9e19-1349e18b9c10", "body": "{\n \"data\": {\n \"completed_at\": null,\n \"cost\": null,\n \"direction\": \"outbound\",\n \"encoding\": \"GSM-7\",\n \"errors\": [],\n \"from\": {\n \"carrier\": \"TELNYX LLC\",\n \"line_type\": \"VoIP\",\n \"phone_number\": \"+18445550001\"\n },\n \"id\": \"40385f64-5717-4562-b3fc-2c963f66afa6\",\n \"media\": [\n {\n \"content_type\": null,\n \"sha256\": null,\n \"size\": null,\n \"url\": \"https://pbs.twimg.com/profile_images/1142168442042118144/AW3F4fFD_400x400.png\"\n }\n ],\n \"messaging_profile_id\": \"4000eba1-a0c0-4563-9925-b25e842a7cb6\",\n \"organization_id\": \"b448f9cc-a842-4784-98e9-03c1a5872950\",\n \"parts\": 1,\n \"received_at\": \"2019-01-23T18:10:02.574Z\",\n \"record_type\": \"message\",\n \"sent_at\": null,\n \"subject\": \"From Telnyx!\",\n \"tags\": [\n \"Greetings\"\n ],\n \"text\": \"Hello, World!\",\n \"to\": [\n {\n \"carrier\": \"T-MOBILE USA, INC.\",\n \"line_type\": \"Wireless\",\n \"phone_number\": \"+18665550001\",\n \"status\": \"queued\"\n }\n ],\n \"type\": \"MMS\",\n \"valid_until\": null,\n \"webhook_failover_url\": \"https://backup.example.com/hooks\",\n \"webhook_url\": \"https://www.example.com/hooks\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a message.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "8d961b63-226d-4b0c-8c6d-264262d5e62a", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "419953c8-0f4b-4abe-8e9a-85540c3836ab", "documentation": "List messaging hosted number orders", "method": "get", "endpoint": "messaging_hosted_number_orders", "responses": [ { "uuid": "819b9e48-6472-4f5f-9d83-d5534bd61edc", "body": "{\n \"data\": [\n {\n \"id\": \"86f58db9-0fe3-4adc-9d1f-46e66e6e9323\",\n \"messaging_profile_id\": \"dc8f39ac-953d-4520-b93b-786ae87db0da\",\n \"phone_numbers\": [\n {\n \"id\": \"bf6307bd-884d-4c1f-b6ea-c62b8c495d3c\",\n \"phone_number\": \"+18665550001\",\n \"record_type\": \"messaging_hosted_number\",\n \"status\": \"pending\"\n },\n {\n \"id\": \"464bd54e-a328-4b11-a131-28e6793cb6f2\",\n \"phone_number\": \"+18665550002\",\n \"record_type\": \"messaging_hosted_number\",\n \"status\": \"pending\"\n }\n ],\n \"record_type\": \"messaging_hosted_number_order\",\n \"status\": \"pending\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of messaging hosted number orders.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "14706cc7-b9ad-4494-9280-0a0a1dd1f126", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "6a327eb0-daef-4a19-9b06-547ee9a160bb", "documentation": "Create a messaging hosted number order", "method": "post", "endpoint": "messaging_hosted_number_orders", "responses": [ { "uuid": "c7979f1b-7a77-4455-ab32-3735e7110ace", "body": "{\n \"data\": {\n \"id\": \"86f58db9-0fe3-4adc-9d1f-46e66e6e9323\",\n \"messaging_profile_id\": \"dc8f39ac-953d-4520-b93b-786ae87db0da\",\n \"phone_numbers\": [\n {\n \"id\": \"bf6307bd-884d-4c1f-b6ea-c62b8c495d3c\",\n \"phone_number\": \"+18665550001\",\n \"record_type\": \"messaging_hosted_number\",\n \"status\": \"pending\"\n },\n {\n \"id\": \"464bd54e-a328-4b11-a131-28e6793cb6f2\",\n \"phone_number\": \"+18665550002\",\n \"record_type\": \"messaging_hosted_number\",\n \"status\": \"pending\"\n }\n ],\n \"record_type\": \"messaging_hosted_number_order\",\n \"status\": \"pending\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a messaging hosted number order.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "97dc07cc-a495-49aa-a4e1-e53c74f44ee1", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "77a21ecd-1af4-4181-a837-3e5ce1024a92", "documentation": "Retrieve a messaging hosted number order", "method": "get", "endpoint": "messaging_hosted_number_orders/:id", "responses": [ { "uuid": "7d9f6be9-dc82-47fa-8b08-977705d16658", "body": "{\n \"data\": {\n \"id\": \"86f58db9-0fe3-4adc-9d1f-46e66e6e9323\",\n \"messaging_profile_id\": \"dc8f39ac-953d-4520-b93b-786ae87db0da\",\n \"phone_numbers\": [\n {\n \"id\": \"bf6307bd-884d-4c1f-b6ea-c62b8c495d3c\",\n \"phone_number\": \"+18665550001\",\n \"record_type\": \"messaging_hosted_number\",\n \"status\": \"pending\"\n },\n {\n \"id\": \"464bd54e-a328-4b11-a131-28e6793cb6f2\",\n \"phone_number\": \"+18665550002\",\n \"record_type\": \"messaging_hosted_number\",\n \"status\": \"pending\"\n }\n ],\n \"record_type\": \"messaging_hosted_number_order\",\n \"status\": \"pending\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a messaging hosted number order.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "43473f5c-fb8c-4cda-b087-5eb77b597897", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e5b90e9f-3a37-4498-b707-37b0cdb3fa6c", "documentation": "Upload file required for a messaging hosted number order", "method": "post", "endpoint": "messaging_hosted_number_orders/:id/actions/file_upload", "responses": [ { "uuid": "acd6899f-eaba-4655-a61d-9d7bae9f5bfb", "body": "{\n \"data\": {\n \"id\": \"86f58db9-0fe3-4adc-9d1f-46e66e6e9323\",\n \"messaging_profile_id\": \"dc8f39ac-953d-4520-b93b-786ae87db0da\",\n \"phone_numbers\": [\n {\n \"id\": \"bf6307bd-884d-4c1f-b6ea-c62b8c495d3c\",\n \"phone_number\": \"+18665550001\",\n \"record_type\": \"messaging_hosted_number\",\n \"status\": \"pending\"\n },\n {\n \"id\": \"464bd54e-a328-4b11-a131-28e6793cb6f2\",\n \"phone_number\": \"+18665550002\",\n \"record_type\": \"messaging_hosted_number\",\n \"status\": \"pending\"\n }\n ],\n \"record_type\": \"messaging_hosted_number_order\",\n \"status\": \"pending\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a messaging hosted number order.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "fe58b45c-db64-4114-9e32-637eb45361e3", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5dabcbcc-a839-4299-9bf3-daa3b1394525", "documentation": "Delete a messaging hosted number", "method": "delete", "endpoint": "messaging_hosted_numbers/:id", "responses": [ { "uuid": "d681e5e0-2355-447d-afcf-321fcc1d9ccb", "body": "{\n \"data\": [\n {\n \"id\": \"bf6307bd-884d-4c1f-b6ea-c62b8c495d3c\",\n \"phone_number\": \"+18665550001\",\n \"record_type\": \"messaging_hosted_number\",\n \"status\": \"successful\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a messaging hosted number.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "7f695200-a2e0-4ea7-a58a-b3480833199f", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "cdaedbbd-11ce-4b63-b662-8cab4e98c18b", "documentation": "List messaging profile metrics", "method": "get", "endpoint": "messaging_profile_metrics", "responses": [ { "uuid": "58631b8f-a289-43d1-af49-ef624e3c85fb", "body": "{\n \"data\": [\n {\n \"inbound\": {\n \"received\": 850\n },\n \"messaging_profile_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"outbound\": {\n \"delivered\": 990,\n \"errors\": 0.01,\n \"sent\": 1000\n },\n \"phone_numbers\": 250,\n \"record_type\": \"messaging_profile_metrics\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of messaging profile metrics.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "597bcc09-a862-45c3-9124-d1ce910c1990", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "8362efc1-7bea-4940-995e-300806b662db", "documentation": "List messaging profiles", "method": "get", "endpoint": "messaging_profiles", "responses": [ { "uuid": "02b614d7-f62a-42c7-8224-de4d6afd7193", "body": "{\n \"data\": [\n {\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"enabled\": true,\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"Profile for Messages\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": 2,\n \"skip_unhealthy\": false,\n \"sticky_sender\": true,\n \"toll_free_weight\": 10\n },\n \"record_type\": \"messaging_profile\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\",\n \"url_shortener_settings\": {\n \"domain\": \"example.ex\",\n \"prefix\": \"cmpny\",\n \"replace_blacklist_only\": true,\n \"send_webhooks\": false\n },\n \"v1_secret\": \"rP1VamejkU2v0qIUxntqLW2c\",\n \"webhook_api_version\": \"2\",\n \"webhook_failover_url\": \"https://backup.example.com/hooks\",\n \"webhook_url\": \"https://www.example.com/hooks\",\n \"whitelisted_destinations\": [\n \"US\"\n ]\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of messaging profiles.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ee2b9004-d70a-4071-a8fc-7421709c7899", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "1de6c5d2-2deb-4aee-b592-d53e382b3e1c", "documentation": "Create a messaging profile", "method": "post", "endpoint": "messaging_profiles", "responses": [ { "uuid": "b7ac2f08-a329-42c2-b069-7260f8ecd29c", "body": "{\n \"data\": {\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"enabled\": true,\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"Profile for Messages\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": 2,\n \"skip_unhealthy\": false,\n \"sticky_sender\": true,\n \"toll_free_weight\": 10\n },\n \"record_type\": \"messaging_profile\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\",\n \"url_shortener_settings\": {\n \"domain\": \"example.ex\",\n \"prefix\": \"cmpny\",\n \"replace_blacklist_only\": true,\n \"send_webhooks\": false\n },\n \"v1_secret\": \"rP1VamejkU2v0qIUxntqLW2c\",\n \"webhook_api_version\": \"2\",\n \"webhook_failover_url\": \"https://backup.example.com/hooks\",\n \"webhook_url\": \"https://www.example.com/hooks\",\n \"whitelisted_destinations\": [\n \"US\"\n ]\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a messaging profile.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "550dfe62-45e7-4d77-a304-58a047f105e5", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "609c1344-8d21-4e78-8ee2-c1e158be37af", "documentation": "Delete a messaging profile", "method": "delete", "endpoint": "messaging_profiles/:id", "responses": [ { "uuid": "e6fe35f0-0c98-466e-89b9-e74b519ecb1d", "body": "{\n \"data\": {\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"enabled\": true,\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"Profile for Messages\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": 2,\n \"skip_unhealthy\": false,\n \"sticky_sender\": true,\n \"toll_free_weight\": 10\n },\n \"record_type\": \"messaging_profile\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\",\n \"url_shortener_settings\": {\n \"domain\": \"example.ex\",\n \"prefix\": \"cmpny\",\n \"replace_blacklist_only\": true,\n \"send_webhooks\": false\n },\n \"v1_secret\": \"rP1VamejkU2v0qIUxntqLW2c\",\n \"webhook_api_version\": \"2\",\n \"webhook_failover_url\": \"https://backup.example.com/hooks\",\n \"webhook_url\": \"https://www.example.com/hooks\",\n \"whitelisted_destinations\": [\n \"US\"\n ]\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a messaging profile.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "45bc21ac-8361-48fa-837f-33e1535df468", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "af46c9bd-049d-49ea-b07f-18da31e0533b", "documentation": "Retrieve a messaging profile", "method": "get", "endpoint": "messaging_profiles/:id", "responses": [ { "uuid": "16c46790-5ad2-484b-b929-054c7083f3a1", "body": "{\n \"data\": {\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"enabled\": true,\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"Profile for Messages\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": 2,\n \"skip_unhealthy\": false,\n \"sticky_sender\": true,\n \"toll_free_weight\": 10\n },\n \"record_type\": \"messaging_profile\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\",\n \"url_shortener_settings\": {\n \"domain\": \"example.ex\",\n \"prefix\": \"cmpny\",\n \"replace_blacklist_only\": true,\n \"send_webhooks\": false\n },\n \"v1_secret\": \"rP1VamejkU2v0qIUxntqLW2c\",\n \"webhook_api_version\": \"2\",\n \"webhook_failover_url\": \"https://backup.example.com/hooks\",\n \"webhook_url\": \"https://www.example.com/hooks\",\n \"whitelisted_destinations\": [\n \"US\"\n ]\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a messaging profile.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "aba04b8d-14ae-4cc0-85f0-081bc48f5eae", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "023027cb-1a06-4f6d-9302-1c035e8060c4", "documentation": "Update a messaging profile", "method": "patch", "endpoint": "messaging_profiles/:id", "responses": [ { "uuid": "42c412b7-4e44-4945-9fb6-fac531fdb953", "body": "{\n \"data\": {\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"enabled\": true,\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"Profile for Messages\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": 2,\n \"skip_unhealthy\": false,\n \"sticky_sender\": true,\n \"toll_free_weight\": 10\n },\n \"record_type\": \"messaging_profile\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\",\n \"url_shortener_settings\": {\n \"domain\": \"example.ex\",\n \"prefix\": \"cmpny\",\n \"replace_blacklist_only\": true,\n \"send_webhooks\": false\n },\n \"v1_secret\": \"rP1VamejkU2v0qIUxntqLW2c\",\n \"webhook_api_version\": \"2\",\n \"webhook_failover_url\": \"https://backup.example.com/hooks\",\n \"webhook_url\": \"https://www.example.com/hooks\",\n \"whitelisted_destinations\": [\n \"US\"\n ]\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a messaging profile.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e0d6ab55-487d-4a7a-ba39-fbde76f3eeaf", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b0c35fc2-d871-447c-a3b6-038503564311", "documentation": "Retrieve messaging profile metrics", "method": "get", "endpoint": "messaging_profiles/:id/metrics", "responses": [ { "uuid": "da01313f-9b2e-4031-b2fd-56b004a405b3", "body": "{\n \"data\": {\n \"detailed\": [\n {\n \"metrics\": [\n {\n \"delivered\": 990,\n \"errors\": 0.01,\n \"label\": \"longcode\",\n \"received\": 750,\n \"sent\": 1000\n }\n ],\n \"timestamp\": \"2019-01-23T18:10:02.574Z\"\n }\n ],\n \"overview\": {\n \"inbound\": {\n \"received\": 850\n },\n \"messaging_profile_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"outbound\": {\n \"delivered\": 990,\n \"errors\": 0.01,\n \"sent\": 1000\n },\n \"phone_numbers\": 250,\n \"record_type\": \"messaging_profile_metrics\"\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a messaging profile's metrics.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "eb2ca2e2-39da-47e5-a5c7-1c6b33441b64", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "3db46457-14e7-43ef-af1d-d9b4a26253f2", "documentation": "List phone numbers associated with a messaging profile", "method": "get", "endpoint": "messaging_profiles/:id/phone_numbers", "responses": [ { "uuid": "cf76108a-450e-473d-9c7e-6a131358b6a5", "body": "{\n \"data\": [\n {\n \"country_code\": \"US\",\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"eligible_messaging_products\": [\n \"A2P\"\n ],\n \"features\": {\n \"mms\": null,\n \"sms\": {\n \"domestic_two_way\": true,\n \"international_inbound\": true,\n \"international_outbound\": true\n }\n },\n \"health\": {\n \"inbound_outbound_ratio\": 0.43,\n \"message_count\": 122,\n \"spam_ratio\": 0.06,\n \"success_ratio\": 0.94\n },\n \"id\": \"1293384261075731499\",\n \"messaging_product\": \"A2P\",\n \"messaging_profile_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"phone_number\": \"+18005550001\",\n \"record_type\": \"messaging_settings\",\n \"traffic_type\": \"A2P\",\n \"type\": \"toll-free\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of messaging profile phone numbers.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "aa937c17-61ee-49c2-87fc-550cd72b7102", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5b578368-1971-4043-bff9-000413723a39", "documentation": "List short codes associated with a messaging profile", "method": "get", "endpoint": "messaging_profiles/:id/short_codes", "responses": [ { "uuid": "0663c7ab-47e8-48bc-bcba-da1f3d1d5693", "body": "{\n \"data\": [\n {\n \"country_code\": \"US\",\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"messaging_profile_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"record_type\": \"short_code\",\n \"short_code\": \"12345\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of messaging profile short codes.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "993b5373-0c69-42df-b695-4a1adb4651cf", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "493c2dd5-9577-41f3-a0a4-f7a3d71ed240", "documentation": "List messaging URL domains", "method": "get", "endpoint": "messaging_url_domains", "responses": [ { "uuid": "cc836c65-8d7d-452c-95cb-e2bdca096d44", "body": "{\n \"data\": [\n {\n \"id\": \"464bd54e-a328-4b11-a131-28e6793cb6f2\",\n \"record_type\": \"messaging_url_domain\",\n \"url_domain\": \"http://example.com\",\n \"use_case\": \"test\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a messaging URL domain.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c6aea787-02cb-4854-8c8a-c631f975bcd2", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "72495233-d5f4-4339-b038-26db7464e807", "documentation": "List mobile operator networks", "method": "get", "endpoint": "mobile_operator_networks", "responses": [ { "uuid": "ad796746-1669-4355-9b2c-3a274b501a0c", "body": "{\n \"data\": [\n {\n \"country_code\": \"US\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"mcc\": \"310\",\n \"mnc\": \"410\",\n \"name\": \"AT&T Mobility (USACG)\",\n \"record_type\": \"mobile_operator_network\",\n \"tadig\": \"USACG\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d8970717-0394-4a6b-a057-6310b689710d", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ea89f94f-0389-4a5d-9ef5-620832b82b64", "documentation": "List notification channels", "method": "get", "endpoint": "notification_channels", "responses": [ { "uuid": "c50bd3de-3d5a-407d-8625-624cd77305d8", "body": "{\n \"data\": [\n {\n \"channel_destination\": \"+13125550000\",\n \"channel_type_id\": \"{{oneOf (array 'sms' 'voice' 'email' 'webhook')}}\",\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"notification_profile_id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Returns a list of notification channels.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "118689d1-ae06-4c84-b017-d53da9d57c52", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a114d73e-e76b-4f5c-ad62-bd2bbf0e88bc", "documentation": "Create a notification channel", "method": "post", "endpoint": "notification_channels", "responses": [ { "uuid": "b9b570d5-85f9-42e8-a296-f8b3bbaa6f8a", "body": "{\n \"data\": {\n \"channel_destination\": \"+13125550000\",\n \"channel_type_id\": \"{{oneOf (array 'sms' 'voice' 'email' 'webhook')}}\",\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"notification_profile_id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A Notification Channel response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "b0898895-31f5-4e74-b032-f05faf9a74c7", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c473638e-7ae1-4da3-95b6-5bd63a254b67", "documentation": "Delete a notification channel", "method": "delete", "endpoint": "notification_channels/:id", "responses": [ { "uuid": "18e83ef9-5b4d-4313-8119-a8b92b116b80", "body": "{\n \"data\": {\n \"channel_destination\": \"+13125550000\",\n \"channel_type_id\": \"{{oneOf (array 'sms' 'voice' 'email' 'webhook')}}\",\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"notification_profile_id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A Notification Channel response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "5c634c73-b270-45f7-9218-f056d71c6063", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "dcdb21a1-667a-4de5-afb3-d21301b1db5d", "documentation": "Retrieve a notification channel", "method": "get", "endpoint": "notification_channels/:id", "responses": [ { "uuid": "04e94c80-2abd-4d57-85cd-885898afd7b7", "body": "{\n \"data\": {\n \"channel_destination\": \"+13125550000\",\n \"channel_type_id\": \"{{oneOf (array 'sms' 'voice' 'email' 'webhook')}}\",\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"notification_profile_id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A Notification Channel response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6fd85675-4aee-450c-9969-8655d69a06e4", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b55354a0-e685-4bed-9e69-94090a4c48ec", "documentation": "Update a notification channel", "method": "patch", "endpoint": "notification_channels/:id", "responses": [ { "uuid": "48700b69-4581-41c3-bf09-60351c79885d", "body": "{\n \"data\": {\n \"channel_destination\": \"+13125550000\",\n \"channel_type_id\": \"{{oneOf (array 'sms' 'voice' 'email' 'webhook')}}\",\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"notification_profile_id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A Notification Channel response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "420c57b8-dc40-45ee-bdfc-2cb83c8c8de1", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "293901a1-30ed-48bc-8003-70b2a0a442b6", "documentation": "List all Notifications Events Conditions", "method": "get", "endpoint": "notification_event_conditions", "responses": [ { "uuid": "007f69b3-73f5-46d3-877d-16f377c12113", "body": "{\n \"data\": [\n {\n \"allow_multiple_channels\": {{faker 'random.boolean'}},\n \"associated_record_type\": \"{{oneOf (array 'account' 'phone_number')}}\",\n \"asynchronous\": true,\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"description\": \"When emergency number dialed from phone number X\",\n \"enabled\": true,\n \"id\": \"70c7c5cb-dce2-4124-accb-870d39dbe852\",\n \"name\": \"from phone number\",\n \"notification_event_id\": \"d5c395cd-9864-4609-b5e2-3f9fd4ce201a\",\n \"parameters\": [\n {\n \"data_type\": \"string\",\n \"name\": \"phone_number\",\n \"optional\": {{faker 'random.boolean'}}\n }\n ],\n \"supported_channels\": [\n \"webhook\",\n \"sms\",\n \"email\",\n \"voice\"\n ],\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Returns a list of notification event conditions available.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "7b758480-91e0-4cd0-a02d-c63a50c4af48", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c0b04872-a056-4268-9af3-53647bcbaa3b", "documentation": "List all Notifications Events", "method": "get", "endpoint": "notification_events", "responses": [ { "uuid": "50eb456e-332e-4164-84ad-69c02e51fb53", "body": "{\n \"data\": [\n {\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"enabled\": true,\n \"id\": \"d5c395cd-9864-4609-b5e2-3f9fd4ce201a\",\n \"name\": \"Emergency Number Dialed\",\n \"notification_category\": \"Calls\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Returns a list of notification events available.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ac7ec441-6cd4-4707-8a89-dada670712d7", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "884ba116-9518-4681-9292-34c1f94619e6", "documentation": "List all Notifications Profiles", "method": "get", "endpoint": "notification_profiles", "responses": [ { "uuid": "db6466a6-610d-4559-9fec-61f8907b167d", "body": "{\n \"data\": [\n {\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"name\": \"\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Returns a list of notification profiles.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "06e31b9a-c3bd-4441-a5cb-cf2a47368702", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2116916f-e914-409f-b17b-b22c64199108", "documentation": "Create a notification profile", "method": "post", "endpoint": "notification_profiles", "responses": [ { "uuid": "f7e28c32-be65-4830-ad8e-451aa684972f", "body": "{\n \"data\": {\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"name\": \"\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A Notification Profile response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "9260156d-617b-4c1b-9c27-e740116251ea", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "896ab86b-9996-4202-8108-01dda486c3e1", "documentation": "Delete a notification profile", "method": "delete", "endpoint": "notification_profiles/:id", "responses": [ { "uuid": "16e5683e-dece-4a20-8a0a-35e02d3712ca", "body": "{\n \"data\": {\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"name\": \"\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A Notification Profile response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "862ecc6f-b65c-4eda-b0d8-fd84ae7dd99a", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a7c11fa7-1b04-4984-b5cf-703f66b66c32", "documentation": "Retrieve a notification profile", "method": "get", "endpoint": "notification_profiles/:id", "responses": [ { "uuid": "3732fb12-cc3c-4f99-bf97-f20d830c6547", "body": "{\n \"data\": {\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"name\": \"\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A Notification Profile response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f24db82a-1433-41fd-9eb4-dccf016cd7cf", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a4520dad-8423-4d13-adb3-40906170bdd6", "documentation": "Update a notification profile", "method": "patch", "endpoint": "notification_profiles/:id", "responses": [ { "uuid": "1c17e6a2-847e-4b2a-add7-148b2c09ff09", "body": "{\n \"data\": {\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"name\": \"\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A Notification Profile response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "80b12718-dc16-4950-8332-4bceb1c5322e", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "bc726893-125c-444c-8fb5-42d34b228cf9", "documentation": "List notification settings", "method": "get", "endpoint": "notification_settings", "responses": [ { "uuid": "b1220f10-0b4c-404d-b2ff-3896ff942cbe", "body": "{\n \"data\": [\n {\n \"associated_record_type\": \"phone_number\",\n \"associated_record_type_value\": \"+13125550000\",\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"id\": \"8eb5b5f9-5893-423c-9f15-b487713d44d4\",\n \"notification_channel_id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"notification_event_condition_id\": \"70c7c5cb-dce2-4124-accb-870d39dbe852\",\n \"notification_profile_id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"parameters\": [\n {\n \"name\": \"phone_number\",\n \"value\": \"+13125550000\"\n }\n ],\n \"status\": \"{{oneOf (array 'enabled' 'enable-received' 'enable-pending' 'enable-submtited' 'delete-received' 'delete-pending' 'delete-submitted' 'deleted')}}\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Returns a list of notification settings.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "fcbdf8fb-88ee-4451-b3bd-94f534d98619", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d612cdfc-f77c-4aec-a7d7-c28a34dd7f07", "documentation": "Add a Notification Setting", "method": "post", "endpoint": "notification_settings", "responses": [ { "uuid": "d23ae5ca-934a-4f08-8db7-b1c5457ae010", "body": "{\n \"data\": {\n \"associated_record_type\": \"phone_number\",\n \"associated_record_type_value\": \"+13125550000\",\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"id\": \"8eb5b5f9-5893-423c-9f15-b487713d44d4\",\n \"notification_channel_id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"notification_event_condition_id\": \"70c7c5cb-dce2-4124-accb-870d39dbe852\",\n \"notification_profile_id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"parameters\": [\n {\n \"name\": \"phone_number\",\n \"value\": \"+13125550000\"\n }\n ],\n \"status\": \"{{oneOf (array 'enabled' 'enable-received' 'enable-pending' 'enable-submtited' 'delete-received' 'delete-pending' 'delete-submitted' 'deleted')}}\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A Notification Setting response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "01e8ba8e-b2d9-4e4e-91f8-ef7871790ff8", "body": "{\n \"data\": {\n \"associated_record_type\": \"phone_number\",\n \"associated_record_type_value\": \"+13125550000\",\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"id\": \"8eb5b5f9-5893-423c-9f15-b487713d44d4\",\n \"notification_channel_id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"notification_event_condition_id\": \"70c7c5cb-dce2-4124-accb-870d39dbe852\",\n \"notification_profile_id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"parameters\": [\n {\n \"name\": \"phone_number\",\n \"value\": \"+13125550000\"\n }\n ],\n \"status\": \"{{oneOf (array 'enabled' 'enable-received' 'enable-pending' 'enable-submtited' 'delete-received' 'delete-pending' 'delete-submitted' 'deleted')}}\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 201, "label": "A Notification Setting response - async", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "dd11120d-f5ee-48f4-baf8-00abacf3d4ea", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7f0cc368-2e30-40c8-aa67-785c1018797c", "documentation": "Delete a notification setting", "method": "delete", "endpoint": "notification_settings/:id", "responses": [ { "uuid": "27642fe7-9902-49b4-b6ae-76574f4b92cb", "body": "{\n \"data\": {\n \"associated_record_type\": \"phone_number\",\n \"associated_record_type_value\": \"+13125550000\",\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"id\": \"8eb5b5f9-5893-423c-9f15-b487713d44d4\",\n \"notification_channel_id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"notification_event_condition_id\": \"70c7c5cb-dce2-4124-accb-870d39dbe852\",\n \"notification_profile_id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"parameters\": [\n {\n \"name\": \"phone_number\",\n \"value\": \"+13125550000\"\n }\n ],\n \"status\": \"{{oneOf (array 'enabled' 'enable-received' 'enable-pending' 'enable-submtited' 'delete-received' 'delete-pending' 'delete-submitted' 'deleted')}}\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A Notification Setting response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c19324d0-99b7-43b2-9a59-2dcb968730c4", "body": "{\n \"data\": {\n \"associated_record_type\": \"phone_number\",\n \"associated_record_type_value\": \"+13125550000\",\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"id\": \"8eb5b5f9-5893-423c-9f15-b487713d44d4\",\n \"notification_channel_id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"notification_event_condition_id\": \"70c7c5cb-dce2-4124-accb-870d39dbe852\",\n \"notification_profile_id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"parameters\": [\n {\n \"name\": \"phone_number\",\n \"value\": \"+13125550000\"\n }\n ],\n \"status\": \"{{oneOf (array 'enabled' 'enable-received' 'enable-pending' 'enable-submtited' 'delete-received' 'delete-pending' 'delete-submitted' 'deleted')}}\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 201, "label": "A Notification Setting response - async", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "4ea9beb0-5c61-4404-a3d6-957a4698e3a2", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7a9bf628-9359-4f5b-acf1-c8f9029cec2b", "documentation": "Retrieve a notification setting", "method": "get", "endpoint": "notification_settings/:id", "responses": [ { "uuid": "54f522f6-fd3d-453a-9ac1-59edc1a448b3", "body": "{\n \"data\": {\n \"associated_record_type\": \"phone_number\",\n \"associated_record_type_value\": \"+13125550000\",\n \"created_at\": \"2019-10-15T10:07:15.527Z\",\n \"id\": \"8eb5b5f9-5893-423c-9f15-b487713d44d4\",\n \"notification_channel_id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"notification_event_condition_id\": \"70c7c5cb-dce2-4124-accb-870d39dbe852\",\n \"notification_profile_id\": \"12455643-3cf1-4683-ad23-1cd32f7d5e0a\",\n \"parameters\": [\n {\n \"name\": \"phone_number\",\n \"value\": \"+13125550000\"\n }\n ],\n \"status\": \"{{oneOf (array 'enabled' 'enable-received' 'enable-pending' 'enable-submtited' 'delete-received' 'delete-pending' 'delete-submitted' 'deleted')}}\",\n \"updated_at\": \"2019-10-15T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A Notification Setting response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "704f703d-09b8-45dc-a0b1-fa814badbac2", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "fdafb5ea-a72d-4cff-9432-58ebf963b31f", "documentation": "List number block orders", "method": "get", "endpoint": "number_block_orders", "responses": [ { "uuid": "92ae1a98-f756-44a1-ae3b-1a7f6dd52988", "body": "{\n \"data\": [\n {\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers_count\": 10,\n \"range\": 10,\n \"record_type\": \"number_block_order\",\n \"requirements_met\": true,\n \"starting_number\": \"+19705555000\",\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of number block orders.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "870940bc-5212-46cc-a3c1-9fcd0c055afd", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "9829a929-ce49-4cf4-9cbf-a15f780eef7d", "documentation": "Create a number block order", "method": "post", "endpoint": "number_block_orders", "responses": [ { "uuid": "68e25922-3948-4ff9-a1e5-b2130895edbf", "body": "{\n \"data\": {\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers_count\": 10,\n \"range\": 10,\n \"record_type\": \"number_block_order\",\n \"requirements_met\": true,\n \"starting_number\": \"+19705555000\",\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a number block order.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e9150621-72a1-4b12-98fa-4ed1cfc1a1ad", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0f44ab63-6211-45e6-8a97-e20837a4e5b4", "documentation": "Retrieve a number block order", "method": "get", "endpoint": "number_block_orders/:number_block_order_id", "responses": [ { "uuid": "61da6a12-fa56-4969-82ba-8e62b9cd65ea", "body": "{\n \"data\": {\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers_count\": 10,\n \"range\": 10,\n \"record_type\": \"number_block_order\",\n \"requirements_met\": true,\n \"starting_number\": \"+19705555000\",\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a number block order.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ad822769-8d4d-49de-a4b0-93d592db5988", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "205bd26a-e947-4195-8168-c06d895949e0", "documentation": "Lookup phone number data", "method": "get", "endpoint": "number_lookup/:phone_number", "responses": [ { "uuid": "d78926b6-7319-4c1f-92f9-f04a9d48f3b5", "body": "{\n \"data\": {\n \"caller_name\": {\n \"caller_name\": \"TELNYX LLC\",\n \"error_code\": \"10001\"\n },\n \"carrier\": {\n \"error_code\": \"\",\n \"mobile_country_code\": \"US\",\n \"mobile_network_code\": 866,\n \"name\": \"Telnyx/4\",\n \"type\": \"{{oneOf (array 'fixed line' 'mobile' 'voip' 'fixed line or mobile' 'toll free' 'premium rate' 'shared cost' 'personal number' 'pager' 'uan' 'voicemail' 'unknown')}}\"\n },\n \"country_code\": \"US\",\n \"fraud\": \"\",\n \"national_format\": \"(0312) 945-7420\",\n \"phone_number\": \"+13129457420\",\n \"portability\": {\n \"altspid\": \"073H\",\n \"altspid_carrier_name\": \"Telnyx/4\",\n \"altspid_carrier_type\": \"3\",\n \"city\": \"WAUKEGAN\",\n \"line_type\": \"voip\",\n \"lrn\": \"2245701999\",\n \"ocn\": \"073H\",\n \"ported_date\": \"2017-10-20\",\n \"ported_status\": \"{{oneOf (array 'Y' 'N' '')}}\",\n \"spid\": \"073H\",\n \"spid_carrier_name\": \"Telnyx/4\",\n \"spid_carrier_type\": \"3\",\n \"state\": \"Illinois\"\n },\n \"record_type\": \"number_lookup\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "902548ba-9ca8-4b63-bb16-87aee2696908", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check the 'detail' field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c692f9b7-d148-4dbf-8646-fa7a9357d29b", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a38cb4fa-44cb-4bef-b35c-9850d500c58a", "documentation": "List number order documents", "method": "get", "endpoint": "number_order_documents", "responses": [ { "uuid": "52a55fd9-9e45-4a68-b65b-7f0692bdd76f", "body": "{\n \"data\": [\n {\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"file_id\": \"1e3c5822-0362-4702-8e46-5a129f0d3976\",\n \"id\": \"387d1e31-a218-4375-8151-103f2d5e2d2c\",\n \"record_type\": \"number_order_document\",\n \"requirement_type\": \"address_proof\",\n \"requirements_id\": \"36aaf27d-986b-493c-bd1b-de16af2e4292\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of number order documents.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a79b0600-37b3-4a22-913b-a780f75a4cc4", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "583fd76e-a55a-40ea-aafe-c65d7d5b3a9d", "documentation": "Create a number order document", "method": "post", "endpoint": "number_order_documents", "responses": [ { "uuid": "f2535166-f9e7-455f-bbdf-b54a59eb6608", "body": "{\n \"data\": {\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"file_id\": \"1e3c5822-0362-4702-8e46-5a129f0d3976\",\n \"id\": \"387d1e31-a218-4375-8151-103f2d5e2d2c\",\n \"record_type\": \"number_order_document\",\n \"requirement_type\": \"address_proof\",\n \"requirements_id\": \"36aaf27d-986b-493c-bd1b-de16af2e4292\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a number order document.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f9a293cc-a339-4be4-bc6e-6afc6e09f070", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f07b85f3-639d-4a07-bf71-ee5f7fd9611d", "documentation": "Retrieve a number order document", "method": "get", "endpoint": "number_order_documents/:number_order_document_id", "responses": [ { "uuid": "fbfd2cea-6572-4e07-b338-dd3d1160ec6e", "body": "{\n \"data\": {\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"file_id\": \"1e3c5822-0362-4702-8e46-5a129f0d3976\",\n \"id\": \"387d1e31-a218-4375-8151-103f2d5e2d2c\",\n \"record_type\": \"number_order_document\",\n \"requirement_type\": \"address_proof\",\n \"requirements_id\": \"36aaf27d-986b-493c-bd1b-de16af2e4292\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a number order document.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "44f59062-9c22-449e-8cff-989890e47188", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "1ee5a79b-4ce9-40f6-a665-503a33e7adbd", "documentation": "Update a number order document", "method": "patch", "endpoint": "number_order_documents/:number_order_document_id", "responses": [ { "uuid": "e0e96b91-3bfb-4c38-a39f-aa8051a647ca", "body": "{\n \"data\": {\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"file_id\": \"1e3c5822-0362-4702-8e46-5a129f0d3976\",\n \"id\": \"387d1e31-a218-4375-8151-103f2d5e2d2c\",\n \"record_type\": \"number_order_document\",\n \"requirement_type\": \"address_proof\",\n \"requirements_id\": \"36aaf27d-986b-493c-bd1b-de16af2e4292\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a number order document.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a7fa7982-a747-4585-a5ec-efd28799a8c5", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2e4d5a58-08dc-4cc5-9504-8ca68c4d004a", "documentation": "Retrieve a list of phone numbers associated to orders", "method": "get", "endpoint": "number_order_phone_numbers", "responses": [ { "uuid": "e8bbbb14-4a5f-47ef-bb24-87770c30eef4", "body": "{\n \"data\": [\n {\n \"country_code\": \"US\",\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"order_request_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd495\",\n \"phone_number\": \"+19705555098\",\n \"phone_number_type\": \"{{oneOf (array 'local' 'toll-free' 'mobile' 'national' 'shared-cost')}}\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"{{oneOf (array 'textual' 'datetime' 'address' 'document')}}\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"{{oneOf (array 'pending' 'success' 'failure')}}\",\n \"sub_number_order_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd496\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of number order phone numbers.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d53dd97a-70c5-44d8-84b8-0e4fd0aedb26", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "60ab9b2d-10a3-46b6-a794-663779eeffd1", "documentation": "Retrieve a number order phone number.", "method": "get", "endpoint": "number_order_phone_numbers/:number_order_phone_number_id", "responses": [ { "uuid": "772773f7-79bd-4f27-9509-19c488396578", "body": "{\n \"data\": {\n \"country_code\": \"US\",\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"order_request_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd495\",\n \"phone_number\": \"+19705555098\",\n \"phone_number_type\": \"{{oneOf (array 'local' 'toll-free' 'mobile' 'national' 'shared-cost')}}\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"{{oneOf (array 'textual' 'datetime' 'address' 'document')}}\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"{{oneOf (array 'pending' 'success' 'failure')}}\",\n \"sub_number_order_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd496\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a number order phone number.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f189af27-74b7-4255-b5a5-60cb715458bb", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a3db443f-02ed-46e2-a2ee-b55e7bd22668", "documentation": "Update a number order phone number.", "method": "patch", "endpoint": "number_order_phone_numbers/:number_order_phone_number_id", "responses": [ { "uuid": "845eaf7e-02ed-4ca5-80af-c95115f7d8c7", "body": "{\n \"data\": {\n \"country_code\": \"US\",\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"order_request_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd495\",\n \"phone_number\": \"+19705555098\",\n \"phone_number_type\": \"{{oneOf (array 'local' 'toll-free' 'mobile' 'national' 'shared-cost')}}\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"{{oneOf (array 'textual' 'datetime' 'address' 'document')}}\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"{{oneOf (array 'pending' 'success' 'failure')}}\",\n \"sub_number_order_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd496\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a number order phone number.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6e3e065f-48b4-49b6-b4ec-50281847c940", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "400d99cb-5d92-45e0-8141-e291c255eec1", "documentation": "List number orders", "method": "get", "endpoint": "number_orders", "responses": [ { "uuid": "6f129974-b9ca-4996-9b65-4c9cdc150947", "body": "{\n \"data\": [\n {\n \"billing_group_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"{{oneOf (array 'pending' 'success' 'failure')}}\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of number orders.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a1123867-26e0-4607-85b6-f377a7fb0030", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "80359a83-897c-4435-b330-2ab501991db1", "documentation": "Create a number order", "method": "post", "endpoint": "number_orders", "responses": [ { "uuid": "cb3d586b-f4aa-4fa1-a1ee-1166541f79af", "body": "{\n \"data\": {\n \"billing_group_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"{{oneOf (array 'pending' 'success' 'failure')}}\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a number order.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "34071318-7cc7-4acd-930a-23e699ef21fb", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "fb6395b0-faf1-470e-878d-d0ca81765c27", "documentation": "Retrieve a number order", "method": "get", "endpoint": "number_orders/:number_order_id", "responses": [ { "uuid": "4c14412c-c3d9-4152-a2ee-e2ed65a58d46", "body": "{\n \"data\": {\n \"billing_group_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"{{oneOf (array 'pending' 'success' 'failure')}}\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a number order.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "7b2e599c-480e-4f7e-aee9-0961193d4321", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "fe79229c-6de3-48c0-b884-48eee5850258", "documentation": "Update a number order", "method": "patch", "endpoint": "number_orders/:number_order_id", "responses": [ { "uuid": "00740174-b9d3-46a4-8512-696acdd2815b", "body": "{\n \"data\": {\n \"billing_group_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"{{oneOf (array 'pending' 'success' 'failure')}}\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a number order.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3a8b7a47-e28f-4895-9b79-2ec46e2b2362", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "788db432-fcda-447f-addc-e6ff76c25ee5", "documentation": "List number reservations", "method": "get", "endpoint": "number_reservations", "responses": [ { "uuid": "abe9835e-32a1-4d0a-b195-f08db4cf31f1", "body": "{\n \"data\": [\n {\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_numbers\": [\n {\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"errors\": \"\",\n \"expired_at\": \"2018-01-01T00:00:00.000000Z\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"reserved_phone_number\",\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n }\n ],\n \"record_type\": \"number_reservation\",\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of number reservations.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2b3bee90-4b89-4c3f-bbcf-2a489e80bbca", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f28f7d50-be55-4edb-9368-b2058ce103fa", "documentation": "Create a number reservation", "method": "post", "endpoint": "number_reservations", "responses": [ { "uuid": "cf731790-28cd-48dc-a273-f544f0cc0c1a", "body": "{\n \"data\": {\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_numbers\": [\n {\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"errors\": \"\",\n \"expired_at\": \"2018-01-01T00:00:00.000000Z\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"reserved_phone_number\",\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n }\n ],\n \"record_type\": \"number_reservation\",\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a number reservation.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "260ef92a-a492-4a13-9991-b25db049f407", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "104a4f5f-727a-40e3-8eb4-35ab7989baf1", "documentation": "Retrieve a number reservation", "method": "get", "endpoint": "number_reservations/:number_reservation_id", "responses": [ { "uuid": "37efcfe4-c300-466f-8ada-9f7cb6d0fa2f", "body": "{\n \"data\": {\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_numbers\": [\n {\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"errors\": \"\",\n \"expired_at\": \"2018-01-01T00:00:00.000000Z\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"reserved_phone_number\",\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n }\n ],\n \"record_type\": \"number_reservation\",\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a number reservation.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "10a6a60f-7b68-4aa7-8386-72323560a52c", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a3e7bee8-d538-45a9-9771-36f376321b63", "documentation": "Extend a number reservation", "method": "post", "endpoint": "number_reservations/:number_reservation_id/actions/extend", "responses": [ { "uuid": "d08b185b-7b66-4204-be55-be3dd68f9279", "body": "{\n \"data\": {\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_numbers\": [\n {\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"errors\": \"\",\n \"expired_at\": \"2018-01-01T00:00:00.000000Z\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"reserved_phone_number\",\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n }\n ],\n \"record_type\": \"number_reservation\",\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a number reservation.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "8f142c24-8ffb-45b9-9ec3-84a8fe7dc896", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "6bd70114-e47f-4ae3-85e8-0c7f3249efbc", "documentation": "List OTA updates", "method": "get", "endpoint": "ota_updates", "responses": [ { "uuid": "a248e532-8904-4433-b305-fc51569620a0", "body": "{\n \"data\": [\n {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"ota_update\",\n \"sim_card_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"{{oneOf (array 'in-progress' 'completed' 'failed')}}\",\n \"type\": \"{{oneOf (array 'sim_card_network_preferences')}}\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f47b7055-1392-42af-822b-1dc359e2e8e4", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a8b476db-e1ee-4f7e-96ab-2df6f10a5635", "documentation": "Get OTA update", "method": "get", "endpoint": "ota_updates/:id", "responses": [ { "uuid": "a8713e5e-53f4-4bb6-95cc-2ba69a6904d1", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"ota_update\",\n \"settings\": {\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"mobile_operator_network_name\": \"AT&T Mobility (USACG)\",\n \"priority\": 0\n }\n ]\n },\n \"sim_card_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"in-progress\",\n \"type\": \"sim_card_network_preferences\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e671722c-a597-4c64-8eac-cc8f9f4b01ba", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c2bffc05-7f74-4b92-a4c6-47e9cbbc3546", "documentation": "Get all outbound voice profiles", "method": "get", "endpoint": "outbound_voice_profiles", "responses": [ { "uuid": "7643c062-4994-4696-af34-1776a670d504", "body": "{\n \"data\": [\n {\n \"billing_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [\n \"+19705555098\"\n ],\n \"call_recording_channels\": \"dual\",\n \"call_recording_format\": \"mp3\",\n \"call_recording_type\": \"by_caller_phone_number\"\n },\n \"concurrent_call_limit\": 10,\n \"connections_count\": 12,\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"daily_spend_limit\": \"100.00\",\n \"daily_spend_limit_enabled\": true,\n \"enabled\": true,\n \"id\": \"1293384261075731499\",\n \"max_destination_rate\": 10,\n \"name\": \"office\",\n \"record_type\": \"outbound_voice_profile\",\n \"service_plan\": \"global\",\n \"tags\": [\n \"office-profile\"\n ],\n \"traffic_type\": \"conversational\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"usage_payment_method\": \"rate-deck\",\n \"whitelisted_destinations\": [\n \"US\",\n \"BR\",\n \"AU\"\n ]\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "7c69e567-cc2b-4233-af19-cb8eaab18c1d", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3b2c65fd-3f36-4122-8995-4fa862f82735", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "898b9a22-5007-41f9-bc74-b4559491d70d", "documentation": "Create an outbound voice profile", "method": "post", "endpoint": "outbound_voice_profiles", "responses": [ { "uuid": "818d9c24-0077-413e-8643-14afc2510881", "body": "{\n \"data\": {\n \"billing_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [\n \"+19705555098\"\n ],\n \"call_recording_channels\": \"dual\",\n \"call_recording_format\": \"mp3\",\n \"call_recording_type\": \"by_caller_phone_number\"\n },\n \"concurrent_call_limit\": 10,\n \"connections_count\": 12,\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"daily_spend_limit\": \"100.00\",\n \"daily_spend_limit_enabled\": true,\n \"enabled\": true,\n \"id\": \"1293384261075731499\",\n \"max_destination_rate\": 10,\n \"name\": \"office\",\n \"record_type\": \"outbound_voice_profile\",\n \"service_plan\": \"global\",\n \"tags\": [\n \"office-profile\"\n ],\n \"traffic_type\": \"conversational\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"usage_payment_method\": \"rate-deck\",\n \"whitelisted_destinations\": [\n \"US\",\n \"BR\",\n \"AU\"\n ]\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "b2849fe8-92ce-4a4c-ac77-98181ff15157", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ff7bbdfd-baf6-4b28-b15b-969753e1cace", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "63612f05-1193-43cc-a412-1da034cfba83", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c20c9a65-4cda-45ce-a654-5acc38f3d297", "documentation": "Delete an outbound voice profile", "method": "delete", "endpoint": "outbound_voice_profiles/:id", "responses": [ { "uuid": "167f16cd-4300-48a7-874c-d928f4177933", "body": "{\n \"data\": {\n \"billing_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [\n \"+19705555098\"\n ],\n \"call_recording_channels\": \"dual\",\n \"call_recording_format\": \"mp3\",\n \"call_recording_type\": \"by_caller_phone_number\"\n },\n \"concurrent_call_limit\": 10,\n \"connections_count\": 12,\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"daily_spend_limit\": \"100.00\",\n \"daily_spend_limit_enabled\": true,\n \"enabled\": true,\n \"id\": \"1293384261075731499\",\n \"max_destination_rate\": 10,\n \"name\": \"office\",\n \"record_type\": \"outbound_voice_profile\",\n \"service_plan\": \"global\",\n \"tags\": [\n \"office-profile\"\n ],\n \"traffic_type\": \"conversational\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"usage_payment_method\": \"rate-deck\",\n \"whitelisted_destinations\": [\n \"US\",\n \"BR\",\n \"AU\"\n ]\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "4613bb2b-5401-4246-a372-981758cd0e28", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d0fa51b2-7023-4b50-bcf0-16fa90a2e4be", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "42f5814e-36c6-44a0-aafa-199d0fa3f82c", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "901a3dee-2257-4a7e-9335-0b26a3cd0384", "documentation": "Retrieve an outbound voice profile", "method": "get", "endpoint": "outbound_voice_profiles/:id", "responses": [ { "uuid": "6a9c7e14-02ab-4a1a-9a62-63185124f6fa", "body": "{\n \"data\": {\n \"billing_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [\n \"+19705555098\"\n ],\n \"call_recording_channels\": \"dual\",\n \"call_recording_format\": \"mp3\",\n \"call_recording_type\": \"by_caller_phone_number\"\n },\n \"concurrent_call_limit\": 10,\n \"connections_count\": 12,\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"daily_spend_limit\": \"100.00\",\n \"daily_spend_limit_enabled\": true,\n \"enabled\": true,\n \"id\": \"1293384261075731499\",\n \"max_destination_rate\": 10,\n \"name\": \"office\",\n \"record_type\": \"outbound_voice_profile\",\n \"service_plan\": \"global\",\n \"tags\": [\n \"office-profile\"\n ],\n \"traffic_type\": \"conversational\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"usage_payment_method\": \"rate-deck\",\n \"whitelisted_destinations\": [\n \"US\",\n \"BR\",\n \"AU\"\n ]\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3eeeff80-40de-4ac6-bb9e-870b0b9239bd", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "002821f0-285d-4346-99f5-f302e60890cd", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f4d8a11a-86ae-43b7-b78c-9887d54c9206", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "75e811db-085f-47f2-8dce-46697a636d98", "documentation": "Updates an existing outbound voice profile.", "method": "patch", "endpoint": "outbound_voice_profiles/:id", "responses": [ { "uuid": "183b25e5-1389-4be2-aa3c-3fc0636038ea", "body": "{\n \"data\": {\n \"billing_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [\n \"+19705555098\"\n ],\n \"call_recording_channels\": \"dual\",\n \"call_recording_format\": \"mp3\",\n \"call_recording_type\": \"by_caller_phone_number\"\n },\n \"concurrent_call_limit\": 10,\n \"connections_count\": 12,\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"daily_spend_limit\": \"100.00\",\n \"daily_spend_limit_enabled\": true,\n \"enabled\": true,\n \"id\": \"1293384261075731499\",\n \"max_destination_rate\": 10,\n \"name\": \"office\",\n \"record_type\": \"outbound_voice_profile\",\n \"service_plan\": \"global\",\n \"tags\": [\n \"office-profile\"\n ],\n \"traffic_type\": \"conversational\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\",\n \"usage_payment_method\": \"rate-deck\",\n \"whitelisted_destinations\": [\n \"US\",\n \"BR\",\n \"AU\"\n ]\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2b5beefe-bf68-44b2-99b1-2035c4682ea7", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "fd782ac2-70bf-4671-bbad-2c723201bff0", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "427e72f6-60b6-4837-abe2-c30f04a3de8b", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d2541228-6055-44ed-b497-409039018e07", "documentation": "Lists the phone number blocks jobs", "method": "get", "endpoint": "phone_number_blocks/jobs", "responses": [ { "uuid": "5b97bd34-b810-4949-9013-02a55e626b6d", "body": "{\n \"data\": [\n {\n \"created_at\": \"2020-10-23T18:10:00.000Z\",\n \"etc\": \"2020-10-30T18:10:00.000Z\",\n \"failed_operations\": [],\n \"id\": \"42587e44-3a3e-46de-9255-0c9a7a1d1ec7\",\n \"record_type\": \"phone_numbers_job\",\n \"status\": \"pending\",\n \"successful_operations\": [],\n \"type\": \"delete_phone_number_block\",\n \"updated_at\": \"2020-10-23T18:10:01.000Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of phone number blocks background jobs.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f3105a4b-1db0-4e9f-9421-5675908c9d34", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d1bfea30-106f-4c47-9c01-f6833a4b4a18", "documentation": "Deletes all numbers associated with a phone number block", "method": "post", "endpoint": "phone_number_blocks/jobs/delete_phone_number_block", "responses": [ { "uuid": "15eeb7b6-ce8b-4b1c-a66a-7dbb03ab729c", "body": "{\n \"data\": {\n \"created_at\": \"2020-10-23T18:10:00.000Z\",\n \"etc\": \"2020-10-30T18:10:00.000Z\",\n \"failed_operations\": [],\n \"id\": \"42587e44-3a3e-46de-9255-0c9a7a1d1ec7\",\n \"record_type\": \"phone_numbers_job\",\n \"status\": \"pending\",\n \"successful_operations\": [],\n \"type\": \"delete_phone_number_block\",\n \"updated_at\": \"2020-10-23T18:10:01.000Z\"\n }\n}", "latency": 0, "statusCode": 202, "label": "Phone number blocks job delete phone numbers requested.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "88cb0e25-1b9e-47fd-8109-fa9f1ad0a8d4", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0a786dbb-4c1c-4f20-9bac-ecb8120bd28c", "documentation": "Retrieves a phone number blocks job", "method": "get", "endpoint": "phone_number_blocks/jobs/:id", "responses": [ { "uuid": "2bf5b856-d5f3-40ec-ad67-b5f0f381a8c2", "body": "{\n \"data\": {\n \"created_at\": \"2020-10-23T18:10:00.000Z\",\n \"etc\": \"2020-10-30T18:10:00.000Z\",\n \"failed_operations\": [],\n \"id\": \"42587e44-3a3e-46de-9255-0c9a7a1d1ec7\",\n \"record_type\": \"phone_numbers_job\",\n \"status\": \"pending\",\n \"successful_operations\": [],\n \"type\": \"delete_phone_number_block\",\n \"updated_at\": \"2020-10-23T18:10:01.000Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Phone number blocks job details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c4198bea-b368-4dfb-a2b2-8ce42d3637b2", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "3c3a9e36-ebe8-4aab-86c1-5c69a9799d81", "documentation": "List phone numbers", "method": "get", "endpoint": "phone_numbers", "responses": [ { "uuid": "24b6560f-a0bc-4ac6-8924-1cf9e7217b49", "body": "{\n \"data\": [\n {\n \"billing_group_id\": \"86f58db9-0fe3-4adc-9d1f-46e66e6e9323\",\n \"call_forwarding_enabled\": true,\n \"call_recording_enabled\": true,\n \"caller_id_name_enabled\": true,\n \"cnam_listing_enabled\": true,\n \"connection_id\": \"1293384261075731499\",\n \"connection_name\": \"connection-name\",\n \"created_at\": \"2019-10-23T18:10:00.000Z\",\n \"customer_reference\": \"customer-reference\",\n \"emergency_address_id\": \"1315261609962112019\",\n \"emergency_enabled\": true,\n \"external_pin\": \"1234\",\n \"id\": \"1293384261075731499\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600000000\",\n \"messaging_profile_name\": \"regional-customers\",\n \"number_level_routing\": \"disabled\",\n \"phone_number\": \"+19705555098\",\n \"phone_number_type\": \"longcode\",\n \"purchased_at\": \"2019-10-23T18:10:00.000Z\",\n \"record_type\": \"phone_number\",\n \"status\": \"active\",\n \"t38_fax_gateway_enabled\": true,\n \"tags\": [\n \"tag_1\",\n \"tag_2\"\n ],\n \"updated_at\": \"2019-10-24T18:10:00.000Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of phone numbers.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "58967eba-3981-4cf5-b5ef-4c1bc3a4c034", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "3ba61de7-8e74-42ea-9625-5121b9e1aaa7", "documentation": "List CSV downloads", "method": "get", "endpoint": "phone_numbers/csv_downloads", "responses": [ { "uuid": "b98afb98-c748-47e6-b81f-acc724f247c3", "body": "{\n \"data\": [\n {\n \"id\": \"42587e44-3a3e-46de-9255-0c9a7a1d1ec7\",\n \"record_type\": \"csv_download\",\n \"status\": \"pending\",\n \"url\": \"https://www.telnyx.com/sample/42587e44-3a3e-46de-9255-0c9a7a1d1ec7\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of CSV downloads.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "803217a0-2566-4dc1-bd15-974ffcf4d3bf", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "dbd07a5a-9837-452a-99f1-2b16246bbf42", "documentation": "Create a CSV download", "method": "post", "endpoint": "phone_numbers/csv_downloads", "responses": [ { "uuid": "ba0062c5-db68-4d72-b9c8-6c16a325f8dd", "body": "{\n \"data\": [\n {\n \"id\": \"42587e44-3a3e-46de-9255-0c9a7a1d1ec7\",\n \"record_type\": \"csv_download\",\n \"status\": \"pending\",\n \"url\": \"https://www.telnyx.com/sample/42587e44-3a3e-46de-9255-0c9a7a1d1ec7\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a CSV download.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2ef4a223-312c-4916-a24e-8b71dd1b043c", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5d7fefde-49f6-452c-a754-2701bdfd2eb7", "documentation": "Retrieve a CSV download", "method": "get", "endpoint": "phone_numbers/csv_downloads/:id", "responses": [ { "uuid": "20d96647-7bd3-4367-bf94-9fe05b9d71e8", "body": "{\n \"data\": [\n {\n \"id\": \"42587e44-3a3e-46de-9255-0c9a7a1d1ec7\",\n \"record_type\": \"csv_download\",\n \"status\": \"pending\",\n \"url\": \"https://www.telnyx.com/sample/42587e44-3a3e-46de-9255-0c9a7a1d1ec7\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a CSV download.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e3244f01-a44d-4b72-877c-f7042e9aa9ff", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "db20a758-e855-4fdc-873a-77e7c1a26d5f", "documentation": "Retrieve your inbound channels", "method": "get", "endpoint": "phone_numbers/inbound_channels", "responses": [ { "uuid": "b05dd6b4-066a-45b3-a5d7-a30eda515c8b", "body": "{\n \"data\": {\n \"channels\": 7,\n \"record_type\": \"inbound_channels\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Inbound Channels Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "de693e8e-43a2-47e1-a8c6-622dba809c02", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "cf64ff31-ff55-432d-b907-b00d98fedaa2", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "33fe8adb-249c-444a-8506-51869efca4d4", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "1fcd9739-1f34-467b-973b-582a2d563c0a", "documentation": "Update inbound channels", "method": "patch", "endpoint": "phone_numbers/inbound_channels", "responses": [ { "uuid": "5c89bb2c-38d9-48c8-a4d3-1c1624aeed25", "body": "{\n \"data\": {\n \"channels\": 7,\n \"record_type\": \"inbound_channels\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Expected Update response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "59ae7d75-8d3e-43e8-9b90-5776e1e31b48", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5d057edb-6375-47f9-a0f2-1397e44ae722", "documentation": "Lists the phone numbers jobs", "method": "get", "endpoint": "phone_numbers/jobs", "responses": [ { "uuid": "51e678b4-b127-420d-8d19-e1397ba500b0", "body": "{\n \"data\": [\n {\n \"created_at\": \"2020-10-23T18:10:00.000Z\",\n \"etc\": \"2020-10-30T18:10:00.000Z\",\n \"failed_operations\": [\n {\n \"errors\": [\n {\n \"code\": \"10015\",\n \"detail\": \"The field is invalid.\",\n \"source\": \"/emergency_address_id\",\n \"title\": \"Bad Request\"\n }\n ],\n \"id\": \"3388768018273\",\n \"phone_number\": \"+19705551234\"\n }\n ],\n \"id\": \"42587e44-3a3e-46de-9255-0c9a7a1d1ec7\",\n \"pending_operations\": [\n {\n \"id\": \"2637816387126861837\",\n \"phone_number\": \"+19705555099\"\n }\n ],\n \"record_type\": \"phone_numbers_job\",\n \"status\": \"pending\",\n \"successful_operations\": [\n {\n \"id\": \"2637816387126861836\",\n \"phone_number\": \"+19705555098\"\n },\n {\n \"id\": \"33081887126861836\",\n \"phone_number\": \"+19715555098\"\n }\n ],\n \"type\": \"update_emergency_settings\",\n \"updated_at\": \"2020-10-23T18:10:01.000Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of phone numbers background jobs.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e7c71d81-5b7c-417c-85b3-05ff1d690587", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "240c592f-f1ea-497d-a06d-b53f88112b66", "documentation": "Delete a batch of numbers", "method": "post", "endpoint": "phone_numbers/jobs/delete_phone_numbers", "responses": [ { "uuid": "3e825526-7e90-448c-a668-73aab97bca8f", "body": "{\n \"data\": {\n \"created_at\": \"2020-10-23T18:10:00.000Z\",\n \"etc\": \"2020-10-30T18:10:00.000Z\",\n \"failed_operations\": [\n {\n \"errors\": [\n {\n \"code\": \"10015\",\n \"detail\": \"The field is invalid.\",\n \"source\": \"/emergency_address_id\",\n \"title\": \"Bad Request\"\n }\n ],\n \"id\": \"3388768018273\",\n \"phone_number\": \"+19705551234\"\n }\n ],\n \"id\": \"42587e44-3a3e-46de-9255-0c9a7a1d1ec7\",\n \"pending_operations\": [\n {\n \"id\": \"2637816387126861837\",\n \"phone_number\": \"+19705555099\"\n }\n ],\n \"record_type\": \"phone_numbers_job\",\n \"status\": \"pending\",\n \"successful_operations\": [\n {\n \"id\": \"2637816387126861836\",\n \"phone_number\": \"+19705555098\"\n },\n {\n \"id\": \"33081887126861836\",\n \"phone_number\": \"+19715555098\"\n }\n ],\n \"type\": \"update_emergency_settings\",\n \"updated_at\": \"2020-10-23T18:10:01.000Z\"\n }\n}", "latency": 0, "statusCode": 202, "label": "Phone numbers job delete phone numbers requested.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6f025ff6-e913-40e7-af48-7f957f8b3018", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f392ed61-7143-49e5-a43b-f9cf8f8d2274", "documentation": "Update the emergency settings from a batch of numbers", "method": "post", "endpoint": "phone_numbers/jobs/update_emergency_settings", "responses": [ { "uuid": "84d08864-e14e-4d30-9460-de1347b3faba", "body": "{\n \"data\": {\n \"created_at\": \"2020-10-23T18:10:00.000Z\",\n \"etc\": \"2020-10-30T18:10:00.000Z\",\n \"failed_operations\": [\n {\n \"errors\": [\n {\n \"code\": \"10015\",\n \"detail\": \"The field is invalid.\",\n \"source\": \"/emergency_address_id\",\n \"title\": \"Bad Request\"\n }\n ],\n \"id\": \"3388768018273\",\n \"phone_number\": \"+19705551234\"\n }\n ],\n \"id\": \"42587e44-3a3e-46de-9255-0c9a7a1d1ec7\",\n \"pending_operations\": [\n {\n \"id\": \"2637816387126861837\",\n \"phone_number\": \"+19705555099\"\n }\n ],\n \"record_type\": \"phone_numbers_job\",\n \"status\": \"pending\",\n \"successful_operations\": [\n {\n \"id\": \"2637816387126861836\",\n \"phone_number\": \"+19705555098\"\n },\n {\n \"id\": \"33081887126861836\",\n \"phone_number\": \"+19715555098\"\n }\n ],\n \"type\": \"update_emergency_settings\",\n \"updated_at\": \"2020-10-23T18:10:01.000Z\"\n }\n}", "latency": 0, "statusCode": 202, "label": "Phone numbers enable emergency requested.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "34ec3ed7-6e0a-434b-be21-bfd4ad4e04b3", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5d8e86cf-71e3-4c7c-ba16-4333ba0170e5", "documentation": "Update a batch of numbers", "method": "post", "endpoint": "phone_numbers/jobs/update_phone_numbers", "responses": [ { "uuid": "c5f63671-03af-4ee8-b8ce-a9702f7f11a2", "body": "{\n \"data\": {\n \"created_at\": \"2020-10-23T18:10:00.000Z\",\n \"etc\": \"2020-10-30T18:10:00.000Z\",\n \"failed_operations\": [\n {\n \"errors\": [\n {\n \"code\": \"10015\",\n \"detail\": \"The field is invalid.\",\n \"source\": \"/emergency_address_id\",\n \"title\": \"Bad Request\"\n }\n ],\n \"id\": \"3388768018273\",\n \"phone_number\": \"+19705551234\"\n }\n ],\n \"id\": \"42587e44-3a3e-46de-9255-0c9a7a1d1ec7\",\n \"pending_operations\": [\n {\n \"id\": \"2637816387126861837\",\n \"phone_number\": \"+19705555099\"\n }\n ],\n \"record_type\": \"phone_numbers_job\",\n \"status\": \"pending\",\n \"successful_operations\": [\n {\n \"id\": \"2637816387126861836\",\n \"phone_number\": \"+19705555098\"\n },\n {\n \"id\": \"33081887126861836\",\n \"phone_number\": \"+19715555098\"\n }\n ],\n \"type\": \"update_emergency_settings\",\n \"updated_at\": \"2020-10-23T18:10:01.000Z\"\n }\n}", "latency": 0, "statusCode": 202, "label": "Phone numbers job update phone numbers requested.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3eb689c6-0cc8-47da-9822-25a5e09778d5", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "1f0d925f-ad56-41ec-a06d-d145694d45e3", "documentation": "Retrieve a phone numbers job", "method": "get", "endpoint": "phone_numbers/jobs/:id", "responses": [ { "uuid": "f7e2e736-5ff2-4ab8-8629-81321bc0cd57", "body": "{\n \"data\": {\n \"created_at\": \"2020-10-23T18:10:00.000Z\",\n \"etc\": \"2020-10-30T18:10:00.000Z\",\n \"failed_operations\": [\n {\n \"errors\": [\n {\n \"code\": \"10015\",\n \"detail\": \"The field is invalid.\",\n \"source\": \"/emergency_address_id\",\n \"title\": \"Bad Request\"\n }\n ],\n \"id\": \"3388768018273\",\n \"phone_number\": \"+19705551234\"\n }\n ],\n \"id\": \"42587e44-3a3e-46de-9255-0c9a7a1d1ec7\",\n \"pending_operations\": [\n {\n \"id\": \"2637816387126861837\",\n \"phone_number\": \"+19705555099\"\n }\n ],\n \"record_type\": \"phone_numbers_job\",\n \"status\": \"pending\",\n \"successful_operations\": [\n {\n \"id\": \"2637816387126861836\",\n \"phone_number\": \"+19705555098\"\n },\n {\n \"id\": \"33081887126861836\",\n \"phone_number\": \"+19715555098\"\n }\n ],\n \"type\": \"update_emergency_settings\",\n \"updated_at\": \"2020-10-23T18:10:01.000Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Phone numbers job details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "965fbe23-c779-4bd2-82e5-733d2646fd5a", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "6f5023cb-9e38-48ba-bcdf-f4af881a7edf", "documentation": "List phone numbers with messaging settings", "method": "get", "endpoint": "phone_numbers/messaging", "responses": [ { "uuid": "52a60af9-7d7e-4253-a5ba-7cdce3b6b289", "body": "{\n \"data\": [\n {\n \"country_code\": \"US\",\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"eligible_messaging_products\": [\n \"A2P\"\n ],\n \"features\": {\n \"mms\": null,\n \"sms\": {\n \"domestic_two_way\": true,\n \"international_inbound\": true,\n \"international_outbound\": true\n }\n },\n \"health\": {\n \"inbound_outbound_ratio\": 0.43,\n \"message_count\": 122,\n \"spam_ratio\": 0.06,\n \"success_ratio\": 0.94\n },\n \"id\": \"1293384261075731499\",\n \"messaging_product\": \"A2P\",\n \"messaging_profile_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"phone_number\": \"+18005550001\",\n \"record_type\": \"messaging_settings\",\n \"traffic_type\": \"A2P\",\n \"type\": \"toll-free\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of phone numbers with messaging settings.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "fa7d2364-c07f-492e-912a-ad0a8a1fff13", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "80a5cc4f-002c-4bad-882f-033a05b72919", "documentation": "List phone numbers with voice settings", "method": "get", "endpoint": "phone_numbers/voice", "responses": [ { "uuid": "f6e2f3ba-94be-4346-a33e-8fbd453f89fb", "body": "{\n \"data\": [\n {\n \"call_forwarding\": {\n \"call_forwarding_enabled\": true,\n \"forwarding_type\": \"always\",\n \"forwards_to\": \"+13035559123\"\n },\n \"call_recording\": {\n \"inbound_call_recording_channels\": \"single\",\n \"inbound_call_recording_enabled\": true,\n \"inbound_call_recording_format\": \"wav\"\n },\n \"cnam_listing\": {\n \"cnam_listing_details\": \"example\",\n \"cnam_listing_enabled\": true\n },\n \"connection_id\": \"1d0e6cb8-8668-462e-94c6-49ae0f0ed48b\",\n \"customer_reference\": \"customer-reference\",\n \"emergency\": {\n \"emergency_address_id\": \"1315261609962112019\",\n \"emergency_enabled\": true\n },\n \"id\": \"1293384261075731499\",\n \"media_features\": {\n \"accept_any_rtp_packets_enabled\": true,\n \"media_handling_mode\": \"default\",\n \"rtp_auto_adjust_enabled\": true,\n \"t38_fax_gateway_enabled\": true\n },\n \"record_type\": \"voice_settings\",\n \"tech_prefix_enabled\": false,\n \"translated_number\": \"+13035559999\",\n \"usage_payment_method\": \"pay-per-minute\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of phone numbers with voice settings.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "39a9d27c-b116-406d-9d05-ed4868b1c6d1", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "19ce7868-dca8-4017-bf15-594cae612f08", "documentation": "Delete a phone number", "method": "delete", "endpoint": "phone_numbers/:id", "responses": [ { "uuid": "9e368fe4-8a02-4975-b4a4-5b97b6ba4fca", "body": "{\n \"data\": {\n \"billing_group_id\": \"86f58db9-0fe3-4adc-9d1f-46e66e6e9323\",\n \"call_forwarding_enabled\": true,\n \"call_recording_enabled\": true,\n \"caller_id_name_enabled\": true,\n \"cnam_listing_enabled\": true,\n \"connection_id\": \"1293384261075731499\",\n \"connection_name\": \"connection-name\",\n \"created_at\": \"2019-10-23T18:10:00.000Z\",\n \"customer_reference\": \"customer-reference\",\n \"emergency_address_id\": \"1315261609962112019\",\n \"emergency_enabled\": true,\n \"external_pin\": \"1234\",\n \"id\": \"1293384261075731499\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600000000\",\n \"messaging_profile_name\": \"regional-customers\",\n \"number_level_routing\": \"disabled\",\n \"phone_number\": \"+19705555098\",\n \"phone_number_type\": \"longcode\",\n \"purchased_at\": \"2019-10-23T18:10:00.000Z\",\n \"record_type\": \"phone_number\",\n \"status\": \"deleted\",\n \"t38_fax_gateway_enabled\": true,\n \"tags\": [\n \"tag_1\",\n \"tag_2\"\n ],\n \"updated_at\": \"2019-10-24T18:10:00.000Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a phone number.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "323d0115-999e-4242-9fb1-1a9f56a64b87", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "4805fa2e-bfb8-4176-b5f7-2c9b826ac0f8", "documentation": "Retrieve a phone number", "method": "get", "endpoint": "phone_numbers/:id", "responses": [ { "uuid": "6113d91a-1604-493e-9afb-cbb3b99b8418", "body": "{\n \"data\": {\n \"billing_group_id\": \"86f58db9-0fe3-4adc-9d1f-46e66e6e9323\",\n \"call_forwarding_enabled\": true,\n \"call_recording_enabled\": true,\n \"caller_id_name_enabled\": true,\n \"cnam_listing_enabled\": true,\n \"connection_id\": \"1293384261075731499\",\n \"connection_name\": \"connection-name\",\n \"created_at\": \"2019-10-23T18:10:00.000Z\",\n \"customer_reference\": \"customer-reference\",\n \"emergency_address_id\": \"1315261609962112019\",\n \"emergency_enabled\": true,\n \"external_pin\": \"1234\",\n \"id\": \"1293384261075731499\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600000000\",\n \"messaging_profile_name\": \"regional-customers\",\n \"number_level_routing\": \"disabled\",\n \"phone_number\": \"+19705555098\",\n \"phone_number_type\": \"longcode\",\n \"purchased_at\": \"2019-10-23T18:10:00.000Z\",\n \"record_type\": \"phone_number\",\n \"status\": \"active\",\n \"t38_fax_gateway_enabled\": true,\n \"tags\": [\n \"tag_1\",\n \"tag_2\"\n ],\n \"updated_at\": \"2019-10-24T18:10:00.000Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a phone number.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "af918610-17a5-42a4-8977-d2f105fb9d87", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "dd4bc402-e0a1-43e4-829b-4060800f887a", "documentation": "Update a phone number", "method": "patch", "endpoint": "phone_numbers/:id", "responses": [ { "uuid": "959b186d-f834-449f-a8f6-7d0027e5bab1", "body": "{\n \"data\": {\n \"billing_group_id\": \"86f58db9-0fe3-4adc-9d1f-46e66e6e9323\",\n \"call_forwarding_enabled\": true,\n \"call_recording_enabled\": true,\n \"caller_id_name_enabled\": true,\n \"cnam_listing_enabled\": true,\n \"connection_id\": \"1293384261075731499\",\n \"connection_name\": \"connection-name\",\n \"created_at\": \"2019-10-23T18:10:00.000Z\",\n \"customer_reference\": \"customer-reference\",\n \"emergency_address_id\": \"1315261609962112019\",\n \"emergency_enabled\": true,\n \"external_pin\": \"1234\",\n \"id\": \"1293384261075731499\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600000000\",\n \"messaging_profile_name\": \"regional-customers\",\n \"number_level_routing\": \"disabled\",\n \"phone_number\": \"+19705555098\",\n \"phone_number_type\": \"longcode\",\n \"purchased_at\": \"2019-10-23T18:10:00.000Z\",\n \"record_type\": \"phone_number\",\n \"status\": \"active\",\n \"t38_fax_gateway_enabled\": true,\n \"tags\": [\n \"tag_1\",\n \"tag_2\"\n ],\n \"updated_at\": \"2019-10-24T18:10:00.000Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a phone number.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "1f984847-c838-447e-bf24-e0cb169160b9", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "724bbd23-7355-4f5d-8f7b-5730148c6dbb", "documentation": "Enable emergency for a phone number", "method": "post", "endpoint": "phone_numbers/:id/actions/enable_emergency", "responses": [ { "uuid": "4218162c-5887-4f6d-9669-77f29a002425", "body": "{\n \"data\": {\n \"call_forwarding\": {\n \"call_forwarding_enabled\": true,\n \"forwarding_type\": \"always\",\n \"forwards_to\": \"+13035559123\"\n },\n \"call_recording\": {\n \"inbound_call_recording_channels\": \"single\",\n \"inbound_call_recording_enabled\": true,\n \"inbound_call_recording_format\": \"wav\"\n },\n \"cnam_listing\": {\n \"cnam_listing_details\": \"example\",\n \"cnam_listing_enabled\": true\n },\n \"connection_id\": \"1d0e6cb8-8668-462e-94c6-49ae0f0ed48b\",\n \"customer_reference\": \"customer-reference\",\n \"emergency\": {\n \"emergency_address_id\": \"1315261609962112019\",\n \"emergency_enabled\": true\n },\n \"id\": \"1293384261075731499\",\n \"media_features\": {\n \"accept_any_rtp_packets_enabled\": true,\n \"media_handling_mode\": \"default\",\n \"rtp_auto_adjust_enabled\": true,\n \"t38_fax_gateway_enabled\": true\n },\n \"record_type\": \"voice_settings\",\n \"tech_prefix_enabled\": false,\n \"translated_number\": \"+13035559999\",\n \"usage_payment_method\": \"pay-per-minute\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Phone number emergency enabled.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "88f18db9-c8c1-4095-a8ea-35c885aa3693", "body": "{\n \"data\": {\n \"call_forwarding\": {\n \"call_forwarding_enabled\": true,\n \"forwarding_type\": \"always\",\n \"forwards_to\": \"+13035559123\"\n },\n \"call_recording\": {\n \"inbound_call_recording_channels\": \"single\",\n \"inbound_call_recording_enabled\": true,\n \"inbound_call_recording_format\": \"wav\"\n },\n \"cnam_listing\": {\n \"cnam_listing_details\": \"example\",\n \"cnam_listing_enabled\": true\n },\n \"connection_id\": \"1d0e6cb8-8668-462e-94c6-49ae0f0ed48b\",\n \"customer_reference\": \"customer-reference\",\n \"emergency\": {\n \"emergency_address_id\": \"1315261609962112019\",\n \"emergency_enabled\": true\n },\n \"id\": \"1293384261075731499\",\n \"media_features\": {\n \"accept_any_rtp_packets_enabled\": true,\n \"media_handling_mode\": \"default\",\n \"rtp_auto_adjust_enabled\": true,\n \"t38_fax_gateway_enabled\": true\n },\n \"record_type\": \"voice_settings\",\n \"tech_prefix_enabled\": false,\n \"translated_number\": \"+13035559999\",\n \"usage_payment_method\": \"pay-per-minute\"\n }\n}", "latency": 0, "statusCode": 202, "label": "Phone number emergency requested.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c6099a7b-cb25-47d8-9cfa-1108e620877d", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f942f1ae-9bb6-4a87-b8ad-a68ed7154a48", "documentation": "Retrieve a phone number with messaging settings", "method": "get", "endpoint": "phone_numbers/:id/messaging", "responses": [ { "uuid": "5e2943e1-4391-4daa-bdfb-a4d14fa0c334", "body": "{\n \"data\": {\n \"country_code\": \"US\",\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"eligible_messaging_products\": [\n \"A2P\"\n ],\n \"features\": {\n \"mms\": null,\n \"sms\": {\n \"domestic_two_way\": true,\n \"international_inbound\": true,\n \"international_outbound\": true\n }\n },\n \"health\": {\n \"inbound_outbound_ratio\": 0.43,\n \"message_count\": 122,\n \"spam_ratio\": 0.06,\n \"success_ratio\": 0.94\n },\n \"id\": \"1293384261075731499\",\n \"messaging_product\": \"A2P\",\n \"messaging_profile_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"phone_number\": \"+18005550001\",\n \"record_type\": \"messaging_settings\",\n \"traffic_type\": \"A2P\",\n \"type\": \"toll-free\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a phone number including voice settings.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "9158addf-f6fa-4ae0-bcc1-9d23b626173b", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0b715e3a-9128-4bed-a1ac-a883ff0c55ed", "documentation": "Update a phone number with messaging settings", "method": "patch", "endpoint": "phone_numbers/:id/messaging", "responses": [ { "uuid": "aa95cae6-c700-4acc-9f23-3d4bf92c0195", "body": "{\n \"data\": {\n \"country_code\": \"US\",\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"eligible_messaging_products\": [\n \"A2P\"\n ],\n \"features\": {\n \"mms\": null,\n \"sms\": {\n \"domestic_two_way\": true,\n \"international_inbound\": true,\n \"international_outbound\": true\n }\n },\n \"health\": {\n \"inbound_outbound_ratio\": 0.43,\n \"message_count\": 122,\n \"spam_ratio\": 0.06,\n \"success_ratio\": 0.94\n },\n \"id\": \"1293384261075731499\",\n \"messaging_product\": \"A2P\",\n \"messaging_profile_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"phone_number\": \"+18005550001\",\n \"record_type\": \"messaging_settings\",\n \"traffic_type\": \"A2P\",\n \"type\": \"toll-free\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a phone number including voice settings.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "5411e7a1-4007-41ed-ba4b-208575fe9df1", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a78a823c-e7da-4835-a576-9b0fecf32b0a", "documentation": "Retrieve a phone number with voice settings", "method": "get", "endpoint": "phone_numbers/:id/voice", "responses": [ { "uuid": "dd4e7248-62a5-4b25-9684-714f14236397", "body": "{\n \"data\": {\n \"call_forwarding\": {\n \"call_forwarding_enabled\": true,\n \"forwarding_type\": \"always\",\n \"forwards_to\": \"+13035559123\"\n },\n \"call_recording\": {\n \"inbound_call_recording_channels\": \"single\",\n \"inbound_call_recording_enabled\": true,\n \"inbound_call_recording_format\": \"wav\"\n },\n \"cnam_listing\": {\n \"cnam_listing_details\": \"example\",\n \"cnam_listing_enabled\": true\n },\n \"connection_id\": \"1d0e6cb8-8668-462e-94c6-49ae0f0ed48b\",\n \"customer_reference\": \"customer-reference\",\n \"emergency\": {\n \"emergency_address_id\": \"1315261609962112019\",\n \"emergency_enabled\": true\n },\n \"id\": \"1293384261075731499\",\n \"media_features\": {\n \"accept_any_rtp_packets_enabled\": true,\n \"media_handling_mode\": \"default\",\n \"rtp_auto_adjust_enabled\": true,\n \"t38_fax_gateway_enabled\": true\n },\n \"record_type\": \"voice_settings\",\n \"tech_prefix_enabled\": false,\n \"translated_number\": \"+13035559999\",\n \"usage_payment_method\": \"pay-per-minute\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a phone number including voice settings.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "5c550695-dc14-44ed-b486-0742e95d0ae2", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "bff99241-a443-4af8-882f-ebab3ab32a60", "documentation": "Update a phone number with voice settings", "method": "patch", "endpoint": "phone_numbers/:id/voice", "responses": [ { "uuid": "c606f486-4e07-4b3d-b15f-694731933132", "body": "{\n \"data\": {\n \"call_forwarding\": {\n \"call_forwarding_enabled\": true,\n \"forwarding_type\": \"always\",\n \"forwards_to\": \"+13035559123\"\n },\n \"call_recording\": {\n \"inbound_call_recording_channels\": \"single\",\n \"inbound_call_recording_enabled\": true,\n \"inbound_call_recording_format\": \"wav\"\n },\n \"cnam_listing\": {\n \"cnam_listing_details\": \"example\",\n \"cnam_listing_enabled\": true\n },\n \"connection_id\": \"1d0e6cb8-8668-462e-94c6-49ae0f0ed48b\",\n \"customer_reference\": \"customer-reference\",\n \"emergency\": {\n \"emergency_address_id\": \"1315261609962112019\",\n \"emergency_enabled\": true\n },\n \"id\": \"1293384261075731499\",\n \"media_features\": {\n \"accept_any_rtp_packets_enabled\": true,\n \"media_handling_mode\": \"default\",\n \"rtp_auto_adjust_enabled\": true,\n \"t38_fax_gateway_enabled\": true\n },\n \"record_type\": \"voice_settings\",\n \"tech_prefix_enabled\": false,\n \"translated_number\": \"+13035559999\",\n \"usage_payment_method\": \"pay-per-minute\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a phone number including voice settings.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "47090702-01cf-4282-8db4-e93c971e0220", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e4583653-fdf8-4dbd-b881-96368c10ceb4", "documentation": "Run a portability check", "method": "post", "endpoint": "portability_checks", "responses": [ { "uuid": "63b20519-af92-42db-9288-062d0f5ae8fc", "body": "{\n \"data\": [\n {\n \"fast_portable\": true,\n \"not_portable_reason\": \"No coverage\",\n \"phone_number\": \"+13125550123\",\n \"portable\": true,\n \"record_type\": \"portability_check_result\"\n }\n ]\n}", "latency": 0, "statusCode": 201, "label": "PortabilityCheck Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a1ac048e-9a3d-4998-94c9-a6a6a9c63135", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0898f0fa-08d1-49e5-8795-a6fc5763b0f2", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d619dd6d-2cad-4c91-be36-af60e3d7d04a", "documentation": "List all porting orders", "method": "get", "endpoint": "porting_orders", "responses": [ { "uuid": "b9375cc3-bcca-4d88-9a5c-0639fb5d70fb", "body": "{\n \"data\": [\n {\n \"activation_settings\": {\n \"activation_status\": \"{{oneOf (array 'New' 'Pending' 'Conflict' 'Cancel Pending' 'Failed' 'Concurred' 'Activate RDY' 'Disconnect Pending' 'Concurrence Sent' 'Old' 'Sending' 'Active' 'Canceled')}}\",\n \"fast_port_eligible\": true,\n \"foc_datetime_actual\": \"2021-03-19T10:07:15.527Z\",\n \"foc_datetime_requested\": \"2021-03-19T10:07:15.527Z\"\n },\n \"created_at\": \"2021-03-19T10:07:15.527Z\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"123abc\",\n \"auth_person_name\": \"Porter McPortersen II\",\n \"billing_phone_number\": 13035551234,\n \"business_identifier\": \"abc123\",\n \"entity_name\": \"Porter McPortersen\",\n \"pin_passcode\": 1234,\n \"tax_identifier\": \"1234abcd\"\n },\n \"location\": {\n \"administrative_area\": \"IL\",\n \"country_code\": \"US\",\n \"extended_address\": \"Suite 504\",\n \"locality\": \"Chicago\",\n \"postal_code\": 60654,\n \"street_address\": \"311 W. Superior St\"\n }\n },\n \"id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"{{oneOf (array 'keep' 'disconnect')}}\",\n \"type\": \"{{oneOf (array 'full' 'partial')}}\"\n },\n \"old_service_provider_ocn\": \"Unreal Communications\",\n \"phone_number_configuration\": {\n \"connection_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"emergency_address_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"messaging_profile_id\": \"f1486bae-f067-460c-ad43-73a92848f901\",\n \"tags\": [\n \"abc\",\n \"123\"\n ]\n },\n \"porting_phone_numbers_count\": 1,\n \"record_type\": \"porting_order\",\n \"requirements\": [\n {\n \"field_type\": \"{{oneOf (array 'document')}}\",\n \"field_value\": \"9787fb5f-cbe5-4de4-b765-3303774ee9fe\",\n \"record_type\": \"porting_requirement\",\n \"requirement_type_id\": \"59b0762a-b274-4f76-ac32-4d5cf0272e66\"\n }\n ],\n \"status\": {\n \"details\": [\n {\n \"code\": \"{{oneOf (array 'ACCOUNT_NUMBER_MISMATCH' 'AUTH_PERSON_MISMATCH' 'BTN_ATN_MISMATCH' 'ENTITY_NAME_MISMATCH' 'FOC_EXPIRED' 'FOC_REJECTED' 'LOCATION_MISMATCH' 'LSR_PENDING' 'MAIN_BTN_PORTING' 'OSP_IRRESPONSIVE' 'OTHER' 'PASSCODE_PIN_INVALID' 'PHONE_NUMBER_HAS_SPECIAL_FEATURE' 'PHONE_NUMBER_MISMATCH' 'PHONE_NUMBER_NOT_PORTABLE' 'PORT_TYPE_INCORRECT' 'PORTING_ORDER_SPLIT_REQUIRED' 'PORTING_ORDER_SPLIT_REQUIRED' 'POSTAL_CODE_MISMATCH' 'RATE_CENTER_NOT_PORTABLE' 'SV_CONFLICT' 'SV_UNKNOWN_FAILURE')}}\",\n \"description\": \"Entity name does not match that on the CSR\"\n }\n ],\n \"value\": \"{{oneOf (array 'draft' 'in-process' 'submitted' 'exception' 'foc-date-confirmed' 'ported' 'canceled' 'cancel-pending')}}\"\n },\n \"support_key\": \"123abc\",\n \"updated_at\": \"2021-03-19T10:07:15.527Z\",\n \"user_feedback\": {\n \"user_comment\": \"I loved my experience porting numbers with Telnyx\",\n \"user_rating\": 5\n },\n \"user_reference\": \"Acct 123abc\",\n \"webhook_url\": \"https://example.com/porting_webhooks\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "1d64697d-438a-4cf6-8c9a-0eb4c10b70c3", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "91e8afbe-1af9-47d2-9164-301ebbb018f6", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "cb805371-801e-4d69-ba43-93ae2cbcd947", "documentation": "Create a porting order", "method": "post", "endpoint": "porting_orders", "responses": [ { "uuid": "9f09d4e6-66e1-4a31-905d-7f05e08a78b1", "body": "{\n \"data\": [\n {\n \"activation_settings\": {\n \"activation_status\": \"{{oneOf (array 'New' 'Pending' 'Conflict' 'Cancel Pending' 'Failed' 'Concurred' 'Activate RDY' 'Disconnect Pending' 'Concurrence Sent' 'Old' 'Sending' 'Active' 'Canceled')}}\",\n \"fast_port_eligible\": true,\n \"foc_datetime_actual\": \"2021-03-19T10:07:15.527Z\",\n \"foc_datetime_requested\": \"2021-03-19T10:07:15.527Z\"\n },\n \"created_at\": \"2021-03-19T10:07:15.527Z\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"123abc\",\n \"auth_person_name\": \"Porter McPortersen II\",\n \"billing_phone_number\": 13035551234,\n \"business_identifier\": \"abc123\",\n \"entity_name\": \"Porter McPortersen\",\n \"pin_passcode\": 1234,\n \"tax_identifier\": \"1234abcd\"\n },\n \"location\": {\n \"administrative_area\": \"IL\",\n \"country_code\": \"US\",\n \"extended_address\": \"Suite 504\",\n \"locality\": \"Chicago\",\n \"postal_code\": 60654,\n \"street_address\": \"311 W. Superior St\"\n }\n },\n \"id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"{{oneOf (array 'keep' 'disconnect')}}\",\n \"type\": \"{{oneOf (array 'full' 'partial')}}\"\n },\n \"old_service_provider_ocn\": \"Unreal Communications\",\n \"phone_number_configuration\": {\n \"connection_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"emergency_address_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"messaging_profile_id\": \"f1486bae-f067-460c-ad43-73a92848f901\",\n \"tags\": [\n \"abc\",\n \"123\"\n ]\n },\n \"porting_phone_numbers_count\": 1,\n \"record_type\": \"porting_order\",\n \"requirements\": [\n {\n \"field_type\": \"{{oneOf (array 'document')}}\",\n \"field_value\": \"9787fb5f-cbe5-4de4-b765-3303774ee9fe\",\n \"record_type\": \"porting_requirement\",\n \"requirement_type_id\": \"59b0762a-b274-4f76-ac32-4d5cf0272e66\"\n }\n ],\n \"status\": {\n \"details\": [\n {\n \"code\": \"{{oneOf (array 'ACCOUNT_NUMBER_MISMATCH' 'AUTH_PERSON_MISMATCH' 'BTN_ATN_MISMATCH' 'ENTITY_NAME_MISMATCH' 'FOC_EXPIRED' 'FOC_REJECTED' 'LOCATION_MISMATCH' 'LSR_PENDING' 'MAIN_BTN_PORTING' 'OSP_IRRESPONSIVE' 'OTHER' 'PASSCODE_PIN_INVALID' 'PHONE_NUMBER_HAS_SPECIAL_FEATURE' 'PHONE_NUMBER_MISMATCH' 'PHONE_NUMBER_NOT_PORTABLE' 'PORT_TYPE_INCORRECT' 'PORTING_ORDER_SPLIT_REQUIRED' 'PORTING_ORDER_SPLIT_REQUIRED' 'POSTAL_CODE_MISMATCH' 'RATE_CENTER_NOT_PORTABLE' 'SV_CONFLICT' 'SV_UNKNOWN_FAILURE')}}\",\n \"description\": \"Entity name does not match that on the CSR\"\n }\n ],\n \"value\": \"{{oneOf (array 'draft' 'in-process' 'submitted' 'exception' 'foc-date-confirmed' 'ported' 'canceled' 'cancel-pending')}}\"\n },\n \"support_key\": \"123abc\",\n \"updated_at\": \"2021-03-19T10:07:15.527Z\",\n \"user_feedback\": {\n \"user_comment\": \"I loved my experience porting numbers with Telnyx\",\n \"user_rating\": 5\n },\n \"user_reference\": \"Acct 123abc\",\n \"webhook_url\": \"https://example.com/porting_webhooks\"\n }\n ]\n}", "latency": 0, "statusCode": 201, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "22cf7f91-7bd4-47e9-9ce4-b862eadfad70", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2c4c30c8-d6d1-45a7-81df-b9903c939d31", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d7e76555-33ed-4c80-846d-05a35603d6df", "documentation": "List all exception types", "method": "get", "endpoint": "porting_orders/exception_types", "responses": [ { "uuid": "7bf0d911-1cbb-4a6c-bfc3-9a7176104b1c", "body": "{\n \"data\": [\n {\n \"code\": \"{{oneOf (array 'ACCOUNT_NUMBER_MISMATCH' 'AUTH_PERSON_MISMATCH' 'BTN_ATN_MISMATCH' 'ENTITY_NAME_MISMATCH' 'FOC_EXPIRED' 'FOC_REJECTED' 'LOCATION_MISMATCH' 'LSR_PENDING' 'MAIN_BTN_PORTING' 'OSP_IRRESPONSIVE' 'OTHER' 'PASSCODE_PIN_INVALID' 'PHONE_NUMBER_HAS_SPECIAL_FEATURE' 'PHONE_NUMBER_MISMATCH' 'PHONE_NUMBER_NOT_PORTABLE' 'PORT_TYPE_INCORRECT' 'PORTING_ORDER_SPLIT_REQUIRED' 'PORTING_ORDER_SPLIT_REQUIRED' 'POSTAL_CODE_MISMATCH' 'RATE_CENTER_NOT_PORTABLE' 'SV_CONFLICT' 'SV_UNKNOWN_FAILURE')}}\",\n \"description\": \"Entity name does not match that on the CSR\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a61b09c0-b320-40f9-bd40-9d29f2ed70ca", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a3eb22c1-97bb-40b9-b15d-4befce805842", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "dec33fb9-2066-401c-899d-16ed20696fcb", "documentation": "Request cancellation", "method": "delete", "endpoint": "porting_orders/:id", "responses": [ { "uuid": "524eed40-bcd7-4ea4-ab38-647f2e2a9b49", "body": "{\n \"data\": {\n \"activation_settings\": {\n \"activation_status\": \"{{oneOf (array 'New' 'Pending' 'Conflict' 'Cancel Pending' 'Failed' 'Concurred' 'Activate RDY' 'Disconnect Pending' 'Concurrence Sent' 'Old' 'Sending' 'Active' 'Canceled')}}\",\n \"fast_port_eligible\": true,\n \"foc_datetime_actual\": \"2021-03-19T10:07:15.527Z\",\n \"foc_datetime_requested\": \"2021-03-19T10:07:15.527Z\"\n },\n \"created_at\": \"2021-03-19T10:07:15.527Z\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"123abc\",\n \"auth_person_name\": \"Porter McPortersen II\",\n \"billing_phone_number\": 13035551234,\n \"business_identifier\": \"abc123\",\n \"entity_name\": \"Porter McPortersen\",\n \"pin_passcode\": 1234,\n \"tax_identifier\": \"1234abcd\"\n },\n \"location\": {\n \"administrative_area\": \"IL\",\n \"country_code\": \"US\",\n \"extended_address\": \"Suite 504\",\n \"locality\": \"Chicago\",\n \"postal_code\": 60654,\n \"street_address\": \"311 W. Superior St\"\n }\n },\n \"id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"{{oneOf (array 'keep' 'disconnect')}}\",\n \"type\": \"{{oneOf (array 'full' 'partial')}}\"\n },\n \"old_service_provider_ocn\": \"Unreal Communications\",\n \"phone_number_configuration\": {\n \"connection_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"emergency_address_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"messaging_profile_id\": \"f1486bae-f067-460c-ad43-73a92848f901\",\n \"tags\": [\n \"abc\",\n \"123\"\n ]\n },\n \"porting_phone_numbers_count\": 1,\n \"record_type\": \"porting_order\",\n \"requirements\": [\n {\n \"field_type\": \"{{oneOf (array 'document')}}\",\n \"field_value\": \"9787fb5f-cbe5-4de4-b765-3303774ee9fe\",\n \"record_type\": \"porting_requirement\",\n \"requirement_type_id\": \"59b0762a-b274-4f76-ac32-4d5cf0272e66\"\n }\n ],\n \"status\": {\n \"details\": [\n {\n \"code\": \"{{oneOf (array 'ACCOUNT_NUMBER_MISMATCH' 'AUTH_PERSON_MISMATCH' 'BTN_ATN_MISMATCH' 'ENTITY_NAME_MISMATCH' 'FOC_EXPIRED' 'FOC_REJECTED' 'LOCATION_MISMATCH' 'LSR_PENDING' 'MAIN_BTN_PORTING' 'OSP_IRRESPONSIVE' 'OTHER' 'PASSCODE_PIN_INVALID' 'PHONE_NUMBER_HAS_SPECIAL_FEATURE' 'PHONE_NUMBER_MISMATCH' 'PHONE_NUMBER_NOT_PORTABLE' 'PORT_TYPE_INCORRECT' 'PORTING_ORDER_SPLIT_REQUIRED' 'PORTING_ORDER_SPLIT_REQUIRED' 'POSTAL_CODE_MISMATCH' 'RATE_CENTER_NOT_PORTABLE' 'SV_CONFLICT' 'SV_UNKNOWN_FAILURE')}}\",\n \"description\": \"Entity name does not match that on the CSR\"\n }\n ],\n \"value\": \"{{oneOf (array 'draft' 'in-process' 'submitted' 'exception' 'foc-date-confirmed' 'ported' 'canceled' 'cancel-pending')}}\"\n },\n \"support_key\": \"123abc\",\n \"updated_at\": \"2021-03-19T10:07:15.527Z\",\n \"user_feedback\": {\n \"user_comment\": \"I loved my experience porting numbers with Telnyx\",\n \"user_rating\": 5\n },\n \"user_reference\": \"Acct 123abc\",\n \"webhook_url\": \"https://example.com/porting_webhooks\"\n },\n \"meta\": {\n \"phone_numbers_url\": \"/porting_phone_numbers?filter[porting_order_id]=a700d03c-4062-4091-8189-1b75216cf7a2\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "21568348-a774-40db-b6bb-d4bcc3f8fc07", "body": "", "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": "2dea3262-e8e4-46df-8cde-329ae5a38d11", "documentation": "Retrieve a porting order", "method": "get", "endpoint": "porting_orders/:id", "responses": [ { "uuid": "005e1d9e-84f0-461c-90fa-39f986eb7b9a", "body": "{\n \"data\": {\n \"activation_settings\": {\n \"activation_status\": \"{{oneOf (array 'New' 'Pending' 'Conflict' 'Cancel Pending' 'Failed' 'Concurred' 'Activate RDY' 'Disconnect Pending' 'Concurrence Sent' 'Old' 'Sending' 'Active' 'Canceled')}}\",\n \"fast_port_eligible\": true,\n \"foc_datetime_actual\": \"2021-03-19T10:07:15.527Z\",\n \"foc_datetime_requested\": \"2021-03-19T10:07:15.527Z\"\n },\n \"created_at\": \"2021-03-19T10:07:15.527Z\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"123abc\",\n \"auth_person_name\": \"Porter McPortersen II\",\n \"billing_phone_number\": 13035551234,\n \"business_identifier\": \"abc123\",\n \"entity_name\": \"Porter McPortersen\",\n \"pin_passcode\": 1234,\n \"tax_identifier\": \"1234abcd\"\n },\n \"location\": {\n \"administrative_area\": \"IL\",\n \"country_code\": \"US\",\n \"extended_address\": \"Suite 504\",\n \"locality\": \"Chicago\",\n \"postal_code\": 60654,\n \"street_address\": \"311 W. Superior St\"\n }\n },\n \"id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"{{oneOf (array 'keep' 'disconnect')}}\",\n \"type\": \"{{oneOf (array 'full' 'partial')}}\"\n },\n \"old_service_provider_ocn\": \"Unreal Communications\",\n \"phone_number_configuration\": {\n \"connection_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"emergency_address_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"messaging_profile_id\": \"f1486bae-f067-460c-ad43-73a92848f901\",\n \"tags\": [\n \"abc\",\n \"123\"\n ]\n },\n \"porting_phone_numbers_count\": 1,\n \"record_type\": \"porting_order\",\n \"requirements\": [\n {\n \"field_type\": \"{{oneOf (array 'document')}}\",\n \"field_value\": \"9787fb5f-cbe5-4de4-b765-3303774ee9fe\",\n \"record_type\": \"porting_requirement\",\n \"requirement_type_id\": \"59b0762a-b274-4f76-ac32-4d5cf0272e66\"\n }\n ],\n \"status\": {\n \"details\": [\n {\n \"code\": \"{{oneOf (array 'ACCOUNT_NUMBER_MISMATCH' 'AUTH_PERSON_MISMATCH' 'BTN_ATN_MISMATCH' 'ENTITY_NAME_MISMATCH' 'FOC_EXPIRED' 'FOC_REJECTED' 'LOCATION_MISMATCH' 'LSR_PENDING' 'MAIN_BTN_PORTING' 'OSP_IRRESPONSIVE' 'OTHER' 'PASSCODE_PIN_INVALID' 'PHONE_NUMBER_HAS_SPECIAL_FEATURE' 'PHONE_NUMBER_MISMATCH' 'PHONE_NUMBER_NOT_PORTABLE' 'PORT_TYPE_INCORRECT' 'PORTING_ORDER_SPLIT_REQUIRED' 'PORTING_ORDER_SPLIT_REQUIRED' 'POSTAL_CODE_MISMATCH' 'RATE_CENTER_NOT_PORTABLE' 'SV_CONFLICT' 'SV_UNKNOWN_FAILURE')}}\",\n \"description\": \"Entity name does not match that on the CSR\"\n }\n ],\n \"value\": \"{{oneOf (array 'draft' 'in-process' 'submitted' 'exception' 'foc-date-confirmed' 'ported' 'canceled' 'cancel-pending')}}\"\n },\n \"support_key\": \"123abc\",\n \"updated_at\": \"2021-03-19T10:07:15.527Z\",\n \"user_feedback\": {\n \"user_comment\": \"I loved my experience porting numbers with Telnyx\",\n \"user_rating\": 5\n },\n \"user_reference\": \"Acct 123abc\",\n \"webhook_url\": \"https://example.com/porting_webhooks\"\n },\n \"meta\": {\n \"phone_numbers_url\": \"/porting_phone_numbers?filter[porting_order_id]=a700d03c-4062-4091-8189-1b75216cf7a2\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "239916e6-690e-4c4b-b762-f71117c411de", "body": "", "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": "0c901ca5-207d-482c-9810-f2cd4002680c", "documentation": "Edit a porting order", "method": "patch", "endpoint": "porting_orders/:id", "responses": [ { "uuid": "72988f45-9d03-4ac0-b4e5-1cf7604331ed", "body": "{\n \"data\": {\n \"activation_settings\": {\n \"activation_status\": \"{{oneOf (array 'New' 'Pending' 'Conflict' 'Cancel Pending' 'Failed' 'Concurred' 'Activate RDY' 'Disconnect Pending' 'Concurrence Sent' 'Old' 'Sending' 'Active' 'Canceled')}}\",\n \"fast_port_eligible\": true,\n \"foc_datetime_actual\": \"2021-03-19T10:07:15.527Z\",\n \"foc_datetime_requested\": \"2021-03-19T10:07:15.527Z\"\n },\n \"created_at\": \"2021-03-19T10:07:15.527Z\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"123abc\",\n \"auth_person_name\": \"Porter McPortersen II\",\n \"billing_phone_number\": 13035551234,\n \"business_identifier\": \"abc123\",\n \"entity_name\": \"Porter McPortersen\",\n \"pin_passcode\": 1234,\n \"tax_identifier\": \"1234abcd\"\n },\n \"location\": {\n \"administrative_area\": \"IL\",\n \"country_code\": \"US\",\n \"extended_address\": \"Suite 504\",\n \"locality\": \"Chicago\",\n \"postal_code\": 60654,\n \"street_address\": \"311 W. Superior St\"\n }\n },\n \"id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"{{oneOf (array 'keep' 'disconnect')}}\",\n \"type\": \"{{oneOf (array 'full' 'partial')}}\"\n },\n \"old_service_provider_ocn\": \"Unreal Communications\",\n \"phone_number_configuration\": {\n \"connection_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"emergency_address_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"messaging_profile_id\": \"f1486bae-f067-460c-ad43-73a92848f901\",\n \"tags\": [\n \"abc\",\n \"123\"\n ]\n },\n \"porting_phone_numbers_count\": 1,\n \"record_type\": \"porting_order\",\n \"requirements\": [\n {\n \"field_type\": \"{{oneOf (array 'document')}}\",\n \"field_value\": \"9787fb5f-cbe5-4de4-b765-3303774ee9fe\",\n \"record_type\": \"porting_requirement\",\n \"requirement_type_id\": \"59b0762a-b274-4f76-ac32-4d5cf0272e66\"\n }\n ],\n \"status\": {\n \"details\": [\n {\n \"code\": \"{{oneOf (array 'ACCOUNT_NUMBER_MISMATCH' 'AUTH_PERSON_MISMATCH' 'BTN_ATN_MISMATCH' 'ENTITY_NAME_MISMATCH' 'FOC_EXPIRED' 'FOC_REJECTED' 'LOCATION_MISMATCH' 'LSR_PENDING' 'MAIN_BTN_PORTING' 'OSP_IRRESPONSIVE' 'OTHER' 'PASSCODE_PIN_INVALID' 'PHONE_NUMBER_HAS_SPECIAL_FEATURE' 'PHONE_NUMBER_MISMATCH' 'PHONE_NUMBER_NOT_PORTABLE' 'PORT_TYPE_INCORRECT' 'PORTING_ORDER_SPLIT_REQUIRED' 'PORTING_ORDER_SPLIT_REQUIRED' 'POSTAL_CODE_MISMATCH' 'RATE_CENTER_NOT_PORTABLE' 'SV_CONFLICT' 'SV_UNKNOWN_FAILURE')}}\",\n \"description\": \"Entity name does not match that on the CSR\"\n }\n ],\n \"value\": \"{{oneOf (array 'draft' 'in-process' 'submitted' 'exception' 'foc-date-confirmed' 'ported' 'canceled' 'cancel-pending')}}\"\n },\n \"support_key\": \"123abc\",\n \"updated_at\": \"2021-03-19T10:07:15.527Z\",\n \"user_feedback\": {\n \"user_comment\": \"I loved my experience porting numbers with Telnyx\",\n \"user_rating\": 5\n },\n \"user_reference\": \"Acct 123abc\",\n \"webhook_url\": \"https://example.com/porting_webhooks\"\n },\n \"meta\": {\n \"phone_numbers_url\": \"/porting_phone_numbers?filter[porting_order_id]=a700d03c-4062-4091-8189-1b75216cf7a2\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "8b50622d-8f17-4bc4-836d-4ffb047082e4", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "411acdcd-79d3-483a-bb03-ae7ca1f60482", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e4498841-86ff-4049-905f-dac485c95276", "documentation": "Activates every number on a porting order.", "method": "post", "endpoint": "porting_orders/:id/actions/activate", "responses": [ { "uuid": "9b39f5fc-e1f5-4e55-b621-627b35d4a6b8", "body": "{\n \"data\": {\n \"created_at\": \"2021-03-19T10:07:15.527Z\",\n \"id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"record_type\": \"porting_activation_job\",\n \"status\": \"{{oneOf (array 'created' 'in-process' 'completed' 'failed')}}\",\n \"updated_at\": \"2021-03-19T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 202, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ec7f0e29-207e-4027-add1-fe3fbc2c06a7", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2806c3de-412f-4574-acfe-d0d2858284be", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0a6ab8c0-004a-4aad-b630-b838e2c39c75", "documentation": "Cancel this porting order", "method": "post", "endpoint": "porting_orders/:id/actions/cancel", "responses": [ { "uuid": "d262e958-2539-40b4-9649-c7bb91584c01", "body": "{\n \"data\": {\n \"activation_settings\": {\n \"activation_status\": \"{{oneOf (array 'New' 'Pending' 'Conflict' 'Cancel Pending' 'Failed' 'Concurred' 'Activate RDY' 'Disconnect Pending' 'Concurrence Sent' 'Old' 'Sending' 'Active' 'Canceled')}}\",\n \"fast_port_eligible\": true,\n \"foc_datetime_actual\": \"2021-03-19T10:07:15.527Z\",\n \"foc_datetime_requested\": \"2021-03-19T10:07:15.527Z\"\n },\n \"created_at\": \"2021-03-19T10:07:15.527Z\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"123abc\",\n \"auth_person_name\": \"Porter McPortersen II\",\n \"billing_phone_number\": 13035551234,\n \"business_identifier\": \"abc123\",\n \"entity_name\": \"Porter McPortersen\",\n \"pin_passcode\": 1234,\n \"tax_identifier\": \"1234abcd\"\n },\n \"location\": {\n \"administrative_area\": \"IL\",\n \"country_code\": \"US\",\n \"extended_address\": \"Suite 504\",\n \"locality\": \"Chicago\",\n \"postal_code\": 60654,\n \"street_address\": \"311 W. Superior St\"\n }\n },\n \"id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"{{oneOf (array 'keep' 'disconnect')}}\",\n \"type\": \"{{oneOf (array 'full' 'partial')}}\"\n },\n \"old_service_provider_ocn\": \"Unreal Communications\",\n \"phone_number_configuration\": {\n \"connection_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"emergency_address_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"messaging_profile_id\": \"f1486bae-f067-460c-ad43-73a92848f901\",\n \"tags\": [\n \"abc\",\n \"123\"\n ]\n },\n \"porting_phone_numbers_count\": 1,\n \"record_type\": \"porting_order\",\n \"requirements\": [\n {\n \"field_type\": \"{{oneOf (array 'document')}}\",\n \"field_value\": \"9787fb5f-cbe5-4de4-b765-3303774ee9fe\",\n \"record_type\": \"porting_requirement\",\n \"requirement_type_id\": \"59b0762a-b274-4f76-ac32-4d5cf0272e66\"\n }\n ],\n \"status\": {\n \"details\": [\n {\n \"code\": \"{{oneOf (array 'ACCOUNT_NUMBER_MISMATCH' 'AUTH_PERSON_MISMATCH' 'BTN_ATN_MISMATCH' 'ENTITY_NAME_MISMATCH' 'FOC_EXPIRED' 'FOC_REJECTED' 'LOCATION_MISMATCH' 'LSR_PENDING' 'MAIN_BTN_PORTING' 'OSP_IRRESPONSIVE' 'OTHER' 'PASSCODE_PIN_INVALID' 'PHONE_NUMBER_HAS_SPECIAL_FEATURE' 'PHONE_NUMBER_MISMATCH' 'PHONE_NUMBER_NOT_PORTABLE' 'PORT_TYPE_INCORRECT' 'PORTING_ORDER_SPLIT_REQUIRED' 'PORTING_ORDER_SPLIT_REQUIRED' 'POSTAL_CODE_MISMATCH' 'RATE_CENTER_NOT_PORTABLE' 'SV_CONFLICT' 'SV_UNKNOWN_FAILURE')}}\",\n \"description\": \"Entity name does not match that on the CSR\"\n }\n ],\n \"value\": \"{{oneOf (array 'draft' 'in-process' 'submitted' 'exception' 'foc-date-confirmed' 'ported' 'canceled' 'cancel-pending')}}\"\n },\n \"support_key\": \"123abc\",\n \"updated_at\": \"2021-03-19T10:07:15.527Z\",\n \"user_feedback\": {\n \"user_comment\": \"I loved my experience porting numbers with Telnyx\",\n \"user_rating\": 5\n },\n \"user_reference\": \"Acct 123abc\",\n \"webhook_url\": \"https://example.com/porting_webhooks\"\n },\n \"meta\": {\n \"phone_numbers_url\": \"/porting_phone_numbers?filter[porting_order_id]=a700d03c-4062-4091-8189-1b75216cf7a2\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2b10b80c-cff4-4e9b-8fa6-f5423fe791a4", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2245e076-fc9c-4cfb-a7ce-9ac2b4b11db1", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c57fbf2c-dd29-4b41-8ea7-529379d26f48", "documentation": "Confirms the porting order is ready to be actioned.", "method": "post", "endpoint": "porting_orders/:id/actions/confirm", "responses": [ { "uuid": "a99a694e-10a5-4e08-bd15-67087b643fd2", "body": "{\n \"data\": {\n \"activation_settings\": {\n \"activation_status\": \"{{oneOf (array 'New' 'Pending' 'Conflict' 'Cancel Pending' 'Failed' 'Concurred' 'Activate RDY' 'Disconnect Pending' 'Concurrence Sent' 'Old' 'Sending' 'Active' 'Canceled')}}\",\n \"fast_port_eligible\": true,\n \"foc_datetime_actual\": \"2021-03-19T10:07:15.527Z\",\n \"foc_datetime_requested\": \"2021-03-19T10:07:15.527Z\"\n },\n \"created_at\": \"2021-03-19T10:07:15.527Z\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"123abc\",\n \"auth_person_name\": \"Porter McPortersen II\",\n \"billing_phone_number\": 13035551234,\n \"business_identifier\": \"abc123\",\n \"entity_name\": \"Porter McPortersen\",\n \"pin_passcode\": 1234,\n \"tax_identifier\": \"1234abcd\"\n },\n \"location\": {\n \"administrative_area\": \"IL\",\n \"country_code\": \"US\",\n \"extended_address\": \"Suite 504\",\n \"locality\": \"Chicago\",\n \"postal_code\": 60654,\n \"street_address\": \"311 W. Superior St\"\n }\n },\n \"id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"{{oneOf (array 'keep' 'disconnect')}}\",\n \"type\": \"{{oneOf (array 'full' 'partial')}}\"\n },\n \"old_service_provider_ocn\": \"Unreal Communications\",\n \"phone_number_configuration\": {\n \"connection_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"emergency_address_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"messaging_profile_id\": \"f1486bae-f067-460c-ad43-73a92848f901\",\n \"tags\": [\n \"abc\",\n \"123\"\n ]\n },\n \"porting_phone_numbers_count\": 1,\n \"record_type\": \"porting_order\",\n \"requirements\": [\n {\n \"field_type\": \"{{oneOf (array 'document')}}\",\n \"field_value\": \"9787fb5f-cbe5-4de4-b765-3303774ee9fe\",\n \"record_type\": \"porting_requirement\",\n \"requirement_type_id\": \"59b0762a-b274-4f76-ac32-4d5cf0272e66\"\n }\n ],\n \"status\": {\n \"details\": [\n {\n \"code\": \"{{oneOf (array 'ACCOUNT_NUMBER_MISMATCH' 'AUTH_PERSON_MISMATCH' 'BTN_ATN_MISMATCH' 'ENTITY_NAME_MISMATCH' 'FOC_EXPIRED' 'FOC_REJECTED' 'LOCATION_MISMATCH' 'LSR_PENDING' 'MAIN_BTN_PORTING' 'OSP_IRRESPONSIVE' 'OTHER' 'PASSCODE_PIN_INVALID' 'PHONE_NUMBER_HAS_SPECIAL_FEATURE' 'PHONE_NUMBER_MISMATCH' 'PHONE_NUMBER_NOT_PORTABLE' 'PORT_TYPE_INCORRECT' 'PORTING_ORDER_SPLIT_REQUIRED' 'PORTING_ORDER_SPLIT_REQUIRED' 'POSTAL_CODE_MISMATCH' 'RATE_CENTER_NOT_PORTABLE' 'SV_CONFLICT' 'SV_UNKNOWN_FAILURE')}}\",\n \"description\": \"Entity name does not match that on the CSR\"\n }\n ],\n \"value\": \"{{oneOf (array 'draft' 'in-process' 'submitted' 'exception' 'foc-date-confirmed' 'ported' 'canceled' 'cancel-pending')}}\"\n },\n \"support_key\": \"123abc\",\n \"updated_at\": \"2021-03-19T10:07:15.527Z\",\n \"user_feedback\": {\n \"user_comment\": \"I loved my experience porting numbers with Telnyx\",\n \"user_rating\": 5\n },\n \"user_reference\": \"Acct 123abc\",\n \"webhook_url\": \"https://example.com/porting_webhooks\"\n },\n \"meta\": {\n \"phone_numbers_url\": \"/porting_phone_numbers?filter[porting_order_id]=a700d03c-4062-4091-8189-1b75216cf7a2\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3543421e-4f86-49a1-8f1e-de4799d03269", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0bf8104b-f637-417c-87de-536c6c50b747", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "410100c1-b7b1-4b9e-9883-8c761399d10d", "documentation": "List all porting activation jobs", "method": "get", "endpoint": "porting_orders/:id/activation_jobs", "responses": [ { "uuid": "2be1152c-25c3-4be4-8da2-1490c0fa3799", "body": "{\n \"data\": [\n {\n \"created_at\": \"2021-03-19T10:07:15.527Z\",\n \"id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"record_type\": \"porting_activation_job\",\n \"status\": \"{{oneOf (array 'created' 'in-process' 'completed' 'failed')}}\",\n \"updated_at\": \"2021-03-19T10:07:15.527Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "791c47b4-2a2d-4a39-9e1d-49c3f83ecc53", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "1a5d1dba-38fa-4304-9f3e-f6f37a3b1518", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "52a86097-f6b2-448d-b939-14c2bd435db8", "documentation": "Retrieve a porting activation job", "method": "get", "endpoint": "porting_orders/:id/activation_jobs/:activationJobId", "responses": [ { "uuid": "c05fbac8-03e8-4af2-bde1-868f1ec80d26", "body": "{\n \"data\": {\n \"created_at\": \"2021-03-19T10:07:15.527Z\",\n \"id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"record_type\": \"porting_activation_job\",\n \"status\": \"{{oneOf (array 'created' 'in-process' 'completed' 'failed')}}\",\n \"updated_at\": \"2021-03-19T10:07:15.527Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "13ee230f-505f-417f-a08c-78856d80be4c", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "fde62edf-241d-4805-b47e-3b801b868995", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7ad89bf8-fefe-4fa7-81a0-1606fe5ae73b", "documentation": "List all comments of a porting order", "method": "get", "endpoint": "porting_orders/:id/comments", "responses": [ { "uuid": "6396bf11-b324-4367-8d49-257d689ed417", "body": "{\n \"data\": [\n {\n \"body\": \"Great experience so far\",\n \"created_at\": \"2021-03-19T10:07:15.527Z\",\n \"id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"porting_order_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"record_type\": \"porting_comment\",\n \"user_type\": \"{{oneOf (array 'admin' 'user' 'system')}}\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e12d9d56-47e7-49dc-9ded-6ceaee454059", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3f2cabea-088e-4983-a82f-85bb470361c5", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "4a2693f9-81e2-4886-8525-58964f595518", "documentation": "Create a comment for a porting order", "method": "post", "endpoint": "porting_orders/:id/comments", "responses": [ { "uuid": "5f5f89d1-5623-4227-99dc-95ede4f1ff07", "body": "{\n \"data\": {\n \"body\": \"Great experience so far\",\n \"created_at\": \"2021-03-19T10:07:15.527Z\",\n \"id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"porting_order_id\": \"f1486bae-f067-460c-ad43-73a92848f902\",\n \"record_type\": \"porting_comment\",\n \"user_type\": \"{{oneOf (array 'admin' 'user' 'system')}}\"\n }\n}", "latency": 0, "statusCode": 201, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0283a057-0d18-493a-bdd1-43f72f0fe20f", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "bba404bf-0c2d-468b-a19b-191960e2b379", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f10d10fd-dfb4-4344-8d45-a64073e2cace", "documentation": "Download a porting order loa template", "method": "get", "endpoint": "porting_orders/:id/loa_template", "responses": [ { "uuid": "5af3243d-6a52-4b13-84b0-071481039bf2", "body": "", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/pdf" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f3fc3b27-3ca7-4b9c-a612-9a4c8525122c", "body": "", "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": "df6c8795-d3dd-459a-96c6-ef6d546d06bd", "documentation": "List all porting phone numbers", "method": "get", "endpoint": "porting_phone_numbers", "responses": [ { "uuid": "55ed44a4-eb41-4cc1-948d-2f5cbccd276b", "body": "{\n \"data\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "76614be1-9b31-4ea3-a693-47143c9dd091", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "df4d4698-5e58-4d74-b908-69d06688a03d", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "36c73865-8849-45b6-b611-820a8a39b20f", "documentation": "Retrieve a list of portout requests", "method": "get", "endpoint": "portouts", "responses": [ { "uuid": "17999559-9ac7-4f3a-99a3-15abacc2bf8b", "body": "{\n \"data\": [\n {\n \"carrier_name\": \"test\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"foc_date\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0\",\n \"phone_numbers\": [\n \"+35312345678\"\n ],\n \"record_type\": \"portout\",\n \"requested_foc_date\": \"2018-02-02T22:25:27.521Z\",\n \"spid\": \"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0\",\n \"status\": \"pending\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 3,\n \"page_size\": 1,\n \"total_pages\": 13,\n \"total_results\": 13\n }\n}", "latency": 0, "statusCode": 200, "label": "Portout Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2bb3078c-f0d7-4b80-9762-e43e7da48826", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d90bbf31-eba8-4166-a628-57a2fe635b8f", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2ff3b409-692d-49f5-a5cd-cfc965d92199", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7f7532fb-230e-4a14-a9e8-48199e996fd4", "documentation": "Retrieve a portout request", "method": "get", "endpoint": "portouts/:id", "responses": [ { "uuid": "678bd9df-11b0-421b-b076-5aceb49679f1", "body": "{\n \"data\": {\n \"carrier_name\": \"test\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"foc_date\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0\",\n \"phone_numbers\": [\n \"+35312345678\"\n ],\n \"record_type\": \"portout\",\n \"requested_foc_date\": \"2018-02-02T22:25:27.521Z\",\n \"spid\": \"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0\",\n \"status\": \"pending\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Portout Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0f8fe430-1431-4482-93d8-02470c04b9b0", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3e03db98-91e0-4db1-82c8-0e0ed2d272b7", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ff95a36b-d856-4484-82c6-15dc584ee4a4", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "09046cc4-c755-4bd4-9af5-1de55a36d5f0", "documentation": "List all comments for a portout request", "method": "get", "endpoint": "portouts/:id/comments", "responses": [ { "uuid": "8f52f89e-bfcb-4596-a4cf-6e946044ff6b", "body": "{\n \"data\": [\n {\n \"body\": \"This is a comment\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0\",\n \"portout_id\": \"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0\",\n \"record_type\": \"portout\",\n \"user_id\": \"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0\"\n }\n ],\n \"meta\": {\n \"page_number\": 3,\n \"page_size\": 1,\n \"total_pages\": 13,\n \"total_results\": 13\n }\n}", "latency": 0, "statusCode": 200, "label": "Portout Comments", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3043e4f0-5c1e-4b54-8314-042bdd72d8a3", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "731d031b-6148-44b5-b573-1fb72eb67219", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c33ae792-edba-4326-89be-dde98cbc6dbd", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5017e597-abbc-436f-88a2-7d00b7fc0064", "documentation": "Create a comment on a portout request", "method": "post", "endpoint": "portouts/:id/comments", "responses": [ { "uuid": "aabef0f1-5862-4af0-94fc-9e887cb9dabb", "body": "{\n \"data\": {\n \"body\": \"This is a comment\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0\",\n \"portout_id\": \"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0\",\n \"record_type\": \"portout\",\n \"user_id\": \"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0\"\n }\n}", "latency": 0, "statusCode": 201, "label": "Portout Comment Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a2fa20ba-f754-4789-95d1-cb358762be4e", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "885eb458-cc09-435f-a1f5-ab9a4604313e", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "358ecf4b-c36b-4673-b17d-e8d02bd0895d", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f5256209-5459-4f14-beae-8185248303a6", "documentation": "Update Status", "method": "patch", "endpoint": "portouts/:id/:status", "responses": [ { "uuid": "f1f68600-56db-43d5-931a-42f20f6cf236", "body": "{\n \"data\": {\n \"carrier_name\": \"test\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"foc_date\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0\",\n \"phone_numbers\": [\n \"+35312345678\"\n ],\n \"record_type\": \"portout\",\n \"requested_foc_date\": \"2018-02-02T22:25:27.521Z\",\n \"spid\": \"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0\",\n \"status\": \"pending\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Portout Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "74416b0b-fc8f-412c-8b62-989a61fdbef3", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "333424eb-3e70-4b46-96a4-b8e96bf32a81", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "cf50172c-b333-436e-bee7-a8ed4cd265f3", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b10adae8-e41d-464d-a770-2beea284a1d1", "documentation": "Get all Private Wireless Gateways", "method": "get", "endpoint": "private_wireless_gateways", "responses": [ { "uuid": "0ec86acb-3c92-4452-93d8-acbc9b221e01", "body": "{\n \"data\": [\n {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"ip_range\": \"100.64.1.0/24\",\n \"name\": \"My private wireless gateway\",\n \"network_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"private_wireless_gateway\",\n \"region_code\": \"ashburn-va\",\n \"status\": {\n \"error_code\": \"\",\n \"error_description\": \"\",\n \"value\": \"{{oneOf (array 'provisioning' 'provisioned' 'failed' 'decommissioning')}}\"\n },\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6bbf27fd-6521-4788-800f-26083562981e", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "dd302e41-296f-49e9-9c5b-e39253774a81", "documentation": "Create a Private Wireless Gateway", "method": "post", "endpoint": "private_wireless_gateways", "responses": [ { "uuid": "8080868c-2c7c-4529-8eec-b70aea812bf3", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"ip_range\": \"100.64.1.0/24\",\n \"name\": \"My private wireless gateway\",\n \"network_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"private_wireless_gateway\",\n \"region_code\": \"ashburn-va\",\n \"status\": {\n \"error_code\": \"\",\n \"error_description\": \"\",\n \"value\": \"{{oneOf (array 'provisioning' 'provisioned' 'failed' 'decommissioning')}}\"\n },\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 202, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0c576579-1b4f-48e0-8ccf-53c634a69ad2", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check the 'detail' field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2db45f00-9017-42c4-8f03-6eca02d2b93d", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ec4836de-191b-4ee2-bfb0-90102c90fa53", "documentation": "Delete a Private Wireless Gateway", "method": "delete", "endpoint": "private_wireless_gateways/:id", "responses": [ { "uuid": "41230a23-a5fe-470a-b866-f3bc93396b47", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"ip_range\": \"100.64.1.0/24\",\n \"name\": \"My private wireless gateway\",\n \"network_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"private_wireless_gateway\",\n \"region_code\": \"ashburn-va\",\n \"status\": {\n \"error_code\": \"\",\n \"error_description\": \"\",\n \"value\": \"{{oneOf (array 'provisioning' 'provisioned' 'failed' 'decommissioning')}}\"\n },\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ad401174-1d26-4278-9cef-e9c8e2c17cda", "body": "{\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "72451be3-b296-4fa5-9315-5d164ea539fe", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e0d4186c-382c-4592-8914-373a47d2eb0e", "documentation": "Get a Private Wireless Gateway", "method": "get", "endpoint": "private_wireless_gateways/:id", "responses": [ { "uuid": "a08ebec6-6c85-44e1-887d-d09169b3cbcf", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"ip_range\": \"100.64.1.0/24\",\n \"name\": \"My private wireless gateway\",\n \"network_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"private_wireless_gateway\",\n \"region_code\": \"ashburn-va\",\n \"status\": {\n \"error_code\": \"\",\n \"error_description\": \"\",\n \"value\": \"{{oneOf (array 'provisioning' 'provisioned' 'failed' 'decommissioning')}}\"\n },\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "42fc9662-86c8-42af-a81a-e3e309e35a35", "body": "{\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "91ca3481-a6ba-49cd-94a5-410400568a52", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "af179514-f7f8-49c2-ad75-bd97e5bb3600", "documentation": "Retrieve a call queue", "method": "get", "endpoint": "queues/:queue_name", "responses": [ { "uuid": "6fb13252-6a1a-4a9e-8d28-6b0490cb8b36", "body": "{\n \"data\": {\n \"average_wait_time_secs\": 175,\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"current_size\": 20,\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"max_size\": 50,\n \"name\": \"support\",\n \"record_type\": \"queue\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a queue.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0a6fc2c6-eb78-4f74-8f75-ba7db92cde4a", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "4a00d6ba-4a59-4213-be05-36824efc8f38", "documentation": "Retrieve calls from a queue", "method": "get", "endpoint": "queues/:queue_name/calls", "responses": [ { "uuid": "bf8e44aa-4530-41ae-8b61-a15105d47cc4", "body": "{\n \"data\": [\n {\n \"call_control_id\": \"v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ\",\n \"call_leg_id\": \"2dc6fc34-f9e0-11ea-b68e-02420a0f7768\",\n \"call_session_id\": \"2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768\",\n \"connection_id\": \"7267xxxxxxxxxxxxxx\",\n \"enqueued_at\": \"2019-01-23T18:10:02.574Z\",\n \"from\": \"+18005550101\",\n \"queue_id\": \"ae1626cc-6f42-11ea-becd-02420a0f8b69\",\n \"queue_position\": 3,\n \"record_type\": \"queue_call\",\n \"to\": \"+18005550102\",\n \"wait_time_secs\": 145\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of calls in a queue.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "38a5e449-cb2d-4eab-a34c-dc6d6cc204ef", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "58329da7-c8af-42e1-b042-d8f08d4f058b", "documentation": "Retrieve a call from a queue", "method": "get", "endpoint": "queues/:queue_name/calls/:call_control_id", "responses": [ { "uuid": "df28f132-91e1-47bb-b5e3-c156631ae6b2", "body": "{\n \"data\": {\n \"call_control_id\": \"v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ\",\n \"call_leg_id\": \"2dc6fc34-f9e0-11ea-b68e-02420a0f7768\",\n \"call_session_id\": \"2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768\",\n \"connection_id\": \"7267xxxxxxxxxxxxxx\",\n \"enqueued_at\": \"2019-01-23T18:10:02.574Z\",\n \"from\": \"+18005550101\",\n \"queue_id\": \"ae1626cc-6f42-11ea-becd-02420a0f8b69\",\n \"queue_position\": 3,\n \"record_type\": \"queue_call\",\n \"to\": \"+18005550102\",\n \"wait_time_secs\": 145\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a call in a queue.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3133415a-00d4-467e-815b-168652f1debc", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "228a1ae5-82a9-4f23-bd2d-3696e08023aa", "documentation": "List recordings", "method": "get", "endpoint": "recordings", "responses": [ { "uuid": "b4a83c3c-9b21-46d7-b41e-8272db18ca46", "body": "{\n \"data\": [\n {\n \"call_leg_id\": \"11111111-5717-4562-b3fc-2c963f66afa6\",\n \"call_session_id\": \"22222222-5717-4562-b3fc-2c963f66afa6\",\n \"channels\": \"single\",\n \"conference_id\": \"41b9acd4-f4da-4ff5-a85c-e07e90b53f46\",\n \"created_at\": \"2019-03-29T13:10:00Z\",\n \"download_urls\": {\n \"mp3\": \"https://s3.amazonaws.com/some/path\"\n },\n \"duration_millis\": 50000,\n \"id\": \"dfadada7-af74-47bc-83a4-554275f55f5c\",\n \"record_type\": \"recording\",\n \"recording_ended_at\": \"2019-03-29T12:10:00Z\",\n \"recording_started_at\": \"2019-03-29T11:10:00Z\",\n \"source\": \"conference\",\n \"status\": \"completed\",\n \"updated_at\": \"2019-03-29T14:10:00Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of recordings.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "9cfb9553-e63c-4cfe-ae5b-5f3687fe0b12", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ff646232-c1a3-48bd-b58a-653fac85e13d", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "11d73f67-1cfd-43d6-b4b2-24ff0b168a6f", "documentation": "Retrieve a recording", "method": "get", "endpoint": "recordings/:id", "responses": [ { "uuid": "04adde01-616d-4780-a258-10248af76481", "body": "{\n \"data\": {\n \"call_leg_id\": \"11111111-5717-4562-b3fc-2c963f66afa6\",\n \"call_session_id\": \"22222222-5717-4562-b3fc-2c963f66afa6\",\n \"channels\": \"single\",\n \"conference_id\": \"41b9acd4-f4da-4ff5-a85c-e07e90b53f46\",\n \"created_at\": \"2019-03-29T13:10:00Z\",\n \"download_urls\": {\n \"mp3\": \"https://s3.amazonaws.com/some/path\"\n },\n \"duration_millis\": 50000,\n \"id\": \"dfadada7-af74-47bc-83a4-554275f55f5c\",\n \"record_type\": \"recording\",\n \"recording_ended_at\": \"2019-03-29T12:10:00Z\",\n \"recording_started_at\": \"2019-03-29T11:10:00Z\",\n \"source\": \"conference\",\n \"status\": \"completed\",\n \"updated_at\": \"2019-03-29T14:10:00Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a recording.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "421235cd-f5c3-4a27-90a6-9d9ac403e1cd", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized response. Happens when the current user is not a manager account.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "8656c770-9806-4ea1-b690-5f8570815764", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0e0a9678-5c1e-47ae-b64a-5d1bdd8499d5", "documentation": "Fetch all previous requests for messaging detail reports. Messaging detail reports are reports for pulling all messaging records. ", "method": "get", "endpoint": "reports/batch_mdr_reports", "responses": [ { "uuid": "3aab2422-a06a-4592-a028-0a7a865c7a06", "body": "{\n \"data\": [\n {\n \"connections\": [\n {{faker 'random.number'}}\n ],\n \"created_at\": \"2020-07-01T00:00:00-06:00\",\n \"directions\": [\n \"{{oneOf (array 'INBOUND' 'OUTBOUND')}}\"\n ],\n \"end_date\": \"2020-07-01T00:00:00-06:00\",\n \"filters\": [\n {\n \"billing_group\": \"adfaa016-f921-4b6c-97bb-e4c1dad231c5\",\n \"cld\": \"+13129457420\",\n \"cld_filter\": \"{{oneOf (array 'contains' 'starts_with' 'ends_with')}}\",\n \"cli\": \"+13129457420\",\n \"cli_filter\": \"{{oneOf (array 'contains' 'starts_with' 'ends_with')}}\",\n \"filter_type\": \"{{oneOf (array 'and' 'or')}}\",\n \"tags_list\": \"tag1\"\n }\n ],\n \"id\": \"{{faker 'random.uuid'}}\",\n \"profiles\": \"My profile\",\n \"record_type\": \"mdr_report\",\n \"record_types\": [\n \"{{oneOf (array 'INCOMPLETE' 'COMPLETED' 'ERRORS')}}\"\n ],\n \"report_name\": \"report_name_8hvb45Gu\",\n \"report_url\": \"http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv\",\n \"start_date\": \"2020-07-01T00:00:00-06:00\",\n \"status\": \"{{oneOf (array 'PENDING' 'COMPLETE' 'FAILED' 'EXPIRED')}}\",\n \"updated_at\": \"2020-07-01T00:00:00-06:00\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "dd920377-aa04-4ebe-aec5-f6c2191f8f4e", "documentation": "Submit a request for new messaging detail report. Messaging detail report pulls all raw messaging data according to defined filters.", "method": "post", "endpoint": "reports/batch_mdr_reports", "responses": [ { "uuid": "9e58fab1-d6e0-4d59-9444-57cac9d57fb3", "body": "{\n \"data\": {\n \"connections\": [\n {{faker 'random.number'}}\n ],\n \"created_at\": \"2020-07-01T00:00:00-06:00\",\n \"directions\": [\n \"{{oneOf (array 'INBOUND' 'OUTBOUND')}}\"\n ],\n \"end_date\": \"2020-07-01T00:00:00-06:00\",\n \"filters\": [\n {\n \"billing_group\": \"adfaa016-f921-4b6c-97bb-e4c1dad231c5\",\n \"cld\": \"+13129457420\",\n \"cld_filter\": \"{{oneOf (array 'contains' 'starts_with' 'ends_with')}}\",\n \"cli\": \"+13129457420\",\n \"cli_filter\": \"{{oneOf (array 'contains' 'starts_with' 'ends_with')}}\",\n \"filter_type\": \"{{oneOf (array 'and' 'or')}}\",\n \"tags_list\": \"tag1\"\n }\n ],\n \"id\": \"{{faker 'random.uuid'}}\",\n \"profiles\": \"My profile\",\n \"record_type\": \"mdr_report\",\n \"record_types\": [\n \"{{oneOf (array 'INCOMPLETE' 'COMPLETED' 'ERRORS')}}\"\n ],\n \"report_name\": \"report_name_8hvb45Gu\",\n \"report_url\": \"http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv\",\n \"start_date\": \"2020-07-01T00:00:00-06:00\",\n \"status\": \"{{oneOf (array 'PENDING' 'COMPLETE' 'FAILED' 'EXPIRED')}}\",\n \"updated_at\": \"2020-07-01T00:00:00-06:00\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "09488f5b-0306-4731-9983-8a18d02b9556", "documentation": "Delete generated messaging detail report by id", "method": "delete", "endpoint": "reports/batch_mdr_reports/:id", "responses": [ { "uuid": "1b29a535-82ca-4607-98a4-a87002867ed8", "body": "{\n \"data\": {\n \"connections\": [\n {{faker 'random.number'}}\n ],\n \"created_at\": \"2020-07-01T00:00:00-06:00\",\n \"directions\": [\n \"{{oneOf (array 'INBOUND' 'OUTBOUND')}}\"\n ],\n \"end_date\": \"2020-07-01T00:00:00-06:00\",\n \"filters\": [\n {\n \"billing_group\": \"adfaa016-f921-4b6c-97bb-e4c1dad231c5\",\n \"cld\": \"+13129457420\",\n \"cld_filter\": \"{{oneOf (array 'contains' 'starts_with' 'ends_with')}}\",\n \"cli\": \"+13129457420\",\n \"cli_filter\": \"{{oneOf (array 'contains' 'starts_with' 'ends_with')}}\",\n \"filter_type\": \"{{oneOf (array 'and' 'or')}}\",\n \"tags_list\": \"tag1\"\n }\n ],\n \"id\": \"{{faker 'random.uuid'}}\",\n \"profiles\": \"My profile\",\n \"record_type\": \"mdr_report\",\n \"record_types\": [\n \"{{oneOf (array 'INCOMPLETE' 'COMPLETED' 'ERRORS')}}\"\n ],\n \"report_name\": \"report_name_8hvb45Gu\",\n \"report_url\": \"http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv\",\n \"start_date\": \"2020-07-01T00:00:00-06:00\",\n \"status\": \"{{oneOf (array 'PENDING' 'COMPLETE' 'FAILED' 'EXPIRED')}}\",\n \"updated_at\": \"2020-07-01T00:00:00-06:00\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d5f58da4-560b-455f-8c25-142f46bcbb64", "documentation": "Fetch single messaging detail report by id.", "method": "get", "endpoint": "reports/batch_mdr_reports/:id", "responses": [ { "uuid": "a0e51939-3654-4881-8f63-019bf9ee8353", "body": "{\n \"data\": {\n \"connections\": [\n {{faker 'random.number'}}\n ],\n \"created_at\": \"2020-07-01T00:00:00-06:00\",\n \"directions\": [\n \"{{oneOf (array 'INBOUND' 'OUTBOUND')}}\"\n ],\n \"end_date\": \"2020-07-01T00:00:00-06:00\",\n \"filters\": [\n {\n \"billing_group\": \"adfaa016-f921-4b6c-97bb-e4c1dad231c5\",\n \"cld\": \"+13129457420\",\n \"cld_filter\": \"{{oneOf (array 'contains' 'starts_with' 'ends_with')}}\",\n \"cli\": \"+13129457420\",\n \"cli_filter\": \"{{oneOf (array 'contains' 'starts_with' 'ends_with')}}\",\n \"filter_type\": \"{{oneOf (array 'and' 'or')}}\",\n \"tags_list\": \"tag1\"\n }\n ],\n \"id\": \"{{faker 'random.uuid'}}\",\n \"profiles\": \"My profile\",\n \"record_type\": \"mdr_report\",\n \"record_types\": [\n \"{{oneOf (array 'INCOMPLETE' 'COMPLETED' 'ERRORS')}}\"\n ],\n \"report_name\": \"report_name_8hvb45Gu\",\n \"report_url\": \"http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv\",\n \"start_date\": \"2020-07-01T00:00:00-06:00\",\n \"status\": \"{{oneOf (array 'PENDING' 'COMPLETE' 'FAILED' 'EXPIRED')}}\",\n \"updated_at\": \"2020-07-01T00:00:00-06:00\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "cc29a846-1599-4fef-8c09-0b6810b22a81", "documentation": "Generate and fetch voice usage report synchronously. This endpoint will both generate and fetch the voice report over a specified time period. No polling is necessary but the response may take up to a couple of minutes. ", "method": "get", "endpoint": "reports/cdr_usage_reports/sync", "responses": [ { "uuid": "421981be-38f5-4eb7-be40-1090600d22a0", "body": "{\n \"data\": {\n \"aggregation_type\": \"{{oneOf (array 'NO_AGGREGATION' 'CONNECTION' 'TAG' 'BILLING_GROUP')}}\",\n \"connections\": \"[1234567890L, 9876543210L]\",\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"end_time\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"{{faker 'random.uuid'}}\",\n \"product_breakdown\": \"{{oneOf (array 'NO_BREAKDOWN' 'DID_VS_TOLL_FREE' 'COUNTRY' 'DID_VS_TOLL_FREE_PER_COUNTRY')}}\",\n \"record_type\": \"cdr_usage_report\",\n \"report_url\": \"http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv\",\n \"result\": {},\n \"start_time\": \"2018-02-02T22:25:27.521Z\",\n \"status\": \"{{oneOf (array 'PENDING' 'COMPLETE' 'FAILED' 'EXPIRED')}}\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a24069cd-b58e-4a7a-a0c4-0f82e64afc7d", "documentation": "Fetch all messaging usage reports. Usage reports are aggregated messaging data for specified time period and breakdown", "method": "get", "endpoint": "reports/mdr_usage_reports", "responses": [ { "uuid": "e9caa1ed-b83a-4484-87c9-b121a4e5e170", "body": "{\n \"data\": [\n {\n \"aggregation_type\": \"{{oneOf (array 'NO_AGGREGATION' 'PROFILE' 'TAGS')}}\",\n \"connections\": [\n {{faker 'random.number'}}\n ],\n \"created_at\": \"2020-07-01T00:00:00-06:00\",\n \"end_date\": \"2020-07-01T00:00:00-06:00\",\n \"id\": \"{{faker 'random.uuid'}}\",\n \"profiles\": \"My profile\",\n \"record_type\": \"mdr_usage_report\",\n \"report_url\": \"http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv\",\n \"result\": [\n {\n \"carrier_passthrough_fee\": \"0\",\n \"connection\": \"all\",\n \"cost\": \"0\",\n \"currency\": \"USD\",\n \"delivered\": \"0\",\n \"direction\": \"outbound\",\n \"message_type\": \"SMS\",\n \"parts\": \"0\",\n \"product\": \"outbound\",\n \"profile_id\": \"All\",\n \"received\": \"0\",\n \"sent\": \"0\",\n \"tags\": \"All\",\n \"tn_type\": \"TF\"\n }\n ],\n \"start_date\": \"2020-07-01T00:00:00-06:00\",\n \"status\": \"{{oneOf (array 'PENDING' 'COMPLETE' 'FAILED' 'EXPIRED')}}\",\n \"updated_at\": \"2020-07-01T00:00:00-06:00\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "9579062f-8216-4956-b793-1a70c00fba59", "documentation": "Submit request for new new messaging usage report. This endpoint will pull and aggregate messaging data in specified time period. ", "method": "post", "endpoint": "reports/mdr_usage_reports", "responses": [ { "uuid": "4fba4c0f-e03c-4344-b7f9-6a45c4c26bc5", "body": "{\n \"data\": {\n \"aggregation_type\": \"{{oneOf (array 'NO_AGGREGATION' 'PROFILE' 'TAGS')}}\",\n \"connections\": [\n {{faker 'random.number'}}\n ],\n \"created_at\": \"2020-07-01T00:00:00-06:00\",\n \"end_date\": \"2020-07-01T00:00:00-06:00\",\n \"id\": \"{{faker 'random.uuid'}}\",\n \"profiles\": \"My profile\",\n \"record_type\": \"mdr_usage_report\",\n \"report_url\": \"http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv\",\n \"result\": [\n {\n \"carrier_passthrough_fee\": \"0\",\n \"connection\": \"all\",\n \"cost\": \"0\",\n \"currency\": \"USD\",\n \"delivered\": \"0\",\n \"direction\": \"outbound\",\n \"message_type\": \"SMS\",\n \"parts\": \"0\",\n \"product\": \"outbound\",\n \"profile_id\": \"All\",\n \"received\": \"0\",\n \"sent\": \"0\",\n \"tags\": \"All\",\n \"tn_type\": \"TF\"\n }\n ],\n \"start_date\": \"2020-07-01T00:00:00-06:00\",\n \"status\": \"{{oneOf (array 'PENDING' 'COMPLETE' 'FAILED' 'EXPIRED')}}\",\n \"updated_at\": \"2020-07-01T00:00:00-06:00\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "1a4ccb47-d866-4a30-93a0-0b0368c4b1bd", "documentation": "Generate and fetch messaging usage report synchronously. This endpoint will both generate and fetch the messaging report over a specified time period. No polling is necessary but the response may take up to a couple of minutes. ", "method": "get", "endpoint": "reports/mdr_usage_reports/sync", "responses": [ { "uuid": "d48488a0-2fa6-4c2e-a42b-a385bd0a9a61", "body": "{\n \"data\": {\n \"aggregation_type\": \"{{oneOf (array 'NO_AGGREGATION' 'PROFILE' 'TAGS')}}\",\n \"connections\": [\n {{faker 'random.number'}}\n ],\n \"created_at\": \"2020-07-01T00:00:00-06:00\",\n \"end_date\": \"2020-07-01T00:00:00-06:00\",\n \"id\": \"{{faker 'random.uuid'}}\",\n \"profiles\": \"My profile\",\n \"record_type\": \"mdr_usage_report\",\n \"report_url\": \"http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv\",\n \"result\": [\n {\n \"carrier_passthrough_fee\": \"0\",\n \"connection\": \"all\",\n \"cost\": \"0\",\n \"currency\": \"USD\",\n \"delivered\": \"0\",\n \"direction\": \"outbound\",\n \"message_type\": \"SMS\",\n \"parts\": \"0\",\n \"product\": \"outbound\",\n \"profile_id\": \"All\",\n \"received\": \"0\",\n \"sent\": \"0\",\n \"tags\": \"All\",\n \"tn_type\": \"TF\"\n }\n ],\n \"start_date\": \"2020-07-01T00:00:00-06:00\",\n \"status\": \"{{oneOf (array 'PENDING' 'COMPLETE' 'FAILED' 'EXPIRED')}}\",\n \"updated_at\": \"2020-07-01T00:00:00-06:00\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "6cf2132f-e223-4303-86d9-dcfd3b7684b5", "documentation": "Delete messaging usage report by id", "method": "delete", "endpoint": "reports/mdr_usage_reports/:id", "responses": [ { "uuid": "ff648a8e-d432-4126-b7db-f47039741301", "body": "{\n \"data\": {\n \"aggregation_type\": \"{{oneOf (array 'NO_AGGREGATION' 'PROFILE' 'TAGS')}}\",\n \"connections\": [\n {{faker 'random.number'}}\n ],\n \"created_at\": \"2020-07-01T00:00:00-06:00\",\n \"end_date\": \"2020-07-01T00:00:00-06:00\",\n \"id\": \"{{faker 'random.uuid'}}\",\n \"profiles\": \"My profile\",\n \"record_type\": \"mdr_usage_report\",\n \"report_url\": \"http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv\",\n \"result\": [\n {\n \"carrier_passthrough_fee\": \"0\",\n \"connection\": \"all\",\n \"cost\": \"0\",\n \"currency\": \"USD\",\n \"delivered\": \"0\",\n \"direction\": \"outbound\",\n \"message_type\": \"SMS\",\n \"parts\": \"0\",\n \"product\": \"outbound\",\n \"profile_id\": \"All\",\n \"received\": \"0\",\n \"sent\": \"0\",\n \"tags\": \"All\",\n \"tn_type\": \"TF\"\n }\n ],\n \"start_date\": \"2020-07-01T00:00:00-06:00\",\n \"status\": \"{{oneOf (array 'PENDING' 'COMPLETE' 'FAILED' 'EXPIRED')}}\",\n \"updated_at\": \"2020-07-01T00:00:00-06:00\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "12393615-95fa-43ff-9932-d3b6ec2093d2", "documentation": "Fetch a single messaging usage report by id", "method": "get", "endpoint": "reports/mdr_usage_reports/:id", "responses": [ { "uuid": "6efebdd0-5a60-4ff1-bd16-e083b037c8ac", "body": "{\n \"data\": {\n \"aggregation_type\": \"{{oneOf (array 'NO_AGGREGATION' 'PROFILE' 'TAGS')}}\",\n \"connections\": [\n {{faker 'random.number'}}\n ],\n \"created_at\": \"2020-07-01T00:00:00-06:00\",\n \"end_date\": \"2020-07-01T00:00:00-06:00\",\n \"id\": \"{{faker 'random.uuid'}}\",\n \"profiles\": \"My profile\",\n \"record_type\": \"mdr_usage_report\",\n \"report_url\": \"http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv\",\n \"result\": [\n {\n \"carrier_passthrough_fee\": \"0\",\n \"connection\": \"all\",\n \"cost\": \"0\",\n \"currency\": \"USD\",\n \"delivered\": \"0\",\n \"direction\": \"outbound\",\n \"message_type\": \"SMS\",\n \"parts\": \"0\",\n \"product\": \"outbound\",\n \"profile_id\": \"All\",\n \"received\": \"0\",\n \"sent\": \"0\",\n \"tags\": \"All\",\n \"tn_type\": \"TF\"\n }\n ],\n \"start_date\": \"2020-07-01T00:00:00-06:00\",\n \"status\": \"{{oneOf (array 'PENDING' 'COMPLETE' 'FAILED' 'EXPIRED')}}\",\n \"updated_at\": \"2020-07-01T00:00:00-06:00\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "63f85612-d6a8-4b1f-a0cd-1b71795be30d", "documentation": "Fetch all Mdr records ", "method": "get", "endpoint": "reports/mdrs", "responses": [ { "uuid": "53dc719f-7ad4-451f-9de8-4f58391713d6", "body": "{\n \"data\": [\n {\n \"cld\": \"+1555123456\",\n \"cli\": \"+1555123456\",\n \"cost\": \"0.1\",\n \"created_at\": \"2020-07-01T00:00:00-06:00\",\n \"currency\": \"{{oneOf (array 'AUD' 'CAD' 'EUR' 'GBP' 'USD')}}\",\n \"direction\": \"outbound\",\n \"id\": \"99b637f3-07fd-45ac-b9ca-b87208c24650\",\n \"message_type\": \"{{oneOf (array 'SMS' 'MMS')}}\",\n \"parts\": 2,\n \"profile_name\": \"configured-profile-name\",\n \"rate\": \"0.05\",\n \"record_type\": \"mdr_report\",\n \"status\": \"{{oneOf (array 'GW_TIMEOUT' 'DELIVERED' 'DLR_UNCONFIRMED' 'DLR_TIMEOUT' 'RECEIVED' 'GW_REJECT' 'FAILED')}}\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f309152a-ecc9-4381-9e8d-8dfc0f5f7a88", "documentation": "Fetch all Wdr records ", "method": "get", "endpoint": "reports/wdrs", "responses": [ { "uuid": "8f4968ac-9323-4ee7-83bf-9ae9e71237cd", "body": "{\n \"data\": [\n {\n \"cost\": {\n \"amount\": 0.1,\n \"currency\": \"{{oneOf (array 'AUD' 'CAD' 'EUR' 'GBP' 'USD')}}\"\n },\n \"created_at\": \"2020-07-01T00:00:00-06:00\",\n \"downlink_data\": {\n \"amount\": 1,\n \"unit\": \"{{oneOf (array 'B' 'KB' 'MB')}}\"\n },\n \"duration_seconds\": 1,\n \"id\": \"3ca7bd3d-7d82-4e07-9df4-009123068320\",\n \"imsi\": \"123\",\n \"mcc\": \"204\",\n \"mnc\": \"01\",\n \"phone_number\": \"+12345678910\",\n \"rate\": {\n \"amount\": 0.1,\n \"currency\": \"{{oneOf (array 'AUD' 'CAD' 'EUR' 'GBP' 'USD')}}\"\n },\n \"record_type\": \"wdr\",\n \"sim_card_id\": \"877f80a6-e5b2-4687-9a04-88076265720f\",\n \"sim_group_id\": \"f05a189f-7c46-4531-ac56-1460dc465a42\",\n \"sim_group_name\": \"sim name\",\n \"uplink_data\": {\n \"amount\": 1,\n \"unit\": \"{{oneOf (array 'B' 'KB' 'MB')}}\"\n }\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c4f6bf2a-09e7-433f-9cb4-cdaf54b59fb8", "documentation": "List all requirement types", "method": "get", "endpoint": "requirement_types", "responses": [ { "uuid": "c36f1661-63b7-4b5f-b187-4ed0efe8a57b", "body": "{\n \"data\": [\n {\n \"acceptance_criteria\": {\n \"locality_limit\": \"Issued by the same country that the phone number belongs to\",\n \"time_limit\": \"Current and not expired\"\n },\n \"created_at\": \"2021-04-09T22:25:27.521Z\",\n \"description\": \"Proves the customer has a physical address in the same locality as the phone number\",\n \"example\": \"Utility bill, internet bill, phone bill, or lease\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"name\": \"Proof of Address\",\n \"record_type\": \"requirement_type\",\n \"type\": \"{{oneOf (array 'document' 'address' 'textual')}}\",\n \"updated_at\": \"2021-04-12T20:20:20.020Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ef61c814-128b-4a04-8ebb-abe29052789c", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "03ec4826-dc42-446d-8e3c-d413aaa7cf2d", "documentation": "Retrieve a requirement types", "method": "get", "endpoint": "requirement_types/:id", "responses": [ { "uuid": "fbb32a55-9360-4f6f-8bf2-1257cbb21b19", "body": "{\n \"data\": {\n \"acceptance_criteria\": {\n \"locality_limit\": \"Issued by the same country that the phone number belongs to\",\n \"time_limit\": \"Current and not expired\"\n },\n \"created_at\": \"2021-04-09T22:25:27.521Z\",\n \"description\": \"Proves the customer has a physical address in the same locality as the phone number\",\n \"example\": \"Utility bill, internet bill, phone bill, or lease\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"name\": \"Proof of Address\",\n \"record_type\": \"requirement_type\",\n \"type\": \"{{oneOf (array 'document' 'address' 'textual')}}\",\n \"updated_at\": \"2021-04-12T20:20:20.020Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3fab85ed-c717-410f-805f-c8ae90d87daf", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e73a8305-b08e-4b2a-80d0-34457c14ba25", "documentation": "List all requirements", "method": "get", "endpoint": "requirements", "responses": [ { "uuid": "e691c7f7-86eb-471f-89ea-3365c283c608", "body": "{\n \"data\": [\n {\n \"action\": \"{{oneOf (array 'both' 'ordering' 'porting')}}\",\n \"country_code\": \"FR\",\n \"created_at\": \"2021-04-09T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"locality\": \"Nice\",\n \"phone_number_type\": \"{{oneOf (array 'local' 'national' 'toll_free')}}\",\n \"record_type\": \"requirement\",\n \"requirements_types\": [\n {\n \"acceptance_criteria\": {\n \"locality_limit\": \"Issued by the same country that the phone number belongs to\",\n \"time_limit\": \"Current and not expired\"\n },\n \"created_at\": \"2021-04-09T22:25:27.521Z\",\n \"description\": \"Proves the customer has a physical address in the same locality as the phone number\",\n \"example\": \"Utility bill, internet bill, phone bill, or lease\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"name\": \"Proof of Address\",\n \"record_type\": \"requirement_type\",\n \"type\": \"{{oneOf (array 'document' 'address' 'textual')}}\",\n \"updated_at\": \"2021-04-12T20:20:20.020Z\"\n }\n ],\n \"updated_at\": \"2021-04-12T20:20:20.020Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e7b45df4-9725-41cd-93fa-0f8773e5cf53", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ed2d2dad-82c2-4739-92d8-983a79662da4", "documentation": "Retrieve a document requirement", "method": "get", "endpoint": "requirements/:id", "responses": [ { "uuid": "72688374-2dac-4407-abfb-58abb1125d9b", "body": "{\n \"data\": {\n \"action\": \"{{oneOf (array 'both' 'ordering' 'porting')}}\",\n \"country_code\": \"FR\",\n \"created_at\": \"2021-04-09T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"locality\": \"Nice\",\n \"phone_number_type\": \"{{oneOf (array 'local' 'national' 'toll_free')}}\",\n \"record_type\": \"requirement\",\n \"requirements_types\": [\n {\n \"acceptance_criteria\": {\n \"locality_limit\": \"Issued by the same country that the phone number belongs to\",\n \"time_limit\": \"Current and not expired\"\n },\n \"created_at\": \"2021-04-09T22:25:27.521Z\",\n \"description\": \"Proves the customer has a physical address in the same locality as the phone number\",\n \"example\": \"Utility bill, internet bill, phone bill, or lease\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"name\": \"Proof of Address\",\n \"record_type\": \"requirement_type\",\n \"type\": \"{{oneOf (array 'document' 'address' 'textual')}}\",\n \"updated_at\": \"2021-04-12T20:20:20.020Z\"\n }\n ],\n \"updated_at\": \"2021-04-12T20:20:20.020Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "dea519ee-78f5-4b33-a150-0060215fc14d", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "9dd4a6f9-e942-47e4-bf6a-1a2f0a0fc7b1", "documentation": "View a list of room participants.", "method": "get", "endpoint": "room_participants", "responses": [ { "uuid": "233c9f81-f1f0-410e-8275-0babc8b169ed", "body": "{\n \"data\": [\n {\n \"context\": \"Alice\",\n \"id\": \"7b61621f-62e0-4aad-ab11-9fd19e272e73\",\n \"joined_at\": \"2021-04-16T09:46:20.954863Z\",\n \"left_at\": \"2021-04-16T10:24:55.962200Z\",\n \"record_type\": \"room_participant\",\n \"session_id\": \"7b61621f-5fe4-4aad-ab11-9fd19e272e73\",\n \"updated_at\": \"2021-04-16T10:24:55.962200Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "List room participants response.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ce44183d-dfb2-414a-b9a0-1158cc1820a8", "documentation": "View a room participant.", "method": "get", "endpoint": "room_participants/:room_participant_id", "responses": [ { "uuid": "cf95505f-7ab5-4f36-9cff-bc1197b2e7cc", "body": "{\n \"data\": {\n \"context\": \"Alice\",\n \"id\": \"7b61621f-62e0-4aad-ab11-9fd19e272e73\",\n \"joined_at\": \"2021-04-16T09:46:20.954863Z\",\n \"left_at\": \"2021-04-16T10:24:55.962200Z\",\n \"record_type\": \"room_participant\",\n \"session_id\": \"7b61621f-5fe4-4aad-ab11-9fd19e272e73\",\n \"updated_at\": \"2021-04-16T10:24:55.962200Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Get room participant response.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "74a30257-869f-47d9-98b3-ba23d23119a6", "body": "{\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "351d1d4d-c816-45a6-9ede-55fd5b6767c5", "documentation": "View a list of room sessions.", "method": "get", "endpoint": "room_sessions", "responses": [ { "uuid": "74e4b2c8-b89d-46e8-af44-b071b49b2960", "body": "{\n \"data\": [\n {\n \"active\": false,\n \"created_at\": \"2021-04-16T09:46:20.954863Z\",\n \"ended_at\": \"2021-04-16T10:24:55.962200Z\",\n \"id\": \"7b61621f-62e0-4aad-ab11-9fd19e272e73\",\n \"participants\": [],\n \"record_type\": \"room_session\",\n \"room_id\": \"7b61621f-5fe4-4aad-ab11-9fd19e272e73\",\n \"updated_at\": \"2021-04-16T10:24:55.962200Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "List room sessions response.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c2242c02-34bf-4d04-bafe-b7b27504720d", "documentation": "View a room session.", "method": "get", "endpoint": "room_sessions/:room_session_id", "responses": [ { "uuid": "7b9e0c56-e7ad-447b-9d45-a798137ad5ea", "body": "{\n \"data\": {\n \"active\": false,\n \"created_at\": \"2021-04-16T09:46:20.954863Z\",\n \"ended_at\": \"2021-04-16T10:24:55.962200Z\",\n \"id\": \"7b61621f-62e0-4aad-ab11-9fd19e272e73\",\n \"participants\": [],\n \"record_type\": \"room_session\",\n \"room_id\": \"7b61621f-5fe4-4aad-ab11-9fd19e272e73\",\n \"updated_at\": \"2021-04-16T10:24:55.962200Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Get room session response.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "b9768d3e-9fd1-44c3-95f3-67fdfdb466cb", "body": "{\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c58baa9a-4e67-44f0-93b0-2a335872f8e1", "documentation": "View a list of room participants.", "method": "get", "endpoint": "room_sessions/:room_session_id/participants", "responses": [ { "uuid": "b5c15f53-66be-4b4d-aa02-fd48788a9e25", "body": "{\n \"data\": [\n {\n \"context\": \"Alice\",\n \"id\": \"7b61621f-62e0-4aad-ab11-9fd19e272e73\",\n \"joined_at\": \"2021-04-16T09:46:20.954863Z\",\n \"left_at\": \"2021-04-16T10:24:55.962200Z\",\n \"record_type\": \"room_participant\",\n \"session_id\": \"7b61621f-5fe4-4aad-ab11-9fd19e272e73\",\n \"updated_at\": \"2021-04-16T10:24:55.962200Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "List room participants response.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7e8a2c66-6f97-4e99-af4d-c5ad5872baa5", "documentation": "View a list of rooms.", "method": "get", "endpoint": "rooms", "responses": [ { "uuid": "31bb700f-807a-4f4a-9feb-fb8ce7c7c485", "body": "{\n \"data\": [\n {\n \"active_session_id\": \"7b61621f-62e0-4aad-ab11-9fd19e272e74\",\n \"created_at\": \"2021-04-16T09:46:20.954863Z\",\n \"id\": \"7b61621f-62e0-4aad-ab11-9fd19e272e73\",\n \"max_participants\": 50,\n \"record_type\": \"room\",\n \"sessions\": [\n {\n \"active\": true,\n \"created_at\": \"2021-04-16T09:46:20.954863Z\",\n \"id\": \"7b61621f-62e0-4aad-ab11-9fd19e272e74\",\n \"participants\": [],\n \"record_type\": \"room_session\",\n \"room_id\": \"7b61621f-62e0-4aad-ab11-9fd19e272e73\",\n \"updated_at\": \"2021-04-16T10:24:55.962200Z\"\n }\n ],\n \"unique_name\": \"My Room\",\n \"updated_at\": \"2021-04-16T10:24:55.962200Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "List rooms response.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "dc181f80-dac8-462e-ad8b-57a0e92fae19", "documentation": "Create a room.", "method": "post", "endpoint": "rooms", "responses": [ { "uuid": "568e1438-9dec-4a10-8f48-6685512147de", "body": "{\n \"data\": {\n \"active_session_id\": \"7b61621f-62e0-4aad-ab11-9fd19e272e74\",\n \"created_at\": \"2021-04-16T09:46:20.954863Z\",\n \"id\": \"7b61621f-62e0-4aad-ab11-9fd19e272e73\",\n \"max_participants\": 50,\n \"record_type\": \"room\",\n \"sessions\": [\n {\n \"active\": true,\n \"created_at\": \"2021-04-16T09:46:20.954863Z\",\n \"id\": \"7b61621f-62e0-4aad-ab11-9fd19e272e74\",\n \"participants\": [],\n \"record_type\": \"room_session\",\n \"room_id\": \"7b61621f-62e0-4aad-ab11-9fd19e272e73\",\n \"updated_at\": \"2021-04-16T10:24:55.962200Z\"\n }\n ],\n \"unique_name\": \"My Room\",\n \"updated_at\": \"2021-04-16T10:24:55.962200Z\"\n }\n}", "latency": 0, "statusCode": 201, "label": "Create room response.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3e25e3bb-343a-4bea-9ab9-1fdf966977d0", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check the 'detail' field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "86bc076a-3f53-4e19-816f-cefb6d28a5e1", "documentation": "Delete a room.", "method": "delete", "endpoint": "rooms/:room_id", "responses": [ { "uuid": "81593998-6301-49d6-830e-77265d467098", "body": "", "latency": 0, "statusCode": 204, "label": "The resource was deleted successfully.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "73f62b1a-9d2e-40fe-9186-7680085eab9f", "body": "{\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "fdee765f-e402-4cae-9744-298e2a8fba11", "documentation": "View a room.", "method": "get", "endpoint": "rooms/:room_id", "responses": [ { "uuid": "e3c6a2e7-3cca-401d-8add-53907c1d4864", "body": "{\n \"data\": {\n \"active_session_id\": \"7b61621f-62e0-4aad-ab11-9fd19e272e74\",\n \"created_at\": \"2021-04-16T09:46:20.954863Z\",\n \"id\": \"7b61621f-62e0-4aad-ab11-9fd19e272e73\",\n \"max_participants\": 50,\n \"record_type\": \"room\",\n \"sessions\": [\n {\n \"active\": true,\n \"created_at\": \"2021-04-16T09:46:20.954863Z\",\n \"id\": \"7b61621f-62e0-4aad-ab11-9fd19e272e74\",\n \"participants\": [],\n \"record_type\": \"room_session\",\n \"room_id\": \"7b61621f-62e0-4aad-ab11-9fd19e272e73\",\n \"updated_at\": \"2021-04-16T10:24:55.962200Z\"\n }\n ],\n \"unique_name\": \"My Room\",\n \"updated_at\": \"2021-04-16T10:24:55.962200Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Get room response.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e380a049-956b-46b0-bdf4-65f41fd58b5e", "body": "{\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7d27ab44-862a-4d96-8731-7ac53c84ae92", "documentation": "Create Client Token to join a room.", "method": "post", "endpoint": "rooms/:room_id/actions/generate_join_client_token", "responses": [ { "uuid": "de408435-cf47-4d65-9703-563d7bb1234c", "body": "{\n \"data\": {\n \"refresh_token\": \"eyJhbGciOiJFZDI1NTE5IiwidHlwIjoiSldUIn0.eyJhdWQiOiJ0ZWxueXhfYWNjZXNzX3Rva2VuIiwiZXhwIjoxNjE5MDkzNzA1LCJncmFudHMiOlt7ImFjdGlvbnMiOlsiam9pbiJdLCJyZXNvdXJjZXMiOlsidGVsbnl4OnZpZGVvOnJvb21zOjllMmEwY2JlLWNlNjYtNDExZS1hMWFjLTQ2OGYwYjEwM2M5YSJdLCJzdWJqZWN0cyI6WyJ0ZWxueXg6dXNlcnM6NzgyYjJjYmUtODQ2Ni00ZTNmLWE0ZDMtOTc4MWViNTc3ZTUwIl19XSwiZ3JhbnRzX3ZlcnNpb24iOiIxLjAuMCIsImlhdCI6MTYxOTA5MzY5NSwiaXNzIjoidGVsbnl4X2FjY2Vzc190b2tlbiIsImp0aSI6ImQ3OWJlMzhjLWFkNTQtNGQ5ZC1hODc4LWExNjVjNTk0MGQwNyIsIm5iZiI6MTYxOTA5MzY5NCwic3ViIjoibnVsbCIsInR5cCI6InJlZnJlc2gifQ.FHsp7KlVXn1E5tTUiKZzmQ4of39gi57AakeQeqI0oAa8hzjFMVb0RGj-mxWTvHVen4GpgsUW_epqqaxK16viCA\",\n \"refresh_token_expires_at\": \"2021-04-22T12:15:05Z\",\n \"token\": \"eyJhbGciOiJFZDI1NTE5IiwidHlwIjoiSldUIn0.eyJhdWQiOiJ0ZWxueXhfYWNjZXNzX3Rva2VuIiwiZXhwIjoxNjE5MDk0Mjk1LCJncmFudHMiOlt7ImFjdGlvbnMiOlsiam9pbiJdLCJyZXNvdXJjZXMiOlsidGVsbnl4OnZpZGVvOnJvb21zOjllMmEwY2JlLWNlNjYtNDExZS1hMWFjLTQ2OGYwYjEwM2M5YSJdLCJzdWJqZWN0cyI6WyJ0ZWxueXg6dXNlcnM6NzgyYjJjYmUtODQ2Ni00ZTNmLWE0ZDMtOTc4MWViNTc3ZTUwIl19XSwiZ3JhbnRzX3ZlcnNpb24iOiIxLjAuMCIsImlhdCI6MTYxOTA5MzY5NSwiaXNzIjoidGVsbnl4X2FjY2Vzc190b2tlbiIsImp0aSI6IjllNjIyOTA2LTc1ZTctNDBiNi1iOTAwLTc1NGIxZjNlZDMyZiIsIm5iZiI6MTYxOTA5MzY5NCwic3ViIjoibnVsbCIsInR5cCI6ImFjY2VzcyJ9.1JGK9PyHkTtoP_iMu-8TzXH_fhmnsDtZZOAJLDzLW6DDtAb80wZ93l1VH5yNx5tFqwIFG0t48dRiBKWlW-nzDA\",\n \"token_expires_at\": \"2021-04-22T12:24:55Z\"\n }\n}", "latency": 0, "statusCode": 201, "label": "Create room client token response.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "cb99309a-21c0-4f6b-9064-c6e4bb241f9e", "body": "{\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d6a25ffa-5319-4352-aea4-336170bf9ff2", "documentation": "Refresh Client Token to join a room.", "method": "post", "endpoint": "rooms/:room_id/actions/refresh_client_token", "responses": [ { "uuid": "bf179b24-1cc8-4493-af25-a7f86c2a2357", "body": "{\n \"data\": {\n \"token\": \"eyJhbGciOiJFZDI1NTE5IiwidHlwIjoiSldUIn0.eyJhdWQiOiJ0ZWxueXhfYWNjZXNzX3Rva2VuIiwiZXhwIjoxNjE5MDk0Mjk1LCJncmFudHMiOlt7ImFjdGlvbnMiOlsiam9pbiJdLCJyZXNvdXJjZXMiOlsidGVsbnl4OnZpZGVvOnJvb21zOjllMmEwY2JlLWNlNjYtNDExZS1hMWFjLTQ2OGYwYjEwM2M5YSJdLCJzdWJqZWN0cyI6WyJ0ZWxueXg6dXNlcnM6NzgyYjJjYmUtODQ2Ni00ZTNmLWE0ZDMtOTc4MWViNTc3ZTUwIl19XSwiZ3JhbnRzX3ZlcnNpb24iOiIxLjAuMCIsImlhdCI6MTYxOTA5MzY5NSwiaXNzIjoidGVsbnl4X2FjY2Vzc190b2tlbiIsImp0aSI6IjllNjIyOTA2LTc1ZTctNDBiNi1iOTAwLTc1NGIxZjNlZDMyZiIsIm5iZiI6MTYxOTA5MzY5NCwic3ViIjoibnVsbCIsInR5cCI6ImFjY2VzcyJ9.1JGK9PyHkTtoP_iMu-8TzXH_fhmnsDtZZOAJLDzLW6DDtAb80wZ93l1VH5yNx5tFqwIFG0t48dRiBKWlW-nzDA\",\n \"token_expires_at\": \"2021-04-22T12:24:55Z\"\n }\n}", "latency": 0, "statusCode": 201, "label": "Refresh room client token response.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "9521cdab-97cd-43f1-ad13-891bcae70c35", "body": "{\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "aeb08d06-b71d-43ee-bf02-e4c18a61c934", "documentation": "View a list of room sessions.", "method": "get", "endpoint": "rooms/:room_id/sessions", "responses": [ { "uuid": "acaed29b-5f4a-4e45-9e89-6fbc80fec369", "body": "{\n \"data\": [\n {\n \"active\": false,\n \"created_at\": \"2021-04-16T09:46:20.954863Z\",\n \"ended_at\": \"2021-04-16T10:24:55.962200Z\",\n \"id\": \"7b61621f-62e0-4aad-ab11-9fd19e272e73\",\n \"participants\": [],\n \"record_type\": \"room_session\",\n \"room_id\": \"7b61621f-5fe4-4aad-ab11-9fd19e272e73\",\n \"updated_at\": \"2021-04-16T10:24:55.962200Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "List room sessions response.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5576104c-7507-48bd-a4c6-b8743b225705", "documentation": "List short codes", "method": "get", "endpoint": "short_codes", "responses": [ { "uuid": "11f5c226-1857-4527-8bd4-cf7260247463", "body": "{\n \"data\": [\n {\n \"country_code\": \"US\",\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"messaging_profile_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"record_type\": \"short_code\",\n \"short_code\": \"12345\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of short codes.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3ae1c2bc-cbd0-4ffe-b4fe-0c693596c8a2", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f25f3238-b9d6-465b-8648-c3371432a392", "documentation": "Retrieve a short code", "method": "get", "endpoint": "short_codes/:id", "responses": [ { "uuid": "a22fba61-dd51-464a-bf41-1b2533132dcb", "body": "{\n \"data\": {\n \"country_code\": \"US\",\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"messaging_profile_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"record_type\": \"short_code\",\n \"short_code\": \"12345\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a short code.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "95a94770-f666-4291-b0f4-77eab354613c", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "1328dad5-9a01-4c4f-ac2d-7dee75daa836", "documentation": "Update short code", "method": "patch", "endpoint": "short_codes/:id", "responses": [ { "uuid": "c3a8ff21-5682-4e11-8ac5-8e6ac67c5e83", "body": "{\n \"data\": {\n \"country_code\": \"US\",\n \"created_at\": \"2019-01-23T18:10:02.574Z\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"messaging_profile_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"record_type\": \"short_code\",\n \"short_code\": \"12345\",\n \"updated_at\": \"2019-01-23T18:10:02.574Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a short code.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "15a90409-e6a0-482c-8c33-cee81a326378", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "63b08f32-3588-4e7d-89f6-1a3325bf3931", "documentation": "List SIM card group actions", "method": "get", "endpoint": "sim_card_group_actions", "responses": [ { "uuid": "4ce6b7b4-4092-46c3-b810-f9371cef23fd", "body": "{\n \"data\": [\n {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"sim_card_group_action\",\n \"settings\": {\n \"private_wireless_gateway_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\"\n },\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"{{oneOf (array 'in-progress' 'completed' 'failed')}}\",\n \"type\": \"{{oneOf (array 'set_private_wireless_gateway' 'remove_private_wireless_gateway')}}\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c44a174c-edd5-4b8b-9832-19dc36aaab2f", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "290d6fd0-5aee-4547-853b-e9b409be04b4", "documentation": "Get SIM card group action details", "method": "get", "endpoint": "sim_card_group_actions/:id", "responses": [ { "uuid": "f880000c-d143-4881-a955-8d2765ff6ee7", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"sim_card_group_action\",\n \"settings\": {\n \"private_wireless_gateway_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\"\n },\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"{{oneOf (array 'in-progress' 'completed' 'failed')}}\",\n \"type\": \"{{oneOf (array 'set_private_wireless_gateway' 'remove_private_wireless_gateway')}}\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "1b5c584f-1875-4652-96fa-5c1b67a9df7f", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "39c193f7-ef8f-4f3c-8977-1381f4403449", "documentation": "Get all SIM card groups", "method": "get", "endpoint": "sim_card_groups", "responses": [ { "uuid": "8736c92d-dedb-4960-a90c-a7ac9d7dae20", "body": "{\n \"data\": [\n {\n \"consumed_data\": {\n \"amount\": 10,\n \"unit\": \"B\"\n },\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"data_limit\": 2048,\n \"default\": true,\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"name\": \"My Test Group\",\n \"private_wireless_gateway_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"sim_card_group\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "4bd68cb9-8ef1-4797-9695-af0be5193d20", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "78e4cbbc-25ea-4324-bc8a-9ddd402668b6", "documentation": "Create a SIM card group", "method": "post", "endpoint": "sim_card_groups", "responses": [ { "uuid": "6fbf4cb1-44bd-425d-a37a-6f6701f8e1ca", "body": "{\n \"data\": {\n \"consumed_data\": {\n \"amount\": 10,\n \"unit\": \"B\"\n },\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"data_limit\": 2048,\n \"default\": true,\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"name\": \"My Test Group\",\n \"private_wireless_gateway_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"sim_card_group\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d75a2cb9-c816-4736-b60c-1e550354ebcd", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b297ba59-2098-4251-8482-ed0d04ecd9fc", "documentation": "Delete a SIM card group", "method": "delete", "endpoint": "sim_card_groups/:id", "responses": [ { "uuid": "874a0a56-9e23-469e-a9be-8454cdb13bbb", "body": "{\n \"data\": {\n \"consumed_data\": {\n \"amount\": 10,\n \"unit\": \"B\"\n },\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"data_limit\": 2048,\n \"default\": true,\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"name\": \"My Test Group\",\n \"private_wireless_gateway_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"sim_card_group\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0837ebcd-f101-42c5-b00c-0a1c126164e4", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "8f3234f0-238d-452d-8588-7d1e10bec666", "documentation": "Get SIM card group", "method": "get", "endpoint": "sim_card_groups/:id", "responses": [ { "uuid": "82255503-f58a-46d1-a464-0b998ead9ef3", "body": "{\n \"data\": {\n \"consumed_data\": {\n \"amount\": 10,\n \"unit\": \"B\"\n },\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"data_limit\": 2048,\n \"default\": true,\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"name\": \"My Test Group\",\n \"private_wireless_gateway_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"sim_card_group\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "5dc5ef70-0335-41e5-9fd9-d0d290e2c4da", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a3b176d4-defc-4f1d-8dc5-98fb9a5b100d", "documentation": "Update a SIM card group", "method": "patch", "endpoint": "sim_card_groups/:id", "responses": [ { "uuid": "f179e423-0b80-44ff-9ed9-74f8fa66a04a", "body": "{\n \"data\": {\n \"consumed_data\": {\n \"amount\": 10,\n \"unit\": \"B\"\n },\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"data_limit\": 2048,\n \"default\": true,\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"name\": \"My Test Group\",\n \"private_wireless_gateway_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"sim_card_group\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "1d14aa7f-2cd3-4c19-bc73-6e2fb4be5833", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "04041ae2-9b55-46a5-9c3c-ffc70bd23e37", "documentation": "Request Private Wireless Gateway removal from SIM card group", "method": "post", "endpoint": "sim_card_groups/:id/actions/remove_private_wireless_gateway", "responses": [ { "uuid": "06e57e64-e051-4452-b2bd-156de70a1df6", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"sim_card_group_action\",\n \"settings\": {\n \"private_wireless_gateway_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\"\n },\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"{{oneOf (array 'in-progress' 'completed' 'failed')}}\",\n \"type\": \"{{oneOf (array 'set_private_wireless_gateway' 'remove_private_wireless_gateway')}}\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 202, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "74c55dbe-56c5-40f7-9cd3-78f449ab5523", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e90ac41f-5446-4d15-a106-affb18ad6b4b", "documentation": "Request Private Wireless Gateway assignment for SIM card group", "method": "post", "endpoint": "sim_card_groups/:id/actions/set_private_wireless_gateway", "responses": [ { "uuid": "61413b4a-e3f3-4e3b-bb57-f5536f08f1db", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"sim_card_group_action\",\n \"settings\": {\n \"private_wireless_gateway_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\"\n },\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"{{oneOf (array 'in-progress' 'completed' 'failed')}}\",\n \"type\": \"{{oneOf (array 'set_private_wireless_gateway' 'remove_private_wireless_gateway')}}\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 202, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "47fc15a5-48cb-4cd6-aae3-f4827b01c5af", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "fbb6db6d-796d-495b-b66d-a850c3a52c89", "documentation": "Preview SIM card orders", "method": "post", "endpoint": "sim_card_order_preview", "responses": [ { "uuid": "189994cc-90be-43bd-85c8-8239f3e2bf6d", "body": "{\n \"data\": {\n \"quantity\": 21,\n \"record_type\": \"sim_card_order_preview\",\n \"shipping_cost\": {\n \"amount\": \"2.32\",\n \"currency\": \"USD\"\n },\n \"sim_cards_cost\": {\n \"amount\": \"2.32\",\n \"currency\": \"USD\"\n },\n \"total_cost\": {\n \"amount\": \"2.32\",\n \"currency\": \"USD\"\n }\n }\n}", "latency": 0, "statusCode": 202, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "eb78fc3d-d358-4dbc-a242-0b46433b0c0b", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check the 'detail' field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a53573c9-6ea1-49a6-be57-ec7807de4488", "documentation": "Get all SIM card orders", "method": "get", "endpoint": "sim_card_orders", "responses": [ { "uuid": "caccafbb-57d3-4751-8ccd-fc52e1f7aae8", "body": "{\n \"data\": [\n {\n \"cost\": {\n \"amount\": \"2.52\",\n \"currency\": \"USD\"\n },\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"order_address\": {\n \"administrative_area\": \"IL\",\n \"country_code\": \"US\",\n \"extended_address\": \"Suite 504\",\n \"id\": \"1293384261075731499\",\n \"locality\": \"Chicago\",\n \"postal_code\": \"60654\",\n \"street_address\": \"311 W Superior St\"\n },\n \"quantity\": 21,\n \"record_type\": \"sim_card_order\",\n \"status\": \"{{oneOf (array 'pending' 'processing' 'ready_to_ship' 'shipped' 'delivered')}}\",\n \"tracking_url\": \"http://www.example.com/\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "352aa3b8-ccf4-4970-9d68-9268fa319982", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "850f9c25-7735-44ae-8eb4-5ba587b77aff", "documentation": "Create a SIM card order", "method": "post", "endpoint": "sim_card_orders", "responses": [ { "uuid": "459e949d-88b3-40f7-8e71-9302e0278d04", "body": "{\n \"data\": {\n \"cost\": {\n \"amount\": \"2.52\",\n \"currency\": \"USD\"\n },\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"order_address\": {\n \"administrative_area\": \"IL\",\n \"country_code\": \"US\",\n \"extended_address\": \"Suite 504\",\n \"id\": \"1293384261075731499\",\n \"locality\": \"Chicago\",\n \"postal_code\": \"60654\",\n \"street_address\": \"311 W Superior St\"\n },\n \"quantity\": 21,\n \"record_type\": \"sim_card_order\",\n \"status\": \"{{oneOf (array 'pending' 'processing' 'ready_to_ship' 'shipped' 'delivered')}}\",\n \"tracking_url\": \"http://www.example.com/\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0f44e9a9-65b4-4b4f-af5b-bcebdc328a3d", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "81015029-b63f-4b11-80d4-ee7eedec0db3", "documentation": "Get a single SIM card order", "method": "get", "endpoint": "sim_card_orders/:id", "responses": [ { "uuid": "fad7b63e-4f51-4257-82f7-4772dbbaba2f", "body": "{\n \"data\": {\n \"cost\": {\n \"amount\": \"2.52\",\n \"currency\": \"USD\"\n },\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"order_address\": {\n \"administrative_area\": \"IL\",\n \"country_code\": \"US\",\n \"extended_address\": \"Suite 504\",\n \"id\": \"1293384261075731499\",\n \"locality\": \"Chicago\",\n \"postal_code\": \"60654\",\n \"street_address\": \"311 W Superior St\"\n },\n \"quantity\": 21,\n \"record_type\": \"sim_card_order\",\n \"status\": \"{{oneOf (array 'pending' 'processing' 'ready_to_ship' 'shipped' 'delivered')}}\",\n \"tracking_url\": \"http://www.example.com/\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0af36d43-eca3-4136-a2c4-bc5b73186344", "body": "{\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d8a7d385-cbad-4539-9839-905211f4717d", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ad16f06e-729d-4608-b0a8-a02faa52198c", "documentation": "Get all SIM cards", "method": "get", "endpoint": "sim_cards", "responses": [ { "uuid": "64e9140f-b23c-4f0f-a606-ff594d686bbc", "body": "{\n \"data\": [\n {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"iccid\": \"89310410106543789301\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"imsi\": 81932214823362980,\n \"msisdn\": \"+13109976224\",\n \"record_type\": \"sim_card\",\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"{{oneOf (array 'registering' 'enabling' 'enabled' 'disabling' 'disabled' 'data_limit_exceeded')}}\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ],\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f72dfe27-272a-476d-a294-719a8fecfa56", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "eabb49bb-7bc0-4abe-af6b-be1080d51394", "documentation": "Validate SIM cards registration codes", "method": "post", "endpoint": "sim_cards/actions/validate_registration_codes", "responses": [ { "uuid": "d0cfe258-019a-4111-86e3-8ca5739adedd", "body": "{\n \"data\": [\n {\n \"invalid_detail\": \"This code has already been used.\",\n \"record_type\": \"sim_card_registration_code_validation\",\n \"registration_code\": 123456789,\n \"valid\": {{faker 'random.boolean'}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "dbc3604c-ce56-41c3-b325-fe87a13585fd", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "44201ebd-c94a-4df4-ac06-80e07806b103", "documentation": "Deletes a SIM card", "method": "delete", "endpoint": "sim_cards/:id", "responses": [ { "uuid": "cc2d277c-945f-4cbd-b812-689c11bd9b71", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"iccid\": \"89310410106543789301\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"imsi\": 81932214823362980,\n \"ipv4\": \"192.168.0.0\",\n \"ipv6\": \"2001:cdba:0000:0000:0000:0000:3257:9652\",\n \"msisdn\": \"+13109976224\",\n \"record_type\": \"sim_card\",\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"{{oneOf (array 'registering' 'enabling' 'enabled' 'disabling' 'disabled' 'data_limit_exceeded')}}\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ],\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "11be7104-1ccf-4c4b-aa86-8512bc243cc9", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "03474879-f630-4175-8bf8-a6ae71e926d6", "documentation": "Get SIM card", "method": "get", "endpoint": "sim_cards/:id", "responses": [ { "uuid": "62cf1f52-e081-4f28-87ed-69d1b135daf4", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"iccid\": \"89310410106543789301\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"imsi\": 81932214823362980,\n \"ipv4\": \"192.168.0.0\",\n \"ipv6\": \"2001:cdba:0000:0000:0000:0000:3257:9652\",\n \"msisdn\": \"+13109976224\",\n \"record_type\": \"sim_card\",\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"{{oneOf (array 'registering' 'enabling' 'enabled' 'disabling' 'disabled' 'data_limit_exceeded')}}\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ],\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e57d00b8-892a-4426-84eb-2f6f6b494bc6", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "537335b6-a65b-4a57-b4fc-2f2509bf8529", "documentation": "Update a SIM card", "method": "patch", "endpoint": "sim_cards/:id", "responses": [ { "uuid": "d56727ac-c8c7-4700-88fb-ca5a10350c6d", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"iccid\": \"89310410106543789301\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"imsi\": 81932214823362980,\n \"ipv4\": \"192.168.0.0\",\n \"ipv6\": \"2001:cdba:0000:0000:0000:0000:3257:9652\",\n \"msisdn\": \"+13109976224\",\n \"record_type\": \"sim_card\",\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"{{oneOf (array 'registering' 'enabling' 'enabled' 'disabling' 'disabled' 'data_limit_exceeded')}}\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ],\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f1381afb-a819-4aa4-9f6d-d5b6ce525d11", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ae7dc2b1-f529-49ca-8656-dda19cc0d682", "documentation": "Request a SIM card disable", "method": "post", "endpoint": "sim_cards/:id/actions/disable", "responses": [ { "uuid": "f99bac20-957b-4ed4-b1e1-70eee9b03b70", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"iccid\": \"89310410106543789301\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"imsi\": 81932214823362980,\n \"msisdn\": \"+13109976224\",\n \"record_type\": \"sim_card\",\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"{{oneOf (array 'registering' 'enabling' 'enabled' 'disabling' 'disabled' 'data_limit_exceeded')}}\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ],\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 202, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "b110e986-819a-425e-a66e-369eb61a32f2", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "3dfe0db4-a190-4731-b2b5-fedcd836bba6", "documentation": "Request a SIM card enable", "method": "post", "endpoint": "sim_cards/:id/actions/enable", "responses": [ { "uuid": "1c0c5ca6-d950-406e-b274-0b2d1fd78509", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"iccid\": \"89310410106543789301\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"imsi\": 81932214823362980,\n \"msisdn\": \"+13109976224\",\n \"record_type\": \"sim_card\",\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"{{oneOf (array 'registering' 'enabling' 'enabled' 'disabling' 'disabled' 'data_limit_exceeded')}}\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ],\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 202, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "32ced9dc-df68-42d6-84c2-77d4c497c49f", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check the 'detail' field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a1d02c42-cf41-4840-af82-1a1f5b38ffd9", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "50a7fc4e-02f7-4c7b-a880-770ece5a363b", "documentation": "Request setting a SIM card to standby", "method": "post", "endpoint": "sim_cards/:id/actions/set_standby", "responses": [ { "uuid": "e850235c-187d-486b-b4e5-ee298fce7880", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"iccid\": \"89310410106543789301\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"imsi\": 81932214823362980,\n \"msisdn\": \"+13109976224\",\n \"record_type\": \"sim_card\",\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"{{oneOf (array 'registering' 'enabling' 'enabled' 'disabling' 'disabled' 'data_limit_exceeded')}}\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ],\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 202, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6fa5ab97-463b-4215-bfa1-0b98ef4d656f", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "fd1225bb-548e-4fc6-ab41-f504dd4998fd", "documentation": "DELETE network preferences", "method": "delete", "endpoint": "sim_cards/:sim_card_id/network_preferences", "responses": [ { "uuid": "ea3c3704-4804-4d8a-be50-a3db0b3047d9", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"mobile_operator_network_name\": \"AT&T Mobility (USACG)\",\n \"priority\": {{faker 'random.number'}}\n }\n ],\n \"ota_updates\": [\n {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"ota_update\",\n \"settings\": {\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"mobile_operator_network_name\": \"AT&T Mobility (USACG)\",\n \"priority\": 0\n }\n ]\n },\n \"sim_card_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"in-progress\",\n \"type\": \"sim_card_network_preferences\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n ],\n \"record_type\": \"sim_card_network_preferences\",\n \"sim_card_id\": \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 202, "label": "A successful network preferences deletion response.

\nThe delete won't be done right away - this is an asynchronous operation. The request will return the resource with an in-progress OTA update resource (in the ota_updates node) representing the delete operation. Similarly to the PUT API, the resource will only be deleted when the OTA updated is successfully completed.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6f1534bd-c942-4dd6-bcf5-bd9fd5323762", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "645b6e72-bf0c-4b7e-a06b-f07b1f565658", "documentation": "Get network preferences", "method": "get", "endpoint": "sim_cards/:sim_card_id/network_preferences", "responses": [ { "uuid": "a36b9691-32e6-4ba8-b9e5-92f116706a26", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"mobile_operator_network_name\": \"AT&T Mobility (USACG)\",\n \"priority\": {{faker 'random.number'}}\n }\n ],\n \"ota_updates\": [\n {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"ota_update\",\n \"settings\": {\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"mobile_operator_network_name\": \"AT&T Mobility (USACG)\",\n \"priority\": 0\n }\n ]\n },\n \"sim_card_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"in-progress\",\n \"type\": \"sim_card_network_preferences\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n ],\n \"record_type\": \"sim_card_network_preferences\",\n \"sim_card_id\": \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A successful network preferences definition response.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "84634c28-c16f-4ac5-bb6d-9d020ce4c648", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "3103796a-7046-4dc4-bbcc-b018c75e941e", "documentation": "Set network preferences", "method": "put", "endpoint": "sim_cards/:sim_card_id/network_preferences", "responses": [ { "uuid": "23cd5fd6-fc23-4e8b-a4fb-40a44e4ac907", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"mobile_operator_network_name\": \"AT&T Mobility (USACG)\",\n \"priority\": {{faker 'random.number'}}\n }\n ],\n \"ota_updates\": [\n {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"ota_update\",\n \"settings\": {\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"mobile_operator_network_name\": \"AT&T Mobility (USACG)\",\n \"priority\": 0\n }\n ]\n },\n \"sim_card_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"in-progress\",\n \"type\": \"sim_card_network_preferences\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n ],\n \"record_type\": \"sim_card_network_preferences\",\n \"sim_card_id\": \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 202, "label": "A successful network preferences definition response.

\nThe sent mobile_operator_networks_preferences parameter won't be applied to the main resource right away - this is an asynchronous operation. While interacting with this API, you will face the following scenarios:\n\n * The first request for this API will return an empty mobile_operator_networks_preferences with an in-progress OTA update resource in the ota_updates node containing the exact sent parameters to indicate the operation progress. The value will be applied to the principal object when the OTA update finishes its processing, thus indicating the SIM card network preference current state. \n * The subsequent requests will contain the current state, that is what's applied to the SIM card settings, and return the related OTA update in the ota_updates node.\n \nThe returned OTA updated (present in the ota_updates node) will, by default, be the resource related to the operation, not all of them.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "66ecb7e2-fc91-4b0e-8bec-4cedd2bccfbc", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "713060cb-d9c3-4eb9-adde-8c067a8bd0da", "documentation": "Delete SIM card public IP", "method": "delete", "endpoint": "sim_cards/:sim_card_id/public_ip", "responses": [ { "uuid": "1aa81be4-742b-4a6f-87c6-e5947513d599", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"ip\": \"192.168.0.0\",\n \"record_type\": \"sim_card_public_ip\",\n \"sim_card_id\": \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"status\": {\n \"error_code\": \"\",\n \"error_description\": \"\",\n \"value\": \"{{oneOf (array 'provisioning' 'provisioned' 'failed' 'decommissioning')}}\"\n },\n \"type\": \"{{oneOf (array 'ipv4')}}\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A successful and synchronous decommission of a public IP. This response happens when no further processing is required. Therefore, a new public IP can be requested right away.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2f96a218-0e9a-4e33-8a56-787f6a9276d3", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"ip\": \"192.168.0.0\",\n \"record_type\": \"sim_card_public_ip\",\n \"sim_card_id\": \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"status\": {\n \"error_code\": \"\",\n \"error_description\": \"\",\n \"value\": \"{{oneOf (array 'provisioning' 'provisioned' 'failed' 'decommissioning')}}\"\n },\n \"type\": \"{{oneOf (array 'ipv4')}}\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 202, "label": "A successful response on an asynchronous operation. The content in this response represents the current status of the public IP. But, it'll change during the operation processing.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "17d0040b-d89b-4ce6-89d7-89c6a72e3614", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "75975d84-3861-4697-9583-a1f57b1bcf73", "documentation": "Get SIM card public IP definition", "method": "get", "endpoint": "sim_cards/:sim_card_id/public_ip", "responses": [ { "uuid": "7d4a11b1-4ce9-4cf5-ac2a-7233c13d152e", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"ip\": \"192.168.0.0\",\n \"record_type\": \"sim_card_public_ip\",\n \"sim_card_id\": \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"status\": {\n \"error_code\": \"\",\n \"error_description\": \"\",\n \"value\": \"{{oneOf (array 'provisioning' 'provisioned' 'failed' 'decommissioning')}}\"\n },\n \"type\": \"{{oneOf (array 'ipv4')}}\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "336f4618-df95-4364-905e-9f2b077357c3", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2693bf43-c7a8-411f-8c4b-613750c27b1b", "documentation": "Set SIM card public IP", "method": "post", "endpoint": "sim_cards/:sim_card_id/public_ip", "responses": [ { "uuid": "71d37da7-24af-4731-a8f0-4b9acaeb8182", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"ip\": \"192.168.0.0\",\n \"record_type\": \"sim_card_public_ip\",\n \"sim_card_id\": \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"status\": {\n \"error_code\": \"\",\n \"error_description\": \"\",\n \"value\": \"{{oneOf (array 'provisioning' 'provisioned' 'failed' 'decommissioning')}}\"\n },\n \"type\": \"{{oneOf (array 'ipv4')}}\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 202, "label": "A successful response on an asynchronous operation. The content in this response represents the current status of the public IP. But, it'll change during the operation processing.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "da9d39c3-03b5-4161-8406-90b0514b466a", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7c813b93-28de-4709-96c7-561122188366", "documentation": "List wireless connectivity logs", "method": "get", "endpoint": "sim_cards/:sim_card_id/wireless_connectivity_logs", "responses": [ { "uuid": "cbca32f7-08ed-458b-a5dc-8534911b3f57", "body": "{\n \"data\": [\n {\n \"apn\": \"data00.telnyx\",\n \"id\": 137509451,\n \"imei\": \"490154203237518\",\n \"imsi\": 81932214823362980,\n \"ipv4\": \"192.168.0.0\",\n \"ipv6\": \"2001:cdba:0000:0000:0000:0000:3257:9652\",\n \"log_type\": \"{{oneOf (array 'registration' 'data')}}\",\n \"mobile_country_code\": \"310\",\n \"mobile_network_code\": \"410\",\n \"radio_access_technology\": \"LTE\",\n \"record_type\": \"wireless_connectivity_log\",\n \"sim_card_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"start_time\": \"2018-02-02T22:25:27.521Z\",\n \"state\": \"provisioned\",\n \"stop_time\": \"2018-02-02T22:25:27.521Z\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e5ac7b1d-1d4d-4fa6-9074-a97082ce25a4", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c7c178b6-24b9-4a08-8740-5d4b54880951", "documentation": "List sub number orders", "method": "get", "endpoint": "sub_number_orders", "responses": [ { "uuid": "3fbf8527-bcea-4cee-8232-8dea80cfede7", "body": "{\n \"data\": [\n {\n \"country_code\": \"US\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"order_request_id\": \"12ade33a-21c0-473b-b055-b3c836e1c293\",\n \"phone_number_type\": \"{{oneOf (array 'local' 'toll-free' 'mobile' 'national' 'shared-cost')}}\",\n \"phone_numbers_count\": 1,\n \"record_type\": \"sub_number_order\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"{{oneOf (array 'textual' 'datetime' 'address' 'document')}}\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\",\n \"user_id\": \"d70873cd-7c98-401a-81b6-b1ae08246995\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with a list of sub number orders.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "b75eae54-57bd-42a5-84d7-242bdd772edd", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "16d19f9e-3d87-4814-8c5a-42f16405db64", "documentation": "Retrieve a sub number order", "method": "get", "endpoint": "sub_number_orders/:sub_number_order_id", "responses": [ { "uuid": "f8e118ec-0351-4546-9555-eb8bdf11ad31", "body": "{\n \"data\": {\n \"country_code\": \"US\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"order_request_id\": \"12ade33a-21c0-473b-b055-b3c836e1c293\",\n \"phone_number_type\": \"{{oneOf (array 'local' 'toll-free' 'mobile' 'national' 'shared-cost')}}\",\n \"phone_numbers_count\": 1,\n \"record_type\": \"sub_number_order\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"{{oneOf (array 'textual' 'datetime' 'address' 'document')}}\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\",\n \"user_id\": \"d70873cd-7c98-401a-81b6-b1ae08246995\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a sub number order.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a8a88391-6914-44db-9510-2dd02a2bda19", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e03a7460-728b-4b8a-afa1-5825733a375a", "documentation": "Update a sub number order", "method": "patch", "endpoint": "sub_number_orders/:sub_number_order_id", "responses": [ { "uuid": "14fda8c1-817c-41b9-8b68-73457612dfda", "body": "{\n \"data\": {\n \"country_code\": \"US\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"order_request_id\": \"12ade33a-21c0-473b-b055-b3c836e1c293\",\n \"phone_number_type\": \"{{oneOf (array 'local' 'toll-free' 'mobile' 'national' 'shared-cost')}}\",\n \"phone_numbers_count\": 1,\n \"record_type\": \"sub_number_order\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"{{oneOf (array 'textual' 'datetime' 'address' 'document')}}\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\",\n \"user_id\": \"d70873cd-7c98-401a-81b6-b1ae08246995\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a sub number order.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "4b7619b7-36a9-4c01-b5bf-598beb6890da", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "912b9d7d-a1ba-4ec8-8e23-0a8c86ea69e1", "documentation": "List all credentials", "method": "get", "endpoint": "telephony_credentials", "responses": [ { "uuid": "2be4aae8-bb11-4850-8ffc-f2a2fb16775a", "body": "{\n \"data\": [\n {\n \"created_at\": \"2020-06-18T21:32:38\",\n \"expired\": \"false\",\n \"expires_at\": \"2042-06-18T21:32:38\",\n \"id\": \"c215ade3-0d39-418e-94be-c5f780760199\",\n \"name\": \"2020-06-18 21:32:38.917732Z\",\n \"record_type\": \"credential\",\n \"resource_id\": \"connection:804252963366242252\",\n \"sip_password\": \"a92dbcfb60184a8cb330b0acb2f7617b\",\n \"sip_username\": \"gencrednCvHU5IYpSBPPsXI2iQsDX\",\n \"updated_at\": \"2020-06-18T21:32:38.000Z\",\n \"user_id\": \"user-id\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with multiple credentials", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "021fc9c5-c881-4f8d-af51-5dccf2015cf1", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6ecab76e-c5a1-4968-9ce8-485ee696b018", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "cfbfdefc-7eac-4060-b76d-01d465f755f6", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d991d63a-d615-4dbd-b322-3320303096dc", "documentation": "Create a credential", "method": "post", "endpoint": "telephony_credentials", "responses": [ { "uuid": "84755d30-3acc-4a3d-afc8-7830294bae5b", "body": "{\n \"data\": {\n \"created_at\": \"2020-06-18T21:32:38\",\n \"expired\": \"false\",\n \"expires_at\": \"2042-06-18T21:32:38\",\n \"id\": \"c215ade3-0d39-418e-94be-c5f780760199\",\n \"name\": \"2020-06-18 21:32:38.917732Z\",\n \"record_type\": \"credential\",\n \"resource_id\": \"connection:804252963366242252\",\n \"sip_password\": \"a92dbcfb60184a8cb330b0acb2f7617b\",\n \"sip_username\": \"gencrednCvHU5IYpSBPPsXI2iQsDX\",\n \"updated_at\": \"2020-06-18T21:32:38.000Z\",\n \"user_id\": \"user-id\"\n }\n}", "latency": 0, "statusCode": 201, "label": "Successful response with details about a credential", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ba88fc35-06f3-4f29-a5e8-b7a1dddee8e7", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b57a54a3-661d-4716-9e89-5ed1515d21f5", "documentation": "List all tags", "method": "get", "endpoint": "telephony_credentials/tags", "responses": [ { "uuid": "afde01a7-adf6-467a-bb90-d4c0bae7bb85", "body": "{\n \"data\": [\n {\n \"amount\": 1,\n \"tag\": \"a_tag\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with multiple tags", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "626981d1-1f1c-4764-948a-98fa8e28424a", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "1224be37-945e-46e7-9b94-90c7b02d88a0", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6cb7032e-4e06-4858-b245-25fa17efd618", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a975f226-b908-4262-8424-4f27b5ee8358", "documentation": "Delete a credential", "method": "delete", "endpoint": "telephony_credentials/:id", "responses": [ { "uuid": "58b04dd9-5bb3-473f-b4a0-1a448e56cbc0", "body": "{\n \"data\": {\n \"created_at\": \"2020-06-18T21:32:38\",\n \"expired\": \"false\",\n \"expires_at\": \"2042-06-18T21:32:38\",\n \"id\": \"c215ade3-0d39-418e-94be-c5f780760199\",\n \"name\": \"2020-06-18 21:32:38.917732Z\",\n \"record_type\": \"credential\",\n \"resource_id\": \"connection:804252963366242252\",\n \"sip_password\": \"a92dbcfb60184a8cb330b0acb2f7617b\",\n \"sip_username\": \"gencrednCvHU5IYpSBPPsXI2iQsDX\",\n \"updated_at\": \"2020-06-18T21:32:38.000Z\",\n \"user_id\": \"user-id\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a credential", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d8aadf85-0b56-478a-9c7c-20bfd953cde7", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "32988ec4-00ba-4935-b8c5-ca74f76f13e9", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a9f7d9de-2b78-4317-a07d-292a7af7ea8c", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "8cd0b4d7-a624-4626-b3ba-84e3e1454f12", "documentation": "Get a credential", "method": "get", "endpoint": "telephony_credentials/:id", "responses": [ { "uuid": "16fe15dc-f548-44ed-a1bf-a603b9a70c84", "body": "{\n \"data\": {\n \"created_at\": \"2020-06-18T21:32:38\",\n \"expired\": \"false\",\n \"expires_at\": \"2042-06-18T21:32:38\",\n \"id\": \"c215ade3-0d39-418e-94be-c5f780760199\",\n \"name\": \"2020-06-18 21:32:38.917732Z\",\n \"record_type\": \"credential\",\n \"resource_id\": \"connection:804252963366242252\",\n \"sip_password\": \"a92dbcfb60184a8cb330b0acb2f7617b\",\n \"sip_username\": \"gencrednCvHU5IYpSBPPsXI2iQsDX\",\n \"updated_at\": \"2020-06-18T21:32:38.000Z\",\n \"user_id\": \"user-id\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a credential", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "b2a40e92-eb61-48c7-b130-23051bc52863", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "fa0fa29d-9671-4149-8e47-55ff344e869f", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a54e4ba2-8895-41ac-9ade-2b282b37c71e", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "beb8e858-2612-452f-9884-1501c05eb4dd", "documentation": "Update a credential", "method": "patch", "endpoint": "telephony_credentials/:id", "responses": [ { "uuid": "e9a1e9dd-e205-47db-b0fe-ac5e0b10ac55", "body": "{\n \"data\": {\n \"created_at\": \"2020-06-18T21:32:38\",\n \"expired\": \"false\",\n \"expires_at\": \"2042-06-18T21:32:38\",\n \"id\": \"c215ade3-0d39-418e-94be-c5f780760199\",\n \"name\": \"2020-06-18 21:32:38.917732Z\",\n \"record_type\": \"credential\",\n \"resource_id\": \"connection:804252963366242252\",\n \"sip_password\": \"a92dbcfb60184a8cb330b0acb2f7617b\",\n \"sip_username\": \"gencrednCvHU5IYpSBPPsXI2iQsDX\",\n \"updated_at\": \"2020-06-18T21:32:38.000Z\",\n \"user_id\": \"user-id\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a credential", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "79ac5ba3-957a-4365-9fbd-e41b07f50f44", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "02cadc1d-0b8f-4658-ac32-a08fbe109888", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "8329ab78-7c49-495b-97e1-34857215f763", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "60bd1948-b3ef-47ce-8225-137b5c92ae5b", "documentation": "Perform activate or deactivate action on provided Credential", "method": "post", "endpoint": "telephony_credentials/:id/actions/:action", "responses": [ { "uuid": "284ee69f-cbb1-4bef-9889-43afccc66a95", "body": "{\n \"data\": {\n \"created_at\": \"2020-06-18T21:32:38\",\n \"expired\": \"false\",\n \"expires_at\": \"2042-06-18T21:32:38\",\n \"id\": \"c215ade3-0d39-418e-94be-c5f780760199\",\n \"name\": \"2020-06-18 21:32:38.917732Z\",\n \"record_type\": \"credential\",\n \"resource_id\": \"connection:804252963366242252\",\n \"sip_password\": \"a92dbcfb60184a8cb330b0acb2f7617b\",\n \"sip_username\": \"gencrednCvHU5IYpSBPPsXI2iQsDX\",\n \"updated_at\": \"2020-06-18T21:32:38.000Z\",\n \"user_id\": \"user-id\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about a credential", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "181bcf1c-e516-4f85-a44c-252a6f70b901", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "aae90657-0d60-4247-ab5d-7db3eb5d1d6b", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "023270f5-769b-4ece-90e6-fda5210d0106", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e1f90e5d-165e-4c21-9032-e1acdfc3e0f7", "documentation": "Create an Access Token.", "method": "post", "endpoint": "telephony_credentials/:id/token", "responses": [ { "uuid": "8a91de96-a9f7-422a-89c6-597e3422c002", "body": "", "latency": 0, "statusCode": 201, "label": "JWT", "headers": [ { "key": "Content-Type", "value": "text/plain" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6d9bda8c-2cd7-42e2-88ab-d9de74817288", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not Found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "79583ca9-de73-4d5c-a708-4b59ded6aeb9", "documentation": "List all TeXML Applications", "method": "get", "endpoint": "texml_applications", "responses": [ { "uuid": "1666a636-1aa5-446a-a44d-da17dad7785f", "body": "{\n \"data\": [\n {\n \"active\": false,\n \"anchorsite_override\": \"Amsterdam, Netherlands\",\n \"created_at\": \"2020-02-02T22:25:27.521Z\",\n \"dtmf_type\": \"Inband\",\n \"first_command_timeout\": true,\n \"first_command_timeout_secs\": 10,\n \"friendly_name\": \"call-router\",\n \"id\": \"1293384261075731499\",\n \"inbound\": {\n \"channel_limit\": 10,\n \"sip_subdomain\": \"example\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\"\n },\n \"outbound\": {\n \"channel_limit\": 10,\n \"outbound_voice_profile_id\": \"1293384261075731499\"\n },\n \"record_type\": \"texml_application\",\n \"status_callback\": \"https://example.com\",\n \"status_callback_method\": \"get\",\n \"updated_at\": \"2020-02-03T22:25:27.521Z\",\n \"voice_fallback_url\": \"https://fallback.example.com\",\n \"voice_method\": \"get\",\n \"voice_url\": \"https://example.com\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3e7988b9-4871-4ab7-9da2-d7890220bfd9", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "4f1c8f02-5732-497a-bf0a-3d9b37dfcd19", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "9d9d0b77-0817-4688-8240-48a2cc78b4fd", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "1171274b-6073-4b3f-bf01-a35afd9fab46", "documentation": "Creates a TeXML Application", "method": "post", "endpoint": "texml_applications", "responses": [ { "uuid": "ae78968b-15c5-4682-b70f-dffd93d4c321", "body": "{\n \"data\": {\n \"active\": false,\n \"anchorsite_override\": \"Amsterdam, Netherlands\",\n \"created_at\": \"2020-02-02T22:25:27.521Z\",\n \"dtmf_type\": \"Inband\",\n \"first_command_timeout\": true,\n \"first_command_timeout_secs\": 10,\n \"friendly_name\": \"call-router\",\n \"id\": \"1293384261075731499\",\n \"inbound\": {\n \"channel_limit\": 10,\n \"sip_subdomain\": \"example\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\"\n },\n \"outbound\": {\n \"channel_limit\": 10,\n \"outbound_voice_profile_id\": \"1293384261075731499\"\n },\n \"record_type\": \"texml_application\",\n \"status_callback\": \"https://example.com\",\n \"status_callback_method\": \"get\",\n \"updated_at\": \"2020-02-03T22:25:27.521Z\",\n \"voice_fallback_url\": \"https://fallback.example.com\",\n \"voice_method\": \"get\",\n \"voice_url\": \"https://example.com\"\n }\n}", "latency": 0, "statusCode": 201, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "112b44b0-8b13-4712-b917-4c67cc3b158d", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "9de476e0-5080-4cb3-ba01-d6f620d837ca", "documentation": "Deletes a TeXML Application", "method": "delete", "endpoint": "texml_applications/:id", "responses": [ { "uuid": "8b3484f5-5857-4ccd-8b52-0c73a8df833b", "body": "{\n \"data\": {\n \"active\": false,\n \"anchorsite_override\": \"Amsterdam, Netherlands\",\n \"created_at\": \"2020-02-02T22:25:27.521Z\",\n \"dtmf_type\": \"Inband\",\n \"first_command_timeout\": true,\n \"first_command_timeout_secs\": 10,\n \"friendly_name\": \"call-router\",\n \"id\": \"1293384261075731499\",\n \"inbound\": {\n \"channel_limit\": 10,\n \"sip_subdomain\": \"example\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\"\n },\n \"outbound\": {\n \"channel_limit\": 10,\n \"outbound_voice_profile_id\": \"1293384261075731499\"\n },\n \"record_type\": \"texml_application\",\n \"status_callback\": \"https://example.com\",\n \"status_callback_method\": \"get\",\n \"updated_at\": \"2020-02-03T22:25:27.521Z\",\n \"voice_fallback_url\": \"https://fallback.example.com\",\n \"voice_method\": \"get\",\n \"voice_url\": \"https://example.com\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c5c85ee7-b8fd-4685-94a4-d947777fd7ad", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c4da774e-bfa5-42bb-8485-4680e08ab1b7", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "29e2e2fe-fe23-4b10-b84f-7bb2c6fd37ab", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "9b073182-1fa9-4c54-b6e9-8505e29dfb6a", "documentation": "Retrieve a TeXML Application", "method": "get", "endpoint": "texml_applications/:id", "responses": [ { "uuid": "13b6df01-5875-4d76-8c62-8bddb5d52d18", "body": "{\n \"data\": {\n \"active\": false,\n \"anchorsite_override\": \"Amsterdam, Netherlands\",\n \"created_at\": \"2020-02-02T22:25:27.521Z\",\n \"dtmf_type\": \"Inband\",\n \"first_command_timeout\": true,\n \"first_command_timeout_secs\": 10,\n \"friendly_name\": \"call-router\",\n \"id\": \"1293384261075731499\",\n \"inbound\": {\n \"channel_limit\": 10,\n \"sip_subdomain\": \"example\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\"\n },\n \"outbound\": {\n \"channel_limit\": 10,\n \"outbound_voice_profile_id\": \"1293384261075731499\"\n },\n \"record_type\": \"texml_application\",\n \"status_callback\": \"https://example.com\",\n \"status_callback_method\": \"get\",\n \"updated_at\": \"2020-02-03T22:25:27.521Z\",\n \"voice_fallback_url\": \"https://fallback.example.com\",\n \"voice_method\": \"get\",\n \"voice_url\": \"https://example.com\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "42b1e982-00e2-4680-aa01-237ce53ad533", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2d3991af-6bca-4ef8-8f0e-85f87d6533d6", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "21b98292-bb60-4578-a99f-e8ac9481e110", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "489facf5-8214-4097-a117-81db7e120b7c", "documentation": "Update a TeXML Application", "method": "patch", "endpoint": "texml_applications/:id", "responses": [ { "uuid": "5d228c19-1d6f-4d24-8b39-da9d17a8322b", "body": "{\n \"data\": {\n \"active\": false,\n \"anchorsite_override\": \"Amsterdam, Netherlands\",\n \"created_at\": \"2020-02-02T22:25:27.521Z\",\n \"dtmf_type\": \"Inband\",\n \"first_command_timeout\": true,\n \"first_command_timeout_secs\": 10,\n \"friendly_name\": \"call-router\",\n \"id\": \"1293384261075731499\",\n \"inbound\": {\n \"channel_limit\": 10,\n \"sip_subdomain\": \"example\",\n \"sip_subdomain_receive_settings\": \"only_my_connections\"\n },\n \"outbound\": {\n \"channel_limit\": 10,\n \"outbound_voice_profile_id\": \"1293384261075731499\"\n },\n \"record_type\": \"texml_application\",\n \"status_callback\": \"https://example.com\",\n \"status_callback_method\": \"get\",\n \"updated_at\": \"2020-02-03T22:25:27.521Z\",\n \"voice_fallback_url\": \"https://fallback.example.com\",\n \"voice_method\": \"get\",\n \"voice_url\": \"https://example.com\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "de9c8fad-f913-4a3c-ac17-47128e5d81d7", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c7ea4ee3-e0b5-4a23-83a9-27c1ed30db76", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "18a464ba-b1ba-4491-9078-8ff34063fb77", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b16a73cc-ea13-46bb-9b6d-5caed825d79f", "documentation": "List verifications by phone number", "method": "get", "endpoint": "verifications/by_phone_number/:phone_number", "responses": [ { "uuid": "0f2bd55d-55a6-4803-82cd-9b9f1ee05d4b", "body": "{\n \"data\": [\n {\n \"call_timeout_secs\": 299,\n \"created_at\": \"2020-09-14T17:03:32.965812\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_number\": \"+13035551234\",\n \"record_type\": \"{{oneOf (array 'verification')}}\",\n \"status\": \"{{oneOf (array 'pending' 'sms_delivery_failed' 'accepted' 'expired' 'not_enough_credit' 'network_error' 'number_unreachable' 'internal_error' 'invalid_destination' 'timed_out')}}\",\n \"timeout_secs\": 300,\n \"updated_at\": \"2020-09-14T17:03:32.965812\",\n \"verification_type\": \"{{oneOf (array 'sms_verification' 'psd2_verification' 'whatsapp_verification' 'call_verification' 'flashcall_verification')}}\",\n \"verify_profile_id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Expected verifications response to a valid request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "adc1f354-2d08-4d25-a522-e4a70a89f851", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 400, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2f9923cc-a2ec-4c4c-ba93-d87994826162", "documentation": "Submit a verification code", "method": "post", "endpoint": "verifications/by_phone_number/:phone_number/actions/verify", "responses": [ { "uuid": "1d9f504c-02b5-4acd-ae67-b441e554892f", "body": "{\n \"data\": {\n \"phone_number\": \"+13035551234\",\n \"response_code\": \"{{oneOf (array 'accepted' 'rejected')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Expected verify response to a valid request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a583e30e-4e08-40e9-a816-226817eb169d", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 400, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5f837bfc-e1fc-4152-a048-077b422563e1", "documentation": "Trigger a Call verification", "method": "post", "endpoint": "verifications/call", "responses": [ { "uuid": "ce1cf977-c278-4e13-a14f-279651329514", "body": "{\n \"data\": {\n \"call_timeout_secs\": 299,\n \"created_at\": \"2020-09-14T17:03:32.965812\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_number\": \"+13035551234\",\n \"record_type\": \"{{oneOf (array 'verification')}}\",\n \"status\": \"{{oneOf (array 'pending' 'sms_delivery_failed' 'accepted' 'expired' 'not_enough_credit' 'network_error' 'number_unreachable' 'internal_error' 'invalid_destination' 'timed_out')}}\",\n \"timeout_secs\": 300,\n \"updated_at\": \"2020-09-14T17:03:32.965812\",\n \"verification_type\": \"{{oneOf (array 'sms_verification' 'psd2_verification' 'whatsapp_verification' 'call_verification' 'flashcall_verification')}}\",\n \"verify_profile_id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Expected verifications response to a valid request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "748094a6-3c76-485a-81d3-e000263e46e9", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 400, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "3ab3fac0-c824-4684-87a8-c07a8e405907", "documentation": "Trigger a Flash call verification", "method": "post", "endpoint": "verifications/flashcall", "responses": [ { "uuid": "1c5b17df-46f9-43de-9720-fea1e0f78be9", "body": "{\n \"data\": {\n \"call_timeout_secs\": 299,\n \"created_at\": \"2020-09-14T17:03:32.965812\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_number\": \"+13035551234\",\n \"record_type\": \"{{oneOf (array 'verification')}}\",\n \"status\": \"{{oneOf (array 'pending' 'sms_delivery_failed' 'accepted' 'expired' 'not_enough_credit' 'network_error' 'number_unreachable' 'internal_error' 'invalid_destination' 'timed_out')}}\",\n \"timeout_secs\": 300,\n \"updated_at\": \"2020-09-14T17:03:32.965812\",\n \"verification_type\": \"{{oneOf (array 'sms_verification' 'psd2_verification' 'whatsapp_verification' 'call_verification' 'flashcall_verification')}}\",\n \"verify_profile_id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Expected verifications response to a valid request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0d650750-ac45-40b2-9576-dc4d4b97e3dc", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 400, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "8f669292-7b47-4cca-859f-3cd8291a7720", "documentation": "Trigger a PSD2 verification", "method": "post", "endpoint": "verifications/psd2", "responses": [ { "uuid": "328f8240-f1ac-4996-b9b5-89242e3d27b2", "body": "{\n \"data\": {\n \"call_timeout_secs\": 299,\n \"created_at\": \"2020-09-14T17:03:32.965812\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_number\": \"+13035551234\",\n \"record_type\": \"{{oneOf (array 'verification')}}\",\n \"status\": \"{{oneOf (array 'pending' 'sms_delivery_failed' 'accepted' 'expired' 'not_enough_credit' 'network_error' 'number_unreachable' 'internal_error' 'invalid_destination' 'timed_out')}}\",\n \"timeout_secs\": 300,\n \"updated_at\": \"2020-09-14T17:03:32.965812\",\n \"verification_type\": \"{{oneOf (array 'sms_verification' 'psd2_verification' 'whatsapp_verification' 'call_verification' 'flashcall_verification')}}\",\n \"verify_profile_id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Expected verifications response to a valid request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "1cf997f6-be1d-4524-b26e-d3f6dc89f8e4", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 400, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "149c475b-2a9e-4ab8-b459-041221b6e327", "documentation": "Trigger a SMS verification", "method": "post", "endpoint": "verifications/sms", "responses": [ { "uuid": "461af0bf-8b82-4936-b341-c806a7ae3314", "body": "{\n \"data\": {\n \"call_timeout_secs\": 299,\n \"created_at\": \"2020-09-14T17:03:32.965812\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_number\": \"+13035551234\",\n \"record_type\": \"{{oneOf (array 'verification')}}\",\n \"status\": \"{{oneOf (array 'pending' 'sms_delivery_failed' 'accepted' 'expired' 'not_enough_credit' 'network_error' 'number_unreachable' 'internal_error' 'invalid_destination' 'timed_out')}}\",\n \"timeout_secs\": 300,\n \"updated_at\": \"2020-09-14T17:03:32.965812\",\n \"verification_type\": \"{{oneOf (array 'sms_verification' 'psd2_verification' 'whatsapp_verification' 'call_verification' 'flashcall_verification')}}\",\n \"verify_profile_id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Expected verifications response to a valid request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "b8c8c765-ed3e-44d2-8a06-827f19b7dc84", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 400, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "cb2b9cfd-849e-44f5-a5ea-b794c36f7d91", "documentation": "Trigger a Whatsapp verification", "method": "post", "endpoint": "verifications/whatsapp", "responses": [ { "uuid": "124f00e2-f33c-4847-8f49-e5e196c6e13d", "body": "{\n \"data\": {\n \"call_timeout_secs\": 299,\n \"created_at\": \"2020-09-14T17:03:32.965812\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_number\": \"+13035551234\",\n \"record_type\": \"{{oneOf (array 'verification')}}\",\n \"status\": \"{{oneOf (array 'pending' 'sms_delivery_failed' 'accepted' 'expired' 'not_enough_credit' 'network_error' 'number_unreachable' 'internal_error' 'invalid_destination' 'timed_out')}}\",\n \"timeout_secs\": 300,\n \"updated_at\": \"2020-09-14T17:03:32.965812\",\n \"verification_type\": \"{{oneOf (array 'sms_verification' 'psd2_verification' 'whatsapp_verification' 'call_verification' 'flashcall_verification')}}\",\n \"verify_profile_id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Expected verifications response to a valid request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "8508b3bc-970e-4388-b807-1e4fd6df0c2b", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 400, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "6170022c-5889-49ac-bc54-cd0a1a168c10", "documentation": "Retrieve a verification", "method": "get", "endpoint": "verifications/:verification_id", "responses": [ { "uuid": "ae9aac4b-45c2-496e-b6b4-83ac79d5ba78", "body": "{\n \"data\": {\n \"call_timeout_secs\": 299,\n \"created_at\": \"2020-09-14T17:03:32.965812\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_number\": \"+13035551234\",\n \"record_type\": \"{{oneOf (array 'verification')}}\",\n \"status\": \"{{oneOf (array 'pending' 'sms_delivery_failed' 'accepted' 'expired' 'not_enough_credit' 'network_error' 'number_unreachable' 'internal_error' 'invalid_destination' 'timed_out')}}\",\n \"timeout_secs\": 300,\n \"updated_at\": \"2020-09-14T17:03:32.965812\",\n \"verification_type\": \"{{oneOf (array 'sms_verification' 'psd2_verification' 'whatsapp_verification' 'call_verification' 'flashcall_verification')}}\",\n \"verify_profile_id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Expected verifications response to a valid request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6fa0a920-3154-4519-947a-02a1309def0d", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 400, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "8f4a44f8-499a-48d6-aa11-e0d2976dab9b", "documentation": "List all Verify profiles", "method": "get", "endpoint": "verify_profiles", "responses": [ { "uuid": "05f135e7-0e28-49bc-b156-46fdaffae391", "body": "{\n \"data\": [\n {\n \"call\": {\n \"default_call_timeout_secs\": 30,\n \"default_verification_timeout_secs\": 300,\n \"speech_template\": \"Hello, this is the Acme Inc verification code you requested: {code}.\"\n },\n \"created_at\": \"2020-09-14T17:03:32.965812\",\n \"flashcall\": {\n \"default_verification_timeout_secs\": 300\n },\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"language\": \"en-US\",\n \"name\": \"Test Profile\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 300\n },\n \"record_type\": \"{{oneOf (array 'verification_profile')}}\",\n \"sms\": {\n \"default_verification_timeout_secs\": 300,\n \"messaging_enabled\": true,\n \"messaging_template\": \"Hello, this is the Acme Inc verification code you requested: {code}.\",\n \"rcs_enabled\": true,\n \"vsms_enabled\": true\n },\n \"updated_at\": \"2020-09-14T17:03:32.965812\",\n \"webhook_failover_url\": \"http://example.com/webhook/failover\",\n \"webhook_url\": \"http://example.com/webhook\",\n \"whatsapp\": {\n \"app_name\": \"Example Secure App\",\n \"default_verification_timeout_secs\": 300\n }\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Expected Verify profile response to a valid request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2fef2f5a-9131-4dab-9a6c-9e123f0a28e4", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 400, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "9c7e3e86-19a2-4d68-a248-ad0a5564f363", "documentation": "Create a Verify profile", "method": "post", "endpoint": "verify_profiles", "responses": [ { "uuid": "f4a90e90-3dee-401d-923c-611b3388f49d", "body": "{\n \"data\": {\n \"call\": {\n \"default_call_timeout_secs\": 30,\n \"default_verification_timeout_secs\": 300,\n \"speech_template\": \"Hello, this is the Acme Inc verification code you requested: {code}.\"\n },\n \"created_at\": \"2020-09-14T17:03:32.965812\",\n \"flashcall\": {\n \"default_verification_timeout_secs\": 300\n },\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"language\": \"en-US\",\n \"name\": \"Test Profile\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 300\n },\n \"record_type\": \"{{oneOf (array 'verification_profile')}}\",\n \"sms\": {\n \"default_verification_timeout_secs\": 300,\n \"messaging_enabled\": true,\n \"messaging_template\": \"Hello, this is the Acme Inc verification code you requested: {code}.\",\n \"rcs_enabled\": true,\n \"vsms_enabled\": true\n },\n \"updated_at\": \"2020-09-14T17:03:32.965812\",\n \"webhook_failover_url\": \"http://example.com/webhook/failover\",\n \"webhook_url\": \"http://example.com/webhook\",\n \"whatsapp\": {\n \"app_name\": \"Example Secure App\",\n \"default_verification_timeout_secs\": 300\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Expected Verify profile response to a valid request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "04c13e0d-7de2-47a0-b4ba-8484b42ec103", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 400, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "3a5cb8de-4b91-408a-8ad2-98ff9298f329", "documentation": "Delete a Verify profile", "method": "delete", "endpoint": "verify_profiles/:verify_profile_id", "responses": [ { "uuid": "ddb60af2-5a14-4dd9-a059-f76f7e7c13b5", "body": "{\n \"data\": {\n \"call\": {\n \"default_call_timeout_secs\": 30,\n \"default_verification_timeout_secs\": 300,\n \"speech_template\": \"Hello, this is the Acme Inc verification code you requested: {code}.\"\n },\n \"created_at\": \"2020-09-14T17:03:32.965812\",\n \"flashcall\": {\n \"default_verification_timeout_secs\": 300\n },\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"language\": \"en-US\",\n \"name\": \"Test Profile\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 300\n },\n \"record_type\": \"{{oneOf (array 'verification_profile')}}\",\n \"sms\": {\n \"default_verification_timeout_secs\": 300,\n \"messaging_enabled\": true,\n \"messaging_template\": \"Hello, this is the Acme Inc verification code you requested: {code}.\",\n \"rcs_enabled\": true,\n \"vsms_enabled\": true\n },\n \"updated_at\": \"2020-09-14T17:03:32.965812\",\n \"webhook_failover_url\": \"http://example.com/webhook/failover\",\n \"webhook_url\": \"http://example.com/webhook\",\n \"whatsapp\": {\n \"app_name\": \"Example Secure App\",\n \"default_verification_timeout_secs\": 300\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Expected Verify profile response to a valid request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6ab2adb4-80bf-43e8-95c4-58b1c4ebf159", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 400, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "756cc23f-afbd-4931-b036-d7b20c74677c", "documentation": "Retrieve a Verify profile", "method": "get", "endpoint": "verify_profiles/:verify_profile_id", "responses": [ { "uuid": "e015f0d7-8bb1-44bb-8697-b73097a12d3c", "body": "{\n \"data\": {\n \"call\": {\n \"default_call_timeout_secs\": 30,\n \"default_verification_timeout_secs\": 300,\n \"speech_template\": \"Hello, this is the Acme Inc verification code you requested: {code}.\"\n },\n \"created_at\": \"2020-09-14T17:03:32.965812\",\n \"flashcall\": {\n \"default_verification_timeout_secs\": 300\n },\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"language\": \"en-US\",\n \"name\": \"Test Profile\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 300\n },\n \"record_type\": \"{{oneOf (array 'verification_profile')}}\",\n \"sms\": {\n \"default_verification_timeout_secs\": 300,\n \"messaging_enabled\": true,\n \"messaging_template\": \"Hello, this is the Acme Inc verification code you requested: {code}.\",\n \"rcs_enabled\": true,\n \"vsms_enabled\": true\n },\n \"updated_at\": \"2020-09-14T17:03:32.965812\",\n \"webhook_failover_url\": \"http://example.com/webhook/failover\",\n \"webhook_url\": \"http://example.com/webhook\",\n \"whatsapp\": {\n \"app_name\": \"Example Secure App\",\n \"default_verification_timeout_secs\": 300\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Expected Verify profile response to a valid request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "822ef786-bac2-4a75-a49c-c06d4401a507", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 400, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "8d10f80b-7280-4497-90ec-2ce5df669e2f", "documentation": "Update a Verify profile", "method": "patch", "endpoint": "verify_profiles/:verify_profile_id", "responses": [ { "uuid": "3146687b-9a5e-4c81-92da-a79b0ee1b706", "body": "{\n \"data\": {\n \"call\": {\n \"default_call_timeout_secs\": 30,\n \"default_verification_timeout_secs\": 300,\n \"speech_template\": \"Hello, this is the Acme Inc verification code you requested: {code}.\"\n },\n \"created_at\": \"2020-09-14T17:03:32.965812\",\n \"flashcall\": {\n \"default_verification_timeout_secs\": 300\n },\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"language\": \"en-US\",\n \"name\": \"Test Profile\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 300\n },\n \"record_type\": \"{{oneOf (array 'verification_profile')}}\",\n \"sms\": {\n \"default_verification_timeout_secs\": 300,\n \"messaging_enabled\": true,\n \"messaging_template\": \"Hello, this is the Acme Inc verification code you requested: {code}.\",\n \"rcs_enabled\": true,\n \"vsms_enabled\": true\n },\n \"updated_at\": \"2020-09-14T17:03:32.965812\",\n \"webhook_failover_url\": \"http://example.com/webhook/failover\",\n \"webhook_url\": \"http://example.com/webhook\",\n \"whatsapp\": {\n \"app_name\": \"Example Secure App\",\n \"default_verification_timeout_secs\": 300\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Expected Verify profile response to a valid request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "7fd68d25-703d-4c89-b662-8727095f6b11", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 400, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "02efecdf-4fc4-4469-99a8-0b47ffcb4417", "documentation": "List webhook deliveries", "method": "get", "endpoint": "webhook_deliveries", "responses": [ { "uuid": "ac9d46d0-7886-465b-82c3-6e6deca73dc2", "body": "{\n \"data\": [\n {\n \"attempts\": [\n {\n \"finished_at\": \"2020-08-10T14:00:05.595Z\",\n \"http\": {\n \"request\": {\n \"headers\": [\n \"Accept: */*\"\n ],\n \"url\": \"https://fallback.example.com/webhooks\"\n },\n \"response\": {\n \"body\": \"All good.\",\n \"headers\": [\n \"Content-Type: text/html\"\n ],\n \"status\": 200\n }\n },\n \"started_at\": \"2020-08-10T14:00:05.364Z\",\n \"status\": \"delivered\"\n },\n {\n \"errors\": [\n {\n \"code\": \"75499\",\n \"detail\": \"The server returned another HTTP 4XX error\",\n \"title\": \"Webhook host returned HTTP 4XX\"\n }\n ],\n \"finished_at\": \"2020-08-10T14:00:05.360Z\",\n \"http\": {\n \"request\": {\n \"headers\": [\n \"Accept: */*\"\n ],\n \"url\": \"https://typo.example.com/webhooks\"\n },\n \"response\": {\n \"body\": \"Oops. Not found.\",\n \"headers\": [\n \"Content-Type: text/html\",\n \"Pragma: no-cache\"\n ],\n \"status\": 404\n }\n },\n \"started_at\": \"2020-08-10T14:00:05.004Z\",\n \"status\": \"failed\"\n }\n ],\n \"finished_at\": \"2020-08-10T14:00:05.595Z\",\n \"id\": \"f5586561-8ff0-4291-a0ac-84fe544797bd\",\n \"record_type\": \"webhook_delivery\",\n \"started_at\": \"2020-08-10T14:00:00.000Z\",\n \"status\": \"{{oneOf (array 'delivered' 'failed')}}\",\n \"user_id\": \"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0\",\n \"webhook\": {\n \"event_type\": \"call_initiated\",\n \"id\": \"C9C0797E-901D-4349-A33C-C2C8F31A92C2\",\n \"occurred_at\": \"2020-08-10T13:02:01.000Z\",\n \"payload\": {\n \"useful\": \"information\"\n },\n \"record_type\": \"event\"\n }\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "A paginated array of webhook_delivery attempts", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6c173481-0a78-4a95-8a6c-b4175b378cc1", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "35be1aeb-75a5-45de-8449-bd225209933c", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "179d0dd7-c21d-478f-b3a9-4a3957ea38ae", "documentation": "Find webhook_delivery details by ID", "method": "get", "endpoint": "webhook_deliveries/:id", "responses": [ { "uuid": "74c517c7-acb7-40ec-b709-91addc3452d0", "body": "{\n \"data\": {\n \"attempts\": [\n {\n \"finished_at\": \"2020-08-10T14:00:05.595Z\",\n \"http\": {\n \"request\": {\n \"headers\": [\n \"Accept: */*\"\n ],\n \"url\": \"https://fallback.example.com/webhooks\"\n },\n \"response\": {\n \"body\": \"All good.\",\n \"headers\": [\n \"Content-Type: text/html\"\n ],\n \"status\": 200\n }\n },\n \"started_at\": \"2020-08-10T14:00:05.364Z\",\n \"status\": \"delivered\"\n },\n {\n \"errors\": [\n {\n \"code\": \"75499\",\n \"detail\": \"The server returned another HTTP 4XX error\",\n \"title\": \"Webhook host returned HTTP 4XX\"\n }\n ],\n \"finished_at\": \"2020-08-10T14:00:05.360Z\",\n \"http\": {\n \"request\": {\n \"headers\": [\n \"Accept: */*\"\n ],\n \"url\": \"https://typo.example.com/webhooks\"\n },\n \"response\": {\n \"body\": \"Oops. Not found.\",\n \"headers\": [\n \"Content-Type: text/html\",\n \"Pragma: no-cache\"\n ],\n \"status\": 404\n }\n },\n \"started_at\": \"2020-08-10T14:00:05.004Z\",\n \"status\": \"failed\"\n }\n ],\n \"finished_at\": \"2020-08-10T14:00:05.595Z\",\n \"id\": \"f5586561-8ff0-4291-a0ac-84fe544797bd\",\n \"record_type\": \"webhook_delivery\",\n \"started_at\": \"2020-08-10T14:00:00.000Z\",\n \"status\": \"{{oneOf (array 'delivered' 'failed')}}\",\n \"user_id\": \"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0\",\n \"webhook\": {\n \"event_type\": \"call_initiated\",\n \"id\": \"C9C0797E-901D-4349-A33C-C2C8F31A92C2\",\n \"occurred_at\": \"2020-08-10T13:02:01.000Z\",\n \"payload\": {\n \"useful\": \"information\"\n },\n \"record_type\": \"event\"\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Webhook delivery record.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "fafba287-bfc0-4b37-8da0-031a721c8471", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d4177912-ea12-49a3-a18f-dfc1c9b574c5", "body": "", "latency": 0, "statusCode": 404, "label": "WebhookDelivery not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "160a4be3-3d71-4da3-9626-e7b0c635c159", "documentation": "Check Contact", "method": "post", "endpoint": "whatsapp_contacts", "responses": [ { "uuid": "d405b906-af6b-4168-a616-ead46ce7233c", "body": "{\n \"data\": [\n {\n \"id\": \"15125551234\",\n \"input\": \"+1 (512) 555-1234\",\n \"record_type\": \"whatsapp_contact\",\n \"status\": \"valid\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response with details about WhatsApp contact(s).", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2a93ab86-2008-48b4-b82b-dbf7e5580a56", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "73cd5398-a7d6-4e37-b440-73d19e42fb10", "documentation": "Fetch all previous requests for WhatsApp detail reports. WhatsApp detail reports are reports for pulling all WhatsApp records. ", "method": "get", "endpoint": "whatsapp_detail_record_reports", "responses": [ { "uuid": "f4c29274-0229-4d54-9c1c-2662173329d6", "body": "{\n \"data\": [\n {\n \"created_at\": \"2020-05-01T00:00:00-06:00\",\n \"download_link\": \"https://portal-cdrs-usage.s3.amazonaws.com\",\n \"end_date\": \"2020-05-01T00:00:00-06:00\",\n \"id\": \"ab76c3b6-80cd-11eb-9439-0242ac130002\",\n \"record_type\": \"whatsapp_detail_record_report\",\n \"start_date\": \"2020-05-01T00:00:00-06:00\",\n \"status\": \"{{oneOf (array 'PENDING' 'COMPLETE' 'FAILED' 'EXPIRED')}}\"\n }\n ],\n \"meta\": {\n \"page_number\": 2,\n \"page_size\": 25,\n \"total_pages\": 3,\n \"total_results\": 55\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "95e741a1-7880-49a2-a04c-bda3684e172a", "documentation": "Submit a request for new WhatsApp detail report. WhatsApp detail report pulls all raw WhatsApp data according to defined filters.", "method": "post", "endpoint": "whatsapp_detail_record_reports", "responses": [ { "uuid": "740c3965-c946-493a-bf1d-f333d63dd687", "body": "{\n \"data\": {\n \"created_at\": \"2020-05-01T00:00:00-06:00\",\n \"download_link\": \"https://portal-cdrs-usage.s3.amazonaws.com\",\n \"end_date\": \"2020-05-01T00:00:00-06:00\",\n \"id\": \"ab76c3b6-80cd-11eb-9439-0242ac130002\",\n \"record_type\": \"whatsapp_detail_record_report\",\n \"start_date\": \"2020-05-01T00:00:00-06:00\",\n \"status\": \"{{oneOf (array 'PENDING' 'COMPLETE' 'FAILED' 'EXPIRED')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "4c204125-56c7-4ca0-8ef9-e6e9408d41c5", "documentation": "Delete generated WhatsApp detail report by id", "method": "delete", "endpoint": "whatsapp_detail_record_reports/:id", "responses": [ { "uuid": "8dc225ce-a6c5-4526-b4ab-f5cab5da8ffc", "body": "{\n \"data\": {\n \"created_at\": \"2020-05-01T00:00:00-06:00\",\n \"download_link\": \"https://portal-cdrs-usage.s3.amazonaws.com\",\n \"end_date\": \"2020-05-01T00:00:00-06:00\",\n \"id\": \"ab76c3b6-80cd-11eb-9439-0242ac130002\",\n \"record_type\": \"whatsapp_detail_record_report\",\n \"start_date\": \"2020-05-01T00:00:00-06:00\",\n \"status\": \"{{oneOf (array 'PENDING' 'COMPLETE' 'FAILED' 'EXPIRED')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e3d117bd-14a8-405c-841f-d675bbd73e65", "documentation": "Fetch single whatsapp detail report by id.", "method": "get", "endpoint": "whatsapp_detail_record_reports/:id", "responses": [ { "uuid": "5b06199a-7e06-4fbc-a6bf-06e2140249d1", "body": "{\n \"data\": {\n \"created_at\": \"2020-05-01T00:00:00-06:00\",\n \"download_link\": \"https://portal-cdrs-usage.s3.amazonaws.com\",\n \"end_date\": \"2020-05-01T00:00:00-06:00\",\n \"id\": \"ab76c3b6-80cd-11eb-9439-0242ac130002\",\n \"record_type\": \"whatsapp_detail_record_report\",\n \"start_date\": \"2020-05-01T00:00:00-06:00\",\n \"status\": \"{{oneOf (array 'PENDING' 'COMPLETE' 'FAILED' 'EXPIRED')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "43141566-d8ed-4e8f-952a-1ddef1e00e25", "body": "{\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d9f2257b-52c4-47a8-b239-9c95fa637bae", "documentation": "Upload Media", "method": "post", "endpoint": "whatsapp_media", "responses": [ { "uuid": "7bc3a5a0-3150-47a5-b415-ddedd47e0994", "body": "{\n \"data\": [\n {\n \"id\": \"f043afd0-f0ae-4b9c-ab3d-696fb4c8cd68\",\n \"record_type\": \"whatsapp_media_id\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6890b6cf-baad-4e1f-81df-6a4a7be8ed89", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "579d89d1-b26c-4446-a900-a7669a47a873", "documentation": "Delete Media", "method": "delete", "endpoint": "whatsapp_media/:whatsapp_user_id/:media_id", "responses": [ { "uuid": "0f12e817-7cac-40a3-95ad-13b5f740f6d8", "body": "", "latency": 0, "statusCode": 204, "label": "Request successful, empty response body.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "b0b8772e-1b94-4b60-a2e8-7d89377355ca", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "01cbe82e-4464-4ac2-9e1c-dc60152d2bfb", "documentation": "Download Media", "method": "get", "endpoint": "whatsapp_media/:whatsapp_user_id/:media_id", "responses": [ { "uuid": "bf77f6a5-5199-4591-8837-43a921c1db2f", "body": "", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "*" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0727bf1f-ec97-4723-840c-c244cd82ffa7", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "bbde1f01-67e9-4965-8df7-81aa6a23e410", "documentation": "Send Message", "method": "post", "endpoint": "whatsapp_messages", "responses": [ { "uuid": "59376ffa-b013-4f89-a95b-aea8b2475f6a", "body": "{\n \"data\": {\n \"id\": \"gBEGkYiEB1VXAglK1ZEqA1YKPrU\",\n \"record_type\": \"whatsapp_message_id\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f2bf6f34-a22e-47b6-958c-4c7b0f681ef9", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b0b42c0b-d085-4e94-a00e-6a312ab37c78", "documentation": "Mark Message As Read", "method": "patch", "endpoint": "whatsapp_messages/:message_id", "responses": [ { "uuid": "27d86233-83d6-4cf7-9094-de43369ecb8e", "body": "", "latency": 0, "statusCode": 204, "label": "Request successful, empty response body.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ddb7d47e-96e2-4364-bc13-9dee25ce7712", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "66113d5c-ee81-4bff-a9ed-4931e8c61abb", "documentation": "Generate and fetch WhatsApp usage aggregations synchronously. This endpoint will both generate and fetch the WhatsApp aggregations over a specified time period. ", "method": "get", "endpoint": "whatsapp_usage_aggregations", "responses": [ { "uuid": "05378e6c-7ed3-4e45-8eb3-1df0d21bd689", "body": "{\n \"data\": [\n {\n \"cost\": {\n \"amount\": \"0.06\",\n \"currency\": \"{{oneOf (array 'AUD' 'CAD' 'EUR' 'GBP' 'USD')}}\"\n },\n \"count\": \"3\",\n \"direction\": \"inbound\",\n \"message_type\": \"template\",\n \"recipient_country_code\": \"1\",\n \"record_type\": \"whatsapp_usage_aggregation\",\n \"status\": \"delivered\",\n \"telnyx_fee\": {\n \"amount\": \"0.06\",\n \"currency\": \"{{oneOf (array 'AUD' 'CAD' 'EUR' 'GBP' 'USD')}}\"\n },\n \"whatsapp_fee\": {\n \"amount\": \"0.06\",\n \"currency\": \"{{oneOf (array 'AUD' 'CAD' 'EUR' 'GBP' 'USD')}}\"\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "8f6b619f-da67-4f48-bc40-4691b154c2e3", "documentation": "Get User", "method": "get", "endpoint": "whatsapp_users/:whatsapp_user_id", "responses": [ { "uuid": "812366be-4793-40d8-85d0-93b36898d53a", "body": "{\n \"data\": {\n \"id\": \"15125551212\",\n \"record_type\": \"whatsapp_user\",\n \"webhook_url\": \"https://mywebhook.com/example/endpoint\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "00420ea7-8100-4b08-9add-e330eaf4b26e", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5c6206fa-2d02-447d-8444-46be7e27ff4e", "documentation": "Update WhatsApp User", "method": "patch", "endpoint": "whatsapp_users/:whatsapp_user_id", "responses": [ { "uuid": "b6c0a54c-e413-4db0-b183-bc438112a010", "body": "", "latency": 0, "statusCode": 204, "label": "Request successful, empty response body.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "9c228462-4628-4125-9840-ae87284146cf", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "52075c3a-da85-4336-ae04-c4acfb10fb25", "documentation": "Get all Wireless Detail Records (WDRs) Reports", "method": "get", "endpoint": "wireless/detail_records_reports", "responses": [ { "uuid": "9484fa7c-e5a1-4c86-868c-ace22219a5d3", "body": "{\n \"data\": [\n {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"end_time\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"detail_records_report\",\n \"report_url\": \"http://example.com\",\n \"start_time\": \"2018-02-02T22:25:27.521Z\",\n \"status\": \"{{oneOf (array 'pending' 'complete' 'failed' 'deleted')}}\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "5fcc1d4c-d630-49f7-a59c-7d742580001d", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "20c0d677-c6a1-4520-88c8-7c11b5ce9d77", "documentation": "Create a Wireless Detail Records (WDRs) Report", "method": "post", "endpoint": "wireless/detail_records_reports", "responses": [ { "uuid": "dd540bac-1dbd-47bf-a518-c4372db4e32a", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"end_time\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"detail_records_report\",\n \"report_url\": \"http://example.com\",\n \"start_time\": \"2018-02-02T22:25:27.521Z\",\n \"status\": \"{{oneOf (array 'pending' 'complete' 'failed' 'deleted')}}\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 201, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "fa11ed91-232a-4849-830f-44bf1b3379cb", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check the 'detail' field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3498acab-58f2-427c-9ce2-28d45e25ad40", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "9e04a6f8-297a-406d-921b-8c7621934c4d", "documentation": "Delete a Wireless Detail Record (WDR) Report", "method": "delete", "endpoint": "wireless/detail_records_reports/:id", "responses": [ { "uuid": "63a63e65-1c63-493e-ac5c-c99d4d30905b", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"end_time\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"detail_records_report\",\n \"report_url\": \"http://example.com\",\n \"start_time\": \"2018-02-02T22:25:27.521Z\",\n \"status\": \"{{oneOf (array 'pending' 'complete' 'failed' 'deleted')}}\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "35d7d403-688b-4857-87eb-a3f75781c05c", "body": "{\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c9757a4e-e5d3-4555-bd30-43f9cf8d234b", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "81d89c2e-d546-4d06-8fa7-6acc14205d44", "documentation": "Get a Wireless Detail Record (WDR) Report", "method": "get", "endpoint": "wireless/detail_records_reports/:id", "responses": [ { "uuid": "2d231da8-696b-405f-8857-9553c3e1efe2", "body": "{\n \"data\": {\n \"created_at\": \"2018-02-02T22:25:27.521Z\",\n \"end_time\": \"2018-02-02T22:25:27.521Z\",\n \"id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"record_type\": \"detail_records_report\",\n \"report_url\": \"http://example.com\",\n \"start_time\": \"2018-02-02T22:25:27.521Z\",\n \"status\": \"{{oneOf (array 'pending' 'complete' 'failed' 'deleted')}}\",\n \"updated_at\": \"2018-02-02T22:25:27.521Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "651effaf-ec63-45e9-a6ad-813e51ff9ab9", "body": "{\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "60094f78-254c-4dd0-97bf-38c268751e90", "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"meta\": {},\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"title\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "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": "" } ] }