SemianiakaVY/elsa-core
1
0
Fork 0
Code Issues Pull requests Actions 1 Packages Projects Releases Wiki Activity

Add GatherUsingSpeak activity

Browse source
This commit is contained in:
Sipke Schoorstra 2021-05-31 20:37:53 +02:00
parent 63a2ec6000
commit d9115639fc
5 changed files with 185 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/activities/Elsa.Activities.Telnyx/Activities/CallRingGroup.cs
View file

@ -106,12 +106,6 @@ namespace Elsa.Activities.Telnyx.Activities
set => SetState(value);
}
private IList<string> DialedControlIds
{
get => GetState(() => new List<string>());
set => SetState(value);
}
private CallAnsweredPayload? CallAnsweredPayload
{
get => GetState<CallAnsweredPayload?>();
@ -200,7 +194,7 @@ namespace Elsa.Activities.Telnyx.Activities
fork
.When("Timeout")
.StartIn(RingTime)
.StartIn(() => RingTime)
.Finish("No Response");
fork

2
src/activities/Elsa.Activities.Telnyx/Activities/GatherUsingAudio.cs
View file

@ -16,7 +16,7 @@ namespace Elsa.Activities.Telnyx.Activities
{
[Action(
Category = Constants.Category,
Description = "Play an audio file on the call until the required DTMF signals are gathered to build interactive menus",
Description = "Play an audio file on the call until the required DTMF signals are gathered to build interactive menus.",
Outcomes = new[] { OutcomeNames.Done, TelnyxOutcomeNames.CallIsNoLongerActive },
DisplayName = "Gather Using Audio"
)]

162
src/activities/Elsa.Activities.Telnyx/Activities/GatherUsingSpeak.cs Normal file
View file

@ -0,0 +1,162 @@
using System.Threading.Tasks;
using Elsa.Activities.Telnyx.Client.Models;
using Elsa.Activities.Telnyx.Client.Services;
using Elsa.Activities.Telnyx.Extensions;
using Elsa.ActivityResults;
using Elsa.Attributes;
using Elsa.Design;
using Elsa.Exceptions;
using Elsa.Expressions;
using Elsa.Services;
using Elsa.Services.Models;
using Refit;
namespace Elsa.Activities.Telnyx.Activities
{
[Action(
Category = Constants.Category,
Description = "Convert text to speech and play it on the call until the required DTMF signals are gathered to build interactive menus.",
Outcomes = new[] { OutcomeNames.Done, TelnyxOutcomeNames.CallIsNoLongerActive },
DisplayName = "Gather Using Speak"
)]
public class GatherUsingSpeak : Activity
{
private readonly ITelnyxClient _telnyxClient;
public GatherUsingSpeak(ITelnyxClient telnyxClient)
{
_telnyxClient = telnyxClient;
}
[ActivityInput(
Label = "Call Control ID", Hint = "Unique identifier and token for controlling the call",
Category = PropertyCategories.Advanced,
SupportedSyntaxes = new[] { SyntaxNames.JavaScript, SyntaxNames.Liquid }
)]
public string? CallControlId { get; set; } = default!;
[ActivityInput(
Hint = "The language you want spoken.",
UIHint = ActivityInputUIHints.Dropdown,
Options = new[] { "en-US", "en-AU", "nl-NL", "es-ES", "ru-RU" },
DefaultValue = "en-US",
SupportedSyntaxes = new[] { SyntaxNames.Literal, SyntaxNames.JavaScript, SyntaxNames.Liquid }
)]
public string Language { get; set; } = "en-US";
[ActivityInput(
Hint = "The gender of the voice used to speak back the text.",
UIHint = ActivityInputUIHints.Dropdown,
Options = new[] { "female", "male" },
DefaultValue = "female",
SupportedSyntaxes = new[] { SyntaxNames.Literal, SyntaxNames.JavaScript, SyntaxNames.Liquid }
)]
public string Voice { get; set; } = "female";
[ActivityInput(Hint = "The text or SSML to be converted into speech. There is a 5,000 character limit.", SupportedSyntaxes = new[] { SyntaxNames.JavaScript, SyntaxNames.Liquid })]
public string Payload { get; set; } = default!;
[ActivityInput(
Hint = "The type of the provided payload. The payload can either be plain text, or Speech Synthesis Markup Language (SSML).",
UIHint = ActivityInputUIHints.Dropdown,
Options = new[] { "", "text", "ssml" },
SupportedSyntaxes = new[] { SyntaxNames.Literal, SyntaxNames.JavaScript, SyntaxNames.Liquid }
)]
public string? PayloadType { get; set; }
[ActivityInput(
Hint = "This parameter impacts speech quality, language options and payload types. When using `basic`, only the `en-US` language and payload type `text` are allowed.",
UIHint = ActivityInputUIHints.Dropdown,
Options = new[] { "", "basic", "premium" },
Category = PropertyCategories.Advanced,
SupportedSyntaxes = new[] { SyntaxNames.Literal, SyntaxNames.JavaScript, SyntaxNames.Liquid }
)]
public string? ServiceLevel { get; set; }
[ActivityInput(Hint = "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", Category = PropertyCategories.Advanced,
SupportedSyntaxes = new[] { SyntaxNames.JavaScript, SyntaxNames.Liquid })]
public string? ClientState { get; set; }
[ActivityInput(
Label = "Command ID",
Hint = "Use this field to avoid duplicate commands. Telnyx will ignore commands with the same Command ID.",
Category = PropertyCategories.Advanced,
SupportedSyntaxes = new[] { SyntaxNames.JavaScript, SyntaxNames.Liquid }
)]
public string? CommandId { get; set; }
[ActivityInput(
Label = "Inter Digit Timeout",
Hint = "The number of milliseconds to wait for input between digits.",
Category = PropertyCategories.Advanced,
DefaultValue = 5000,
SupportedSyntaxes = new[] { SyntaxNames.JavaScript, SyntaxNames.Liquid }
)]
public int? InterDigitTimeoutMillis { get; set; } = 5000;
[ActivityInput(
Hint = "A list of all digits accepted as valid.",
Category = PropertyCategories.Advanced,
DefaultValue = "0123456789#*",
SupportedSyntaxes = new[] { SyntaxNames.JavaScript, SyntaxNames.Liquid }
)]
public string? ValidDigits { get; set; } = "0123456789#*";
[ActivityInput(Hint = "The minimum number of digits to fetch. This parameter has a minimum value of 1.", DefaultValue = 1, SupportedSyntaxes = new[] { SyntaxNames.JavaScript, SyntaxNames.Liquid })]
public int? MinimumDigits { get; set; } = 1;
[ActivityInput(Hint = "The maximum number of digits to fetch. This parameter has a maximum value of 128.", DefaultValue = 128, SupportedSyntaxes = new[] { SyntaxNames.JavaScript, SyntaxNames.Liquid })]
public int? MaximumDigits { get; set; } = 128;
[ActivityInput(Hint = "The maximum number of times the file should be played if there is no input from the user on the call.", DefaultValue = 3, SupportedSyntaxes = new[] { SyntaxNames.JavaScript, SyntaxNames.Liquid })]
public int? MaximumTries { get; set; } = 3;
[ActivityInput(Hint = "The digit used to terminate input if fewer than `maximum_digits` digits have been gathered.", DefaultValue = "#", SupportedSyntaxes = new[] { SyntaxNames.JavaScript, SyntaxNames.Liquid })]
public string? TerminatingDigit { get; set; } = "#";
[ActivityInput(
Label = "Timeout",
Hint = "The number of milliseconds to wait for a DTMF response after file playback ends before a replaying the sound file.",
Category = PropertyCategories.Advanced,
DefaultValue = 60000,
SupportedSyntaxes = new[] { SyntaxNames.JavaScript, SyntaxNames.Liquid })]
public int? TimeoutMillis { get; set; } = 60000;
protected override async ValueTask<IActivityExecutionResult> OnExecuteAsync(ActivityExecutionContext context)
{
var request = new GatherUsingSpeakRequest(
EmptyToNull(ClientState),
EmptyToNull(CommandId),
Language,
Voice,
Payload,
PayloadType,
ServiceLevel,
InterDigitTimeoutMillis,
MaximumDigits,
MaximumTries,
MinimumDigits,
EmptyToNull(TerminatingDigit),
TimeoutMillis,
EmptyToNull(ValidDigits)
);
var callControlId = context.GetCallControlId(CallControlId);
try
{
await _telnyxClient.Calls.GatherUsingSpeakAsync(callControlId, request, context.CancellationToken);
return Done();
}
catch (ApiException e)
{
if (await e.CallIsNoLongerActiveAsync())
return Outcome(TelnyxOutcomeNames.CallIsNoLongerActive);
throw new WorkflowException(e.Content ?? e.Message, e);
}
}
private string? EmptyToNull(string? value) => value is "" ? null : value;
}
}

19
src/activities/Elsa.Activities.Telnyx/Client/Models/Requests.cs
View file

@ -21,6 +21,23 @@ namespace Elsa.Activities.Telnyx.Client.Models
string? ValidDigits
);
public record GatherUsingSpeakRequest(
string? ClientState,
string? CommandId,
string Language,
string Voice,
string Payload,
string? PayloadType,
string? ServiceLevel,
int? InterDigitTimeoutMillis,
int? MaximumDigits,
int? MaximumTries,
int? MinimumDigits,
string? TerminatingDigit,
int? TimeoutMillis,
string? ValidDigits
);
public record TransferCallRequest(
string To,
string? From,
@ -92,9 +109,9 @@ namespace Elsa.Activities.Telnyx.Client.Models
string Voice,
string Payload,
string? PayloadType,
string? ServiceLevel,
string? ClientState,
string? CommandId,
string? ServiceLevel,
string? Stop
);
}

3
src/activities/Elsa.Activities.Telnyx/Client/Services/ICallsApi.cs
View file

@ -22,6 +22,9 @@ namespace Elsa.Activities.Telnyx.Client.Services
[Post("/v2/calls/{callControlId}/actions/gather_using_audio")]
Task GatherUsingAudioAsync(string callControlId, [Body]GatherUsingAudioRequest request, CancellationToken cancellationToken = default);
[Post("/v2/calls/{callControlId}/actions/gather_using_speak")]
Task GatherUsingSpeakAsync(string callControlId, [Body]GatherUsingSpeakRequest request, CancellationToken cancellationToken = default);
[Post("/v2/calls/{callControlId}/actions/bridge")]
Task BridgeCallsAsync(string callControlId, [Body]BridgeCallsRequest request, CancellationToken cancellationToken = default);