{ "uuid": "903740f6-2c74-430d-98bd-25a6c65f841b", "lastMigration": 24, "name": "Telnyx API", "endpointPrefix": "v2", "latency": 0, "port": 3000, "hostname": "0.0.0.0", "routes": [ { "uuid": "f1637e01-1f7b-404f-86e0-215ecfd523f6", "documentation": "Delete several credentials", "method": "delete", "endpoint": "actions/bulk/telephony_credentials", "responses": [ { "uuid": "4cc7de77-b9a9-42ca-be01-71c797358969", "body": "{\n \"data\": {\n \"credentials\": {{faker 'datatype.number'}}\n }\n}", "latency": 0, "statusCode": 201, "label": "Successful response for Bulk credential requests", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "54f50f10-7a6f-441d-95b8-cdc02d9f01de", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "7c5c05a7-bce8-42ee-b00d-daf2aa2517df", "documentation": "Update several credentials", "method": "patch", "endpoint": "actions/bulk/telephony_credentials", "responses": [ { "uuid": "4771ee90-73b3-4beb-bb88-f67849805636", "body": "{\n \"data\": {\n \"credentials\": {{faker 'datatype.number'}}\n }\n}", "latency": 0, "statusCode": 201, "label": "Successful response for Bulk credential requests", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "3c659518-4ec6-4f00-b911-de13318c64ae", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b27aff4a-0acc-464e-863a-ef184dc86299", "documentation": "Creates several credentials", "method": "post", "endpoint": "actions/bulk/telephony_credentials", "responses": [ { "uuid": "d56c1b2c-5aec-41b3-8af9-6568c30a6b18", "body": "{\n \"data\": {\n \"credentials\": {{faker 'datatype.number'}}\n }\n}", "latency": 0, "statusCode": 201, "label": "Successful response for Bulk credential requests", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "a1b88b43-584f-47c2-b875-95bac59b892a", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "7275989f-db60-488f-939b-f98f9316b903", "documentation": "Bulk Network Preferences for SIM cards", "method": "put", "endpoint": "actions/network_preferences/sim_cards", "responses": [ { "uuid": "785e63e4-80a2-4b94-b9d6-ff11c3d8730b", "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 'datatype.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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "a12679dc-5e45-42f8-9053-5066748b5523", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "f71c111f-bc99-470d-a7b0-4ecf1dbc2888", "documentation": "Register SIM cards", "method": "post", "endpoint": "actions/register/sim_cards", "responses": [ { "uuid": "a058483c-f4ec-4794-8a60-66ca7007a850", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "623ad092-b2ec-47f1-8aab-8be20f5fd7dc", "documentation": "Perform activate or deactivate action on all credentials filtered by the provided tag.", "method": "post", "endpoint": "actions/:action/telephony_credentials", "responses": [ { "uuid": "77707d49-19ab-4380-9ecf-5f3fbb511e24", "body": "{\n \"data\": {\n \"credentials\": {{faker 'datatype.number'}}\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response for Bulk credential requests", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "d6b899da-e9ec-4709-80f0-3deb720e0f63", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "6d362088-7343-4a8c-bb4e-7ff69f795e68", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "05e21779-a432-44e1-a7c2-ef34e3bb081d", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "2967d4a8-5997-46b6-b693-acfd25a01ea9", "documentation": "List all addresses", "method": "get", "endpoint": "addresses", "responses": [ { "uuid": "bfc2ca67-a961-45e9-82c5-abb2b61c3fc0", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "013626ed-619b-46a2-97b1-aa6cac99e018", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "9b477723-9645-4d6d-9216-9c41743e2f08", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "9e25530b-e6cb-4678-96a4-a75a4098799a", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "3db54e90-5dc3-4f16-ae0c-ee8c256a1ffa", "documentation": "Creates an address", "method": "post", "endpoint": "addresses", "responses": [ { "uuid": "e4e3b083-9085-4131-aea5-1486dad75b7f", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "a9432e6d-e11b-4234-9d97-30e22741e4d4", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "bf5be8dd-696a-478c-aa62-65c13fe95a94", "documentation": "Validate an address", "method": "post", "endpoint": "addresses/actions/validate", "responses": [ { "uuid": "5a08fe05-d4de-42a4-a968-84cef2ccf6d9", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "f26b625e-bd84-4947-9cd9-a1bca427165e", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "fb6a0822-c610-46be-84e4-f4aa6878d2e8", "documentation": "Deletes an address", "method": "delete", "endpoint": "addresses/:id", "responses": [ { "uuid": "d12903d9-9955-4e2f-aad8-1d6d46bec82c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "afb36a00-9519-44b7-9209-8f98fcd59a6b", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "74a9d571-24af-4ac1-9c86-5d9c8358b9ae", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "1251b2e6-750f-43f7-b5e1-03ec9a569820", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "a281096e-d5a1-4ddf-9da4-d37caefb4fba", "documentation": "Retrieve an address", "method": "get", "endpoint": "addresses/:id", "responses": [ { "uuid": "4c36c08f-187e-457c-95a7-30dae925570c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "ad5b7b70-909c-43bd-9673-b1878e01d580", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "37500ba9-41b1-472c-806c-bf41c88dbbab", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "69d3f696-a3c2-469a-9a24-a5c165237135", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "072b45e6-51b0-4927-acd5-76a668ae6db8", "documentation": "List all SSO authentication providers", "method": "get", "endpoint": "authentication_providers", "responses": [ { "uuid": "c3f98b48-d220-4e0e-8a00-2776552bcc1a", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "3b297b85-494e-4871-aa71-a031333ad6ce", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "a0627076-e322-4a7a-bf21-260a9f4c747d", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "9fc1ed0a-237c-456f-93fa-9e15ea749d7d", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "d01560ee-66d4-478a-aefd-0b7d000082db", "documentation": "Creates an authentication provider", "method": "post", "endpoint": "authentication_providers", "responses": [ { "uuid": "50af09d4-e87e-4a6e-b426-a1cb1bb3d2b7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "3acc11ee-6aa1-4553-99cd-378e600bb943", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "0a229239-b4f1-492e-8d4e-4552496d599f", "documentation": "Deletes an authentication provider", "method": "delete", "endpoint": "authentication_providers/:id", "responses": [ { "uuid": "47245e50-bf91-4d01-a8f2-1de6f8dd618d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "f5305375-660a-4680-ab98-8e40fc3ada2e", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "6facf909-9881-4074-b341-7834b06853e2", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "26af8986-7468-45ca-acac-30aeef1e0733", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "16c812c9-01e0-41e5-98f3-568d244e2c24", "documentation": "Retrieve an authentication provider", "method": "get", "endpoint": "authentication_providers/:id", "responses": [ { "uuid": "1ae7c7df-10ce-4691-98af-99440478f9f4", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "88f8588a-5fdb-457f-a9f5-5c755a1e0b0a", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "3ce0dc25-cedf-4f43-84e0-7c206936efa8", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "ca9aff59-a134-4cc0-b13e-a9e5d0276e61", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "9c6e61d1-770b-4e70-a242-d28ccbba8072", "documentation": "Update a authentication provider", "method": "patch", "endpoint": "authentication_providers/:id", "responses": [ { "uuid": "e1f35e44-1902-45ab-bfa6-4a72c5df0168", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "f0517df2-daab-4f32-afef-9da24fa106ad", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "dab5d378-3384-4dd6-af8e-826dd25b6e72", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "9a303061-8f8c-4cc4-9324-d948fce19d08", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "48f048ab-b5f6-469a-901e-b504d52df614", "documentation": "List available phone number blocks", "method": "get", "endpoint": "available_phone_number_blocks", "responses": [ { "uuid": "20ddb157-cee2-4110-b511-2e3b490bb647", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "0f475b8f-0290-4f20-86d5-0e1fce94393d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "a1c88fb1-8838-44b3-b481-ce0a3869d9cc", "documentation": "List available phone numbers", "method": "get", "endpoint": "available_phone_numbers", "responses": [ { "uuid": "e845d8da-b5a0-4ffb-baca-6faf9c841a3a", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "0051f036-8b5b-42ca-9b59-f39257ab7bf6", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "fd3dd553-745f-4d9d-9478-607d0f2b5390", "documentation": "Retrieve user balance details", "method": "get", "endpoint": "balance", "responses": [ { "uuid": "11d7e861-a9fa-47fa-b881-be7466f655fd", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "80bcdfdb-b961-4d4d-b281-abd773f42501", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "2bd0d22c-682a-427c-b0a7-063c1fd5e1ff", "documentation": "List all billing groups", "method": "get", "endpoint": "billing_groups", "responses": [ { "uuid": "edf53ab6-8264-418c-9a3c-1b588e6436f2", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "ed85fd3b-8720-4b14-bb89-7893fa163c2b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1a6e461c-9a38-4ab1-b722-86c426c128b8", "documentation": "Create a billing group", "method": "post", "endpoint": "billing_groups", "responses": [ { "uuid": "911355c8-8c63-44ec-9450-3a74ec29c260", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "a0958b0d-a599-42f4-95be-2ba2f123e41d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "fb1b2e58-8b0c-4ce3-8b8c-2fc52d396a91", "documentation": "Delete a billing group", "method": "delete", "endpoint": "billing_groups/:id", "responses": [ { "uuid": "be42d7cd-9666-4316-9b6e-d8a6141bb4a7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "98d166a3-64c1-4905-8b80-df71e44dd076", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "5477b14f-bc39-44d0-ab0a-03629eb967e4", "documentation": "Retrieve a billing group", "method": "get", "endpoint": "billing_groups/:id", "responses": [ { "uuid": "bafe2280-85ea-49f3-8b64-aace03daaf4b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "528f6ad6-4008-4f5f-8c2a-b05470ea60af", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "5ca7929b-9504-4afc-bcc4-098d457d9044", "documentation": "Update a billing group", "method": "patch", "endpoint": "billing_groups/:id", "responses": [ { "uuid": "dbc423d6-ab4e-4d7f-99f2-a1f52170e281", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "152b1075-381d-4062-a65b-964922ae96a5", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b95690b7-260b-4e8b-a8bc-c09db4bb49f2", "documentation": "List call control applications", "method": "get", "endpoint": "call_control_applications", "responses": [ { "uuid": "92fcc035-a099-4216-ad4d-6feabf3b7b79", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "f008d506-1373-4dbf-9581-04c63723b52e", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "ad52547d-9d07-46bb-a2e3-c23e5262487b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "0e6e4699-cddf-4394-86eb-aa6227b1ab18", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "5cbf00c0-20d7-49f6-ac93-ae5e6dd2bacd", "documentation": "Create a call control application", "method": "post", "endpoint": "call_control_applications", "responses": [ { "uuid": "75597ad3-b142-4ce8-84e6-0de7671ea4ed", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "a4a2a612-7743-4be4-93e5-b7df41bf2e18", "body": "", "latency": 0, "statusCode": 422, "label": "Bad Request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "dd2c58f4-fa19-4eef-aba9-45ba0cdc2729", "documentation": "Delete a call control application", "method": "delete", "endpoint": "call_control_applications/:id", "responses": [ { "uuid": "16c23705-e37d-4b87-9365-312faad6e075", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "d20f73f6-1357-4c3e-ab8e-28ba892dba3e", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "fd13ec1d-b801-44a1-97c0-1989f7ba7296", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "46484162-4afc-409d-8242-4a5106f19797", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "182daa67-5533-4fb7-83ac-ef40439476c8", "documentation": "Retrieve a call control application", "method": "get", "endpoint": "call_control_applications/:id", "responses": [ { "uuid": "74d53aea-14f8-48b9-8db4-b04cb8e1ff42", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "42891fda-5e20-4423-aa80-6305b3c04f03", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "9cd5c333-c43e-4f40-ab27-3b129c385ebe", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "cb542085-0857-40ed-a478-b687f2416187", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "ef8cee83-d1a6-4e30-a255-fdbf3a449bff", "documentation": "Update a call control application", "method": "patch", "endpoint": "call_control_applications/:id", "responses": [ { "uuid": "779cf7df-637b-4d61-bc67-0153be4955e7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "ba6b106c-bf54-40e6-bfad-95c4307670bd", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "ec6b7bb3-002e-44d7-a070-f4990b1507ac", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "369bdebe-b05f-4b9b-bbc6-4ec9a3549c72", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "6eed8cac-e40d-4ae5-8a3b-7c90890e3464", "documentation": "List call events", "method": "get", "endpoint": "call_events", "responses": [ { "uuid": "8bd6fc28-5739-4840-bdff-1c817aa1c132", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "bd9b763b-4adb-4852-bfd9-480692257811", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "cf7e7937-d3b4-4f19-9cf8-6436f75ecce3", "documentation": "Dial", "method": "post", "endpoint": "calls", "responses": [ { "uuid": "70ce04ab-b4d6-45e1-8f3b-6b6281284c4f", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "0ee96ee2-a3a5-4457-8556-ebbe05cca3c8", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "dc45f135-8839-4b64-8d48-fbe823b81948", "documentation": "Retrieve a call status", "method": "get", "endpoint": "calls/:call_control_id", "responses": [ { "uuid": "c775cb54-fb1b-4e1d-a14c-e5c83e838f61", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "e2a426ba-14d3-471a-85ae-e25318d823d6", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "25d77015-145a-4122-9e9d-21da229febee", "documentation": "Answer call", "method": "post", "endpoint": "calls/:call_control_id/actions/answer", "responses": [ { "uuid": "508e7fd2-32f5-49f4-9cb7-452d3d17763b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "581bc87c-6d8f-4f7c-a747-558d2eac703c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "61031ec4-dfb1-4455-9098-16292c8a1011", "documentation": "Bridge calls", "method": "post", "endpoint": "calls/:call_control_id/actions/bridge", "responses": [ { "uuid": "d3c665a9-ade2-4aef-988e-498d3eacd595", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "bd30c501-3d6a-4e7a-b927-5c96645e1f32", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "2b7cea06-a74c-4aa7-b753-95ef52218c31", "documentation": "Enqueue call", "method": "post", "endpoint": "calls/:call_control_id/actions/enqueue", "responses": [ { "uuid": "c260459a-3f85-419a-922a-a2aa57fc89b9", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "d8cc838e-d955-447a-a263-d6777e24c76f", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "28050dc9-ebb3-45e3-98e2-6c33496bf2d6", "documentation": "Forking start", "method": "post", "endpoint": "calls/:call_control_id/actions/fork_start", "responses": [ { "uuid": "20073147-e6d0-445d-9439-a564624eae16", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "892a16cf-23e2-4caf-a262-dfc4aca1bb21", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "a2c16d59-d795-421c-bfaa-20b3d155faab", "documentation": "Forking stop", "method": "post", "endpoint": "calls/:call_control_id/actions/fork_stop", "responses": [ { "uuid": "b38d8355-6b7a-4860-9719-12fbb3ba8629", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "086a608c-01bb-4924-a3a7-6927e1fe8534", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "89a8b5df-96f5-44c4-9027-37d85c2d5927", "documentation": "Gather stop", "method": "post", "endpoint": "calls/:call_control_id/actions/gather_stop", "responses": [ { "uuid": "1853ea76-abc7-4fd8-9941-d1419fa15986", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "7c7c6466-1c6f-45ea-b645-8b344958885e", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "8c57281f-21dd-4279-9b0c-db6ec21ccdf6", "documentation": "Gather using audio", "method": "post", "endpoint": "calls/:call_control_id/actions/gather_using_audio", "responses": [ { "uuid": "9d261086-5cfc-4b8d-8f95-263f0daf67ac", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "c9c5bdd1-1126-4d1b-8f91-b623d1888222", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "7e9c8e51-6a0e-45e8-a2ce-2b73481d86ae", "documentation": "Gather using speak", "method": "post", "endpoint": "calls/:call_control_id/actions/gather_using_speak", "responses": [ { "uuid": "839a4531-2a80-46d2-b14b-e943029f8100", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "1814ee8c-fe52-4c0e-a3f0-015e24677cb4", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "e8cff73d-2979-4470-94b9-f82bcebcfffe", "documentation": "Hangup call", "method": "post", "endpoint": "calls/:call_control_id/actions/hangup", "responses": [ { "uuid": "49710233-8887-403e-bdc3-d80ae4590e72", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "6e0a8bfe-0c61-4e44-8543-61ba07045c52", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "5a3234d2-fc9f-4b2c-b9f6-202fd5229f3c", "documentation": "Remove call from a queue", "method": "post", "endpoint": "calls/:call_control_id/actions/leave_queue", "responses": [ { "uuid": "a33ed204-23e6-4f91-8f13-f14be6209036", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "1da2c93e-5ec8-4876-8ea3-a68f9bcc8689", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b25c9d13-46b8-478a-9ebb-f5b88c4c2082", "documentation": "Play audio URL", "method": "post", "endpoint": "calls/:call_control_id/actions/playback_start", "responses": [ { "uuid": "291c361d-6ca7-4a50-911e-58d3fc8d0c98", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "83a6a53c-b0d3-42c9-8800-a22841dc0860", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "72c4fe93-a360-48ad-8542-f759768f9914", "documentation": "Stop audio playback", "method": "post", "endpoint": "calls/:call_control_id/actions/playback_stop", "responses": [ { "uuid": "c1faf803-05ac-435e-b967-a97a6d3be413", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "6b2bc92c-6f5c-4809-9e21-f5901c4e5ba6", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b880f44d-8b89-4b9c-8c53-27a6701d5169", "documentation": "Record pause", "method": "post", "endpoint": "calls/:call_control_id/actions/record_pause", "responses": [ { "uuid": "a85236ec-cc8c-4ab0-88b7-a1be9d039d18", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "f46aa924-adad-4860-8ae0-9c0f4a853da0", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1beb481f-d743-48cb-b241-785682ae8b35", "documentation": "Record resume", "method": "post", "endpoint": "calls/:call_control_id/actions/record_resume", "responses": [ { "uuid": "679ff89a-0aa7-4854-b10d-d654b7ee013d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "d69926a5-aea1-46cb-bbe8-49e200560dd4", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "60a28244-e70b-410d-ae36-6c01ff92c3d7", "documentation": "Recording start", "method": "post", "endpoint": "calls/:call_control_id/actions/record_start", "responses": [ { "uuid": "17ed375a-77df-499a-b62b-9e7b7e675ca1", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "ecac114a-8b42-4686-bad9-9f27ce90f20c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "dfcb7cc6-fb8c-4e90-8306-c5f96a893d45", "documentation": "Recording stop", "method": "post", "endpoint": "calls/:call_control_id/actions/record_stop", "responses": [ { "uuid": "f626ea97-7862-4d7a-8984-052d6fd383fa", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "5b875ca5-ecf5-4331-9aba-d4e6b73c58fb", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "c22fdfaa-3e36-4c13-9df1-1c3c932971e8", "documentation": "SIP Refer a call", "method": "post", "endpoint": "calls/:call_control_id/actions/refer", "responses": [ { "uuid": "8258a6d8-7ed6-4a0a-b57e-4342756b3c84", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "1f5e6a23-4cc1-42a4-9749-10fd6a1ad282", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "2694b4b6-13e6-4fe3-a587-f124deaeb2e5", "documentation": "Reject a call", "method": "post", "endpoint": "calls/:call_control_id/actions/reject", "responses": [ { "uuid": "6b8aeccb-93e5-4d20-9608-ffe190895818", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "32096b7e-96c6-4f89-aa05-a3dc4d7ea1ef", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "7f16794f-6d27-4011-a3fd-dd6cc00dbf97", "documentation": "Send DTMF", "method": "post", "endpoint": "calls/:call_control_id/actions/send_dtmf", "responses": [ { "uuid": "1f6b6d18-2ffc-4c78-b48e-216ae7176a52", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "bd8ef4e0-cf40-42a2-a543-1aa6d94509e5", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "01aa205a-9d50-47af-98e1-6ba252c80c0f", "documentation": "Speak text", "method": "post", "endpoint": "calls/:call_control_id/actions/speak", "responses": [ { "uuid": "86498494-a090-4ec6-948b-0da5db66c177", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "ee3cfef8-351f-4ce4-9e24-3896598057d7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1fc25bbc-69e9-471d-b195-cdcfdebda605", "documentation": "Transcription start", "method": "post", "endpoint": "calls/:call_control_id/actions/transcription_start", "responses": [ { "uuid": "52b0af70-9255-4735-97bd-aaf25bbd7d6a", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "d92d5285-d713-44a9-ae9b-344cd8b03787", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "c98dd1a9-ddb5-469d-a931-6d344e060ddc", "documentation": "Transcription stop", "method": "post", "endpoint": "calls/:call_control_id/actions/transcription_stop", "responses": [ { "uuid": "70b1420c-dd52-46eb-936c-f1222be9a40c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "9578ce53-24c1-46ea-82c0-2c1f3500fcbc", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "9bad75e2-0982-4dfb-82df-77949ccc9090", "documentation": "Transfer call", "method": "post", "endpoint": "calls/:call_control_id/actions/transfer", "responses": [ { "uuid": "bab4a81d-71be-4069-b804-e364decc149f", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "def8b4d1-83dc-4b43-aaea-fdf7c304b9a4", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1b5ed97f-cff3-4424-ac95-c3f74bb35c07", "documentation": "Retrieve all comments", "method": "get", "endpoint": "comments", "responses": [ { "uuid": "dc44dff7-89d6-4a4a-842a-e18f3580dd5c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "b3b3b9a0-298c-400e-9c29-7b5ec273edac", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "3ef6c240-be3c-483a-ab76-3eff88f9df69", "documentation": "Create a comment", "method": "post", "endpoint": "comments", "responses": [ { "uuid": "781f6a90-a9d0-452a-bb43-c5dbeefadf0b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "342e95b7-148d-4062-ac83-7e22826559e3", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "bcabb2e6-4b96-4df5-9ec7-beb0587bfed2", "documentation": "Retrieve a comment", "method": "get", "endpoint": "comments/:id", "responses": [ { "uuid": "e4a51ed4-4858-4a1d-9dd7-9092e70ee247", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "0e0c6a7f-2b7d-4d45-a726-3947fafd284c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "85251963-c64f-4878-a845-d94f15882685", "documentation": "Mark a comment as read", "method": "patch", "endpoint": "comments/:id/read", "responses": [ { "uuid": "9ebc7897-7f2a-4e7a-98e5-1870d2e91284", "body": "{\n \"data\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "A Comment Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "0277d1e5-b2dc-4a1f-9ed8-93554f05e081", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "16d1e882-4479-430f-be1d-86b96a768d3c", "documentation": "List conferences", "method": "get", "endpoint": "conferences", "responses": [ { "uuid": "1244f4e8-f9d6-437e-aa4c-2351bc8c7df0", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "8a7ff559-9152-4c07-820b-81799fb5c5d3", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "32654b8b-6e55-4957-a44f-129a6ae8d311", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "324490e8-05fc-4106-beeb-ae12b01adad3", "documentation": "Create conference", "method": "post", "endpoint": "conferences", "responses": [ { "uuid": "9379ae17-e55d-47a5-9e99-ce82351b8b15", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "fea33fee-f3fb-4f02-81f6-f0d5037a66ae", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "c49e01cc-7b3a-421d-a169-128a73b0ff1f", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "650db730-e908-4fbe-91d4-5fe76e2cc060", "documentation": "List conference participants", "method": "get", "endpoint": "conferences/:conference_id/participants", "responses": [ { "uuid": "08c569fe-feaf-4a5c-a498-790740c04bb8", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "d971ee71-7673-4519-a54d-e4a39c4fbbe1", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "8ce8d28b-2b7c-44fe-9d7b-ca7cbd90e8e5", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "49fa6d1f-779f-4dc3-af95-bbb3ee80d182", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "f82d4c9d-7233-4e98-a207-8c99669e937f", "documentation": "Retrieve a conference", "method": "get", "endpoint": "conferences/:id", "responses": [ { "uuid": "147c3954-f369-4431-82d3-81e7ba4a3b5a", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "82017b32-cdb1-4570-b3b2-073a58ee543e", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "606a82c3-fa72-4c29-9389-0c3828a9f0db", "documentation": "Dial a new participant into a conference", "method": "post", "endpoint": "conferences/:id/actions/dial_participant", "responses": [ { "uuid": "eeb45ff5-4232-4cc7-911d-949194a495d7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "c832306a-af2a-4166-b168-91516e5ce371", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "240aea14-3a71-452c-975d-d9719430e3a4", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "5b62fbd6-4e8f-4f86-8f10-96bddf04c44a", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "d5427725-18e6-49da-80da-9390b3dab755", "documentation": "Hold conference participants", "method": "post", "endpoint": "conferences/:id/actions/hold", "responses": [ { "uuid": "d0fe1c90-8564-496a-851d-bdf5d016a8af", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "31ee7aa9-5763-41d3-9106-290e9c77475b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "25646204-ecef-4189-8ffb-a722c0176864", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "38fdeec2-5081-49e7-9798-33df5884e763", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "c67b9a08-510b-4ec0-ae62-d45a71e8d699", "documentation": "Join a conference", "method": "post", "endpoint": "conferences/:id/actions/join", "responses": [ { "uuid": "cd203edf-5da5-4d59-a32a-4bd70865a40b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "65530cc4-e054-411e-b582-71574e0577a4", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "692962f6-574d-4fc0-b36e-e320e5727a8f", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1ad027f7-4dbd-4043-8e30-4d120dfd8d9b", "documentation": "Leave a conference", "method": "post", "endpoint": "conferences/:id/actions/leave", "responses": [ { "uuid": "e124a422-a930-4feb-9764-070dd351ee24", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "6bbecad1-9c20-4840-aca1-5854bde31909", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "83dc4320-e4ee-4af6-b86b-50c539e3b0ac", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "6a0b5a95-cb64-4f54-97ba-6983935849cb", "documentation": "Mute conference participants", "method": "post", "endpoint": "conferences/:id/actions/mute", "responses": [ { "uuid": "f17426c1-7d93-4f7e-b39a-189f5ab4c461", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "9acc1463-db20-49e3-8e7d-0bcc7e83839a", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "301a76a3-4f22-48a0-bdec-82aad45b7166", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "d17fbf2d-0fb8-4423-a6b4-8786c775e18f", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1cf40e69-1b34-452c-9681-760527d88cf4", "documentation": "Play audio to conference participants", "method": "post", "endpoint": "conferences/:id/actions/play", "responses": [ { "uuid": "a19099cb-d98d-4610-9037-9dca26eb99e6", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "81411c03-8e6e-44c7-ae5c-203c3d25c25d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "850a4bdb-e0bc-4df8-8e6d-d23da9d2c594", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "f3535fda-f853-4834-89b5-051d2f3f25da", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "7882e896-1056-4be0-980d-64a4fa490c9c", "documentation": "Conference recording start", "method": "post", "endpoint": "conferences/:id/actions/record_start", "responses": [ { "uuid": "44781b8a-dc73-4ca5-b8ff-4197237b53aa", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "541e7a0d-0369-4450-bec4-1701ce722015", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "b2df681c-7325-4bf0-b72e-bb7bbbaf90be", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "a9f27ce8-6db8-4bdf-9fcb-f04151516aa8", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "a0b5d4ed-4362-4f99-8b9b-d8ea9e9852b1", "documentation": "Conference recording stop", "method": "post", "endpoint": "conferences/:id/actions/record_stop", "responses": [ { "uuid": "337a914f-52fb-429f-b7e6-e8b2db0159d7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "b2ddc2ec-177c-4695-9ec2-c2dac3bfee84", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "67631e79-ae23-452d-bd4b-2899e45e6190", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "aa18d619-7105-4b47-aa41-a8d6049aa0b0", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "d3f2548c-dbe8-4b40-b15c-db91088843aa", "documentation": "Speak text to conference participants", "method": "post", "endpoint": "conferences/:id/actions/speak", "responses": [ { "uuid": "c250f54b-51fa-4d77-b6ca-b5ed50cd8b25", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "b545f824-de64-43eb-948f-603d6688aa79", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "db32e1b5-075f-4134-ad25-97efa7343095", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "252a6ba4-d0f3-44f2-aea2-d0f44cee16e8", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "90757320-00b1-4ed3-b301-bac7684687b0", "documentation": "Stop audio being played on the conference", "method": "post", "endpoint": "conferences/:id/actions/stop", "responses": [ { "uuid": "3f41f4a2-0a0c-4424-8974-fa334774641d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "826055fa-76f1-4e4e-9ad0-b729c4f6e7d7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "d3f0eb88-c31a-49d3-baa1-7417626e904f", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "870ecbfd-1071-480d-937d-7373e140a7cc", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "2f630e6b-087f-46cb-9b89-8f6bd4465638", "documentation": "Unhold conference participants", "method": "post", "endpoint": "conferences/:id/actions/unhold", "responses": [ { "uuid": "59027626-8c83-4101-b959-e0c2d393f1e6", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "7dc96281-fead-4b77-ac11-b32b75ce48a7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "d5441d06-9170-4468-b18c-639311561ee8", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "fe9f2a30-4146-4921-a163-f59d0c0d7b56", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "3f1daf5f-4dea-48dd-881b-a814af7c09ab", "documentation": "Unmute conference participants", "method": "post", "endpoint": "conferences/:id/actions/unmute", "responses": [ { "uuid": "054a5613-f1cc-4fd1-a3eb-ec0b9d332f0b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "4dcd7eeb-d01f-499e-93d3-3ff8304cde61", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "2c4ffcaf-4893-42df-a358-9f30ebfd82c7", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "5aa3f735-db28-4f25-8660-fe7984b3fa27", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "a2f9bba6-52cd-410a-a6e5-bfba1a5c1c9b", "documentation": "Update conference participant", "method": "post", "endpoint": "conferences/:id/actions/update", "responses": [ { "uuid": "094b4541-8b14-4ff4-88d6-c52abe44bf3a", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "7512285b-8787-4ad6-88fc-6520324cdac6", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "5e011780-5aac-43b5-92f9-0bfd9d628df0", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "2e9ce13a-d72d-4b13-8e0f-1f798bf03814", "documentation": "List connections", "method": "get", "endpoint": "connections", "responses": [ { "uuid": "43034307-26a9-44ae-8351-a3626a6b045f", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "f10ec219-3f03-4d86-843d-db480c53e5a7", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "d3ca09c9-6558-4026-ab86-555d8801131c", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "d6823569-2e55-4a4c-b1d7-c555db6b08fe", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "eef5c757-8214-45c7-ac89-41b375eb9594", "documentation": "Retrieve a connection", "method": "get", "endpoint": "connections/:id", "responses": [ { "uuid": "e897f6a2-2d9e-4e30-a4a8-811399dfa726", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "b1932735-e4ec-493f-8bf3-a3419509115a", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "a3284e74-adab-4f77-bb6a-16bdd2480b35", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "505d8bad-260f-4b37-9de2-799b2bd3ff81", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "7907bb79-52f7-49e3-991f-3b7e4d5406b0", "documentation": "List credential connections", "method": "get", "endpoint": "credential_connections", "responses": [ { "uuid": "26154722-f35c-4260-b63c-01056b415818", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "efca8a53-e2fc-4483-b396-8162c86873f3", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "c26035c3-d343-4bdc-b3c7-2e76f7549456", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "0958ab31-8ec5-4120-8df2-6b0d445b261c", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "35a051b2-64ad-4282-baa0-1292aa5daf10", "documentation": "Create a credential connection", "method": "post", "endpoint": "credential_connections", "responses": [ { "uuid": "4fe28b49-5a2a-487f-adb7-f03fd5974702", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "7fb1f532-8a2b-41c1-99e3-60b55c4a6d2e", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "9d40cb7e-324a-4151-8975-4ffef4ef1727", "documentation": "Delete a credential connection", "method": "delete", "endpoint": "credential_connections/:id", "responses": [ { "uuid": "f9cc7d8b-430b-435b-925c-0655e826338e", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "39c6b509-0c93-4a55-aa64-9d67a4378234", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "dd038da1-91a6-440d-b5a8-497224f88d83", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "d620c24d-e459-4120-8bbd-b34152ee6a38", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "f7e1eef4-59fe-43e5-9707-4f34aa8bbea7", "documentation": "Retrieve a credential connection", "method": "get", "endpoint": "credential_connections/:id", "responses": [ { "uuid": "dcc416b6-b534-496b-8c3c-3bb7b5b3f918", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "80e74574-df7e-474f-b2c3-f8e8c201094b", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "91a7235f-fd57-4cbd-a514-b93998e765f3", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "8211969c-4b74-4a72-8020-40fe924e4225", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "ca004519-dcc4-43bb-9cd1-8930aa42041f", "documentation": "Update a credential connection", "method": "patch", "endpoint": "credential_connections/:id", "responses": [ { "uuid": "d60b95ea-8c33-46c7-882e-cae8e39333bf", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "7cbd34c8-d370-43ab-980a-5964ed5ed4da", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "a860442a-8e11-4d3a-a02b-74e3f3aa6279", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "f11eb20f-7aad-4b01-8621-ab84716ad840", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "78958b41-e00a-402c-ab48-7a8d2c314811", "documentation": "Search detail records", "method": "get", "endpoint": "detail_records", "responses": [ { "uuid": "b4379b91-2e40-4bcc-97ce-90e775e0f4ed", "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 'datatype.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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "edfe222b-e447-4b0c-8374-7ebad9c9b964", "documentation": "List all document links", "method": "get", "endpoint": "document_links", "responses": [ { "uuid": "230a3cbe-a19e-4f51-8066-5280ca427e31", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "2167c527-7259-4291-a2c6-b5ee16221037", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "0e81c8de-2934-4874-8cfc-b9c6813b70d4", "documentation": "List all documents", "method": "get", "endpoint": "documents", "responses": [ { "uuid": "b411da80-d533-4fff-8478-5dac3d2f3c95", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "c9e54618-3845-493b-8fb3-d14c171dd364", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "87759646-a520-4f8c-8f97-261f274cadba", "documentation": "Upload a document", "method": "post", "endpoint": "documents", "responses": [ { "uuid": "d2caaddc-b9bf-4d7c-bc23-2ca157206b4b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "217c1470-2262-4a08-832e-2352558c10fc", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "64687104-24f7-47d1-9a0b-de7819db4bdf", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b325340e-08b8-4adf-b0ad-5b6d879677bb", "documentation": "Delete a document", "method": "delete", "endpoint": "documents/:id", "responses": [ { "uuid": "75f355e6-ad64-46cf-bcac-0d20d79ed565", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "ddc601bd-1f89-47f0-996b-309bcf709930", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "35289abf-8cce-4569-b9a8-45a236c33df4", "documentation": "Retrieve a document", "method": "get", "endpoint": "documents/:id", "responses": [ { "uuid": "343e850f-20dd-4711-ba92-45c1b4372191", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "bc8cb882-ea0f-46ac-81f0-f54bb2f74c60", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "91ae2f07-c916-4a87-97bb-7546ecaa33a5", "documentation": "Update a document", "method": "patch", "endpoint": "documents/:id", "responses": [ { "uuid": "033d0a22-d39c-4a15-bbd7-c87eb68940bc", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "cf1a8715-5275-4bb8-beac-2b3489cfce37", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "7b1e73e2-de87-462f-b23f-6d3c26d4ea35", "documentation": "Download a document", "method": "get", "endpoint": "documents/:id/download", "responses": [ { "uuid": "4062ce62-3669-4555-baf2-9af9d2ad0de0", "body": "", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "*" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "8804ca97-9f77-4ab1-8db1-576d789aa6d7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b2ffba9b-2385-4d24-9cb4-81e2bbe9c97c", "documentation": "List all Fax Applications", "method": "get", "endpoint": "fax_applications", "responses": [ { "uuid": "931200e2-f72e-4677-9595-83f6b43f0333", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "4618ff67-ea5c-4507-964f-f7f29e4045f9", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "0a065ab6-b7a5-481f-ac67-a5e5d76e249c", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "5c6780f1-96bb-4c51-a876-1977dd17b1a9", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "3b2e91c6-4fb7-4932-a42b-d8742781ca87", "documentation": "Creates a Fax Application", "method": "post", "endpoint": "fax_applications", "responses": [ { "uuid": "e3777ae1-f3b2-4a97-b5b2-83bb4dc46a25", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "75cbd4f2-09ef-47a7-9513-05eacd020fb0", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "aec1314a-407a-406d-bc04-993a7bc686a0", "documentation": "Deletes a Fax Application", "method": "delete", "endpoint": "fax_applications/:id", "responses": [ { "uuid": "ef83ec5d-fa6f-4c58-8d42-b9ae37e84613", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "ae7f5578-9655-4fd1-82dc-fab439d34acc", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "be8e248a-889f-4b8b-a42f-e99f544e07da", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "f66094bf-ff47-4b01-969c-8e88001fd022", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "c72b36d4-3404-4755-ba1f-349888d32a9f", "documentation": "Retrieve a Fax Application", "method": "get", "endpoint": "fax_applications/:id", "responses": [ { "uuid": "b1d749f1-aed2-40f8-8100-74200b453821", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "6d26d689-fdb6-4b21-bed6-0a59429d2e36", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "ac1dcbda-694a-4333-9cae-1a0c22439621", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "b2e43a4f-c6f8-4c26-a51f-4bf0fe29f892", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "7735ebc8-69ad-4259-9ceb-afcf5626855c", "documentation": "Update a Fax Application", "method": "patch", "endpoint": "fax_applications/:id", "responses": [ { "uuid": "5d957d28-b6c1-46b8-8a23-57fe8593de12", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "3c04eced-ee2e-4ca3-b1a8-b31c70d60cd5", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "a64ac588-7b35-48a4-b2aa-dcf6947bde46", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "2e02e0af-e945-43ea-843a-4dc47ae5f40e", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "0edbcd9b-5f88-465b-8f13-9b2d8e0b6389", "documentation": "View a list of faxes", "method": "get", "endpoint": "faxes", "responses": [ { "uuid": "67d083cd-476a-4e50-9188-663623ce9b89", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "9d498368-41b4-4685-b178-85e7fd373b2b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "f33cd3d9-5fa1-4c0c-aafe-7c21349029ba", "documentation": "Send a fax", "method": "post", "endpoint": "faxes", "responses": [ { "uuid": "b949fc15-e904-4075-85b9-3d7c975a3001", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "6dc33ceb-be51-4bd9-8d64-1e2b997e2ecf", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1baa8ee7-a234-40d5-8459-be88cf55fe0d", "documentation": "Delete a fax", "method": "delete", "endpoint": "faxes/:id", "responses": [ { "uuid": "faef024b-4c84-4a97-b9aa-c1868121c38e", "body": "", "latency": 0, "statusCode": 204, "label": "The resource was deleted successfully.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "d1003081-a1f5-4612-b70e-4e3fb2bafb91", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "a06eb237-9c02-4f08-968d-e522df29738b", "documentation": "View a fax", "method": "get", "endpoint": "faxes/:id", "responses": [ { "uuid": "fead8992-9c46-4775-a21e-1839db530dd7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "7eb05c98-2109-45c4-9327-d1517e83fd6f", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "8bb5e754-5eae-43cf-95fc-41b85a98a5ae", "documentation": "Refresh a fax", "method": "post", "endpoint": "faxes/:id/actions/refresh", "responses": [ { "uuid": "54cded73-dbdd-438d-8b56-e2c462f4b31a", "body": "{\n \"data\": {\n \"result\": \"ok\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Refresh fax response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "796a6780-3a9d-4c62-9335-3d666592da18", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "283a3bd5-5942-4004-83db-d2a0b6e2ebc6", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "07713969-97d4-4dd9-9d64-47e2d9dd9e36", "documentation": "List FQDN connections", "method": "get", "endpoint": "fqdn_connections", "responses": [ { "uuid": "be9b0571-b816-4243-95db-d956ed338d30", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "219b3cf5-0115-40ee-8255-1b1d5f7c2a4e", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "4f23c558-7c57-4a0c-8203-8ef35b3f53ec", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "33be066a-67a1-4e06-b4ec-04de0eac5849", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "8b3835b9-f05a-4df6-9f9c-9f51708a022d", "documentation": "Create an FQDN connection", "method": "post", "endpoint": "fqdn_connections", "responses": [ { "uuid": "462c6746-9361-4a27-9d47-200777a13ebf", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "60352d66-2982-426a-91eb-cfaf18e79138", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "17d7583a-9502-435d-a9cf-d8096fd68c99", "documentation": "Delete an FQDN connection", "method": "delete", "endpoint": "fqdn_connections/:id", "responses": [ { "uuid": "1046b646-6d3e-45a4-bbdd-f6d786cafbd7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "aa3586cf-d891-40e8-b036-f35e04bd8329", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "8c3d7cf8-42a6-4173-9e03-a5ae95916372", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "12b66377-a32d-401d-8c05-43ec3c4f5e16", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "5e806720-6fd5-4af7-8851-f946987cd5f7", "documentation": "Retrieve an FQDN connection", "method": "get", "endpoint": "fqdn_connections/:id", "responses": [ { "uuid": "4bbb48e5-41f8-43d6-ae67-821528f54d2e", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "75bcf5cc-b4aa-458a-a061-1bd324b254a4", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "4f3fd483-7eaf-427b-822b-dcb76712d03d", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "e99ef1ca-cecd-4043-90b8-05670c16cf04", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "3d280e54-bd90-4e89-881f-f65673da3577", "documentation": "Update an FQDN connection", "method": "patch", "endpoint": "fqdn_connections/:id", "responses": [ { "uuid": "da812f85-c184-4243-a8f6-69384a239c90", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "ea489b42-ad21-4669-a00a-b1ddbc4f45df", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "841d421c-1f32-45ca-a461-3b7c17ba086f", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "4ebc038b-384e-47c1-af3a-668b1c39a322", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "91c55fa8-cd27-476b-b818-5cad36411da3", "documentation": "List FQDNs", "method": "get", "endpoint": "fqdns", "responses": [ { "uuid": "1da7961f-470a-44d3-b010-b540e8527a45", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "57475166-d720-4647-98da-027a122be136", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "69941921-169f-4a1d-af43-bd46ecbe86f6", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "bfcde86e-81cf-4377-bc3f-5885d5aab69c", "documentation": "Create an FQDN", "method": "post", "endpoint": "fqdns", "responses": [ { "uuid": "bdaf8f85-93a8-473a-84e2-940b73ed2255", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "e0bb0567-05d4-45ba-88bb-502c04bf6800", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "bc396d87-752d-4119-96ef-5e4a90f8e4b8", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "f57b3d97-ac94-4953-b94b-95672525a4cc", "documentation": "Delete an FQDN", "method": "delete", "endpoint": "fqdns/:id", "responses": [ { "uuid": "176e85e8-2d2e-43eb-821a-7acec53a00ea", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "b5588fe3-a580-4f75-ab6b-b7fce25b9190", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "f1eff3b2-bad0-4b8c-a3ba-94306dadb409", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "5f75090d-2299-485c-a53b-740b3dc0e11e", "documentation": "Retrieve an FQDN", "method": "get", "endpoint": "fqdns/:id", "responses": [ { "uuid": "e869806a-9072-4c92-b4b0-640e160e9b8d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "a8cca3f8-d312-4b2a-a1ba-d79494ab2d13", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "320fb230-3710-445c-85d8-600798bbe67e", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "8e6c16fe-64bb-4cea-9e54-896a161b2716", "documentation": "Update an FQDN", "method": "patch", "endpoint": "fqdns/:id", "responses": [ { "uuid": "7a63c9c8-5449-424a-b37b-bd84959d2d5d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "ed365fc6-b71c-4edd-ba1d-18c999d50981", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "bdd0cbdf-d117-4583-9e68-ea251cec66c3", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "e15c1901-20cf-48e3-88f8-75d64a3565bf", "documentation": "Create an inventory coverage request", "method": "get", "endpoint": "inventory_coverage", "responses": [ { "uuid": "d63b3eda-f2fa-45ba-9a43-14e7b3674915", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "322a8adc-a67b-423e-afbc-88a9c96b6bb7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "fb9c382d-7fa9-4095-a40f-fa945a4e7e77", "documentation": "List Ip connections", "method": "get", "endpoint": "ip_connections", "responses": [ { "uuid": "e0072a56-dab3-4748-b33c-ae1c8c0d045d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "6d01e6c6-b4ad-432d-939d-0f2a184fe3ec", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "e0a89885-3337-450c-8591-308166e87f2c", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "f9c199f0-775e-462f-b4a3-18e58dd49311", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "6d637d46-25e0-40c3-a974-f2dbff67d8be", "documentation": "Create an Ip connection", "method": "post", "endpoint": "ip_connections", "responses": [ { "uuid": "519f20a0-5f4d-40a4-adf8-161576a86096", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "dd303086-9d99-4a1f-bcb7-82aad8c29d81", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b8d24203-eb0d-4836-9e52-cb05d3d88674", "documentation": "Delete an Ip connection", "method": "delete", "endpoint": "ip_connections/:id", "responses": [ { "uuid": "076e4e25-4411-4cfb-be35-7d991f9e877d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "0edca02e-e36f-4477-b46b-6660ad65d5c8", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "20a69d80-5ad7-4b71-be40-43e656845cb2", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "ee79ef0e-6e5b-4dc5-b241-24c175342f14", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "c84d2aa2-2602-4944-b578-e397b8198dc9", "documentation": "Retrieve an Ip connection", "method": "get", "endpoint": "ip_connections/:id", "responses": [ { "uuid": "81014471-8559-4823-a11e-c8c670ee6d21", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "f2980e66-b7a7-47c0-aedc-14da236601fc", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "1e3071e9-4444-4a18-a87d-bf336ba1486b", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "82959b5a-8c4a-4a80-a9a1-26109ed9c137", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "c85b3065-6116-4315-86c6-4c9ffe06c93e", "documentation": "Update an Ip connection", "method": "patch", "endpoint": "ip_connections/:id", "responses": [ { "uuid": "e3b4557f-4c66-4672-b878-f19ec81eb923", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "c215ee7e-4edb-4497-b598-3b38d8fa0927", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "f3a9dc51-85ce-46b7-a141-f60ea49c7e63", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "ad915341-c8de-4afb-88fd-16eedbea9e84", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "44399afd-5569-40c3-8ed8-fe996019405c", "documentation": "List Ips", "method": "get", "endpoint": "ips", "responses": [ { "uuid": "721f29ae-0dd1-46f3-ba2c-99012c9ac5e3", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "4163c09d-451d-4f85-bc9c-e70823562c4c", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "9e33912b-2df4-481e-a768-9199f3822605", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "216dc9b1-ac28-49d5-8811-5b7c6e5906a6", "documentation": "Create an Ip", "method": "post", "endpoint": "ips", "responses": [ { "uuid": "a0ce1365-4f21-4fbb-a453-db4109bef0c3", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "c736509a-99fa-43d3-97b0-607626c49633", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "2e21d166-0d1b-4c3e-ae9b-2eb3195dd0fc", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "358c9d06-0819-4304-b22c-f1ad2a5c08c2", "documentation": "Delete an Ip", "method": "delete", "endpoint": "ips/:id", "responses": [ { "uuid": "91cfc92b-1bdc-4f28-9caf-ff192af004ea", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "8dc05bfa-696e-45e1-9361-e0c6d8888dd1", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "c3a94cc3-ccb0-4ed9-b235-72aab7e81b65", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "fcf4216e-f069-4c75-9ed9-e07af6082ae7", "documentation": "Retrieve an Ip", "method": "get", "endpoint": "ips/:id", "responses": [ { "uuid": "d6b1ccf5-80a1-475e-ac91-df534b3d4d69", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "d83a6b75-b714-4279-a264-b9a0fc72ac7b", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "336fbce4-489e-4579-a2b6-c601b9d080cb", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "9a104118-3478-4859-9aca-1691c94f7978", "documentation": "Update an Ip", "method": "patch", "endpoint": "ips/:id", "responses": [ { "uuid": "2a95c56c-e948-4c01-9b60-dfba512f7422", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "0d9df198-e5ab-412b-8f5b-036f3f94aea3", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "1e59c961-be6d-4a15-a084-d3053ecc8b4a", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "bc6f6490-cc6b-4169-bcc4-909fd67d045b", "documentation": "Create a ledger billing group report", "method": "post", "endpoint": "ledger_billing_group_reports", "responses": [ { "uuid": "272e1383-8714-4219-a0c9-b2c3b3060a4d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "128fc00e-0e22-429d-b94a-aa0d6cdf1d92", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "f818e23b-6584-443b-98fe-a51367594932", "documentation": "Retrieve a ledger billing group report", "method": "get", "endpoint": "ledger_billing_group_reports/:id", "responses": [ { "uuid": "27ba2941-dd3f-406c-a870-3d7f680e3bf6", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "99a2556a-fda7-427b-b603-5254e22f93cc", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "110fcc76-fb1d-460b-9390-2abeb9001fbd", "documentation": "Lists accounts managed by the current user.", "method": "get", "endpoint": "managed_accounts", "responses": [ { "uuid": "3d1e3a08-1589-4616-a8e4-665dfca6c6f6", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "be53dfa2-36a2-4242-b354-6112fd00220f", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "bed243f3-08e7-4f7a-ad0d-a0e1723ca2ed", "documentation": "Create a new managed account.", "method": "post", "endpoint": "managed_accounts", "responses": [ { "uuid": "ad935a2e-33f8-4b9b-a1ac-8403a9e0bd0e", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "3240860a-ac2c-4861-9980-3e603186d3af", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "1f40d5ad-7331-4b72-a465-a0ab24e1036a", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1bf3885a-d32c-497d-9925-c62f5241171c", "documentation": "Retrieve a managed account", "method": "get", "endpoint": "managed_accounts/:id", "responses": [ { "uuid": "444c9dc5-080e-4557-a630-6e5174d709f5", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "66205d0e-054e-49f5-bdd7-25776f8ff461", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "b16eb7b7-4c3a-4a41-bbb2-8f418cd69389", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "c97c0834-f920-4a18-90a3-6ef72d31faed", "documentation": "Disables a managed account", "method": "post", "endpoint": "managed_accounts/:id/actions/disable", "responses": [ { "uuid": "71c82b8c-c774-4abf-a00b-eb3226c5e114", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "325d4591-7341-4fe9-be1b-624dddaf255e", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "2c4f4ddb-ff2d-462c-adee-e7c22135cfce", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "63445a16-811f-400c-9ea6-c3dfae63d4f3", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "a5f91269-3bcc-4b8d-8efd-7c75998b4c3d", "documentation": "Enables a managed account", "method": "post", "endpoint": "managed_accounts/:id/actions/enable", "responses": [ { "uuid": "886756a1-7dae-4e5d-b2a0-c0b0e3e3d50c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "b05fe3db-7758-41b3-a51c-9634dab96b50", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "4effa85b-0018-43ab-97dc-bc83dba8c341", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "ea52aaa6-2d7d-48a4-99bf-111dc0533c0d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "21246d72-8142-4a04-bac0-570c5bcc0473", "documentation": "List uploaded media", "method": "get", "endpoint": "media", "responses": [ { "uuid": "5c3a4ead-b485-4c53-a934-0d6d5eb244cc", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "2f9a7787-9bae-4ed8-9cfb-c77155563757", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "6cddff35-80a6-465b-bbd2-37034909df1b", "documentation": "Upload media", "method": "post", "endpoint": "media", "responses": [ { "uuid": "d8f2f27f-a345-42ef-ad21-d8b4285fbaba", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "0f2a43f7-f96e-4a59-bf3b-2c92b9268d41", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "aef58acf-738b-4663-858a-3fb02a3b0958", "documentation": "Deletes stored media", "method": "delete", "endpoint": "media/:media_name", "responses": [ { "uuid": "64555ec7-8c61-4425-941d-4bd19858254f", "body": "", "latency": 0, "statusCode": 204, "label": "The media was deleted successfully.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "1a22d394-5952-4750-b6b7-f4848ee0e777", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "bf1f8862-2caf-4730-b2d0-9b6d73b5cab8", "documentation": "Retrieve stored media", "method": "get", "endpoint": "media/:media_name", "responses": [ { "uuid": "41df026d-1654-4d43-b526-9835da2c53da", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "603d8e82-e947-4e77-8a8f-f161d3592b59", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b8c73ab6-7b6e-4099-9573-e2ae5ed3afce", "documentation": "Update stored media", "method": "put", "endpoint": "media/:media_name", "responses": [ { "uuid": "1feec9de-23dd-45a1-a6d2-70640cec57f1", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "9964d51f-3a60-4983-8737-27f038f9a356", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "8d31b0bd-063e-491f-a49d-4f2521ae5d6a", "documentation": "Download stored media", "method": "get", "endpoint": "media/:media_name/download", "responses": [ { "uuid": "3e49de8e-473e-4b36-b845-648070ea906a", "body": "", "latency": 0, "statusCode": 200, "label": "A response describing a media resource", "headers": [ { "key": "Content-Type", "value": "*/*" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "b16b3843-f312-4290-8a7d-c3f8f4cd13a3", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "c1c682a2-531a-4e09-b5c0-fe5fad284a48", "documentation": "Fetch messaging detail records.", "method": "get", "endpoint": "message_detail_records", "responses": [ { "uuid": "4d67ee89-5ec3-4e60-b1a2-3d7714b4c7b1", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c8d40228-b1f1-4fdd-b272-f14e822902da", "documentation": "Fetch message body by id.", "method": "get", "endpoint": "message_detail_records/:id/message_body", "responses": [ { "uuid": "55061fb6-d09c-4bac-b2e1-51dfaef3224e", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "eb2ec8fc-416d-4559-a700-7b4dcf48c45f", "documentation": "Send a message", "method": "post", "endpoint": "messages", "responses": [ { "uuid": "dc8bd8f6-6d0e-4bed-9501-5cf55cb8dfd6", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "15434dce-b9bc-4ea6-b6c9-2c3a9e36c9b7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "7f84e982-4656-4dac-8dcd-bd7de9e9e355", "documentation": "Send a long code message", "method": "post", "endpoint": "messages/long_code", "responses": [ { "uuid": "de7319e6-1a22-45a6-b3cc-63028c6aa0df", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "b35321a1-a8e2-4a20-bbbe-80f5cf936285", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "d7b1c06c-4b62-4438-9ce0-fe371b88e2dc", "documentation": "Send a message using number pool", "method": "post", "endpoint": "messages/number_pool", "responses": [ { "uuid": "b160e636-4a7a-416a-88ca-7048d7caff69", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "0c03d714-cf96-4b72-958f-375cf09fdaba", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "5c12d16e-0e0d-4e4d-b64a-9b602a02fdd2", "documentation": "Send a short code message", "method": "post", "endpoint": "messages/short_code", "responses": [ { "uuid": "51db904f-acb4-4ac0-b346-229acd654f53", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "3c507b61-28c5-483d-8e71-3515c114c796", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "d1f22f5f-3b20-48d9-8401-e2cd6e6b251c", "documentation": "Retrieve a message", "method": "get", "endpoint": "messages/:id", "responses": [ { "uuid": "d60f9e34-8875-4bce-b144-01ea3455dd8d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "357014f5-780b-47e3-86e7-d36cb2a34a60", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "c933228d-8cba-4e16-b99c-922200c16dfa", "documentation": "List messaging hosted number orders", "method": "get", "endpoint": "messaging_hosted_number_orders", "responses": [ { "uuid": "d2f0c8da-5d74-473e-8106-d3eff238724a", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "e2d23c08-4f4c-4420-9552-1a0f0d81f544", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "be8e5638-56c9-4aee-abca-818feccced27", "documentation": "Create a messaging hosted number order", "method": "post", "endpoint": "messaging_hosted_number_orders", "responses": [ { "uuid": "58c376f6-f09b-4c1c-b634-a4975c453c3c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "cc1d44ad-7791-4d1a-a69e-de22ddfdcf24", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "ba013338-9d14-4f36-8188-656d0d7d8044", "documentation": "Retrieve a messaging hosted number order", "method": "get", "endpoint": "messaging_hosted_number_orders/:id", "responses": [ { "uuid": "ad6548ec-62dd-432b-a2ef-575afdf7c2a8", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "105656b6-b1ba-4a66-8556-27964c7f1906", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "464b471b-3e22-4da3-9c06-4bd7439f8900", "documentation": "Upload file required for a messaging hosted number order", "method": "post", "endpoint": "messaging_hosted_number_orders/:id/actions/file_upload", "responses": [ { "uuid": "b6f09383-6053-4f74-9e2a-84f135cf44f3", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "17bddc78-fd88-40e8-8638-fa8a5c4e3621", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "7335a1f7-b538-47ee-a55a-55f76104e557", "documentation": "Delete a messaging hosted number", "method": "delete", "endpoint": "messaging_hosted_numbers/:id", "responses": [ { "uuid": "caa55b19-2971-47d8-99f1-1f93ffc7acd2", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "a300c24b-6013-4ba5-aa47-f7497da9ed09", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "5e2f279d-87dc-4a79-a02a-35315d1eac83", "documentation": "List messaging profile metrics", "method": "get", "endpoint": "messaging_profile_metrics", "responses": [ { "uuid": "c921a713-32c0-4944-9543-f35414e8a2b0", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "2b457ba8-1821-422e-ba13-f10163362d88", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b1dab1b4-8b22-4639-b184-b985b8a81da5", "documentation": "List messaging profiles", "method": "get", "endpoint": "messaging_profiles", "responses": [ { "uuid": "d9d42e13-5ef6-489f-968d-7f1d74ce0121", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "6b37487c-e942-44ee-a7ad-38fee67c29f9", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "5c65ec33-5b9a-4f20-8208-bfa64c9009bd", "documentation": "Create a messaging profile", "method": "post", "endpoint": "messaging_profiles", "responses": [ { "uuid": "627db48c-89ff-426e-b793-3377ce35c6b8", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "74c9b1d8-cf84-411f-9c35-7a1e667579c2", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "33667925-54a8-44f8-ac92-a66d2433196f", "documentation": "Delete a messaging profile", "method": "delete", "endpoint": "messaging_profiles/:id", "responses": [ { "uuid": "4b3fc78b-a6fd-4ca5-9bdc-dceed102e3f6", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "9f33d651-7cfd-4bab-900a-0ecca921fbfc", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "8b7d8efe-9837-405e-b816-b8b065d71a46", "documentation": "Retrieve a messaging profile", "method": "get", "endpoint": "messaging_profiles/:id", "responses": [ { "uuid": "2c5028fe-ac71-4514-bd9f-97c60a3213d9", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "d309ea20-c943-4617-b9ad-a0ac6bf961a1", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "3faa5c1d-d5dc-4fbd-8da9-6d421a4c393c", "documentation": "Update a messaging profile", "method": "patch", "endpoint": "messaging_profiles/:id", "responses": [ { "uuid": "ff5c7a06-749d-499a-b2d1-5de600204673", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "4d47b268-0192-48cf-b398-3eac6d484c2e", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "057f1a23-a6c0-49d8-a83d-2c2ec9405ad8", "documentation": "Retrieve messaging profile metrics", "method": "get", "endpoint": "messaging_profiles/:id/metrics", "responses": [ { "uuid": "66346c5b-0d6d-48c7-af0d-0c3f41987ea0", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "6ef9be35-f5a0-4cc7-ade2-3bab8f70810c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "2f8314c2-dea7-4152-acd3-748b0130563b", "documentation": "List phone numbers associated with a messaging profile", "method": "get", "endpoint": "messaging_profiles/:id/phone_numbers", "responses": [ { "uuid": "5d4ee9a8-9b3d-4648-8051-e7a5b3ff9af3", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "e025fc80-7ba5-4c5f-b30b-e3f30b04900d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "ea0d9fe7-7949-4bc0-a582-1a84341ab4bc", "documentation": "List short codes associated with a messaging profile", "method": "get", "endpoint": "messaging_profiles/:id/short_codes", "responses": [ { "uuid": "83e275c0-674e-4527-a0ed-4419cf7e2c25", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "feda3b9f-3930-4425-af66-9e37e6d20365", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "c953a55a-2892-4984-8796-cc3d8a6d4cb7", "documentation": "List messaging URL domains", "method": "get", "endpoint": "messaging_url_domains", "responses": [ { "uuid": "3e677dfb-1643-428e-a9d8-822c12ea9ec7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "8b53f15a-73a8-493b-a56e-2f5eafe93180", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "ab98b2a7-823f-494c-a666-5a2d7f892a55", "documentation": "List mobile operator networks", "method": "get", "endpoint": "mobile_operator_networks", "responses": [ { "uuid": "00788ed4-e914-4a99-bdbc-3d29341a281f", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "0abd3038-93d7-4fbf-b55d-22ca7914a226", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "546e1439-14c2-4ce7-afd6-4bc2d69b8426", "documentation": "List notification channels", "method": "get", "endpoint": "notification_channels", "responses": [ { "uuid": "a889603e-ee76-45c5-856d-d0c716eafffb", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "7b7d1d83-0396-4133-b45b-856ca66addb4", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "baf871a5-9d3c-404c-a809-ccd966c0c31a", "documentation": "Create a notification channel", "method": "post", "endpoint": "notification_channels", "responses": [ { "uuid": "bbf2da34-b4d6-4d9e-aafd-1b726ea45dab", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "85966078-785a-453a-a507-1068e08e1ef2", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "a3c09406-a425-4657-b102-615d9d50becf", "documentation": "Delete a notification channel", "method": "delete", "endpoint": "notification_channels/:id", "responses": [ { "uuid": "ded28e4a-4d1b-45dc-ac06-ce7c3b433a9d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "bfeb3242-9026-4425-9e5f-c77181a6537b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "6b18f344-6ecb-4e5c-ab56-629698d240eb", "documentation": "Retrieve a notification channel", "method": "get", "endpoint": "notification_channels/:id", "responses": [ { "uuid": "80988e84-c94d-493a-9781-f6ce46497476", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "7e8463de-398c-4c3d-b2b1-1018fced4eb8", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "8346a7fb-2998-4bd5-9cd1-c74cbf4c64f8", "documentation": "Update a notification channel", "method": "patch", "endpoint": "notification_channels/:id", "responses": [ { "uuid": "a3d162f3-dda3-4d61-8cbf-90332d789a6d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "240477b4-e6fc-4601-90f2-dacde1f26a01", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1aa09daf-b2ce-4b3c-bb7f-fd2b8288c050", "documentation": "List all Notifications Events Conditions", "method": "get", "endpoint": "notification_event_conditions", "responses": [ { "uuid": "2a99f4a3-f1ea-48cb-af41-c9e6e1ca412b", "body": "{\n \"data\": [\n {\n \"allow_multiple_channels\": {{faker 'datatype.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 'datatype.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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "44c16a2b-5f23-4d66-8207-77071be544c3", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "6c851a68-59c2-466f-8e9b-e5bdf49e913f", "documentation": "List all Notifications Events", "method": "get", "endpoint": "notification_events", "responses": [ { "uuid": "6de630c9-8d47-4c54-b009-2741e870e415", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "3916b61d-4dd9-45fd-9a71-b6aaf79cda11", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "0b8c7df9-6606-47c9-a9a6-aefc3ff7dfe1", "documentation": "List all Notifications Profiles", "method": "get", "endpoint": "notification_profiles", "responses": [ { "uuid": "0f3c5161-eb03-4d39-af2a-24259684716e", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "42a1d6ac-e240-40eb-817d-df7e5c57d5f0", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1f7efc11-89ff-4819-b492-aa1482d8648f", "documentation": "Create a notification profile", "method": "post", "endpoint": "notification_profiles", "responses": [ { "uuid": "4b733047-a939-491b-811a-251c1e8a585d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "c5b3d249-ab3c-43ae-91a8-88bf82fa5b93", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "7722abf7-fc19-4239-8c45-fcde0e554c73", "documentation": "Delete a notification profile", "method": "delete", "endpoint": "notification_profiles/:id", "responses": [ { "uuid": "8882fd11-1f7c-4057-a160-09feb2cee7c0", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "7b8f47be-1d5d-4d1e-9903-48fa3733c635", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "c72b88bf-5d48-4990-b7fc-98291adfd7b5", "documentation": "Retrieve a notification profile", "method": "get", "endpoint": "notification_profiles/:id", "responses": [ { "uuid": "f48d306e-9722-4c86-b1b7-55e0e9a4b340", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "aeb340d5-99a1-48f6-ae19-8c7c08aee74e", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b204ef98-8412-4415-ab67-75a26dcf1e86", "documentation": "Update a notification profile", "method": "patch", "endpoint": "notification_profiles/:id", "responses": [ { "uuid": "f64a4381-fc6e-430b-96f0-c2a2824388aa", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "b7dc685c-09cd-4d5b-978b-6d2a8ce4444f", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "6a96949c-3f0c-4cf9-b76f-b51ac70ef07d", "documentation": "List notification settings", "method": "get", "endpoint": "notification_settings", "responses": [ { "uuid": "97df232c-a6a9-4a94-b155-90c5ef2d6a7a", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "d46ee184-e002-41a3-8b90-10261d8eba14", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "3d916be7-d418-4dc2-a11a-f4f9e28e509e", "documentation": "Add a Notification Setting", "method": "post", "endpoint": "notification_settings", "responses": [ { "uuid": "9033aa35-5703-461c-af28-2291f575379d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "9ea960a2-efb8-4c17-918d-f96994a6e587", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "f4904819-66c8-4c6d-a39c-ad38b78ee03b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "2634ac8d-d25a-4a45-8d24-7e1ec2969674", "documentation": "Delete a notification setting", "method": "delete", "endpoint": "notification_settings/:id", "responses": [ { "uuid": "74e341fb-5c47-41a7-99ca-da46fd9b8969", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "27cabee8-aac7-442e-87b1-660715a2c541", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "ea0bbad7-ebaf-412a-ae11-1f6c5ca9ddb5", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "63b6c6f3-1648-4d5e-949d-44da91b84619", "documentation": "Retrieve a notification setting", "method": "get", "endpoint": "notification_settings/:id", "responses": [ { "uuid": "92dac041-bb77-4b60-90a4-9b962f9b9265", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "415c4725-1b00-436d-a03c-c2263585a45c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "e14dd36d-7f0c-49c8-b024-302e21aa44ec", "documentation": "List number block orders", "method": "get", "endpoint": "number_block_orders", "responses": [ { "uuid": "dfb9c786-9bdf-4212-8b7d-9a805f437e85", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "1c417e02-1ac7-4bfa-ab1c-c7ef86b509ca", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "403931c7-6594-47fc-8f66-8849fb3e318e", "documentation": "Create a number block order", "method": "post", "endpoint": "number_block_orders", "responses": [ { "uuid": "b3e0a38e-e6f7-4581-94ef-bf3be286c6a5", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "da3f06c5-0fea-456c-8db2-1cb0c985c413", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "a77985b0-0a84-4980-a226-847121c0a2ab", "documentation": "Retrieve a number block order", "method": "get", "endpoint": "number_block_orders/:number_block_order_id", "responses": [ { "uuid": "9aea9bc3-213a-414a-9220-5c6cc02a9c5c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "38fc04be-fe92-4d7b-9f82-ca2f4d451619", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "c61ec5af-ef28-4b25-bb58-3c88bf9a5177", "documentation": "Lookup phone number data", "method": "get", "endpoint": "number_lookup/:phone_number", "responses": [ { "uuid": "1f726357-1724-4b45-9884-faa9abc37a51", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "bde86941-19b8-4275-8424-8187c2ff1c2c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "ad711ed7-f642-4a75-852a-ef1f97a53f84", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "94432eba-661d-4e33-bf61-346f0b0f9b79", "documentation": "List number order documents", "method": "get", "endpoint": "number_order_documents", "responses": [ { "uuid": "ef7f9f38-7129-4a2b-9d15-19954b8a551f", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "5fbdf5f7-3d2b-4852-806b-3eadba260cb3", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "4ad2a2a3-89a9-4abb-9938-b79a42f82a23", "documentation": "Create a number order document", "method": "post", "endpoint": "number_order_documents", "responses": [ { "uuid": "50ffeccc-810d-4581-b464-2cb53afef4fa", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "765dc27a-f508-4794-adeb-f6cee5b6fd22", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "04274afe-d3f5-4008-b10d-773d8be23aa3", "documentation": "Retrieve a number order document", "method": "get", "endpoint": "number_order_documents/:number_order_document_id", "responses": [ { "uuid": "aa8ff3ab-b221-4fc1-872f-8cd8b71b590a", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "ec67b509-13d5-4d75-a48f-9155a21a4498", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "793298bf-bd97-4d57-aeba-389004095535", "documentation": "Update a number order document", "method": "patch", "endpoint": "number_order_documents/:number_order_document_id", "responses": [ { "uuid": "fcd312c6-2350-416e-a95f-bf0262685ae4", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "50e3d090-0beb-47cb-bd89-be8edd8f6c6d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "06fe2905-88ff-4043-acd1-6f80d20eef29", "documentation": "Retrieve a list of phone numbers associated to orders", "method": "get", "endpoint": "number_order_phone_numbers", "responses": [ { "uuid": "c89705d9-1f2a-4c70-96fe-aac677ac37cd", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "65d585bc-bcc1-4ff4-ae90-e694c38ceb22", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "d25cd975-2ece-4a19-abd4-e3b761b8a8a6", "documentation": "Retrieve a number order phone number.", "method": "get", "endpoint": "number_order_phone_numbers/:number_order_phone_number_id", "responses": [ { "uuid": "a78eccfc-8f68-442a-9fa9-925bf7133747", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "5a0e0ca3-92d4-4e0e-a5fd-ffadc7314e13", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "bde10c0b-7bfd-4396-89ce-14724f8236c7", "documentation": "Update a number order phone number.", "method": "patch", "endpoint": "number_order_phone_numbers/:number_order_phone_number_id", "responses": [ { "uuid": "d8d055fd-15e1-4fa2-b0e5-ba6cb71a9053", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "ee908a47-2542-4185-9376-15383819a81b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1bec2f77-3132-4c5e-9a10-6be6f340f797", "documentation": "List number orders", "method": "get", "endpoint": "number_orders", "responses": [ { "uuid": "6a807851-b92e-422e-9ab6-43ef33fc8dca", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "4c67ef0d-4b16-462d-8e61-a06fe3785ef6", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "d4519a34-f713-480b-8535-de8bb998131d", "documentation": "Create a number order", "method": "post", "endpoint": "number_orders", "responses": [ { "uuid": "297ebfa2-fcae-482d-8e8b-3bed80ba1490", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "de400957-0487-43c5-9250-7b1fbe45ac09", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "48d275b1-57b0-4757-af81-6bed255e3af6", "documentation": "Retrieve a number order", "method": "get", "endpoint": "number_orders/:number_order_id", "responses": [ { "uuid": "c64a2c35-e3ba-48fd-ba51-54ca38bb5842", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "0152012b-c90a-4835-a601-d009b9b83453", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "8277937c-ff4e-49d4-b5ca-b992e56f305c", "documentation": "Update a number order", "method": "patch", "endpoint": "number_orders/:number_order_id", "responses": [ { "uuid": "d38a9623-32e1-49a0-85c6-fe17d602dd3c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "b5e65101-8801-4920-8e9d-6d193fd05dcf", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "423de464-5fdd-41e5-b5da-d0d8a67812ae", "documentation": "List number reservations", "method": "get", "endpoint": "number_reservations", "responses": [ { "uuid": "9a1335a3-299a-4160-8805-3e86055ad351", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "b3db48b7-be33-4fa1-853b-a8c92ef89696", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "4f9da796-7b17-466d-980c-84701aab3ae8", "documentation": "Create a number reservation", "method": "post", "endpoint": "number_reservations", "responses": [ { "uuid": "ae600987-7863-43a5-9f25-a89bbedd1c9c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "bbe1e5fd-0322-42fb-8b7f-390cf3867347", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b4e0e094-df02-4dee-b443-3f3418814e16", "documentation": "Retrieve a number reservation", "method": "get", "endpoint": "number_reservations/:number_reservation_id", "responses": [ { "uuid": "ee05d739-af80-48c6-81ec-ef51985d7ad7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "5baa206d-3ee3-4098-b550-62b2d92cfa1d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "ec8fed04-f5ec-4023-b033-e006fbe3e1f0", "documentation": "Extend a number reservation", "method": "post", "endpoint": "number_reservations/:number_reservation_id/actions/extend", "responses": [ { "uuid": "7919c47c-ec51-4eab-a52d-21ddf76edea7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "512fc647-e54e-47bc-8fa4-198e1b1097d4", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "893dcc05-5318-4d1a-a260-2e033aa8eb1d", "documentation": "List OTA updates", "method": "get", "endpoint": "ota_updates", "responses": [ { "uuid": "a8d5c5c5-e3de-40fb-b4ea-790d69ad550e", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "3327dfb5-0b9f-4224-ae55-a32eaba20c1c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "479316ed-8d74-4c1b-8dce-1541348383b1", "documentation": "Get OTA update", "method": "get", "endpoint": "ota_updates/:id", "responses": [ { "uuid": "a1e75553-9a44-4f2a-badf-b3b6d703a5c1", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "84400943-c334-4b92-a6f5-55aafa2f5af9", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b6176cd4-5d06-48b0-8dbf-c2cc28abafa6", "documentation": "Get all outbound voice profiles", "method": "get", "endpoint": "outbound_voice_profiles", "responses": [ { "uuid": "5bea1ca2-5783-4329-bd78-30e32f16a0db", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "5fda7c87-3c77-4aba-8c05-33144d8691c5", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "06d55a8c-39cb-4c77-a426-26dc6243e4ee", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "9a0e0a65-f26c-40da-928b-b73249fb1b91", "documentation": "Create an outbound voice profile", "method": "post", "endpoint": "outbound_voice_profiles", "responses": [ { "uuid": "408dc702-3da4-4e60-b2d0-d75cc0c7d677", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "ff7b83da-0fae-4a5e-b126-c49d68cc463a", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "0ce30074-0b0c-40e4-8893-47c24dde4590", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "c202c6e1-466f-4e00-9ef6-fa0c3ece6e1f", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "17f214f3-cd04-4883-88c3-ffc3523bb103", "documentation": "Delete an outbound voice profile", "method": "delete", "endpoint": "outbound_voice_profiles/:id", "responses": [ { "uuid": "08bc307e-2416-4ca9-bef2-c673386f6cca", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "a2721780-0ea0-46e1-bdba-43e1d5e65a7f", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "ce445555-699e-4348-aea7-f9ab44d4f642", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "19d2ba1e-89e1-44e1-8bc3-3f003cfea581", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "c5e7c5ca-28b4-4150-afbb-fbb8a1addaff", "documentation": "Retrieve an outbound voice profile", "method": "get", "endpoint": "outbound_voice_profiles/:id", "responses": [ { "uuid": "7a6ae875-a9b4-4ff1-8174-44c1f9c73c3d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "1c4137fd-20ca-41e8-8233-e6e29eb3e964", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "e0c0210e-b299-4da7-a183-b663905ca243", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "3d180d78-3a47-47e2-b077-466793aa4551", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "9695df28-4b10-40bf-9972-e53232839a80", "documentation": "Updates an existing outbound voice profile.", "method": "patch", "endpoint": "outbound_voice_profiles/:id", "responses": [ { "uuid": "afc7a72c-7017-4b41-966e-2d4c8ea24255", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "ee83bb0e-8de7-4ef8-86c5-0045211fc57e", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "7957cae7-b6fb-4bdb-8d86-56fe3d35ace8", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "fb60f336-aedb-4916-95b6-d6be15194008", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "732717d2-2718-4af0-96c4-9e11a129e216", "documentation": "Lists the phone number blocks jobs", "method": "get", "endpoint": "phone_number_blocks/jobs", "responses": [ { "uuid": "f4c77ebd-0a22-4de7-b0f3-facea19411eb", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "989ec015-a398-443a-be42-874780cd7a98", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "88a9f907-78be-4def-98f3-c964d39aace8", "documentation": "Deletes all numbers associated with a phone number block", "method": "post", "endpoint": "phone_number_blocks/jobs/delete_phone_number_block", "responses": [ { "uuid": "04c1364e-f2f8-4bd4-9415-33f8851f69c7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "28aa6016-9032-4280-866c-d8e4fdc9ac03", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "fb426624-4ca8-4f50-83be-7f0b60565ebe", "documentation": "Retrieves a phone number blocks job", "method": "get", "endpoint": "phone_number_blocks/jobs/:id", "responses": [ { "uuid": "b8ffc898-9156-4431-bc71-0aea361e41eb", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "9dfd6783-49b4-4d18-8732-6977810b8b55", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "045d16f3-9c23-4ba7-97c7-1918ec93a7a3", "documentation": "List phone numbers", "method": "get", "endpoint": "phone_numbers", "responses": [ { "uuid": "1a5e779d-12c2-4f32-8f07-3db989b02ac8", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "5352a5f4-ac8d-427f-85e4-5a22864876c3", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b21642e0-d68d-4823-8e01-aea433cdb28d", "documentation": "List CSV downloads", "method": "get", "endpoint": "phone_numbers/csv_downloads", "responses": [ { "uuid": "4de6d9b1-e12c-4450-90a2-a2fb06faa5bc", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "7d3af2df-12e9-4c8e-a004-f6ae58a0cca3", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "deda3733-ff6e-40b2-bc1f-c4a4d5aa7bd2", "documentation": "Create a CSV download", "method": "post", "endpoint": "phone_numbers/csv_downloads", "responses": [ { "uuid": "278aaf5c-fcf9-4a53-a1bc-ed6a106009dc", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "299179db-179a-42c8-bcb7-6149343b3ee2", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "2411ef06-80ac-4351-957b-11ffca21c94d", "documentation": "Retrieve a CSV download", "method": "get", "endpoint": "phone_numbers/csv_downloads/:id", "responses": [ { "uuid": "52567037-ea3e-4673-a4de-dc6db24141b9", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "4887a5ad-558c-45c3-9411-72b7c0631e75", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "6d34726d-9225-4efc-b993-f3354759ee12", "documentation": "Retrieve your inbound channels", "method": "get", "endpoint": "phone_numbers/inbound_channels", "responses": [ { "uuid": "4fd728e5-e663-4bf4-8d62-c3ebe7a71caa", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "3999a2ad-ce5b-432e-89a9-fee7d32fd61e", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "4fa29f42-0afc-45a4-bd22-8e3d70d1d5b2", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "10b06a52-3b86-4688-9d91-38c09b9a8c4c", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "aaa8d53c-94e8-4968-84df-ccf706ef00b3", "documentation": "Update inbound channels", "method": "patch", "endpoint": "phone_numbers/inbound_channels", "responses": [ { "uuid": "12a348df-64fd-4a25-becd-efb9c2a15cb9", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "8aa0ce3f-f57c-4687-ad6a-72c47607ff3e", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "60d255ae-2650-4afe-8c30-f6ebc290c83f", "documentation": "Lists the phone numbers jobs", "method": "get", "endpoint": "phone_numbers/jobs", "responses": [ { "uuid": "332d3050-096a-4a77-93cb-e463ef404968", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "52a6f10f-1808-4bc8-8bc1-24d82a88e7df", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "02f638bc-87ed-4d15-8531-b56573bbd93c", "documentation": "Delete a batch of numbers", "method": "post", "endpoint": "phone_numbers/jobs/delete_phone_numbers", "responses": [ { "uuid": "e0adfc69-8472-424f-9dff-b96c25c2efdf", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "68be2f6e-f021-4815-8540-0a7238ddad17", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "2e91ca57-a8bf-4f8e-87b1-beb5a5960813", "documentation": "Update the emergency settings from a batch of numbers", "method": "post", "endpoint": "phone_numbers/jobs/update_emergency_settings", "responses": [ { "uuid": "6eb85937-198c-4eec-85d2-ca04f90ec1e0", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "76962ff0-e271-4ffd-aebd-aa6bfc477eba", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1dfaa8e7-d4c2-462b-aaec-2094e4ed0c1f", "documentation": "Update a batch of numbers", "method": "post", "endpoint": "phone_numbers/jobs/update_phone_numbers", "responses": [ { "uuid": "7726accf-3822-4b68-ad88-276174bf48bb", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "6ce54e6c-4fbb-495b-a320-cac54730e47e", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "bf81ebf2-d465-4bf7-8e0a-ecdf595fa598", "documentation": "Retrieve a phone numbers job", "method": "get", "endpoint": "phone_numbers/jobs/:id", "responses": [ { "uuid": "1503d9bc-a40b-401b-87fb-d141ae9f319d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "2cd91267-ff56-42df-b1ed-3a65ca237faa", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "e12a1715-de9f-46e9-be27-00fbc0752e2a", "documentation": "List phone numbers with messaging settings", "method": "get", "endpoint": "phone_numbers/messaging", "responses": [ { "uuid": "bc91987a-7a20-476b-9bc7-2f8e64425305", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "1d4d39fe-fbad-4d0b-981e-5427400322e1", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "a7d75dd1-a287-4b80-a30f-b9830e7b42eb", "documentation": "List phone numbers with voice settings", "method": "get", "endpoint": "phone_numbers/voice", "responses": [ { "uuid": "f1a90b9a-dc0e-4377-92cf-961aa3b1a4c6", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "f9ab8fe8-550d-4ab2-b0b8-b4f775621c22", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "35a0aba4-026f-43c6-88a7-0f1d80801f68", "documentation": "Delete a phone number", "method": "delete", "endpoint": "phone_numbers/:id", "responses": [ { "uuid": "6cbfad71-74b5-4e82-aed5-03f63abc094c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "20b50ae6-57e7-47dd-a9c9-a889ea5876ad", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "0ace00cc-5c03-4616-b32d-b671009970c7", "documentation": "Retrieve a phone number", "method": "get", "endpoint": "phone_numbers/:id", "responses": [ { "uuid": "4df6849a-8d99-46a1-890e-d45868688173", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "26c9469a-bd5d-4a72-be5d-cc3d14842a7b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "44235ddf-8b45-4314-b539-6aae29be899e", "documentation": "Update a phone number", "method": "patch", "endpoint": "phone_numbers/:id", "responses": [ { "uuid": "22ce8e5f-b3f8-4b1f-a3af-3049bca7cc0a", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "8af933eb-9d67-4abc-93b4-a7504eb6bc0b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b8b623f4-5686-4f04-a96d-117bca368612", "documentation": "Enable emergency for a phone number", "method": "post", "endpoint": "phone_numbers/:id/actions/enable_emergency", "responses": [ { "uuid": "7a008d5c-7cb2-4122-b9a6-39ebf72d8aaf", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "9cb4a492-b8df-4a9d-bb13-7921c976a303", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "fbbdbd2a-3597-4840-bb1a-540811d1ab89", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "8938eb0c-5006-4a7e-805b-d91c960ffc9e", "documentation": "Retrieve a phone number with messaging settings", "method": "get", "endpoint": "phone_numbers/:id/messaging", "responses": [ { "uuid": "dddf706d-b3b2-4f13-bca9-7ac9bfcd9a9c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "c6150f37-e03f-482d-b360-2f8d65ab0e98", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "df52803b-45e3-4ac3-8ed2-1d3f2e8e58f3", "documentation": "Update a phone number with messaging settings", "method": "patch", "endpoint": "phone_numbers/:id/messaging", "responses": [ { "uuid": "78087f64-48d5-4239-bfa4-45edb25b76a1", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "1f548547-b1de-4cf3-8124-02e8b7732bd8", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "8cd94cf2-cac4-455f-a137-6b520a89d9a1", "documentation": "Retrieve a phone number with voice settings", "method": "get", "endpoint": "phone_numbers/:id/voice", "responses": [ { "uuid": "0e4d757f-0082-4b7c-9a0b-2bb44a096440", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "8114f2f6-03d7-43ca-ba87-96d42f839e73", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "05f93a33-7d97-4a29-b864-a689c0a6e948", "documentation": "Update a phone number with voice settings", "method": "patch", "endpoint": "phone_numbers/:id/voice", "responses": [ { "uuid": "3cac521c-c4aa-4c49-b8f7-e2c2a5c58aac", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "b96116f7-f871-438b-843b-6b829546a088", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "8b0f5bbf-733c-47fa-b70f-fba7d93e7de5", "documentation": "Run a portability check", "method": "post", "endpoint": "portability_checks", "responses": [ { "uuid": "43c8e0b0-05e9-49c4-8e10-6623153e5a2b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "6a0e1ffb-6909-4bcf-b070-1d260308b05e", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "b7928067-0de3-4b09-a980-13c06090ac55", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "16df2825-502b-41af-93ac-2ddb01f796e8", "documentation": "List all porting orders", "method": "get", "endpoint": "porting_orders", "responses": [ { "uuid": "48efd2f1-adcd-4333-a545-772d3db7265d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "2a5335ba-2db3-49c1-89ce-e02554c4e1c7", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "0f21c3c1-98bd-4ead-b28d-0f48c3f6ff84", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1eddaf4f-10c9-4910-8348-688f1b1fc557", "documentation": "Create a porting order", "method": "post", "endpoint": "porting_orders", "responses": [ { "uuid": "29173874-560c-49cc-994d-9b41dd0d4133", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "68e01f3d-fbc1-4a8f-8a16-b9e29b9dda0c", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "bdd5e77c-2296-48e1-b8cc-77bac48a2abe", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "d666a984-1654-49b8-84dc-ea994a56afd1", "documentation": "List all exception types", "method": "get", "endpoint": "porting_orders/exception_types", "responses": [ { "uuid": "643efd02-e0bd-41e7-a973-b713751b179d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "4ad3401e-f56a-41c3-9f1b-2e1e8598d53f", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "3ca8c2cc-a27f-4adf-af81-2f8777370a4c", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "931a6ca7-6c13-4bb8-96f6-19344d933fd6", "documentation": "Request cancellation", "method": "delete", "endpoint": "porting_orders/:id", "responses": [ { "uuid": "57542af2-d069-4bbd-8824-f2f2193b01c7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "48ec2fea-0a5a-464b-a4e8-8901e887fdf2", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "c65ee8a4-bb7b-485a-8fa0-e14c54795cb9", "documentation": "Retrieve a porting order", "method": "get", "endpoint": "porting_orders/:id", "responses": [ { "uuid": "bfe2e068-69fa-4cab-94e9-e2bd8afe5e5c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "396c40f3-83e2-459f-ac7e-74b025cfba07", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1acd18d9-994c-4671-b6a4-6da6c4fd2fe2", "documentation": "Edit a porting order", "method": "patch", "endpoint": "porting_orders/:id", "responses": [ { "uuid": "2f3d9d64-f809-4c60-835d-b8d46fd7ddc7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "ebd429cf-fc44-439d-9588-a494dac0e661", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "01582b3c-5ae5-4391-932c-a06203a089bd", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "9a64929a-02d0-428d-b2d9-69da9894fac5", "documentation": "Activates every number on a porting order.", "method": "post", "endpoint": "porting_orders/:id/actions/activate", "responses": [ { "uuid": "98d96084-f996-4566-a684-e702e698891a", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "5f47dfb5-826b-4b6d-a01a-d3a09fa956bc", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "e9ba4da9-f354-49a1-9d37-ad14e9ab108b", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "c73efa8a-fe22-4a02-8105-3536c09df257", "documentation": "Cancel this porting order", "method": "post", "endpoint": "porting_orders/:id/actions/cancel", "responses": [ { "uuid": "37d3ddc6-0da6-406e-9253-01b0972114c5", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "f726adef-de79-458d-8c62-e40843d27804", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "1f0e7e98-2657-4ef6-8643-663a07473ab0", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "9427f125-e760-4fd8-b449-e7f44da70f56", "documentation": "Confirms the porting order is ready to be actioned.", "method": "post", "endpoint": "porting_orders/:id/actions/confirm", "responses": [ { "uuid": "9c5e92c8-7138-4c6e-8776-030e176490bb", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "3df6c4cb-9890-42ac-9b94-176c1ec7f5ed", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "e9238de8-c6fb-44a1-8b1f-d5b371c030d2", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "eb01fb6d-f0c5-4093-9237-cc4c0ab3e17c", "documentation": "List all porting activation jobs", "method": "get", "endpoint": "porting_orders/:id/activation_jobs", "responses": [ { "uuid": "cbe9fae4-610f-45ae-98b2-a1620eb5f3a0", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "350fa301-69e3-44fb-8ca6-e741ac283226", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "48495d1f-b57b-4f14-bfc3-229e905ae291", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "984c1e88-5f8d-49c1-9d61-9f16d01534a3", "documentation": "Retrieve a porting activation job", "method": "get", "endpoint": "porting_orders/:id/activation_jobs/:activationJobId", "responses": [ { "uuid": "22f4fb83-3fde-45bc-955d-6ad24cf2edf7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "1b2df459-6207-4b8a-be66-dc3a09c96fbd", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "5c027357-6869-4141-8b6c-6006040abdc0", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "d2863fdc-74eb-4402-89df-3ba15146fac5", "documentation": "List all comments of a porting order", "method": "get", "endpoint": "porting_orders/:id/comments", "responses": [ { "uuid": "dce4760a-da8d-4b7c-92ea-f3665522c4dd", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "71e8a0fa-1ace-4951-a2c9-b7c2062d1c5c", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "73ee7829-5090-44ea-83d1-310e09213b1d", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "7dfeb0c2-079d-4380-b62d-fd336b8c6eac", "documentation": "Create a comment for a porting order", "method": "post", "endpoint": "porting_orders/:id/comments", "responses": [ { "uuid": "421ea0b2-6dd8-4901-b510-23e077203c16", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "69f3f69a-09e8-4076-8540-3e8ecb0ce520", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "8a58622e-ba88-480c-80de-a553b0929b1c", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "f73881c0-884d-4911-b518-79e6e7d8d84a", "documentation": "Download a porting order loa template", "method": "get", "endpoint": "porting_orders/:id/loa_template", "responses": [ { "uuid": "3fb63dcd-cd22-4242-96fd-a8744825f77d", "body": "", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "application/pdf" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "480953ba-ccce-4e0c-aed7-a0f143e7fa7a", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "274245ad-d589-4154-a5f1-eac01fc81a7f", "documentation": "List all porting phone numbers", "method": "get", "endpoint": "porting_phone_numbers", "responses": [ { "uuid": "72e0a94c-24cd-4361-943b-c57538c849f0", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "fbf32724-5b40-431b-b8ca-9ce162439cf4", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "c825fc01-cf6c-4511-8cab-9dffe14af620", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "106bd32e-5542-4cbc-a668-e6a23a55c5d2", "documentation": "Retrieve a list of portout requests", "method": "get", "endpoint": "portouts", "responses": [ { "uuid": "5d743cca-f696-4a84-83b7-444609fd5b30", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "d7a20102-a9a5-4ecd-b7ae-59319e6df924", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "d3a1d269-a8d9-4851-b65d-1c17ef294379", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "987a1996-f2d3-4278-aace-431514df090c", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "71f906f2-d69b-4011-a419-6abdb60ab69e", "documentation": "Retrieve a portout request", "method": "get", "endpoint": "portouts/:id", "responses": [ { "uuid": "1a4011d5-183f-44e8-b462-6d04859114c1", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "0296192b-a144-44ee-8c14-cae38e217762", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "5ad6681e-7dad-49fe-a948-76672da780a8", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "3079129c-2221-4104-92c3-78b80a69e9ed", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "ef1b61b1-e029-4421-92d4-591f60d814dd", "documentation": "List all comments for a portout request", "method": "get", "endpoint": "portouts/:id/comments", "responses": [ { "uuid": "2adf5aee-ebba-4406-9fdf-6840cf3d7ff2", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "e4757e5c-8ef3-4179-8b22-ff5bb5b0e8fd", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "0a63db5f-ced3-439e-a9c0-c87b602911f7", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "3f1b76b5-b514-436c-aa9f-c4de7575fa63", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "e5d4a813-7ee8-4335-ac39-a2a5a2049f88", "documentation": "Create a comment on a portout request", "method": "post", "endpoint": "portouts/:id/comments", "responses": [ { "uuid": "f3480bac-469e-4f7a-a00b-05eadbc8f2a9", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "703593de-697d-4929-9a89-52c14e628a4d", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "30e4d9c6-1b88-4740-ab16-3f5600aa22dc", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "f89c2b56-4380-4f81-914f-d4cd730f4610", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b0e6164f-2c09-49a4-8f13-5c1237004086", "documentation": "Update Status", "method": "patch", "endpoint": "portouts/:id/:status", "responses": [ { "uuid": "b7e1d5e1-12d3-4a44-9485-9e40224d261c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "c900b6d6-37d4-4215-bc08-cf35c89f4374", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "4b9e7d67-9878-441b-96af-8f9bf8e42614", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "dccea3a1-1178-42f6-9d13-be66a405f178", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity. Check message field in response for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b592f745-fa56-42f5-826a-6de04a8c5447", "documentation": "Get all Private Wireless Gateways", "method": "get", "endpoint": "private_wireless_gateways", "responses": [ { "uuid": "6139b7ba-8684-42d9-a69f-8203db893c63", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "dd71a3ad-4c99-4d6c-9e14-ae0dd6d9c245", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "8f5eb44e-244c-4fe0-add6-d5b74c5483f8", "documentation": "Create a Private Wireless Gateway", "method": "post", "endpoint": "private_wireless_gateways", "responses": [ { "uuid": "bbcc2a31-92b9-4e00-9400-8f0da55875ce", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "13af2909-2bae-4a3f-8622-40929eafc80d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "a2ce6266-30ac-451d-93e8-829c6f5dc741", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "55da21c1-8785-4a5d-8fce-2e1b1a1f4dec", "documentation": "Delete a Private Wireless Gateway", "method": "delete", "endpoint": "private_wireless_gateways/:id", "responses": [ { "uuid": "b1ea91ea-867b-4c3b-bfb6-e43b5013192d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "3e61a2ce-19e0-444d-947d-650185768a3d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "78fa365c-e777-46b7-a65c-0005ba7877e0", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "176c643e-6d73-492b-b799-1853217ce0c1", "documentation": "Get a Private Wireless Gateway", "method": "get", "endpoint": "private_wireless_gateways/:id", "responses": [ { "uuid": "c2c8ec47-57cd-4979-88cb-c89a83fc59cc", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "4965fd03-b54a-4c5f-b6d4-4f159227529a", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "1d62391b-5040-44c5-bdc9-d78decdffba4", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "9f208c8a-a4e4-4089-9cab-76d6d0b666fe", "documentation": "Retrieve a call queue", "method": "get", "endpoint": "queues/:queue_name", "responses": [ { "uuid": "eb1384ef-1cde-4f92-aac0-db3d1a9d6cac", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "ca52be6c-efef-45fd-b255-338270f92da6", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "e449aee6-b8f7-4307-b0b7-6fe6c6985dab", "documentation": "Retrieve calls from a queue", "method": "get", "endpoint": "queues/:queue_name/calls", "responses": [ { "uuid": "fcbb48fe-fab2-4aba-8816-1e629c68fb29", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "e3c02d0e-cbc2-4aaa-b72c-6e3fc998e2d3", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "fa965fa4-36c3-4865-a06a-8143aa121d15", "documentation": "Retrieve a call from a queue", "method": "get", "endpoint": "queues/:queue_name/calls/:call_control_id", "responses": [ { "uuid": "835dcbb3-02d1-4e7b-8929-4570f6cb8639", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "1eff0c3f-315c-4399-846b-f193c4216573", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "21bad869-4001-4aec-be4e-7b96704cb7e7", "documentation": "List recordings", "method": "get", "endpoint": "recordings", "responses": [ { "uuid": "efe26f96-9f5f-45d6-a97d-bd7807675c11", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "d4c17b7c-216e-4a79-9a9c-34584d00a09a", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "cbbded27-8de6-497a-b2e1-c6632483f28f", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "233c7b42-1e39-475c-b732-bde8a5c8b061", "documentation": "Retrieve a recording", "method": "get", "endpoint": "recordings/:id", "responses": [ { "uuid": "fe4bbb78-1e5f-4ae1-bfcf-9c80d5647a76", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "a1e0bcce-0abb-4f8c-94cf-cb296b6cde39", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "3af3d999-3aa1-446c-98d3-9b1c5eeb9e44", "body": "", "latency": 0, "statusCode": 404, "label": "Conference does not exist", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "937609ca-ca24-4bee-a06c-e0648cf20d36", "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": "45e8efd1-afdf-42c2-99bc-5ad8a94c2eba", "body": "{\n \"data\": [\n {\n \"connections\": [\n {{faker 'datatype.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 'datatype.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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "48d6fd5e-ad8f-429c-a7e6-f825586b71c7", "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": "8d06359f-661b-44a0-b998-8506d29df68a", "body": "{\n \"data\": {\n \"connections\": [\n {{faker 'datatype.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 'datatype.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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "bdfed14a-d168-443a-ba9e-70c34e5a7e50", "documentation": "Delete generated messaging detail report by id", "method": "delete", "endpoint": "reports/batch_mdr_reports/:id", "responses": [ { "uuid": "0ec9a691-4f81-4437-85ff-af8fe234ae30", "body": "{\n \"data\": {\n \"connections\": [\n {{faker 'datatype.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 'datatype.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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "78359d58-1303-4d8e-a7f8-76ffbe1dc944", "documentation": "Fetch single messaging detail report by id.", "method": "get", "endpoint": "reports/batch_mdr_reports/:id", "responses": [ { "uuid": "cdd5e7a0-dffb-46c2-bbb1-3e4571bf8d5b", "body": "{\n \"data\": {\n \"connections\": [\n {{faker 'datatype.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 'datatype.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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ea56b865-95d3-4e8a-b543-6412f125aab7", "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": "3a3692ff-dee4-4e1f-b1f2-2f0f6c31e912", "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 'datatype.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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "3f15e992-acb1-4f73-8ace-9fa8162c8bd7", "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": "be1358c7-7b02-451b-bf58-63f036819675", "body": "{\n \"data\": [\n {\n \"aggregation_type\": \"{{oneOf (array 'NO_AGGREGATION' 'PROFILE' 'TAGS')}}\",\n \"connections\": [\n {{faker 'datatype.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 'datatype.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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "3fc84fb7-f524-47de-9d1d-261655fa522c", "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": "91b60777-6a33-43d3-a7a9-2bf876e0bb41", "body": "{\n \"data\": {\n \"aggregation_type\": \"{{oneOf (array 'NO_AGGREGATION' 'PROFILE' 'TAGS')}}\",\n \"connections\": [\n {{faker 'datatype.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 'datatype.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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "64e23377-7d5c-4181-bf02-9a4b580da7f4", "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": "7ff7b7ef-5344-4c71-8af4-6f74c857163e", "body": "{\n \"data\": {\n \"aggregation_type\": \"{{oneOf (array 'NO_AGGREGATION' 'PROFILE' 'TAGS')}}\",\n \"connections\": [\n {{faker 'datatype.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 'datatype.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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5be877ba-67a7-4e3e-a172-a5a4b39902ba", "documentation": "Delete messaging usage report by id", "method": "delete", "endpoint": "reports/mdr_usage_reports/:id", "responses": [ { "uuid": "9b9a2df9-42a6-416a-bd7d-772f8a6a3441", "body": "{\n \"data\": {\n \"aggregation_type\": \"{{oneOf (array 'NO_AGGREGATION' 'PROFILE' 'TAGS')}}\",\n \"connections\": [\n {{faker 'datatype.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 'datatype.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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "943b9a2d-20fd-4e5e-aedf-f1b9b107ca13", "documentation": "Fetch a single messaging usage report by id", "method": "get", "endpoint": "reports/mdr_usage_reports/:id", "responses": [ { "uuid": "d27a4e56-e746-49c2-9790-a2bfe19a967e", "body": "{\n \"data\": {\n \"aggregation_type\": \"{{oneOf (array 'NO_AGGREGATION' 'PROFILE' 'TAGS')}}\",\n \"connections\": [\n {{faker 'datatype.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 'datatype.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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "fe8e3b24-24ae-4709-9518-ad8b0fea0f5d", "documentation": "Fetch all Mdr records ", "method": "get", "endpoint": "reports/mdrs", "responses": [ { "uuid": "639732df-bfa0-4f67-8daf-ecdff847aa5f", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ea918e87-8640-4131-9be7-67a4fd25b532", "documentation": "Fetch all Wdr records ", "method": "get", "endpoint": "reports/wdrs", "responses": [ { "uuid": "b8df7e63-cba1-4d2f-91c0-70b3fb5469bb", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "950d7ec1-a688-497b-9f74-ae6537ac84de", "documentation": "List all requirement types", "method": "get", "endpoint": "requirement_types", "responses": [ { "uuid": "056c8a1a-1bdf-408e-9771-c4da7c8ad98c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "79a2c881-6dd7-4662-998b-45475e07ed01", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b8c0950f-c96a-4894-8a83-593fcfb24ef5", "documentation": "Retrieve a requirement types", "method": "get", "endpoint": "requirement_types/:id", "responses": [ { "uuid": "086efdc1-7648-4670-8ed1-2e2a0c3bfcd9", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "2b62de51-fb78-40a6-8aa5-2ddf1d96af33", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "459f012d-63b2-4c4c-b845-cd0cf20d547f", "documentation": "List all requirements", "method": "get", "endpoint": "requirements", "responses": [ { "uuid": "624f4a1b-de2a-4351-8927-ff7ce3d37509", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "bade683b-fc0d-4025-b286-e8063f463f0d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "3ac43dd0-d282-411a-b13d-fbaa0f504b12", "documentation": "Retrieve a document requirement", "method": "get", "endpoint": "requirements/:id", "responses": [ { "uuid": "02ef1c7c-0c8c-4833-987e-061424244071", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "16973a2b-8edb-4015-b076-210465c270e6", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "714085bf-88c2-4b30-9d39-f96b5043a41b", "documentation": "View a list of room participants.", "method": "get", "endpoint": "room_participants", "responses": [ { "uuid": "de36ed80-64eb-451d-abe3-2356b9611a92", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ae5a0067-bc1f-454b-93ef-f64d0f8aadf4", "documentation": "View a room participant.", "method": "get", "endpoint": "room_participants/:room_participant_id", "responses": [ { "uuid": "238ef032-0920-4d4b-a899-e660301c28b6", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "47902cea-914a-41fb-907f-79d903140a88", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "6b3c1012-e11a-4825-864d-86c688eef881", "documentation": "View a list of room sessions.", "method": "get", "endpoint": "room_sessions", "responses": [ { "uuid": "b0f36aa0-e6f2-41a0-9bc5-5f32be0e1f31", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7880e9a4-a879-44e1-b189-01fcbdbaed69", "documentation": "View a room session.", "method": "get", "endpoint": "room_sessions/:room_session_id", "responses": [ { "uuid": "146a7bb4-994e-4418-b372-6e1345c1be8c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "960110d0-ebb2-47f7-a6ab-1347b3c59f6c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "f47261be-e4d2-4900-8916-b97af592bfa0", "documentation": "View a list of room participants.", "method": "get", "endpoint": "room_sessions/:room_session_id/participants", "responses": [ { "uuid": "b783cabc-7d7c-4bb0-9d5d-8ed947d1448b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "93fb9f9d-810c-411d-882d-1e2a85b1a7da", "documentation": "View a list of rooms.", "method": "get", "endpoint": "rooms", "responses": [ { "uuid": "1d8efce1-d6cd-4952-9318-cd342ad62733", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6f6dddb0-b808-4049-997c-161e50dc2c4c", "documentation": "Create a room.", "method": "post", "endpoint": "rooms", "responses": [ { "uuid": "31259e9e-25f2-49d9-8aed-e9897d62e2e9", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "400da36c-6615-4f7b-843e-d1ea5b8cf7c1", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b066276f-853e-407a-a31f-74f80a22da0c", "documentation": "Delete a room.", "method": "delete", "endpoint": "rooms/:room_id", "responses": [ { "uuid": "4f2c2d4f-953f-40ce-89b9-b22faf73536e", "body": "", "latency": 0, "statusCode": 204, "label": "The resource was deleted successfully.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "94b62921-b2c5-41b9-a0a3-fd4938724633", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b76bbefa-0a71-4bd7-a65d-a888a777a462", "documentation": "View a room.", "method": "get", "endpoint": "rooms/:room_id", "responses": [ { "uuid": "4bd761fc-3cb5-4d64-a1ed-565e13a68cc0", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "a20ed554-6d89-458e-9135-0a713702f097", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "fcedd35b-1ea0-4683-88a5-888e95bc1fae", "documentation": "Create Client Token to join a room.", "method": "post", "endpoint": "rooms/:room_id/actions/generate_join_client_token", "responses": [ { "uuid": "a081bcc1-f04c-4fb3-89dd-3a4c234caaa9", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "1c5db028-ec77-4eed-b68e-3684ad294f49", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "c70ce59f-1184-455d-820e-e1a9430522d4", "documentation": "Refresh Client Token to join a room.", "method": "post", "endpoint": "rooms/:room_id/actions/refresh_client_token", "responses": [ { "uuid": "3b4f8f15-9108-452a-a6e6-7b9129ae91e8", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "0e49e1a9-3339-4506-9bfa-b7db85ece47c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "4724317a-4bcb-420a-9eda-d52bdfc98694", "documentation": "View a list of room sessions.", "method": "get", "endpoint": "rooms/:room_id/sessions", "responses": [ { "uuid": "ff1d0df8-198f-4410-a134-728eb557e911", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "1bffe4c9-152f-44bd-9651-fe6fc36b0445", "documentation": "List short codes", "method": "get", "endpoint": "short_codes", "responses": [ { "uuid": "9eec6677-3394-4055-b530-aa1415bd40a5", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "e73cf775-1dba-43dc-97d8-6b8693fa2ca6", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1646d174-cac6-4bf1-b6fd-16bdc955a318", "documentation": "Retrieve a short code", "method": "get", "endpoint": "short_codes/:id", "responses": [ { "uuid": "e690b72e-22d0-4987-b4bf-e0fe7845b829", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "432080ea-63ef-4a41-8c17-56d0038d1d83", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "7e3e237e-9ffe-4650-b151-4b0a576bd33c", "documentation": "Update short code", "method": "patch", "endpoint": "short_codes/:id", "responses": [ { "uuid": "71efcb0e-1637-4490-be1a-cf103cf34e45", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "4dc48768-3816-4428-9538-5a58bc93d470", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "694ca5a4-a975-41ca-98da-00c48f9f02b5", "documentation": "List SIM card group actions", "method": "get", "endpoint": "sim_card_group_actions", "responses": [ { "uuid": "334e2275-d982-4814-87a0-375eed76f862", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "878a34de-c6a1-4bc1-a179-b6803e5c1313", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "bf7a1aac-be4f-4247-9a47-27b983867dc1", "documentation": "Get SIM card group action details", "method": "get", "endpoint": "sim_card_group_actions/:id", "responses": [ { "uuid": "42ba963a-135a-4bf4-b48f-eb4319c945d9", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "a3d8f62a-05f1-4e2f-91b7-29e4aa709117", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "e89ba36e-02e6-4ebf-b344-819923de8931", "documentation": "Get all SIM card groups", "method": "get", "endpoint": "sim_card_groups", "responses": [ { "uuid": "eaa959f8-1b10-42cc-abdf-52da1d162edc", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "8a9d6736-ffee-4806-8c96-ea91bef904d9", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "8d147708-4052-464e-8212-ef9e8084a7ba", "documentation": "Create a SIM card group", "method": "post", "endpoint": "sim_card_groups", "responses": [ { "uuid": "ff0a123a-e986-4c72-8007-e065623a6261", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "7af4e35e-f7a4-4342-ac56-c9f7bdc97d57", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "bc68a5db-aac9-443b-a37e-23093a3ad3f1", "documentation": "Delete a SIM card group", "method": "delete", "endpoint": "sim_card_groups/:id", "responses": [ { "uuid": "61c5aa2c-eb7f-46ec-a306-460134205aa9", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "a14f4b29-915c-44c7-9224-b084aecff40f", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "40c95112-3259-4fc2-8caa-fc4a2b8d9186", "documentation": "Get SIM card group", "method": "get", "endpoint": "sim_card_groups/:id", "responses": [ { "uuid": "4a9813cb-1d8e-4f6d-a34b-4f996b382d21", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "3d0f8662-1af6-4efd-9b40-71243c1529b0", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "09c528ac-f9d9-44b2-b032-2e514389349a", "documentation": "Update a SIM card group", "method": "patch", "endpoint": "sim_card_groups/:id", "responses": [ { "uuid": "6c1cb300-2d1b-467a-a1f4-6680d394c539", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "addb0b25-a8ee-4622-83e7-54c7e8687e80", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "c27fb1ed-bbe8-4c58-a20d-82ed39d8fb70", "documentation": "Request Private Wireless Gateway removal from SIM card group", "method": "post", "endpoint": "sim_card_groups/:id/actions/remove_private_wireless_gateway", "responses": [ { "uuid": "f2d7ffd3-31fc-4beb-a09c-117f1c06edb3", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "a5e5c8bf-ab56-43bd-8589-141d91ab45eb", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "e475cf0b-63a7-4c5f-bff4-6407b99ca7a9", "documentation": "Request Private Wireless Gateway assignment for SIM card group", "method": "post", "endpoint": "sim_card_groups/:id/actions/set_private_wireless_gateway", "responses": [ { "uuid": "7b34bfb8-bb3c-44da-9cd6-b1a377e0576d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "2bfc3651-c5a5-4c4e-aad8-63bd409d3694", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "6e82dcae-9f54-43e4-8cab-506c7ccf255d", "documentation": "Preview SIM card orders", "method": "post", "endpoint": "sim_card_order_preview", "responses": [ { "uuid": "50e29dfc-482b-44eb-9a43-c7dff1c21527", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "0a11c05a-5bea-4250-b343-94a8819ee941", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "6b4aa21c-0972-4770-8711-a303de99e028", "documentation": "Get all SIM card orders", "method": "get", "endpoint": "sim_card_orders", "responses": [ { "uuid": "cfab1d8c-0fb1-4129-8c3f-aba7df484e71", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "f7f4f935-0b96-44ae-b918-27ab69cbe13a", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "4a2cc310-0b2b-4ceb-b04b-b6221bb2daf1", "documentation": "Create a SIM card order", "method": "post", "endpoint": "sim_card_orders", "responses": [ { "uuid": "8b90a523-f89d-47a6-8dc5-f55ae64cc7c9", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "712d76ef-b400-49c4-8fe9-648ab1555639", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "2ab1adb4-bd22-4cf1-8ff1-2b5e103481fd", "documentation": "Get a single SIM card order", "method": "get", "endpoint": "sim_card_orders/:id", "responses": [ { "uuid": "7c318141-3ded-4681-82c6-81749cb1c5eb", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "d7d831a0-e455-4ddd-81b4-8ac05fd2204b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "230791ab-3d36-4536-9b1e-d069f70cdc92", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "624a32bc-4622-4621-8065-7b3dde2a5d8b", "documentation": "Get all SIM cards", "method": "get", "endpoint": "sim_cards", "responses": [ { "uuid": "2c73df3a-a3b2-4e37-b1bf-9b4decb390a3", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "e20103b1-d156-4dba-9179-0c9c012ce237", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "fa9c2b84-d683-4c28-a2f5-1513338b4450", "documentation": "Validate SIM cards registration codes", "method": "post", "endpoint": "sim_cards/actions/validate_registration_codes", "responses": [ { "uuid": "776a131d-96c2-4ddc-9304-9ab0f3f6ec3b", "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 'datatype.boolean'}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "0fdeecda-7423-4036-8044-fca7079bb28b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "3a83bc06-487f-4a80-b106-d4345eba78cc", "documentation": "Deletes a SIM card", "method": "delete", "endpoint": "sim_cards/:id", "responses": [ { "uuid": "afacc51d-2c7e-4484-a306-0885c6ee0fb1", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "a9f01634-3886-4c81-b1fb-367d06d19a50", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "69752da5-17a5-4e87-860d-1bdb35e836c1", "documentation": "Get SIM card", "method": "get", "endpoint": "sim_cards/:id", "responses": [ { "uuid": "188919bf-7cf3-4126-bf5e-ca3c5ccf57ac", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "628ca51a-84d5-4bad-b621-71aab6ee7fa6", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "22303605-f494-48e1-9a0a-71b4e6de2278", "documentation": "Update a SIM card", "method": "patch", "endpoint": "sim_cards/:id", "responses": [ { "uuid": "5eb83d97-cc3a-44fa-90d1-93878480b404", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "4d119176-e1d9-4bf0-b37c-5096533c0893", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "4d8b89e3-cc69-4908-ac9b-862516581dc3", "documentation": "Request a SIM card disable", "method": "post", "endpoint": "sim_cards/:id/actions/disable", "responses": [ { "uuid": "46f7af54-c7a0-4edf-a337-ecc5b320cb2e", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "b65e03bd-4f4e-4d22-8dbc-4daa9a2eacb3", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "46537683-6518-490e-aeb5-cfcb20b178e5", "documentation": "Request a SIM card enable", "method": "post", "endpoint": "sim_cards/:id/actions/enable", "responses": [ { "uuid": "61624955-de15-4b0c-8642-44749877e309", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "8d02aaf6-8811-4779-92e0-068b516478a2", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "19444a1b-b056-4a44-bee2-5faf2300b614", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "6aca9a2e-2a92-4158-9767-79491bf79ea9", "documentation": "Request setting a SIM card to standby", "method": "post", "endpoint": "sim_cards/:id/actions/set_standby", "responses": [ { "uuid": "1e5641cb-d4c0-42af-bfa4-c823aada39b5", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "f498d55b-970e-4f17-9261-4dbf3ec23fd1", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "bf4809ad-7aec-4977-93af-9244aa806b63", "documentation": "DELETE network preferences", "method": "delete", "endpoint": "sim_cards/:sim_card_id/network_preferences", "responses": [ { "uuid": "7422f38d-80f3-4c15-be12-6cda32faee97", "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 'datatype.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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "52f3a7ef-3217-4179-ba9b-e069a100d20d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "716537e1-37bc-4188-8a4a-ee602942d5a0", "documentation": "Get network preferences", "method": "get", "endpoint": "sim_cards/:sim_card_id/network_preferences", "responses": [ { "uuid": "9d3123fd-758b-4888-85e3-57904d33e2de", "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 'datatype.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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "ceb6fde5-9d11-4b3e-b372-4052eec2a1b8", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1e311366-4adf-4793-84b1-7ceeb979c3af", "documentation": "Set network preferences", "method": "put", "endpoint": "sim_cards/:sim_card_id/network_preferences", "responses": [ { "uuid": "3a20c6b1-3083-41ed-bcba-836438463761", "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 'datatype.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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "bc51b6a6-349f-41c3-889d-4083dcca3d26", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "53d5400f-d136-4bbd-9350-5d25912b8c21", "documentation": "Delete SIM card public IP", "method": "delete", "endpoint": "sim_cards/:sim_card_id/public_ip", "responses": [ { "uuid": "34c0eab8-f623-46a8-abac-08f16f871520", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "822f7d54-309f-44c9-9cc7-cf7ee3d4f37f", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "f47d956f-57c0-46fc-a004-185d51617b61", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "9e1d6fe2-a8d4-4c97-a2ea-5f489484bc5c", "documentation": "Get SIM card public IP definition", "method": "get", "endpoint": "sim_cards/:sim_card_id/public_ip", "responses": [ { "uuid": "12ee37ce-0a08-4a3d-bbc1-8658ebc3025b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "89bd055c-313d-463c-8fc0-6b58c9fa9b27", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "ce36a39e-5d73-4596-8875-ffd4d21b3d9a", "documentation": "Set SIM card public IP", "method": "post", "endpoint": "sim_cards/:sim_card_id/public_ip", "responses": [ { "uuid": "75aced43-20dc-493a-8e92-01f1408c32f6", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "f1520dc7-c19a-47d1-a54b-a2381737d649", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "9023685d-3b20-4973-b6f9-d1c2b62105ca", "documentation": "List wireless connectivity logs", "method": "get", "endpoint": "sim_cards/:sim_card_id/wireless_connectivity_logs", "responses": [ { "uuid": "21da211e-80a7-4ef0-afb8-29ce676ec745", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "62df55ed-3a6b-452f-abd5-a83c439ac2b1", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "9573b4fd-ef3c-4ae3-b18c-ef49d71a84bd", "documentation": "List sub number orders", "method": "get", "endpoint": "sub_number_orders", "responses": [ { "uuid": "9b57d112-2c98-4791-bdd4-dcf22762f7a6", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "bbcad128-6a11-4802-8a95-3c8e9bc9dc4a", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "5ef03a17-60e8-4261-909a-0a4adb53e330", "documentation": "Retrieve a sub number order", "method": "get", "endpoint": "sub_number_orders/:sub_number_order_id", "responses": [ { "uuid": "869d3f6e-69e0-4b81-9b9c-48184450c4a1", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "7829c829-1c41-4cf3-a339-9f8a1b98e0b6", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "87434d07-da22-4853-a21b-3f28cd970dec", "documentation": "Update a sub number order", "method": "patch", "endpoint": "sub_number_orders/:sub_number_order_id", "responses": [ { "uuid": "e55571dd-292d-4036-9080-0cb382ce55f7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "2f0d1cda-9b2c-496e-a1b8-879baad7f20f", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "fed8e137-ad3d-4575-88cc-356d89f9dafe", "documentation": "List all credentials", "method": "get", "endpoint": "telephony_credentials", "responses": [ { "uuid": "95baab27-7741-434f-b111-6380b87ddb50", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "c5b9b3bc-ae2e-46e2-83bd-719d3e3a2119", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "72b25426-3558-428d-90b0-553594fe49dd", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "4e1aadf8-419e-4ccf-8716-61fe66dfbaf3", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "fbb7f4a7-c37f-4ab4-a8f7-e8565d494383", "documentation": "Create a credential", "method": "post", "endpoint": "telephony_credentials", "responses": [ { "uuid": "d391364a-4474-4ed3-af08-698164185b06", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "5fb6ec10-db3b-4404-b6ae-0d600b9a1d24", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "4962bec9-f410-459e-9612-ab73070d4254", "documentation": "List all tags", "method": "get", "endpoint": "telephony_credentials/tags", "responses": [ { "uuid": "59f06ae2-ecec-4e2b-ba6d-c1071c8c6a38", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "8caff322-8759-4b2d-b2e3-3fb3295a6ad5", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "95c717b2-cc66-4a9d-b129-ce7027561c41", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "3033710c-75ba-4a15-ace3-f104cdf6a73b", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "550b0656-3650-42ca-aafb-836b291e60e7", "documentation": "Delete a credential", "method": "delete", "endpoint": "telephony_credentials/:id", "responses": [ { "uuid": "45d8b8ab-a1b3-4f2c-ba7b-efd7789dfcbd", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "8f8941ba-adda-4f5b-a56a-667d6a985907", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "02665fbd-6095-4302-9d38-d74c0be1e438", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "b9239bca-d473-4aff-85b4-8bf46a2ee567", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "f82da9dc-a2b5-49a8-9c9d-56f47b4a01ec", "documentation": "Get a credential", "method": "get", "endpoint": "telephony_credentials/:id", "responses": [ { "uuid": "5aaa7337-ebf2-4e71-b29e-ea27c828ad26", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "8427df2e-71d9-41d5-a293-1376fec4e044", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "b6839f7f-e1c3-49a9-a3e7-5adae6bdac30", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "362e7b85-a310-44c9-8736-e4851d1ecd55", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "9390292f-5b65-4282-b9fa-894250616c9a", "documentation": "Update a credential", "method": "patch", "endpoint": "telephony_credentials/:id", "responses": [ { "uuid": "39fa4c43-b5f5-4d17-bded-e0f09f2e2f4a", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "1a48793f-2e98-4e57-822f-d6fa7b8800df", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "d766d6d7-2646-4e79-b112-2e77f32b3787", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "35f59231-db6e-45ad-a723-d802057717e4", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "afc6d9d0-698d-4a13-8ee7-4685d721f5fa", "documentation": "Perform activate or deactivate action on provided Credential", "method": "post", "endpoint": "telephony_credentials/:id/actions/:action", "responses": [ { "uuid": "36058238-ac9f-4053-b3ea-e0a793d1a463", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "e0a181b1-ab36-4a26-ad41-94f891f7bafb", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "f53b9453-a91e-4006-94a4-8c68017eb0c5", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "37fcb2da-5a36-4ed0-ad84-0451ff6f900e", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "f37100ab-e083-4945-992c-2528f3273876", "documentation": "Create an Access Token.", "method": "post", "endpoint": "telephony_credentials/:id/token", "responses": [ { "uuid": "0da71fd5-cabc-4e95-be19-cdd1da5157d6", "body": "", "latency": 0, "statusCode": 201, "label": "JWT", "headers": [ { "key": "Content-Type", "value": "text/plain" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "897ab1b1-4ac5-45e6-87e8-67f034e301b7", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not Found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "ad0aaf13-254e-48d6-aff4-b828369dcdee", "documentation": "List all TeXML Applications", "method": "get", "endpoint": "texml_applications", "responses": [ { "uuid": "a861e6cd-cb31-49a0-bcff-c6d3626b7ba0", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "b5290785-9ec5-4d60-9c76-4f5a68267ff5", "body": "", "latency": 0, "statusCode": 400, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "12ba917f-f0ab-4946-9738-71db0f509205", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "a776ebcc-082c-4138-ac11-b31911ffe355", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "d4b1cad2-b8ba-48f7-bf31-0b2f9dc00cd0", "documentation": "Creates a TeXML Application", "method": "post", "endpoint": "texml_applications", "responses": [ { "uuid": "2d249b6a-9665-4c95-a552-09407c1cd6e8", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "7706af7c-cbba-45ff-8351-84cb2b6f2ead", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "09d6a028-47ba-4432-92c6-84c97f2cf161", "documentation": "Deletes a TeXML Application", "method": "delete", "endpoint": "texml_applications/:id", "responses": [ { "uuid": "537c2117-914c-40bf-8637-e59341f4d3df", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "fb5ae59d-6d63-4646-ba23-bb494d2c903e", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "b027014d-b3be-4690-877c-d14a973fdfc0", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "18e6c49d-d196-4065-bc61-9af03a47c460", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "22800fc9-1468-45a0-bad3-fd80f8f9921b", "documentation": "Retrieve a TeXML Application", "method": "get", "endpoint": "texml_applications/:id", "responses": [ { "uuid": "692453dd-df54-4d62-9a9a-32a31c38586f", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "b5ffd396-bc56-479e-86cd-0fcfb80038a0", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "d3e54105-8095-41aa-b646-541fca70e3b1", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "55f70a85-c6de-4ab6-a948-e295431d0b31", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "876173c8-092a-4dae-8bc5-4c6639bab751", "documentation": "Update a TeXML Application", "method": "patch", "endpoint": "texml_applications/:id", "responses": [ { "uuid": "e6477db5-7939-4344-8023-8f074de3ebb2", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "5f274659-722c-465c-aae3-339ff0a1eb05", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "c4df6206-1551-4aa6-ae41-4e4c39087e88", "body": "", "latency": 0, "statusCode": 404, "label": "Resource not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "cc9b213d-9e89-4b64-9f79-ea6970ad82c3", "body": "", "latency": 0, "statusCode": 422, "label": "Bad request", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "ac8f6eab-b3e1-4365-bc00-1adecbbf7d25", "documentation": "List verifications by phone number", "method": "get", "endpoint": "verifications/by_phone_number/:phone_number", "responses": [ { "uuid": "188072ef-047d-40ae-96a7-df224c768847", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "e8080f98-5646-4094-8e5d-922af5d9d79d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "4da6a17f-3a85-4327-9a2e-8dc4f9380109", "documentation": "Submit a verification code", "method": "post", "endpoint": "verifications/by_phone_number/:phone_number/actions/verify", "responses": [ { "uuid": "0d54f9ab-4a08-427b-9e7b-284c8318aec3", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "7cf9f8fc-61fc-4a5d-80fa-ff588b1e5084", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "35e4b764-e728-47ea-8c17-d766955d37b3", "documentation": "Trigger a Call verification", "method": "post", "endpoint": "verifications/call", "responses": [ { "uuid": "895ab0ea-4d5d-42f7-a007-6fd92322ff6f", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "844c8bc9-4d62-48b6-9766-d9eb5272bca8", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "cfe9e9cd-1df2-47d6-aa6d-5131cacff10a", "documentation": "Trigger a Flash call verification", "method": "post", "endpoint": "verifications/flashcall", "responses": [ { "uuid": "3b6ee4d8-5066-48c4-8437-a32dd916330e", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "573a7275-542d-4167-80c7-2ccfb62b5567", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "ecb38ddd-e2ec-48f5-b822-aab6503ee934", "documentation": "Trigger a PSD2 verification", "method": "post", "endpoint": "verifications/psd2", "responses": [ { "uuid": "fe9312aa-9e27-4eaa-8dd5-b0400139c635", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "64d392b8-f820-47de-8ad6-ba0d2d3480ca", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "365cfd40-696c-404e-a933-ba2f78969535", "documentation": "Trigger a SMS verification", "method": "post", "endpoint": "verifications/sms", "responses": [ { "uuid": "0d5c5b93-85e1-4fbe-8c0b-b2d5a0c556f0", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "f683f14b-e2e8-4aea-a914-387bdefb511e", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1abe0874-d531-4da0-8389-47434e056824", "documentation": "Trigger a Whatsapp verification", "method": "post", "endpoint": "verifications/whatsapp", "responses": [ { "uuid": "5f11f857-224f-4b75-b765-76daac548bec", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "33a4e55e-65d1-4197-b3c8-2a4dcdc3e33d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "e069b7e9-96b3-4e92-ad35-8bd7d58c4c0a", "documentation": "Retrieve a verification", "method": "get", "endpoint": "verifications/:verification_id", "responses": [ { "uuid": "d0ae095e-53aa-46ec-93ea-f22dc8964ff2", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "76b11672-f83a-491f-96f3-e830cc58eb2d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "3c31a375-eda8-4a5e-a83c-83c6a2ae5bf5", "documentation": "List all Verify profiles", "method": "get", "endpoint": "verify_profiles", "responses": [ { "uuid": "7513f8a6-2fe8-4b3d-8548-7817bb78c2fa", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "29ef5d9d-c353-41b8-b4a8-f9cd6fc2552f", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "0463f364-f63d-4792-8f99-1571b4d3cc51", "documentation": "Create a Verify profile", "method": "post", "endpoint": "verify_profiles", "responses": [ { "uuid": "770da4b8-5399-4487-8ae7-80976e8697fe", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "5c93ec5b-7c54-4568-8961-c93b5f3e329f", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "739e8aa1-8a54-494f-a7ca-c28f0ec1cad0", "documentation": "Delete a Verify profile", "method": "delete", "endpoint": "verify_profiles/:verify_profile_id", "responses": [ { "uuid": "67dd3fcd-a8f3-45cf-82c1-d7f6bf18409b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "46f2ca82-4250-43fd-978e-c5abe8abfa19", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "504f7bef-c081-4579-a102-6b70a701835f", "documentation": "Retrieve a Verify profile", "method": "get", "endpoint": "verify_profiles/:verify_profile_id", "responses": [ { "uuid": "b0b0a005-723d-4d4a-9c6b-d0fd26064197", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "8a7aa333-a8e8-4113-bc38-65d57adc1188", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "83fb8370-37dd-4f39-8656-773c588d2750", "documentation": "Update a Verify profile", "method": "patch", "endpoint": "verify_profiles/:verify_profile_id", "responses": [ { "uuid": "d455b53d-7370-4de1-a47c-48fd6b3d69a7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "605ee62d-26c6-4d6e-b2b7-65a234763816", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "50b1147f-7d0b-4668-8c8e-de6a5c0a4bca", "documentation": "List webhook deliveries", "method": "get", "endpoint": "webhook_deliveries", "responses": [ { "uuid": "be488b9a-a94c-4f10-b9b3-b388b60cfeb7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "36c1dd03-e6e4-4e1b-9d8e-26a220a34b23", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "32d6f19b-340c-4b4c-a515-5d55b8f47336", "body": "", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "0b313c3e-1fc8-4570-8b89-0a5d2fba884c", "documentation": "Find webhook_delivery details by ID", "method": "get", "endpoint": "webhook_deliveries/:id", "responses": [ { "uuid": "9aaa49f2-0c2a-40e6-a00c-d56636eebf14", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "28bbef6d-608a-4d3b-a4f5-061dfac4f9e6", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "58bdbe0a-9a24-4516-8571-da422efe7f3b", "body": "", "latency": 0, "statusCode": 404, "label": "WebhookDelivery not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "3a469963-2024-4869-8c37-00c1ad431e07", "documentation": "Check Contact", "method": "post", "endpoint": "whatsapp_contacts", "responses": [ { "uuid": "3bc53022-4646-4c13-8788-bdd5a469f5f5", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "642353cf-0786-41be-a0ca-c8f6ea9179aa", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "582578a2-adf9-4e33-92c5-d043408065c0", "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": "6fab4de2-870f-4a41-abce-26e40fe5dd5b", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "d779d384-0a6b-4fee-86ab-9a7ede9de51b", "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": "b66fb469-d2b6-4983-8f6b-65ce65b272c5", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "47cc2ded-eb78-44bc-b56a-1d66c14a3285", "documentation": "Delete generated WhatsApp detail report by id", "method": "delete", "endpoint": "whatsapp_detail_record_reports/:id", "responses": [ { "uuid": "1579c775-4590-4350-a913-33ce729fda4e", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a097829f-36b1-46a7-a113-7df0e289ef65", "documentation": "Fetch single whatsapp detail report by id.", "method": "get", "endpoint": "whatsapp_detail_record_reports/:id", "responses": [ { "uuid": "28686078-f6ea-464e-ad16-bfea6b436553", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "7cb332e2-1bea-4ea8-8594-0fe274539634", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "8be8b976-33f1-48b1-939f-9b6aab3701ca", "documentation": "Upload Media", "method": "post", "endpoint": "whatsapp_media", "responses": [ { "uuid": "ce0a55fa-bcd8-43be-9c2f-fc0e41bea5ba", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "11089dfb-9d76-4796-8312-4440fa370b51", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "fbd547e4-9572-4e7c-9df8-2a8b6edd3fed", "documentation": "Delete Media", "method": "delete", "endpoint": "whatsapp_media/:whatsapp_user_id/:media_id", "responses": [ { "uuid": "f6855b99-d900-4ed2-83c1-53b462c50766", "body": "", "latency": 0, "statusCode": 204, "label": "Request successful, empty response body.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "67808335-a4b9-475c-9ff0-b3a3e4e9ff45", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "a37d6978-db30-4b5e-99e4-1318655f50fc", "documentation": "Download Media", "method": "get", "endpoint": "whatsapp_media/:whatsapp_user_id/:media_id", "responses": [ { "uuid": "da4d0480-0e85-4973-b475-0bc5b069873a", "body": "", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [ { "key": "Content-Type", "value": "*" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "9b05f822-a27a-4a61-89e4-e3e7e5470548", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "7e61f4b8-36af-4a96-aecb-d07292df02e5", "documentation": "Send Message", "method": "post", "endpoint": "whatsapp_messages", "responses": [ { "uuid": "87a5d738-e433-4c56-b097-6d3c5fb591a3", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "98ec494e-2cef-4734-9ed5-623c036380e7", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "7aaaf601-3536-47b6-866e-5da09cd855dc", "documentation": "Mark Message As Read", "method": "patch", "endpoint": "whatsapp_messages/:message_id", "responses": [ { "uuid": "5a58df35-0b42-461f-84c4-fbdb7a3ee339", "body": "", "latency": 0, "statusCode": 204, "label": "Request successful, empty response body.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "23a100d4-a011-4e20-a212-ddbb5020dcdf", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "f8902093-42f8-4218-8b74-265f8fc35a62", "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": "24d6a718-a180-4fc3-8c8a-112a4ce64b36", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "401b1a82-405e-46ce-a779-ebbfe7323657", "documentation": "Get User", "method": "get", "endpoint": "whatsapp_users/:whatsapp_user_id", "responses": [ { "uuid": "7907d5d4-0292-47e2-a2c5-b267d6335621", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "403ea7f6-38e3-4cb2-bfb3-9909bfc3248c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "876c1891-d928-47a1-9a5a-b82ab9c07202", "documentation": "Update WhatsApp User", "method": "patch", "endpoint": "whatsapp_users/:whatsapp_user_id", "responses": [ { "uuid": "cf4fd8ae-6684-4fd3-b871-1968da9c7c98", "body": "", "latency": 0, "statusCode": 204, "label": "Request successful, empty response body.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "2ce26db4-0a2d-457f-9726-4b747223067d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "4bca20ae-4256-4eb9-9bb1-706116755cca", "documentation": "Get all Wireless Detail Records (WDRs) Reports", "method": "get", "endpoint": "wireless/detail_records_reports", "responses": [ { "uuid": "b9fb7519-7704-4573-9cc3-b7bcd28e7138", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "d6233a8a-382f-45e0-b3e3-3ad277c37ac0", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "8fa03319-583b-4fe4-b5e2-f44584aa9658", "documentation": "Create a Wireless Detail Records (WDRs) Report", "method": "post", "endpoint": "wireless/detail_records_reports", "responses": [ { "uuid": "d34a8ae4-65c0-4d82-9a45-011fe7278e1d", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "7b17eed6-30df-494d-ac79-89297fa0823e", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "183b0b37-bc1f-490b-994f-c1c649216bac", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "2f31bc6b-5f62-44ee-bae8-ef3a74f6ca5a", "documentation": "Delete a Wireless Detail Record (WDR) Report", "method": "delete", "endpoint": "wireless/detail_records_reports/:id", "responses": [ { "uuid": "042f49eb-162d-4155-b5e0-ab122f1ce459", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "db490c48-c94b-4b13-8e1d-a394b36c3f0c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "57409e89-8df2-4886-90aa-1c4147699ae1", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "0f37bb89-3214-4f96-b5c1-b63b3083f4fe", "documentation": "Get a Wireless Detail Record (WDR) Report", "method": "get", "endpoint": "wireless/detail_records_reports/:id", "responses": [ { "uuid": "4c8de7b4-e221-4b01-8080-811bac9a0da8", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "20098081-a571-4601-a36d-ad9c1a4aadc0", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "e6e60ce3-5439-4970-b8a4-9b42a791a37c", "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" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [ { "key": "", "value": "" } ], "proxyResHeaders": [ { "key": "", "value": "" } ], "data": [] }