{ "openapi": "3.0.1", "components": { "securitySchemes": { "accountSid_authToken": { "scheme": "basic", "type": "http" } }, "schemas": { "insights.v2.create_account_report_request": { "type": "object", "properties": { "time_range": { "type": "object", "description": "Optional start and end date time for the report window. Defaults to the most recent 7 days when omitted.", "properties": { "start_time": { "type": "string", "format": "date-time", "description": "Start time of the report", "example": "2024-01-01T00:00:00Z", "x-twilio": { "shortDescription": "Start time of the report" } }, "end_time": { "type": "string", "format": "date-time", "description": "End time of the report", "example": "2024-01-07T00:00:00Z", "x-twilio": { "shortDescription": "Start time of the report" } } } }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/report_filter" } } } }, "insights.v2.create_report_response": { "type": "object", "properties": { "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "description": "The unique SID identifier of the Account." }, "report_id": { "type": "string", "description": "The report identifier as Voice Insights Report TTID." }, "status": { "$ref": "#/components/schemas/report_status" }, "request_meta": { "$ref": "#/components/schemas/report_metadata" }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of this resource." } } }, "insights.v2.account_report": { "type": "object", "properties": { "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "description": "The unique SID identifier of the Account." }, "report_id": { "type": "string", "description": "The account level report identifier as Voice Insights Report TTID." }, "status": { "$ref": "#/components/schemas/report_status" }, "request_meta": { "$ref": "#/components/schemas/report_metadata" }, "report": { "$ref": "#/components/schemas/account_report" }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of this resource." } } }, "insights.v2.create_phone_numbers_report_request": { "type": "object", "properties": { "time_range": { "type": "object", "properties": { "start_time": { "type": "string", "format": "date-time", "description": "Start time of the report", "example": "2024-01-01T00:00:00Z", "x-twilio": { "shortDescription": "Start time of the report" } }, "end_time": { "type": "string", "format": "date-time", "description": "End time of the report", "example": "2024-01-07T00:00:00Z", "x-twilio": { "shortDescription": "Start time of the report" } } } }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/phone_number_report_filter" } }, "size": { "type": "integer", "default": 1000, "minimum": 1, "maximum": 6000, "description": "The number of max available top Phone Numbers to generate." } } }, "insights.v2.inbound_phone_number_report": { "type": "object", "properties": { "handle": { "type": "string", "description": "Inbound phone number handle represented in the report.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "total_calls": { "type": "integer", "description": "Total number of calls made with the given handle during the report period." }, "call_answer_score": { "type": "number", "format": "float", "description": "The call answer score measures customers behavior to the delivered calls.\nThe score is a value between 0 and 100, where 100 indicates that all calls were successfully answered.\n" }, "call_state_percentage": { "type": "object", "properties": { "completed": { "type": "number", "format": "float", "description": "Percentage of completed inbound calls." }, "fail": { "type": "number", "format": "float", "description": "Percentage of failed inbound calls." }, "busy": { "type": "number", "format": "float", "description": "Percentage of busy inbound calls." }, "noanswer": { "type": "number", "format": "float", "description": "Percentage of no-answer inbound calls." }, "canceled": { "type": "number", "format": "float", "description": "Percentage of canceled inbound calls." } }, "description": "Percentage of calls made in each state." }, "silent_calls_percentage": { "type": "number", "format": "float", "description": "Percentage of inbound calls with silence tags over total outbound calls. A silent tag is indicative of a connectivity issue or muted audio." } } }, "insights.v2.outbound_phone_number_report": { "type": "object", "properties": { "handle": { "type": "string", "description": "The outbound phone number handle.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "total_calls": { "type": "integer", "description": "Total number of outbound calls made with the given handle during the report period." }, "call_answer_score": { "type": "number", "format": "float", "description": "The call answer score measures customers behavior to the delivered calls.\nThe score is a value between 0 and 100, where 100 indicates that all calls were successfully answered.\n" }, "calls_by_device_type": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "Number of calls made with each device type.\n`voip`, `mobile`, `landline`, `unknown`\n", "example": { "voip": 1500, "mobile": 3000, "landline": 500, "unknown": 200 } }, "answer_rate_device_type": { "type": "object", "additionalProperties": { "type": "number", "format": "float" }, "description": "Answer rate for each device type.\n`voip`, `mobile`, `landline`, `unknown`\n", "example": { "voip": 45.5, "mobile": 60.2, "landline": 70.1, "unknown": 30.0 } }, "call_state_percentage": { "type": "object", "properties": { "completed": { "type": "number", "format": "float", "description": "Percentage of completed outbound calls." }, "fail": { "type": "number", "format": "float", "description": "Percentage of failed outbound calls." }, "busy": { "type": "number", "format": "float", "description": "Percentage of busy outbound calls." }, "noanswer": { "type": "number", "format": "float", "description": "Percentage of no-answer outbound calls." }, "canceled": { "type": "number", "format": "float", "description": "Percentage of canceled outbound calls." } }, "description": "Percentage of calls made in each state." }, "blocked_calls_by_carrier": { "type": "array", "items": { "$ref": "#/components/schemas/county_carrier_value" }, "description": "Percentage of blocked calls by carrier per country." }, "silent_calls_percentage": { "type": "number", "format": "float", "description": "Percentage of calls with silence tags over total calls. A silent tag is indicative of a connectivity issue or muted audio." }, "short_duration_calls_percentage": { "type": "number", "format": "float", "description": "Percentage of completed outbound calls under 10 seconds (PSTN Short call tags); More than 15% is typically low trust measured." }, "long_duration_calls_percentage": { "type": "number", "format": "float", "description": "Percentage of long duration calls ( >= 60 seconds)" }, "potential_robocalls_percentage": { "type": "number", "format": "float", "description": "Percentage of completed outbound calls to unassigned or unallocated phone numbers." }, "answering_machine_detection": { "type": "object", "properties": { "total_calls": { "type": "integer", "description": "Total number of calls with answering machine detection (AMD) enabled.", "x-twilio": { "shortDescription": "Total number of calls with answering machine detection enabled" } }, "answered_by_human_percentage": { "type": "number", "format": "float", "description": "Percentage of calls marked as answered by human.", "x-twilio": { "shortDescription": "Percentage of calls marked as answered by human" } }, "answered_by_machine_percentage": { "type": "number", "format": "float", "description": "Percentage of calls marked as answered by machined related like the following:\n`machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `fax`\n" } }, "description": "Number of calls made in answering machine detection (AMD) enabled." } } }, "report_status": { "type": "string", "enum": [ "created", "running", "completed" ], "description": "The status of the report." }, "report_filter": { "type": "object", "properties": { "key": { "type": "string", "description": "The name of the filter\n'call_state', 'call_direction', 'call_type', 'twilio_regions', 'caller_country_code', 'callee_country_code', 'silent'\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of supported filter values for the field name" } } }, "phone_number_report_filter": { "type": "object", "properties": { "key": { "type": "string", "description": "The name of the filter\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of supported filter values for the field name" } } }, "report_metadata": { "type": "object", "properties": { "start_time": { "type": "string", "format": "date-time", "description": "Start time of the report" }, "end_time": { "type": "string", "format": "date-time", "description": "End time of the report" }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/report_filter" }, "default": [], "description": "Filter values applied to the report" } } }, "account_report": { "type": "object", "properties": { "call_deliverability_score": { "type": "number", "format": "float", "description": "The call deliverability score measures the network effectiveness in delivering calls by scoring calls reach the intended recipient.\nThe score is a value between 0 and 100, where 100 indicates that all calls were successfully delivered.\n" }, "call_answer_score": { "type": "number", "format": "float", "description": "The call answer score measures customers behavior to the delivered calls.\nThe score is a value between 0 and 100, where 100 indicates that all calls were successfully answered.\n" }, "total_calls": { "type": "integer", "description": "Total number of calls made during the report period." }, "call_direction": { "type": "object", "properties": { "outbound": { "type": "integer", "description": "Number of outbound calls" }, "inbound": { "type": "integer", "description": "Number of inbound calls" } }, "description": "Number of calls made in each direction." }, "call_state": { "type": "object", "properties": { "completed": { "type": "integer", "description": "Number of completed calls" }, "fail": { "type": "integer", "description": "Number of failed calls" }, "busy": { "type": "integer", "description": "Number of busy calls" }, "noanswer": { "type": "integer", "description": "Number of no-answer calls" }, "canceled": { "type": "integer", "description": "Number of canceled calls" } }, "description": "Number of calls made in each state." }, "call_type": { "type": "object", "properties": { "carrier": { "type": "integer", "description": "Number of carrier calls" }, "sip": { "type": "integer", "description": "Number of SIP calls" }, "trunking": { "type": "integer", "description": "Number of trunking calls" }, "client": { "type": "integer", "description": "Number of client calls" }, "whatsapp": { "type": "integer", "description": "Number of WhatsApp Business calls" } }, "description": "Number of calls made in each type.\n`carrier`, `sip`, `trunking`, `client`, `whatsapp`\n" }, "aloc": { "type": "number", "format": "float", "description": "Average length of call in seconds." }, "twilio_edge_location": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "Number of calls made in each Twilio Edge location. Refer to [Public Edge Locations](https://www.twilio.com/docs/global-infrastructure/edge-locations#public-edge-locations) for more detail.", "example": { "ashburn": 1500, "umatilla": 1200, "sydney": 800 } }, "caller_country_code": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "Number of calls originating from each country (ISO alpha-2).", "example": { "US": 2000, "AU": 500 } }, "callee_country_code": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "Number of calls terminating in each country (ISO alpha-2).", "example": { "US": 2000, "AU": 500 } }, "average_queue_time_ms": { "type": "number", "format": "float", "description": "Average queue time in milliseconds." }, "silent_calls_percentage": { "type": "number", "format": "float", "description": "Percentage of silent calls." }, "network_issues": { "type": "object", "description": "Network-quality indicators for SDK and Twilio Gateway traffic during the report period.", "properties": { "sdk": { "type": "object", "properties": { "ice_failures_percentage": { "type": "number", "format": "float", "description": "Percentage of ICE connection failure tag that ICE candidates have failed to find compatible connection.", "x-twilio": { "shortDescription": "Percentage of ICE failures" } }, "high_latency_percentage": { "type": "number", "format": "float", "description": "Percentage of calls with high latency.", "x-twilio": { "shortDescription": "Percentage of calls with high latency" } }, "high_packet_loss_percentage": { "type": "number", "format": "float", "description": "Percentage of calls with high packet loss.", "x-twilio": { "shortDescription": "Percentage of calls with high packet loss" } }, "high_jitter_percentage": { "type": "number", "format": "float", "description": "Percentage of calls with high jitter.", "x-twilio": { "shortDescription": "Percentage of calls with high jitter" } } }, "description": "Network issues of calls for client type. This is indicative of local network issues.", "x-twilio": { "shortDescription": "Network issues of calls for client type. This is indicative of local network issues." } }, "twilio_gateway": { "type": "object", "properties": { "high_latency_percentage": { "type": "number", "format": "float", "description": "Percentage of calls with high latency.", "x-twilio": { "shortDescription": "Percentage of calls with high latency" } }, "high_packet_loss_percentage": { "type": "number", "format": "float", "description": "Percentage of calls with high packet loss.", "x-twilio": { "shortDescription": "Percentage of calls with high packet loss" } }, "high_jitter_percentage": { "type": "number", "format": "float", "description": "Percentage of calls with high jitter.", "x-twilio": { "shortDescription": "Percentage of calls with high jitter" } } }, "description": "Network related metrics for Twilio Gateway calls only.", "x-twilio": { "shortDescription": "Network related metrics for Twilio Gateway calls only" } } } }, "KYT": { "type": "object", "properties": { "outbound_carrier_calling": { "type": "object", "properties": { "unique_calling_numbers": { "type": "integer", "description": "Number of unique PSTN calling numbers to non-Twilio numbers during the report period." }, "unique_called_numbers": { "type": "integer", "description": "Number of unique non-Twilio PSTN called numbers during the report period." }, "blocked_calls_by_carrier": { "type": "array", "items": { "$ref": "#/components/schemas/county_carrier_value" }, "description": "Percentage of blocked calls by carrier per country.", "x-twilio": { "shortDescription": "Percentage of blocked calls by carrier per country" } }, "short_duration_calls_percentage": { "type": "number", "format": "float", "description": "Percentage of completed outbound calls under 10 seconds (PSTN Short call tags); More than 15% is typically low trust measured.", "x-twilio": { "shortDescription": "Percentage of short duration calls" } }, "long_duration_calls_percentage": { "type": "number", "format": "float", "description": "Percentage of long duration calls ( >= 60 seconds)", "x-twilio": { "shortDescription": "Percentage of long duration calls" } }, "potential_robocalls_percentage": { "type": "number", "format": "float", "description": "Percentage of completed outbound calls to unassigned or unallocated phone numbers.", "x-twilio": { "shortDescription": "Percentage of potential robocalls" } }, "branded_calling": { "$ref": "#/components/schemas/branded_calling" }, "voice_integrity": { "$ref": "#/components/schemas/voice_integrity" }, "stir_shaken": { "$ref": "#/components/schemas/stir_shaken" } }, "description": "KYT metrics for outbound carrier calling.", "x-twilio": { "shortDescription": "KYT metrics for outbound carrier calling" } } }, "description": "Know Your Traffic (KYT) metrics focused on outbound carrier performance and trust signals for the report period." }, "answering_machine_detection": { "type": "object", "properties": { "total_calls": { "type": "integer", "description": "Total number of calls with answering machine detection enabled (AMD).", "x-twilio": { "shortDescription": "Total number of calls with answering machine detection enabled (AMD)" } }, "answered_by_human_percentage": { "type": "number", "format": "float", "description": "Percentage of calls marked as answered by human.", "x-twilio": { "shortDescription": "Percentage of calls marked as answered by human" } }, "answered_by_machine_percentage": { "type": "number", "format": "float", "description": "Percentage of calls marked as answered by machined related like the following:\n`machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `fax`\n" } }, "description": "Number of calls made in each answering machine detection." } } }, "county_carrier_value": { "type": "object", "properties": { "country": { "type": "string" }, "carriers": { "type": "array", "items": { "type": "object", "properties": { "carrier": { "type": "string", "description": "The name of the carrier." }, "total_calls": { "type": "integer", "description": "Total number of outbound calls for the carrier in the country." }, "blocked_calls": { "type": "integer", "description": "Total number of blocked outbound calls for the carrier in the country." }, "blocked_calls_percentage": { "type": "number", "format": "float", "description": "Percentage of blocked outbound calls for the carrier in the country." } } } } } }, "branded_calling": { "type": "object", "properties": { "total_branded_calls": { "type": "integer", "description": "Total number of Branded bundled calls." }, "percent_branded_calls": { "type": "number", "format": "float", "description": "Percentage of Branded bundled calls over total outbound calls." }, "answer_rate": { "type": "number", "format": "float", "description": "Answer rate for Branded bundled calls." }, "human_answer_rate": { "type": "number", "format": "float", "description": "Rate of Branded bundled calls that were answered by Human." }, "engagement_rate": { "type": "number", "format": "float", "description": "Engagement Rate for Branded bundled calls where its call length is longer than 60 seconds." }, "by_use_case": { "type": "array", "items": { "$ref": "#/components/schemas/branded_use_case_detail" }, "description": "Details of branded calls by use case." } }, "description": "Metrics related to Branded Calling bundled calls including CTIA for the report period." }, "branded_use_case_detail": { "type": "object", "properties": { "use_case": { "type": "string", "description": "The name of supported use case for Branded calls." }, "enabled_phonenumbers": { "type": "integer", "description": "The number of phone numbers enabled Branded calls." }, "total_calls": { "type": "integer", "description": "The number of total outbound calls for the use case." }, "answer_rate": { "type": "number", "format": "float", "description": "Answer rate per each use case for Branded bundled calls." }, "human_answer_rate": { "type": "number", "format": "float", "description": "Rate of Branded bundled calls that were answered by Human per each use case for Branded bundled calls." }, "engagement_rate": { "type": "number", "format": "float", "description": "Engagement Rate for Branded bundled calls where its call length is longer than 60 seconds per each use case for Branded bundled calls." } }, "description": "Associated metrics for Branded calls grouped by each use case." }, "voice_integrity": { "type": "object", "properties": { "enabled_calls": { "type": "integer", "description": "Total number of calls with Voice Integrity enabled." }, "enabled_percentage": { "type": "number", "format": "float", "description": "Percentage of calls with Voice Integrity enabled." }, "calls_per_bundle": { "type": "array", "items": { "$ref": "#/components/schemas/voice_integrity_calls_per_bundle" }, "description": "Number of calls per Voice Integrity enabled Bundle Sid." } }, "description": "Metrics related to Voice Integrity enabled calls for the report period." }, "voice_integrity_calls_per_bundle": { "type": "object", "properties": { "bundle_sid": { "type": "string", "description": "Voice Integrity Approved Profile Sid." }, "enabled_phonenumbers": { "type": "integer", "description": "The number of Voice Integrity enabled and registered phone numbers per Bundle Sid." }, "total_calls": { "type": "integer", "description": "The number of outbound calls on Voice Integrity enabled and registered number per Bundle Sid." }, "answer_rate": { "type": "number", "format": "float", "description": "Answer rate for calls on Voice Integrity enabled and registered number per Bundle Sid." }, "human_answer_rate": { "type": "number", "format": "float", "description": "Rate for calls on Voice Integrity enabled and registered number per Bundle Sid that were answered by Human per each use case for Branded bundled calls." } } }, "stir_shaken": { "type": "object", "properties": { "call_count": { "type": "object", "properties": { "stsh_a": { "type": "integer", "description": "Total number of calls for Stir Shaken category A." }, "stsh_b": { "type": "integer", "description": "Total number of calls for Stir Shaken category B." }, "stsh_c": { "type": "integer", "description": "Total number of calls for Stir Shaken category C." } }, "description": "Total number of calls for each STIR/SHAKEN attestation category." }, "percentage": { "type": "object", "properties": { "stsh_a": { "type": "number", "format": "float", "description": "Percentage of calls for Stir Shaken category A." }, "stsh_b": { "type": "number", "format": "float", "description": "Percentage of calls for Stir Shaken category B." }, "stsh_c": { "type": "number", "format": "float", "description": "Percentage of calls for Stir Shaken category C." } }, "description": "Percentage of calls for each STIR/SHAKEN attestation category." }, "answer_rate": { "type": "object", "properties": { "stsh_a": { "type": "number", "format": "float", "description": "Answer rate for Stir Shaken category A." }, "stsh_b": { "type": "number", "format": "float", "description": "Answer rate for Stir Shaken category B." }, "stsh_c": { "type": "number", "format": "float", "description": "Answer rate for Stir Shaken category C." } }, "description": "Answer rate for each STIR/SHAKEN attestation category." } }, "description": "Metrics related to STIR/SHAKEN attestation A, B, and C for the report period." } } }, "security": [ { "accountSid_authToken": [] } ], "servers": [ { "url": "https://insights.twilio.com" } ], "info": { "contact": { "email": "api-team@twilio.com", "name": "Twilio API Team" }, "version": "1.0.0", "title": "Sample/reference Twilio API.", "description": "This is the reference API for the rest-proxy server.", "x-twilio": { "apiStandards": "v0.1" } }, "paths": { "/v2/Voice/Reports": { "servers": [ { "url": "https://insights.twilio.com" } ], "description": "Root resource for Voice Reports V2", "x-twilio": { "defaultOutputProperties": [ "account_sid", "report_id", "status" ], "pathType": "instance" }, "post": { "description": "Create a Report for a specific account with given time range and filters.", "tags": [ "InsightsV1CreateAccountReport" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insights.v2.create_account_report_request" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insights.v2.create_report_response" }, "examples": { "post": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "report_id": "voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av", "status": "created", "request_meta": { "start_time": "2024-11-01T00:00:00Z", "end_time": "2024-11-07T00:00:00Z", "filters": [] }, "url": "https://insights.twilio.com/v2/Voice/Reports/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateAccountReport", "summary": "Create Account Level Report" } }, "/v2/Voice/Reports/{reportId}": { "servers": [ { "url": "https://insights.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", "report_id", "status" ], "pathType": "instance" }, "get": { "description": "Get Account Level Report for the given Report Id.", "tags": [ "InsightsV1GetAccountReport" ], "parameters": [ { "name": "reportId", "in": "path", "description": "A unique request id.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insights.v2.account_report" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "report_id": "voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av", "status": "completed", "request_meta": { "start_time": "2024-11-01T00:00:00Z", "end_time": "2024-11-07T00:00:00Z", "filters": [] }, "report": { "call_deliverability_score": 99.99, "call_answer_score": 83.4, "total_calls": 67895, "call_direction": { "outbound": 43841, "inbound": 24054 }, "call_state": { "completed": 43841, "fail": 4070, "busy": 4004, "noanswer": 15030, "canceled": 1050 }, "call_type": { "carrier": 14403, "sip": 23094, "trunking": 9884, "client": 20514, "whatsapp": 0 }, "aloc": 120.34, "twilio_edge_location": { "tokyo": 12, "sydney": 9, "dublin": 34, "ashburn": 67784, "umatilla": 27, "frankfurt": 29 }, "caller_country_code": { "US": 67784, "NL": 111 }, "callee_country_code": { "PR": 466, "US": 67143, "CA": 286 }, "average_queue_time_ms": 212.49, "silent_calls_percentage": 18.83, "network_issues": { "sdk": { "ice_failures_percentage": 0.0, "high_latency_percentage": 26.08, "high_packet_loss_percentage": 0.06, "high_jitter_percentage": 1.88 }, "twilio_gateway": { "high_latency_percentage": 9.26, "high_packet_loss_percentage": 0.1, "high_jitter_percentage": 0.0 } }, "KYT": { "outbound_carrier_calling": { "unique_calling_numbers": 430, "unique_called_numbers": 35, "blocked_calls_by_carrier": [ { "country": "US", "carriers": [ { "carrier": "att", "total_calls": 1000, "blocked_calls": 3, "blocked_calls_percentage": 0.3 }, { "carrier": "tmobile", "total_calls": 1000, "blocked_calls": 0, "blocked_calls_percentage": 0.0 }, { "carrier": "verizon", "total_calls": 1000, "blocked_calls": 4, "blocked_calls_percentage": 0.4 } ] } ], "short_duration_calls_percentage": 22.15, "long_duration_calls_percentage": 18.09, "potential_robocalls_percentage": 0.11, "branded_calling": { "total_branded_calls": 500, "percent_branded_calls": 25.0, "answer_rate": 81.0, "human_answer_rate": 75.0, "engagement_rate": 60.0, "by_use_case": [ { "use_case": "Marketing", "enabled_phonenumbers": 50, "total_calls": 200, "answer_rate": 85.0, "human_answer_rate": 80.0, "engagement_rate": 70.0 }, { "use_case": "Customer Support", "enabled_phonenumbers": 30, "total_calls": 150, "answer_rate": 78.0, "human_answer_rate": 72.0, "engagement_rate": 65.0 } ] }, "voice_integrity": { "enabled_calls": 1000, "enabled_percentage": 1.47, "calls_per_bundle": [ { "bundle_sid": "BUxxxxxxxxxxxxxxxxxxxx", "enabled_phonenumbers": 3, "total_calls": 100, "answer_rate": 85.0, "human_answer_rate": 80.0 }, { "bundle_sid": "BUyyyyyyyyyyyyyyyyyyyy", "enabled_phonenumbers": 2, "total_calls": 150, "answer_rate": 78.0, "human_answer_rate": 72.0 } ] }, "stir_shaken": { "call_count": { "stsh_a": 2, "stsh_b": 1, "stsh_c": 1 }, "percentage": { "stsh_a": 50.0, "stsh_b": 25.0, "stsh_c": 25.0 }, "answer_rate": { "stsh_a": 50.0, "stsh_b": 0.0, "stsh_c": 100.0 } } } }, "answering_machine_detection": { "total_calls": 40841, "answered_by_human_percentage": 57.07, "answered_by_machine_percentage": 28.01 } }, "url": "https://insights.twilio.com/v2/Voice/Reports/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchAccountReport", "summary": "Fetch Voice Insights Account Level Report" } }, "/v2/Voice/Reports/PhoneNumbers/Inbound": { "servers": [ { "url": "https://insights.twilio.com" } ], "description": "Inbound Report resource for Voice Insights Phone Numbers Level", "x-twilio": { "defaultOutputProperties": [ "account_sid", "report_id", "status" ], "pathType": "instance" }, "post": { "description": "Create Inbound specific Phone Numbers Report for a specific account with given time range.", "tags": [ "InsightsV1CreateInboundPhoneNumbersReport" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insights.v2.create_phone_numbers_report_request" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insights.v2.create_report_response" }, "examples": { "post": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "report_id": "voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av", "status": "created", "request_meta": { "start_time": "2024-11-01T00:00:00Z", "end_time": "2024-11-07T00:00:00Z", "filters": [] }, "url": "https://insights.twilio.com/v2/Voice/Reports/PhoneNumbers/Inbound/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateInboundPhoneNumbersReport", "summary": "Create Inbound Phone Numbers Level Report" } }, "/v2/Voice/Reports/PhoneNumbers/Inbound/{reportId}": { "servers": [ { "url": "https://insights.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "handle", "total_calls" ], "pathType": "list" }, "get": { "description": "Get Inbound Phone Numbers Level Reports for the given Report Id.", "tags": [ "InsightsV1GetInboundPhoneNumbersReport" ], "parameters": [ { "name": "reportId", "in": "path", "description": "A unique Report Id.", "schema": { "type": "string" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "reports": { "type": "array", "items": { "$ref": "#/components/schemas/insights.v2.inbound_phone_number_report" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListInboundPhoneNumbersReports" }, "examples": { "readEmpty": { "value": { "meta": { "page": 0, "page_size": 50, "first_page_url": "https://insights.twilio.com/v2/Voice/Reports/PhoneNumbers/Inbound/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av?PageSize=50&Page=0", "previous_page_url": null, "url": "https://insights.twilio.com/v2/Voice/Reports/PhoneNumbers/Inbound/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av?PageSize=50&Page=0", "next_page_url": null, "key": "reports" }, "reports": [] } }, "readPartial": { "value": { "meta": { "page": 0, "page_size": 1, "first_page_url": "https://insights.twilio.com/v2/Voice/Reports/PhoneNumbers/Inbound/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av?PageSize=1&Page=0", "previous_page_url": null, "url": "https://insights.twilio.com/v2/Voice/Reports/PhoneNumbers/Inbound/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av?PageSize=1&Page=0", "next_page_url": "https://insights.twilio.com/v2/Voice/Reports/PhoneNumbers/Inbound/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av?PageSize=1&PageToken=PTeyJwYWdlT2Zmc2V0IjoxfQ==&Page=1", "key": "reports" }, "reports": [ { "handle": "+11111111111", "total_calls": 1234, "call_answer_score": 83.4, "call_state_percentage": { "completed": 81.4, "fail": 1.46, "busy": 6.54, "noanswer": 1.6, "canceled": 9.0 }, "silent_calls_percentage": 18.83 } ] } }, "readFull": { "value": { "meta": { "page": 0, "page_size": 50, "first_page_url": "https://insights.twilio.com/v2/Voice/Reports/PhoneNumbers/Inbound/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av?PageSize=50&Page=0", "previous_page_url": null, "url": "https://insights.twilio.com/v2/Voice/Reports/PhoneNumbers/Inbound/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av?PageSize=50&Page=0", "next_page_url": null, "key": "reports" }, "reports": [ { "handle": "+10123456789", "total_calls": 1234, "call_answer_score": 83.4, "call_state_percentage": { "completed": 81.4, "fail": 1.46, "busy": 6.54, "noanswer": 1.6, "canceled": 9.0 }, "silent_calls_percentage": 18.83 } ] } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListInboundPhoneNumbersReport", "summary": "List Inbound Phone Numbers Level Reports" } }, "/v2/Voice/Reports/PhoneNumbers/Outbound": { "servers": [ { "url": "https://insights.twilio.com" } ], "description": "Outbound Report resource for Voice Insights Phone Numbers Level", "x-twilio": { "defaultOutputProperties": [ "account_sid", "report_id", "status" ], "pathType": "instance" }, "post": { "description": "Create Outbound specific Phone Numbers Report for a specific account with given time range.", "tags": [ "InsightsV1CreateOutboundPhoneNumbersReport" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insights.v2.create_phone_numbers_report_request" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insights.v2.create_report_response" }, "examples": { "post": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "report_id": "voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av", "status": "created", "request_meta": { "start_time": "2024-11-01T00:00:00Z", "end_time": "2024-11-07T00:00:00Z", "filters": [] }, "url": "https://insights.twilio.com/v2/Voice/Reports/PhoneNumbers/Outbound/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateOutboundPhoneNumbersReport", "summary": "Create Outbound Phone Numbers Level Report" } }, "/v2/Voice/Reports/PhoneNumbers/Outbound/{reportId}": { "servers": [ { "url": "https://insights.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "handle", "total_calls" ], "pathType": "list" }, "get": { "description": "Get Outbound Phone Numbers Level Report for the given Report Id.", "tags": [ "InsightsV1GetOutboundPhoneNumbersReport" ], "parameters": [ { "name": "reportId", "in": "path", "description": "A unique Report Id.", "schema": { "type": "string" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "reports": { "type": "array", "items": { "$ref": "#/components/schemas/insights.v2.outbound_phone_number_report" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListOutboundPhoneNumbersReports" }, "examples": { "readEmpty": { "value": { "meta": { "page": 0, "page_size": 50, "first_page_url": "https://insights.twilio.com/v2/Voice/Reports/PhoneNumbers/Outbound/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av?PageSize=50&Page=0", "previous_page_url": null, "url": "https://insights.twilio.com/v2/Voice/Reports/PhoneNumbers/Outbound/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av?PageSize=50&Page=0", "next_page_url": null, "key": "reports" }, "reports": [] } }, "readPartial": { "value": { "meta": { "page": 0, "page_size": 1, "first_page_url": "https://insights.twilio.com/v2/Voice/Reports/PhoneNumbers/Outbound/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av?PageSize=1&Page=0", "previous_page_url": null, "url": "https://insights.twilio.com/v2/Voice/Reports/PhoneNumbers/Outbound/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av?PageSize=1&Page=0", "next_page_url": "https://insights.twilio.com/v2/Voice/Reports/PhoneNumbers/Outbound/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av?PageSize=1&PageToken=PTeyJwYWdlT2Zmc2V0IjoxfQ==&Page=1", "key": "reports" }, "reports": [ { "handle": "+11111111111", "total_calls": 1234, "call_answer_score": 83.4, "calls_by_device_type": { "voip": 333, "mobile": 400, "landline": 401, "unknown": 100 }, "answer_rate_device_type": { "voip": 83.4, "mobile": 83.4, "landline": 83.4, "unknown": 83.4 }, "call_state_percentage": { "completed": 81.4, "fail": 1.46, "busy": 6.54, "noanswer": 1.6, "canceled": 9.0 }, "blocked_calls_by_carrier": [ { "country": "US", "carriers": [ { "carrier": "att", "total_calls": 1000, "blocked_calls": 3, "blocked_calls_percentage": 0.3 }, { "carrier": "tmobile", "total_calls": 1000, "blocked_calls": 0, "blocked_calls_percentage": 0.0 }, { "carrier": "verizon", "total_calls": 1000, "blocked_calls": 4, "blocked_calls_percentage": 0.4 } ] } ], "silent_calls_percentage": 18.83, "short_duration_calls_percentage": 22.15, "long_duration_calls_percentage": 18.09, "potential_robocalls_percentage": 0.11, "answering_machine_detection": { "total_calls": 500, "answered_by_human_percentage": 77.07, "answered_by_machine_percentage": 18.01 } } ] } }, "readFull": { "value": { "meta": { "page": 0, "page_size": 50, "first_page_url": "https://insights.twilio.com/v2/Voice/Reports/PhoneNumbers/Outbound/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av?PageSize=50&Page=0", "previous_page_url": null, "url": "https://insights.twilio.com/v2/Voice/Reports/PhoneNumbers/Outbound/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av?PageSize=50&Page=0", "next_page_url": null, "key": "reports" }, "reports": [ { "handle": "+10123456789", "total_calls": 1234, "call_answer_score": 83.4, "calls_by_device_type": { "voip": 333, "mobile": 400, "landline": 401, "unknown": 100 }, "answer_rate_device_type": { "voip": 83.4, "mobile": 83.4, "landline": 83.4, "unknown": 83.4 }, "call_state_percentage": { "completed": 81.4, "fail": 1.46, "busy": 6.54, "noanswer": 1.6, "canceled": 9.0 }, "blocked_calls_by_carrier": [ { "country": "US", "carriers": [ { "carrier": "att", "total_calls": 1000, "blocked_calls": 3, "blocked_calls_percentage": 0.3 }, { "carrier": "tmobile", "total_calls": 1000, "blocked_calls": 0, "blocked_calls_percentage": 0.0 }, { "carrier": "verizon", "total_calls": 1000, "blocked_calls": 4, "blocked_calls_percentage": 0.4 } ] } ], "silent_calls_percentage": 18.83, "short_duration_calls_percentage": 22.15, "long_duration_calls_percentage": 18.09, "potential_robocalls_percentage": 0.11, "answering_machine_detection": { "total_calls": 500, "answered_by_human_percentage": 77.07, "answered_by_machine_percentage": 18.01 } } ] } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListOutboundPhoneNumbersReport", "summary": "List Outbound Phone Numbers Level Reports" } } } }