How can I access the MultiTXT API?

We have recently released a new REST API for MultiTXT customers to use for sending and receiving messages. Full documentation of this API is available here

API credentials are generated when you first set up your multiTXT account. Use the initial token supplied to you for API access.

HTTP API

A lightweight API provides the simplicity that you’re looking for when wanting to enable your applications to send text messages. For example, linking back to your CRM to push out status or balance alerts. Or sending out appointment reminders or one time passwords.

The following limits are in place for this API

1. Only one recipient or group alias per connection. If you need to send to multiple recipients then you will need to loop through your recipient list sending to one each time.
2. Message Status is not reported back via the API. The status will be updated and can be viewed by logging in to multiTXT or by requesting a list of recent messages using the available feeds.
3. Replies are not handled by the API. Replies can be viewed by logging in to multiTXT or by requesting a list of recent messages using the available feeds.

API capabilities

Sending messages

Allows you to send a single message to a recipient.

Retrieve recent messages (XML / RSS feed)

Return a list of recently received and sent messages.

API endpoints

Authentication

The multiTXT API supports the following methods of authenticating requests:

Basic authorization

You must add the following header to each HTTP request.

Authorization: Basic <credentials>

where <credentials> is your username and password base64 encoded.

URL parameters

You can pass your credentials as URL encoded parameters:

Example send messages request:

POST https://multitxt.vodafone.co.nz/api/1/sms/out?userId=yourId&password=yourPassword&to=recipientNumber&body=hello

Username and password authentication via Basic Auth header is preferable and more secure than passing them as URL parameters.

Support

Our business service team is here to help. Call 888 from your mobile, 0800 4000 888 from your landline or +64 9 962 9888 from overseas.

You can also visit us in store or access your account at www.vodafone.co.nz/business

For more information go to www.vodafone.co.nz/multitxt