====== Form Post ====== This interface uses a simple HTTP form post method used by many web based interfaces to send this information to a remote host. This remote host may be located on the local network or even on a remote server on the internet. The host may be written in any language suitable for the remote party, this includes PHP, C#, and C/C++. ===== Requirements ===== * PBX Link License. * DuVoice 5.20 or above. ===== Revision History ===== |**Version**|**Released**|**Changes**| |200|2018/01/30|- Added support for resources and other settings. | |102|2015/12/10|- Added support for sending call blocking / DND state. | |101|2013/10/15|- Changed the configuration dialog to support a timeout. \\ - Combined URL, Resource and TCP/IP port. \\ - MWI On/Off posting.| |100|2013/04/10|Initial release| ===== Configuration ===== Using System Configuration, configure the PBXLink for your profile as HTTP Post. {{:images:dev:httppost:httppost-form.png?direct|}} ^ Setting ^ Default ^ Description ^ | //URL// | Blank | Enter full URL to post items to. \\ Examples: http://127.0.0.1:8080/pbx or https://127.0.0.1:8080/pbx | | //Username// | Blank | If using authentication enter username. | | //Password// | Blank | If using authentication enter password. | | //Format// | POST Form Data | Type of data to post to server. | | //Resource// | None | Can be used to add a mailbox or extension automatically as part of the URL. \\ Example: http://127.0.0.1:8080/pbx/7101 | | //Slash// | Unchecked | Add addtional slash at end of URL. | | //Retries// | 3 | Number of retries before giving up. | | //Interval (seconds)// | 60 | Number of seconds to wait between retries. | | //Timeout (seconds)// | 10 | Number of seconds to wait for response from server. | ====== Response Errors ====== ^ HTTP Code ^ Description ^ | 200 | Success. | | 401 | Not authorized. Postings will not be retried. | | 404 | Failure. Posting will not be retried. | | Other | Will attempt retry. | ====== Syntax ====== ===== Field Descriptions ===== All field values use standard HTTP escaping for characters like spaces and punctuation marks. |**Field**|**Required**|**Description**| |room|Yes|Mailbox extension| |fname|No|First name| |lname|No|Last name| |fullname|No|Full name for those systems which prefer or only support a single name field. The default format is LNAME, FNAME but can be modified on the DuVoice system.| |group|No|Phone restriction group extension should be associated with. This can also be considered the class of service on your PBX.| |state|No|State for the guest room. \\ **in** - Room is currently checked in. \\ **out** - Room is currently checked out.| |description|No|Mailbox description field.| |mwi|No|Message waiting indicator state. \\ **0** - Light OFF. \\ **1** - Light ON. \\ **Note:** For MWI's to be sent out this interface the Method for MWI Notifications should be set to HTTP or HTTP + PMS.| |dnd|No|Call Blocking / DND \\ **0** = Call blocking DND off. \\ **1** = Call blocking DND on. | ====== Examples ====== POST /pbx Date: 2018-02-08T21:56:01Z User-Agent: DuVoice/6.01.21 HTTPPOST/200 Content-Length: 73 Content-Type: application/x-www-form-urlencoded Connection: Close Host: 127.0.0.1:8080 room=7101&fname=Brock&lname=Sampson&fullname=Sampson%2C%20Brock&state=out