Where Developers Build for Developers

Send via HTTP Over Query Parameters

API Overview

This document describes the full functionalities and detailed documentation of the SMSPoh HTTP API V3. It is intended for organizations and individuals who need to send or receive SMS messages programmatically.

Version

The last version of SMSPoh HTTP API V3.0 enhanced performance, streamlined endpoints, and improved security features. With simplified authentication and more consistent responses, it aims to provide a smoother, more reliable experience for developers.

Base URL

The base URL for this service is https://v3.smspoh.com/api/http. This base URL cannot be used independently;
you must append a specific path that identifies the desired operation, and you may need to specify certain path parameters.

https://v3.smspoh.com/api/http

Authentication

Please note that the previous SMSPoh API credentials are no longer compatible with API V3.

To create a new API credential, please navigate to the https://v3.smspoh.com/ and Accounts & Security > API Credentials page in the customer dashboard.

Base64Encode:


                            base64encode(SMSPohV3APIKey:SMSPohV3APISecret)

Query Parameter Authentication:

QueryParamAuth is an action filter that supports the authentication based on the access token passed through a query parameter.


                            accessToken=U01TUG9oVjNBUElLZXk6U01TUG9oVjNBUElTZWNyZXQ=

Send

Send URL

This API allows you to send message using simple HTTP query.


                            https://v3.smspoh.com/api/otp/request?to=09*******&message=Hello+World+HTTP+API&from=SMSPoh&accessToken=U01TUG9oVjNBUElLZXk6U01TUG9oVjNBUElTZWNyZXQ=
                            POST

Query Parameters

Name	Type	Description
accessToken	String Required	Your API credential.
to	String Required	Recipient mobile numbers. The mobile number can start with (09, 959 or +959) prefixes.
message	String Required	The message text to be sent.
from	String Required	The sender ID (alphanumeric or numeric, depending on your account settings).
scheduledAt	String	MySQL Date time. Schedule your message to send later at a specific time.
encrypt	Boolean	To encrypt the message content. We encrypt your message content using the BKDF2 algorithm in the database.
unicode	Boolean	Send force as the unicode message.
test	Boolean	Send a test message.
deliveryReceiptUrl	String	Define custom delivery receipt URL for this transaction.
clientReference	String	Your reference value for this transaction.

Response Body

Success:


                            Status: 201 OK Content-type: application/json

                           {
  "messages": [
    {
      "messageId": "F5BR4DB-44A1C-446C-8R69-J50248VB9ORE",
      "message": "Hello World HTTP API",
      "to": "959*******",
      "clientReference": null,
      "scheduledAt": null,
      "createdAt": "2024-12-20 12:09:48",
      "messageCount": 1,
      "from": "SMSPoh",
      "network": "MPT",
      "type": "sms.text",
      "status": "Accepted",
      "test": false
    }
  ]
}

Error:


                            Status: 401 Unauthorized Content-type: application/json

                        {
  "name": "Unauthorized",
  "message": "Your request was made with invalid credentials.",
  "code": 0,
  "status": 401
}