KongNet Telco API

Get a help article with numbered steps

Returns the article title, which router models and packages it applies to, and the numbered steps to read back to the customer.

get
/kb/articles/{article_id}

Path Parameters

article_idstringrequired

Response

application/json

Successful Response

application/json

CreditCreate

object
amount_penceintegerrequired

Credit in pence, capped at 5000

<= 5000> 0

reasonstringrequired

Why the credit is being applied

>= 5 characters<= 280 characters

Example

HTTPValidationError

object
detailarray[object]
Show Child Parameters
Example

NoteCreate

object
textstringrequired

Note to add to the ticket

>= 1 characters<= 4000 characters

Example

TicketCreate

object
categorystringrequired

Ticket category

Allowed values:outageconnectionwifispeedtvbillingaccountother

summarystringrequired

One line summary in the customer’s words

>= 5 characters<= 140 characters

detailsstring

What the customer reported and what was found

Default:

<= 4000 characters

steps_triedarray[string]

Troubleshooting steps already tried, in order

diagnosticsobject

Results from line test or wifi scan, if run

* Additional properties are allowed.
model_aliasAny Of

Model alias that handled the conversation

Variant 1string
trace_idAny Of

Gateway trace id for the conversation

Variant 1string
Example