Appearance
telecloud-mobile
15 endpoints.
GET /api/v1/tc-app/store
Store
What the signed-in account can buy. store_enabled: false means the app hides its Store tile: the review account, or an account with no billing customer of its own to order on.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
key | query | no | ||
api_token | query | no | ||
v | query | no | integer | |
account_token | query | no | ||
app | query | no | ||
x-api-token | header | no | ||
x-account-token | header | no |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/tc-app/store/buy
Store Buy
Order one item (builds before the cart). Same as a one-line checkout.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
x-api-token | header | no | ||
x-account-token | header | no |
Request body
json
{
"properties": {
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Key"
},
"api_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Api Token"
},
"account_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Account Token"
},
"app": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "App"
},
"item_id": {
"type": "integer",
"title": "Item Id"
},
"qty": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"title": "Qty",
"default": 1
}
},
"type": "object",
"required": [
"item_id"
],
"title": "StoreBuyIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/tc-app/store/checkout
Store Checkout
Check the cart out: one Sales Order for every line, mailed to the helpdesk, and its Paystack Pay Now link. Paying it invoices the order and raises its activations, the same as an order placed on the portal.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
x-api-token | header | no | ||
x-account-token | header | no |
Request body
json
{
"properties": {
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Key"
},
"api_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Api Token"
},
"account_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Account Token"
},
"app": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "App"
},
"lines": {
"items": {
"properties": {
"item_id": {
"type": "integer",
"title": "Item Id"
},
"qty": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"title": "Qty",
"default": 1
}
},
"type": "object",
"required": [
"item_id"
],
"title": "StoreCartLine"
},
"type": "array",
"maxItems": 30,
"minItems": 1,
"title": "Lines"
}
},
"type": "object",
"required": [
"lines"
],
"title": "StoreCheckoutIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/tc-app/store/change
Store Change
Upgrade or downgrade the account's airtime plan. Lodges the portal's own "Change Package" request (a Pending Migration Activation) — nothing is billed or switched until staff apply it, prorated, from the Activations queue.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
x-api-token | header | no | ||
x-account-token | header | no |
Request body
json
{
"properties": {
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Key"
},
"api_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Api Token"
},
"account_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Account Token"
},
"app": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "App"
},
"subscription_id": {
"type": "integer",
"title": "Subscription Id"
},
"item_id": {
"type": "integer",
"title": "Item Id"
}
},
"type": "object",
"required": [
"subscription_id",
"item_id"
],
"title": "StoreChangeIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/tc-app/store/order-status
Store Order Status
Where an app order stands after its Paystack checkout. Books the payment first when reference is paid, so the app shows the invoice and its Activations the moment the payer is back.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
x-api-token | header | no | ||
x-account-token | header | no |
Request body
json
{
"properties": {
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Key"
},
"api_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Api Token"
},
"account_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Account Token"
},
"app": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "App"
},
"order_id": {
"type": "integer",
"title": "Order Id"
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference"
}
},
"type": "object",
"required": [
"order_id"
],
"title": "StoreOrderIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/tc-app/store/pay
Store Pay
A fresh Paystack checkout for an app order still waiting for payment (the Store's "Awaiting payment" list).
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
x-api-token | header | no | ||
x-account-token | header | no |
Request body
json
{
"properties": {
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Key"
},
"api_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Api Token"
},
"account_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Account Token"
},
"app": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "App"
},
"order_id": {
"type": "integer",
"title": "Order Id"
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference"
}
},
"type": "object",
"required": [
"order_id"
],
"title": "StoreOrderIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/tc-app/store/cancel
Store Cancel
Delete an app order still waiting for payment: cancels the Sales Order in the books (docstatus 2, kept for the record, same as Cancel in the ERP), so a later account payment never invoices it.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
x-api-token | header | no | ||
x-account-token | header | no |
Request body
json
{
"properties": {
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Key"
},
"api_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Api Token"
},
"account_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Account Token"
},
"app": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "App"
},
"order_id": {
"type": "integer",
"title": "Order Id"
},
"reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference"
}
},
"type": "object",
"required": [
"order_id"
],
"title": "StoreOrderIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/tc-app/store/paid
Store Paid
Paystack's return from an app checkout (it appends reference). Books the payment right here — the receipt invoices the order and raises its Activations — and says so. The app closes its in-app browser on this address and asks /store/order-status itself; older builds show this page.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
b | query | yes | string | |
o | query | yes | integer | |
reference | query | no | ||
trxref | query | no |
200 — Successful Response
422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/tc-app/account/signup
Account Signup
Step 1: check the email and mobile are new and text a code to the mobile. Nothing is created until /account/signup-verify.
Request body
json
{
"properties": {
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Key"
},
"app": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "App"
},
"name": {
"type": "string",
"maxLength": 120,
"minLength": 2,
"title": "Name"
},
"email": {
"type": "string",
"maxLength": 255,
"minLength": 5,
"title": "Email"
},
"mobile": {
"type": "string",
"maxLength": 20,
"minLength": 9,
"title": "Mobile"
},
"company": {
"anyOf": [
{
"type": "string",
"maxLength": 160
},
{
"type": "null"
}
],
"title": "Company"
},
"password": {
"type": "string",
"maxLength": 72,
"minLength": 8,
"title": "Password"
}
},
"type": "object",
"required": [
"name",
"email",
"mobile",
"password"
],
"title": "SignupIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/tc-app/account/signup-verify
Account Signup Verify
Step 2: the SMS code. Creates the customer and its free SIP line and signs the app in to that line (line).
Request body
json
{
"properties": {
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Key"
},
"signup_token": {
"type": "string",
"title": "Signup Token"
},
"code": {
"type": "string",
"maxLength": 6,
"minLength": 6,
"title": "Code"
}
},
"type": "object",
"required": [
"signup_token",
"code"
],
"title": "SignupVerifyIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/tc-app/account/login
Account Login
Sign in with the email and password set at sign-up (or on the website).
Request body
json
{
"properties": {
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Key"
},
"app": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "App"
},
"email": {
"type": "string",
"maxLength": 255,
"minLength": 3,
"title": "Email"
},
"password": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"title": "Password"
}
},
"type": "object",
"required": [
"email",
"password"
],
"title": "AccountLoginIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/tc-app/account/reset-request
Account Reset Request
Email a 6-digit code to reset the password. The answer is the same whether or not the address has an account.
Request body
json
{
"properties": {
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Key"
},
"app": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "App"
},
"email": {
"type": "string",
"maxLength": 255,
"minLength": 3,
"title": "Email"
}
},
"type": "object",
"required": [
"email"
],
"title": "ResetRequestIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/tc-app/account/reset
Account Reset
Set a new password with the emailed code; signs the app in.
Request body
json
{
"properties": {
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Key"
},
"reset_token": {
"type": "string",
"title": "Reset Token"
},
"code": {
"type": "string",
"maxLength": 6,
"minLength": 6,
"title": "Code"
},
"password": {
"type": "string",
"maxLength": 72,
"minLength": 8,
"title": "Password"
}
},
"type": "object",
"required": [
"reset_token",
"code",
"password"
],
"title": "ResetIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/tc-app/account
Account
Where an app-signed-up account stands: line is its phone line's sign-in ({domain, extension, password}) once one is active, else None and the app keeps to the Store.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
key | query | no | ||
account_token | query | no | ||
x-account-token | header | no |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/tc-app/account/status
Account Status
After sign-in: store_only when the domain has no airtime plan, so the app opens on the Store instead of the dialler. Wholesale and AI Call Center Pay As You Go run without a plan (the provisioning gate's own exemptions) and the App Store review domain never sees the Store.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
key | query | no | ||
api_token | query | no | ||
account_token | query | no | ||
x-api-token | header | no | ||
x-account-token | header | no |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}