Versions Compared

Old Version 1

changes.mady.by.user Lee Mbugua

Saved on

compared with

New Version Current

changes.mady.by.user Jermin Ananda

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

The sendSMS request will queue an SMS to be sent to via integrated rails on DPO 3G i.einfobip or nexmo. The message routing will happen internally as per configuration and using the MID to map Merchant Phone and or provided customer phone.

Resource endpoint

HTTP METHOD

URI

ENV

Status
colourGreen
titlePOST

https://secure1.sandbox.directpay.online/API/v6/

Status
colourYellow
titlestaging

Status
colourGreen
titlePOST

https://api.directpay.online/API/V6/

Status
colourGreen
titlePROD

Request

Variables to send:

Parameter

Data type

Description

 Request

 Text

 sendSMS

Mandatory

CompanyToken

Token

Token you got from 3G to operate this API

Mandatory

MerchantID

Text

The MID for the Merchant to receive the SMS

Mandatory

MessageContent

Text

Message body content containing a short bit url that is clickable to allow receipt downloading

Mandatory

CustomerPhone

Text

The customers phone number to used.

Optional

Request Sample:

Expand
titlerequest body : POST
Code Block
languagexml
<?xml version="1.0" encoding="utf-8" ?>
<API3G>
    <Request>sendSMS</Request>
    <CompanyToken>4E003B15-6E43-4682-B46B-B41F6RETGYHA</CompanyToken>
    <MerchantID>5090011739</MerchantID>
    <MessageContent>{{Message Content}}</MessageContent>
     <CustomerPhone>712345678</CustomerPhone>
</API3G>

Response

The response body will be in the format below.

  • success

Expand
titleresponse body
Code Block
languagexml
<?xml version="1.0" encoding="UTF-8"?>
<API3G>
    <Code>000</Code>
	<Explanation>Success</Explanation>
</API3G>

  • Error - Wrong CompanyToken

Expand
titleresponse body
Code Block
<?xml version="1.0" encoding="UTF-8"?>
<API3G>
    <Code>802</Code>
	<Explanation>Wrong CompanyToken</Explanation>
</API3G>

  • Error - Missing Mandatory field.

Expand
titleresponse body
Code Block
<?xml version="1.0" encoding="UTF-8"?>
<API3G>
    <Code>950</Code>
	<Explanation>Request missing mandatory fields – CompanyToken</Explanation>
</API3G>