Skip to main content
POST
/
v1.0
/
workgroups
json
{
  "Name": "Workgroup 1",
  "TelegentPhone": "+1234567890",
  "Type": "IVR",
  "CallOrder": "",
  "AnnouncementText": "Press 1 for Sales, Press 2 for Support",
  "AnnouncementUrl": "",
  "InternalExtension": "",
  "CallerIdType": "",
  "CallerIdName": "",
  "RecordCalls": "",
  "TranscribeRecordings": "",
  "Hours": "",
  "OffHoursForwarding": "",
  "AnnouncementFileId": "",
  "ScheduleId": "SID-3741d220-0663-4289-85df-c203f43db5a6",
  "TimeZone": "",
  "HoldMusicId": "",
  "AiRecording": "",
  "OffHoursType": "",
  "OffHoursId": "",
  "WaitBetween": "",
  "TollFreeNumber": "",
  "CallerIdOption": "",
  "AnnounceWorkgroupCaller": "",
  "WorkgroupMessaging": "",
  "WorkgroupMessagingUser": "",
  "WorkgroupMessagingRespondingFrom": "",
  "OnHoursForwarding": "",
  "OnHoursType": "",
  "OnHoursId": ""
}
{
  "WorkgroupId": "WID-12345-abc-12345",
  "Name": "IVR Workgroup",
  "TelegentPhone": "+1234567890",
  "Type": "IVR",
  "CallOrder": "1",
  "AnnouncementText": "Hello, welcome to Telegent. Press 1 for Sales, Press 2 for Support, Press 3 for HR. Press 0 for operator.",
  "AnnouncementUrl": "",
  "InternalExtension": "",
  "CallerIdType": "",
  "CallerIdName": "",
  "AccountId": "",
  "RecordCalls": "",
  "TranscribeRecordings": "",
  "Hours": "",
  "OffHoursForwarding": "",
  "AnnouncementFileId": "",
  "ScheduleId": "",
  "TimeZone": "",
  "HoldMusicId": "",
  "AiRecording": "",
  "WaitBetween": "",
  "TollFreeNumber": "",
  "CallerIdOption": "",
  "AnnounceWorkgroupCaller": "",
  "WorkgroupMessaging": "",
  "WorkgroupMessagingUser": "",
  "WorkgroupMessagingRespondingFrom": "",
  "OnHoursForwarding": "",
  "OnHoursType": "",
  "OnHoursId": "",
  "OffHoursType": "",
  "OffHoursId": ""
}

Authorizations

​
Authorization
string
header
required

Enter the token obtained from the Authentication endpoint

Body

application/json
​
Name
string
required

Workgroup name

Example:

"Workgroup 1"

​
Type
enum<string>
required

Workgroup type

Available options:
IVR,
simultaneous,
round-robin
Example:

"IVR"

​
TelegentPhone
string

Phone number (E.164)

Example:

"+1234567890"

​
AnnouncementText
string

IVR announcement text

Example:

"Press 1 for Sales, Press 2 for Support"

​
AnnouncementUrl
string<uri>

URL to announcement audio

​
ScheduleId
string

Schedule ID for hours

Example:

"SID-3741d220-0663-4289-85df-c203f43db5a6"

​
RecordCalls
boolean

Enable call recording

​
TranscribeRecordings
boolean

Enable transcription

​
OnHoursType
string

On-hours routing type

​
OnHoursId
string

User ID or Workgroup ID for on-hours

​
OffHoursType
string

Off-hours routing type

​
OffHoursId
string

User ID or Workgroup ID for off-hours

​
CallOrder
string

Order of call distribution

​
InternalExtension
string

Internal extension number for the workgroup

​
CallerIdType
string

Type of caller ID to display

​
CallerIdName
string

Caller ID name to display

​
Hours
string

Operating hours configuration

​
OffHoursForwarding
string

Forwarding destination during off-hours

​
AnnouncementFileId
string

ID of the announcement audio file

​
TimeZone
string

Timezone for schedule (e.g., America/New_York)

​
HoldMusicId
string

ID of the hold music file

​
AiRecording
string

AI recording settings

​
WaitBetween
string

Wait time between ring attempts

​
TollFreeNumber
string

Associated toll-free number

​
CallerIdOption
string

Caller ID option setting

​
AnnounceWorkgroupCaller
string

Announce caller to workgroup agents

​
WorkgroupMessaging
string

Enable workgroup messaging

​
WorkgroupMessagingUser
string

User for workgroup messaging

​
WorkgroupMessagingRespondingFrom
string

Responding from identifier for messaging

​
OnHoursForwarding
string

Forwarding destination during on-hours

Response

200 - application/json

Create Workgroup

The response is of type object.