Skip to main content

Spark NZ

Navigate to SMS Management

Add an SMS provider​

  • Log into your Vodia Tenant portal.

  • Click Trunks on the left menu then SMS Management

  • Under the Providers tab click the [+ | Add] button

  • Complete the information.

  • Name: Provide a name (for your purposes)

  • Provider: Select Spark NZ

  • Username: Enter your Spark NZ / eTXT User ID.

  • Password / Application Secret: Enter your Spark NZ / eTXT password (API key).

    note

    Spark NZ uses the eTXT service. The User ID and password are passed as query parameters when sending. Obtain these credentials in the eTXT / Spark portal — consult the Spark NZ documentation for the exact location.

  • Click [Save].

Add your SMS numbers​

Now you need to add your DIDs into the Numbers tab.

  • Under the section SMS Management (Trunks on the left menu then SMS Management)
  • Click the Numbers tab and click the [+ | Add] button.
  • Provide a name (for your purposes)
  • Enter your phone number in E.164 format (e.g., +6421555012).
  • Policy: If you have any policy in place, choose it. (optional)
  • Provider: Choose the provider name you have created.
  • URL prefix for receiving messages: Enter something you will use for your SMS callback URL. Eg: sparknzinbound
  • Source: It could be your extension number.
  • Destination: It could be your extension number.
  • Click [Save].
note

Vodia strips the leading + from numbers when sending and re-adds it to inbound numbers, so store your numbers in E.164 (+) format in Vodia.

Configure the Spark NZ inbound webhook​

To receive messages, configure the eTXT service to deliver inbound messages to your PBX. In the eTXT / Spark portal, locate the inbound message forwarding / webhook settings (consult the Spark NZ documentation for the exact location) and set:

  • Webhook URL: Your PBX URL with the prefix you specified above, for example: https://your-pbx-domain.com/sparknzinbound
  • Format: Form-encoded POST (FORMv1) with from, to, and body attributes

Vodia expects an inbound form-encoded POST containing from, to, and body. Numbers are normalized to E.164.

Outbound messages are sent to https://www.etxtservice.co.nz/api/3/sms/out.

Your Spark NZ SMS integration is now configured and ready to use.