Richmo.LK API Integration Guide

  • Home
  • Richmo.LK API Integration Guide

Richmo.LK API Integration Guide

Start sending SMS using our API

Integrate SMS functionality into your application using your programming language.

 

Base URL

All URLs referenced in the API documentation have the following base url.

 

https://portal.richmo.lk

Method 01 : Integration with Bearer Authentication (token authentication) 

Send a Single Message

HTTP request

GET /api/sms/send/

Parameters

Parameter

Type

Description

Required

dst

String

Recipent phone number.

Required

from

String

 The Sender name.(Mask)

Required

msg

String

The body of the message.

Required

Returns

Code

Description

Message Example

200

Success

{ "message": "success", "id": 69412 }

400

Bad Request such as missing required parameter.

{ "errors": { "destination": [ "This field may not be blank." ] } }

401

Unauthorized : Errors like invalid token

{ "detail": "Invalid token." }

Code Sample

Method 02 : Simple Integration – authentication token send via request parameters

HTTP request

GET /api/v1/sms/send/

Parameters

Parameter

Type

Description

Required

dst

String

Recipent phone number.

Required

from

String

 The Sender name.(Mask)

Required

msg

String

The body of the message.

Required

key

String

Authentication token

Required

Returns

Code

Description

Message Example

200

Success

{ "message": "success", "id": 69412 }

400

Bad Request such as missing required parameter.

{ "errors": { "destination": [ "This field may not be blank." ] } }

401

Unauthorized : Errors like invalid token

{ "detail": "Invalid token." }

Code Sample

Check account balance

HTTP request

GET /api/account/balance/

Parameters

Returns

Code

Description

Message Example

200

Success

{ "message": "success", "id": 69412 }

401

Unauthorized : Errors like invalid token

{ "detail": "Invalid token." }

Code Sample