Telebroad REST API Functions and Descriptions

Telebroad's REST API requests on this support portal are grouped according to methods (Delete, Get, Post, Put). 

To help you navigate them more easily and find APIs relevant to your needs, this article provides a brief description of each API and groups APIs according to the following functions:

• Automatic Calls Distribution
  • Hunt Groups
• Calls Information 
• Calling
• Contacts
• Faxes
• Mailbox
• Messages (functions relating to all messages - fax, SMS, voicemail)
• PBX Information
• Phone Functions
  • Physical Phones Functions
• SMS/MMS 
• TeleConsole Functions 
• Telephone numbers 
• User's Information 
• Voicemail

Automatic Calls Distribution

Hunt Groups

• GET/my/huntgroups –returns a list of all hunt groups that the user is assigned to.

Calls Information

• GET/active/calls – returns details of currently active (dialed or received) calls, broken down to segments of the call as it progresses through the system (call flow).
  
  
• GET/call/flow –  returns a list of call flow segments for a call as it moves through the PBX system.
  
  
• GET/call/history – returns a list of all calls made or received for a particular telephone line.
  
  

• GET/call/recording – returns a URL path for a downloadable MP3 audio recording of a particular call flow segment.

  
  

• GET/calls/recent – returns a list of recent calls for a specific phone number.  
  
  
• GET/my/calls/ringing –returns a list of all ringing calls for a user.
  
  
• DELETE/phone/cdrs – the request deletes one or more call detail records for a user's given phone line(s). 
  
  
• GET/phone/cdrs–returns a list of call detail records for a user's given phone line(s).
  
  

Calling

• POST/call/hangup – the request ends a specific call placed using the POST/send/call request.
  
  
• POST/call/pickup – lets a user pick up a call that has been placed using the POST/send/call request.
  
  
• POST/call/redirect – redirects a call placed using the POST/send/call request to another PBX or external number. 
   
• POST/send/call –initiates a voice call using a Telebroad account.
  
  
• POST/voicemail/call– redirects a call to a user's voicemail.
  
  

Contacts

• DELETE/contact –deletes one or more of the user's contacts.
  
  
• GET/contact and GET/contacts – returns a list of personal contacts for a user.
  
  
• GET/contacts/export – returns a list of the user's private contacts as a downloadable CSV or VCF file.
  
  
• PUT/contact – the request is used to create a new personal TeleConsole contact or update an existing one.
  
  
• GET/people –  returns a list of company and personal contacts for a user.
  
  

Faxes

• GET/fax/message – returns the file attachment of a fax document as an ASCII string encoded in Base64 format.
  
  
• DELETE/fax/messages – the request will delete one or more fax documents from the user's account. 
  
  
• GET/fax/messages –returns a list of fax documents received or sent for a particular mailbox.
  
  
• POST/send/fax – the request uses a Telebroad account to send a fax document to a recipient's fax machine or fax-enabled VoIP service.
  
  

Mailbox

• GET/mailbox –returns the general settings of a particular mailbox. These settings apply to all voicemail or fax messages in the mailbox.  
• PUT/mailbox –  updates the general settings of an existing mailbox or creates a new mailbox. These settings apply to all voicemail or fax messages in the mailbox.   

Messages

• GET/allMessages (case sensitive) –returns a list of SMS, fax, and voicemail messages received or sent by a user. It essentially combines three separate GET requests into one request. 
  
  
• GET/messages/unread –returns a count of unread SMS, fax, and voicemail messages, plus a count of missed or unanswered calls received or dialled by the user.
  
  
• PUT/messages/read –marks users' messages as read and seen. It also operates on the missed/unanswered "phn" counter of the GET/messages/unread request, resetting it to zero.
  
  

PBX Information

• GET/pbx/logs –returns a detailed log of PBX call flow records for all calls dialled or received by all users.
  
  
• GET/pbx/logs/csv–returns a log of PBX call flow records as a downloadable CSV file for all calls dialled or received by all users.
  
  
• GET/phone/destinations–returns a list of destinations (users) on the company's PBX along with phone lines, extensions, and internal caller IDs.
  
  

Phone Functions

• PUT/phone/dnd – activates or deactivates the Do Not Disturb status on a TeleConsole account and any physical phone that is associated with it. When DND is activated calls go directly to voicemail.
  
  
• PUT/phone/forwarding –enables (or disables) call forwarding of a user's phone line to a specific phone number.
  
  

Physical Phones Functions

• GET/nextSpeedDial –returns the number of the next available speed Dial or BLF button.
   
  
• GET/speeddials –returns a list of programmed speed dial and BLF buttons, showing you which buttons are used to call which destinations.
  
  
• DELETE/speeddial – the request will delete a speed dial or BLF button's definitions, making the button available to be assigned for a new speed dial or BLF. 
  
  
• PUT/speeddial – creates or updates a speed dial or BLF (Busy Lamp Field) button for a physical telephone.
  
  

SMS/MMS

• DELETE/sms/conversation –deletes one or more SMS/MMS conversations from the user's account.
   
  
• GET/sms/conversation –returns details about a particular SMS/MMS conversation, displaying all the messages exchanged in the conversation.
  
  
• GET/sms/conversations – returns a list of all SMS/MMS conversations for a particular telephone line. 
   
  
• GET/sms/lines–returns a list of all SMS lines for a user. It is useful for other SMS related requests.
  
  
• POST/send/sms–sends an SMS/MMS message to a recipient with a mobile phone, another Telebroad account, or a VoIP line that supports SMS messaging.
  
  

TeleConsole Functions

• PUT/myStatus (case sensitive) – sets a user's TeleConsole availability status, specifying both the type and message of the status.
  
  

Telephone Numbers

• GET/cnam –returns the Caller ID Name for any nationwide mobile or landline number registered with the CNAM repositories.
  
  

User's Information

• GET/myProfile (case sensitive) –returns a list of entries about a user's TeleConsole's profile and PBX settings.
  
  The list is divided into several categories that include the user's main details, role information, system rights (his ability to see information or change settings), his phone lines, SMS lines, fax lines, voicemail boxes, and fax storage boxes.
  
  

Voicemail

• GET/download/mailbox/greeting –returns the audio file of a mailbox greeting as a base64 text string. There are four types of TeleConsole mailbox greetings that can be requested. You can convert this string to an audio file using any online base64 converting tool.
  
  
• DELETE/mailbox/greeting– deletes one of the four possible mailbox greetings.
  
  
• GET/voicemail –returns a list of voicemail messages for a particular mailbox.
  
  
• DELETE/voicemail/file –deletes one or more voicemail messages from the user's account.
  
  
• GET/voicemail/file –returns a particular voicemail file as an ASCII string encoded in Base64 format.