Tyntec SMS API

Tyntec is a cloud communications platform that provides global SMS delivery, messaging APIs, phone number provisioning, and contact management. The Nexla connector authenticates with a Tyntec API key and lets you ingest messages, contacts, and phone-number data as a source, or send SMS messages and manage contacts and provisioning as a destination.

Power end-to-end data operations for your Tyntec SMS API API with Nexla. Our bi-directional Tyntec SMS API connector is purpose-built for Tyntec SMS API, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Tyntec SMS API or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Tyntec SMS API workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Tyntec credential, you need a Tyntec account and an API key. The Tyntec API is a REST API that authenticates each request with an API key sent in the apikey HTTP header.

To obtain your credentials, follow these steps:

1. Sign in to your Tyntec account at tyntec.com.

2. Open the account or API settings area of your Tyntec dashboard, where API keys are managed.

3. Locate your API key, or create a new key if one has not been generated yet. Tyntec also supports managing keys programmatically through its Account API.

4. Copy the API key and store it securely, as you will need it to configure your Nexla credential.

The default base URL for the Tyntec SMS API is https://api.tyntec.com. For more detail on authentication and available endpoints, see the Tyntec API Reference and the Tyntec SMS API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
Base URL	Yes	No	The base URL for the Tyntec SMS API.
API Key	Yes	Yes	Your Tyntec SMS API key from the dashboard.

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter the API base URL in the Base URL field. Unless you have been directed to a different environment, use the default https://api.tyntec.com.

4. Enter your Tyntec API key in the API Key field. This key is sent in the apikey request header to authenticate every call and must be kept confidential.

   If your API key is compromised, revoke it in your Tyntec account and generate a new one. Treat the key as sensitive information.

   For detailed information about authentication and available endpoints, see the Tyntec API Reference.

5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Tyntec SMS API connector tile, then select the credential that will be used to connect to Tyntec, and click Next; or, create a new Tyntec credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Tyntec endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Messages

Retrieves a list of messages from the messaging service.

[Rest API] Send SMS (GET)

Send SMS messages using the Tyntec SMS API with the GET request method. Message details such as recipient, sender, message text, encoding, and delivery options are supplied as query parameters.

[Rest API] List all phone numbers

Retrieve all phone numbers associated with the account from the Tyntec SMS API phonebook service. Results can be filtered by request ID or contact ID and paginated with page and page-size parameters.

[Rest API] List all contacts

Retrieve all contacts from the Tyntec SMS API. Results can optionally be filtered by friendly name.

[Rest API] List all phones

Retrieve all provisioning phone numbers for the account.

[Rest API] Read SMS Status

Retrieves the delivery status and details of a previously sent SMS message by request ID.

[Rest API] Read a Phone Number

Retrieves details of a specific phone number assigned to your account.

[Rest API] Read a Contact

Retrieves detailed information about a specific contact by contact ID.

[Rest API] Read phone status

Retrieves the status and details of a phone provisioning request by ID.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Tyntec data sources can also be manually configured to ingest data from any valid Tyntec API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Tyntec data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Tyntec destination, and select the Send to Destination option from the menu. Select the Tyntec SMS API connector from the list of available destination connectors, then select the credential that will be used to connect to Tyntec, and click Next; or, create a new Tyntec credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Tyntec endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Send SMS (POST)

Sends an SMS message using a POST request with a JSON body for recipient, sender, message content, and delivery options.

[Rest API] Receive SMS

Webhook endpoint to receive incoming SMS messages and process inbound delivery notifications.

[Rest API] Create a Contact

Creates a new contact record with company and personal information.

[Rest API] Edit a Contact

Updates the information of an existing contact by contact ID.

[Rest API] Delete a contact

Deletes a contact from the account by ID.

[Rest API] Register phones

Submits a request to register and provision new phone numbers for the account.

[Rest API] Conversion report

Submits a conversion report for tracking message delivery and conversion metrics.

Manual configuration

Tyntec destinations can also be manually configured to send data to any valid Tyntec API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Tyntec APIs expect JSON format for most write operations. For update operations, include the ID of the object to be updated at the end of the URL.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Tyntec endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Tyntec endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.