Parameters and field names

Telnyx V2 REST operations share common naming and value conventions. The selected endpoint’s API reference remains authoritative when its schema defines a different format, enum, range, or requirement.

Data types

Booleans

JSON Boolean values are true and false, not 1, 0, "true", or "false".

Date-times

Date-time fields commonly use UTC ISO 8601 values:

YYYY-MM-DDThh:mm:ss.fffZ

Endpoint schemas can accept additional ISO 8601 timezone and precision variants. Preserve timezone information when converting values and do not interpret an absent offset as local time unless the endpoint explicitly defines that behavior.

Times without a date

Time-only fields commonly use UTC with millisecond precision:

hh:mm:ss.fffZ

Durations

Duration field names include the unit when the endpoint uses a numeric value, for example retry_timeout_secs or retry_timeout_millis. Confirm the exact field and unit in the endpoint schema.

Time zones

Fields named timezone use an IANA Time Zone Database area name when declared by the endpoint, for example Europe/Berlin or America/Chicago.

Naming conventions

Field and enum names

JSON field names and string enum values commonly use snake_case. Preserve the spelling and case declared by the schema.

Country codes

Fields named country_code commonly use uppercase ISO 3166-1 alpha-2 values, for example DE or US.

Phone numbers

Telephone-number fields commonly use E.164 format, including the leading +, for example:

{
  "phone_number": "+18005550199",
  "country_calling_code": "1",
  "country_code": "US"
}

Some protocol-specific fields also accept SIP URIs, alphanumeric sender IDs, short codes, or other identifiers. Follow the endpoint schema rather than applying E.164 universally.

Addresses

Address objects commonly use these fields:

{
  "street_address": "311 W Superior St",
  "extended_address": "Suite 504",
  "locality": "Chicago",
  "administrative_area": "IL",
  "country_code": "US",
  "postal_code": "60654"
}

Required fields and validation vary by country and operation.

HTTP date headers

Date-time values in standard HTTP headers follow the IMF-fixdate format defined by RFC 9110, for example:

Sun, 06 Nov 1994 08:49:37 GMT

Collection query parameters

See Pagination, filtering, and sorting. Only use collection parameters declared by the selected endpoint.

​Data types

​Booleans

​Date-times

​Times without a date

​Durations

​Time zones

​Naming conventions

​Field and enum names

​Country codes

​Phone numbers

​Addresses

​HTTP date headers

​Collection query parameters