Mobitel Voice API

Mobitel Voice API 1.0.0

0
No votes yet
forum Discuss this API in the forum
production
development
https://apphub.mobitel.lk/mobext/mapi

Paths

/unsubscribe

post /unsubscribe
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
request
Optional in body
object
unsub-req
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
POST https://apphub.mobitel.lk/mobext/mapi/mvoice/unsubscribe
Try this operation
https://apphub.mobitel.lk/mobext/mapi/mvoice/unsubscribe
content-type
accept

/getconsentandsubscribe

post /getconsentandsubscribe
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
request
Optional in body
object
consent-req
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
POST https://apphub.mobitel.lk/mobext/mapi/mvoice/getconsentandsubscribe
Try this operation
https://apphub.mobitel.lk/mobext/mapi/mvoice/getconsentandsubscribe
content-type
accept

/playandwaitforinputasync

post /playandwaitforinputasync
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
request
Optional in body
object
play-wait-async-req
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
POST https://apphub.mobitel.lk/mobext/mapi/mvoice/playandwaitforinputasync
Try this operation
https://apphub.mobitel.lk/mobext/mapi/mvoice/playandwaitforinputasync
content-type
accept

/playfilelistssync

post /playfilelistssync
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
request
Optional in body
object
play-async-req
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
POST https://apphub.mobitel.lk/mobext/mapi/mvoice/playfilelistssync
Try this operation
https://apphub.mobitel.lk/mobext/mapi/mvoice/playfilelistssync
content-type
accept

/playfileasync

post /playfileasync
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
request
Optional in body
object
play-async-req
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
POST https://apphub.mobitel.lk/mobext/mapi/mvoice/playfileasync
Try this operation
https://apphub.mobitel.lk/mobext/mapi/mvoice/playfileasync
content-type
accept

/saynumber

post /saynumber
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
request
Optional in body
object
say-number-req
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
POST https://apphub.mobitel.lk/mobext/mapi/mvoice/saynumber
Try this operation
https://apphub.mobitel.lk/mobext/mapi/mvoice/saynumber
content-type
accept

/saydigits

post /saydigits
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
request
Optional in body
object
say-digit-req
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
POST https://apphub.mobitel.lk/mobext/mapi/mvoice/saydigits
Try this operation
https://apphub.mobitel.lk/mobext/mapi/mvoice/saydigits
content-type
accept

/playandwaitforinput

post /playandwaitforinput
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
request
Optional in body
object
play-wait-req
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
POST https://apphub.mobitel.lk/mobext/mapi/mvoice/playandwaitforinput
Try this operation
https://apphub.mobitel.lk/mobext/mapi/mvoice/playandwaitforinput
content-type
accept

/playfile

post /playfile
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
request
Optional in body
object
play-file-req
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
POST https://apphub.mobitel.lk/mobext/mapi/mvoice/playfile
Try this operation
https://apphub.mobitel.lk/mobext/mapi/mvoice/playfile
content-type
accept

/hangupcall

post /hangupcall
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
request
Optional in body
object
basic-input-req
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
POST https://apphub.mobitel.lk/mobext/mapi/mvoice/hangupcall
Try this operation
https://apphub.mobitel.lk/mobext/mapi/mvoice/hangupcall
content-type
accept

/helloworld

post /helloworld
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
request
Optional in body
object
basic-input-req
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
POST https://apphub.mobitel.lk/mobext/mapi/mvoice/helloworld
Try this operation
https://apphub.mobitel.lk/mobext/mapi/mvoice/helloworld
content-type
accept

/getconsentandcharge

post /getconsentandcharge
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
request
Optional in body
object
consent-chg-req
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
POST https://apphub.mobitel.lk/mobext/mapi/mvoice/getconsentandcharge
Try this operation
https://apphub.mobitel.lk/mobext/mapi/mvoice/getconsentandcharge
content-type
accept

Definitions 

{
    "properties": {
        "txid": {
            "properties": [],
            "type": "string"
        },
        "ivrno": {
            "properties": [],
            "type": "string"
        },
        "callerid": {
            "properties": [],
            "type": "string"
        },
        "organization": {
            "properties": [],
            "type": "string"
        }
    },
    "additionalProperties": false,
    "required": [
        "txid",
        "ivrno",
        "callerid",
        "organization"
    ]
}
              
{
    "properties": {
        "txid": {
            "properties": [],
            "type": "string"
        },
        "ivrno": {
            "properties": [],
            "type": "string"
        },
        "callerid": {
            "properties": [],
            "type": "string"
        },
        "filename": {
            "properties": [],
            "type": "string"
        },
        "organization": {
            "properties": [],
            "type": "string"
        }
    },
    "additionalProperties": false,
    "required": [
        "txid",
        "ivrno",
        "callerid",
        "filename",
        "organization"
    ]
}
              
{
    "properties": {
        "timeout": {
            "properties": [],
            "type": "string"
        },
        "numdigits": {
            "properties": [],
            "type": "string"
        },
        "filename": {
            "properties": [],
            "type": "string"
        },
        "txid": {
            "properties": [],
            "type": "string"
        },
        "ivrno": {
            "properties": [],
            "type": "string"
        },
        "callerid": {
            "properties": [],
            "type": "string"
        },
        "organization": {
            "properties": [],
            "type": "string"
        }
    },
    "additionalProperties": false,
    "required": [
        "timeout",
        "numdigits",
        "filename"
    ]
}
              
{
    "properties": {
        "language": {
            "properties": [],
            "type": "string"
        },
        "digits": {
            "properties": [],
            "type": "string"
        },
        "txid": {
            "properties": [],
            "type": "string"
        },
        "ivrno": {
            "properties": [],
            "type": "string"
        },
        "callerid": {
            "properties": [],
            "type": "string"
        },
        "organization": {
            "properties": [],
            "type": "string"
        }
    },
    "additionalProperties": false,
    "required": [
        "language",
        "digits"
    ]
}
              
{
    "properties": {
        "number": {
            "properties": [],
            "type": "string"
        },
        "language": {
            "properties": [],
            "type": "string"
        },
        "organization": {
            "properties": [],
            "type": "string"
        },
        "txid": {
            "properties": [],
            "type": "string"
        },
        "ivrno": {
            "properties": [],
            "type": "string"
        },
        "callerid": {
            "properties": [],
            "type": "string"
        }
    },
    "additionalProperties": false,
    "required": [
        "number",
        "language"
    ]
}
              
{
    "properties": {
        "txid": {
            "properties": [],
            "type": "string"
        },
        "ivrno": {
            "properties": [],
            "type": "string"
        },
        "callerid": {
            "properties": [],
            "type": "string"
        }
    },
    "additionalProperties": false,
    "required": [
        "txid",
        "ivrno",
        "callerid"
    ]
}
              
{
    "properties": {
        "filename": {
            "properties": [],
            "type": "string"
        },
        "txdata": {
            "$ref": "#/definitions/basic-input-req"
        }
    },
    "additionalProperties": false
}
              
{
    "properties": {
        "timeout": {
            "properties": [],
            "type": "string"
        },
        "numdigits": {
            "properties": [],
            "type": "string"
        },
        "filename": {
            "properties": [],
            "type": "string"
        },
        "txdata": {
            "$ref": "#/definitions/basic-input-req"
        }
    },
    "additionalProperties": false,
    "required": [
        "timeout",
        "numdigits",
        "filename",
        "txdata"
    ]
}
              
{
    "properties": {
        "language": {
            "properties": [],
            "type": "string"
        },
        "digits": {
            "properties": [],
            "type": "string"
        },
        "txdata": {
            "$ref": "#/definitions/basic-input-req"
        }
    },
    "additionalProperties": false,
    "required": [
        "txdata"
    ]
}
              
{
    "properties": {
        "number": {
            "properties": [],
            "type": "string"
        },
        "language": {
            "properties": [],
            "type": "string"
        },
        "txdata": {
            "$ref": "#/definitions/basic-input-req"
        }
    },
    "additionalProperties": false,
    "required": [
        "txdata"
    ]
}
              
{
    "properties": {
        "organization": {
            "type": "string"
        },
        "txid": {
            "properties": [],
            "type": "string"
        },
        "ivrno": {
            "properties": [],
            "type": "string"
        },
        "callerid": {
            "properties": [],
            "type": "string"
        },
        "callbackurl": {
            "properties": [],
            "type": "string"
        },
        "filename": {
            "properties": [],
            "type": "string"
        }
    },
    "additionalProperties": false
}
              
{
    "properties": {
        "txdata": {
            "$ref": "#/definitions/basic-input-req"
        },
        "filename": {
            "properties": [],
            "type": "string"
        },
        "callbackurl": {
            "properties": [],
            "type": "string"
        }
    },
    "additionalProperties": false,
    "required": [
        "txdata"
    ]
}
              
{
    "properties": {
        "organization": {
            "type": "string"
        },
        "txid": {
            "properties": [],
            "type": "string"
        },
        "ivrno": {
            "properties": [],
            "type": "string"
        },
        "callerid": {
            "properties": [],
            "type": "string"
        },
        "filename": {
            "properties": [],
            "type": "string"
        },
        "timeout": {
            "properties": [],
            "type": "integer",
            "format": "int32"
        },
        "numdigits": {
            "properties": [],
            "type": "integer",
            "format": "int32"
        },
        "callbackurl": {
            "properties": [],
            "type": "string"
        }
    },
    "additionalProperties": false,
    "required": [
        "organization",
        "txid",
        "ivrno",
        "callerid"
    ]
}
              
{
    "properties": {
        "txdata": {
            "$ref": "#/definitions/basic-input-req"
        },
        "filename": {
            "properties": [],
            "type": "string"
        },
        "timeout": {
            "properties": [],
            "type": "integer",
            "format": "int32"
        },
        "numdigits": {
            "properties": [],
            "type": "integer",
            "format": "int32"
        },
        "callbackurl": {
            "properties": [],
            "type": "string"
        }
    },
    "additionalProperties": false,
    "required": [
        "txdata",
        "filename",
        "timeout"
    ]
}
              
{
    "properties": {
        "organization": {
            "type": "string"
        },
        "txid": {
            "properties": [],
            "type": "string"
        },
        "ivrno": {
            "properties": [],
            "type": "string"
        },
        "callerid": {
            "properties": [],
            "type": "string"
        },
        "productid": {
            "properties": [],
            "type": "string"
        },
        "language": {
            "properties": [],
            "type": "string"
        }
    },
    "additionalProperties": false,
    "required": [
        "organization",
        "txid",
        "ivrno",
        "callerid"
    ]
}
              
{
    "properties": {
        "txdata": {
            "properties": [],
            "$ref": "#/definitions/basic-input-req"
        },
        "productid": {
            "properties": [],
            "type": "string"
        },
        "language": {
            "properties": [],
            "type": "string"
        }
    },
    "additionalProperties": false,
    "required": [
        "productid",
        "language"
    ]
}
              
{
    "properties": {
        "organization": {
            "type": "string"
        },
        "callerid": {
            "properties": [],
            "type": "string"
        },
        "productid": {
            "properties": [],
            "type": "string"
        }
    },
    "additionalProperties": false
}
              
{
    "properties": {
        "callerid": {
            "type": "string"
        },
        "productid": {
            "properties": [],
            "type": "string"
        }
    },
    "additionalProperties": false
}
              
{
    "properties": {
        "organization": {
            "type": "string"
        },
        "txid": {
            "type": "string"
        },
        "ivrno": {
            "type": "string"
        },
        "callerid": {
            "type": "string"
        },
        "amount": {
            "type": "string"
        },
        "language": {
            "type": "string"
        }
    },
    "additionalProperties": false
}
              
{
    "properties": {
        "amount": {
            "type": "string"
        },
        "language": {
            "type": "string"
        },
        "txdata": {
            "$ref": "#/definitions/basic-input-req"
        }
    },
    "additionalProperties": false
}