> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# sipgate

> How to set up the sipgate connector, plus the actions that are available.

![sipgate](https://stackone-logos.com/api/sipgate/filled/svg)

Previewv0.2.1[See changelog](https://docs.stackone.com/connectors/sipgate/changelog.md)

[91 actions](#actions) · 1 auth method

Telephony
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Personal Access Token · Connector Profile](https://docs.stackone.com/connectors/sipgate/guides/connector-profile/personal-access-token.md)
>
> 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](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Personal Access Token · Link Account](https://docs.stackone.com/connectors/sipgate/guides/link-account/personal-access-token.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

91 actions

ActionDescription

Get Account`sipgate_get_account`

Get the sipgate account behind the token.

Get Signed-In User`sipgate_get_userinfo`

Get the sipgate user the token belongs to.

List Addresses`sipgate_list_addresses`

List the postal addresses of the sipgate account.

Get Calls`sipgate_get_calls`

List the calls currently established on the sipgate account.

Start Channel Call`sipgate_create_call`

Start a new outbound channel call from a sipgate neo device.

Hang Up Call`sipgate_hangup_call`

Hang up an established call.

Play Call Announcement`sipgate_start_call_announcement`

Play an audio announcement to every participant of an established call.

Send Call DTMF`sipgate_send_call_dtmf`

Send a DTMF tone sequence to every participant of an established call.

Set Call Hold`sipgate_set_call_hold`

Put every participant of an established call on hold, or resume them.

Set Call Muted`sipgate_set_call_muted`

Mute or unmute your own side of an established call.

Set Call Recording`sipgate_set_call_recording`

Start or stop recording an established call.

Transfer Call`sipgate_transfer_call`

Transfer an established call to another phone number.

List Channels`sipgate_list_channels`

List the channels of the sipgate account.

Get Contacts`sipgate_get_contacts`

List the contacts of the sipgate account.

Get Contact`sipgate_get_contact`

Get one contact of the sipgate account by ID.

Create Contact`sipgate_create_contact`

Create a contact in the sipgate account.

Update Contact`sipgate_update_contact`

Replace the details of one contact in the sipgate account.

Delete Contact`sipgate_delete_contact`

Delete one contact from the sipgate account.

Delete Contacts`sipgate_delete_contacts`

Delete several contacts, or every contact in one scope, from the sipgate account.

Get Contacts As CSV`sipgate_get_contacts_as_csv`

Export the contacts of one scope as CSV.

Get Contacts VCard`sipgate_get_contacts_vcard`

Export the contacts of one scope in structured vCard form.

Upsert Contacts As VCard`sipgate_upsert_contacts_vcard`

Create or overwrite contacts from structured vCard records.

Import Contacts From CSV`sipgate_import_contacts_csv`

Import contacts into the sipgate account from a CSV file.

Import Contacts From Google`sipgate_import_contacts_google`

Import contacts into the sipgate account from Google Contacts.

Get Devices`sipgate_get_devices`

List the devices of one sipgate user.

Get Device`sipgate_get_device`

Get one sipgate device by ID.

Create Device`sipgate_create_device`

Create a device for one sipgate user.

Change Device Settings`sipgate_change_device_settings`

Set the do-not-disturb flag and the emergency address of a device.

Delete Device`sipgate_delete_device`

Delete a device from the sipgate account.

Change Device Alias`sipgate_change_device_alias`

Rename a sipgate device.

Get Device Caller ID`sipgate_get_device_caller_id`

Get the caller ID a device shows when it places a call.

Change Caller ID Settings`sipgate_change_caller_id_settings`

Set the caller ID a device shows when it places a call.

Get User Faxlines`sipgate_get_user_faxlines`

List the fax lines of one sipgate user.

Create Faxline`sipgate_create_faxline`

Create a fax line for one sipgate user.

List Fax Line Numbers`sipgate_list_faxline_numbers`

List the phone numbers routed to one fax line.

Get Fax Line Caller ID`sipgate_get_faxline_caller_id`

Get the caller ID a fax line shows when it sends a fax.

Get Groups`sipgate_get_groups`

List the groups of the sipgate account.

Get Group`sipgate_get_group`

Get one group of the sipgate account by ID.

Get Group Users`sipgate_get_group_users`

List the members of a sipgate group.

Get History`sipgate_get_history`

List the calls, faxes, SMS and voicemails of the sipgate account.

Get History Entry`sipgate_get_history_entry`

Get one call, fax, SMS or voicemail of the sipgate account by ID.

Update History Entry`sipgate_update_history_entry`

Update the note, read, starred and archived state of one history entry.

Delete History Entry`sipgate_delete_history_entry`

Delete one call, fax, SMS or voicemail from the sipgate history.

Update History Entries`sipgate_update_history_entries`

Update the read, starred and archived state of several history entries in one call.

Delete History Entries`sipgate_delete_history_entries`

Delete several calls, faxes, SMS or voicemails from the sipgate history in one call.

Get History CSV`sipgate_get_history_csv`

Export the calls, faxes, SMS and voicemails of the sipgate account as CSV.

Set History Entry Archived`sipgate_set_history_entry_archive`

Archive one history entry or restore it from the archive.

Set History Entry Note`sipgate_set_history_entry_note`

Set the free-text note on one history entry.

Set History Entry Read`sipgate_set_history_entry_read`

Mark one history entry as read or unread.

Get Unified Credentials`sipgate_unified_get_me`

Get the current sipgate connection's unified credentials and identity.

List Unified Groups`sipgate_unified_list_groups`

List unified groups in a sipgate account.

Get Unified Group`sipgate_unified_get_group`

Get a unified sipgate group by ID.

List Unified Roles`sipgate_unified_list_roles`

List the roles a user can hold in a sipgate account.

Get Unified Role`sipgate_unified_get_role`

Get a unified sipgate role by ID.

List Unified Users`sipgate_unified_list_users`

List unified users in a sipgate account.

Get Unified User`sipgate_unified_get_user`

Get a unified sipgate user by ID.

Get Numbers`sipgate_get_numbers`

List the phone numbers of the sipgate account.

Get User Numbers`sipgate_get_user_numbers`

List the phone numbers routed to one sipgate user.

Change Number Settings`sipgate_change_number_settings`

Route a phone number to an endpoint or release it for porting.

Create Quick Dial Number`sipgate_create_quick_dial_number`

Add a quick dial number for a sipgate user.

Update Quick Dial Number`sipgate_update_quick_dial_number`

Change the number or the owner of a quick dial number.

Delete Quick Dial Number`sipgate_delete_quick_dial_number`

Remove a quick dial number from the sipgate account.

Validate Quick Dial Number`sipgate_validate_quick_dial_number`

Check whether a quick dial number is still available.

List Account Phone Lines`sipgate_list_account_phonelines`

List every phone line of the sipgate account.

List User Phone Lines`sipgate_list_user_phonelines`

List the phone lines of one sipgate user.

Get Phone Line`sipgate_get_phoneline`

Get one phone line of a sipgate user by ID.

Create Phone Line`sipgate_create_phoneline`

Create a phone line for one sipgate user.

Update Phone Line Alias`sipgate_update_phoneline_alias`

Rename a phone line of a sipgate user.

Delete Phone Line`sipgate_delete_phoneline`

Delete a phone line from a sipgate user.

List Phone Line Devices`sipgate_list_phoneline_devices`

List the devices that ring on one phone line.

Add Device To Phone Line`sipgate_add_device_to_phoneline`

Route a device to a phone line so it rings on incoming calls.

Remove Device From Phone Line`sipgate_remove_device_from_phoneline`

Stop a device from ringing on a phone line.

List Phone Line Numbers`sipgate_list_phoneline_numbers`

List the phone numbers routed to one phone line.

List Phone Line Voicemails`sipgate_list_phoneline_voicemails`

List the voicemail boxes attached to one phone line.

List Phone Line Voicemail Greetings`sipgate_list_phoneline_voicemail_greetings`

List the greetings of one voicemail box on a phone line.

List Phone Line Forwardings`sipgate_list_phoneline_forwardings`

List the call forwarding rules of one phone line.

Update Phone Line Forwardings`sipgate_update_phoneline_forwardings`

Replace the call forwarding rules of one phone line.

Initiate Call`sipgate_initiate_call`

Place an outbound call from a sipgate classic extension to a phone number.

Send SMS`sipgate_send_sms`

Send a text message from a sipgate SMS extension.

Send Fax`sipgate_send_fax`

Send a PDF as a fax from a sipgate fax line.

Resend Fax`sipgate_resend_fax`

Send a fax that is already in the sipgate history again.

Play Recording`sipgate_play_recording`

Call a device and play a recorded voicemail over the phone.

Record Voicemail Greeting`sipgate_record_voicemail_greeting`

Call a device so the greeting of a voicemail box can be recorded over the phone.

Record IVR Announcement`sipgate_record_ivr_announcement`

Call a device so an IVR announcement can be recorded over the phone.

Get SMS Extensions`sipgate_get_sms_extensions`

List the SMS extensions of one sipgate user.

Add Caller ID`sipgate_add_caller_id`

Register a sender phone number on one SMS extension.

Get SMS Caller IDs`sipgate_get_sms_caller_ids`

List the caller IDs registered on one SMS extension.

Get All Users`sipgate_get_all_users`

List the users of the sipgate account.

Get User`sipgate_get_user`

Get one user of the sipgate account by ID.

Get Voicemails`sipgate_get_voicemails`

List the voicemail boxes of the sipgate account.

Get Voicemail`sipgate_get_voicemail`

Get one voicemail box of the sipgate account by ID.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.