Hail · JSON-LD Context

Hail So Context

JSON-LD context defining the semantic vocabulary for Hail So from Hail.

100 Classes 278 Properties 4 Namespaces
View Context View on GitHub

Namespaces

schema: https://schema.org/
xsd: http://www.w3.org/2001/XMLSchema#
dcterms: http://purl.org/dc/terms/
hail: https://hail.so/schema#

Classes

Address AgentCreate AgentListResponse AgentResponse AgentUpdate Body_upload_email_attachment CallCreate CallListResponse CallResponse ConfirmRequest ContactCreate ContactEntry ContactListResponse ContactPatch DmarcCheck DnsProviderSchema DnsRecordSchema DocumentOption DocumentSlot DomainCheckResponse EmailAttachmentResponse EmailAttachmentUploadResponse EmailCreate EmailDomainCreate EmailDomainDnsCheck EmailDomainListResponse EmailDomainPatch EmailDomainResponse EmailEventListResponse EmailEventResponse EmailListResponse EmailResponse EmailStatsBucket EmailStatsCounts EmailStatsRates EmailStatsResponse EmailSummary EventResponse EventStreamResponse EvidenceUploadResponse FieldOption FieldSpec FileUploadCreate FileUploadLinkResponse FileUploadResponse ForwardTargetListResponse ForwardTargetResponse HTTPValidationError HandoverContactIn HandoverContactOut LLMConfig MemberPhonePut NumberAcquireRequest NumberOptionsResponse NumberQuoteRequest NumberQuotesResponse NumberRegion NumberRegionsResponse ObservedDnsRecord OfferVerification OptionVerification PaperworkItem PhoneNumberListResponse PhoneNumberResponse PhoneNumberRoutingUpdate ProviderActivateRequest ProviderConfigEntry ProviderConfigListResponse ProviderConfigUpsert ProviderValidateRequest ProviderValidateResult QuoteOffer SenderIdPatch SenderIdResponse SmsApplicationAmendRequest SmsApplicationResponse SmsCreate SmsListResponse SmsPreviewRequest SmsResponse SubjectOption SuppressionListResponse SuppressionResponse TypeOptions ValidationError VerificationCheckFile VerificationCheckResponse VerificationRequirements VerificationResponse VoiceConfig WebhookDeliveryListResponse WebhookDeliveryResponse WebhookEventCatalogResponse WebhookEventDefinition WebhookEventType WebhookSubscriptionCreate WebhookSubscriptionListResponse WebhookSubscriptionPatch WebhookSubscriptionResponse WhoamiResponse

Properties

Property Type Container
customer_name string
street string
city string
region string
postal_code string
country_code string
name string
system_prompt string
first_message
recording_enabled
ai_disclosure boolean
ai_disclosure_line
voice_config reference
tools
max_duration_seconds
handover_max_duration_seconds
voice_enabled boolean
sms_enabled boolean
status string
handover_contacts list
items list
id string
organization_id string
created_at dateTime
updated_at dateTime
file string
recipient_consent boolean
consent_source
consent_obtained_at
message_type string
to string
from
llm
metadata
agent_id
next_cursor
from_e164 string
to_e164 string
direction string
end_reason
provider_call_sid
livekit_room
initial_prompt
recording_status string
recording_duration_ms
recording_s3_key
requested_at dateTime
started_at
answered_at
ended_at
failure_message
code string
phone_e164
email
kind string
role
present boolean
suggested
dns_url string
note
value string
type string
priority
key string
label string
file_required boolean
fields list
copies list
needs_address boolean
help string
options list
needs_input boolean
domain string
in_use boolean
existing_mx list
suggested_domain string
filename string
content_type string
size_bytes integer
content_id
url string
from_name
cc
bcc
reply_to
subject string
body_text
body_html
attachment_ids
local_prefix_user
local_prefix_org
dns_provider
zone
records list
dmarc reference
lookup_ok boolean
default_from
inbound_enabled
forward_to
forward_rate_per_hour
verification_status string
dns_records list
mail_from_domain
mail_from_status
provider string
verified_at
receive_ready
email_id string
payload
occurred_at dateTime
email_domain_id
from_address string
to_addresses list
cc_addresses
bcc_addresses
provider_message_id
sent_at
failed_at
message_id
in_reply_to
references_ids
spam_verdict
virus_verdict
dkim_verdict
spf_verdict
dmarc_verdict
provider_received_at
raw_url
attachments list
last_event_at
sent integer
delivered integer
delivery_delayed integer
bounced integer
bounced_hard integer
complained integer
rejected integer
opened integer
clicked integer
unique_opened integer
unique_clicked integer
bucket_start dateTime
delivery
bounce
complaint
open
click
bucket string
totals reference
rates reference
series list
source string
call_id
sms_id
call_status
pattern
required boolean
min_choices
max_choices
max_length
purpose string
upload_url string
method string
max_bytes integer
expires_at dateTime
sha256 string
address string
pending_reason
token_sent_at
stopped_at
stopped_reason
detail list
contact_id string
base_url string
api_key string
model string
quote_id string
number_type string
expected_total_cents
subject_type
verification_id
needs_paperwork boolean
types list
capabilities list
area_code
offers list
recommended_quote_id
incomplete boolean
regions list
observed
state string
subject_name
held_cents integer
e164 string
provisioning_state string
is_dedicated boolean
voice_agent_id
sms_agent_id
inbound_registered boolean
layer string
key_last4
key_set_at
params
fallback_enabled boolean
is_active boolean
providers list
message
monthly_cents integer
setup_cents integer
currency string
readiness string
regulatory_friction string
requirements list
locality
subject_types list
verifications list
verification
by_request boolean
paperwork
custom_sender_id
effective_default string
schema_version integer
body string
number_id
provider_message_sid
segment_count integer
error_code
allowed boolean
reason
how string
paperwork_known boolean
more_options integer
recipient string
channel string
for
loc list
msg string
input
ctx
slot string
upload_id
ok boolean
files list
documents list
address_required boolean
rejection_reason
submitted_at
approved_at
confirmation
step
campaign_accepted boolean
runtime_ready
cancellable boolean
identity_confirmed boolean
waiting_for_credit boolean
credit_needed_cents
tts string
vad string
turn_detection string
voice_id
language
subscription_id
event_type string
event_id string
attempt integer
response_status
response_body
next_attempt_at dateTime
succeeded_at
target_url string
event_types list
consecutive_failures integer
last_success_at
last_failure_at
secret
auth_kind string
user_id
superadmin boolean

JSON-LD Document

Raw ↑
{
  "@context": {
    "@vocab": "https://hail.so/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "hail": "https://hail.so/schema#",
    "Address": "hail:Address",
    "customer_name": {
      "@id": "hail:customer_name",
      "@type": "xsd:string"
    },
    "street": {
      "@id": "hail:street",
      "@type": "xsd:string"
    },
    "city": {
      "@id": "hail:city",
      "@type": "xsd:string"
    },
    "region": {
      "@id": "hail:region",
      "@type": "xsd:string"
    },
    "postal_code": {
      "@id": "hail:postal_code",
      "@type": "xsd:string"
    },
    "country_code": {
      "@id": "hail:country_code",
      "@type": "xsd:string"
    },
    "AgentCreate": "hail:AgentCreate",
    "name": {
      "@id": "hail:name",
      "@type": "xsd:string"
    },
    "system_prompt": {
      "@id": "hail:system_prompt",
      "@type": "xsd:string"
    },
    "first_message": {
      "@id": "hail:first_message"
    },
    "recording_enabled": {
      "@id": "hail:recording_enabled"
    },
    "ai_disclosure": {
      "@id": "hail:ai_disclosure",
      "@type": "xsd:boolean"
    },
    "ai_disclosure_line": {
      "@id": "hail:ai_disclosure_line"
    },
    "voice_config": {
      "@id": "hail:voice_config",
      "@type": "@id"
    },
    "tools": {
      "@id": "hail:tools"
    },
    "max_duration_seconds": {
      "@id": "hail:max_duration_seconds"
    },
    "handover_max_duration_seconds": {
      "@id": "hail:handover_max_duration_seconds"
    },
    "voice_enabled": {
      "@id": "hail:voice_enabled",
      "@type": "xsd:boolean"
    },
    "sms_enabled": {
      "@id": "hail:sms_enabled",
      "@type": "xsd:boolean"
    },
    "status": {
      "@id": "hail:status",
      "@type": "xsd:string"
    },
    "handover_contacts": {
      "@id": "hail:handover_contacts",
      "@container": "@list"
    },
    "AgentListResponse": "hail:AgentListResponse",
    "items": {
      "@id": "hail:items",
      "@container": "@list"
    },
    "AgentResponse": "hail:AgentResponse",
    "id": {
      "@id": "hail:id",
      "@type": "xsd:string"
    },
    "organization_id": {
      "@id": "hail:organization_id",
      "@type": "xsd:string"
    },
    "created_at": {
      "@id": "hail:created_at",
      "@type": "xsd:dateTime"
    },
    "updated_at": {
      "@id": "hail:updated_at",
      "@type": "xsd:dateTime"
    },
    "AgentUpdate": "hail:AgentUpdate",
    "Body_upload_email_attachment": "hail:Body_upload_email_attachment",
    "file": {
      "@id": "hail:file",
      "@type": "xsd:string"
    },
    "CallCreate": "hail:CallCreate",
    "recipient_consent": {
      "@id": "hail:recipient_consent",
      "@type": "xsd:boolean"
    },
    "consent_source": {
      "@id": "hail:consent_source"
    },
    "consent_obtained_at": {
      "@id": "hail:consent_obtained_at"
    },
    "message_type": {
      "@id": "hail:message_type",
      "@type": "xsd:string"
    },
    "to": {
      "@id": "hail:to",
      "@type": "xsd:string"
    },
    "from": {
      "@id": "hail:from"
    },
    "llm": {
      "@id": "hail:llm"
    },
    "metadata": {
      "@id": "hail:metadata"
    },
    "agent_id": {
      "@id": "hail:agent_id"
    },
    "CallListResponse": "hail:CallListResponse",
    "next_cursor": {
      "@id": "hail:next_cursor"
    },
    "CallResponse": "hail:CallResponse",
    "from_e164": {
      "@id": "hail:from_e164",
      "@type": "xsd:string"
    },
    "to_e164": {
      "@id": "hail:to_e164",
      "@type": "xsd:string"
    },
    "direction": {
      "@id": "hail:direction",
      "@type": "xsd:string"
    },
    "end_reason": {
      "@id": "hail:end_reason"
    },
    "provider_call_sid": {
      "@id": "hail:provider_call_sid"
    },
    "livekit_room": {
      "@id": "hail:livekit_room"
    },
    "initial_prompt": {
      "@id": "hail:initial_prompt"
    },
    "recording_status": {
      "@id": "hail:recording_status",
      "@type": "xsd:string"
    },
    "recording_duration_ms": {
      "@id": "hail:recording_duration_ms"
    },
    "recording_s3_key": {
      "@id": "hail:recording_s3_key"
    },
    "requested_at": {
      "@id": "hail:requested_at",
      "@type": "xsd:dateTime"
    },
    "started_at": {
      "@id": "hail:started_at"
    },
    "answered_at": {
      "@id": "hail:answered_at"
    },
    "ended_at": {
      "@id": "hail:ended_at"
    },
    "failure_message": {
      "@id": "hail:failure_message"
    },
    "ConfirmRequest": "hail:ConfirmRequest",
    "code": {
      "@id": "hail:code",
      "@type": "xsd:string"
    },
    "ContactCreate": "hail:ContactCreate",
    "phone_e164": {
      "@id": "hail:phone_e164"
    },
    "email": {
      "@id": "hail:email"
    },
    "ContactEntry": "hail:ContactEntry",
    "kind": {
      "@id": "hail:kind",
      "@type": "xsd:string"
    },
    "role": {
      "@id": "hail:role"
    },
    "ContactListResponse": "hail:ContactListResponse",
    "ContactPatch": "hail:ContactPatch",
    "DmarcCheck": "hail:DmarcCheck",
    "present": {
      "@id": "hail:present",
      "@type": "xsd:boolean"
    },
    "suggested": {
      "@id": "hail:suggested"
    },
    "DnsProviderSchema": "hail:DnsProviderSchema",
    "dns_url": {
      "@id": "hail:dns_url",
      "@type": "xsd:string"
    },
    "note": {
      "@id": "hail:note"
    },
    "DnsRecordSchema": "hail:DnsRecordSchema",
    "value": {
      "@id": "hail:value",
      "@type": "xsd:string"
    },
    "type": {
      "@id": "hail:type",
      "@type": "xsd:string"
    },
    "priority": {
      "@id": "hail:priority"
    },
    "DocumentOption": "hail:DocumentOption",
    "key": {
      "@id": "hail:key",
      "@type": "xsd:string"
    },
    "label": {
      "@id": "hail:label",
      "@type": "xsd:string"
    },
    "file_required": {
      "@id": "hail:file_required",
      "@type": "xsd:boolean"
    },
    "fields": {
      "@id": "hail:fields",
      "@container": "@list"
    },
    "copies": {
      "@id": "hail:copies",
      "@container": "@list"
    },
    "needs_address": {
      "@id": "hail:needs_address",
      "@type": "xsd:boolean"
    },
    "DocumentSlot": "hail:DocumentSlot",
    "help": {
      "@id": "hail:help",
      "@type": "xsd:string"
    },
    "options": {
      "@id": "hail:options",
      "@container": "@list"
    },
    "needs_input": {
      "@id": "hail:needs_input",
      "@type": "xsd:boolean"
    },
    "DomainCheckResponse": "hail:DomainCheckResponse",
    "domain": {
      "@id": "hail:domain",
      "@type": "xsd:string"
    },
    "in_use": {
      "@id": "hail:in_use",
      "@type": "xsd:boolean"
    },
    "existing_mx": {
      "@id": "hail:existing_mx",
      "@container": "@list"
    },
    "suggested_domain": {
      "@id": "hail:suggested_domain",
      "@type": "xsd:string"
    },
    "EmailAttachmentResponse": "hail:EmailAttachmentResponse",
    "filename": {
      "@id": "hail:filename",
      "@type": "xsd:string"
    },
    "content_type": {
      "@id": "hail:content_type",
      "@type": "xsd:string"
    },
    "size_bytes": {
      "@id": "hail:size_bytes",
      "@type": "xsd:integer"
    },
    "content_id": {
      "@id": "hail:content_id"
    },
    "url": {
      "@id": "hail:url",
      "@type": "xsd:string"
    },
    "EmailAttachmentUploadResponse": "hail:EmailAttachmentUploadResponse",
    "EmailCreate": "hail:EmailCreate",
    "from_name": {
      "@id": "hail:from_name"
    },
    "cc": {
      "@id": "hail:cc"
    },
    "bcc": {
      "@id": "hail:bcc"
    },
    "reply_to": {
      "@id": "hail:reply_to"
    },
    "subject": {
      "@id": "hail:subject",
      "@type": "xsd:string"
    },
    "body_text": {
      "@id": "hail:body_text"
    },
    "body_html": {
      "@id": "hail:body_html"
    },
    "attachment_ids": {
      "@id": "hail:attachment_ids"
    },
    "EmailDomainCreate": "hail:EmailDomainCreate",
    "local_prefix_user": {
      "@id": "hail:local_prefix_user"
    },
    "local_prefix_org": {
      "@id": "hail:local_prefix_org"
    },
    "EmailDomainDnsCheck": "hail:EmailDomainDnsCheck",
    "dns_provider": {
      "@id": "hail:dns_provider"
    },
    "zone": {
      "@id": "hail:zone"
    },
    "records": {
      "@id": "hail:records",
      "@container": "@list"
    },
    "dmarc": {
      "@id": "hail:dmarc",
      "@type": "@id"
    },
    "lookup_ok": {
      "@id": "hail:lookup_ok",
      "@type": "xsd:boolean"
    },
    "EmailDomainListResponse": "hail:EmailDomainListResponse",
    "default_from": {
      "@id": "hail:default_from"
    },
    "EmailDomainPatch": "hail:EmailDomainPatch",
    "inbound_enabled": {
      "@id": "hail:inbound_enabled"
    },
    "forward_to": {
      "@id": "hail:forward_to"
    },
    "forward_rate_per_hour": {
      "@id": "hail:forward_rate_per_hour"
    },
    "EmailDomainResponse": "hail:EmailDomainResponse",
    "verification_status": {
      "@id": "hail:verification_status",
      "@type": "xsd:string"
    },
    "dns_records": {
      "@id": "hail:dns_records",
      "@container": "@list"
    },
    "mail_from_domain": {
      "@id": "hail:mail_from_domain"
    },
    "mail_from_status": {
      "@id": "hail:mail_from_status"
    },
    "provider": {
      "@id": "hail:provider",
      "@type": "xsd:string"
    },
    "verified_at": {
      "@id": "hail:verified_at"
    },
    "receive_ready": {
      "@id": "hail:receive_ready"
    },
    "EmailEventListResponse": "hail:EmailEventListResponse",
    "EmailEventResponse": "hail:EmailEventResponse",
    "email_id": {
      "@id": "hail:email_id",
      "@type": "xsd:string"
    },
    "payload": {
      "@id": "hail:payload"
    },
    "occurred_at": {
      "@id": "hail:occurred_at",
      "@type": "xsd:dateTime"
    },
    "EmailListResponse": "hail:EmailListResponse",
    "EmailResponse": "hail:EmailResponse",
    "email_domain_id": {
      "@id": "hail:email_domain_id"
    },
    "from_address": {
      "@id": "hail:from_address",
      "@type": "xsd:string"
    },
    "to_addresses": {
      "@id": "hail:to_addresses",
      "@container": "@list"
    },
    "cc_addresses": {
      "@id": "hail:cc_addresses"
    },
    "bcc_addresses": {
      "@id": "hail:bcc_addresses"
    },
    "provider_message_id": {
      "@id": "hail:provider_message_id"
    },
    "sent_at": {
      "@id": "hail:sent_at"
    },
    "failed_at": {
      "@id": "hail:failed_at"
    },
    "message_id": {
      "@id": "hail:message_id"
    },
    "in_reply_to": {
      "@id": "hail:in_reply_to"
    },
    "references_ids": {
      "@id": "hail:references_ids"
    },
    "spam_verdict": {
      "@id": "hail:spam_verdict"
    },
    "virus_verdict": {
      "@id": "hail:virus_verdict"
    },
    "dkim_verdict": {
      "@id": "hail:dkim_verdict"
    },
    "spf_verdict": {
      "@id": "hail:spf_verdict"
    },
    "dmarc_verdict": {
      "@id": "hail:dmarc_verdict"
    },
    "provider_received_at": {
      "@id": "hail:provider_received_at"
    },
    "raw_url": {
      "@id": "hail:raw_url"
    },
    "attachments": {
      "@id": "hail:attachments",
      "@container": "@list"
    },
    "last_event_at": {
      "@id": "hail:last_event_at"
    },
    "EmailStatsBucket": "hail:EmailStatsBucket",
    "sent": {
      "@id": "hail:sent",
      "@type": "xsd:integer"
    },
    "delivered": {
      "@id": "hail:delivered",
      "@type": "xsd:integer"
    },
    "delivery_delayed": {
      "@id": "hail:delivery_delayed",
      "@type": "xsd:integer"
    },
    "bounced": {
      "@id": "hail:bounced",
      "@type": "xsd:integer"
    },
    "bounced_hard": {
      "@id": "hail:bounced_hard",
      "@type": "xsd:integer"
    },
    "complained": {
      "@id": "hail:complained",
      "@type": "xsd:integer"
    },
    "rejected": {
      "@id": "hail:rejected",
      "@type": "xsd:integer"
    },
    "opened": {
      "@id": "hail:opened",
      "@type": "xsd:integer"
    },
    "clicked": {
      "@id": "hail:clicked",
      "@type": "xsd:integer"
    },
    "unique_opened": {
      "@id": "hail:unique_opened",
      "@type": "xsd:integer"
    },
    "unique_clicked": {
      "@id": "hail:unique_clicked",
      "@type": "xsd:integer"
    },
    "bucket_start": {
      "@id": "hail:bucket_start",
      "@type": "xsd:dateTime"
    },
    "EmailStatsCounts": "hail:EmailStatsCounts",
    "EmailStatsRates": "hail:EmailStatsRates",
    "delivery": {
      "@id": "hail:delivery"
    },
    "bounce": {
      "@id": "hail:bounce"
    },
    "complaint": {
      "@id": "hail:complaint"
    },
    "open": {
      "@id": "hail:open"
    },
    "click": {
      "@id": "hail:click"
    },
    "EmailStatsResponse": "hail:EmailStatsResponse",
    "bucket": {
      "@id": "hail:bucket",
      "@type": "xsd:string"
    },
    "totals": {
      "@id": "hail:totals",
      "@type": "@id"
    },
    "rates": {
      "@id": "hail:rates",
      "@type": "@id"
    },
    "series": {
      "@id": "hail:series",
      "@container": "@list"
    },
    "EmailSummary": "hail:EmailSummary",
    "EventResponse": "hail:EventResponse",
    "source": {
      "@id": "hail:source",
      "@type": "xsd:string"
    },
    "call_id": {
      "@id": "hail:call_id"
    },
    "sms_id": {
      "@id": "hail:sms_id"
    },
    "EventStreamResponse": "hail:EventStreamResponse",
    "call_status": {
      "@id": "hail:call_status"
    },
    "EvidenceUploadResponse": "hail:EvidenceUploadResponse",
    "FieldOption": "hail:FieldOption",
    "FieldSpec": "hail:FieldSpec",
    "pattern": {
      "@id": "hail:pattern"
    },
    "required": {
      "@id": "hail:required",
      "@type": "xsd:boolean"
    },
    "min_choices": {
      "@id": "hail:min_choices"
    },
    "max_choices": {
      "@id": "hail:max_choices"
    },
    "max_length": {
      "@id": "hail:max_length"
    },
    "FileUploadCreate": "hail:FileUploadCreate",
    "purpose": {
      "@id": "hail:purpose",
      "@type": "xsd:string"
    },
    "FileUploadLinkResponse": "hail:FileUploadLinkResponse",
    "upload_url": {
      "@id": "hail:upload_url",
      "@type": "xsd:string"
    },
    "method": {
      "@id": "hail:method",
      "@type": "xsd:string"
    },
    "max_bytes": {
      "@id": "hail:max_bytes",
      "@type": "xsd:integer"
    },
    "expires_at": {
      "@id": "hail:expires_at",
      "@type": "xsd:dateTime"
    },
    "FileUploadResponse": "hail:FileUploadResponse",
    "sha256": {
      "@id": "hail:sha256",
      "@type": "xsd:string"
    },
    "ForwardTargetListResponse": "hail:ForwardTargetListResponse",
    "ForwardTargetResponse": "hail:ForwardTargetResponse",
    "address": {
      "@id": "hail:address",
      "@type": "xsd:string"
    },
    "pending_reason": {
      "@id": "hail:pending_reason"
    },
    "token_sent_at": {
      "@id": "hail:token_sent_at"
    },
    "stopped_at": {
      "@id": "hail:stopped_at"
    },
    "stopped_reason": {
      "@id": "hail:stopped_reason"
    },
    "HTTPValidationError": "hail:HTTPValidationError",
    "detail": {
      "@id": "hail:detail",
      "@container": "@list"
    },
    "HandoverContactIn": "hail:HandoverContactIn",
    "contact_id": {
      "@id": "hail:contact_id",
      "@type": "xsd:string"
    },
    "HandoverContactOut": "hail:HandoverContactOut",
    "LLMConfig": "hail:LLMConfig",
    "base_url": {
      "@id": "hail:base_url",
      "@type": "xsd:string"
    },
    "api_key": {
      "@id": "hail:api_key",
      "@type": "xsd:string"
    },
    "model": {
      "@id": "hail:model",
      "@type": "xsd:string"
    },
    "MemberPhonePut": "hail:MemberPhonePut",
    "NumberAcquireRequest": "hail:NumberAcquireRequest",
    "quote_id": {
      "@id": "hail:quote_id",
      "@type": "xsd:string"
    },
    "number_type": {
      "@id": "hail:number_type",
      "@type": "xsd:string"
    },
    "expected_total_cents": {
      "@id": "hail:expected_total_cents"
    },
    "subject_type": {
      "@id": "hail:subject_type"
    },
    "verification_id": {
      "@id": "hail:verification_id"
    },
    "NumberOptionsResponse": "hail:NumberOptionsResponse",
    "needs_paperwork": {
      "@id": "hail:needs_paperwork",
      "@type": "xsd:boolean"
    },
    "types": {
      "@id": "hail:types",
      "@container": "@list"
    },
    "NumberQuoteRequest": "hail:NumberQuoteRequest",
    "capabilities": {
      "@id": "hail:capabilities",
      "@container": "@list"
    },
    "area_code": {
      "@id": "hail:area_code"
    },
    "NumberQuotesResponse": "hail:NumberQuotesResponse",
    "offers": {
      "@id": "hail:offers",
      "@container": "@list"
    },
    "recommended_quote_id": {
      "@id": "hail:recommended_quote_id"
    },
    "incomplete": {
      "@id": "hail:incomplete",
      "@type": "xsd:boolean"
    },
    "NumberRegion": "hail:NumberRegion",
    "NumberRegionsResponse": "hail:NumberRegionsResponse",
    "regions": {
      "@id": "hail:regions",
      "@container": "@list"
    },
    "ObservedDnsRecord": "hail:ObservedDnsRecord",
    "observed": {
      "@id": "hail:observed"
    },
    "OfferVerification": "hail:OfferVerification",
    "state": {
      "@id": "hail:state",
      "@type": "xsd:string"
    },
    "subject_name": {
      "@id": "hail:subject_name"
    },
    "held_cents": {
      "@id": "hail:held_cents",
      "@type": "xsd:integer"
    },
    "OptionVerification": "hail:OptionVerification",
    "PaperworkItem": "hail:PaperworkItem",
    "PhoneNumberListResponse": "hail:PhoneNumberListResponse",
    "PhoneNumberResponse": "hail:PhoneNumberResponse",
    "e164": {
      "@id": "hail:e164",
      "@type": "xsd:string"
    },
    "provisioning_state": {
      "@id": "hail:provisioning_state",
      "@type": "xsd:string"
    },
    "is_dedicated": {
      "@id": "hail:is_dedicated",
      "@type": "xsd:boolean"
    },
    "voice_agent_id": {
      "@id": "hail:voice_agent_id"
    },
    "sms_agent_id": {
      "@id": "hail:sms_agent_id"
    },
    "inbound_registered": {
      "@id": "hail:inbound_registered",
      "@type": "xsd:boolean"
    },
    "PhoneNumberRoutingUpdate": "hail:PhoneNumberRoutingUpdate",
    "ProviderActivateRequest": "hail:ProviderActivateRequest",
    "ProviderConfigEntry": "hail:ProviderConfigEntry",
    "layer": {
      "@id": "hail:layer",
      "@type": "xsd:string"
    },
    "key_last4": {
      "@id": "hail:key_last4"
    },
    "key_set_at": {
      "@id": "hail:key_set_at"
    },
    "params": {
      "@id": "hail:params"
    },
    "fallback_enabled": {
      "@id": "hail:fallback_enabled",
      "@type": "xsd:boolean"
    },
    "is_active": {
      "@id": "hail:is_active",
      "@type": "xsd:boolean"
    },
    "ProviderConfigListResponse": "hail:ProviderConfigListResponse",
    "providers": {
      "@id": "hail:providers",
      "@container": "@list"
    },
    "ProviderConfigUpsert": "hail:ProviderConfigUpsert",
    "ProviderValidateRequest": "hail:ProviderValidateRequest",
    "ProviderValidateResult": "hail:ProviderValidateResult",
    "message": {
      "@id": "hail:message"
    },
    "QuoteOffer": "hail:QuoteOffer",
    "monthly_cents": {
      "@id": "hail:monthly_cents",
      "@type": "xsd:integer"
    },
    "setup_cents": {
      "@id": "hail:setup_cents",
      "@type": "xsd:integer"
    },
    "currency": {
      "@id": "hail:currency",
      "@type": "xsd:string"
    },
    "readiness": {
      "@id": "hail:readiness",
      "@type": "xsd:string"
    },
    "regulatory_friction": {
      "@id": "hail:regulatory_friction",
      "@type": "xsd:string"
    },
    "requirements": {
      "@id": "hail:requirements",
      "@container": "@list"
    },
    "locality": {
      "@id": "hail:locality"
    },
    "subject_types": {
      "@id": "hail:subject_types",
      "@container": "@list"
    },
    "verifications": {
      "@id": "hail:verifications",
      "@container": "@list"
    },
    "verification": {
      "@id": "hail:verification"
    },
    "by_request": {
      "@id": "hail:by_request",
      "@type": "xsd:boolean"
    },
    "paperwork": {
      "@id": "hail:paperwork"
    },
    "SenderIdPatch": "hail:SenderIdPatch",
    "custom_sender_id": {
      "@id": "hail:custom_sender_id"
    },
    "SenderIdResponse": "hail:SenderIdResponse",
    "effective_default": {
      "@id": "hail:effective_default",
      "@type": "xsd:string"
    },
    "SmsApplicationAmendRequest": "hail:SmsApplicationAmendRequest",
    "SmsApplicationResponse": "hail:SmsApplicationResponse",
    "schema_version": {
      "@id": "hail:schema_version",
      "@type": "xsd:integer"
    },
    "SmsCreate": "hail:SmsCreate",
    "body": {
      "@id": "hail:body",
      "@type": "xsd:string"
    },
    "SmsListResponse": "hail:SmsListResponse",
    "SmsPreviewRequest": "hail:SmsPreviewRequest",
    "number_id": {
      "@id": "hail:number_id"
    },
    "SmsResponse": "hail:SmsResponse",
    "provider_message_sid": {
      "@id": "hail:provider_message_sid"
    },
    "segment_count": {
      "@id": "hail:segment_count",
      "@type": "xsd:integer"
    },
    "error_code": {
      "@id": "hail:error_code"
    },
    "SubjectOption": "hail:SubjectOption",
    "allowed": {
      "@id": "hail:allowed",
      "@type": "xsd:boolean"
    },
    "reason": {
      "@id": "hail:reason"
    },
    "how": {
      "@id": "hail:how",
      "@type": "xsd:string"
    },
    "paperwork_known": {
      "@id": "hail:paperwork_known",
      "@type": "xsd:boolean"
    },
    "more_options": {
      "@id": "hail:more_options",
      "@type": "xsd:integer"
    },
    "SuppressionListResponse": "hail:SuppressionListResponse",
    "SuppressionResponse": "hail:SuppressionResponse",
    "recipient": {
      "@id": "hail:recipient",
      "@type": "xsd:string"
    },
    "channel": {
      "@id": "hail:channel",
      "@type": "xsd:string"
    },
    "TypeOptions": "hail:TypeOptions",
    "for": {
      "@id": "hail:for"
    },
    "ValidationError": "hail:ValidationError",
    "loc": {
      "@id": "hail:loc",
      "@container": "@list"
    },
    "msg": {
      "@id": "hail:msg",
      "@type": "xsd:string"
    },
    "input": {
      "@id": "hail:input"
    },
    "ctx": {
      "@id": "hail:ctx"
    },
    "VerificationCheckFile": "hail:VerificationCheckFile",
    "slot": {
      "@id": "hail:slot",
      "@type": "xsd:string"
    },
    "upload_id": {
      "@id": "hail:upload_id"
    },
    "VerificationCheckResponse": "hail:VerificationCheckResponse",
    "ok": {
      "@id": "hail:ok",
      "@type": "xsd:boolean"
    },
    "files": {
      "@id": "hail:files",
      "@container": "@list"
    },
    "VerificationRequirements": "hail:VerificationRequirements",
    "documents": {
      "@id": "hail:documents",
      "@container": "@list"
    },
    "address_required": {
      "@id": "hail:address_required",
      "@type": "xsd:boolean"
    },
    "VerificationResponse": "hail:VerificationResponse",
    "rejection_reason": {
      "@id": "hail:rejection_reason"
    },
    "submitted_at": {
      "@id": "hail:submitted_at"
    },
    "approved_at": {
      "@id": "hail:approved_at"
    },
    "confirmation": {
      "@id": "hail:confirmation"
    },
    "step": {
      "@id": "hail:step"
    },
    "campaign_accepted": {
      "@id": "hail:campaign_accepted",
      "@type": "xsd:boolean"
    },
    "runtime_ready": {
      "@id": "hail:runtime_ready"
    },
    "cancellable": {
      "@id": "hail:cancellable",
      "@type": "xsd:boolean"
    },
    "identity_confirmed": {
      "@id": "hail:identity_confirmed",
      "@type": "xsd:boolean"
    },
    "waiting_for_credit": {
      "@id": "hail:waiting_for_credit",
      "@type": "xsd:boolean"
    },
    "credit_needed_cents": {
      "@id": "hail:credit_needed_cents"
    },
    "VoiceConfig": "hail:VoiceConfig",
    "tts": {
      "@id": "hail:tts",
      "@type": "xsd:string"
    },
    "vad": {
      "@id": "hail:vad",
      "@type": "xsd:string"
    },
    "turn_detection": {
      "@id": "hail:turn_detection",
      "@type": "xsd:string"
    },
    "voice_id": {
      "@id": "hail:voice_id"
    },
    "language": {
      "@id": "hail:language"
    },
    "WebhookDeliveryListResponse": "hail:WebhookDeliveryListResponse",
    "WebhookDeliveryResponse": "hail:WebhookDeliveryResponse",
    "subscription_id": {
      "@id": "hail:subscription_id"
    },
    "event_type": {
      "@id": "hail:event_type",
      "@type": "xsd:string"
    },
    "event_id": {
      "@id": "hail:event_id",
      "@type": "xsd:string"
    },
    "attempt": {
      "@id": "hail:attempt",
      "@type": "xsd:integer"
    },
    "response_status": {
      "@id": "hail:response_status"
    },
    "response_body": {
      "@id": "hail:response_body"
    },
    "next_attempt_at": {
      "@id": "hail:next_attempt_at",
      "@type": "xsd:dateTime"
    },
    "succeeded_at": {
      "@id": "hail:succeeded_at"
    },
    "WebhookEventCatalogResponse": "hail:WebhookEventCatalogResponse",
    "WebhookEventDefinition": "hail:WebhookEventDefinition",
    "WebhookEventType": "hail:WebhookEventType",
    "WebhookSubscriptionCreate": "hail:WebhookSubscriptionCreate",
    "target_url": {
      "@id": "hail:target_url",
      "@type": "xsd:string"
    },
    "event_types": {
      "@id": "hail:event_types",
      "@container": "@list"
    },
    "WebhookSubscriptionListResponse": "hail:WebhookSubscriptionListResponse",
    "WebhookSubscriptionPatch": "hail:WebhookSubscriptionPatch",
    "WebhookSubscriptionResponse": "hail:WebhookSubscriptionResponse",
    "consecutive_failures": {
      "@id": "hail:consecutive_failures",
      "@type": "xsd:integer"
    },
    "last_success_at": {
      "@id": "hail:last_success_at"
    },
    "last_failure_at": {
      "@id": "hail:last_failure_at"
    },
    "secret": {
      "@id": "hail:secret"
    },
    "WhoamiResponse": "hail:WhoamiResponse",
    "auth_kind": {
      "@id": "hail:auth_kind",
      "@type": "xsd:string"
    },
    "user_id": {
      "@id": "hail:user_id"
    },
    "superadmin": {
      "@id": "hail:superadmin",
      "@type": "xsd:boolean"
    }
  },
  "@type": "schema:Dataset",
  "schema:name": "Hail API JSON-LD context",
  "schema:description": "A JSON-LD @context for the objects Hail'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-11-11) from openapi/hail-so-openapi.json.",
  "dcterms:created": "2026-11-11",
  "dcterms:source": [
    "openapi/hail-so-openapi.json"
  ]
}