KongNet Telco API

Search help articles

Full text search over KongNet troubleshooting articles. Use two to four plain words such as ‘slow wifi evening’ or ‘red light’. Returns article ids, titles, a snippet and a score. Follow up with get_article for the steps.

get
/kb/search

Query Parameters

qstringrequired

Search words

>= 2 characters<= 120 characters

limitinteger

Maximum results

Default:3

>= 1<= 10

Response

application/json

Successful Response

application/json

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