MSEGAT Communication Platform

https://msegat.docs.apiary.io/
Admin
MSEGAT is a REST and SMPP API platform that enables developers to integrate SMS messaging, OTP...
Tokens:4,436
Snippets:17
Trust Score:9.9
Update:8 months ago
Show doc for...
Tokens:
Raw
### Get Message Templates

Source: https://msegat.docs.apiary.io/index

Retrieve a list of pre-defined message templates.

```APIDOC
## POST /gw/GetMessageTemplates.php

### Description
Retrieve a list of ready-made message templates available for use.

### Method
POST

### Endpoint
https://www.msegat.com/gw/GetMessageTemplates.php

### Parameters
#### Request Body
- **userName** (string) - Required - Username for the account in Msegat.com
- **apiKey** (string) - Required - API key associated with the account

### Request Example
```json
{
 "userName": "xxxxxx",
 "apiKey": "xxxxxx"
}
```

### Response
#### Success Response (200)
- **code** (string) - Response code
- **message** (string) - Response message
- **result** (array) - An array of message template objects
  - **id** (integer) - Template ID
  - **title** (string) - Template title
  - **msgBody** (string) - Template message body

#### Response Example
```json
{
 "code": "M0000",
 "message": "Success",
 "result": [
   {
     "id": 1234,
     "title": "xxxxxx",
     "msgBody": "xxxxxx"
   }
 ]
}
```
```

--------------------------------

### Get Message Templates from Msegat API

Source: https://msegat.docs.apiary.io/index

Retrieves a list of pre-defined message templates from the Msegat API. Requires account credentials (userName, apiKey). The request is a POST to the GetMessageTemplates.php endpoint.

```JSON
{
   "userName": "your_username",
   "apiKey": "your_api_key"
}
```

--------------------------------

### Get Messages API

Source: https://msegat.docs.apiary.io/index

Retrieve details about sent messages, including status and recipient information. You can filter by mobile number or a specific bulk ID.

```APIDOC
## GET /getMessages.php

### Description
Use this service to get the message recipient details (status, recipient mobile number, ...).

### Method
GET

### Endpoint
https://www.msegat.com/gw/getMessages.php

### Parameters
#### Query Parameters
- **userName** (string) - Required - username for the account in Msegat.com
- **apiKey** (string) - Required - apiKey associated with the account
- **numbers** (string) - Optional - string of numbers separated by commas (optional to filter messages by mobile numbers)
- **reqBulkId** (string) - Required - bulk id of the messages
- **pageNumber** (integer) - Optional - optional and the default is one
- **limit** (integer) - Optional - optional and set to default limit in case not sent

### Request Example
```
https://www.msegat.com/gw/getMessages.php?userName=your_username&apiKey=your_apiKey&reqBulkId=123456789&numbers=966xxxxxxxxx
```

### Response
#### Success Response (200 OK)
- **data** (array) - Array of message objects
  - **mobile** (string) - Recipient mobile number
  - **status** (string) - Message status
  - **message_id** (string) - Unique message ID

#### Response Example
```json
{
  "data": [
    {
      "mobile": "966xxxxxxxxx",
      "status": "DELIVERED",
      "message_id": "msg_abc123"
    }
  ]
}
```

#### Error Response (404 Not Found)
- **error** (string) - Error message
```

--------------------------------

### Balance Inquiry API

Source: https://msegat.docs.apiary.io/index

Retrieve your current account balance from Msegat.com using your username and API key.

```APIDOC
## GET /gw/Credits.php

### Description
Retrieves the account balance for a given user.

### Method
GET

### Endpoint
https://www.msegat.com/gw/Credits.php

### Parameters
#### Query Parameters
- **userName** (string) - Required - username for the account in Msegat.com
- **apiKey** (string) - Required - apiKey associated with the account
- **msgEncoding** (string) - Required - UTF8

### Response
#### Success Response (200)
- **userBalance** (number) - The current balance of the account.

#### Response Example
```json
{
  "userBalance": 0
}
```

#### Error Response (404)
- **error** (string) - Description of the error.

#### Response Example
```json
{
  "error": "Some error"
}
```
```

--------------------------------

### Send Free OTP API

Source: https://msegat.docs.apiary.io/index

Test the Msegat API for free with daily free SMS. This endpoint is for testing purposes and uses a predefined sender name.

```APIDOC
## POST /gw/sendsms.php (Free OTP)

### Description
Test our API for free. You will get free SMS every day. To test our service you can send SMS using below parameters.

### Method
POST

### Endpoint
https://www.msegat.com/gw/sendsms.php

### Parameters
#### Query Parameters
- **userName** (string) - Required - username for the account in Msegat.com
- **apiKey** (string) - Required - apiKey associated with the account
- **numbers** (string) - Required - international format without zeros separated by comma
- **userSender** (string) - Required - "auth-mseg"
- **msg** (string) - Required - sms body, example : "Pin Code is: xxxx" or "رمز التحقق: xxxx"
- **msgEncoding** (string) - Required - UTF8 or windows-1256

### Request Example
```json
{
  "userName": "your_username",
  "apiKey": "your_apiKey",
  "numbers": "966xxxxxxxxx",
  "userSender": "auth-mseg",
  "msg": "Pin Code is: 1234",
  "msgEncoding": "UTF8"
}
```

### Response
#### Success Response (200 OK)
- **message** (string) - Confirmation message

#### Response Example
```json
{
  "message": "Free OTP message sent successfully."
}
```

#### Error Response (404 Not Found)
- **error** (string) - Error message
```

--------------------------------

### Send SMS API

Source: https://msegat.docs.apiary.io/index

Send SMS messages using the Msegat API. Supports free OTP SMS daily.

```APIDOC
## POST /gw/sendsms.php

### Description
Sends SMS messages to specified recipients. This endpoint also supports sending free One-Time Password (OTP) SMS messages daily.

### Method
POST

### Endpoint
https://www.msegat.com/gw/sendsms.php

### Parameters
#### Request Body
- **userName** (string) - Required - The username for the Msegat account.
- **apiKey** (string) - Required - The API key associated with the account.
- **userSender** (string) - Required - The sender ID or name.
- **userRecipients** (string) - Required - A comma-separated list of recipient mobile numbers.
- **msg** (string) - Required - The message content to be sent.
- **msgEncoding** (string) - Required - The encoding of the message (e.g., UTF8).

### Request Example
```json
{
  "userName": "your_username",
  "apiKey": "your_api_key",
  "userSender": "YourSenderName",
  "userRecipients": "+1234567890,+1987654321",
  "msg": "Verification Code: 123456",
  "msgEncoding": "UTF8"
}
```

### Response
#### Success Response (200)
- **code** (string) - Status code indicating success (e.g., '1' or 'M0000').
- **message** (string) - A success message.

#### Response Example
```json
{
  "code": "1",
  "message": "SMS sent successfully"
}
```

#### Error Response
- **code** (string) - Status code indicating an error (e.g., 'M0001', 'M0002', '1064').
- **message** (string) - A description of the error.

#### Response Example
```json
{
  "code": "M0001",
  "message": "Variables missing"
}
```
```

--------------------------------

### Verify OTP Code via Msegat API

Source: https://msegat.docs.apiary.io/index

Verifies an OTP code previously sent via SMS using the Msegat API. Requires account credentials, the verification code, and the ID received from the send OTP code response. The request is a POST to the verifyOTPCode.php endpoint.

```JSON
{
  "lang":"Ar",
  "userName": "your_username",
  "apiKey":"your_api_key",
  "code":"123456",
  "id": 11,
  "userSender":"your_sender_id"
}
```

--------------------------------

### Send OTP Code via Msegat API

Source: https://msegat.docs.apiary.io/index

Sends an One-Time Password (OTP) code via SMS using the Msegat API. Requires account credentials (userName, apiKey), recipient's number, and a sender ID. The request is a POST to the sendOTPCode.php endpoint.

```JSON
{
  "lang":"Ar",
  "userName": "your_username",
  "number":"+1234567890",
  "apiKey":"your_api_key",
  "userSender":"your_sender_id"
}
```

--------------------------------

### Verify OTP Code

Source: https://msegat.docs.apiary.io/index

Verify a previously sent OTP code using its ID and the provided code.

```APIDOC
## POST /gw/verifyOTPCode.php

### Description
Verify the OTP code sent to a number. Requires the verification code and the ID received from the send OTP API.

### Method
POST

### Endpoint
https://www.msegat.com/gw/verifyOTPCode.php

### Parameters
#### Header Parameters
- **lang** (string) - Required - 'Ar' or 'En'

#### Request Body
- **userName** (string) - Required - Username for the account in Msegat.com
- **apiKey** (string) - Required - API key associated with the account
- **code** (string) - Required - The verification code sent via SMS
- **id** (integer) - Required - The ID received from the send code API response
- **userSender** (string) - Required - Sender ID

### Request Example
```json
{
  "lang":"Ar",
  "userName": "xxxxxx",
  "apiKey":"xxxxxx",
  "code":"xxxxxx",
  "id": 11,
  "userSender":"xxxxxx"
}
```

### Response
#### Success Response (200)
- **code** (string) - Response code
- **message** (string) - Response message

#### Response Example
```json
{
  "code":"1",
  "message": "Success"
}
```
```

--------------------------------

### Send OTP Code

Source: https://msegat.docs.apiary.io/index

Send SMS with a verification code to a specified number.

```APIDOC
## POST /gw/sendOTPCode.php

### Description
Send SMS with a verification code using provided account credentials and recipient information.

### Method
POST

### Endpoint
https://www.msegat.com/gw/sendOTPCode.php

### Parameters
#### Header Parameters
- **lang** (string) - Required - 'Ar' or 'En'

#### Request Body
- **userName** (string) - Required - Username for the account in Msegat.com
- **apiKey** (string) - Required - API key associated with the account
- **number** (string) - Required - International phone number format without leading zeros
- **userSender** (string) - Required - Sender ID

### Request Example
```json
{
  "lang":"Ar",
  "userName": "xxxxxx",
  "number":"xxxxxx",
  "apiKey":"xxxxxx",
  "userSender":"xxxxxx"
}
```

### Response
#### Success Response (200)
- **code** (string) - Response code
- **message** (string) - Response message
- **id** (integer) - Unique identifier for the sent OTP

#### Response Example
```json
{
  "code":"1",
  "message": "Success",
  "id": 11
}
```
```

--------------------------------

### Send SMS API

Source: https://msegat.docs.apiary.io/index

This endpoint allows you to send standard SMS messages to one or more recipients. You can specify sender name, message content, and encoding. Optional parameters allow for scheduled sending and filtering of duplicate numbers.

```APIDOC
## POST /gw/sendsms.php

### Description
Send standard SMS messages to one or more recipients.

### Method
POST

### Endpoint
https://www.msegat.com/gw/sendsms.php

### Parameters
#### Query Parameters
- **userName** (string) - Required - username for the account in Msegat.com
- **apiKey** (string) - Required - apiKey associated with the account
- **numbers** (string) - Required - international format without zeros separated by comma, example: "966xxxxxxxxx" or "966xxxxxxxxx,966xxxxxxxxx,966xxxxxxxxx"
- **userSender** (string) - Required - sender name, should be activated from Msegat.com, Max Length 11
- **msg** (string) - Required - sms body, you must put in msg to replace it with recipient name
- **msgEncoding** (string) - Required - UTF8 or windows-1256
- **timeToSend** (string) - Optional - "now" or "later", if not defined = "now"
- **exactTime** (string) - Optional - datetime in format : yyyy-MM-dd HH:mm:ss , if not defined = "now"
- **reqBulkId** (string) - Optional - "true" or "false", if not defined = "false", when user need the msg id of the bulk, he must pass the variable with value = "true"
- **reqFilter** (string) - Optional - "true" or "false", the system will filter the duplicated numbers, the default value is true
- **By** (string) - Optional - YourPlatform Name, the default value is true
- **reqDlr** (string) - Optional - "true" or "false", the system will be return bulk id, the default value is false

### Request Example
```json
{
  "userName": "your_username",
  "apiKey": "your_apiKey",
  "numbers": "966xxxxxxxxx,966xxxxxxxxx",
  "userSender": "YourSenderName",
  "msg": "Hello {name}!",
  "msgEncoding": "UTF8",
  "timeToSend": "now",
  "exactTime": "",
  "reqBulkId": "false",
  "reqFilter": "true",
  "By": "YourPlatform Name",
  "reqDlr": "false"
}
```

### Response
#### Success Response (200 OK)
- **message** (string) - Confirmation message
- **bulk_id** (string) - Bulk ID if requested

#### Response Example
```json
{
  "message": "Message sent successfully.",
  "bulk_id": "123456789"
}
```

#### Error Response (404 Not Found)
- **error** (string) - Error message
```

--------------------------------

### Calculate Message Cost API

Source: https://msegat.docs.apiary.io/index

Calculate the estimated cost (in points) for sending SMS messages before actually sending them. This helps in managing your SMS budget.

```APIDOC
## POST /gw/calculateCost.php

### Description
Calculate the number of points that will be deducted from your account before sending the message.

### Method
POST

### Endpoint
https://www.msegat.com/gw/calculateCost.php

### Parameters
#### Query Parameters
- **userName** (string) - Required - username for the account in Msegat.com
- **apiKey** (string) - Required - apiKey associated with the account
- **contactType** (string) - Required - "numbers"
- **contacts** (string) - Required - international format without zeros separated by comma
- **msg** (string) - Required - sms body
- **By** (string) - Required - "Link"
- **msgEncoding** (string) - Required - UTF8

### Request Example
```json
{
  "userName": "your_username",
  "apiKey": "your_apiKey",
  "contactType": "numbers",
  "contacts": "966xxxxxxxxx,966xxxxxxxxx",
  "msg": "This is a test message.",
  "By": "Link",
  "msgEncoding": "UTF8"
}
```

### Response
#### Success Response (201 Created)
- **cost_details** (string) - Contains the total number of contacts and the point cost.

#### Response Example
```json
{
  "cost_details": "Total contacts: 2, Point cost: 4"
}
```

#### Error Response (404 Not Found)
- **error** (string) - Error message
```

--------------------------------

### Send Personalized Messages API

Source: https://msegat.docs.apiary.io/index

Send personalized SMS messages where each recipient can receive a different message content. This is useful for bulk messages with custom information.

```APIDOC
## POST /gw/sendVars.php

### Description
Send Personalized SMS. You can send different SMS content for each number in bulk.

### Method
POST

### Endpoint
https://www.msegat.com/gw/sendVars.php

### Parameters
#### Query Parameters
- **userName** (string) - Required - username for the account in Msegat.com
- **apiKey** (string) - Required - apiKey associated with the account
- **numbers** (JSON array) - Required - international format without zeros, ex: ["966xxxxxxxxx","966xxxxxxxxx"]
- **userSender** (string) - Required - sender name, should be activated from Msegat.com
- **msg** (string) - Required - sms body, it should contain the message body including the variables that should be between curly brackets, ex: {variable}
- **msgEncoding** (string) - Required - UTF8 or windows-1256
- **timeToSend** (string) - Optional - "now" or "later", if not defined = "now"
- **exactTime** (string) - Optional - datetime in format : yyyy-MM-dd HH:mm:ss , if not defined = "now"
- **reqBulkId** (string) - Optional - "true" or "false", if not defined = "false"
- **reqFilter** (string) - Optional - "true" or "false", the system will filter the duplicated numbers, the default value is true
- **vars** (JSON array) - Required - it should contain the variables for each number, ex: [{"var1":"value","var2":"value"},{"var1":"value","var2":"value"}]

### Request Example
```json
{
  "userName": "your_username",
  "apiKey": "your_apiKey",
  "numbers": ["966xxxxxxxxx", "966xxxxxxxxx"],
  "userSender": "YourSenderName",
  "msg": "Hello {name}! Your code is {code}.",
  "msgEncoding": "UTF8",
  "vars": [
    {"name": "Alice", "code": "1234"},
    {"name": "Bob", "code": "5678"}
  ]
}
```

### Response
#### Success Response (200 OK)
- **message** (string) - Confirmation message
- **bulk_id** (string) - Bulk ID if requested

#### Response Example
```json
{
  "message": "Personalized messages sent successfully.",
  "bulk_id": "987654321"
}
```

#### Error Response (404 Not Found)
- **error** (string) - Error message
```
Tokens:
Raw