118 lines
3.0 KiB
YAML
118 lines
3.0 KiB
YAML
openapi: 3.0.3
|
|
info:
|
|
title: Event Manager API
|
|
description: The documentation for Event Manager API
|
|
version: 1.0.0
|
|
contact:
|
|
name: API Support
|
|
email: support@example.com
|
|
license:
|
|
name: MIT
|
|
url: https://opensource.org/licenses/MIT
|
|
|
|
servers:
|
|
- url: http://localhost:5000
|
|
description: Local development server
|
|
|
|
paths:
|
|
/health:
|
|
get:
|
|
summary: Returns a health message
|
|
responses:
|
|
200:
|
|
description: A successful response
|
|
/status-call:
|
|
post:
|
|
summary: Perform a status call
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
requestId:
|
|
type: string
|
|
example: "R02802"
|
|
countryCode:
|
|
type: string
|
|
example: "NGR"
|
|
transactionId:
|
|
type: string
|
|
example: "Tr201712RK9232P115"
|
|
debtId:
|
|
type: string
|
|
example: "173021"
|
|
transactionType:
|
|
type: string
|
|
example: "Disbursement"
|
|
customerId:
|
|
type: string
|
|
example: "CN621868"
|
|
responses:
|
|
200:
|
|
description: A successful response
|
|
/sms:
|
|
post:
|
|
summary: Send a SMS
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
text:
|
|
type: string
|
|
example: "This is a test message for SMS request method."
|
|
dest:
|
|
type: string
|
|
example: "+2348039409144"
|
|
unicode:
|
|
type: boolean
|
|
example: false
|
|
responses:
|
|
200:
|
|
description: A successful response
|
|
/bulk-sms:
|
|
post:
|
|
summary: Send a bulk SMS
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
text:
|
|
type: string
|
|
example: "This is a test message for SMS request method."
|
|
dest:
|
|
type: string
|
|
example: "+2348039409144"
|
|
unicode:
|
|
type: boolean
|
|
example: true
|
|
responses:
|
|
200:
|
|
description: A successful response
|
|
/autocall/refresh-verify-disbursement:
|
|
get:
|
|
summary: Refresh the disbursement to verify
|
|
responses:
|
|
200:
|
|
description: A successful response
|
|
/autocall/refresh-disbursement:
|
|
get:
|
|
summary: Refresh the disbursement
|
|
responses:
|
|
200:
|
|
description: A successful response
|
|
/autocall/payment-callback:
|
|
get:
|
|
summary: The Payment callback
|
|
responses:
|
|
200:
|
|
description: A successful response |