Sipgate (sipgate.io)

This integration enables Zammad to provide a caller log to your agents. With this your agents can greet your customers by their name and are supported by Zammad with automatically opening a new ticket dialog or the user profile.

Click the toggle next to the heading to activate or deactivate this integration.

If you want to learn more on how your agents can use this function, please refer the user documentation.

Note

Automatically opening new ticket dialogues or user profiles requires agent to extension mapping - see more below.

Limitations

Please note the following limitations to reduce confusion later on:

• CTI integrations provide caller log functions only.

• This integration does not provide any VoIP functionalities; you can’t make phone calls from within Zammad.

• If your browser supports tel-URLs, you can click on phone numbers for automatic dialing. This requires additional software / configuration on your agent’s computers.

Requirements

Please provide the following requirements:

• You need an administrative Sipgate account for your organization.

• Zammad requires a sipgate.io addon from the feature store (please note that API calls are not free with Sipgate. Rates may apply and differ from account to account).

• Your Zammad instance must be allowed to communicate to external services.

• Sipgate must be able to reach your Zammad instance.

Setup Sipgate connection for Zammad

Learn how to configure Sipgate to enable Zammad and Sipgate to communicate with each other.

Available Settings

Endpoint Settings

Below endpoint settings affect the sipgate.io configuration.

Inbound

This endpoint is required for incoming call hooks.

Outbound

This endpoint is required for outgoing call hooks.

Important

All following options do not save automatically. Always use the Save button on the lower end of the integration page!

Call Settings

Inbound

This option allows you to block specific incoming caller IDs. It allows you to temporarily reject e.g. spam callers without having to contact providers or PBX administrators.

Caller ID to block

Provide caller IDs to block in E.164 format.

Your telephony system has to support this function. Zammad will send a reject response which will cause your telephony system to hang up the call. To callers this usually will feel like the line is busy.

Note

Provide a meaningful note for your fellow administrators to remind yourself why you’ve chosen to block the number.

Outbound

In many cases you may want to use a different caller ID depending on the destination you’re calling. This may apply due to specific connection rates to other countries or because you want your customer to feel you’re calling from the same country.

This option expects E.164 number formats.

Destination caller ID

The caller ID or number you’re trying to call.

You can use wildcards for e.g. country specific outbound numbers like:

• 49* for Germany

• 4930* for Berlin / Germany landlines

• 33* for France

Set Outbound caller ID

The outbound caller ID to set (the number your customer sees on his display) in E.164 number format.

Note

Provide a short description for fellow administrators.

Other Settings

Below you can find all available additional settings for this CTI integration. For your overview we’re sorting them by appearance and reference their description first.

Default caller ID for outbound calls

In many cases you may want to use a different caller ID depending on the destination you’re calling. This may apply due to specific connection rates to other countries or because you want your customer to feel you’re calling from the same country.

This option expects E.164 number formats.

Shown records in caller log

Allows you to set the number of shown caller log entries for all users. You can choose from the following values:

• 60 (default)

• 120

• 180

• 240

• 300

Warning

🥵 Potential performance issue

Setting this setting higher than 60 may cause serious performance issues on very busy instances. Keep in mind that this setting causes Zammad to poll and send up to 300 records to all active agent sessions in very short time periods.

Phone Extension to Agent Mapping

By mapping your agents extension to their existing Zammad users, Zammad can provide a new ticket dialog or open the user profile for the agent that picks up the call.

This speeds up ticket aiding, no matter if it’s for existing tickets or new ones!

To see it work from the agent’s perspective, have a look on user documentation.

Hint

You can find your agent’s Sipgate username within Accountverwaltung → Benutzer. You’re looking for the SIP-ID.

Note

Users with several devices also have several SIP-IDs.

Recent Logs

With recent logs Zammad allows you to view the latest calls for the CTI functionality. This usually comes in handy, when you’re looking for errors.

I’m just here to clear floats up.

By clicking on the entry of interest, Zammad will provide more details on the call in question. You’ll see the payload it received and also the response that was sent.

x

Troubleshooting

My Phone page stays blank, signalling does work…

If you’ve made sure that signalling works (check Recent logs) and your Caller Log still stays empty, please ensure that you only configured one CTI integration version. Specifically defining more than one agent mapping on the different integration variants will be the issue.

Clear the not needed agent mapping and reload your browser page.