v1

latestOpenAPI 3.0.02026-07-144224981.3 MB
TransportTelnyx

Creates a TransportTelnyx resource.

Creates a TransportTelnyx resource.

post/api/transport-telnyx

Request body

dataSegmentCodestring nullable

User-provided string on which to segment and filter data. Max 50 characters.

partitionstring iri-reference required

The partition that contains this resource instance. The resource cannot be moved to another partition.

telnyxApiKeystring nullable required

The API key for the Telnyx service. Stored in encrypted format.

telnyxFromstring nullable required

The from value for the Telnyx service.

telnyxMessagingProfileIdstring nullable required

The messaging profile ID (You need this in order to show a name to the recipient instead of just the phone number) for the Telnyx service.

transportNamestring nullable required

The name of the transport.

Response

TransportTelnyx resource created

createdAtstring date-time

When the resource instance was created. This date-time is in the UTC timezone.

dataSegmentCodestring nullable

User-provided string on which to segment and filter data. Max 50 characters.

idstring uuid nullable

The unique identifier of the resource instance.

partitionstring iri-reference required

The partition that contains this resource instance. The resource cannot be moved to another partition.

resourceOwnerstring nullable

The name of the person who owns this resource.

telnyxApiKeystring nullable required

The API key for the Telnyx service. Stored in encrypted format.

telnyxFromstring nullable required

The from value for the Telnyx service.

telnyxMessagingProfileIdstring nullable required

The messaging profile ID (You need this in order to show a name to the recipient instead of just the phone number) for the Telnyx service.

transportNamestring nullable required

The name of the transport.