Telnyx · JSON-LD Context
Telnyx Context
JSON-LD context defining the semantic vocabulary for Telnyx from Telnyx.
120 Classes
261 Properties
4 Namespaces
Namespaces
schema:
https://schema.org/
xsd:
http://www.w3.org/2001/XMLSchema#
dcterms:
http://purl.org/dc/terms/
telnyx:
https://telnyx.com/schema#
Classes
PaginationMeta
Error
ValidateAddressResult
Address
ValidateAddressRequest
ValidateAddressField
AcceptSuggestionsRequest
AddressSuggestionResponse
ResourceNotFoundError
AddressCreate
AdvancedOrderRequest
numbers_Errors
AdvancedOrder
numbers_Error
TestRunDetailResult
TriggerTestSuiteRunsRequest
Rule-Output
SkipTurnToolParams
InsightSettings
AssistantMCPServer
TestWebhookToolRequest
VoiceSettings
InviteTool
AssistantTestResponse
SendMessageTool
ExternalLLM
ObservabilityReq
WidgetSettings
TranscriptionSettingsConfig
TestRunResponse
CanaryDeployResponse
AssistantChatResponse
PostConversationSettings
FallbackConfig
AssistantsListData
AssistantDeletedResponse
AudioVisualizerConfig
SharedToolListResponse
HandoffTool
CreateSharedToolRequest
PaginatedAssistantTestList
ScheduledPhoneCallEventResponse
AssistantSmsChatResponse
BucketIds
AssistantIntegration
UpdateAssistantRequest
Rule-Input
UpdateAssistantTestRequest
PostConversationSettingsReq
ScheduledSmsEventResponse
inference-embedding_Assistant
UpdateSharedToolRequest
AssistantChatReq
MessagingSettings
EventStatus
SkipTurnTool
AssistantScheduledCallAttempt
ExternalLLMReq
Observability
AuthenticationMethod
CreateAssistantRequest
RetrievalTool
TelnyxConversationChannel
HangupTool
ObservabilityStatus
Meta
PaginatedScheduledEventList
ConversationChannelType
RolloutSlot
CreateScheduledEventRequest
TriggerTestRunRequest
TelephonySettings
HTTPValidationError
ValidationError
HandoffToolParams
StartSpeakingPlan
SIPReferToolParams
TranscriptionEndpointingPlan
TagsResponse
InviteToolConfig
Operator
PaginatedTestRunList
CreateAssistantTestRequest
EnabledFeatures
DTMFTool
ImportMetadata
Clause
InferenceEmbeddingTransferToolParams
ImportAssistantsRequest
Serve
FallbackConfigReq
TestWebhookToolResponse
PrivacySettings
HangupToolParams
TestWebhookToolResponseData
SIPReferTool
inference-embedding_InterruptionSettings
AssistantSmsChatReq
TranscriptionSettings
inference-embedding_WebhookTool
WebhookToolParams
TestSuitesResponse
inference-embedding_TransferTool
TestStatus
AddTagRequest
CanaryDeployRequest
SharedToolResponse
PromptSyncStatus
AudioTranscriptionResponseSegments
AudioTranscriptionResponseWord
AudioTranscriptionRequest
AudioTranscriptionResponse
AuditLog
AuditLogList
AuditLogsErrors
AuditEventChanges
audit-logs_PaginationMeta
audit-logs_Error
UpdateAuthenticationProviderRequest
AuthenticationProviderCreate
Properties
| Property | Type | Container |
|---|---|---|
| page_number | integer | |
| page_size | integer | |
| total_pages | integer | |
| total_results | integer | |
| code | string | |
| description | string | |
| meta | ||
| source | ||
| title | string | |
| errors | list | |
| record_type | string | |
| result | string | |
| suggested | reference | |
| address_book | reference | |
| administrative_area | reference | |
| borough | reference | |
| business_name | reference | |
| country_code | reference | |
| created_at | string | |
| customer_reference | reference | |
| extended_address | reference | |
| first_name | reference | |
| id | string | |
| last_name | reference | |
| locality | reference | |
| neighborhood | reference | |
| phone_number | reference | |
| postal_code | reference | |
| street_address | reference | |
| updated_at | string | |
| validate_address | reference | |
| data | ||
| area_code | string | |
| comments | string | |
| features | list | |
| phone_number_type | string | |
| quantity | integer | |
| requirement_group_id | string | |
| orders | list | |
| status | ||
| detail | string | |
| name | string | |
| destination_version_id | string | |
| match | list | |
| serve | reference | |
| insight_group_id | string | |
| allowed_tools | list | |
| arguments | ||
| dynamic_variables | ||
| api_key_ref | string | |
| background_audio | ||
| expressive_mode | boolean | |
| language_boost | string | |
| similarity_boost | decimal | |
| speed | decimal | |
| style | decimal | |
| temperature | decimal | |
| use_speaker_boost | boolean | |
| voice | string | |
| voice_speed | decimal | |
| invite | reference | |
| type | string | |
| destination | string | |
| instructions | string | |
| max_duration_seconds | integer | |
| rubric | list | |
| telnyx_conversation_channel | ||
| test_id | string | |
| test_suite | string | |
| send_message | ||
| authentication_method | reference | |
| base_url | string | |
| certificate_ref | string | |
| forward_metadata | boolean | |
| llm_api_key_ref | string | |
| model | string | |
| token_retrieval_url | string | |
| host | string | |
| prompt_label | string | |
| prompt_name | string | |
| prompt_sync | reference | |
| prompt_version | integer | |
| public_key_ref | string | |
| secret_key_ref | string | |
| agent_thinking_text | string | |
| audio_visualizer_config | reference | |
| default_state | string | |
| give_feedback_url | string | |
| logo_icon_url | string | |
| position | string | |
| report_issue_url | string | |
| speak_to_interrupt_text | string | |
| start_call_text | string | |
| theme | string | |
| view_history_url | string | |
| eager_eot_threshold | decimal | |
| end_of_turn_confidence_threshold | decimal | |
| eot_threshold | decimal | |
| eot_timeout_ms | integer | |
| keyterm | string | |
| max_turn_silence | integer | |
| min_turn_silence | integer | |
| numerals | boolean | |
| smart_format | boolean | |
| completed_at | dateTime | |
| conversation_id | string | |
| conversation_insights_id | string | |
| detail_status | list | |
| logs | string | |
| run_id | string | |
| test_suite_run_id | string | |
| triggered_by | string | |
| assistant_id | string | |
| rules | list | |
| content | string | |
| enabled | boolean | |
| external_llm | reference | |
| deleted | boolean | |
| object | string | |
| color | string | |
| preset | string | |
| handoff | reference | |
| display_name | string | |
| function | ||
| retrieval | ||
| timeout_ms | integer | |
| webhook | ||
| call_attempts | list | |
| call_duration | integer | |
| call_status | string | |
| conversation_metadata | ||
| dispatched_at | dateTime | |
| max_retries_client_errors | integer | |
| retry_attempts | integer | |
| retry_count | integer | |
| retry_interval_secs | integer | |
| scheduled_at_fixed_datetime | dateTime | |
| scheduled_event_id | string | |
| telnyx_agent_target | string | |
| telnyx_end_user_target | string | |
| bucket_ids | list | |
| max_num_results | integer | |
| allowed_list | list | |
| integration_id | string | |
| dynamic_variables_webhook_timeout_ms | integer | |
| dynamic_variables_webhook_url | string | |
| enabled_features | list | |
| fallback_config | reference | |
| greeting | string | |
| insight_settings | reference | |
| integrations | list | |
| interruption_settings | reference | |
| mcp_servers | list | |
| messaging_settings | reference | |
| observability_settings | reference | |
| post_conversation_settings | reference | |
| privacy_settings | reference | |
| tags | list | |
| telephony_settings | reference | |
| tool_ids | list | |
| tools | reference | |
| transcription | reference | |
| version_name | string | |
| voice_settings | reference | |
| widget_settings | reference | |
| text | string | |
| import_metadata | reference | |
| related_mission_ids | list | |
| version_created_at | dateTime | |
| version_id | string | |
| conversation_inactivity_minutes | integer | |
| default_messaging_profile_id | string | |
| delivery_status_webhook_url | string | |
| skip_turn | reference | |
| attempt_number | integer | |
| attempted_at | dateTime | |
| telnyx_call_control_id | string | |
| hangup | reference | |
| weight | decimal | |
| default_texml_app_id | string | |
| noise_suppression | string | |
| noise_suppression_config | ||
| recording_settings | ||
| supports_unauthenticated_web_calls | boolean | |
| time_limit_secs | integer | |
| user_idle_reply_secs | integer | |
| user_idle_timeout_secs | integer | |
| voicemail_detection | ||
| loc | list | |
| msg | string | |
| ai_assistants | list | |
| voice_mode | string | |
| transcription_endpointing_plan | reference | |
| wait_seconds | decimal | |
| custom_headers | list | |
| sip_headers | list | |
| targets | list | |
| on_no_punctuation_seconds | decimal | |
| on_number_seconds | decimal | |
| on_punctuation_seconds | decimal | |
| from | string | |
| send_dtmf | ||
| import_id | string | |
| import_provider | string | |
| attribute | string | |
| operator | reference | |
| values | list | |
| warm_message_delay_ms | integer | |
| warm_transfer_instructions | string | |
| import_ids | list | |
| provider | string | |
| rollout | list | |
| content_type | string | |
| request | ||
| response | string | |
| status_code | integer | |
| success | boolean | |
| data_retention | boolean | |
| refer | reference | |
| disable_greeting_interruption | boolean | |
| enable | boolean | |
| start_speaking_plan | reference | |
| should_create_conversation | boolean | |
| to | string | |
| language | string | |
| region | string | |
| settings | reference | |
| async | boolean | |
| body_parameters | ||
| headers | list | |
| method | string | |
| path_parameters | ||
| query_parameters | ||
| store_fields_as_variables | list | |
| url | string | |
| transfer | reference | |
| tag | string | |
| tool_definition | ||
| end | decimal | |
| start | decimal | |
| confidence | decimal | |
| speaker | integer | |
| word | string | |
| file | string | |
| file_url | string | |
| model_config | ||
| response_format | string | |
| duration | decimal | |
| segments | list | |
| words | list | |
| alternate_resource_id | string | |
| change_made_by | string | |
| change_type | string | |
| changes | list | |
| organization_id | string | |
| resource_id | string | |
| user_id | string | |
| field | string | |
| active | reference | |
| settings_url | reference | |
| short_name | reference |
JSON-LD Document
{
"@context": {
"@vocab": "https://telnyx.com/schema#",
"schema": "https://schema.org/",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"dcterms": "http://purl.org/dc/terms/",
"telnyx": "https://telnyx.com/schema#",
"PaginationMeta": "telnyx:PaginationMeta",
"page_number": {
"@id": "telnyx:page_number",
"@type": "xsd:integer"
},
"page_size": {
"@id": "telnyx:page_size",
"@type": "xsd:integer"
},
"total_pages": {
"@id": "telnyx:total_pages",
"@type": "xsd:integer"
},
"total_results": {
"@id": "telnyx:total_results",
"@type": "xsd:integer"
},
"Error": "telnyx:Error",
"code": {
"@id": "telnyx:code",
"@type": "xsd:string"
},
"description": {
"@id": "telnyx:description",
"@type": "xsd:string"
},
"meta": {
"@id": "telnyx:meta"
},
"source": {
"@id": "telnyx:source"
},
"title": {
"@id": "telnyx:title",
"@type": "xsd:string"
},
"ValidateAddressResult": "telnyx:ValidateAddressResult",
"errors": {
"@id": "telnyx:errors",
"@container": "@list"
},
"record_type": {
"@id": "telnyx:record_type",
"@type": "xsd:string"
},
"result": {
"@id": "telnyx:result",
"@type": "xsd:string"
},
"suggested": {
"@id": "telnyx:suggested",
"@type": "@id"
},
"Address": "telnyx:Address",
"address_book": {
"@id": "telnyx:address_book",
"@type": "@id"
},
"administrative_area": {
"@id": "telnyx:administrative_area",
"@type": "@id"
},
"borough": {
"@id": "telnyx:borough",
"@type": "@id"
},
"business_name": {
"@id": "telnyx:business_name",
"@type": "@id"
},
"country_code": {
"@id": "telnyx:country_code",
"@type": "@id"
},
"created_at": {
"@id": "telnyx:created_at",
"@type": "xsd:string"
},
"customer_reference": {
"@id": "telnyx:customer_reference",
"@type": "@id"
},
"extended_address": {
"@id": "telnyx:extended_address",
"@type": "@id"
},
"first_name": {
"@id": "telnyx:first_name",
"@type": "@id"
},
"id": {
"@id": "telnyx:id",
"@type": "xsd:string"
},
"last_name": {
"@id": "telnyx:last_name",
"@type": "@id"
},
"locality": {
"@id": "telnyx:locality",
"@type": "@id"
},
"neighborhood": {
"@id": "telnyx:neighborhood",
"@type": "@id"
},
"phone_number": {
"@id": "telnyx:phone_number",
"@type": "@id"
},
"postal_code": {
"@id": "telnyx:postal_code",
"@type": "@id"
},
"street_address": {
"@id": "telnyx:street_address",
"@type": "@id"
},
"updated_at": {
"@id": "telnyx:updated_at",
"@type": "xsd:string"
},
"validate_address": {
"@id": "telnyx:validate_address",
"@type": "@id"
},
"ValidateAddressRequest": "telnyx:ValidateAddressRequest",
"ValidateAddressField": "telnyx:ValidateAddressField",
"AcceptSuggestionsRequest": "telnyx:AcceptSuggestionsRequest",
"AddressSuggestionResponse": "telnyx:AddressSuggestionResponse",
"data": {
"@id": "telnyx:data"
},
"ResourceNotFoundError": "telnyx:ResourceNotFoundError",
"AddressCreate": "telnyx:AddressCreate",
"AdvancedOrderRequest": "telnyx:AdvancedOrderRequest",
"area_code": {
"@id": "telnyx:area_code",
"@type": "xsd:string"
},
"comments": {
"@id": "telnyx:comments",
"@type": "xsd:string"
},
"features": {
"@id": "telnyx:features",
"@container": "@list"
},
"phone_number_type": {
"@id": "telnyx:phone_number_type",
"@type": "xsd:string"
},
"quantity": {
"@id": "telnyx:quantity",
"@type": "xsd:integer"
},
"requirement_group_id": {
"@id": "telnyx:requirement_group_id",
"@type": "xsd:string"
},
"numbers_Errors": "telnyx:numbers_Errors",
"AdvancedOrder": "telnyx:AdvancedOrder",
"orders": {
"@id": "telnyx:orders",
"@container": "@list"
},
"status": {
"@id": "telnyx:status"
},
"numbers_Error": "telnyx:numbers_Error",
"detail": {
"@id": "telnyx:detail",
"@type": "xsd:string"
},
"TestRunDetailResult": "telnyx:TestRunDetailResult",
"name": {
"@id": "telnyx:name",
"@type": "xsd:string"
},
"TriggerTestSuiteRunsRequest": "telnyx:TriggerTestSuiteRunsRequest",
"destination_version_id": {
"@id": "telnyx:destination_version_id",
"@type": "xsd:string"
},
"Rule-Output": "telnyx:Rule-Output",
"match": {
"@id": "telnyx:match",
"@container": "@list"
},
"serve": {
"@id": "telnyx:serve",
"@type": "@id"
},
"SkipTurnToolParams": "telnyx:SkipTurnToolParams",
"InsightSettings": "telnyx:InsightSettings",
"insight_group_id": {
"@id": "telnyx:insight_group_id",
"@type": "xsd:string"
},
"AssistantMCPServer": "telnyx:AssistantMCPServer",
"allowed_tools": {
"@id": "telnyx:allowed_tools",
"@container": "@list"
},
"TestWebhookToolRequest": "telnyx:TestWebhookToolRequest",
"arguments": {
"@id": "telnyx:arguments"
},
"dynamic_variables": {
"@id": "telnyx:dynamic_variables"
},
"VoiceSettings": "telnyx:VoiceSettings",
"api_key_ref": {
"@id": "telnyx:api_key_ref",
"@type": "xsd:string"
},
"background_audio": {
"@id": "telnyx:background_audio"
},
"expressive_mode": {
"@id": "telnyx:expressive_mode",
"@type": "xsd:boolean"
},
"language_boost": {
"@id": "telnyx:language_boost",
"@type": "xsd:string"
},
"similarity_boost": {
"@id": "telnyx:similarity_boost",
"@type": "xsd:decimal"
},
"speed": {
"@id": "telnyx:speed",
"@type": "xsd:decimal"
},
"style": {
"@id": "telnyx:style",
"@type": "xsd:decimal"
},
"temperature": {
"@id": "telnyx:temperature",
"@type": "xsd:decimal"
},
"use_speaker_boost": {
"@id": "telnyx:use_speaker_boost",
"@type": "xsd:boolean"
},
"voice": {
"@id": "telnyx:voice",
"@type": "xsd:string"
},
"voice_speed": {
"@id": "telnyx:voice_speed",
"@type": "xsd:decimal"
},
"InviteTool": "telnyx:InviteTool",
"invite": {
"@id": "telnyx:invite",
"@type": "@id"
},
"type": {
"@id": "telnyx:type",
"@type": "xsd:string"
},
"AssistantTestResponse": "telnyx:AssistantTestResponse",
"destination": {
"@id": "telnyx:destination",
"@type": "xsd:string"
},
"instructions": {
"@id": "telnyx:instructions",
"@type": "xsd:string"
},
"max_duration_seconds": {
"@id": "telnyx:max_duration_seconds",
"@type": "xsd:integer"
},
"rubric": {
"@id": "telnyx:rubric",
"@container": "@list"
},
"telnyx_conversation_channel": {
"@id": "telnyx:telnyx_conversation_channel"
},
"test_id": {
"@id": "telnyx:test_id",
"@type": "xsd:string"
},
"test_suite": {
"@id": "telnyx:test_suite",
"@type": "xsd:string"
},
"SendMessageTool": "telnyx:SendMessageTool",
"send_message": {
"@id": "telnyx:send_message"
},
"ExternalLLM": "telnyx:ExternalLLM",
"authentication_method": {
"@id": "telnyx:authentication_method",
"@type": "@id"
},
"base_url": {
"@id": "telnyx:base_url",
"@type": "xsd:string"
},
"certificate_ref": {
"@id": "telnyx:certificate_ref",
"@type": "xsd:string"
},
"forward_metadata": {
"@id": "telnyx:forward_metadata",
"@type": "xsd:boolean"
},
"llm_api_key_ref": {
"@id": "telnyx:llm_api_key_ref",
"@type": "xsd:string"
},
"model": {
"@id": "telnyx:model",
"@type": "xsd:string"
},
"token_retrieval_url": {
"@id": "telnyx:token_retrieval_url",
"@type": "xsd:string"
},
"ObservabilityReq": "telnyx:ObservabilityReq",
"host": {
"@id": "telnyx:host",
"@type": "xsd:string"
},
"prompt_label": {
"@id": "telnyx:prompt_label",
"@type": "xsd:string"
},
"prompt_name": {
"@id": "telnyx:prompt_name",
"@type": "xsd:string"
},
"prompt_sync": {
"@id": "telnyx:prompt_sync",
"@type": "@id"
},
"prompt_version": {
"@id": "telnyx:prompt_version",
"@type": "xsd:integer"
},
"public_key_ref": {
"@id": "telnyx:public_key_ref",
"@type": "xsd:string"
},
"secret_key_ref": {
"@id": "telnyx:secret_key_ref",
"@type": "xsd:string"
},
"WidgetSettings": "telnyx:WidgetSettings",
"agent_thinking_text": {
"@id": "telnyx:agent_thinking_text",
"@type": "xsd:string"
},
"audio_visualizer_config": {
"@id": "telnyx:audio_visualizer_config",
"@type": "@id"
},
"default_state": {
"@id": "telnyx:default_state",
"@type": "xsd:string"
},
"give_feedback_url": {
"@id": "telnyx:give_feedback_url",
"@type": "xsd:string"
},
"logo_icon_url": {
"@id": "telnyx:logo_icon_url",
"@type": "xsd:string"
},
"position": {
"@id": "telnyx:position",
"@type": "xsd:string"
},
"report_issue_url": {
"@id": "telnyx:report_issue_url",
"@type": "xsd:string"
},
"speak_to_interrupt_text": {
"@id": "telnyx:speak_to_interrupt_text",
"@type": "xsd:string"
},
"start_call_text": {
"@id": "telnyx:start_call_text",
"@type": "xsd:string"
},
"theme": {
"@id": "telnyx:theme",
"@type": "xsd:string"
},
"view_history_url": {
"@id": "telnyx:view_history_url",
"@type": "xsd:string"
},
"TranscriptionSettingsConfig": "telnyx:TranscriptionSettingsConfig",
"eager_eot_threshold": {
"@id": "telnyx:eager_eot_threshold",
"@type": "xsd:decimal"
},
"end_of_turn_confidence_threshold": {
"@id": "telnyx:end_of_turn_confidence_threshold",
"@type": "xsd:decimal"
},
"eot_threshold": {
"@id": "telnyx:eot_threshold",
"@type": "xsd:decimal"
},
"eot_timeout_ms": {
"@id": "telnyx:eot_timeout_ms",
"@type": "xsd:integer"
},
"keyterm": {
"@id": "telnyx:keyterm",
"@type": "xsd:string"
},
"max_turn_silence": {
"@id": "telnyx:max_turn_silence",
"@type": "xsd:integer"
},
"min_turn_silence": {
"@id": "telnyx:min_turn_silence",
"@type": "xsd:integer"
},
"numerals": {
"@id": "telnyx:numerals",
"@type": "xsd:boolean"
},
"smart_format": {
"@id": "telnyx:smart_format",
"@type": "xsd:boolean"
},
"TestRunResponse": "telnyx:TestRunResponse",
"completed_at": {
"@id": "telnyx:completed_at",
"@type": "xsd:dateTime"
},
"conversation_id": {
"@id": "telnyx:conversation_id",
"@type": "xsd:string"
},
"conversation_insights_id": {
"@id": "telnyx:conversation_insights_id",
"@type": "xsd:string"
},
"detail_status": {
"@id": "telnyx:detail_status",
"@container": "@list"
},
"logs": {
"@id": "telnyx:logs",
"@type": "xsd:string"
},
"run_id": {
"@id": "telnyx:run_id",
"@type": "xsd:string"
},
"test_suite_run_id": {
"@id": "telnyx:test_suite_run_id",
"@type": "xsd:string"
},
"triggered_by": {
"@id": "telnyx:triggered_by",
"@type": "xsd:string"
},
"CanaryDeployResponse": "telnyx:CanaryDeployResponse",
"assistant_id": {
"@id": "telnyx:assistant_id",
"@type": "xsd:string"
},
"rules": {
"@id": "telnyx:rules",
"@container": "@list"
},
"AssistantChatResponse": "telnyx:AssistantChatResponse",
"content": {
"@id": "telnyx:content",
"@type": "xsd:string"
},
"PostConversationSettings": "telnyx:PostConversationSettings",
"enabled": {
"@id": "telnyx:enabled",
"@type": "xsd:boolean"
},
"FallbackConfig": "telnyx:FallbackConfig",
"external_llm": {
"@id": "telnyx:external_llm",
"@type": "@id"
},
"AssistantsListData": "telnyx:AssistantsListData",
"AssistantDeletedResponse": "telnyx:AssistantDeletedResponse",
"deleted": {
"@id": "telnyx:deleted",
"@type": "xsd:boolean"
},
"object": {
"@id": "telnyx:object",
"@type": "xsd:string"
},
"AudioVisualizerConfig": "telnyx:AudioVisualizerConfig",
"color": {
"@id": "telnyx:color",
"@type": "xsd:string"
},
"preset": {
"@id": "telnyx:preset",
"@type": "xsd:string"
},
"SharedToolListResponse": "telnyx:SharedToolListResponse",
"HandoffTool": "telnyx:HandoffTool",
"handoff": {
"@id": "telnyx:handoff",
"@type": "@id"
},
"CreateSharedToolRequest": "telnyx:CreateSharedToolRequest",
"display_name": {
"@id": "telnyx:display_name",
"@type": "xsd:string"
},
"function": {
"@id": "telnyx:function"
},
"retrieval": {
"@id": "telnyx:retrieval"
},
"timeout_ms": {
"@id": "telnyx:timeout_ms",
"@type": "xsd:integer"
},
"webhook": {
"@id": "telnyx:webhook"
},
"PaginatedAssistantTestList": "telnyx:PaginatedAssistantTestList",
"ScheduledPhoneCallEventResponse": "telnyx:ScheduledPhoneCallEventResponse",
"call_attempts": {
"@id": "telnyx:call_attempts",
"@container": "@list"
},
"call_duration": {
"@id": "telnyx:call_duration",
"@type": "xsd:integer"
},
"call_status": {
"@id": "telnyx:call_status",
"@type": "xsd:string"
},
"conversation_metadata": {
"@id": "telnyx:conversation_metadata"
},
"dispatched_at": {
"@id": "telnyx:dispatched_at",
"@type": "xsd:dateTime"
},
"max_retries_client_errors": {
"@id": "telnyx:max_retries_client_errors",
"@type": "xsd:integer"
},
"retry_attempts": {
"@id": "telnyx:retry_attempts",
"@type": "xsd:integer"
},
"retry_count": {
"@id": "telnyx:retry_count",
"@type": "xsd:integer"
},
"retry_interval_secs": {
"@id": "telnyx:retry_interval_secs",
"@type": "xsd:integer"
},
"scheduled_at_fixed_datetime": {
"@id": "telnyx:scheduled_at_fixed_datetime",
"@type": "xsd:dateTime"
},
"scheduled_event_id": {
"@id": "telnyx:scheduled_event_id",
"@type": "xsd:string"
},
"telnyx_agent_target": {
"@id": "telnyx:telnyx_agent_target",
"@type": "xsd:string"
},
"telnyx_end_user_target": {
"@id": "telnyx:telnyx_end_user_target",
"@type": "xsd:string"
},
"AssistantSmsChatResponse": "telnyx:AssistantSmsChatResponse",
"BucketIds": "telnyx:BucketIds",
"bucket_ids": {
"@id": "telnyx:bucket_ids",
"@container": "@list"
},
"max_num_results": {
"@id": "telnyx:max_num_results",
"@type": "xsd:integer"
},
"AssistantIntegration": "telnyx:AssistantIntegration",
"allowed_list": {
"@id": "telnyx:allowed_list",
"@container": "@list"
},
"integration_id": {
"@id": "telnyx:integration_id",
"@type": "xsd:string"
},
"UpdateAssistantRequest": "telnyx:UpdateAssistantRequest",
"dynamic_variables_webhook_timeout_ms": {
"@id": "telnyx:dynamic_variables_webhook_timeout_ms",
"@type": "xsd:integer"
},
"dynamic_variables_webhook_url": {
"@id": "telnyx:dynamic_variables_webhook_url",
"@type": "xsd:string"
},
"enabled_features": {
"@id": "telnyx:enabled_features",
"@container": "@list"
},
"fallback_config": {
"@id": "telnyx:fallback_config",
"@type": "@id"
},
"greeting": {
"@id": "telnyx:greeting",
"@type": "xsd:string"
},
"insight_settings": {
"@id": "telnyx:insight_settings",
"@type": "@id"
},
"integrations": {
"@id": "telnyx:integrations",
"@container": "@list"
},
"interruption_settings": {
"@id": "telnyx:interruption_settings",
"@type": "@id"
},
"mcp_servers": {
"@id": "telnyx:mcp_servers",
"@container": "@list"
},
"messaging_settings": {
"@id": "telnyx:messaging_settings",
"@type": "@id"
},
"observability_settings": {
"@id": "telnyx:observability_settings",
"@type": "@id"
},
"post_conversation_settings": {
"@id": "telnyx:post_conversation_settings",
"@type": "@id"
},
"privacy_settings": {
"@id": "telnyx:privacy_settings",
"@type": "@id"
},
"tags": {
"@id": "telnyx:tags",
"@container": "@list"
},
"telephony_settings": {
"@id": "telnyx:telephony_settings",
"@type": "@id"
},
"tool_ids": {
"@id": "telnyx:tool_ids",
"@container": "@list"
},
"tools": {
"@id": "telnyx:tools",
"@type": "@id"
},
"transcription": {
"@id": "telnyx:transcription",
"@type": "@id"
},
"version_name": {
"@id": "telnyx:version_name",
"@type": "xsd:string"
},
"voice_settings": {
"@id": "telnyx:voice_settings",
"@type": "@id"
},
"widget_settings": {
"@id": "telnyx:widget_settings",
"@type": "@id"
},
"Rule-Input": "telnyx:Rule-Input",
"UpdateAssistantTestRequest": "telnyx:UpdateAssistantTestRequest",
"PostConversationSettingsReq": "telnyx:PostConversationSettingsReq",
"ScheduledSmsEventResponse": "telnyx:ScheduledSmsEventResponse",
"text": {
"@id": "telnyx:text",
"@type": "xsd:string"
},
"inference-embedding_Assistant": "telnyx:inference-embedding_Assistant",
"import_metadata": {
"@id": "telnyx:import_metadata",
"@type": "@id"
},
"related_mission_ids": {
"@id": "telnyx:related_mission_ids",
"@container": "@list"
},
"version_created_at": {
"@id": "telnyx:version_created_at",
"@type": "xsd:dateTime"
},
"version_id": {
"@id": "telnyx:version_id",
"@type": "xsd:string"
},
"UpdateSharedToolRequest": "telnyx:UpdateSharedToolRequest",
"AssistantChatReq": "telnyx:AssistantChatReq",
"MessagingSettings": "telnyx:MessagingSettings",
"conversation_inactivity_minutes": {
"@id": "telnyx:conversation_inactivity_minutes",
"@type": "xsd:integer"
},
"default_messaging_profile_id": {
"@id": "telnyx:default_messaging_profile_id",
"@type": "xsd:string"
},
"delivery_status_webhook_url": {
"@id": "telnyx:delivery_status_webhook_url",
"@type": "xsd:string"
},
"EventStatus": "telnyx:EventStatus",
"SkipTurnTool": "telnyx:SkipTurnTool",
"skip_turn": {
"@id": "telnyx:skip_turn",
"@type": "@id"
},
"AssistantScheduledCallAttempt": "telnyx:AssistantScheduledCallAttempt",
"attempt_number": {
"@id": "telnyx:attempt_number",
"@type": "xsd:integer"
},
"attempted_at": {
"@id": "telnyx:attempted_at",
"@type": "xsd:dateTime"
},
"telnyx_call_control_id": {
"@id": "telnyx:telnyx_call_control_id",
"@type": "xsd:string"
},
"ExternalLLMReq": "telnyx:ExternalLLMReq",
"Observability": "telnyx:Observability",
"AuthenticationMethod": "telnyx:AuthenticationMethod",
"CreateAssistantRequest": "telnyx:CreateAssistantRequest",
"RetrievalTool": "telnyx:RetrievalTool",
"TelnyxConversationChannel": "telnyx:TelnyxConversationChannel",
"HangupTool": "telnyx:HangupTool",
"hangup": {
"@id": "telnyx:hangup",
"@type": "@id"
},
"ObservabilityStatus": "telnyx:ObservabilityStatus",
"Meta": "telnyx:Meta",
"PaginatedScheduledEventList": "telnyx:PaginatedScheduledEventList",
"ConversationChannelType": "telnyx:ConversationChannelType",
"RolloutSlot": "telnyx:RolloutSlot",
"weight": {
"@id": "telnyx:weight",
"@type": "xsd:decimal"
},
"CreateScheduledEventRequest": "telnyx:CreateScheduledEventRequest",
"TriggerTestRunRequest": "telnyx:TriggerTestRunRequest",
"TelephonySettings": "telnyx:TelephonySettings",
"default_texml_app_id": {
"@id": "telnyx:default_texml_app_id",
"@type": "xsd:string"
},
"noise_suppression": {
"@id": "telnyx:noise_suppression",
"@type": "xsd:string"
},
"noise_suppression_config": {
"@id": "telnyx:noise_suppression_config"
},
"recording_settings": {
"@id": "telnyx:recording_settings"
},
"supports_unauthenticated_web_calls": {
"@id": "telnyx:supports_unauthenticated_web_calls",
"@type": "xsd:boolean"
},
"time_limit_secs": {
"@id": "telnyx:time_limit_secs",
"@type": "xsd:integer"
},
"user_idle_reply_secs": {
"@id": "telnyx:user_idle_reply_secs",
"@type": "xsd:integer"
},
"user_idle_timeout_secs": {
"@id": "telnyx:user_idle_timeout_secs",
"@type": "xsd:integer"
},
"voicemail_detection": {
"@id": "telnyx:voicemail_detection"
},
"HTTPValidationError": "telnyx:HTTPValidationError",
"ValidationError": "telnyx:ValidationError",
"loc": {
"@id": "telnyx:loc",
"@container": "@list"
},
"msg": {
"@id": "telnyx:msg",
"@type": "xsd:string"
},
"HandoffToolParams": "telnyx:HandoffToolParams",
"ai_assistants": {
"@id": "telnyx:ai_assistants",
"@container": "@list"
},
"voice_mode": {
"@id": "telnyx:voice_mode",
"@type": "xsd:string"
},
"StartSpeakingPlan": "telnyx:StartSpeakingPlan",
"transcription_endpointing_plan": {
"@id": "telnyx:transcription_endpointing_plan",
"@type": "@id"
},
"wait_seconds": {
"@id": "telnyx:wait_seconds",
"@type": "xsd:decimal"
},
"SIPReferToolParams": "telnyx:SIPReferToolParams",
"custom_headers": {
"@id": "telnyx:custom_headers",
"@container": "@list"
},
"sip_headers": {
"@id": "telnyx:sip_headers",
"@container": "@list"
},
"targets": {
"@id": "telnyx:targets",
"@container": "@list"
},
"TranscriptionEndpointingPlan": "telnyx:TranscriptionEndpointingPlan",
"on_no_punctuation_seconds": {
"@id": "telnyx:on_no_punctuation_seconds",
"@type": "xsd:decimal"
},
"on_number_seconds": {
"@id": "telnyx:on_number_seconds",
"@type": "xsd:decimal"
},
"on_punctuation_seconds": {
"@id": "telnyx:on_punctuation_seconds",
"@type": "xsd:decimal"
},
"TagsResponse": "telnyx:TagsResponse",
"InviteToolConfig": "telnyx:InviteToolConfig",
"from": {
"@id": "telnyx:from",
"@type": "xsd:string"
},
"Operator": "telnyx:Operator",
"PaginatedTestRunList": "telnyx:PaginatedTestRunList",
"CreateAssistantTestRequest": "telnyx:CreateAssistantTestRequest",
"EnabledFeatures": "telnyx:EnabledFeatures",
"DTMFTool": "telnyx:DTMFTool",
"send_dtmf": {
"@id": "telnyx:send_dtmf"
},
"ImportMetadata": "telnyx:ImportMetadata",
"import_id": {
"@id": "telnyx:import_id",
"@type": "xsd:string"
},
"import_provider": {
"@id": "telnyx:import_provider",
"@type": "xsd:string"
},
"Clause": "telnyx:Clause",
"attribute": {
"@id": "telnyx:attribute",
"@type": "xsd:string"
},
"operator": {
"@id": "telnyx:operator",
"@type": "@id"
},
"values": {
"@id": "telnyx:values",
"@container": "@list"
},
"InferenceEmbeddingTransferToolParams": "telnyx:InferenceEmbeddingTransferToolParams",
"warm_message_delay_ms": {
"@id": "telnyx:warm_message_delay_ms",
"@type": "xsd:integer"
},
"warm_transfer_instructions": {
"@id": "telnyx:warm_transfer_instructions",
"@type": "xsd:string"
},
"ImportAssistantsRequest": "telnyx:ImportAssistantsRequest",
"import_ids": {
"@id": "telnyx:import_ids",
"@container": "@list"
},
"provider": {
"@id": "telnyx:provider",
"@type": "xsd:string"
},
"Serve": "telnyx:Serve",
"rollout": {
"@id": "telnyx:rollout",
"@container": "@list"
},
"FallbackConfigReq": "telnyx:FallbackConfigReq",
"TestWebhookToolResponse": "telnyx:TestWebhookToolResponse",
"content_type": {
"@id": "telnyx:content_type",
"@type": "xsd:string"
},
"request": {
"@id": "telnyx:request"
},
"response": {
"@id": "telnyx:response",
"@type": "xsd:string"
},
"status_code": {
"@id": "telnyx:status_code",
"@type": "xsd:integer"
},
"success": {
"@id": "telnyx:success",
"@type": "xsd:boolean"
},
"PrivacySettings": "telnyx:PrivacySettings",
"data_retention": {
"@id": "telnyx:data_retention",
"@type": "xsd:boolean"
},
"HangupToolParams": "telnyx:HangupToolParams",
"TestWebhookToolResponseData": "telnyx:TestWebhookToolResponseData",
"SIPReferTool": "telnyx:SIPReferTool",
"refer": {
"@id": "telnyx:refer",
"@type": "@id"
},
"inference-embedding_InterruptionSettings": "telnyx:inference-embedding_InterruptionSettings",
"disable_greeting_interruption": {
"@id": "telnyx:disable_greeting_interruption",
"@type": "xsd:boolean"
},
"enable": {
"@id": "telnyx:enable",
"@type": "xsd:boolean"
},
"start_speaking_plan": {
"@id": "telnyx:start_speaking_plan",
"@type": "@id"
},
"AssistantSmsChatReq": "telnyx:AssistantSmsChatReq",
"should_create_conversation": {
"@id": "telnyx:should_create_conversation",
"@type": "xsd:boolean"
},
"to": {
"@id": "telnyx:to",
"@type": "xsd:string"
},
"TranscriptionSettings": "telnyx:TranscriptionSettings",
"language": {
"@id": "telnyx:language",
"@type": "xsd:string"
},
"region": {
"@id": "telnyx:region",
"@type": "xsd:string"
},
"settings": {
"@id": "telnyx:settings",
"@type": "@id"
},
"inference-embedding_WebhookTool": "telnyx:inference-embedding_WebhookTool",
"WebhookToolParams": "telnyx:WebhookToolParams",
"async": {
"@id": "telnyx:async",
"@type": "xsd:boolean"
},
"body_parameters": {
"@id": "telnyx:body_parameters"
},
"headers": {
"@id": "telnyx:headers",
"@container": "@list"
},
"method": {
"@id": "telnyx:method",
"@type": "xsd:string"
},
"path_parameters": {
"@id": "telnyx:path_parameters"
},
"query_parameters": {
"@id": "telnyx:query_parameters"
},
"store_fields_as_variables": {
"@id": "telnyx:store_fields_as_variables",
"@container": "@list"
},
"url": {
"@id": "telnyx:url",
"@type": "xsd:string"
},
"TestSuitesResponse": "telnyx:TestSuitesResponse",
"inference-embedding_TransferTool": "telnyx:inference-embedding_TransferTool",
"transfer": {
"@id": "telnyx:transfer",
"@type": "@id"
},
"TestStatus": "telnyx:TestStatus",
"AddTagRequest": "telnyx:AddTagRequest",
"tag": {
"@id": "telnyx:tag",
"@type": "xsd:string"
},
"CanaryDeployRequest": "telnyx:CanaryDeployRequest",
"SharedToolResponse": "telnyx:SharedToolResponse",
"tool_definition": {
"@id": "telnyx:tool_definition"
},
"PromptSyncStatus": "telnyx:PromptSyncStatus",
"AudioTranscriptionResponseSegments": "telnyx:AudioTranscriptionResponseSegments",
"end": {
"@id": "telnyx:end",
"@type": "xsd:decimal"
},
"start": {
"@id": "telnyx:start",
"@type": "xsd:decimal"
},
"AudioTranscriptionResponseWord": "telnyx:AudioTranscriptionResponseWord",
"confidence": {
"@id": "telnyx:confidence",
"@type": "xsd:decimal"
},
"speaker": {
"@id": "telnyx:speaker",
"@type": "xsd:integer"
},
"word": {
"@id": "telnyx:word",
"@type": "xsd:string"
},
"AudioTranscriptionRequest": "telnyx:AudioTranscriptionRequest",
"file": {
"@id": "telnyx:file",
"@type": "xsd:string"
},
"file_url": {
"@id": "telnyx:file_url",
"@type": "xsd:string"
},
"model_config": {
"@id": "telnyx:model_config"
},
"response_format": {
"@id": "telnyx:response_format",
"@type": "xsd:string"
},
"AudioTranscriptionResponse": "telnyx:AudioTranscriptionResponse",
"duration": {
"@id": "telnyx:duration",
"@type": "xsd:decimal"
},
"segments": {
"@id": "telnyx:segments",
"@container": "@list"
},
"words": {
"@id": "telnyx:words",
"@container": "@list"
},
"AuditLog": "telnyx:AuditLog",
"alternate_resource_id": {
"@id": "telnyx:alternate_resource_id",
"@type": "xsd:string"
},
"change_made_by": {
"@id": "telnyx:change_made_by",
"@type": "xsd:string"
},
"change_type": {
"@id": "telnyx:change_type",
"@type": "xsd:string"
},
"changes": {
"@id": "telnyx:changes",
"@container": "@list"
},
"organization_id": {
"@id": "telnyx:organization_id",
"@type": "xsd:string"
},
"resource_id": {
"@id": "telnyx:resource_id",
"@type": "xsd:string"
},
"user_id": {
"@id": "telnyx:user_id",
"@type": "xsd:string"
},
"AuditLogList": "telnyx:AuditLogList",
"AuditLogsErrors": "telnyx:AuditLogsErrors",
"AuditEventChanges": "telnyx:AuditEventChanges",
"field": {
"@id": "telnyx:field",
"@type": "xsd:string"
},
"audit-logs_PaginationMeta": "telnyx:audit-logs_PaginationMeta",
"audit-logs_Error": "telnyx:audit-logs_Error",
"UpdateAuthenticationProviderRequest": "telnyx:UpdateAuthenticationProviderRequest",
"active": {
"@id": "telnyx:active",
"@type": "@id"
},
"settings_url": {
"@id": "telnyx:settings_url",
"@type": "@id"
},
"short_name": {
"@id": "telnyx:short_name",
"@type": "@id"
},
"AuthenticationProviderCreate": "telnyx:AuthenticationProviderCreate"
},
"@type": "schema:Dataset",
"schema:name": "Telnyx API JSON-LD context",
"schema:description": "A JSON-LD @context for the objects Telnyx's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-10-08) from openapi/telnyx-access-tokens-api-openapi.yml, openapi/telnyx-addresses-api-openapi.yml, openapi/telnyx-advanced-number-orders-api-openapi.yml.",
"dcterms:created": "2026-10-08",
"dcterms:source": [
"openapi/telnyx-access-tokens-api-openapi.yml",
"openapi/telnyx-addresses-api-openapi.yml",
"openapi/telnyx-advanced-number-orders-api-openapi.yml",
"openapi/telnyx-assistants-api-openapi.yml",
"openapi/telnyx-audio-api-openapi.yml"
]
}