Implement Asterisk phone provider #1282

vucong2409 · 2023-02-03T10:51:48Z

What this PR does

This PR adds support for Asterisk call center beside Twilio.

Which issue(s) this PR fixes

Checklist

Tests updated
Documentation added
CHANGELOG.md updated

CLAassistant · 2023-02-03T10:51:56Z

All committers have signed the CLA.

sparfenov · 2023-02-06T02:29:27Z

Makefile

@@ -54,7 +54,7 @@ ifeq ($(DB),$(SQLITE_PROFILE))
 endif

 define run_docker_compose_command
-	$(DOCKER_COMPOSE_ENV_VARS) docker compose -f $(DOCKER_COMPOSE_FILE) $(1)
+	$(DOCKER_COMPOSE_ENV_VARS) docker-compose -f $(DOCKER_COMPOSE_FILE) $(1)


https://docs.docker.com/compose/compose-v2/#differences-between-compose-v1-and-compose-v2

Thanks for pointing that out! I've reverted that change.

Refactor phone_manager for asterisk support

dzift · 2023-02-21T07:44:51Z

Hello! can you show an example of a working configuration for testing? When I send alerts, oncall requires twilio to confirm numbers, but I'm trying to integrate with asterisk.

badhop · 2023-03-03T14:07:46Z

Hello! can you show an example of a working configuration for testing? When I send alerts, oncall requires twilio to confirm numbers, but I'm trying to integrate with asterisk.

Also have the same problem. Need twilio to confirm telephone number.

Git-general-InternalIT · 2023-03-03T14:10:50Z

Hello! can you show an example of a working configuration for testing? When I send alerts, oncall requires twilio to confirm numbers, but I'm trying to integrate with asterisk.

Also have the same problem. Need twilio to confirm telephone number.

In Env Variables -> PHONE_PROVIDER, need set to Asterisk

badhop · 2023-03-03T20:12:10Z

Hello! can you show an example of a working configuration for testing? When I send alerts, oncall requires twilio to confirm numbers, but I'm trying to integrate with asterisk.

Also have the same problem. Need twilio to confirm telephone number.

In Env Variables -> PHONE_PROVIDER, need set to Asterisk

Already set. When you try verify phone number it sends request to asterisk, but without verification code.

vucong2409 · 2023-03-07T05:57:37Z

Hi guys,
Sorry for the late reply
Currently, I sent a message containing OTP via alertMessage variable (you can see that in engine/apps/twilioapp/asterisk_client.py) and expect Asterisk to have some sort of TTS set up to read it.

For example, I have a dial plan set up like below. I use https://github.com/zaf/asterisk-googletts for TTS.

[oncall]
exten => 12345, 1, Answer()
           =>  12345, n, agi(googletts.agi,${alertMessage},en)
           =>  12345, n, Hangup()

dzift · 2023-03-22T08:07:03Z

Hi all! Please tell me how to solve the problem with verify phone number?

Konstantinov-Innokentii · 2023-03-25T07:34:04Z

Hi, @vucong2409. First of all - sorry for the late reply. Second - thanks for the PR.
I want to provide asterisk feature for OSS and make phone providers little more "robust".
I believe, that abstraction on phone numbers should be a level higher, than a clients. I experimenting with the PhoneNotificator interface, which will hide all interactions with phone providers form the core code (mainly from alerts)
Now I'm working on that, keeping in mind you asterisk changes, so it will be great to collaborate with you.

# What this PR does This PR moves phone notification logic into separate object PhoneBackend and introduces PhoneProvider interface to hide actual implementation of external phone services provider. It should allow add new phone providers just by implementing one class (See SimplePhoneProvider for example). # Why [Asterisk PR](#1282) showed that our phone notification system is not flexible. However this is one of the most frequent community questions - how to add "X" phone provider. Also, this refactoring move us one step closer to unifying all notification backends, since with PhoneBackend all phone notification logic is collected in one place and independent from concrete realisation. # Highligts 1. PhoneBackend object - contains all phone notifications business logic. 2. PhoneProvider - interface to external phone services provider. 3. TwilioPhoneProvider and SimplePhoneProvider - two examples of PhoneProvider implementation. 4. PhoneCallRecord and SMSRecord models. I introduced these models to keep phone notification limits logic decoupled from external providers. Existing TwilioPhoneCall and TwilioSMS objects will be migrated to the new table to not to reset limits counter. To be able to receive status callbacks and gather from Twilio TwilioPhoneCall and TwilioSMS still exists, but they are linked to PhoneCallRecord and SMSRecord via fk, to not to leat twilio logic into core code. --------- Co-authored-by: Yulia Shanyrova <yulia.shanyrova@grafana.com>

Konstantinov-Innokentii · 2023-05-31T04:34:45Z

Hi everyone. I merged #1713 with refactoring of phone provider system, which should make implementing asterisk much simpler. Waiting for contributions :)

Konstantinov-Innokentii · 2023-06-09T09:15:10Z

We are still waiting for volunteers to finish this PR or make a new one with Asterisk integration, feel free to contact me to sync up on that!

github-actions · 2023-07-10T02:08:15Z

This pull request has been automatically marked as stale because it has not had activity in the last 30 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, ping for review, or re-open when it's ready. Thank you for your contributions!

github-actions · 2023-08-10T01:52:10Z

This pull request has been automatically closed because it has not had activity in the last 30 days. Please feel free to give a status update now, ping for review, or re-open when it's ready. Thank you for your contributions!

joeyorlando · 2023-08-30T13:07:03Z

closing this PR as it needs to be refactored to use the new phone provider interface. It's not currently on the core team's roadmap to add this provider, but if anyone would like to open a new PR, implemented using the new interface, feel free and we will definitely review 🙂

feat: implement Asterisk phone provider

eb6fbac

vucong2409 requested review from a team as code owners February 3, 2023 10:51

vucong2409 changed the title ~~feat: implement Asterisk phone provider~~ Implement Asterisk phone provider Feb 3, 2023

Refactor asterisk_client

42d44f0

sparfenov reviewed Feb 6, 2023

View reviewed changes

Merge pull request #2 from dungdm93/feature/refactor-phone-provider

28e090b

Refactor phone_manager for asterisk support

mderynck force-pushed the dev branch from c50f4f0 to cdb62f2 Compare April 25, 2023 22:40

Konstantinov-Innokentii mentioned this pull request Apr 26, 2023

Phone provider refactoring #1713

Merged

github-actions bot added the pr:stale Added to a PR that has been deemed "stale". Managed by the actions/stale GitHub Action label Jul 10, 2023

github-actions bot closed this Aug 10, 2023

joeyorlando reopened this Aug 16, 2023

joeyorlando removed the pr:stale Added to a PR that has been deemed "stale". Managed by the actions/stale GitHub Action label Aug 16, 2023

joeyorlando closed this Aug 30, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement Asterisk phone provider #1282

Implement Asterisk phone provider #1282

vucong2409 commented Feb 3, 2023

CLAassistant commented Feb 3, 2023 •

edited

sparfenov Feb 6, 2023

vucong2409 Feb 6, 2023

dzift commented Feb 21, 2023

badhop commented Mar 3, 2023

Git-general-InternalIT commented Mar 3, 2023

badhop commented Mar 3, 2023

vucong2409 commented Mar 7, 2023 •

edited

dzift commented Mar 22, 2023

Konstantinov-Innokentii commented Mar 25, 2023 •

edited

Konstantinov-Innokentii commented May 31, 2023

Konstantinov-Innokentii commented Jun 9, 2023 •

edited

github-actions bot commented Jul 10, 2023

github-actions bot commented Aug 10, 2023

joeyorlando commented Aug 30, 2023

Implement Asterisk phone provider #1282

Implement Asterisk phone provider #1282

Conversation

vucong2409 commented Feb 3, 2023

What this PR does

Which issue(s) this PR fixes

Checklist

CLAassistant commented Feb 3, 2023 • edited

sparfenov Feb 6, 2023

Choose a reason for hiding this comment

vucong2409 Feb 6, 2023

Choose a reason for hiding this comment

dzift commented Feb 21, 2023

badhop commented Mar 3, 2023

Git-general-InternalIT commented Mar 3, 2023

badhop commented Mar 3, 2023

vucong2409 commented Mar 7, 2023 • edited

dzift commented Mar 22, 2023

Konstantinov-Innokentii commented Mar 25, 2023 • edited

Konstantinov-Innokentii commented May 31, 2023

Konstantinov-Innokentii commented Jun 9, 2023 • edited

github-actions bot commented Jul 10, 2023

github-actions bot commented Aug 10, 2023

joeyorlando commented Aug 30, 2023

CLAassistant commented Feb 3, 2023 •

edited

vucong2409 commented Mar 7, 2023 •

edited

Konstantinov-Innokentii commented Mar 25, 2023 •

edited

Konstantinov-Innokentii commented Jun 9, 2023 •

edited