BotSharp/src/Plugins/BotSharp.Plugin.Twilio/Interfaces/ITwilioSessionHook.cs at 0159c356619be68ca29519c086a50fa9067520e1 · hchen2020/BotSharp · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
using BotSharp.Abstraction.Realtime.Models;
using BotSharp.Plugin.Twilio.Models;
using Task = System.Threading.Tasks.Task;

namespace BotSharp.Plugin.Twilio.Interfaces;

public interface ITwilioSessionHook
{
    /// <summary>
    /// Before session creating
    /// </summary>
    /// <param name="request"></param>
    /// <param name="response"></param>
    /// <returns></returns>
    Task OnSessionCreating(ConversationalVoiceRequest request, ConversationalVoiceResponse response)
        => Task.CompletedTask;

    /// <summary>
    /// On session created
    /// </summary>
    /// <param name="request"></param>
    /// <param name="response"></param>
    /// <returns></returns>
    Task OnSessionCreated(ConversationalVoiceRequest request)
        => Task.CompletedTask;

    Task OnStreamingStarted(RealtimeHubConnection conn)
        => Task.CompletedTask;

    /// <summary>
    /// On received user message
    /// </summary>
    /// <param name="request"></param>
    /// <param name="response"></param>
    /// <returns></returns>
    Task OnReceivedUserMessage(ConversationalVoiceRequest request)
        => Task.CompletedTask;

    /// <summary>
    /// Waiting user response
    /// </summary>
    /// <param name="request"></param>
    /// <param name="response"></param>
    /// <returns></returns>
    Task OnWaitingUserResponse(ConversationalVoiceRequest request, ConversationalVoiceResponse response)
        => Task.CompletedTask;

    /// <summary>
    /// Waiting agent response
    /// </summary>
    /// <param name="request"></param>
    /// <param name="response"></param>
    /// <returns></returns>
    Task OnWaitingAgentResponse(ConversationalVoiceRequest request, ConversationalVoiceResponse response)
        => Task.CompletedTask;

    /// <summary>
    /// Before agent responsing
    /// </summary>
    /// <param name="request"></param>
    /// <param name="response"></param>
    /// <returns></returns>
    Task OnAgentResponsing(ConversationalVoiceRequest request, ConversationalVoiceResponse response)
        => Task.CompletedTask;

    /// <summary>
    /// On agent hang up
    /// </summary>
    /// <param name="request"></param>
    /// <param name="response"></param>
    /// <returns></returns>
    Task OnAgentHangUp(ConversationalVoiceRequest request)
        => Task.CompletedTask;

    /// <summary>
    /// Before agent transferred
    /// </summary>
    /// <param name="request"></param>
    /// <param name="response"></param>
    /// <returns></returns>
    Task OnAgentTransferring(ConversationalVoiceRequest request, TwilioSetting settings)
    => Task.CompletedTask;

    /// <summary>
    /// Allow Twilio to reconnect when it's in streaming mode.
    /// </summary>
    /// <param name="message"></param>
    /// <returns></returns>
    Task<bool> ShouldReconnect(ConversationalVoiceRequest request, RoleDialogModel message)
        => Task.FromResult(false);
}