SMS Gateway for Accounting & POS Software

This section covers software such as Holoo, Parmis, Mahak, Negin, Dasht/Sepidar, and other products that let you configure a “custom web service”, “dedicated URL”, or “generic SMS provider” in their messaging settings.

The modern /messaging/send endpoint accepts JSON in the body and the token in a header, but many accounting packages can only call a simple URL with username, password, and query parameters PortalCode, ServerType, to, and text. The /messaging/gateway endpoint accepts that legacy contract.

Quick setup: URL = https://www.HomaCRM.com/api/v1/external/messaging/gateway, username = API token, portal code = PortalCode, server type = ServerType, recipient = to, message body = text.

Gateway endpoint

GET POST /messaging/gateway

Send a single SMS using simple web-service parameters. Parameter names are case-insensitive; several aliases are accepted for each field.

Parameter	Aliases	Required	Description
`username`	`user`, `uname`	Yes	Portal API token.
`password`	`pass`, `apikey`, `api_key`, `apiKey`, `key`, `token`	Alternative	API token when the software expects a separate password field.
`PortalCode`	`portalcode`, `portal_code`	Recommended	Portal code, e.g. `10003385`.
`ServerType`	`servertype`, `server_type`	Recommended	Server/line type; e.g. `100` for public send / blacklist.
`to`	`mobile`, `recipient`, `receiver`, `phone`	Yes	Recipient mobile; normalized to `09XXXXXXXXX`.
`text`	`message`, `msg`, `body`, `content`	Yes	Message text (max 600 characters).
`from`	`sender`, `line`, `number`, `senderid`, `sender_id`	No	Sender line number (optional).
`format`	`output`, `response`	No	`text` (default) or `json`.

Software field → gateway parameter mapping

Field in software	Gateway parameter	Value
Username (UserName)	`username`	API token
Portal code (PortalCode)	`PortalCode`	Portal code, e.g. `10003385`
Server type (ServerType)	`ServerType`	e.g. `100`
Recipient (To)	`to`	Recipient mobile number
Message text (Message)	`text`	SMS body

Response format

By default the response is plain text: on success a positive message ID is returned; on error a value less than or equal to zero (0 = auth error, -2 = missing required field, -4 = invalid number, -1 = send failure). Append ?format=json to receive the standard JSON envelope used elsewhere in this API.

Example — GET

curl -G "https://www.HomaCRM.com/api/v1/external/messaging/gateway" \
  --data-urlencode "username=a1B2c3D4e5F6g7H8-i9J0k1L2m3N4o5P6-q7R8s9T0u1V2w3X4" \
  --data-urlencode "PortalCode=10003385" \
  --data-urlencode "ServerType=100" \
  --data-urlencode "to=09129876543" \
  --data-urlencode "text=Hello, your order is registered. Tracking code: 987654"

Example — POST (form)

curl -X POST "https://www.HomaCRM.com/api/v1/external/messaging/gateway" \
  -d "username=a1B2c3D4e5F6g7H8-i9J0k1L2m3N4o5P6-q7R8s9T0u1V2w3X4" \
  -d "PortalCode=10003385" \
  -d "ServerType=100" \
  -d "to=09129876543" \
  -d "text=Your verification code: 847291"

Response (text)

184920315

Response (?format=json)

{
  "success": true,
  "data": {
    "messageId": 184920315,
    "recipient": "09129876543",
    "status": "queued",
    "deliveryCode": 10001,
    "creditUsed": 1
  },
  "meta": { "requestId": "req_7f3a9c21b4e8" }
}

Common integration patterns

Pattern	Homa connection
Custom web service / dedicated URL	Direct connection via this gateway.
SMS plugin with fixed providers	Direct only if a custom URL option exists; otherwise a dedicated adapter is required.
Corporate API / ERP	Prefer a dedicated adapter built on the Homa REST API.

Software compatibility matrix

Software	Typical status	Connection method	Notes
Holoo	Direct test possible when custom provider is supported	Custom web service	If URL and parameter names are configurable, this gateway is enough.
Holoo APEX	Version-dependent	Custom web service or adapter	If only fixed providers are listed, a dedicated adapter is needed.
Parmis	Official SMS module / gateway	SMS module or custom URL	Direct connection works only when the panel accepts a custom web service.
Mahak	Official SMS messenger plugin	Plugin or custom URL	If the plugin only supports fixed providers, HomaCRM must be added to the list or an adapter written.
Negin	Product-specific	Custom web service	Exact product name and version should be verified.
Dasht (Hamkaran System)	Official SMS subsystem	SMS subsystem or adapter	Direct connection only if the subsystem/plugin exposes a custom URL.
Sepidar	Plugin review required	Plugin / dedicated adapter	Many installations use fixed provider lists.
Rahkaran (Hamkaran System)	Adapter project usually required	Custom API / integration	For enterprise ERP, a simple URL setup is usually insufficient.
Shayegan, Ghyas, Ferdad, Arian System, Tadbir, Peyvast, Rafe	Depends on version and SMS module	Custom web service or adapter	Direct when `to` and `text` parameters are configurable.
Hesabfa, Chortke, and cloud accounting apps	Often API-driven or locked to built-in SMS	API / adapter	Check whether the service allows choosing a custom SMS panel.

Holoo

On Holoo versions that support a custom SMS provider or web service, the usual path is Management settings → Provider settings. Create a new gateway and map parameter names as in the table below.

Holoo field	Value
Panel name	HomaCRM (any label)
Site URL	`https://www.HomaCRM.com/api/v1/external/messaging/gateway`
Username	API token
UserName → parameter	`username`
PortalCode → parameter	`PortalCode`
ServerType → parameter	`ServerType`
To → parameter	`to`
Message → parameter	`text`

If your Holoo build only shows a fixed provider list and offers no custom URL or parameter mapping, direct connection is not possible — evaluate a dedicated plugin or adapter instead.

Parmis, Mahak, Negin, and similar products

When messaging settings include a “custom / generic web service” option, use the values below. For Parmis and Mahak, first confirm the installed build is not limited to an official SMS module only.

Field	Value
Web service URL	`https://www.HomaCRM.com/api/v1/external/messaging/gateway`
Username	API token
ServerType parameter	`ServerType`
Recipient parameter	`to`
Message parameter	`text`
PortalCode parameter	`PortalCode`

Generic / custom web service (other software)

Any product that lets you define “web service URL + custom parameters” can connect to Homa using the pattern below. The software sends GET or POST with these parameters:

https://www.HomaCRM.com/api/v1/external/messaging/gateway?username={token}&PortalCode={portalCode}&ServerType={serverType}&to={mobile}&text={message}

Note: Sepidar, Dasht, Rahkaran, and some Parmis/Mahak builds typically use SMS subsystems or plugins tied to specific providers. Direct Homa connection works only when that plugin allows a custom URL; otherwise prepare a dedicated plugin or adapter.

مدیریت مشتریان

عملیات مالی