Buzzeasy Management Service API Reference

version: v2.1.2.0 [2022-06-25 04:56:18] System DB:Initialized

HTTP Request Methods & Response Status Codes

GET
POST
PUT
DELETE
PATCH

Error Codes

Resource Types

agentskills
announcementgroups
announcements
attributes
auditlogs
billinggroups
billingplans
botchannels
bots
breaknames
callpacers
calltypedetails
campaignimport
campaignnumberrestrictions
campaignreports
campaigns
channelholidays
channelopeninghours
chatconfigs
chatopeninghours
chatreports
chatservices
companies
companygroups
custommenuannouncements
dashboard
datacollectorquestions
datacollectortemplates
datacollectorvalidationrules
dbschemainfo
divisions
emailcontacts
emailgroups
filereports
freetrial
ftpreports
inboundnumbers
keywords
menunumbermaps
menus
numberrestrictions
openinghours
originatingnumbers
permissions
qnamakerconfigurations
queuechatconnectorconfiguration
queuephonenumbers
queuetreatmentconfiguration
resources
roles
self
servicequeues
smsaccounts
smsplans
smsrates
smsthresholds
snippets
steeringmenus
surveyreports
timeslots
timeslottemplates
timezones
ttsannouncements
users
wizard
workflows
workitemcodes

HTTP Request Methods & Response Status Codes

GET - Get resource

Status Code	Status Name	Description
200	OK	Request successful - Resource retrieved
400	BadRequest	Invalid request body
401	Unauthorized	Login token expired or invalid
403	Forbidden	No permission to get resource
404	NotFound	Resource not found
500	InternalServerError	Server side error occurred - Response body contains error details
503	ServiceUnavailable	Service unavailable

POST - Create resource

Status Code	Status Name	Description
201	Created	Request successful - New resource created
400	BadRequest	Invalid request body
401	Unauthorized	Login token expired or invalid
403	Forbidden	No permission to create resource
409	Conflict	Resource to be created would be in conflict with another existing resource
500	InternalServerError	Server side error occurred - Response body contains error details
503	ServiceUnavailable	Service unavailable

PUT - Update resource

Status Code	Status Name	Description
200	OK	Request successful - Existing resource updated
400	BadRequest	Invalid request body
401	Unauthorized	Login token expired or invalid
403	Forbidden	No permission to update resource
404	NotFound	Resource not found
409	Conflict	Resource to be updated would be in conflict with another existing resource
500	InternalServerError	Server side error occurred - Response body contains error details
503	ServiceUnavailable	Service unavailable

DELETE - Delete resource

Status Code	Status Name	Description
200	OK	Request successful - Resource deleted
400	BadRequest	Invalid request body
401	Unauthorized	Login token expired or invalid
403	Forbidden	No permission to delete resource
404	NotFound	Resource not found
500	InternalServerError	Server side error occurred - Response body contains error details
503	ServiceUnavailable	Service unavailable

PATCH - Partially update resource

Status Code	Status Name	Description
200	OK	Request successful - Existing resource partially updated
400	BadRequest	Invalid request body
401	Unauthorized	Login token expired or invalid
403	Forbidden	No permission to update resource
404	NotFound	Resource not found
409	Conflict	Resource to be updated would be in conflict with another existing resource
500	InternalServerError	Server side error occurred - Response body contains error details
503	ServiceUnavailable	Service unavailable

Error Codes

Error Code	Error Name	Description
1000	Unknown
1001	UserDisabled
1002	InvalidRequest
1003	PasswordChangeDenied
1004	BadPassword
1005	InvalidValue
1006	InvalidPayload
1007	UniquenessViolated
1008	ActionFailed
1009	RelationMissing
1010	RelationBroken
1011	InvalidRelation
1012	RoleInUse
1013	NoPermission
1014	TenantChangeNotAllowed
1015	SecondaryServerActive
1016	HARemoveFailed
1017	HuntGroupTenantConflict
1018	VoiceGatewayTenantConflict
1019	RecordingGatewayTenantConflict
1020	RecordingRuleTenantConflict
1021	WorkcodeExists
1022	NotImplemented
1023	RecordingRuleDomainConflict
1024	BackendError

Resource Types

agentskills

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/agentskills	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "AgentSkillId": { "required": true, "type": "integer" }, "Name": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" } } } }
POST	api/1/agentskills	Post	[Show/Hide] { "type": "object", "properties": { "DivisionId": { "required": true, "type": "integer" }, "Company": { "required": true, "type": "integer" }, "DivisionName": { "required": true, "type": [ "string", "null" ] }, "BillingGroup": { "required": true, "type": "integer" } } }
DELETE	api/1/agentskills/{id}	Delete
PUT	api/1/agentskills/{id}	Put	[Show/Hide] { "type": "object", "properties": { "DivisionId": { "required": true, "type": "integer" }, "Company": { "required": true, "type": "integer" }, "DivisionName": { "required": true, "type": [ "string", "null" ] }, "BillingGroup": { "required": true, "type": "integer" } } }

announcementgroups

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/announcementgroups/list	List	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "GroupId": { "required": true, "type": "integer" }, "GroupName": { "required": true, "type": [ "string", "null" ] } } } }
GET	api/1/announcementgroups	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "GroupId": { "required": true, "type": "integer" }, "GroupName": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "UseTts": { "required": true, "type": "boolean" } } } }
GET	api/1/announcementgroups/types	GetTypes	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "AnnouncementTypeId": { "required": true, "type": "integer" }, "Type": { "required": true, "type": [ "string", "null" ] } } } }
POST	api/1/announcementgroups	Post	[Show/Hide] { "type": "object", "properties": { "GroupId": { "required": true, "type": "integer" }, "GroupName": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "UseTts": { "required": true, "type": "boolean" } } }
PUT	api/1/announcementgroups/{id}	Put	[Show/Hide] { "type": "object", "properties": { "GroupId": { "required": true, "type": "integer" }, "GroupName": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "UseTts": { "required": true, "type": "boolean" } } }
DELETE	api/1/announcementgroups/{id}	Delete

announcements

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/announcements/{id}	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "AnnouncementId": { "required": true, "type": "integer" }, "GroupId": { "required": true, "type": "integer" }, "AnnouncementType": { "required": true, "type": "integer" }, "FileName": { "required": true, "type": [ "string", "null" ] } } } }
GET	api/1/announcements/locale/{id}	GetLocales	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "AnnouncementId": { "required": true, "type": "integer" }, "GroupId": { "required": true, "type": "integer" }, "AnnouncementType": { "required": true, "type": "integer" }, "FileName": { "required": true, "type": [ "string", "null" ] } } } }
POST	api/1/announcements/bulk	Post	[Show/Hide] { "type": "object", "properties": { "AnnouncementId": { "required": true, "type": "integer" }, "GroupId": { "required": true, "type": "integer" }, "AnnouncementType": { "required": true, "type": "integer" }, "FileName": { "required": true, "type": [ "string", "null" ] } } }
PUT	api/1/announcements/bulk	Put	[Show/Hide] { "type": "object", "properties": { "AnnouncementId": { "required": true, "type": "integer" }, "GroupId": { "required": true, "type": "integer" }, "AnnouncementType": { "required": true, "type": "integer" }, "FileName": { "required": true, "type": [ "string", "null" ] } } }
DELETE	api/1/announcements/bulk	Delete
POST	api/1/announcements/name/{prefix}	Upload
POST	api/1/announcements/locale/{filename}	UploadLocale

attributes

HTTP Method	URL	Class Method	Description	JSON Schema
GET	api/1/attributes/{companyId}	Get		[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "AttributeId": { "required": true, "type": "integer" }, "Name": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" } } } }

auditlogs

HTTP Method	URL	Class Method	Description	JSON Schema
GET	api/1/auditlogs	Get		[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "AuditLogId": { "required": true, "type": "integer" }, "EntryDateTime": { "required": true, "type": "string" }, "CompanyName": { "required": true, "type": [ "string", "null" ] }, "ResourceName": { "required": true, "type": [ "string", "null" ] }, "Data": { "required": true, "type": [ "string", "null" ] }, "Response": { "required": true, "type": [ "string", "null" ] }, "Action": { "required": true, "type": [ "string", "null" ] }, "RemoteIp": { "required": true, "type": [ "string", "null" ] }, "UserName": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" } } } }

billinggroups

HTTP Method	URL	Class Method
POST	api/1/billinggroups	CreateBillingGroup
GET	api/1/billinggroups	GetBillingGroups
PUT	api/1/billinggroups/{id}	UpdateBillingGroup
DELETE	api/1/billinggroups/{id}	DeleteBillingGroup

billingplans

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/billingplans/list	List	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "Billingid": { "required": true, "type": "integer" }, "Planname": { "required": true, "type": [ "string", "null" ] }, "BillingStyle": { "required": true, "type": "integer" }, "FlatCost": { "required": true, "type": "number" } } } }
GET	api/1/billingplans	Get
POST	api/1/billingplans	Post
PUT	api/1/billingplans/{id}	Put
DELETE	api/1/billingplans/{id}	Delete

botchannels

HTTP Method	URL	Class Method	JSON Schema
POST	api/1/botchannels	Post	[Show/Hide] { "type": "object", "properties": { "Id": { "required": true, "type": "integer" }, "CCCConfigurationId": { "required": true, "type": "integer" }, "ChannelType": { "required": true, "type": [ "string", "null" ] }, "Configuration": { "required": true, "type": [ "string", "null" ] }, "Customisation": { "required": true, "type": [ "string", "null" ] } } }
	api/1/botchannels/{chatServiceId}	AddToChatService
GET	api/1/botchannels/directline/{chatServiceId}	GetDirectLineByChatServiceId
GET	api/1/botchannels/directline/customisation/{chatServiceId}	GetCustomisationForDirectlineByChatServiceId
POST	api/1/botchannels/directline/customisation/{chatServiceId}	UpdateCustomisation

bots

HTTP Method	URL	Class Method	JSON Schema
POST	api/1/bots	Post	[Show/Hide] { "type": "object", "properties": { "BotId": { "required": true, "type": "integer" }, "BotType": { "required": true, "type": [ "string", "null" ] }, "BotSecret": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "MessagingEndpoint": { "required": true, "type": [ "string", "null" ] }, "OutputParameters": { "required": true, "type": [ "string", "null" ] }, "CustomUrls": { "required": true, "type": "boolean" }, "CustomMessageUrl": { "required": true, "type": [ "string", "null" ] }, "CustomAssignConversationUrl": { "required": true, "type": [ "string", "null" ] } } }
PUT	api/1/bots/{id}	Put	[Show/Hide] { "type": "object", "properties": { "BotId": { "required": true, "type": "integer" }, "BotType": { "required": true, "type": [ "string", "null" ] }, "BotSecret": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "MessagingEndpoint": { "required": true, "type": [ "string", "null" ] }, "OutputParameters": { "required": true, "type": [ "string", "null" ] }, "CustomUrls": { "required": true, "type": "boolean" }, "CustomMessageUrl": { "required": true, "type": [ "string", "null" ] }, "CustomAssignConversationUrl": { "required": true, "type": [ "string", "null" ] } } }
DELETE	api/1/bots/{id}	Delete	[Show/Hide] { "type": "object", "properties": { "BotId": { "required": true, "type": "integer" }, "BotType": { "required": true, "type": [ "string", "null" ] }, "BotSecret": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "MessagingEndpoint": { "required": true, "type": [ "string", "null" ] }, "OutputParameters": { "required": true, "type": [ "string", "null" ] }, "CustomUrls": { "required": true, "type": "boolean" }, "CustomMessageUrl": { "required": true, "type": [ "string", "null" ] }, "CustomAssignConversationUrl": { "required": true, "type": [ "string", "null" ] } } }
GET	api/1/bots	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "BotId": { "required": true, "type": "integer" }, "BotType": { "required": true, "type": [ "string", "null" ] }, "BotSecret": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "MessagingEndpoint": { "required": true, "type": [ "string", "null" ] }, "OutputParameters": { "required": true, "type": [ "string", "null" ] }, "CustomUrls": { "required": true, "type": "boolean" }, "CustomMessageUrl": { "required": true, "type": [ "string", "null" ] }, "CustomAssignConversationUrl": { "required": true, "type": [ "string", "null" ] } } } }
GET	api/1/bots/params	GetParams	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "BotId": { "required": true, "type": "integer" }, "BotType": { "required": true, "type": [ "string", "null" ] }, "BotSecret": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "MessagingEndpoint": { "required": true, "type": [ "string", "null" ] }, "OutputParameters": { "required": true, "type": [ "string", "null" ] }, "CustomUrls": { "required": true, "type": "boolean" }, "CustomMessageUrl": { "required": true, "type": [ "string", "null" ] }, "CustomAssignConversationUrl": { "required": true, "type": [ "string", "null" ] } } } }

breaknames

HTTP Method	URL	Class Method	Description	JSON Schema
GET	api/1/breaknames	Get
POST	api/1/breaknames	Post

callpacers

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/callpacers	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "Callpacerid": { "required": true, "type": "integer" }, "Pacinginterval": { "required": true, "type": "integer" }, "Pacingcapacity": { "required": true, "type": "integer" }, "Companyid": { "required": true, "type": "integer" } } } }
POST	api/1/callpacers	Post	[Show/Hide] { "type": "object", "properties": { "Callpacerid": { "required": true, "type": "integer" }, "Pacinginterval": { "required": true, "type": "integer" }, "Pacingcapacity": { "required": true, "type": "integer" }, "Companyid": { "required": true, "type": "integer" } } }
PUT	api/1/callpacers/{id}	Put	[Show/Hide] { "type": "object", "properties": { "Callpacerid": { "required": true, "type": "integer" }, "Pacinginterval": { "required": true, "type": "integer" }, "Pacingcapacity": { "required": true, "type": "integer" }, "Companyid": { "required": true, "type": "integer" } } }
DELETE	api/1/callpacers/{id}	Delete	[Show/Hide] { "type": "object", "properties": { "Callpacerid": { "required": true, "type": "integer" }, "Pacinginterval": { "required": true, "type": "integer" }, "Pacingcapacity": { "required": true, "type": "integer" }, "Companyid": { "required": true, "type": "integer" } } }

calltypedetails

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/calltypedetails/sq/{sqId}	GetByServiceQueueId	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "CallTypeDetailsId": { "required": true, "type": "integer" }, "ServiceQueueId": { "required": true, "type": "integer" }, "QueuePhoneNumberId": { "required": true, "type": "integer" }, "CallPacerId": { "required": true, "type": [ "integer", "null" ] }, "CallType": { "required": true, "type": "integer" }, "RetryAttempts": { "required": true, "type": "integer" }, "RetryTimeout": { "required": true, "type": "integer" }, "RetryInterval": { "required": true, "type": "integer" }, "VmRule": { "required": true, "type": "integer" }, "VmMsg": { "required": true, "type": [ "string", "null" ] }, "AgentWhisperRule": { "required": true, "type": "boolean" }, "AgentWhisperMsg": { "required": true, "type": [ "string", "null" ] }, "AllowCustomerCLIPresentation": { "required": true, "type": "boolean" }, "EnableDtmfInQueue": { "required": true, "type": "boolean" }, "DtmfValue": { "required": true, "type": [ "string", "null" ] }, "DtmfDelayTime": { "required": true, "type": "integer" }, "EnableFailureCampaign": { "required": true, "type": "boolean" }, "FailureCampaignId": { "required": true, "type": [ "integer", "null" ] } } } }
GET	api/1/calltypedetails/{id}	GetSingle	[Show/Hide] { "type": "object", "properties": { "CallTypeDetailsId": { "required": true, "type": "integer" }, "ServiceQueueId": { "required": true, "type": "integer" }, "QueuePhoneNumberId": { "required": true, "type": "integer" }, "CallPacerId": { "required": true, "type": [ "integer", "null" ] }, "CallType": { "required": true, "type": "integer" }, "RetryAttempts": { "required": true, "type": "integer" }, "RetryTimeout": { "required": true, "type": "integer" }, "RetryInterval": { "required": true, "type": "integer" }, "VmRule": { "required": true, "type": "integer" }, "VmMsg": { "required": true, "type": [ "string", "null" ] }, "AgentWhisperRule": { "required": true, "type": "boolean" }, "AgentWhisperMsg": { "required": true, "type": [ "string", "null" ] }, "AllowCustomerCLIPresentation": { "required": true, "type": "boolean" }, "EnableDtmfInQueue": { "required": true, "type": "boolean" }, "DtmfValue": { "required": true, "type": [ "string", "null" ] }, "DtmfDelayTime": { "required": true, "type": "integer" }, "EnableFailureCampaign": { "required": true, "type": "boolean" }, "FailureCampaignId": { "required": true, "type": [ "integer", "null" ] } } }
GET	api/1/calltypedetails/list	List	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "CallTypeDetailsId": { "required": true, "type": "integer" }, "ServiceQueueId": { "required": true, "type": "integer" }, "ServiceQueueName": { "required": true, "type": [ "string", "null" ] }, "QueuePhoneNumberId": { "required": true, "type": "integer" }, "CallType": { "required": true, "type": "integer" }, "CallPacerId": { "required": true, "type": [ "integer", "null" ] } } } }
GET	api/1/calltypedetails/pacer/{pId}	ListByPacerId	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "CallTypeDetailsId": { "required": true, "type": "integer" }, "ServiceQueueId": { "required": true, "type": "integer" }, "ServiceQueueName": { "required": true, "type": [ "string", "null" ] }, "QueuePhoneNumberId": { "required": true, "type": "integer" }, "CallType": { "required": true, "type": "integer" }, "CallPacerId": { "required": true, "type": [ "integer", "null" ] } } } }
POST	api/1/calltypedetails	Create	[Show/Hide] { "type": "object", "properties": { "CallTypeDetailsId": { "required": true, "type": "integer" }, "ServiceQueueId": { "required": true, "type": "integer" }, "QueuePhoneNumberId": { "required": true, "type": "integer" }, "CallPacerId": { "required": true, "type": [ "integer", "null" ] }, "CallType": { "required": true, "type": "integer" }, "RetryAttempts": { "required": true, "type": "integer" }, "RetryTimeout": { "required": true, "type": "integer" }, "RetryInterval": { "required": true, "type": "integer" }, "VmRule": { "required": true, "type": "integer" }, "VmMsg": { "required": true, "type": [ "string", "null" ] }, "AgentWhisperRule": { "required": true, "type": "boolean" }, "AgentWhisperMsg": { "required": true, "type": [ "string", "null" ] }, "AllowCustomerCLIPresentation": { "required": true, "type": "boolean" }, "EnableDtmfInQueue": { "required": true, "type": "boolean" }, "DtmfValue": { "required": true, "type": [ "string", "null" ] }, "DtmfDelayTime": { "required": true, "type": "integer" }, "EnableFailureCampaign": { "required": true, "type": "boolean" }, "FailureCampaignId": { "required": true, "type": [ "integer", "null" ] } } }
PUT	api/1/calltypedetails/{id}	Put	[Show/Hide] { "type": "object", "properties": { "CallTypeDetailsId": { "required": true, "type": "integer" }, "ServiceQueueId": { "required": true, "type": "integer" }, "QueuePhoneNumberId": { "required": true, "type": "integer" }, "CallPacerId": { "required": true, "type": [ "integer", "null" ] }, "CallType": { "required": true, "type": "integer" }, "RetryAttempts": { "required": true, "type": "integer" }, "RetryTimeout": { "required": true, "type": "integer" }, "RetryInterval": { "required": true, "type": "integer" }, "VmRule": { "required": true, "type": "integer" }, "VmMsg": { "required": true, "type": [ "string", "null" ] }, "AgentWhisperRule": { "required": true, "type": "boolean" }, "AgentWhisperMsg": { "required": true, "type": [ "string", "null" ] }, "AllowCustomerCLIPresentation": { "required": true, "type": "boolean" }, "EnableDtmfInQueue": { "required": true, "type": "boolean" }, "DtmfValue": { "required": true, "type": [ "string", "null" ] }, "DtmfDelayTime": { "required": true, "type": "integer" }, "EnableFailureCampaign": { "required": true, "type": "boolean" }, "FailureCampaignId": { "required": true, "type": [ "integer", "null" ] } } }
POST	api/1/calltypedetails/pacer/{ctdId}	UpdatePacer	[Show/Hide] { "type": "object", "properties": { "CallTypeDetailsId": { "required": true, "type": "integer" }, "ServiceQueueId": { "required": true, "type": "integer" }, "QueuePhoneNumberId": { "required": true, "type": "integer" }, "CallPacerId": { "required": true, "type": [ "integer", "null" ] }, "CallType": { "required": true, "type": "integer" }, "RetryAttempts": { "required": true, "type": "integer" }, "RetryTimeout": { "required": true, "type": "integer" }, "RetryInterval": { "required": true, "type": "integer" }, "VmRule": { "required": true, "type": "integer" }, "VmMsg": { "required": true, "type": [ "string", "null" ] }, "AgentWhisperRule": { "required": true, "type": "boolean" }, "AgentWhisperMsg": { "required": true, "type": [ "string", "null" ] }, "AllowCustomerCLIPresentation": { "required": true, "type": "boolean" }, "EnableDtmfInQueue": { "required": true, "type": "boolean" }, "DtmfValue": { "required": true, "type": [ "string", "null" ] }, "DtmfDelayTime": { "required": true, "type": "integer" }, "EnableFailureCampaign": { "required": true, "type": "boolean" }, "FailureCampaignId": { "required": true, "type": [ "integer", "null" ] } } }

campaignimport

HTTP Method	URL	Class Method	Description	JSON Schema
POST	api/1/campaignimport/{id}	PostFile

campaignnumberrestrictions

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/campaignnumberrestrictions/{campaignid}	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "NumberRestrictionId": { "required": true, "type": "integer" }, "CampaignId": { "required": true, "type": "integer" }, "Number": { "required": true, "type": [ "string", "null" ] }, "Notes": { "required": true, "type": [ "string", "null" ] }, "IsExclude": { "required": true, "type": "boolean" } } } }
POST	api/1/campaignnumberrestrictions	Post	[Show/Hide] { "type": "object", "properties": { "NumberRestrictionId": { "required": true, "type": "integer" }, "CampaignId": { "required": true, "type": "integer" }, "Number": { "required": true, "type": [ "string", "null" ] }, "Notes": { "required": true, "type": [ "string", "null" ] }, "IsExclude": { "required": true, "type": "boolean" } } }
PUT	api/1/campaignnumberrestrictions/{id}	Put	[Show/Hide] { "type": "object", "properties": { "NumberRestrictionId": { "required": true, "type": "integer" }, "CampaignId": { "required": true, "type": "integer" }, "Number": { "required": true, "type": [ "string", "null" ] }, "Notes": { "required": true, "type": [ "string", "null" ] }, "IsExclude": { "required": true, "type": "boolean" } } }
DELETE	api/1/campaignnumberrestrictions/{id}/blacklist/{blacklist}	Delete
POST	api/1/campaignnumberrestrictions/bulkcreate	BulkCreate	[Show/Hide] { "type": "object", "properties": { "NumberRestrictionId": { "required": true, "type": "integer" }, "CampaignId": { "required": true, "type": "integer" }, "Number": { "required": true, "type": [ "string", "null" ] }, "Notes": { "required": true, "type": [ "string", "null" ] }, "IsExclude": { "required": true, "type": "boolean" } } }
DELETE	api/1/campaignnumberrestrictions/bulk/blacklist	BulkDeleteBlacklist
DELETE	api/1/campaignnumberrestrictions/bulk/whitelist	BulkDeleteWhitelist

campaignreports

HTTP Method	URL	Class Method	Description	JSON Schema
GET	api/1/campaignreports/itemized	GetItemised		[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "CampaignRecordId": { "required": true, "type": "integer" }, "CampaignId": { "required": true, "type": "integer" }, "UserPhoneNumber": { "required": true, "type": [ "string", "null" ] }, "FirstName": { "required": true, "type": [ "string", "null" ] }, "SecondName": { "required": true, "type": [ "string", "null" ] }, "Field1": { "required": true, "type": [ "string", "null" ] }, "Field2": { "required": true, "type": [ "string", "null" ] }, "Field3": { "required": true, "type": [ "string", "null" ] }, "Field4": { "required": true, "type": [ "string", "null" ] }, "Field5": { "required": true, "type": [ "string", "null" ] }, "Field6": { "required": true, "type": [ "string", "null" ] }, "Field7": { "required": true, "type": [ "string", "null" ] }, "Field8": { "required": true, "type": [ "string", "null" ] }, "Field9": { "required": true, "type": [ "string", "null" ] }, "Field10": { "required": true, "type": [ "string", "null" ] }, "EnteredTime": { "required": true, "type": "string" }, "SMSSent": { "required": true, "type": "string" }, "ResponseTime": { "required": true, "type": "string" }, "ExpiryDate": { "required": true, "type": "string" }, "CampaignText": { "required": true, "type": [ "string", "null" ] }, "RecordStatus": { "required": true, "type": [ "string", "null" ] }, "ReasonCode": { "required": true, "type": [ "string", "null" ] }, "Region": { "required": true, "type": [ "string", "null" ] }, "ResponseText": { "required": true, "type": [ "string", "null" ] } } } }
GET	api/1/campaignreports/summary	GetSummaryReport		[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "CampaignId": { "required": true, "type": "integer" }, "Keywords": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "Counts": { "required": true, "type": [ "array", "null" ], "items": { "type": "integer" } }, "EscalationEnabled": { "required": true, "type": "boolean" }, "EscalationCount": { "required": true, "type": "integer" }, "SMSCount": { "required": true, "type": "integer" } } } }

campaigns

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/campaigns/list/type/{id}	List	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "CampaignId": { "required": true, "type": "integer" }, "CampaignName": { "required": true, "type": [ "string", "null" ] }, "DivisionId": { "required": true, "type": "integer" } } } }
GET	api/1/campaigns	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "CampaignId": { "required": true, "type": "integer" }, "Active": { "required": true, "type": "boolean" }, "Pacing": { "required": true, "type": "boolean" }, "PacingInterval": { "required": true, "type": [ "integer", "null" ] }, "PacingQuantity": { "required": true, "type": [ "integer", "null" ] }, "CampaignText": { "required": true, "type": [ "string", "null" ] }, "OohText": { "required": true, "type": [ "string", "null" ] }, "RecordExpiry": { "required": true, "type": "integer" }, "StopEnabled": { "required": true, "type": "boolean" }, "DivisionId": { "required": true, "type": "integer" }, "CampaignName": { "required": true, "type": [ "string", "null" ] }, "DefaultRegion": { "required": true, "type": [ "string", "null" ] }, "Inbound": { "required": true, "type": "boolean" }, "AllowMultiReplies": { "required": true, "type": "boolean" }, "ReplyInterval": { "required": true, "type": [ "integer", "null" ] }, "TestMode": { "required": true, "type": "boolean" }, "Timezone": { "required": true, "type": "integer" }, "ServiceQueueId": { "required": true, "type": "integer" }, "CampaignType": { "required": true, "type": "integer" }, "CallType": { "required": true, "type": [ "integer", "null" ] }, "SurveyType": { "required": true, "type": [ "integer", "null" ] }, "OriginatingNoId": { "required": true, "type": "integer" } } } }
POST	api/1/campaigns	Post	[Show/Hide] { "type": "object", "properties": { "CampaignId": { "required": true, "type": "integer" }, "Active": { "required": true, "type": "boolean" }, "Pacing": { "required": true, "type": "boolean" }, "PacingInterval": { "required": true, "type": [ "integer", "null" ] }, "PacingQuantity": { "required": true, "type": [ "integer", "null" ] }, "CampaignText": { "required": true, "type": [ "string", "null" ] }, "OohText": { "required": true, "type": [ "string", "null" ] }, "RecordExpiry": { "required": true, "type": "integer" }, "StopEnabled": { "required": true, "type": "boolean" }, "DivisionId": { "required": true, "type": "integer" }, "CampaignName": { "required": true, "type": [ "string", "null" ] }, "DefaultRegion": { "required": true, "type": [ "string", "null" ] }, "Inbound": { "required": true, "type": "boolean" }, "AllowMultiReplies": { "required": true, "type": "boolean" }, "ReplyInterval": { "required": true, "type": [ "integer", "null" ] }, "TestMode": { "required": true, "type": "boolean" }, "Timezone": { "required": true, "type": "integer" }, "ServiceQueueId": { "required": true, "type": "integer" }, "CampaignType": { "required": true, "type": "integer" }, "CallType": { "required": true, "type": [ "integer", "null" ] }, "SurveyType": { "required": true, "type": [ "integer", "null" ] }, "OriginatingNoId": { "required": true, "type": "integer" } } }
PUT	api/1/campaigns/{id}	Put	[Show/Hide] { "type": "object", "properties": { "CampaignId": { "required": true, "type": "integer" }, "Active": { "required": true, "type": "boolean" }, "Pacing": { "required": true, "type": "boolean" }, "PacingInterval": { "required": true, "type": [ "integer", "null" ] }, "PacingQuantity": { "required": true, "type": [ "integer", "null" ] }, "CampaignText": { "required": true, "type": [ "string", "null" ] }, "OohText": { "required": true, "type": [ "string", "null" ] }, "RecordExpiry": { "required": true, "type": "integer" }, "StopEnabled": { "required": true, "type": "boolean" }, "DivisionId": { "required": true, "type": "integer" }, "CampaignName": { "required": true, "type": [ "string", "null" ] }, "DefaultRegion": { "required": true, "type": [ "string", "null" ] }, "Inbound": { "required": true, "type": "boolean" }, "AllowMultiReplies": { "required": true, "type": "boolean" }, "ReplyInterval": { "required": true, "type": [ "integer", "null" ] }, "TestMode": { "required": true, "type": "boolean" }, "Timezone": { "required": true, "type": "integer" }, "ServiceQueueId": { "required": true, "type": "integer" }, "CampaignType": { "required": true, "type": "integer" }, "CallType": { "required": true, "type": [ "integer", "null" ] }, "SurveyType": { "required": true, "type": [ "integer", "null" ] }, "OriginatingNoId": { "required": true, "type": "integer" } } }
DELETE	api/1/campaigns/{id}	Delete
GET	api/1/campaigns/type/{id}	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "CampaignId": { "required": true, "type": "integer" }, "Active": { "required": true, "type": "boolean" }, "Pacing": { "required": true, "type": "boolean" }, "PacingInterval": { "required": true, "type": [ "integer", "null" ] }, "PacingQuantity": { "required": true, "type": [ "integer", "null" ] }, "CampaignText": { "required": true, "type": [ "string", "null" ] }, "OohText": { "required": true, "type": [ "string", "null" ] }, "RecordExpiry": { "required": true, "type": "integer" }, "StopEnabled": { "required": true, "type": "boolean" }, "DivisionId": { "required": true, "type": "integer" }, "CampaignName": { "required": true, "type": [ "string", "null" ] }, "DefaultRegion": { "required": true, "type": [ "string", "null" ] }, "Inbound": { "required": true, "type": "boolean" }, "AllowMultiReplies": { "required": true, "type": "boolean" }, "ReplyInterval": { "required": true, "type": [ "integer", "null" ] }, "TestMode": { "required": true, "type": "boolean" }, "Timezone": { "required": true, "type": "integer" }, "ServiceQueueId": { "required": true, "type": "integer" }, "CampaignType": { "required": true, "type": "integer" }, "CallType": { "required": true, "type": [ "integer", "null" ] }, "SurveyType": { "required": true, "type": [ "integer", "null" ] }, "OriginatingNoId": { "required": true, "type": "integer" } } } }

channelholidays

HTTP Method	URL	Class Method
GET	api/1/channelholidays/{chatId}	GetByChatService
DELETE	api/1/channelholidays/bulk	Delete
POST	api/1/channelholidays/bulk	Post

channelopeninghours

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/channelopeninghours/{chatId}	GetByChatService
POST	api/1/channelopeninghours/bulk	PostBulk	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "ChannelOpeningHoursId": { "required": true, "type": "integer" }, "Day": { "required": true, "type": "integer" }, "OpenTime": { "required": true, "type": "string" }, "CloseTime": { "required": true, "type": "string" }, "ChatServiceId": { "required": true, "type": "integer" } } } }
PUT	api/1/channelopeninghours/bulk	UpdateBulk
DELETE	api/1/channelopeninghours/bulk	DeleteBulk

chatconfigs

HTTP Method	URL	Class Method	Description	JSON Schema
GET	api/1/chatconfigs	Get		[Show/Hide] { "type": "object", "properties": { "ChatConfigs": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "ChatService": { "required": true, "type": [ "object", "null" ], "properties": { "TimezoneName": { "required": true, "type": [ "string", "null" ] }, "ChatServiceId": { "required": true, "type": "integer" }, "DivisionId": { "required": true, "type": "integer" }, "TenantId": { "required": true, "type": [ "string", "null" ] }, "Name": { "required": true, "type": [ "string", "null" ] }, "Enabled": { "required": true, "type": "boolean" }, "WorkflowId": { "required": true, "type": "integer" }, "CCCConfigurations": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "ChannelType": { "required": true, "type": [ "string", "null" ] }, "Configuration": { "required": true, "type": [ "string", "null" ] }, "Enabled": { "required": true, "type": "boolean" } } } }, "MsAppId": { "required": true, "type": [ "string", "null" ] }, "MsAppSecret": { "required": true, "type": [ "string", "null" ] }, "FbPageSecret": { "required": true, "type": [ "string", "null" ] }, "ProvisioningState": { "required": true, "type": "integer" }, "Default": { "required": true, "type": "boolean" }, "SLATarget": { "required": true, "type": "integer" } } }, "Workflow": { "required": true, "type": [ "object", "null" ], "properties": { "WorkflowId": { "required": true, "type": "integer" }, "WorkflowName": { "required": true, "type": [ "string", "null" ] }, "EnableBotDialog": { "required": true, "type": "boolean" }, "GreetingMessage": { "required": true, "type": [ "string", "null" ] }, "GUMTenantId": { "required": true, "type": [ "string", "null" ] }, "RequiredFields": { "required": true, "type": [ "string", "null" ] }, "QuestionTemplate": { "required": true, "type": [ "integer", "null" ] }, "AgentChannelConnector": { "required": true, "type": [ "string", "null" ] }, "ACCConfigurations": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "ChannelType": { "required": true, "type": [ "string", "null" ] }, "Configuration": { "required": true, "type": [ "string", "null" ] }, "Enabled": { "required": true, "type": "boolean" } } } }, "EnableQnABotDialog": { "required": true, "type": "boolean" }, "QNAMakerConfigurationID": { "required": true, "type": [ "integer", "null" ] }, "JSONConfiguration": { "required": true, "type": [ "string", "null" ] }, "WorkflowTimeouts": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "ChannelID": { "required": true, "type": [ "string", "null" ] }, "TimeoutMinutes": { "required": true, "type": "integer" }, "Message": { "required": true, "type": [ "string", "null" ] }, "TimeoutHours": { "required": true, "type": "integer" } } } }, "CustomerWelcomeMessage": { "required": true, "type": [ "string", "null" ] }, "CustomerWelcomeSuggestedActions": { "required": true, "type": [ "string", "null" ] } } }, "DataCollectorQuestions": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "QuestionId": { "required": true, "type": "integer" }, "TemplateId": { "required": true, "type": "integer" }, "Text": { "required": true, "type": [ "string", "null" ] }, "FieldName": { "required": true, "type": [ "string", "null" ] }, "Order": { "required": true, "type": "integer" }, "UseSuggestedActions": { "required": true, "type": "boolean" }, "SuggestedActions": { "required": true, "type": [ "string", "null" ] }, "Timeout": { "required": true, "type": [ "integer", "null" ] }, "DigitCount": { "required": true, "type": [ "integer", "null" ] }, "UseForCustomerMatching": { "required": true, "type": "boolean" }, "ValidationRule": { "required": true, "type": [ "integer", "null" ] } } } }, "QNAMakerConfigurations": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "QNAMakerConfigurationID": { "required": true, "type": "integer" }, "DisplayName": { "required": true, "type": [ "string", "null" ] }, "AuthKey": { "required": true, "type": [ "string", "null" ] }, "KnowledgebaseID": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "SubscriptionKey": { "required": true, "type": [ "string", "null" ] }, "Host": { "required": true, "type": [ "string", "null" ] }, "ScoreThreshold": { "required": true, "type": "number" }, "ProvisioningState": { "required": true, "type": [ "integer", "null" ] } } } }, "OpeningHours": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "ChannelOpeningHoursId": { "required": true, "type": "integer" }, "Day": { "required": true, "type": "integer" }, "OpenTime": { "required": true, "type": "string" }, "CloseTime": { "required": true, "type": "string" }, "ChatServiceId": { "required": true, "type": "integer" } } } }, "Holidays": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "ChannelHolidaysId": { "required": true, "type": "integer" }, "ChatServiceId": { "required": true, "type": "integer" }, "Date": { "required": true, "type": "string" }, "OpenTime": { "required": true, "type": "string" }, "CloseTime": { "required": true, "type": "string" }, "Closed": { "required": true, "type": "boolean" }, "Comment": { "required": true, "type": [ "string", "null" ] } } } } } } }, "Bots": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "BotType": { "required": true, "type": [ "string", "null" ] }, "BotSecret": { "required": true, "type": [ "string", "null" ] }, "MessagingEndpoint": { "required": true, "type": [ "string", "null" ] }, "CustomUrls": { "required": true, "type": "boolean" }, "CustomMessageUrl": { "required": true, "type": [ "string", "null" ] }, "CustomAssignConversationUrl": { "required": true, "type": [ "string", "null" ] } } } }, "DataCollectorQuestions": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "QuestionId": { "required": true, "type": "integer" }, "TemplateId": { "required": true, "type": "integer" }, "Text": { "required": true, "type": [ "string", "null" ] }, "FieldName": { "required": true, "type": [ "string", "null" ] }, "Order": { "required": true, "type": "integer" }, "UseSuggestedActions": { "required": true, "type": "boolean" }, "SuggestedActions": { "required": true, "type": [ "string", "null" ] }, "Timeout": { "required": true, "type": [ "integer", "null" ] }, "DigitCount": { "required": true, "type": [ "integer", "null" ] }, "UseForCustomerMatching": { "required": true, "type": "boolean" }, "ValidationRule": { "required": true, "type": [ "integer", "null" ] } } } }, "QueueChatConnectorConfigurations": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "TenantId": { "required": true, "type": [ "string", "null" ] }, "ChatServiceId": { "required": true, "type": "integer" }, "QueueNames": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } } } } }, "DataCollectorTemplates": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "Id": { "required": true, "type": "integer" }, "Name": { "required": true, "type": [ "string", "null" ] }, "GUMTenantId": { "required": true, "type": [ "string", "null" ] }, "Hidden": { "required": true, "type": "boolean" }, "TemplateType": { "required": true, "type": [ "string", "null" ] }, "MaxRepeatOnInvalidResponse": { "required": true, "type": "integer" }, "IsForVoice": { "required": true, "type": "boolean" } } } }, "Campaigns": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "CampaignId": { "required": true, "type": "integer" }, "Active": { "required": true, "type": "boolean" }, "Pacing": { "required": true, "type": "boolean" }, "PacingInterval": { "required": true, "type": [ "integer", "null" ] }, "PacingQuantity": { "required": true, "type": [ "integer", "null" ] }, "CampaignText": { "required": true, "type": [ "string", "null" ] }, "OohText": { "required": true, "type": [ "string", "null" ] }, "RecordExpiry": { "required": true, "type": "integer" }, "StopEnabled": { "required": true, "type": "boolean" }, "DivisionId": { "required": true, "type": "integer" }, "CampaignName": { "required": true, "type": [ "string", "null" ] }, "DefaultRegion": { "required": true, "type": [ "string", "null" ] }, "Inbound": { "required": true, "type": "boolean" }, "AllowMultiReplies": { "required": true, "type": "boolean" }, "ReplyInterval": { "required": true, "type": [ "integer", "null" ] }, "TestMode": { "required": true, "type": "boolean" }, "Timezone": { "required": true, "type": "integer" }, "ServiceQueueId": { "required": true, "type": "integer" }, "CampaignType": { "required": true, "type": "integer" }, "CallType": { "required": true, "type": [ "integer", "null" ] }, "SurveyType": { "required": true, "type": [ "integer", "null" ] }, "FromNumber": { "required": true, "type": [ "string", "null" ] }, "TenantId": { "required": true, "type": [ "string", "null" ] } } } }, "DataCollectorValidationRules": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "Id": { "required": true, "type": "integer" }, "Name": { "required": true, "type": [ "string", "null" ] }, "RuleType": { "required": true, "type": [ "string", "null" ] }, "RegularExpression": { "required": true, "type": [ "string", "null" ] }, "CountryCode": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" } } } }, "Workflows": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "WorkflowId": { "required": true, "type": "integer" }, "WorkflowName": { "required": true, "type": [ "string", "null" ] }, "EnableBotDialog": { "required": true, "type": "boolean" }, "GreetingMessage": { "required": true, "type": [ "string", "null" ] }, "GUMTenantId": { "required": true, "type": [ "string", "null" ] }, "RequiredFields": { "required": true, "type": [ "string", "null" ] }, "QuestionTemplate": { "required": true, "type": [ "integer", "null" ] }, "AgentChannelConnector": { "required": true, "type": [ "string", "null" ] }, "ACCConfigurations": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "ChannelType": { "required": true, "type": [ "string", "null" ] }, "Configuration": { "required": true, "type": [ "string", "null" ] }, "Enabled": { "required": true, "type": "boolean" } } } }, "EnableQnABotDialog": { "required": true, "type": "boolean" }, "QNAMakerConfigurationID": { "required": true, "type": [ "integer", "null" ] }, "JSONConfiguration": { "required": true, "type": [ "string", "null" ] }, "WorkflowTimeouts": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "ChannelID": { "required": true, "type": [ "string", "null" ] }, "TimeoutMinutes": { "required": true, "type": "integer" }, "Message": { "required": true, "type": [ "string", "null" ] }, "TimeoutHours": { "required": true, "type": "integer" } } } }, "CustomerWelcomeMessage": { "required": true, "type": [ "string", "null" ] }, "CustomerWelcomeSuggestedActions": { "required": true, "type": [ "string", "null" ] } } } } } }

chatopeninghours

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/chatopeninghours/{chatId}	GetByChatService
POST	api/1/chatopeninghours/bulk	PostBulk	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "ChatOpeningHoursId": { "required": true, "type": "integer" }, "Day": { "required": true, "type": "integer" }, "OpenTime": { "required": true, "type": "string" }, "CloseTime": { "required": true, "type": "string" }, "ChatServiceId": { "required": true, "type": "integer" }, "Closed": { "required": true, "type": "boolean" } } } }
PUT	api/1/chatopeninghours/bulk	UpdateBulk
DELETE	api/1/chatopeninghours/bulk	DeleteBulk

chatreports

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/chatreports/chats	GetChats	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "ChatConversationId": { "required": true, "type": "integer" }, "ChatServiceId": { "required": true, "type": "integer" }, "StartTime": { "required": true, "type": "string" }, "EndTime": { "required": true, "type": "string" }, "AssistTimeSecs": { "required": true, "type": "integer" }, "AgentTimeSecs": { "required": true, "type": "integer" }, "Result": { "required": true, "type": [ "string", "null" ] }, "ConversationEscalated": { "required": true, "type": "boolean" }, "ConversationId": { "required": true, "type": [ "string", "null" ] } } } }
GET	api/1/chatreports/summary	GetSummaryReport	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "ChatCount": { "required": true, "type": "integer" }, "EscalationCount": { "required": true, "type": "integer" }, "AbondonedChatCount": { "required": true, "type": "integer" }, "SuccessChatCount": { "required": true, "type": "integer" }, "TotalAssistTime": { "required": true, "type": "integer" }, "TotalEscalationTime": { "required": true, "type": "integer" } } } }
GET	api/1/chatreports/segments	GetSegments	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "SegmentId": { "required": true, "type": "integer" }, "ConversationId": { "required": true, "type": [ "string", "null" ] }, "ChatServiceId": { "required": true, "type": "integer" }, "StartTime": { "required": true, "type": "string" }, "EndTime": { "required": true, "type": "string" }, "Result": { "required": true, "type": [ "string", "null" ] }, "SegmentType": { "required": true, "type": [ "string", "null" ] }, "Destination": { "required": true, "type": [ "string", "null" ] } } } }
GET	api/1/chatreports/messageUrl	GetMessagesUrl	[Show/Hide] { "type": "string" }

chatservices

HTTP Method	URL	Class Method	JSON Schema
POST	api/1/chatservices	Post	[Show/Hide] { "type": "object", "properties": { "TimezoneId": { "required": true, "type": "integer" }, "ChatServiceId": { "required": true, "type": "integer" }, "DivisionId": { "required": true, "type": "integer" }, "TenantId": { "required": true, "type": [ "string", "null" ] }, "Name": { "required": true, "type": [ "string", "null" ] }, "Enabled": { "required": true, "type": "boolean" }, "WorkflowId": { "required": true, "type": "integer" }, "CCCConfigurations": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "ChannelType": { "required": true, "type": [ "string", "null" ] }, "Configuration": { "required": true, "type": [ "string", "null" ] }, "Enabled": { "required": true, "type": "boolean" } } } }, "MsAppId": { "required": true, "type": [ "string", "null" ] }, "MsAppSecret": { "required": true, "type": [ "string", "null" ] }, "FbPageSecret": { "required": true, "type": [ "string", "null" ] }, "ProvisioningState": { "required": true, "type": "integer" }, "Default": { "required": true, "type": "boolean" }, "SLATarget": { "required": true, "type": "integer" } } }
	api/1/chatservices/updateCCCconfig/{chatServiceId}/{provisioningGuid}	UpdateCCCConfig
GET	api/1/chatservices	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "TimezoneId": { "required": true, "type": "integer" }, "ChatServiceId": { "required": true, "type": "integer" }, "DivisionId": { "required": true, "type": "integer" }, "TenantId": { "required": true, "type": [ "string", "null" ] }, "Name": { "required": true, "type": [ "string", "null" ] }, "Enabled": { "required": true, "type": "boolean" }, "WorkflowId": { "required": true, "type": "integer" }, "CCCConfigurations": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "ChannelType": { "required": true, "type": [ "string", "null" ] }, "Configuration": { "required": true, "type": [ "string", "null" ] }, "Enabled": { "required": true, "type": "boolean" } } } }, "MsAppId": { "required": true, "type": [ "string", "null" ] }, "MsAppSecret": { "required": true, "type": [ "string", "null" ] }, "FbPageSecret": { "required": true, "type": [ "string", "null" ] }, "ProvisioningState": { "required": true, "type": "integer" }, "Default": { "required": true, "type": "boolean" }, "SLATarget": { "required": true, "type": "integer" } } } }
GET	api/1/chatservices/list	List	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "ChatServiceId": { "required": true, "type": "integer" }, "Name": { "required": true, "type": [ "string", "null" ] } } } }
PUT	api/1/chatservices/{id}	Put	[Show/Hide] { "type": "object", "properties": { "TimezoneId": { "required": true, "type": "integer" }, "ChatServiceId": { "required": true, "type": "integer" }, "DivisionId": { "required": true, "type": "integer" }, "TenantId": { "required": true, "type": [ "string", "null" ] }, "Name": { "required": true, "type": [ "string", "null" ] }, "Enabled": { "required": true, "type": "boolean" }, "WorkflowId": { "required": true, "type": "integer" }, "CCCConfigurations": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "ChannelType": { "required": true, "type": [ "string", "null" ] }, "Configuration": { "required": true, "type": [ "string", "null" ] }, "Enabled": { "required": true, "type": "boolean" } } } }, "MsAppId": { "required": true, "type": [ "string", "null" ] }, "MsAppSecret": { "required": true, "type": [ "string", "null" ] }, "FbPageSecret": { "required": true, "type": [ "string", "null" ] }, "ProvisioningState": { "required": true, "type": "integer" }, "Default": { "required": true, "type": "boolean" }, "SLATarget": { "required": true, "type": "integer" } } }
DELETE	api/1/chatservices/{id}	Delete
POST	api/1/chatservices/provisioning/{id}	PostProvisioningUpdate

companies

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/companies/list	List	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "CompanyID": { "required": true, "type": "integer" }, "Name": { "required": true, "type": [ "string", "null" ] } } } }
GET	api/1/companies	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "CompanyID": { "required": true, "type": "integer" }, "BillingPlan": { "required": true, "type": "integer" }, "Name": { "required": true, "type": [ "string", "null" ] }, "Password": { "required": true, "type": [ "string", "null" ] }, "HybridMode": { "required": true, "type": "boolean" }, "TenantShortCode": { "required": true, "type": [ "string", "null" ] }, "GAuthToken": { "required": true, "type": [ "string", "null" ] }, "CompanyGroupId": { "required": true, "type": [ "integer", "null" ] }, "GUMTenantId": { "required": true, "type": [ "string", "null" ] } } } }
POST	api/1/companies	Post	[Show/Hide] { "type": "object", "properties": { "CompanyID": { "required": true, "type": "integer" }, "BillingPlan": { "required": true, "type": "integer" }, "Name": { "required": true, "type": [ "string", "null" ] }, "Password": { "required": true, "type": [ "string", "null" ] }, "HybridMode": { "required": true, "type": "boolean" }, "TenantShortCode": { "required": true, "type": [ "string", "null" ] }, "GAuthToken": { "required": true, "type": [ "string", "null" ] }, "CompanyGroupId": { "required": true, "type": [ "integer", "null" ] }, "GUMTenantId": { "required": true, "type": [ "string", "null" ] } } }
POST	api/1/companies/{id}/newtoken	RenewToken
PUT	api/1/companies/{id}	Put	[Show/Hide] { "type": "object", "properties": { "CompanyID": { "required": true, "type": "integer" }, "BillingPlan": { "required": true, "type": "integer" }, "Name": { "required": true, "type": [ "string", "null" ] }, "Password": { "required": true, "type": [ "string", "null" ] }, "HybridMode": { "required": true, "type": "boolean" }, "TenantShortCode": { "required": true, "type": [ "string", "null" ] }, "GAuthToken": { "required": true, "type": [ "string", "null" ] }, "CompanyGroupId": { "required": true, "type": [ "integer", "null" ] }, "GUMTenantId": { "required": true, "type": [ "string", "null" ] } } }

companygroups

HTTP Method	URL	Class Method	Description	JSON Schema
GET	api/1/companygroups	Get		[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "GroupId": { "required": true, "type": "integer" }, "GroupName": { "required": true, "type": [ "string", "null" ] }, "TenantShortCode": { "required": true, "type": [ "string", "null" ] }, "Companies": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "properties": { "CompanyID": { "required": true, "type": "integer" }, "Name": { "required": true, "type": [ "string", "null" ] } } } } } } }
POST	api/1/companygroups	Post

custommenuannouncements

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/custommenuannouncements/{id}	Get	[Show/Hide] { "type": "object", "properties": { "CustomAnnouncementId": { "required": true, "type": "integer" }, "MenuId": { "required": true, "type": "integer" }, "AnnouncementId": { "required": true, "type": "integer" }, "FileName": { "required": true, "type": [ "string", "null" ] } } }
POST	api/1/custommenuannouncements/bulk	Post	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "CustomAnnouncementId": { "required": true, "type": "integer" }, "MenuId": { "required": true, "type": "integer" }, "AnnouncementId": { "required": true, "type": "integer" }, "FileName": { "required": true, "type": [ "string", "null" ] } } } }
DELETE	api/1/custommenuannouncements/bulk	Delete	[Show/Hide] { "type": "array", "items": { "type": "integer" } }
DELETE	api/1/custommenuannouncements/{id}	DeleteByMenuId

dashboard

HTTP Method	URL	Class Method	Description	JSON Schema
GET	api/1/dashboard	Get		[Show/Hide] { "type": "object", "properties": { "ReportData": { "required": true, "type": [ "object", "null" ], "additionalProperties": { "type": [ "string", "null" ] } } } }

datacollectorquestions

HTTP Method	URL	Class Method
GET	api/1/datacollectorquestions/params	GetParams
GET	api/1/datacollectorquestions/{templateid}	Get
POST	api/1/datacollectorquestions	BulkCreate
PUT	api/1/datacollectorquestions	BulkUpdate
DELETE	api/1/datacollectorquestions	BulkDelete

datacollectortemplates

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/datacollectortemplates	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "Id": { "required": true, "type": "integer" }, "Name": { "required": true, "type": [ "string", "null" ] }, "Company": { "required": true, "type": "integer" }, "Hidden": { "required": true, "type": "boolean" }, "TemplateType": { "required": true, "type": [ "string", "null" ] }, "MaxRepeatOnInvalidResponse": { "required": true, "type": "integer" }, "IsForVoice": { "required": true, "type": "boolean" } } } }
POST	api/1/datacollectortemplates	Post	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "Id": { "required": true, "type": "integer" }, "Name": { "required": true, "type": [ "string", "null" ] }, "Company": { "required": true, "type": "integer" }, "Hidden": { "required": true, "type": "boolean" }, "TemplateType": { "required": true, "type": [ "string", "null" ] }, "MaxRepeatOnInvalidResponse": { "required": true, "type": "integer" }, "IsForVoice": { "required": true, "type": "boolean" } } } }
PUT	api/1/datacollectortemplates/{id}	Put	[Show/Hide] { "type": "object", "properties": { "Id": { "required": true, "type": "integer" }, "Name": { "required": true, "type": [ "string", "null" ] }, "Company": { "required": true, "type": "integer" }, "Hidden": { "required": true, "type": "boolean" }, "TemplateType": { "required": true, "type": [ "string", "null" ] }, "MaxRepeatOnInvalidResponse": { "required": true, "type": "integer" }, "IsForVoice": { "required": true, "type": "boolean" } } }
DELETE	api/1/datacollectortemplates/{id}	Delete	[Show/Hide] { "type": "integer" }

datacollectorvalidationrules

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/datacollectorvalidationrules	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "Id": { "required": true, "type": "integer" }, "Name": { "required": true, "type": [ "string", "null" ] }, "RuleType": { "required": true, "type": [ "string", "null" ] }, "RegularExpression": { "required": true, "type": [ "string", "null" ] }, "CountryCode": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" } } } }
POST	api/1/datacollectorvalidationrules	Post	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "Id": { "required": true, "type": "integer" }, "Name": { "required": true, "type": [ "string", "null" ] }, "RuleType": { "required": true, "type": [ "string", "null" ] }, "RegularExpression": { "required": true, "type": [ "string", "null" ] }, "CountryCode": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" } } } }
PUT	api/1/datacollectorvalidationrules/{id}	Put	[Show/Hide] { "type": "object", "properties": { "Id": { "required": true, "type": "integer" }, "Name": { "required": true, "type": [ "string", "null" ] }, "RuleType": { "required": true, "type": [ "string", "null" ] }, "RegularExpression": { "required": true, "type": [ "string", "null" ] }, "CountryCode": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" } } }
DELETE	api/1/datacollectorvalidationrules/{id}	Delete	[Show/Hide] { "type": "integer" }

dbschemainfo

HTTP Method	URL	Class Method	Description	JSON Schema
GET	api/1/dbschemainfo/list	List		[Show/Hide] { "type": "object", "properties": { "LastUpdateTime": { "required": true, "type": "string" }, "SchemaVersion": { "required": true, "type": [ "string", "null" ] } } }
GET	api/1/dbschemainfo	Get		[Show/Hide] { "type": "object", "properties": { "LastUpdateTime": { "required": true, "type": "string" }, "SchemaVersion": { "required": true, "type": [ "string", "null" ] } } }

divisions

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/divisions/list	List	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "DivisionName": { "required": true, "type": [ "string", "null" ] }, "DivisionId": { "required": true, "type": "integer" } } } }
GET	api/1/divisions	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "DivisionId": { "required": true, "type": "integer" }, "Company": { "required": true, "type": "integer" }, "DivisionName": { "required": true, "type": [ "string", "null" ] }, "BillingGroup": { "required": true, "type": "integer" } } } }
POST	api/1/divisions	Post	[Show/Hide] { "type": "object", "properties": { "DivisionId": { "required": true, "type": "integer" }, "Company": { "required": true, "type": "integer" }, "DivisionName": { "required": true, "type": [ "string", "null" ] }, "BillingGroup": { "required": true, "type": "integer" } } }
DELETE	api/1/divisions/{id}	Delete
PUT	api/1/divisions/{id}	Put	[Show/Hide] { "type": "object", "properties": { "DivisionId": { "required": true, "type": "integer" }, "Company": { "required": true, "type": "integer" }, "DivisionName": { "required": true, "type": [ "string", "null" ] }, "BillingGroup": { "required": true, "type": "integer" } } }
PATCH	api/1/divisions/billinggroup	UpdateBillingGroups

emailcontacts

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/emailcontacts/{id}	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "EmailContactId": { "required": true, "type": "integer" }, "ContactAddress": { "required": true, "type": [ "string", "null" ] }, "ContactName": { "required": true, "type": [ "string", "null" ] }, "ContactDescription": { "required": true, "type": [ "string", "null" ] }, "EmailGroupId": { "required": true, "type": "integer" } } } }
POST	api/1/emailcontacts/bulk	Post	[Show/Hide] { "type": "object", "properties": { "EmailContactId": { "required": true, "type": "integer" }, "ContactAddress": { "required": true, "type": [ "string", "null" ] }, "ContactName": { "required": true, "type": [ "string", "null" ] }, "ContactDescription": { "required": true, "type": [ "string", "null" ] }, "EmailGroupId": { "required": true, "type": "integer" } } }
DELETE	api/1/emailcontacts/bulk	Delete

emailgroups

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/emailgroups/list	List	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "EmailGroupId": { "required": true, "type": "integer" }, "EmailGroupName": { "required": true, "type": [ "string", "null" ] } } } }
GET	api/1/emailgroups	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "EmailGroupId": { "required": true, "type": "integer" }, "EmailGroupName": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" } } } }
POST	api/1/emailgroups	Post	[Show/Hide] { "type": "object", "properties": { "EmailGroupId": { "required": true, "type": "integer" }, "EmailGroupName": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" } } }
PUT	api/1/emailgroups/{id}	Put	[Show/Hide] { "type": "object", "properties": { "EmailGroupId": { "required": true, "type": "integer" }, "EmailGroupName": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" } } }
DELETE	api/1/emailgroups/{id}	Delete

filereports

HTTP Method	URL	Class Method	Description	JSON Schema
GET	api/1/filereports/records	GetRecords		[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "FileName": { "required": true, "type": [ "string", "null" ] }, "SuccessCount": { "required": true, "type": "integer" }, "RejectCount": { "required": true, "type": "integer" }, "Status": { "required": true, "type": [ "string", "null" ] }, "ImportDateTime": { "required": true, "type": "string" }, "Comment": { "required": true, "type": [ "string", "null" ] } } } }

freetrial

HTTP Method	URL	Class Method	Description	JSON Schema
POST	api/1/freetrial	StartFreeTrial

ftpreports

HTTP Method	URL	Class Method	Description	JSON Schema
GET	api/1/ftpreports/{id}	GetFiles
GET	api/1/ftpreports/{id}/{filename}	GetFile

inboundnumbers

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/inboundnumbers	Get	[Show/Hide] { "type": "object", "properties": { "NumberId": { "required": true, "type": "integer" }, "Number": { "required": true, "type": [ "string", "null" ] }, "Company": { "required": true, "type": [ "integer", "null" ] }, "Active": { "required": true, "type": "boolean" }, "Region": { "required": true, "type": [ "string", "null" ] }, "Type": { "required": true, "type": "integer" } } }
GET	api/1/inboundnumbers/list	List	[Show/Hide] { "type": "object", "properties": { "NumberId": { "required": true, "type": "integer" }, "Number": { "required": true, "type": [ "string", "null" ] }, "Company": { "required": true, "type": [ "integer", "null" ] }, "Active": { "required": true, "type": "boolean" }, "Region": { "required": true, "type": [ "string", "null" ] }, "Type": { "required": true, "type": "integer" } } }
POST	api/1/inboundnumbers	Post	[Show/Hide] { "type": "object", "properties": { "NumberId": { "required": true, "type": "integer" }, "Number": { "required": true, "type": [ "string", "null" ] }, "Company": { "required": true, "type": [ "integer", "null" ] }, "Active": { "required": true, "type": "boolean" }, "Region": { "required": true, "type": [ "string", "null" ] }, "Type": { "required": true, "type": "integer" } } }
PUT	api/1/inboundnumbers/{id}	Put	[Show/Hide] { "type": "object", "properties": { "NumberId": { "required": true, "type": "integer" }, "Number": { "required": true, "type": [ "string", "null" ] }, "Company": { "required": true, "type": [ "integer", "null" ] }, "Active": { "required": true, "type": "boolean" }, "Region": { "required": true, "type": [ "string", "null" ] }, "Type": { "required": true, "type": "integer" } } }
DELETE	api/1/inboundnumbers/{id}	Delete	[Show/Hide] { "type": "object", "properties": { "NumberId": { "required": true, "type": "integer" }, "Number": { "required": true, "type": [ "string", "null" ] }, "Company": { "required": true, "type": [ "integer", "null" ] }, "Active": { "required": true, "type": "boolean" }, "Region": { "required": true, "type": [ "string", "null" ] }, "Type": { "required": true, "type": "integer" } } }

keywords

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/keywords/{campaignId}	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "KeywordId": { "required": true, "type": "integer" }, "KeywordVal": { "required": true, "type": [ "string", "null" ] }, "CampaignId": { "required": true, "type": "integer" }, "ResponseAction": { "required": true, "type": "integer" }, "ResponseCampaignId": { "required": true, "type": [ "integer", "null" ] } } } }
GET	api/1/keywords/Actions	GetActions	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "KeywordId": { "required": true, "type": "integer" }, "KeywordVal": { "required": true, "type": [ "string", "null" ] }, "CampaignId": { "required": true, "type": "integer" }, "ResponseAction": { "required": true, "type": "integer" }, "ResponseCampaignId": { "required": true, "type": [ "integer", "null" ] } } } }
POST	api/1/keywords/bulk	Post	[Show/Hide] { "type": "object", "properties": { "KeywordId": { "required": true, "type": "integer" }, "KeywordVal": { "required": true, "type": [ "string", "null" ] }, "CampaignId": { "required": true, "type": "integer" }, "ResponseAction": { "required": true, "type": "integer" }, "ResponseCampaignId": { "required": true, "type": [ "integer", "null" ] } } }
PUT	api/1/keywords/bulk	Put	[Show/Hide] { "type": "object", "properties": { "KeywordId": { "required": true, "type": "integer" }, "KeywordVal": { "required": true, "type": [ "string", "null" ] }, "CampaignId": { "required": true, "type": "integer" }, "ResponseAction": { "required": true, "type": "integer" }, "ResponseCampaignId": { "required": true, "type": [ "integer", "null" ] } } }
DELETE	api/1/keywords/bulk	BulkDelete

menunumbermaps

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/menunumbermaps	Get	[Show/Hide] { "type": "object", "properties": { "InboundNumberId": { "required": true, "type": "integer" }, "MenuId": { "required": true, "type": "integer" } } }
POST	api/1/menunumbermaps	Post	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "InboundNumberId": { "required": true, "type": "integer" }, "MenuId": { "required": true, "type": "integer" } } } }
DELETE	api/1/menunumbermaps	Delete	[Show/Hide] { "type": "array", "items": { "type": "integer" } }

menus

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/menus	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "MenuId": { "required": true, "type": "integer" }, "Active": { "required": true, "type": "boolean" }, "NumberOfRetries": { "required": true, "type": "integer" }, "TransferToSipUri": { "required": true, "type": [ "string", "null" ] }, "PlayOfferMenu": { "required": true, "type": "boolean" }, "PlayEwt": { "required": true, "type": "boolean" }, "PlayOfferSchedule": { "required": true, "type": "boolean" }, "UseCustomAnnouncements": { "required": true, "type": "boolean" }, "Name": { "required": true, "type": [ "string", "null" ] }, "UseCli": { "required": true, "type": "boolean" }, "AnnouncementGroup": { "required": true, "type": "integer" }, "RecordName": { "required": true, "type": "boolean" }, "AskAccNum": { "required": true, "type": "boolean" }, "MinAccNumDigits": { "required": true, "type": [ "integer", "null" ] }, "MaxAccNumDigits": { "required": true, "type": [ "integer", "null" ] }, "ServiceQueueId": { "required": true, "type": "integer" }, "IsOoh": { "required": true, "type": "boolean" }, "EnableCwa": { "required": true, "type": "boolean" }, "isHybrid": { "required": true, "type": "boolean" } } } }
POST	api/1/menus	Post	[Show/Hide] { "type": "object", "properties": { "MenuId": { "required": true, "type": "integer" }, "Active": { "required": true, "type": "boolean" }, "NumberOfRetries": { "required": true, "type": "integer" }, "TransferToSipUri": { "required": true, "type": [ "string", "null" ] }, "PlayOfferMenu": { "required": true, "type": "boolean" }, "PlayEwt": { "required": true, "type": "boolean" }, "PlayOfferSchedule": { "required": true, "type": "boolean" }, "UseCustomAnnouncements": { "required": true, "type": "boolean" }, "Name": { "required": true, "type": [ "string", "null" ] }, "UseCli": { "required": true, "type": "boolean" }, "AnnouncementGroup": { "required": true, "type": "integer" }, "RecordName": { "required": true, "type": "boolean" }, "AskAccNum": { "required": true, "type": "boolean" }, "MinAccNumDigits": { "required": true, "type": [ "integer", "null" ] }, "MaxAccNumDigits": { "required": true, "type": [ "integer", "null" ] }, "ServiceQueueId": { "required": true, "type": "integer" }, "IsOoh": { "required": true, "type": "boolean" }, "EnableCwa": { "required": true, "type": "boolean" }, "isHybrid": { "required": true, "type": "boolean" } } }
PUT	api/1/menus/{id}	Put	[Show/Hide] { "type": "object", "properties": { "MenuId": { "required": true, "type": "integer" }, "Active": { "required": true, "type": "boolean" }, "NumberOfRetries": { "required": true, "type": "integer" }, "TransferToSipUri": { "required": true, "type": [ "string", "null" ] }, "PlayOfferMenu": { "required": true, "type": "boolean" }, "PlayEwt": { "required": true, "type": "boolean" }, "PlayOfferSchedule": { "required": true, "type": "boolean" }, "UseCustomAnnouncements": { "required": true, "type": "boolean" }, "Name": { "required": true, "type": [ "string", "null" ] }, "UseCli": { "required": true, "type": "boolean" }, "AnnouncementGroup": { "required": true, "type": "integer" }, "RecordName": { "required": true, "type": "boolean" }, "AskAccNum": { "required": true, "type": "boolean" }, "MinAccNumDigits": { "required": true, "type": [ "integer", "null" ] }, "MaxAccNumDigits": { "required": true, "type": [ "integer", "null" ] }, "ServiceQueueId": { "required": true, "type": "integer" }, "IsOoh": { "required": true, "type": "boolean" }, "EnableCwa": { "required": true, "type": "boolean" }, "isHybrid": { "required": true, "type": "boolean" } } }
DELETE	api/1/menus/{id}	Delete

numberrestrictions

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/numberrestrictions/{servicequeueid}	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "NumberRestrictionId": { "required": true, "type": "integer" }, "ServiceQueueId": { "required": true, "type": "integer" }, "Number": { "required": true, "type": [ "string", "null" ] }, "Notes": { "required": true, "type": [ "string", "null" ] }, "IsExclude": { "required": true, "type": "boolean" } } } }
POST	api/1/numberrestrictions	Post	[Show/Hide] { "type": "object", "properties": { "NumberRestrictionId": { "required": true, "type": "integer" }, "ServiceQueueId": { "required": true, "type": "integer" }, "Number": { "required": true, "type": [ "string", "null" ] }, "Notes": { "required": true, "type": [ "string", "null" ] }, "IsExclude": { "required": true, "type": "boolean" } } }
PUT	api/1/numberrestrictions/{id}	Put	[Show/Hide] { "type": "object", "properties": { "NumberRestrictionId": { "required": true, "type": "integer" }, "ServiceQueueId": { "required": true, "type": "integer" }, "Number": { "required": true, "type": [ "string", "null" ] }, "Notes": { "required": true, "type": [ "string", "null" ] }, "IsExclude": { "required": true, "type": "boolean" } } }
DELETE	api/1/numberrestrictions/{id}/blacklist/{blacklist}	Delete
POST	api/1/numberrestrictions/bulkcreate	BulkCreate	[Show/Hide] { "type": "object", "properties": { "NumberRestrictionId": { "required": true, "type": "integer" }, "ServiceQueueId": { "required": true, "type": "integer" }, "Number": { "required": true, "type": [ "string", "null" ] }, "Notes": { "required": true, "type": [ "string", "null" ] }, "IsExclude": { "required": true, "type": "boolean" } } }
DELETE	api/1/numberrestrictions/bulk/blacklist	BulkDeleteBlacklist
DELETE	api/1/numberrestrictions/bulk/whitelist	BulkDeleteWhitelist

openinghours

HTTP Method	URL	Class Method	JSON Schema
POST	api/1/openinghours	Post	[Show/Hide] { "type": "object", "properties": { "OpeningHoursID": { "required": true, "type": "integer" }, "Day": { "required": true, "type": [ "integer", "null" ] }, "OpenTime": { "required": true, "type": "string" }, "CloseTime": { "required": true, "type": "string" }, "Date": { "required": true, "type": [ "string", "null" ] }, "Comment": { "required": true, "type": [ "string", "null" ] }, "ServiceQueueID": { "required": true, "type": [ "integer", "null" ] }, "DivisionID": { "required": true, "type": [ "integer", "null" ] }, "Closed": { "required": true, "type": "boolean" } } }
POST	api/1/openinghours/bulk	BulkInsert	[Show/Hide] { "type": "object", "properties": { "OpeningHoursID": { "required": true, "type": "integer" }, "Day": { "required": true, "type": [ "integer", "null" ] }, "OpenTime": { "required": true, "type": "string" }, "CloseTime": { "required": true, "type": "string" }, "Date": { "required": true, "type": [ "string", "null" ] }, "Comment": { "required": true, "type": [ "string", "null" ] }, "ServiceQueueID": { "required": true, "type": [ "integer", "null" ] }, "DivisionID": { "required": true, "type": [ "integer", "null" ] }, "Closed": { "required": true, "type": "boolean" } } }
GET	api/1/openinghours/servicequeue/{sqId}	GetByServiceQueue	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "OpeningHoursID": { "required": true, "type": "integer" }, "Day": { "required": true, "type": [ "integer", "null" ] }, "OpenTime": { "required": true, "type": "string" }, "CloseTime": { "required": true, "type": "string" }, "Date": { "required": true, "type": [ "string", "null" ] }, "Comment": { "required": true, "type": [ "string", "null" ] }, "ServiceQueueID": { "required": true, "type": [ "integer", "null" ] }, "DivisionID": { "required": true, "type": [ "integer", "null" ] }, "Closed": { "required": true, "type": "boolean" } } } }
GET	api/1/openinghours/division/{divId}	GetByDivision	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "OpeningHoursID": { "required": true, "type": "integer" }, "Day": { "required": true, "type": [ "integer", "null" ] }, "OpenTime": { "required": true, "type": "string" }, "CloseTime": { "required": true, "type": "string" }, "Date": { "required": true, "type": [ "string", "null" ] }, "Comment": { "required": true, "type": [ "string", "null" ] }, "ServiceQueueID": { "required": true, "type": [ "integer", "null" ] }, "DivisionID": { "required": true, "type": [ "integer", "null" ] }, "Closed": { "required": true, "type": "boolean" } } } }
GET	api/1/openinghours/servicequeue/{sqId}/list	ListByServiceQueue	[Show/Hide] { "type": "object", "properties": { "OpeningHoursID": { "required": true, "type": "integer" }, "Day": { "required": true, "type": [ "integer", "null" ] }, "Date": { "required": true, "type": [ "string", "null" ] } } }
GET	api/1/openinghours/division/{divId}/list	ListByDivision	[Show/Hide] { "type": "object", "properties": { "OpeningHoursID": { "required": true, "type": "integer" }, "Day": { "required": true, "type": [ "integer", "null" ] }, "Date": { "required": true, "type": [ "string", "null" ] } } }
PUT	api/1/openinghours/{id}	Update	[Show/Hide] { "type": "object", "properties": { "OpeningHoursID": { "required": true, "type": "integer" }, "Day": { "required": true, "type": [ "integer", "null" ] }, "OpenTime": { "required": true, "type": "string" }, "CloseTime": { "required": true, "type": "string" }, "Date": { "required": true, "type": [ "string", "null" ] }, "Comment": { "required": true, "type": [ "string", "null" ] }, "ServiceQueueID": { "required": true, "type": [ "integer", "null" ] }, "DivisionID": { "required": true, "type": [ "integer", "null" ] }, "Closed": { "required": true, "type": "boolean" } } }
PUT	api/1/openinghours/bulk/	BulkUpdate	[Show/Hide] { "type": "object", "properties": { "OpeningHoursID": { "required": true, "type": "integer" }, "Day": { "required": true, "type": [ "integer", "null" ] }, "OpenTime": { "required": true, "type": "string" }, "CloseTime": { "required": true, "type": "string" }, "Date": { "required": true, "type": [ "string", "null" ] }, "Comment": { "required": true, "type": [ "string", "null" ] }, "ServiceQueueID": { "required": true, "type": [ "integer", "null" ] }, "DivisionID": { "required": true, "type": [ "integer", "null" ] }, "Closed": { "required": true, "type": "boolean" } } }
DELETE	api/1/openinghours/{id}	Delete
DELETE	api/1/openinghours/bulk	BulkDelete

originatingnumbers

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/originatingnumbers/list/{smsAccountId}	List	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "OriginatingNoId": { "required": true, "type": "integer" }, "OriginatingNoValue": { "required": true, "type": [ "string", "null" ] } } } }
GET	api/1/originatingnumbers/sms/{smsAccountId}	GetBySmsAccountId	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "OriginatingNoId": { "required": true, "type": "integer" }, "OriginatingNoValue": { "required": true, "type": [ "string", "null" ] }, "SmsAccountId": { "required": true, "type": "integer" }, "Notes": { "required": true, "type": [ "string", "null" ] }, "WebhookSecret": { "required": true, "type": [ "string", "null" ] }, "Cost": { "required": true, "type": "number" } } } }
GET	api/1/originatingnumbers/{originatingId}	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "OriginatingNoId": { "required": true, "type": "integer" }, "OriginatingNoValue": { "required": true, "type": [ "string", "null" ] }, "SmsAccountId": { "required": true, "type": "integer" }, "Notes": { "required": true, "type": [ "string", "null" ] }, "WebhookSecret": { "required": true, "type": [ "string", "null" ] }, "Cost": { "required": true, "type": "number" } } } }
POST	api/1/originatingnumbers	Post	[Show/Hide] { "type": "object", "properties": { "OriginatingNoId": { "required": true, "type": "integer" }, "OriginatingNoValue": { "required": true, "type": [ "string", "null" ] }, "SmsAccountId": { "required": true, "type": "integer" }, "Notes": { "required": true, "type": [ "string", "null" ] }, "WebhookSecret": { "required": true, "type": [ "string", "null" ] }, "Cost": { "required": true, "type": "number" } } }
POST	api/1/originatingnumbers/bulk	BulkInsert	[Show/Hide] { "type": "object", "properties": { "OriginatingNoId": { "required": true, "type": "integer" }, "OriginatingNoValue": { "required": true, "type": [ "string", "null" ] }, "SmsAccountId": { "required": true, "type": "integer" }, "Notes": { "required": true, "type": [ "string", "null" ] }, "WebhookSecret": { "required": true, "type": [ "string", "null" ] }, "Cost": { "required": true, "type": "number" } } }
PUT	api/1/originatingnumbers/{id}	Put	[Show/Hide] { "type": "object", "properties": { "OriginatingNoId": { "required": true, "type": "integer" }, "OriginatingNoValue": { "required": true, "type": [ "string", "null" ] }, "SmsAccountId": { "required": true, "type": "integer" }, "Notes": { "required": true, "type": [ "string", "null" ] }, "WebhookSecret": { "required": true, "type": [ "string", "null" ] }, "Cost": { "required": true, "type": "number" } } }
PUT	api/1/originatingnumbers/bulk/	BulkUpdate	[Show/Hide] { "type": "object", "properties": { "OriginatingNoId": { "required": true, "type": "integer" }, "OriginatingNoValue": { "required": true, "type": [ "string", "null" ] }, "SmsAccountId": { "required": true, "type": "integer" }, "Notes": { "required": true, "type": [ "string", "null" ] }, "WebhookSecret": { "required": true, "type": [ "string", "null" ] }, "Cost": { "required": true, "type": "number" } } }
DELETE	api/1/originatingnumbers/{id}	Delete
DELETE	api/1/originatingnumbers/bulk/	BulkDelete
PATCH	api/1/originatingnumbers/cost	PatchCost

permissions

HTTP Method	URL	Class Method	Description	JSON Schema
GET	api/1/permissions/list	List		[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "PermissionID": { "required": true, "type": "integer" }, "PermissionType": { "required": true, "type": [ "string", "null" ] } } } }
GET	api/1/permissions	Get	Return permission types	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "PermissionID": { "required": true, "type": "integer" }, "PermissionType": { "required": true, "type": [ "string", "null" ] } } } }

qnamakerconfigurations

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/qnamakerconfigurations/list	List	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "QNAMakerConfigurationID": { "required": true, "type": "integer" }, "DisplayName": { "required": true, "type": [ "string", "null" ] } } } }
PUT	api/1/qnamakerconfigurations/{id}	Put	[Show/Hide] { "type": "object", "properties": { "QNAMakerConfigurationID": { "required": true, "type": "integer" }, "DisplayName": { "required": true, "type": [ "string", "null" ] }, "AuthKey": { "required": true, "type": [ "string", "null" ] }, "KnowledgebaseID": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "SubscriptionKey": { "required": true, "type": [ "string", "null" ] }, "Host": { "required": true, "type": [ "string", "null" ] }, "ScoreThreshold": { "required": true, "type": "number" }, "ProvisioningState": { "required": true, "type": [ "integer", "null" ] } } }
POST	api/1/qnamakerconfigurations/finish/{id}	PostSubscriptionKey	[Show/Hide] { "type": "object", "properties": { "QNAMakerConfigurationID": { "required": true, "type": "integer" }, "DisplayName": { "required": true, "type": [ "string", "null" ] }, "AuthKey": { "required": true, "type": [ "string", "null" ] }, "KnowledgebaseID": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "SubscriptionKey": { "required": true, "type": [ "string", "null" ] }, "Host": { "required": true, "type": [ "string", "null" ] }, "ScoreThreshold": { "required": true, "type": "number" }, "ProvisioningState": { "required": true, "type": [ "integer", "null" ] } } }
PUT	api/1/qnamakerconfigurations/{id}/knowledgebase	Put	[Show/Hide] { "type": "object", "properties": { "QNAMakerConfigurationID": { "required": true, "type": "integer" }, "DisplayName": { "required": true, "type": [ "string", "null" ] }, "AuthKey": { "required": true, "type": [ "string", "null" ] }, "KnowledgebaseID": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "SubscriptionKey": { "required": true, "type": [ "string", "null" ] }, "Host": { "required": true, "type": [ "string", "null" ] }, "ScoreThreshold": { "required": true, "type": "number" }, "ProvisioningState": { "required": true, "type": [ "integer", "null" ] } } }
GET	api/1/qnamakerconfigurations/{id}/knowledgebase/status	GetOperationStatus	[Show/Hide] { "type": "object", "properties": { "operationState": { "required": true, "type": [ "string", "null" ] }, "createdTimestamp": { "required": true, "type": "string" }, "lastActionTimestamp": { "required": true, "type": "string" }, "userId": { "required": true, "type": [ "string", "null" ] }, "operationId": { "required": true, "type": [ "string", "null" ] } } }
GET	api/1/qnamakerconfigurations/{id}/knowledgebase/unanswered	GetUnansweredQuestion	[Show/Hide] { "type": "object", "properties": { "UnansweredQnAQuestionId": { "required": true, "type": "integer" }, "Question": { "required": true, "type": [ "string", "null" ] }, "QnAMakerConfigurationId": { "required": true, "type": "integer" }, "KnowledgeBaseId": { "required": true, "type": [ "string", "null" ] }, "Confidence": { "required": true, "type": "number" }, "ChatServiceId": { "required": true, "type": "integer" }, "ConversationId": { "required": true, "type": [ "string", "null" ] }, "CreateTime": { "required": true, "type": "string" } } }
DELETE	api/1/qnamakerconfigurations/{id}/knowledgebase/unanswered/{questionId}	DeleteUnansweredQuestion
PUT	api/1/qnamakerconfigurations/{id}/knowledgebase/publish	PublishKb	[Show/Hide] { "type": "object", "properties": { "QNAMakerConfigurationID": { "required": true, "type": "integer" }, "DisplayName": { "required": true, "type": [ "string", "null" ] }, "AuthKey": { "required": true, "type": [ "string", "null" ] }, "KnowledgebaseID": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "SubscriptionKey": { "required": true, "type": [ "string", "null" ] }, "Host": { "required": true, "type": [ "string", "null" ] }, "ScoreThreshold": { "required": true, "type": "number" }, "ProvisioningState": { "required": true, "type": [ "integer", "null" ] } } }
GET	api/1/qnamakerconfigurations/{id}/knowledgebase	ReadKnowledgeBase	[Show/Hide] { "type": "object", "properties": { "QNAMakerConfigurationID": { "required": true, "type": "integer" }, "DisplayName": { "required": true, "type": [ "string", "null" ] }, "AuthKey": { "required": true, "type": [ "string", "null" ] }, "KnowledgebaseID": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "SubscriptionKey": { "required": true, "type": [ "string", "null" ] }, "Host": { "required": true, "type": [ "string", "null" ] }, "ScoreThreshold": { "required": true, "type": "number" }, "ProvisioningState": { "required": true, "type": [ "integer", "null" ] } } }
GET	api/1/qnamakerconfigurations	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "QNAMakerConfigurationID": { "required": true, "type": "integer" }, "DisplayName": { "required": true, "type": [ "string", "null" ] }, "AuthKey": { "required": true, "type": [ "string", "null" ] }, "KnowledgebaseID": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "SubscriptionKey": { "required": true, "type": [ "string", "null" ] }, "Host": { "required": true, "type": [ "string", "null" ] }, "ScoreThreshold": { "required": true, "type": "number" }, "ProvisioningState": { "required": true, "type": [ "integer", "null" ] } } } }
DELETE	api/1/qnamakerconfigurations/{id}	Delete
POST	api/1/qnamakerconfigurations	Post	[Show/Hide] { "type": "object", "properties": { "QNAMakerConfigurationID": { "required": true, "type": "integer" }, "DisplayName": { "required": true, "type": [ "string", "null" ] }, "AuthKey": { "required": true, "type": [ "string", "null" ] }, "KnowledgebaseID": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "SubscriptionKey": { "required": true, "type": [ "string", "null" ] }, "Host": { "required": true, "type": [ "string", "null" ] }, "ScoreThreshold": { "required": true, "type": "number" }, "ProvisioningState": { "required": true, "type": [ "integer", "null" ] } } }
POST	api/1/qnamakerconfigurations/provisioning/{id}	PostProvisioningUpdate

queuechatconnectorconfiguration

HTTP Method	URL	Class Method	JSON Schema
POST	api/1/queuechatconnectorconfiguration	Post
GET	api/1/queuechatconnectorconfiguration/company/{companyid}	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "QueueChatConnectorConfigurationId": { "required": true, "type": "integer" }, "QueueName": { "required": true, "type": [ "string", "null" ] }, "Name": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" } } } }
GET	api/1/queuechatconnectorconfiguration	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "QueueChatConnectorConfigurationId": { "required": true, "type": "integer" }, "QueueName": { "required": true, "type": [ "string", "null" ] }, "Name": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" } } } }

queuephonenumbers

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/queuephonenumbers/{SQid}/list	List	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "QueuePhoneNoId": { "required": true, "type": "integer" }, "QueuePhoneNoName": { "required": true, "type": [ "string", "null" ] } } } }
GET	api/1/queuephonenumbers/list	List	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "QueuePhoneNoId": { "required": true, "type": "integer" }, "QueuePhoneNoName": { "required": true, "type": [ "string", "null" ] } } } }
GET	api/1/queuephonenumbers	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "QueuePhoneNoId": { "required": true, "type": "integer" }, "CompanyId": { "required": true, "type": "integer" }, "Destination": { "required": true, "type": [ "string", "null" ] }, "QueuePhoneNoName": { "required": true, "type": [ "string", "null" ] } } } }
POST	api/1/queuephonenumbers	Post	[Show/Hide] { "type": "object", "properties": { "QueuePhoneNoId": { "required": true, "type": "integer" }, "CompanyId": { "required": true, "type": "integer" }, "Destination": { "required": true, "type": [ "string", "null" ] }, "QueuePhoneNoName": { "required": true, "type": [ "string", "null" ] } } }
PUT	api/1/queuephonenumbers/{id}	Put	[Show/Hide] { "type": "object", "properties": { "QueuePhoneNoId": { "required": true, "type": "integer" }, "CompanyId": { "required": true, "type": "integer" }, "Destination": { "required": true, "type": [ "string", "null" ] }, "QueuePhoneNoName": { "required": true, "type": [ "string", "null" ] } } }
DELETE	api/1/queuephonenumbers/{id}	Delete

queuetreatmentconfiguration

HTTP Method	URL	Class Method
GET	api/1/queuetreatmentconfiguration/{companyId}	GetQueueTreatments
DELETE	api/1/queuetreatmentconfiguration/{companyId}/{id}	DeleteQueueTreatment
PUT	api/1/queuetreatmentconfiguration/{companyId}	CreateOrUpdateTreatment

resources

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/resources/list	List	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "ResourceID": { "required": true, "type": "integer" }, "ResourceName": { "required": true, "type": [ "string", "null" ] } } } }
GET	api/1/resources	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "ResourceID": { "required": true, "type": "integer" }, "ResourceName": { "required": true, "type": [ "string", "null" ] }, "Static": { "required": true, "type": "integer" } } } }
GET	api/1/resources/{resourceid}	GetById	[Show/Hide] { "type": "object", "properties": { "ResourceID": { "required": true, "type": "integer" }, "ResourceName": { "required": true, "type": [ "string", "null" ] }, "Static": { "required": true, "type": "integer" } } }

roles

HTTP Method	URL	Class Method	Description
GET	api/1/roles/list	List	List all roles available at calling user hierachy
GET	api/1/roles	Get	Returns all the roles available at user hierarchy
GET	api/1/roles/assignable	GetUserAssignableRoles	Return role ids with effective permissions the same or more restrictive than user's effective permissions taking into account the calling user's hierarchy level
GET	api/1/roles/{roleid}/users	GetUsersWithRole	Returns users id of the users assigned to the requested role
GET	api/1/roles/{roleid}	GetById	Returns the role if available at user hierarchy

self

HTTP Method	URL	Class Method	Description
GET	api/1/self/settings	GetSettings	Return user's settings
PUT	api/1/self/settings	UpdateSettings	Update user's settings
GET	api/1/self	Get
PATCH	api/1/self	Patch

servicequeues

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/servicequeues/list	List	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "ServiceQueueId": { "required": true, "type": "integer" }, "ServiceName": { "required": true, "type": [ "string", "null" ] } } } }
GET	api/1/servicequeues/timeslottemplate/{templateid}/list	ListByTimeslotTemplate	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "ServiceQueueId": { "required": true, "type": "integer" }, "ServiceName": { "required": true, "type": [ "string", "null" ] } } } }
GET	api/1/servicequeues/division/{divId}/list	ListByDivision	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "ServiceQueueId": { "required": true, "type": "integer" }, "ServiceName": { "required": true, "type": [ "string", "null" ] } } } }
GET	api/1/servicequeues	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "ServiceQueueId": { "required": true, "type": "integer" }, "DivisionId": { "required": true, "type": "integer" }, "TimezoneId": { "required": true, "type": "integer" }, "ServiceName": { "required": true, "type": [ "string", "null" ] }, "Status": { "required": true, "type": "boolean" }, "Userpresentedno": { "required": true, "type": [ "string", "null" ] }, "EnableEmailNotifications": { "required": true, "type": "boolean" }, "EmailGroupId": { "required": true, "type": [ "integer", "null" ] }, "EnableSmsConfirmation": { "required": true, "type": "boolean" }, "EnableSmsReminder": { "required": true, "type": "boolean" }, "SmsReminderInterval": { "required": true, "type": [ "integer", "null" ] }, "TimeslotTemplate": { "required": true, "type": [ "integer", "null" ] }, "GAuthToken": { "required": true, "type": [ "string", "null" ] } } } }
PUT	api/1/servicequeues/{id}	Put
POST	api/1/servicequeues	Post	[Show/Hide] { "type": "object", "properties": { "ServiceQueueId": { "required": true, "type": "integer" }, "DivisionId": { "required": true, "type": "integer" }, "TimezoneId": { "required": true, "type": "integer" }, "ServiceName": { "required": true, "type": [ "string", "null" ] }, "Status": { "required": true, "type": "boolean" }, "Userpresentedno": { "required": true, "type": [ "string", "null" ] }, "EnableEmailNotifications": { "required": true, "type": "boolean" }, "EmailGroupId": { "required": true, "type": [ "integer", "null" ] }, "EnableSmsConfirmation": { "required": true, "type": "boolean" }, "EnableSmsReminder": { "required": true, "type": "boolean" }, "SmsReminderInterval": { "required": true, "type": [ "integer", "null" ] }, "TimeslotTemplate": { "required": true, "type": [ "integer", "null" ] }, "GAuthToken": { "required": true, "type": [ "string", "null" ] } } }
DELETE	api/1/servicequeues/{id}	Delete

smsaccounts

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/smsaccounts/list	List	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "SmsAccountId": { "required": true, "type": "integer" }, "SmsAccountName": { "required": true, "type": [ "string", "null" ] } } } }
GET	api/1/smsaccounts	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "SmsAccountId": { "required": true, "type": "integer" }, "SmsUsername": { "required": true, "type": [ "string", "null" ] }, "SmsPassword": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "SmsAccountName": { "required": true, "type": [ "string", "null" ] }, "Hidden": { "required": true, "type": "boolean" }, "SmsProvider": { "required": true, "type": [ "string", "null" ] } } } }
POST	api/1/smsaccounts	Post	[Show/Hide] { "type": "object", "properties": { "QueuePhoneNoId": { "required": true, "type": "integer" }, "CompanyId": { "required": true, "type": "integer" }, "Destination": { "required": true, "type": [ "string", "null" ] }, "QueuePhoneNoName": { "required": true, "type": [ "string", "null" ] } } }
PUT	api/1/smsaccounts/{id}	Put	[Show/Hide] { "type": "object", "properties": { "SmsAccountId": { "required": true, "type": "integer" }, "SmsUsername": { "required": true, "type": [ "string", "null" ] }, "SmsPassword": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "SmsAccountName": { "required": true, "type": [ "string", "null" ] }, "Hidden": { "required": true, "type": "boolean" }, "SmsProvider": { "required": true, "type": [ "string", "null" ] } } }
DELETE	api/1/smsaccounts/{id}	Delete

smsplans

HTTP Method	URL	Class Method
POST	api/1/smsplans	CreateSMSPlan
GET	api/1/smsplans	GetSMSPlans
PUT	api/1/smsplans/{id}	UpdateSMSPlan
DELETE	api/1/smsplans/{id}	DeleteSMSPlan

smsrates

HTTP Method	URL	Class Method
POST	api/1/smsrates/bulk	CreateSMSRate
GET	api/1/smsrates/{planId}	GetSMSRatesByPlanId
PUT	api/1/smsrates/bulk	UpdateSMSRate
DELETE	api/1/smsrates/bulk	DeleteSMSRate

smsthresholds

HTTP Method	URL	Class Method
POST	api/1/smsthresholds	CreateSMSThreshold
POST	api/1/smsthresholds/bulk	BulkCreateSMSThreshold
GET	api/1/smsthresholds/{id}	GetSMSThresholds
PUT	api/1/smsthresholds/bulk	UpdateSMSThreshold
DELETE	api/1/smsthresholds/bulk	DeleteSMSThreshold

snippets

HTTP Method	URL	Class Method	Description	JSON Schema
GET	api/1/snippets/{type}/{id}	GetChatSnippet

steeringmenus

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/steeringmenus	Get	[Show/Hide] { "type": "object", "properties": { "MenuId": { "required": true, "type": "integer" }, "RetryCount": { "required": true, "type": "integer" }, "CampaignId": { "required": true, "type": "integer" }, "DivisionId": { "required": true, "type": "integer" }, "AnnouncementGroup": { "required": true, "type": "integer" }, "TransferUri": { "required": true, "type": [ "string", "null" ] }, "InboundNumbers": { "required": true, "type": [ "array", "null" ], "items": { "type": "integer" } }, "Name": { "required": true, "type": [ "string", "null" ] } } }
POST	api/1/steeringmenus	Post	[Show/Hide] { "type": "object", "properties": { "MenuId": { "required": true, "type": "integer" }, "RetryCount": { "required": true, "type": "integer" }, "CampaignId": { "required": true, "type": "integer" }, "DivisionId": { "required": true, "type": "integer" }, "AnnouncementGroup": { "required": true, "type": "integer" }, "TransferUri": { "required": true, "type": [ "string", "null" ] }, "InboundNumbers": { "required": true, "type": [ "array", "null" ], "items": { "type": "integer" } }, "Name": { "required": true, "type": [ "string", "null" ] } } }
PUT	api/1/steeringmenus/{id}	Put	[Show/Hide] { "type": "object", "properties": { "MenuId": { "required": true, "type": "integer" }, "RetryCount": { "required": true, "type": "integer" }, "CampaignId": { "required": true, "type": "integer" }, "DivisionId": { "required": true, "type": "integer" }, "AnnouncementGroup": { "required": true, "type": "integer" }, "TransferUri": { "required": true, "type": [ "string", "null" ] }, "InboundNumbers": { "required": true, "type": [ "array", "null" ], "items": { "type": "integer" } }, "Name": { "required": true, "type": [ "string", "null" ] } } }
DELETE	api/1/steeringmenus/{id}	Delete

surveyreports

HTTP Method	URL	Class Method	Description	JSON Schema
GET	api/1/surveyreports/itemized	GetItemised		[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "CampaignRecordId": { "required": true, "type": "integer" }, "CampaignId": { "required": true, "type": "integer" }, "UserPhoneNumber": { "required": true, "type": [ "string", "null" ] }, "FirstName": { "required": true, "type": [ "string", "null" ] }, "SecondName": { "required": true, "type": [ "string", "null" ] }, "Field1": { "required": true, "type": [ "string", "null" ] }, "Field2": { "required": true, "type": [ "string", "null" ] }, "Field3": { "required": true, "type": [ "string", "null" ] }, "Field4": { "required": true, "type": [ "string", "null" ] }, "Field5": { "required": true, "type": [ "string", "null" ] }, "Field6": { "required": true, "type": [ "string", "null" ] }, "Field7": { "required": true, "type": [ "string", "null" ] }, "Field8": { "required": true, "type": [ "string", "null" ] }, "Field9": { "required": true, "type": [ "string", "null" ] }, "Field10": { "required": true, "type": [ "string", "null" ] }, "EnteredTime": { "required": true, "type": "string" }, "SMSSent": { "required": true, "type": "string" }, "ResponseTime": { "required": true, "type": "string" }, "ExpiryDate": { "required": true, "type": "string" }, "CampaignText": { "required": true, "type": [ "string", "null" ] }, "RecordStatus": { "required": true, "type": [ "string", "null" ] }, "ReasonCode": { "required": true, "type": [ "string", "null" ] }, "Region": { "required": true, "type": [ "string", "null" ] }, "ResponseText": { "required": true, "type": [ "string", "null" ] } } } }
GET	api/1/surveyreports/summary	GetSummaryReport		[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "CampaignId": { "required": true, "type": "integer" }, "Keywords": { "required": true, "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "Counts": { "required": true, "type": [ "array", "null" ], "items": { "type": "integer" } }, "EscalationEnabled": { "required": true, "type": "boolean" }, "EscalationCount": { "required": true, "type": "integer" }, "SMSCount": { "required": true, "type": "integer" } } } }

timeslots

HTTP Method	URL	Class Method	JSON Schema
PUT	api/1/timeslots/bulk	BulkUpdate	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "TimeslotId": { "required": true, "type": "integer" }, "TimeFrom": { "required": true, "type": "string" }, "TimeTo": { "required": true, "type": "string" }, "Capacity": { "required": true, "type": "integer" }, "Day": { "required": true, "type": "integer" }, "Disabled": { "required": true, "type": "boolean" }, "TemplateId": { "required": true, "type": "integer" } } } }
GET	api/1/timeslots/{templateId}	GetByTemplateId	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "TimeslotId": { "required": true, "type": "integer" }, "TimeFrom": { "required": true, "type": "string" }, "TimeTo": { "required": true, "type": "string" }, "Capacity": { "required": true, "type": "integer" }, "Day": { "required": true, "type": "integer" }, "Disabled": { "required": true, "type": "boolean" }, "TemplateId": { "required": true, "type": "integer" } } } }
POST	api/1/timeslots/bulk	BulkInsert	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "TimeslotId": { "required": true, "type": "integer" }, "TimeFrom": { "required": true, "type": "string" }, "TimeTo": { "required": true, "type": "string" }, "Capacity": { "required": true, "type": "integer" }, "Day": { "required": true, "type": "integer" }, "Disabled": { "required": true, "type": "boolean" }, "TemplateId": { "required": true, "type": "integer" } } } }
DELETE	api/1/timeslots/bulk	BulkDelete	[Show/Hide] { "type": "array", "items": { "type": "integer" } }

timeslottemplates

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/timeslottemplates	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "TemplateId": { "required": true, "type": "integer" }, "CompanyId": { "required": true, "type": "integer" }, "TimezoneId": { "required": true, "type": "integer" }, "Name": { "required": true, "type": [ "string", "null" ] } } } }
POST	api/1/timeslottemplates	Post	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "TemplateId": { "required": true, "type": "integer" }, "CompanyId": { "required": true, "type": "integer" }, "TimezoneId": { "required": true, "type": "integer" }, "Name": { "required": true, "type": [ "string", "null" ] } } } }
PUT	api/1/timeslottemplates/{id}	Put	[Show/Hide] { "type": "object", "properties": { "TemplateId": { "required": true, "type": "integer" }, "CompanyId": { "required": true, "type": "integer" }, "TimezoneId": { "required": true, "type": "integer" }, "Name": { "required": true, "type": [ "string", "null" ] } } }
DELETE	api/1/timeslottemplates/{id}	Delete	[Show/Hide] { "type": "integer" }

timezones

HTTP Method	URL	Class Method	Description	JSON Schema
GET	api/1/timezones/list	List		[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "TimezoneId": { "required": true, "type": "integer" }, "Utcoffset": { "required": true, "type": "number" }, "TimezoneName": { "required": true, "type": [ "string", "null" ] } } } }

ttsannouncements

HTTP Method	URL	Class Method	JSON Schema
GET	api/1/ttsannouncements/{id}	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "TtsAnnouncementId": { "required": true, "type": "integer" }, "GroupId": { "required": true, "type": "integer" }, "AnnouncementType": { "required": true, "type": "integer" }, "Text": { "required": true, "type": [ "string", "null" ] } } } }
POST	api/1/ttsannouncements/bulk	Post	[Show/Hide] { "type": "object", "properties": { "TtsAnnouncementId": { "required": true, "type": "integer" }, "GroupId": { "required": true, "type": "integer" }, "AnnouncementType": { "required": true, "type": "integer" }, "Text": { "required": true, "type": [ "string", "null" ] } } }
PUT	api/1/ttsannouncements/bulk	Put	[Show/Hide] { "type": "object", "properties": { "TtsAnnouncementId": { "required": true, "type": "integer" }, "GroupId": { "required": true, "type": "integer" }, "AnnouncementType": { "required": true, "type": "integer" }, "Text": { "required": true, "type": [ "string", "null" ] } } }
DELETE	api/1/ttsannouncements/bulk	Delete

users

HTTP Method	URL	Class Method	Description	JSON Schema
GET	api/1/users/{userid}/permissions	GetUserPermissions	Return effective permissions for a user
GET	api/1/users/list	List		[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "UserId": { "required": true, "type": "integer" }, "Name": { "required": true, "type": [ "string", "null" ] } } } }
GET	api/1/users	Get
GET	api/1/users/{id}	GetById
POST	api/1/users	Post
PUT	api/1/users/{id}	Put
DELETE	api/1/users/{id}	Delete

wizard

HTTP Method	URL	Class Method	Description	JSON Schema
POST	api/1/wizards/InQueueCallback	InQueueCallbackProvisionWizardTask
POST	api/1/wizards/WebCallback	WebCallbackProvisionWizardTask

workflows

HTTP Method	URL	Class Method	JSON Schema
	api/1/workflows/messages/files/{companyId}	UploadMessageFile
POST	api/1/workflows	Post	[Show/Hide] { "type": "object", "properties": { "WorkflowId": { "required": true, "type": "integer" }, "WorkflowName": { "required": true, "type": [ "string", "null" ] }, "EnableBotDialog": { "required": true, "type": "boolean" }, "GreetingMessage": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "RequiredFields": { "required": true, "type": [ "string", "null" ] }, "QuestionTemplate": { "required": true, "type": [ "integer", "null" ] }, "AgentChannelConnector": { "required": true, "type": [ "string", "null" ] }, "EnableQnABotDialog": { "required": true, "type": "boolean" }, "QNAMakerConfigurationID": { "required": true, "type": [ "integer", "null" ] }, "JSONConfiguration": { "required": true, "type": [ "string", "null" ] }, "Hidden": { "required": true, "type": "boolean" }, "CustomerWelcomeMessage": { "required": true, "type": [ "string", "null" ] }, "CustomerWelcomeSuggestedActions": { "required": true, "type": [ "string", "null" ] } } }
GET	api/1/workflows	Get	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "WorkflowId": { "required": true, "type": "integer" }, "WorkflowName": { "required": true, "type": [ "string", "null" ] }, "EnableBotDialog": { "required": true, "type": "boolean" }, "GreetingMessage": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "RequiredFields": { "required": true, "type": [ "string", "null" ] }, "QuestionTemplate": { "required": true, "type": [ "integer", "null" ] }, "AgentChannelConnector": { "required": true, "type": [ "string", "null" ] }, "EnableQnABotDialog": { "required": true, "type": "boolean" }, "QNAMakerConfigurationID": { "required": true, "type": [ "integer", "null" ] }, "JSONConfiguration": { "required": true, "type": [ "string", "null" ] }, "Hidden": { "required": true, "type": "boolean" }, "CustomerWelcomeMessage": { "required": true, "type": [ "string", "null" ] }, "CustomerWelcomeSuggestedActions": { "required": true, "type": [ "string", "null" ] } } } }
GET	api/1/workflows/list	List	[Show/Hide] { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "WorkflowId": { "required": true, "type": "integer" }, "WorkflowName": { "required": true, "type": [ "string", "null" ] } } } }
PUT	api/1/workflows/{id}	Put	[Show/Hide] { "type": "object", "properties": { "WorkflowId": { "required": true, "type": "integer" }, "WorkflowName": { "required": true, "type": [ "string", "null" ] }, "EnableBotDialog": { "required": true, "type": "boolean" }, "GreetingMessage": { "required": true, "type": [ "string", "null" ] }, "CompanyId": { "required": true, "type": "integer" }, "RequiredFields": { "required": true, "type": [ "string", "null" ] }, "QuestionTemplate": { "required": true, "type": [ "integer", "null" ] }, "AgentChannelConnector": { "required": true, "type": [ "string", "null" ] }, "EnableQnABotDialog": { "required": true, "type": "boolean" }, "QNAMakerConfigurationID": { "required": true, "type": [ "integer", "null" ] }, "JSONConfiguration": { "required": true, "type": [ "string", "null" ] }, "Hidden": { "required": true, "type": "boolean" }, "CustomerWelcomeMessage": { "required": true, "type": [ "string", "null" ] }, "CustomerWelcomeSuggestedActions": { "required": true, "type": [ "string", "null" ] } } }
DELETE	api/1/workflows/{id}	Delete

workitemcodes

HTTP Method	URL	Class Method	Description	JSON Schema
GET	api/1/workitemcodes	Get
POST	api/1/workitemcodes	Post

ToC

Buzzeasy Management Service API Reference

version: v2.1.2.0 [2022-06-25 04:56:18] System DB:Initialized

Table of Contents

HTTP Request Methods & Response Status Codes

Error Codes

Resource Types

HTTP Request Methods & Response Status Codes

GET - Get resource

POST - Create resource

PUT - Update resource

DELETE - Delete resource

PATCH - Partially update resource

Error Codes

Resource Types

agentskills

announcementgroups

announcements

attributes

auditlogs

billinggroups

billingplans

botchannels

bots

breaknames

callpacers

calltypedetails

campaignimport

campaignnumberrestrictions

campaignreports

campaigns

channelholidays

channelopeninghours

chatconfigs

chatopeninghours

chatreports

chatservices

companies

companygroups

custommenuannouncements

dashboard

datacollectorquestions

datacollectortemplates

datacollectorvalidationrules

dbschemainfo

divisions

emailcontacts

emailgroups

filereports

freetrial

ftpreports

inboundnumbers

keywords

menunumbermaps

menus

numberrestrictions

openinghours

originatingnumbers

permissions

qnamakerconfigurations

queuechatconnectorconfiguration

queuephonenumbers

queuetreatmentconfiguration

resources

roles

self

servicequeues

smsaccounts

smsplans

smsrates

smsthresholds

snippets

steeringmenus

surveyreports

timeslots

timeslottemplates

timezones

ttsannouncements

users

wizard

workflows