| [ Index ] |
PHP Cross Reference of Phabricator |
[Summary view] [Print] [Text view]
1 .. _api-rest: 2 3 ############################### 4 Twilio Rest Resources 5 ############################### 6 7 ************** 8 List Resources 9 ************** 10 11 .. phpautoclass:: Services_Twilio_ListResource 12 :filename: ../Services/Twilio/ListResource.php 13 :members: 14 15 All of the below classes inherit from the :php:class:`ListResource 16 <Services_Twilio_ListResource>`. 17 18 Accounts 19 =========== 20 21 .. phpautoclass:: Services_Twilio_Rest_Accounts 22 :filename: ../Services/Twilio/Rest/Accounts.php 23 :members: 24 25 AvailablePhoneNumbers 26 ======================== 27 28 .. php:class:: Services_Twilio_Rest_AvailablePhoneNumbers 29 30 For more information, see the `AvailablePhoneNumbers API Resource <http://www.twilio.com/docs/api/rest/available-phone-numbers#local>`_ documentation at twilio.com. 31 32 .. php:method:: getList($country, $type) 33 34 Get a list of available phone numbers. 35 36 :param string country: The 2-digit country code for numbers ('US', 'GB', 37 'CA') 38 :param string type: The type of phone number ('TollFree' or 'Local') 39 :return: An instance of the :php:class:`Services_Twilio_Rest_AvailablePhoneNumbers` resource. 40 41 .. php:attr:: available_phone_numbers 42 43 A list of :php:class:`Services_Twilio_Rest_AvailablePhoneNumber` instances. 44 45 .. php:attr:: uri 46 47 The uri representing this resource, relative to https://api.twilio.com. 48 49 50 Calls 51 ======= 52 53 .. php:class:: Services_Twilio_Rest_Calls 54 55 For more information, see the `Call List Resource <http://www.twilio.com/docs/api/rest/call#list>`_ documentation. 56 57 .. php:method:: create($from, $to, $url, params = array()) 58 59 Make an outgoing call 60 61 :param string $from: The phone number to use as the caller id. 62 :param string $to: The number to call formatted with a '+' and country code 63 :param string $url: The fully qualified URL that should be consulted when 64 the call connects. This value can also be an ApplicationSid. 65 :param array $params: An array of optional parameters for this call 66 67 The **$params** array can contain the following keys: 68 69 *Method* 70 The HTTP method Twilio should use when making its request to the above Url parameter's value. Defaults to POST. If an ApplicationSid parameter is present, this parameter is ignored. 71 72 *FallbackUrl* 73 A URL that Twilio will request if an error occurs requesting or executing the TwiML at Url. If an ApplicationSid parameter is present, this parameter is ignored. 74 75 *FallbackMethod* 76 The HTTP method that Twilio should use to request the FallbackUrl. Must be either GET or POST. Defaults to POST. If an ApplicationSid parameter is present, this parameter is ignored. 77 78 *StatusCallback* 79 A URL that Twilio will request when the call ends to notify your app. If an ApplicationSid parameter is present, this parameter is ignored. 80 81 *StatusCallbackMethod* 82 The HTTP method Twilio should use when requesting the above URL. Defaults to POST. If an ApplicationSid parameter is present, this parameter is ignored. 83 84 *SendDigits* 85 A string of keys to dial after connecting to the number. Valid digits in the string include: any digit (0-9), '#' and '*'. For example, if you connected to a company phone number, and wanted to dial extension 1234 and then the pound key, use SendDigits=1234#. Remember to URL-encode this string, since the '#' character has special meaning in a URL. 86 87 *IfMachine* 88 Tell Twilio to try and determine if a machine (like voicemail) or a human has answered the call. Possible values are Continue and Hangup. See the answering machines section below for more info. 89 90 *Timeout* 91 The integer number of seconds that Twilio should allow the phone to ring before assuming there is no answer. Default is 60 seconds, the maximum is 999 seconds. Note, you could set this to a low value, such as 15, to hangup before reaching an answering machine or voicemail. 92 93 CredentialListMappings 94 ========================= 95 96 .. phpautoclass:: Services_Twilio_Rest_CredentialListMappings 97 :filename: ../Services/Twilio/Rest/CredentialListMappings.php 98 :members: 99 100 101 CredentialLists 102 ================= 103 104 .. phpautoclass:: Services_Twilio_Rest_CredentialLists 105 :filename: ../Services/Twilio/Rest/CredentialLists.php 106 :members: 107 108 Credentials 109 ============== 110 111 .. phpautoclass:: Services_Twilio_Rest_Credentials 112 :filename: ../Services/Twilio/Rest/Credentials.php 113 :members: 114 115 Domains 116 ========== 117 118 .. phpautoclass:: Services_Twilio_Rest_Domains 119 :filename: ../Services/Twilio/Rest/Domains.php 120 :members: 121 122 123 IncomingPhoneNumbers 124 ======================== 125 126 .. phpautoclass:: Services_Twilio_Rest_IncomingPhoneNumbers,Services_Twilio_Rest_Local,Services_Twilio_Rest_Mobile,Services_Twilio_Rest_TollFree 127 :filename: ../Services/Twilio/Rest/IncomingPhoneNumbers.php 128 :members: 129 130 IpAccessControlListMappings 131 ============================== 132 133 .. phpautoclass:: Services_Twilio_Rest_IpAccessControlListMappings 134 :filename: ../Services/Twilio/Rest/IpAccessControlListMappings.php 135 :members: 136 137 IpAccessControlLists 138 ======================= 139 140 .. phpautoclass:: Services_Twilio_Rest_IpAccessControlLists 141 :filename: ../Services/Twilio/Rest/IpAccessControlLists.php 142 :members: 143 144 IpAddresses 145 ======================= 146 147 .. phpautoclass:: Services_Twilio_Rest_IpAddresses 148 :filename: ../Services/Twilio/Rest/IpAddresses.php 149 :members: 150 151 Media 152 ====== 153 154 .. phpautoclass:: Services_Twilio_Rest_Media 155 :filename: ../Services/Twilio/Rest/Media.php 156 :members: 157 158 Members 159 =========== 160 161 .. php:class:: Services_Twilio_Rest_Members 162 163 For more information, including a list of filter parameters, see the `Member List Resource <http://www.twilio.com/docs/api/rest/member#list>`_ documentation. 164 165 .. php:method:: front() 166 167 Return the :php:class:`Services_Twilio_Rest_Member` at the front of the 168 queue. 169 170 Messages 171 ======== 172 173 .. phpautoclass:: Services_Twilio_Rest_Messages 174 :filename: ../Services/Twilio/Rest/Messages.php 175 :members: 176 177 Queues 178 =========== 179 180 .. php:class:: Services_Twilio_Rest_Queues 181 182 For more information, including a list of filter parameters, see the 183 `Queues List Resource <http://www.twilio.com/docs/api/rest/queues#list>`_ 184 documentation. 185 186 .. php:method:: create($friendly_name, $params = array()) 187 188 Create a new :php:class:`Services_Twilio_Rest_Queue`. 189 190 :param string $friendly_name: The name of the new Queue. 191 :param array $params: An array of optional parameters and their values, 192 like `MaxSize`. 193 :returns: A new :php:class:`Services_Twilio_Rest_Queue` 194 195 196 UsageRecords 197 ============== 198 199 .. php:class:: Services_Twilio_Rest_UsageRecords 200 201 For more information, including a list of filter parameters, see the `UsageRecords List Resource <http://www.twilio.com/docs/api/rest/usage-records#list>`_ documentation. 202 203 .. php:method:: getCategory($category) 204 205 Return the single UsageRecord corresponding to this category of usage. 206 Valid only for the `Records`, `Today`, `Yesterday`, `ThisMonth`, 207 `LastMonth` and `AllTime` resources. 208 209 :param string $category: The category to retrieve a usage record for. For a full list of valid categories, see the full `Usage Category documentation <http://www.twilio.com/docs/api/rest/usage-records#usage-all-categories>`_. 210 :returns: :php:class:`Services_Twilio_Rest_UsageRecord` A single usage record 211 212 UsageTriggers 213 ============= 214 215 .. php:class:: Services_Twilio_Rest_UsageTriggers 216 217 For more information, including a list of filter parameters, see the `UsageTriggers List Resource <http://www.twilio.com/docs/api/rest/usage-triggers#list>`_ documentation. 218 219 .. php:method:: create($category, $value, $url, $params = array()) 220 221 Create a new UsageTrigger. 222 223 :param string $category: The category of usage to fire a trigger for. A full list of categories can be found in the `Usage Categories documentation <http://www.twilio.com/docs/api/rest/usage-records#usage-categories>`_. 224 :param string $value: Fire the trigger when usage crosses this value. 225 :param string $url: The URL to request when the trigger fires. 226 :param array $params: Optional parameters for this trigger. A full list of parameters can be found in the `Usage Trigger documentation <http://www.twilio.com/docs/api/rest/usage-triggers#list-post-optional-parameters>`_. 227 :returns: :php:class:`Services_Twilio_Rest_UsageTrigger` The created trigger. 228 229 230 ******************** 231 Instance Resources 232 ******************** 233 234 .. phpautoclass:: Services_Twilio_InstanceResource 235 :filename: ../Services/Twilio/InstanceResource.php 236 :members: 237 238 Below you will find a list of objects created by interacting with the Twilio 239 API, and the methods and properties that can be called on them. These are 240 derived from the :php:class:`ListResource <Services_Twilio_ListResource>` and 241 :php:class:`InstanceResource <Services_Twilio_InstanceResource>` above. 242 243 244 Account 245 ======== 246 247 .. php:class:: Services_Twilio_Rest_Account 248 249 For more information, see the `Account Instance Resource <http://www.twilio.com/docs/api/rest/account#instance>`_ documentation. 250 251 .. php:method:: update($params) 252 253 Update the account 254 255 The **$params** array is the same as in :php:meth:`Services_Twilio_Rest_Accounts::create` 256 257 .. php:attr:: sid 258 259 A 34 character string that uniquely identifies this account. 260 261 .. php:attr:: date_created 262 263 The date that this account was created, in GMT in RFC 2822 format 264 265 .. php:attr:: date_updated 266 267 The date that this account was last updated, in GMT in RFC 2822 format. 268 269 .. php:attr:: friendly_name 270 271 A human readable description of this account, up to 64 characters long. By default the FriendlyName is your email address. 272 273 .. php:attr:: status 274 275 The status of this account. Usually active, but can be suspended if you've been bad, or closed if you've been horrible. 276 277 .. php:attr:: auth_token 278 279 The authorization token for this account. This token should be kept a secret, so no sharing. 280 281 Application 282 =========== 283 284 .. php:class:: Services_Twilio_Rest_Application 285 286 For more information, see the `Application Instance Resource <http://www.twilio.com/docs/api/rest/applications#instance>`_ documentation. 287 288 .. php:attr:: sid 289 290 A 34 character string that uniquely idetifies this resource. 291 292 .. php:attr:: date_created 293 294 The date that this resource was created, given as GMT RFC 2822 format. 295 296 .. php:attr:: date_updated 297 298 The date that this resource was last updated, given as GMT RFC 2822 format. 299 300 .. php:attr:: friendly_name 301 302 A human readable descriptive text for this resource, up to 64 characters long. By default, the FriendlyName is a nicely formatted version of the phone number. 303 304 .. php:attr:: account_sid 305 306 The unique id of the Account responsible for this phone number. 307 308 .. php:attr:: api_version 309 310 Calls to this phone number will start a new TwiML session with this API version. 311 312 .. php:attr:: voice_caller_id_lookup 313 314 Look up the caller's caller-ID name from the CNAM database (additional charges apply). Either true or false. 315 316 .. php:attr:: voice_url 317 318 The URL Twilio will request when this phone number receives a call. 319 320 .. php:attr:: voice_method 321 322 The HTTP method Twilio will use when requesting the above Url. Either GET or POST. 323 324 .. php:attr:: voice_fallback_url 325 326 The URL that Twilio will request if an error occurs retrieving or executing the TwiML requested by Url. 327 328 .. php:attr:: voice_fallback_method 329 330 The HTTP method Twilio will use when requesting the VoiceFallbackUrl. Either GET or POST. 331 332 .. php:attr:: status_callback 333 334 The URL that Twilio will request to pass status parameters (such as call ended) to your application. 335 336 .. php:attr:: status_callback_method 337 338 The HTTP method Twilio will use to make requests to the StatusCallback URL. Either GET or POST. 339 340 .. php:attr:: sms_url 341 342 The URL Twilio will request when receiving an incoming SMS message to this number. 343 344 .. php:attr:: sms_method 345 346 The HTTP method Twilio will use when making requests to the SmsUrl. Either GET or POST. 347 348 .. php:attr:: sms_fallback_url 349 350 The URL that Twilio will request if an error occurs retrieving or executing the TwiML from SmsUrl. 351 352 .. php:attr:: sms_fallback_method 353 354 The HTTP method Twilio will use when requesting the above URL. Either GET or POST. 355 356 .. php:attr:: uri 357 358 The URI for this resource, relative to https://api.twilio.com. 359 360 AvailablePhoneNumber 361 ======================== 362 363 .. php:class:: Services_Twilio_Rest_AvailablePhoneNumber 364 365 For more information, see the `AvailablePhoneNumber Instance Resource <http://www.twilio.com/docs/api/rest/available-phone-numbers#instance>`_ documentation. 366 367 .. php:attr:: friendly_name 368 369 A nicely-formatted version of the phone number. 370 371 .. php:attr:: phone_number 372 373 The phone number, in E.164 (i.e. "+1") format. 374 375 .. php:attr:: lata 376 377 The LATA of this phone number. 378 379 .. php:attr:: rate_center 380 381 The rate center of this phone number. 382 383 .. php:attr:: latitude 384 385 The latitude coordinate of this phone number. 386 387 .. php:attr:: longitude 388 389 The longitude coordinate of this phone number. 390 391 .. php:attr:: region 392 393 The two-letter state or province abbreviation of this phone number. 394 395 .. php:attr:: postal_code 396 397 The postal (zip) code of this phone number. 398 399 .. php:attr:: iso_country 400 401 Call 402 ==== 403 404 .. phpautoclass:: Services_Twilio_Rest_Call 405 :filename: ../Services/Twilio/Rest/Call.php 406 :members: 407 408 CallerId 409 ============ 410 411 .. php:class:: Services_Twilio_Rest_OutgoingCallerId 412 413 For more information, see the `OutgoingCallerId Instance Resource <http://www.twilio.com/docs/api/rest/outgoing-caller-ids#instance>`_ documentation. 414 415 .. php:attr:: sid 416 417 A 34 character string that uniquely identifies this resource. 418 419 .. php:attr:: date_created 420 421 The date that this resource was created, given in RFC 2822 format. 422 423 .. php:attr:: date_updated 424 425 The date that this resource was last updated, given in RFC 2822 format. 426 427 .. php:attr:: friendly_name 428 429 A human readable descriptive text for this resource, up to 64 characters long. By default, the FriendlyName is a nicely formatted version of the phone number. 430 431 .. php:attr:: account_sid 432 433 The unique id of the Account responsible for this Caller Id. 434 435 .. php:attr:: phone_number 436 437 The incoming phone number. Formatted with a '+' and country code e.g., +16175551212 (E.164 format). 438 439 .. php:attr:: uri 440 441 The URI for this resource, relative to https://api.twilio.com. 442 443 Conference 444 ============= 445 446 .. php:class:: Services_Twilio_Rest_Conference 447 448 For more information, see the `Conference Instance Resource <http://www.twilio.com/docs/api/rest/conference#instance>`_ documentation. 449 450 .. php:attr:: sid 451 452 A 34 character string that uniquely identifies this conference. 453 454 .. php:attr:: friendly_name 455 456 A user provided string that identifies this conference room. 457 458 .. php:attr:: status 459 460 A string representing the status of the conference. May be init, in-progress, or completed. 461 462 .. php:attr:: date_created 463 464 The date that this conference was created, given as GMT in RFC 2822 format. 465 466 .. php:attr:: date_updated 467 468 The date that this conference was last updated, given as GMT in RFC 2822 format. 469 470 .. php:attr:: account_sid 471 472 The unique id of the Account responsible for creating this conference. 473 474 .. php:attr:: uri 475 476 The URI for this resource, relative to https://api.twilio.com. 477 478 .. php:attr:: participants 479 480 The :php:class:`Services_Twilio_Rest_Participants` instance, listing people currently in this conference 481 482 CredentialListMapping 483 ========================= 484 485 .. phpautoclass:: Services_Twilio_Rest_CredentialListMapping 486 :filename: ../Services/Twilio/Rest/CredentialListMapping.php 487 :members: 488 489 490 CredentialList 491 ================= 492 493 .. phpautoclass:: Services_Twilio_Rest_CredentialList 494 :filename: ../Services/Twilio/Rest/CredentialList.php 495 :members: 496 497 Credential 498 ============== 499 500 .. phpautoclass:: Services_Twilio_Rest_Credential 501 :filename: ../Services/Twilio/Rest/Credential.php 502 :members: 503 504 Domain 505 ========== 506 507 .. phpautoclass:: Services_Twilio_Rest_Domain 508 :filename: ../Services/Twilio/Rest/Domain.php 509 :members: 510 511 IncomingPhoneNumber 512 =================== 513 514 .. phpautoclass:: Services_Twilio_Rest_IncomingPhoneNumber 515 :filename: ../Services/Twilio/Rest/IncomingPhoneNumber.php 516 :members: 517 518 IpAccessControlListMapping 519 ============================== 520 521 .. phpautoclass:: Services_Twilio_Rest_IpAccessControlListMapping 522 :filename: ../Services/Twilio/Rest/IpAccessControlListMapping.php 523 :members: 524 525 IpAccessControlList 526 ======================= 527 528 .. phpautoclass:: Services_Twilio_Rest_IpAccessControlList 529 :filename: ../Services/Twilio/Rest/IpAccessControlList.php 530 :members: 531 532 IpAddress 533 ============== 534 .. phpautoclass:: Services_Twilio_Rest_IpAddress 535 :filename: ../Services/Twilio/Rest/IpAddress.php 536 :members: 537 538 539 Notification 540 ============= 541 542 .. php:class:: Services_Twilio_Rest_Notification 543 544 For more information, see the `Notification Instance Resource <http://www.twilio.com/docs/api/rest/notification#instance>`_ documentation. 545 546 .. php:attr:: sid 547 548 A 34 character string that uniquely identifies this resource. 549 550 .. php:attr:: date_created 551 552 The date that this resource was created, given in RFC 2822 format. 553 554 .. php:attr:: date_updated 555 556 The date that this resource was last updated, given in RFC 2822 format. 557 558 .. php:attr:: account_sid 559 560 The unique id of the Account responsible for this notification. 561 562 .. php:attr:: call_sid 563 564 CallSid is the unique id of the call during which the notification was generated. Empty if the notification was generated by the REST API without regard to a specific phone call. 565 566 .. php:attr:: api_version 567 568 The version of the Twilio in use when this notification was generated. 569 570 .. php:attr:: log 571 572 An integer log level corresponding to the type of notification: 0 is ERROR, 1 is WARNING. 573 574 .. php:attr:: error_code 575 576 A unique error code for the error condition. You can lookup errors, with possible causes and solutions, in our `Error Dictionary <http://www.twilio.com/docs/errors/reference>`_. 577 578 .. php:attr:: more_info 579 580 A URL for more information about the error condition. The URL is a page in our `Error Dictionary <http://www.twilio.com/docs/errors/reference>`_. 581 582 .. php:attr:: message_text 583 584 The text of the notification. 585 586 .. php:attr:: message_date 587 588 The date the notification was actually generated, given in RFC 2822 589 format. Due to buffering, this may be slightly different than the 590 DateCreated date. 591 592 .. php:attr:: request_url 593 594 The URL of the resource that generated the notification. If the 595 notification was generated during a phone call: This is the URL of the 596 resource on YOUR SERVER that caused the notification. If the notification 597 was generated by your use of the REST API: This is the URL of the REST 598 resource you were attempting to request on Twilio's servers. 599 600 .. php:attr:: request_method 601 602 The HTTP method in use for the request that generated the notification. If 603 the notification was generated during a phone call: The HTTP Method use to 604 request the resource on your server. If the notification was generated by 605 your use of the REST API: This is the HTTP method used in your request to 606 the REST resource on Twilio's servers. 607 608 .. php:attr:: request_variables 609 610 The Twilio-generated HTTP GET or POST variables sent to your server. Alternatively, if the notification was generated by the REST API, this field will include any HTTP POST or PUT variables you sent to the REST API. 611 612 .. php:attr:: response_headers 613 614 The HTTP headers returned by your server. 615 616 .. php:attr:: response_body 617 618 The HTTP body returned by your server. 619 620 .. php:attr:: uri 621 622 The URI for this resource, relative to https://api.twilio.com 623 624 Media 625 ======= 626 627 .. phpautoclass:: Services_Twilio_Rest_MediaInstance 628 :filename: ../Services/Twilio/Rest/MediaInstance.php 629 :members: 630 631 Member 632 ======= 633 634 .. php:class:: Services_Twilio_Rest_Member 635 636 For more information about available properties, see the `Member Instance Resource <http://www.twilio.com/docs/api/rest/member#instance>`_ documentation. 637 638 .. php:method:: dequeue($url, $method = 'POST') 639 640 Dequeue this member and immediately play the Twiml at the given ``$url``. 641 642 :param string $url: The Twiml URL to play for this member, after dequeuing them 643 :param string $method: The HTTP method to use when fetching the Twiml URL. Defaults to POST. 644 :return: The dequeued member 645 :rtype: :php:class:`Member <Services_Twilio_Rest_Member>` 646 647 648 Participant 649 ============= 650 651 .. php:class:: Services_Twilio_Rest_Participant 652 653 For more information, see the `Participant Instance Resource <http://www.twilio.com/docs/api/rest/participant#instance>`_ documentation. 654 655 .. php:attr:: call_sid 656 657 A 34 character string that uniquely identifies the call that is connected to this conference 658 659 .. php:attr:: conference_sid 660 661 A 34 character string that identifies the conference this participant is in 662 663 .. php:attr:: date_created 664 665 The date that this resource was created, given in RFC 2822 format. 666 667 .. php:attr:: date_updated 668 669 The date that this resource was last updated, given in RFC 2822 format. 670 671 .. php:attr:: account_sid 672 673 The unique id of the Account that created this conference 674 675 .. php:attr:: muted 676 677 true if this participant is currently muted. false otherwise. 678 679 .. php:attr:: start_conference_on_enter 680 681 Was the startConferenceOnEnter attribute set on this participant (true or false)? 682 683 .. php:attr:: end_conference_on_exit 684 685 Was the endConferenceOnExit attribute set on this participant (true or false)? 686 687 .. php:attr:: uri 688 689 The URI for this resource, relative to https://api.twilio.com. 690 691 Queue 692 ============ 693 694 .. php:class:: Services_Twilio_Rest_Queue 695 696 For more information about available properties of a queue, see the `Queue 697 Instance Resource <http://www.twilio.com/docs/api/rest/queue#instance>`_ 698 documentation. A Queue has one subresource, a list of 699 :php:class:`Services_Twilio_Rest_Members`. 700 701 Recording 702 ============= 703 704 .. php:class:: Services_Twilio_Rest_Recording 705 706 For more information, see the `Recording Instance Resource <http://www.twilio.com/docs/api/rest/recording#instance>`_ documentation. 707 708 .. php:attr:: sid 709 710 A 34 character string that uniquely identifies this resource. 711 712 .. php:attr:: date_created 713 714 The date that this resource was created, given in RFC 2822 format. 715 716 .. php:attr:: date_updated 717 718 The date that this resource was last updated, given in RFC 2822 format. 719 720 .. php:attr:: account_sid 721 722 The unique id of the Account responsible for this recording. 723 724 .. php:attr:: call_sid 725 726 The call during which the recording was made. 727 728 .. php:attr:: duration 729 730 The length of the recording, in seconds. 731 732 .. php:attr:: api_version 733 734 The version of the API in use during the recording. 735 736 .. php:attr:: uri 737 738 The URI for this resource, relative to https://api.twilio.com 739 740 .. php:attr:: subresource_uris 741 742 The list of subresources under this account 743 744 .. php:attr:: formats 745 746 A dictionary of the audio formats available for this recording 747 748 .. code-block:: php 749 750 array( 751 'wav' => 'https://api.twilio.com/path/to/recording.wav', 752 'mp3' => 'https://api.twilio.com/path/to/recording.mp3', 753 ) 754 755 Message 756 ======= 757 758 .. phpautoclass:: Services_Twilio_Rest_Message 759 :filename: ../Services/Twilio/Rest/Message.php 760 :members: 761 762 SmsMessage 763 =========== 764 765 .. php:class:: Services_Twilio_Rest_SmsMessage 766 767 For more information, see the `SMS Message Instance Resource <http://www.twilio.com/docs/api/rest/sms#instance>`_ documentation. 768 769 .. php:attr:: sid 770 771 A 34 character string that uniquely identifies this resource. 772 773 .. php:attr:: date_created 774 775 The date that this resource was created, given in RFC 2822 format. 776 777 .. php:attr:: date_updated 778 779 The date that this resource was last updated, given in RFC 2822 format. 780 781 .. php:attr:: date_sent 782 783 The date that the SMS was sent, given in RFC 2822 format. 784 785 .. php:attr:: account_sid 786 787 The unique id of the Account that sent this SMS message. 788 789 .. php:attr:: from 790 791 The phone number that initiated the message in E.164 format. For incoming messages, this will be the remote phone. For outgoing messages, this will be one of your Twilio phone numbers. 792 793 .. php:attr:: to 794 795 The phone number that received the message in E.164 format. For incoming messages, this will be one of your Twilio phone numbers. For outgoing messages, this will be the remote phone. 796 797 .. php:attr:: body 798 799 The text body of the SMS message. Up to 160 characters long. 800 801 .. php:attr:: status 802 803 The status of this SMS message. Either queued, sending, sent, or failed. 804 805 .. php:attr:: direction 806 807 The direction of this SMS message. ``incoming`` for incoming messages, 808 ``outbound-api`` for messages initiated via the REST API, ``outbound-call`` for 809 messages initiated during a call or ``outbound-reply`` for messages initiated in 810 response to an incoming SMS. 811 812 .. php:attr:: price 813 814 The amount billed for the message. 815 816 .. php:attr:: api_version 817 818 The version of the Twilio API used to process the SMS message. 819 820 .. php:attr:: uri 821 822 The URI for this resource, relative to https://api.twilio.com 823 824 825 Transcription 826 ================== 827 828 .. php:class:: Services_Twilio_Rest_Transcription 829 830 For more information, see the `Transcription Instance Resource <http://www.twilio.com/docs/api/rest/transcription#instance>`_ documentation. 831 832 .. php:attr:: sid 833 834 A 34 character string that uniquely identifies this resource. 835 836 .. php:attr:: date_created 837 838 The date that this resource was created, given in RFC 2822 format. 839 840 .. php:attr:: date_updated 841 842 The date that this resource was last updated, given in RFC 2822 format. 843 844 .. php:attr:: account_sid 845 846 The unique id of the Account responsible for this transcription. 847 848 .. php:attr:: status 849 850 A string representing the status of the transcription: ``in-progress``, ``completed`` or ``failed``. 851 852 .. php:attr:: recording_sid 853 854 The unique id of the Recording this Transcription was made of. 855 856 .. php:attr:: duration 857 858 The duration of the transcribed audio, in seconds. 859 860 .. php:attr:: transcription_text 861 862 The text content of the transcription. 863 864 .. php:attr:: price 865 866 The charge for this transcript in USD. Populated after the transcript is completed. Note, this value may not be immediately available. 867 868 .. php:attr:: uri 869 870 The URI for this resource, relative to https://api.twilio.com 871 872
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated: Sun Nov 30 09:20:46 2014 | Cross-referenced by PHPXref 0.7.1 |