Developer API

GVMax licensed under the GPL v3 license


I am providing a developer api for those interested in developing applications that make use of Google Voice numbers. Right now it only exposes send and receiving of SMS. In the future it will provide all the functionalities of GVMax.

There are two ways to interface with GVMax. If you only need to know when you receive SMS and Voicemail you can use the Http Post notification mechanism. After creating an account specify a URL where you want the notifications to go.

I am also exposing an API for sending SMS. To use this API your GVMax account must be created with your GoogleVoice password.

API


To send an SMS
Parameter name Parameter value
action send
email your google voice email
apikey your apikey (found in your account page)
number number to send SMS to
text SMS Text

The response to this url will be an 'actionId' or an error message (errors always start with the work error). GVMax does not wait for the SMS to be sent before returning from this request. The actionId is used to identify this SMS send request when GVMax notifies you via a callback about the status of this request.

To change your callback options
Parameter name Parameter value
action callback
email your google voice email
apikey your apikey (found in your account page)
callbackActive (true/false) turn callbacks on / off
callbackUrl The callback url (not required if callbackActive=false)


Callbacks

This is a list of the requests you will receive on your callback url. (ie This is what GVMax will call, not you. Your application should listen to these callbacks).

SMS Sent notification
Parameter Name Parameter Value
type smsSent
actionId The action identifier (from the send API call)
error Only if an error happened and if so a description of the error

SMS Notifications
Parameter Name Parameter Value
type SMS
receiver Google Voice Email of SMS receiver
number The phone number
contact The contact name if available, or number otherwise
text SMS text

Voicemail Notifications
Parameter Name Parameter Value
type VM
receiver Google Voice Email of SMS receiver
number The phone number
contact The contact name if available, or number otherwise
text Voicemail transcript
link URL to voicemail recording