langchain_community.utilities.twilio
.TwilioAPIWrapper¶
- class langchain_community.utilities.twilio.TwilioAPIWrapper[source]¶
Bases:
BaseModel
Messaging Client using Twilio.
To use, you should have the
twilio
python package installed, and the environment variablesTWILIO_ACCOUNT_SID
,TWILIO_AUTH_TOKEN
, andTWILIO_FROM_NUMBER
, or pass account_sid, auth_token, and from_number as named parameters to the constructor.Example
from langchain_community.utilities.twilio import TwilioAPIWrapper twilio = TwilioAPIWrapper( account_sid="ACxxx", auth_token="xxx", from_number="+10123456789" ) twilio.run('test', '+12484345508')
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
- param account_sid: Optional[str] = None¶
Twilio account string identifier.
- param auth_token: Optional[str] = None¶
Twilio auth token.
- param from_number: Optional[str] = None¶
A Twilio phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, an [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), or a [Channel Endpoint address](https://www.twilio.com/docs/sms/channels#channel-addresses) that is enabled for the type of message you want to send. Phone numbers or [short codes](https://www.twilio.com/docs/sms/api/short-code) purchased from Twilio also work here. You cannot, for example, spoof messages from a private cell phone number. If you are using messaging_service_sid, this parameter must be empty.
- run(body: str, to: str) str [source]¶
Run body through Twilio and respond with message sid.
- Parameters
body (str) – The text of the message you want to send. Can be up to 1,600 characters in length.
to (str) – The destination phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format for SMS/MMS or [Channel user address](https://www.twilio.com/docs/sms/channels#channel-addresses) for other 3rd-party channels.
- Return type
str