eTelecom docs
English
English
  • INSTRUCTIONS FOR USE
    • Administration page for cs.etelecom
    • Google Chrome Extension
    • App eTelecom
  • API INTEGRATION
    • Shop
      • Account
      • Usage
    • Partner
      • Account
      • Usage
    • VPBX
      • VoIP SDK
        • Android
        • iOS
        • Web
        • Flutter
      • PBX REST APIs
        • Partner Get Tenant List
        • Partner Add Hotline
        • Partner Get Hotline List
        • Partner Activate Tenant
        • Partner Add Hotline To Tenant
        • Partner Removed Hotline From Tenant
        • Partner Remove Hotline
        • Create Tenant
        • Get Tenant information
        • Get Driver Config
        • Get hotline list
        • Create Account User
        • Get List User
        • Create extension
        • Get extension information
        • Get extension list
        • Assign extension to user
        • Change hotline for extension
        • Remove User Of Extension
        • Get call history
    • Zalo Cloud
      • Instructions for connecting Zalo Cloud
      • Zalo Cloud API
        • Create OA authorization link
        • Connect OA
        • Get refresh token
        • Get OA list
        • Get OA information
        • Update Webhook for OA
        • Get list of users
        • Send Text Consulting
        • Send Consulting message according to user information request form
        • Send advice message with sticker
        • Send message Consulting with attached photo
        • Send message Consulting attached file
        • Send transaction message
        • Upload file
        • Send request for calling permission
        • Check if the customer has granted calling permission
        • Get list of requests for calling permission
        • Create a news template
        • Get sample details
        • Get list of news samples
        • Journey Token Creation
        • Get Journey Token Details
        • Get Journey Token List
        • Get message list
        • Get message details
        • Send ZNS
        • Send ZNS with Journey Token
  • SMS BRANDNAME
    • User manual
    • SMS API
      • Send SMS
      • Get message status
      • Get sample details
Powered by GitBook
On this page
  1. SMS BRANDNAME
  2. SMS API

Send SMS

Request:

curl --location 'https://sms.etelecom.vn/api/OmniMessage/SendMessage' \
--header 'Content-Type: application/json' \
--data '{
    "username": "string",
    "password": "string",
    "phonenumber":"string",
    "routerule": ["3"],
    "templatecode":"string",
    "list_param":{
        "property1":"string",
        "property2": "string"
    }
}'

Request body structure:

Parameters
Data type
Describe

username

string

Account provided by eTelecom

password

string

Password provided by eTelecom

phonenumber

string

Phone number to receive message (Recommended standard format 84)

routerule

string

The channel routing will follow the smart channel sliding mechanism (the first channel that fails will be forwarded to the next channels): 1: ZNS 2: AutoCall 3: SMS

templatecode

string

Template code when registering

list_param

object

List of variables (depending on the template there will be different variables)

The returned response structure:

Status
Response
Description

200

{ "status": "1", "code": "Success", " idOmniMess ": "ICOMNI prefix string and 30 characters" }

Success: eTelecom has received the message request. The status will be updated in the GetStatus API or the webhook registered with eTelecom based on the received idOmniMess.

401

Unauthorized

Wrong username and password

401

Can't access from this IP

User's IP is not in the system whitelist

200

{ "status": "-1", "code": "PhoneNumber Wrong Format" }

The phone number received is not in the correct format.

200

{ "status": "-2", "code": "Wrong Format Parameter: xxxxxx" }

Variable xxxxxx is in wrong format

200

{ "status": "-3", "code": "You have run out of messages"

}

Omni message sent number has run out of business contacts to issue more.

200

{ "status": "-6", "code": "Can't find template with templatecode: xxxxxx " }

Cannot find template with requested id

200

{ "status": "-8", "code": "Can't find any routing for this request" }

No routerule found for template code, contact engineering for reconfiguration.

200

{ "status": "-9", "code": "Can't find any information about channel: XXXXX" }

Error Channel XXXXX in routerule contact technical for reconfiguration.

PreviousSMS APINextGet message status

Last updated 2 months ago