Skip to main content
POST
/
v1.0
/
workgroups
json
{
  "Name": "IVR Workgroup",
  "TelegentPhone": "+1234567890",
  "Type": "IVR",
  "CallOrder": "1",
  "AnnouncementText": "Hello, welcome to Telegent. Press 1 for Sales, Press 2 for Support.",
  "ScheduleId": "SID-3741d220-0663-4289-85df-c203f43db5a6",
  "RecordCalls": true,
  "TranscribeRecordings": false
}
{
  "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.",
  "ScheduleId": "SID-3741d220-0663-4289-85df-c203f43db5a6",
  "AccountId": ""
}

Authorizations

​
Authorization
string
header
required

Enter the token obtained from the Authentication endpoint

Body

application/json
​
Name
string
required

Friendly name for the workgroup

Example:

"IVR Workgroup"

​
Type
enum<string>
required

Workgroup routing type

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

"IVR"

​
TelegentPhone
string

Phone number assigned to this workgroup (E.164 format)

Example:

"+1234567890"

​
CallOrder
string

Call distribution order

Example:

"1"

​
AnnouncementText
string

Text-to-speech announcement played to callers

​
AnnouncementUrl
string<uri>

URL of audio file for announcement

​
InternalExtension
string

Internal extension number

​
CallerIdType
string

Caller ID type configuration

​
CallerIdName
string

Caller ID name

​
RecordCalls
boolean

Enable call recording

Example:

true

​
TranscribeRecordings
boolean

Enable transcription of recordings

Example:

false

​
ScheduleId
string

Schedule ID to associate with this workgroup

Example:

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

​
TimeZone
string

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

​
HoldMusicId
string

ID of hold music to play

​
AiRecording
boolean

Enable AI-enhanced recording

​
OffHoursType
string

Off-hours routing type (User or Workgroup)

​
OffHoursId
string

User ID or Workgroup ID for off-hours routing

​
OnHoursType
string

On-hours routing type (User or Workgroup)

​
OnHoursId
string

User ID or Workgroup ID for on-hours routing

​
WaitBetween
string

Wait time between call attempts

​
TollFreeNumber
string

Toll-free number associated with workgroup

​
AccountId
string

Account ID to associate workgroup with

Response

200 - application/json

Workgroup Created

The response is of type object.