ANTS API SPECIFICATION
English v1.0.0
English v1.0.0
  • INTRODUCTION
  • ACCOUNT
  • SMS
    • Send Message
    • Callback Delivery Report
    • Message Logs
    • Preview Message
    • Sender List
    • Status and Error codes
  • OTP (One Time Password)
  • SMS 2 WAY Interactive
Powered by GitBook
On this page
  • Sequence Diagram
  • Callback
  • RESULT THIRD PARTY

Was this helpful?

SMS 2 WAY Interactive

2 SMS messaging uses keywords and a short number to interact between mobile users and enterprises to trigger business process automation for both marketing and transaction.

PreviousOTP (One Time Password)

Last updated 5 years ago

Was this helpful?

Sequence Diagram

Request body requires parameters as these following

Parameters

type

description

TRAN_ID

String

The ID which uniquely identifies the request

MOBILE_NO

String

The destination phone number for your message

KEYWORD

String

Keyword of this campaign

MESSAGE

String

Message text

The request will look like:

{
"TRAN_ID":"db41f538-66bc-4d13-8d99-a6c2b5414ff8",
"MOBILE_NO":"66987654321",
"MESSAGE":"4567930000000048",
"KEYWORD":"ANTS"
}

SMS 2 Way Response

Parameters

type

description

TRAIN_ID

String

The ID that uniquely identifies the sent message.

RESULT_CODE

String

Code ID of return result

RESULT_NAME

String

Name of return result

MESSAGE

String

Text of the message return

The response will look like:

{
    "TRAIN_ID": "db41f538-66bc-4d13-8d99-a6c2b5414ff8",
    "RESULT_CODE": "301",
    "RESULT_NAME": " INVALID_MEMBER ",
    "MESSAGE": "Sorry, Membership  is not eligible for this event."
}

Callback

Request body requires parameters as these following

Parameters

types

description

ERROR_MESSAGE

String

Reason of each transaction ID

TRANSACTION_ID

String

The ID which uniquely identifies the request

The JSON callback will look like:

"ERROR_MESSAGE":"CHARGING_FAILED",
"TRANSACTION_ID":" db41f538-66bc-4d18-8d99-a6c2b5484ff8"

RESULT THIRD PARTY

Code

Name of the code

Description

00

Success

Success

301 to 399

Configurable

Response based on configuration that you defined

The sample of naming different codes will look like:

Code

Name of the code

Description

00

Success

Your registration is successful; please show this message at the counter.

301

INVALID_MEMBER

Sorry, this membership account is not eligible for this event.

302

INVALID_PRICE

Sorry, you have entered the wrong amount, please kindly check and re-submit again.

Sequence Diagram SMS 2 WAY