TwilioAgent's receive_text and receive_call options are poorly documented.

[virtadpt]

The online documentation for the TwilioAgent does not seem complete. The use case for the receive_call option isn't fully documented; what it does and why it might be useful are not specified. The receive_text option is not documented at all (though it could be inferred that this is so that the agent could receive text messages for processing this may not be correct).

Additionally, it is not certain what the value of server_url would be if Huginn is behind a proxy of some kind (such as Nginx). It seems reasonable that omitting the port Huginn is running on behind the proxy might be the correct thing to do, but this may not be the case.

[cantino]

Did you figure out your issue? If so, a PR to update the docs would be awesome!

[virtadpt]

Maybe. I've got notes but I haven't actually tried to implement them yet. Let me do a few experiments, and if I'm right I will.

[virtadpt]

Okay, here's what I've got:

If Huginn is behind a web server of some kind (like Nginx), the value of server_url will be whatever the URL would be in the browser: https://huginn.example.com/. If HTTP authentication is enabled, a separate username and passphrase need to be set in the .htaccess file and added to the URL (ref ticket #815), like this: http://user:password@huginn.example.com/. Twilio's TwiML aplication configurations work with this fine.

TwilioAgent will accept as its message any of the following keys: {{message}}, {{text}}, or {{sms}}

receiver_cell must contain the phone number TwilioAgent will send a message to.

At least one of the keys receive_text and receive_call must be set. receive_text means that Twilio will send a text message. receive_call means that the message will be run through a speech synthesis system and the destination number will receive a phone call. Messages sent from free accounts will have a "Buy a real account" nag prepended to them.

[cantino]

Would it be worth writing this up on the wiki?

[virtadpt]

I think it would. I'll get on it.

[virtadpt]

https://github.com/cantino/huginn/wiki/Using-the-Twilio-Agent

[cantino]

Thanks! Are any parts of that worthy of also adding to the agent in a PR?

[virtadpt]

At the moment, no. I don't think so, anyway.

[cantino]

Okay, it seems like you've figured this out now and documented it, so I'm going to close the issue. Please reopen if more discussion is needed.