Getting Started
1
Create or Select a Project
Set up a new project or select an existing one. See Organizations & Projects.
2
Configure the Connector
Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.
Personal Access Token · Connector Profile
A sipgate Personal Access Token is a Token ID and Token pair that replaces a username and password for the REST API. Acc…
3
Link an Account
Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:
Personal Access Token · Link Account
4
Use Actions
Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.
Actions
91 actions
Action
Description
Get Account
Get the sipgate account behind the token.
Get Signed-In User
Get the sipgate user the token belongs to.
List Addresses
List the postal addresses of the sipgate account.
Get Calls
List the calls currently established on the sipgate account.
Start Channel Call
Start a new outbound channel call from a sipgate neo device.
Hang Up Call
Hang up an established call.
Play Call Announcement
Play an audio announcement to every participant of an established call.
Send Call DTMF
Send a DTMF tone sequence to every participant of an established call.
Set Call Hold
Put every participant of an established call on hold, or resume them.
Set Call Muted
Mute or unmute your own side of an established call.
Set Call Recording
Start or stop recording an established call.
Transfer Call
Transfer an established call to another phone number.
List Channels
List the channels of the sipgate account.
Get Contacts
List the contacts of the sipgate account.
Get Contact
Get one contact of the sipgate account by ID.
Create Contact
Create a contact in the sipgate account.
Update Contact
Replace the details of one contact in the sipgate account.
Delete Contact
Delete one contact from the sipgate account.
Delete Contacts
Delete several contacts, or every contact in one scope, from the sipgate account.
Get Contacts As CSV
Export the contacts of one scope as CSV.
Get Contacts VCard
Export the contacts of one scope in structured vCard form.
Upsert Contacts As VCard
Create or overwrite contacts from structured vCard records.
Import Contacts From CSV
Import contacts into the sipgate account from a CSV file.
Import Contacts From Google
Import contacts into the sipgate account from Google Contacts.
Get Devices
List the devices of one sipgate user.
Get Device
Get one sipgate device by ID.
Create Device
Create a device for one sipgate user.
Change Device Settings
Set the do-not-disturb flag and the emergency address of a device.
Delete Device
Delete a device from the sipgate account.
Change Device Alias
Rename a sipgate device.
Get Device Caller ID
Get the caller ID a device shows when it places a call.
Change Caller ID Settings
Set the caller ID a device shows when it places a call.
Get User Faxlines
List the fax lines of one sipgate user.
Create Faxline
Create a fax line for one sipgate user.
List Fax Line Numbers
List the phone numbers routed to one fax line.
Get Fax Line Caller ID
Get the caller ID a fax line shows when it sends a fax.
Get Groups
List the groups of the sipgate account.
Get Group
Get one group of the sipgate account by ID.
Get Group Users
List the members of a sipgate group.
Get History
List the calls, faxes, SMS and voicemails of the sipgate account.
Get History Entry
Get one call, fax, SMS or voicemail of the sipgate account by ID.
Update History Entry
Update the note, read, starred and archived state of one history entry.
Delete History Entry
Delete one call, fax, SMS or voicemail from the sipgate history.
Update History Entries
Update the read, starred and archived state of several history entries in one call.
Delete History Entries
Delete several calls, faxes, SMS or voicemails from the sipgate history in one call.
Get History CSV
Export the calls, faxes, SMS and voicemails of the sipgate account as CSV.
Set History Entry Archived
Archive one history entry or restore it from the archive.
Set History Entry Note
Set the free-text note on one history entry.
Set History Entry Read
Mark one history entry as read or unread.
Get Unified Credentials
Get the current sipgate connection’s unified credentials and identity.
List Unified Groups
List unified groups in a sipgate account.
Get Unified Group
Get a unified sipgate group by ID.
List Unified Roles
List the roles a user can hold in a sipgate account.
Get Unified Role
Get a unified sipgate role by ID.
List Unified Users
List unified users in a sipgate account.
Get Unified User
Get a unified sipgate user by ID.
Get Numbers
List the phone numbers of the sipgate account.
Get User Numbers
List the phone numbers routed to one sipgate user.
Change Number Settings
Route a phone number to an endpoint or release it for porting.
Create Quick Dial Number
Add a quick dial number for a sipgate user.
Update Quick Dial Number
Change the number or the owner of a quick dial number.
Delete Quick Dial Number
Remove a quick dial number from the sipgate account.
Validate Quick Dial Number
Check whether a quick dial number is still available.
List Account Phone Lines
List every phone line of the sipgate account.
List User Phone Lines
List the phone lines of one sipgate user.
Get Phone Line
Get one phone line of a sipgate user by ID.
Create Phone Line
Create a phone line for one sipgate user.
Update Phone Line Alias
Rename a phone line of a sipgate user.
Delete Phone Line
Delete a phone line from a sipgate user.
List Phone Line Devices
List the devices that ring on one phone line.
Add Device To Phone Line
Route a device to a phone line so it rings on incoming calls.
Remove Device From Phone Line
Stop a device from ringing on a phone line.
List Phone Line Numbers
List the phone numbers routed to one phone line.
List Phone Line Voicemails
List the voicemail boxes attached to one phone line.
List Phone Line Voicemail Greetings
List the greetings of one voicemail box on a phone line.
List Phone Line Forwardings
List the call forwarding rules of one phone line.
Update Phone Line Forwardings
Replace the call forwarding rules of one phone line.
Initiate Call
Place an outbound call from a sipgate classic extension to a phone number.
Send SMS
Send a text message from a sipgate SMS extension.
Send Fax
Send a PDF as a fax from a sipgate fax line.
Resend Fax
Send a fax that is already in the sipgate history again.
Play Recording
Call a device and play a recorded voicemail over the phone.
Record Voicemail Greeting
Call a device so the greeting of a voicemail box can be recorded over the phone.
Record IVR Announcement
Call a device so an IVR announcement can be recorded over the phone.
Get SMS Extensions
List the SMS extensions of one sipgate user.
Add Caller ID
Register a sender phone number on one SMS extension.
Get SMS Caller IDs
List the caller IDs registered on one SMS extension.
Get All Users
List the users of the sipgate account.
Get User
Get one user of the sipgate account by ID.
Get Voicemails
List the voicemail boxes of the sipgate account.
Get Voicemail
Get one voicemail box of the sipgate account by ID.