documentation has no mention of how to send a dial response

twilio / twilio-node

Node.js helper library

MIT License

1.41k stars 515 forks source link

documentation has no mention of how to send a dial response #13

Closed coolaj86 closed 7 years ago

coolaj86 commented 11 years ago

I'm trying to create a server that forwards the call with the twilio number in the callerId so that the person receiving the call knows it's a business call (and to answer appropriately).

The documentation makes no mention of TwimlResponse in relation to Dial, Number, callerId, record, etc... and just looking over the code it's unclear to me.

(The raw xml I tried responds with an application error, so I figured trying the node api response object would be a good idea)

coolaj86 commented 11 years ago

My suggestion would be to list the API like so

TwimlResponse#dial(number, attributes)

number - an internationally formatted phone number such as +15557778888 (US formatting also works, but is not recommended)
attributes - a hash that may contain
- callerId - a twillio number to show (if omitted, the original calling number is used)
- record - If true, both sides of the call will be recorded
- sendDigits - the extension to dial after the connection has been established

kwhinnery commented 11 years ago

Hmm, my main concern here would be documenting the semantics of TwiML in two places (main doc site and the helper library docs), and keeping the two in sync. I do document the TwimlResponse object and its intended functionality, but as you point out, I don't document the actual intended usage of TwiML.

I do see the utility of duplicating documentation here for the sake of convenience - I will keep this open and give it some thought (as well as allow others to weigh in on this issue in the meantime).

kwhinnery commented 10 years ago

This has been bouncing around a bit, but this is coming up often enough where I think it makes sense to duplicate the documentation here. We should at least enumerate the different nodes and how to use them, and provide links out to the official docs for all attributes.

jingming commented 7 years ago

@coolaj86 if this is still applicable, we have redesigned to our TwiML generation code to be much more developer friendly with docs describing each Verb! You can find the classes here: https://github.com/twilio/twilio-node/blob/master/lib/twiml/VoiceResponse.js and https://github.com/twilio/twilio-node/blob/master/lib/twiml/MessagingResponse.js