Skip to main content

SMS Localhost Integration

SMS Localhost is a Zimbabwean SMS gateway. It is used for OTP phone number verification by Spaaza chains operating in Zimbabwe.

Contents​

About SMS Localhost​

SMS Localhost is a Zimbabwean SMS gateway service at sms.localhost.co.zw. Spaaza uses the SMS Localhost API to send OTP verification codes to users with Zimbabwean phone numbers.

Webhook Configuration​

Webhook config type: smslocalhost

To configure SMS Localhost as the SMS provider for a chain, create a webhook configuration with type set to smslocalhost and event_name set to phone_number_verification. See Configuring an SMS Provider for the general setup steps.

Credentials​

The following fields must be set in the webhook configuration:

  • password — SMS Localhost API key
  • url — the SMS Localhost API endpoint URL
  • send_from — the sender identifier displayed on the SMS

Phone Number Format​

SMS Localhost requires Zimbabwe local-format phone numbers:

  • 10 digits, starting with 07 (Zimbabwe mobile prefix)
  • E.164 numbers (e.g. +263771234567) are automatically normalised to local format (e.g. 0771234567) before sending

API Details​

The integration sends a JSON POST request to the configured URL with the following payload structure:

{
  "to": "0771234567",
  "sender": "SenderName",
  "message": "Phone number verification: 123456. This code is valid for a limited time..."
}

Authentication is via the X-API-KEY header containing the API key.