{"info":{"_postman_id":"788c2aff-2476-4d47-bcee-44babefcb8a3","name":"MSEGAT Communication Platform API","description":"

MSEGAT REST and SMPP APIs allows you to connect your apps directly to networks.
Where you can integrate your apps to send text messages around the world.
And also inquire meta-data about your account, text messages, and usage.

This manual is to describe Mseagt API
\n
This manual is for developers
\n

Before Starting

This API is based on HTTPS protocol
\n
You must have an account to test this API, to register please https://www.msegat.com/
\n
You must use HTTPS POST with parameters in body
\n
You must use URL ENCODING when you send the variables
\n
Authentication is required for all requests using the following parameters:
\n
- userName: Username for the account in Msegat.
  \n
- apiKey: API key associated with the account.
  \n
\n
If SMS is English only, charged 1 point per 160 chars (153 if long SMS)
\n
If SMS contains non-English language, charged 1 point per 70 chars (67 if long SMS)
\n
Free OTP testing available using:
\n
- userSender: auth-mseg.
  \n
- msg: \"Pin Code is: xxxx\" or \"رمز التحقق: xxxx\".
  \n
\n
msgEncoding (optional, string): Message encoding type
\n
- Supported values: UTF8, windows-1256
  \n
- Default value: UTF8
  \n
- If not provided, the API will use UTF8 encoding.
  \n
\n

Error Codes

M0000 - Success
\n
M0001 - Variables missing
\n
M0002 - Invalid login info
\n
M0022 - Exceed number of senders allowed
\n
M0023 - Sender Name is active or under activation or refused
\n
M0024 - Sender Name should be in English or number
\n
M0025 - Invalid Sender Name Length
\n
M0026 - Sender Name is already activated or not found
\n
M0027 - Activation Code is not Correct
\n
M0029 - Invalid Sender Name - Sender Name should contain only letters, numbers and the maximum length should be 11 characters
\n
M0030 - Sender Name should ended with AD
\n
M0031 - Maximum allowed size of uploaded file is 5 MB
\n
M0032 - Only pdf,png,jpg and jpeg files are allowed!
\n
M0033 - Sender Type should be normal or whitelist only
\n
M0034 - Please Use POST Method
\n
M0036 - There is no any sender
\n
M0008 - The mobile number has an incorrect prefix
\n
M0037 - Please send SMS by statist IP. (If you do not have a static IP, you can disable this feature from your account settings)
\n
M0090 - The Message you entered does not match any Template
\n
M0092 - There are no templates Exist for this user and this sender
\n
M0040 - The numbers exceeded the allowed limit
\n
M0041 - No ready templates are currently available
\n
1 - success
\n
1010 - Variables missing
\n
1020 - Invalid login info
\n
1050 - MSG body is empty
\n
1060 - Balance is not enough
\n
1061 - MSG duplicated
\n
1064 - Free OTP , Invalid MSG content you should use \"Pin Code is: xxxx\" or \"Verification Code: xxxx\" or \"رمز التحقق: 1234\" , or upgrade your account and activate your sender to send any content
\n
1110 - Sender name is missing or incorrect
\n
1120 - Mobile numbers is not correct or international messaging is not enabled
\n
1140 - MSG length is too long
\n
400 - Code expired
\n
404 - Code not found
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Before Starting","slug":"before-starting"},{"content":"Error Codes","slug":"error-codes"}],"owner":"39158411","collectionId":"788c2aff-2476-4d47-bcee-44babefcb8a3","publishedId":"2sBXwqqqD2","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-06-07T12:56:19.000Z"},"item":[{"name":"Credits.php","item":[{"name":"Balance Inquiry","id":"8b29ff5e-c31a-4ae6-ad75-3b0aae5c2278","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://www.msegat.com/gw/Credits.php?userName=xxxx&apiKey=xxxx","description":"

To inquire about your balance at Msegat.com

userName (required, string, username for the account in Msegat.com)
\n
apiKey (required, string, apiKey associated with the account)
\n

\n","urlObject":{"path":["Credits.php"],"host":["https://www.msegat.com/gw"],"query":[{"key":"userName","value":"xxxx"},{"key":"apiKey","value":"xxxx"}],"variable":[]}},"response":[{"id":"e684e8d3-d0ec-434a-9566-3fae74f60f80","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://www.msegat.com/gw/Credits.php?userName=xxxx&apiKey=xxxx","host":["https://www.msegat.com/gw"],"path":["Credits.php"],"query":[{"key":"userName","value":"xxxx"},{"key":"apiKey","value":"xxxx"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"date","value":"Mon, 08 Jun 2026 09:22:44 GMT"},{"key":"content-length","value":"5"},{"key":"content-type","value":"text/html; charset=UTF-8"},{"key":"host","value":"LB"},{"key":"strict-transport-security","value":"max-age=63072000"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block;"},{"key":"referrer-policy","value":"no-referrer-when-downgrade"}],"cookie":[],"responseTime":null,"body":"272.6"}],"_postman_id":"8b29ff5e-c31a-4ae6-ad75-3b0aae5c2278"}],"id":"b194aff5-81d0-4892-b377-44a76e454df8","_postman_id":"b194aff5-81d0-4892-b377-44a76e454df8","description":""},{"name":"sendsms.php","item":[{"name":"Send SMS","id":"9074c6a9-b1cc-4953-b8ed-627b9e0ae288","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"userSender\": \"xxxx\",\n \"userName\": \"xxxx\",\n \"numbers\": \"966xxxxxxxxx\",\n \"apiKey\": \"xxxx\",\n \"msg\": \"xxxx\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://www.msegat.com/gw/sendsms.php","description":"

Use this service to send SMS.

Rules:

English SMS: 1 point per 160 chars (153 if long SMS)
\n
Arabic/Other: 1 point per 70 chars (67 if long SMS)
\n

Free OTP Test:
userSender: auth-mseg

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

\n","urlObject":{"path":["sendsms.php"],"host":["https://www.msegat.com/gw"],"query":[],"variable":[]}},"response":[{"id":"2ea1b8f2-8b92-4b13-9fdc-b984d0e85dd1","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiKey\": \"xxxx\",\n \"msg\": \"xxxx\",\n \"msgEncoding\": \"xxxx\",\n \"numbers\": \"xxxx\",\n \"userName\": \"xxxx\",\n \"userSender\": \"xxxx\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://www.msegat.com/gw/sendsms.php"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"code\": \"1\",\r\n \"message\": \"xxxx\"\r\n}"}],"_postman_id":"9074c6a9-b1cc-4953-b8ed-627b9e0ae288"}],"id":"1aebfb6c-fb26-4262-825c-b2d47647c5e8","_postman_id":"1aebfb6c-fb26-4262-825c-b2d47647c5e8","description":""},{"name":"getMessages.php","item":[{"name":"Get Messages","id":"4fa8c6db-18e8-427a-9821-56de24b02310","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiKey\": \"xxxx\",\n \"reqBulkId\": \"xxxx\",\n \"userName\": \"xxxx\",\n \"numbers\": \"xxxx\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://www.msegat.com/gw/getMessages.php","description":"

Retrieve message status and provider details

userName (required, string, username for the account in Msegat.com)
\n
apiKey (required, string, apiKey associated with the account)
\n
numbers (optional, string, string of numbers seperated by commas (optional to filter messages by mobile numbers)
\n
reqBulkId (required, string, bulk id of the messages)
\n
pageNumber (optional, integer, optional and the default is one)
\n
limit (optional, integer, optional and set to default limit in case not sent)
\n

\n","urlObject":{"path":["getMessages.php"],"host":["https://www.msegat.com/gw"],"query":[],"variable":[]}},"response":[{"id":"255936b0-a9f7-4454-93bb-aa8ab963a7ed","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiKey\": \"xxxx\",\n \"reqBulkId\": \"xxxx\",\n \"userName\": \"xxxx\",\n \"numbers\": \"xxxx\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://www.msegat.com/gw/getMessages.php"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 1,\n \"message\": \"xxxx\",\n \"data\": {\n \"messages\": [\n {\n \"mobileNumber\": \"xxxx\",\n \"status\": \"xxxx\",\n \"provider\": \"xxxx\"\n }\n ],\n \"pageNumber\": 1,\n \"next\": 2,\n \"previous\": 0\n }\n}"}],"_postman_id":"4fa8c6db-18e8-427a-9821-56de24b02310"}],"id":"2c466a65-9824-4e6b-8d66-626cfb388350","_postman_id":"2c466a65-9824-4e6b-8d66-626cfb388350","description":""},{"name":"sendVars.php","item":[{"name":"Send Personalized Messages","id":"3d77bd24-ea26-44b1-adcc-d28e764951ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiKey\": \"xxxx\",\n \"msg\": \"xxxx\",\n \"numbers\": [\n \"xxxx\",\n \"xxxx\"\n ],\n \"userName\": \"xxxx\",\n \"userSender\": \"xxxx\",\n \"vars\": [\n {\n \"var1\": \"xxxx\",\n \"var2\": \"xxxx\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://www.msegat.com/gw/sendVars.php","description":"

Send different SMS content for each number in bulk.

numbers (required, JSON, international format without zeros and it should be in array, ex: [\"966xxxxxxxxx\",\"966xxxxxxxxx\"])
\n
userSender (required, string, sender name, should be activated from Msegat.com)
\n
msg (required, string, sms body, it should contain the message body including the variables that should be between curly brackets, ex: {variable})
\n
timeToSend (optional, string, now or later, if not defined = now) + exactTime (optional, string,datetime in format : yyyy-MM-dd HH:mm:ss , if not defined =now)
\n
msgEncoding (required, string,UTF8orwindows-1256)
\n
reqBulkId (optional, string,trueorfalse, if not defined =false, when user need the msg id of the bulk, he must pass the variable with value =true)
\n
reqFilter (optional, string,trueorfalse, the system will filter the duplicated numbers, the default value is true)
\n
vars (required, JSON, it should contain the variables for each number, ex: [{\"var1\":\"value\",\"var2\":\"value\"},{\"var1\":\"value\",\"var2\":\"value\"}])
\n

\n","urlObject":{"path":["sendVars.php"],"host":["https://www.msegat.com/gw"],"query":[],"variable":[]}},"response":[{"id":"6e588532-8faa-49ab-8d9e-814efec44c15","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiKey\": \"xxxx\",\n \"msg\": \"xxxx\",\n \"numbers\": [\n \"xxxx\",\n \"xxxx\"\n ],\n \"userName\": \"xxxx\",\n \"userSender\": \"xxxx\",\n \"vars\": [\n {\n \"var1\": \"xxxx\",\n \"var2\": \"xxxx\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://www.msegat.com/gw/sendVars.php"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"code\": \"1\",\r\n \"message\": \"xxxx\"\r\n}"}],"_postman_id":"3d77bd24-ea26-44b1-adcc-d28e764951ae"}],"id":"55a74170-cccf-4dbb-a66f-d66b0a5f74ba","_postman_id":"55a74170-cccf-4dbb-a66f-d66b0a5f74ba","description":""},{"name":"calculateCost.php","item":[{"name":"Calculate Message Cost","id":"1cdcc2cd-9cbf-457d-8d2f-f542b1e9e1e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://www.msegat.com/gw/calculateCost.php","description":"

Calculate points cost before sending SMS

userName (required, string, username for the account in Msegat.com)
\n
apiKey (required, string, apiKey associated with the account)
\n
contactType (required, string,numbers)
\n
contacts (required, string,international format without zeros separated by comma)
\n
msg (required, string, sms body)
\n
By (optional, string, Link)
\n
msgEncoding (optional, string,UTF8orwindows-1256)
\n

\n","urlObject":{"path":["calculateCost.php"],"host":["https://www.msegat.com/gw"],"query":[],"variable":[]}},"response":[{"id":"5ceb2867-86cb-4691-b8f7-b5549bc5eae1","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"formdata","formdata":[{"key":"apiKey","value":"xxxx","type":"text"},{"key":"contactType","value":"xxxx","type":"text"},{"key":"contacts","value":"xxxx","type":"text"},{"key":"msg","value":"xxxx","type":"text"},{"key":"userName","value":"xxxx","type":"text"}]},"url":"https://www.msegat.com/gw/calculateCost.php"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"12,5"}],"_postman_id":"1cdcc2cd-9cbf-457d-8d2f-f542b1e9e1e5"}],"id":"c10c0c4b-05fc-485c-bf1d-922cd6ac5cf1","_postman_id":"c10c0c4b-05fc-485c-bf1d-922cd6ac5cf1","description":""},{"name":"sendOTPCode.php","item":[{"name":"Send OTP Code","id":"5a6a3370-0590-448e-913a-16e328f623bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiKey\": \"xxxx\",\n \"lang\": \"xxxx\",\n \"number\": \"xxxx\",\n \"userName\": \"xxxx\",\n \"userSender\": \"xxxx\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://www.msegat.com/gw/sendOTPCode.php","description":"

Send verification code via SMS.

lang : Ar or En in header
\n
userName (required, string, username for the account in Msegat.com)
\n
apiKey (required, string, apiKey associated with the account)
\n
number (required, string, international format without zeros)
\n
userSender (required, string)
\n

\n","urlObject":{"path":["sendOTPCode.php"],"host":["https://www.msegat.com/gw"],"query":[],"variable":[]}},"response":[{"id":"616c372c-1665-4a0d-982e-799032674b00","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiKey\": \"xxxx\",\n \"lang\": \"xxxx\",\n \"number\": \"xxxx\",\n \"userName\": \"xxxx\",\n \"userSender\": \"xxxx\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://www.msegat.com/gw/sendOTPCode.php"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"date","value":"Mon, 08 Jun 2026 08:08:14 GMT"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-allow-headers","value":"Content-Type, Access-Control-Allow-Headers, Authorization, X-Requested-With"},{"key":"access-control-allow-methods","value":"POST"},{"key":"content-length","value":"76"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"host","value":"LB"},{"key":"strict-transport-security","value":"max-age=63072000"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block;"},{"key":"referrer-policy","value":"no-referrer-when-downgrade"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"xx\",\n \"success\": true,\n \"code\": \"1\",\n \"message\": \"xxxx\"\n}"}],"_postman_id":"5a6a3370-0590-448e-913a-16e328f623bc"}],"id":"122c3b5d-a122-412c-b2cf-8d5cec15052c","_postman_id":"122c3b5d-a122-412c-b2cf-8d5cec15052c","description":""},{"name":"verifyOTPCode.php","item":[{"name":"Verify OTP Code","id":"82e089f8-c1b9-4cfb-8acd-204333298b65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiKey\": \"xxxx\",\n \"code\": \"xxxx\",\n \"id\": 1,\n \"lang\": \"xxxx\",\n \"userName\": \"xxxx\",\n \"userSender\": \"xxxx\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://www.msegat.com/gw/verifyOTPCode.php","description":"

Verify the code after sending.

lang : Ar or En in header
\n
userName (required, string, username for the account in Msegat.com)
\n
apiKey (required, string, apiKey associated with the account)
\n
code (required, string,the verification code sent to the number via SMS)
\n
userSender (required, string)
\n
id (required ,the id from the response of the send code API)
\n

\n","urlObject":{"path":["verifyOTPCode.php"],"host":["https://www.msegat.com/gw"],"query":[],"variable":[]}},"response":[{"id":"a075e249-ddea-4bc5-ba0f-eaf6d6ba6848","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiKey\": \"xxxx\",\n \"code\": \"xxxx\",\n \"id\": 1,\n \"lang\": \"xxxx\",\n \"userName\": \"xxxx\",\n \"userSender\": \"xxxx\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://www.msegat.com/gw/verifyOTPCode.php"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"1\",\n \"message\": \"xxxx\"\n}"}],"_postman_id":"82e089f8-c1b9-4cfb-8acd-204333298b65"}],"id":"93108472-bd52-4108-9d80-09e0f0e19d42","_postman_id":"93108472-bd52-4108-9d80-09e0f0e19d42","description":""},{"name":"GetMessageTemplates.php","item":[{"name":"Get Message Templates","id":"a2322f4e-45f7-46ac-a1af-fd1591dd746b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiKey\": \"xxxx\",\n \"userName\": \"xxxx\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://www.msegat.com/gw/GetMessageTemplates.php","description":"

Retrieve the list of ready message templates

userName (required, string, username for the account in Msegat.com)
\n
apiKey (required, string, apiKey associated with the account)
\n

\n","urlObject":{"path":["GetMessageTemplates.php"],"host":["https://www.msegat.com/gw"],"query":[],"variable":[]}},"response":[{"id":"93bc56f8-02c9-45d8-bf49-72829b02c48e","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apiKey\": \"xxxx\",\n \"userName\": \"xxxx\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://www.msegat.com/gw/GetMessageTemplates.php"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"xxxx\",\n \"message\": \"xxxx\",\n \"result\": [\n {\n \"id\": 1234,\n \"title\": \"xxxxxx\",\n \"msgBody\": \"xxxxxx\"\n }\n ]\n}"}],"_postman_id":"a2322f4e-45f7-46ac-a1af-fd1591dd746b"}],"id":"127ddcd0-215a-4ff1-9a7d-0f560276aff1","_postman_id":"127ddcd0-215a-4ff1-9a7d-0f560276aff1","description":""}],"event":[{"listen":"prerequest","script":{"id":"f81a881c-eba1-4e63-94ff-ea6e5300c835","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"52697405-f548-47f5-9557-14edb81adf5e","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://www.msegat.com/gw"}]}