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 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546
|
# coding=utf-8
r"""
This code was generated by
\ / _ _ _| _ _
| (_)\/(_)(_|\/| |(/_ v1.0.0
/ /
"""
import json
from twilio.base.obsolete import deprecated_method
from twilio.twiml import (
TwiML,
format_language,
)
class VoiceResponse(TwiML):
""" <Response> TwiML for Voice """
def __init__(self, **kwargs):
super(VoiceResponse, self).__init__(**kwargs)
self.name = 'Response'
def connect(self, action=None, method=None, **kwargs):
"""
Create a <Connect> element
:param action: Action URL
:param method: Action URL method
:param kwargs: additional attributes
:returns: <Connect> element
"""
return self.nest(Connect(action=action, method=method, **kwargs))
def dial(self, number=None, action=None, method=None, timeout=None,
hangup_on_star=None, time_limit=None, caller_id=None, record=None,
trim=None, recording_status_callback=None,
recording_status_callback_method=None,
recording_status_callback_event=None, answer_on_bridge=None,
ring_tone=None, recording_track=None, sequential=None, **kwargs):
"""
Create a <Dial> element
:param number: Phone number to dial
:param action: Action URL
:param method: Action URL method
:param timeout: Time to wait for answer
:param hangup_on_star: Hangup call on star press
:param time_limit: Max time length
:param caller_id: Caller ID to display
:param record: Record the call
:param trim: Trim the recording
:param recording_status_callback: Recording status callback URL
:param recording_status_callback_method: Recording status callback URL method
:param recording_status_callback_event: Recording status callback events
:param answer_on_bridge: Preserve the ringing behavior of the inbound call until the Dialed call picks up
:param ring_tone: Ringtone allows you to override the ringback tone that Twilio will play back to the caller while executing the Dial
:param recording_track: To indicate which audio track should be recorded
:param sequential: Used to determine if child TwiML nouns should be dialed in order, one after the other (sequential) or dial all at once (parallel). Default is false, parallel
:param kwargs: additional attributes
:returns: <Dial> element
"""
return self.nest(Dial(
number=number,
action=action,
method=method,
timeout=timeout,
hangup_on_star=hangup_on_star,
time_limit=time_limit,
caller_id=caller_id,
record=record,
trim=trim,
recording_status_callback=recording_status_callback,
recording_status_callback_method=recording_status_callback_method,
recording_status_callback_event=recording_status_callback_event,
answer_on_bridge=answer_on_bridge,
ring_tone=ring_tone,
recording_track=recording_track,
sequential=sequential,
**kwargs
))
def echo(self, **kwargs):
"""
Create a <Echo> element
:param kwargs: additional attributes
:returns: <Echo> element
"""
return self.nest(Echo(**kwargs))
def enqueue(self, name=None, action=None, method=None, wait_url=None,
wait_url_method=None, workflow_sid=None, **kwargs):
"""
Create a <Enqueue> element
:param name: Friendly name
:param action: Action URL
:param method: Action URL method
:param wait_url: Wait URL
:param wait_url_method: Wait URL method
:param workflow_sid: TaskRouter Workflow SID
:param kwargs: additional attributes
:returns: <Enqueue> element
"""
return self.nest(Enqueue(
name=name,
action=action,
method=method,
wait_url=wait_url,
wait_url_method=wait_url_method,
workflow_sid=workflow_sid,
**kwargs
))
def gather(self, input=None, action=None, method=None, timeout=None,
speech_timeout=None, max_speech_time=None, profanity_filter=None,
finish_on_key=None, num_digits=None, partial_result_callback=None,
partial_result_callback_method=None, language=None, hints=None,
barge_in=None, debug=None, action_on_empty_result=None,
speech_model=None, enhanced=None, **kwargs):
"""
Create a <Gather> element
:param input: Input type Twilio should accept
:param action: Action URL
:param method: Action URL method
:param timeout: Time to wait to gather input
:param speech_timeout: Time to wait to gather speech input and it should be either auto or a positive integer.
:param max_speech_time: Max allowed time for speech input
:param profanity_filter: Profanity Filter on speech
:param finish_on_key: Finish gather on key
:param num_digits: Number of digits to collect
:param partial_result_callback: Partial result callback URL
:param partial_result_callback_method: Partial result callback URL method
:param language: Language to use
:param hints: Speech recognition hints
:param barge_in: Stop playing media upon speech
:param debug: Allow debug for gather
:param action_on_empty_result: Force webhook to the action URL event if there is no input
:param speech_model: Specify the model that is best suited for your use case
:param enhanced: Use enhanced speech model
:param kwargs: additional attributes
:returns: <Gather> element
"""
return self.nest(Gather(
input=input,
action=action,
method=method,
timeout=timeout,
speech_timeout=speech_timeout,
max_speech_time=max_speech_time,
profanity_filter=profanity_filter,
finish_on_key=finish_on_key,
num_digits=num_digits,
partial_result_callback=partial_result_callback,
partial_result_callback_method=partial_result_callback_method,
language=language,
hints=hints,
barge_in=barge_in,
debug=debug,
action_on_empty_result=action_on_empty_result,
speech_model=speech_model,
enhanced=enhanced,
**kwargs
))
def hangup(self, **kwargs):
"""
Create a <Hangup> element
:param kwargs: additional attributes
:returns: <Hangup> element
"""
return self.nest(Hangup(**kwargs))
def leave(self, **kwargs):
"""
Create a <Leave> element
:param kwargs: additional attributes
:returns: <Leave> element
"""
return self.nest(Leave(**kwargs))
def pause(self, length=None, **kwargs):
"""
Create a <Pause> element
:param length: Length in seconds to pause
:param kwargs: additional attributes
:returns: <Pause> element
"""
return self.nest(Pause(length=length, **kwargs))
def play(self, url=None, loop=None, digits=None, **kwargs):
"""
Create a <Play> element
:param url: Media URL
:param loop: Times to loop media
:param digits: Play DTMF tones for digits
:param kwargs: additional attributes
:returns: <Play> element
"""
return self.nest(Play(url=url, loop=loop, digits=digits, **kwargs))
def queue(self, name, url=None, method=None, reservation_sid=None,
post_work_activity_sid=None, **kwargs):
"""
Create a <Queue> element
:param name: Queue name
:param url: Action URL
:param method: Action URL method
:param reservation_sid: TaskRouter Reservation SID
:param post_work_activity_sid: TaskRouter Activity SID
:param kwargs: additional attributes
:returns: <Queue> element
"""
return self.nest(Queue(
name,
url=url,
method=method,
reservation_sid=reservation_sid,
post_work_activity_sid=post_work_activity_sid,
**kwargs
))
def record(self, action=None, method=None, timeout=None, finish_on_key=None,
max_length=None, play_beep=None, trim=None,
recording_status_callback=None,
recording_status_callback_method=None,
recording_status_callback_event=None, transcribe=None,
transcribe_callback=None, **kwargs):
"""
Create a <Record> element
:param action: Action URL
:param method: Action URL method
:param timeout: Timeout to begin recording
:param finish_on_key: Finish recording on key
:param max_length: Max time to record in seconds
:param play_beep: Play beep
:param trim: Trim the recording
:param recording_status_callback: Status callback URL
:param recording_status_callback_method: Status callback URL method
:param recording_status_callback_event: Recording status callback events
:param transcribe: Transcribe the recording
:param transcribe_callback: Transcribe callback URL
:param kwargs: additional attributes
:returns: <Record> element
"""
return self.nest(Record(
action=action,
method=method,
timeout=timeout,
finish_on_key=finish_on_key,
max_length=max_length,
play_beep=play_beep,
trim=trim,
recording_status_callback=recording_status_callback,
recording_status_callback_method=recording_status_callback_method,
recording_status_callback_event=recording_status_callback_event,
transcribe=transcribe,
transcribe_callback=transcribe_callback,
**kwargs
))
def redirect(self, url, method=None, **kwargs):
"""
Create a <Redirect> element
:param url: Redirect URL
:param method: Redirect URL method
:param kwargs: additional attributes
:returns: <Redirect> element
"""
return self.nest(Redirect(url, method=method, **kwargs))
def reject(self, reason=None, **kwargs):
"""
Create a <Reject> element
:param reason: Rejection reason
:param kwargs: additional attributes
:returns: <Reject> element
"""
return self.nest(Reject(reason=reason, **kwargs))
def say(self, message=None, voice=None, loop=None, language=None, **kwargs):
"""
Create a <Say> element
:param message: Message to say
:param voice: Voice to use
:param loop: Times to loop message
:param language: Message langauge
:param kwargs: additional attributes
:returns: <Say> element
"""
return self.nest(Say(message=message, voice=voice, loop=loop, language=language, **kwargs))
def sms(self, message, to=None, from_=None, action=None, method=None,
status_callback=None, **kwargs):
"""
Create a <Sms> element
:param message: Message body
:param to: Number to send message to
:param from: Number to send message from
:param action: Action URL
:param method: Action URL method
:param status_callback: Status callback URL
:param kwargs: additional attributes
:returns: <Sms> element
"""
return self.nest(Sms(
message,
to=to,
from_=from_,
action=action,
method=method,
status_callback=status_callback,
**kwargs
))
def pay(self, input=None, action=None, bank_account_type=None,
status_callback=None, status_callback_method=None, timeout=None,
max_attempts=None, security_code=None, postal_code=None,
min_postal_code_length=None, payment_connector=None,
payment_method=None, token_type=None, charge_amount=None, currency=None,
description=None, valid_card_types=None, language=None, **kwargs):
"""
Create a <Pay> element
:param input: Input type Twilio should accept
:param action: Action URL
:param bank_account_type: Bank account type for ach transactions. If set, payment method attribute must be provided and value should be set to ach-debit. defaults to consumer-checking
:param status_callback: Status callback URL
:param status_callback_method: Status callback method
:param timeout: Time to wait to gather input
:param max_attempts: Maximum number of allowed retries when gathering input
:param security_code: Prompt for security code
:param postal_code: Prompt for postal code and it should be true/false or default postal code
:param min_postal_code_length: Prompt for minimum postal code length
:param payment_connector: Unique name for payment connector
:param payment_method: Payment method to be used. defaults to credit-card
:param token_type: Type of token
:param charge_amount: Amount to process. If value is greater than 0 then make the payment else create a payment token
:param currency: Currency of the amount attribute
:param description: Details regarding the payment
:param valid_card_types: Comma separated accepted card types
:param language: Language to use
:param kwargs: additional attributes
:returns: <Pay> element
"""
return self.nest(Pay(
input=input,
action=action,
bank_account_type=bank_account_type,
status_callback=status_callback,
status_callback_method=status_callback_method,
timeout=timeout,
max_attempts=max_attempts,
security_code=security_code,
postal_code=postal_code,
min_postal_code_length=min_postal_code_length,
payment_connector=payment_connector,
payment_method=payment_method,
token_type=token_type,
charge_amount=charge_amount,
currency=currency,
description=description,
valid_card_types=valid_card_types,
language=language,
**kwargs
))
def prompt(self, for_=None, error_type=None, card_type=None, attempt=None,
**kwargs):
"""
Create a <Prompt> element
:param for_: Name of the payment source data element
:param error_type: Type of error
:param card_type: Type of the credit card
:param attempt: Current attempt count
:param kwargs: additional attributes
:returns: <Prompt> element
"""
return self.nest(Prompt(
for_=for_,
error_type=error_type,
card_type=card_type,
attempt=attempt,
**kwargs
))
def start(self, action=None, method=None, **kwargs):
"""
Create a <Start> element
:param action: Action URL
:param method: Action URL method
:param kwargs: additional attributes
:returns: <Start> element
"""
return self.nest(Start(action=action, method=method, **kwargs))
def stop(self, **kwargs):
"""
Create a <Stop> element
:param kwargs: additional attributes
:returns: <Stop> element
"""
return self.nest(Stop(**kwargs))
def refer(self, action=None, method=None, **kwargs):
"""
Create a <Refer> element
:param action: Action URL
:param method: Action URL method
:param kwargs: additional attributes
:returns: <Refer> element
"""
return self.nest(Refer(action=action, method=method, **kwargs))
class Refer(TwiML):
""" <Refer> TwiML Verb """
def __init__(self, **kwargs):
super(Refer, self).__init__(**kwargs)
self.name = 'Refer'
def sip(self, sip_url, **kwargs):
"""
Create a <Sip> element
:param sip_url: SIP URL
:param kwargs: additional attributes
:returns: <Sip> element
"""
return self.nest(ReferSip(sip_url, **kwargs))
@deprecated_method('sip')
def refer_sip(self, sip_url, **kwargs):
"""
Create a <Sip> element
:param sip_url: SIP URL
:param kwargs: additional attributes
:returns: <Sip> element
"""
return self.sip(sip_url, **kwargs)
class ReferSip(TwiML):
""" <Sip> TwiML Noun used in <Refer> """
def __init__(self, sip_url, **kwargs):
super(ReferSip, self).__init__(**kwargs)
self.name = 'Sip'
self.value = sip_url
class Stop(TwiML):
""" <Stop> TwiML Verb """
def __init__(self, **kwargs):
super(Stop, self).__init__(**kwargs)
self.name = 'Stop'
def stream(self, name=None, connector_name=None, url=None, track=None,
**kwargs):
"""
Create a <Stream> element
:param name: Friendly name given to the Stream
:param connector_name: Unique name for Stream Connector
:param url: URL of the remote service where the Stream is routed
:param track: Track to be streamed to remote service
:param kwargs: additional attributes
:returns: <Stream> element
"""
return self.nest(Stream(name=name, connector_name=connector_name, url=url, track=track, **kwargs))
def siprec(self, name=None, connector_name=None, track=None, **kwargs):
"""
Create a <Siprec> element
:param name: Friendly name given to SIPREC
:param connector_name: Unique name for Connector
:param track: Track to be streamed to remote service
:param kwargs: additional attributes
:returns: <Siprec> element
"""
return self.nest(Siprec(name=name, connector_name=connector_name, track=track, **kwargs))
class Siprec(TwiML):
""" <Siprec> TwiML Noun """
def __init__(self, **kwargs):
super(Siprec, self).__init__(**kwargs)
self.name = 'Siprec'
def parameter(self, name=None, value=None, **kwargs):
"""
Create a <Parameter> element
:param name: The name of the custom parameter
:param value: The value of the custom parameter
:param kwargs: additional attributes
:returns: <Parameter> element
"""
return self.nest(Parameter(name=name, value=value, **kwargs))
class Parameter(TwiML):
""" <Parameter> TwiML Noun """
def __init__(self, **kwargs):
super(Parameter, self).__init__(**kwargs)
self.name = 'Parameter'
class Stream(TwiML):
""" <Stream> TwiML Noun """
def __init__(self, **kwargs):
super(Stream, self).__init__(**kwargs)
self.name = 'Stream'
def parameter(self, name=None, value=None, **kwargs):
"""
Create a <Parameter> element
:param name: The name of the custom parameter
:param value: The value of the custom parameter
:param kwargs: additional attributes
:returns: <Parameter> element
"""
return self.nest(Parameter(name=name, value=value, **kwargs))
class Start(TwiML):
""" <Start> TwiML Verb """
def __init__(self, **kwargs):
super(Start, self).__init__(**kwargs)
self.name = 'Start'
def stream(self, name=None, connector_name=None, url=None, track=None,
**kwargs):
"""
Create a <Stream> element
:param name: Friendly name given to the Stream
:param connector_name: Unique name for Stream Connector
:param url: URL of the remote service where the Stream is routed
:param track: Track to be streamed to remote service
:param kwargs: additional attributes
:returns: <Stream> element
"""
return self.nest(Stream(name=name, connector_name=connector_name, url=url, track=track, **kwargs))
def siprec(self, name=None, connector_name=None, track=None, **kwargs):
"""
Create a <Siprec> element
:param name: Friendly name given to SIPREC
:param connector_name: Unique name for Connector
:param track: Track to be streamed to remote service
:param kwargs: additional attributes
:returns: <Siprec> element
"""
return self.nest(Siprec(name=name, connector_name=connector_name, track=track, **kwargs))
class Prompt(TwiML):
""" <Prompt> Twiml Verb """
def __init__(self, **kwargs):
super(Prompt, self).__init__(**kwargs)
self.name = 'Prompt'
def say(self, message=None, voice=None, loop=None, language=None, **kwargs):
"""
Create a <Say> element
:param message: Message to say
:param voice: Voice to use
:param loop: Times to loop message
:param language: Message langauge
:param kwargs: additional attributes
:returns: <Say> element
"""
return self.nest(Say(message=message, voice=voice, loop=loop, language=language, **kwargs))
def play(self, url=None, loop=None, digits=None, **kwargs):
"""
Create a <Play> element
:param url: Media URL
:param loop: Times to loop media
:param digits: Play DTMF tones for digits
:param kwargs: additional attributes
:returns: <Play> element
"""
return self.nest(Play(url=url, loop=loop, digits=digits, **kwargs))
def pause(self, length=None, **kwargs):
"""
Create a <Pause> element
:param length: Length in seconds to pause
:param kwargs: additional attributes
:returns: <Pause> element
"""
return self.nest(Pause(length=length, **kwargs))
class Pause(TwiML):
""" <Pause> TwiML Verb """
def __init__(self, **kwargs):
super(Pause, self).__init__(**kwargs)
self.name = 'Pause'
class Play(TwiML):
""" <Play> TwiML Verb """
def __init__(self, url=None, **kwargs):
super(Play, self).__init__(**kwargs)
self.name = 'Play'
if url:
self.value = url
class Say(TwiML):
""" <Say> TwiML Verb """
def __init__(self, message=None, **kwargs):
super(Say, self).__init__(**kwargs)
self.name = 'Say'
if message:
self.value = message
def break_(self, strength=None, time=None, **kwargs):
"""
Create a <Break> element
:param strength: Set a pause based on strength
:param time: Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms
:param kwargs: additional attributes
:returns: <Break> element
"""
return self.nest(SsmlBreak(strength=strength, time=time, **kwargs))
@deprecated_method('break_')
def ssml_break(self, strength=None, time=None, **kwargs):
"""
Create a <Break> element
:param strength: Set a pause based on strength
:param time: Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms
:param kwargs: additional attributes
:returns: <Break> element
"""
return self.break_(strength=strength, time=time, **kwargs)
def emphasis(self, words, level=None, **kwargs):
"""
Create a <Emphasis> element
:param words: Words to emphasize
:param level: Specify the degree of emphasis
:param kwargs: additional attributes
:returns: <Emphasis> element
"""
return self.nest(SsmlEmphasis(words, level=level, **kwargs))
@deprecated_method('emphasis')
def ssml_emphasis(self, words, level=None, **kwargs):
"""
Create a <Emphasis> element
:param words: Words to emphasize
:param level: Specify the degree of emphasis
:param kwargs: additional attributes
:returns: <Emphasis> element
"""
return self.emphasis(words, level=level, **kwargs)
def lang(self, words, xml_lang=None, **kwargs):
"""
Create a <Lang> element
:param words: Words to speak
:param xml:lang: Specify the language
:param kwargs: additional attributes
:returns: <Lang> element
"""
return self.nest(SsmlLang(words, xml_lang=xml_lang, **kwargs))
@deprecated_method('lang')
def ssml_lang(self, words, xml_lang=None, **kwargs):
"""
Create a <Lang> element
:param words: Words to speak
:param xml:lang: Specify the language
:param kwargs: additional attributes
:returns: <Lang> element
"""
return self.lang(words, xml_lang=xml_lang, **kwargs)
def p(self, words, **kwargs):
"""
Create a <P> element
:param words: Words to speak
:param kwargs: additional attributes
:returns: <P> element
"""
return self.nest(SsmlP(words, **kwargs))
@deprecated_method('p')
def ssml_p(self, words, **kwargs):
"""
Create a <P> element
:param words: Words to speak
:param kwargs: additional attributes
:returns: <P> element
"""
return self.p(words, **kwargs)
def phoneme(self, words, alphabet=None, ph=None, **kwargs):
"""
Create a <Phoneme> element
:param words: Words to speak
:param alphabet: Specify the phonetic alphabet
:param ph: Specifiy the phonetic symbols for pronunciation
:param kwargs: additional attributes
:returns: <Phoneme> element
"""
return self.nest(SsmlPhoneme(words, alphabet=alphabet, ph=ph, **kwargs))
@deprecated_method('phoneme')
def ssml_phoneme(self, words, alphabet=None, ph=None, **kwargs):
"""
Create a <Phoneme> element
:param words: Words to speak
:param alphabet: Specify the phonetic alphabet
:param ph: Specifiy the phonetic symbols for pronunciation
:param kwargs: additional attributes
:returns: <Phoneme> element
"""
return self.phoneme(words, alphabet=alphabet, ph=ph, **kwargs)
def prosody(self, words, volume=None, rate=None, pitch=None, **kwargs):
"""
Create a <Prosody> element
:param words: Words to speak
:param volume: Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB
:param rate: Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n%
:param pitch: Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n%
:param kwargs: additional attributes
:returns: <Prosody> element
"""
return self.nest(SsmlProsody(words, volume=volume, rate=rate, pitch=pitch, **kwargs))
@deprecated_method('prosody')
def ssml_prosody(self, words, volume=None, rate=None, pitch=None, **kwargs):
"""
Create a <Prosody> element
:param words: Words to speak
:param volume: Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB
:param rate: Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n%
:param pitch: Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n%
:param kwargs: additional attributes
:returns: <Prosody> element
"""
return self.prosody(words, volume=volume, rate=rate, pitch=pitch, **kwargs)
def s(self, words, **kwargs):
"""
Create a <S> element
:param words: Words to speak
:param kwargs: additional attributes
:returns: <S> element
"""
return self.nest(SsmlS(words, **kwargs))
@deprecated_method('s')
def ssml_s(self, words, **kwargs):
"""
Create a <S> element
:param words: Words to speak
:param kwargs: additional attributes
:returns: <S> element
"""
return self.s(words, **kwargs)
def say_as(self, words, interpret_as=None, role=None, **kwargs):
"""
Create a <Say-As> element
:param words: Words to be interpreted
:param interpret-as: Specify the type of words are spoken
:param role: Specify the format of the date when interpret-as is set to date
:param kwargs: additional attributes
:returns: <Say-As> element
"""
return self.nest(SsmlSayAs(words, interpret_as=interpret_as, role=role, **kwargs))
@deprecated_method('say_as')
def ssml_say_as(self, words, interpret_as=None, role=None, **kwargs):
"""
Create a <Say-As> element
:param words: Words to be interpreted
:param interpret-as: Specify the type of words are spoken
:param role: Specify the format of the date when interpret-as is set to date
:param kwargs: additional attributes
:returns: <Say-As> element
"""
return self.say_as(words, interpret_as=interpret_as, role=role, **kwargs)
def sub(self, words, alias=None, **kwargs):
"""
Create a <Sub> element
:param words: Words to be substituted
:param alias: Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation
:param kwargs: additional attributes
:returns: <Sub> element
"""
return self.nest(SsmlSub(words, alias=alias, **kwargs))
@deprecated_method('sub')
def ssml_sub(self, words, alias=None, **kwargs):
"""
Create a <Sub> element
:param words: Words to be substituted
:param alias: Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation
:param kwargs: additional attributes
:returns: <Sub> element
"""
return self.sub(words, alias=alias, **kwargs)
def w(self, words, role=None, **kwargs):
"""
Create a <W> element
:param words: Words to speak
:param role: Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning
:param kwargs: additional attributes
:returns: <W> element
"""
return self.nest(SsmlW(words, role=role, **kwargs))
@deprecated_method('w')
def ssml_w(self, words, role=None, **kwargs):
"""
Create a <W> element
:param words: Words to speak
:param role: Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning
:param kwargs: additional attributes
:returns: <W> element
"""
return self.w(words, role=role, **kwargs)
class SsmlW(TwiML):
""" Improving Pronunciation by Specifying Parts of Speech in <Say> """
def __init__(self, words, **kwargs):
super(SsmlW, self).__init__(**kwargs)
self.name = 'w'
self.value = words
class SsmlSub(TwiML):
""" Pronouncing Acronyms and Abbreviations in <Say> """
def __init__(self, words, **kwargs):
super(SsmlSub, self).__init__(**kwargs)
self.name = 'sub'
self.value = words
class SsmlSayAs(TwiML):
""" Controlling How Special Types of Words Are Spoken in <Say> """
def __init__(self, words, **kwargs):
super(SsmlSayAs, self).__init__(**kwargs)
self.name = 'say-as'
self.value = words
class SsmlS(TwiML):
""" Adding A Pause Between Sentences in <Say> """
def __init__(self, words, **kwargs):
super(SsmlS, self).__init__(**kwargs)
self.name = 's'
self.value = words
class SsmlProsody(TwiML):
""" Controling Volume, Speaking Rate, and Pitch in <Say> """
def __init__(self, words, **kwargs):
super(SsmlProsody, self).__init__(**kwargs)
self.name = 'prosody'
self.value = words
class SsmlPhoneme(TwiML):
""" Using Phonetic Pronunciation in <Say> """
def __init__(self, words, **kwargs):
super(SsmlPhoneme, self).__init__(**kwargs)
self.name = 'phoneme'
self.value = words
class SsmlP(TwiML):
""" Adding a Pause Between Paragraphs in <Say> """
def __init__(self, words, **kwargs):
super(SsmlP, self).__init__(**kwargs)
self.name = 'p'
self.value = words
class SsmlLang(TwiML):
""" Specifying Another Language for Specific Words in <Say> """
def __init__(self, words, **kwargs):
super(SsmlLang, self).__init__(**kwargs)
self.name = 'lang'
self.value = words
class SsmlEmphasis(TwiML):
""" Emphasizing Words in <Say> """
def __init__(self, words, **kwargs):
super(SsmlEmphasis, self).__init__(**kwargs)
self.name = 'emphasis'
self.value = words
class SsmlBreak(TwiML):
""" Adding a Pause in <Say> """
def __init__(self, **kwargs):
super(SsmlBreak, self).__init__(**kwargs)
self.name = 'break'
class Pay(TwiML):
""" <Pay> Twiml Verb """
def __init__(self, **kwargs):
super(Pay, self).__init__(**kwargs)
self.name = 'Pay'
def prompt(self, for_=None, error_type=None, card_type=None, attempt=None,
**kwargs):
"""
Create a <Prompt> element
:param for_: Name of the payment source data element
:param error_type: Type of error
:param card_type: Type of the credit card
:param attempt: Current attempt count
:param kwargs: additional attributes
:returns: <Prompt> element
"""
return self.nest(Prompt(
for_=for_,
error_type=error_type,
card_type=card_type,
attempt=attempt,
**kwargs
))
def parameter(self, name=None, value=None, **kwargs):
"""
Create a <Parameter> element
:param name: The name of the custom parameter
:param value: The value of the custom parameter
:param kwargs: additional attributes
:returns: <Parameter> element
"""
return self.nest(Parameter(name=name, value=value, **kwargs))
class Sms(TwiML):
""" <Sms> TwiML Noun """
def __init__(self, message, **kwargs):
super(Sms, self).__init__(**kwargs)
self.name = 'Sms'
self.value = message
class Reject(TwiML):
""" <Reject> TwiML Verb """
def __init__(self, **kwargs):
super(Reject, self).__init__(**kwargs)
self.name = 'Reject'
class Redirect(TwiML):
""" <Redirect> TwiML Verb """
def __init__(self, url, **kwargs):
super(Redirect, self).__init__(**kwargs)
self.name = 'Redirect'
self.value = url
class Record(TwiML):
""" <Record> TwiML Verb """
def __init__(self, **kwargs):
super(Record, self).__init__(**kwargs)
self.name = 'Record'
class Queue(TwiML):
""" <Queue> TwiML Noun """
def __init__(self, name, **kwargs):
super(Queue, self).__init__(**kwargs)
self.name = 'Queue'
self.value = name
class Leave(TwiML):
""" <Leave> TwiML Verb """
def __init__(self, **kwargs):
super(Leave, self).__init__(**kwargs)
self.name = 'Leave'
class Hangup(TwiML):
""" <Hangup> TwiML Verb """
def __init__(self, **kwargs):
super(Hangup, self).__init__(**kwargs)
self.name = 'Hangup'
class Gather(TwiML):
""" <Gather> TwiML Verb """
def __init__(self, **kwargs):
super(Gather, self).__init__(**kwargs)
self.name = 'Gather'
def say(self, message=None, voice=None, loop=None, language=None, **kwargs):
"""
Create a <Say> element
:param message: Message to say
:param voice: Voice to use
:param loop: Times to loop message
:param language: Message langauge
:param kwargs: additional attributes
:returns: <Say> element
"""
return self.nest(Say(message=message, voice=voice, loop=loop, language=language, **kwargs))
def pause(self, length=None, **kwargs):
"""
Create a <Pause> element
:param length: Length in seconds to pause
:param kwargs: additional attributes
:returns: <Pause> element
"""
return self.nest(Pause(length=length, **kwargs))
def play(self, url=None, loop=None, digits=None, **kwargs):
"""
Create a <Play> element
:param url: Media URL
:param loop: Times to loop media
:param digits: Play DTMF tones for digits
:param kwargs: additional attributes
:returns: <Play> element
"""
return self.nest(Play(url=url, loop=loop, digits=digits, **kwargs))
class Enqueue(TwiML):
""" <Enqueue> TwiML Noun """
def __init__(self, name=None, **kwargs):
super(Enqueue, self).__init__(**kwargs)
self.name = 'Enqueue'
if name:
self.value = name
def task(self, body, priority=None, timeout=None, **kwargs):
"""
Create a <Task> element
:param body: TaskRouter task attributes
:param priority: Task priority
:param timeout: Timeout associated with task
:param kwargs: additional attributes
:returns: <Task> element
"""
return self.nest(Task(body, priority=priority, timeout=timeout, **kwargs))
class Task(TwiML):
""" <Task> TwiML Noun """
def __init__(self, body, **kwargs):
super(Task, self).__init__(**kwargs)
self.name = 'Task'
self.value = body
class Echo(TwiML):
""" <Echo> TwiML Verb """
def __init__(self, **kwargs):
super(Echo, self).__init__(**kwargs)
self.name = 'Echo'
class Dial(TwiML):
""" <Dial> TwiML Verb """
def __init__(self, number=None, **kwargs):
super(Dial, self).__init__(**kwargs)
self.name = 'Dial'
if number:
self.value = number
def client(self, identity=None, url=None, method=None,
status_callback_event=None, status_callback=None,
status_callback_method=None, **kwargs):
"""
Create a <Client> element
:param identity: Client identity
:param url: Client URL
:param method: Client URL Method
:param status_callback_event: Events to trigger status callback
:param status_callback: Status Callback URL
:param status_callback_method: Status Callback URL Method
:param kwargs: additional attributes
:returns: <Client> element
"""
return self.nest(Client(
identity=identity,
url=url,
method=method,
status_callback_event=status_callback_event,
status_callback=status_callback,
status_callback_method=status_callback_method,
**kwargs
))
def conference(self, name, muted=None, beep=None,
start_conference_on_enter=None, end_conference_on_exit=None,
wait_url=None, wait_method=None, max_participants=None,
record=None, region=None, coach=None, trim=None,
status_callback_event=None, status_callback=None,
status_callback_method=None, recording_status_callback=None,
recording_status_callback_method=None,
recording_status_callback_event=None, event_callback_url=None,
jitter_buffer_size=None, participant_label=None, **kwargs):
"""
Create a <Conference> element
:param name: Conference name
:param muted: Join the conference muted
:param beep: Play beep when joining
:param start_conference_on_enter: Start the conference on enter
:param end_conference_on_exit: End the conferenceon exit
:param wait_url: Wait URL
:param wait_method: Wait URL method
:param max_participants: Maximum number of participants
:param record: Record the conference
:param region: Conference region
:param coach: Call coach
:param trim: Trim the conference recording
:param status_callback_event: Events to call status callback URL
:param status_callback: Status callback URL
:param status_callback_method: Status callback URL method
:param recording_status_callback: Recording status callback URL
:param recording_status_callback_method: Recording status callback URL method
:param recording_status_callback_event: Recording status callback events
:param event_callback_url: Event callback URL
:param jitter_buffer_size: Size of jitter buffer for participant
:param participant_label: A label for participant
:param kwargs: additional attributes
:returns: <Conference> element
"""
return self.nest(Conference(
name,
muted=muted,
beep=beep,
start_conference_on_enter=start_conference_on_enter,
end_conference_on_exit=end_conference_on_exit,
wait_url=wait_url,
wait_method=wait_method,
max_participants=max_participants,
record=record,
region=region,
coach=coach,
trim=trim,
status_callback_event=status_callback_event,
status_callback=status_callback,
status_callback_method=status_callback_method,
recording_status_callback=recording_status_callback,
recording_status_callback_method=recording_status_callback_method,
recording_status_callback_event=recording_status_callback_event,
event_callback_url=event_callback_url,
jitter_buffer_size=jitter_buffer_size,
participant_label=participant_label,
**kwargs
))
def number(self, phone_number, send_digits=None, url=None, method=None,
status_callback_event=None, status_callback=None,
status_callback_method=None, byoc=None, **kwargs):
"""
Create a <Number> element
:param phone_number: Phone Number to dial
:param send_digits: DTMF tones to play when the call is answered
:param url: TwiML URL
:param method: TwiML URL method
:param status_callback_event: Events to call status callback
:param status_callback: Status callback URL
:param status_callback_method: Status callback URL method
:param byoc: BYOC trunk SID (Beta)
:param kwargs: additional attributes
:returns: <Number> element
"""
return self.nest(Number(
phone_number,
send_digits=send_digits,
url=url,
method=method,
status_callback_event=status_callback_event,
status_callback=status_callback,
status_callback_method=status_callback_method,
byoc=byoc,
**kwargs
))
def queue(self, name, url=None, method=None, reservation_sid=None,
post_work_activity_sid=None, **kwargs):
"""
Create a <Queue> element
:param name: Queue name
:param url: Action URL
:param method: Action URL method
:param reservation_sid: TaskRouter Reservation SID
:param post_work_activity_sid: TaskRouter Activity SID
:param kwargs: additional attributes
:returns: <Queue> element
"""
return self.nest(Queue(
name,
url=url,
method=method,
reservation_sid=reservation_sid,
post_work_activity_sid=post_work_activity_sid,
**kwargs
))
def sim(self, sim_sid, **kwargs):
"""
Create a <Sim> element
:param sim_sid: SIM SID
:param kwargs: additional attributes
:returns: <Sim> element
"""
return self.nest(Sim(sim_sid, **kwargs))
def sip(self, sip_url, username=None, password=None, url=None, method=None,
status_callback_event=None, status_callback=None,
status_callback_method=None, **kwargs):
"""
Create a <Sip> element
:param sip_url: SIP URL
:param username: SIP Username
:param password: SIP Password
:param url: Action URL
:param method: Action URL method
:param status_callback_event: Status callback events
:param status_callback: Status callback URL
:param status_callback_method: Status callback URL method
:param kwargs: additional attributes
:returns: <Sip> element
"""
return self.nest(Sip(
sip_url,
username=username,
password=password,
url=url,
method=method,
status_callback_event=status_callback_event,
status_callback=status_callback,
status_callback_method=status_callback_method,
**kwargs
))
class Sip(TwiML):
""" <Sip> TwiML Noun """
def __init__(self, sip_url, **kwargs):
super(Sip, self).__init__(**kwargs)
self.name = 'Sip'
self.value = sip_url
class Sim(TwiML):
""" <Sim> TwiML Noun """
def __init__(self, sim_sid, **kwargs):
super(Sim, self).__init__(**kwargs)
self.name = 'Sim'
self.value = sim_sid
class Number(TwiML):
""" <Number> TwiML Noun """
def __init__(self, phone_number, **kwargs):
super(Number, self).__init__(**kwargs)
self.name = 'Number'
self.value = phone_number
class Conference(TwiML):
""" <Conference> TwiML Noun """
def __init__(self, name, **kwargs):
super(Conference, self).__init__(**kwargs)
self.name = 'Conference'
self.value = name
class Client(TwiML):
""" <Client> TwiML Noun """
def __init__(self, identity=None, **kwargs):
super(Client, self).__init__(**kwargs)
self.name = 'Client'
if identity:
self.value = identity
def identity(self, client_identity, **kwargs):
"""
Create a <Identity> element
:param client_identity: Identity of the client to dial
:param kwargs: additional attributes
:returns: <Identity> element
"""
return self.nest(Identity(client_identity, **kwargs))
def parameter(self, name=None, value=None, **kwargs):
"""
Create a <Parameter> element
:param name: The name of the custom parameter
:param value: The value of the custom parameter
:param kwargs: additional attributes
:returns: <Parameter> element
"""
return self.nest(Parameter(name=name, value=value, **kwargs))
class Identity(TwiML):
""" <Identity> TwiML Noun """
def __init__(self, client_identity, **kwargs):
super(Identity, self).__init__(**kwargs)
self.name = 'Identity'
self.value = client_identity
class Connect(TwiML):
""" <Connect> TwiML Verb """
def __init__(self, **kwargs):
super(Connect, self).__init__(**kwargs)
self.name = 'Connect'
def room(self, name, participant_identity=None, **kwargs):
"""
Create a <Room> element
:param name: Room name
:param participant_identity: Participant identity when connecting to the Room
:param kwargs: additional attributes
:returns: <Room> element
"""
return self.nest(Room(name, participant_identity=participant_identity, **kwargs))
def autopilot(self, name, **kwargs):
"""
Create a <Autopilot> element
:param name: Autopilot assistant sid or unique name
:param kwargs: additional attributes
:returns: <Autopilot> element
"""
return self.nest(Autopilot(name, **kwargs))
def stream(self, name=None, connector_name=None, url=None, track=None,
**kwargs):
"""
Create a <Stream> element
:param name: Friendly name given to the Stream
:param connector_name: Unique name for Stream Connector
:param url: URL of the remote service where the Stream is routed
:param track: Track to be streamed to remote service
:param kwargs: additional attributes
:returns: <Stream> element
"""
return self.nest(Stream(name=name, connector_name=connector_name, url=url, track=track, **kwargs))
class Autopilot(TwiML):
""" <Autopilot> TwiML Noun """
def __init__(self, name, **kwargs):
super(Autopilot, self).__init__(**kwargs)
self.name = 'Autopilot'
self.value = name
class Room(TwiML):
""" <Room> TwiML Noun """
def __init__(self, name, **kwargs):
super(Room, self).__init__(**kwargs)
self.name = 'Room'
self.value = name
|