SMS YANU documentation home

Upstream bind

Check that SMS YANU is connected to the upstream SMPP gateway.

SMS YANU's own SMPP server sends every message on to the upstream SMPP gateway over one SMPP bind. If that bind is down, nothing goes out.

Settings

The upstream bind is set only in the yanu-smpp env file (/etc/yanu/yanu-smpp.env):

KeyWhat it is
UPSTREAM_HOSTHost name of the upstream SMPP gateway.
UPSTREAM_PORTIts SMPP port. Default 2775.
UPSTREAM_SYSTEM_IDThe system_id the upstream gave us.
UPSTREAM_PASSWORDThe password for that bind. Secret.
UPSTREAM_CONNECTOR_IDThe connector name inside our gateway. Default upstream.
UPSTREAM_BIND_TYPEDefault transceiver.
UPSTREAM_SUBMIT_THROUGHPUTMost messages per second we send upstream. Default 50.
UPSTREAM_SYSTEM_TYPEOptional. Leave empty unless the upstream asks.
UPSTREAM_SYNC_ON_STARTDefault true: apply these settings each time the service starts.

Clients and resellers never see any of this. Admins see the host and system_id, never the password.

One upstream only

All client traffic leaves through one connector. When yanu-smpp starts, and when you press Sync to gateway on the Upstream page (POST /api/v1/admin/upstream/sync), it makes the gateway match the settings:

  • creates or updates the upstream connector,
  • removes any other connector or route,
  • adds one default route to the upstream,
  • starts the connector.

Do not add connectors or routes by hand in the gateway console. The next sync removes them.

Is it connected?

  • Portal: the staff Upstream page shows whether the settings are complete (and which are missing), whether the gateway is reachable, and the connector status. The staff Overview shows upstream health too.
  • API: GET https://smpp.smsyanu.com/api/v1/admin/upstream with an admin token returns configured, missing, gateway_connected and status.
  • Server: the gateway and yanu-smpp-api container logs show bind and unbind events.

If it is disconnected

  1. Check the server can reach the upstream: from the server, test a TCP connection to UPSTREAM_HOST on UPSTREAM_PORT.
  2. If the connection is refused or times out, the upstream may not have our server's public IP on its allowlist, or it is down. Contact the upstream provider.
  3. If it connects but the bind is refused with ESME_RINVPASWD, the password changed. Get the new one and update UPSTREAM_PASSWORD. See Rotating secrets.
  4. If the page says the settings are incomplete, fill in the missing UPSTREAM_* values and restart yanu-smpp-api.
  5. If the connector is missing or stopped after a gateway restart, press Sync to gateway.
  6. If the bind works but messages are refused with no credit, the upstream account balance is empty. Top up with the upstream provider.

Credit at the upstream

The upstream account is prepaid too. Watch its balance. When it runs out, every message fails, even if clients have credit on their binds.

To be confirmed

yanu-smpp does not send an alert when the upstream bind drops. Whether yanu-infra adds monitoring for it is not decided yet.

On this page