Call Flow Customization

1
#!/usr/bin/env python3
2
from signalwire_agents import AgentBase
3
4
5
class RingbackAgent(AgentBase):
6
    """Agent that plays ringback tone before answering."""
7
8
    def __init__(self):
9
        super().__init__(name="ringback", port=3000)
10
11
        # Play US ringback tone before answering
12
        # IMPORTANT: auto_answer=False prevents play from answering the call
13
        self.add_pre_answer_verb("play", {
14
            "urls": ["ring:us"],
15
            "auto_answer": False
16
        })
17
18
        # Configure AI
19
        self.add_language("English", "en-US", "rime.spore")
20
        self.prompt_add_section("Role", "You are a helpful assistant.")
21
22
23
if __name__ == "__main__":
24
    agent = RingbackAgent()
25
    agent.run()

1
#!/usr/bin/env python3
2
from signalwire_agents import AgentBase
3
4
5
class WelcomeAgent(AgentBase):
6
    """Agent that plays welcome message before AI."""
7
8
    def __init__(self):
9
        super().__init__(name="welcome", port=3000)
10
11
        # Play welcome announcement
12
        self.add_post_answer_verb("play", {
13
            "url": "say:Thank you for calling Acme Corporation. "
14
                   "Your call may be recorded for quality assurance."
15
        })
16
17
        # Brief pause before AI speaks
18
        self.add_post_answer_verb("sleep", {"time": 500})
19
20
        # Configure AI
21
        self.add_language("English", "en-US", "rime.spore")
22
        self.prompt_add_section(
23
            "Role",
24
            "You are a customer service representative. "
25
            "The caller has just heard the welcome message."
26
        )
27
28
29
if __name__ == "__main__":
30
    agent = WelcomeAgent()
31
    agent.run()

1
#!/usr/bin/env python3
2
from signalwire_agents import AgentBase
3
4
5
class SurveyAgent(AgentBase):
6
    """Agent that logs call outcome after conversation."""
7
8
    def __init__(self):
9
        super().__init__(name="survey", port=3000)
10
11
        # Configure AI
12
        self.add_language("English", "en-US", "rime.spore")
13
        self.prompt_add_section("Role", "You are a support agent.")
14
15
        # After AI ends, log the call and hang up
16
        self.add_post_ai_verb("request", {
17
            "url": "https://api.example.com/call-complete",
18
            "method": "POST"
19
        })
20
        self.add_post_ai_verb("hangup", {})
21
22
23
if __name__ == "__main__":
24
    agent = SurveyAgent()
25
    agent.run()

1
#!/usr/bin/env python3
2
from signalwire_agents import AgentBase
3
4
5
class CallFlowAgent(AgentBase):
6
    """Agent demonstrating complete call flow customization."""
7
8
    def __init__(self):
9
        super().__init__(name="call-flow", port=3000)
10
11
        # PRE-ANSWER: Ringback tone
12
        self.add_pre_answer_verb("play", {
13
            "urls": ["ring:us"],
14
            "auto_answer": False
15
        })
16
17
        # POST-ANSWER: Welcome and disclaimer
18
        self.add_post_answer_verb("play", {
19
            "url": "say:Welcome to Acme Corporation."
20
        })
21
        self.add_post_answer_verb("play", {
22
            "url": "say:This call may be recorded for quality assurance."
23
        })
24
        self.add_post_answer_verb("sleep", {"time": 500})
25
26
        # Configure AI
27
        self.add_language("English", "en-US", "rime.spore")
28
        self.prompt_add_section(
29
            "Role",
30
            "You are a friendly customer service representative. "
31
            "The caller has just heard the welcome message."
32
        )
33
        self.set_params({
34
            "end_of_speech_timeout": 1000,
35
            "attention_timeout": 10000
36
        })
37
38
        # POST-AI: Clean disconnect
39
        self.add_post_ai_verb("hangup", {})
40
41
42
if __name__ == "__main__":
43
    agent = CallFlowAgent()
44
    agent.run()

1
class ManualAnswerAgent(AgentBase):
2
    def __init__(self):
3
        # Disable auto-answer
4
        super().__init__(name="manual", port=3000, auto_answer=False)
5
6
        # Pre-answer: Play ringback
7
        self.add_pre_answer_verb("play", {
8
            "urls": ["ring:us"],
9
            "auto_answer": False
10
        })
11
12
        # Note: Without auto_answer, the AI will start without
13
        # explicitly answering. Use add_answer_verb() if you need
14
        # to answer at a specific point.

1
# Set max call duration to 1 hour
2
agent.add_answer_verb({"max_duration": 3600})

1
class DynamicFlowAgent(AgentBase):
2
    def __init__(self):
3
        super().__init__(name="dynamic", port=3000)
4
        self.add_language("English", "en-US", "rime.spore")
5
        self.prompt_add_section("Role", "You are a receptionist.")
6
7
        # VIP numbers get special treatment
8
        self.vip_numbers = ["+15551234567", "+15559876543"]
9
10
    def on_swml_request(self, request_data=None, callback_path=None, request=None):
11
        call_data = (request_data or {}).get("call", {})
12
        caller = call_data.get("from", "")
13
14
        if caller in self.vip_numbers:
15
            # VIP: No ringback, immediate welcome
16
            self.clear_pre_answer_verbs()
17
            self.add_post_answer_verb("play", {
18
                "url": "say:Welcome back, valued customer!"
19
            })
20
        else:
21
            # Regular caller: Ringback tone
22
            self.add_pre_answer_verb("play", {
23
                "urls": ["ring:us"],
24
                "auto_answer": False
25
            })

1
agent.clear_pre_answer_verbs()   # Remove all pre-answer verbs
2
agent.clear_post_answer_verbs()  # Remove all post-answer verbs
3
agent.clear_post_ai_verbs()      # Remove all post-AI verbs

1
agent = AgentBase(name="chained", port=3000)
2
agent.add_pre_answer_verb("play", {"urls": ["ring:us"], "auto_answer": False}) \
3
     .add_post_answer_verb("play", {"url": "say:Welcome"}) \
4
     .add_post_answer_verb("sleep", {"time": 500}) \
5
     .add_post_ai_verb("hangup", {})