Ytel API

Welcome to the Ytel API. You'll find comprehensive guides and documentation to help you start working with our API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Guides    ChangeLog

Ytel API is a RESTful API that fuels communications, engagements and interactions. Create a unified communications experience with one of the most robust Communications APIs around.

The Ytel API consists of 17 unique endpoints. Some endpoints are used for communication purposes and others for account maintenance and management. Below are all 17 endpoints and a brief description of each.

Access to the Full API Requires a verified and funded account.

If you are not already registered for a Ytel API account, sign up here.

Account

The Account endpoint allows you to retrieve information regarding your Ytel account by a specific date. The response object will contain data such as account status, balance, and account usage totals.

Usage

The Usage endpoint allows you to retrieve usage metrics regarding your Ytel account. Results include inbound/outbound voice calls and inbound/outbound SMS messages and carrier lookup requests.

Carrier

The Carrier endpoint allows you to retrieve information about a specific phone number. Determine if the number is a mobile number and which carrier the number is registered with.

SMS

The SMS endpoint allows you to send an SMS from a Ytel number to a mobile device and view previous inbound and outbound SMS history.

Call

The Call endpoints are used for making calls from a Ytel number or one of your verified phone numbers to an external phone number. Retrieve and view previous inbound and outbound calls.

Shared Short Code

The SharedShortCode endpoint provides the opportunity to use a short code in a controlled environment. A message is created, verified and converted to a template for your use. Variables can be passed to the template and populated in approved areas of the message.

Conference

The Conference endpoint allows you to create a conference for up to 20 participants. Participants can be muted, removed or have listen functionality turned off if needed.

Phone Number

The Phone Number endpoint is where numbers can be purchased and modified for use in the call and SMS endpoints.

Transcription

The Transcription endpoint allows for the transcription of audio urls and call recordings. This endpoint also allows you to view and delete past transcriptions.

Recording

The Recording endpoint allows you to view and delete past recordings.

Email

The Email endpoint allows you to send out HTML or text emails and manage spam, block, unsubscribe and bounced email lists.

Address

The Address endpoint works in conjunction with the PostCard and Letter endpoints. It allows you to create an address object used for direct mail pieces sent via traditional "snail" mail.

Sub Account

the Sub Account endpoint allows for the creation of sub-accounts under a main parent account. It allows for this creation process to be done outside fo the portal.

Short Code

The ShortCode endpoint is very similar to the SharedShortCode endpoint. This endpoint however is not shared and does not require a template. It acts and is utilized in the same way a regular long code DID is used.

Postcard

The PostCard endpoint allows you to create a postcard object that can then be sent to a mailing address via an API call. Postcards generally consist of a PDF document or image.

Letter

The Letter endpoint allows you to create a letter object that can be sent to a mailing address via an API call. Letters generally consist of a PDF document or image.

AreaMail

The AreaMail endpoint allows you to create bulk mail drops. Simply supply an object (image or PDF) and the zip code and Ytel manages the rest.